Skip to content

Commit 3030662

Browse files
authored
Merge pull request #475 from ugexe/docs/update-env-options
Update docs and help message
2 parents 80a9476 + 9d14441 commit 3030662

File tree

2 files changed

+22
-7
lines changed

2 files changed

+22
-7
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -176,15 +176,25 @@ to fulfill any dependencies of other requested identities.
176176
ZEF_TEST_TIMEOUT=3600
177177
ZEF_INSTALL_TIMEOUT=3600
178178

179+
# Set default --install-to target
180+
ZEF_INSTALL_TO=site
181+
179182
# Path to config file (see: --config-path option)
180183
ZEF_CONFIG_PATH=$PWD/resources/config.json
181184

185+
# Override DefaultCUR from the config file
186+
ZEF_CONFIG_DEFAULTCUR=auto
187+
188+
# Override StoreDir from the config file
189+
ZEF_CONFIG_STOREDIR=/home/ugexe/.config/zef/store
190+
191+
# Override TempDir from the config file
192+
ZEF_CONFIG_TEMPDIR=/home/ugexe/.config/zef/temp
193+
182194
#### **uninstall** \[\*@identities\]
183195

184196
Uninstall the specified distributions
185197

186-
Note: Requires a bleeding edge rakudo (not available in 6.c)
187-
188198
#### **update**
189199

190200
Update the package indexes for all `Repository` backends
@@ -405,7 +415,7 @@ If you are most users (e.g. not: power users, packagers, zef plugin developers)
405415
406416
### How the configuration file is chosen
407417
408-
The configuration file will be chosen at runtime from one of two (technically four) locations, and one can affect the others (this is not really a design decision and suggestions and PRs are welcome).
418+
The configuration file will be chosen at runtime from one of two (technically four) locations.
409419
410420
First, and the most precise way, is to specify the config file by passing `--config-path="..."` to any zef command.
411421

lib/Zef/CLI.rakumod

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1035,10 +1035,10 @@ package Zef::CLI {
10351035
10361036
install Install specific dependencies by name or path
10371037
uninstall Uninstall specified distributions
1038-
test Run tests on a given module's path
1039-
fetch Fetch and extract module's source
1040-
build Run the Build.rakumod in a given module's path
1041-
look Fetch followed by shelling into the module's path
1038+
test Run tests on a given distribution path
1039+
fetch Fetch and extract distribution source
1040+
build Run the builder for given distribution path
1041+
look Fetch followed by shelling into the distribution path
10421042
update Update package indexes for repositories
10431043
upgrade (BETA) Upgrade specific distributions (or all if no arguments)
10441044
search Show a list of possible distribution candidates for the given terms
@@ -1068,6 +1068,11 @@ package Zef::CLI {
10681068
10691069
ZEF_[phase]_TIMEOUT See --[phase]-timeout ( phases: FETCH, BUILD, TEST, INSTALL )
10701070
ZEF_[phase]_DEGREE See --[phase]-degree ( phases: FETCH, TEST )
1071+
ZEF_INSTALL_TO See --install-to
1072+
ZEF_CONFIG_PATH Set the path to the config file zef should use
1073+
ZEF_CONFIG_DEFAULTCUR Override DefaultCUR from the config file
1074+
ZEF_CONFIG_STOREDIR Override StoreDir from the config file
1075+
ZEF_CONFIG_TEMPDIR Override TempDir from the config file
10711076
10721077
VERBOSITY LEVEL (from least to most verbose)
10731078
--error, --warn, --info (default), --verbose, --debug

0 commit comments

Comments
 (0)