Dokumentace software

Kategorie: Obecně
  1. Dokumentace
  2. Instalace
  3. Prohlížení

Dokumentace

Dokumentace se v systému Linux vyznačuje značkou doc. Odděluje se od obsahu vlastního softwaru a nachází se tedy odděleně. Pokud instalujete software z repozitáře, hodí se Vám nápověda a dokumentace k programu právě s označením doc. Balíčky doc obsahují veškerou dokumentaci k příslušným programům a nástrojům. Takovou dokumentaci pak lze prohlížet díky nástroji man.

Instalace

Instalace dokumentace probíhá automaticky s programem nebo nástrojem. Pokud chcete volitelnou dokumentaci bez instalace vlastního programu, postupy se liší dle distribuce, stačí třeba jen nainstalovat pouze balíček doc se jménem programu. V programech na správu softwaru si jej dobře vyfiltrujete.

Prohlížení

Prohlížení dokumentace uskutečníme nástrojem man. Pro výpis dokumentace stačí napsat příkaz man a jméno programu.

man program

Použitelnost programu zobrazíme přídavkem –help a nebo jen -h za příkaz spuštění programu.

program --help
program -h

Poznámky

  • Nápověda a dokumentace je automaticky k dispozici po nainstalování příslušného softwaru.
  • Dokumentace bývá k dohledání také na internetu a stránkách výrobce.