Changeset 2591 for trunk/doc/misc/foo.pl

Timestamp:

Dec 1, 2004, 12:34:23 PM (22 years ago)

Author:

jhoblitt

Message:

only use source code I hold the copyright on for examples
LaTeX formatting
document formatting
grammar and spelling fixes
misc example corrections
misc corrections
moved example source code to appendix
added several new programming practices

File:

• trunk/doc/misc/foo.pl (modified) (2 diffs)

trunk/doc/misc/foo.pl

@@ -1 +1 @@
 #!/usr/bin/perl
 
-# Copyright (C) 2004  Joshua Hoblitt
+# Copyright (C) 2004  Author's Name
 #
 # $Id$
@@ -25 +25 @@
 __END__
 
-...
+=pod
+
+=head1 NAME
+
+foo.pl - Does something with Baz.
+
+=head1 SYNOPSIS
+
+    foo.pl --baz
+
+    ...
+
+=head1 DESCRIPTION
+
+=head1 OPTIONS
+
+=over 4
+
+=item * --baz
+
+=back
+
+=head1 DEVELOPER NOTES
+
+=head1 REFERENCES
+
+=head1 CREDITS
+
+Just me, myself, and I.
+
+=head1 SUPPORT
+
+Please contact the author directly via e-mail.
+
+=head1 AUTHOR
+
+Principle authors and contact info.
+
+=head1 COPYRIGHT
+
+Copyright (C) 2004  Author's Name.  All rights reserved.
+
+This program is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free Software
+Foundation; either version 2 of the License, or (at your option) any later
+version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with
+this program; if not, write to the Free Software Foundation, Inc., 59 Temple
+Place - Suite 330, Boston, MA  02111-1307, USA.
+
+The full text of the license can be found in the L<perlgpl> Pod as supplied
+with Perl 5.8.1 and later.
+
+=head1 SEE ALSO
+
+L<Bar::Baz>
+
+=cut