[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Groff-commit] groff ChangeLog contrib/pdfmark/pdfroff.man
|
From: |
Werner LEMBERG |
|
Subject: |
[Groff-commit] groff ChangeLog contrib/pdfmark/pdfroff.man |
|
Date: |
Mon, 22 Jan 2007 05:43:35 +0000 |
CVSROOT: /cvsroot/groff
Module name: groff
Changes by: Werner LEMBERG <wl> 07/01/22 05:43:35
Modified files:
. : ChangeLog
contrib/pdfmark: pdfroff.man
Log message:
* contrib/pdfmark/pdfroff.man: Revised, based on a patch from Eric
Raymond. It now uses the new macros from an-ext.tmac. This is the
first of a series of man patches which Eric has contributed.
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/groff/ChangeLog?cvsroot=groff&r1=1.1021&r2=1.1022
http://cvs.savannah.gnu.org/viewcvs/groff/contrib/pdfmark/pdfroff.man?cvsroot=groff&r1=1.7&r2=1.8
Patches:
Index: ChangeLog
===================================================================
RCS file: /cvsroot/groff/groff/ChangeLog,v
retrieving revision 1.1021
retrieving revision 1.1022
diff -u -b -r1.1021 -r1.1022
--- ChangeLog 16 Jan 2007 21:45:14 -0000 1.1021
+++ ChangeLog 22 Jan 2007 05:43:34 -0000 1.1022
@@ -1,3 +1,9 @@
+2006-01-21 Werner LEMBERG <address@hidden>
+
+ * contrib/pdfmark/pdfroff.man: Revised, based on a patch from Eric
+ Raymond. It now uses the new macros from an-ext.tmac. This is the
+ first of a series of man patches which Eric has contributed.
+
2006-01-16 Werner LEMBERG <address@hidden>
* tmac/an-ext.tmac: Remove code for grodvi.
Index: contrib/pdfmark/pdfroff.man
===================================================================
RCS file: /cvsroot/groff/groff/contrib/pdfmark/pdfroff.man,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -b -r1.7 -r1.8
--- contrib/pdfmark/pdfroff.man 14 Jul 2006 23:48:35 -0000 1.7
+++ contrib/pdfmark/pdfroff.man 22 Jan 2007 05:43:35 -0000 1.8
@@ -8,10 +8,11 @@
File position: <groff-source>/contrib/pdfmark/pdfroff.man
Last update:
+16 Jan 2007. Converted to use .SY/.OP/.YS
This file is part of groff, the GNU roff type-setting system.
-Copyright (C) 2005, 2006 Free Software Foundation, Inc.
+Copyright (C) 2005, 2006, 2007 Free Software Foundation, Inc.
written by Keith Marshall <address@hidden>
Permission is granted to copy, distribute and/or modify this document
@@ -29,121 +30,76 @@
A copy of the Free Documentation License is included as a file called
FDL in the main directory of the groff source package.
..
-.\" --------------------------------------------------------------------
.
-.SH NAME
-pdfroff \- create PDF documents using
-.I groff
.
-.ig
- This `.ig' block is here to make mandb happy -- it forces the end of
- the NAME section processing.
-..
+.\" --------------------------------------------------------------------
+.\" Local macro definitions
.
.hw pdfmark
-.de Q
-\&\\$3\*(lq\\$1\*(rq\\$2
-..
-.de nohy
-.hy 0
+.
+.de NH
+. hy 0
\&\\$*
-.hy
+. hy
..
+.
+.
+.\" --------------------------------------------------------------------
+.
+.SH NAME
+.
+pdfroff \- create PDF documents using groff
+.
+.
.\" --------------------------------------------------------------------
.
.SH SYNOPSIS
-.de cmd
-. if address@hidden .in
-. nr @i \\n(.i
-. in +\w'\f[B]\\$1\0'u
-. ti \\n(@iu
-. B \\$1\0\c
-..
-.de opt
-. tr -\-
-. RB [ -\\$1\c
-. IR \&\\$2 ]
-. tr --
-..
-.de opta
-. ie \\n(.$>1 .opt \\$1 \0\\$2
-. el .opt \\$1
-..
-.de opte
-. tr -\-
-. RB [ -\\$1 =\c
-. IR \&\\$2 ]
-. tr --
-..
-.de optx
-. tr -\-
-. RB [ --no\\$1 \0|\0\c
-. BR -\\$1 =\c
-. IR \&\\$2 ]
-. tr --
-..
-.ad l
-.hy 0
-.ll -5
-.cmd pdfroff
-.opt abcegilpstzCEGNRSUVXZ
-.opta d cs
-.opta f fam
-.opta F dir
-.opta I dir
-.opta L arg
-.opta m name
-.opta M dir
-.opta n num
-.opta o list
-.opta P arg
-.opta r cn
-.opta T dev
-.opta w name
-.opta W name
-.opt -emit-ps
-.opt -no-toc-relocation
-.opt -no-kill-null-pages
-.opte -stylesheet name
-.optx -pdf-output name
-.optx -reference-dictionary name
-.opt -report-progress
-.opt -keep-temporary-files
-.B file
-.I ...
-.ll
-.sp
-.cmd pdfroff
-.B -h
+.
+.SY pdfroff
+.OP \-abcegilpstzCEGNRSUVXZ
+.OP \-d cs
+.OP \-f fam
+.OP \-F dir
+.OP \-I dir
+.OP \-L arg
+.OP \-m name
+.OP \-M dir
+.OP \-n num
+.OP \-o list
+.OP \-P arg
+.OP \-r cn
+.OP \-T dev
+.OP \-w name
+.OP \-W name
+.OP \-\-emit\-ps
+.OP \-\-no\-toc\-relocation
+.OP \-\-no-kill\-null\-pages
+.OP \-\-stylesheet=\fIname\fP
+.OP \-\-no\-pdf\-output
+.OP \-\-pdf\-output=\fIname\fP
+.OP \-\-no\-reference\-dictionary
+.OP \-\-reference\-dictionary=\fIname\fP
+.OP \-\-report\-progress
+.OP \-\-keep\-temporary\-files
+.I file .\|.\|.
+.
+.SY pdfroff
+.B \-h
|
-.B --help
-.sp
-.cmd pdfroff
-.B -v
+.B \-\-help
+.
+.SY pdfroff
+.B \-v
|
-.B --version
-.RI [ option
-.IR ... ]
-.rr @i
-.in
-.ad
-.hy
-.P
-The command line is parsed in accordance with normal GNU conventions,
-but with one exception \(em when specifying any short form option
-(i.e., a single character option introduced by a single hyphen),
-and if that option expects an argument, then it
-.I must
-be specified independently (i.e., it may
-.I not
-be appended to any group of other single character short form options).
-.P
-Long form option names (i.e., those introduced by a double hyphen)
-may be abbreviated to their minimum length unambigous initial substring.
+.B \-\-version
+.RI [ option\ .\|.\|. ]
+.YS
+.
.
.\" --------------------------------------------------------------------
.
.SH DESCRIPTION
+.
.B pdfroff
is a wrapper program for the GNU text processing system,
.BR groff .
@@ -156,17 +112,19 @@
and are subsequently combined in the correct order, for final publication
as a single PDF document.
A further optional
-.Q style\0sheet
+\*(lqstyle sheet\*(rq
capability is provided;
-this allows for the definition of content which is required to preceed the
+this allows for the definition of content which is required to precede the
table of contents, in the published document.
+.
.P
For each invocation of
.BR pdfroff ,
the ultimate
.B groff
-output stream is post\(hyprocessed by the GhostScript interpreter,
+output stream is post-processed by the GhostScript interpreter,
to produce a finished PDF document.
+.
.P
.B pdfroff
makes no assumptions about, and imposes no restrictions on,
@@ -186,7 +144,7 @@
package, is used to define public reference marks,
or dynamic links to such reference marks, then
.B pdfroff
-will perform as many preformatting
+performs as many preformatting
.B groff
passes as required, up to a maximum limit of
.IR four ,
@@ -194,9 +152,27 @@
to resolve references, and to expand the dynamically defined
content of links.
.
+.
.\" --------------------------------------------------------------------
.
.SH USAGE
+.
+The command line is parsed in accordance with normal GNU conventions,
+but with one exception \(em when specifying any short form option
+(i.e., a single character option introduced by a single hyphen),
+and if that option expects an argument, then it
+.I must
+be specified independently (i.e., it may
+.I not
+be appended to any group of other single character short form options).
+.
+.P
+Long form option names (i.e., those introduced by a double hyphen)
+may be abbreviated to their minimum length unambiguous initial
+substring.
+.
+.P
+Otherwise,
.B pdfroff
usage closely mirrors that of
.B groff
@@ -206,7 +182,7 @@
.BR \-h ,
.BR \-v ,
and
-.BI \-T \0dev
+.BI \-T \ dev
short form options, and
all long form options,
which are parsed internally by
@@ -223,9 +199,11 @@
.BR pdfroff
options and argument usage.
.
+.
.\" --------------------------------------------------------------------
.
.SH OPTIONS
+.
.B pdfroff
accepts all of the short form options
(i.e., those introduced by a single hyphen),
@@ -236,11 +214,13 @@
.BR groff ;
the following, however, are handled specially by
.BR pdfroff .
+.
.TP
.B \-h
Same as
.BR \-\-help ;
see below.
+.
.TP
.B \-i
Process standard input, after all other specified input files.
@@ -249,25 +229,28 @@
but, if grouped with other options, it
.I must
be the first in the group.
-Hiding it within a group will
-break standard input processing, in the multiple pass
+Hiding it within a group
+breaks standard input processing, in the multiple pass
.B groff
processing context of
.BR pdfroff .
+.
.TP
-.BI \-T \0dev
+.BI \-T \ dev
Only
-.BI \-T \0ps
+.B \-T\ ps
is supported by
.BR pdfroff .
-Attempting to specify any other device will cause
+Attempting to specify any other device causes
.B pdfroff
to abort.
+.
.TP
.B \-v
Same as
.BR \-\-version ;
see below.
+.
.P
See
.BR groff (@MAN1EXT@)
@@ -276,6 +259,7 @@
.BR pdfroff
to
.BR groff .
+.
.P
All long form options
(i.e., those introduced by a double hyphen)
@@ -286,12 +270,14 @@
passed on to
.BR groff ,
unless otherwise stated below.
+.
.TP
.B \-\-help
Causes
.B pdfroff
to display a summary of the its usage syntax, and supported options,
and then exit.
+.
.TP
.B \-\-emit\-ps
Suppresses the final output conversion step,
@@ -307,6 +293,7 @@
in place of the default
.I GhostScript
PDF writer.
+.
.TP
.B \-\-keep\-temporary\-files
Suppresses the deletion of temporary files,
@@ -320,21 +307,24 @@
.BR FILES ,
for a description of the temporary files used by
.BR pdfroff .
+.
.TP
.B \-\-no\-pdf\-output
May be used with the
-.BI \-\-reference\-dictionary= name
+.BI \%\-\-reference\-dictionary= name
option (described below) to eliminate the overhead of PDF formatting,
when running
.B pdfroff
to create a reference dictionary, for use in a different document.
+.
.TP
.B \-\-no\-reference\-dictionary
May be used to eliminate the overhead of creating a reference dictionary,
-when it is known that the target PDF document will contain no public
+when it is known that the target PDF document contains no public
references, created by the
.I pdfhref
macro.
+.
.TP
.B \-\-no\-toc\-relocation
May be used to eliminate the extra
@@ -344,14 +334,15 @@
and relocate it to the start of the PDF document,
when processing any document which lacks an automatically
generated table of contents.
+.
.TP
.B \-\-no\-kill\-null\-pages
While preparing for simulation of the manual collation step,
which is traditionally required to relocate of a
-.I "table of contents
+.I "table of contents"
to the start of a document,
.B pdfroff
-will accumulate a number of empty page descriptions
+accumulates a number of empty page descriptions
into the intermediate
.I PostScript
output stream.
@@ -360,6 +351,7 @@
this option forces
.B pdfroff
to leave them in place.
+.
.TP
.BI \-\-pdf\-output= name
Specifies the name to be used for the resultant PDF document;
@@ -368,6 +360,7 @@
.B pdfroff
may use this option,
to encode the document name in a generated reference dictionary.
+.
.TP
.BI \-\-reference\-dictionary= name
Specifies the name to be used for the generated reference dictionary file;
@@ -379,6 +372,7 @@
.I must
be specified, if it is desired to save the reference dictionary,
for use in references placed in other PDF documents.
+.
.TP
.B \-\-report\-progress
Causes
@@ -387,6 +381,7 @@
at the start of each
.B groff
processing pass.
+.
.TP
.BI \-\-stylesheet= name
Specifies the name of an
@@ -396,6 +391,7 @@
.I before
the table of contents,
in the formatted PDF document.
+.
.TP
.B \-\-version
Causes
@@ -411,12 +407,14 @@
.B groff
version information, before exiting.
.
+.
.\" --------------------------------------------------------------------
.
.SH ENVIRONMENT
The following environment variables may be set, and exported,
to modify the behaviour of
.BR pdfroff .
+.
.TP
.B PDFROFF_COLLATE
Specifies the program to be used
@@ -429,18 +427,18 @@
which print them at the end.
However,
users should not normally need to specify
-.BR PDFROFF_COLLATE ,
+.BR \%PDFROFF_COLLATE ,
(and indeed,
are not encouraged to do so).
If unspecified,
.B pdfroff
-will use
-.BI sed (@MAN1EXT@)
+uses
+.BR sed (@MAN1EXT@)
by default,
-which will normally suffice.
+which normally suffices.
.IP
If
-.B PDFROFF_COLLATE
+.B \%PDFROFF_COLLATE
.I is
specified,
then it must act as a filter,
@@ -449,31 +447,32 @@
.I stdout
stream,
whence it is piped to the
-.BR PDFROFF_POSTPROCESSOR_COMMAND ,
+.BR \%PDFROFF_POSTPROCESSOR_COMMAND ,
to produce the finished PDF output.
.IP
When specifying
-.BR PDFROFF_COLLATE ,
-it will normally be necessary to also specify
-.BR PDFROFF_KILL_NULL_PAGES .
+.BR \%PDFROFF_COLLATE ,
+it is normally necessary to also specify
+.BR \%PDFROFF_KILL_NULL_PAGES .
.IP
-.B PDFROFF_COLLATE
+.B \%PDFROFF_COLLATE
is ignored,
if
.B pdfroff
is invoked with the
-.I \-\-no\-kill\-null\-pages
+.I \%\-\-no\-kill\-null\-pages
option.
+.
.TP
.B PDFROFF_KILL_NULL_PAGES
-Sepcifies options to be passed to the
-.B PDFROFF_COLLATE
+Specifies options to be passed to the
+.B \%PDFROFF_COLLATE
program.
.IP
It should not normally be necessary to specify
-.BR PDFROFF_KILL_NULL_PAGES .
+.BR \%PDFROFF_KILL_NULL_PAGES .
The internal default is a
-.BI sed (@MAN1EXT@)
+.BR sed (@MAN1EXT@)
script,
which is intended to remove completely blank pages
from the collated output stream,
@@ -481,22 +480,23 @@
.BR pdfroff .
However,
if any alternative to
-.BI sed (@MAN1EXT@)
+.BR sed (@MAN1EXT@)
is specified for
-.BR PDFROFF_COLLATE ,
+.BR \%PDFROFF_COLLATE ,
then it is likely that a corresponding alternative specification for
-.B PDFROFF_KILL_NULL_PAGES
-will be required.
+.B \%PDFROFF_KILL_NULL_PAGES
+is required.
.IP
As in the case of
-.BR PDFROFF_COLLATE ,
-.B PDFROFF_KILL_NULL_PAGES
+.BR \%PDFROFF_COLLATE ,
+.B \%PDFROFF_KILL_NULL_PAGES
is ignored,
if
.B pdfroff
is invoked with the
-.I \-\-no\-kill\-null\-pages
+.I \%\-\-no\-kill\-null\-pages
option.
+.
.TP
.B PDFROFF_POSTPROCESSOR_COMMAND
Specifies the command to be used for the final document conversion
@@ -506,7 +506,7 @@
.I stdout
stream,
and must accept an arbitrary number of
-.I files ...
+.I files .\|.\|.\&
arguments,
with the special case of
.I \-
@@ -515,22 +515,24 @@
stream.
.IP
If unspecified,
-.B PDFROFF_POSTPROCESSOR_COMMAND
-defaults to:
+.B \%PDFROFF_POSTPROCESSOR_COMMAND
+defaults to
+.
.RS 2
.IP
.I
.ad l
-.nohy gs \-dBATCH \-dQUIET \-dNOPAUSE \-sDEVICE=pdfwrite \-sOutputFile=\-
+.NH gs \-dBATCH \-dQUIET \-dNOPAUSE \-sDEVICE=pdfwrite \-sOutputFile=\-
.ad
.RE
+.
.TP
.B GROFF_TMPDIR
Identifies the directory in which
.B pdfroff
should create temporary files.
If
-.B GROFF_TMPDIR
+.B \%GROFF_TMPDIR
is
.I not
specified, then the variables
@@ -539,8 +541,9 @@
and
.B TEMP
are considered in turn, as possible temporary file repositories.
-If none of these are set, then temporary files will be created
+If none of these are set, then temporary files are created
in the current directory.
+.
.TP
.B GROFF_GHOSTSCRIPT_INTERPRETER
Specifies the program to be invoked, when
@@ -549,24 +552,25 @@
.B groff
PostScript output to PDF.
If
-.B PDFROFF_POSTPROCESSOR_COMMAND
+.B \%PDFROFF_POSTPROCESSOR_COMMAND
is specified,
then the command name it specifies is
.I implicitly
assigned to
-.BR GROFF_GHOSTSCRIPT_INTERPRETER ,
+.BR \%GROFF_GHOSTSCRIPT_INTERPRETER ,
overriding any explicit setting specified in the environment.
If
-.B GROFF_GHOSTSCRIPT_INTERPRETER
+.B \%GROFF_GHOSTSCRIPT_INTERPRETER
is not specified, then
.B pdfroff
-will search the process
+searches the process
.BR PATH ,
looking for a program with any of the well known names
for the GhostScript interpreter;
if no GhostScript interpreter can be found,
.B pdfroff
-will abort.
+aborts.
+.
.TP
.B GROFF_AWK_INTERPRETER
Specifies the program to be invoked, when
@@ -575,49 +579,53 @@
.B groff
intermediate message stream.
If
-.B GROFF_AWK_INTERPRETER
+.B \%GROFF_AWK_INTERPRETER
is not specified, then
.B pdfroff
-will search the process
+searches the process
.BR PATH ,
looking for any of the preferred programs, `gawk', `mawk', `nawk'
and `awk', in this order;
if none of these are found,
.B pdfroff
-will issue a warning message, and continue processing;
-however, in this case, no reference dictionary will be created.
+issues a warning message, and continue processing;
+however, in this case, no reference dictionary is created.
+.
.TP
.B OSTYPE
Typically defined automatically by the operating system,
.B OSTYPE
-is used on Microsoft Win32/MS\(hyDOS platforms
+is used on Microsoft Win32/MS-DOS platforms
.IR only ,
to infer the default
-.B PATH_SEPARATOR
+.B \%PATH_SEPARATOR
character,
which is used when parsing the process
.B PATH
to search for external helper programs.
+.
.TP
.B PATH_SEPARATOR
If set,
-.B PATH_SEPARATOR
+.B \%PATH_SEPARATOR
overrides the default separator character,
-(':' on POSIX/UNIX systems,
+(`:' on POSIX/UNIX systems,
inferred from
.B OSTYPE
-on Microsoft Win32/MS\(hyDOS),
+on Microsoft Win32/MS-DOS),
which is used when parsing the process
.B PATH
to search for external helper programs.
+.
.TP
.B SHOW_PROGRESS
If this is set to a non-empty value, then
.B pdfroff
-will always behave as if the
-.B \-\-report\-progress
+always behaves as if the
+.B \%\-\-report\-progress
option is specified, on the command line.
.
+.
.\" --------------------------------------------------------------------
.
.SH FILES
@@ -634,6 +642,7 @@
normally, the final output file should be named
.IB file .pdf\c
\&.
+.
.P
Temporary files, created by
.BR pdfroff ,
@@ -650,8 +659,8 @@
.I *
represents any of the extensions used by
.B pdfroff
-to identify the following temporary and intermediate files:\(em
-.RS
+to identify the following temporary and intermediate files.
+.
.TP
.BI pdf $$ .tmp
A scratch pad file,
@@ -660,6 +669,7 @@
during the
.I reference dictionary
compilation phase.
+.
.TP
.BI pdf $$ .ref
The
@@ -676,7 +686,7 @@
as collected in the preceding pass).
.IP
If the
-.BR \-\-reference\-dictionary =\c
+.BR \%\-\-reference\-dictionary =\c
.I name
option is specified,
this intermediate file becomes permanent,
@@ -685,6 +695,7 @@
rather than
.BI pdf $$ .ref\c
\&.
+.
.TP
.BI pdf $$ .cmp
Used to collect
@@ -699,7 +710,7 @@
.BI pdf $$ .ref\c
\&,
(or the corresponding file named by the
-.BR \-\-reference\-dictionary =\c
+.BR \%\-\-reference\-dictionary =\c
.I name
option),
then
@@ -709,6 +720,7 @@
.I document reference map
is appended to this intermediate file,
for inclusion in the final formatting passes.
+.
.TP
.BI pdf $$ .tc
An intermediate
@@ -719,6 +731,7 @@
on ultimate output to the
.I GhostScript
postprocessor.
+.
.TP
.BI pdf $$ .ps
An intermediate
@@ -731,7 +744,7 @@
.I after
.BI pdf $$ .tc\c
\&.
-.RE
+.
.
.\" --------------------------------------------------------------------
.
@@ -753,6 +766,7 @@
with this document providing the reference to
.BR pdfroff 's
extended features.
+.
.P
While
.B pdfroff
@@ -769,32 +783,31 @@
in PDF format, in the reference guide
.BR "\*(lqPortable Document Format Publishing with GNU Troff\*(rq" ,
included in the installed documentation set as
-.hy 0
-.BR @PDFDOCDIR@/pdfmark.pdf .
-.hy
+.BR address@hidden@/pdfmark.pdf .
+.
.
.\" --------------------------------------------------------------------
.
.SH AUTHOR
-Copyright \(co 2005, 2006, Free Software Foundation, Inc.
-.LP
+Copyright \(co 2005, 2006, 2007 Free Software Foundation, Inc.
+.
+.P
This man page is distributed under the terms of the
GNU Free Documentation License (FDL), version 1.1 or later,
and is part of the
.I GNU troff
software package.
It was originally written by Keith Marshall,
-.nohy <address@hidden>,
+.NH <address@hidden>,
who also wrote the implementation of the
.I pdfroff
program, to which it relates.
-.LP
+.
+.P
You should have received a copy of the FDL as part of the
.I GNU troff
-distribution; it is also available on\-line, at the GNU
-.Q copyleft
-site,
-.nohy <http://www.gnu.org/copyleft/fdl.html>.
+distribution; it is also available on\-line, at
+.URL http://www.gnu.org/copyleft/fdl.html "The GNU copyleft site" .
.
.\" --------------------------------------------------------------------
.\" EOF / vim: ft=groff
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Groff-commit] groff ChangeLog contrib/pdfmark/pdfroff.man,
Werner LEMBERG <=