r1142 - packages/libfortune-perl/trunk/blib/man3

Gustavo Franco stratus@costa.debian.org
Mon, 13 Jun 2005 02:35:21 +0000 

Author: stratus
Date: 2005-06-13 02:35:21 +0000 (Mon, 13 Jun 2005)
New Revision: 1142

Modified:
   packages/libfortune-perl/trunk/blib/man3/Fortune.3pm
Log:
Fortune.3pm rebuilt



Modified: packages/libfortune-perl/trunk/blib/man3/Fortune.3pm
===================================================================
--- packages/libfortune-perl/trunk/blib/man3/Fortune.3pm	2005-06-13 02:33:29 UTC (rev 1141)
+++ packages/libfortune-perl/trunk/blib/man3/Fortune.3pm	2005-06-13 02:35:21 UTC (rev 1142)
@@ -1,8 +1,7 @@
-.\" Automatically generated by Pod::Man version 1.16
-.\" Mon Jun 25 14:13:03 2001
+.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
 .\"
 .\" Standard preamble:
-.\" ======================================================================
+.\" ========================================================================
 .de Sh \" Subsection heading
 .br
 .if t .Sp
@@ -15,12 +14,6 @@
 .if t .sp .5v
 .if n .sp
 ..
-.de Ip \" List item
-.br
-.ie \\n(.$>=3 .ne \\$3
-.el .ne 3
-.IP "\\$1" \\$2
-..
 .de Vb \" Begin verbatim text
 .ft CW
 .nf
@@ -28,15 +21,14 @@
 ..
 .de Ve \" End verbatim text
 .ft R
-
 .fi
 ..
 .\" Set up some character translations and predefined strings.  \*(-- will
 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
 .\" double quote, and \*(R" will give a right double quote.  | will give a
-.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used
-.\" to do unbreakable dashes and therefore won't be available.  \*(C` and
-.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
+.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
+.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
+.\" expand to `' in nroff, nothing in troff, for use with C<>.
 .tr \(*W-|\(bv\*(Tr
 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 .ie n \{\
@@ -56,10 +48,10 @@
 .    ds R" ''
 'br\}
 .\"
-.\" If the F register is turned on, we'll generate index entries on stderr
-.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
-.\" index entries marked with X<> in POD.  Of course, you'll have to process
-.\" the output yourself in some meaningful fashion.
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" entries marked with X<> in POD.  Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
 .if \nF \{\
 .    de IX
 .    tm Index:\\$1\t\\n%\t"\\$2"
@@ -68,14 +60,13 @@
 .    rr F
 .\}
 .\"
-.\" For nroff, turn off justification.  Always turn off hyphenation; it
-.\" makes way too many mistakes in technical documents.
+.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
 .hy 0
 .if n .na
 .\"
 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
-.bd B 3
 .    \" fudge factors for nroff and troff
 .if n \{\
 .    ds #H 0
@@ -135,11 +126,10 @@
 .    ds Ae AE
 .\}
 .rm #[ #] #H #V #F C
-.\" ======================================================================
+.\" ========================================================================
 .\"
-.IX Title "Fortune 3"
-.TH Fortune 3 "perl v5.6.1" "2000-02-26" "User Contributed Perl Documentation"
-.UC
+.IX Title "Fortune 3pm"
+.TH Fortune 3pm "2005-06-12" "perl v5.8.4" "User Contributed Perl Documentation"
 .SH "NAME"
 Fortune \- read and write fortune (strfile) databases
 .SH "SYNOPSIS"
@@ -147,20 +137,22 @@
 .Vb 6
 \&   # input
 \&   $ffile = new Fortune ($base_filename);
-\&   $ffile->read_header ();
-\&   $num_fortunes = $ffile->num_fortunes ();
-\&   $fortune = $ffile->read_fortune ($num);
-\&   $fortune = $ffile->get_random_fortune ();
+\&   $ffile\->read_header ();
+\&   $num_fortunes = $ffile\->num_fortunes ();
+\&   $fortune = $ffile\->read_fortune ($num);
+\&   $fortune = $ffile\->get_random_fortune ();
 .Ve
+.PP
 .Vb 3
-\&   # create header file from data file -- NOT IMPLEMENTED YET
+\&   # create header file from data file \-\- NOT IMPLEMENTED YET
 \&   $ffile = new Fortune ($base_filename);
-\&   $ffile->write_header ();
+\&   $ffile\->write_header ();
 .Ve
+.PP
 .Vb 3
-\&   # write to data file -- NOT IMPLEMENTED YET
+\&   # write to data file \-\- NOT IMPLEMENTED YET
 \&   $ffile = new Fortune (">>$base_filename");
-\&   $ffile->write_fortune ($fortune);
+\&   $ffile\->write_fortune ($fortune);
 .Ve
 .SH "DESCRIPTION"
 .IX Header "DESCRIPTION"
@@ -180,15 +172,17 @@
 \&   # trivial 'fortune' progam
 \&   my $fortune_filename = $ARGV[0];
 \&   my $fortune_file = new Fortune ($fortune_filename);
-\&   $fortune_file->read_header ();
-\&   my $fortune = $fortune_file->get_random_fortune ();
+\&   $fortune_file\->read_header ();
+\&   my $fortune = $fortune_file\->get_random_fortune ();
 \&   print $fortune;
 .Ve
+.PP
 This can be compressed considerably:
 .PP
 .Vb 1
-\&   print new Fortune ($ARGV[0])->read_header()->get_random_fortune();
+\&   print new Fortune ($ARGV[0])\->read_header()\->get_random_fortune();
 .Ve
+.PP
 Of course, this doesn't provide all of \f(CW\*(C`fortune\*(C'\fR's interesting
 features, such as parallel databases of offensive fortunes, selection of
 long or short fortunes, dealing with multiple fortune files, etc.  If
@@ -204,37 +198,38 @@
 \&   # trivial (and hypothetical) 'strfile' program
 \&   my $fortune_filename = @ARGV[0];
 \&   my $fortune_file = new Fortune ($fortune_filename);
-\&   $fortune_file->write_header ();
+\&   $fortune_file\->write_header ();
 .Ve
+.PP
 Note that the header filename is assumed to be just the name of the main
-fortune database, with \f(CW\*(C`".dat"\*(C'\fR appended.  You can supply an alternate
+fortune database, with \f(CW".dat"\fR appended.  You can supply an alternate
 header filename to the constructor, \f(CW\*(C`new()\*(C'\fR, if you wish.
 .SH "METHODS"
 .IX Header "METHODS"
 .Sh "Initialization/cleanup"
 .IX Subsection "Initialization/cleanup"
-.Ip "new (\s-1FILE\s0 [, \s-1HEADER_FILE\s0])" 4
+.IP "new (\s-1FILE\s0 [, \s-1HEADER_FILE\s0])" 4
 .IX Item "new (FILE [, HEADER_FILE])"
 Opens a fortune cookie database.  \s-1FILE\s0 is the name of the data file to
 open, and \s-1HEADER_FILE\s0 (if given) the name of the header file that
 contains (or will contain) meta-data about the fortune database.  If
-\&\s-1HEADER_FILE\s0 is not given, it defaults to \s-1FILE\s0 with \f(CW\*(C`".dat"\*(C'\fR appended.
+\&\s-1HEADER_FILE\s0 is not given, it defaults to \s-1FILE\s0 with \f(CW".dat"\fR appended.
 .Sp
 The data file is opened via \f(CW\*(C`open_file()\*(C'\fR, which \f(CW\*(C`die\*(C'\fRs if the file
 cannot be opened.  The header file is \fInot\fR opened, whether you supply
 its filename or not \*(-- after all, it might not exist yet.  Rather, you
 must explicitly call \f(CW\*(C`read_header()\*(C'\fR or \f(CW\*(C`write_header()\*(C'\fR as
 appropriate.
-.Ip "open_file ()" 4
+.IP "open_file ()" 4
 .IX Item "open_file ()"
 Opens the fortune file whose name was supplied to the constructor.  Dies
 on failure.
-.Ip "close_file ()" 4
+.IP "close_file ()" 4
 .IX Item "close_file ()"
 Closes the fortune file if it's open; does nothing otherwise.
 .Sh "Header functions (read and write)"
 .IX Subsection "Header functions (read and write)"
-.Ip "read_header ()" 4
+.IP "read_header ()" 4
 .IX Item "read_header ()"
 Reads the header file associated with this fortune database.  The name
 of the header file is determined by the constructor \f(CW\*(C`new\*(C'\fR: either it is
@@ -246,28 +241,28 @@
 The header contains the following values, which are stored as attributes
 of the \f(CW\*(C`Fortune\*(C'\fR object:
 .RS 4
-.if n .Ip "\f(CW""""version""""\fR" 4
-.el .Ip "\f(CWversion\fR" 4
+.ie n .IP """version""" 4
+.el .IP "\f(CWversion\fR" 4
 .IX Item "version"
 version number
-.if n .Ip "\f(CW""""numstr""""\fR" 4
-.el .Ip "\f(CWnumstr\fR" 4
+.ie n .IP """numstr""" 4
+.el .IP "\f(CWnumstr\fR" 4
 .IX Item "numstr"
 number of strings (fortunes) in the file
-.if n .Ip "\f(CW""""max_length""""\fR" 4
-.el .Ip "\f(CWmax_length\fR" 4
+.ie n .IP """max_length""" 4
+.el .IP "\f(CWmax_length\fR" 4
 .IX Item "max_length"
 length of longest string in the file
-.if n .Ip "\f(CW""""min_length""""\fR" 4
-.el .Ip "\f(CWmin_length\fR" 4
+.ie n .IP """min_length""" 4
+.el .IP "\f(CWmin_length\fR" 4
 .IX Item "min_length"
 length of shortest string in the file
-.if n .Ip "\f(CW""""flags""""\fR" 4
-.el .Ip "\f(CWflags\fR" 4
+.ie n .IP """flags""" 4
+.el .IP "\f(CWflags\fR" 4
 .IX Item "flags"
 bit field for flags (see \fIstrfile\fR\|(1) man page)
-.if n .Ip "\f(CW""""delim""""\fR" 4
-.el .Ip "\f(CWdelim\fR" 4
+.ie n .IP """delim""" 4
+.el .IP "\f(CWdelim\fR" 4
 .IX Item "delim"
 character that delimits fortunes
 .RE
@@ -279,16 +274,17 @@
 .Sp
 .Vb 3
 \&   $fortune_file = new Fortune ('fortunes');
-\&   $fortune_file->read_header ();
-\&   $delim = $fortune_file->{'delim'};
+\&   $fortune_file\->read_header ();
+\&   $delim = $fortune_file\->{'delim'};
 .Ve
+.Sp
 \&\f(CW\*(C`read_header()\*(C'\fR \f(CW\*(C`die\*(C'\fRs if there are any problems reading the header file,
 e.g. if it seems to be corrupt or truncated.
 .Sp
 \&\f(CW\*(C`read_header()\*(C'\fR returns the current \f(CW\*(C`Fortune\*(C'\fR object, to allow for
 sneaky one-liners (see the examples above).
 .RE
-.Ip "compute_header ([\s-1DELIM\s0])" 4
+.IP "compute_header ([\s-1DELIM\s0])" 4
 .IX Item "compute_header ([DELIM])"
 Reads the contents of the fortune file and computes the header
 information that would normally be found in a header (\fI.dat\fR) file.
@@ -300,29 +296,29 @@
 file.  If not provided, the existing \f(CW\*(C`delim\*(C'\fR attribute of the Fortune
 object will be used.  If that is not defined, then a percent sign (\*(L"%\*(R")
 will be used.
-.Ip "num_fortunes ()" 4
+.IP "num_fortunes ()" 4
 .IX Item "num_fortunes ()"
 Returns the number of fortunes found by \f(CW\*(C`read_header()\*(C'\fR.
-.Ip "write_header ([\s-1DELIM\s0])" 4
+.IP "write_header ([\s-1DELIM\s0])" 4
 .IX Item "write_header ([DELIM])"
 is not yet implemented.
 .Sh "Fortune input"
 .IX Subsection "Fortune input"
-.Ip "get_fortune (\s-1NUM\s0)" 4
+.IP "get_fortune (\s-1NUM\s0)" 4
 .IX Item "get_fortune (NUM)"
-Reads string number \s-1NUM\s0 from the open fortune file.  \s-1NUM\s0 is zero-based,
+Reads string number \s-1NUM\s0 from the open fortune file.  \s-1NUM\s0 is zero\-based,
 ie. it must be between 0 and \f(CW\*(C`num_fortunes()\-1\*(C'\fR (inclusive).  \f(CW\*(C`croak\*(C'\fRs if
 you haven't opened the file and read the header, or if \s-1NUM\s0 is out of range.
 (Opening the file is pretty hard to screw up, since it's taken care of for
 you by the constructor, but you have to read the header explicitly with
 \&\f(CW\*(C`read_header()\*(C'\fR.)  Returns the text of the fortune as a (possibly)
 multiline string.
-.Ip "get_random_fortune ()" 4
+.IP "get_random_fortune ()" 4
 .IX Item "get_random_fortune ()"
 Picks a random fortune for you and reads it with \f(CW\*(C`read_fortune()\*(C'\fR.
 .Sh "Fortune output"
 .IX Subsection "Fortune output"
-.Ip "write_fortune (\s-1FORTUNE\s0)" 4
+.IP "write_fortune (\s-1FORTUNE\s0)" 4
 .IX Item "write_fortune (FORTUNE)"
 is not yet implemented.
 .SH "AUTHOR AND COPYRIGHT"
@@ -339,6 +335,7 @@
 .Vb 1
 \&   http://starship.python.net/~gward/perl/
 .Ve
+.PP
 and it can also be found on \s-1CPAN\s0.
 .PP
 If you are using an operating system lacking a sufficient sense of
@@ -351,5 +348,6 @@
 .Vb 1
 \&   http://www.progsoc.uts.edu.au/~dbugger/hacks/hacks.html
 .Ve
+.PP
 This is the \f(CW\*(C`fortune\*(C'\fR implementation on which the \f(CW\*(C`Fortune\*(C'\fR module is
 based.