Penguin
Hide Sidebar Hide Ads Recent Changes
Blame: podchecker(1)
EditPageHistoryDiffInfoLikePages
Annotated edit history of podchecker(1) version 1 showing authors affecting page license. View with all changes included.
Rev Author # Line
1 perry 1 PODCHECKER
2 !!!PODCHECKER
3 NAME
4 SYNOPSIS
5 OPTIONS AND ARGUMENTS
6 DESCRIPTION
7 RETURN VALUE
8 ERRORS
9 SEE ALSO
10 AUTHORS
11 ----
12 !!NAME
13
14
15 podchecker - check the syntax of POD format documentation files
16 !!SYNOPSIS
17
18
19 __podchecker__ [[__-help__] [[__-man__]
20 [[__-(no)warnings__] [[''file'' ...]
21 !!OPTIONS AND ARGUMENTS
22
23
24 __-help__
25
26
27 Print a brief help message and exit.
28
29
30 __-man__
31
32
33 Print the manual page and exit.
34
35
36 __-warnings -nowarnings__
37
38
39 Turn on/off printing of warnings. Repeating __-warnings__
40 increases the warning level, i.e. more warnings are printed.
41 Currently increasing to level two causes flagging of
42 unescaped __
43
44
45 ''file''
46
47
48 The pathname of a POD file to syntax-check
49 (defaults to standard input).
50 !!DESCRIPTION
51
52
53 __podchecker__ will read the given input files looking
54 for POD syntax errors in the
55 POD documentation and will print any errors
56 it find to STDERR . At the end, it will print
57 a status message indicating the number of errors
58 found.
59
60
61 Directories are ignored, an appropriate warning message is
62 printed.
63
64
65 __podchecker__ invokes the ''podchecker()'' function
66 exported by __Pod::Checker__ Please see
67 ``''podchecker()'''' in Pod::Checker for more
68 details.
69 !!RETURN VALUE
70
71
72 __podchecker__ returns a 0 (zero) exit status if all
73 specified POD files are ok.
74 !!ERRORS
75
76
77 __podchecker__ returns the exit status 1 if at least one
78 of the given POD files has syntax
79 errors.
80
81
82 The status 2 indicates that at least one of the specified
83 files does not contain ''any'' POD
84 commands.
85
86
87 Status 1 overrides status 2. If you want unambigouus
88 results, call __podchecker__ with one single argument
89 only.
90 !!SEE ALSO
91
92
93 Pod::Parser and Pod::Checker
94 !!AUTHORS
95
96
97 Brad Appleton
98
99
100 Based on code for ''Pod::Text::pod2text''__(1)__
101 written by Tom Christiansen
102 __
103 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.