summaryrefslogtreecommitdiff
path: root/Build/source/texk/dvipdfm-x/man
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2021-02-25 19:22:25 +0000
committerKarl Berry <karl@freefriends.org>2021-02-25 19:22:25 +0000
commitad547a6b5986815fda458221149728d9d9ab1d87 (patch)
tree16296910eb3eca724371474ea9aea3994dc69614 /Build/source/texk/dvipdfm-x/man
parent947b43de3dd21d58ccc2ffadefc4441ea1c2a813 (diff)
restore Build,TODO from r57911
git-svn-id: svn://tug.org/texlive/trunk@57915 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Build/source/texk/dvipdfm-x/man')
-rw-r--r--Build/source/texk/dvipdfm-x/man/dvipdfmx.1354
-rw-r--r--Build/source/texk/dvipdfm-x/man/dvipdft.140
-rw-r--r--Build/source/texk/dvipdfm-x/man/extractbb.199
3 files changed, 493 insertions, 0 deletions
diff --git a/Build/source/texk/dvipdfm-x/man/dvipdfmx.1 b/Build/source/texk/dvipdfm-x/man/dvipdfmx.1
new file mode 100644
index 00000000000..c8a6ad6c3c8
--- /dev/null
+++ b/Build/source/texk/dvipdfm-x/man/dvipdfmx.1
@@ -0,0 +1,354 @@
+.de EX
+.sp
+.in +5
+.nf
+.ft CW
+..
+.de EE
+.in -5
+.ft R
+.sp
+.fi
+..
+.TH "DVIPDFMX" "1" "5 October 2020"
+.SH NAME
+dvipdfmx, xdvipdfmx, dvipdfm \- produce PDF files directly from DVI files
+.SH SYNOPSIS
+.B dvipdfmx
+or
+.B dvipdfm
+.RI [ options ]
+.I file\c
+.RB [ .dvi ]
+.SH DESCRIPTION
+The program
+.B dvipdfmx
+generates a PDF file from a DVI file. DVI files are the output produced
+by TeX.
+.B groff
+can also generate DVI files using
+.BR grodvi (-Tdvi).
+
+In TeX Live,
+.B dvipdfm
+is another incarnation of
+.B dvipdfmx
+rather than a separate program. Compatibility is attempted as best as
+possible.
+
+In addition,
+.B xdvipdfmx
+is another incarnation. It is used as the back end for
+.BR xetex (1)
+and is not intended to be invoked directly.
+
+.B dvipdfmx
+recognizes several commonly used
+.BR \especial
+commands, which are extensions to the DVI format. Specifically, it
+understands color specials, papersize specials, tpic specials (which
+allow it to be used with
+.BR pic ),
+hypertex specials, and some PostScript specials. These extensions allow
+documents to contain color, figures, and hyperlinks. The program tries
+to mimic the behavior of
+.B dvips
+where possible, so that many macro packages produced for use with
+.B dvips
+will also work with
+.BR dvipdfmx .
+In addition,
+.B dvipdfmx
+understands its own specific
+.B \especial
+commands to allow access to PDF features such as annotations and
+bookmarks.
+
+As of December 2018, one such special specific to
+.B dvipdfmx
+is
+.IR pdf:trailerid ,
+which specifies the /ID in the PDF trailer.
+It is used like this (from the TeX level):
+.br
+\especial{pdf:trailerid [ (0123456789abcdef) (01234567890abcdef) ]}
+.br
+That is, the special takes an array (the square brackets) of two 16-byte
+PDF strings (the parentheses). This is the same syntax as LuaTeX's
+.IR "\epdfvariable trailerid" ,
+while different from pdfTeX's
+.IR \epdftrailerid .
+It must appear on the first output page, otherwise it is ignored.
+
+Unrecognized specials will generate warning messages. Packages that may need a
+.B dvipdfm
+or
+.B dvipdfmx
+driver option include
+.IR geometry ,
+.IR hyperref ,
+.IR bookmark ,
+.IR graphicx ,
+and
+.IR xcolor .
+
+For issues related to bounding boxes (and hence image sizes), see
+.BR extractbb (1).
+.SH OPTIONS
+Unlike with many other programs, argument values must be separated from
+option names by a space, not an = sign; option names cannot be
+abbreviated; and \- and \-\- cannot be used interchangeably.
+.TP 5
+.B \-\^c
+Ignore (or accept) color
+.BR \especials .
+By default, color
+.BR \especial "s"
+are interpreted normally (changeable in the configuration file). The
+.B \-\^c
+option may be used to produce a black and white document
+from a document containing color TeX
+.B \especial
+commands.
+.TP 5
+.B \-\-\^dvipdfm
+Enable
+.B dvipdfm
+emulation mode. This is the default if the executable name is `dvipdfm'.
+.TP 5
+.B \-\^d number
+Specify the number of decimal digits in the PDF output; must be between
+0 and 5, default is 2.
+.TP 5
+.B \-\^e
+Ignored, for (semi-)compatibility with
+.BR dvipdfm .
+.TP 5
+.B \-\^f map_file
+Read the font map file given by
+.IR map_file .
+The default map file in TeX Live is
+.IR pdftex.map ,
+as defined in the configuration file.
+.TP 5
+.B \-\-\^help
+Show a help message and exit successfully.
+.TP 5
+.B \-\^l
+Select landscape mode. In other words, exchange the
+.I x
+and
+.I y
+dimensions of the paper.
+.TP 5
+.B \-\^m " mag"
+Magnify the input document by
+.IR mag .
+.TP 5
+.B \-\^o " filename"
+Set the PDF output file name; use `-' for stdout.
+By default, the name of the output
+file is derived from the input, that is,
+.IR file .pdf.
+.TP 5
+.B \-\^p " paper"
+Select the papersize by name (e.g.,
+.BR letter ", " legal ", " ledger ", " tabloid ", " a3 ", " a4 ", or " a5
+)
+.TP 5
+.B \-\^q
+Quiet mode.
+.TP 5
+.B \-\^r " size"
+Set resolution of bitmapped fonts to
+.B size
+dots per inch. Bitmapped fonts are generated
+by the Kpathsea library, which uses Metafont. Bitmapped
+fonts are included as Type 3 fonts in the PDF output file. Default is 600.
+.TP 5
+.B \-\^s " page_specifications"
+Select the pages of the DVI file to be processed; default is `-',
+meaning all pages. The
+.I page_specifications
+consists of a comma separated list of
+.IR page_ranges :
+.EX
+.IR "page_specifications := page_specification" "[," page_specifications "]"
+.EE
+where
+.EX
+.IR "page_specification := single_page" | page_range
+.IR "page_range := " [ first_page ]\^\-\^[ last_page ]
+.EE
+An empty
+.I first_page
+is treated as the first page of the DVI file, and
+an empty
+.I last_page
+is treated as the last page of the DVI file.
+
+Examples:
+.RS
+.TP 5
+.B "\-\^s 1,3,5"
+includes pages 1, 3, and 5;
+.TP 5
+.B "\-\^s \-"
+includes all pages;
+.TP 5
+.B "\-\^s \-,\-"
+includes two copies of all pages in the DVI file;
+and
+.TP 5
+.B "\-\^s 1\-10"
+includes the first ten pages of the DVI
+file.
+.RE
+.TP 5
+.B \-\^t
+Search for thumbnail images of each page
+in the directory named by the
+.B TMPDIR
+environment variable. The thumbnail images must be named in a specific
+format: the same base name as the DVI file and the page number as the
+extension to the file name.
+.B dvipdfmx
+does not generate such thumbnails itself, but it is distributed with a
+wrapper program named
+.B dvipdft
+that does so.
+.TP 5
+.B \-\-\^version
+Show a help message and exit successfully.
+.TP 5
+.B \-\^v
+Increase verbosity.
+Results of the
+.B \-\^v
+option are cumulative (e.g.,
+.B \-\^vv
+increases the verbosity by two increments). Maximum verbosity is four.
+.TP 5
+.B \-\-\^kpathsea-debug number
+Have Kpathsea output debugging information; `-1' for everything (voluminous).
+.TP 5
+.B \-\^x x_offset
+Set the left margin to
+.IR x_offset .
+The default left margin is
+.BR 1.0in .
+The dimension may be specified in any units understood by TeX (e.g.,
+.BR bp ", " pt ", " in ", " cm ).
+.TP 5
+.B \-\^y y_offset
+Set the top margin to
+.IR y_offset .
+The default top margin is
+.BR 1.0in .
+The dimension may be specified in any units understood by TeX (e.g.,
+.BR bpt ", " pt ", " in ", " cm ).
+.TP 5
+.B \-\^z number
+Set the compression level to
+.IR compression_level .
+Compression levels range from 0 (no compression) to
+9 (maximum compression) and correspond to the values understood by zlib;
+default is 9.
+.TP 5
+.B \-\^C number
+Miscellaneous option flags; see the --help output for details.
+.TP 5
+.B \-\^D template
+PostScript to PDF conversion command line template; the default is taken
+from the configuration file, which also gives all the details and
+mentions several possibilities.
+.TP 5
+.B \-\^E
+Always try to embed fonts, ignoring licensing flags, etc.
+.TP 5
+.B \-\^I number
+Image cache life in hours; default is -2, meaning to not cache images at
+all. A value of -1 means to erase all old images and also new images; 0
+means to erase all old images but leave new images.
+.TP 5
+.B \-\^K number
+Encryption key length; default 40.
+.TP 5
+.B \-\^M
+Process MetaPost PostScript output.
+.TP 5
+.B \-\^O number
+Set maximum depth of open bookmark items; default 0.
+.TP 5
+.B \-\^P number
+Set permission flags for PDF encryption; default 0x003C.
+.TP 5
+.B \-\^S
+Enable PDF encryption.
+.TP 5
+.B \-\^V number
+Set PDF minor version; default 5 (from the configuration file).
+.SH "IMAGE BOUNDING BOXES"
+When including images with
+.BR dvipdfmx ,
+their bounding boxes should be generated by running
+.BR extractbb .
+The result will be in an
+.B .xbb
+file; the xbb information is the same as for the PDF format.
+.SH ENVIRONMENT
+.B dvipdfmx
+uses the
+.B kpathsea
+library for locating the files that it opens. Hence, the environment
+variables documented in the
+.I Kpathsea library
+documentation influence
+.BR dvipdfmx .
+It also uses the value of the environment variable TMPDIR as the
+directory to search for thumbnail images of each page.
+.SH FILES
+The precise location of the following files is determined by the
+.I Kpathsea library
+configuration. The location may be determined by using kpsewhich, e.g.,
+.nf
+.B kpsewhich \-progname=dvipdfmx \-format='other text files' dvipdfmx.cfg
+.fi
+.TP 5
+.I dvipdfmx.cfg
+Default configuration file
+.TP 5
+.I pdftex.map
+The default font map file (this may be changed in the config file).
+.TP 5
+.I *.tfm
+TeX font metrics
+.TP 5
+.I *.vf
+TeX virtual font files
+.TP 5
+.I *.pfb
+PostScript Type 1 font files
+.TP 5
+.I
+texmf.cnf
+The Kpathsea library configuration file.
+The location of this file may be found by typing
+.nf
+.B kpsewhich texmf.cnf
+.fi
+.SH "SEE ALSO"
+dvipdft(1), extractbb(1),
+.br
+tex(1), luatex(1), xetex(1), dvips(1),
+.br
+groff(1), grodvi(1), pic(1),
+the Kpathsea library Info documentation (http://tug.org/kpathsea),
+and the Dvipdfmx User's Manual (in the distribution).
+.SH AUTHOR
+Primarily Mark A. Wicks; dvipdfmx extensions primarily by Jin-Hwan Cho,
+Shunsaku Hirata, and Matthias Franz. For the version in TeX Live, all
+bugs and other reports should go to the
+.B dvipdfmx
+maintainers at tex-k (at) tug.org. This man page edited for TeX Live
+by Bob Tennent and others. This man page is public domain.
diff --git a/Build/source/texk/dvipdfm-x/man/dvipdft.1 b/Build/source/texk/dvipdfm-x/man/dvipdft.1
new file mode 100644
index 00000000000..50646022ef0
--- /dev/null
+++ b/Build/source/texk/dvipdfm-x/man/dvipdft.1
@@ -0,0 +1,40 @@
+.TH "dvipdft" "1" "May 2004" "teTeX" "teTeX"
+.PP
+.SH "NAME"
+dvipdft \- create thumbnail images for use with dvipdfm
+.PP
+.SH "SYNOPSIS"
+.PP
+.B dvipdft
+.RI [ DVIPDFM-OPTIONS \&.\&.\&.]
+.I filename\c
+.RB [ .dvi ]
+.PP
+.SH "DESCRIPTION"
+.PP
+.B dvipdft
+creates thumbnail pictures of the pages in your file
+and subsequently runs dvipdfm to create a PDF file with these
+thumbnails.
+.PP
+.SH "OPTIONS"
+.HP
+All options are simply handed on to dvipdfm
+.HP
+.SH "SEE ALSO"
+.IP
+\fBdvipdfm\fP(1)
+.PP
+.SH "BUGS"
+.PP
+None known\&.
+.PP
+.SH "AUTHOR"
+.PP
+\fBdvipdft\fP was written by Mark A. Wicks and Thomas Esser.
+.PP
+This manual page was written by Frank K\[:u]ster <frank@kuesterei\&.ch>,
+for the Debian GNU/Linux system\&. It may be used by others without
+contacting the author\&. Any mistakes or omissions in the manual page
+are my fault; inquiries about or corrections to this manual page
+should be directed to me (and not to the primary author)\&.
diff --git a/Build/source/texk/dvipdfm-x/man/extractbb.1 b/Build/source/texk/dvipdfm-x/man/extractbb.1
new file mode 100644
index 00000000000..34b6d348580
--- /dev/null
+++ b/Build/source/texk/dvipdfm-x/man/extractbb.1
@@ -0,0 +1,99 @@
+.TH "EXTRACTBB" "1" "20 April 2012" "20120420" "DVIPDFMx"
+.PP
+.SH "NAME"
+extractbb, ebb \- extract bounding box information from graphics files
+.PP
+.SH "SYNOPSIS"
+.PP
+.B extractbb
+.RB [ \-v | \-q ]
+.RB [ \-O ]
+.RB [ \-m | \-x ]
+.IR file \&.\&.\&.
+.PP
+.SH "DESCRIPTION"
+.PP
+For each
+.SM JPEG\c
+,
+.SM PNG\c
+, or
+.SM PDF
+file given on the command line,
+.B extractbb
+extracts the bounding box information and writes it into a file with extension
+.BR .xbb ,
+together with some header information. These files can then be used by
+.B dvipdfmx
+or other programs. For
+.SM PDF
+files, the number of pages and the
+.SM PDF
+version number are reported as well.
+The input filename extension may be in upper or lower case.
+.PP
+If called as
+.BR ebb ,
+the output is written in the ``bb'' format (and with extension
+.BR .bb )
+as used by
+.BR dvipdfm .
+.B Xbb
+may be defined as a synomym for
+.B extractbb
+on your system.
+.PP
+.SH "OPTIONS"
+.PD 0
+.TP 10
+.B -v
+Be verbose.
+.TP
+.B -q
+Be quiet.
+.TP
+.B -O
+Write output to standard output.
+.TP
+.B -m
+Write output in dvipdfm's ``bb'' format.
+.TP
+.B -x
+Write output in dvipdfmx's ``xbb'' format (default), which is the same
+as that used by pdfTeX.
+.PD
+.PP
+.SH "OUTPUT FORMATS"
+.PP
+Here are more details about the bb and xbb formats:
+.PP
+The original ebb (from dvipdfm) ignored density information in bitmap
+images, and generated bounding boxes with 100px = 72bp = 1in.
+Unfortunately, screenshots (especially) tend to look bad with this
+approach.
+.PP
+So, extractbb (from dvipdfmx) uses density information if present.
+Otherwise, it generates bounding box with 100px = 100bp. This is what
+pdfTeX does.
+.SH "BUGS"
+.PP
+There is currently no way to specify which bounding box is taken
+for
+.SM PDF
+files. It will always be the first one from the following
+list: ArtBox, TrimBox, BleedBox, MediaBox. (Often only MediaBox
+is defined.) Moreover, the reported bounding box always refers
+to the first page in a
+.SM PDF
+file.
+.PP
+.SH "AUTHOR"
+.PP
+\fBextractbb\fP was written by the DVIPDFMx project team
+<dvipdfmx@ktug.or.kr>, based on the program \fBebb\fP by Mark A. Wicks.
+.PP
+This manual page was also written by the DVIPDFMx project team,
+based on a manual page Frank K\[:u]ster <frank@kuesterei\&.ch>
+wrote for the Debian GNU/Linux system\&.
+It may be used, modified, and/or redistributed by others without
+contacting the authors\&.