1ROFFPP(1)                   General Commands Manual                  ROFFPP(1)
2
3
4

NAME

6       roffpp - replace .so requests within *roff sources
7

SYNOPSIS

9       roffpp [ option...  ][ infile [ outfile ]]
10       roffpp -Help
11       roffpp -VERSion
12

DESCRIPTION

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
18       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 gen‐
21       eral *roff interpreter, so many constructs will be  beyond  it,  fortu‐
22       nately,  most  of  them have nothing to do with include files.  Include
23       files which cannot be found, probably  from  uninterpreted  *roff  con‐
24       structs,  if the files really does exist, will simply be passed through
25       unchanged, for *roff to interpret at a later time.
26
27       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
31       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
37       Any extra arguments on the line are ignored, and quoting is not  under‐
38       stood.  All characters are interpreted literally.
39
40       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
45       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
49       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 utili‐
52       ties included in the groff package.
53

OPTIONS

55       The following options are understood.
56
57       -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
63       -Help
64               Give information on how to use roffpp.
65
66       -VERSion
67               Tell what version of roffpp is being run.
68
69       Any other option will generate a diagnostic error.
70
71
72
73Reference Manual                     Cook                            ROFFPP(1)