steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

add some docs for environment variables

db4
Doug Coleman 2008-04-09 00:32:18 -05:00
parent 111fc5e50c
commit c5229fcbd1
1 changed files with 29 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
core/system/system-docs.factor
View File

@ -7,9 +7,7 @@ ABOUT: "system"
ARTICLE: "system" "System interface" ARTICLE: "system" "System interface"
{ $subsection "cpu" } { $subsection "cpu" }
{ $subsection "os" } { $subsection "os" }
"Reading environment variables:" { $subsection "environment-variables" }
{ $subsection os-env }
{ $subsection os-envs }
"Getting the path to the Factor VM and image:" "Getting the path to the Factor VM and image:"
{ $subsection vm } { $subsection vm }
{ $subsection image } { $subsection image }
@ -19,7 +17,16 @@ ARTICLE: "system" "System interface"
{ $subsection exit } { $subsection exit }
{ $see-also "io.files" "io.mmap" "io.monitors" "network-streams" "io.launcher" } ; { $see-also "io.files" "io.mmap" "io.monitors" "network-streams" "io.launcher" } ;
ARTICLE: "cpu" "Processor Detection" ARTICLE: "environment-variables" "Environment variables"
"Reading environment variables:"
{ $subsection os-env }
{ $subsection os-envs }
"Writing environment variables:"
{ $subsection set-os-env }
{ $subsection unset-os-env }
{ $subsection set-os-envs } ;
ARTICLE: "cpu" "Processor detection"
"Processor detection:" "Processor detection:"
{ $subsection cpu } { $subsection cpu }
"Supported processors:" "Supported processors:"
@ -30,7 +37,7 @@ ARTICLE: "cpu" "Processor Detection"
"Processor families:" "Processor families:"
{ $subsection x86 } ; { $subsection x86 } ;
ARTICLE: "os" "Operating System Detection" ARTICLE: "os" "Operating system detection"
"Operating system detection:" "Operating system detection:"
{ $subsection os } { $subsection os }
"Supported operating systems:" "Supported operating systems:"
@ -98,7 +105,23 @@ HELP: set-os-envs
} }
{ $errors "Windows CE has no concept of environment variables, so this word throws an error there." } ; { $errors "Windows CE has no concept of environment variables, so this word throws an error there." } ;
{ os-env os-envs set-os-envs } related-words HELP: set-os-env ( value key -- )
{ $values { "value" string } { "key" string } }
{ $description "Set an environment variable." }
{ $notes
"Names and values of environment variables are operating system-specific."
}
{ $errors "Windows CE has no concept of environment variables, so this word throws an error there." } ;
HELP: unset-os-env ( key -- )
{ $values { "key" string } }
{ $description "Unset an environment variable." }
{ $notes
"Names and values of environment variables are operating system-specific."
}
{ $errors "Windows CE has no concept of environment variables, so this word throws an error there." } ;
{ os-env os-envs set-os-env unset-os-env set-os-envs } related-words
HELP: image HELP: image
{ $values { "path" "a pathname string" } } { $values { "path" "a pathname string" } }