1ROFFPP(1) General Commands Manual ROFFPP(1)
2
6 roffpp - replace .so requests within *roff sources
7
9 roffpp [ option... ][ infile [ outfile ]]
10 roffpp -Help
11 roffpp -VERSion
12
14 The roffpp command may be used to copies the input file to the output
15 file, including files named using .so directives along the way, and
16 removing the .so directives.
17 This is useful when processing large multi-file documents with filters
19 such as tbl(1) or eqn(1) which do not understand the .so directive.
20 The .nx directive is not understood. The roffpp program is not a
21 general *roff interpreter, so many constructs will be beyond it,
22 fortunately, most of them have nothing to do with include files.
23 Include files which cannot be found, probably from uninterpreted *roff
24 constructs, if the files really does exist, will simply be passed
25 through unchanged, for *roff to interpret at a later time.
26 The roffpp program also allows the user to specify an include search
28 path. This allows, for example, common files to be kept in a central
29 location.
30 Only directives of the form
32 .so filename
33 are processed. If the directive is introduced using the single quote
34 form, or the dot is not the first character of the line, the directive
35 will be ignored.
36 Any extra arguments on the line are ignored, and quoting is not
38 understood. All characters are interpreted literally.
39 Examples of directives which will be ignored include
41 'so /usr/lib/tmac/tmac.an
42 .if n .so yuck
43 This list is not exhaustive.
44 The special file name `-' on the command line means the standard input
46 or standard output, as appropriate. Files which are omitted are also
47 assumed to be the standard input or standard output, as appropriate.
48 The output attempts to keep file names and line numbers in sync by
50 using the .lf directive. The .lf directive is also understood as
51 input. This is compatible with groff(1) and the other GNU text
52 utilities included in the groff package.
53
55 The following options are understood.
56 -Ipath
58 Specify include path, a la cc(1). Include paths are searched
59 in the order specified. The include search path defaults to
60 the current directory if and only if the user does not specify
61 any include search paths.
62 -Help
64 Give information on how to use roffpp.
65 -VERSion
67 Tell what version of roffpp is being run.
68 Any other option will generate a diagnostic error.
70 All options may be abbreviated; the abbreviation is documented as the
72 upper case letters, all lower case letters and underscores (_) are
73 optional. You must use consecutive sequences of optional letters.
74 All options are case insensitive, you may type them in upper case or
76 lower case or a combination of both, case is not important.
77 For example: the arguments "-help", "-HEL" and "-h" are all
79 interpreted to mean the -Help option. The argument "-hlp" will not be
80 understood, because consecutive optional characters were not supplied.
81 Options and other command line arguments may be mixed arbitrarily on
83 the command line.
84 The GNU long option names are understood. Since all option names for
86 roffpp are long, this means ignoring the extra leading '-'. The
87 "--option=value" convention is also understood.
88
90 The roffpp command will exit with a status of 1 on any error. The
91 roffpp command will only exit with a status of 0 if there are no
92 errors.
93
95 roffpp version 2.30
96 Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
97 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 Peter
98 Miller; All rights reserved.
99 The roffpp program comes with ABSOLUTELY NO WARRANTY; for details use
101 the 'roffpp -VERSion License' command. This is free software and you
102 are welcome to redistribute it under certain conditions; for details
103 use the 'roffpp -VERSion License' command.
104
106 Peter Miller E-Mail: millerp@canb.auug.org.au
107 /\/\* WWW: http://www.canb.auug.org.au/~millerp/
108Reference Manual Cook ROFFPP(1)