V systému Windows je zvykem pouzívat hypertextovou dokumentaci ulozenou v souboru s príponou .hlp. Tento typ souboru umí zobrazit program winhelp.exe. Tato dokumentace bývá pomerne intuitivní a nemá vetsí smysl popisovat její ovládání. Nevýhodou tohoto typu dokumentace je, ze se pomerne slozite vytvárí. Navíc nekdy bývá problém vhodnou dokumentaci vubec sehnat (prekladac jazyka C není standardní soucástí Windows).
Manuálové stránky jsou v prostredí Unix/Linux stejnou klasikou, jako v prostredí Windows soubory .hlp. Jde o pomerne jednoduchý systém, který funguje v textové konzoli (ale lze je zobrazit i v grafickém prostredí). Tento systém neobsahuje zádné hypertextové odkazy, pouze ciste textové informace. Spoustí se príkazem man
$ man stránka
Pokud se chcete dozvedet, jak presne príkaz man funguje, zkuste v konzoli napsat
$ man man
Vlastní ovládání prohlízece není slozité.
Manuálové stránky jsou cleneny do nekolika úrovní podle svého úcelu. V první úrovni jsou umísteny manuálové stránky systémových príkazu jako man, bash, apod. Programátorské stránky jsou az ve tretí úrovni. Zde najdeme kompletní dokumentaci k systémovým knihovnám jazyku C a C++. Mezi úrovnemi se prepíná zadáním parametru s císlem pozadované úrovne.
$ man 3 printf
Tento prepínac je nutné pouzít pouze v prípade, ze dve manuálové stránky z ruzných úrovní mají stejný název (jako je tomu v prípade printf). U vetsiny céckových funkcí tento prepínac pouzít nemusíme.
$ man strcmp
Pokud vám nevyhovuje zobrazení v textové konzoli a pouzíváte prostredí KDE, muzete manuálové stránky zobrazit pomocí webového prohlízece Konqueror. V prostredí KDE stisknete kombinaci kláves Alt+F2 a do príkazového rádku napiste man:strcmp. Prohlízec Konqueror umí do manuálové stránky doplnit hypertextové odkazy na jiné manuálové stránky, takze je to mnohem pohodlnejsí nez samotné pouzití programu man.
Info stránky jsou mnohem komfortnejsí nez manuálové stránky, obsahují totiz hypertextové odkazy na jiné info stránky. Program info funguje v textové konzoli stejne jako program man, takze je mozno jej pouzít i na textových terminálech bez prítomnosti grafického systému XWindow. Pouzití je podobné jako u manuálových stránek:
$ info info
Ovládání je opet podobné jako u manuálových stránek, pouze je rozsíreno o hypertextové odkazy, coz je text uvozený zleva hvezdickou * a zprava ctyrteckou ::. Skok na odkazovanou stránku se prování najetím kurzoru na odkaz a stisknutím klávesy Enter.
Info stránky obsahují mnohem obsaznejsí informace nez manuálové stránky. Nehodí se proto pro rychlé hledání prototypu funkcí. Na druhou stranu info stránky bezne obsahují ukázky kódu a popis ruzných souvislostí. Zkuste napsat
$ info strcmp
V prostredí KDE opet muzete pouzít prohlízec Konqueror, kdyz do jeho adresní rádky napísete info:strcmp.
V podobe info stránek najdete i kompletní dokumentaci k základním knihovnám jazyka C. Tato dokumentace je rozclenená jednak podle základních cinností, které programátor potrebuje provádet (alokace pameti, vstup/výstup, práce se soubory, ...), ale také podle jmen jednotlivých funkcí nebo datových typu. Tyto stránky zobrazíte pomocí info:libc.
V unixovém prostredí jsou uzitecné jeste dva jednoduché programy - whatis a apropos. Tyto programy slouzí pro snazsí orientaci ve velkém poctu manuálových stránek. Nezobrazují celou manuálovou stránku, ale pouze jednorádkový komentár. Rozdíl mezi temito programy ukázu na príkladech:
$ whatis printf printf (3) - formatted output conversion
$ apropos printf format (n) - Format a string in the style of sprintf asprintf (3) - print to allocated string dprintf (3) - print to a file descriptor fprintf [printf] (3) - formatted output conversion fwprintf [wprintf] (3) - formatted wide character output conversion printf (3) - formatted output conversion snprintf [printf] (3) - formatted output conversion
Výhodou dokumentace ve formátu HTML je její snadná dostupnost. Na internetu se dá najít témer vse, co potrebujete. Dalsí výhodou je, ze HTML jde celkem bez problému zobrazit vsude - a to jak na grafické, tak i na textové konzoli. Nezanedbatelnou výhodou tohoto formátu je i to, ze pro jeho generování není potreba zádné slozité nástroje - klidne si vystacíte s jednoduchým editorem.
Následuje seznam odkazu, které jsou pro programátora v jazyce C velmi uzitecné.
Autor: David Martinek. Poslední modifikace: 15. April 2009. Pokud v tomto dokumentu narazíte na chybu, dejte mi prosím vedet.