summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/shdoc/README.txt
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2016-05-02 23:56:09 +0000
committerKarl Berry <karl@freefriends.org>2016-05-02 23:56:09 +0000
commit5feb9fd1afef1dc215799e36d9a96ef2f4ed47ac (patch)
tree25b3d1656a239bc6784ccea166f8c602c3775ac6 /Master/texmf-dist/doc/latex/shdoc/README.txt
parent18e1e0676806d75d5accc5104cc3ab13865bda21 (diff)
shdoc (29apr16)
git-svn-id: svn://tug.org/texlive/trunk@40848 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/shdoc/README.txt')
-rw-r--r--Master/texmf-dist/doc/latex/shdoc/README.txt28
1 files changed, 8 insertions, 20 deletions
diff --git a/Master/texmf-dist/doc/latex/shdoc/README.txt b/Master/texmf-dist/doc/latex/shdoc/README.txt
index b7bac2da4af..4dee522ac99 100644
--- a/Master/texmf-dist/doc/latex/shdoc/README.txt
+++ b/Master/texmf-dist/doc/latex/shdoc/README.txt
@@ -16,7 +16,7 @@
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.0.
+ The current version of the package is v2.1.
To create the package (*.sty) from source open a command line prompt,
change to the package directory and type
@@ -27,23 +27,11 @@
(pdf)latex shdoc.dtx
-\begin{sh}
- \shuser{simon}
- \shmachine{linuxmint}
- \begin{shbox}
- \shline{}{cd Desktop/}
- \shline{Desktop/}{xsensors -help}
- \shoutput{}{}
- \shoutput{}{\underline{Options:}}
- \shoutput{}{}
- \shoutput{-f} {Display all temperatures in Fahrenheit.}
- \shoutput{-h} {Display this help text and exit.}
- \shoutput{-c} {+filename Specify the libsensors configuration file.}
- \shoutput{-i} {+filename Specify the image file to use as a theme.}
- \shoutput{-t} {+time Specify the update time in number of seconds.}
- \shoutput{-v} {Display version number.}
- \end{shbox}
- \caption{The options of \textit{xsensors}}
- \label{sh:xsensor}
-\end{sh}
+ 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.
+