summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/shdoc
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
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')
-rw-r--r--Master/texmf-dist/doc/latex/shdoc/README9
-rw-r--r--Master/texmf-dist/doc/latex/shdoc/README.txt28
-rw-r--r--Master/texmf-dist/doc/latex/shdoc/avrdude-log.save13
-rw-r--r--Master/texmf-dist/doc/latex/shdoc/shdoc.pdfbin455752 -> 543806 bytes
-rwxr-xr-xMaster/texmf-dist/doc/latex/shdoc/shreformat.sh9
5 files changed, 38 insertions, 21 deletions
diff --git a/Master/texmf-dist/doc/latex/shdoc/README b/Master/texmf-dist/doc/latex/shdoc/README
index 1437bf3a922..4dee522ac99 100644
--- a/Master/texmf-dist/doc/latex/shdoc/README
+++ b/Master/texmf-dist/doc/latex/shdoc/README
@@ -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,4 +27,11 @@
(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.
+
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.
+
diff --git a/Master/texmf-dist/doc/latex/shdoc/avrdude-log.save b/Master/texmf-dist/doc/latex/shdoc/avrdude-log.save
new file mode 100644
index 00000000000..c5f2e460134
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/shdoc/avrdude-log.save
@@ -0,0 +1,13 @@
+
+avrdude: AVR device initialized and ready to accept instructions
+
+Reading | ################################################## | 100% 0.01s
+
+avrdude: Device signature = 0x1e910b
+
+avrdude: safemode: Fuses OK (H:FF, E:DF, L:E2)
+
+avrdude done. Thank you.
+
+
+
diff --git a/Master/texmf-dist/doc/latex/shdoc/shdoc.pdf b/Master/texmf-dist/doc/latex/shdoc/shdoc.pdf
index bd9a661895e..c66b37d7952 100644
--- a/Master/texmf-dist/doc/latex/shdoc/shdoc.pdf
+++ b/Master/texmf-dist/doc/latex/shdoc/shdoc.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/shdoc/shreformat.sh b/Master/texmf-dist/doc/latex/shdoc/shreformat.sh
new file mode 100755
index 00000000000..d27e9c088d8
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/shdoc/shreformat.sh
@@ -0,0 +1,9 @@
+#!/bin/bash
+
+# experimental formatting script to pre-format shell output that is read by
+# the LaTeX package 'shdoc' (see ctan.org/pkg/shdoc)
+
+# 1. read from shrun.tmp and substitute double tabs with two spaces
+# 2. substitute single tabs with a single space
+# 3. remove all leading spaces and save the output to shrun-formatted.tmp
+sed 's/\t\t/ /' <shrun.tmp | sed 's/\t/ /' | sed -e 's/^[ \t]*//' >shrun-formatted.tmp