[go: up one dir, main page]

File: cppi.1

package info (click to toggle)
cppi 1.18-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,936 kB
  • sloc: ansic: 12,443; sh: 7,551; lex: 850; perl: 173; makefile: 47; sed: 16
file content (87 lines) | stat: -rw-r--r-- 2,720 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.40.12.
.TH CPPI "1" "March 2013" "cppi 1.18" "User Commands"
.SH NAME
cppi \- indent the C preprocessor directives in FILE to reflect their nesting
.SH SYNOPSIS
.B cppi
[\fIFILE\fR]
.br
.B cppi
\fI-c \fR[\fIOPTION\fR] [\fIFILE\fR]...
.SH DESCRIPTION
.\" Add any additional description here
.PP
Indent the C preprocessor directives in FILE to reflect their nesting
and ensure that there is exactly one space character between each #if,
#elif, #define directive and the following token, and write the result
to standard output.  The number of spaces between the `#' and the following
directive must correspond to the level of nesting of that directive.
With no FILE, or when FILE is \-, read standard input.
.TP
\fB\-a\fR, \fB\-\-ansi\fR
when checking, fail if text follows #else or #endif
.TP
\fB\-c\fR, \fB\-\-check\fR
set exit code, but don't produce any output
.TP
\fB\-l\fR, \fB\-\-list\-files\-only\fR
don't generate diagnostics about indentation;
print to stdout only the names of files that
are not properly indented
.TP
\fB\-m\fR, \fB\-\-max\-string\-length\fR=\fILENGTH\fR
fail if there is a double\-quoted string longer
than LENGTH;  if LENGTH is 0 (the default),
then there is no limit
.TP
\fB\-\-help\fR
display this help and exit
.TP
\fB\-\-version\fR
output version information and exit
.PP
With the \fB\-c\fR option, don't write to stdout.  Instead, check the
indentation of the specified files giving diagnostics for preprocessor
lines that aren't properly indented or are otherwise invalid.
.PP
Note that \fB\-\-ansi\fR without \fB\-\-check\fR does not correct the problem of
non\-ANSI text following #else and #endif directives.
.SS "The exit code will be one of these:"
.TP
0
all directives properly indented
.TP
1
some cpp directive(s) improperly indented, or
text follows #else/#endif (enabled with \fB\-\-check\fR \fB\-\-ansi\fR), or
a double\-quoted string is longer than the specified maximum
.TP
2
#if/#endif mismatch, EOF in comment or string
.TP
3
file (e.g. open/read/write) error
.PP
A pragma directive may have its `#' indented.
.SH AUTHOR
Written by Jim Meyering.
.SH "REPORTING BUGS"
Report bugs to <bug\-cppi@gnu.org>.
.SH COPYRIGHT
Copyright \(co 2013 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.
.br
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
.SH "SEE ALSO"
The full documentation for
.B cppi
is maintained as a Texinfo manual.  If the
.B info
and
.B cppi
programs are properly installed at your site, the command
.IP
.B info cppi
.PP
should give you access to the complete manual.