mirrors/zsh
1
0
Fork 0
mirror of git://git.code.sf.net/p/zsh/code synced 2025-10-22 16:20:23 +02:00
Code Releases Activity

manual/9083

Browse source
This commit is contained in:
Tanaka Akira 1999-12-16 14:26:16 +00:00
parent 77d48c89e0
commit 02c0df2174
80 changed files with 470 additions and 394 deletions
Download patch file Download diff file Expand all files Collapse all files

8
Doc/Makefile.in
View file

@ -172,7 +172,7 @@ Zsh/modlist.yo: $(MODDOCSRC)
modules=`echo '' $(MODDOCSRC) '' | sed 's| Zsh/mod_| |g;s|\.yo | |g'`; \
echo "startitem()"; \
for mod in $$modules; do \
echo "item(tt($$mod))("; \
echo "item(tt(zsh/$$mod))("; \
sed -n '1d;/^!MOD!)$$/q;p' < $(sdir)/Zsh/mod_$${mod}.yo; \
echo ")"; \
done; \
@ -182,8 +182,8 @@ Zsh/modlist.yo: $(MODDOCSRC)
echo "endmenu()"; \
set '' $$modules; \
while test ".$$2" != .; do \
echo "texinode(The $$2 Module)($${3+The $$3 Module})($${1:+The $$1 Module})(Zsh Modules)"; \
echo "sect(The $$2 Module)"; \
echo "texinode(The zsh/$$2 Module)($${3+The $$3 Module})($${1:+The $$1 Module})(Zsh Modules)"; \
echo "sect(The zsh/$$2 Module)"; \
echo "includefile(Zsh/mod_$${2}.yo)"; \
shift; \
done \
@ -193,7 +193,7 @@ Zsh/modmenu.yo: $(MODDOCSRC)
( \
modules=`echo '' $(MODDOCSRC) '' | sed 's| Zsh/mod_| |g;s|\.yo | |g'`; \
for mod in $$modules; do \
echo "menu(The $$mod Module)"; \
echo "menu(The zsh/$$mod Module)"; \
done \
) > $(sdir)/Zsh/modmenu.yo

11
Doc/Zsh/builtins.yo
View file

