LEXGROG

ÐÐÐÐÐÐÐÐ
СÐÐТÐÐСÐС
ÐÐÐСÐÐÐÐ
ÐÐРÐÐÐТРЫ
ÐÐÐ ÐЫХÐÐÐ
ÐРÐÐÐРЫ
ЧТРÐÐÐÐÐÐÐРУÐТСЯ
СÐÐТРÐТРТÐÐÐÐ
ÐÐÐÐЧÐÐÐЯ
ÐÐТÐР
ÐШÐÐÐÐ


ÐÐÐÐÐÐÐÐ

lexgrog − анализиÑÑÐµÑ Ð·Ð°Ð³Ð¾Ð»Ð¾Ð²Ð¾ÑнÑÑ Ð¸Ð½ÑоÑмаÑÐ¸Ñ ÑпÑавоÑнÑÑ ÑÑÑаниÑ

СÐÐТÐÐСÐС

lexgrog [−m|−c] [−dfw?V] [−E кодиÑовка] Ñайл

ÐÐÐСÐÐÐÐ

lexgrog â ÑÑо ÑеализаÑÐ¸Ñ ÑÑадиÑионной “groff guess” ÑÑилиÑÑ Ñ Ð¿Ð¾Ð¼Ð¾ÑÑÑ lex. Ðна ÑиÑÐ°ÐµÑ ÑпиÑок Ñайлов из командной ÑÑÑоки, коÑоÑÑе ÑвлÑÑÑÑÑ Ñайлами иÑÑодников ÑпÑавоÑнÑÑ ÑÑÑÐ°Ð½Ð¸Ñ Ð¸Ð»Ð¸ Ñже оÑÑоÑмиÑованнÑми (“cat”) ÑÑÑаниÑами, и показÑÐ²Ð°ÐµÑ Ð¸Ñ Ð½Ð°Ð·Ð²Ð°Ð½Ð¸Ñ Ð¸ опиÑаниÑ, иÑполÑзÑемÑе apropos и whatis, ÑпиÑок пÑедваÑиÑелÑнÑÑ ÑилÑÑÑов обÑабоÑки, ÑÑебÑемÑй man ÑÑÑаниÑей пеÑед Ñем как она бÑÐ´ÐµÑ Ð¿ÐµÑедана nroff или troff, или обеим пÑогÑаммам.

ÐÑли вÑоднÑе даннÑе непÑавилÑно оÑÑоÑмаÑиÑованÑ, lexgrog вÑÐ²ÐµÐ´ÐµÑ “parse failed”; ÑÑо Ð¼Ð¾Ð¶ÐµÑ Ð¾ÐºÐ°Ð·Ð°ÑÑÑÑ Ð¿Ð¾Ð»ÐµÐ·Ð½Ñм Ð´Ð»Ñ Ð²Ð½ÐµÑÐ½Ð¸Ñ Ð¿ÑогÑамм, коÑоÑÑм нÑжно пÑовеÑÑÑÑ Ð¿ÑавилÑноÑÑÑ Ð½Ð°Ð¿Ð¸ÑÐ°Ð½Ð¸Ñ man ÑÑÑаниÑ. ÐÑли в каÑеÑÑве одного из имÑн Ñайлов lexgrog пеÑедан Ñимвол “−”, Ñо даннÑе бÑдÑÑ ÑиÑаÑÑÑÑ Ð¸Ð· ÑÑандаÑÑного вÑодного поÑока; еÑли лÑбой вÑодной Ñайл ÑжаÑ, Ñо бÑÐ´ÐµÑ Ð°Ð²ÑомаÑиÑеÑки ÑиÑаÑÑÑÑ ÐµÐ³Ð¾ ÑаÑжаÑÐ°Ñ Ð²ÐµÑÑиÑ.

ÐÐРÐÐÐТРЫ

−d, −−debug

ÐоказÑваÑÑ Ð¾ÑладоÑнÑÑ Ð¸Ð½ÑоÑмаÑиÑ.

−m, −−man

ÐнализиÑоваÑÑ Ð²ÑоднÑе даннÑе как ÑÐ°Ð¹Ð»Ñ Ð¸ÑÑодников ÑпÑавоÑнÑÑ ÑÑÑаниÑ. ЯвлÑеÑÑÑ Ð´ÐµÐ¹ÑÑвием по ÑмолÑаниÑ, еÑли не Ñказан паÑамеÑÑ −−man или −−cat.

−c, −−cat

ÐнализиÑоваÑÑ Ð²ÑоднÑе даннÑе как Ñже оÑÑоÑмаÑиÑованнÑе ÑпÑавоÑнÑе ÑÑÑаниÑÑ (“cat ÑÑÑаниÑÑ”). −−man и −−cat не могÑÑ ÑказÑваÑÑÑÑ Ð¾Ð´Ð½Ð¾Ð²Ñеменно.

−w, −−whatis

