[[Vorlage(Getestet, general)]] {{{#!vorlage Wissen [:Terminal: Ein Terminal öffnen] [:Pakete_installieren: Installation von Programmen] }}} [[Inhaltsverzeichnis()]] [[Bild(Wiki/Icons/terminal.png, 48, align=left)]] Sucht man Hilfe zur Funktion und den Optionen eines bestimmten Befehls oder Programms, so kann man sich im Terminal [1] umfangreiche Hilfedateien anzeigen lassen: Die sogenannten [wikipedia:Manpage:Manpages]. "man" steht für Manual (Anleitung). Diese Anleitungen haben unter Linux/Unix eine lange Tradition und werden ständig gepflegt. Wer gerade nicht am eigenen Rechner sitzt, kann Manpages auch [#Manpages-uebers-Internet-lesen online] im Browser nachschlagen. = Installation = Das Programm '''man''' ist normalerweise in der Standardinstallation enthalten, kann aber ansonsten über das Paket * '''man-db''' installiert werden [2]. Die Handbuchseiten von neuen Programmen werden automatisch durch die Paketverwaltung in '''/usr/share/man/''' gespeichert. Dort finden sich alle Manpages in Sprachen und Themen sortiert. = Funktion = Die Syntax des Aufrufs lautet: {{{#!vorlage Befehl man [OPTION] THEMA }}} oder praktisch: {{{#!vorlage Befehl man name_des_programms }}} Beendet wird die Anzeige der Manpage mit der Taste [[Vorlage(Tasten, q)]] (quit). == Umfang == Es gibt Manpages für folgende Bereiche: * Konsolenprogramme (z.B. ``ln``) * Geräte (z.B. ``hd``) * Dateiformate und Protokolle (z.B. ``nfs``) * Konventionen und Standards (z.B. ``ascii``) * Kommandos zur Systemadministration * Anwendungsprogramme (z.B. ``gedit`` oder ``firefox``) == Sprache == Die Manpages liegen in der Regel in englischer Sprache vor. Wer sie auf deutsch bevorzugt, sollte sich das Paket {{{#!vorlage Paketinstallation manpages-de, universe }}} installieren [3]. Auch ohne obiges Paket werden teilweise deutsche Manpages installiert, die bei entsprechend gesetzter LANG-Umgebungsvariable auch standardmäßig angezeigt werden. Leider sind die Übersetzungen nicht immer auf dem aktuellsten Stand. Möchte man daher immer die englische Version betrachten, so ist das mittels des folgenden Aufrufs möglich: {{{#!vorlage Befehl man -L en_US.utf8 manpage-name }}} Möchte man die Einstellung dauerhaft übernehmen, so bietet es sich an, in einer der Dateien '''~/.bashrc''' oder '''~/.bash_aliases''' ein Alias hinzuzufügen. Dazu fügt man folgende Zeile an die Datei an: {{{#!code bash alias man="man -L en_US.utf8" }}} == man-Optionen == ||<-4 rowclass="titel">Die Optionen|| ||Option||Bedeutung|| ||`-k Schlüsselwort`||zur Suche von Manual-Seiten mit einem bestimmten Schlüsselwort|| ||`-f Thema`||Kurzinfo zum gewählten Thema|| ||`-t > ausgabe.ps`||Erzeugt ein schön formatiertes Postscript-Dokument des Themas|| == man-Themenbereich == In Unix- und Linux-Literatur oder auch in den Manpages selbst ist häufig eine man-Nummer hinter dem Kommando angegeben, z.B. less'''(1)''', damit der man-Text zielgenau aufgerufen werden kann. Es gibt die Themenbereiche 1 bis 9 und n. * (1) Benutzerkommandos * (2) Systemaufruf * (3) Funktionen der Programmiersprache C * (4) Dateiformate * (5) Konfigurationsdateien * (6) Spiele * (7) Diverses * (8) Kommandos zur Systemadministration * (9) Kernelfunktionen * (n) Neue Kommandos Die Eingabe für den Aufruf von less mit dem Thema (1) sieht so aus: {{{#!vorlage Befehl man 1 less }}} == man-Tastenkürzel == {{{#!vorlage Tabelle <-4 rowclass="titel">Die Tastenkürzel +++ Taste Bedeutung Taste Bedeutung +++ [[Vorlage(Tasten, hoch)]] oder [[Vorlage(Tasten, y)]] im Text nach oben scrollen [[Vorlage(Tasten, runter)]] oder [[Vorlage(Tasten, e)]] im Text nach unten scrollen +++ [[Vorlage(Tasten, links)]] im Text nach links scrollen [[Vorlage(Tasten, rechts)]] im Text nach rechts scrollen +++ [[Vorlage(Tasten, bild-auf)]] oder [[Vorlage(Tasten, u)]] oder [[Vorlage(Tasten, b)]] im Text seitenweise nach oben scrollen [[Vorlage(Tasten, bild-ab)]] oder [[Vorlage(Tasten, d)]] oder [[Vorlage(Tasten, f)]] im Text seitenweise nach unten scrollen +++ [[Vorlage(Tasten, g)]] zum Textanfang springen [[Vorlage(Tasten, shift+g)]] zum Textende springen +++ [[Vorlage(Tasten, shift+7)]] in den Suchmodus "Vorwärtssuche" [[Vorlage(Tasten, shift+sz)]] in den Suchmodus "Rückwärtssuche" +++ [[Vorlage(Tasten, n)]] zum nächsten Suchresultat springen [[Vorlage(Tasten, shift+n)]] zum vorherigen Suchresultat springen +++ [[Vorlage(Tasten, h)]] Hilfetext mit vielen zusätzlichen Tasten und Optionen [[Vorlage(Tasten, q)]] Beenden }}} == Farbige Textanzeige == Unter Ubuntu wird standardmäßig [:less:] als [wikipedia_en:Terminal pager:Terminal Pager] für die Anzeige einer Manpage verwendet. Möchte man für mehr Übersichtlichkeit einige Schlüsselworte im Text farblich hervorheben lassen, dann kann man stattdessen [https://www.jedsoft.org/most/ most] {en} dafür verwenden. Der unterstützt sozusagen eine [wikipedia:Syntaxhervorhebung:] für Manpages. Das gleichnamige Paket muss installiert sein: {{{#!vorlage Paketinstallation most, universe }}} Und der Pager danach als Standard im [:Alternativen-System:] einrichten werden: {{{#!vorlage befehl sudo update-alternatives --config pager }}} = Falsch installierte Manpages lesen = Manchmal gibt es Situationen, in denen man Manpages nicht mit dem `man`-Befehl lesen kann, da sie zum Beispiel nicht in den richtigen Ordnern liegen. Dann kann man sie mit folgendem Befehl lesen: {{{#!vorlage Befehl man -l /Pfad/Zur/Manpage }}} Den Pfad zur Manpage (u.a.) erhält man mit dem Befehl [man:whereis:]: {{{#!vorlage Befehl whereis name_des_programms }}} = Anzeige mittels grafischer Programme = Unter GNOME gibt es mit gnome-help - auch yelp genannt - ein grafisches Frontend zum Darstellen der Hilfetexte. Der Aufruf erfolgt durch {{{#!vorlage Befehl gnome-help man:SEITENNAME }}} oder {{{#!vorlage Befehl yelp man:SEITENNAME }}} Ist die Benutzeroberfläche [:KDE:] auf dem System installiert, kann man auch dessen Universalbetrachter [:Konqueror:] zum Anzeigen von man- und [:info:]-Seiten verwenden. Dazu gibt man in die Adresszeile eine der vier folgenden Aufruf-Varianten ein: {{{#!vorlage Befehl man:/pfad-zu-der-man-page-Datei/man-page-Dateiname man:SEITENNAME #SEITENNAME info:SEITENNAME }}} Konqueror liefert eine besser lesbare Ausgabe, da es sich nicht strikt an die in den Manpages vorgegebene 80-Zeichen-pro-Zeile-Begrenzung hält, sondern die Absatzbreiten so formatiert, dass die volle Fensterbreite ausgenutzt wird. Für den [:Firefox:] gilt etwa der gleiche Befehl, nämlich {{{ man:SEITENNAME }}} als URL einzugeben. Zunächst erscheint ein Dialog mit der Frage, ob die entsprechende Anwendung gestartet werden soll. Bestätigt man diese (über eine Checkbox kann festgelegt werden, dass zukünftig die Anwendung immer gestartet werden soll), startet Firefox dann das grafische Werkzeug '''gnome-help'''. ##Möchte man jedoch mit Firefox, IceCat oder [:Opera:] genauso wie mit Konqueror die Manpages direkt im Browser lesen, findet man hier ein leicht zu installierendes Skript, mit dem dies ermöglicht wird: [:Skripte/Manpages_im_Browser_lesen:Manpages im Browser lesen]. == Manpages übers Internet lesen == Die Manpages für alle unterstützen Ubuntu-Versionen findet man im tagesaktuellen [ubuntusub:manpages:Ubuntu Manpage Repository] {en}. Das ermöglicht es auch, nicht installierte Manpages anzuschauen. Um bequem auf diese Seiten zuzugreifen, gibt es verschiedene Möglichkeiten: * Für die Suchleiste des Browsers kann man über die Seite [ubuntusub:manpages:Ubuntu Manpage Repository] {en} eine Suchmaschine installieren. * Man kann diese Manpages auch über die Kommandozeile lesen. Dazu installiert man das Paket {{{#!vorlage Paketinstallation bikeshed, universe }}} Dann kann man folgenden Befehl verwenden: {{{#!vorlage Befehl dman SEITENNAME }}} = Export von Manpages = == Generierung von PS-Dateien zum Drucken == Mit dem Befehl {{{#!vorlage Befehl man -Tps SEITENNAME > datei.ps }}} kann man eine PS-Datei generieren, die man zum Drucken verwenden kann. == Generierung von durchsuchbaren PDF-Dateien == Mit dem Befehl {{{#!vorlage Befehl man -t bash | ps2pdf - > bash.pdf }}} kann man eine PDF-Datei generieren, die man auch durchsuchen kann. #http://en.kioskea.net/faq/5339-convert-a-man-page-into-pdf = Weiterführende Themen = * Um Manpages auf Webservern bereitzustellen, dient das Paket '''man2html''' (''universe''). Möchte man die gesamte Breite der mitgelieferten [:Dokumentation:] nutzen: [:dwww:]. * Eine weitere Möglichkeit, Manpages im Web bereitzustellen, ist das [launchpad:ubuntu-manpage-repository:Ubuntu Manpage Repository] {en} (Code), welches beim [ubuntusub:manpages:Ubuntu Manpage Repository] Anwendung findet. Es stellt die Manpages für eine vollständige Distribution als formatierte und Google-indizierte Webseiten bereit. * Eine [:man/Manpage_erstellen:Manpage erstellen] ist auch nicht schwer. * [:info:] ist eine komfortable Alternative zu man * [:tldr:]-Seiten sind mehrsprachig, fassen Wichtiges zu einem Shell-Befehl zusammen und liefern Beispiele = Links = * [ubuntusub:manpages:Ubuntu Manpage Repository] {en} - in verschiedenen Sprachen, aber leider keine Sprachauswahl * [debian::] [https://manpages.debian.org Debian Man Page Lookup] {en} - Sprachauswahl vorhanden, auch verschiedene Ausgabeformate möglich * [:Shell/Befehlsübersicht:] {Übersicht} Übersicht über verschiedene Shell-Befehle # tag: Shell