about summary refs log tree commit diff
path: root/Doc/Zsh/mod_example.yo
blob: af6d53b88eb23c0d9880935483f45a5e3a2294e7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
COMMENT(!MOD!zsh/example
An example of how to write a module.
!MOD!)
The tt(zsh/example) module makes available one builtin command:

startitem()
findex(example)
cindex(modules, example)
cindex(modules, writing)
cindex(writing modules)
item(tt(example) [ tt(-flags) ] [ var(args) ... ])(
Displays the flags and arguments it is invoked with.
)
enditem()

The purpose of the module is to serve as an example of how to write a
module.