next up previous index
suivant: Les formats monter: Le format de documentation précédent: Intégration dans du code   Index

Exemple

Un exemple est beaucoup plus parlant. En voilà quelques lignes, tirées d'un programme existant :

=head1 NAME

clean - clean your account...

=head1 SYNOPSIS

B<clean> [options] [directory]

with options in:

=over 4

[B<-a>] [B<-all>]
[B<-c>] [B<-check-only>]
[B<-d>] [B<-default>]
[B<-e>] [B<-delete-empty-dir>]
[B<-f>I<[filename]>] [B<-output>I<[=filename]>]
[...]
[B<-V>] [B<-version>]

=back

=head1 OPTIONS

[...]

On voit ici apparaître diverses sections standard dans les pages de manuel UNIX : NAME, SYNOPSIS, OPTIONS, DESCRIPTION, NOTES, ENVIRONMENT, FILES, AUTHOR, BUGS.

De nombreux exemples sont disponibles également dans toute distribution de perl : la documentation est au format POD. Elle se trouve généralement dans le répertoire /usr/local/lib/perl5/pod/, ou /usr/lib/perl5/pod/.



Olivier Aubert
1999-06-01