Debian Codegraph @

upstream/mageia-cauldron/man1/pod2usage.1

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "POD2USAGE 1"
61 .TH POD2USAGE 1 2026-05-26 "perl v5.42.0" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 pod2usage \- print usage messages from embedded pod docs in files
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .IP \fBpod2usage\fR 12
71 .IX Item "pod2usage"
72 [\fB\-help\fR]
73 [\fB\-man\fR]
74 [\fB\-exit\fR\ \fIexitval\fR]
75 [\fB\-output\fR\ \fIoutfile\fR]
76 [\fB\-verbose\fR \fIlevel\fR]
77 [\fB\-pathlist\fR \fIdirlist\fR]
78 [\fB\-formatter\fR \fImodule\fR]
79 [\fB\-utf8\fR]
80 \&\fIfile\fR
81 .SH "OPTIONS AND ARGUMENTS"
82 .IX Header "OPTIONS AND ARGUMENTS"
83 .IP \fB\-help\fR 8
84 .IX Item "-help"
85 Prints a brief help message and exit.
86 .IP \fB\-man\fR 8
87 .IX Item "-man"
88 Prints this command\*(Aqs manual page and exit.
89 .IP "\fB\-exit\fR \fIexitval\fR" 8
90 .IX Item "-exit exitval"
91 The exit status value to return.
92 .IP "\fB\-output\fR \fIoutfile\fR" 8
93 .IX Item "-output outfile"
94 The output file to print to. If the special names "\-" or ">&1" or ">&STDOUT"
95 are used then standard output is used. If ">&2" or ">&STDERR" is used then
96 standard error is used.
97 .IP "\fB\-verbose\fR \fIlevel\fR" 8
98 .IX Item "-verbose level"
99 The desired level of verbosity to use:
100 .Sp
101 .Vb 3
102 \& 1 : print SYNOPSIS only
103 \& 2 : print SYNOPSIS sections and any OPTIONS/ARGUMENTS sections
104 \& 3 : print the entire manpage (similar to running pod2text)
105 .Ve
106 .IP "\fB\-pathlist\fR \fIdirlist\fR" 8
107 .IX Item "-pathlist dirlist"
108 Specifies one or more directories to search for the input file if it
109 was not supplied with an absolute path. Each directory path in the given
110 list should be separated by a \*(Aq:\*(Aq on Unix (\*(Aq;\*(Aq on MSWin32 and DOS).
111 .IP "\fB\-formatter\fR \fImodule\fR" 8
112 .IX Item "-formatter module"
113 Which text formatter to use. Default is Pod::Text. An alternative would
114 be e.g. Pod::Text::Termcap.
115 .IP \fB\-utf8\fR 8
116 .IX Item "-utf8"
117 This option assumes that the formatter (see above) understands the option
118 "utf8". It turns on generation of utf8 output.
119 .IP \fIfile\fR 8
120 .IX Item "file"
121 The pathname of a file containing pod documentation to be output in
122 usage message format. If omitted, standard input is read \- but the
123 output is then formatted with Pod::Text only \- unless a specific
124 formatter has been specified with \fB\-formatter\fR.
125 .SH DESCRIPTION
126 .IX Header "DESCRIPTION"
127 \&\fBpod2usage\fR will read the given input file looking for pod
128 documentation and will print the corresponding usage message.
129 If no input file is specified then standard input is read.
130 .PP
131 \&\fBpod2usage\fR invokes the \fBpod2usage()\fR function in the \fBPod::Usage\fR
132 module. Please see "\fBpod2usage()\fR" in Pod::Usage.
133 .SH "SEE ALSO"
134 .IX Header "SEE ALSO"
135 Pod::Usage, pod2text, Pod::Text, Pod::Text::Termcap,
136 perldoc
137 .SH AUTHOR
138 .IX Header "AUTHOR"
139 Please report bugs using <http://rt.cpan.org>.
140 .PP
141 Brad Appleton <[email protected]>
142 .PP
143 Based on code for \fBpod2text\|(1)\fR written by
144 Tom Christiansen <[email protected]>