ÐоказаÑÑ Ð½Ð°Ð·Ð²Ð°Ð½Ð¸Ðµ и опиÑание из заголовка ÑпÑавоÑной ÑÑÑаниÑÑ, иÑполÑзÑемого apropos и whatis. ЯвлÑеÑÑÑ Ð´ÐµÐ¹ÑÑвием по ÑмолÑаниÑ, еÑли не Ñказан паÑамеÑÑ −−whatis или −−filters.

−f, −−filters

ÐоказаÑÑ ÑпиÑок ÑилÑÑÑов, необÑодимÑÑ Ð´Ð»Ñ Ð¿ÑедваÑиÑелÑной обÑабоÑки ÑпÑавоÑной ÑÑÑаниÑÑ Ð¿ÐµÑед ÑоÑмаÑиÑованием Ñ Ð¿Ð¾Ð¼Ð¾ÑÑÑ nroff или troff.

−E кодиÑовка, −−encoding кодиÑовка

ÐÑполÑзоваÑÑ ÐºÐ¾Ð´Ð¸ÑÐ¾Ð²ÐºÑ Ð²Ð¼ÐµÑÑо пÑедполагаемой кодиÑовки Ñимволов ÑÑÑаниÑÑ.

−?, −−help

ÐоказаÑÑ ÑпÑавоÑное ÑообÑение и законÑиÑÑ ÑабоÑÑ.

−−usage

ÐоказаÑÑ ÐºÐ¾ÑоÑкое ÑообÑение об иÑполÑзовании и завеÑÑиÑÑ ÑабоÑÑ.

−V, −−version

ÐоказаÑÑ Ð¸Ð½ÑоÑмаÑÐ¸Ñ Ð¾ веÑÑии.

ÐÐÐ ÐЫХÐÐÐ

0

УÑпеÑное вÑполнение пÑогÑаммÑ.

1

ÐÑибка иÑполÑзованиÑ.

2

lexgrog не ÑдалоÑÑ ÑазобÑаÑÑ Ð¾Ð´Ð¸Ð½ или более вÑоднÑÑ Ñайлов.

ÐРÐÐÐРЫ

$ 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

ЧТРÐÐÐÐÐÐÐРУÐТСЯ

mandb (иÑполÑзÑÐµÑ ÑÐ¾Ñ Ð¶Ðµ код, ÑÑо и lexgrog) анализиÑÑÐµÑ Ñаздел NAME (ÐÐÐÐÐÐÐÐ), ÑаÑположеннÑй в Ñамом наÑале каждой ÑпÑавоÑной ÑÑÑаниÑÑ, в поиÑке названий и опиÑаний возможноÑÑей. ХоÑÑ Ð°Ð½Ð°Ð»Ð¸Ð·Ð°ÑÐ¾Ñ Ð´Ð¾Ð¿ÑÑÐºÐ°ÐµÑ ÑазлиÑнÑе ваÑиаÑии и Ð¿Ð¾Ð½Ð¸Ð¼Ð°ÐµÑ Ð¼Ð½Ð¾Ð³Ð¾ ÑазлиÑнÑÑ ÑоÑмаÑов, коÑоÑÑе ÑложилиÑÑ Ð·Ð° вÑÐµÐ¼Ñ Ð¸ÑполÑзованиÑ, иногда он не Ð¼Ð¾Ð¶ÐµÑ Ð¸Ð·Ð²Ð»ÐµÑÑ ÑÑебÑемÑÑ Ð¸Ð½ÑоÑмаÑиÑ.

ÐÑи иÑполÑзовании ÑÑадиÑионнÑÑ Ð½Ð°Ð±Ð¾Ñов макÑоÑов man, пÑавилÑно оÑоÑмленнÑй Ñаздел NAME вÑглÑÐ´Ð¸Ñ Ñак:

.SH NAME
foo − пÑогÑамма, вÑполнÑÑÑÐ°Ñ ÑÑо−Ñо

ÐекоÑоÑÑе ÑпÑавоÑнÑе пейджеÑÑ ÑÑебÑÑÑ ‘−’ ÑоÑно как показано; mandb более ÑеÑпим, но Ð´Ð»Ñ ÑовмеÑÑимоÑÑи Ñ Ð´ÑÑгими ÑиÑÑемами вÑÑ Ð¶Ðµ лÑÑÑе оÑÑавлÑÑÑ Ñимвол обÑаÑной коÑой ÑеÑÑÑ.

