about summary refs log tree commit diff
path: root/Doc/Zsh/mod_parameter.yo
blob: 0cf44d4b130653885e118137ada3cf6bd37c619f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
texinode(The parameter Module)(The sched Module)(The mathfunc 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 some special parameters.

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(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
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(builtins)
item(tt(builtins))(
This association gives information about the builtin commands
currently known. 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. Also, the string
`tt(<disabled> )' will be prepended to the value if the builtin
command is currently disabled.
)
vindex(reswords)
item(tt(reswords))(
This association maps the reserved words to one of `tt(<enabled>)' or
`tt(<disabled>)' for enabled and disabled reserved words, respectively.
)
vindex(raliases)
item(tt(raliases))(
This maps the names of the regular aliases currently defined to their
expansions. For disabled aliases the string `tt(<disabled>)' is
prepended to their value.
)
vindex(galiases)
item(tt(galiases))(
Like tt(raliases), but for global aliases.
)
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.
)
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(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 follwed 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.
)
enditem()