summaryrefslogtreecommitdiff
path: root/Master/texmf-dist
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2015-04-07 21:18:10 +0000
committerKarl Berry <karl@freefriends.org>2015-04-07 21:18:10 +0000
commitde98010a196f66b2cde6e3d844be72313106dcea (patch)
treecb03513b4b606220c61c6865ebd670165c9c2bf1 /Master/texmf-dist
parentd78455f684469ab6c480b05e84332d30c32f5b52 (diff)
shdoc (7apr15)
git-svn-id: svn://tug.org/texlive/trunk@36739 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist')
-rw-r--r--Master/texmf-dist/doc/latex/shdoc/README23
-rw-r--r--Master/texmf-dist/doc/latex/shdoc/shdoc_example.pdfbin0 -> 79397 bytes
-rw-r--r--Master/texmf-dist/doc/latex/shdoc/shdoc_example.tex63
-rw-r--r--Master/texmf-dist/tex/latex/shdoc/shdoc.sty62
4 files changed, 148 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/shdoc/README b/Master/texmf-dist/doc/latex/shdoc/README
new file mode 100644
index 00000000000..f3b818d5ab1
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/shdoc/README
@@ -0,0 +1,23 @@
+%% 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.
+
+
diff --git a/Master/texmf-dist/doc/latex/shdoc/shdoc_example.pdf b/Master/texmf-dist/doc/latex/shdoc/shdoc_example.pdf
new file mode 100644
index 00000000000..e287554343d
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/shdoc/shdoc_example.pdf
Binary files differ
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
diff --git a/Master/texmf-dist/tex/latex/shdoc/shdoc.sty b/Master/texmf-dist/tex/latex/shdoc/shdoc.sty
new file mode 100644
index 00000000000..3640fd38c4e
--- /dev/null
+++ b/Master/texmf-dist/tex/latex/shdoc/shdoc.sty
@@ -0,0 +1,62 @@
+ %% shdoc.sty
+ %% 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
+ %
+\ProvidesPackage{shdoc}
+\NeedsTeXFormat{LaTeX2e}
+
+\def\shdocversion{v1.2}
+
+
+\typeout{-----------------------------------------------------------------}
+\typeout{Package for documenting terminal operations by RL-Systems (c)}
+\typeout{\shdocversion , 03/2015}
+\typeout{-----------------------------------------------------------------}
+
+\RequirePackage[dvipsnames]{xcolor}
+\RequirePackage{float}
+\RequirePackage{caption}
+\RequirePackage{mdframed}
+
+
+
+\newcounter{shlinenumber}
+\setcounter{shlinenumber}{0}
+
+%% New Float
+\newfloat{sh}{tbph}{lsh}
+\restylefloat*{sh}
+\floatstyle{plain}
+\floatname{sh}{Terminal~Session}
+\captionsetup[sh]{position=bottom}
+\newcommand{\listofsh}{\listof{sh}{List of Terminal Sessions}}
+\makeatletter
+\let\@shuser\relax
+\let\@shmachine\relax
+\def\shuser#1{\gdef\@shuser{#1}}
+\def\shmachine#1{\gdef\@shmachine{#1}}
+\long\def\shline#1#2{\ttfamily%
+ \noindent\scriptsize\ifnum\value{shlinenumber}<10 0\theshlinenumber\else \theshlinenumber\fi\normalsize\ \ \textcolor{green!80!yellow}{\@shuser @\@shmachine}%
+ \ \ifx&#1&%
+ \textcolor{RoyalBlue}{\~\ \$}
+ \else
+ \textcolor{RoyalBlue}{#1\ \$}
+ \fi\ #2\stepcounter{shlinenumber}\par
+}
+\long\def\shoutput#1#2{\ttfamily%
+ \noindent\scriptsize\ifnum\value{shlinenumber}<10 0\theshlinenumber\else \theshlinenumber\fi\normalsize \begin{tabular}{l l}\ifx&#1& \else\fcolorbox{white!60!gray}{white!60!gray}{[#1]}\fi
+ & #2\stepcounter{shlinenumber}\end{tabular}\par
+}
+\makeatother
+\newmdenv[linecolor=white,backgroundcolor=gray,settings=\setcounter{shlinenumber}{1}]{shbox} \ No newline at end of file