Слева Ð¾Ñ ÑеÑÑÑ Ð¼Ð¾Ð³ÑÑ Ð±ÑÑÑ Ð½ÐµÑколÑко названий, ÑазделÑннÑÑ ÑеÑез запÑÑÑÑ. ÐÐ°Ð·Ð²Ð°Ð½Ð¸Ñ Ñ Ð¿Ñобелами бÑдÑÑ Ð¸Ð³Ð½Ð¾ÑиÑоваÑÑÑÑ Ð²Ð¾ избежании необÑÑного Ð¿Ð¾Ð²ÐµÐ´ÐµÐ½Ð¸Ñ Ð´Ð»Ñ Ð¾Ð¿ÑеделÑнно плоÑо оÑоÑмленнÑÑ Ñазделов NAME. У ÑекÑÑа ÑпÑава Ð½ÐµÑ ÑпеÑиалÑного ÑоÑмаÑа, и он Ð¼Ð¾Ð¶ÐµÑ ÑаÑполагаÑÑÑÑ Ð½Ð° неÑколÑÐºÐ¸Ñ ÑÑÑокаÑ. ÐÑли в одной ÑпÑавоÑной ÑÑÑаниÑе ÑодеÑжаÑÑÑ Ð½ÐµÑколÑко ÑвойÑÑв Ñ ÑазлиÑнÑми опиÑаниÑми, Ñо иÑполÑзÑеÑÑÑ ÑледÑÑÑÐ°Ñ ÑоÑма:

.SH NAME
foo, bar − пÑогÑаммÑ, вÑполнÑÑÑие ÑÑо−Ñо
.br
baz − пÑогÑамма ниÑего не делаÑÑаÑ

(ÐмеÑÑо макÑоÑа ÑазÑÑва .br Ð¼Ð¾Ð¶ÐµÑ Ð¸ÑполÑзоваÑÑÑÑ Ð¼Ð°ÐºÑоÑ, наÑинаÑÑий новÑй паÑагÑаÑ, Ñипа .PP.)

ÐÑли иÑполÑзÑеÑÑÑ BSD−пÑоизводнÑй Ð½Ð°Ð±Ð¾Ñ Ð¼Ð°ÐºÑоÑов mdoc, Ñо пÑавилÑно оÑоÑмленнÑй Ñаздел NAME вÑглÑÐ´Ð¸Ñ Ñак:

.Sh NAME
.Nm foo
.Nd пÑогÑамма, вÑполнÑÑÑÐ°Ñ ÑÑо−Ñо

ÐÑÑÑ Ð½ÐµÑколÑко ÑаÑпÑоÑÑÑанÑннÑÑ Ð¿ÑиÑин, по коÑоÑÑм анализ Ð¼Ð¾Ð¶ÐµÑ Ð·Ð°Ð²ÐµÑÑаÑÑÑÑ Ð½ÐµÑдаÑно. Ðногда авÑоÑÑ ÑпÑавоÑнÑÑ ÑÑÑÐ°Ð½Ð¸Ñ Ð·Ð°Ð¼ÐµÐ½ÑÑÑ ‘.SH NAME’ на ‘.SH MYPROGRAM’, и поÑÑÐ¾Ð¼Ñ mandb не Ð¼Ð¾Ð¶ÐµÑ Ð½Ð°Ð¹Ñи Ñаздел, из коÑоÑого нÑжно извлекаÑÑ Ð¸Ð½ÑоÑмаÑиÑ. Ðногда авÑоÑÑ Ð²ÐºÐ»ÑÑаÑÑ Ñаздел NAME, но ÑазмеÑаÑÑ ÐµÐ³Ð¾ в Ñвободной ÑоÑме, а не как положено ‘название − опиÑание’. Ðднако лÑбой ÑинÑакÑиÑ, пÑиведÑннÑй вÑÑе, бÑÐ´ÐµÑ Ð¿Ð¾Ð½ÑÑ.

СÐÐТРÐТРТÐÐÐÐ

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

ÐÐÐÐЧÐÐÐЯ

lexgrog пÑÑаеÑÑÑ Ð¿ÑоанализиÑоваÑÑ ÑайлÑ, ÑодеÑжаÑие запÑоÑÑ .so, но ÑÐ¼Ð¾Ð¶ÐµÑ ÑÑо ÑделаÑÑ, еÑли ÑолÑко ÑÐ°Ð¹Ð»Ñ Ð¿ÑавилÑно ÑÑÑÐ°Ð½Ð¾Ð²Ð»ÐµÐ½Ñ Ð² иеÑаÑÑии ÑпÑавоÑнÑÑ ÑÑÑаниÑ.

ÐÐТÐР

ÐвÑоÑÑ ÐºÐ¾Ð´Ð°, иÑполÑзÑемого lexgrog Ð´Ð»Ñ ÑканиÑÐ¾Ð²Ð°Ð½Ð¸Ñ ÑпÑавоÑнÑÑ ÑÑÑаниÑ:

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

Ðолин ÐаÑÑон (Colin Watson) напиÑал ÑекÑÑий ваÑÐ¸Ð°Ð½Ñ Ð´Ð»Ñ Ð¸Ð½ÑеÑÑейÑа командной ÑÑÑоки, а Ñакже даннÑÑ ÑпÑавоÑнÑÑ ÑÑÑаниÑÑ.

ÐШÐÐÐÐ

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