LEXGROG(1)

НАЗИВ
lexgrog - обрађује податке заглавља у страницама упутства

УВОД
lexgrog [-m|-c] [-dfw?V] [-E кодирање] датотека ...

ОПИС
лексгрог је примена традиционалног помагала „groff guess“ у лексу. Чита списак датотека на својој линији наредби или као изворне датотеке страница упутства или као унапред обликоване „cat“ странице, и приказује њихове називе и описе као што их користе apropos и whatis, списак пропусника предобраде које захтева страница упутства пре прослеђивања у нрофф или трофф или у оба.

Ако је његов улаз лоше обликован, лексгрог ће исписати „parse failed“ (обрада није успела); што може бити корисно спољним програмима који треба да провере странице упутства за тачношћу. Ако једна улазна датотека лексгрога јесте „-“, читаће са стандардног улаза; ако је било која улазна датотека запакована, распаковано издање ће бити читано.

ОПЦИЈЕ

-d, --debug
    Исписује податке прочишћавања.

-m, --man
    Обрађује улаз као изворне датотеке страница упутства. Ово је основно ако није дато ни „--man“ ни „--cat“.

-c, --cat
    Обрађује улаз као предобликоване странице упутства („cat pages“). „--man“ и „--cat“ не могу бити дати истовремено.

-w, --whatis
    Приказује назив и опис из заглавља странице упутства, као што користе apropos и whatis. Ово је основно ако није дато ни „--whatis“ ни „--filters“.

-f, --filters
    Приказује списак пропусника потребних за предобраду странице упутства пре обликовања нрофф-ом или трофф-ом.

-E кодирање, --encoding кодирање
    Пребацује откривени скуп знакова за страницу на кодирање.

-?, --help
    Исписује поруку помоћи и излази.

--usage
    Исписује кратку поруку о коришћењу и излази.

-V, --version
    Исписује податке о издању.

СТАЊЕ ИЗЛАЗА

0   Успешно извршавање програма.

1   Грешка коришћења.

2   „лексгрог“ није успео да обради једну или више својих улазних датотека.

ПРИМЕРИ
  $ lexgrog man.1
  man.1: „man - сучеље за упутства упута на мрежи“
  $ lexgrog -fw man.1
  man.1 (t): „man - сучеље за упутства упута на мрежи“
  $ lexgrog -c whatis.cat1
  whatis.cat1: „whatis - приказује описе страница упутства“
  $ lexgrog broken.1
  broken.1: обрада није успела

ШТА-ЈЕ ОБРАДА
%мандб% (који користи исти код као и лексгрог) обрађује одељак НАЗИВ на врху сваке странице упутства тражећи називе и описе функција које су документоване у свакој. Док је обрађивач поприлично толерантан, јер мора да се бори са бројним различитим облицима који су коришћени кроз историју, може понекад и да не успе да извуче затражене податке.

Приликом коришћења традиционалног макро скупа ман-а, исправан одељак НАЗИВ личи на овако нешто:

    .SH НАЗИВ
    foo \- програм који ће да уради нешто

Неки страничари упутства захтевају „\-“ да би били тачно као што је приказано; %мандб%“ је толерантнији, али због сагласности са другим системима ипак је добра идеја задржати контра косу црту.

На левој страни, може постојати неколико назива, раздвијених зарезима. Називи који садрже празнину биће занемарени да би се избегло патолошко понашање на одређеним лоше обликованим одељцима НАЗИВ. Текст на десној страни је слободан образац, и може бити раширен преко неколико редова. Ако је документовано неколико функција са различитим описима на истој страници упутства, онда се користи следећи образац:

    .SH НАЗИВ
    foo, bar \- програми који ће урадити нешто
    .br
    baz \- програм који неће ништа да ради

(Макро који започиње нови пасус, као „.PP“, може бити коришћен уместо макроа прекида „.br“.)

Приликом коришћења мдоц макро скупа произашлог из БСД-а, исправан одељак НАЗИВ личи на овако нешто:

    .SH НАЗИВ
    .Nm foo
    .Nd програм који ће нешто да уради
Има неколико општих разлога зашто не успе шта-је обрада. Понекад аутори страница упутства замене „.SH НАЗИВ“ са „.SH МОЈПРОГРАМ“, и тада %мандб% не може да пронађе одељак из ког да извуче податке које требује. Понекад аутори укључе одељак НАЗИВ, али ту ставе текст у слободном облику уместо „name \- description“. Међутим, било која синтакса налик на горњу би требала бити прихваћена.

ВИДЕТИ ТАКОЂЕ
apropos(1), man(1), whatis(1), mandb(8)

НАПОМЕНЕ
лексгрог покушава да обради датотеке које садрже „.so“ захтеве, али ће бити у стању да то уради тачно само ако су датотеке исправно инсталиране у хијерархији странице упутства.

АУТОР
Код који користи „лексгрог“ да прегледа ман странице је написао:

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

Колин Вотсон је написао текуће отелотворење челника линије наредби, као и ову страницу упутства.