--------------------------------Linux Guide---------------------------------- by Ingo Blechschmidt (c) 2002 ----------------------------------------------------------------------------- ------------------------- Manpages erstellen ------------------------- Die Aug 7 09:48:30 MEST 2001 ------------------------- Manpage Manpages selbst erstellen pod pod2man man nroff troff groff Man-Page POD POD-Format ----------------------------------------------------------------------------- Sie wollen Manpages selbst erstellen. Mit pod2man (Plain Old Documentaion to Manual Page) funktioniert dies sehr schnell. ----------------------------------------------------------------------------- Das POD-Format (Plain Old Documentation) ist das Dokumentationsformat von Perl. Es gibt sehr viele Converter, z.B. pod2man, pod2html, pod2text, pod2latex, und so weiter, die es ermöglichen, das POD-Format in viele Standard-Formate zu konvertieren. Das POD-Format ist denkbar einfach: --------CODE--------: siehe <"down/podvorlage.pod">beispiel.pod =head1 Hauptüberschrift Einleitung =head2 Unterüberschrift gefasel... Code-Snippet =over 4 =item 1 Listeneintrag =item 2 Listeneintrag =pod Text, der nicht von POD verarbeitet wird. =cut =back blabla... Formatierungsmöglichkeiten: =over 4 =item * I =item * B =item * Mit SETextE wird ein nicht umbrechbarer Text erzeugt, Ehnlich wie Cnbsp in HTML: S. =item * Dies ist ein C. =item * Mit LZ<>ELinktext|ESectionnameEE ein C: L =item * Und ZZ<>EZ<>E erzeugt ein "Null"-Zeichen, also "Nichts". =back =head2 Bild =for html

=begin text .~. <-- Der Linux-Pinguin! /V\ // \\ /( )\ ^`~'^ =end text =over 4 =item 1 Verschachtelte Listen =over 8 =item * Und ein E-Zeichen oder E. =back =item 2 blabla... schwafel... =back blabla. Ende. --------/CODE-------- Die Ausgabe im Text-Format: --------CODE--------: beispiel.txt Hauptüberschrift Einleitung Unterüberschrift gefasel... Code-Snippet 1 Listeneintrag 2 Listeneintrag Text, der nicht von POD verarbeitet wird. blabla... Formatierungsmöglichkeiten: * *Kursiver Text* * Fetter Text * Mit S wird ein nicht umbrechbarer Text erzeugt, ähnlich wie "amp"nbsp in HTML: Nicht umbrechbarer Text. * Dies ist ein "Code-Text, kein Snippet". * Mit L ein "Link": Linktext * Und Z<> erzeugt ein "Null"-Zeichen, also "Nichts". Bild .~. <-- Der Linux-Pinguin! /V\ // \\ /( )\ ^`~'^ 1 Verschachtelte Listen * Und ein <-Zeichen oder À. 2 blabla... schwafel... blabla. Ende. --------/CODE-------- Die Ausgabe im HTML-Format: --------CODE--------: beispiel.html

* siehe <"#hauptüberschrift">Hauptüberschrift * siehe <"#unterüberschrift">Unterüberschrift * siehe <"#bild">Bild