tldr

Was sind tldr-pages?

Das tldr-pages -Projekt ist eine Sammlung von von der Community gepflegten Hilfeseiten für Befehlszeilentools, die eine einfachere und zugänglichere Ergänzung zu herkömmlichen Manpages darstellen soll.

Vielleicht sind Sie neu in der Welt der Befehlszeilen. Vielleicht sind Sie nur ein wenig eingerostet oder können sich nicht immer an die Argumente für Befehle wie lsof oder tar erinnern?

Es hilft sicherlich nicht, dass in der Vergangenheit die erste Option, die in man tar erklärt wurde, so lautete:

$ man tar
...
-b blocksize
   Specify the block size, in 512-byte records, for tape drive I/O.
   As a rule, this argument is only needed when reading from or writing to tape drives,
   and usually not even then as the default block size of 20 records (10240 bytes) is very common.
...

Es gibt Platz für einfachere Hilfeseiten, die sich auf praktische Beispiele konzentrieren. Wie wäre es mit:

Dieses Repository ist genau das: eine ständig wachsende Sammlung von Beispielen für die gängigsten UNIX-, Linux-, macOS-, FreeBSD-, NetBSD-, OpenBSD-, SunOS-, Android- und Windows-Befehlszeilentools.

Wie verwende ich es?

Tipp

Informationen zum Surfen ohne Installation eines Clients auf Ihrem Computer finden Sie im Webclient unter https://tldr.inbrowser.app (mit Offline-Unterstützung über PWA).

Eine beliebte und bequeme Möglichkeit, auf Ihrem Computer auf diese Seiten zuzugreifen, ist die Installation des offiziellen Node.js-Clients:

npm install -g tldr

Alternativ können Sie auch den offiziellen Python-Client verwenden, der über pip3 (oder andere Paketmanager) installiert werden kann:

pip3 install tldr

Linux- und Mac-Benutzer können den offiziellen Rust-Client auch mit Homebrew (oder anderen Paketmanagern auf anderen Betriebssystemen) installieren:

brew install tlrc

Dann haben Sie direkten Zugriff auf eine vereinfachte, leicht lesbare Hilfe für Befehle wie tar , auf die Sie zugreifen können, indem Sie tldr tar anstelle des standardmäßigen man tar eingeben.

Wenn Sie keine Software installieren möchten, schauen Sie sich stattdessen die PDF-Version an.

Notiz

Für die meisten Sprachen sind PDFs für Übersetzungen verfügbar. Sie finden sie in den Release-Assets der neuesten Version.

Es gibt auch verschiedene andere Clients , die von der Community bereitgestellt werden, sowohl für die Befehlszeile als auch für andere Plattformen. Eine umfassende Kundenliste finden Sie in unserem Wiki.

Wie trage ich zu tldr-Seiten bei?

Alle Beiträge sind willkommen!

Zu den Möglichkeiten, einen Beitrag zu leisten, gehören:

• Fügen Sie Ihren bevorzugten Befehl hinzu, der nicht behandelt wird.
• Beispiele hinzufügen oder den Inhalt einer vorhandenen Seite verbessern.
• Hinzufügen angeforderter Seiten aus unseren Ausgaben mit dem Label „Hilfe gesucht“.
• Seiten in verschiedene Sprachen übersetzen.

Alle tldr -Seiten sind in Markdown geschrieben, sodass sie ganz einfach bearbeitet werden können und Änderungen hier in Pull-Requests über Git in der Befehlszeile oder über die GitHub-Weboberfläche übermittelt werden können.

Wir sind bestrebt, eine einladende und kooperative Gemeinschaft aufrechtzuerhalten. Wenn Sie zum ersten Mal einen Beitrag leisten, werfen Sie einen Blick auf die Beitragsrichtlinien und legen Sie los!

Wenn Sie zu Übersetzungen beitragen möchten, können Sie https://lukwebsforge.github.io/tldri18n/ besuchen, um den Gesamtfortschritt aller Übersetzungen zu sehen und zu sehen, welche Übersetzungen fehlen oder veraltet sind.

Sie sind auch herzlich willkommen, uns im Matrix-Chatroom zu besuchen!

Ähnliche Projekte

• Mit Command Line Interface Pages können Sie standardisierte Hilfeseiten für CLI, Verzeichnisse und Konfigurationen schreiben.

• Mit Cheat können Sie interaktive Cheatsheets in der Befehlszeile erstellen und anzeigen. Es wurde entwickelt, um Unix-Systemadministratoren an Optionen für Befehle zu erinnern, die sie häufig verwenden, sich aber nicht oft genug merken können.

• cheat.sh fasst Spickzettel aus mehreren Quellen (einschließlich tldr-Seiten) in einer einheitlichen Oberfläche zusammen.

• Devhints Ricos Cheatsheets konzentrieren sich nicht nur auf die Befehlszeile und enthalten eine Vielzahl anderer Cheatsheets zum Thema Programmierung.

• Bietet beispielsweise detaillierte Beispiele mit Erklärungen auf der Befehlszeile. Beispiele stammen aus dem Repository, unterstützen aber eg die Anzeige benutzerdefinierter Beispiele und Befehle neben den Standardeinstellungen.

• kb ist ein minimalistischer Befehlszeilen-Wissensdatenbankmanager. Mit kb können Sie Ihre Notizen und Spickzettel auf minimalistische und saubere Weise organisieren. Es unterstützt auch Nicht-Textdateien.

• Navi ist ein interaktives Cheatsheet-Tool, mit dem Sie im Handumdrehen bestimmte Beispiele durchsuchen oder Befehle ausführen können.

• Bropages (veraltet) sind eine gut lesbare Ergänzung zu Manpages. Es zeigt prägnante, häufig vorkommende Beispiele für Unix-Befehle. Die Beispiele werden von der Benutzerbasis eingereicht und können nach oben oder unten bewertet werden; Die besten Einträge sind die, die die Leute zuerst sehen, wenn sie einen Befehl nachschlagen.

Was bedeutet „tldr“?

TL;DR steht für „Too Long; Didn't Read“. Es entstand als Internet-Slang, wo es verwendet wird, um anzuzeigen, dass ein langer Text (oder Teile davon) als zu lang übersprungen wurde. Lesen Sie mehr im Artikel von How-To Geek.