Wie extrahieren Sie alle Befehlszusammenfassungen korrekt aus den Manpages in /usr/share/man/man1?

Question 1

~~Man kann nicht einfach weglaufenman foo.gz~~Es sieht aus wie dudürfenlaufen man foo.1.gz, aber die Verwendung -lscheint sauberer zu sein. Von man man:

   -l, --local-file
          Activate `local' mode.  Format and display  local  manual  files
          instead  of  searching  through  the system's manual collection.
          Each manual page argument will be interpreted as an nroff source
          file in the correct format.  No cat file is produced.  If '-' is
          listed as one of the arguments, input will be taken from  stdin.
          When  this  option  is  not used, and man fails to find the page
          required, before displaying the error message,  it  attempts  to
          act as if this option was supplied, using the name as a filename
          and looking for an exact match.

Ihr Skript sollte also etwa so aussehen:

#!/usr/bin/env bash
## synopses - extract all synopses in /usr/share/man/man1

## No need to cd into the directory, you can just use globs     
for i in /usr/share/man/man1/ajc*.gz; do
    ## This will print the name of the command.      
    basename "${i//.1.gz}"
    man -l "$i"  | 
       awk '/^SYNOPSIS/{a=1; getline}
            (/^[a-zA-z0-9_]/ && a==1){a=0} 
            (a==1 && /./){print}' | tr -s [:space:]

done

Der awkvon mir angegebene Befehl funktioniert besser als Ihr Ansatz (testen Sie ihn man ajcbeispielsweise an) und funktioniert jetzt auch bei mehrzeiligen Zusammenfassungen. Die meisten der angezeigten Fehler sind irrelevant, andere waren auf die Art und Weise zurückzuführen, wie Sie mit Dateinamen umgegangen sind. Lassen Sie mich wissen, ob dieser besser funktioniert.

Answer

~~Man kann nicht einfach weglaufenman foo.gz~~Es sieht aus wie dudürfenlaufen man foo.1.gz, aber die Verwendung -lscheint sauberer zu sein. Von man man:

   -l, --local-file
          Activate `local' mode.  Format and display  local  manual  files
          instead  of  searching  through  the system's manual collection.
          Each manual page argument will be interpreted as an nroff source
          file in the correct format.  No cat file is produced.  If '-' is
          listed as one of the arguments, input will be taken from  stdin.
          When  this  option  is  not used, and man fails to find the page
          required, before displaying the error message,  it  attempts  to
          act as if this option was supplied, using the name as a filename
          and looking for an exact match.

Ihr Skript sollte also etwa so aussehen:

#!/usr/bin/env bash
## synopses - extract all synopses in /usr/share/man/man1

## No need to cd into the directory, you can just use globs     
for i in /usr/share/man/man1/ajc*.gz; do
    ## This will print the name of the command.      
    basename "${i//.1.gz}"
    man -l "$i"  | 
       awk '/^SYNOPSIS/{a=1; getline}
            (/^[a-zA-z0-9_]/ && a==1){a=0} 
            (a==1 && /./){print}' | tr -s [:space:]

done

Der awkvon mir angegebene Befehl funktioniert besser als Ihr Ansatz (testen Sie ihn man ajcbeispielsweise an) und funktioniert jetzt auch bei mehrzeiligen Zusammenfassungen. Die meisten der angezeigten Fehler sind irrelevant, andere waren auf die Art und Weise zurückzuführen, wie Sie mit Dateinamen umgegangen sind. Lassen Sie mich wissen, ob dieser besser funktioniert.

Question 2

Die aufgetretenen Fehler werden alle hier behandelt:

man man

MANWIDTH- Wenn $MANWIDTHgesetzt ist, wird sein Wert als Zeilenlänge verwendet, für die Handbuchseiten formatiert werden sollen. Wenn es nicht gesetzt ist, werden Handbuchseiten mit einer Zeilenlänge formatiert, die dem aktuellen Terminal entspricht (mit ioctl(2), falls verfügbar, dem Wert von $COLUMNSoder mit 80 Zeichen, falls keines von beiden verfügbar ist). Handbuchseiten werden nur gespeichert, wenn die Standardformatierung verwendet werden kann, d. h. wenn die Zeilenlänge des Terminals zwischen 66 und 80 Zeichen liegt.

