Annotation of src/usr.bin/deroff/deroff.1, Revision 1.1
1.1 ! millert 1: .\" $OpenBSD$
! 2: .\"
! 3: .\" Copyright (c) 1990, 1993
! 4: .\" The Regents of the University of California. All rights reserved.
! 5: .\"
! 6: .\" Redistribution and use in source and binary forms, with or without
! 7: .\" modification, are permitted provided that the following conditions
! 8: .\" are met:
! 9: .\" 1. Redistributions of source code must retain the above copyright
! 10: .\" notice, this list of conditions and the following disclaimer.
! 11: .\" 2. Redistributions in binary form must reproduce the above copyright
! 12: .\" notice, this list of conditions and the following disclaimer in the
! 13: .\" documentation and/or other materials provided with the distribution.
! 14: .\" 3. All advertising materials mentioning features or use of this software
! 15: .\" must display the following acknowledgement:
! 16: .\" This product includes software developed by the University of
! 17: .\" California, Berkeley and its contributors.
! 18: .\" 4. Neither the name of the University nor the names of its contributors
! 19: .\" may be used to endorse or promote products derived from this software
! 20: .\" without specific prior written permission.
! 21: .\"
! 22: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
! 23: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
! 24: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
! 25: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
! 26: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
! 27: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
! 28: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
! 29: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
! 30: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
! 31: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
! 32: .\" SUCH DAMAGE.
! 33: .\"
! 34: .\" Copyright (C) Caldera International Inc. 2001-2002.
! 35: .\" All rights reserved.
! 36: .\"
! 37: .\" Redistribution and use in source and binary forms, with or without
! 38: .\" modification, are permitted provided that the following conditions
! 39: .\" are met:
! 40: .\" 1. Redistributions of source code and documentation must retain the above
! 41: .\" copyright notice, this list of conditions and the following disclaimer.
! 42: .\" 2. Redistributions in binary form must reproduce the above copyright
! 43: .\" notice, this list of conditions and the following disclaimer in the
! 44: .\" documentation and/or other materials provided with the distribution.
! 45: .\" 3. All advertising materials mentioning features or use of this software
! 46: .\" must display the following acknowledgement:
! 47: .\" This product includes software developed or owned by Caldera
! 48: .\" International, Inc.
! 49: .\" 4. Neither the name of Caldera International, Inc. nor the names of other
! 50: .\" contributors may be used to endorse or promote products derived from
! 51: .\" this software without specific prior written permission.
! 52: .\"
! 53: .\" USE OF THE SOFTWARE PROVIDED FOR UNDER THIS LICENSE BY CALDERA
! 54: .\" INTERNATIONAL, INC. AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR
! 55: .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
! 56: .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
! 57: .\" IN NO EVENT SHALL CALDERA INTERNATIONAL, INC. BE LIABLE FOR ANY DIRECT,
! 58: .\" INDIRECT INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
! 59: .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
! 60: .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
! 61: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
! 62: .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
! 63: .\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
! 64: .\" POSSIBILITY OF SUCH DAMAGE.
! 65: .\"
! 66: .\" @(#)deroff.1 8.1 (Berkeley) 6/6/93
! 67: .\"
! 68: .Dd June 6, 1993
! 69: .Dt DEROFF 1
! 70: .Os
! 71: .Sh NAME
! 72: .Nm deroff
! 73: .Nd remove nroff/troff, eqn, pic and tbl constructs
! 74: .Sh SYNOPSIS
! 75: .Nm deroff
! 76: .Op Fl ikpw
! 77: .Op Fl m Ar m | s | e | a | l
! 78: .Ar file \&...
! 79: .Sh DESCRIPTION
! 80: .Nm deroff
! 81: reads each file in sequence and removes all
! 82: .Xr nroff 1
! 83: and
! 84: .Xr troff 1
! 85: command lines, backslash constructions, macro definitions,
! 86: .Xr eqn 1
! 87: constructs (between `.EQ' and `.EN' lines or between delimiters),
! 88: .Xr pic 1
! 89: pictures,
! 90: and table descriptions and writes the remainder to the standard output.
! 91: .Nm
! 92: follows chains of included files (`.so' and `.nx' commands);
! 93: if a file has already been included, a `.so' is ignored and a `.nx'
! 94: terminates execution.
! 95: If no input file is given,
! 96: .Nm
! 97: reads from the standard input.
! 98: .Pp
! 99: The options are as follows:
! 100: .Bl -tag -width Ds
! 101: .It Fl i
! 102: Ignore `.so' and `.nx' commands.
! 103: .It Fl k
! 104: Keep blocks of text intact.
! 105: This is the default behavior unless the
! 106: .Fl m
! 107: option is given.
! 108: .It Fl m
! 109: Enable support for common macro packages.
! 110: The
! 111: .Fl m
! 112: option takes the following arguments:
! 113: .Bl -tag -width Ds
! 114: .It a
! 115: recognize
! 116: .Xr man 7
! 117: macros.
! 118: .It e
! 119: recognize
! 120: .Xr me 7
! 121: macros.
! 122: .It m
! 123: recognize
! 124: .Xr me 7
! 125: macros.
! 126: .It s
! 127: recognize
! 128: .Xr me 7
! 129: macros.
! 130: .It l
! 131: recognize
! 132: .Xr mm 7
! 133: macros and delete
! 134: .Xr mm 7
! 135: lists.
! 136: .El
! 137: .It Fl p
! 138: Preserve paragraph macros.
! 139: This option only has an effect if the
! 140: .Fl m
! 141: option is also specified.
! 142: .It Fl w
! 143: Output a word list, one
! 144: .Sq word
! 145: (string of letters, digits, and apostrophes, beginning with a letter;
! 146: apostrophes are removed) per line, and all other characters ignored.
! 147: Normally, the output follows the original, with the deletions mentioned above.
! 148: .El
! 149: .Sh SEE ALSO
! 150: .Xr eqn 1 ,
! 151: .Xr nroff 1 ,
! 152: .Xr troff 1 ,
! 153: .Xr pic 1 ,
! 154: .Xr tbl 1
! 155: .Sh HISTORY
! 156: .Nm
! 157: appeared in Version 7 AT&T Unix.
! 158: .Sh BUGS
! 159: .Nm
! 160: is not a complete
! 161: .Xr troff 1
! 162: interpreter, so it can be confused by subtle constructs.
! 163: Most errors result in too much rather than too little output.