]> gitweb.factorcode.org Git - factor.git/commitdiff
Make -roots=<paths> known to the documentation
authorGiftpflanze <gifti@tools.wmflabs.org>
Sat, 24 Feb 2024 10:18:31 +0000 (11:18 +0100)
committerGiftpflanze <gifti@tools.wmflabs.org>
Sat, 24 Feb 2024 10:18:49 +0000 (11:18 +0100)
basis/command-line/command-line-docs.factor
core/vocabs/loader/loader-docs.factor

index 71e139a30a4a912a563f7f28907c5f91a1508ebb..22c9d2c3be12fb7e93cb6eb9db780846f51ef646 100644 (file)
@@ -95,6 +95,7 @@ ARTICLE: "standard-cli-args" "Command line switches for general usage"
     { { $snippet "-e=" { $emphasis "code" } } { "This specifies a code snippet to evaluate and then exit Factor." } }
     { { $snippet "-run=" { $emphasis "vocab" } } { { $snippet { $emphasis "vocab" } } " is the name of a vocabulary with a " { $link POSTPONE: MAIN: } " hook to run on startup, for example " { $vocab-link "listener" } " or " { $vocab-link "ui.tools" } "." } }
     { { $snippet "-no-user-init" } { "Inhibits the running of user initialization files on startup. See " { $link "rc-files" } "." } }
+    { { $snippet "-roots=" { $emphasis "paths" } } { "Specify additional vocabulary roots. The list is colon-separated on Unix and semicolon-separated on Windows." } }
 } ;
 
 ARTICLE: ".factor-boot-rc" "Bootstrap initialization file"
index bff9ada6c3f0c357f11d1d935d313130c5af2ded..b9962c152e53871a04cad766ea5249d3fd58db00 100644 (file)
@@ -5,11 +5,13 @@ IN: vocabs.loader
 ARTICLE: "add-vocab-roots" "Working with code outside of the Factor source tree"
 "You can work with code outside of the Factor source tree by adding additional directories to the list of vocabulary roots."
 $nl
-"There are three ways of doing this."
+"There are four ways of doing this:"
 $nl
 "The first way is to use an environment variable. Factor looks at the " { $snippet "FACTOR_ROOTS" } " environment variable for a list of " { $snippet ":" } "-separated paths (on Unix) or a list of " { $snippet ";" } "-separated paths (on Windows)."
 $nl
-"The second way is to create a configuration file. You can list additional vocabulary roots in a file that Factor reads at startup:"
+"The second way is to use the " { $snippet "-roots=" } " command-line argument. The format is the same as for the environment variable."
+$nl
+"The third way is to create a configuration file. You can list additional vocabulary roots in a file that Factor reads at startup:"
 { $subsections ".factor-roots" }
 "Finally, you can add vocabulary roots by calling a word from your " { $snippet ".factor-rc" } " file (see " { $link ".factor-rc" } "):"
 { $subsections add-vocab-root } ;