Linux

Documentatie

Leerdoelen

• Kennismaking met documentatie systeem op Linux

Manual pages

man man

1. Executable programs or shell commands
2. System calls (functions provided by the kernel)
3. Library calls (functions within program libraries)
4. Special files (usually found in /dev)
5. File formats and conventions (eg /etc/passwd)
6. Games
7. Miscellaneous (macro's and conventions)
8. System administration commands
9. Kernel routines [Non standard]

Structuur manual-page

• Vaak de volgende stukken:
  • NAME: naam van het commando, plus korte uitleg
  • SYNOPSIS: syntax van het commando
  • DESCRIPTION: hopelijk een complete beschrijving van een commando
  • OPTIONS: welke opties kent het commando
  • EXAMPLES: hoe het commando te gebruiken
  • AUTHORS: wie heeft de manual-page geschreven
  • SEE ALSO: verwijzingen naar andere documentatie

Bedienen van man

• q = quit
• h = help
• /zoek
• Space = page down
• Page Up, Page Down = page up, down
• Pijltjes up en down toetsen = regel up en down

Synopsis

• {optie} – verplichte optie
  • {optie1|optie2} – kies optie 1 of 2
• [o] – optioneel
  • [o|p] – keuze tussen o, p of geen
  • [op] – o en/of p of geen van beide is een optie

Zoeken naar hulp

• Zoeken naar een bepaalde functie (apropos)

  man -k <functie>

• Korte beschrijving van een commando (whatis)

  man -f <commando>

• Waar is een man-page of een commando

  whereis <commando>

  which <commando>
  

• Commando opties die vaak werken
  • -h
  • --help

/usr/share/doc

• Documentatie behorende bij een geïnstalleerd pakket
• Documentatie van de ontwikkelaars en de packager
  • README
  • NEWS
  • changelog
  • FAQ
  • copyright
  • En eventueel (default) configuratie bestanden
• Bestanden kunnen gegzipped zijn

info

• Niet meer standaard geïnstalleerd
• Een documentatie systeem gebaseerd op hypertext
• Pijltjes toetsten om te scrollen
• Enter – volgt een link
• q – verlaat info

Het is Open Source

• Veel informatie op het Internet
• Source Code in github, sourceforge, etc.
• Google!
  • De kans is klein dat je de eerste bent

Samenvatting

• We hebben geleerd hoe we met man documentatie kunnen opvragen
• We hebben geleerd hoe we met dat extra documentatie gevonden kan worden in /usr/share/doc
• We weten dat er ook nog info is
• We kunnen zoek-machines en chatbots gebruiken voor meer informatie