Artikel
2 Kommentare

Cheat: Beispiele als Ergänzung zu Manpages

https://xkcd.com/1168/

Man muss ja schon ein gewisses Faible für Manpages haben um so richtig mit Ihnen zurecht zu kommen. Es gibt sehr viele gute Manpages, aber auch einige miserable Exemplare. Diese Lücke schließt meiner Meinung nach cheat. Ich kann nur für mich sprechen, aber Beispiele bringen mich 10 mal weiter, als trockene Theorie. Cheat bietet eine stattliche Anzahl an Beispielen, die einfach in die bestehende Landschaft integriert werden können. Ein ‚cheat -l‘ bietet dann eine Auswahl an Befehlen, für die es Cheatsheets gibt. Mit einem ‚cheat tar‘ könnte man unter Umständen das nächste mal die Bombe entschärfen:

user@pc ~/ $ cheat tar
# To extract an uncompressed archive:
tar -xvf /path/to/foo.tar

# To create an uncompressed archive:
tar -cvf /path/to/foo.tar /path/to/foo/

# To extract a .gz archive:
tar -xzvf /path/to/foo.tgz

# To create a .gz archive:
tar -czvf /path/to/foo.tgz /path/to/foo/

# To list the content of an .gz archive:
tar -ztvf /path/to/foo.tgz

# To extract a .bz2 archive:
tar -xjvf /path/to/foo.tgz

# To create a .bz2 archive:
tar -cjvf /path/to/foo.tgz /path/to/foo/

# To list the content of an .bz2 archive:
tar -jtvf /path/to/foo.tgz

# To create a .gz archive and exclude all jpg,gif,... from the tgz
tar czvf /path/to/foo.tgz --exclude=\*.{jpg,gif,png,wmv,flv,tar.gz,zip} /path/to/foo/

Cheat installieren

Installieren lässt sich Cheat, indem man das git-Repository klont und anschließend die setup.py ausführt:

git clone https://github.com/chrisallenlane/cheat.git
cd cheat
sudo python setup.py install

Ich für meinen Teil habe das Repository geforkt und anschließend unter meinem ~/bin abgelegt. So kann ich die Cheatsheets auch mal anpassen und u.U. Pullrequests senden um meine Arbeit zu teilen. Der geneigte Archlinux User kann sich aus dem AUR bedienen.

Sonstiges

Cheat lässt sich über diverse Variablen konfigurieren. Somit lassen sich z.B. auch Rezept- oder Notizdatenbanken aufbauen (alternatives Verzeichnis mit Rezept- / Notiznamen als Dateinamen).

2 Kommentare

  1. Die Verwendung von tar scheint irgendwie immer wieder falsch dokumentiert zu sein. Mit das Parameter v (verbose) wird den Inhalt der Archive ausgegeben. Beim extrahieren ist dies nicht unbedingt wünchenswert. Sollte ein Fehler auftreten wird die Meldung optimal in der Ausgabe versteckt.

  2. Ein sehr interessanter Ansatz. Du bist auf jeden Fall nicht der einzige, der lieber ein knappes Beispiel als drei Seiten formale Syntaxbeschreibung liest. Schön wäre es aber, wenn man das irgendwie in die normalen Manpages integrieren könnte…

Schreibe einen Kommentar

Pflichtfelder sind mit * markiert.