int21h

Informační systémy v Linuxu

Pokud chcete získat informace o programu, máte v linuxu celkem dost možností.

man pages

Manuálové stránky má snad každý důležitější program, který máte v distribuci. Jejich výhody jsou rychlost, přehlednost a podporují i jemné formátování texu omezné jen možnosti prohlížeče. Nevýhoda je, že je to pořád jenom jeden texový soubor nepodporující obrázky - ne že by to byla nějaká nevýhoda. Přístup je jednoduchý: $ man [sekce] nazev_programu. Manuálky se tedy člení do sekcí podle funkce programu. Pokud napíšete program, tak se rozhodněte, kam ho zařadit. Význam sekcí je asi takhle:

(1) Uživatelské příkazy
(2) Systémová volání
(3) Funkce z hlavičkových souborů
(4) Speciální soubory a zařízení
(5) Formáty souborů
(6) Hry a zábava
(7) Ostatní
(8) Administrace a administrační nástroje
existuje ještě sekce (n), která je ale téměř bezvýhradně obsazena příkazy jazyka Tcl.

Manuálky můžete najít někde u /usr/share/man popřípadně ještě /usr/share/man/cs a většinou to jsou soubory zabalené do formátu bzipu. Formát jména je jmeno.sekce.bz2 např. intro.5.bz2. K tomu intro. Zkuste man sekce intro. To vám dá informace k čemu je tato sekce. Na formátování textu se používá groff, který se vyvinul z troff, který se vyvinul z roff, který se vyvinul z off, který se vyvinul s ff - no dobře, těma posledníma dvěma si nejsem jistý, ale předpokládám, že to tak bylo. (Možná až po f...) Použití těchto formátovačů je veskrze stejné už těch 180 let co unix existuje. Tyto nástroje umožňují tisk formátovaného textu do několika formátů: ascii, ps(postscript), html. groff není jen pro manuálové stránky. Umí více formátů, proto to musíme definovat - na to je parametr -mandoc. Takže jak to celé funguje: program man vyhledá manuálku a tento soubor předá programu groff, který ho zformátuje a výsledek pak podá stránkovači (nejčastěji less), který ho dokáže správně zobrazit. Samozřejmě existuje více prohlížečů manuálních stránek. Mě osobně vyhodvuje pman (zmíním se i o pinfo), který je napsán v ncurses - přistupné z konzole, funkčnost myši. Kdo má radši okna tak xman, myslím, že i dokumentace gnome (yelp) podporuje manuálky a určitě existuje hodně dalších.

Na závěr jsem vám připravil moji ukázkovou manuálku, která stačí k jednoduchým úpravám textu. (Když se podíváte na nějáke systémové, tak se v nich asi nevyznáte). Balíky najdete na konci článku.


Info stránky

Info je už dokonalejší, ale také složitější na tvorbu. Největší výhoda je, že podporuje hypertextové odkazy. Formát zdrojového souboru info je jakýsi derivát texu. K formátování je potřeba už speciální nástroj makeinfo. Ten potřebuje právě zdrojový soubor info stránky a ten pak umí přetvořit do formátů html,xml,docbook nebo ascii a samozřejmě info, což je program, který umí číst program info, nebo další prohlížeče. Opět doporučuju pinfo které má zkvělé ovládání a i možnost kroků zpět. Opět přikládám můj sample na konci řádku


DOCumentace

Každý program by měl mít svou základní dokumentaci někde v /usr/share/doc/nazev-verze/

Většina programů tu složku má, ale povětšinou je obsazená jen souborem README. Podle mě by měl každý program mít dokumentační soubory: README NEWS INSTALL COPYING ChangeLog AUTHORS. K čemu který slouží je snad jasné podle názvů. Už jsem se o tom trochu zmiňoval v článku o automake.


HOWTO

Málokterý programátor píše dokumentaci v HOWTO. Většinou ho tvoří někdo dodatečně. Největší sbírky HOWTOs jsou on-line na internetu. V distribucích je můžete nalézt všechny v jednom balíku. Jsou to co nejjednodušší soubory libovolného, ale všude čitelného formátu, ve kterých se dodržují určité - velmi staré - konvence. Například pěkně strukturovaný obsah na začátku, pokud je HOWTO v html formátu, tak už naprosto neodmyslitelné tlačítka další, předchozí, index. V HOWTO se zaměřuje čistě na užívání programu - je to vlastně takový tutoriál. U postup přes google: HOWTO aplikace, je úspěch skoro zaručený. Nejrozšířenější jsou HOWTO v jednom html souboru. Tyhle dokumenty jsou ukázkou unixového pohledu na html - jednoduchost, přehlednost => efektivita.


Help centra

Obě nejrozšířenější desktopy KDE a Gnome mají svá help centra. U kde je to khelpcenter. Není špatný. Je lokalizovaný, má nápovědy ke všem kaplikacím a k manuálkám i info souborům. Podporuje i vyhledávání. |man, info ani vyhledávání jsem nerozjel, ale určitě to půjde nějak zprovoznit (konfugurace KDE? Znám lepší způsoby jak strávit dovolenou..)|

Gnome má systém yelp. Ten nepodporuje vyhledávání, ale prohlížení man a hlavně info je skvělé.


Pack

Balík obsahuje příklad man stránky a info stránky.

|unixinfos.tar.gz| - MD5:bc678fde9a83e2a24902aeaddf1f9da1

2006-12-22 | BOby
Reklamy:
Ronnie.cz - kulturistika, fitness, bojové sporty