summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/generic/termmenu
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2015-06-29 00:15:42 +0000
committerKarl Berry <karl@freefriends.org>2015-06-29 00:15:42 +0000
commitd3fb2a6dc958e53b3b9d4e9282794904d32c590c (patch)
tree8e8e384abaa3cb475e0d84fd262b8f6a0304e38c /Master/texmf-dist/doc/generic/termmenu
parent99ab05030fdb929862749f25df2f137362584aef (diff)
termmenu (27jun15)
git-svn-id: svn://tug.org/texlive/trunk@37700 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/generic/termmenu')
-rw-r--r--Master/texmf-dist/doc/generic/termmenu/README80
-rw-r--r--Master/texmf-dist/doc/generic/termmenu/termmenu.pdfbin0 -> 472608 bytes
2 files changed, 80 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/generic/termmenu/README b/Master/texmf-dist/doc/generic/termmenu/README
new file mode 100644
index 00000000000..9a110bbd122
--- /dev/null
+++ b/Master/texmf-dist/doc/generic/termmenu/README
@@ -0,0 +1,80 @@
+termmenu - Terminal-driven menus in TeX
+=======================================
+
+When writing programs, it's often required to present the user with a
+list of options/actions. The user is then expected to select one of
+these options for the program to process.
+
+`termmenu` provides this mechanism for TeX. Using `termmenu` requires
+only `expl3` support, thus the `l3kernel` and `l3packages` are both
+required.
+
+----------------------------------------------------------------------
+
+`termmenu.dtx` may be distributed and/or modified under the conditions
+of the LaTeX Project Public License (LPPL), either version 1.3c of
+this license or (at your option) any later version. The latest
+version of this license is in the file
+
+ http://www.latex-project.org/lppl.txt
+
+The released version is available from CTAN.
+
+----------------------------------------------------------------------
+
+The development version can be found at
+
+ http://www.github.com/vermiculus/tex-termmenu
+
+for those people who are interested.
+
+Installation
+------------
+
+To install `termmenu`, simply run
+
+ tex termmenu.ins
+
+`termmenu.tex` will be produced. Since it can be run by anything that
+can run `expl3`, I recommend placing it in `tex/generic/termmenu`.
+
+To produce the documentation, run `pdflatex` or
+[`arara`](https://github.com/cereda/arara) on the file as normal.
+
+Usage
+-----
+
+Full documentation is available in `termmenu.pdf`, but using
+`termmenu` is very simple if you're familiar with `expl3` programming:
+
+ \termmenu_new:N \g_demo_termmenu
+
+will create a menu and
+
+ \termmenu_add:Nnnn \g_demo_termmenu { option }
+ { Description text }
+ { \msg_term:n { Actions } }
+
+will add a menu item. The user is prompted with
+
+ \termmenu_get_choice:NN \g_demo_termmenu \l_tmpa_tl
+
+and an action is taken with
+
+ \termmenu_exec:NV \g_demo_termmenu \l_tmpa_tl
+
+The menu itself looks something like this:
+
+ *************************************************
+ * Menu
+ *************************************************
+
+ The following commands are available:
+
+ > option
+ Description text
+
+ \choice=option
+ *************************************************
+ * Actions
+ *************************************************
diff --git a/Master/texmf-dist/doc/generic/termmenu/termmenu.pdf b/Master/texmf-dist/doc/generic/termmenu/termmenu.pdf
new file mode 100644
index 00000000000..decef56323e
--- /dev/null
+++ b/Master/texmf-dist/doc/generic/termmenu/termmenu.pdf
Binary files differ