Debian Codegraph @

upstream/debian-unstable/man1/pod2usage.1

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (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 .\"
57 .IX Title "POD2USAGE 1"
58 .TH POD2USAGE 1 2026-04-10 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 pod2usage \- print usage messages from embedded pod docs in files
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .IP \fBpod2usage\fR 12
68 .IX Item "pod2usage"
69 [\fB\-help\fR]
70 [\fB\-man\fR]
71 [\fB\-exit\fR\ \fIexitval\fR]
72 [\fB\-output\fR\ \fIoutfile\fR]
73 [\fB\-verbose\fR \fIlevel\fR]
74 [\fB\-pathlist\fR \fIdirlist\fR]
75 [\fB\-formatter\fR \fImodule\fR]
76 [\fB\-utf8\fR]
77 \&\fIfile\fR
78 .SH "OPTIONS AND ARGUMENTS"
79 .IX Header "OPTIONS AND ARGUMENTS"
80 .IP \fB\-help\fR 8
81 .IX Item "-help"
82 Print a brief help message and exit.
83 .IP \fB\-man\fR 8
84 .IX Item "-man"
85 Print this command's manual page and exit.
86 .IP "\fB\-exit\fR \fIexitval\fR" 8
87 .IX Item "-exit exitval"
88 The exit status value to return.
89 .IP "\fB\-output\fR \fIoutfile\fR" 8
90 .IX Item "-output outfile"
91 The output file to print to. If the special names "\-" or ">&1" or ">&STDOUT"
92 are used then standard output is used. If ">&2" or ">&STDERR" is used then
93 standard error is used.
94 .IP "\fB\-verbose\fR \fIlevel\fR" 8
95 .IX Item "-verbose level"
96 The desired level of verbosity to use:
97 .Sp
98 .Vb 3
99 \& 1 : print SYNOPSIS only
100 \& 2 : print SYNOPSIS sections and any OPTIONS/ARGUMENTS sections
101 \& 3 : print the entire manpage (similar to running pod2text)
102 .Ve
103 .IP "\fB\-pathlist\fR \fIdirlist\fR" 8
104 .IX Item "-pathlist dirlist"
105 Specifies one or more directories to search for the input file if it
106 was not supplied with an absolute path. Each directory path in the given
107 list should be separated by a ':' on Unix (';' on MSWin32 and DOS).
108 .IP "\fB\-formatter\fR \fImodule\fR" 8
109 .IX Item "-formatter module"
110 Which text formatter to use. Default is Pod::Text, or for very old
111 Perl versions Pod::PlainText. An alternative would be e.g.
112 Pod::Text::Termcap.
113 .IP \fB\-utf8\fR 8
114 .IX Item "-utf8"
115 This option assumes that the formatter (see above) understands the option
116 "utf8". It turns on generation of utf8 output.
117 .IP \fIfile\fR 8
118 .IX Item "file"
119 The pathname of a file containing pod documentation to be output in
120 usage message format. If omitted, standard input is read \- but the
121 output is then formatted with Pod::Text only \- unless a specific
122 formatter has been specified with \fB\-formatter\fR.
123 .SH DESCRIPTION
124 .IX Header "DESCRIPTION"
125 \&\fBpod2usage\fR will read the given input file looking for pod
126 documentation and will print the corresponding usage message.
127 If no input file is specified then standard input is read.
128 .PP
129 \&\fBpod2usage\fR invokes the \fBpod2usage()\fR function in the \fBPod::Usage\fR
130 module. Please see "\fBpod2usage()\fR" in Pod::Usage.
131 .SH "SEE ALSO"
132 .IX Header "SEE ALSO"
133 Pod::Usage, pod2text, Pod::Text, Pod::Text::Termcap,
134 perldoc
135 .SH AUTHOR
136 .IX Header "AUTHOR"
137 Please report bugs using <http://rt.cpan.org>.
138 .PP
139 Brad Appleton <[email protected]>
140 .PP
141 Based on code for \fBpod2text\|(1)\fR written by
142 Tom Christiansen <[email protected]>