Terminamls mit LaTeX setzen

Das termsim Paket (v1.1.1 2021/12/26) ist ein Paket mit dem Windows, Mac und Linux (Ubuntu) Terminals gesetzt werden können.[1] Dadurch erspart man sich beim Schreiben von Dokumentationen das Erstellen, bearbeiten und einfügen von Screenshots. Auch ermöglicht es die Veränderung des Textes der innerhalb der Terminals steht für den Fall, dass der Inhalt geändert muss.

1.1 Paket einbinden

Das Paket wird mit \usepackage{termsim} eingebunden. Das Paket selbst bindet eine Vielzahl weiterer Paket ein, unter anderem xcolor, tcolorbox und über das tcolorbox Paket werden mit \tcbuselibrary{...} zusätzliche Pakete eingebunden, insbesondere das listings und minted Paket.

2 terminal Umgebung

Das Terminal kann über die terminal beziehungsweise über die terminal* Umgebung gesetzt werden. Der Unterschied zwischen den beiden Varianten ist, dass es bei der Sternvariante möglich ist, einen zusätzlichen Kommentar am Ende des Terminals einzufügen.

\begin{terminal}[Optionen]{Titel des Terminals}
%...
\end{terminal}

\begin{terminal*}[Optionen][Kommentar]{Titel des Terminals}
%...
\end{terminal*}

\documentclass{article}
\usepackage[ngerman]{babel}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage{lmodern}
\usepackage{termsim}
%...
\begin{document}
%...
\begin{terminal}{Command Prompt}
Microsoft Windows [Version 10.0.19041.867]
(c) 2020 Microsoft Corporation. All rights reserved.

C:\Users\latex >echo %username%
latex
\end{terminal}
%...
\end{document}

\documentclass{article}
\usepackage[ngerman]{babel}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage{lmodern}
\usepackage{termsim}
%...
\begin{document}
%...
\begin{terminal}[os=mac, theme=white]{none -- -bash -- 80$\times$ 40}
Last login: Mon Feb 14 21:55:17 on ttys000
my-MacBook:~ none$ ls
\end{terminal}
%...
\end{document}

\documentclass{article}
\usepackage[ngerman]{babel}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage{lmodern}
\usepackage{termsim}
%...
\begin{document}
%...
\begin{terminal}[os=ubuntu]{user@ubuntu: \textasciitilde }
user@ubuntu:~$ ls 
\end{terminal}
%...
\end{document}

Wenn die Kommentarfunktion der terminal* Variante genutzt werden soll, ohne das Optionen der Umgebung gesetzt werden, müssen dennoch die entsprechenden Klammern ([]) gesetzt werden, da andernfalls der Inhalt des Kommentarfeldes als Option interpretiert wird.

\begin{terminal*}[][das ist ein Kommentar]{Titel des Terminals}
%...
\end{terminal*}

\documentclass{article}
\usepackage[ngerman]{babel}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage{lmodern}
\usepackage{termsim}
%...
\begin{document}
%...
\begin{terminal*}[][Das ist ein Kommentar]{Command Prompt}
Microsoft Windows [Version 10.0.19041.867]
(c) 2020 Microsoft Corporation. All rights reserved.

C:\Users\latex >echo %username%
latex
\end{terminal*}
%...
\end{document}

Beispiel Windows Terminal mit einem zusätzlichen Kommentar

2.1 Optionen der terminal / terminal* Umgebungen

Die Optionen zur Zeit stehen sieben Optionen zur Verfügung, können direkt bei der Umgebung selbst gesetzt werden oder über den Befehl \termset{Option1,...,OptionN}. Die Optionen werden über das Key = Value Prinzip gesetzt.

os Mit der Option os wird das Betriebssystem ausgesucht, dabei hat man die Auswahl zwischen win10, mac und ubuntu, wobei win10 der Standardwert ist.
theme Die Hintergrundfarbe des Terminals lässt sich über die Option theme verändern. Zur Verfügung stehen dabei dark, light und white, wobei erwähnt werden muss, dass es beim Betriebssystem win10 keinen Unterschied zwischen der Option light und white gibt. Der Standardwert ist dark.
commentf Mit commentf kann die Ausgabe der Schrift des Kommentars am Ende des Terminals geändert werden. Dazu stehen die typischen Schriftgrößenbefehle (\tiny ... \Huge) und Schriftfamilien (\rmfamily, \sffamily und \ttfamily) zur Verfügung. Die Standardeinstellung ist dabei \small\sffamily also klein und serifenfrei.
minted Die Option minted hat hier die zwei möglichen Werte true und false. Im Fall das der Wert gleich true ist wird das minted Paket für die Darstellung des Codes verwendet. Im Fall, dass der Wert gleich false ist wird das listings Paket für die Darstellung des Codes verwendet. Die Standardeinstellung ist dabei true. Die nachfolgenden Optionen können nur dann verwendet werden, wenn die Option minted=true gesetzt wurde beziehungsweise die Standardeinstellung beibehalten wurde.
shstyle Mit dieser Option kann der Stil des Codes (Syntax Highlighting etc.) festgelegt werden. Eine Übersicht über die Möglichkeiten erhält man unter Linux mit
shsize Über die Option shsize lässt sich die Schriftgröße der Codes im Terminal über Schriftgrößenbefehle festlegen. Die Standardgröße ist \small.
shstrech Mit der Option shstrech kann der baselinestretch Faktor verändert werden. Der Standardwert ist 1.0.

2. termfile und termfile*

Alternativ zu den Umgebungen terminal beziehungsweise terminal* können die Befehl \termfile beziehungsweise \termfile* verwendet werden. Der Aufbau der Befehle ist dabei, abgesehen von der externen Datei, die eingebunden wird, analog zu dem Aufbau der Umgebungen.

\termfile[Optionen]{Titel des Terminals}{Datei}

\termfile*[Optionen][Komentar]{Titel des Terminals}{Datei}

\documentclass{article}
\usepackage[ngerman]{babel}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage{lmodern}
\usepackage{termsim}
%...
\begin{document}
\termfile{Command Prompt}{windows.bat}
%...
\end{document}

\documentclass{article}
\usepackage[ngerman]{babel}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage{lmodern}
\usepackage{termsim}
%...
\begin{document}
\termfile[os=mac, theme=white]{none -- -bash -- 80$\times$ 40}{mac}
%...
\end{document}

\documentclass{article}
\usepackage[ngerman]{babel}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage{lmodern}
\usepackage{termsim}
%...
\begin{document}
\termfile[os=ubuntu]{user@ubuntu: \textasciitilde }{ubuntu}
%...
\end{document}

3. termset

Mit dem Befehl \termset{Option1,...,OptionN} können die Optionen, für alle nachfolgenden Terminals, ebenfalls gesetzt werden. Das funktioniert sowohl für die terminal Umgebung als auch für den termfile Befehl.

\documentclass{article}
\usepackage[ngerman]{babel}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage{lmodern}
\usepackage{termsim}
%...
\begin{document}
%...
\termset{os=mac}
\termfile{Command Prompt}{windows.bat}
%...
\end{document}

Literatur