V systému Windows je zvykem používat hypertextovou dokumentaci uloženou v souboru s příponou .hlp. Tento typ souborů umí zobrazit program winhelp.exe. Tato dokumentace bývá poměrně intuitivní a nemá větší smysl popisovat její ovládání. Nevýhodou tohoto typu dokumentace je, že se poměrně složitě vytváří. Navíc někdy bývá problém vhodnou dokumentaci vůbec sehnat (překladač jazyka C není standardní součástí Windows).
Manuálové stránky jsou v prostředí Unix/Linux stejnou klasikou, jako v prostředí Windows soubory .hlp. Jde o poměrně jednoduchý systém, který funguje v textové konzoli (ale lze je zobrazit i v grafickém prostředí). Tento systém neobsahuje žádné hypertextové odkazy, pouze čistě textové informace. Spouští se příkazem man
$ man stránka
Pokud se chcete dozvědět, jak přesně příkaz man funguje, zkuste v konzoli napsat
$ man man
Vlastní ovládání prohlížeče není složité.
Manuálové stránky jsou členěny do několika úrovní podle svého účelu. V první úrovni jsou umístěny manuálové stránky systémových příkazů jako man, bash, apod. Programátorské stránky jsou až ve třetí úrovni. Zde najdeme kompletní dokumentaci k systémovým knihovnám jazyků C a C++. Mezi úrovněmi se přepíná zadáním parametru s číslem požadované úrovně.
$ man 3 printf
Tento přepínač je nutné použít pouze v případě, že dvě manuálové stránky z různých úrovní mají stejný název (jako je tomu v případě printf). U většiny céčkových funkcí tento přepínač použít nemusíme.
$ man strcmp
Pokud vám nevyhovuje zobrazení v textové konzoli a používáte prostředí KDE, můžete manuálové stránky zobrazit pomocí webového prohlížeče Konqueror. V prostředí KDE stiskněte kombinaci kláves Alt+F2 a do příkazového řádku napište man:strcmp. Prohlížeč Konqueror umí do manuálové stránky doplnit hypertextové odkazy na jiné manuálové stránky, takže je to mnohem pohodlnější než samotné použití programu man.
Info stránky jsou mnohem komfortnější než manuálové stránky, obsahují totiž hypertextové odkazy na jiné info stránky. Program info funguje v textové konzoli stejně jako program man, takže je možno jej použít i na textových terminálech bez přítomnosti grafického systému XWindow. Použití je podobné jako u manuálových stránek:
$ info info
Ovládání je opět podobné jako u manuálových stránek, pouze je rozšířeno o hypertextové odkazy, což je text uvozený zleva hvězdičkou * a zprava čtyřtečkou ::. Skok na odkazovanou stránku se prování najetím kurzoru na odkaz a stisknutím klávesy Enter.
Info stránky obsahují mnohem obsažnější informace než manuálové stránky. Nehodí se proto pro rychlé hledání prototypů funkcí. Na druhou stranu info stránky běžně obsahují ukázky kódu a popis různých souvislostí. Zkuste napsat
$ info strcmp
V prostředí KDE opět můžete použít prohlížeč Konqueror, když do jeho adresní řádky napíšete info:strcmp.
V podobě info stránek najdete i kompletní dokumentaci k základním knihovnám jazyka C. Tato dokumentace je rozčleněná jednak podle základních činností, které programátor potřebuje provádět (alokace paměti, vstup/výstup, práce se soubory, ...), ale také podle jmen jednotlivých funkcí nebo datových typů. Tyto stránky zobrazíte pomocí info:libc.
V unixovém prostředí jsou užitečné ještě dva jednoduché programy - whatis a apropos. Tyto programy slouží pro snazší orientaci ve velkém počtu manuálových stránek. Nezobrazují celou manuálovou stránku, ale pouze jednořádkový komentář. Rozdíl mezi těmito programy ukážu na pří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éměř vše, co potřebujete. Další výhodou je, že HTML jde celkem bez problémů zobrazit všude - a to jak na grafické, tak i na textové konzoli. Nezanedbatelnou výhodou tohoto formátu je i to, že pro jeho generování není potřeba žádné složité nástroje - klidně si vystačíte s jednoduchým editorem.
Následuje seznam odkazů, které jsou pro programátora v jazyce C velmi užitečné.
Autor: David Martinek. Poslední modifikace: 15. April 2009. Pokud v tomto dokumentu narazíte na chybu, dejte mi prosím vědět.