Konventionen

Auf dieser Webseite sammle ich meine Erkenntnisse beim Umgang mit Computern, in der Hoffnung, dass diese Aufzeichnungen sowohl für mein zukünftiges Selbst als auch für andere nützlich sind. Ich schreibe für den verständigen Leser, der in der Lage ist, sich selbst ein Urteil zu bilden und die Auswirkungen seines Handelns abzuschätzen – und nicht für Menschen, die blindlings Anleitungen befolgen wollen. Obwohl ich mich bemühe, nur funktionierende Beispiele aus dem Praxiseinsatz zu dokumentieren, erhebe ich keinen Anspruch auf Korrektheit. Wenn Dein Server in Flammen aufgeht, gib nicht mir die Schuld! Ich feue mich jedoch über Vorschläge zur Verbesserung.

Fließtext

Im laufenden Text gelten folgende typographischen Konventionen:

Kursiv
Neu eingeführter Begriff, Datei- oder Pfadname
Ctrl+C
Tastenkombination
Magenta
Verweis auf Fragment innerhalb der Seite
Blau
Interner Link auf ein anderes Kapitel
Unterstrichen
Externer Link mit verschlüsselter Verbindung
Unterringelt
Externer Link mit unverschlüsselter Verbindung

Quelltext

Zur Demonstration von Quellcode, Konfigurationsdateien und Interaktion mit dem Terminal wird Schrift mit konstanter Breite verwendet.

Konstante Breite
Ausgabe im Terminal
command
Eingabe im Terminal als Benutzer
command
Eingabe im Terminal als Administrator
command
Eingabe im Terminal einer virtuellen Maschine
Variable
Abstrakter Platzhalter für individuell anzupassende Angaben
name=value
Exemplarischer Platzhalter für individuell anzupassende Angaben
$name
Verweis auf Platzhalter

Syntax

Um die Syntax von optionalen Argumente und Listen von Kommandos darzustellen, verwende ich die Wirth Syntax Notation. Ob die Klammern nun Teil einer Notation oder Teil des Codes sind, ergibt sich oft nur aus dem Kontext, hier ist die Intuition des Lesers gefragt.

[…]
Eckige Klammern für Optionen (0 oder 1)
{…}
Geschweifte Klammern für Listen (0 oder mehr)
(…)
Runde Klammern für die Gruppierung von Elementen

Diagramme

Zusammenhänge diverser Komponenten von komplexeren Software-Systemen veranschauliche ich gerne mit einer freizügigen Variante von Datenflussdiagrammen. Pfeile zeigen dabei immer die Richtung der Nutzdaten an. Außerdem verwende ich Piktogramme für verschiede Arten von Datenquellen und -senken.