Was ist TLDR und erklärt, wie man es verwendet?

Benutzer der Linux-Befehlszeile müssen mit dem Befehl “man” vertraut sein. Es steht für Manual Pages, was bedeutet, dass jeder Linux-Befehl oder jedes Linux-Dienstprogramm eine Reihe von Anweisungen oder die mögliche Verwendung des Befehls enthält. Manpages sind eine große Hilfe bei der Arbeit an der Kommandozeile, aber oft ist die Dokumentation, die über manpages verfügbar ist, zu lang oder zu verwirrend, um sie zu erlernen. Es bietet auch keine Beispiele aus dem wirklichen Leben. Alles, was es enthält, sind die Details dessen, was dieser bestimmte Befehl tut, und welche Schalter verfügbar sind (auch Optionen genannt).

TLDR (Too Long Didn’t Read) ist ein von der Community betriebenes Bemühen, die standardmäßigen Linux-Manpages zu verbessern. Es bietet eine einfache Dokumentation für jeden Befehl oder jedes Dienstprogramm und demonstriert auch die Verwendung des Befehls mit ziemlich einfachen Beispielen. In diesem Artikel erfahren Sie, wie Sie TLDR installieren und wie Sie es verwenden, um auf Linux-Terminals besser zu funktionieren.

So installieren Sie TLDR auf Ubuntu- und CentOS-Systemen

Der einfachste Weg, TLDR zu installieren, ist die Verwendung von NPM und Nodejs. Also müssen wir zuerst diese beiden Komponenten auf unserem System installieren. Benutzer von Ubuntu-Systemen können NPM und Nodejs mit dem folgenden Befehl installieren.

sudo apt-get install nodejs npm

CentOS-Benutzer müssen zuerst das EPEL-Repository von Yum aktivieren. Führen Sie den folgenden Befehl aus, um das Epel-Repository zu installieren. Sobald es aktiv ist, können wir nodejs und npm mit YUM installieren.

yum install epel-release -y

Führen Sie den folgenden Befehl auf dem CentOS-System aus, um Node und NPM zu installieren.

sudo yum install nodejs npm

In Ordnung, führen Sie jetzt den folgenden Befehl auf Ihrem System aus, um den Installationsvorgang abzuschließen.

sudo npm install -g tldr

Herzlichen Glückwunsch, Sie haben Ihr Linux-System erfolgreich mit leicht verständlichen Befehlshandbüchern ausgestattet.

TLDR-Beispiele

Die Syntax, um Hilfe bei der Verwendung von TLDR zu erhalten, ist ziemlich einfach. Verwenden Sie das folgende Format.

tldr Command

Ersetzen Sie “Befehl” durch den tatsächlichen Dienstprogramm- oder Befehlsnamen, für den Sie die Dokumentation abrufen möchten.

Die Dokumentation für den Befehl “ls” sieht wie folgt aus.

# tldr ls

ls
List directory contents.

- List files one per line:
ls -1

- List all files, including hidden files:
ls -a

- Long format list (permissions, ownership, size and modification date) of all files:
ls -la

- Long format list with size displayed using human readable units (KB, MB, GB):
ls -lh

- Long format list sorted by size (descending):
ls -lS

Ist das nicht ganz einfach und anschaulich? So sieht die Dokumentation des tar-Befehls aus:

# tldr tar

tar
Archiving utility.
Optional compression with gzip / bzip.

- Create an archive from files:
tar cf target.tar file1 file2 file3

- Create a gzipped archive:
tar czf target.tar.gz file1 file2 file3

- Extract an archive in a target folder:
tar xf source.tar -C folder

- Extract a gzipped archive in the current directory:
tar xzf source.tar.gz

- Extract a bzipped archive in the current directory:
tar xjf source.tar.bz2

- Create a compressed archive, using archive suffix to determine the compression program:
tar caf target.tar.xz file1 file2 file3

Wie Sie sehen, bietet es eine sehr intuitive Möglichkeit, Informationen zu Befehlen zu suchen. Es zeigt Beispiele für die verschiedenen Verwendungen jedes Befehls, was sie sehr leicht verständlich macht.

Sie können auch alle verfügbaren Befehle im Repository auflisten, indem Sie Folgendes eingeben:

$ tldr -l

Beitragen

Wenn Sie einen Befehl nicht finden oder mehr Beispiele für einen vorhandenen Befehl haben, können Sie gerne zum Projekt beitragen!

Stellen Sie zunächst und sehr wichtig sicher, dass Sie alle diese Punkte respektieren:

Richtlinien

  1. Es ist am besten, Seiten bei etwa 5 Beispielen zu halten. Wenn es wirklich benötigt wird, können die Seiten länger sein, aber 8 Beispiele nicht überschreiten. Die Seite muss nicht alles abdecken, das ist was Mann ist für.
  2. Wenn Sie Zweifel haben, wählen Sie die sichere Methode, von der Sie wissen, dass sie immer funktioniert. Für example: Befehle, die erfordern sudo sollte es direkt in die Beispiele aufnehmen.
  3. Fügen Sie zusätzlich zu den Optionen aus einem Buchstaben auch ausgeschriebene Optionen ein. Dies gibt dem Benutzer die Möglichkeit zu verstehen, was er/sie tut.
  4. Beginnen Sie in den Beispielen mit den einfacheren Optionen und fahren Sie dann mit den komplexeren fort.
  5. Vermeiden Sie es, allgemeine UNIX-Konzepte zu erklären, sondern konzentrieren Sie sich nur auf die spezifischen Details der Befehle.