MAN_KEEP_FORMATTING- Wenn die Ausgabe nicht an ein Terminal geleitet wird (z. B. an eine Datei oder eine Pipe), werden Formatierungszeichen normalerweise verworfen, um das Lesen des Ergebnisses ohne Spezialwerkzeuge zu erleichtern. Wenn jedoch $MAN_KEEP_FORMATTINGauf einen beliebigen nicht leeren Wert gesetzt ist, werden diese Formatierungszeichen beibehalten. Dies kann für Wrapper um man nützlich sein, die Formatierungszeichen interpretieren können.

MAN_KEEP_STDERR- Wenn die Ausgabe an ein Terminal (normalerweise an einen Pager) geleitet wird, wird normalerweise jede Fehlerausgabe des Befehls, der zum Erstellen formatierter Versionen von Handbuchseiten verwendet wird, verworfen, um Störungen der Anzeige des Pagers zu vermeiden. Programme wie grofferzeugen oft relativ geringfügige Fehlermeldungen über typografische Probleme wie schlechte Ausrichtung, die unansehnlich und im Allgemeinen verwirrend sind, wenn sie zusammen mit der Handbuchseite angezeigt werden. Einige Benutzer möchten sie jedoch trotzdem sehen, daher $MAN_KEEP_STDERRwird die Fehlerausgabe wie üblich angezeigt, wenn auf einen beliebigen nicht leeren Wert gesetzt ist.

Und nun dazu, wie Sie das andere tun könnten:

Ich denke, das hier macht, was Sie wollen:

for f in /usr/share/man/man1/*gz ; do
    man -P "sed -ne '1,/^[Nn]/d;/^ /{H;b}
    /^[Ss]..[Yy]..[Nn]/{g;:n
    N;/\n\(\n\)[^ ].*/!bn;s//\1/
    s/.\x08//g;s/\(\n\)  */\1/g;
    w /dev/stderr' -ne '};/./q'" -l "$f"
done 2>~/file

Es gibt an, dass es sedsich um die Zeile handelt PAGER, und gibt dann nur die folgende Zeile ausNAMEund die folgendenZUSAMMENFASSUNGbis es auf eine andere Zeile trifft, die mit etwas anderem als a beginnt <space>. Es drucktNichtswenn die erste Zeile, die nicht damit beginnt, <space>folgtNAMEstimmt nicht mit begin überein [Ss][Yy][Nn]. In jedem Fall wird das Lesen der Datei in der zweiten Zeile beendet, die nachNAMEdas nicht mit beginnt <space>. Es löscht führende <spaces>und alle \bAckslashs aus der Ausgabe.

Ich habe es forgerade in einer Schleife ausgeführt und es hat manin nur einer Minute meine gesamte Bibliothek durchlaufen.

manpasst seine Ausgabe an, je nachdem, ob es in ein Terminal oder eine Pipe/Datei schreibt. Wenn Sie ihm also sagen, dass er das tun soll, verzichtet er ganz auf den PAGER. Das war unerwartet. Aber ich habe es ausgetrickst und die wRite-Funktion von sed verwendet, um in >&2 zu schreiben und das umzuleiten, also hat es nichts gemerkt.

Eine Anmerkung jedoch: Es ist vielleicht die bessere Vorgehensweise von @terdon. Sie können dies zwar einfacher anpassen, da Sie eine sedpro Datei erhalten, und die Formatierung ist etwas besser, da sie nicht versucht, auf die Breite eines Terminals zu passen, diese \Backslashes werden anscheinend jedoch mannicht in ein geschrieben |pipe.

Answer

Die aufgetretenen Fehler werden alle hier behandelt:

man man