@ -1303,16 +1303,15 @@ xitem(tt(zmodload) [ tt(-i) ] var(name) ... )
item(tt(zmodload) tt(-u) [ tt(-i) ] var(name) ...)(
In the simplest case, tt(zmodload) loads a binary module. The module must
be in a file with a name consisting of the specified var(name) followed by
a standard suffix, usually `tt(.so)'. If this can't be found, the
var(name) is tried without the suffix. If the module to be loaded is
a standard suffix, usually `tt(.so)'.
If the module to be loaded is
already loaded and the tt(-i) option is given, the duplicate module is
ignored. Otherwise tt(zmodload) prints an error message.
The var(name)d module is searched for in the same way a command is, using
tt($module_path) instead of tt($path). If var(name) contains a `tt(/)',
it will be used as-is, and a path search will be performed otherwise.
This behaviour can be modified by the tt(PATH_DIRS) option.
cindex(PATH_DIRS, use of)
tt($module_path) instead of tt($path). However, the path search is
performed even when the module name contains a `tt(/)', which it usually does.
There is no way to prevent the path search.
With tt(-u), tt(zmodload) unloads modules. The same var(name)
must be given that was given when the module was loaded, but it is not

2
Doc/Zsh/mod_cap.yo
View file

@ -1,7 +1,7 @@
COMMENT(!MOD!
Builtins for manipulating POSIX.1e (POSIX.6) capability (privilege) sets.
!MOD!)
The tt(cap) module is used for manipulating POSIX.1e (POSIX.6) capability
The tt(zsh/cap) module is used for manipulating POSIX.1e (POSIX.6) capability
sets. If the operating system does not support this interface, the
builtins defined by this module will do nothing.
The builtins in this module are:

2
Doc/Zsh/mod_clone.yo
View file

@ -1,7 +1,7 @@
COMMENT(!MOD!
A builtin that can clone a running shell onto another terminal.
!MOD!)
The tt(clone) module makes available one builtin command:
The tt(zsh/clone) module makes available one builtin command:
startitem()
findex(clone)

2
Doc/Zsh/mod_compctl.yo
View file

@ -1,7 +1,7 @@
COMMENT(!MOD!
The tt(compctl) builtin for controlling completion.
!MOD!)
The tt(compctl) module makes available two builtin commands. tt(compctl),
The tt(zsh/compctl) module makes available two builtin commands. tt(compctl),
is the old, deprecated way to control completions for ZLE. See
ifzman(zmanref(zshcompctl))\
ifnzman(noderef(Programmable Completion Using compctl))\

2
Doc/Zsh/mod_complete.yo
View file

@ -1,7 +1,7 @@
COMMENT(!MOD!
The basic completion code.
!MOD!)
The tt(complete) module makes available several builtin commands which
The tt(zsh/complete) module makes available several builtin commands which
can be used in user-defined completion widgets, see
ifzman(zmanref(zshcompwid))\
ifnzman(noderef(Completion Widgets))\

10
Doc/Zsh/mod_complist.yo
View file

@ -3,15 +3,15 @@ Completion listing extensions.
!MOD!)
cindex(completion, listing)
cindex(completion, coloured listings)
The tt(complist) module offers two extensions to completion listings:
The tt(zsh/complist) module offers two extensions to completion listings:
the ability to highlight matches in such a list and a different
style of menu-completion.
Whenever one of the parameters tt(ZLS_COLORS) or tt(ZLS_COLOURS) is set
and the tt(complist) module is loaded or linked into the shell,
and the tt(zsh/complist) module is loaded or linked into the shell,
completion lists will be colored. Note, however, that tt(complist) will
not automatically be loaded if it is not linked in: on systems with
dynamic loading, `tt(zmodload complist)' is required.
dynamic loading, `tt(zmodload zsh/complist)' is required.
subsect(Parameters)
vindex(ZLS_COLORS)
@ -130,7 +130,7 @@ subsect(Menu selection)
cindex(completion, selecting by cursor)
vindex(SELECTMIN)
tindex(menu-select)
The tt(complist) module also offers an alternative style of selecting
The tt(zsh/complist) module also offers an alternative style of selecting
matches from a list, called menu-selection, which can be used if the
shell is set up to return to the last prompt after showing a
completion list (see the tt(ALWAYS_LAST_PROMPT) option in
@ -211,4 +211,4 @@ continue with normal menu-completion one can call
indent(tt(bindkey -M menuselect '^M' send-break))
after loading the tt(complist) module.
after loading the tt(zsh/complist) module.

2
Doc/Zsh/mod_computil.yo
View file

@ -3,7 +3,7 @@ A module with utility builtins needed for the shell function based
completion system.
!MOD!)
cindex(completion, utility)
The tt(computil) module adds several builtin commands that are used by
The tt(zsh/computil) module adds several builtin commands that are used by
some of the completion functions in the shell function based
completions system (see
ifzman(zmanref(zshcompsys))\

2
Doc/Zsh/mod_deltochar.yo
View file

@ -1,7 +1,7 @@
COMMENT(!MOD!
A ZLE function duplicating EMACS' tt(zap-to-char).
!MOD!)
The tt(deltochar) module makes available two ZLE functions:
The tt(zsh/deltochar) module makes available two ZLE functions:
startitem()
tindex(delete-to-char)

2
Doc/Zsh/mod_example.yo
View file

@ -1,7 +1,7 @@
COMMENT(!MOD!
An example of how to write a module.
!MOD!)
The tt(example) module makes available one builtin command:
The tt(zsh/example) module makes available one builtin command:
startitem()
findex(example)

2
Doc/Zsh/mod_files.yo
View file

@ -2,7 +2,7 @@ COMMENT(!MOD!
Some basic file manipulation commands as builtins.
!MOD!)
cindex(files, manipulating)
The tt(files) module makes some standard commands available as builtins:
The tt(zsh/files) module makes some standard commands available as builtins:
startitem()
findex(chgrp)

2
Doc/Zsh/mod_mapfile.yo
View file

@ -2,7 +2,7 @@ COMMENT(!MOD!
Access to external files via a special associative array.
!MOD!)
cindex(parameter, file access via)
The tt(mapfile) module provides one special associative array parameter of
The tt(zsh/mapfile) module provides one special associative array parameter of
the same name.
startitem()

3
Doc/Zsh/mod_mathfunc.yo
View file

@ -3,7 +3,8 @@ Standard scientific functions for use in mathematical evaluations.
!MOD!)
cindex(functions, mathematical)
cindex(mathematical functions)
The tt(mathfunc) module provides standard mathematical functions for use when
The tt(zsh/mathfunc) module provides standard
mathematical functions for use when
evaluating mathematical formulae. The syntax agrees with normal C and
FORTRAN conventions, for example,

2
Doc/Zsh/mod_parameter.yo
View file