Markdown-Format

Das Format jeder Seite sollte wie folgt aussehen:

# command-name

> Short, snappy description.
> Preferably one line; two are acceptable if necessary.

- Example description:

`command -opt1 -opt2 -arg1 {{arg_value}}`

- Example description:

`command -opt1 -opt2`

Es gibt einen Formatierer, der das obige Format erzwingt. Es wird automatisch in jedem Pull-Request ausgeführt, aber Sie können es installieren, um zu sehen, wie Ihre Beiträge aussehen:

$ sudo npm install tldr-lint
$ tldrl -f {{page.md}}

Sie können weitere Verwendungen überprüfen oder tldrl durch Eingabe von:

$ tldr tldrl

Token-Syntax

Benutzen {{Zeichen}} Syntax für vom Benutzer bereitgestellte Werte, damit tldr-Clients sie hervorheben können. Mehrwort-Tokens sollten verwendet werden Schlangenhülle.

Richtlinien für die Auswahl von Tokennamen:

  1. Tokenwerte müssen kurz und beschreibend sein. Für example: {{file_route}} oder {{home/user/.bashrc}}
  2. Wenn die example Es ist klarer, einen tatsächlichen Wert zu verwenden, anstatt die Eingabevariable, den Parameternamen oder was auch immer zu schreiben, verwenden Sie den tatsächlichen Wert. Für example: Benutzen Herunterfahren -h {{5}} eher, als Herunterfahren -h {{time_in_HHmm}}
  3. Verwenden Sie für Verweise auf Pfade zu Dateien oder Ordnern das Format {{Pfad/zu/}}. Für example, ln -s {{Pfad/zu/Datei}} {{Pfad/zu/Symlink}}. Bei einem möglichen Verweis sowohl auf eine Datei als auch auf einen Ordner verwenden Sie {{Pfad/zu/Datei_oder_Ordner}}
  4. Folge dem {{Pfad/zu/}} Konvention, wenn ein pfadbezogener Befehl vorhanden ist, außer wenn der Dateispeicherort implizit ist.
  5. Wenn es einen Befehl gibt, der eine Datei mit einer bestimmten Erweiterung erwartet, zeigen Sie sie an. Beispiel: unrar x {{compressed_file.rar}}. Wenn eine generische Erweiterung benötigt wird, verwenden Sie {{.ext}}

Dies sind nur Richtlinien, keine strengen Regeln. Versuchen Sie einfach, sie zu befolgen und die Beispiele so intuitiv wie möglich zu gestalten.

Senden einer Pull-Anfrage

Sie können die von Ihnen bevorzugte Methode verwenden:

Die Weboberfläche von Github

Der einfachste Weg besteht darin, die Seite direkt über die Github-Benutzeroberfläche zu bearbeiten. Sie können einige Anweisungen über sehen Hier.

Befehlszeile

  1. Fork das Repository von der Github-Benutzeroberfläche
  2. Klonen Sie Ihren Fork auf Ihren lokalen Computer
    https://help.github.com/articles/editing-files-in-another-user-s-repository/
  3. Erstellen Sie einen Feature-Branch
    git checkout -b {{branch_name}}
  4. Nehmen Sie Ihre Änderungen vor
  5. Übernehmen Sie die Änderungen
     git commit --all -m "{{commit_message}}"</>
  6. Stoß an deine Gabel
     git push origin {{branch_name}}</>
  7. Gehen Sie zur Github-Seite für Ihren Fork und klicken Sie auf die grüne Pull-Request-Schaltfläche.

Senden Sie nur verwandte Änderungen in derselben Anfrage.

Verwenden Sie für die Commit-Nachricht diesen Befehl:

<command>: type of change

Beispiel: ls: Seite hinzufügen

Sie können sich auch auf die offizielles Repository um weitere Unterlagen zu finden.

TLDR aktualisieren

Es ist wichtig, TLDR auf dem neuesten Stand zu halten, damit Ihnen die aktuellsten Informationen zur Verfügung stehen. Es wird ständig mehr und mehr Dokumentation hinzugefügt und Sie können es mit dem folgenden Befehl aktualisieren.

tldr --update

Online verwenden (webbasiert)

Sie können die Dokumentation/Hilfe für den Linux-Befehl auch mit dem online Version. Entwickler haben eine Web-URL, die Sie verwenden können, um nach der Dokumentation oder Hilfe zu jedem Linux-Dienstprogramm/-Befehl zu suchen. Gehen Sie zur folgenden URL und geben Sie einfach Ihren gewünschten Befehls-/Dienstprogrammnamen ein und drücken Sie “Enter”, Sie erhalten eine Community-Dokumentation des gesuchten Befehls und eine hübsche Benutzeroberfläche.

Ich hoffe, Ihnen hat dieser Artikel gefallen. Wir haben den Installations- und Verwendungsprozess für den TLDR-Befehl in diesem Tutorial besprochen. Sie können auch die Online-Version dieses Dienstprogramms verwenden, um Ihre tägliche Arbeitsproduktivität auf der Linux-Befehlszeile zu verbessern. Es spart Ihnen viel Zeit und stellt Ihnen dringend benötigte Informationen auf äußerst einfache und detaillierte Weise zur Verfügung. Versuchen Sie es noch heute! Teilen Sie uns im Kommentarbereich Ihre Erfahrungen mit diesem Dienstprogramm mit.