as 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:
=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<Kursiver Text>
=item *
B<Fetter Text>
=item *
Mit SE<lt>TextE<gt> wird ein nicht umbrechbarer Text erzeugt, E<auml>hnlich wie
C<amp>nbsp in HTML: S<Nicht umbrechbarer Text>.
=item *
Dies ist ein C<Code-Text, kein Snippet>.
=item *
Mit LZ<>E<lt>Linktext|E<quot>SectionnameE<quot>E<gt> ein C<Link>: L<Linktext|"Bild">
=item *
Und ZZ<>E<lt>Z<>E<gt> erzeugt ein "Null"-Zeichen, also "Nichts".
=back
=head2 Bild
=for html
<img src="logo.png" />
=begin text
.~. <-- Der Linux-Pinguin!
/V\
// \\
/( )\
^`~'^
=end text
=over 4
=item 1
Verschachtelte Listen
=over 8
=item *
Und ein E<lt>-Zeichen oder E<Agrave>.
=back
=item 2
blabla... schwafel...
=back
blabla.
Ende.
Die Ausgabe im Text-Format:
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.
Kursiver TextFetter Text
Mit S<Text> wird ein nicht umbrechbarer Text erzeugt, ähnlich wie
ampnbsp in HTML: Nicht umbrechbarer Text.
Dies ist ein Code-Text, kein Snippet.
Mit L<Linktext|"Sectionname"> ein Link: Linktext
Und Z<> erzeugt ein ``Null''-Zeichen, also ``Nichts''.
Auf diese Weise können Sie schnell Manpages schreiben, welche Sie dann mit
einem Alias, der in dem Artikel "Alias" (siehe "Verwandte
Artikel", oben rechts) bereits beschrieben worden ist, anzeigen
können. Sie müssen jediglich den Befehl
pod2man eingabe.pod > ausgabe.man ausführen.
Für weitere Informationen siehe die perlpod(1) Manpage.
Document Informations:
Content-Type: text/html; charset=iso-8859-1
Author: Ingo Blechschmidt
Description: LinuxGuide - Sie wollen Manpages selbst erstellen. Mit pod2man (Plain Old Documentaion
to Manual Page) funktioniert dies sehr schnell.
Keywords: Manpage, Manpages, selbst, erstellen, pod, pod2man, man, nroff, troff, groff, Man-Page, POD, POD-Format, LinuxGuide
Robots: all
Copyright: Copyright (C) 2002 by Ingo Blechschmidt
Date: 2003-08-07T09:48:30+02:00
Druckbare Version
