about summary refs log tree commit diff
path: root/Doc/Zsh/mod_example.yo
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/Zsh/mod_example.yo')
-rw-r--r--Doc/Zsh/mod_example.yo16
1 files changed, 16 insertions, 0 deletions
diff --git a/Doc/Zsh/mod_example.yo b/Doc/Zsh/mod_example.yo
new file mode 100644
index 000000000..5339253d9
--- /dev/null
+++ b/Doc/Zsh/mod_example.yo
@@ -0,0 +1,16 @@
+texinode(The example Module)(The files Module)(The deltochar Module)(Zsh Modules)
+sect(The example Module)
+The tt(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.