.lf 1 lib/en/man1/roffpp.1
'\" t
.\"     cook - file construction tool
.\"     Copyright (C) 1991-1994, 1997, 2001, 2007, 2008 Peter Miller
.\"
.\"     This program is free software; you can redistribute it and/or modify
.\"     it under the terms of the GNU General Public License as published by
.\"     the Free Software Foundation; either version 3 of the License, or
.\"     (at your option) any later version.
.\"
.\"     This program is distributed in the hope that it will be useful,
.\"     but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"     GNU General Public License for more details.
.\"
.\"     You should have received a copy of the GNU General Public License
.\"     along with this program. If not, see
.\"     <http://www.gnu.org/licenses/>.
.\"
.TH ROFFPP 1 Cook "Reference Manual"
.lf 1 lib/en/man1/z_name.so
.\"
.\"     cook - file construction tool
.\"     Copyright (C) 1994, 1995, 1997, 2007, 2008 Peter Miller
.\"
.\"     This program is free software; you can redistribute it and/or modify
.\"     it under the terms of the GNU General Public License as published by
.\"     the Free Software Foundation; either version 3 of the License, or
.\"     (at your option) any later version.
.\"
.\"     This program is distributed in the hope that it will be useful,
.\"     but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"     GNU General Public License for more details.
.\"
.\"     You should have received a copy of the GNU General Public License
.\"     along with this program. If not, see
.\"     <http://www.gnu.org/licenses/>.
.\"
.ds n) cook
.ds N) Cook
.if n .nr )M 8n
.if n .nr IN 8n
.if n .nr )I 8n
.if n .po 0
.if n .hy 0
.if n .ad l
.lf 21 lib/en/man1/roffpp.1
.ds n) roffpp
.SH NAME
\*(n) \- replace \&.so requests within *roff sources
.XX "roffpp(1)" "replace .so requests within *roff sources"
.SH SYNOPSIS
.B \*(n)
[
.IR option ...
][
.I infile
[
.I outfile
]]
.br
.B \*(n)
.B -Help
.br
.B \*(n)
.B -VERSion
.SH DESCRIPTION
The
.I \*(n)
command may be used to
copies the input file to the output file,
including files named using
.I \&.so
directives along the way,
and removing the
.I \&.so
directives.
.PP
This is useful when processing large multi-file documents
with filters such as
.IR tbl (1)
or
.IR eqn (1)
which do not understand the
.I .so
directive.
The
.I \&.nx
directive is not understood.
The
.I \*(n)
program is not a general *roff interpreter,
so many constructs will be beyond it,
fortunately, most of them have nothing to do with include files.
Include files which cannot be found,
probably from uninterpreted *roff constructs,
if the files really does exist,
will simply be passed through unchanged,
for *roff to interpret at a later time.
.PP
The
.I \*(n)
program also allows the user to specify an include search path.
This allows, for example, common files to be kept in a central location.
.PP
Only directives of the form
.RS
.B \&.so
.I filename
.RE
are processed.
If the directive is introduced using the single quote form,
or the dot is not the first character of the line,
the directive will be ignored.
.PP
Any extra arguments on the line are ignored,
and quoting is not understood.
All characters are interpreted literally.
.PP
Examples of directives which will be ignored include
.RS
.nf
\&'so /usr/lib/tmac/tmac.an
\&.if n .so yuck
.fi
.RE
This list is not exhaustive.
.PP
The special file name
.RB ` \- '
on the command line
means the standard input or standard output,
as appropriate.
Files which are omitted are also assumed to be
the standard input or standard output,
as appropriate.
.PP
The output attempts to keep file names and line numbers in sync
by using the
.B \&.lf
directive.
The
.B \&.lf
directive is also understood as input.
This is compatible with
.IR groff (1)
and the other GNU text utilities included in the groff package.
.br
.ne 1i
.SH OPTIONS
The following options are understood.
.TP 8n
.BI -I path
.br
Specify include path, a la
.IR cc (1).
Include paths are searched in the order specified.
The include search path defaults to the current directory
if and only if the user does not specify any include search paths.
.TP 8n
.B -Help
.br
Give information on how to use
.IR \*(n) .
.TP 8n
.B -VERSion
.br
Tell what version of
.I \*(n)
is being run.
.PP
Any other option will generate a diagnostic error.
.lf 1 lib/en/man1/o__rules.so
.\"
.\"     cook - file construction tool
.\"     Copyright (C) 1993, 1997, 2007, 2008 Peter Miller
.\"
.\"     This program is free software; you can redistribute it and/or modify
.\"     it under the terms of the GNU General Public License as published by
.\"     the Free Software Foundation; either version 3 of the License, or
.\"     (at your option) any later version.
.\"
.\"     This program is distributed in the hope that it will be useful,
.\"     but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"     GNU General Public License for more details.
.\"
.\"     You should have received a copy of the GNU General Public License
.\"     along with this program. If not, see
.\"     <http://www.gnu.org/licenses/>.
.\"
.PP
All options may be abbreviated;
the abbreviation is documented as the upper case letters,
all lower case letters and underscores (_) are optional.
You must use consecutive sequences of optional letters.
.PP
All options are case insensitive,
you may type them in upper case or lower case or a combination of both,
case is not important.
.PP
For example:
the arguments "-help", "-HEL" and "-h" are
all interpreted to mean the \fB-Help\fP option.
The argument "-hlp" will not be understood,
because consecutive optional characters were not supplied.
.PP
Options and other command line arguments may be
mixed arbitrarily on the command line.
.br
.ne 4
.PP
The GNU long option names are understood.
Since all option names for
.I \*(n)
are long,
this means ignoring the extra leading '-'.
The "\fB--\fIoption\fB=\fIvalue\fR" convention is also understood.
.lf 147 lib/en/man1/roffpp.1
.lf 1 lib/en/man1/z_exit.so
.\"
.\"     cook - file construction tool
.\"     Copyright (C) 1993, 1994, 1997, 2001, 2007, 2008 Peter Miller
.\"
.\"     This program is free software; you can redistribute it and/or modify
.\"     it under the terms of the GNU General Public License as published by
.\"     the Free Software Foundation; either version 3 of the License, or
.\"     (at your option) any later version.
.\"
.\"     This program is distributed in the hope that it will be useful,
.\"     but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"     GNU General Public License for more details.
.\"
.\"     You should have received a copy of the GNU General Public License
.\"     along with this program. If not, see
.\"     <http://www.gnu.org/licenses/>.
.\"
.br
.ne 1i
.SH EXIT STATUS
The
.I \*(n)
command will exit with a status of 1 on any error.
The
.I \*(n)
command will only exit with a status of 0 if there are no errors.
.lf 148 lib/en/man1/roffpp.1
.lf 1 lib/en/man1/copyright.so
.\"
.\"     cook - file construction tool
.\"     Copyright (C) 1993-1995, 1997, 2007-2009 Peter Miller
.\"
.\"     This program is free software; you can redistribute it and/or modify
.\"     it under the terms of the GNU General Public License as published by
.\"     the Free Software Foundation; either version 3 of the License, or
.\"     (at your option) any later version.
.\"
.\"     This program is distributed in the hope that it will be useful,
.\"     but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"     GNU General Public License for more details.
.\"
.\"     You should have received a copy of the GNU General Public License
.\"     along with this program. If not, see
.\"     <http://www.gnu.org/licenses/>.
.\"
.br
.ne 1i
.SH COPYRIGHT
.lf 1 etc/../etc/version.so
.ds V) 2.33.D001
.ds v) 2.33
.ds Y) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
.lf 23 lib/en/man1/copyright.so
.I \*(n)
version \*(v)
.br
Copyright
.if n (C)
.if t \(co
.nr d) \n(.d
\*(Y) Peter Miller
.if '\n(d)'\n(.d' .br
.PP
The
.I \*(n)
program comes with ABSOLUTELY NO WARRANTY;
for details use the '\fI\*(n) -VERSion License\fP' command.
This is free software
and you are welcome to redistribute it under certain conditions;
for details use the '\fI\*(n) -VERSion License\fP' command.
.br
.ne 1i
.SH AUTHOR
.TS
tab(;);
l r l.
Peter Miller;E-Mail:;pmiller@opensource.org.au
/\e/\e*;WWW:;http://miller.emu.id.au/pmiller/
.TE
.lf 149 lib/en/man1/roffpp.1