Softwaredokumentation

Aus Mikiwiki
Zur Navigation springen Zur Suche springen

Zur Softwaredokumentation von Linux gibt es verschiedenste Informationsquellen.

  • Handbücher [engl. manpages] können mit man oder über mit dem Konqueror über den Kioslave man:/ angesehen werden
  • Infoseiten können mit info angesehen werden
  • howtos (Anleitungen zu bestimmten Themen in ASCII-Text) unter "/usr/share" oder "/usr/share/doc" sowie online
  • mini-howtos (kurze howtos, meist spezieller Natur) unter "/usr/share" oder "/usr/share/doc" sowie online
  • FAQs (frequently asked questions) beantworten häufig vorkommende, konkrete Fragen zu einem eng umschriebenen Thema und finden sich unter "/usr/share/doc" sowie online
  • guides (sehr umfangreiche Texte bzw. Bücher, häufig als .ps, .dvi oder .pdf-Dokumente) unter "/usr/share/doc" sowie online
  • Paketinformationen (meist mindestens die Dokumente "README", "TODO", "CHANGES" und "BUGS") unter "/usr/share/doc/packages" oder "/usr/share"
  • help ist ein im Binärcode eingebauter Shellbefehl (z. B. "help type")
  • Optionen (im Binärcode vieler Programme enthalten), z. B.
    • Befehl --help
    • Befehl -h
    • Befehl -?
    • Befehl -v
    • Befehl -V
  • World Wide Web
  • Die Support-Datenbanken der Distributoren bieten Musterlösungen und Antworten auf Fragen, die nur im Zusammenhang mit der betreffenden Distribution auftreten.
  • Die RFCs (requests for comment) informieren genauer über die dem Internet zugrundeliegenden Protokolle und Konzepte.
  • Linux User Groups (LUG)
  • Mailinglisten
  • Newsgruppen

Eigene Dokumentation sollten am besten als einfach les- und umwandelbare Textdateien erstellt werden. Aus Dateien mit Endung ".tex" oder ".dvi" können mit dem Programm "dvi" .pdf-, .ljet- und .ps-Dateien usw. generiert werden (LATEX).

Weblinks

Vorlage:dewi