diff options
author | Karl Berry <karl@freefriends.org> | 2015-09-02 23:59:16 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2015-09-02 23:59:16 +0000 |
commit | 42bfcf8ad29b80c26850bc74b566386ea436ad47 (patch) | |
tree | 8e12ed94fb8eebe1777cfe6e6c19b754b00e2d35 /Master/texmf-dist/doc/latex | |
parent | 3f1f1cefd70c2c51b5ebf053549cea2c2709d2d7 (diff) |
shdoc (2sep15)
git-svn-id: svn://tug.org/texlive/trunk@38277 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex')
-rw-r--r-- | Master/texmf-dist/doc/latex/shdoc/README | 53 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/shdoc/README.txt | 49 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/shdoc/shdoc.pdf | bin | 0 -> 455752 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/shdoc/shdoc_example.pdf | bin | 79397 -> 0 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/shdoc/shdoc_example.tex | 63 |
5 files changed, 79 insertions, 86 deletions
diff --git a/Master/texmf-dist/doc/latex/shdoc/README b/Master/texmf-dist/doc/latex/shdoc/README index f3b818d5ab1..1437bf3a922 100644 --- a/Master/texmf-dist/doc/latex/shdoc/README +++ b/Master/texmf-dist/doc/latex/shdoc/README @@ -1,23 +1,30 @@ -%% README -%% Copyright 2015 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 v1.2. - - + Copyright 2015 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.0. + + 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 + + diff --git a/Master/texmf-dist/doc/latex/shdoc/README.txt b/Master/texmf-dist/doc/latex/shdoc/README.txt new file mode 100644 index 00000000000..b7bac2da4af --- /dev/null +++ b/Master/texmf-dist/doc/latex/shdoc/README.txt @@ -0,0 +1,49 @@ + Copyright 2015 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.0. + + 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 + +\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} + diff --git a/Master/texmf-dist/doc/latex/shdoc/shdoc.pdf b/Master/texmf-dist/doc/latex/shdoc/shdoc.pdf Binary files differnew file mode 100644 index 00000000000..bd9a661895e --- /dev/null +++ b/Master/texmf-dist/doc/latex/shdoc/shdoc.pdf diff --git a/Master/texmf-dist/doc/latex/shdoc/shdoc_example.pdf b/Master/texmf-dist/doc/latex/shdoc/shdoc_example.pdf Binary files differdeleted file mode 100644 index e287554343d..00000000000 --- a/Master/texmf-dist/doc/latex/shdoc/shdoc_example.pdf +++ /dev/null diff --git a/Master/texmf-dist/doc/latex/shdoc/shdoc_example.tex b/Master/texmf-dist/doc/latex/shdoc/shdoc_example.tex deleted file mode 100644 index 010630228ff..00000000000 --- a/Master/texmf-dist/doc/latex/shdoc/shdoc_example.tex +++ /dev/null @@ -1,63 +0,0 @@ - %% shdoc_example.tex - %% Copyright 2015 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 - % -\documentclass{article} -\usepackage[scale=.7]{geometry} -\usepackage{shdoc} -\usepackage[colorlinks=true,linkcolor=black]{hyperref} - -\title{The {\ttfamily shdoc} package -- an example} -\author{Simon Michael Laube} -\date{03/2015} -\begin{document} - -\maketitle - -\noindent This is an example \TeX{}-File for how to use the \textit{shdoc} package, -version \shdocversion{}. - - -\begin{sh} - \shuser{simon} - \shmachine{linuxmint} - \begin{shbox} - \shline{}{cd Desktop/} - \shline{Desktop/}{xsensors -help} - \shoutput{}{} - \shoutput{}{Usage: xsensors [options]} - \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:test} -\end{sh} - - - -One can refer to terminal sessions via \verb|\ref| -- for example: see Terminal Session~\ref{sh:test} for -the options of \textit{xsensors}. It is also possible to automatically create the list of terminal sessions -by typing \verb|\listofsh|. - -\listofsh - - - -\end{document}
\ No newline at end of file |