about summary refs log tree commit diff
path: root/Doc/Zsh
diff options
context:
space:
mode:
authorTanaka Akira <akr@users.sourceforge.net>1999-05-19 13:10:41 +0000
committerTanaka Akira <akr@users.sourceforge.net>1999-05-19 13:10:41 +0000
commit4fec788fa5f6e7c9723e02e3d0b57068ce9785aa (patch)
tree2b4fd7f79ee29b231c77c9bc0bc67b4eed913bef /Doc/Zsh
parentea0ddb0fc6073be3d7d289e59b083f564dbd761f (diff)
downloadzsh-4fec788fa5f6e7c9723e02e3d0b57068ce9785aa.tar.gz
zsh-4fec788fa5f6e7c9723e02e3d0b57068ce9785aa.tar.xz
zsh-4fec788fa5f6e7c9723e02e3d0b57068ce9785aa.zip
Diffstat (limited to 'Doc/Zsh')
-rw-r--r--Doc/Zsh/.distfiles11
-rw-r--r--Doc/Zsh/compat.yo14
-rw-r--r--Doc/Zsh/mod_files.yo2
-rw-r--r--Doc/Zsh/mod_parameter.yo49
-rw-r--r--Doc/Zsh/mod_sched.yo2
-rw-r--r--Doc/Zsh/modules.yo5
-rw-r--r--Doc/Zsh/options.yo4
7 files changed, 77 insertions, 10 deletions
diff --git a/Doc/Zsh/.distfiles b/Doc/Zsh/.distfiles
index c4a6d8080..785febb16 100644
--- a/Doc/Zsh/.distfiles
+++ b/Doc/Zsh/.distfiles
@@ -1,9 +1,10 @@
 DISTFILES_SRC='
     .distfiles
-    arith.yo builtins.yo compat.yo compctl.yo compwid.yo cond.yo exec.yo
-    expn.yo filelist.yo files.yo func.yo grammar.yo guide.yo index.yo intro.yo
-    invoke.yo jobs.yo metafaq.yo mod_cap.yo mod_clone.yo mod_comp1.yo
-    mod_compctl.yo mod_deltochar.yo mod_example.yo mod_files.yo mod_sched.yo
+    arith.yo builtins.yo compat.yo compctl.yo compsys.yo compwid.yo
+    cond.yo exec.yo expn.yo filelist.yo files.yo func.yo grammar.yo
+    guide.yo index.yo intro.yo invoke.yo jobs.yo metafaq.yo mod_cap.yo
+    mod_clone.yo mod_comp1.yo mod_compctl.yo mod_deltochar.yo
+    mod_example.yo mod_files.yo mod_parameter.yo mod_sched.yo
     mod_stat.yo mod_zftp.yo mod_zle.yo modules.yo options.yo params.yo
-    prompt.yo redirect.yo restricted.yo seealso.yo zle.yo
+    prompt.yo redirect.yo restricted.yo seealso.yo zftpsys.yo zle.yo
 '
diff --git a/Doc/Zsh/compat.yo b/Doc/Zsh/compat.yo
index a1ebd5411..26f8fe896 100644
--- a/Doc/Zsh/compat.yo
+++ b/Doc/Zsh/compat.yo
@@ -7,7 +7,19 @@ cindex(compatibility)
 cindex(sh, compatibility)
 cindex(ksh, compatibility)
 Zsh tries to emulate bf(sh) or bf(ksh) when it is invoked as
-tt(sh) or tt(ksh) respectively.  In this mode the following
+tt(sh) or tt(ksh) respectively.  More precisely, it looks at the first
+letter of the name passed to it, which may not necessarily be the
+name of the executable file, ignoring any initial `tt(-)' as well as
+`tt(r)' (for restricted); an `tt(s)' or `tt(b)' will force
+bf(sh) compatibility, while `tt(k)' will force bf(ksh) compatibility.  An
+exception is if the name excluding any `tt(-)' is tt(su), in which case
+the environment variable tt(SHELL) will be used to test the emulation;
+this is to workaround a problem under some operating systems where the
+tt(su) command does not change the name when executing a user shell.  Note
+that, from within zsh itself, this mechanism can be invoked by `tt(ARGV0=sh
+zsh ...)'.
+
+In this emulation mode, the following
 parameters are not special and not initialized by the shell:
 tt(ARGC),
 tt(argv),
