Revise cat documentation

docs/book/book.toml

@@ -11,5 +11,8 @@ create-missing = false
 [rust]
 edition = "2021"
 
+[output.html]
+additional-css = ["custom.css"]
+
 [output.html.search]
 limit-results = 15

docs/book/custom.css

@@ -0,0 +1,19 @@
+body {
+  font-family: arial, sans-serif;
+}
+
+main h1, h2 {
+  border-bottom: 1px solid #d8dee4;
+}
+
+main h1 {
+  text-transform: uppercase;
+}
+
+main h2, h3 {
+  margin-top: 1em;
+}
+
+.content ul li {
+  padding: 5px 0px;
+}

docs/book/src/SUMMARY.md

@@ -6,3 +6,5 @@
     - [Installation](./anleitungen/installation.md)
 
 - [Referenz](./referenz/index.md)
+    - [Kommandos](./referenz/kommandos/index.md)
+        - [cat](./referenz/kommandos/cat.md)

docs/book/src/referenz/kommandos/cat.md

@@ -0,0 +1,154 @@
+# `cat`
+
+Das `cat` Kommando liest Datensätze direkt von der Standardeingabe
+(`stdin`) oder aus Dateien ein und fügt diese zusammen. Die Ausgabe
+kann entweder in eine Datei oder in die Standardausgabe (`stdout`)
+geschrieben werden.
+
+## Beschreibung
+
+Der wichtigste Anwendungsfall des Kommandos besteht in Kombination mit
+den Kommandos [_partition_] oder [_split_], da mittels `cat` das
+Ergebnis von [_partition_] oder [_split_] (teil-)rückgängig gemacht
+werden kann. Häufig macht es Sinn, eine große Datei in viele kleinere
+Dateien anhand eines Kriteriums zu teilen und anschließend eine
+Teilmenge wieder zusammenzufügen.
+
+Das folgende Beispiel fügt die zwei Partitionen `ger.dat` und `eng.dat`
+zu einer Datei zusammen:
+
+```bash
+$ pica cat ger.dat eng.dat -o ger_eng.dat
+```
+
+## Optionen
+
+* `-s`, `--skip-invalid` — überspringt jene Zeilen aus der Eingabe, die nicht
+  dekodiert werden konnten.
+* `-u`, `--unique` — es werden keine Duplikate in die Ausgabe
+  geschrieben. Die Strategie zur Erkennung von Duplikaten wird mittels
+  der Option `--unique-strategy` festgelegt.
+* `--unique-strategy <strategy>` — festlegen, dass ein Duplikat erkannt
+  werden soll. Standardmäßig ist der Wert `idn` gesetzt und es werden
+  Duplikate durch Vergleichen der PPN/IDN (erster Wert im Feld `[email protected]`)
+  eines Datensatzes erkannt. Alternativ kann über die Strategie `hash`
+  gewählt werden. Der Vergleich erfolgt dann über die SHA-256 Prüfsumme
+  des Datensatzes.
+* `--append` — Wenn die Ausgabedatei bereits existiert, wird die
+  Ausgabe an die Datei angehangen. Ist das Flag nicht gesetzt wird eine
+  bestehende Datei standardmäßig überschrieben.
+* `--tee <filename>` — abzweigen der Ausgabe in eine zusätzlich Datei.
+* `-g`, `--gzip` — komprimieren der Ausgabe im
+  [gzip](https://de.wikipedia.org/wiki/Gzip)-Format.
+* `-o`, `--output` — Angabe, in welche Datei die Ausgabe geschrieben
+  werden soll. Standardmäßig wird Ausgabe in die Standardausgabe
+  `stdout` geschrieben. Endet der Dateiname mit dem Suffix `.gz`, wird
+  die Ausgabe automatisch im gzip-Format komprimiert.
+
+
+
+## Beispiele
+
+
+### Überspringen ungültiger Datensätze
+
+Der Eingangs verwendete Befehl geht davon aus, dass die zwei Partition
+ausschließlich gültige Datensätze enthalten. Gültig in diesem
+Zusammenhang bedeutet, dass es sich um valide Datensätze im Format PICA+
+handelt und nicht ob ein Datensatz einem bestimmten Regelwerk
+entspricht.
+
+Das Ausschließen von ungültigen Datensätzen wird mit der Option
+`--skip-invalid` oder `-s` erreicht:
+
+```bash
+$ pica cat --skip-invalid DUMP.dat.gz -o dump_valid.dat
+$ pica cat -s DUMP.dat.gz --output dump_valid.dat.gz
+```
+
+
+### Lesen von der Standardeingabe
+
+Das Kommando kann auch direkt von der Standardeingabe (`stdin`) lesen.
+Das ist bspw. dann hilfreich, wenn die Ausgabe aus einem vorhergehenden
+Pipeline-Schritt mit dem Inhalt einer oder mehrerer Dateien konkateniert
+werden soll.
+
+Das folgende Beispiel liest im ersten Pipeline-Schritt die Datei
+`dump1.dat` ein, entfernt ungültige Datensätze und gibt die Ausgabe nach
+`stdout` aus. Der zweite Pipeline-Schritt liest diese Datensätze ein
+(`-`) und konkateniert diese mit den Datensätzen aus der Datei
+`dump2.dat`. Das Ergebnis wird in die Datei `out.dat` geschrieben.
+
+```bash
+$ pica cat -s dump1.dat | pica cat - dump2.dat -o out.dat
+```
+
+Der Dateiname `-` steht für die Standardeingabe (`stdin`). Wären die
+zwei Argumente vertauscht (`pica cat dump2.dat -`), dann würden erst die
+gültigen Datensätze aus der Datei `dump1.dat` und anschließend die
+Datensätze aus dem ersten Pipeline-Schritt geschrieben.
+
+
+### Hinzufügen von Datensätzen
+
+Wenn eine Ausgabedatei bereits existiert, wird diese standardmäßig neu
+angelegt und überschrieben. Soll das Verhalten dahingehend geändert
+werden, dass an die bestehenden Dateien angehangen wird, kann dies mit
+der `--append`-Option erreicht werden. Diese Option ändert das Verhalten
+von `--output` und `--tee`. Die Option hat auf das Verhalten beim
+Schreiben in die Standardausgabe keine Auswirkung.
+
+Im folgenden Beispiel erzeugt der erste Befehl eine neue Datei
+`gnd.dat`. Sollte die Datei bereits existieren, wird der Datei-Inhalt
+überschrieben. Die darauffolgenden Kommandos hängen jeweils an das Ende
+der Datei `gnd.dat` an.
+
+```bash
+$ pica cat Tp*.dat -o gnd.dat
+$ pica cat --append Ts*.dat -o gnd.dat
+$ pica cat --append Tu*.dat -o gnd.dat
+...
+```
+
+
+### Abzweigen der Ausgabe
+
+Gelegenlich kann es nützlich sein, die Ausgabe des `cat`-Kommandos in
+eine Datei zu schreiben und gleichzeitig die Ausgabe an einen weiteren
+Pipeline-Schritt weiterzureichen. Dies hat den Vorteil, dass zwei
+CPU-Kerne gleichzeitig genutzt werden können. Mit der `--tee`-Option
+lässt sich dieses Verhalten erzielen. Der Name der Option leitet sich
+von dem T-Stück (engl. tee connector) ab, mit dem ein Klempner eine
+Abzeigung in eine Leitung einbaut.
+
+Im folgenden Beispiel werden alle `Tp*.dat` zusammengefügt und in eine
+Datei `Tp.dat` geschrieben. Gleichzeitig werden alle Datensätze mit dem
+[_filter_]-Kommando danach gefiltert, ob die Satzart im Feld `[email protected]`
+gleich dem Wert `Tp2`[^2] ist. Das Ergebnis wird in eine zweite Datei
+`Tp2.dat` geschrieben.
+
+```bash
+$ pica cat partitions/Tp*.dat --tee gnd_person.dat | \
+      pica filter "[email protected] =^ 'Tp2'" -o Tp.dat
+```
+
+### Komprimierte Ein- und Ausgabe
+
+Das vorhergende Beispiel zeigt auch, dass das `cat`-Kommando sowohl
+unkompromierte als auch komprimierte Dateien verarbeiten kann. Endet
+eine Datei mit dem Suffix `.gz` wird die Datei automatisch dekompromiert
+(als Eingabedatei) bzw. komprimiert (als Ausgabedatei).
+
+Mittels der Option `-g`/`--gzip` erfolgt eine Komprimierung der Ausgabe
+unabhängig von der Dateiendung:
+
+```bash
+$ pica cat --gzip ger.dat eng.dat -o eng_ger_compressed.dat
+$ pica cat ger.dat eng.dat -o eng_ger.dat.gz
+```
+
+
+[_filter_]: filter.md
+[_partition_]: partition.md
+[_split_]: split.md