@ -2,7 +2,7 @@ COMMENT(!MOD!
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
The tt(zsh/parameter) module gives access to some of the internal hash
tables used by the shell by defining some special parameters.
startitem()

2
Doc/Zsh/mod_sched.yo
View file

@ -1,7 +1,7 @@
COMMENT(!MOD!
A builtin that provides a timed execution facility within the shell.
!MOD!)
The tt(sched) module makes available one builtin command:
The tt(zsh/sched) module makes available one builtin command:
startitem()
findex(sched)

2
Doc/Zsh/mod_stat.yo
View file

@ -1,7 +1,7 @@
COMMENT(!MOD!
A builtin command interface to the tt(stat) system call.
!MOD!)
The tt(stat) module makes available one builtin command:
The tt(zsh/stat) module makes available one builtin command:
startitem()
findex(stat)

6
Doc/Zsh/mod_zftp.yo
View file

@ -1,14 +1,14 @@
COMMENT(!MOD!
A builtin FTP client.
!MOD!)
The tt(zftp) module makes available one builtin command:
The tt(zsh/zftp) module makes available one builtin command:
startitem()
findex(zftp)
cindex(FTP)
cindex(files, transferring)
item(tt(zftp) var(subcommand) [ var(args) ])(
The tt(zftp) module is a client for FTP (file transfer protocol). It
The tt(zsh/zftp) module is a client for FTP (file transfer protocol). It
is implemented as a builtin to allow full use of shell command line
editing, file I/O, and job control mechanisms. Often, users will
access it via shell functions providing a more powerful interface; a set is
@ -84,7 +84,7 @@ are deleted. In that case, calling tt(open) with no arguments will
cause an error.
The list of parameters is not deleted after a tt(close), however it
will be deleted if the tt(zftp) module is unloaded.
will be deleted if the tt(zsh/zftp) module is unloaded.
For example,

2
Doc/Zsh/mod_zle.yo
View file

@ -1,7 +1,7 @@
COMMENT(!MOD!
The Zsh Line Editor, including the tt(bindkey) and tt(vared) builtins.
!MOD!)
The tt(zle) module contains the Zsh Line Editor. See
The tt(zsh/zle) module contains the Zsh Line Editor. See
ifzman(zmanref(zshzle))\
ifnzman(noderef(Zsh Line Editor))\
. It also contains three related builtin commands:

2
Doc/Zsh/mod_zleparameter.yo
View file

@ -2,7 +2,7 @@ COMMENT(!MOD!
Access to internals of the Zsh Line Editor via parameters.
!MOD!)
cindex(parameters, special)
The tt(zleparameter) module defines two special parameters that can be
The tt(zsh/zleparameter) module defines two special parameters that can be
used to access internal information of the Zsh Line Editor (see
ifzman(zmanref(zshzle))\
ifnzman(noderef(Zsh Line Editor))\

2
Doc/Zsh/mod_zutil.yo
View file

@ -3,7 +3,7 @@ Some utility builtins, e.g. the one for supporting configuration via
styles.
!MOD!)
cindex(builtins, utility)
The tt(zutil) module only adds some builtins:
The tt(zsh/zutil) module only adds some builtins:
startitem()
xitem(tt(zstyle) [ tt(-L) ])

3
Doc/Zsh/modules.yo
View file

@ -6,6 +6,7 @@ Some optional parts of zsh are in modules, separate from the core
of the shell. Each of these modules may be linked in to the
shell at build time,
or can be dynamically linked while the shell is running
if the installation supports this feature. The modules available are:
if the installation supports this feature. The modules that
are bundled with the zsh distribution are:
includefile(Zsh/modlist.yo)

3
Doc/Zsh/options.yo
View file

@ -758,8 +758,7 @@ Thus if `tt(/usr/local/bin)' is in the user's path, and he types
(assuming it exists).
Commands explicitly beginning with `tt(/)', `tt(./)' or `tt(../)'
are not subject to the path search.
This also applies to the tt(.) builtin,
and to searches for modules performed by the tt(zmodload) builtin.
This also applies to the tt(.) builtin.
)
pindex(POSIX_BUILTINS)
item(tt(POSIX_BUILTINS) <K> <S>)(

2
Doc/Zsh/restricted.yo
View file

@ -29,8 +29,6 @@ itemiz(using the tt(ARGV0) parameter to override tt(argv[0]) for external
commands)
itemiz(turning off restricted mode with tt(set +r) or tt(unsetopt
RESTRICTED))
itemiz(specifying modules to be loaded with an explicitly given
pathname containing slashes)
enditemize()
These restrictions are enforced after processing the startup files. The

2
Doc/Zsh/zftpsys.yo
View file

@ -21,7 +21,7 @@ ifnzman(\
noderef(The zftp Module)
), must be available in the
version of tt(zsh) installed at your site. If the shell is configured to
load new commands at run time, it probably is: typing `tt(zmodload zftp)'
load new commands at run time, it probably is: typing `tt(zmodload zsh/zftp)'
will make sure (if that runs silently, it has worked). If this is not the
case, it is possible tt(zftp) was linked into the shell anyway: to test
this, type `tt(which zftp)' and if tt(zftp) is available you will get the