Commit | Line | Data |
---|---|---|
c3facf4a WJ |
1 | .\" Copyright (c) 1985, 1991 The Regents of the University of California. |
2 | .\" All rights reserved. | |
3 | .\" | |
4 | .\" This code is derived from software contributed to Berkeley by | |
5 | .\" Dave Yost. | |
6 | .\" | |
7 | .\" Redistribution and use in source and binary forms, with or without | |
8 | .\" modification, are permitted provided that the following conditions | |
9 | .\" are met: | |
10 | .\" 1. Redistributions of source code must retain the above copyright | |
11 | .\" notice, this list of conditions and the following disclaimer. | |
12 | .\" 2. Redistributions in binary form must reproduce the above copyright | |
13 | .\" notice, this list of conditions and the following disclaimer in the | |
14 | .\" documentation and/or other materials provided with the distribution. | |
15 | .\" 3. All advertising materials mentioning features or use of this software | |
16 | .\" must display the following acknowledgement: | |
17 | .\" This product includes software developed by the University of | |
18 | .\" California, Berkeley and its contributors. | |
19 | .\" 4. Neither the name of the University nor the names of its contributors | |
20 | .\" may be used to endorse or promote products derived from this software | |
21 | .\" without specific prior written permission. | |
22 | .\" | |
23 | .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | |
24 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
25 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
26 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | |
27 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
28 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
29 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
30 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |
31 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |
32 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |
33 | .\" SUCH DAMAGE. | |
34 | .\" | |
35 | .\" @(#)unifdef.1 6.5 (Berkeley) 4/23/91 | |
36 | .\" | |
37 | .Dd April 23, 1991 | |
38 | .Dt UNIFDEF 1 | |
39 | .Os BSD 4.3 | |
40 | .Sh NAME | |
41 | .Nm unifdef | |
42 | .Nd remove ifdef'ed lines | |
43 | .Sh SYNOPSIS | |
44 | .Nm unifdef | |
45 | .Oo | |
46 | .Fl t l c | |
47 | .Fl D Ns Ar sym | |
48 | .Fl U Ns Ar sym | |
49 | .Fl iD Ns Ar sym | |
50 | .Fl iD Ns Ar sym | |
51 | .Oc | |
52 | .Ar ... | |
53 | .Op Ar file | |
54 | .Sh DESCRIPTION | |
55 | .Nm Unifdef | |
56 | is useful for removing ifdef'ed lines | |
57 | from a file while otherwise leaving the file alone. | |
58 | .Nm Unifdef | |
59 | acts on | |
60 | #ifdef, #ifndef, #else, and #endif lines, | |
61 | and it knows only enough about C | |
62 | to know when one of these is inactive | |
63 | because it is inside | |
64 | a comment, | |
65 | or a single or double quote. | |
66 | Parsing for quotes is very simplistic: | |
67 | when it finds an open quote, | |
68 | it ignores everything (except escaped quotes) | |
69 | until it finds a close quote, and | |
70 | it will not complain if it gets | |
71 | to the end of a line and finds no backslash for continuation. | |
72 | .Pp | |
73 | Available options: | |
74 | .Bl -tag -width Ds -compact | |
75 | .It Fl D Ns Ar sym | |
76 | .It Fl U Ns Ar sym | |
77 | Specify which symbols to define or undefine. | |
78 | and the lines inside those ifdefs will be copied to the output or removed as | |
79 | appropriate. | |
80 | The ifdef, ifndef, else, and endif lines associated with | |
81 | .Ar sym | |
82 | will also be removed. | |
83 | Ifdefs involving symbols you don't specify | |
84 | and ``#if'' control lines | |
85 | are untouched and copied out | |
86 | along with their associated | |
87 | ifdef, else, and endif lines. | |
88 | If an ifdef X occurs nested inside another ifdef X, then the | |
89 | inside ifdef is treated as if it were an unrecognized symbol. | |
90 | If the same symbol appears in more than one argument, | |
91 | the last occurrence dominates. | |
92 | .Pp | |
93 | .It Fl c | |
94 | If the | |
95 | .Fl c | |
96 | flag is specified, | |
97 | then the operation of | |
98 | .Nm unifdef | |
99 | is complemented, | |
100 | i.e. the lines that would have been removed or blanked | |
101 | are retained and vice versa. | |
102 | .Pp | |
103 | .It Fl l | |
104 | Replace removed lines with blank lines | |
105 | instead of deleting them. | |
106 | .It Fl t | |
107 | Disables parsing for | |
108 | C comments and quotes useful for plain text | |
109 | (not C code). | |
110 | .Pp | |
111 | .It Fl iD Ns Ar sym | |
112 | .It Fl iU Ns Ar sym | |
113 | Ignore ifdefs. | |
114 | If your C code uses ifdefs to delimit non-C lines, | |
115 | such as comments | |
116 | or code which is under construction, | |
117 | then you must tell | |
118 | .Nm unifdef | |
119 | which symbols are used for that purpose so that it won't try to parse | |
120 | for quotes and comments | |
121 | inside those ifdefs. | |
122 | One specifies ignored ifdefs with | |
123 | .Fl iD Ns Ar sym | |
124 | and | |
125 | .Fl iU Ns Ar sym | |
126 | similar to | |
127 | .Fl D Ns Ar sym | |
128 | and | |
129 | .Fl U Ns Ar sym | |
130 | above. | |
131 | .El | |
132 | .Pp | |
133 | .Nm Unifdef | |
134 | copies its output to | |
135 | .Em stdout | |
136 | and will take its input from | |
137 | .Em stdin | |
138 | if no | |
139 | .Ar file | |
140 | argument is given. | |
141 | .Pp | |
142 | .Nm Unifdef | |
143 | works nicely with the | |
144 | .Fl D Ns Ar sym | |
145 | option added to | |
146 | .Xr diff 1 | |
147 | as of the 4.1 Berkeley Software Distribution. | |
148 | .Sh SEE ALSO | |
149 | .Xr diff 1 | |
150 | .Sh DIAGNOSTICS | |
151 | Inappropriate else or endif. | |
152 | .br | |
153 | Premature | |
154 | .Tn EOF | |
155 | with line numbers of the unterminated #ifdefs. | |
156 | .Pp | |
157 | Exit status is 0 if output is exact copy of input, 1 if not, 2 if trouble. | |
158 | .Sh BUGS | |
159 | Should try to deal with ``#if'' lines. | |
160 | .Pp | |
161 | Doesn't work correctly if input contains null characters. | |
162 | .Sh HISTORY | |
163 | The | |
164 | .Nm | |
165 | command appeared in | |
166 | .Bx 4.3 . |