lexgrog – Online in der Cloud

PROGRAMM:

NAME/FUNKTION

lexgrog – Header-Informationen in Manpages analysieren

ZUSAMMENFASSUNG

Lexgrog [-m|-c] [-dfw?V] [-E Codierung] Datei ...

BESCHREIBUNG

Lexgrog ist eine Implementierung des traditionellen Dienstprogramms „Groff Guess“ in lex. Es liest
die Liste der Dateien in der Befehlszeile entweder als Manpage-Quelldateien oder vorformatiert
„Katzen“-Seiten und zeigt deren Namen und Beschreibung an, wie sie von verwendet werden apropos und was ist, der
Liste der Vorverarbeitungsfilter, die von der Manpage benötigt werden, bevor sie übergeben wird Nroff or
troff, oder beides.

Wenn die Eingabe schlecht formatiert ist, Lexgrog gibt „Analyse fehlgeschlagen“ aus; Dies kann nützlich sein für
externe Programme, die Manpages auf Richtigkeit überprüfen müssen. Wenn einer von Lexgrog's Eingabe
files ist „-“, es wird von der Standardeingabe gelesen; Wenn eine Eingabedatei komprimiert ist, a
Die dekomprimierte Version wird automatisch gelesen.

OPTIONAL

-d, --debuggen
Debugging-Informationen drucken.

-m, --Mann
Analysieren Sie die Eingabe als Manpage-Quelldateien. Dies ist die Standardeinstellung, falls keines von beidem der Fall ist --Mann noch
--Katze gegeben ist.

-c, --Katze
Analysieren Sie Eingaben als vorformatierte Manpages („Katzenseiten“). --Mann und --Katze möglicherweise nicht
gleichzeitig gegeben.

-w, --was ist
Zeigt den Namen und die Beschreibung aus der Kopfzeile der Manpage an, wie sie von verwendet werden apropos und
was ist. Dies ist die Standardeinstellung, falls keines von beidem der Fall ist --was ist noch --filters gegeben ist.

-f, --filters
Zeigt die Liste der Filter an, die zur Vorverarbeitung der Manpage vor der Formatierung erforderlich sind
mit Nroff or troff.

-E Codierung, --Codierung Codierung
Überschreiben Sie den vermuteten Zeichensatz für die Seite Codierung.

-?, --help
Drucken Sie eine Hilfenachricht und beenden Sie das Programm.

--Verwendungszweck
Drucken Sie eine kurze Nutzungsnachricht und beenden Sie den Vorgang.

-V, --Version
Versionsinformationen anzeigen.

EXIT STATUS

0 Erfolgreiche Programmausführung.

1 Nutzungsfehler.

2 Lexgrog Eine oder mehrere seiner Eingabedateien konnten nicht analysiert werden.

Beispiele:

$ lexgrog man.1
man.1: „man – eine Schnittstelle zu den Online-Referenzhandbüchern“
$ lexgrog -fw man.1
man.1 (t): „man – eine Schnittstelle zu den Online-Referenzhandbüchern“
$ lexgrog -c whatis.cat1
whatis.cat1: „whatis – Handbuchseitenbeschreibungen anzeigen“
$ Lexgrog kaputt.1
defekt.1: Analyse fehlgeschlagen

WAS IST PARSING

mandb (das den gleichen Code verwendet wie Lexgrog) analysiert die NAME/FUNKTION Abschnitt oben auf jedem Abschnitt
Suchen Sie auf der Handbuchseite nach Namen und Beschreibungen der jeweils dokumentierten Funktionen. Während
Der Parser ist recht tolerant, da er mit einer Reihe unterschiedlicher Formen zurechtkommen muss
Obwohl es in der Vergangenheit verwendet wurde, kann es manchmal fehlschlagen, die erforderlichen Informationen zu extrahieren.

Bei Verwendung des Traditionellen Mann Makrosatz, ein korrektes NAME/FUNKTION Abschnitt sieht ungefähr so ​​aus
Dies:

.SH NAME
foo \- Programm, um etwas zu tun

Bei manchen Manualpagern muss das „\-“ genau wie abgebildet sein; mandb ist toleranter, aber
Aus Kompatibilitätsgründen mit anderen Systemen empfiehlt es sich dennoch, die beizubehalten
umgekehrter Schrägstrich.

Auf der linken Seite können mehrere Namen stehen, getrennt durch Kommas. Namen enthalten
Leerzeichen werden ignoriert, um pathologisches Verhalten bei bestimmten Fehlformen zu vermeiden NAME/FUNKTION
Abschnitte. Der Text auf der rechten Seite ist frei formatiert und kann über mehrere verteilt werden
Linien. Wenn mehrere Features mit unterschiedlichen Beschreibungen im selben Dokument dokumentiert sind
Handbuchseite, daher wird folgende Form verwendet:

.SH NAME
foo, bar \- Programme, um etwas zu tun
.br
baz \- Programm, um nichts zu tun

(Ein Makro, das einen neuen Absatz beginnt, wie z. B. .PP, kann anstelle des Umbruchmakros verwendet werden
.br.)

Bei Verwendung des BSD-abgeleiteten mdoc Makrosatz, ein korrektes NAME/FUNKTION Abschnitt sieht ungefähr so ​​aus
Dies:

.Sh NAME
.Nm foo
.Nd Programm, um etwas zu tun

Es gibt mehrere häufige Gründe, warum das Whatis-Parsing fehlschlägt. Manchmal Autoren von Handbüchern
Seiten ersetzen „.SH NAME“ durch „.SH MYPROGRAM“ und dann mandb Ich kann den Abschnitt nicht finden
um die benötigten Informationen zu extrahieren. Manchmal fügen Autoren einen NAME-Abschnitt hinzu, aber
Platzieren Sie dort Freiformtext anstelle von „Name \- Beschreibung“. Allerdings jede Syntax
Ähnliches sollte akzeptiert werden.

Nutzen Sie Lexgrog online über die Dienste von onworks.net