summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/shdoc/shdoc_example.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/shdoc/shdoc_example.tex')
-rw-r--r--Master/texmf-dist/doc/latex/shdoc/shdoc_example.tex63
1 files changed, 63 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/shdoc/shdoc_example.tex b/Master/texmf-dist/doc/latex/shdoc/shdoc_example.tex
new file mode 100644
index 00000000000..010630228ff
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/shdoc/shdoc_example.tex
@@ -0,0 +1,63 @@
+ %% 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