Scroll to navigation

LEXGROG(1) Rokasgrāmatu lapotāja rīki LEXGROG(1)

NOSAUKUMS

lexgrog - parsēt galvenes informāciju man lapās

KOPSAVILKUMS

lexgrog [-m|-c] [-dfw?V] [-E kodējums] fails ...

APRAKSTS

lexgrog ir tradicionālās “groff guess” utilītas realizācija lex valodā. Tā nolasa komandrindā norādīto failu sarakstu kā man lapu avota failus vai iepriekš formatētas “cat” lapas un parāda to nosaukumu un aprakstu, kā tos izmanto apropos un whatis, vai priekšapstrādes filtru sarakstu, kas man lapai nepieciešami, pirms tā tiek nodota nroff vai troff, vai abus.

Ja ievade ir slikti formatēta, lexgrog izvadīs “parse failed”; tas var noderēt ārējām programmām, kurām jāpārbauda man lapu pareizība. Ja kāds no lexgrog ievades failiem ir “-”, tā lasīs no standarta ievades; ja kāds ievades fails ir saspiests, automātiski tiks nolasīta tā atspiestā versija.

OPCIJAS

Izvadīt atkļūdošanas informāciju.
Parsēt ievadi kā man lapu avota failus. Tas ir noklusējums, ja nav norādīts ne --man, ne --cat.
Parsēt ievadi kā iepriekš formatētas man lapas (“cat lapas”). --man un --cat nedrīkst norādīt vienlaikus.
Parādīt nosaukumu un aprakstu no man lapas galvenes, kā tos izmanto apropos un whatis. Tas ir noklusējums, ja nav norādīts ne --whatis, ne --filters.
Parādīt filtru sarakstu, kas nepieciešami man lapas priekšapstrādei pirms formatēšanas ar nroff vai troff.
Aizstāt lapai uzminēto rakstzīmju kopu ar kodējumu.
-?, --help
Izvadīt palīdzības ziņojumu un iziet.
Izvadīt īsu lietošanas ziņojumu un iziet.
Parādīt versijas informāciju.

IZPILDES STATUSS

0
Veiksmīga programmas izpilde.
1
Lietošanas kļūda.
2
lexgrog neizdevās parsēt vienu vai vairākus ievades failus.

PIEMĒRI


$ lexgrog man.1
man.1: "man - an interface to the system reference manuals"
$ lexgrog -fw man.1
man.1 (t): "man - an interface to the system reference manuals"
$ lexgrog -c whatis.cat1
whatis.cat1: "whatis - display manual page descriptions"
$ lexgrog broken.1
broken.1: parse failed

WHATIS PARSĒŠANA

mandb (kas izmanto to pašu kodu, ko lexgrog) parsē NAME sadaļu katras rokasgrāmatas lapas sākumā, meklējot katrā dokumentēto līdzekļu nosaukumus un aprakstus. Lai gan parsētājs ir diezgan iecietīgs, jo tam jātiek galā ar vairākām vēsturiski lietotām formām, dažreiz tam var neizdoties izgūt vajadzīgo informāciju.

Izmantojot tradicionālo man makro kopu, pareiza NAME sadaļa izskatās apmēram šādi:

.SH NAME
foo \- program to do something

Dažiem rokasgrāmatu lapotājiem nepieciešams, lai ‘\-’ būtu tieši tāds, kā parādīts; mandb ir iecietīgāka, tomēr saderībai ar citām sistēmām ir ieteicams saglabāt atpakaļvērsto slīpsvītru.

Kreisajā pusē var būt vairāki nosaukumi, atdalīti ar komatiem. Nosaukumi, kas satur atstarpes, tiks ignorēti, lai izvairītos no patoloģiskas uzvedības dažās nepareizi veidotās NAME sadaļās. Teksts labajā pusē ir brīvas formas un var aizņemt vairākas rindas. Ja vienā rokasgrāmatas lapā tiek dokumentēti vairāki līdzekļi ar dažādiem aprakstiem, tāpēc tiek izmantota šāda forma:

.SH NAME
foo, bar \- programs to do something
.br
baz \- program to do nothing

(Pārtraukuma makro .br vietā var izmantot makro, kas sāk jaunu rindkopu, piemēram, .PP.)

Izmantojot no BSD atvasināto mdoc makro kopu, pareiza NAME sadaļa izskatās apmēram šādi:

.Sh NAME
.Nm foo
.Nd program to do something

Ir vairāki bieži sastopami iemesli, kāpēc whatis parsēšana neizdodas. Dažreiz rokasgrāmatas lapu autori aizstāj ‘.SH NAME’ ar ‘.SH MYPROGRAM’, un tad mandb nevar atrast sadaļu, no kuras izgūt vajadzīgo informāciju. Dažreiz autori iekļauj NAME sadaļu, bet tajā ievieto brīvas formas tekstu, nevis ‘nosaukums \- apraksts’. Tomēr jebkurai sintaksei, kas līdzinās iepriekš minētajai, vajadzētu tikt pieņemtai.

SKATĪT ARĪ

apropos(1), man(1), whatis(1), mandb(8)

PIEZĪMES

lexgrog mēģina parsēt failus, kas satur .so pieprasījumus, taču spēs to izdarīt pareizi tikai tad, ja faili ir pareizi instalēti rokasgrāmatas lapu hierarhijā.

AUTORS

Kodu, ko lexgrog izmanto man lapu skenēšanai, uzrakstīja:

Wilf. (G.Wilford@ee.surrey.ac.uk).
Fabrizio Polacco (fpolacco@debian.org).
Colin Watson (cjwatson@debian.org).

Colin Watson uzrakstīja pašreizējo komandrindas saskarnes versiju, kā arī šo man lapu.

KĻŪDAS

https://gitlab.com/man-db/man-db/-/issues
https://savannah.nongnu.org/bugs/?group=man-db

2026-11-15 2.13.2