summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/shdoc/README
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/shdoc/README
Initial commit
Diffstat (limited to 'macros/latex/contrib/shdoc/README')
-rw-r--r--macros/latex/contrib/shdoc/README37
1 files changed, 37 insertions, 0 deletions
diff --git a/macros/latex/contrib/shdoc/README b/macros/latex/contrib/shdoc/README
new file mode 100644
index 0000000000..b6917f6f3c
--- /dev/null
+++ b/macros/latex/contrib/shdoc/README
@@ -0,0 +1,37 @@
+ Copyright 2016 Simon M. Laube
+
+ This work may be distributed and/or modified under the
+ conditions of the LaTeX Project Public License, either version 1.3
+ of this license or (at your option) any later version.
+ The latest version of this license is in
+ http://www.latex-project.org/lppl.txt
+ and version 1.3 or later is part of all distributions of LaTeX
+ version 2005/12/01 or later.
+
+ This work has the LPPL maintenance status `author maintained'.
+
+ The Current Maintainer of this work is S. M. Laube
+
+ The shdoc package provides a simple, though fancy, float
+ environment that can be used to document operations or command
+ executions of a terminal session on a shell.
+
+ The current version of the package is v2.1b.
+
+ To create the package (*.sty) from source open a command line prompt,
+ change to the package directory and type
+
+ tex shdoc.ins
+
+ Afterwards you can generate the package documentation by typing
+
+ (pdf)latex shdoc.dtx
+
+ Be aware, that the shdoc package is using Unix/Linux specific shell
+ commands within the documentation. Thus, you may not be able to build
+ the documentation on your system. For security reasons, make sure that
+ you do not execute unknown shell scripts -- that are distributed with this
+ or other packages -- blindly. Further, you will need to enable `write18'
+ to build the documentation successfully.
+
+