about summary refs log tree commit diff
path: root/Doc/Zsh/mod_parameter.yo
diff options
context:
space:
mode:
authorOliver Kiddle <opk@users.sourceforge.net>2000-05-11 00:01:03 +0000
committerOliver Kiddle <opk@users.sourceforge.net>2000-05-11 00:01:03 +0000
commited8b82b9b1bf74392caf4f4683f367bc4cbbd193 (patch)
tree253b1493fad4d586ffa79fed073bac3bf95ef410 /Doc/Zsh/mod_parameter.yo
parent548fe00d96c7a96f1c3922e3dd34bc0795c51a4c (diff)
downloadzsh-ed8b82b9b1bf74392caf4f4683f367bc4cbbd193.tar.gz
zsh-ed8b82b9b1bf74392caf4f4683f367bc4cbbd193.tar.xz
zsh-ed8b82b9b1bf74392caf4f4683f367bc4cbbd193.zip
Spelling corrections in the docs (11315)
Diffstat (limited to 'Doc/Zsh/mod_parameter.yo')
-rw-r--r--Doc/Zsh/mod_parameter.yo120
1 files changed, 111 insertions, 9 deletions
diff --git a/Doc/Zsh/mod_parameter.yo b/Doc/Zsh/mod_parameter.yo
index c84dd18eb..c7ac62280 100644
--- a/Doc/Zsh/mod_parameter.yo
+++ b/Doc/Zsh/mod_parameter.yo
@@ -1,8 +1,9 @@
-texinode(The parameter Module)(The sched Module)(The files Module)(Zsh Modules)
-sect(The parameter Module)
+COMMENT(!MOD!zsh/parameter
+Access to internal hash tables via special associative arrays.
+!MOD!)
 cindex(parameters, special)
-The tt(parameter) module gives access to some of the internal hash
-tables used by the shell, by defining four special associative arrays.
+The tt(zsh/parameter) module gives access to some of the internal hash
+tables used by the shell by defining some special parameters.
 
 startitem()
 vindex(options)
@@ -16,7 +17,7 @@ the option, respectively. Unsetting a key in this array is like
 setting it to the value tt(off).
 )
 vindex(commands)
-item(tt(command))(
+item(tt(commands))(
 This array gives access to the command hash table. The keys are the
 names of external commands, the values are the pathnames of the files
 that would be executed when the command would be invoked. Setting a
@@ -27,10 +28,51 @@ hash table.
 )
 vindex(functions)
 item(tt(functions))(
-This association maps function names to their definitions. Setting a
-key in it is like defining a function with the name given by the key
-and the body given by the value. Unsetting a key removes the
-definition for the function named by the key.
+This association maps names of enabled functions to their
+definitions. Setting a key in it is like defining a function with the
+name given by the key and the body given by the value. Unsetting a key
+removes the definition for the function named by the key.
+)
+vindex(dis_functions)
+item(tt(dis_functions))(
+Like tt(functions) but for disabled functions.
+)
+vindex(builtins)
+item(tt(builtins))(
+This association gives information about the builtin commands
+currently enabled. The keys are the names of the builtin commands and
+the values are either `tt(undefined)' for builtin commands that will
+automatically be loaded from a module if invoked or `tt(defined)' for
+builtin commands that are already loaded.
+)
+vindex(dis_builtins)
+item(tt(dis_builtins))(
+Like tt(builtins) but for disabled builtin commands.
+)
+vindex(reswords)
+item(tt(reswords))(
+This array contains the enabled reserved words.
+)
+vindex(dis_reswords)
+item(tt(dis_reswords))(
+Like tt(reswords) but for disabled reserved words.
+)
+vindex(aliases)
+item(tt(aliases))(
+This maps the names of the regular aliases currently enabled to their
+expansions.
+)
+vindex(dis_aliases)
+item(tt(dis_aliases))(
+Like tt(raliases) but for disabled regular aliases.
+)
+vindex(galiases)
+item(tt(galiases))(
+Like tt(raliases), but for global aliases.
+)
+vindex(dis_galiases)
+item(tt(dis_galiases))(
+Like tt(galiases) but for disabled global aliases.
 )
 vindex(parameters)
 item(tt(parameters))(
@@ -46,4 +88,64 @@ noderef(Parameter Expansion)
 .
 Setting or unsetting keys in this array is not possible.
 )
+vindex(modules)
+item(tt(modules))(
+An association giving information about module. The keys are the names
+of the modules builtin, loaded, or registered to be autoloaded. The
+value says which state the named module is in and is one of the
+strings tt(builtin), tt(loaded), or tt(autoloaded).
+
+Setting or unsetting keys in this array is not possible.
+)
+vindex(dirstack)
+item(tt(dirstack))(
+A normal array holding the elements of the directory stack. Note that
+the output of the tt(dirs) builtin command includes one more
+directory, the current working directory.
+)
+vindex(history)
+item(tt(history))(
+This association maps history event numbers to the full history lines.
+)
+vindex(historywords)
+item(tt(historywords))(
+A special array containing the words stored in the history.
+)
+vindex(jobdirs)
+item(tt(jobdirs))(
+This association maps job numbers to the directories from which the job was started (which may not be the current directory of the job).
+)
+vindex(jobtexts)
+item(tt(jobtexts))(
+This association maps job numbers to the texts of the command lines
+that were used to start the jobs.
+)
+vindex(jobstates)
+item(tt(jobstates))(
+This association gives information about the states of the jobs
+currently known. The keys are the job numbers and the values are
+strings of the form
+`var(job-state):var(pid)tt(=)var(state)tt(...)'. The var(job-state)
+gives the state the whole job is currently in, one of `tt(running)',
+`tt(suspended)', or `tt(done)'. This is followed by one
+`var(pid)tt(=)var(state)' for every process in the job. The var(pid)s
+are, of course, the process IDs and the var(state) describes the state 
+of that process.
+)
+vindex(nameddirs)
+item(tt(nameddirs))(
+This association maps the names of named directories to the pathnames
+they stand for.
+)
+vindex(userdirs)
+item(tt(userdirs))(
+This association maps user names to the pathnames of their home
+directories.
+)
+vindex(funcstack)
+item(tt(funcstack))(
+This array contains the names of the functions currently being
+executed. The first element is the name of the function using the
+parameter.
+)
 enditem()