diff --git a/Doc/Zsh/mod_files.yo b/Doc/Zsh/mod_files.yo
index 541ebb4a9..160473fba 100644
--- a/Doc/Zsh/mod_files.yo
+++ b/Doc/Zsh/mod_files.yo
@@ -1,4 +1,4 @@
-texinode(The files Module)(The sched Module)(The example Module)(Zsh Modules)
+texinode(The files Module)(The parameter Module)(The example Module)(Zsh Modules)
 sect(The files Module)
 cindex(files, manipulating)
 The tt(files) module makes some standard commands available as builtins:
diff --git a/Doc/Zsh/mod_parameter.yo b/Doc/Zsh/mod_parameter.yo
new file mode 100644
index 000000000..c84dd18eb
--- /dev/null
+++ b/Doc/Zsh/mod_parameter.yo
@@ -0,0 +1,49 @@
+texinode(The parameter Module)(The sched Module)(The files Module)(Zsh Modules)
+sect(The parameter Module)
+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.
+
+startitem()
+vindex(options)
+item(tt(options))(
+The keys for this associative array are the names of the options that
+can be set and unset using the tt(setopt) and tt(unsetopt)
+builtins. The value of each key is either the string tt(on) if the
+option is currently set, or the string tt(off) if the option is unset.
+Setting a key to one of these strings is like setting or unsetting
+the option, respectively. Unsetting a key in this array is like
+setting it to the value tt(off).
+)
+vindex(commands)
+item(tt(command))(
+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
+key in this array defines a new entry in this table in the same way as
+with the tt(hash) builtin. Unsetting a key as in `tt(unset
+"commands[foo]")' removes the entry for the given key from the command 
+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.
+)
+vindex(parameters)
+item(tt(parameters))(
+The keys in this associative array are the names of the parameters
+currently defined. The values are strings describing the type of the
+parameter, in the same format used by the tt(t) parameter flag, see
+ifzman(\
+zmanref(zshexpn)
+)\
+ifnzman(\
+noderef(Parameter Expansion)
+)\
+.
+Setting or unsetting keys in this array is not possible.
+)
+enditem()
diff --git a/Doc/Zsh/mod_sched.yo b/Doc/Zsh/mod_sched.yo
index 1be550a79..18ea87db5 100644
--- a/Doc/Zsh/mod_sched.yo
+++ b/Doc/Zsh/mod_sched.yo
@@ -1,4 +1,4 @@
-texinode(The sched Module)(The stat Module)(The files Module)(Zsh Modules)
+texinode(The sched Module)(The stat Module)(The parameter Module)(Zsh Modules)
 sect(The sched Module)
 The tt(sched) module makes available one builtin command:
 
diff --git a/Doc/Zsh/modules.yo b/Doc/Zsh/modules.yo
index 63894076b..a7c528951 100644
--- a/Doc/Zsh/modules.yo
+++ b/Doc/Zsh/modules.yo
@@ -31,6 +31,9 @@ An example of how to write a module.
 item(tt(files))(
 Some basic file manipulation commands as builtins.
 )
+item(tt(parameter))(
+Access to internal hash tables via special associative arrays.
+)
 item(tt(sched))(
 A builtin that provides a timed execution facility within the shell.
 )
@@ -52,6 +55,7 @@ menu(The compctl Module)
 menu(The deltochar Module)
 menu(The example Module)
 menu(The files Module)
+menu(The parameter Module)
 menu(The sched Module)
 menu(The stat Module)
 menu(The zftp Module)
@@ -64,6 +68,7 @@ includefile(Zsh/mod_compctl.yo)
 includefile(Zsh/mod_deltochar.yo)
 includefile(Zsh/mod_example.yo)
 includefile(Zsh/mod_files.yo)
+includefile(Zsh/mod_parameter.yo)
 includefile(Zsh/mod_sched.yo)
 includefile(Zsh/mod_stat.yo)
 includefile(Zsh/mod_zftp.yo)
diff --git a/Doc/Zsh/options.yo b/Doc/Zsh/options.yo
index 41c5ce24e..c34736107 100644
--- a/Doc/Zsh/options.yo
+++ b/Doc/Zsh/options.yo
@@ -479,9 +479,9 @@ of tt(exit) or tt(logout) instead.
 However, ten consecutive EOFs will cause the shell to exit anyway,
 to avoid the shell hanging if its tty goes away.
 )
-pindex(INCREMENTAL_APPEND_HISTORY)
+pindex(INC_APPEND_HISTORY)
 cindex(history, incremental appending to a file)
-item(tt(INCREMENTAL_APPEND_HISTORY))(
+item(tt(INC_APPEND_HISTORY))(
 This options works like APPEND_HISTORY except that new history lines
 are added to the tt($HISTFILE) when they finish running, rather than
 waiting until the shell is killed. The file is periodically trimmed