Richtlinien zur Erstellung deutscher Handbuchseiten
Kapitel 2 - Übersetzung der Seiten

2.1 Formatierungen

Die Handbuchseiten werden vor dem Anzeigen compiliert bzw. übersetzt und ansprechend formatiert. Informationen für die Formatierung befinden sich im Quellcode, der eigentlichen Manpage. Historisch bedingt wird roff (bzw. groff unter GNU/Linux) für die Formatierung verwendet. Das erfolgt vollautomatisch vom Programm man.

Aus diesem Grund enthalten die Handbuchseiten verschiedene Formatanweisungen, die in der Übersetzung erhalten bleiben sollten. Die formatierten Texte werden übersetzt und mit den gleichen Anweisungen formatiert. Daher wird nicht die Ausgabe von man übersetzt sondern die zugrundeliegende Textdatei.

Der Quellcode von Handbuchseiten ist eine herkömmliche Textdatei, so daß ein beliebiger Editor für die Arbeit verwendet wird. Es werden keine Spezialprogramme benötigt, weder für die Übersetzung noch für das spätere Anzeigen der Handbuchseiten.

Die Bedeutung der verschiedenen Formatanweisungen wird in man(7) beschrieben. Es ist dort relativ leicht zu sehen, daß nur wenige Anweisungen ausreichen, um Handbuchseiten so zu formatieren, wie man es gewohnt ist.

2.2 Hilfsmittel

Das Shell-Skript manpages-de-prepare überträgt die Struktur (z.B. .SH Überschriften) einer Manpage ins Deutsche. Probiert es aus, wenn etwas nicht funktioniert, bitte Mail an mich.

2.3 Kopfzeile

Kopfzeilen sehen wie folgt aus:

      .TH GLOB 3 "13. Mai 1996" "GNU" "Bibliotheksfunktionen"

Bitte denkt dran, das Datum zu ändern, wenn ihr die Seite übersetzt habt. Der Text vor der Kopfzeile, also die jeweilige Policy, Änderungen etc. sollen nicht mit übersetzt werden. Jedoch soll sich der oder die Übersetzer/in hier verewigen mit einer Zeile ähnlich der folgenden Zeile:

       .\" Translated into german by Martin Schulze <joey@infodrom.org>

Zwischen diesen Kommentaren und der o.g. Kopfzeile soll eine leere Kommentarzeile stehen:

       .\"

2.4 Änderungen

Wenn ihr Fehler in den Handbuchseiten entdeckt, inhaltliche oder formelle, dann ändert sie bitte und schickt Michael Kerrisk den Patch.

Richtlinien zur Erstellung deutscher Handbuchseiten