diff options
Diffstat (limited to 'upstream/mageia-cauldron/man1/pod2usage.1')
| -rw-r--r-- | upstream/mageia-cauldron/man1/pod2usage.1 | 142 |
1 files changed, 142 insertions, 0 deletions
diff --git a/upstream/mageia-cauldron/man1/pod2usage.1 b/upstream/mageia-cauldron/man1/pod2usage.1 new file mode 100644 index 00000000..6c095656 --- /dev/null +++ b/upstream/mageia-cauldron/man1/pod2usage.1 @@ -0,0 +1,142 @@ +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. +.ie n \{\ +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds C` +. ds C' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is >0, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.\" +.\" Avoid warning from groff about undefined register 'F'. +.de IX +.. +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} +. \} +.\} +.rr rF +.\" ======================================================================== +.\" +.IX Title "POD2USAGE 1" +.TH POD2USAGE 1 2023-12-15 "perl v5.38.2" "Perl Programmers Reference Guide" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH NAME +pod2usage \- print usage messages from embedded pod docs in files +.SH SYNOPSIS +.IX Header "SYNOPSIS" +.IP \fBpod2usage\fR 12 +.IX Item "pod2usage" +[\fB\-help\fR] +[\fB\-man\fR] +[\fB\-exit\fR\ \fIexitval\fR] +[\fB\-output\fR\ \fIoutfile\fR] +[\fB\-verbose\fR \fIlevel\fR] +[\fB\-pathlist\fR \fIdirlist\fR] +[\fB\-formatter\fR \fImodule\fR] +[\fB\-utf8\fR] +\&\fIfile\fR +.SH "OPTIONS AND ARGUMENTS" +.IX Header "OPTIONS AND ARGUMENTS" +.IP \fB\-help\fR 8 +.IX Item "-help" +Print a brief help message and exit. +.IP \fB\-man\fR 8 +.IX Item "-man" +Print this command's manual page and exit. +.IP "\fB\-exit\fR \fIexitval\fR" 8 +.IX Item "-exit exitval" +The exit status value to return. +.IP "\fB\-output\fR \fIoutfile\fR" 8 +.IX Item "-output outfile" +The output file to print to. If the special names "\-" or ">&1" or ">&STDOUT" +are used then standard output is used. If ">&2" or ">&STDERR" is used then +standard error is used. +.IP "\fB\-verbose\fR \fIlevel\fR" 8 +.IX Item "-verbose level" +The desired level of verbosity to use: +.Sp +.Vb 3 +\& 1 : print SYNOPSIS only +\& 2 : print SYNOPSIS sections and any OPTIONS/ARGUMENTS sections +\& 3 : print the entire manpage (similar to running pod2text) +.Ve +.IP "\fB\-pathlist\fR \fIdirlist\fR" 8 +.IX Item "-pathlist dirlist" +Specifies one or more directories to search for the input file if it +was not supplied with an absolute path. Each directory path in the given +list should be separated by a ':' on Unix (';' on MSWin32 and DOS). +.IP "\fB\-formatter\fR \fImodule\fR" 8 +.IX Item "-formatter module" +Which text formatter to use. Default is Pod::Text, or for very old +Perl versions Pod::PlainText. An alternative would be e.g. +Pod::Text::Termcap. +.IP \fB\-utf8\fR 8 +.IX Item "-utf8" +This option assumes that the formatter (see above) understands the option +"utf8". It turns on generation of utf8 output. +.IP \fIfile\fR 8 +.IX Item "file" +The pathname of a file containing pod documentation to be output in +usage message format. If omitted, standard input is read \- but the +output is then formatted with Pod::Text only \- unless a specific +formatter has been specified with \fB\-formatter\fR. +.SH DESCRIPTION +.IX Header "DESCRIPTION" +\&\fBpod2usage\fR will read the given input file looking for pod +documentation and will print the corresponding usage message. +If no input file is specified then standard input is read. +.PP +\&\fBpod2usage\fR invokes the \fBpod2usage()\fR function in the \fBPod::Usage\fR +module. Please see "\fBpod2usage()\fR" in Pod::Usage. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +Pod::Usage, pod2text, Pod::Text, Pod::Text::Termcap, +perldoc +.SH AUTHOR +.IX Header "AUTHOR" +Please report bugs using <http://rt.cpan.org>. +.PP +Brad Appleton <bradapp@enteract.com> +.PP +Based on code for \fBpod2text\|(1)\fR written by +Tom Christiansen <tchrist@mox.perl.com> |