MANWIDTH- Wenn $MANWIDTHgesetzt ist, wird sein Wert als Zeilenlänge verwendet, für die Handbuchseiten formatiert werden sollen. Wenn es nicht gesetzt ist, werden Handbuchseiten mit einer Zeilenlänge formatiert, die dem aktuellen Terminal entspricht (mit ioctl(2), falls verfügbar, dem Wert von $COLUMNSoder mit 80 Zeichen, falls keines von beiden verfügbar ist). Handbuchseiten werden nur gespeichert, wenn die Standardformatierung verwendet werden kann, d. h. wenn die Zeilenlänge des Terminals zwischen 66 und 80 Zeichen liegt.

MAN_KEEP_FORMATTING- Wenn die Ausgabe nicht an ein Terminal geleitet wird (z. B. an eine Datei oder eine Pipe), werden Formatierungszeichen normalerweise verworfen, um das Lesen des Ergebnisses ohne Spezialwerkzeuge zu erleichtern. Wenn jedoch $MAN_KEEP_FORMATTINGauf einen beliebigen nicht leeren Wert gesetzt ist, werden diese Formatierungszeichen beibehalten. Dies kann für Wrapper um man nützlich sein, die Formatierungszeichen interpretieren können.

MAN_KEEP_STDERR- Wenn die Ausgabe an ein Terminal (normalerweise an einen Pager) geleitet wird, wird normalerweise jede Fehlerausgabe des Befehls, der zum Erstellen formatierter Versionen von Handbuchseiten verwendet wird, verworfen, um Störungen der Anzeige des Pagers zu vermeiden. Programme wie grofferzeugen oft relativ geringfügige Fehlermeldungen über typografische Probleme wie schlechte Ausrichtung, die unansehnlich und im Allgemeinen verwirrend sind, wenn sie zusammen mit der Handbuchseite angezeigt werden. Einige Benutzer möchten sie jedoch trotzdem sehen, daher $MAN_KEEP_STDERRwird die Fehlerausgabe wie üblich angezeigt, wenn auf einen beliebigen nicht leeren Wert gesetzt ist.

Und nun dazu, wie Sie das andere tun könnten:

Ich denke, das hier macht, was Sie wollen:

for f in /usr/share/man/man1/*gz ; do
    man -P "sed -ne '1,/^[Nn]/d;/^ /{H;b}
    /^[Ss]..[Yy]..[Nn]/{g;:n
    N;/\n\(\n\)[^ ].*/!bn;s//\1/
    s/.\x08//g;s/\(\n\)  */\1/g;
    w /dev/stderr' -ne '};/./q'" -l "$f"
done 2>~/file

Es gibt an, dass es sedsich um die Zeile handelt PAGER, und gibt dann nur die folgende Zeile ausNAMEund die folgendenZUSAMMENFASSUNGbis es auf eine andere Zeile trifft, die mit etwas anderem als a beginnt <space>. Es drucktNichtswenn die erste Zeile, die nicht damit beginnt, <space>folgtNAMEstimmt nicht mit begin überein [Ss][Yy][Nn]. In jedem Fall wird das Lesen der Datei in der zweiten Zeile beendet, die nachNAMEdas nicht mit beginnt <space>. Es löscht führende <spaces>und alle \bAckslashs aus der Ausgabe.

Ich habe es forgerade in einer Schleife ausgeführt und es hat manin nur einer Minute meine gesamte Bibliothek durchlaufen.

manpasst seine Ausgabe an, je nachdem, ob es in ein Terminal oder eine Pipe/Datei schreibt. Wenn Sie ihm also sagen, dass er das tun soll, verzichtet er ganz auf den PAGER. Das war unerwartet. Aber ich habe es ausgetrickst und die wRite-Funktion von sed verwendet, um in >&2 zu schreiben und das umzuleiten, also hat es nichts gemerkt.

Eine Anmerkung jedoch: Es ist vielleicht die bessere Vorgehensweise von @terdon. Sie können dies zwar einfacher anpassen, da Sie eine sedpro Datei erhalten, und die Formatierung ist etwas besser, da sie nicht versucht, auf die Breite eines Terminals zu passen, diese \Backslashes werden anscheinend jedoch mannicht in ein geschrieben |pipe.

Wie extrahieren Sie alle Befehlszusammenfassungen korrekt aus den Manpages in /usr/share/man/man1?

Antwort1

Antwort2

verwandte Informationen