[linux-l] Re: Linux - Dokumentationsstandard?

[Peter Ross]

On Thu, 7 Apr 2005, Sven Guckes wrote:

> welches dokumentationsmittel haetten
> wir denn nun gern als *standard*?

Schau mal unter http://www.freebsd.org/cgi/man.cgi nach, wieviele Systeme
Manpages benutzen (es sind lange nicht alle auf der Seite)

Es ist bewaehrt und ueberall einsetzbar, selbst mit dem duemssten Terminal
(was fuer den Serverraum wichtig ist).

Die Aufteilung der einzelnen Kapitel ist weitgehend standardisiert, nicht
erst seit gestern, so dass sich jeder Nutzer schnell zurechtfindet.

Dadurch, dass man etwas von Anfang zu Ende durchlesen kann, entfaellt die
"Moeglichkeit", den passenden Menuepunkt zu uebersehen, dank des Pagers
(less or more;-) gibt es ausgefeilte Suchfunktionalitaet ueber die gesamte
Dokumentation zu einem Kommando/Fileformat etc.

Ja, es implementiert Hyperlinks nicht direkt, stattdessen steht am Ende
eine "SEE ALSO"-Rubrik, welche Hyperlinks anbietet, die durch einen
weiteren Aufruf von man einfach erreichbar sind.

Diese leichte Unbequemlichkeit ist fuer mich nicht ausreichend Grund, um
stattdessen mich durch ein Sammelsurium von Alternativen durchschlagen zu
muessen, um endlich eine Info zu bekommen.

Die funktionalen Unterschiede unterschiedlicher Formate sind marginal,
fuer mich sind daher Standardisierung (sprich Verfuegbarkeit ueberall),
Uebersichtlichkeit (nichts ist versteckt unter Menupunkt 7.5.4.2) minimale
Anforderungen an Ein- und Ausgabe (Stichwort dummes Terminal) und
Lokalitaet (sprich: auf Platte und nicht irgendwo im Netz) wichtiger.

Und da schneidet man(1) am besten ab..

Gruss
Peter