usr.bin/unifdef/unifdef.1

   1 .\" Copyright (c) 1985, 1991, 1993
   2 .\"     The Regents of the University of California.  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   8.2 (Berkeley) 4/1/94
  36 .\"
  37 .Dd April 1, 1994
  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 .Op Fl clt
  46 .Oo
  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
  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 C comments and quotes, which is useful
 108 for plain text.
 109 .Pp
 110 .It Fl iD Ns Ar sym
 111 .It Fl iU Ns Ar sym
 112 Ignore ifdefs.
 113 If your C code uses ifdefs to delimit non-C lines,
 114 such as comments
 115 or code which is under construction,
 116 then you must tell
 117 .Nm
 118 which symbols are used for that purpose so that it won't try to parse
 119 for quotes and comments
 120 inside those ifdefs.
 121 One specifies ignored ifdefs with
 122 .Fl iD Ns Ar sym
 123 and
 124 .Fl iU Ns Ar sym
 125 similar to
 126 .Fl D Ns Ar sym
 127 and
 128 .Fl U Ns Ar sym
 129 above.
 130 .El
 131 .Pp
 132 .Nm Unifdef
 133 copies its output to
 134 .Em stdout
 135 and will take its input from
 136 .Em stdin
 137 if no
 138 .Ar file
 139 argument is given.
 140 .Pp
 141 .Nm Unifdef
 142 works nicely with the
 143 .Fl D Ns Ar sym
 144 option added to
 145 .Xr diff 1
 146 as of the 4.1 Berkeley Software Distribution.
 147 .Sh SEE ALSO
 148 .Xr diff 1
 149 .Sh DIAGNOSTICS
 150 Inappropriate else or endif.
 151 .br
 152 Premature
 153 .Tn EOF
 154 with line numbers of the unterminated #ifdefs.
 155 .Pp
 156 Exit status is 0 if output is exact copy of input, 1 if not, 2 if trouble.
 157 .Sh BUGS
 158 Should try to deal with ``#if'' lines.
 159 .Pp
 160 Doesn't work correctly if input contains null characters.
 161 .Sh HISTORY
 162 The
 163 .Nm
 164 command appeared in
 165 .Bx 4.3 .