diff options
Diffstat (limited to 'Master/texmf-dist/doc/man')
480 files changed, 45457 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/man/Makefile b/Master/texmf-dist/doc/man/Makefile new file mode 100644 index 00000000000..b0d665adbb4 --- /dev/null +++ b/Master/texmf-dist/doc/man/Makefile @@ -0,0 +1,24 @@ +# Public domain. Originally written by Manuel Pegourie-Gonnard, 2008. + +DIR = man1 man5 + +export GROFF = groff +export PDFOPTS = -man -t -rS11 +export PSPDF = ps2pdf -sPAPERSIZE=a4 + +all: $(DIR) +pdf: $(DIR) +clean: $(DIR) + +# we don't cd to the new dir, since otherwise '.so man1/XXXX.1' doesn't work +$(DIR): + $(MAKE) -f $@/Makefile $(MAKECMDGOALS) +.PHONY: $(DIR) + +# The rules for the .so pages are generated by this target. +# Compare by hand against man1/Makefile. +so_pattern = ^\(.*\)\.1:\.so \(.*\)\.1$$ +so_replace = \1.man1.pdf: \1.1 \2.1\n\t$$(MKPDF)\n +so.rules: + grep '^\.so ' man1/* \ + | sed -e 's/$(so_pattern)/$(so_replace)/' diff --git a/Master/texmf-dist/doc/man/man1/Makefile b/Master/texmf-dist/doc/man/man1/Makefile new file mode 100644 index 00000000000..19c5ce20a31 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/Makefile @@ -0,0 +1,96 @@ +# $Id$ +# Public domain. Originally written by Manuel Pegourie-Gonnard, 2008. + +SRC = $(wildcard man1/*.1) +PDF = $(patsubst %.1, %.man1.pdf, $(SRC)) + +MKPDF = $(GROFF) $(PDFOPTS) $< | $(PSPDF) - $@.tmp && mv $@.tmp $@ || rm $@.tmp + +all: pdf +pdf: $(PDF) + +clean: + @echo 'Removing pdf files.' + @rm -f -- $(PDF) + +%.man1.pdf: %.1 + $(MKPDF) + +# +# See ../Makefile for the so.rules target which generates this list of rules. + +man1/ctangle.man1.pdf: man1/ctangle.1 man1/cweb.1 + $(MKPDF) + +man1/cweave.man1.pdf: man1/cweave.1 man1/cweb.1 + $(MKPDF) + +man1/dvigif.man1.pdf: man1/dvigif.1 man1/dvipng.1 + $(MKPDF) + +man1/dvilj2p.man1.pdf: man1/dvilj2p.1 man1/dvilj.1 + $(MKPDF) + +man1/dvilj4.man1.pdf: man1/dvilj4.1 man1/dvilj.1 + $(MKPDF) + +man1/dvilj4l.man1.pdf: man1/dvilj4l.1 man1/dvilj.1 + $(MKPDF) + +man1/dvilj6.man1.pdf: man1/dvilj6.1 man1/dvilj.1 + $(MKPDF) + +man1/ebb.man1.pdf: man1/ebb.1 man1/extractbb.1 + $(MKPDF) + +man1/fmtutil-sys.man1.pdf: man1/fmtutil-sys.1 man1/fmtutil.1 + $(MKPDF) + +man1/kpsepath.man1.pdf: man1/kpsepath.1 man1/kpsetool.1 + $(MKPDF) + +man1/kpsexpand.man1.pdf: man1/kpsexpand.1 man1/kpsetool.1 + $(MKPDF) + +man1/lamed.man1.pdf: man1/lamed.1 man1/aleph.1 + $(MKPDF) + +man1/mf-nowin.man1.pdf: man1/mf-nowin.1 man1/mf.1 + $(MKPDF) + +man1/mktexfmt.man1.pdf: man1/mktexfmt.1 man1/fmtutil.1 + $(MKPDF) + +man1/odvicopy.man1.pdf: man1/odvicopy.1 man1/dvicopy.1 + $(MKPDF) + +man1/odvitype.man1.pdf: man1/odvitype.1 man1/dvitype.1 + $(MKPDF) + +man1/otangle.man1.pdf: man1/otangle.1 man1/tangle.1 + $(MKPDF) + +man1/pdfclose.man1.pdf: man1/pdfclose.1 man1/pdfopen.1 + $(MKPDF) + +man1/pdflatex.man1.pdf: man1/pdflatex.1 man1/pdftex.1 + $(MKPDF) + +man1/repstopdf.man1.pdf: man1/repstopdf.1 man1/epstopdf.1 + $(MKPDF) + +man1/texconfig-sys.man1.pdf: man1/texconfig-sys.1 man1/texconfig.1 + $(MKPDF) + +man1/texhash.man1.pdf: man1/texhash.1 man1/mktexlsr.1 + $(MKPDF) + +man1/texlua.man1.pdf: man1/texlua.1 man1/luatex.1 + $(MKPDF) + +man1/texluac.man1.pdf: man1/texluac.1 man1/luatex.1 + $(MKPDF) + +man1/updmap-sys.man1.pdf: man1/updmap-sys.1 man1/updmap.1 + $(MKPDF) + diff --git a/Master/texmf-dist/doc/man/man1/a2ping.1 b/Master/texmf-dist/doc/man/man1/a2ping.1 new file mode 100644 index 00000000000..ec06d892da8 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/a2ping.1 @@ -0,0 +1,380 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.13 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "A2PING 1" +.TH A2PING 1 "2004-05-26" "perl v5.8.1" "User Contributed Perl Documentation" +.ds pts-dev \*[.T] +.do if '\*[.T]'ascii' .ds pts-dev tty +.do if '\*[.T]'ascii8' .ds pts-dev tty +.do if '\*[.T]'latin1' .ds pts-dev tty +.do if '\*[.T]'nippon' .ds pts-dev tty +.do if '\*[.T]'utf8' .ds pts-dev tty +.do if '\*[.T]'cp1047' .ds pts-dev tty +.do if '\*[pts-dev]'tty' \{\ +.ll 79 +.pl 33333v +.nr IN 2n +.\} +.ad n + +.SH "NAME" +a2ping.pl \-\- convert between PS, EPS and PDF and other page description +formats +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\& \fBa2ping.pl\fR [\fB\-\-\fR]\fBhelp\fR + \fBa2ping.pl\fR [\fB\-\-\fR]\fBdoc\fR + \fBa2ping.pl\fR [\fIoptions\fR] <\fIinputfile\fR> [[\fIoutformat\fR:] \fIoutputfile\fR] +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +\&\fBa2ping\fR is a \s-1UNIX\s0 command line utility written in Perl that +converts many raster image and vector graphics formats to \s-1EPS\s0 or \s-1PDF\s0 and +other page description formats. Accepted input file formats are: \s-1PS\s0 +(PostScript), \s-1EPS\s0, \s-1PDF\s0, \s-1PNG\s0, \s-1JPEG\s0, \s-1TIFF\s0, \s-1PNM\s0, \s-1BMP\s0, \s-1GIF\s0, \s-1LBM\s0, \s-1XPM\s0, \s-1PCX\s0, +\&\s-1TGA\s0. Accepted output formats are: \s-1EPS\s0, \s-1PCL5\s0, \s-1PDF\s0, \s-1PDF1\s0, \s-1PBM\s0, \s-1PGM\s0, \s-1PPM\s0, +\&\s-1PS\s0, markedEPS, markedPS, \s-1PNG\s0, \s-1XWD\s0, \s-1BMP\s0, \s-1TIFF\s0, \s-1JPEG\s0, \s-1GIF\s0, \s-1XPM\s0. +\&\fBa2ping\fR delegates the low-level work to +Ghostscript (\s-1GS\s0), \fBpdftops\fR and \fBsam2p\fR. \fBa2ping\fR fixes many glitches +during the \s-1EPS\s0 to \s-1EPS\s0 conversion, so its output is often more compatible +and better embeddable than its input. +.PP +Without the \f(CW\*(C`\-\-below\*(C'\fR option, it is guarenteed to start at the 0,0 +coordinate. \f(CW\*(C`\-\-below\*(C'\fR, \f(CW\*(C`\-\-hires\*(C'\fR and \f(CW\*(C`\-v\*(C'\fR are recommended options. +.PP +The page size is set exactly corresponding to the BoundingBox. +This means that when Ghostscript renders it, the result needs no +cropping, and the \s-1PDF\s0 MediaBox is correct. +.PP +If the bounding box is not right, of course, you have problems. If you +feed crap in, you get crap. But you can supply the +\&\fB\-\-bboxfrom=compute\-gs\fR option to make \s-1GS\s0 recompute the bounding box. +.PP +The name of the input file doesn't matter \*(-- \fBa2ping\fR detects the file +format based on the first few bytes of the file. The name of the output +file matters if \fIoutformat\fR is missing from the command line: then the +extension of the output file determines the FileFormat (\fIoutformat\fR). +.SH "EXTERNAL PROGRAMS" +.IX Header "EXTERNAL PROGRAMS" +The internal file format of \fBa2ping.pl\fR is \s-1PS/EPS\s0. Everything read is +first converted to \s-1PS\s0 or \s-1EPS\s0, then processed by \fBa2ping.pl\fR, then +converted to the output format. +.PP +To analyse the bounding box and other properties of non-EPS \s-1PS\s0 files +(and \s-1EPS\s0 files with option \fB\-\-bboxfrom\fR other than \fB=guess\fR), \s-1GS\s0 is +used. Converting \s-1PS\s0 to \s-1EPS\s0 involves this analysis. +.PP +To write \s-1PDF\s0 files, \s-1GS\s0 is used. +.PP +To read \s-1PDF\s0 files, \fBpdftops\fR from the \fBxpdf\fR package is used. +.PP +Sampled input formats are \s-1PNG\s0, \s-1JPEG\s0, \s-1TIFF\s0, \s-1PNM\s0, \s-1BMP\s0, \s-1GIF\s0, \s-1LBM\s0, \s-1XPM\s0, \s-1PCX\s0 +and \s-1TGA\s0. To read sampled input formats, \fBsam2p\fR is used. \fBsam2p\fR is +a raster image converter written in \*(C+ by the author of \fBa2ping.pl\fR. +.PP +Extra output formats are \s-1PNG\s0, \s-1XWD\s0, \s-1BMP\s0, \s-1TIFF\s0, \s-1JPEG\s0, \s-1GIF\s0 and \s-1XPM\s0. To +write extra output formats, \fBsam2p\fR and \s-1GS\s0 are used. +.PP +\&\s-1PNM\s0 output formats are \s-1PGM\s0, \s-1PGM\s0 and \s-1PPM\s0. To write \s-1PNM\s0 output formats, \s-1GS\s0 +is used. +.SH "TIPS AND TRICKS" +.IX Header "TIPS AND TRICKS" +.IP "\(bu" 2 +Call with the \fB\-v\fR option to see progress and debug messages. +.IP "\(bu" 2 +If your \s-1EPS\s0 contains a wrong bounding box, you can fix it by running +\&\f(CW\*(C`a2ping.pl \-v \-\-bboxfrom=compute\-gs thefile.eps \-\-\*(C'\fR +.IP "\(bu" 2 +You can specify \fB\-\fR as \fIinputfile\fR to get stdin and as \fIoutputfile\fR +to get stdout. This works even for \s-1PDF\s0 files (which must be seekable), +because \fBa2ping\fR copies them to a temporary file automatically. +.IP "\(bu" 2 +If \fIinputfile\fR and \fIoutputfile\fR are the same, \fBa2ping\fR copies the +\&\fIinputfile\fR to a temporary location first. However, this usage is +recommended only if there is a backup of the file to be restored in case +\&\fBa2ping\fR doesn't produce the desired result. +.IP "\(bu" 2 +If you specify \fB\-\-\fR as \fIoutputfile\fR, it will be the same as \fIinputfile\fR. +.IP "\(bu" 2 +\&\fBa2ping\fR respects \fB\-\-Duplex\fR for FileFormat \s-1PCL5\s0, even though \s-1GS\s0 doesn't. +.IP "\(bu" 2 +If you have an incompatible \s-1PS\s0 that \s-1GS\s0 can read but your printer cannot print, +just run \f(CW\*(C`a2ping.pl foo.ps PDF: \- | a2ping.pl \- PS: foo.ps\*(C'\fR +.IP "\(bu" 2 +If you have a \s-1PS\s0 coming from Win32 (often with extension \f(CW\*(C`.prn\*(C'\fR), run +it through \fBa2ping\fR. It will remove the resolution changes and the +progress text printed to the terminal (which confuses \fIgv\fR\|(1) and makes +some filters in the print queue emit incorrect output). +.IP "\(bu" 2 +\&\fBa2ping\fR does antialiasing (\fB\-\-antialias=scale3no\fR) of glyphs and +curves when emitting a sampled image (FileFormats such as \s-1PGM\s0 and \s-1PPM\s0). +This improves readability of the glyphs. \fB=yes\fR instructs \s-1GS\s0 to do +internal antialiasing, but it usually doesn't improve much. \fB=scale3no\fR +turns off \s-1GS\s0 internal antialiasing, but makes it render everything 3x3 +as big, and then scales it back down. \fB=scale3no\fR turns on both 3x3 +scaling and \s-1GS\s0 internal antialiasing, which results in thicker lines and +worse quality in general. +.IP "\(bu" 2 +When creating a \s-1PBM\s0 file, antialiasing usually doesn't improve the +quality, so it is switched off by default. But if you set +\&\fB\-\-antialias=scale3no\fR or \fB\-\-antialias=scale3yes\fR, \s-1GS\s0 will render a \s-1PGM\s0 file, +and the value of \fB\-\-threshold\fR determines the minimum intensity for white in +the final \s-1PBM\s0. +.IP "\(bu" 2 +If you need a bigger sampled output file, specify a larger +\&\fB\-\-Resolution\fR. The default is \fB\-\-Resolution=72\fR. If your sampled output file +is going to be really big, you should specify \fB\-\-AntiAlias=yes\fR instead of +the default \fB\-\-AntiAlias=scale3no\fR to speed up conversion. +.SH "MISC" +.IX Header "MISC" +.IP "\(bu" 2 +Doesn't depend on the filename or extension of the input file. +.IP "\(bu" 2 +Conversion from \s-1EPS\s0 to \s-1PDF:\s0 fixes glitches etc., calls gs +\&\-sDEVICE=pdfwrite +.IP "\(bu" 2 +Conversion from \s-1EPS\s0 to \s-1EPS:\s0 fixes various glitches, moves (llx,lly) to +(0,0), removes binary junk from the beginning of the \s-1EPS\s0 etc. +.IP "\(bu" 2 +Conversion from \s-1PDF\s0 to \s-1PDF:\s0 keeps the file intact +.IP "\(bu" 2 +Conversion from \s-1PDF\s0 to \s-1EPS:\s0 calls pdftops \-eps (of the xpdf package) +.IP "\(bu" 2 +Conversion from \s-1PS\s0 to \s-1EPS:\s0 keeps 1st page only, removes setpagedevice etc. +.SH "AUTHORS" +.IX Header "AUTHORS" +The author of \fBa2ping\fR is Szabó Péter <\fIpts@fazekas.hu\fR>. +.PP +\&\fBa2ping\fR is inspired by and historically based on the \fBepstopdf\fR Perl +script modified by Thomas Esser, Sept. 1998, but his modifications have +been removed from \fBa2ping\fR, and also \fBa2ping\fR and \fBepstopdf\fR do not +share common code anymore. \fBepstopdf\fR is written by Sebastian Rahtz, +for Elsevier Science. \fBepstopdf\fR contained extra tricks from Hans Hagen's +texutil. +.SH "HISTORY" +.IX Header "HISTORY" +.Sh "1999/05/06 v2.5 (Heiko Oberdiek)" +.IX Subsection "1999/05/06 v2.5 (Heiko Oberdiek)" +.Vb 14 +\& * New options: --hires, --exact, --filter, --help. +\& * Many cosmetics: title, usage, ... +\& * New code for debug, warning, error +\& * Detecting of cygwin perl +\& * Scanning for %%{Hires,Exact,}BoundingBox. +\& * Scanning only the header in order not to get a wrong +\& BoundingBox of an included file. +\& * (atend) supported. +\& * uses strict; (earlier error detecting). +\& * changed first comment from '%!PS' to '%!'; +\& * corrected (atend) pattern: '\es*\e(atend\e)' +\& * using of $bbxpat in all BoundingBox cases, +\& correct the first white space to '...Box:\es*$bb...' +\& * corrected first line (one line instead of two before 'if 0;'; +.Ve +.Sh "2000/11/05 v2.6 (Heiko Oberdiek)" +.IX Subsection "2000/11/05 v2.6 (Heiko Oberdiek)" +.Vb 1 +\& * %%HiresBoundingBox corrected to %%HiResBoundingBox +.Ve +.Sh "2001/03/05 v2.7 (Heiko Oberdiek)" +.IX Subsection "2001/03/05 v2.7 (Heiko Oberdiek)" +.Vb 2 +\& * Newline before grestore for the case that there is no +\& whitespace at the end of the eps file. +.Ve +.Sh "2003/02/02 (Szabó Péter)" +.IX Subsection "2003/02/02 (Szabó Péter)" +.Vb 10 +\& * option --below +\& * removes DOS EPSF binary junk correctly +\& * adds all 3 BoundingBox DSC comments +\& * reads all 3 BoundingBox DSC comments, and picks the best +\& * forces BoundingBox to be an integer +\& * adds %%EndComments and proper %!PS-Adobe-?-? EPSF-?.? header +\& * adds %%Pages: +\& * adds invocation syntax: a2ping <infile.eps> <outfile.eps|pdf> +\& * can convert PDF to EPS (by calling pdftops(1)) and PDF to PDF +\& * emulates work for PDF input +.Ve +.Sh "2003/04/16 (Szabó Péter)" +.IX Subsection "2003/04/16 (Szabó Péter)" +.Vb 7 +\& * added PS and sam2p support, renamed to a2ping +\& * sam2p and pdftops if $InputFilename eq '-'; +\& * remove PJL UEL header from the beginning +\& * works for PS non-EPS files for input +\& * input support for PNG JPEG TIFF PNM BMP GIF LBM XPM PCX TGA via sam2p +\& * removes ^L (form feed) from end of EPS file +\& * -x=-c:rle to add sam2p options +.Ve +.Sh "2003/04/26 (Szabó Péter)" +.IX Subsection "2003/04/26 (Szabó Péter)" +.Vb 14 +\& * omit the unnecessary setpagedevice calls when creating normal eps +\& * --noverbose --nocompress supported differently +\& * no more option defaults :-( +\& * justlib2 +\& * multi-page output with PS:, PDF:, PCL5: +\& * after `a2ping -pa4', file out.pcl says: `HP PCL printer data - A4 page +\& size', instead of `US letter' +\& * justlib2-ified doesn't depend on Getopt::Long anymore +\& * fully supports filtering (stdin and/or stdout), PDF and PCL5 output to +\& pipe (!$$ll_zero) +\& * adds DSC ``%%DocumentMedia: plain 612 792 0 () ()'' +\& * BoundingBox precedence for EPS input: --PageSize, %%*BoundingBox, +\& setpagedevice. Precedence for other inputs: --PageSize, setpagedevice, +\& %%*BoundingBox +.Ve +.Sh "2003/09/25 (Szabó Péter)" +.IX Subsection "2003/09/25 (Szabó Péter)" +.Vb 7 +\& * --bboxfrom=adsc: %%BoundingBox overrides -sDEVICE=bbox +\& * improved bbox discovery +\& * many bugfixes +\& * MetaPost EPS input fixes for prologues:=0; +\& * a2ping.pl -v --papersize=50,60 --bboxfrom=compute-gs t.ps t2.ps +\& * consistent bbox, --PageSize, /PageSize handling +\& * consistent --Resolution and --Duplex handling +.Ve +.Sh "2003/12/02 (Szabó Péter)" +.IX Subsection "2003/12/02 (Szabó Péter)" +.Vb 1 +\& * --bboxfrom=compute-gs option to fix PS -> EPS bbox (gs -sDEVICE=bbox), tuzv.eps +.Ve +.Sh "2004/02/10 v2.77 (Szabó Péter)" +.IX Subsection "2004/02/10 v2.77 (Szabó Péter)" +.Vb 7 +\& * the compute-pipe routine is now run unless --bboxfrom=guess with EPS +\& * added --gsextra= +\& * added --antialias= +\& * added FileFormat PBM, PGM, PPM +\& * separated FileFormat features to FL_* constants +\& * added --doc +\& * there is no default FileFormat (PDF) anymore +.Ve diff --git a/Master/texmf-dist/doc/man/man1/a2ping.man1.pdf b/Master/texmf-dist/doc/man/man1/a2ping.man1.pdf Binary files differnew file mode 100644 index 00000000000..4921e218674 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/a2ping.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/afm2afm.1 b/Master/texmf-dist/doc/man/man1/afm2afm.1 new file mode 100644 index 00000000000..3f66df9a8bb --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/afm2afm.1 @@ -0,0 +1,199 @@ +.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "AFM2AFM 1" +.TH AFM2AFM 1 "2012-03-06" "fontools" "Marc Penninga" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +afm2afm \- reencode an afm file +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +.IP "\fBafm2afm\fR" 8 +.IX Item "afm2afm" +[\fB\-help\fR] +[\fB\-encoding\fR \fIencodingfile\fR] +[\fB\-output\fR \fIoutputfile\fR] +\&\fBafmfile\fR +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +\&\fBafm2afm\fR re-encodes an \fIafm\fR file. +.PP +Metrics (including kerning data) for characters not present in the +chosen encoding are excluded from the output, which resuls in +much smaller files. +.PP +Note that if you don't specify an encoding file, the \fIafm\fR file +isn't re-encoded, but the unused data is still pruned. +.PP +The program also generates an entry for a \fIdvips\fR\-style map file, +but only if the \fIafm\fR file has been re-encoded and +the output was written to file +(i.e., if both the \fI\-encoding\fR and \fI\-output\fR options were specified). +.SH "OPTIONS AND ARGUMENTS" +.IX Header "OPTIONS AND ARGUMENTS" +.IP "\fB\-help\fR" 4 +.IX Item "-help" +Print a short description of the syntax +.IP "\fB\-encoding\fR \fIencodingfile\fR" 4 +.IX Item "-encoding encodingfile" +Re-encode to the enconding in \fIencodingfile\fR +.IP "\fB\-output\fR \fIoutputfile\fR" 4 +.IX Item "-output outputfile" +Write the result to \fIoutputfile\fR instead of \f(CW\*(C`stdout\*(C'\fR. +.IP "\fBafmfile\fR" 4 +.IX Item "afmfile" +The \fIafm\fR file to be re-encoded. +.PP +Option names may be shortened to a unique prefix. +.SH "AUTHOR" +.IX Header "AUTHOR" +Marc Penninga <marcpenninga@gmail.com> +.SH "COPYRIGHT" +.IX Header "COPYRIGHT" +Copyright (C) 2005\-2012 Marc Penninga. +.SH "LICENSE" +.IX Header "LICENSE" +This program is free software; you can redistribute it and/or modify +it under the terms of the \s-1GNU\s0 General Public License as published +by the Free Software Foundation, either version 2 of the License, +or (at your option) any later version. +A copy of the \s-1GNU\s0 General Public License is included with \fBautoinst\fR; +see the file \fIGPLv2.txt\fR. +.SH "DISCLAIMER" +.IX Header "DISCLAIMER" +This program is distributed in the hope that it will be useful, +but \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of +\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0. +See the \s-1GNU\s0 General Public License for more details. +.SH "RECENT CHANGES" +.IX Header "RECENT CHANGES" +(See the source code for the rest of the story.) +.IP "\fI2012\-02\-01\fR" 12 +.IX Item "2012-02-01" +Refactored the code; added the \*(L"no re-encoding, only pruning\*(R" +functionality. diff --git a/Master/texmf-dist/doc/man/man1/afm2afm.man1.pdf b/Master/texmf-dist/doc/man/man1/afm2afm.man1.pdf Binary files differnew file mode 100644 index 00000000000..2e6b61eeac4 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/afm2afm.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/afm2pl.1 b/Master/texmf-dist/doc/man/man1/afm2pl.1 new file mode 100644 index 00000000000..bceec28b937 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/afm2pl.1 @@ -0,0 +1,464 @@ +.\" Title: afm2pl +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> +.\" Date: May 2009 +.\" Manual: afm2pl +.\" Source: +.\" +.TH "AFM2PL" "1" "May 2009" "" "afm2pl" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +afm2pl \- convert AFM font metrics to TeX pl font metrics +.SH "SYNOPSIS" +.HP 7 +\fBafm2pl\fR [\fB\-p\fR\ \fIencoding_file\fR] [\fB\-o\fR] [\fB\-e\fR\ \fIextension_factor\fR] [\fB\-s\fR\ \fIslant_factor\fR] [\fB\-f\fR\ \fIfont_dimensions\fR] [\fB\-k\fR] [\fB\-m\fR\ \fIletter_spacing\fR] [\fB\-l\fR\ \fIligkern_spec\fR] [\fB\-L\fR\ \fIligkern_spec\fR] [\fB\-n\fR] \fIinput_file[\&.afm]\fR [\fIoutput_file[\&.pl]\fR] +.HP 7 +\fBafm2pl\fR [\-\-help] | [\-\-version] +.SH "DESCRIPTION" +.PP +afm2pl converts an afm (Adobe Font Metric) file into a pl (Property List) file, which in its turn can be converted to a tfm (TeX Font Metric) file\&. It normally preserves kerns and ligatures, but also offers additional control over them\&. +.PP +afm2pl is meant to be a partial replacement for afm2tfm, on which it is based\&. With afm2tfm, preserving kerns and ligatures is possible only in a roundabout way, and handling of them is hard\-wired\&. +.PP +For text fonts, Y&Y\'s texnansi is a good encoding to be used with afm2pl\&. Its character set includes all the accented characters likely to be needed for Western languages, plus many typographic symbols, without a need for either virtual fonts or a separate text companion font\&. +.PP +Full LaTeX support for this encoding is available in the form of the texnansi package, which is already part of TeX Live and teTeX\&. These distributions also contain the encoding file texnansi\&.enc\&. +.PP +The distribution contains uppercased and lowercased versions of texnansi, viz\&. texnanuc and texnanlc, to allow font\-based rather than macro\-based uppercasing and lowercasing, and the familiar old ot1 encoding plus some variations in PostScript \&.enc format (I included these because they seem to be absent from teTeX/TeX Live)\&. However, +check your mapfiles +if you have old afm2pl\-generated fonts using these\&. +.PP +Return value: 0 if no error; a negative number indicating the number of missing glyphs if conversion was otherwise successfull but glyphs are missing, and 1 in case of error\&. +.SH "OPTIONS" +.PP +\fB\-p\fR \fIencoding_file\fR +.RS 4 +The default is the encoding specified in the afm file, which had better match the encoding in the fontfile (pfa or pfb)\&. If +afm2pl\-name\&.enc +exists, afm2pl will use this file instead of +name\&.enc, unless an option +\-n +is given\&. The generated mapfile entry (see below) instructs pdftex or the dvi driver to reencode the font on the fly\&. On\-the\-fly reencoding does not require virtual fonts\&. +.RE +.PP +\fB\-o\fR +.RS 4 +Use octal for all character codes in the pl file\&. +.RE +.PP +\fB\-e\fR \fIextend_factor\fR +.RS 4 +Widen or narrow characters by +\fIextend_factor\fR\&. Default is 1\&.0 (natural width)\&. Not recommended\&[1]\&. +.RE +.PP +\fB\-s\fR \fIslant_factor\fR +.RS 4 +Oblique (slant) characters by +\fIslant_factor\fR\&. Not recommended either\&. +.RE +.PP +\fB\-f\fR \fIfont_dimensions\fR +.RS 4 +The value is either the keyword +afm2tfm +or a comma\-separated list of up to five integers\&. The parameters are listed below, with their defaults and their value when the afm2tfm keyword is specified\&. \(oqSpace\(cq means the width of a space in the target font, except of course in the last row\&. Keep in mind that the design size is 1000, and that all numbers must be nonnegative integers\&. +.TS +allbox tab(:); +lB lB lB. +T{ +Font dimension +T}:T{ +Default value +T}:T{ +Afm2tfm value +T} +.T& +l l l +l l l +l l l +l l l +l l l. +T{ +\fIstretch\fR +T}:T{ +space div 2 +T}:T{ +300 \(mu \fIextend_factor\fR +T} +T{ +\fIshrink\fR +T}:T{ +space div 3 +T}:T{ +100 \(mu \fIextend_factor\fR +T} +T{ +\fIextra space\fR +T}:T{ +space div 3 +T}:T{ +missing +T} +T{ +\fIquad\fR +T}:T{ +2 \(mu width of \(oq0\(cq +T}:T{ +1000 \(mu \fIextend_factor\fR +T} +T{ +\fIspace\fR +T}:T{ +(space source font) \(mu \fIextend_factor\fR +T}:T{ +(space source font) \(mu \fIextend_factor\fR +T} +.TE +.sp +For fixed\-pitch fonts, different values apply: +.TS +allbox tab(:); +lB lB lB. +T{ +Font dimension +T}:T{ +Default value +T}:T{ +Afm2tfm value +T} +.T& +l l l +l l l +l l l +l l l +l l l. +T{ +\fIstretch\fR +T}:T{ +0 +T}:T{ +0 +T} +T{ +\fIshrink\fR +T}:T{ +0 +T}:T{ +0 +T} +T{ +\fIextra space\fR +T}:T{ +space +T}:T{ +missing +T} +T{ +\fIquad\fR +T}:T{ +2 \(mu character width +T}:T{ +1000 \(mu \fIextend_factor\fR +T} +T{ +\fIspace\fR +T}:T{ +character width +T}:T{ +character width +T} +.TE +.sp +Specify just a non\-default stretch and shrink with e\&.g\&. +150,70 +and just a non\-default extra space with +,,10\&. +.RE +.PP +\fB\-k\fR +.RS 4 +Keep original ligatures\&. This option only has effect in combination with positive letterspacing; see the section on +letterspacing and extra ligkern info\&. +.RE +.PP +\fB\-m\fR \fIletter_spacing\fR +.RS 4 +Letterspace by +\fIletter_spacing\fR/1000 em (integer)\&. This is useful for making all\-caps typesetting look better\&. Try a value of e\&.g\&. 50 or 100\&. But see the section on +letterspacing and extra ligkern info +for details\&. A better alternative, though, is letting pdftex do the letterspacing\&. The +microtype +package gives LaTeX users access to this feature\&. +.RE +.PP +\fB\-l\fR \fIligkern_spec\fR, \fB\-L\fR \fIligkern_spec\fR +.RS 4 +See the section on +extra ligkern info +for details\&. +.RE +.PP +\fB\-n\fR +.RS 4 +No prefix\&. For \&.enc\- and \&.lig files, the program normally first prefixes the name with `afm2pl\-\'\&. Only if the prefixed filename is not found, will it search for the original filename\&. This option prevents searching for the prefixed filename\&. +.RE +.PP +\fB\-V\fR +.RS 4 +Verbose\&. If turned on, it reports the number of missing glyphs to stderr and their names to stdout\&. +.RE +.PP +\fB\-\-help\fR +.RS 4 +Display a short usage message\&. +.RE +.PP +\fB\-\-version\fR +.RS 4 +Display the version number of afm2pl\&. +.RE +.SH "MAPFILE ENTRIES" +.PP +afm2pl writes a mapfile entry to a file with the same basename as the pl output file, but with extension \&.map\&. It can be used for the dvips mapfile and for the pdftex mapfile\&. It is assumed that the pfb file has the same basename as the afm file and must be downloaded\&. +\fIYou may have to hand\-edit this entry\&.\fR +.PP +You can configure dvips and pdftex to read this additional mapfile or otherwise add the entry to an existing mapfile\&. +.PP +\fBCheck your mapfiles!\fR +To reduce the likelihood of name conflicts, the \&.enc\- files which are part of afm2pl (ot1, ot1csc, ot1ital, ot1tt, texnanlc and texnanuc) have now been prepended with +afm2pl\-\&. The \&.enc files are referenced in mapfiles\&. If you have old afm2pl\-generated \&.tfm files using these, then you should update their mapfile fragments and rerun updmap or updmap\-sys\&. Or you can copy the relevant enc files to your personal or local texmf tree under their previous non\-prefixed names\&. +.SH "EXTRA LIGKERN INFO" +.PP +\fIMost users are well\-advised to leave this mess alone and to accept the default behavior\&.\fR +.PP +The ligatures and kerns present in the afm file can be modified in various ways\&. Default, the encoding file is scanned for extra ligkern specifications, whose format will be described below\&. If there are no ligkern specifications in the encoding file, then extra ligkern specifications will be read from a file [afm2pl\-]default\&.lig\&. A value of 0 for +\fIligkern_spec\fR +means that the ligatures and kerns from the afm file won\'t be tampered with and a value of 1 specifies default behavior\&. One can also specify a comma\-separated list of files with extra ligkerns specs\&. +.PP +If afm2pl is compiled with the kpathsea library, then these files will be searched for under $TEXMF/fonts/lig\&. +.PP +\fINote that ligatures and kerns are hints for the typesetting application; there is no need to download this information to the printer or to make it available to a dvi driver\&.\fR +.PP +The parser for ligkern info has been inherited from afm2tfm virtually without change\&. A ligkern specification can have one of the following forms: +.sp +.RS 4 +.nf +\fIglyph_name1\fR \fIglyph_name2\fR \fIlig_op\fR \fIglyph_name3\fR ; +.fi +.RE +.PP +This specifies a ligature\&. Possible values for +\fIlig_op\fR +are +=:, +|=:, +|=:>, +=:|, +=:|>, +|=:|, +|=:|> +and +|=:|>>\&. These correspond to +LIG, +/LIG, +/LIG>, +LIG/, +LIG/>, +/LIG/, +/LIG/>, +/LIG/>> +in \&.pl syntax; see the pltotf documentation and the \&.lig files in the distribution\&. +.sp +.RS 4 +.nf +\fIglyph_name1\fR <> \fIglyph_name2\fR ; +.fi +.RE +.PP +Kern +\fIglyph_name1\fR +as +\fIglyph_name2\fR\&. +.sp +.RS 4 +.nf +\fIglyph_name1\fR {} \fIglyph_name2\fR ; +.fi +.RE +.PP +Remove the kern between +\fIglyph_name1\fR +and +\fIglyph_name2\fR\&. A value of +* +for either glyph name is interpreted as a wildcard\&. +.sp +.RS 4 +.nf +|| = \fIglyph\fR ; +.fi +.RE +.PP +Set the (right) boundary character to +\fIglyph\fR\&. +\fIglyph\fR +may be either a glyphname or a slot in the encoding vector\&. Choosing a glyph which doesn\'t occur in the output encoding is equivalent to not specifying a boundarychar at all\&. It is ok to pick an encoded glyphname which does not occur in the afm\&. In fact, this is what default\&.lig does: +|| = cwm ;\&. +.PP +You can copy the kerns of an unencoded character to the boundarychar\&. Below, +space +is the unencoded character: +.sp +.RS 4 +.nf +|| <> space ; +.fi +.RE +.PP +This ligkern specification should occur before the one that deletes space kerns\&. +.PP +A ligkern specification should be contained within one line\&. One line may contain several ligkern specifications, separated by spaces\&. Note that +; +(space followed by semicolon) is considered part of the ligkern specification\&. See the lig files included in this distribution\&. Example: +.sp +.RS 4 +.nf +one {} * ; * {} one ; two {} * ; * {} two ; +.fi +.RE +.PP +Lines with ligkern specifications inside an encoding file should start with +% LIGKERN\&. Ligkern specifications in a lig file may optionally start this way\&. +.SH "LETTERSPACING AND EXTRA LIGKERN INFO" +.PP +Letterspacing has various side\-effects for ligkern info\&. Instead of simply applying the extra ligkern info (see previous section), the following is done: +.sp +.RS 4 +\h'-04' 1.\h'+02'In case of positive letterspacing, native ligatures are removed, unless the \-k option is specified\&. +.RE +.sp +.RS 4 +\h'-04' 2.\h'+02'Extra ligkern info is applied as usual, except that in case of positive letterspacing different defaults apply: +\-l 0 +is quietly ignored, ligkern comments in the encoding file are ignored, and defpre\&.lig is read instead of default\&.lig\&. +.RE +.sp +.RS 4 +\h'-04' 3.\h'+02'Letterspacing is applied\&. This adds a lot of kerns, and modifies existing kerns\&. +.RE +.sp +.RS 4 +\h'-04' 4.\h'+02'The extra ligkern info specified with \-L is applied\&. The only ligkern specs which are allowed here, are removals of kerning pairs (with the +{} +operator)\&. Values 0 and 1 have a similar meaning as for the \-l parameter\&. +\fIThe tfm format has room for only about 180x180 ligatures and kerning pairs\&.\fR +This is enough for OT1 encoding, but for texnansi encoding quite a few ligkern specifications have to be removed\&. The pltotf program will remove +\fIall\fR +ligkern info if too many ligatures and kerns remain\&. The default lig file is defpost\&.lig\&. This file throws out kerning pairs which are unlikely to be involved in letterspacing, such as kerns involving accents or kerns with a punctuation character or right bracket at the left\&. It does not add letterspacing kerns involving boundarychars\&. Instead, fontspace is increased by twice the letterspacing\&. defpost\&.lig throws out enough kerns in case of texnansi encoding\&. With other encodings, you may have to throw out additional kerning pairs\&. +.RE +.SH "FONT-BASED UPPER- AND LOWERCASING" +.PP +The distribution includes encoding vectors texnanuc\&.enc and texnanlc\&.enc which produce all\-uppercase and all\-lowercase fonts +.PP +The principal uses for an all\-uppercase font are page headers and section heads\&. If these contain math, then macro\-based uppercasing would create unpleasant complications\&. Example: +.sp +.RS 4 +.nf +afm2pl \-p texnanuc ptmr8a ptmup8y +pltotf ptmup8y +.fi +.RE +.sp +For best results, you should add some letterspacing\&. In LaTeX, this is best done with the +microtype +package; see the documentation of that package\&. But it can also be done with +afm2pl: +.sp +.RS 4 +.nf +afm2pl \-p texnanuc \-m 100 ptmr8a ptmup8y +.fi +.RE +.sp +This requires caution; see +above\&. +.PP +You can use this new font within the context of LaTeX font selection as follows: +.sp +.RS 4 +.nf + +<preamble commands> +\emakeatletter +{\enfss@catcodes +\eDeclareFontShape{LY1}{ptm}{m}{upp}{<\-> ptmup8y}{}} +\emakeatother +\&.\&.\&. +\ebegin{document} +\&.\&.\&. +{\efontshape{upp}\eselectfont uppercase text} + +.fi +.RE +.sp +Note that +upp +is simply a newly made\-up shape name\&. +.SS "The sz ligature \(ss" +.PP +Note that the texnanuc encoding provides no glyph for the sz ligature \(ss; you\'ll either have to substitute ss or provide a macro\-based solution\&. The following code uses either the usual glyph or substitutes the letters ss, depending on whether the glyph exists in the current font: +.sp +.RS 4 +.nf + +\edef\ess{% + \esetbox0\ehbox{\echar25}% + \eifnum\ewd0=0 ss\eelse\ebox0\efi +} + +.fi +.RE +.PP +In LaTeX, this code appears to work well enough, although on occasion you may need to insert +\eprotect\&. A better solution might involve the sixth parameter of the +\eDeclareFontShape +macro, but I failed to get that to work\&. +.SH "AFM2PL, FONTINST AND ARTIFICIAL SMALLCAPS" +.PP +Afm2pl doesn\'t do virtual fonts\&. That means that for things such as artificial smallcaps you have to turn elsewhere, e\&.g\&. to the fontinst package, which is part of any mainstream TeX distribution\&. +.PP +Look under texmf/tex/fontinst for fontinst support files, which allow you to generate a smallcaps font (tfm and vf files) from an afm2pl\-generated tfm file\&. This package only supports texnansi encoding\&. +.PP +There should be no real problem in doing the same for OT1 encoding\&. However, there are several variations of the OT1 encoding to take care of\&. Also, there are as far as I know no officially sanctioned PostScript names for all the variations of the OT1 encoding; the fontinst names contain spaces and are therefore not useable as PostScript names\&. +.SH "CHANGED IN VERSION 0.7.1" +.PP +In order to avoid name conflicts, the \&.enc\- and \&.lig files distributed with afm2pl got +afm2pl\- +prepended to their name\&. The program itself now first searches for the thus prepended name\&. If the \&.enc\- or \&.lig file is not found it will look for the original filename\&. The renaming of the afm2pl \&.enc files may require modification of some mapfiles\&. +.SH "URLS" +.PP +The afm2pl homepage is +\fIhttp://tex\&.aanhet\&.net/afm2pl/\fR\&. +.PP +The paper +\fIFont installation the shallow way\fR\&[2] +(EuroTeX 2006 Proceedings, published as +\fITUGboat\fR\&[3] +issue 27\&.1) illustrates the use of afm2pl\&. +.SH "NOTES" +.IP " 1." 4 +Except that arguably a narrowed Courier is less jarring than a full-width Courier, when used in combination with a normal proportional font. For Courier, choose .833 to match the width of cmtt. Better yet, don't use Courier at all; most TeX distributions offer various good replacements. +.IP " 2." 4 +Font installation the shallow way +.RS 4 +\%http://www.tug.org/TUGboat/Articles/tb27-1/tb86kroonenberg-fonts.pdf +.RE +.IP " 3." 4 +TUGboat +.RS 4 +\%http://www.tug.org/TUGboat/ +.RE diff --git a/Master/texmf-dist/doc/man/man1/afm2pl.man1.pdf b/Master/texmf-dist/doc/man/man1/afm2pl.man1.pdf Binary files differnew file mode 100644 index 00000000000..48a1487a9a4 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/afm2pl.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/afm2tfm.1 b/Master/texmf-dist/doc/man/man1/afm2tfm.1 new file mode 100644 index 00000000000..32822173aa4 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/afm2tfm.1 @@ -0,0 +1,25 @@ +.\" man page for afm2tfm +.TH AFM2TFM 1 "9 August 1990" +.SH NAME +afm2tfm \- convert Adobe font metrics to TeX font metrics +.SH DESCRIPTION +PostScript fonts are (or should be) accompanied by font metric files +such as +.B Times-Roman.afm, +which describes the characteristics of the font called Times-Roman. +To use such fonts with TeX, we need TFM files that contain similar +information. This program does that conversion. For more +information, print out the dvips manual. +.SH FILES +.I psfonts.map +in the config directory used by dvips (update this). +.br +.I ../afm/Makefile +in the dvips sources (look at this for examples). +.SH "SEE ALSO" +dvips(1), tex(1), vptovf(1) +.SH BUGS +An option to add letterspacing to the virtual font was rejected by Knuth +because it would make the fi and fl ligatures break the normal rhythmic pattern. +.SH AUTHORS +Tomas Rokicki <rokicki@cs.stanford.edu> and Donald E. Knuth diff --git a/Master/texmf-dist/doc/man/man1/afm2tfm.man1.pdf b/Master/texmf-dist/doc/man/man1/afm2tfm.man1.pdf Binary files differnew file mode 100644 index 00000000000..04fbfc5ee7f --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/afm2tfm.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/aleph.1 b/Master/texmf-dist/doc/man/man1/aleph.1 new file mode 100644 index 00000000000..0ce1172402f --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/aleph.1 @@ -0,0 +1,240 @@ +.TH ALEPH 1 "1 March 2011" "Web2C 2012" +.\"===================================================================== +.if n .ds MF Metafont +.if t .ds MF M\s-2ETAFONT\s0 +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff +.el .ds OX TeX for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.if t .ds AX \fRA\\h'-0.1667m'\\v'0.20v'M\\v'-0.20v'\\h'-0.125m'S\fP\*(TX +.if n .ds AX AmSTeX +.if t .ds AY \fRA\\h'-0.1667m'\\v'0.20v'M\\v'-0.20v'\\h'-0.125m'S\fP\*(LX +.if n .ds AY AmSLaTeX +.\"===================================================================== +.SH NAME +aleph \- extended Unicode TeX +.SH SYNOPSIS +.B aleph +.RI [ options ] +.RI [ \fB&\fPformat ] +.RI [ file | \fB\e\fPcommands ] +.\"===================================================================== +.SH DESCRIPTION +Run the Aleph typesetter on +.IR file , +usually creating +.IR file.dvi . +If the file argument has no extension, ".tex" will be appended to it. +Instead of a filename, a set of Aleph commands can be given, the first +of which must start with a backslash. +With a +.BI & format +argument Aleph uses a different set of precompiled commands, +contained in +.IR format\fB.fmt\fP ; +it is usually better to use the +.B -fmt +.I format +option instead. +.PP +Aleph is a version of the \*(TX program modified for multilingual +typesetting. It uses Unicode, and has additional primitives for +(among other things) bidirectional typesetting. +.PP +Aleph's command line options are similar to those of \*(TX. +.PP +Aleph is no longer being actively developed; see LuaTeX for current +activity. +.\"===================================================================== +.SH OPTIONS +Run aleph --help to see the complete list of options; this is not +exhaustive. +.TP +.BI --fmt \ format +Use +.I format +as the name of the format to be used, instead of the name by which +Aleph was called or a +.I %& +line. +.TP +.B --halt-on-error +Exit with an error code when an error is encountered during processing. +.TP +.B --help +Print help message and exit. +.TP +.B --ini +Be `initial' Aleph for dumping formats; this is implicitly true if the +program is called as +.BR inialeph . +.TP +.BI --interaction \ mode +Sets the interaction mode. The mode can be one of +.IR batchmode , +.IR nonstopmode , +.IR scrollmode , +and +.IR errorstopmode . +The meaning of these modes is the same as that of the corresponding +\ecommands. +.TP +.B --ipc +Send DVI output to a socket as well as the usual output file. Whether +this option is available is the choice of the installer. +.TP +.B --ipc-start +As +.BR --ipc , +and starts the server at the other end as well. Whether this option +is available is the choice of the installer. +.TP +.BI --kpathsea-debug \ bitmask +Sets path searching debugging flags according to the bitmask. See the +.I Kpathsea +manual for details. +.TP +.BI --maketex \ fmt +Enable +.RI mktex fmt , +where +.I fmt +must be one of +.I tex +or +.IR tfm . +.TP +.BI --no-maketex \ fmt +Disable +.RI mktex fmt , +where +.I fmt +must be one of +.I tex +or +.IR tfm . +.TP +.BI --output-comment \ string +Use +.I string +for the DVI file comment instead of the date. +.TP +.BI --output-directory \ directory +Write output files in +.I directory +instead of the current directory. Look up input files in +.I directory +first, the along the normal search path. +.TP +.B --parse-first-line +If the first line of the main input file begins with +.I %& +parse it to look for a dump name. +.TP +.BI --progname \ name +Pretend to be program +.IR name . +This affects both the format used and the search paths. +.TP +.B --recorder +Enable the filename recorder. This leaves a trace of the files opened +for input and output in a file with extension +.IR .ofl . +(This option is always on.) +.TP +.B --shell-escape +Enable the +.BI \ewrite18{ command } +construct. The +.I command +can be any Bourne shell command. By default, this construct is +enabled in a restricted mode, for security reasons. +.TP +.B --version +Print version information and exit. +.\"===================================================================== +.SH ENVIRONMENT +See the Kpathsearch library documentation (the `Path specifications' +node) for precise details of how the environment variables are used. +The +.B kpsewhich +utility can be used to query the values of the variables. +.PP +One caveat: In most Aleph formats, you cannot use ~ in a filename you +give directly to Aleph, because ~ is an active character, and hence is +expanded, not taken as part of the filename. Other programs, such as +\*(MF, do not have this problem. +.PP +.TP +.B TEXMFOUTPUT +Normally, Aleph puts its output files in the current directory. If +any output file cannot be opened there, it tries to open it in the +directory specified in the environment variable TEXMFOUTPUT. +There is no default value for that variable. For example, if you say +.I tex paper +and the current directory is not writable, if TEXMFOUTPUT has +the value +.IR /tmp , +Aleph attempts to create +.I /tmp/paper.log +(and +.IR /tmp/paper.dvi , +if any output is produced.) TEXMFOUTPUT is also checked for input +files, as \*(TX often generates files that need to be subsequently +read; for input, no suffixes (such as ``.tex'') are added by default, +the input name is simply checked as given. +.TP +.B TEXINPUTS +Search path for +.I \einput +and +.I \eopenin +files. +This should start with ``.'', so +that user files are found before system files. An empty path +component will be replaced with the paths defined in the +.I texmf.cnf +file. For example, set TEXINPUTS to ".:/home/user/tex:" to prepend the +current direcory and ``/home/user/tex'' to the standard search path. +.TP +.B TEXEDIT +Command template for switching to editor. The default, usually +.BR vi , +is set when Aleph is compiled. +.\"===================================================================== +.SH NOTES +This manual page is not meant to be exhaustive. The complete +documentation for this version of Aleph can be found in the info +manual +.IR "Web2C: A TeX implementation" . +See http://tug/org/web2c. +.\"===================================================================== +.SH BUGS +This version of Aleph implements a number of optional extensions. +In fact, many of these extensions conflict to a greater or lesser +extent with the definition of Aleph. When such extensions are +enabled, the banner printed when Aleph starts is changed to print +.B Alephk +instead of +.BR Aleph . +.PP +This version of Aleph fails to trap arithmetic overflow when +dimensions are added or subtracted. Cases where this occurs are rare, +but when it does the generated +.I DVI +file will be invalid. +.\"===================================================================== +.SH "SEE ALSO" +.BR tex (1), +.BR mf (1) +.\"===================================================================== +.SH AUTHORS +The primary authors of Aleph are John Plaice and Yannis Haralambous. +It is currently maintained (for severe bug fixes only) by Taco Hoekwater. diff --git a/Master/texmf-dist/doc/man/man1/aleph.man1.pdf b/Master/texmf-dist/doc/man/man1/aleph.man1.pdf Binary files differnew file mode 100644 index 00000000000..b561b31fb5a --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/aleph.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/allcm.1 b/Master/texmf-dist/doc/man/man1/allcm.1 new file mode 100644 index 00000000000..fe75f4ef6d3 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/allcm.1 @@ -0,0 +1,28 @@ +.TH allcm 1 "11/94" "teTeX" "teTeX" +.SH NAME +allcm \- force the most important Computer\-Modern\-fonts to be calculated +.SH SYNOPSIS +.B allcm [-r] +.SH DESCRIPTION +.I allcm +forces a large number of Computer Modern Fonts to be calculated as pixel files. +This is done through running +.IR dvips (1) +over a certain test-file. Therefore, the fonts are created in the resolution +needed by dvips. + +If the \-r flag is specified, the command +.IR dvired (1) +will be used instead of dvips. + +.I allcm +does not recalculate existing fonts (as long as the Metafont mode does not change). + +.SH "SEE ALSO" +allec(1), +allneeded(1), +dvips(1), +dvired(1). + +.SH AUTHOR +Thomas Esser <te@dbs.uni-hannover.de> diff --git a/Master/texmf-dist/doc/man/man1/allcm.man1.pdf b/Master/texmf-dist/doc/man/man1/allcm.man1.pdf Binary files differnew file mode 100644 index 00000000000..650e2431abd --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/allcm.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/allec.1 b/Master/texmf-dist/doc/man/man1/allec.1 new file mode 100644 index 00000000000..56bf87a60c5 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/allec.1 @@ -0,0 +1,28 @@ +.TH alldc 1 "11/94" "teTeX" "teTeX" +.SH NAME +allec \- force the most important ec\-fonts to be calculated +.SH SYNOPSIS +.B allec [\-r] +.SH DESCRIPTION +.I allec +forces a large number of ec-style Fonts to be calculated as pixel files. +This is done through running +.IR dvips (1) +over a certain test-file. Therefore, the fonts are created in the resolution +needed by dvips. + +If the \-r flag is specified, the command +.IR dvired (1) +will be used instead of dvips. + +.I alldc +does not recalculate existing fonts (as long as the Metafont mode does not change). + +.SH "SEE ALSO" +allcm(1), +allneeded(1), +dvips(1), +dvired(1). + +.SH AUTHOR +Thomas Esser <te@dbs.uni-hannover.de> diff --git a/Master/texmf-dist/doc/man/man1/allec.man1.pdf b/Master/texmf-dist/doc/man/man1/allec.man1.pdf Binary files differnew file mode 100644 index 00000000000..5aac00771e0 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/allec.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/allneeded.1 b/Master/texmf-dist/doc/man/man1/allneeded.1 new file mode 100644 index 00000000000..7d9a67548b7 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/allneeded.1 @@ -0,0 +1,30 @@ +.TH allneeded 1 "11/94" "teTeX" "teTeX" +.SH NAME +allneeded \- force the calculation of all fonts now needed +.SH SYNOPSIS +.B allneeded [\-r] files ... +.SH DESCRIPTION +.I allneeded +forces the calculation of all fonts that are needed to preview a set of +dvi files. Just specify where the program should search for files on the +commandline. +The fonts generation is triggered by running +.IR dvips (1) +over all accessible dvi\-files. Therefore, the fonts are created in the resolution +needed by dvips. + +If the \-r flag is specified, the command +.IR dvired (1) +will be used instead of dvips. + +.I allneeded +does not recalculate existing fonts (as long as the Metafont mode does not change). + +.SH "SEE ALSO" +allec(1), +allcm(1), +dvips(1), +dvired(1). + +.SH AUTHOR +Thomas Esser <te@dbs.uni-hannover.de> diff --git a/Master/texmf-dist/doc/man/man1/allneeded.man1.pdf b/Master/texmf-dist/doc/man/man1/allneeded.man1.pdf Binary files differnew file mode 100644 index 00000000000..f428f811da0 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/allneeded.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/amstex.1 b/Master/texmf-dist/doc/man/man1/amstex.1 new file mode 100644 index 00000000000..af05e2639ee --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/amstex.1 @@ -0,0 +1,63 @@ +.TH AMSTEX 1 "14 May 2010" "Web2C 2012" +.\"===================================================================== +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.if t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP\" for troff +.if n .ds OX TeX\" for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.if t .ds AX \fRA\\h'-0.1667m'\\v'0.20v'M\\v'-0.20v'\\h'-0.125m'S\fP\*(TX +.if n .ds AX AmSTeX +.if t .ds AY \fRA\\h'-0.1667m'\\v'0.20v'M\\v'-0.20v'\\h'-0.125m'S\fP\*(LX +.if n .ds AY AmSLaTeX +.\"===================================================================== +.SH NAME +amstex \- structured text formatting and typesetting +.SH SYNOPSIS +.B amstex +.RI [ first-line ] +.\"===================================================================== +.SH DESCRIPTION +This manual page is not meant to be exhaustive. The complete +documentation for this version of \*(TX can be found in the info file +or manual +.IR "Web2C: A TeX implementation" . +.PP +The \*(AX language is described in the book +.IR "The Joy of \*(OX" . +\*(AX is a \*(TX macro package, not a modification to the \*(TX source +program, so all the capabilities described in +.BR tex (1) +are present. +.PP +The \*(AX macros encourage writers to think about the content of their +documents, rather than the form. The ideal, not always realized, is to +have no formatting commands (like \(lqswitch to italic\(rq or \(lqskip 2 +picas\(rq) in the document at all; instead, everything is done +by specific markup instructions: \(lqemphasize\(rq, \(lqstart a section\(rq. +.PP +For authors more familiar with \*(LX, an AMS-supported package called +.I amsmath.sty +is available, among others. +.\"===================================================================== +.SH FILES +.TP +.I amsguide.tex +Documentation for \*(AX, typesettable by \*(TX. +.TP +.I amfndoc.tex +Documentation for AMS fonts, typesettable by \*(TX. +.\"===================================================================== +.SH "SEE ALSO" +.BR latex (1), +.BR tex (1), +.BR slitex (1). +.br +Michael Spivak, +.IR "The Joy of \*(OX" , +2nd edition, American Mathematical Society, 1990, ISBN 0-8218-2997-1. diff --git a/Master/texmf-dist/doc/man/man1/amstex.man1.pdf b/Master/texmf-dist/doc/man/man1/amstex.man1.pdf Binary files differnew file mode 100644 index 00000000000..8755fd9f42a --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/amstex.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/arlatex.1 b/Master/texmf-dist/doc/man/man1/arlatex.1 new file mode 100644 index 00000000000..2db9327c252 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/arlatex.1 @@ -0,0 +1,279 @@ +.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "ARLATEX 1" +.TH ARLATEX 1 "2011-05-01" "v1.02" "User Commands" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +arlatex \- archive a number of ancillary LaTeX files into a master +\&\fI.tex\fR file +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +arlatex +[\fB\-\-outfile\fR=\fIfilename\fR\fI.tex\fR] +\&\fB\-\-document\fR=\fIfilename\fR\fI.tex\fR +\&\fIfilename\fR +\&... +.PP +arlatex +\&\fB\-\-version\fR +.PP +arlatex +\&\fB\-\-help\fR +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +\&\fBarlatex\fR is an archiving program like \fBshar\fR, \fBtar\fR, \fBzip\fR, etc. +Unlike those other archivers, however, \fBarlatex\fR is designed +specifically for use with LaTeX. \fBarlatex\fR takes the name of a +master \fI.tex\fR file and a number of ancillary files used by that +master file (e.g., \fI.tex\fR, \fI.sty\fR, \fI.cls\fR, and \fI.eps\fR files). +From these, \fBarlatex\fR outputs a single file that, when it's run +through \fBlatex\fR, both regenerates the ancillary files and compiles +the document into a \fI.dvi\fR file. +.PP +\&\fBarlatex\fR has a few advantages over other archiving programs: +.IP "\(bu" 4 +The \fI.tex\fR files produced by \fBarlatex\fR are in a plain-text format. +They are therefore perfectly portable and trivial to e\-mail to +colleagues. +.IP "\(bu" 4 +\&\fBarlatex\fR needs only LaTeX to run. There is no dependence on any +external tools. +.IP "\(bu" 4 +There is no explicit extraction step. As the generated document is +run through \fBlatex\fR, it extracts the ancillary files and builds the +document in the same step. The user running \fBlatex\fR may not even +notice that additional files are being produced. +.PP +\&\fBarlatex\fR works by writing a number of \f(CW\*(C`\ebegin{filecontents*}\*(C'\fR\ ... +\&\f(CW\*(C`\eend{filecontents*}\*(C'\fR blocks to the output file, followed by the +contents of the master file. (In fact, any LaTeX comments at the +beginning of the master file are hoisted to the top of the generated +file. This enables the author to draw attention, if so desired, to +the fact that ancillary files will be generated.) The +\&\f(CW\*(C`filecontents*\*(C'\fR environment, part of standard LaTeX2e, writes its +contents verbatim to a specified file. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-\-version\fR" 4 +.IX Item "--version" +Output the \fBarlatex\fR script's version number. +.IP "\fB\-\-help\fR" 4 +.IX Item "--help" +Output brief \fBarlatex\fR usage information. +.IP "\fB\-\-document\fR=\fI.tex file\fR" 4 +.IX Item "--document=.tex file" +Specify the master document. The output from \fBarlatex\fR is this file +with all of the other files named on the command line prepended to it. +Note that \f(CW\*(C`\-\-document\*(C'\fR is a \fImandatory\fR parameter; \fBarlatex\fR will +abort with an error message if \f(CW\*(C`\-\-document\*(C'\fR is not specified. +.IP "\fB\-\-outfile\fR=\fI.tex file\fR" 4 +.IX Item "--outfile=.tex file" +Specify the output file. The output file looks just like the master +document, but with a number of \f(CW\*(C`filecontents*\*(C'\fR environments preceding +the \f(CW\*(C`\edocumentclass\*(C'\fR line. If \f(CW\*(C`\-\-outfile\*(C'\fR is not specified, output +will be written to the standard output device. +.SH "EXAMPLES" +.IX Header "EXAMPLES" +Suppose you have a paper called \fIpaper.tex\fR that loads a custom +package with \f(CW\*(C`\eusepackage{mypackage}\*(C'\fR. You want to submit the paper +to a conference, but you want to be absolutely certain that +\&\fImypackage.sty\fR doesn't get lost as your paper is shuttled from +person to person. Here's how \fBarlatex\fR can be of use: +.PP +.Vb 1 +\& arlatex \-\-document=paper.tex mypackage.sty \-\-outfile=paper\-submit.tex +.Ve +.PP +When \fIpaper\-submit.tex\fR is processed with \fBlatex\fR, it builds just +like the original \fIpaper.tex\fR, except that it additionally creates a +\&\fImypackage.sty\fR in the current directory: +.PP +.Vb 5 +\& This is TeX, Version 3.14159 (Web2C 7.3.1) +\& (paper\-submit.tex +\& LaTeX2e <1999/12/01> patch level 1 +\& Babel <v3.6Z> and hyphenation patterns for american, french, german, +\& ngerman, italian, nohyphenation, loaded. +\& +\& LaTeX Warning: Writing file \`./mypackage.sty\*(Aq. +\& +\& (/usr/share/texmf/tex/latex/base/article.cls +\& Document Class: article 1999/09/10 v1.4a Standard LaTeX document class +\& (/usr/share/texmf/tex/latex/base/size12.clo)) (mypackage.sty) +\& . +\& . +\& . +.Ve +.PP +As another example, here's how you could bundle together all of the +files needed to build a large document for longevity: +.PP +.Vb 4 +\& arlatex \-\-document=thesis.tex abstract.tex introduction.tex +\& background.tex approach.tex experiments.tex relatedwork.tex +\& conclusions.tex before.eps after.eps fast.eps slow.eps +\& podunkUthesis.cls \-\-outfile=thesis\-all.tex +.Ve +.PP +As the number of files to archive together increases it becomes more +cumbersome to run \fBarlatex\fR manually. Fortunately, using \fBarlatex\fR +with \fBbundledoc\fR is straightforward. \fBbundledoc\fR finds all of the +files needed to build the document, and \fBarlatex\fR combines them into +a single file. The following are examples of the \f(CW\*(C`bundle:\*(C'\fR line you +might use in a \fBbundledoc\fR configuration file: +.IP "Unix:" 1 +.IX Item "Unix:" +.Vb 2 +\& bundle: (arlatex \-\-document=$BDBASE.tex $BDINPUTS \e +\& \-\-outfile=$BDBASE\-all.tex) +.Ve +.IP "Windows:" 1 +.IX Item "Windows:" +.Vb 2 +\& bundle: arlatex \-\-document=%BDBASE%.tex %BDINPUTS% \e +\& \-\-outfile=%BDBASE%\-all.tex +.Ve +.PP +See the \fBbundledoc\fR documentation for more information. +.SH "CAVEATS" +.IX Header "CAVEATS" +\&\fBarlatex\fR makes use of LaTeX2e's \f(CW\*(C`filecontents*\*(C'\fR environment. +\&\f(CW\*(C`filecontents*\*(C'\fR refuses to overwrite an existing file. However, it +also refuses to create a file that exists \fIanywhere\fR that LaTeX can +find it. That is, if the user running \fBlatex\fR on an +\&\fBarlatex\fR\-generated \fI.tex\fR file already has a +\&\fI/usr/share/texmf/tex/latex/whatever/whatever.sty\fR file then +\&\f(CW\*(C`filecontents*\*(C'\fR will refuse to create a \fIwhatever.sty\fR file, even in +a different directory. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fIbundledoc\fR\|(1), \fIlatex\fR\|(1), \fIshar\fR\|(1), \fItar\fR\|(1), \fIzip\fR\|(1) +.SH "AUTHOR" +.IX Header "AUTHOR" +Scott Pakin, \fIscott+bdoc@pakin.org\fR diff --git a/Master/texmf-dist/doc/man/man1/arlatex.man1.pdf b/Master/texmf-dist/doc/man/man1/arlatex.man1.pdf Binary files differnew file mode 100644 index 00000000000..38a80c458bd --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/arlatex.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/asy.1 b/Master/texmf-dist/doc/man/man1/asy.1 new file mode 100644 index 00000000000..7f3d2a40772 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/asy.1 @@ -0,0 +1,294 @@ +.\" Hey, EMACS: -*- nroff -*- +.TH ASY 1 "1 Dec 2004" +.SH NAME +asy \- Asymptote: a script-based vector graphics language +.SH SYNOPSIS +.B asy +.RI [ options ] +.RI [ file \ ...] +.SH DESCRIPTION +\fBAsymptote\fP is a powerful descriptive vector graphics language for +technical drawings, inspired by MetaPost but with an improved C++-like syntax. +Asymptote provides for figures the same high-quality level of typesetting that +LaTeX does for scientific text. +.SH OPTIONS +If no arguments are given, Asymptote runs in interactive mode. +.PP +If "\-" is given as the file argument, Asymptote reads from standard input. +.PP +A summary of options is included below. The effect of most options +can be negated by prepending +.B no +to the option name. +Default values for most options may also be entered in the +file +.B .asy/config.asy +in the user's home directory using the long form: +.PP + import settings; + batchView=true; +.PP +For a complete +description, see the Info files. +.TP +.B \-V,\-View +View output; command-line only. +.TP +.B \-a,\-align C|B|T|Z +Center, Bottom, Top, or Zero page alignment [C]. +.TP +.B \-antialias n +Antialiasing width for rasterized output [2]. +.TP +.B \-arcballradius pixels +Arcball radius [750]. +.TP +.B \-auto3D +Automatically activate 3D scene [true]. +.TP +.B \-autobillboard +3D labels always face viewer by default [true]. +.TP +.B \-autoimport string +Module to automatically import. +.TP +.B \-autoplain +Enable automatic importing of plain [true]. +.TP +.B \-autoplay +Autoplay 3D animations [false]. +.TP +.B \-autorotate +Enable automatic PDF page rotation [false]. +.TP +.B \-batchMask +Mask fpu exceptions in batch mode [false]. +.TP +.B \-batchView +View output in batch mode [false]. +.TP +.B \-bw +Convert all colors to black and white [false]. +.TP +.B \-cd directory +Set current directory; command-line only. +.TP +.B \-cmyk +Convert rgb colors to cmyk [false]. +.TP +.B \-c,\-command string +Command to autoexecute. +.TP +.B \-compact +Conserve memory at the expense of speed [false]. +.TP +.B \-d,\-debug +Enable debugging messages [false]. +.TP +.B \-divisor n +Garbage collect using purge(divisor=n) [2]. +.TP +.B \-doubleclick ms +Emulated double-click timeout [200]. +.TP +.B \-embed +Embed rendered preview image [true]. +.TP +.B \-exitonEOF +Exit interactive mode on EOF [true]. +.TP +.B \-fitscreen +Fit rendered image to screen [true]. +.TP +.B \-framedelay ms +Additional frame delay [0]. +.TP +.B \-framerate frames/s +Animation speed [30]. +.TP +.B \-globalwrite +Allow write to other directory [false]. +.TP +.B \-gray +Convert all colors to grayscale [false]. +.TP +.B \-h,\-help +Show summary of options; command-line only. +.TP +.B \-historylines n +Retain n lines of history [1000]. +.TP +.B \-iconify +Iconify rendering window [false]. +.TP +.B \-inlineimage +Generate inline embedded image [false]. +.TP +.B \-inlinetex +Generate inline TeX code [false]. +.TP +.B \-interactiveMask +Mask fpu exceptions in interactive mode [true]. +.TP +.B \-interactiveView +View output in interactive mode [true]. +.TP +.B \-interactiveWrite +Write expressions entered at the prompt to stdout [true]. +.TP +.B \-k,\-keep +Keep intermediate files [false]. +.TP +.B \-keepaux +Keep intermediate LaTeX .aux files [false]. +.TP +.B \-level n +Postscript level [3]. +.TP +.B \-l,\-listvariables +List available global functions and variables [false]. +.TP +.B \-localhistory +Use a local interactive history file [false]. +.TP +.B \-loop +Loop 3D animations [false]. +.TP +.B \-m,\-mask +Mask fpu exceptions; command-line only. +.TP +.B \-maxtile pair +Maximum rendering tile size [(1024,768)]. +.TP +.B \-maxviewport pair +Maximum viewport size [(2048,2048)]. +.TP +.B \-multiline +Input code over multiple lines at the prompt [false]. +.TP +.B \-multipleView +View output from multiple batch-mode files [false]. +.TP +.B \-multisample n +Multisampling width for screen images [4]. +.TP +.B \-offscreen +Use offscreen rendering [false]. +.TP +.B \-O,\-offset pair +PostScript offset [(0,0)]. +.TP +.B \-f,\-outformat format +Convert each output file to specified format. +.TP +.B \-o,\-outname name +Alternative output directory/filename. +.TP +.B \-p,\-parseonly +Parse file [false]. +.TP +.B \-pdfreload +Automatically reload document in pdfviewer [false]. +.TP +.B \-pdfreloaddelay usec +Delay before attempting initial pdf reload [750000]. +.TP +.B \-position pair +Initial 3D rendering screen position [(0,0)]. +.TP +.B \-prc +Embed 3D PRC graphics in PDF output [true]. +.TP +.B \-prompt string +Prompt [> ]. +.TP +.B \-prompt2 string +Continuation prompt for multiline input [..]. +.TP +.B \-q,\-quiet +Suppress welcome message [false]. +.TP +.B \-render n +Render 3D graphics using n pixels per bp (-1=auto) [-1]. +.TP +.B \-resizestep step +Resize step [1.2]. +.TP +.B \-reverse +reverse 3D animations [false]. +.TP +.B \-rgb +Convert cmyk colors to rgb [false]. +.TP +.B \-safe +Disable system call [true]. +.TP +.B \-scroll n +Scroll standard output n lines at a time [0]. +.TP +.B \-spinstep deg/s +Spin speed [60]. +.TP +.B \-svgemulation +Emulate unimplemented SVG shading [false]. +.TP +.B \-tabcompletion +Interactive prompt auto-completion [true]. +.TP +.B \-tex engine +latex|pdflatex|xelatex|tex|pdftex|context|none [latex]. +.TP +.B \-thick +Render thick 3D lines [true]. +.TP +.B \-thin +Render thin 3D lines [true]. +.TP +.B \-threads +Use POSIX threads for 3D rendering [true]. +.TP +.B \-toolbar +Show 3D toolbar in PDF output [true]. +.TP +.B \-s,\-translate +Show translated virtual machine code [false]. +.TP +.B \-twice +Run LaTeX twice (to resolve references) [false]. +.TP +.B \-twosided +Use two-sided 3D lighting model for rendering [true]. +.TP +.B \-u,\-user string +General purpose user string. +.TP +.B \-v,\-verbose +Increase verbosity level (can specify multiple times) [0]. +.TP +.B \-version +Show version; command-line only. +.TP +.B \-wait +Wait for child processes to finish before exiting [false]. +.TP +.B \-warn string +Enable warning; command-line only. +.TP +.B \-where +Show where listed variables are declared [false]. +.TP +.B \-zoomfactor factor +Zoom step factor [1.05]. +.TP +.B \-zoomstep step +Mouse motion zoom step [0.1]. + +.SH SEE ALSO +Asymptote is documented fully in the asymptote Info page. +The manual can also be accessed in interactive mode with the "help" command. + +.SH AUTHOR +Asymptote was written by Andy Hammerlindl, John Bowman, and Tom Prince. +.PP +This manual page was written by Hubert Chan for the Debian project (but may +be used by others). diff --git a/Master/texmf-dist/doc/man/man1/asy.man1.pdf b/Master/texmf-dist/doc/man/man1/asy.man1.pdf Binary files differnew file mode 100644 index 00000000000..4cd462f1d30 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/asy.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/autoinst.1 b/Master/texmf-dist/doc/man/man1/autoinst.1 new file mode 100644 index 00000000000..ffb1ffaca14 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/autoinst.1 @@ -0,0 +1,669 @@ +.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "AUTOINST 1" +.TH AUTOINST 1 "2013-02-06" "fontools" "Marc Penninga" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +autoinst \- wrapper around the LCDF TypeTools, +for installing OpenType fonts in LaTeX. +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBautoinst\fR [\fIoptions\fR] \fBfont(s)\fR +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +Eddie Kohler's \fITypeTools\fR, especially \fIotftotfm\fR, are superb tools +for installing OpenType fonts in LaTeX, but their use +(even in automatic mode) is complicated: they need many long +command lines and don't generate the \fIfd\fR and \fIsty\fR files LaTeX needs. +\&\fBautoinst\fR simplifies the font installation process with \fIotftotfm\fR +by generating and executing all command lines +and by creating and installing all \fIfd\fR and \fIsty\fR files. +.PP +Given a family of font files (in either \fIotf\fR or \fIttf\fR format), +\&\fBautoinst\fR will create several LaTeX font families: +.RS 2 +.IP "\-" 3 +Four text families (with lining and oldstyle digits, in both tabular +and proportional variants), each with the following shapes: +.RS 3 +.RS 2 +.IP "\fIn\fR" 6 +.IX Item "n" +Roman text +.IP "\fIsc\fR" 6 +.IX Item "sc" +Small caps +.IP "\fInw\fR" 6 +.IX Item "nw" +\&\*(L"Upright swash\*(R"; usually normal text with some extra \*(L"oldstyle\*(R" ligatures, +such as ct, sp and st. +.IP "\fItl\fR" 6 +.IX Item "tl" +Titling shape. Meant for all-caps text only (even though it sometimes contains +lowercase glyphs as well), where letterspacing and the positioning of +punctuation characters have been adjusted to suit all-caps text. +This shape is generated only for the families with lining digits, +since old-style digits make no sense with all-caps text. +.IP "\fIit\fR" 6 +.IX Item "it" +Italic (or oblique) text +.IP "\fIscit\fR" 6 +.IX Item "scit" +Italic small caps +.IP "\fIsw\fR" 6 +.IX Item "sw" +Swash +.IP "\fItlit\fR" 6 +.IX Item "tlit" +Italic titling +.RE +.RS 2 +.RE +.RE +.RS 3 +.RE +.IP "\-" 3 +For each text family: a family of TS1\-encoded symbol fonts, +in roman and italic shapes. +.IP "\-" 3 +Four families with superiors, inferiors, numerators and denominators, +in roman and italic shapes. +.IP "\-" 3 +An ornament family, in roman and italic shapes. +.RE +.RS 2 +.RE +.PP +Of course, if the fonts don't contain oldstyle digits, small caps etc., +the corresponding shapes and families are not created. +Furthermore, the creation of most families and shapes can be controlled by +command-line options (see \*(L"COMMAND-LINE \s-1OPTIONS\s0\*(R" below). +.PP +The generated font families are named \fI<FontFamily>\-<Suffix>\fR, +where \fI<Suffix>\fR is one of +.IP "\fI\s-1LF\s0\fR" 8 +.IX Item "LF" +proportional (i.e., figures have varying widths) lining figures +.IP "\fI\s-1TLF\s0\fR" 8 +.IX Item "TLF" +tabular (i.e., all figures have the same width) lining figures +.IP "\fIOsF\fR" 8 +.IX Item "OsF" +proportional oldstyle figures +.IP "\fITOsF\fR" 8 +.IX Item "TOsF" +tabular oldstyle figures +.IP "\fISup\fR" 8 +.IX Item "Sup" +superior characters (many fonts have only an incomplete set of superior +characters: digits, some punctuation and the letters \fIabdeilmnorst\fR; +normal forms will then be used for the other characters) +.IP "\fIInf\fR" 8 +.IX Item "Inf" +inferior characters; usually only digits and punctuation, +normal forms for the other characters +.IP "\fIOrn\fR" 8 +.IX Item "Orn" +ornaments +.IP "\fINumr\fR" 8 +.IX Item "Numr" +numerators +.IP "\fIDnom\fR" 8 +.IX Item "Dnom" +denominators +.PP +The generated fonts are named \fI<FontName>\-<suffix>\-<shape>\-<enc>\fR, +where \fI<suffix>\fR is the same as above (but in lowercase), +\&\fI<shape>\fR is either empty, \*(L"sc\*(R", \*(L"swash\*(R" or \*(L"titling\*(R", +and \fI<enc>\fR is the encoding. +A typical name in this scheme would be \*(L"MinionPro\-Regular\-osf\-sc\-ly1\*(R". +.SS "On the choice of text encoding" +.IX Subsection "On the choice of text encoding" +By default, \fBautoinst\fR generates text fonts with \s-1OT1\s0, T1 and \s-1LY1\s0 +encodings, and the generated style files use \s-1LY1\s0 as the default text encoding. +\&\s-1LY1\s0 has been chosen over T1 because it has some empty slots to accomodate +the additional ligatures and alternate glyphs provided by many OpenType fonts. +Different encodings can be selected using the \fI\-encoding\fR +command-line option (see \*(L"COMMAND-LINE \s-1OPTIONS\s0\*(R" below). +.SS "Using the fonts in your LaTeX documents" +.IX Subsection "Using the fonts in your LaTeX documents" +\&\fBautoinst\fR generates a style file for using the font in LaTeX documents, +named \fI<FontFamily>.sty\fR. This style file also takes care of loading the +\&\fIfontenc\fR and \fItextcomp\fR packages, if necessary. +To use the font, simply put \f(CW\*(C`\eusepackage{\f(CI<FontFamily>\f(CW}\*(C'\fR +in the preamble of your document. +.PP +This style file defines a number of options: +.IP "\fIlining, oldstyle, tabular, proportional\fR" 4 +.IX Item "lining, oldstyle, tabular, proportional" +Choose which digits will be used for the text fonts. +The defaults are \*(L"oldstyle\*(R" and \*(L"proportional\*(R" (if available). +.IP "\fIultrablack, ultrabold, heavy, extrablack, black, extrabold, demibold, semibold, bold\fR" 4 +.IX Item "ultrablack, ultrabold, heavy, extrablack, black, extrabold, demibold, semibold, bold" +Choose the weight that LaTeX will use for the \*(L"bold\*(R" weight +(i.e., the value of \f(CW\*(C`\ebfdefault\*(C'\fR). +.IP "\fIlight, medium, regular\fR" 4 +.IX Item "light, medium, regular" +Choose the weight that LaTeX will use for the \*(L"regular\*(R" weight +(i.e., the value of \f(CW\*(C`\emddefault\*(C'\fR). +.IP "\fIscaled=<scale>\fR" 4 +.IX Item "scaled=<scale>" +Scale the font by a factor of \fI<scale>\fR. +For example: to increase the size of the font by 5%, use the command +\&\f(CW\*(C`\eusepackage[scaled=1.05]{\f(CI<FontFamily>\f(CW}\*(C'\fR. +.Sp +This option is only available when the \fIxkeyval\fR package is found +in your TeX installation. +.PP +The style file will also try to load the \fIfontaxes\fR package, +which gives easy access to various font shapes and styles. +It is available from \s-1CTAN\s0 +(\fIhttp://www.ctan.org/tex\-archive/macros/latex/contrib/fontaxes\fR). +Using the machinery set up by \fIfontaxes\fR, the generated style file also +defines a number of commands (which take the text to be typeset as argument) +and declarations (which don't take arguments, but affect all text up to +the end of the current group) of its own: +.PP +.Vb 1 +\& DECLARATION COMMAND SHORT FORM OF COMMAND +\& +\& \etlshape \etexttitling \etexttl +\& \esufigures \etextsuperior \etextsu +\& \einfigures \etextinferior \etextin +.Ve +.PP +In addition, the \f(CW\*(C`\eswshape\*(C'\fR and \f(CW\*(C`\etextsw\*(C'\fR commands are redefined to place +swash on the secondary shape axis (\fIfontaxes\fR places it on the primary +shape axis); this makes these commands behave properly when nested, so that +\&\f(CW\*(C`\eswshape\eupshape\*(C'\fR will give upright swash. +.PP +There are no commands for accessing the numerator and denominator +fonts; these can be selected using \fIfontaxes\fR' standard commands, +e.g., \f(CW\*(C`\efontfigurestyle{numerator}\eselectfont\*(C'\fR. +.PP +The style file also provides a command \f(CW\*(C`\eornament{\f(CI<number>\f(CW}\*(C'\fR, +where \f(CW\*(C`\f(CI<number>\f(CW\*(C'\fR is a number from 0 to the total number of +ornaments minus one. Ornaments are always typeset using the current family, +series and shape. A list of all ornaments in a font can be created by +running LaTeX on the file \fInfssfont.tex\fR (part of a standard +LaTeX installation) and supplying the name of the ornament font. +.PP +To access the ornaments, \fBautoinst\fR creates a font-specific encoding file +\&\fI<FontFamily>_orn.enc\fR, +but only if that file doesn't yet exist in the current directory. +This is a deliberate feature that allows you to provide your own +encoding vector, e.g. if your fonts use non-standard glyph names for ornaments. +.PP +These commands are only generated for shapes and number styles +that actually exist; no commands are generated for shapes and styles +that don't exist, or whose generation has been turned off +using command-line options (see below). +Please also note that these commands are built on top of \fIfontaxes\fR; +if that package cannot be found, you're limited to using the +lower-level commands from standard \s-1NFSS\s0 (\f(CW\*(C`\efontfamily\*(C'\fR, \f(CW\*(C`\efontseries\*(C'\fR, +\&\f(CW\*(C`\efontshape\*(C'\fR etc.). +.SS "Using multiple font families in one document" +.IX Subsection "Using multiple font families in one document" +If you want to use more than one font family in a document, be aware +that style files generated by versions of \fBautoinst\fR older dan 2009 +are incompatible with those generated by newer versions. +.SS "\s-1NFSS\s0 codes" +.IX Subsection "NFSS codes" +\&\s-1NFSS\s0 identifies fonts by a combination of family, series (weight plus width), +shape and size. +\&\fBautoinst\fR parses the output of \f(CW\*(C`otfinfo \-\-info\*(C'\fR to determine +these parameters. When this fails +(e.g., because the font family contains uncommon widths or weights), +\&\fBautoinst\fR would end up with different fonts having the \fIsame\fR values +for these font parameters, which means that these fonts cannot be used in \s-1NFSS\s0. +In this case, \fBautoinst\fR will split the font family into multiple subfamilies +(based on each font file's \*(L"Subfamily\*(R" value) and try again. +(Since many font vendors misunderstand the \*(L"Subfamily\*(R" concept +and make each font file its own separate subfamily, +this strategy is only used as a last resort.) +.PP +If such a proliferation of font families is unwanted, +either run \fBautoinst\fR on a smaller set of fonts (omitting the ones that +failed to parse correctly) +or else add the missing widths, weights and shapes to the tables \f(CW%FD_WIDTH\fR, +\&\f(CW%FD_WEIGHT\fR and \f(CW%FD_SHAPE\fR, near the top of the source code. +Please also send a bug report (see \s-1AUTHOR\s0 below). +.PP +\&\fBautoinst\fR maps widths, weights and shapes to \s-1NFSS\s0 codes using +the following tables. These are based both on the standard \fIFontname\fR scheme +and on the tables in Philipp Lehman's \fIFont Installation Guide\fR, +but some changes had to be made to avoid name clashes in font families +with many different widths and weights. +.PP +.Vb 1 +\& WEIGHT WIDTH +\& +\& Thin t Ultra Compressed up +\& Ultra Light ul Extra Compressed ep +\& Extra Light el Compressed, Compact p +\& Light l Compact p +\& Book [1] Ultra Condensed uc +\& Regular [1] Extra Condensed ec +\& Medium mb Condensed c +\& Demibold db Narrow n +\& Semibold sb Semicondensed sc +\& Bold b Regular [1] +\& Extra Bold eb Semiextended sx +\& Ultra ub Extended x +\& Ultra Bold ub Expanded e +\& Black k Wide w +\& Extra Black ek +\& Ultra Black uk +\& Heavy h SHAPE +\& Poster r +\& Roman, Upright n [2] +\& Italic it +\& Cursive, Kursiv it +\& Oblique, Slanted it [3] +\& Incline(d) it [3] +.Ve +.PP +\fINotes:\fR +.IX Subsection "Notes:" +.IP "[1]" 4 +.IX Item "[1]" +When \fIboth\fR weight and width are empty, the \*(L"series\*(R" attribute becomes \*(L"m\*(R". +.IP "[2]" 4 +.IX Item "[2]" +Adobe Silentium Pro contains two \*(L"Roman\*(R" shapes (\*(L"RomanI\*(R" and \*(L"RomanII\*(R"); +the first of these is mapped to \*(L"n\*(R", the second one to \*(L"it\*(R". +.IP "[3]" 4 +.IX Item "[3]" +Mapping the \*(L"Slanted\*(R", \*(L"Oblique\*(R" or \*(L"Inclined\*(R" shape to \*(L"it\*(R" instead of \*(L"sl\*(R" +simplifies \fBautoinst\fR. Since font families with both italic and slanted +shapes do \- to the best of my knowledge \- not exist +(apart from Computer Modern, of course), +this shouldn't cause problems in real life. +.SS "A note for MiKTeX users" +.IX Subsection "A note for MiKTeX users" +Automatically installing the fonts into a suitable \s-1TEXMF\s0 tree +(as \fBautoinst\fR does by default) requires a TeX-installation that uses +the \fIkpathsea\fR library; with TeX distributions that implement their +own directory searching (such as MiKTeX), \fBautoinst\fR will complain that +it cannot find the \fIkpsewhich\fR program and install all generated files +into subdirectories of the current directory. +If you use such a TeX distribution, you should either move these files +to their correct destinations by hand, or use the \fI\-target\fR option +(see \*(L"COMMAND-LINE \s-1OPTIONS\s0\*(R" below) to specify a \s-1TEXMF\s0 tree. +.PP +Also, some OpenType fonts lead to \fIpl\fR and \fIvpl\fR files that +are too big for MiKTeX's \fIpltotf\fR and \fIvptovf\fR; +the versions that come with W32TeX (\fIhttp://www.w32tex.org\fR) +and TeXLive (\fIhttp://tug.org/texlive\fR) don't have this problem. +.SH "COMMAND-LINE OPTIONS" +.IX Header "COMMAND-LINE OPTIONS" +You may use either one or two dashes before options, +and option names may be shortened to a unique prefix +(e.g., \fB\-encoding\fR may be abbreviated to \fB\-enc\fR or even \fB\-en\fR, +but \fB\-e\fR is ambiguous (\fB\-encoding\fR, \fB\-extra\fR). +.IP "\fB\-encoding\fR=\fIencoding[,encoding]\fR" 4 +.IX Item "-encoding=encoding[,encoding]" +Use the specified encodings for the text fonts. The default is \*(L"\s-1OT1\s0,T1,LY1\*(R". +For each encoding, a file \fI<encoding>.enc\fR (in all \fIlowercase\fR) +should be somewhere where \fIotftotfm\fR can find it. Suitable encoding files +for \s-1OT1\s0, T1/TS1 and \s-1LY1\s0 come with \fBautoinst\fR. (Note that these files are +called \fIfontools_ot1.enc\fR etc. to avoid name clashes with other packages; +the \*(L"fontools_\*(R" prefix doesn't need to be specified.) +.Sp +Multiple text encodings can be specified as a comma-separated list: +\&\f(CW\*(C`\-encoding=OT1,T1\*(C'\fR. The encodings are passed to \fIfontenc\fR in the order +specified, so the last one will be the default text encoding. +.IP "\fB\-sanserif\fR" 4 +.IX Item "-sanserif" +Install the font as a sanserif font, accessed via \f(CW\*(C`\esffamily\*(C'\fR and \f(CW\*(C`\etextsf\*(C'\fR. +Note that the generated style file redefines \f(CW\*(C`\efamilydefault\*(C'\fR, +so including it will still make this font the default text font. +.IP "\fB\-typewriter\fR" 4 +.IX Item "-typewriter" +Install the font as a typewriter font, accessed via \f(CW\*(C`\ettfamily\*(C'\fR and +\&\f(CW\*(C`\etexttt\*(C'\fR. +Note that the generated style file redefines \f(CW\*(C`\efamilydefault\*(C'\fR, +so including it will still make this font the default text font. +.IP "\fB\-ts1\fR" 4 +.IX Item "-ts1" +.PD 0 +.IP "\fB\-nots1\fR" 4 +.IX Item "-nots1" +.PD +Turn the creation of TS1\-encoded fonts on or off. The default is \fB\-ts1\fR +if the text encodings (see \fI\-encoding\fR above) include T1, +\&\fB\-nots1\fR otherwise. +.IP "\fB\-smallcaps\fR" 4 +.IX Item "-smallcaps" +.PD 0 +.IP "\fB\-nosmallcaps\fR" 4 +.IX Item "-nosmallcaps" +.PD +Turn the creation of small caps fonts on or off. The default is +\&\fB\-smallcaps\fR. +.IP "\fB\-swash\fR" 4 +.IX Item "-swash" +.PD 0 +.IP "\fB\-noswash\fR" 4 +.IX Item "-noswash" +.PD +Turn the creation of swash fonts on or off. The default is \fB\-swash\fR. +.IP "\fB\-titling\fR" 4 +.IX Item "-titling" +.PD 0 +.IP "\fB\-notitling\fR" 4 +.IX Item "-notitling" +.PD +Turn the creation of titling fonts on or off. The default is \fB\-titling\fR. +.IP "\fB\-superiors\fR" 4 +.IX Item "-superiors" +.PD 0 +.IP "\fB\-nosuperiors\fR" 4 +.IX Item "-nosuperiors" +.PD +Turn the creation of fonts with superior characters on or off. +The default is \fB\-superiors\fR. +.IP "\fB\-inferiors\fR" 4 +.IX Item "-inferiors" +.PD 0 +.IP "\fB\-noinferiors\fR" 4 +.IX Item "-noinferiors" +.PD +Turn the creation of fonts with inferior digits on or off. +The default is \fB\-noinferiors\fR. +.IP "\fB\-fractions\fR" 4 +.IX Item "-fractions" +.PD 0 +.IP "\fB\-nofractions\fR" 4 +.IX Item "-nofractions" +.PD +Turn the creation of fonts with numerators and denominators on or off. +The default is \fB\-nofractions\fR. +.IP "\fB\-ornaments\fR" 4 +.IX Item "-ornaments" +.PD 0 +.IP "\fB\-noornaments\fR" 4 +.IX Item "-noornaments" +.PD +Turn the creation of ornament fonts on or off. The default is \fB\-ornaments\fR. +.IP "\fB\-verbose\fR" 4 +.IX Item "-verbose" +Verbose mode; print detailed info about what \fBautoinst\fR thinks it's doing. +.IP "\fB\-extra\fR=\fItext\fR" 4 +.IX Item "-extra=text" +Pass \fItext\fR as options to \fIotftotfm\fR. To prevent \fItext\fR from accidentily +being interpreted as options to \fBautoinst\fR, it should be properly quoted. +.IP "\fB\-figurekern\fR" 4 +.IX Item "-figurekern" +.PD 0 +.IP "\fB\-nofigurekern\fR" 4 +.IX Item "-nofigurekern" +.PD +Some fonts provide kerning pairs for tabular figures. +This is very probably not what you want +(e.g., numbers in tables won't line up exactly). +The option \fB\-nofigurekern\fR adds extra \fI \-\-ligkern\fR options +to the command lines for \fIotftotfm\fR to suppress such kerns +(but of course only for the \*(L"\s-1TLF\s0\*(R" and \*(L"TOsF\*(R" families). +Since this leads to very long command lines (it adds one hundred such options) +and the problem only occurs in very few fonts, +the default is \fB\-figurekern\fR. +.IP "\fB\-manual\fR" 4 +.IX Item "-manual" +Manual mode. By default, \fBautoinst\fR executes all \fIotftotfm\fR +command lines it generates; with the \fB\-manual\fR option, these commands are +instead written to a file \fIautoinst.bat\fR. +Also, the generated \fIotftotfm\fR command lines specify the \fI \-\-pl\fR option +(which tells \fIotftotfm\fR to generate readable/editable \fIpl\fR and \fIvpl\fR files +instead of the default \fItfm\fR and \fIvf\fR files) +and leave out the \fI \-\-automatic\fR option (which tells \fIotftotfm\fR to +leave all generated files in the current directory, rather than install +them into your \s-1TEXMF\s0 tree). +.Sp +When using this option, you should run \fIpltotf\fR and \fIvptovf\fR after +executing all commands, +to convert the \fIpl\fR and \fIvf\fR files to \fItfm\fR and \fIvf\fR format. +.PP +The following options are only meaningful in automatic mode, +and hence ignored in manual mode: +.IP "\fB\-target\fR=\fI\s-1DIRECTORY\s0\fR" 4 +.IX Item "-target=DIRECTORY" +Install all generated files into the \s-1TEXMF\s0 tree at \fI\s-1DIRECTORY\s0\fR. +.Sp +By default, \fBautoinst\fR searches your \f(CW$TEXMFLOCAL\fR and \f(CW$TEXMFHOME\fR paths +and installs all files into subdirectories of the first writable \s-1TEXMF\s0 tree +it finds (or into subdirectories of the current directory, +if no writable directory is found). +.IP "\fB\-vendor\fR=\fI\s-1VENDOR\s0\fR" 4 +.IX Item "-vendor=VENDOR" +.PD 0 +.IP "\fB\-typeface\fR=\fI\s-1TYPEFACE\s0\fR" 4 +.IX Item "-typeface=TYPEFACE" +.PD +These options are equivalent to \fIotftotfm\fR's \fI \-\-vendor\fR and \fI \-\-typeface\fR +options: they change the \*(L"vendor\*(R" and \*(L"typeface\*(R" parts of the names of the +subdirectories in the \s-1TEXMF\s0 tree where generated files will be stored. +The default values are \*(L"lcdftools\*(R" and the font's FontFamily name. +.Sp +Please note that these options change \fIonly\fR directory names, +not the names of any generated files. +.IP "\fB\-updmap\fR" 4 +.IX Item "-updmap" +.PD 0 +.IP "\fB\-noupdmap\fR" 4 +.IX Item "-noupdmap" +.PD +Control whether or not \fIupdmap\fR is called after the last call to \fIotftotfm\fR. +The default is \fB\-updmap\fR. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +Eddie Kohler's TypeTools (\fIhttp://www.lcdf.org/type\fR). +.PP +Perl is pre-installed on most Linux and Unix systems; +on Windows, try ActiveState's ActivePerl +(available from \fIhttp://www.activestate.com\fR) +or Strawberry Perl (\fIhttp://strawberryperl.com\fR). +.PP +XeTeX (\fIhttp://www.tug.org/xetex\fR) and LuaTeX (\fIhttp://www.luatex.org\fR) +are TeX extensions that can use many types of font +(including both flavours of OpenType) without TeX-specific support files. +.PP +The FontPro project (\fIhttps://github.com/sebschub/FontPro\fR) +offers very complete support for Adobe's Minion Pro and Myriad Pro +(including math), and is currently working on Cronos Pro as well. +.PP +John Owens' \fIotfinst\fR (available from \s-1CTAN\s0) is another wrapper +around \fIotftotfm\fR, and may work for you when \fBautoinst\fR doesn't. +.SH "AUTHOR" +.IX Header "AUTHOR" +Marc Penninga <marcpenninga@gmail.com> +.PP +When sending a bug report, please give as much relevant information as +possible; this includes at least (but may not be limited to) the output +from running \fBautoinst\fR with the \fI\-verbose\fR option. +Please make sure that this output includes all (if any) error messages. +.SH "COPYRIGHT" +.IX Header "COPYRIGHT" +Copyright (C) 2005\-2013 Marc Penninga. +.SH "LICENSE" +.IX Header "LICENSE" +This program is free software; you can redistribute it and/or modify +it under the terms of the \s-1GNU\s0 General Public License as published +by the Free Software Foundation, either version 2 of the License, +or (at your option) any later version. +A copy of the text of the \s-1GNU\s0 General Public License is included in +the \fIfontools\fR distribution; see the file \fIGPLv2.txt\fR. +.SH "DISCLAIMER" +.IX Header "DISCLAIMER" +This program is distributed in the hope that it will be useful, +but \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of +\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0. See the +\&\s-1GNU\s0 General Public License for more details. +.SH "RECENT CHANGES" +.IX Header "RECENT CHANGES" +(See the source code for the rest of the story.) +.IP "\fI2013\-02\-06\fR" 12 +.IX Item "2013-02-06" +Bugfix: the directory names for map and encoding files contained +the \*(L"vendor\*(R" instead of the \*(L"typeface\*(R". +.IP "\fI2013\-01\-03\fR" 12 +.IX Item "2013-01-03" +Added extra \*(L"ssub\*(R" rules to the \fIfd\fR files that substitute \*(L"b\*(R" for \*(L"bx\*(R". +Verbose mode now also prints all generated commands before they're executed. +.IP "\fI2012\-10\-25\fR" 12 +.IX Item "2012-10-25" +Added extra \*(L"ssub\*(R" rules to the \fIfd\fR files that substitute italic +shapes for slanted ones. +.IP "\fI2012\-09\-25\fR" 12 +.IX Item "2012-09-25" +Added the \fI\-vendor\fR, \fI\-typeface\fR and \fI\-(no)updmap\fR command line options. +.IP "\fI2012\-07\-06\fR" 12 +.IX Item "2012-07-06" +Documentation update. +.IP "\fI2012\-03\-06\fR" 12 +.IX Item "2012-03-06" +Implemented the \*(L"splitting the font family into multiple subfamilies\*(R" +emergency strategy when font info parsing fails. +Added recognition for a number of unusual widths, weights and shapes. +.IP "\fI2012\-02\-29\fR" 12 +.IX Item "2012-02-29" +Fixed a bug in the font parsing code, +where possible widths, weights and shapes where tested in the wrong order; +this led to \*(L"ExtraLight\*(R" fonts being recognised as \*(L"Light\*(R". +Added recognition for \*(L"Narrow\*(R" and \*(L"Wide\*(R" widths. +Also added the \fI\-(no)figurekern\fR command-line option. +.IP "\fI2012\-02\-01\fR" 12 +.IX Item "2012-02-01" +Reorganised the code, and fixed some bugs in the process. +Added the \fI\-target\fR command-line option. +Made \fBautoinst\fR install the \fIfd\fR and \fIsty\fR files in +the same \s-1TEXMF\s0 tree as the other generated files. +Generate \s-1OT1\s0, T1 and \s-1LY1\s0 encoded text fonts by default. +Made \fI\-titling\fR a default option (instead of \fI\-notitling\fR). +Updated the documentation. diff --git a/Master/texmf-dist/doc/man/man1/autoinst.man1.pdf b/Master/texmf-dist/doc/man/man1/autoinst.man1.pdf Binary files differnew file mode 100644 index 00000000000..ae6a665e9b0 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/autoinst.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/bbox.1 b/Master/texmf-dist/doc/man/man1/bbox.1 new file mode 100644 index 00000000000..64696f32645 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/bbox.1 @@ -0,0 +1,71 @@ +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> +.\" Please send any bug reports, improvements, comments, patches, +.\" etc. to Steve Cheng <steve@ggi-project.org>. +.TH "BBOX" "1" "31 August 2010" "" "" + +.SH NAME +bbox \- prints out the bounding box of a rawppm or rawpbm image +.SH SYNOPSIS + +\fBbbox\fR [ \fB-l\fR ] [ \fB-r\fR ] [ \fB-h\fR ] [ \fB-V\fR ] [ \fB\fIrawpbmfile\fB\fR ] + +.SH "DESCRIPTION" +.PP +\fBbbox\fR reads a rawppm or rawpbm file +and prints out the bounding box of the image (as postscript comment and +in postscript points, i.e. 1/72dpi) as well as the high resolution +bounding box. Input is read from standard input if no filename is +specified. +Example output: + +.nf + %%BoundingBox: 12 253 829 837 + %%HiResBoundingBox: 12.500000 253.000000 828.500000 837.00000 + +.fi +.PP +\fBbbox\fR has only very limited memory requirements +as it reads the input line by line and thus needs to store only one picture +line in memory. +.SH "OPTIONS" +.TP +\fB-h | --help \fR +Show summary of options. +.TP +\fB-V \fR +Show version of program. +.TP +\fB-r \fR +resolution of picture in dpi +.TP +\fB-l \fR +loose bounding box (integer bounding box is expanded by 1 +point, hires bounding box is expanded by 0.5 points) +.SH "SEE ALSO" +.PP +ps2eps (1) +.SH "AUTHOR" +.PP +\fBbbox\fR was written by Roland Bless. +.SS "ACKNOWLEDGMENTS" +.PP +Special thanks goes to Michael Sharpe from UCSD who suggested a lot of improvements for +bbox to become more precise and robust, especially for small drawings. +.PP +An earlier version of this manual page was originally written by +Rafael Laboissiere <rafael@debian.org> for +the Debian system. Thank you Rafael! Permission is +granted to copy, distribute and/or modify this document under +the terms of the GNU Free Documentation +License, Version 1.1 or any later version published by the Free +Software Foundation; with no Invariant Sections, no Front-Cover +Texts and no Back-Cover Texts. +.SH "BUGS" +.PP +Though the code is quite small and the probability for bugs +is now small, there may be some left somewhere between the lines. +In case you find one, please send a short description with +\fBbbox\fR version number to <roland@bless.de> (please allow some time +to reply). diff --git a/Master/texmf-dist/doc/man/man1/bbox.man1.pdf b/Master/texmf-dist/doc/man/man1/bbox.man1.pdf Binary files differnew file mode 100644 index 00000000000..113beebfb8d --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/bbox.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/bg5conv.1 b/Master/texmf-dist/doc/man/man1/bg5conv.1 new file mode 100644 index 00000000000..4ee4815cfef --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/bg5conv.1 @@ -0,0 +1,110 @@ +.\" man page for bg5conv +.\" Copyright (C) 1994-2012 Werner Lemberg <wl@gnu.org> +.\" +.\" 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 2 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 in doc/COPYING; if not, write to the Free +.\" Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, +.\" MA 02110-1301 USA +. +.TH BG5CONV 1 07-May-2012 "CJK Version 4.8.3" +. +.\" ==== +.\" ==== macro definitions +.\" ==== +. +.\" here we define \TeX for troff and nroff +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +. +.\" and here the same for \LaTeX +.if t \{\ +.ie '\*(.T'dvi' \ +.ds LX \fRL\h'-0.36m'\v'-0.15v'\s-3A\s0\h'-0.15m'\v'0.15v'\fP\*(TX +.el .ds LX \fRL\h'-0.36m'\v'-0.22v'\s-2A\s0\h'-0.15m'\v'0.22v'\fP\*(TX +.\} +.if n .ds LX LaTeX +. +.\" \LaTeXe +.\" note that we need \vareps for TeX instead of \eps which can only be +.\" accessed with the \N escape sequence (in the Math Italic font) +.if t \{\ +.ie '\*(.T'dvi' .ds LE \*(LX\h'0.15m'2\v'0.20v'\f(MI\N'34'\fP\v'-0.20v' +.el .ds LE \*(LX\h'0.15m'2\v'0.20v'\(*e\v'-0.20v' +.\} +.if n .ds LE LaTeX\ 2e +. +.\" a typewriter font +.if t \{\ +.de C +\fC\\$1\fP\\$2 +.. +.\} +.if n \{\ +.de C +\\$1\\$2 +.. +.\} +. +.\" ==== +.\" ==== end of macro definitions +.\" ==== +. +. +. +.SH NAME +bg5conv \- convert a TeX document in Big\ 5 encoding into `preprocessed' +form. +. +. +.SH SYNOPSIS +.B bg5conv +< +.I infile +> +.I outfile +. +. +.SH DESCRIPTION +Big\ 5 encoding for traditional Chinese uses the characters +.C { , +.C } , +and +.C \e +which have special meanings in \*(TX +documents. +.PP +After processing a \*(LE +document which contains Big\ 5 characters with +.B bg5conv +you need not care about these special characters. +.PP +This filter is part of the +.B CJK +macro package for \*(LE. +. +. +.SH "SEE ALSO" +.BR \%sjisconv (1), +.BR \%cefconv (1), +.BR cef5conv (1), +.BR \%cefsconv (1), +.BR \%extconv (1), +.br +the +.B CJK +documentation files. +. +. +.SH AUTHOR +Werner Lemberg +.C <wl@gnu.org> diff --git a/Master/texmf-dist/doc/man/man1/bg5conv.man1.pdf b/Master/texmf-dist/doc/man/man1/bg5conv.man1.pdf Binary files differnew file mode 100644 index 00000000000..93d54c85c5b --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/bg5conv.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/bibtex.1 b/Master/texmf-dist/doc/man/man1/bibtex.1 new file mode 100644 index 00000000000..671acdbf6d7 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/bibtex.1 @@ -0,0 +1,136 @@ +.TH BIBTEX 1 "1 February 2010" "bibtex 0.99d" "Web2C 2012" +.\"===================================================================== +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff +.el .ds OX TeX for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\\s-2A\\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.\"===================================================================== +.SH NAME +bibtex \- make a bibliography for (La)TeX +.SH SYNOPSIS +.B bibtex +.RB [ \-min-crossrefs=\fInumber\fP ] +.RB [ \-terse ] +.IR auxname [ \fB.aux\fP ] +.\"===================================================================== +.SH DESCRIPTION +This manual page is not meant to be exhaustive. The complete +documentation for this version of \*(TX can be found in the info file +or manual +.IR "Web2C: A TeX implementation" . +.PP +\*(BX reads the top-level auxiliary +.RB ( .aux ) +file +.I auxname +that was output during the running of +.BR latex (1) +or +.BR tex (1) +and creates a bibliography +.RB ( .bbl ) +file that will be incorporated into the document on subsequent runs of +\*(LX or \*(TX. +.PP +\*(BX looks up, in bibliographic database +.RB ( .bib ) +files specified by the \\bibliography command, +the entries specified by the \\cite and \\nocite commands +in the \*(LX or \*(TX source file. +It formats the information from those entries +according to instructions in a bibliography style +.RB ( .bst ) +file (specified by the \\bibliographystyle command, +and it outputs the results to the +.B .bbl +file. +.PP +The \*(LX manual +explains what a \*(LX source file must contain to work with \*(BX. +Appendix B of the manual describes the format of the +.B .bib +files. The `\*(BXing' document describes extensions and details of +this format, and it gives other useful hints for using \*(BX. +.\"===================================================================== +.SH OPTIONS +The +.B \-min-crossrefs +option defines the minimum number of +.B crossref +required for automatic inclusion of the crossref'd entry on the citation +list; the default is two. +With the +.B \-terse +option, \*(BX operates silently. Without it, a banner and progress +reports are printed on +.IR stdout . +.PP +.\"===================================================================== +.SH ENVIRONMENT +\*(BX searches the directories in the +path defined by the BSTINPUTS environment variable for +.B .bst +files. If BSTINPUTS is not set, it uses the system default. +For +.B .bib +files, it uses the BIBINPUTS environment variable if that is set, +otherwise the default. +See +.BR tex (1) +for the details of the searching. +.PP +If the environment variable +TEXMFOUTPUT is set, \*(BX attempts to put its output +files in it, if they cannot be put in the current directory. Again, see +.BR tex (1). +No special searching is done for the +.B .aux +file. +.\"===================================================================== +.SH FILES +.TP +.I *.bst +Bibliography style files. +.TP +.I btxdoc.tex +``\*(BXing'' \- \*(LXable documentation for general \*(BX users +.TP +.I btxhak.tex +``Designing \*(BX Styles'' \- \*(LXable documentation for style designers +.TP +.I btxdoc.bib +database file for those two documents +.TP +.I xampl.bib +database file giving examples of all standard entry types +.TP +.I btxbst.doc +template file and documentation for the standard styles +.PP +All those files should be available somewhere on your system. +.PP +The host math.utah.edu has a vast collection of +.B .bib +files available for anonymous ftp, including references for all the +standard \*(TX books and a complete bibliography for TUGboat. +.\"===================================================================== +.SH "SEE ALSO" +.BR latex (1), +.BR tex (1). +.br +Leslie Lamport, +.IR "\*(LX \- A Document Preparation System" , +Addison-Wesley, 1985, ISBN 0-201-15790-X. +.\"===================================================================== +.SH AUTHOR +Oren Patashnik, Stanford University. This man page describes the web2c +version of \*(BX. Other ports of \*(BX, such as Donald Knuth's version +using the Sun Pascal compiler, do not have the same path searching +implementation, or the command-line options. diff --git a/Master/texmf-dist/doc/man/man1/bibtex.man1.pdf b/Master/texmf-dist/doc/man/man1/bibtex.man1.pdf Binary files differnew file mode 100644 index 00000000000..c0ce9f44a4d --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/bibtex.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/bundledoc.1 b/Master/texmf-dist/doc/man/man1/bundledoc.1 new file mode 100644 index 00000000000..c96c0fc8ec6 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/bundledoc.1 @@ -0,0 +1,516 @@ +.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "BUNDLEDOC 1" +.TH BUNDLEDOC 1 "2011-05-02" "v3.1" "User Commands" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +bundledoc \- bundle all the files needed by a LaTeX document +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +bundledoc +[\fB\-\-version\fR] +[\fB\-\-help\fR] +[\fB\-\-\fR[\fBno\fR]\fBverbose\fR] +[\fB\-\-texfile\fR=\fIfile\fR] +[\fB\-\-directory\fR=\fIdirectory\fR] +[\fB\-\-\fR[\fBno\fR]\fBlocalonly\fR] +[\fB\-\-exclude\fR=\fIstring\fR] +[\fB\-\-include\fR=\fIfilespec\fR] +[\fB\-\-manifest\fR=\fIfile\fR] +[\fB\-\-\fR\fBlistdeps\fR=[yes|no|only|rel]...] +[\fB\-\-\fR[\fBno\fR]\fBkeepdirs\fR] +[\fB\-\-config\fR=\fIfile\fR] +\&\fI.dep file\fR +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +\&\fBbundledoc\fR is a post-processor for the \fBsnapshot\fR package that +bundles together all the classes, packages, and files needed to build +a given LaTeX document. It reads the \fI.dep\fR file that \fBsnapshot\fR +produces, finds each of the files mentioned therein, and packages them +into a single archive file (e.g., a \fI.tar.gz\fR file), suitable for +moving across systems, transmitting to a colleague, etc. +.PP +As the simplest example possible, consider a LaTeX file called, say, +\&\fIhello.tex\fR: +.PP +.Vb 2 +\& \eRequirePackage{snapshot} % Needed by bundledoc +\& \edocumentclass[11pt]{article} +\& +\& \ebegin{document} +\& Hello, world! +\& \eend{document} +.Ve +.PP +The \f(CW\*(C`\eRequirePackage{snapshot}\*(C'\fR causes a \fIhello.dep\fR file to be produced. +When \fBbundledoc\fR is then given \f(CW\*(C`hello.dep\*(C'\fR as an argument, it locates the +dependent files \*(-- \fIsnapshot.sty\fR, \fIarticle.cls\fR, and \fIsize11.clo\fR \*(-- +and bundles them into a single archive file, along with \fIhello.tex\fR and a +\&\fI\s-1MANIFEST\s0\fR file (described in \*(L"\s-1OPTIONS\s0\*(R", below). +.SH "OPTIONS" +.IX Header "OPTIONS" +In the following descriptions, \fIsomefile\fR refers to the name of your +main LaTeX document (no extension). +.PP +\&\fBbundledoc\fR requires the name of the dependency file produced by +\&\fBsnapshot\fR (normally \fIsomefile\fR\fI.dep\fR). The following options may +also be given: +.IP "\fB\-\-version\fR" 4 +.IX Item "--version" +Output the \fBbundledoc\fR script's version number. This overrides all +of the remaining options. +.IP "\fB\-\-help\fR" 4 +.IX Item "--help" +Give a brief usage message. This overrides all of the remaining options. +.ie n .IP "\fB\-\-\fR[\fBno\fR]\fBverbose\fR (default: ""noverbose"")" 4 +.el .IP "\fB\-\-\fR[\fBno\fR]\fBverbose\fR (default: \f(CWnoverbose\fR)" 4 +.IX Item "--[no]verbose (default: noverbose)" +\&\fBbundledoc\fR normally does not output anything except error messages. +With \f(CW\*(C`\-\-verbose\*(C'\fR, it outputs copious status messages. +.IP "\fB\-\-texfile\fR=\fImain .tex file\fR (default: \fIsomefile\fR\fI.tex\fR)" 4 +.IX Item "--texfile=main .tex file (default: somefile.tex)" +\&\fBsnapshot\fR's dependency file does not list the main LaTeX file (the +one that gets passed to \fBlatex\fR). In order for \fBbundledoc\fR to find +and bundle that file, \fBbundledoc\fR assumes it has the same name as the +\&\fBsnapshot\fR dependency file but with a \fI.tex\fR extension. If this is +not the case, then use \f(CW\*(C`\-\-texfile\*(C'\fR to specify the correct filename. +.IP "\fB\-\-directory\fR=\fIarchive directory\fR (default: \fIsomefile\fR)" 4 +.IX Item "--directory=archive directory (default: somefile)" +When \fBbundledoc\fR creates an archive (e.g., a \fI.tar\fR or \fI.zip\fR file) +containing the document's files, it puts all of them in a directory to +avoid cluttering the current directory with files. If the given +dependency file is called \fIsomefile\fR\fI.dep\fR then the resulting +archive will, by default, store all the dependent files in a +\&\fIsomefile\fR directory. To change the directory name use the +\&\f(CW\*(C`\-\-directory\*(C'\fR option. +.ie n .IP "\fB\-\-\fR[\fBno\fR]\fBlocalonly\fR (default: ""nolocalonly"")" 4 +.el .IP "\fB\-\-\fR[\fBno\fR]\fBlocalonly\fR (default: \f(CWnolocalonly\fR)" 4 +.IX Item "--[no]localonly (default: nolocalonly)" +Although \fBbundledoc\fR normally archives all of the files named in the +\&\fI.dep\fR file, the \f(CW\*(C`\-\-localonly\*(C'\fR option tells \fBbundledoc\fR to exclude +all files located in a directory other than the \fI.tex\fR file's +directory or one of its subdirectories. +.IP "\fB\-\-exclude\fR=\fIstring\fR (default: \fInone\fR)" 4 +.IX Item "--exclude=string (default: none)" +While \f(CW\*(C`\-\-localonly\*(C'\fR causes files outside of the \fI.tex\fR file's +directory tree to be omitted from the archive, \f(CW\*(C`\-\-exclude\*(C'\fR provides +finer-grained control over files to omit from the archive. The +\&\f(CW\*(C`\-\-exclude\*(C'\fR option, which can be specified repeatedly on the command +line, causes all files whose name contains \fIstring\fR to be omitted +from the archive. +.IP "\fB\-\-include\fR=\fIfilespec\fR (default: \fInone\fR)" 4 +.IX Item "--include=filespec (default: none)" +The \f(CW\*(C`\-\-include\*(C'\fR option, which can be specified repeatedly on the +command line, instructs \fBbundledoc\fR to include in the archive all of +the files matching \fIfilespec\fR, even if they're not referenced in the +\&\fI.dep\fR file. +.IP "\fB\-\-manifest\fR=\fImanifest file\fR (default: \fI\s-1MANIFEST\s0\fR)" 4 +.IX Item "--manifest=manifest file (default: MANIFEST)" +In addition to the dependent files, \fBbundledoc\fR includes in the +archive file one extra file called, by default, ``\fI\s-1MANIFEST\s0\fR''. +\&\fI\s-1MANIFEST\s0\fR is a text file that lists the original filenames of all +the dependencies. To change the filename from ``\fI\s-1MANIFEST\s0\fR'' to +something else, use the \f(CW\*(C`\-\-manifest\*(C'\fR option. As a special case, +\&\f(CW\*(C`\-\-manifest=""\*(C'\fR tells \fBbundledoc\fR not to include a manifest file at +all. +.ie n .IP "\fB\-\-listdeps\fR=[yes|no|only|rel]...] (default: ""no"")" 4 +.el .IP "\fB\-\-listdeps\fR=[yes|no|only|rel]...] (default: \f(CWno\fR)" 4 +.IX Item "--listdeps=[yes|no|only|rel]...] (default: no)" +\&\f(CW\*(C`\-\-listdeps\*(C'\fR accepts one or more of \f(CW\*(C`yes\*(C'\fR, \f(CW\*(C`no\*(C'\fR, \f(CW\*(C`only\*(C'\fR, or \f(CW\*(C`rel\*(C'\fR +as a comma-separated list. As long as \f(CW\*(C`no\*(C'\fR does not appear in this +list, \fBbundledoc\fR outputs all of the main LaTeX file's dependencies. +If the list contains \f(CW\*(C`rel\*(C'\fR, then \fBbundledoc\fR outputs the list of +dependencies with relative pathnames. If the list contains \f(CW\*(C`only\*(C'\fR, +then \fBbundledoc\fR exits after displaying the list, without producing +an archive. +.ie n .IP "\fB\-\-\fR[\fBno\fR]\fBkeepdirs\fR (default: ""nokeepdirs"")" 4 +.el .IP "\fB\-\-\fR[\fBno\fR]\fBkeepdirs\fR (default: \f(CWnokeepdirs\fR)" 4 +.IX Item "--[no]keepdirs (default: nokeepdirs)" +Normally, the archive file that \fBbundledoc\fR produces contains a +single directory \*(-- and subdirectories, if the document refers +explicitly to them \*(-- in which all the dependent files lie. If +\&\f(CW\*(C`\-\-keepdirs\*(C'\fR is specified, all the dependent files are stored with +their original pathnames. For example, if \fIsomefile.tex\fR depends on +\&\fIfigures/somefigure.eps\fR, \fIarticle.cls\fR, and \fIsnapshot.sty\fR, then +the \fIsomefile\fR archive will normally contain the following files: +.RS 4 +.IP "\(bu" 4 +\&\fIsomefile/somefile.tex\fR +.IP "\(bu" 4 +\&\fIsomefile/figures/somefigure.eps\fR +.IP "\(bu" 4 +\&\fIsomefile/article.cls\fR +.IP "\(bu" 4 +\&\fIsomefile/snapshot.sty\fR +.IP "\(bu" 4 +\&\fIsomefile/MANIFEST\fR +.RE +.RS 4 +.Sp +However, \f(CW\*(C`\-\-keepdirs\*(C'\fR will cause the \fIsomefile\fR archive to contain +the following sorts of filenames instead: +.IP "\(bu" 4 +\&\fIhome/me/mydocs/somefile.tex\fR +.IP "\(bu" 4 +\&\fIhome/me/mydocs/figures/somefigure.eps\fR +.IP "\(bu" 4 +\&\fIusr/share/texmf/tex/latex/base/article.cls\fR +.IP "\(bu" 4 +\&\fIusr/share/texmf/tex/latex/snapshot/snapshot.sty\fR +.RE +.RS 4 +.Sp +\&\f(CW\*(C`\-\-directory\*(C'\fR is not used when \f(CW\*(C`\-\-keepdirs\*(C'\fR is in effect. In +addition, no manifest file is written to the archive file as it +contains redundant information. +.RE +.IP "\fB\-\-config\fR=\fIconfiguration file\fR (default: <none>)" 4 +.IX Item "--config=configuration file (default: <none>)" +The \f(CW\*(C`\-\-config\*(C'\fR option is used to point \fBbundledoc\fR to the +appropriate configuration (\fI.cfg\fR) file for your TeX distribution and +operating system. \fBbundledoc\fR comes with a few configuration files +and it's easy to write more. See \*(L"\s-1CONFIGURATION\s0 \s-1FILES\s0\*(R" (below) for +a description of the configuration file format. +.SH "CONFIGURATION FILES" +.IX Header "CONFIGURATION FILES" +.SS "Format" +.IX Subsection "Format" +Configuration files follow a fairly simple format. Lines beginning with +\&\f(CW\*(C`#\*(C'\fR are comments. Blank lines are ignored. All other lines are of the +form: +.PP +.Vb 1 +\& variable: value +.Ve +.PP +The current version of \fBbundledoc\fR recognizes the following variables: +.IP "\fBbundle\fR" 4 +.IX Item "bundle" +The command to use to bundle a set of files into a single archive file +.IP "\fBsink\fR" 4 +.IX Item "sink" +The affix to a command to discard its output +.IP "\fBfind\fR" 4 +.IX Item "find" +The command to find a file within the TeX tree(s). +.PP +Values that are too long for one line can be split across multiple lines +by using \f(CW\*(C`\e\*(C'\fR as the line-continuation symbol. +.PP +There are two environment variables that \fBbundledoc\fR makes available +for use by configuration-file commands: \f(CW\*(C`BDBASE\*(C'\fR, which is set to +\&\fIsomefile\fR (as in \*(L"\s-1OPTIONS\s0\*(R"), and \f(CW\*(C`BDINPUTS\*(C'\fR, which is set to a +space-separated list of files that a command is to operate upon. That +is, when the command associated with \f(CW\*(C`bundle\*(C'\fR is running, \f(CW\*(C`BDINPUTS\*(C'\fR +contains the list of all the files that are to be archived. In +contrast, when the command associated with \f(CW\*(C`find\*(C'\fR is running, +\&\f(CW\*(C`BDINPUTS\*(C'\fR contains the name of the file to search for. +.SS "Examples" +.IX Subsection "Examples" +The following configuration file parallels \fBbundledoc\fR's default +values of the various configuration-file variables, which represents a +kpathsea-based TeX distribution running on a generic Unix system, +which doesn't necessarily have any of the \s-1GNU\s0 tools, such as \fBgzip\fR +or \s-1GNU\s0 \fBtar\fR: +.PP +.Vb 2 +\& # "Default" configuration file +\& # By Scott Pakin <scott+bdoc@pakin.org> +\& +\& bundle: (tar \-cvf \- $BDINPUTS | compress > $BDBASE.tar.Z) +\& sink: > /dev/null 2>&1 +\& find: kpsewhich \-progname=latex $BDINPUTS +.Ve +.PP +The parentheses in the \f(CW\*(C`bundle:\*(C'\fR line tell the Unix shell to run the +command in a subshell. This is to make the \f(CW\*(C`sink:\*(C'\fR affix work +properly (i.e., so there aren't two \f(CW\*(C`>\*(C'\fR's in the same command). +.PP +Notice how the commands treat \f(CW\*(C`BDBASE\*(C'\fR and \f(CW\*(C`BDINPUTS\*(C'\fR like any other +environment variables in a Unix shell, using \f(CW\*(C`$\*(C'\fR to take their value. +Other operating systems use different conventions for referring to +environment variables. For instance, a configuration file for a +Windows-based TeX distribution would use \f(CW\*(C`%BDBASE%\*(C'\fR and \f(CW\*(C`%BDINPUTS%\*(C'\fR +instead. +.PP +The value for \f(CW\*(C`sink:\*(C'\fR is specific to an operating system. The value +for \f(CW\*(C`find:\*(C'\fR is specific to a TeX distribution. \f(CW\*(C`bundle:\*(C'\fR is where +the most opportunity for customization lies. You can use \f(CW\*(C`bundle:\*(C'\fR +to specify your favorite archive format. For example, you can produce +a shar file on Unix with something like: +.PP +.Vb 1 +\& bundle: (shar \-\-archive\-name="$BDBASE" $BDINPUTS > $BDBASE.sh) +.Ve +.PP +or a \s-1CAB\s0 file on Microsoft Windows with something like: +.PP +.Vb 1 +\& bundle: cabarc \-r \-p N %BDBASE%.cab %BDINPUTS% +.Ve +.SH "EXAMPLES" +.IX Header "EXAMPLES" +Assume that \fImyfile.dep\fR was produced from \fImyfile.tex\fR by following +the instructions in the Description section. The +following command produces a \fI.zip\fR file with the MikTeX TeX +distribution running on Microsoft Windows: +.PP +.Vb 1 +\& bundledoc \-\-config=miktex.cfg myfile.dep +.Ve +.PP +(In practice, it's probably necessary to specify to \f(CW\*(C`\-\-config\*(C'\fR the +complete path to \fBbundledoc\fR's \fImiktex.cfg\fR configuration file.) +.PP +The following builds a \fI.tar.gz\fR archive with the TeX Live +distribution running on a Unix-like operating system. \fBbundledoc\fR +will produce verbose output describing its operations. All files not +in the same directory tree as \fImyfile.tex\fR and all files containing +\&\*(L".fd\*(R" or \*(L".sty\*(R" in their names are omitted. However, all \fI.bib\fR +files in the current directory will be included in the archive even +though none of them are referenced by \fImyfile.dep\fR. Finally, no +\&\fI\s-1MANIFEST\s0\fR file will be produced. +.PP +.Vb 3 +\& bundledoc \-\-config=texlive\-unix.cfg \-\-verbose \-\-localonly \e +\& \-\-exclude=.fd \-\-exclude=.cfg \-\-include="*.bib" \-\-manifest="" \e +\& myfile.dep +.Ve +.SH "FILES" +.IX Header "FILES" +The user must have previously installed \fIsnapshot.sty\fR and used it to +produce a dependency file for his document. Besides that, the set of +external files needed by \fBbundledoc\fR is system-specific and depends on the +configuration file used. (See \*(L"\s-1CONFIGURATION\s0 \s-1FILES\s0\*(R", above.) +.PP +\&\fBbundledoc\fR currently comes with two configuration files: +.IP "\fItexlive\-unix.cfg\fR" 4 +.IX Item "texlive-unix.cfg" +Configuration file for TeX Live installations on Unix or Linux. TeX +Live is a kpathsea-based TeX distribution that runs on various flavors +of Unix and Microsoft Windows. \fItexlive\-unix.cfg\fR assumes you have +\&\fBgzip\fR and uses it to produce a \fI.tar.gz\fR archive file. The +configuration file has \fBbundledoc\fR use \fBkpsewhich\fR to find LaTeX +files. +.IP "\fImiktex.cfg\fR" 4 +.IX Item "miktex.cfg" +Configuration file for MikTeX installations. MikTeX is a popular TeX +distribution for Microsoft Windows. \fImiktex.cfg\fR assumes you have +\&\fBzip\fR and uses it to produce a \fI.zip\fR archive file. The +configuration file has \fBbundledoc\fR use the rather nonstandard +\&\fBinitexmf\fR to find LaTeX files. +.SH "NOTES" +.IX Header "NOTES" +.SS "Including and excluding files" +.IX Subsection "Including and excluding files" +The \f(CW\*(C`\-\-localonly\*(C'\fR, \f(CW\*(C`\-\-exclude\*(C'\fR, and \f(CW\*(C`\-\-include\*(C'\fR options provide +control over the archive's contents. \f(CW\*(C`\-\-exclude\*(C'\fR and \f(CW\*(C`\-\-include\*(C'\fR +can be specified repeatedly on the command line. The order in which +these options are specified is immaterial; \fBbundledoc\fR processes file +inclusions and exclusions in the following order: +.IP "1." 4 +All files referenced by the \fI.dep\fR file are added to the list of +files to archive. +.IP "2." 4 +If \f(CW\*(C`\-\-localonly\*(C'\fR is specified, all files not found in the \fI.tex\fR +file's directory are removed from the list. +.IP "3." 4 +For each \f(CW\*(C`\-\-exclude\*(C'\fR string specified, all files containing that +string are removed from the list. +.IP "4." 4 +For each \f(CW\*(C`\-\-include\*(C'\fR file specification, the set of files designated +by its expansion are added to the list. +.SS "Issues When Running Under Microsoft Windows" +.IX Subsection "Issues When Running Under Microsoft Windows" +First, because \fBbundledoc\fR is a Perl script, you should do one of the +following to run it under Windows: +.IP "\(bu" 4 +\&\f(CW\*(C`perl bundledoc\*(C'\fR +.IP "\(bu" 4 +Rename \fIbundledoc\fR to \fIbundledoc.pl\fR and run \f(CW\*(C`bundledoc.pl\*(C'\fR. (This +is assuming you have a file association set up for \fI.pl\fR.) +.IP "\(bu" 4 +Run the \fBpl2bat\fR script (if you have it) to convert \fIbundledoc\fR to +\&\fIbundledoc.bat\fR, then run \f(CW\*(C`bundledoc\*(C'\fR. +.PP +Second, Windows uses a multi-rooted filesystem (i.e., multiple drive +letters). I wouldn't be surprised if bad things were to happen if the +files to be bundled are scattered across drives. In addition, Windows +supports ``\s-1UNC\s0'' filenames, which have no drive letter at all, just a +machine and share name. \s-1UNC\s0 filenames are also untested waters for +\&\fBbundledoc\fR. Be careful! +.SS "Testing Status" +.IX Subsection "Testing Status" +I have tested \fBbundledoc\fR only with Perl v5.6.0 and later and only on +the following platforms: +.IP "\(bu" 4 +Linux + TeX Live +.IP "\(bu" 4 +Linux + teTeX +.IP "\(bu" 4 +Windows \s-1NT\s0 + MiKTeX +.IP "\(bu" 4 +Solaris + ??? (something kpathsea-based) +.PP +It is my hope that \fBbundledoc\fR works on many more platforms than +those. I tried to make the program itself fairly independent of the +operating system; only the configuration files should have to change +to run \fBbundledoc\fR on a different system. +.SS "Future Work" +.IX Subsection "Future Work" +I'd like \fBbundledoc\fR to work on as wide a variety of TeX +distributions as possible. If your platform is significantly +different from the ones listed in \*(L"Testing Status\*(R" (e.g., if you're +running MacOS) and you need to create a substantially different +configuration file from \fItexlive\-unix.cfg\fR and \fImiktex.cfg\fR, please +send it to me at the address listed in \*(L"\s-1AUTHOR\s0\*(R" so I can include it +in a future version of \fBbundledoc\fR. (I make no promises, though). +.PP +Once \fBbundledoc\fR works on all the major operating systems and TeX +distributions it would be really convenient if I could get +\&\fBbundledoc\fR to detect the platform it's running on and automatically +select an appropriate configuration file. +.PP +Finally, it would be handy for \fBbundledoc\fR to include fonts in the +archive file. At a minimum, it should include \fI.tfm\fR files, but it +would be even better if it included \fI.mf\fR, \fI.pfb\fR, \fI.ttf\fR, and +other common font formats, as well. +.SS "Acknowledgments" +.IX Subsection "Acknowledgments" +Thanks to Fabien Vignes-Tourneret for suggesting what became the +\&\f(CW\*(C`\-\-localonly\*(C'\fR option and for a discussion that led to the +\&\f(CW\*(C`\-\-exclude\*(C'\fR and \f(CW\*(C`\-\-include\*(C'\fR options; and to Marius Kleiner for +updating \fBbundledoc\fR to properly handle document subdirectories. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fIgzip\fR\|(1), \fIkpsewhich\fR\|(1), \fIlatex\fR\|(1), \fIperl\fR\|(1), \fIzip\fR\|(1), the \fBsnapshot\fR +documentation +.SH "AUTHOR" +.IX Header "AUTHOR" +Scott Pakin, \fIscott+bdoc@pakin.org\fR diff --git a/Master/texmf-dist/doc/man/man1/bundledoc.man1.pdf b/Master/texmf-dist/doc/man/man1/bundledoc.man1.pdf Binary files differnew file mode 100644 index 00000000000..e2d458a6830 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/bundledoc.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/cef5conv.1 b/Master/texmf-dist/doc/man/man1/cef5conv.1 new file mode 100644 index 00000000000..e1d2c6a7ad8 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/cef5conv.1 @@ -0,0 +1,127 @@ +.\" man page for cef5conv +.\" Copyright (C) 1994-2012 Werner Lemberg <wl@gnu.org> +.\" +.\" 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 2 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 in doc/COPYING; if not, write to the Free +.\" Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, +.\" MA 02110-1301 USA +. +.TH CEF5CONV 1 07-May-2012 "CJK Version 4.8.3" +. +.\" ==== +.\" ==== macro definitions +.\" ==== +. +.\" here we define \TeX for troff and nroff +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +. +.\" and here the same for \LaTeX +.if t \{\ +.ie '\*(.T'dvi' \ +.ds LX \fRL\h'-0.36m'\v'-0.15v'\s-3A\s0\h'-0.15m'\v'0.15v'\fP\*(TX +.el .ds LX \fRL\h'-0.36m'\v'-0.22v'\s-2A\s0\h'-0.15m'\v'0.22v'\fP\*(TX +.\} +.if n .ds LX LaTeX +. +.\" \LaTeXe +.\" note that we need \vareps for TeX instead of \eps which can only be +.\" accessed with the \N escape sequence (in the Math Italic font) +.if t \{\ +.ie '\*(.T'dvi' .ds LE \*(LX\h'0.15m'2\v'0.20v'\f(MI\N'34'\fP\v'-0.20v' +.el .ds LE \*(LX\h'0.15m'2\v'0.20v'\(*e\v'-0.20v' +.\} +.if n .ds LE LaTeX\ 2e +. +.\" a typewriter font +.if t \{\ +.de C +\fC\\$1\fP +.. +.\} +.if n \{\ +.de C +\\$1 +.. +.\} +. +.\" ==== +.\" ==== end of macro definitions +.\" ==== +. +. +. +.SH NAME +cef5conv \- convert a TeX document in Big\ 5 encoding containing CEF macros +into `preprocessed' form. +. +. +.SH SYNOPSIS +.B cef5conv +< +.I infile +> +.I outfile +. +. +.SH DESCRIPTION +The +.B Chinese Encoding Framework +.RB ( CEF ) +developed by Christian Wittern +.C <cwittern@conline.central.de> +makes it possible to include CJK characters in various encodings using the +SGML macros +.B &CX-aabb; +for Big\ 5 and CNS encoding and +.B &U-aabb; +for Unicode +.RB ( X +denotes a number between 0 and 7; 0 represents Big\ 5 encoding, 1-7 CNS +encoding planes 1-7. +.B aabb +is either a decimal or hexadecimal number). +.PP +.B cef5conv +converts the CEF macros of a Big\ 5 encoded document together with the Big\ +5 encoding itself into a form which can directly processed with \*(LE. +It is identical to +.IP +.B bg5conv +< +.I infile +| +.B cefconv +> +.I outfile +.PP +This filter is part of the +.B CJK +macro package for \*(LE. +. +. +.SH "SEE ALSO" +.BR \%sjisconv (1), +.BR bg5conv (1), +.BR \%cefconv (1), +.BR \%cefsconv (1), +.BR \%extconv (1), +.br +the +.B CJK +documentation files. +. +. +.SH AUTHOR +Werner Lemberg +.C <wl@gnu.org> diff --git a/Master/texmf-dist/doc/man/man1/cef5conv.man1.pdf b/Master/texmf-dist/doc/man/man1/cef5conv.man1.pdf Binary files differnew file mode 100644 index 00000000000..8cabb2e1a89 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/cef5conv.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/cefconv.1 b/Master/texmf-dist/doc/man/man1/cefconv.1 new file mode 100644 index 00000000000..312740d7d1c --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/cefconv.1 @@ -0,0 +1,117 @@ +.\" man page for cefconv +.\" Copyright (C) 1994-2012 Werner Lemberg <wl@gnu.org> +.\" +.\" 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 2 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 in doc/COPYING; if not, write to the Free +.\" Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, +.\" MA 02110-1301 USA +. +.TH CEFCONV 1 07-May-2012 "CJK Version 4.8.3" +. +.\" ==== +.\" ==== macro definitions +.\" ==== +. +.\" here we define \TeX for troff and nroff +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +. +.\" and here the same for \LaTeX +.if t \{\ +.ie '\*(.T'dvi' \ +.ds LX \fRL\h'-0.36m'\v'-0.15v'\s-3A\s0\h'-0.15m'\v'0.15v'\fP\*(TX +.el .ds LX \fRL\h'-0.36m'\v'-0.22v'\s-2A\s0\h'-0.15m'\v'0.22v'\fP\*(TX +.\} +.if n .ds LX LaTeX +. +.\" \LaTeXe +.\" note that we need \vareps for TeX instead of \eps which can only be +.\" accessed with the \N escape sequence (in the Math Italic font) +.if t \{\ +.ie '\*(.T'dvi' .ds LE \*(LX\h'0.15m'2\v'0.20v'\f(MI\N'34'\fP\v'-0.20v' +.el .ds LE \*(LX\h'0.15m'2\v'0.20v'\(*e\v'-0.20v' +.\} +.if n .ds LE LaTeX\ 2e +. +.\" a typewriter font +.if t \{\ +.de C +\fC\\$1\fP +.. +.\} +.if n \{\ +.de C +\\$1 +.. +.\} +. +.\" ==== +.\" ==== end of macro definitions +.\" ==== +. +. +. +.SH NAME +cefconv \- convert a TeX document containing CEF macros into `preprocessed' +form. +. +. +.SH SYNOPSIS +.B cefconv +< +.I infile +> +.I outfile +. +. +.SH DESCRIPTION +The +.B Chinese Encoding Framework +.RB ( CEF ) +developed by Christian Wittern +.C <cwittern@conline.central.de> +makes it possible to include CJK characters in various encodings using the +SGML macros +.B &CX-aabb; +for Big\ 5 and CNS encoding and +.B &U-aabb; +for Unicode +.RB ( X +denotes a number between 0 and 7; 0 represents Big\ 5 encoding, 1-7 CNS +encoding planes 1-7. +.B aabb +is either a decimal or hexadecimal number) +.PP +.B \%cefconv +converts the CEF macros into a form which can directly processed with \*(LE. +.PP +This filter is part of the +.B CJK +macro package for \*(LE. +. +. +.SH "SEE ALSO" +.BR \%sjisconv (1), +.BR bg5conv (1), +.BR cef5conv (1), +.BR \%cefsconv (1), +.BR \%extconv (1), +.br +the +.B CJK +documentation files. +. +. +.SH AUTHOR +Werner Lemberg +.C <wl@gnu.org> diff --git a/Master/texmf-dist/doc/man/man1/cefconv.man1.pdf b/Master/texmf-dist/doc/man/man1/cefconv.man1.pdf Binary files differnew file mode 100644 index 00000000000..0f2054a1a0e --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/cefconv.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/cefsconv.1 b/Master/texmf-dist/doc/man/man1/cefsconv.1 new file mode 100644 index 00000000000..d9c2d578acd --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/cefsconv.1 @@ -0,0 +1,127 @@ +.\" man page for cefsconv +.\" Copyright (C) 1994-2012 Werner Lemberg <wl@gnu.org> +.\" +.\" 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 2 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 in doc/COPYING; if not, write to the Free +.\" Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, +.\" MA 02110-1301 USA +. +.TH CEFSCONV 1 07-May-2012 "CJK Version 4.8.3" +. +.\" ==== +.\" ==== macro definitions +.\" ==== +. +.\" here we define \TeX for troff and nroff +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +. +.\" and here the same for \LaTeX +.if t \{\ +.ie '\*(.T'dvi' \ +.ds LX \fRL\h'-0.36m'\v'-0.15v'\s-3A\s0\h'-0.15m'\v'0.15v'\fP\*(TX +.el .ds LX \fRL\h'-0.36m'\v'-0.22v'\s-2A\s0\h'-0.15m'\v'0.22v'\fP\*(TX +.\} +.if n .ds LX LaTeX +. +.\" \LaTeXe +.\" note that we need \vareps for TeX instead of \eps which can only be +.\" accessed with the \N escape sequence (in the Math Italic font) +.if t \{\ +.ie '\*(.T'dvi' .ds LE \*(LX\h'0.15m'2\v'0.20v'\f(MI\N'34'\fP\v'-0.20v' +.el .ds LE \*(LX\h'0.15m'2\v'0.20v'\(*e\v'-0.20v' +.\} +.if n .ds LE LaTeX\ 2e +. +.\" a typewriter font +.if t \{\ +.de C +\fC\\$1\fP +.. +.\} +.if n \{\ +.de C +\\$1 +.. +.\} +. +.\" ==== +.\" ==== end of macro definitions +.\" ==== +. +. +. +.SH NAME +cefsconv \- convert a TeX document in SJIS encoding containing CEF macros +into `preprocessed' form. +. +. +.SH SYNOPSIS +.B cefsconv +< +.I infile +> +.I outfile +. +. +.SH DESCRIPTION +The +.B Chinese Encoding Framework +.RB ( CEF ) +developed by Christian Wittern +.C <cwittern@conline.central.de> +makes it possible to include CJK characters in various encodings using the +SGML macros +.B &CX-aabb; +for Big\ 5 and CNS encoding and +.B &U-aabb; +for Unicode +.RB ( X +denotes a number between 0 and 7; 0 represents Big\ 5 encoding, 1-7 CNS +encoding planes 1-7. +.B aabb +is either a decimal or hexadecimal number). +.PP +.B \%cefsconv +converts the CEF macros of a SJIS encoded document together with the SJIS +encoding itself into a form which can directly processed with \*(LE. +It is identical to +.IP +.B sjisconv +< +.I infile +| +.B cefconv +> +.I outfile +.PP +This filter is part of the +.B CJK +macro package for \*(LE. +. +. +.SH "SEE ALSO" +.BR \%sjisconv (1), +.BR bg5conv (1), +.BR \%cefconv (1), +.BR cef5conv (1), +.BR \%extconv (1), +.br +the +.B CJK +documentation files. +. +. +.SH AUTHOR +Werner Lemberg +.C <wl@gnu.org> diff --git a/Master/texmf-dist/doc/man/man1/cefsconv.man1.pdf b/Master/texmf-dist/doc/man/man1/cefsconv.man1.pdf Binary files differnew file mode 100644 index 00000000000..f4c0e0102ea --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/cefsconv.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/cfftot1.1 b/Master/texmf-dist/doc/man/man1/cfftot1.1 new file mode 100644 index 00000000000..7cefb03d69e --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/cfftot1.1 @@ -0,0 +1,87 @@ +.ds V 2.92 +.de M +.BR "\\$1" "(\\$2)\\$3" +.. +.de Sp +.if n .sp +.if t .sp 0.4 +.. +.TH CFFTOT1 1 "LCDF Typetools" "Version \*V" +.SH NAME +cfftot1 \- convert PostScript font from CFF to Type 1 +.SH SYNOPSIS +.B cfftot1 +\%[\fB\-a\fR] +\%[\fIinput\fR [\fIoutput\fR]] +.SH DESCRIPTION +.BR Cfftot1 +converts PostScript font programs in the Compact Font Format (CFF) into +Type 1 font programs in PFB or PFA format, preserving all hints that can be +represented in Type 1. The input file should be a raw CFF file or a +PostScript-flavored OpenType font. If the file +.I output +is not specified output goes to the standard output. +If the file +.I input +is not specified input comes from the standard input. +' +.SH OPTIONS +.PD 0 +.TP 5 +.BI \-a "\fR, " \-\-pfa +Output font in ASCII PFA format. +' +.Sp +.TP 5 +.BI \-b "\fR, " \-\-pfb +Output font in binary PFB format. This is the default. +' +.Sp +.TP 5 +.BI \-n " name\fR, " \-\-name " name" +Output the CFF's component font named +.IR name . +CFF files can contain more than one font, although few do. Use this option +to select a particular font from a multi-font collection. By default +cfftot1 chooses the collection's first font. +' +.Sp +.TP 5 +.BI \-o " file\fR, " \-\-output " file" +Write output font to +.IR file +instead of the standard output. +' +.Sp +.TP 5 +.BR \-q ", " \-\-quiet +Do not generate any error messages. +' +.Sp +.TP 5 +.BR \-h ", " \-\-help +Print usage information and exit. +' +.Sp +.TP 5 +.BR \-v ", " \-\-version +Print the version number and some short non-warranty information and exit. +.PD +' +.SH "SEE ALSO" +.LP +.M t1binary 1 , +.M t1ascii 1 +.LP +.I "Adobe Type 1 Font Format" +.LP +Adobe Technical Notes #5176, +.IR "The Compact Font Format Specification" , +and #5177, +.I "The Type 2 Charstring Format" +.LP +.IR "OpenType Specification" , +Version 1.4 +' +.SH AUTHOR +Eddie Kohler (ekohler@gmail.com) diff --git a/Master/texmf-dist/doc/man/man1/cfftot1.man1.pdf b/Master/texmf-dist/doc/man/man1/cfftot1.man1.pdf Binary files differnew file mode 100644 index 00000000000..9bc34d8e0d5 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/cfftot1.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/chktex.1 b/Master/texmf-dist/doc/man/man1/chktex.1 new file mode 100644 index 00000000000..914076926a8 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/chktex.1 @@ -0,0 +1,139 @@ +.TH chktex 1 "March 30, 2001" +.AT 3 +.SH NAME +chktex \- finds typographic errors in LaTeX. +.SH SYNOPSIS +.B chktex +.I [-hiqrW] [-v[0-...]] [-l <rcfile>] [-[wemn] <[1-42]|all>] +.I [-d[0-...]] [-p <name>] [-o <outfile>] [-[btxgI][0|1]] +.B file1 file2 ... +.SH DESCRIPTION +.I chktex +finds typographic errors in +.I LaTeX +. +.SH OPTIONS +.PP +Miscellaneous options: +.TP +.B "-h --help" +Print a help screen. +.TP +.B "-i --license" +Show distribution information. +.TP +.B "-l --localrc" +Read local .chktexrc formatted file. +.TP +.B "-d --debug" +Debug information. Give it a number. +.TP +.B "-r --reset" +Reset settings to default. +.PP +Muting warning messages: +.TP +.B "-w --warnon" +Makes msg # given a warning and turns it on. +.TP +.B "-e --erroron" +Makes msg # given an error and turns it on. +.TP +.B "-m --msgon" +Makes msg # given a message and turns it on. +.TP +.B "-n --nowarn" +Mutes msg # given. + +.PP +Output control flags: +.TP +.B "-v --verbosity" +How errors are displayed. +Default 1, 0=Less, 2=Fancy, 3=lacheck. +.TP +.B "-V --pipeverb" +How errors are displayed when stdout != tty. +Defaults to the same as -v. +.TP +.B "-s --splitchar" +String used to split fields when doing -v0 +.TP +.B "-o --output" +Redirect error report to a file. +.TP +.B "-q --quiet" +Shuts up about version information. +.TP +.B "-p --pseudoname" +Input file-name when reporting. +.TP +.B "-f --format" +Format to use for output + +.PP +Boolean switches (1 -> enables / 0 -> disables): +.TP +.B "-b --backup" +Backup output file. +.TP +.B "-x --wipeverb" +Ignore contents of `\\verb' commands. +.TP +.B "-g --globalrc" +Read global .chktexrc file. +.TP +.B "-I --inputfiles" +Execute \\input statements. +.TP +.B "-H --headererr" +Show errors found in front of \\begin{document} +.PP Miscellaneous switches: +.TP +.B "-W --version" +Version information + +.PP +If no LaTeX files are specified on the command line, we will read from +stdin. For explanation of warning/error messages, please consult the +main document /usr/share/doc/chktex/ChkTeX.dvi.gz. + +.SH DISTRIBUTION +Copyright (C) 1996 Jens T. Berger Thielemann +.PP +This program is free software; you can redistribute it and/or modify +it under the terms of the +.I GNU General Public License +as published by +the Free Software Foundation; either version 2 of the License, or +(at your option) any later version. +.PP +This program is distributed in the hope that it will be useful, +but +.B WITHOUT ANY WARRANTY; +without even the implied warranty of +.B MERCHANTABILITY +or +.B FITNESS FOR A PARTICULAR PURPOSE. +See the +.I GNU General Public License +for more details. +.PP +You should have received a copy of the +.B GNU General Public License +along with this program; if not, write to the +.I Free Software Foundation, Inc., +59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +.SH ENVIRONMENT +No environment variables are used. +.SH FILES +None. +.SH AUTHOR +Jens T. Berger Thielemann, +.I <jensthi@ifi.uio.no> +.PP +This manual page was cobbled together by Clint Adams <schizo@debian.org>, +based on the output of "chktex --help" and deweb(1). +.SH "SEE ALSO" +.B deweb(1), chkweb(1) diff --git a/Master/texmf-dist/doc/man/man1/chktex.man1.pdf b/Master/texmf-dist/doc/man/man1/chktex.man1.pdf Binary files differnew file mode 100644 index 00000000000..877defeb6ff --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/chktex.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/chkweb.1 b/Master/texmf-dist/doc/man/man1/chkweb.1 new file mode 100644 index 00000000000..5cb7063f786 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/chkweb.1 @@ -0,0 +1,132 @@ +.TH chkweb 1 "March 30, 2001" +.AT 3 +.SH NAME +chkweb \- runs the LaTeX parts of a CWEB file through chktex +.SH SYNOPSIS +.B chkweb +.I [-hiqrW] [-l <rcfile>] [-[wemn] <[1-42]|all>] +.I [-d[0-...]] [-o <outfile>] [-[btxgI][0|1]] +.B file1 file2 ... +.SH DESCRIPTION +.I chkweb +runs the +.I LaTeX +parts of a CWEB file through chktex. +.SH OPTIONS +.PP +Miscellaneous options: +.TP +.B "-h --help" +Print a help screen. +.TP +.B "-i --license" +Show distribution information. +.TP +.B "-l --localrc" +Read local .chktexrc formatted file. +.TP +.B "-d --debug" +Debug information. Give it a number. +.TP +.B "-r --reset" +Reset settings to default. +.PP +Muting warning messages: +.TP +.B "-w --warnon" +Makes msg # given a warning and turns it on. +.TP +.B "-e --erroron" +Makes msg # given an error and turns it on. +.TP +.B "-m --msgon" +Makes msg # given a message and turns it on. +.TP +.B "-n --nowarn" +Mutes msg # given. + +.PP +Output control flags: +.TP +.B "-V --pipeverb" +How errors are displayed when stdout != tty. +Defaults to the same as -v. +.TP +.B "-s --splitchar" +String used to split fields when doing -v0 +.TP +.B "-o --output" +Redirect error report to a file. +.TP +.B "-q --quiet" +Shuts up about version information. +.TP +.B "-f --format" +Format to use for output + +.PP +Boolean switches (1 -> enables / 0 -> disables): +.TP +.B "-b --backup" +Backup output file. +.TP +.B "-x --wipeverb" +Ignore contents of `\\verb' commands. +.TP +.B "-g --globalrc" +Read global .chktexrc file. +.TP +.B "-I --inputfiles" +Execute \\input statements. +.TP +.B "-H --headererr" +Show errors found in front of \\begin{document} +.PP Miscellaneous switches: +.TP +.B "-W --version" +Version information + +.PP +If no LaTeX files are specified on the command line, we will read from +stdin. For explanation of warning/error messages, please consult the +main document /usr/share/doc/chktex/ChkTeX.dvi.gz. + +.SH DISTRIBUTION +Copyright (C) 1996 Jens T. Berger Thielemann +.PP +This program is free software; you can redistribute it and/or modify +it under the terms of the +.I GNU General Public License +as published by +the Free Software Foundation; either version 2 of the License, or +(at your option) any later version. +.PP +This program is distributed in the hope that it will be useful, +but +.B WITHOUT ANY WARRANTY; +without even the implied warranty of +.B MERCHANTABILITY +or +.B FITNESS FOR A PARTICULAR PURPOSE. +See the +.I GNU General Public License +for more details. +.PP +You should have received a copy of the +.B GNU General Public License +along with this program; if not, write to the +.I Free Software Foundation, Inc., +59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +.SH ENVIRONMENT +No environment variables are used. +.SH FILES +None. +.SH AUTHOR +Jens T. Berger Thielemann, +.I <jensthi@ifi.uio.no> +.PP +This manual page was cobbled together by Clint Adams <schizo@debian.org>, +based on the output of "chktex --help" and deweb(1). +.SH "SEE ALSO" +.B deweb(1), chktex(1) diff --git a/Master/texmf-dist/doc/man/man1/chkweb.man1.pdf b/Master/texmf-dist/doc/man/man1/chkweb.man1.pdf Binary files differnew file mode 100644 index 00000000000..23b2ca39e38 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/chkweb.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/context.1 b/Master/texmf-dist/doc/man/man1/context.1 new file mode 100644 index 00000000000..254d9b87468 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/context.1 @@ -0,0 +1,140 @@ +.TH "CONTEXT" "1" "June 2011" "context 0.52" "ConTeXt" +.de URL +\\$2 \(laURL: \\$1 \(ra\\$3 +.. +.if \n[.g] .mso www.tmac +.de EX +.in +3 +.nf +.ft CW +.. +.de EE +.in -3 +.ft R +.fi +.. + +.SH "NAME" +context \- front end to the new ConTeXt typesetting system + +.SH "SYNOPSIS" +\fBcontext\fP [ \fIOPTION\fP ... ] \fIFILE\fP [ ... ] + +.SH "DESCRIPTION" + +\fBcontext\fP, a \fBtexlua\fP(1) script, +is the command-line front end to the new version of the +ConTeXt typesetting system, an extensive macro package +built on the \fBtex\fP(1) family of typesetting programs. +\fBcontext\fP provides several facilties: +.IP \(bu +Process a ConTeXt source file, +performing as many runs as +necessary of \fBluatex\fP(1). Options control the output +format, the pages to process, paper size, and so forth. +.IP \(bu +Create new ConTeXt formats, useful during installation. +.IP \(bu +Post-process existing PDF files, including merging multiple +files, and extracting and rearranging pages within a file, +similar to the facilities provided for PostScript files by +\fBpsnup\fP(1) or for PDF files by \fBpdftk\fP(1). +.IP +.SH "OPTIONS" + +All switches should always be specified in full. With no options, +\fBcontext\fP assumes that +the file on the command line is a ConTeXt source file, i.e. a TeX file +in the ConTeXt dialect, and produces a PDF file using the source file. + +.IP "\fB--run\fP" +process (one or more) files (default action) +.IP "\fB--make\fP" +create context formats +.IP "\fB--ctx\fP\fI=\fP\fIname\fP" +use ctx file (process management specification) +.IP "\fB--interface\fP" +use specified user interface (default: en) +.IP "\fB--autopdf\fP" +close pdf file in viewer and start pdf viewer afterwards +.IP "\fB--purge(all)\fP" +purge files either or not after a run (\fB--pattern\fP\fI=\fP\fI...\fP) +.IP "\fB--usemodule\fP\fI=\fP\fIlist\fP" +load the given module or style, normally part o fthe distribution +.IP "\fB--environment\fP\fI=\fP\fIlist\fP" +load the given environment file first (document styles) +.IP "\fB--mode\fP\fI=\fP\fIlist\fP" +enable given the modes (conditional processing in styles) +.IP "\fB--path\fP\fI=\fP\fIlist\fP" +also consult the given paths when files are looked for +.IP "\fB--arguments\fP\fI=\fP\fIlist\fP" +set variables that can be consulted during a run (key/value pairs) +.IP "\fB--randomseed\fP\fI=\fP\fInumber\fP" +set the randomseed +.IP "\fB--result\fP\fI=\fP\fIname\fP" +rename the resulting output to the given name +.IP "\fB--trackers\fP\fI=\fP\fIlist\fP" +set tracker variables (show list with \fB--showtrackers\fP) +.IP "\fB--directives\fP\fI=\fP\fIlist\fP" +set directive variables (show list with \fB--showdirectives\fP) +.IP "\fB--silent\fP\fI=\fP\fIlist\fP" +disable logcatgories (show list with \fB--showlogcategories\fP) +.IP "\fB--noconsole\fP" +disable logging to the console (logfile only) +.IP "\fB--purgeresult\fP" +purge result file before run +.IP "\fB--forcexml\fP" +force xml stub (optional flag: \fB--mkii\fP) +.IP "\fB--forcecld\fP" +force cld (context lua document) stub +.IP "\fB--arrange\fP" +run extra imposition pass, given that the style sets up imposition +.IP "\fB--noarrange\fP" +ignore imposition specifications in the style +.IP "\fB--once\fP" +only run once (no multipass data file is produced) +.IP "\fB--batchmode\fP" +run without stopping and don't show messages on the console +.IP "\fB--nonstopmode\fP" +run without stopping +.IP "\fB--generate\fP" +generate file database etc. (as \fBmtxrun\fP does) +.IP "\fB--paranoid\fP" +don't descend to .. and ../.. +.IP "\fB--version\fP" +report installed context version +.IP "\fB--expert\fP" +show expert options + + +.SH "INITIALIZATION" + +.PP +The \fBcontext\fP command is just a stub that runs the larger \fBmtxrun\fP +script, which is a scripting framework written for \fBtexlua\fP(1) that +supports loading of extra modules, of which \fBcontext\fP is one. The +implementation actually resides in a file named \fBmtx-context.lua\fP +deep within the TDS structure. + +If \fBcontext\fP complains about \fBUnknown script 'context'\fP, this +can usually be fixed by executing \fBmtxrun --generate\fP on the +command line: this command regenerates the database that \fBmtxrun\fP +uses to find its extra modules. + +.SH "SEE ALSO" +.PP +\fBtex\fP(1), \fBluatex\fP(1), \fBtexlua\fP(1), \fBpsnup\fP(1), \fBpdftk\fP(1). +.PP +.URL "http://www.contextgarden.net" "ConTeXt wiki" . +.PP +.URL "http://www.ntg.nl/mailman/listinfo/ntg-context" "ConTeXt mailing list home" . + +.SH "BUGS" + +.PP +This manpage is horribly incomplete. + +.SH "AUTHOR" +This partial manpage was written by Taco Hoekwater +<taco@metatex.org>. +It is based on the \fB--help\fP output of \fBcontext\fP. diff --git a/Master/texmf-dist/doc/man/man1/context.man1.pdf b/Master/texmf-dist/doc/man/man1/context.man1.pdf Binary files differnew file mode 100644 index 00000000000..8863439d028 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/context.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/ctangle.1 b/Master/texmf-dist/doc/man/man1/ctangle.1 new file mode 100644 index 00000000000..197f7c83e94 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ctangle.1 @@ -0,0 +1 @@ +.so man1/cweb.1 diff --git a/Master/texmf-dist/doc/man/man1/ctangle.man1.pdf b/Master/texmf-dist/doc/man/man1/ctangle.man1.pdf Binary files differnew file mode 100644 index 00000000000..e84bb7f852b --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ctangle.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/ctanify.1 b/Master/texmf-dist/doc/man/man1/ctanify.1 new file mode 100644 index 00000000000..f2758913f57 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ctanify.1 @@ -0,0 +1,376 @@ +.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "CTANIFY 1" +.TH CTANIFY 1 "2009-08-02" "v1.1" "" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +ctanify \- Prepare a package for upload to CTAN +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +ctanify +[\fB\-\-pkgname\fR=\fIstring\fR] +[\fB\-\-\fR[\fBno\fR]\fBauto\fR] +[\fB\-\-tdsonly\fR=\fIfilespec\fR ...] +[\fB\-\-\fR[\fBno\fR]\fBunixify\fR] +[\fB\-\-\fR[\fBno\fR]\fBskip\fR] +\&\fIfilespec\fR[=\fIdirname\fR] ... +.PP +ctanify +[\fB\-\-help\fR] +.PP +ctanify +[\fB\-\-version\fR] +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +\&\fBctanify\fR is intended for developers who have a L\h'-0.36'\v'-0.15'\s-2A\s+2\v'0.15'\h'-0.15'T\h'-0.1667'\v'0.2'E\v'-0.2'\h'-0.125'X package that +they want to distribute via the Comprehensive T\h'-0.1667'\v'0.2'E\v'-0.2'\h'-0.125'X Archive Network +(\s-1CTAN\s0). Given a list of filenames, \fBctanify\fR creates a tarball (a +\&\fI.tar.gz\fR file) with the files laid out in \s-1CTAN\s0's preferred +structure. The tarball additionally contains a \s-1ZIP\s0 (\fI.zip\fR) file +with copies of all files laid out in the standard T\h'-0.1667'\v'0.2'E\v'-0.2'\h'-0.125'X Directory +Structure (\s-1TDS\s0), which facilitates inclusion of the package in the T\h'-0.1667'\v'0.2'E\v'-0.2'\h'-0.125'X +Live distribution. +.SH "OPTIONS" +.IX Header "OPTIONS" +\&\fBctanify\fR accepts the following command-line options: +.IP "\fB\-h\fR, \fB\-\-help\fR" 5 +.IX Item "-h, --help" +Output basic usage information and exit. +.IP "\fB\-V\fR, \fB\-\-version\fR" 5 +.IX Item "-V, --version" +Output \fBctanify\fR's version number and exit. +.IP "\fB\-p\fR \fIstring\fR, \fB\-\-pkgname\fR=\fIstring\fR" 5 +.IX Item "-p string, --pkgname=string" +Specify explicitly a package name. Normally, \fBctanify\fR uses the base +name of the first \fI.ins\fR or \fI.sty\fR file listed as the package name. +The package name forms the base name of the tarball that \fBctanify\fR +produces. +.IP "\fB\-\-noauto\fR" 5 +.IX Item "--noauto" +Do not automatically add files to the tarball. Normally, \fBctanify\fR +automatically includes all files mentioned in a \fI.ins\fR file. +.IP "\fB\-t\fR \fIfilespec\fR, \fB\-\-tdsonly\fR=\fIfilespec\fR" 5 +.IX Item "-t filespec, --tdsonly=filespec" +Specify a subset of the files named on the command line to include +only in the \s-1TDS\s0 \s-1ZIP\s0 file, not in the \s-1CTAN\s0 package directory. +Wildcards are allowed (quoted if necessary), and \fB\-\-tdsonly\fR can be +used multiple times on the same command line. +.PP +At least one filename must be specified on the command line. +\&\fBctanify\fR automatically places files in the \s-1TDS\s0 tree based on their +extension, but this can be overridden by specifying explicitly a +target \s-1TDS\s0 directory using the form \fIfilespec\fR=\fIdirname\fR. Wildcards +are allowed for the filespec (quoted if necessary). +.SH "ADDITIONAL OPTIONS" +.IX Header "ADDITIONAL OPTIONS" +The following options are unlikely to be necessary in ordinary usage. +They are provided for special circumstances that may arise. +.IP "\fB\-d\fR \fIdirname\fR, \fB\-\-tdsdir\fR=\fIdirname\fR" 5 +.IX Item "-d dirname, --tdsdir=dirname" +Instead of creating a tarball for \s-1CTAN\s0, merely create the package \s-1TDS\s0 +tree rooted in directory \fIdirname\fR. +.IP "\fB\-nou\fR, \fB\-\-no\-unixify\fR" 5 +.IX Item "-nou, --no-unixify" +Store text files unmodified instead of converting their end-of-line +character to Unix format (a single linefeed character with no +carriage-return character), even though \s-1CTAN\s0 prefers receiving all +files with Unix-format end-of-line characters. +.IP "\fB\-nok\fR, \fB\-\-no\-skip\fR" 5 +.IX Item "-nok, --no-skip" +Force \fBctanify\fR to include files such as Unix hidden files, Emacs +backup files, and version-control metadata files, all of which \s-1CTAN\s0 +dislikes receiving. +.IP "\fB\-m\fR, \fB\-\-miscify\fR" 5 +.IX Item "-m, --miscify" +Rename directories containing a single file to \f(CW\*(C`misc\*(C'\fR. (For example, +rename \f(CW\*(C`tex/latex/mypackage/mypackage.sty\*(C'\fR to +\&\f(CW\*(C`tex/latex/misc/mypackage.sty\*(C'\fR.) This was common practice in the +past but is now strongly discouraged. +.SH "DIAGNOSTICS" +.IX Header "DIAGNOSTICS" +.ie n .IP """Failed to copy \f(CIfilename\f(CW (No such file or directory)""" 5 +.el .IP "\f(CWFailed to copy \f(CIfilename\f(CW (No such file or directory)\fR" 5 +.IX Item "Failed to copy filename (No such file or directory)" +This message is typically caused by a \fI.ins\fR file that generates +\&\fIfilename\fR but that has not already been run through \fItex\fR or +\&\fIlatex\fR to actually produce \fIfilename\fR. \fBctanify\fR does not +automatically run \fItex\fR or \fIlatex\fR; this needs to be done manually +by the user. See \*(L"\s-1CAVEATS\s0\*(R" for more information. +.ie n .IP """Modified \f(CIfilename\f(CW to use Unix line endings (use \-\-no\-unixify to prevent this)""" 5 +.el .IP "\f(CWModified \f(CIfilename\f(CW to use Unix line endings (use \-\-no\-unixify to prevent this)\fR" 5 +.IX Item "Modified filename to use Unix line endings (use --no-unixify to prevent this)" +For consistency, \s-1CTAN\s0 stores all text files with Unix-style line +endings (a single linefeed character with no carriage-return +character). To help in this effort, \fBctanify\fR automatically replaces +non-Unix-style line endings. The preceding merely message notifies +the user that he should not be alarmed to see a different size for +\&\fIfilename\fR in the tarball versus the original \fIfilename\fR on disk +(which \fBctanify\fR never modifies). If there's a good reason to +preserve the original line endings (and there rarely is), the +\&\fB\-\-no\-unixify\fR option can be used to prevent \fBctanify\fR from altering +any files when storing them in the tarball. +.ie n .IP """Excluding \f(CIfilename\f(CW (use \-\-no\-skip to force inclusion)""" 5 +.el .IP "\f(CWExcluding \f(CIfilename\f(CW (use \-\-no\-skip to force inclusion)\fR" 5 +.IX Item "Excluding filename (use --no-skip to force inclusion)" +\&\fBctanify\fR normally ignores files\*(--even when specified explicitly on +the command line\*(--that \s-1CTAN\s0 prefers not receiving. These include +files whose names start with "\fI.\fR\*(L" (Unix hidden files), end in \*(R"\fI~\fR" +(Emacs automatic backups), or that come from a \fI\s-1CVS\s0\fR or \fI.svn\fR +directory (version-control metadata files). If there's a good reason +to submit such files to \s-1CTAN\s0 (and there rarely is), the \fB\-\-no\-skip\fR +option can be used to prevent \fBctanify\fR from ignoring them. +.ie n .IP """CTAN prefers having only PDF documentation (re: \f(CIfilename\f(CW)""" 5 +.el .IP "\f(CWCTAN prefers having only PDF documentation (re: \f(CIfilename\f(CW)\fR" 5 +.IX Item "CTAN prefers having only PDF documentation (re: filename)" +Because of the popularity of the \s-1PDF\s0 format, \s-1CTAN\s0 wants to have as +much documentation as possible distributed in \s-1PDF\s0. The preceding +message asks the user to replace any PostScript or \s-1DVI\s0 documentation +with \s-1PDF\s0 if possible. (\fBctanify\fR will still include PostScript and +\&\s-1DVI\s0 documentation in the tarball; the preceding message is merely a +polite request.) +.ie n .IP """Not including \f(CIfilename\f(CW in the TDS tree (unknown extension)""" 5 +.el .IP "\f(CWNot including \f(CIfilename\f(CW in the TDS tree (unknown extension)\fR" 5 +.IX Item "Not including filename in the TDS tree (unknown extension)" +\&\fBctanify\fR places files in the \s-1TDS\s0 tree based on a table of file +extensions. For example, all \fI.sty\fR files are placed in +\&\fItex/latex/\fIpackage-name\fI\fR. If \fBctanify\fR does not know where to +put a file it does not put it anywhere. See the last paragraph of +\&\*(L"\s-1OPTIONS\s0\*(R" for an explanation of how to specify explicitly a file's +target location in the \s-1TDS\s0 tree. For common file extensions that +happen to be absent from \fBctanify\fR's table, consider also notifying +\&\fBctanify\fR's author at the address shown below under \*(L"\s-1AUTHOR\s0\*(R". +.SH "EXAMPLES" +.IX Header "EXAMPLES" +.SS "The Common Case" +.IX Subsection "The Common Case" +Normally, all that's needed is to tell \fBctanify\fR the name of the +\&\fI.ins\fR file (or \fI.sty\fR if the package does not use DocStrip) and the +prebuilt documentation, if any: +.PP +.Vb 1 +\& $ ctanify mypackage.ins mypackage.pdf README +\& +\& 490347 mypackage.tar.gz +\& +\& 1771 mypackage/README +\& 15453 mypackage/mypackage.dtx +\& 1957 mypackage/mypackage.ins +\& 277683 mypackage/mypackage.pdf +\& 246935 mypackage.tds.zip +\& +\& 1771 doc/latex/mypackage/README +\& 277683 doc/latex/mypackage/mypackage.pdf +\& 15453 source/latex/mypackage/mypackage.dtx +\& 1957 source/latex/mypackage/mypackage.ins +\& 1725 tex/latex/mypackage/mypackage.sty +.Ve +.Ve +.PP +\&\fBctanify\fR outputs the size in bytes of the resulting tarball, each +file within it, and each file within the contained \s-1ZIP\s0 file. In the +preceding example, notice how \fBctanify\fR automatically performed all +of the following operations: +.IP "\(bu" 5 +including \fImypackage.dtx\fR (found by parsing \fImypackage.ins\fR) in both +the \fImypackage\fR directory and the \s-1ZIP\s0 file, +.IP "\(bu" 5 +including \fImypackage.sty\fR (found by parsing \fImypackage.ins\fR) in the +\&\s-1ZIP\s0 file but, because it's a generated file, not in the \fImypackage\fR +directory, and +.IP "\(bu" 5 +placing all files into appropriate \s-1TDS\s0 directories (documentation, +source, main package) within the \s-1ZIP\s0 file. +.PP +Consider what it would take to manually produce an equivalent +\&\fImypackage.tar.gz\fR file. \fBctanify\fR is definitely a simpler, quicker +alternative. +.SS "Advanced Usage" +.IX Subsection "Advanced Usage" +\&\fBctanify\fR assumes that PostScript files are documentation and +therefore stores them under \fIdoc/latex/\fIpackage-name\fI/\fR in the \s-1TDS\s0 +tree within the \s-1ZIP\s0 File. Suppose, however, that a L\h'-0.36'\v'-0.15'\s-2A\s+2\v'0.15'\h'-0.15'T\h'-0.1667'\v'0.2'E\v'-0.2'\h'-0.125'X package uses +a set of PostScript files to control \fBdvips\fR's output. In this case, +\&\fBctanify\fR must be told to include those PostScript files in the +package directory, not the documentation directory. +.PP +.Vb 1 +\& $ ctanify mypackage.ins "mypackage*.ps=tex/latex/mypackage" +.Ve +.Ve +.SH "FILES" +.IX Header "FILES" +.IP "\fIperl\fR" 5 +.IX Item "perl" +\&\fBctanify\fR is written in Perl and needs a Perl installation to run. +.IP "\fItar\fR, \fIgzip\fR" 5 +.IX Item "tar, gzip" +\&\fBctanify\fR requires the \s-1GNU\s0 \fItar\fR and \fIgzip\fR programs to create a +compressed tarball (\fI.tar.gz\fR). +.IP "\fIzip\fR" 5 +.IX Item "zip" +\&\fBctanify\fR uses a \fIzip\fR program to archive the \s-1TDS\s0 tree within the +main tarball. +.SH "CAVEATS" +.IX Header "CAVEATS" +\&\fBctanify\fR does not invoke \fItex\fR or \fIlatex\fR on its own, e.g.,\ to +process a \fI.ins\fR file. The reason is that \fBctanify\fR does not know +in the general case how to produce all of a package's generated files. +It was deemed better to do nothing than to risk overwriting existing +\&\fI.sty\fR (or other) files or to include outdated generated files in the +tarball. In short, before running \fBctanify\fR you should manually +process any \fI.ins\fR files and otherwise generate any files that should +be sent to \s-1CTAN\s0. +.PP +\&\fBctanify\fR has been tested only on Linux. It may work on MacOS\ X. +It probably does not work on Windows. Volunteers willing to help port +\&\fBctanify\fR to other platforms are extremely welcome. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fItar\fR\|(1), +\&\fIzip\fR\|(1), +\&\fIlatex\fR\|(1), +Guidelines for uploading TDS-Packaged materials to \s-1CTAN\s0 +(<http://www.ctan.org/TDS\-guidelines.html>), +A Directory Structure for T\h'-0.1667'\v'0.2'E\v'-0.2'\h'-0.125'X Files (<http://tug.org/tds/>), +.SH "AUTHOR" +.IX Header "AUTHOR" +Scott Pakin, \fIscott+ctify@pakin.org\fR +.SH "COPYRIGHT AND LICENSE" +.IX Header "COPYRIGHT AND LICENSE" +Copyright 2009 Scott Pakin +.PP +This work may be distributed and/or modified under the conditions of +the L\h'-0.36'\v'-0.15'\s-2A\s+2\v'0.15'\h'-0.15'T\h'-0.1667'\v'0.2'E\v'-0.2'\h'-0.125'X Project Public License, either version\ 1.3c of this +license or (at your option) any later version. The latest version of +this license is in +.PP +<http://www.latex\-project.org/lppl.txt> +.PP +and version\ 1.3c or later is part of all distributions of L\h'-0.36'\v'-0.15'\s-2A\s+2\v'0.15'\h'-0.15'T\h'-0.1667'\v'0.2'E\v'-0.2'\h'-0.125'X +version 2008/05/04 or later. diff --git a/Master/texmf-dist/doc/man/man1/ctanify.man1.pdf b/Master/texmf-dist/doc/man/man1/ctanify.man1.pdf Binary files differnew file mode 100644 index 00000000000..c2e30e4380d --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ctanify.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/ctie.1 b/Master/texmf-dist/doc/man/man1/ctie.1 new file mode 100644 index 00000000000..2a8e2ee9ea6 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ctie.1 @@ -0,0 +1,59 @@ +.TH CTIE 1 "7 April 2010" "Web2C 2012" +.\"===================================================================== +.SH NAME +ctie \- merge or apply CWEB change files +.\"===================================================================== +.SH SYNOPSIS +.B ctie +.BR \-c | \-m +.I outputfile masterfile +.IR changefile .\|.\|. +.\"===================================================================== +.SH DESCRIPTION +The +.B ctie +program is used to process multiple change files used with the CWEB +system for literate programming. The CWEB programs allow one to apply +patches to a source file (the +.IR masterfile ) +by means of a single change file. +.B ctie +can be used to either merge up to 32 change files into a single one or +to apply the changes to the +.I masterfile +in order to create a new master file. Output of either the new change +file or the patched master file goes into +.IR outputfile . +Any include files (indicated using the CWEB +.B @i +command) are fully expanded during +.B ctie +processing, which means that the change files are able to modify the +contents of any included files. +.SH OPTIONS +.TP +.B \-c +Create a single change file from the given +.IR changefile s. +.TP +.B \-m +Create a new master file by applying the given +.IR changefile s. +.\"===================================================================== +.SH ENVIRONMENT +The environment variable CWEBINPUTS is used to search for the input files, +or the system default if CWEBINPUTS is not set. See +.BR tex (1) +for the details of the searching. +.\"===================================================================== +.SH "SEE ALSO" +.BR cweb (1), +.IR ctiedoc.tex , +.BR tie (1), +.BR web (1). +.\"===================================================================== +.SH "AUTHOR" +Julian Gilbey, jdg@debian.org. The original TIE program was by Klaus +Guntermann, TH Darmstadt, Institut f. Theoretische Informatik. The +TIE man page was by Joachim Schnitter, TH Darmstadt, Phys. Chemie I, +and was modified for CTIE by Julian Gilbey. diff --git a/Master/texmf-dist/doc/man/man1/ctie.man1.pdf b/Master/texmf-dist/doc/man/man1/ctie.man1.pdf Binary files differnew file mode 100644 index 00000000000..836ce5cb085 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ctie.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/ctxtools.1 b/Master/texmf-dist/doc/man/man1/ctxtools.1 new file mode 100644 index 00000000000..c22263d4267 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ctxtools.1 @@ -0,0 +1,89 @@ +.de URL +\\$2 \(laURL: \\$1 \(ra\\$3 +.. +.if \n[.g] .mso www.tmac +.de EX +.in +3 +.nf +.ft CW +.. +.de EE +.in -3 +.ft R +.fi +.. +.TH CTXTOOLS "1" "January 2007" "ctxtools 1.3.3" "ConTeXt" + +.SH NAME +ctxtools \- clean up temporary ConTeXt files, install latest ConTeXt + +.SH "SYNOPSIS" +\fBctxtools\fP [ \fIOPTION\fP ... ] + +.SH DESCRIPTION +\fBctxtools\fP is useful for dealing with ConTeXt source and generated +files and for installing new versions of ConTeXt. + +.SH "OPTIONS" +.TP +.B --help +Print the available options. +.TP +.B --purgefiles +Get rid of many temporary files generated by ConTeXt. You can give the +.B --all +option to remove a larger fraction of those files, +and the +.B --recurse +option to remove these files also in subdirectories. +.TP +.B --contextversion +Show the date of the ConTeXt macros and the format file. Useful after +upgrading ConTeXt (perhaps using \fB--updatecontext\fP) to check +whether the new formats and macros are visible to the TeX path +searches (see +.BR kpsewhich (1). +.TP +.B --updatecontext +Download the latest ConTeXt distribution and install it in the +TEXMFLOCAL tree (see +.BR kpsewhich (1) +for information on +TeX path searching). TEXMFLOCAL usually points to a system-wide +location. If you want to install the new ConTeXt in your home +directory (i.e. an install for one user), then set the TEXMFLOCAL +environment variable while running +.BR ctxtools . +For example, using the syntax of the Bourne shell +.BR sh (1): +.EX +TEXMFLOCAL=$HOME/texmf ctxtools --updatecontext +.EE +.TP +.B --documentation +Generate a \fI.ted\fP file from the source file. See also the +\fB--module\fP option to +.BR texexec (1). +.TP +\fB--patternfiles\fP [languagecode] +Generate pattern files. You can also give the +\fB--all\fP, \fB--xml\fP, and \fB--utf8\fP options. + +.SH "ENVIRONMENT" +.TP +TEXMFLOCAL +Used by \f(CW--updatecontext\fP to decide where to install the distribution. + +.SH "SEE ALSO" +.PP +.BR texexec (1), +.BR texmfstart (1). +.PP +.URL "http://www.contextgarden.net" "ConTeXt wiki" . + +.SH BUGS +This manual page is not complete. + +.SH "AUTHOR" +This manual page was written by Sanjoy Mahajan <sanjoy@mit.edu>. It is in +the public domain. diff --git a/Master/texmf-dist/doc/man/man1/ctxtools.man1.pdf b/Master/texmf-dist/doc/man/man1/ctxtools.man1.pdf Binary files differnew file mode 100644 index 00000000000..b5e180f96c1 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ctxtools.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/cweave.1 b/Master/texmf-dist/doc/man/man1/cweave.1 new file mode 100644 index 00000000000..197f7c83e94 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/cweave.1 @@ -0,0 +1 @@ +.so man1/cweb.1 diff --git a/Master/texmf-dist/doc/man/man1/cweave.man1.pdf b/Master/texmf-dist/doc/man/man1/cweave.man1.pdf Binary files differnew file mode 100644 index 00000000000..174019027a3 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/cweave.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/cweb.1 b/Master/texmf-dist/doc/man/man1/cweb.1 new file mode 100644 index 00000000000..0312568de95 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/cweb.1 @@ -0,0 +1,152 @@ +.TH CWEB 1 "7 April 2010" "Web2C 2012" +.\"===================================================================== +.SH NAME +ctangle, cweave \- translate CWEB to C and/or TeX +.\"===================================================================== +.SH SYNOPSIS +.na +.B ctangle +.RB [ \-bhp ] +.RB [ +s ] +.IR webfile [ \fB.w\fP ] +.RI [{ changefile [ \fB.ch\fP ]| \fB\-\fP } +.RI [ outfile [ \fB.c\fP ]]] +.br +.B cweave +.RB [ \-befhpx ] +.RB [ +s ] +.IR webfile [ \fB.w\fP ] +.RI [{ changefile [ \fB.ch\fP ]| \fB\-\fP } +.RI [ outfile [ \fB.tex\fP ]]] +.ad +.\"===================================================================== +.SH DESCRIPTION +The +.B ctangle +program converts a CWEB +source document into a C\ program that may be compiled in the usual way. +The output file includes #line specifications so that debugging can be +done in terms of the CWEB source file. +.PP +The +.B cweave +program converts the same CWEB file into a TeX file that may be +formatted and printed in the usual way. +It takes appropriate care of typographic details like page +layout and the use of indentation, italics, boldface, etc., and it supplies +extensive cross-index information that it gathers automatically. +.PP +CWEB allows you to prepare a single +document containing all the information that is needed both to produce +a compilable C\ program and to produce a well-formatted document +describing the program in as much detail as the writer may desire. +The user of CWEB ought to be familiar with TeX as well as\ C. +.PP +The command line should have one, two, or three names on it. +The first is taken as the CWEB file (and +.B .w +is added if there is no extension). +If that file cannot be opened, the extension +.B .web +is tried instead. (But +.B .w +is recommended, since +.B .web +usually implies Pascal.) +If there is a second name, it is a change file (and +.B .ch +is added if there is no extension). +The change file overrides parts of the WEB file, +as described in the documentation. +If there is a third name, it overrides +the default name of the output file, which is ordinarily the same as +the name of the input file (but on the current directory) with the +extension +.B .c +or +.BR .tex . +.PP +Options in the command line may be either turned off with\ \- +(if they are on by default) or turned on with\ + (if they are off by +default). +In fact, the options are processed from left to right, +so a sequence like -f\ +f corresponds to +f (which is the default). +.PP +The +.B \-b +option suppresses the banner line that normally appears on your terminal +when ctangle or cweave begins. +The +.B \-h +option suppresses the happy message that normally appears if the processing +was successful. +The +.B \-p +option suppresses progress reports (starred module numbers) as the processing +takes place. +If you say +.BR \-bhp , +you get nothing but error messages. +.PP +The +.B +s +option prints statistics about memory usage at the end of a run +(assuming that the programs have been compiled with the -DSTAT switch). +.PP +There are three other options applicable to +.B cweave +only: +.B \-f +means do not force a newline after every statement in the formatted output. +.B \-e +inhibits the enclosure of C\ material formatted by +.I cweave +in brackets +\ePB{.\|.\|.}. +Such brackets are normally inserted so that special hooks +can be used by +.I cweb-latex +and similar programs. +.B \-x +means omit the index and table of contents. +.\"===================================================================== +.SH ENVIRONMENT +The environment variable CWEBINPUTS is used to search for the input files, +or the system default if CWEBINPUTS is not set. See +.BR tex (1) +for the details of the searching. +.\"===================================================================== +.SH FILES +The location of the files mentioned below varies from system to +system. Use the +.B kpsewhich +utility to find their locations. +.TP +.I cwebmac.tex +TeX macros used by cweave output. +.TP +.I cwebman.tex +The user manual. +.\"===================================================================== +.SH "SEE ALSO" +.TP +.I Literate Programming +by D. E. Knuth. +.TP +.I Weaving a Program +by Wayne Sewell. +.TP +.I The CWEB System of Structured Documentation +by Donald E. Knuth and Silvio Levy (hardcopy version of cwebman.tex +and the source code listings). +.PP +.BR tex (1), +.BR cc (1). +.\"===================================================================== +.SH AUTHORS +Don Knuth wrote WEB for TeX and Pascal. +Silvio Levy designed and developed CWEB +by adapting the WEB conventions to\ C and by recoding everything in CWEB. +Knuth began using CWEB and made further refinements. +Many other helpers are acknowledged in the CWEB manual. + diff --git a/Master/texmf-dist/doc/man/man1/cweb.man1.pdf b/Master/texmf-dist/doc/man/man1/cweb.man1.pdf Binary files differnew file mode 100644 index 00000000000..64fd033c6fd --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/cweb.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/detex.1 b/Master/texmf-dist/doc/man/man1/detex.1 new file mode 100644 index 00000000000..93e71005746 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/detex.1 @@ -0,0 +1,126 @@ +.TH DETEX 1L "12 August 1993" "Purdue University" +.SH NAME +detex \- a filter to strip \fITeX\fP commands from a .tex file. +.SH SYNOPSIS +.B detex +[ \fB\-clnstw\fR ] [ \fB\-e\fI environment-list\fR ] [ \fIfilename\fR[.tex] ... ] +.SH DESCRIPTION +.I Detex +(Version 2.6) +reads each file in sequence, removes all comments and +.I TeX +control sequences +and writes the remainder on the standard output. +All text in math mode and display mode is removed. +By default, +.I detex +follows \\input commands. +If a file cannot be opened, a warning message is +printed and the command is ignored. +If the +.B \-n +option is used, no \\input or \\include commands will be processed. +This allows single file processing. +If no input file is given on the command line, +.I detex +reads from standard input. +.PP +If the magic sequence ``\\begin{document}'' appears in the text, +.I detex +assumes it is dealing with +.I LaTeX +source and +.I detex +recognizes additional constructs used in +.IR LaTeX . +These include the \\include and \\includeonly commands. +The +.B \-l +option can be used to force +.I LaTeX +mode and the +.B \-t +option can be used to force +.I TeX +mode regardless of input content. +.PP +Text in various environment modes of +.I LaTeX +is ignored. The default modes are array, eqnarray, equation, figure, +mathmatica, picture, table and verbatim. The +.B \-e +option can be used to specify a comma separated +.I environment-list +of environments to ignore. The list replaces the defaults so specifying an +empty list effectively causes no environments to be ignored. +.PP +The +.B \-c +option can be used in +.I LaTeX +mode to have detex echo the arguments to \\cite, +\\ref, and \\pageref macros. This can be useful when sending the output to +a style checker. +.PP +.I Detex +assumes the standard character classes are being used for +.IR TeX . +.I Detex +allows white space between control sequences +and magic characters like `{' when recognizing things like +.I LaTeX +environments. +.PP +If the +.B \-w +flag is given, the output is a word list, one `word' (string of two or more +letters and apostrophes beginning with a letter) +per line, and all other characters ignored. +Without \fB\-w\fR the output follows the original, +with the deletions mentioned above. Newline characters are +preserved where possible +so that the lines of output match the input as closely as possible. +.PP +The TEXINPUTS environment variable is used to find \\input and \\include +files. Like \fITeX\fP, it interprets a leading or trailing `:' as the default +TEXINPUTS. It does \fInot\fP support the `//' directory expansion magic sequence. +.PP +Detex now handles the basic \fITeX\fP ligatures as a special case, replacing the +ligatures with acceptable charater substitutes. This eliminates +spelling errors introduced by merely removing them. The ligatures are +\\aa, \\ae, \\oe, \\ss, \\o, \\l (and their upper-case +equivalents). The special "dotless" characters \\i and \\j are also +replaced with i and j respectively. +.PP +Note that previous versions of +.I detex +would replace control sequences with a space character to prevent words +from running together. +However, this caused accents in the middle of words to break words, generating +"spelling errors" that were not desirable. +Therefore, the new version merely removes these accents. +The old functionality can be essentially duplicated by using the +.B \-s +option. +.SH SEE ALSO +tex(1L) +.SH DIAGNOSTICS +Nesting of \\input is allowed but the number of opened files must not +exceed the system's limit on the number of simultaneously opened files. +.I Detex +ignores unrecognized option characters after printing a warning message. +.SH AUTHOR +Daniel Trinkle, Computer Science Department, Purdue University +.SH BUGS +.I Detex +is not a complete +.I TeX +interpreter, so it can be confused by some constructs. +Most errors result in too much rather than too little output. +.PP +Running \fILaTeX\fR +source without a ``\\begin{document}'' +through \fIdetex\fR may produce +errors. +.PP +Suggestions for improvements are (mildly) encouraged. diff --git a/Master/texmf-dist/doc/man/man1/detex.man1.pdf b/Master/texmf-dist/doc/man/man1/detex.man1.pdf Binary files differnew file mode 100644 index 00000000000..b0c7174acc4 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/detex.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/deweb.1 b/Master/texmf-dist/doc/man/man1/deweb.1 new file mode 100644 index 00000000000..43770aa1fd3 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/deweb.1 @@ -0,0 +1,116 @@ +.TH deweb 1 "June 8, 1996" +.AT 3 +.SH NAME +deweb \- strips away C & CWEB commands from CWEB sources +.SH SYNOPSIS +.B deweb +[ +.B file1 file2 ... +] +.SH DESCRIPTION +.I deweb +filters away all C & CWEB commands from a CWEB source code. This +leaves only the +.I LaTeX +code. This stripped code, in turn, may then +be passed to a suitable syntax checker for LaTeX, like +.I ChkTeX +and +.I lacheck, +or spell-checkers like +.I ispell. +.PP +The +.I chkweb +tool, included in the +.I ChkTeX +distribution will do just this; writing similar scripts should be +trivial. +.PP +When +.I deweb +strips away the C code from your CWEB source, it tries to preserve line breaks. +This means that the error reports from +.I <your favorite tool> +will be correct regarding to line numbers. In most cases, +the column position +will also be correct. This significantly simplifies +finding the errors in the +.I LaTeX +source (in contrast to the output from +.I cweave, +which output is truly difficult to figure anything out from). +.PP +.I deweb +accepts a list of filenames on the argument line, and will send its output +to +.I stdout. +If no filenames are given, it will read from stdin, acting as +a filter. No options are currently accepted. +.PP +Macho users may try to pipe the output from +.I deweb +directly into +.I LaTeX, +theoretically, this should work. This would ease the debugging +of the +.I LaTeX +code significantly, as when +.I LaTeX +complains about wrong syntax, you'll be able to find the erroneous +line much more easily. Don't expect that the output looks very much +like the final one, though. +.PP +.I deweb +should now understand all correct +.I CWEB +opcodes. If it complains about not understanding a correct opcode, +please inform the author. +.SH DISTRIBUTION +Copyright (C) 1996 Jens T. Berger Thielemann +.PP +This program is free software; you can redistribute it and/or modify +it under the terms of the +.I GNU General Public License +as published by +the Free Software Foundation; either version 2 of the License, or +(at your option) any later version. +.PP +This program is distributed in the hope that it will be useful, +but +.B WITHOUT ANY WARRANTY; +without even the implied warranty of +.B MERCHANTABILITY +or +.B FITNESS FOR A PARTICULAR PURPOSE. +See the +.I GNU General Public License +for more details. +.PP +You should have received a copy of the +.B GNU General Public License +along with this program; if not, write to the +.I Free Software Foundation, Inc., +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. +.SH ENVIRONMENT +No environment variables are used. +.SH FILES +None. +.SH AUTHOR +Jens T. Berger Thielemann, +.I <jensthi@ifi.uio.no> +.SH "SEE ALSO" +.B cweave(1), perl(1), chktex, lacheck(1), ispell(1) +.SH BUGS +Doesn't even +.B compile +under +.I Perl +versions before perl v5. Unfortunately, this means that we can't even +tell the user why we failed; +.I Perl +will just complain about not being able to compile the regexps. +.PP +The program will try to swallow the whole input file at once, instead of +processing it on a line\-by\-line basis. +.ex diff --git a/Master/texmf-dist/doc/man/man1/deweb.man1.pdf b/Master/texmf-dist/doc/man/man1/deweb.man1.pdf Binary files differnew file mode 100644 index 00000000000..448092cac02 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/deweb.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/disdvi.1 b/Master/texmf-dist/doc/man/man1/disdvi.1 new file mode 100644 index 00000000000..e59ce5ce46b --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/disdvi.1 @@ -0,0 +1,27 @@ +.TH DISDVI 1 "27 October 2010" +.SH NAME +disdvi \- `disassemble' a (p)TeX or XeTeX DVI file +.SH SYNOPSIS +.B disdvi +.RB [ \-p ] +.RI [ dvi_file [ \fB.dvi\fP ]] +.br +.B disdvi \-x +.RI [ xdv_file [ \fB.xdv\fP ]] +.br +.B disdvi \-h +.SH DESCRIPTION +.I disdvi +interprets the contents of +.IR dvi_file +or +.IR xdv_file +printing the DVI commands and text in a human-readable ASCII format on +the standard output. +.SH "SEE ALSO" +.BR dvi2tty (1) +.SH AUTHOR +Marcel J.E. Mol, Delft University of Technology, The Netherlands +.br +marcel@mesa.nl, MESA Consulting + diff --git a/Master/texmf-dist/doc/man/man1/disdvi.man1.pdf b/Master/texmf-dist/doc/man/man1/disdvi.man1.pdf Binary files differnew file mode 100644 index 00000000000..c0b4da7e2e9 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/disdvi.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/dosepsbin.1 b/Master/texmf-dist/doc/man/man1/dosepsbin.1 new file mode 100644 index 00000000000..6f2fa66b2b1 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dosepsbin.1 @@ -0,0 +1,275 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.13 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "DOSEPSBIN 1" +.TH DOSEPSBIN 1 "2012-03-22 v1.2" "perl v5.8.1" "User Contributed Perl Documentation" +.SH "NAME" +dosepsbin \-\- Extract PS/WMF/TIFF sections from DOS EPS binary files +.SH "VERSION" +.IX Header "VERSION" +2012\-03\-22 v1.2 +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +The progam \fBdosepsbin\fR analyses an \s-1EPS\s0 file that is not +a plain \s-1ASCII\s0 PostScript file but given as \s-1DOS\s0 \s-1EPS\s0 binary file. +.PP +.Vb 1 +\& dosepsbin [options] <input file> +.Ve +.PP +First it analyzes the \fIinput file\fR, validates its header +and summarizes the available sections. Depending on the +given options, the sections are then written to files. +.PP +Options: +.PP +.Vb 9 +\& --eps-file <file> Write PS section to <file>. +\& --wmf-file <file> Write WMF section to <file>. +\& --tiff-file <file> Write TIFF section to <file>. +\& --inputfile <file> The name of the input file. +\& --verbose Verbose output. +\& --quiet Only errors and warnings are printed. +\& --help Brief help message. +\& --man Full documentation. +\& --version Print version identification. +.Ve +.PP +The files for output must be different from the input file. +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +.Sh "\s-1DOS\s0 \s-1EPS\s0 Binary File Format" +.IX Subsection "DOS EPS Binary File Format" +A Encapsulated PostScript (\s-1EPS\s0) file can also given in a special +binary format to support the inclusion of a thumbnail. The file +format starts with a binary header that contains the positions of +the possible sections: +.IP "* Postscript (\s-1PS\s0)" 4 +.IX Item "Postscript (PS)" +.PD 0 +.IP "* Windows Metafile Format (\s-1WMF\s0)" 4 +.IX Item "Windows Metafile Format (WMF)" +.IP "* Tag Image File Format (\s-1TIFF\s0)" 4 +.IX Item "Tag Image File Format (TIFF)" +.PD +.PP +The \s-1PS\s0 section must be present and either the \s-1WMF\s0 file or the \s-1TIFF\s0 +file should be given. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-\fR\fB\-eps\-file\fR=<\fIfile\fR>" 4 +.IX Item "--eps-file=<file>" +The \s-1PS\s0 section is written to <\fIfile\fR>. The output file must +be different from the input file. +.IP "\fB\-\fR\fB\-wmf\-file\fR=<\fIfile\fR>" 4 +.IX Item "--wmf-file=<file>" +The \s-1WMF\s0 section is written to <\fIfile\fR> if present. The output +file must be different from the input file. +.IP "\fB\-\fR\fB\-tiff\-file\fR=<\fIfile\fR>" 4 +.IX Item "--tiff-file=<file>" +The \s-1TIFF\s0 section is written to <\fIfile\fR> if present. The output +file must be different from the input file. +.IP "\fB\-\fR\fB\-inputfile\fR=<\fIfile\fR>" 4 +.IX Item "--inputfile=<file>" +The input file can also be given directly on the command line. +If the file does not exist, then the file with extension `.eps' +is tried. +.IP "\fB\-\fR\fB\-verbose\fR" 4 +.IX Item "--verbose" +Verbose messages. +.IP "\fB\-\fR\fB\-quiet\fR" 4 +.IX Item "--quiet" +No messages are printed except for errors and warnings. +.IP "\fB\-\fR\fB\-help\fR" 4 +.IX Item "--help" +Display help screen. +.IP "\fB\-\fR\fB\-man\fR" 4 +.IX Item "--man" +Prints manual page. +.IP "\fB\-\fR\fB\-version\fR" 4 +.IX Item "--version" +Print version identification and exit. +.SH "EXAMPLES" +.IX Header "EXAMPLES" +The following command extracts the \s-1PS\s0 section from file \fItest.eps\fR +and stores the result in file \fItest\-ps.eps\fR: +.PP +.Vb 1 +\& dosepsbin --eps-file test-ps.eps test.eps +.Ve +.SH "AUTHOR" +.IX Header "AUTHOR" +Heiko Oberdiek, email: heiko.oberdiek at googlemail.com +.SH "COPYRIGHT AND LICENSE" +.IX Header "COPYRIGHT AND LICENSE" +Copyright 2011\-2012 by Heiko Oberdiek. +.PP +This library is free software; you may redistribute it and/or +modify it under the same terms as Perl itself +(Perl Artistic License/GNU General Public License, version 2). +.SH "SEE ALSO" +.IX Header "SEE ALSO" +The \s-1DOS\s0 \s-1EPS\s0 binary file format is described +in section \*(L"5.2 Windows Metafile or \s-1TIFF\s0\*(R": +.PP +.Vb 5 +\& Adobe Developer Support, +\& Encapsulated PostScript File Format Specification, +\& Version 3.0, +\& 1992-05-01, +\& http://partners.adobe.com/public/developer/en/ps/5002.EPSF_Spec.pdf +.Ve +.SH "HISTORY" +.IX Header "HISTORY" +.IP "\fB2011/11/10 v1.0\fR" 2 +.IX Item "2011/11/10 v1.0" +.RS 2 +.PD 0 +.IP "* First version." 2 +.IX Item "First version." +.RE +.RS 2 +.RE +.IP "\fB2011/12/05 v1.1\fR" 2 +.IX Item "2011/12/05 v1.1" +.RS 2 +.IP "* Typo fixed in help text (thanks Peter Breitenlohner)." 2 +.IX Item "Typo fixed in help text (thanks Peter Breitenlohner)." +.RE +.RS 2 +.RE +.IP "\fB2012/03/22 v1.2\fR" 2 +.IX Item "2012/03/22 v1.2" +.RS 2 +.IP "* Fix in validation test for offset of \s-1PS\s0 section." 2 +.IX Item "Fix in validation test for offset of PS section." +.RE +.RS 2 +.RE diff --git a/Master/texmf-dist/doc/man/man1/dosepsbin.man1.pdf b/Master/texmf-dist/doc/man/man1/dosepsbin.man1.pdf Binary files differnew file mode 100644 index 00000000000..ebbd02f8166 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dosepsbin.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/dt2dv.1 b/Master/texmf-dist/doc/man/man1/dt2dv.1 new file mode 100644 index 00000000000..26783c9ecc8 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dt2dv.1 @@ -0,0 +1,160 @@ +.\" This file is public domain. +.\" Originally written 1995, Geoffrey Tobin. +.\" The author has expressed the hope that any modification will retain enough content to remain useful. He would also appreciate being acknowledged as the original author in the documentation. +.\" This declaration added 2008/11/14 by Clea F. Rees with the permission of Geoffrey Tobin. +.\" ==================================================================== +.\" @Troff-man-file{ +.\" author = "Nelson H. F. Beebe and Geoffrey R. D. Tobin", +.\" version = "0.6.0", +.\" date = "08 March 1995", +.\" time = "19:57:00 GMT +11", +.\" filename = "dt2dv.man", +.\" address = "Center for Scientific Computing +.\" Department of Mathematics +.\" University of Utah +.\" Salt Lake City, UT 84112 +.\" USA", +.\" telephone = "+1 801 581 5254", +.\" FAX = "+1 801 581 4148", +.\" checksum = "03708 156 634 4989", +.\" email = "beebe@math.utah.edu (Internet)", +.\" codetable = "ISO/ASCII", +.\" keywords = "DVI, TeX", +.\" supported = "no", +.\" docstring = "This file contains the UNIX manual pages +.\" for the dt2dv utility, a program for +.\" converting a DTL text representation of a TeX +.\" DVI file, usually produced by the companion +.\" dv2dt utility, back to a binary DVI file. +.\" +.\" The checksum field above contains a CRC-16 +.\" checksum as the first value, followed by the +.\" equivalent of the standard UNIX wc (word +.\" count) utility output of lines, words, and +.\" characters. This is produced by Robert +.\" Solovay's checksum utility.", +.\" } +.\" ==================================================================== +.if t .ds Te T\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X +.if n .ds Te TeX +.TH DT2DV 1 "08 March 1995" "Version 0.6.0" +.\"====================================================================== +.SH NAME +dt2dv \- convert a DTL text representation of a TeX DVI file to a binary DVI file +.\"====================================================================== +.SH SYNOPSIS +.B dt2dv +.RB [ \-debug ] +.RB [ \-group ] +.RB [ \-si ] +.RB [ \-so ] +.I [input-DTL-file] +.I [output-DVI-file] +.PP +In the absence of the +.B \-si +and +.B \-so +options, +both file arguments are +.IR required +in the order +.B input-DTL-file output-DVI-file . +But also see the OPTIONS section below. +No default file extensions are supplied. +.\"====================================================================== +.SH DESCRIPTION +.B dt2dv +converts a text representation of a \*(Te\& DVI +file, usually produced by the companion +.BR dv2dt (1) +utility, back to a binary DVI file. DTL +.RI ( "DVI Text Language" ) +files can be edited, with care, and then restored +to DVI form for processing by any \*(Te\& DVI +driver program. In DTL files, font directory names +and font names are preceded by a length field, +which must be updated if the names are modified. +.PP +.BR dvitype (1) +can also display a textual representation of DVI +files, but in some implementations at least, it +cannot be used in batch mode, and its output is +not well-suited for conversion back to a DVI file. +.PP +The format of \*(Te\& DVI files is fully described +in +Donald E. Knuth, +.IR "\*(Te\&: The Program" , +Addison-Wesley (1986), ISBN 0-201-13437-3, as well +as in the +.BR dvitype (1) +literate program source code. Brief descriptions +of the DTL and DVI formats are given in +.BR dv2dt (1). +.\"====================================================================== +.SH OPTIONS +.\"----------------------------------------------- +.TP \w'\-debug'u+3n +.B \-debug +Turn on detailed debugging output. +.\"----------------------------------------------- +.TP +.B \-group +Expect each DTL command to be in parentheses. +.\"----------------------------------------------- +.TP +.B \-si +Read all DTL commands from standard input. +.\"----------------------------------------------- +.TP +.B \-so +Write all DVI commands to standard output. +.\"====================================================================== +.SH "SEE ALSO" +.BR dv2dt (1), +.BR dvitype (1), +.BR tex (1). +.\"====================================================================== +.SH FILES +.TP \w'\fI*.dvi\fP'u+3n +.I *.dvi +binary \*(Te\& DVI file. +.TP +.I *.dtl +text representation of a \*(Te\& DVI file in +.I "DVI Text Language" +format. +.\"====================================================================== +.SH AUTHOR +.B dt2dv +and +.BR dv2dt (1) +were written by +.RS +.nf +Geoffrey Tobin +Department of Electronic Engineering +La Trobe University +Bundoora, Victoria 3083 +Australia +Tel: +61 3 479 3736 +FAX: +61 3 479 3025 +Email: <G.Tobin@ee.latrobe.edu.au> +.fi +.RE +.PP +These manual pages were written primarily by +.RS +.nf +Nelson H. F. Beebe, Ph.D. +Center for Scientific Computing +Department of Mathematics +University of Utah +Salt Lake City, UT 84112 +Tel: +1 801 581 5254 +FAX: +1 801 581 4148 +Email: <beebe@math.utah.edu> +.fi +.RE +.\"==============================[The End]============================== diff --git a/Master/texmf-dist/doc/man/man1/dt2dv.man1.pdf b/Master/texmf-dist/doc/man/man1/dt2dv.man1.pdf Binary files differnew file mode 100644 index 00000000000..3d820816096 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dt2dv.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/dv2dt.1 b/Master/texmf-dist/doc/man/man1/dv2dt.1 new file mode 100644 index 00000000000..9b5b40a02f3 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dv2dt.1 @@ -0,0 +1,719 @@ +.\" This file is public domain. +.\" Originally written 1995, Geoffrey Tobin. +.\" The author has expressed the hope that any modification will retain enough content to remain useful. He would also appreciate being acknowledged as the original author in the documentation. +.\" This declaration added 2008/11/14 by Clea F. Rees with the permission of Geoffrey Tobin. +.\" ==================================================================== +.\" @Troff-man-file{ +.\" author = "Nelson H. F. Beebe and Geoffrey Tobin", +.\" version = "0.6.0", +.\" date = "08 March 1995", +.\" time = "19:52:00 GMT +11", +.\" filename = "dv2dt.man", +.\" address = "Center for Scientific Computing +.\" Department of Mathematics +.\" University of Utah +.\" Salt Lake City, UT 84112 +.\" USA", +.\" telephone = "+1 801 581 5254", +.\" FAX = "+1 801 581 4148", +.\" checksum = "32328 715 2191 12898", +.\" email = "beebe@math.utah.edu (Internet)", +.\" codetable = "ISO/ASCII", +.\" keywords = "DVI, TeX", +.\" supported = "no", +.\" docstring = "This file contains the UNIX manual pages +.\" for the dv2dt utility, a program for +.\" converting a binary TeX DVI file to an +.\" editable text representation in DTL (DVI Text +.\" Language). The companion dt2dv utility can +.\" convert the output DTL file back to a binary +.\" DVI file. +.\" +.\" The checksum field above contains a CRC-16 +.\" checksum as the first value, followed by the +.\" equivalent of the standard UNIX wc (word +.\" count) utility output of lines, words, and +.\" characters. This is produced by Robert +.\" Solovay's checksum utility.", +.\" } +.\" ==================================================================== +.if t .ds Te T\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X +.if n .ds Te TeX +.if t .ds Xe X\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'T +.if n .ds Xe XeT +.TH DV2DT 1 "08 March 1995" "Version 0.6.0" +.\"====================================================================== +.SH NAME +dv2dt \- convert a binary TeX DVI file to DTL text representation +.\"====================================================================== +.SH SYNOPSIS +.B dv2dt +.I input-DVI-file +.I output-DTL-file +.PP +If the filenames are omitted, then +.I stdin +and +.I stdout +are assumed. +.\"====================================================================== +.SH DESCRIPTION +.B dv2dt +converts a binary \*(Te\& DVI file to an editable +text file in DTL +.RI ( "DVI Text Language" ) +format. The companion +.BR dt2dv (1) +utility can convert the DTL file back to a binary +DVI file. +.\"====================================================================== +.SH "DVI COMMAND DESCRIPTION" +\*(Te\& DVI files contain a compact binary +description of typeset pages, as a stream of +operation code bytes, each immediately followed by +zero or more parameter bytes. The format of DVI +files is fully described in Donald E. Knuth, +.IR "\*(Te\&: The Program" , +Addison-Wesley (1986), ISBN 0-201-13437-3, as well +as in the +.BR dvitype (1) +literate program source code. +.PP +For convenience, we provide a summary of DVI +commands here. In the following list, operation +code bytes are given as unsigned decimal values, +followed by their symbolic names (not present in +the DVI file), and a short description. A +designation like +.I b[+n] +means that the operation code byte is followed by +a parameter +.I b +which uses +.I n +bytes, and is signed. Without the plus sign, the +parameter is unsigned. Signed integer parameter +values are always represented in two's complement +arithmetic, which is the system followed by most +computers manufactured today, including all +personal computers and workstations. +.if n .TP \w'\fI128_set1__c[1]\fP'u+3n +.if t .TP \w'\fI243_fnt_def1__k[1]_c[4]_s[4]_d[4]_a[1]_l[1]_n[a+l]\fP'u+3n +.I "0 set_char_0" +Set character 0 from current font. +.TP +.I .\|.\|. +.TP +.I "127 set_char_127" +Set character 127 from current font. +.TP +.I "128 set1 c[1]" +Set 1-byte unsigned character (uchar) number +.IR c . +.TP +.I "129 set2 c[2]" +Set 2-byte uchar number +.IR c . +.TP +.I "130 set3 c[3]" +Set 3-byte uchar number +.IR c . +.TP +.I "131 set4 c[+4]" +Set 4-byte signed character (schar) number +.IR c . +.TP +.I "132 set_rule a[+4] b[+4]" +Set rule, height +.IR a , +width +.IR b . +.TP +.I "133 put1 c[1]" +Put 1-byte uchar +.IR c . +.TP +.I "134 put2 c[2]" +Put 2-byte uchar +.IR c . +.TP +.I "135 put3 c[3]" +Put 3-byte uchar +.IR c . +.TP +.I "136 put4 c[+4]" +Put 4-byte schar +.IR c . +.TP +.I "137 put_rule a[+4] b[+4]" +Put rule, height +.IR a , +width +.IR b . +.TP +.I "138 nop" +Do nothing. +.TP +.I "139 bop c0[+4] .\|.\|. c9[+4] p[+4]" +Beginning of page. The parameters +.I "c0 .\|.\|. c9" +are the \*(Te\& page counters, the contents of +\*(Te\& count registers +.IR "\ecount0 .\|.\|. \ecount9" . +The parameter +.I p +is the byte offset from the beginning of the DVI +file of the previous +.I bop +operation code byte. The first such command in +the file has +.IR "p = \-1" . +.TP +.I "140 eop" +End of page. +.TP +.I "141 push" +Push +.RI ( h,v,w,x,y,z ) +onto stack. +.TP +.I "142 pop" +Pop +.RI ( h,v,w,x,y,z ) +from stack. +.TP +.I "143 right1 b[+1]" +Move right +.I b +units. +.TP +.I "144 right2 b[+2]" +Move right +.I b +units. +.TP +.I "145 right3 b[+3]" +Move right +.I b +units. +.TP +.I "146 right4 b[+4]" +Move right +.I b +units. +.TP +.I "147 w0" +Move right +.I w +units. +.TP +.I "148 w1 b[+1]" +Move right +.I b +units, and set +.IR "w = b" . +.TP +.I "149 w2 b[+2]" +Move right +.I b +units, and set +.IR "w = b" . +.TP +.I "150 w3 b[+3]" +Move right +.I b +units, and set +.IR "w = b" . +.TP +.I "151 w4 b[+4]" +Move right +.I b +units, and set +.IR "w = b" . +.TP +.I "152 x0" +Move right +.I x +units. +.TP +.I "153 x1 b[+1]" +Move right +.I b +units, and set +.IR "x = b" . +.TP +.I "154 x2 b[+2]" +Move right +.I b +units, and set +.IR "x = b" . +.TP +.I "155 x3 b[+3]" +Move right +.I b +units, and set +.IR "x = b" . +.TP +.I "156 x4 b[+4]" +Move right +.I b +units, and set +.IR "x = b" . +.TP +.I "157 down1 a[+1]" +Move down +.I a +units. +.TP +.I "158 down2 a[+2]" +Move down +.I a +units. +.TP +.I "159 down3 a[+3]" +Move down +.I a +units. +.TP +.I "160 down4 a[+4]" +Move down +.I a +units. +.TP +.I "161 y0" +Move right +.I y +units. +.TP +.I "162 y1 a[+1]" +Move right +.I a +units, and set +.IR "y = a" . +.TP +.I "163 y2 a[+2]" +Move right +.I a +units, and set +.IR "y = a" . +.TP +.I "164 y3 a[+3]" +Move right +.I a +units, and set +.IR "y = a" . +.TP +.I "165 y4 a[+4]" +Move right +.I a +units, and set +.IR "y = a" . +.TP +.I "166 z0" +Move right +.I z +units. +.TP +.I "167 z1 a[+1]" +Move right +.I a +units, and set +.IR "z = a" . +.TP +.I "168 z2 a[+2]" +Move right +.I a +units, and set +.IR "z = a" . +.TP +.I "169 z3 a[+3]" +Move right +.I a +units, and set +.IR "z = a" . +.TP +.I "170 z4 a[+4]" +Move right +.I a +units, and set +.IR "z = a" . +.TP +.I "171 fnt_num_0" +Set current font number +.IR "(f) = 0" . +.TP +.I .\|.\|. +.TP +.I "234 fnt_num_63" +Set +.IR "f = 63" . +.TP +.I "235 fnt1 k[1]" +Set +.IR "f = k" . +.TP +.I "236 fnt2 k[2]" +Set +.IR "f = k" . +.TP +.I "237 fnt3 k[3]" +Set +.IR "f = k" . +.TP +.I "238 fnt4 k[+4]" +Set +.IR "f = k" . +.TP +.I "239 xxx1 k[1] x[k]" +Special string +.I x +with +.I k +bytes. +.TP +.I "240 xxx2 k[2] x[k]" +Special string +.I x +with +.I k +bytes. +.TP +.I "241 xxx3 k[3] x[k]" +Special string +.I x +with +.I k +bytes. +.TP +.I "242 xxx4 k[4] x[k]" +Special string +.I x +with (unsigned) +.I k +bytes. +.TP +.I "243 fnt_def1 k[1] c[4] s[4] d[4] a[1] l[1] n[a+l]" +Define font +.IR k . +The parameters are: +.RS +.TP \w'\fIm\fP'u+3n +.I c +Checksum for TFM file. +.TP +.I s +Scale factor, in DVI units. +.TP +.I d +Design size, in DVI units. +.TP +.I a +Length of the ``area'' or directory. +.TP +.I l +Length of the font name. +.TP +.I n +Area and font name string(s). +.RE +.TP +.I "244 fnt_def2 k[2] c[4] s[4] d[4] a[1] l[1] n[a+l]" +Define font +.IR k . +.TP +.I "245 fnt_def3 k[3] c[4] s[4] d[4] a[1] l[1] n[a+l]" +Define font +.IR k . +.TP +.I "246 fnt_def4 k[+4] c[4] s[4] d[4] a[1] l[1] n[a+l]" +Define font +.IR k . +.TP +.I "247 pre i[1] num[4] den[4] mag[4] k[1] x[k]" +Begin preamble. The parameters are: +.RS +.TP \w'\fInum\fP'u+3n +.I i +DVI format. Standard \*(Te\& has +.IR "ID = 2" , +and \*(Te\&-\*(Xe\& has +.IR "ID = 3" . +.TP +.I num +Numerator of 100 nm / DVI unit. +.TP +.I den +Denominator of 100 nm / DVI unit. +.TP +.I mag +1000 * magnification. +.TP +.I k +Comment length. +.TP +.I x +Comment string. +.RE +.TP +.I "248 post p[4] num[4] den[4] mag[4] l[4] u[4] s[2] t[2]" +Begin postamble. The parameters are: +.RS +.TP \w'\fInum\fP'u+3n +.I p +Pointer to final bop. +.TP +.I "num, den, mag" +Duplicates of values in preamble. +.TP +.I l +Height-plus-depth of tallest page, in DVI units. +.TP +.I u +Width of widest page, in DVI units. +.TP +.I s +Maximum stack depth needed to process this DVI file. +.TP +.I t +Total number of pages +.RI ( bop +commands) present. +.RE +.TP +.I "249 post_post q[4] i[1] 223 .\|.\|. 223" +End postamble. The parameters are: +.RS +.TP \w'\fI223\fP'u+3n +.I q +Byte offset from the beginning of the DVI file to +the +.I post +command that started the postamble. +.TP +.I i +DVI format ID, as in the preamble. +.TP +.I +223 +At least four +.I 223 +bytes. +.RE +.TP +.I "250" +Undefined. +.TP +.I .\|.\|. +.TP +.I "255" +Undefined. +.\"====================================================================== +.SH "DTL COMMAND DESCRIPTION" +A DTL file contains one line per command, with a +limit of 1024 characters per line. Each command +contains a symbolic operation name, followed by +zero or more parameter values. The parameter +value descriptions are not repeated here; they can +be found in the previous section. +.TP \w'\fIw0,_w1,_w2,_w3,_w4\fP'u+3n +variety <variety-name> +This command specifies the name of the DTL file +type; it has no DVI file equivalent. +.TP +.I (text) +Series of set_char commands, for printable ASCII text. +.TP +.I \e( +Literal ASCII left parenthesis in (text). +.TP +.I \e) +Literal ASCII right parenthesis in (text). +.TP +.I \e\e +Literal ASCII backslash in (text). +.TP +.I \e" +Literal ASCII double quote in (text). +.TP +.I \eXY +Set_char for character with hexadecimal code XY, +not in parentheses, but by itself for readability. +.TP +.I "s1, s2, s2, s3" +Set, with (1,2,3,4)-byte charcodes. +.TP +.I sr +.IR set_rule . +.TP +.I "p1, p2, p2, p3" +Put, with (1,2,3,4)-byte charcodes. +.TP +.I pr +.IR put_rule . +.TP +.I nop +.I nop +(do nothing). +.TP +.I bop +.I bop +(beginning of page). +.TP +.I eop +.I eop +(end of page). +.TP +.I [ +Push. +.TP +.I ] +Pop. +.TP +.I "r1, r2, r3, r4" +Right, with (1,2,3,4)-byte argument. +.TP +.I "w0, w1, w2, w3, w4" +As in DVI. +.TP +.I "x0, x1, x2, x3, x4" +As in DVI. +.TP +.I "d1, d2, d3, d4" +Down, with (1,2,3,4)-byte argument. +.TP +.I "y0, y1, y2, y3, y4" +As in DVI. +.TP +.I "z0, z1, z2, z3, z4" +As in DVI. +.TP +.I fn +.I fnt_num +(set current font to font number in 0 to 63). +.TP +.I "f1, f2, f3, f4" +.I fnt +(set current font to (1,2,3,4)-byte font number). +.TP +.I special +.I xxx +(special commands with (1,2,3,4)-byte string length). +.TP +.I fd +.I fnt_def +(assign a number to a named font). +.TP +.I pre +Preamble. +.TP +.I post +.I post +(begin postamble). +.TP +.I post_post +.I post_post +(end postamble). +.TP +.I opcode +Undefined DVI command (250 to 255). +.\"====================================================================== +.SH "SAMPLE DTL FILE" +The following 2-line \*(Te\& file +.RS +.nf +Hello. +\ebye +.fi +.RE +when processed with the commands +.RS +.nf +tex hello.tex +dv2dt hello.dvi hello.dtl +.fi +.RE +produces this DTL file: +.RS +.nf +variety sequences-6 +pre 2 25400000 473628672 1000 27 ' TeX output 1995.03.02:2334' +bop 1 0 0 0 0 0 0 0 0 0 -1 +[ +d3 -917504 +] +d4 42152922 +[ +d4 -41497562 +[ +r3 1310720 +fd1 0 11374260171 655360 655360 0 5 '' 'cmr10' +fn0 +(Hello.) +] +] +d3 1572864 +[ +r4 15229091 +(1) +] +eop +post 42 25400000 473628672 1000 43725786 30785863 2 1 +fd1 0 11374260171 655360 655360 0 5 'cmr10' +post_post 152 2 223 223 223 223 +.fi +.RE +The command +.RS +.nf +dt2dv hello.dtl hello.dvi +.fi +.RE +will reconstruct the original DVI file. +.\"====================================================================== +.SH "SEE ALSO" +.BR dt2dv (1), +.BR dvitype (1), +.BR tex (1). +.\"====================================================================== +.SH FILES +.TP \w'\fI*.dvi\fP'u+3n +.I *.dvi +binary \*(Te\& DVI file. +.TP +.I *.dtl +text representation of a \*(Te\& DVI file in +.I "DVI Text Language" +format. +.\"====================================================================== +.SH AUTHOR +.B dv2dt +and +.BR dt2dv (1) +were written by +.RS +.nf +Geoffrey Tobin +Department of Electronic Engineering +La Trobe University +Bundoora, Victoria 3083 +Australia +Tel: +61 3 479 3736 +FAX: +61 3 479 3025 +Email: <G.Tobin@ee.latrobe.edu.au> +.fi +.RE +.PP +These manual pages were primarily written by +.RS +.nf +Nelson H. F. Beebe, Ph.D. +Center for Scientific Computing +Department of Mathematics +University of Utah +Salt Lake City, UT 84112 +Tel: +1 801 581 5254 +FAX: +1 801 581 4148 +Email: <beebe@math.utah.edu> +.fi +.RE +.\"==============================[The End]============================== diff --git a/Master/texmf-dist/doc/man/man1/dv2dt.man1.pdf b/Master/texmf-dist/doc/man/man1/dv2dt.man1.pdf Binary files differnew file mode 100644 index 00000000000..4d350f4fba9 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dv2dt.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/dvi2fax.1 b/Master/texmf-dist/doc/man/man1/dvi2fax.1 new file mode 100644 index 00000000000..f7c436d6e33 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvi2fax.1 @@ -0,0 +1,22 @@ +.TH DVI2FAX 1 "October 30, 1999" +.\" man page by Jim Van Zandt <jrv@vanzandt.mv.com> -*- nroff -*- +.SH NAME +dvi2fax \- convert a TeX DVI file to G3 fax format +.SH SYNOPSIS +\fBdvi2fax\fP [\fB-hi\fP|\fB-lo\fP] \fIfile\fP[.dvi] [\fIoptions for dvips\fP] +.SH DESCRIPTION +\fBdvi2fax\fP uses \fBdvips\fP(1) to convert a TeX DVI file to PostScript, +then \fBgs\fP(1) to convert the PostScript to G3 fax file format. +.SH OPTIONS +.LP +.B -hi +use high fax resolution (204x196 dpi) (default). +.LP +.B -lo +use low fax resolution (204x98). +.PP +\fBdvips\fP options can follow the file name. +.SH EXAMPLE +Example: dvi2fax foo -l 2 +.SH SEE ALSO +\fBdvips\fP(1), \fBgs\fP(1). diff --git a/Master/texmf-dist/doc/man/man1/dvi2fax.man1.pdf b/Master/texmf-dist/doc/man/man1/dvi2fax.man1.pdf Binary files differnew file mode 100644 index 00000000000..6f3b5ca29fc --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvi2fax.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/dvi2tty.1 b/Master/texmf-dist/doc/man/man1/dvi2tty.1 new file mode 100644 index 00000000000..0c3a7da6177 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvi2tty.1 @@ -0,0 +1,172 @@ +.TH DVI2TTY 1 "13 November 1990" +.SH NAME +dvi2tty \- preview a TeX DVI\-file on an ordinary ascii terminal +.SH SYNOPSIS +.B dvi2tty +[ options ] dvi\-file +.SH DESCRIPTION +.I dvi2tty +converts a TeX DVI\-file to a format that is appropriate for terminals +and line printers. The program is intended to be used for +preliminary proofreading of TeX-ed documents. +By default the output is directed to the terminal, +possibly through a pager (depending on how the program was installed), +but it can be directed to a file or a pipe. +.PP +The output leaves much to be desired, but is still +useful if you want to avoid walking to the +laser printer (or whatever) for each iteration of your +document. +.br +Since +.I dvi2tty +produces output for terminals and line printers the +representation of documents is naturally quite primitive. +In principle Font Changes are totally ignored, but +.I dvi2tty +recognizes +a few mathematical and special symbols that can be be displayed on an +ordinary ascii terminal, such as the '+' and '-' symbol. +.PP +If the width of the output text requires more columns than fits +in one line (c.f. the \-w option) it is broken into several lines by +.I dvi2tty +although they will be printed as one line on regular TeX output +devices (e.g. laser printers). To show that a broken line is really +just one logical line an asterisk (``*'') in the last position +means that the logical line is continued on the next physical +line output by +.I dvi2tty. +Such a continuation line is started with a a space and an asterisk +in the first two columns. +.PP +Options may be specified in the environment variable DVI2TTY. +Any option on the command line, conflicting with one in the +environment, will override the one from the environment. +.PP +.B Options: +.PP +.TP +.B \-o file +Write output to file ``file''. +.TP +.B \-p list +Print the pages chosen by list. +Numbers refer to TeX\-page numbers (known as \\count0). +An example of format for list is ``1,3:6,8'' +to choose pages 1, 3 through 6 and 8. +Negative numbers can be used exactly as in TeX, +e g \-1 comes before \-4 as in ``\-p\-1:\-4,17''. +.TP +.B \-P list +Like \-p except that page numbers refer to +the sequential ordering of the pages in the dvi\-file. +Negative numbers don't make a lot of sense here... +.TP +.B \-w n +Specify terminal width +.I n. +Legal range 16\-132. +Default is 80. If your terminal has the +ability to display in 132 columns it might +be a good idea to use \-w132 and toggle the +terminal into this mode as output will +probably look somewhat better. +.TP +.B \-v +Specify height of lines. Default value 450000. Allows to adjust linespacing. +.TP +.B \-q +Don't pipe the output through a pager. +This may be the default on some systems +(depending on the whims of the person installing the program). +.TP +.B \-e n +This option can be used to influence the spacing between words. +With a negative value the number of spaces +between words becomes less, with a positive value it becomes more. +\-e\-11 seems to worked well. +.TP +.B \-f +Pipe through a pager, $PAGER if defined, or whatever the installer of +the program compiled +in (often ``more''). This may be the default, but it is still okay +to redirect output with ``>'', the pager will not be used if output +is not going to a terminal. +.TP +.B \-F +Specify the pager program to be used. +This overrides the $PAGER and the default pager. +.TP +.B \-Fprog +Use ``prog'' as program to pipe output into. Can be used to choose an +alternate pager (e g ``-Fless''). +.TP +.B \-t +\\tt fonts were used (instead of cm) to produce dvi file. (screen.sty +is a powerfull mean to do that with LaTeX). +.TP +.B \-a +Dvi2tty normally tries to output accented characters. With the -a option, +accented characters are output without the accent sign. +.TP +.B \-l +Mark page breaks with the two-character sequence ``^L''. The default is +to mark them with a form-feed character. +.TP +.B \-c +Do not attempt to translate any characters (like the Scandinavion/latin1 mode) +except when running in tt-font. +.TP +.B \-u +Toggle option to process certain latin1 characters. Use this if your output +devices supports latin1 cahracters. +Note this may interfere with -s. Best not to use -u and -s together. +.TP +.B \-s +Toggle option to process the special Scandinavian characters that on most (?) +terminals in Scandinavia are mapped to ``{|}[\\]''. +Note this may interfere with -u. Best not to use -u and -s together. +.TP +.B \-J +Auto detect NTT JTeX, ASCII pTeX, and upTeX dvi format. +.TP +.B \-N +Display NTT JTeX dvi. +.TP +.B \-A +Display ASCII pTeX dvi. +.TP +.B \-U +Display upTeX dvi. +.TP +.B \-Eenc +Set output Japanese encoding. The enc argument 'e', 's', 'j', and 'u' +denotes EUC-JP, Shift_JIS, ISO-2022-JP, and UTF-8, respectively. +.TP +.B \-bdelim +Print the name of fonts when switching to it (and ending it). The delim +argument is used to delimit the fontname. +.SH FILES +/bin/more \ \ \ \ +probably the default pager. +.SH ENVIRONMENT +PAGER \ \ \ \ \ \ \ \ \ \ \ \ +the pager to use. +.br +DVI2TTY \ \ \ \ \ \ \ \ \ \ \ +can be set to hold command-line options. +.SH "SEE ALSO" +TeX, dvi2ps +.SH AUTHOR +Original Pascal verion: Svante Lindahl, Royal Institute of Technology, Stockholm +.br +Improved C version: Marcel Mol +.br +marcel@mesa.nl, MESA Consulting +.SH BUGS +Blanks between words get lost quite easy. This is less +likely if you are using a wider output than the default 80. +.PP +Only one file may be specified on the command line. + diff --git a/Master/texmf-dist/doc/man/man1/dvi2tty.man1.pdf b/Master/texmf-dist/doc/man/man1/dvi2tty.man1.pdf Binary files differnew file mode 100644 index 00000000000..735508fb809 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvi2tty.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/dvibook.1 b/Master/texmf-dist/doc/man/man1/dvibook.1 new file mode 100644 index 00000000000..01ee1d6b05e --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvibook.1 @@ -0,0 +1,55 @@ +.\" Copyright (c) 1987-2012 UMD-CS, released under the X11 license; +.\" see README and source files. +.TH DVIBOOK 1 +.SH NAME +dvibook \- rearrange pages in DVI file into signatures +.SH SYNOPSIS +.B dvibook +[ +.B \-q +] [ +.B \-s\fI<num> +] [ +.B \-i +.I infile +] [ +.B \-o +.I outfile +] +[ +.I infile +[ +.I outfile +] ] +.SH DESCRIPTION +.I Dvibook +rearranges pages from a DVI file produced by TeX into ``signatures'' for +printing books or booklets, creating a new DVI file +usable by any of the TeX conversion programs. +.PP +The +.I \-s +option selects the size of signature which will be used. The signature size is +the number of sides which will be folded and bound together; the number given +should be a multiple of four. The default is to use one signature for the +whole file. Extra blank sides will be added if the file does not contain a +multiple of four pages. +.PP +Dvibook normally prints the page numbers of the pages rearranged; the +.I \-q +option suppresses this. +.SH AUTHOR +Angus Duggan, from dviselect(1), by +Chris Torek, University of Maryland +.SH "SEE ALSO" +dviconcat(1), dviselect(1), latex(1), tex(1) +.br +.I "MC-TeX User's Guide" +.br +.I "The TeXbook" +.SH BUGS +.I Dvibook +does not adjust the parameters in the postamble; however, since these +values are normally used only to size certain structures in the output +conversion programs, and the parameters never need to be adjusted upward, +this has not proven to be a problem. diff --git a/Master/texmf-dist/doc/man/man1/dvibook.man1.pdf b/Master/texmf-dist/doc/man/man1/dvibook.man1.pdf Binary files differnew file mode 100644 index 00000000000..540ecd89613 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvibook.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/dviconcat.1 b/Master/texmf-dist/doc/man/man1/dviconcat.1 new file mode 100644 index 00000000000..b148786820e --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dviconcat.1 @@ -0,0 +1,48 @@ +.\" Copyright (c) 1987-2012 UMD-CS, released under the X11 license; +.\" see README and source files. +.TH DVICONCAT 1 +.SH NAME +dviconcat \- concatenate DVI files +.SH SYNOPSIS +.B dviconcat +[ +.B \-m +.I magnification +] [ +.B \-o +.I outfile +] +.I "list of files" +.SH DESCRIPTION +.I Dviconcat +concatenates the named +.IR file s +(or standard input, if no file names are given) +onto the standard output +or the given +.IR outfile , +creating a new DVI file +usable by any of the TeX conversion programs, +or even by +.I dviconcat +itself. +.PP +The magnification of the output file +is the same as that of the first input file +unless the +.B \-m +option is given. +When +.I dviconcat +changes the magnification of any input file, +it prints a warning to this effect. +.SH AUTHOR +Chris Torek, University of Maryland +.SH "SEE ALSO" +dviselect(1), latex(1), tex(1) +.br +.I "MC-TeX User's Guide" +.SH BUGS +The program should be called +.IR dvicat , +but that name was taken (for the driver for the C/A/T typesetter). diff --git a/Master/texmf-dist/doc/man/man1/dviconcat.man1.pdf b/Master/texmf-dist/doc/man/man1/dviconcat.man1.pdf Binary files differnew file mode 100644 index 00000000000..8c2da08b481 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dviconcat.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/dvicopy.1 b/Master/texmf-dist/doc/man/man1/dvicopy.1 new file mode 100644 index 00000000000..7d6e7f34d06 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvicopy.1 @@ -0,0 +1,52 @@ +.TH DVICOPY 1 TeX "24 January 1999" "Web2C 2012" +.\"===================================================================== +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.\"===================================================================== +.SH NAME +dvicopy, odvicopy \- produce modified copy of DVI file +.SH SYNOPSIS +.B dvicopy +.RI [ options ] +.RI [ infile [ \fB.dvi\fP ] +.RI [ outfile [ \fB.dvi\fP ]]] +.\"===================================================================== +.SH DESCRIPTION +This manual page is not meant to be exhaustive. The complete +documentation for this version of \*(TX can be found in the info file +or manual +.IR "Web2C: A TeX implementation" . +.PP +.B dvicopy +reads a DVI file, expands any references to virtual fonts to base +fonts, and writes the resulting DVI file. Thus you can use virtual +fonts even if your DVI processor does not support them, by passing the +documents through +.B dvicopy +first. +.\"===================================================================== +.SH OPTIONS +.TP +.BI \-magnification= NUMBER +Override existing magnification with +.IR NUMBER . +.PP +.TP +.BI \-max-pages= NUMBER +Process +.I NUMBER +pages; default one million. +.PP +.TP +.BI \-page-start= PAGE-SPEC +Start at +.IR PAGE-SPEC , +for example `2' or `5.*.-2'. +.\"===================================================================== +.SH "SEE ALSO" +.BR dviselect (1), +.BR dvitype (1). +.\"===================================================================== +.SH AUTHORS +Peter Breitenlohner wrote the program. Klaus Guntermann originally ported +it to Unix. diff --git a/Master/texmf-dist/doc/man/man1/dvicopy.man1.pdf b/Master/texmf-dist/doc/man/man1/dvicopy.man1.pdf Binary files differnew file mode 100644 index 00000000000..e3ac7a5d812 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvicopy.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/dvidvi.1 b/Master/texmf-dist/doc/man/man1/dvidvi.1 new file mode 100644 index 00000000000..0e464f4d3e0 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvidvi.1 @@ -0,0 +1,128 @@ +.TH DVIDVI L "February 2011" +.SH NAME +.PP +dvidvi \- selects and/or re-arranges pages in a TeX dvi file +.SH SYNOPSIS +.PP +dvidvi [param] infile outfile +.SH DESCRIPTION +.SS Introduction +.PP +The dvidvi program converts a dvi file into another dvi file, with perhaps +certain changes. +.br +.SS Parameters +.PP +-f n page n is first page selected +.br +-l n page n is last page selected +.in +10 +.ti -10 +-n n select at most n pages. Notice that n is the number of pages +selected, independently of the number of pages actually +contained in a sheet +.ti -10 +-i { n1..n2 | n1 }[,...] +.br +include pages (ranges allowed). When this option is +used, ONLY the specified pages are selected. However, +we can exclude from these pages with the option -x +.ti -10 +-x { n1..n2 | n1 }[,...] +.br +exclude pages (ranges allowed) +.ti -10 +-q work in quiet mode, that is do not print in the screen +messages of how the work is being done. +.ti -10 +-r reverse the order of the pages. +.PP +The page numbers for the above options -f -l -i and -x can be specified +in different ways. +.in +4 +.ti -4 +1) If a number n is given, it is interpreted as the n'th page from the +beginning of the .dvi file. Of course, this number is independent of the +page number assigned by TeX. +.ti -4 +2) TeX page numbers are those who are actually written in the page; +these page numbers can be modified, for example, by using the TeX commands +\\pagenumbering, \\setcounter{page}{n}, and \\addtocounter{page}{n}. +A TeX page number can be specified by preceding the number n with the +character @. Thus, if you specify -f @25 -l @30 you select the pages +between 25 and 30, these numbers being those assigned by TeX. +.ti -4 +3) However, several pages can have the same TeX page number in a .dvi file. +For example, the introductory pages in a book are numbered i, ii, and so on +until the first chapter begins and then, the pages are numbered 1, 2, etc. +In this case, the pages numbered i and 1 in the .dvi file have the same TeX +page number. If you want to select for example the second occurrence of the +page numbered 1, you can specify a page number as (@2)1. Thus @1 is equivalent +to (@1)1. For example, if you specify -f (@2)1 -l(@2)10 you select the pages +between 1 and 10 of the first chapter, not the introductory pages between +i and x. +.PP +There is another parameter that tells dvidvi how you want to change page +layout and specifications. This is the -m parameter. +.in +4 +.ti -4 +* The number preceding the colon is the modulo value. Everything will be +done in chunks of pages this big. If there is no colon, than the default +value is assumed to be one. The last chunk of pages is padded with as many +blank pages as necessary. +.ti -4 +* Following the colon is a comma-separated list of page numbers. These +page numbers are with respect to the current chunk of pages, and must lie +in the range zero to the modulo value less one. If a negative sign +precedes the number, then the page is taken from the mirror chunk; if there +are m chunks, then the mirror chunk of chunk n is the chunk numbered m-n-1. +Put simply, it is the chunk numbered the same, only from the end. This can +be used to reverse pages. If no number is given, the page number defaults +to 1. +.ti -4 +* Following each page number is an optional offset value in parenthesis, +which consists of a pair of comma-separated dimensions. Each dimension is +a decimal number with an optional unit of measure. The default unit of +measure is inches, or the last unit of measure used. All units are in true +dimensions. Allowable units of measure are the same that TeX allows: in, +mm, cm, pt, pc, dd, and cc. +.SS Copyright +dvidvi 1.0, Copyright (C) 1988-2011, Radical Eye Software +Anyone may freely use, modify and/or distribute this program and +documentation, or any portion thereof, without limitation. +.SH EXAMPLES +.PP +.in +10 +.ti -10 +-m - Reverses the order of the pages. This time, both the modulo and the +page number are defaulted. +.ti -10 +-m 2:0 Selects the first, third, fifth, etc. pages from the file. Print +this one after printing the next, taking the paper out of the +feed tray and reinserting it into the paper feed. +.ti -10 +-m 2:-1 Selects the second, fourth, etc. pages, and writes them in reverse +order. +.ti -10 +-m 4:-1,2(4.25in,0in) +.ti -10 +-m 4:-3,0(4.25in,0in) +.br +Useful for printing a little booklet, four pages to a sheet, +double-sided, for stapling in the middle. Print the first one, +put the stack back into the printer upside down, and print the +second. The `in' specifications are superfluous. +.ti -10 +-m ,(1pt,1) +.br +Scare your system administrator! Actually, things are so blurry with this +option, you may want to send enemies letters printed like this. *Long* +letters. +.ti -10 +-m 4:0(5.5in,4.25),3(0,4.25) +.ti -10 +-m 4:1(0in,4.25),2(5.5,4.25) +.br +Print a four-page card on one sheet. Print the first, rotate the paper 180 +degrees and feed it again. (PostScript people can do funny tricks with +PostScript so this isn't necessary.) diff --git a/Master/texmf-dist/doc/man/man1/dvidvi.man1.pdf b/Master/texmf-dist/doc/man/man1/dvidvi.man1.pdf Binary files differnew file mode 100644 index 00000000000..2e080b5302c --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvidvi.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/dvigif.1 b/Master/texmf-dist/doc/man/man1/dvigif.1 new file mode 100644 index 00000000000..537ea8bfa35 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvigif.1 @@ -0,0 +1 @@ +.so man1/dvipng.1 diff --git a/Master/texmf-dist/doc/man/man1/dvigif.man1.pdf b/Master/texmf-dist/doc/man/man1/dvigif.man1.pdf Binary files differnew file mode 100644 index 00000000000..35194cc5459 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvigif.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/dvihp.1 b/Master/texmf-dist/doc/man/man1/dvihp.1 new file mode 100644 index 00000000000..9627bb312ee --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvihp.1 @@ -0,0 +1,49 @@ +.TH DVIHP 1 "December 24, 2009" +.\" man page by Jim Van Zandt <jrv@vanzandt.mv.com> -*- nroff -*- +.SH NAME +dvihp \- convert a TeX DVI file to Hewlett-Packard PCL +.SH SYNOPSIS +\fBdvihp\fP [\fIoptions\fP] \fIdvifile\fP[.dvi] +.SH DESCRIPTION +\fBdvihp\fP translates the given \fIdvifile\fP to Hewlett-Packard PCL +using \fBdvicopy\fP(1) then $DVILJ (dvilj4 by default). +.P +In the absence of other options, pipe the PCL to $SPOOL (lpr by default). +.SH OPTIONS +Options are recognized from dvips where possible: +.IP \fB-A\fP +print odd pages +.IP \fB-B\fP +print even pages +.IP "\fB-d\fP \fIn\fP" +set debug bits to \fIn\fP (see documentation) +.IP "\fB-D\fP \fIn\fP" +set resolution to \fIn\fP +.IP \fB-f\fP +run as filter +.IP "\fB-l\fP \fIn\fP" +don't print pages after \fIn\fP +.IP \fB-m\fP +manual feed +.IP "\fB-n\fP \fIn\fP" +print \fIn\fP pages +.IP "\fB-O\fP \fIa\fP,\fIb\fP" +set/change paper offset to \fIa\fP,\fIb\fP mm. +.IP "\fB-o\fP \fIs\fP" +output to \fIs\fP instead of spooling +.IP "\fB-p\fP \fIn\fP" +don't print pages before \fIn\fP. +.IP \fB-Ps\fP +pass directly to lpr. +.IP \fB-v\fP +verbose operation. +.IP "\fB-x\fP \fIn\fP" +set magnification to \fIn\fP. +.IP \fB--help\fP +write usage summary. +.P +Other options are passed to the dvilj program. +.SH BUGS +Email bug reports to tex-k@tug.org. +.SH SEE ALSO +\fBdvicopy\fP(1), \fBdvilj4\fP(1). diff --git a/Master/texmf-dist/doc/man/man1/dvihp.man1.pdf b/Master/texmf-dist/doc/man/man1/dvihp.man1.pdf Binary files differnew file mode 100644 index 00000000000..dadd6dbcaaf --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvihp.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/dvilj.1 b/Master/texmf-dist/doc/man/man1/dvilj.1 new file mode 100644 index 00000000000..af00f982db4 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvilj.1 @@ -0,0 +1,688 @@ +.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.04) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "DVILJ 1" +.TH DVILJ 1 "2012-03-12" "Version 2.6p5" "TeX-Live" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +dvilj4, dvilj4l, dvilj2p, dvilj \- convert a TeX DVI file to PCL, for HP LaserJet printers +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +.Vb 4 +\& dvilj [\-\-Dnumber] [\-ccopies] [\-dmode] [\-D] [\-E] [\-eoutputfile] +\& [\-ffrompage] [\-g] [\-hheaderfile] [\-l] [\-Mflag] [\-mmag] [\-ppages] +\& [\-q] [\-r] [\-ttopage] [\-spagesize] [\-v] [\-Vmode] [\-w] [\-xxoff(mm)] +\& [\-yyoff(mm)] [\-Xxoff(dots)] [\-Yyoff(dots)] [\-z] [filename] +.Ve +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +\&\fBdvilj\fR and siblings convert TeX-output \f(CW\*(C`.dvi\*(C'\fR files into \s-1PCL\s0 (the +Hewlett-Packard Printer Control Language) commands suitable for +printing on a \s-1HP\s0 LaserJet+, \s-1HP\s0 LaserJet \s-1IIP\s0 (using \fBdvilj2p\fR), \s-1HP\s0 +LaserJet 4 (using \fBdvilj4\fR), and fully compatible printers. +.PP +\&\fBdvilj4\fR also provides support for the builtin Intellifont and +TrueType fonts; \s-1TFM\s0 and \s-1VF\s0 files are provided in the distribution. +Virtual fonts are not supported directly by \fBdvilj\fR, so you must run +\&\fIdvicopy\fR\|(1) first, or otherwise expand the virtual fonts +.PP +All programs are generated from one source file \fIdvi2xx.c\fR. They are +usually called via a shell script or as a line printer filter. One +such script, \fIdvihp\fR\|(1), is included in the distribution. It provides +command-line options similar to those of \fIdvips\fR\|(1). +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-\-D\fR\fInumber\fR" 4 +.IX Item "--Dnumber" +Debug according to the bits of \fInumber\fR; see the \fIkpathsea\fR\|(3) manual +for values. Also turns on general verbosity. +.IP "\fB\-c\fR\fInumber\fR" 4 +.IX Item "-cnumber" +Print each page \fInumber\fR times (including original) +.IP "\fB\-d\fR\fInumber\fR" 4 +.IX Item "-dnumber" +print in duplex mode. The option \fB\-d1\fR means long edge binding, +\&\fB\-d2\fR stands for short edge binding. This option is only selectable +in \fBdvilj4\fR and \fBdvilj2p\fR. +.IP "\fB\-D\fR\fI[\-12]\fR" 4 +.IX Item "-D[-12]" +Double-sided printing \- see below; \fB\-D1\fR prints odd sides only, +\&\fB\-D2\fR is for even pages, a trailing \fB\-\fR suppresses printing of empty +padding pages. +.IP "\fB\-E\fR" 4 +.IX Item "-E" +Switch printer into econo mode (\fBdvilj4\fR only). +.IP "\fB\-e\fR\fIoutfile\fR" 4 +.IX Item "-eoutfile" +Send output to \fIoutfile\fR instead of the basename of dvi file extended +with \f(CW\*(C`.lj\*(C'\fR. If outfile is \fB\-\fR (as in \f(CW\*(C`\-e\-\*(C'\fR) the output is directed +to standard output and can be directly piped into a spooler. +.IP "\fB\-f\fR\fIpagenum\fR" 4 +.IX Item "-fpagenum" +Print pages with TeX page numbers greater than or equal to \fIpagenum\fR. +.IP "\fB\-g\fR" 4 +.IX Item "-g" +\&\fIGo\fR mode: do not reset printer at start of job. +.IP "\fB\-h\fR\fIheaderfile\fR" 4 +.IX Item "-hheaderfile" +Copy \fIheaderfile\fR to output before translation of the \s-1DVI\s0 file. Used +to send arbitrary commands to the laserprinter. +.IP "\fB\-l\fR" 4 +.IX Item "-l" +Print output in landscape mode; supported only by \fBdvilj2p\fR and +\&\fBdvilj4\fR. +.IP "\fB\-M\fR\fIflag\fR" 4 +.IX Item "-Mflag" +Do (not) call \fImktexpk\fR\|(1) to generate fonts on demand. \fB\-M1\fR and \fB\-M\fR +are equivalent. \fB\-M0\fR enables invoking \fImktexpk\fR\|(1). (This is the same +as in \fIdvips\fR\|(1).) The default behavior (i.e., if no \fB\-M\fR option is +given) is chosen at compile-time; as distributed, mktexpk is enabled. +.IP "\fB\-m\fR\fImagnification\fR" 4 +.IX Item "-mmagnification" +Specify the magnification to use. The following are available: +.Sp +.Vb 9 +\& \-m#usermag e.g., #900 +\& \-m0 equivalent to \-m#1000 +\& \-mh equivalent to \-m#1095 +\& \-m1 equivalent to \-m#1200 +\& \-mq equivalent to \-m#1250 +\& \-m2 equivalent to \-m#1440 +\& \-m3 equivalent to \-m#1728 +\& \-m4 equivalent to \-m#2074 +\& \-m5 equivalent to \-m#2488 +.Ve +.IP "\fB\-p\fR\fIpagecount\fR" 4 +.IX Item "-ppagecount" +Print \fIpagecount\fR pages after the starting page. +.IP "\fB\-q\fR" 4 +.IX Item "-q" +Quiet operation: omit final statistics, etc. +.IP "\fB\-r\fR" 4 +.IX Item "-r" +Toggle page reversal. +.IP "\fB\-s\fR\fIpagesize\fR" 4 +.IX Item "-spagesize" +Specify the page size: +.Sp +.Vb 10 +\& \-s1: Executive (7.25" x 10.5") +\& \-s2: Letter (8.5" x 11") +\& \-s3: Legal (8.5" x 14") +\& \-s6: Ledger (11" x 17") +\& \-s25: A5 paper (148mm x 210mm) +\& \-s26: A4 paper (210mm x 297mm) +\& \-s27: A3 (297mm x 420mm) +\& \-s45: JIS B5 paper (182mm x 257mm) +\& \-s46: JIS B4 paper (250mm x 354mm) +\& \-s71: Hagaki postcard (100mm x 148mm) +\& \-s72: Oufuku\-Hagaki postcard (200mm x 148mm) +\& \-s80: Monarch Envelope (3 7/8" x 7 1/2") +\& \-s81: Commercial Envelope 10 (4 1/8" x 9 1/2") +\& \-s90: International DL (110mm x 220mm) +\& \-s91: International C5 (162mm x 229mm) +\& \-s100: International B5 (176mm x 250mm) +.Ve +.Sp +These values are from the \s-1PCL\s0 5 technical reference manual. If the +\&\fB\-s\fR commandline option is omitted, no clipping is performed at the +bottom of the page. (But printing below the paper bottom should not +disturb any correctly behaving \s-1PCL\s0 printer.) Please remember that the +correct paper tray must be installed for selected paper size, so use +this option only if you have full control over your print destination. +.IP "\fB\-t\fR\fIpagenum\fR" 4 +.IX Item "-tpagenum" +Print pages with TeX page numbers less than or equal to \fIpagenum\fR. +.IP "\fB\-v\fR" 4 +.IX Item "-v" +Verbose mode: list fonts used, etc. +.IP "\fB\-V\fR\fImode\fR" 4 +.IX Item "-Vmode" +Compatibility mode. As \fImode\fR, use \f(CW\*(C`K\*(C'\fR for Kyocera, \f(CW\*(C`B\*(C'\fR for +Brother, \f(CW6\fR for \s-1LJ6\s0 printers. +.IP "\fB\-w\fR" 4 +.IX Item "-w" +Omit warnings. +.IP "\fB\-x\fR\fIoffset\fR" 4 +.IX Item "-xoffset" +Global x\-offset in mm on output page relative to 1 inch/1 inch origin. +.IP "\fB\-y\fR\fIoffset\fR" 4 +.IX Item "-yoffset" +Global y\-offset in mm on output page relative to 1 inch/1 inch origin. +.IP "\fB\-X\fR\fIoffset\fR" 4 +.IX Item "-Xoffset" +Global x\-offset in dots on output page (overrides 1 inch/1 inch +origin). +.IP "\fB\-Y\fR\fIoffset\fR" 4 +.IX Item "-Yoffset" +Global y\-offset in dots on output page (overrides 1 inch/1 +inch origin). +.IP "\fB\-z\fR" 4 +.IX Item "-z" +Print a test page with the page counter at end of job. +.SH "OPERANDS" +.IX Header "OPERANDS" +If no operands are specified a brief usage message is displayed. +.IP "\fIfilename\fR" 4 +.IX Item "filename" +The \s-1DVI\s0 file name that shall be converted by \fBdvilj\fR. It must always +be seekable. +.Sp +The output file name is constructed from \fIfilename\fR. Either an +extension \f(CW\*(C`.dvi\*(C'\fR is replaced by \f(CW\*(C`.lj\*(C'\fR, or the extension \f(CW\*(C`.lj\*(C'\fR is +appended. +.Sp +If \fIfilename\fR is \fB\-\fR, the \s-1DVI\s0 file is read from standard input and +the resulting \s-1PCL\s0 document is written to standard output. (Please +remember that thhe \s-1DVI\s0 file must be seekable, even if it's stdin.) +.SH "SUPPORTED TeX \especial COMMANDS" +.IX Header "SUPPORTED TeX special COMMANDS" +\&\f(CW\*(C`\especial\*(C'\fR commands supported by \fBdvilj\fR have the generic syntax +.PP +.Vb 2 +\& \especial{key1=value key1="value with space"} +\& \especial{key3 = value key4 = \*(Aqnote optional spaces around equal sign\*(Aq} +.Ve +.PP +I.e., specials are a sequence of key/value pairs, separated by an +equal sign. Spaces around the equal sign are ignored. The value is +either a space separated word, or a quoted string. Both double and +single quotes can be used, alternatively. There is no support for +quoting quote characters in values; if you want both double and single +quotes in one value, you're out of luck. +.PP +The following key/value combinations are valid: +.IP "\fBhpfile\fR=\fIfile\fR" 4 +.IX Item "hpfile=file" +Insert \fIfile\fR at the current position. \fIfile\fR is searched with +\&\fIkpathsea\fR\|(3), see below. +.Sp +The file content must be valid for this printer, i.e., it should +contain \s-1PCL\s0 escape sequences or \s-1HP\-GL/2\s0 commands. If the file is a +graphics file, this typically means that the upper left corner of the +graphics is placed at the current position. +.Sp +\&\s-1PCL\s0 absolute positioning escape sequences in \fIfile\fR are rewritten to +be relative positioning commands; the lowest appearing coordinate is +used as reference. +.IP "\fBhpfile_verbatim\fR=\fIfile\fR" 4 +.IX Item "hpfile_verbatim=file" +Insert \fIfile\fR verbatim at the current position, without any changes +of the file content. \fIfile\fR is searched with \fIkpathsea\fR\|(3), see below. +.Sp +This is mostly used to keep absolute positions in \s-1PCL\s0 files. +.IP "\fBpsfile\fR=\fIfile\fR \fBllx\fR=\fIx0\fR \fBlly\fR=\fIy0\fR \fBurx\fR=\fIx1\fR \fBury\fR=\fIy1\fR \fBrwi\fR=\fIs\fR" 4 +.IX Item "psfile=file llx=x0 lly=y0 urx=x1 ury=y1 rwi=s" +Convert Postscript file \fIfile\fR to \s-1HP\s0 \s-1PCL\s0, by Ghostscript with device +\&\f(CW\*(C`ljetplus\*(C'\fR, and insert the resulting graphics file at the current +position, rewriting absolute position escape sequences. \fIfile\fR is +searched with \fIkpathsea\fR\|(3), see below. +.Sp +The accompanying key/value pairs are mandatory, they can be specified +in an arbitrary order. Values \fIx0\fR, \fIx1\fR, \fIy0\fR, \fIy1\fR, and \fIs\fR are +integers. (\fIx0\fR,\fIy0\fR) is the lower left corner, (\fIx1\fR,\fIy1\fR) the +upper right corner of the image. +.Sp +\&\fBPlease note: The specific semantics of this special is not known.\fR +In particular, the \fBrwi\fR parameter is some scale factor; but even +looking at the source code it is not quite clear what the special's +author intended to implement here. In addition, it is unclear what +dimensions are used to specify the corners, Postscript points or \s-1PCL\s0 +dots. +.Sp +\&\fIIf you happen to know the psfile semantics, or if you spent the work +analyzing them, please inform us at tex\-k@tug.org, so that we can +update this man page with the relevant information.\fR +.IP "\fBdvilj-psfile-syntax\fR=\fIsyntax\fR" 4 +.IX Item "dvilj-psfile-syntax=syntax" +where \fIsyntax\fR is either \f(CW\*(C`dvilj\*(C'\fR or \f(CW\*(C`ignore\*(C'\fR. This is a very crude +way to tell the driver what to do with \fBpsfile\fR specials. +.Sp +If the value is \f(CW\*(C`ignore\*(C'\fR, all \fBpsfile\fR specials that are processed +afterwards are ignored, until the next \fBdvilj-psfile-syntax\fR special is +processed. +.Sp +If the value is \f(CW\*(C`dvilj\*(C'\fR, \fBpsfiles\fR specials are processed as +explained above, until the next \fBdvilj-psfile-syntax\fR special is +processed. +.Sp +An obvious, planned, extension is the value \f(CW\*(C`dvips\*(C'\fR, but this has not +been implemented yet. +.Sp +That special is not as simple as it sounds at first. Since its +semantics is defined by processing order, it is only of use if it is +placed on the same page as the \fBpsfile\fR special. Having it once in a +file (e.g., on the first page) does not help if you print just one +page of the document \*(-- \fBdvilj\fR does not do prescanning of first-page +specials like some other drivers do. (Patches would be welcome, of +course.) +.IP "\fBcomment\fR=\fIarbitrary text\fR" 4 +.IX Item "comment=arbitrary text" +.PD 0 +.IP "\fBcomment\fR \fIarbitrary text\fR" 4 +.IX Item "comment arbitrary text" +.PD +This causes the rest of the special to be ignored; it may be used to +add meta-information to a \s-1DVI\s0 file. +.Sp +With the first form, the comment may appear anywhere in the special. +When it appears first, the processing of this special is terminated +and all other text behind is ignored. +.Sp +The second form is a speciality that has been introduced for +compatibility with other drivers. If the first keyword of the special +is \fBcomment\fR and has no value, it is taken as a valid comment syntax, +too; the rest of the special is ignored. +.IP "\fBorientation\fR=\fIpo\fR" 4 +.IX Item "orientation=po" +Position the page on the physical paper. The value \fIpo\fR may be one of +the following values: +.Sp +.Vb 4 +\& 0 for portrait +\& 1 for landscape +\& 2 for reverse portrait +\& 3 for reverse landscape +.Ve +.IP "\fBdefpoint\fR=\fIn(x,y)\fR" 4 +.IX Item "defpoint=n(x,y)" +Define the point number \fIn\fR. This point can be referred to later in +other special commands to specify areas that shall be filled with some +pattern. \fIn\fR must be between 0 and 79. +.Sp +\&\fIx\fR and \fIy\fR are the position of that point and have the form \f(CW\*(C`?pt\*(C'\fR +where \f(CW\*(C`?\*(C'\fR is a floating point number. The positions are relative to +the \s-1DVI\s0 page origin; i.e., coordinates increase moving right and down, +the point of origin is (1in,1in) in the upper left corner, altered by +options \fB\-x\fR, \fB\-y\fR, \fB\-X\fR, and \fB\-Y\fR, but not by \ehoffset and +\&\evoffset. +.Sp +\&\fIx\fR and \fIy\fR can be omitted, i.e., the values \f(CW3\fR or \f(CW\*(C`4(,)\*(C'\fR are +valid. Then the current page position is used as position for point +\&\fIn\fR. +.ie n .IP "\fBresetpoints\fR=""all""" 4 +.el .IP "\fBresetpoints\fR=\f(CWall\fR" 4 +.IX Item "resetpoints=all" +This undefines all points again. +.IP "\fBgray\fR=\fIgray_scale\fR" 4 +.IX Item "gray=gray_scale" +.PD 0 +.IP "\fBgrey\fR=\fIgray_scale\fR" 4 +.IX Item "grey=gray_scale" +.PD +This sets the fill mode for the next \fBfill\fR special, the area will be +filled with gray color. (\fBgrey\fR is an alias for \fBgray\fR.) Any pattern +specification is reset. +.Sp +\&\fIgray_scale\fR is the percentage of gray that shall be used here; with +\&\f(CW0\fR meaning white and \f(CW100\fR meaning black. +.Sp +Caveat: That special is actually a misnomer. \s-1PCL\s0 names these gray +scales \fIshading patterns\fR and they are created by placing dots in the +area. The gray scale selects how far spread the dots are. In the lower +ranges, this doesn't look very gray on close sight, but more like a +dotted background. Furthermore, the gray scales are not as +fine-grained as the value range 0..100 might make you believe. In +reality, there are only 8 different gray patterns available: +.Sp +.Vb 8 +\& 1 \- 2% +\& 3 \- 10% +\& 11 \- 20% +\& 21 \- 35% +\& 36 \- 55% +\& 56 \- 80% +\& 81 \- 99% +\& 100% +.Ve +.Sp +One of these patterns is selected according to the \fIgray_scale\fR value. +.IP "\fBpattern\fR=\fIpat\fR" 4 +.IX Item "pattern=pat" +This sets the fill mode for the next \fBfill\fR special, the area will be +filled with a pattern. Any gray color specification is reset. +.Sp +\&\fIpat\fR is one of the following values: +.Sp +.Vb 6 +\& 1 horizontal lines +\& 2 vertical lines +\& 3 diagonal lines, from lower left corner to upper right corner +\& 4 diagonal lines, from upper right corner to lower left corner +\& 5 crossed lines, vertically +\& 6 crossed lines, diagonally +.Ve +.IP "\fBfill\fR=\fIa/b\fR" 4 +.IX Item "fill=a/b" +Fill the area between the points \fIa\fR and \fIb\fR, according to the +current fill mode. +.Sp +Point \fIa\fR \fBmust\fR be the upper left corner and point \fIb\fR \fBmust\fR be the +lower left corner of the rectangle. Otherwise the result is garbage. +.Sp +The default fill mode is 10% gray color filling. +.IP "\fIfilename\fR" 4 +.IX Item "filename" +This is a legacy special, its use is depreciated. If the special is +just one word that names an existing file, that file is verbatim +included. Contrary to other file inclusion means, the file is not +searched with \fIkpathsea\fR\|(3). \fIYou are not supposed to use this special +and we won't fix any problems with it.\fR +.PP +It should be noted that the special parser does sometimes accept +constructs that are not valid as in the documentation above. Then, the +output is most often damaged in some way. +.Sh "Searching for Included Files" +.IX Subsection "Searching for Included Files" +Proper file include specials search the file with \fIkpathsea\fR\|(3). The +search path is configured by variable \f(CW\*(C`DVILJINPUTS\*(C'\fR and, if the file +is not found in that search path, by variable \f(CW\*(C`TEXINPUTS\*(C'\fR. +.PP +Search via \f(CW\*(C`DVILJINPUTS\*(C'\fR covers the use case that one has common +site-wide graphics that shall be included in documents, e.g., scanned +signatures. Search via \f(CW\*(C`TEXINPUTS\*(C'\fR covers the use case that one has +graphics as part of ones current document. +.PP +\&\f(CW\*(C`dvilj\*(C'\fR is used as the \f(CW\*(C`.PROGRAM\*(C'\fR name in \fItexmf.cnf\fR, for all +driver variants, independent of the actual program name. +.ie n .Sh "Unknown Specials and ""TEX_HUSH"" configuration" +.el .Sh "Unknown Specials and \f(CWTEX_HUSH\fP configuration" +.IX Subsection "Unknown Specials and TEX_HUSH configuration" +\&\fIKpathsea\fR\|(3) has the concept of warning suppression with the +configuration variable \f(CW\*(C`TEX_HUSH\*(C'\fR, please refer to its Info node +\&\fITeX support / Suppressing warnings\fR. That variable holds a +colon-separated identifiers that specifies the to-be-suppressed +warnings. +.PP +If \f(CW\*(C`special\*(C'\fR is among the listed values, \fBdvilj\fR does not output +warnings any more about specials that it doesn't know about. But if +there is a recognized special and if that special has an invalid +parameter, then a warning is output nevertheless, independent of the +content of \f(CW\*(C`TEX_HUSH\*(C'\fR. +.SH "DOUBLE PAGE PRINTING" +.IX Header "DOUBLE PAGE PRINTING" +If the printer has a duplex unit installed, duplex printing can be +demanded with the \fB\-d\fR option. +.PP +Otherwise, the command line option \fB\-D\fR causes the printer to print +in doublepage mode, that is, roughly speaking, printing first the even +pages and then the odd pages of a document. If \fB\-D\fR is used to print +both even and odd pages (\fB\-D\fR is used without the optional 1 or 2) +the following will happen after half of the pages is printed: \s-1LJ:\s0 the +printer stops, shows message \*(L"\s-1FEED\s0\*(R" and switches on manual feed led. +The printer continues when either the printed pages are fed into the +manual page feeder, or the operator pushes the continue button (after +placing first the printed pages into the paper tray). +.PP +If \fB\-D1\fR was specified only odd pages will be printed, \fB\-D2\fR can be +used for even pages. A trailing \f(CW\*(C`\-\*(C'\fR (as in \fB\-D\-\fR, \fB\-D1\-\fR or +\&\fB\-D2\-\fR) supresses printing of empty pages which are generated for +padding otherwise. +.PP +The driver allows the \fB\-D\fR option for both print-directions +(front-to-back or back-to-front printing). It tries to be clever in +certain cases: when a document has an odd number of pages it inserts +in the right place an empty page when a document starts with page 0 +the driver inserts an empty page after the 0\-page when a piece of a +document is printed that starts with an even page-number it prints +this page at the backside of the first page to ensure that the odd +sides are always on the frontside. The 0\-page is treated like an odd +page. +.PP +The doubleside option works for all LJs, not only for the new D model +with does doubleside-printing (actually, I don't know whether it makes +much sense on the new \s-1LJ\s0 \s-1II\s0 D at all). +.PP +Caveat on the doubleside-option: When it is used frequently or on very +large files, it might become necessary to clean the printer much more +frequently. +.PP +The command line option \fB\-p\fR\fIX\fR can be used to abort printing after +the output of \fIX\fR pages (can lead to strange results together with +\&\fB\-D\fR). I personally dislike this option. The secure way of printing a +part of a document is using \fB\-f\fR (from) and \fB\-t\fR (to). +.SH "ENVIRONMENT" +.IX Header "ENVIRONMENT" +\&\fBdvilj\fR uses the same environment variables and algorithms for finding +font files as TeX and its friends do. See the documentation for the +\&\fIkpathsea\fR\|(3) library for details. (Repeating it here is too cumbersome.) +.ie n .IP """DVILJFONTS""" 4 +.el .IP "\f(CWDVILJFONTS\fR" 4 +.IX Item "DVILJFONTS" +If set, overrides all other font paths. +.ie n .IP """DVILJMAKEPK""" 4 +.el .IP "\f(CWDVILJMAKEPK\fR" 4 +.IX Item "DVILJMAKEPK" +If set, overrides \fImktexpk\fR\|(1) as the name of the command to execute to +create a \s-1PK\s0 file if one isn't found. +.ie n .IP """DVILJSIZES""" 4 +.el .IP "\f(CWDVILJSIZES\fR" 4 +.IX Item "DVILJSIZES" +May be set to indicate which sizes of fonts are available. It should +consist of a list of numbers separated by colons. If the list begins +with a colon, the system default sizes are used, as well. Sizes are +expressed in dots per inch; decimals may be used for \f(CW\*(C`pxl\*(C'\fR files: for +example, a 300 dots per inch file magnified by half a step comes out +to 1643 dots per five inches, which should be encoded as 328.6. +\&\fBdvilj\fR tries the actual size of the font before trying any of the +given sizes. +.ie n .IP """DVILJINPUTS""" 4 +.el .IP "\f(CWDVILJINPUTS\fR" 4 +.IX Item "DVILJINPUTS" +Primary search path for include files. +.ie n .IP """TEXINPUTS""" 4 +.el .IP "\f(CWTEXINPUTS\fR" 4 +.IX Item "TEXINPUTS" +Secondary search path for include files. +.ie n .IP """TEX_HUSH""" 4 +.el .IP "\f(CWTEX_HUSH\fR" 4 +.IX Item "TEX_HUSH" +Colon separated list of identifiers that name situations where no +warning shall be output. The following identifiers are used: +.Sp +.Vb 5 +\& checksum suppress mismatched font checksum warnings +\& readable suppress warnings about unreadable files +\& special suppress warnings about unknown specials +\& all suppress all warning classes above +\& none suppress no warnings +.Ve +.ie n .IP """KPATHSEA_DEBUG""" 4 +.el .IP "\f(CWKPATHSEA_DEBUG\fR" 4 +.IX Item "KPATHSEA_DEBUG" +Trace \fIkpathsea\fR\|(3) lookups; set to \-1 for complete tracing. +.ie n .IP """GS_PATH""" 4 +.el .IP "\f(CWGS_PATH\fR" 4 +.IX Item "GS_PATH" +On Windows, this may be the path to Ghostscript; there the default is +\&\fIgswin32c.exe\fR. +.Sp +On Unix, this environment variable is not used. Ghostscript is called +as \fIgs\fR\|(1) and must be found over \f(CW$PATH\fR. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fIdvihp\fR\|(1), \fIdvicopy\fR\|(1), \fIdvips\fR\|(1), \fIxdvi\fR\|(1), \fImktexpk\fR\|(1), \fIgs\fR\|(1), +\&\fIkpathsea\fR\|(3) +.PP +Email bug reports to tex\-k@tug.org. +.PP +Source is at <http://mirror.ctan.org/dviware/dviljk/>; but for +compilation the texk build environment is needed, from +<svn://tug.org/texlive/*/Build/source>. +.PP +As of July 2007, \s-1PCL\s0 reference documentation is found at \s-1HP\s0's Web site +at +<http://h20000.www2.hp.com/bizsupport/TechSupport/Document.jsp?objectID=bpl04568>. +At the end of that page are links to reference manuals for \s-1PCL\s0 and \s-1PJL\s0. +.PP +In case that page is changed, here are the URLs of these documents. +All have the form +<http://h20000.www2.hp.com/bc/docs/support/SupportManual/bpl<\s-1ID\s0>/bpl<\s-1ID\s0>.pdf>, +where \f(CW\*(C`<ID>\*(C'\fR is the following document \s-1ID:\s0 +.IP "\fB13205\fR" 4 +.IX Item "13205" +\&\s-1PCL\s0 5 Technical Quick Reference Guide. This is the 1st thing to look up +if you have questions about \s-1PCL\s0 escape sequences. +.IP "\fB13210\fR and \fB13211\fR" 4 +.IX Item "13210 and 13211" +\&\s-1PCL\s0 5 Technical Reference Manual (part I and \s-1II\s0). This is the +full-detailled explanation that you need to look up if you don't +understand how the printer works. Part I is the actual manual, part \s-1II\s0 +explains \s-1HP\-GL/2\s0 and has overall tips. +.IP "\fB13208\fR and \fB13207\fR" 4 +.IX Item "13208 and 13207" +\&\s-1PJL\s0 Technical Reference Manual (and addendum) +.IP "\fB13212\fR" 4 +.IX Item "13212" +\&\s-1PCL\s0 5 Color Manual. This explains color specials for the newer \s-1HP\s0 +printers. (Not of much use today; for practical purposes we would need +to add color specials to \fBdvilj\fR first.) +.IP "\fB13206\fR and \fB13209\fR" 4 +.IX Item "13206 and 13209" +Comparison Guide (and addendum) that documents which \s-1PCL\s0 escape +sequences are supported on which \s-1HP\s0 printers. +.SH "AUTHOR" +.IX Header "AUTHOR" +dvi2xx by Gustaf Neumann, Wirtschaftsuniversitaet Wien. +.PP +dviljk fork by Karl Berry. +.PP +Joachim Schrod <jschrod@acm.org> supplied security fixes and updated +this man page. +.SH "LICENSE" +.IX Header "LICENSE" +dvi2xx is public domain software. dviljk changes are covered by the +\&\s-1GNU\s0 General Public License. diff --git a/Master/texmf-dist/doc/man/man1/dvilj.man1.pdf b/Master/texmf-dist/doc/man/man1/dvilj.man1.pdf Binary files differnew file mode 100644 index 00000000000..e095f4ce198 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvilj.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/dvilj2p.1 b/Master/texmf-dist/doc/man/man1/dvilj2p.1 new file mode 100644 index 00000000000..e133513e289 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvilj2p.1 @@ -0,0 +1 @@ +.so man1/dvilj.1 diff --git a/Master/texmf-dist/doc/man/man1/dvilj2p.man1.pdf b/Master/texmf-dist/doc/man/man1/dvilj2p.man1.pdf Binary files differnew file mode 100644 index 00000000000..70b40b341d9 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvilj2p.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/dvilj4.1 b/Master/texmf-dist/doc/man/man1/dvilj4.1 new file mode 100644 index 00000000000..e133513e289 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvilj4.1 @@ -0,0 +1 @@ +.so man1/dvilj.1 diff --git a/Master/texmf-dist/doc/man/man1/dvilj4.man1.pdf b/Master/texmf-dist/doc/man/man1/dvilj4.man1.pdf Binary files differnew file mode 100644 index 00000000000..22ede011923 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvilj4.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/dvilj4l.1 b/Master/texmf-dist/doc/man/man1/dvilj4l.1 new file mode 100644 index 00000000000..e133513e289 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvilj4l.1 @@ -0,0 +1 @@ +.so man1/dvilj.1 diff --git a/Master/texmf-dist/doc/man/man1/dvilj4l.man1.pdf b/Master/texmf-dist/doc/man/man1/dvilj4l.man1.pdf Binary files differnew file mode 100644 index 00000000000..21d8d0962bb --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvilj4l.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/dvilj6.1 b/Master/texmf-dist/doc/man/man1/dvilj6.1 new file mode 100644 index 00000000000..e133513e289 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvilj6.1 @@ -0,0 +1 @@ +.so man1/dvilj.1 diff --git a/Master/texmf-dist/doc/man/man1/dvilj6.man1.pdf b/Master/texmf-dist/doc/man/man1/dvilj6.man1.pdf Binary files differnew file mode 100644 index 00000000000..5e142d3aed8 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvilj6.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/dvipdfm.1 b/Master/texmf-dist/doc/man/man1/dvipdfm.1 new file mode 100644 index 00000000000..b72633f76ae --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvipdfm.1 @@ -0,0 +1,358 @@ +.de EX +.sp +.in +5 +.nf +.ft CW +.. +.de EE +.in -5 +.ft R +.sp +.fi +.. +.TH "DVIPDFM" "1" "28 April 2011" "20120420" "DVIPDFMx" +.SH NAME +dvipdfm \- produce PDF files directly from DVI files + +.SH SYNOPSIS +.B dvipdfm +.RI [ options ] +.I file\c +.RB [ .dvi ] + +.SH DESCRIPTION +In TeX Live, +.B dvipdfm +is another incarnation of +.B dvipdfmx +rather than a separate program. Compatibility is attempted as best as +possible. (The change was made due to duplicated security and +configuration issues arising repeatedly.) Please report problems with +this +.B dvipdfm +to the +.B dvipdfmx +maintainers at dvipdfmx (at) ktug.or.kr. + +The program +.B dvipdfm +generates a +.SM PDF +file from a +.SM DVI +file. +.SM DVI +files are the output format +produced by TeX. +Output from +.B groff +can be converted to +.SM DVI +format +using +.BR grodvi . + +The program +.B dvipdfm +recognizes several commonly used +.BR \especial +commands, which are extensions to the +.SM 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 +so that many +macro packages produced for use with +.B dvips +will work with +.B dvipdfm. +Dvipdfm understands its own specific +.B \especial +commands to allow access to PDF features +such as annotations and bookmarks. + +For issues related to bounding boxes (and hence image sizes), please see +.BR extractbb (1). + +.SH OPTIONS + +.TP 5 +.B \-\^c +Ignore color +.BR \especials . +The +.B \-\^c +toggles a flag that disables color +.B \especial +processing. +Unless changed in the configuration file, +that flag is off, and color +.BR \especial "s" +are interpreted normally. +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 \-\^d +Remove thumbnail images after including them. +(See the +.B \-\^t +option for more information.) + +.TP 5 +.B \-\^e +Toggle partial font embedding flag. If partial +font embedding is off, embedded fonts are +.I fully +embedded. +The default, if not changed in the configuration file, +is to embed only those glyphs actually used in the document. + +.TP 5 +.B \-\^f map_file +Set the name of the font map file to +.IR map_file . +The format of the font map file +is documented in the +.IR "Dvipdfm User's Manual" . + +.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 " name" +Generate PDF output file having the name +.IR name . +By default, the name of the output +file 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 \-\^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. + +.TP 5 +.B \-\^s " page_specifications" +Select the pages of the +.SM DVI +file to be converted. +The +.I page_specifications +consists of a comma separated list of +.I 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 implied to be the first page of the +.SM DVI +file. +An empty +.I last_page +is treated as the last page of the +.SM 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 +.SM DVI +file; +and +.TP 5 +.B "\-\^s 1\-10" +includes the first ten pages of the +.SM 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. +They must have the same base name +as the +.SM DVI +file and they must have the page number as the extension +to the file name. Dvipdfm does not +generate the thumbnails itself, but it is distributed with a wrapper +program named +.B dvipdft +that does so. + +.TP 5 +.B \-\^v +Increase verbosity. +Results of the +.B \-\^v +option are cumulative (e.g., +.B \-\^vv +) increases the verbosity by two increments. + +.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 bpt ", " 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 compression_level +Set the compression level to +.IR compression_level . +Compressions levels range from 0 (no compression) to +9 (maximum compression) and correspond to the values understood by zlib. + +.SH "IMAGE BOUNDING BOXES" + +When including images with +.BR dvipdfm , +their bounding boxes should be generated by running +.BR ebb , +or extractbb -m. +The result will be in an +.B .bb +file. + +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 Dvipdfm +uses the +.B kpathsea +library for locating the files that it opens. Hence, +the environment variables documented in the +.I Kpathsea library +documentation influence +.B dvipdfm. + +Dvipdfm also reads the following environment variables: + +.TP 5 +TMP +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=dvipdfm \-format='other text files' config +.fi + +.TP 5 +.I config +Startup options + +.TP 5 +.I t1fonts.map +The default font map file (this name 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" +.BR dvipdft "(1), " +.BR tex "(1), " dvips "(1), " groff "(1), " grodvi "(1), " pic "(1), " +.BR extractbb "(1), " +and the +.I "Kpathsea library" +info documentation. + +.SH AUTHOR +Mark A. Wicks. But for the version in TeX Live, all bugs and other +reports should go to the +.B dvipdfmx +maintainers at dvipdfmx (at) ktug.or.kr. diff --git a/Master/texmf-dist/doc/man/man1/dvipdfm.man1.pdf b/Master/texmf-dist/doc/man/man1/dvipdfm.man1.pdf Binary files differnew file mode 100644 index 00000000000..889cf439be2 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvipdfm.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/dvipdft.1 b/Master/texmf-dist/doc/man/man1/dvipdft.1 new file mode 100644 index 00000000000..50646022ef0 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/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/Master/texmf-dist/doc/man/man1/dvipdft.man1.pdf b/Master/texmf-dist/doc/man/man1/dvipdft.man1.pdf Binary files differnew file mode 100644 index 00000000000..fb58e415c4a --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvipdft.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/dvipng.1 b/Master/texmf-dist/doc/man/man1/dvipng.1 new file mode 100644 index 00000000000..934a7c9aac5 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvipng.1 @@ -0,0 +1,521 @@ +.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "DVIPNG 1" +.TH DVIPNG 1 "2010-12-15" "dvipng 1.14" "User commands" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +dvipng \- A DVI\-to\-PNG translator +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +dvipng [options] filename +.PP +dvipng [options] [filename] \- +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +This program makes \s-1PNG\s0 and/or \s-1GIF\s0 graphics from \s-1DVI\s0 files as obtained +from TeX and its relatives. +.PP +If \s-1GIF\s0 support is enabled, \s-1GIF\s0 output is chosen by using the +\&\fBdvigif\fR binary or with the \fB\-\-gif\fR option. +.PP +The benefits of \fBdvipng\fR/\fBdvigif\fR include +.IP "\(bu" 4 +Speed. It is a very fast bitmap-rendering code for \s-1DVI\s0 files, which +makes it suitable for generating large amounts of images on-the-fly, +as needed in preview-latex, WeBWorK and others. +.IP "\(bu" 4 +It does not read the postamble, so it can be started before TeX +finishes. There is a \fB\-\-follow\fR switch that makes dvipng wait at +end-of-file for further output, unless it finds the \s-1POST\s0 marker that +indicates the end of the \s-1DVI\s0. +.IP "\(bu" 4 +Interactive query of options. dvipng can read options interactively +through stdin, and all options are usable. It is even possible to change +the input file through this interface. +.IP "\(bu" 4 +Supports \s-1PK\s0, \s-1VF\s0, PostScript Type1, and TrueType fonts, subfonts (i.e., +as used in CJK-LaTeX), color specials, and inclusion of PostScript, +\&\s-1PNG\s0, \s-1JPEG\s0 or \s-1GIF\s0 images. +.IP "\(bu" 4 +and more... +.SH "OPTIONS" +.IX Header "OPTIONS" +Many of the parameterless options listed here can be turned off by +suffixing the option with a zero (\fB0\fR); for instance, to turn off +page reversal, use \fB\-r0\fR. Such options are marked with a trailing +\&\fB*\fR. +.IP "\fB\-\fR" 4 +.IX Item "-" +Read additional options from standard input after processing the command +line. +.IP "\fB\-\-help\fR" 4 +.IX Item "--help" +Print a usage message and exit. +.IP "\fB\-\-version\fR" 4 +.IX Item "--version" +Print the version number and exit. +.IP "\fB\-bd\fR \fInum\fR" 4 +.IX Item "-bd num" +.PD 0 +.IP "\fB\-bd\fR \fIcolor_spec\fR" 4 +.IX Item "-bd color_spec" +.IP "\fB\-bd '\fR\fInum\fR\fB \fR\fIcolor_spec\fR\fB'\fR" 4 +.IX Item "-bd 'num color_spec'" +.PD +Set the pixel width of the transparent border (default 0). Using this +option will make the image edges transparent, but it only affects pixels +with the background color. Giving a \fIcolor_spec\fR will set the +fallback color, to be used in viewers that cannot handle transparency +(the default is the background color). The color spec should be in +TeX color \especial syntax, e.g., 'rgb 1.0 0.0 0.0'. Setting the +fallback color makes the default border width 1 px. +.IP "\fB\-\-bdpi\fR \fInum\fR" 4 +.IX Item "--bdpi num" +This option only has an effect when using bitmapped (\s-1PK\s0) fonts. The +option sets the base (Metafont) resolution, both horizontal and +vertical, to \fInum\fR dpi (dots per inch). This option is necessary +when manually selecting Metafont mode with the \-\-mode option (see +below). +.IP "\fB\-bg\fR \fIcolor_spec\fR" 4 +.IX Item "-bg color_spec" +Choose background color for the images. This option will be ignored if +there is a background color \especial in the \s-1DVI\s0. The color spec should +be in TeX color \especial syntax, e.g., 'rgb 1.0 0.0 0.0'. You can +also specify 'Transparent' or 'transparent' which will give you a +transparent background with the normal background as a fallback color. A +capitalized 'Transparent' will give a full-alpha transparency, while an +all-lowercase 'transparent' will give a simple fully transparent +background with non-transparent antialiased pixels. The latter would be +suitable for viewers who cannot cope with a true alpha channel. \s-1GIF\s0 +images do not support full alpha transparency, so in case of \s-1GIF\s0 output, +both variants will use the latter behaviour. +.IP "\fB\-d\fR \fInum\fR" 4 +.IX Item "-d num" +Set the debug flags, showing what dvipng (thinks it) is doing. This will +work unless dvipng has been compiled without the \f(CW\*(C`DEBUG\*(C'\fR option +(not recommended). Set the flags as you need them, use \fB\-d \-1\fR as +the first option for maximum output. +.IP "\fB\-D\fR \fInum\fR" 4 +.IX Item "-D num" +Set the output resolution, both horizontal and vertical, to \fInum\fR +dpi (dots per inch). +.Sp +One may want to adjust this to fit a certain text font size (e.g., on +a web page), and for a text font height of \fIfont_px\fR pixels (in +Mozilla) the correct formula is +.Sp +.Vb 1 +\& <dpi> = <font_px> * 72.27 / 10 [px * TeXpt/in / TeXpt] +.Ve +.Sp +The last division by ten is due to the standard font height 10pt in +your document, if you use 12pt, divide by 12. Unfortunately, some +proprietary browsers have font height in pt (points), not pixels. You +have to rescale that to pixels, using the screen resolution (default +is usually 96 dpi) which means the formula is +.Sp +.Vb 1 +\& <font_px> = <font_pt> * 96 / 72 [pt * px/in / (pt/in)] +.Ve +.Sp +On some high-res screens, the value is instead 120 dpi. Good luck! +.IP "\fB\-\-depth*\fR" 4 +.IX Item "--depth*" +Report the depth of the image. This only works reliably when the +LaTeX style \fIpreview.sty\fR from preview-latex is used with +the \fBactive\fR option. It reports the number of pixels from the +bottom of the image to the baseline of the image. This can be used for +vertical positioning of the image in, e.g., web documents, where one +would use (Cascading StyleSheets 1) +.Sp +.Vb 1 +\& <IMG SRC="<filename.png>" STYLE="vertical\-align: \-<depth>px"> +.Ve +.Sp +The depth is a negative offset in this case, so the minus sign is +necessary, and the unit is pixels (px). +.IP "\fB\-\-dvinum*\fR" 4 +.IX Item "--dvinum*" +Set this option to make the output page number be the TeX page +numbers rather than the physical page number. See the \fB\-o\fR switch. +.IP "\fB\-fg\fR \fIcolor_spec\fR" 4 +.IX Item "-fg color_spec" +Choose foreground color for the images. This option will be ignored if +there is a foreground color \especial in the \s-1DVI\s0. The color spec should +be in TeX color \especial syntax, e.g., 'rgb 1.0 0.0 0.0'. +.IP "\fB\-\-follow*\fR" 4 +.IX Item "--follow*" +Wait for data at end-of-file. One of the benefits of dvipng is that it +does not read the postamble, so it can be started before TeX +finishes. This switch makes dvipng wait at end-of-file for further +output, unless it finds the \s-1POST\s0 marker that indicates the end of the +\&\s-1DVI\s0. This is similar to \fBtail \-f\fR but for DVI-to-PNG conversion. +.IP "\fB\-\-freetype*\fR" 4 +.IX Item "--freetype*" +Enable/disable FreeType font rendering (default on). This option is +available if the FreeType2 font library was present at compilation time. +If this is the case, dvipng will have direct support for PostScript +Type1 and TrueType fonts internally, rather than using \fBgsftopk\fR +for rendering the fonts. If you have PostScript versions of Computer +Modern installed, there will be no need to generate bitmapped (\s-1PK\s0) +variants on disk of these. Then, you can render images at different (and +unusual) resolutions without cluttering the disk with lots of bitmapped +fonts. Note that if you have both FreeType and T1lib on your system, +FreeType will be preferred by dvipng. If you for some reason would want +to use T1lib rendering, use this option. +.IP "\fB\-\-gamma\fR \fInum\fR" 4 +.IX Item "--gamma num" +Control the interpolation of colors in the greyscale anti-aliasing +color palette. Default value is 1.0. For 0 < \fInum\fR < 1, the +fonts will be lighter (more like the background), and for \fInum\fR > +1, the fonts will be darker (more like the foreground). +.IP "\fB\-\-gif*\fR" 4 +.IX Item "--gif*" +The images are output in the \s-1GIF\s0 format, if \s-1GIF\s0 support is enabled. +This is the default for the \fBdvigif\fR binary, which only will be +available when \s-1GIF\s0 support is enabled. \s-1GIF\s0 images are palette images +(see the \fB\-\-palette\fR option) and does not support true alpha +channels (see the \fB\-\-bg\fR option). See also the \fB\-\-png\fR +option. +.IP "\fB\-\-height*\fR" 4 +.IX Item "--height*" +Report the height of the image. This only works reliably when the +LaTeX style \fIpreview.sty\fR from preview-latex is used with +the \fBactive\fR option. It reports the number of pixels from the top +of the image to the baseline of the image. The total height of the +image is obtained as the sum of the values reported from +\&\fB\-\-height\fR and \fB\-\-depth\fR. +.IP "\fB\-l [=]\fR\fInum\fR" 4 +.IX Item "-l [=]num" +The last page printed will be the first one numbered \fInum\fR. Default +is the last page in the document. If \fInum\fR is prefixed by an equals +sign, then it (and the argument to the \fB\-p\fR option, if specified) +is treated as a physical (absolute) page number, rather than a value to +compare with the TeX \fB\ecount0\fR values stored in the \s-1DVI\s0 file. +Thus, using \fB\-l =9\fR will end with the ninth page of the document, +no matter what the pages are actually numbered. +.IP "\fB\-\-mode\fR \fImode\fR" 4 +.IX Item "--mode mode" +This option only has an effect when using bitmapped (\s-1PK\s0) fonts. Use +\&\fImode\fR as the Metafont device name for the \s-1PK\s0 fonts (both for path +searching and font generation). This needs to be augmented with the base +device resolution, given with the \fB\-\-bdpi\fR option. See the file +<\fBftp://ftp.tug.org/tex/modes.mf\fR> for a list of resolutions and mode +names for most devices. +.IP "\fB\-M*\fR" 4 +.IX Item "-M*" +This option only has an effect when using bitmapped (\s-1PK\s0) fonts. It turns +off automatic \s-1PK\s0 font generation (\fImktexpk\fR). +.IP "\fB\-\-nogs*\fR" 4 +.IX Item "--nogs*" +This switch prohibits the internal call to GhostScript for displaying +PostScript specials. \fB\-\-nogs0\fR turns the call back on. +.IP "\fB\-\-nogssafer*\fR" 4 +.IX Item "--nogssafer*" +Normally, if GhostScript is used to render PostScript specials, the +GhostScript interpreter is run with the option \fB\-dSAFER\fR. The +\&\fB\-\-nogssafer\fR option runs GhostScript without \fB\-dSAFER\fR. The +\&\fB\-dSAFER\fR option in Ghostscript disables PostScript operators such +as deletefile, to prevent possibly malicious PostScript programs from +having any effect. +.IP "\fB\-\-norawps*\fR" 4 +.IX Item "--norawps*" +Some packages generate raw PostScript specials, even non-rendering such +specials. This switch turns off the internal call to GhostScript +intended to display these raw PostScript specials. \fB\-\-norawps0\fR +turns the call back on. +.IP "\fB\-o\fR \fIname\fR" 4 +.IX Item "-o name" +Send output to the file \fIname\fR. A single occurrence of \fB\f(CB%d\fB\fR or +\&\fB\f(CB%01d\fB\fR, ..., \fB\f(CB%09d\fB\fR will be exchanged for the physical +page number (this can be changed, see the \fB\-\-dvinum\fR switch). The +default output filename is \fIfile\fR\fB\f(CB%d\fB.png\fR where the input \s-1DVI\s0 +file was \fIfile\fR\fB.dvi\fR. +.IP "\fB\-O\fR \fIx\-offset\fR\fB,\fR\fIy\-offset\fR" 4 +.IX Item "-O x-offset,y-offset" +Move the origin by \fIx\-offset\fR,\fIy\-offset\fR, a comma-separated +pair of dimensions such as \fB.1in,\-.3cm\fR. +The origin of the page is shifted from the default position +(of one inch down, one inch to the right from the upper left corner of +the paper) by this amount. +.IP "\fB\-p [=]\fR\fInum\fR" 4 +.IX Item "-p [=]num" +The first page printed will be the first one numbered \fInum\fR. Default +is the first page in the document. If \fInum\fR is prefixed by an +equals sign, then it (and the argument to the \fB\-l\fR option, if +specified) is treated as a physical (absolute) page number, rather than +a value to compare with the TeX \fB\ecount0\fR values stored in the +\&\s-1DVI\s0 file. Thus, using \fB\-p =3\fR will start with the third page of +the document, no matter what the pages are actually numbered. +.IP "\fB\-\-palette*\fR" 4 +.IX Item "--palette*" +When an external image is included, \fBdvipng\fR will automatically +switch to truecolor mode, to avoid unnecessary delay and quality +reduction, and enable the \s-1EPS\s0 translator to draw on a transparent +background and outside of the boundingbox. This switch will force +palette (256\-color) output and make \fBdvipng\fR revert to opaque +clipped image inclusion. This will also override the \fB\-\-truecolor\fR +switch if present. +.IP "\fB\-\-picky*\fR" 4 +.IX Item "--picky*" +No images are output when a warning occurs. Normally, dvipng will +output an image in spite of a warning, but there may be something +missing in this image. One reason to use this option would be if you +have a more complete but slower fallback converter. Mainly, this is +useful for failed figure inclusion and unknown \especial occurrences, +but warnings will also occur for missing or unknown color specs and +missing \s-1PK\s0 fonts. +.IP "\fB\-\-png*\fR" 4 +.IX Item "--png*" +The images are output in the \s-1PNG\s0 format. This is the default for the +\&\fBdvipng\fR binary. See also the \fB\-\-gif\fR option. +.IP "\fB\-pp\fR \fIfirstpage\fR\fB\-\fR\fIlastpage\fR" 4 +.IX Item "-pp firstpage-lastpage" +Print pages \fIfirstpage\fR through \fIlastpage\fR; but not quite +equivalent to \fB\-p\fR \fIfirstpage\fR \fB\-l\fR \fIlastpage\fR. For example, +when rendering a book, there may be several instances of a page in the +\&\s-1DVI\s0 file (one in \f(CW\*(C`\efrontmatter\*(C'\fR, one in \f(CW\*(C`\emainmatter\*(C'\fR, and one +in \f(CW\*(C`\ebackmatter\*(C'\fR). In case of several pages matching, \fB\-pp\fR +\&\fIfirstpage\fR\fB\-\fR\fIlastpage\fR will render \fIall\fR pages that +matches the specified range, while \fB\-p\fR \fIfirstpage\fR \fB\-l\fR +\&\fIlastpage\fR will render the pages from the \fIfirst\fR occurrence +of \fIfirstpage\fR to the \fIfirst\fR occurrence of \fIlastpage\fR. +This is the (undocumented) behaviour of dvips. In dvipng you can give +both kinds of options, in which case you get all pages that matches the +range in \fB\-pp\fR between the pages from \fB\-p\fR to \fB\-l\fR. Also +multiple \fB\-pp\fR options accumulate, unlike \fB\-p\fR and \fB\-l\fR. +The \fB\-\fR separator can also be \fB:\fR. Note that \fB\-pp \-1\fR +will be interpreted as \*(L"all pages up to and including 1\*(R", if you want a +page numbered \-1 (only the table of contents, say) put \fB\-pp \-1\-\-1\fR, +or more readable, \fB\-pp \-1:\-1\fR. +.IP "\fB\-q*\fR" 4 +.IX Item "-q*" +Run quietly. Don't chatter about pages converted, etc. to standard +output; report no warnings (only errors) to standard error. +.IP "\fB\-Q\fR \fInum\fR" 4 +.IX Item "-Q num" +Set the quality to \fInum\fR. That is, choose the number of antialiasing +levels for bitmapped fonts (\s-1PK\s0) and fonts rendered using T1lib, to be +\&\fInum\fR*\fInum\fR+1. The default value is 4 which gives 17 levels of +antialiasing for antialiased fonts from these two. If FreeType is +available, its rendering is unaffected by this option. +.IP "\fB\-r*\fR" 4 +.IX Item "-r*" +Toggle output of pages in reverse/forward order. By default, the first +page in the \s-1DVI\s0 is output first. +.IP "\fB\-\-strict*\fR" 4 +.IX Item "--strict*" +The program exits when a warning occurs. Normally, dvipng will output +an image in spite of a warning, but there may be something missing in +this image. One reason to use this option would be if you have a more +complete but slower fallback converter. See the \fB\-\-picky\fR option +above for a list of when warnings occur. +.IP "\fB\-T\fR \fIimage_size\fR" 4 +.IX Item "-T image_size" +Set the image size to \fIimage_size\fR which can be either of +\&\fBbbox\fR, \fBtight\fR, or a comma-separated pair of dimensions +\&\fIhsize\fR,\fIvsize\fR such as \fB.1in,.3cm\fR. The default is +\&\fBbbox\fR which produces a \s-1PNG\s0 that includes all ink put on the page +and in addition the \s-1DVI\s0 origin, located 1in from the top and 1in from +the left edge of the paper. This usually gives whitespace above and to +the left in the produced image. The value \fBtight\fR will make dvipng +only include all ink put on the page, producing neat images. +.IP "\fB\-\-t1lib*\fR" 4 +.IX Item "--t1lib*" +Enable T1lib font rendering (default on). This option is available if +the T1lib font library was present at compilation time. If this is the +case, dvipng will have direct support for PostScript Type1 fonts +internally, rather than using \fBgsftopk\fR for rendering the fonts. If +you have PostScript versions of Computer Modern installed, there will be +no need to generate bitmapped variants on disk of these. Then, you can +render images at different (and unusual) resolutions without cluttering +the disk with lots of bitmapped fonts. Note that if you have both +FreeType and T1lib on your system, FreeType will be preferred by dvipng, +and if you for some reason rather want to use T1lib, give the option +\&\fB\-\-freetype0\fR (see above). +.IP "\fB\-\-truecolor*\fR" 4 +.IX Item "--truecolor*" +This will make \fBdvipng\fR generate truecolor output. Note that +truecolor output is automatic if you include an external image in your +\&\s-1DVI\s0, e.g., via a PostScript special (i.e., the \fBgraphics\fR or +\&\fBgraphicx\fR package). This switch is overridden by the +\&\fB\-\-palette\fR switch. +.IP "\fB\-v*\fR" 4 +.IX Item "-v*" +Enable verbose operation. This will currently indicate what fonts is +used, in addition to the usual output. +.IP "\fB\-\-width*\fR" 4 +.IX Item "--width*" +Report the width of the image. See also \fB\-\-height\fR and +\&\fB\-\-depth\fR. +.IP "\fB\-x\fR \fInum\fR" 4 +.IX Item "-x num" +This option is deprecated; it should not be used. It is much better to +select the output resolution directly with the \fB\-D\fR option. This +option sets the magnification ratio to \fInum\fR/1000 and +overrides the magnification specified in the \s-1DVI\s0 file. Must be between +10 and 100000. It is recommended that you use standard magstep values +(1095, 1200, 1440, 1728, 2074, 2488, 2986, and so on) to help reduce the +total number of \s-1PK\s0 files generated. \fInum\fR may be a real number, not +an integer, for increased precision. +.IP "\fB\-z\fR \fInum\fR" 4 +.IX Item "-z num" +Set the \s-1PNG\s0 compression level to \fInum\fR. This option is enabled if +your \fBlibgd\fR is new enough. The default compression level is 1, +which selects maximum speed at the price of slightly larger PNGs. For an +older \fBlibgd\fR, the hard-soldered value 5 is used. The include file +\&\fBpng.h\fR says +\&\*(L"Currently, valid values range from 0 \- 9, corresponding directly to +the zlib compression levels 0 \- 9 (0 \- no compression, 9 \- \*(R"maximal\*(L" +compression). Note that tests have shown that zlib compression levels +3\-6 usually perform as well as level 9 for \s-1PNG\s0 images, and do +considerably fewer calculations. In the future, these values may not +correspond directly to the zlib compression levels.\*(R" +.SH "NOTES" +.IX Header "NOTES" +The full manual is accessible in info format, on most systems by typing +.PP +.Vb 1 +\& info dvipng +.Ve +.SH "COPYRIGHT" +.IX Header "COPYRIGHT" +This program is released under the \s-1GNU\s0 Lesser General Public License +version 3, see the \s-1COPYING\s0 file in the dvipng distribution or +<\fBhttp://www.gnu.org/licenses/gpl.html\fR>. +.PP +Copyright (c) 2002\-2010 Jan-AAke Larsson diff --git a/Master/texmf-dist/doc/man/man1/dvipng.man1.pdf b/Master/texmf-dist/doc/man/man1/dvipng.man1.pdf Binary files differnew file mode 100644 index 00000000000..82b64f33ce5 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvipng.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/dvipos.1 b/Master/texmf-dist/doc/man/man1/dvipos.1 new file mode 100644 index 00000000000..b62172e3fae --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvipos.1 @@ -0,0 +1,153 @@ +.TH "DVIPOS" "1" "January 2007" "dvipos 20070107 (KPATHSEA)" "ConTeXt" +.de URL +\\$2 \(laURL: \\$1 \(ra\\$3 +.. +.if \n[.g] .mso www.tmac +.de EX +.in +3 +.nf +.ft CW +.. +.de EE +.in -3 +.ft R +.fi +.. + +.SH NAME +dvipos \- compute positions in a DVI file + +.SH SYNOPSIS +\fBdvipos\fP [ \fIOPTION\fP... ] \fIinfile[.dvi]\fP + +.SH DESCRIPTION +\fBdvipos\fP parses a DVI file looking for \fIpos:\fP specials. It +currently recognizes \fIpos:pxy\fP, \fIpos:pxywhd\fP, +\fIpos:pxyplus\fP, \fIpos:begbox\fP, \fIpos:endbox\fP, +\fIpos:beglines\fP, and \fIpos:endlines\fP. It then outputs the +information from those specials along with information that only a DVI +postprocessor could determine, such as the current \fIx\fP and \fIy\fP +location. The output looks like: +.EX +\\pospxywhd{text:54}{54}{10663sp}{8535sp}{21326sp}{34081sp}{0sp} +.EE +and is suitable for including in a +.BR tex (1) +or +.BR pdftex (1) +auxilliary file, such as \fIdocument.tuo\fP, to be read in by the next +run of the +.BR tex (1) +or similar typesetting engine. + +.SH OPTIONS + +.TP +\fB-h, --help\fR +print usage. +.TP +\fB-W, --warning\fR +print warnings. +.TP +\fB-v, --verbose\fR +print verbose output. +.TP +\fB-d, --debug\fR +print +.BR dvitype (1) +debugging data. +.TP +\fB-s, --smashchars\fR +regard height and depth as zero. +.TP +\fB-o, --output=\fIFILE\fR +send all output to FILE. Without this option, output goes to stdout. +.TP +\fB-b, --bbox[=\fP\fIFILE\fP]\fR +send bounding box to FILE (default FILE is \fIinfile.pos\fP). +.TP +\fB-f, --framed[=\fP\fIBASE\fP]\fR +request copy of DVI file, \fIBASE.dvi\fP, with bounding boxes +\fBframed\fP (default FILE is \fIinfile_frames.dvi\fP). See the +\fB--framesize\fP option. +.TP +\fB-m, --mag=\fIINT\fR +override +.BR tex (1) +magnification by INT. +.TP +\fB-w, --framesize=\fIINT\fR +set frame rule size by INT (default 6554 = .1pt). +.TP +\fB-p, --pages=\fIX:Y\fR +set page ranges from X to Y. + +.SH USAGE +.B dvipos +is run mostly behind the scenes by ConTeXt's +.BR texexec (1) +between runs of +.BR tex (1) +or +.BR pdftex (1), +in order to provide information to and get information about +positional graphics. These graphics are provided by the MetaFun +interface to +.BR mpost (1). +\fBdvipos\fP is not used (or needed) in PDF-output mode but is +needed for DVI-output mode. +.BR pdftex (1) +starting with version 1.40 can produce position information even in +DVI mode, so once the ConTeXt macros take advantage of this feature, +the need for \fBdvipos\fP will fade. + +Until then, here is a typical use of \fBdvipos\fP: +.EX +dvipos notes.dvi +.EE +The position information that is output is collected by +.BR texexec (1) +to include in the \fInotes.tuo\fP auxilliary file to use in the next +run. + + +.SH EXAMPLES +.TP +Extract positions from \fIdoc.dvi\fP, with output to \fIdoc.loc\fP: +\f(CWdvipos -o doc.loc doc.dvi\fP +.TP +Same as above, but also send bbox information to \fIdoc.pos\fP: +\f(CWdvipos -b -o doc.loc doc.dvi\fP +.TP +Instead send bbox information to \fI/tmp/debug.pos\fP: +\f(CWdvipos -b=/tmp/debug.pos -o doc.loc doc.dvi\fP + +.SH "SEE ALSO" +.BR dvips (1), +.BR dvitype (1), +.BR mpost (1), +.BR pdftex (1), +.BR tex (1), +.BR texexec (1). + +For more about positional graphics, see the MetaFun documentation on +the +.URL "http://wiki.contextgarden.net/MetaFun" "ConTeXt wiki" . + +.SH BUGS +If you specify a file for the \fB-b\fP option, you must join the +option and name with \fB=\fP rather than (the more common) space: +.EX +dvipos -b=/tmp/debug.pos notes.dvi +.EE +works, but +.EX +dvipos -b /tmp/debug.pos notes.dvi +.EE +does not. + +.SH AUTHOR +.B dvipos +is written by Jin-Hwan Cho <chofchof@ktug.or.kr>. It is free +software (GPLv2 or later). This manpage was written by Sanjoy +Mahajan <sanjoy@mit.edu> and is in the public domain. diff --git a/Master/texmf-dist/doc/man/man1/dvipos.man1.pdf b/Master/texmf-dist/doc/man/man1/dvipos.man1.pdf Binary files differnew file mode 100644 index 00000000000..b40fd3ab717 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvipos.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/dvips.1 b/Master/texmf-dist/doc/man/man1/dvips.1 new file mode 100644 index 00000000000..c8bd77995d4 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvips.1 @@ -0,0 +1,531 @@ +.TH DVIPS 1 "4 May 2010" +.SH NAME +dvips \- convert a TeX DVI file to PostScript +.SH SYNOPSIS +.B dvips +.RI [ OPTIONS ] +.IR file [\fB.dvi\fP] +.SH DESCRIPTION +THIS MAN PAGE IS OBSOLETE! +See the Texinfo documentation instead. +You can read it either in Emacs or with the standalone +.B info +program which comes with the GNU texinfo distribution as +ftp.gnu.org:pub/gnu/texinfo/texinfo*.tar.gz. +.PP +The program +.B dvips +takes a DVI file +.IR file [\fB.dvi\fP] +produced by TeX (or by some other processor such as GFtoDVI) and +converts it to PostScript, sending the output to a file or directly to a +printer. The DVI file may be specified without the +.B .dvi +extension. Fonts used may either be resident in the printer or defined +as bitmaps in PK files, or a `virtual' combination of both. If the +.B mktexpk +program is installed, +.B dvips +will automatically invoke METAFONT to generate fonts that don't already +exist. +.PP +For more information, see the Texinfo manual +.IR dvips.texi , +which should be installed somewhere on your system, hopefully accessible +through the standard Info tree. +.SH OPTIONS +.TP +.B -a +Conserve memory by making three passes over the .dvi file instead of two +and only loading those characters actually used. Generally only useful +on machines with a very limited amount of memory, like some PCs. +.TP +.B -A +Print only odd pages (TeX pages, not sequence pages). +.TP +.B -b num +Generate +.I num +copies of each page, but duplicating the page body rather than using the +.I #numcopies +option. This can be useful in conjunction with a header file setting +.I \ebop-hook +to do color separations or other neat tricks. +.TP +.B -B +Print only even pages (TeX pages, not sequence pages). +.TP +.B -c num +Generate +.I num +copies of every page. Default is 1. (For collated copies, see the +.I -C +option below.) +.TP +.B -C num +Create +.I num +copies, but collated (by replicating the data in the PostScript file). +Slower than the +.I -c +option, but easier on the hands, and faster than resubmitting the same +PostScript file multiple times. +.TP +.B -d num +Set the debug flags. This is intended only for emergencies or for +unusual fact-finding expeditions; it will work only if +.B dvips +has been compiled with the DEBUG option. If nonzero, prints additional +information on standard error. For maximum information, you can use +`-1'. See the Dvips Texinfo manual for more details. +.TP +.B -D num +Set the resolution in dpi (dots per inch) to +.IR num . +This affects the choice of bitmap fonts that are loaded and also the +positioning of letters in resident PostScript fonts. Must be between 10 +and 10000. This affects both the horizontal and vertical resolution. +If a high resolution (something greater than 400 dpi, say) is selected, +the +.I -Z +flag should probably also be used. +.TP +.B -e num +Make sure that each character is placed at most this many pixels from +its `true' resolution-independent position on the page. The default +value of this parameter is resolution dependent. Allowing individual +characters to `drift' from their correctly rounded positions by a few +pixels, while regaining the true position at the beginning of each new +word, improves the spacing of letters in words. +.TP +.B -E +makes +.B dvips +attempt to generate an EPSF file with a tight bounding box. This only +works on one-page files, and it only looks at marks made by characters +and rules, not by any included graphics. In addition, it gets the glyph +metrics from the +.I tfm +file, so characters that lie outside their enclosing +.I tfm +box may confuse it. In addition, the bounding box might be a bit too +loose if the character glyph has significant left or right side +bearings. Nonetheless, this option works well for creating small EPSF +files for equations or tables or the like. (Note, of course, that +.B dvips +output is resolution dependent and thus does not make very good EPSF +files, especially if the images are to be scaled; use these EPSF files +with a great deal of care.) +.TP +.B -f +Run as a filter. Read the +.I .dvi +file from standard input and write the PostScript to standard output. +The standard input must be seekable, so it cannot be a pipe. If you +must use a pipe, write a shell script that copies the pipe output to a +temporary file and then points +.B dvips +at this file. This option also disables the automatic reading of the +.I PRINTER +environment variable, and turns off the automatic sending of control D +if it was turned on with the +.I -F +option or in the configuration file; use +.I -F +after this option if you want both. +.TP +.B -F +Causes Control-D (ASCII code 4) to be appended as the very last +character of the PostScript file. This is useful when +.B dvips +is driving the printer directly instead of working through a spooler, +as is common on extremely small systems. NOTE! DO NOT USE THIS OPTION! +.TP +.B -G +Causes +.B dvips +to shift non-printing characters to higher-numbered positions. +This may be useful sometimes. +.TP +.B -h name +Prepend file +.I name +as an additional header file. (However, if the name is simply `-' +suppress all header files from the output.) This header file gets added +to the PostScript +.IR userdict . +.TP +.B -i +Make each section be a separate file. Under certain circumstances, +.B dvips +will split the document up into `sections' to be processed +independently; this is most often done for memory reasons. Using this +option tells +.B dvips +to place each section into a separate file; the new file names are +created replacing the suffix of the supplied output file name by a +three-digit sequence number. This option is most often used in +conjunction with the +.I -S +option which sets the maximum section length in pages. For instance, +some phototypesetters cannot print more than ten or so consecutive pages +before running out of steam; these options can be used to automatically +split a book into ten-page sections, each to its own file. +.TP +.B -j +Download only needed characters from Type 1 fonts. This is the +default in the current release. Some debugging flags trace this operation. +You can also control partial downloading on a per-font basis, via the +.B psfonts.map +file. +.TP +.B -k +Print crop marks. This option increases the paper size (which should be +specified, either with a paper size special or with the +.I -T +option) by a half inch in each dimension. It translates each page by a +quarter inch and draws cross-style crop marks. It is mostly useful with +typesetters that can set the page size automatically. +.TP +.B -K +This option causes comments in included PostScript graphics, font files, +and headers to be removed. This is sometimes necessary to get around +bugs in spoolers or PostScript post-processing programs. Specifically, +the %%Page comments, when left in, often cause difficulties. Use of +this flag can cause some included graphics to fail, since the PostScript +header macros from some software packages read portions of the input +stream line by line, searching for a particular comment. This option +has been turned off by default because PostScript previewers and +spoolers have been getting better. +.TP +.B -l num +The last page printed will be the first one numbered +.I num +Default is the last page in the document. If the +.I num +is prefixed by an equals sign, then it (and any argument to the +.I -p +option) is treated as a sequence number, rather than a value to compare +with +.I \ecount0 +values. Thus, using +.I -l =9 +will end with the ninth page of the document, no matter what the pages +are actually numbered. +.TP +.B -m +Specify manual feed for printer. +.TP +.B -mode mode +Use +.I mode +as the Metafont device name for path searching and font +generation. This overrides any value from configuration files. With +the default paths, explicitly specifying the mode also makes the program +assume the fonts are in a subdirectory named +.IR mode . +.TP +.B -M +Turns off the automatic font generation facility. If any fonts are +missing, commands to generate the fonts are appended to the file +.I missfont.log +in the current directory; this file can then be executed and deleted to +create the missing fonts. +.TP +.B -n num +At most +.I num +pages will be printed. Default is 100000. +.TP +.B -N +Turns off structured comments; this might be necessary on some systems +that try to interpret PostScript comments in weird ways, or on some +PostScript printers. Old versions of TranScript in particular cannot +handle modern Encapsulated PostScript. +.TP +.BR -noomega +This will disable the use of Omega extensions when interpreting DVI +files. By default, the additional opcodes +.I 129 +and +.I 134 +are recognized by dvips as Omega or pTeX extensions and interpreted as +requests to set 2-byte characters. +.TP +.BR -noptex +This will disable the use of pTeX extensions when interpreting DVI files. +By default, the additional opcodes +.I 130 +and +.I 135 +are recognized by dvips as pTeX extensions and interpreted as requests to +set 3-byte characters, and +.I 255 +as request to change the typesetting direction. +.sp +The only drawback is that the virtual font array will (at least temporarily) +require 65536 or more positions instead of the default 256 positions, i.e., +the memory requirements of dvips will be somewhat larger. If you find this +unacceptable or encounter another problem with the Omega or pTeX extensions, +you can switch off the pTeX extension by using +.BR -noptex , +or both by using +.B -noomega +(but please do send a bug report if you find such problems - see the bug +address in the +.B AUTHORS +section below). +.TP +.B -o name +The output will be sent to file +.I name +If no file name is given (i.e., -o is last on the command line), the +default name is +.I file.ps +where the .dvi file was called +.IR file.dvi ; +if this option isn't given, any default in the configuration file is +used. If the first character of the supplied output file name is an +exclamation mark, then the remainder will be used as an argument to +.IR popen ; +thus, specifying +.I !lpr +as the output file will automatically queue the file for printing. +This option also disables the automatic reading of the +.I PRINTER +environment variable, and turns off the automatic sending of control D +if it was turned on with the +.I -F +option or in the configuration file; use +.I -F +after this option if you want both. +.TP +.B -O offset +Move the origin by a certain amount. The +.I offset +is a comma-separated pair of dimensions, such as +.I .1in,-.3cm +(in the same syntax used in the +.I papersize +special). The origin of the page is shifted from the +default position (of one inch down, one inch to the right from the upper +left corner of the paper) by this amount. +.TP +.B -p num +The first page printed will be the first one numbered +.IR num . +Default is the first page in the document. If the +.I num +is prefixed by an equals sign, then it (and any argument to the +.I -l +option) is treated as a sequence number, rather than a value to compare +with +.I \ecount0 +values. Thus, using +.I -p =3 +will start with the third page of the document, no matter what the pages +are actually numbered. +.TP +.B -pp pagelist +A comma-separated list of pages and ranges (a-b) may be given, which +will be interpreted as +.I \ecount0 +values. Pages not specified will not be printed. Multiple +.B -pp +options may be specified or all pages and page ranges can be +specified with one +.B -pp +option. +.TP +.B -P printername +Sets up the output for the appropriate printer. This is implemented by +reading in +.I config.printername +, which can then set the output pipe (as in, +.I !lpr -Pprintername +as well as the font paths and any other +.I config.ps +defaults for that printer only. Note that +.I config.ps +is read before +.I config.printername +In addition, another file called +.I ~/.dvipsrc +is searched for immediately after +.IR config.ps ; +this file is intended for user defaults. If no +.I -P +command is given, the environment variable +.I PRINTER +is checked. If that variable exists, and a corresponding configuration +file exists, that configuration file is read in. +.TP +.B -q +Run in quiet mode. Don't chatter about pages converted, etc.; report +nothing but errors to standard error. +.TP +.B -r +Stack pages in reverse order. Normally, page 1 will be printed first. +.TP +.B -R[0|1|2] +Run securely. +.BR -R2 +disables both shell command execution in +.I \especial'{} +(via backticks +.BR ` +) and config files (via the +.I E +option), and opening of any absolute filenames. +.BR -R1 +, the default, forbids shell escapes but allows absolute filenames. +.BR -R0 +allows both. The config file option is +.I z +.TP +.B -s +Causes the entire global output to be enclosed in a save/restore pair. +This causes the file to not be truly conformant, and is thus not +recommended, but is useful if you are driving the printer directly and +don't care too much about the portability of the output. +.TP +.B -S num +Set the maximum number of pages in each `section'. This option is most +commonly used with the +.I -i +option; see that documentation above for more information. +.TP +.B -t papertype +This sets the paper type to +.IR papertype . +The +.I papertype +should be defined in one of the configuration files, along with the +appropriate code to select it. (Currently known types include +.BR letter , +.BR legal , +.BR ledger , +.BR a4 , +.BR a3 ). +You can also specify +.BR -t " " landscape , +which rotates a document by 90 degrees. To rotate a document whose size +is not letter, you can use the +.I -t +option twice, once for the page size, and once for landscape. +You should not use any +.I -t +option when the DVI file already contains a +.I papersize +special, as is done by some LaTeX packages, notably hyperref.sty. + +The upper left corner of each page in the +.I .dvi +file is placed one inch from the left and one inch from the top. Use of +this option is highly dependent on the configuration file. Note that +executing the +.B letter +or +.B a4 +or other PostScript operators cause the document to be nonconforming and +can cause it not to print on certain printers, so the paper size should +not execute such an operator if at all possible. +.TP +.B -T papersize +Set the paper size to the given pair of dimensions. This option takes +its arguments in the same style as +.IR -O . +It overrides any paper size special in the dvi file. +.TP +.B -u psmapfile +Set +.I psmapfile +to be the file that dvips uses for looking up PostScript font aliases. If +.I psmapfile +begins with a +.B + +character, then the rest of the name is used as the name of the map file, +and the map file is appended to the list of map files (instead of replacing +the list). In either case, if +.I psmapfile +has no extension, then +.B .map +is added at the end. +.TP +.B -U +Disable a PostScript virtual memory saving optimization that stores the +character metric information in the same string that is used to store +the bitmap information. This is only necessary when driving the Xerox +4045 PostScript interpreter. It is caused by a bug in that interpreter +that results in `garbage' on the bottom of each character. Not +recommended unless you must drive this printer. +.TP +.B -v +Print the +.B dvips +version number and exit. +.TP +.B -V +Download non-resident PostScript fonts as bitmaps. This requires use of +`gsftopk' or `pstopk' or some other such program(s) in order to generate +the required bitmap fonts; these programs are supplied with +.BR dvips . +.TP +.B -x num +Set the +magnification ratio to +.IR num /1000. +Overrides the magnification specified in the .dvi file. Must be +between 10 and 100000. Instead of an integer, +.I num +may be a real number for increased precision. +.TP +.B -X num +Set the horizontal resolution in dots per inch to +.IR num . +.TP +.B -y num +Set the +magnification ratio to +.IR num /1000 +times the magnification specified in the .dvi file. +See +.B -x +above. +.TP +.B -Y num +Set the vertical resolution in dots per inch to +.IR num . +.TP +.B -z +Pass +.B html +hyperdvi specials through to the output for eventual +distillation into PDF. This is not enabled by default to avoid +including the header files unnecessarily, and use of temporary files in +creating the output. +.TP +.B -Z +Causes bitmapped fonts to be compressed before they are downloaded, +thereby reducing the size of the PostScript font-downloading +information. Especially useful at high resolutions or when very large +fonts are used. Will slow down printing somewhat, especially on early +68000-based PostScript printers. +.SH "SEE ALSO" +mf(1), afm2tfm(1), tex(1), latex(1), lpr(1), +.IR dvips.texi , +http://tug.org/dvips. +.SH ENVIRONMENT +Dvipsk uses the same environment variables and algorithms for finding +font files as TeX and its friends do. See the documentation for the +Kpathsea library for details. (Repeating it here is too cumbersome.) +.PP +KPATHSEA_DEBUG: Trace Kpathsea lookups; set to -1 for complete tracing. +.PP +PRINTER: see above. +.SH NOTES +PostScript is a registered trademark of Adobe Systems Incorporated. +.SH AUTHOR +Tomas Rokicki <rokicki@cs.stanford.edu>; extended to virtual fonts +by Don Knuth. Path searching and configuration modifications by +Karl Berry. diff --git a/Master/texmf-dist/doc/man/man1/dvips.man1.pdf b/Master/texmf-dist/doc/man/man1/dvips.man1.pdf Binary files differnew file mode 100644 index 00000000000..ae1c25f7e8c --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvips.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/dvired.1 b/Master/texmf-dist/doc/man/man1/dvired.1 new file mode 100644 index 00000000000..f76e58087a3 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvired.1 @@ -0,0 +1,63 @@ +.TH dvired 1 "09/94" "teTeX" "teTeX" +.SH NAME +dvired \- print dvi-files +.SH SYNOPSIS +.B dvired +[ +.B options +] +.B file +.SH DESCRIPTION +.I dvired +behaves like +.IR dvips , +except for the fact that two logical pages are put onto each physical +sheet of paper. + +For +.IR options , +see +.IR dvips (1). +This program only interprets the following options: + +.I \-o file +\- redirect output into +.I file. + +.I \-P printer +\- direct output to +.I printer. + +.I \-f +\- direct output to stdout. + +Any other option is passed directly to +.IR dvips . + +.SH EXAMPLES +It is assumed that the PRINTER-variable is set. + +.B dvired \-Plw foo +\- send output to printer +.IR lw . +.br +.B dvired \-o foo.ps foo +\- send output to file +.IR foo.ps . +.br +.B dvired \-pp4-7 foo +\- send 4 pages (reduced onto 2 sheets) of +.I foo +to the printer. +.br +.B dvired foo \-f | ghostview \- +\- preview output with ghostview. + +.SH "SEE ALSO" +.IR dvips (1) +.SH BUGS +.I dvired +is fixed on A4 paper size. If you want to use it with other paper, you have +to change the settings within the source. +.SH AUTHOR +Thomas Esser <te@dbs.uni-hannover.de> diff --git a/Master/texmf-dist/doc/man/man1/dvired.man1.pdf b/Master/texmf-dist/doc/man/man1/dvired.man1.pdf Binary files differnew file mode 100644 index 00000000000..3b80e9055fa --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvired.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/dviselect.1 b/Master/texmf-dist/doc/man/man1/dviselect.1 new file mode 100644 index 00000000000..735cacd0ba7 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dviselect.1 @@ -0,0 +1,131 @@ +.\" Copyright (c) 1987-2012 UMD-CS, released under the X11 license; +.\" see README and source files. +.TH DVISELECT 1 +.SH NAME +dviselect \- extract pages from DVI files +.SH SYNOPSIS +.B dviselect +[ +.B \-s +] [ +.B \-i +.I infile +] [ +.B \-o +.I outfile +] +.I "list of pages" +[ +.I infile +[ +.I outfile +] ] +.SH DESCRIPTION +.I Dviselect +selects pages from a DVI file produced by TeX, +creating a new DVI file +usable by any of the TeX conversion programs, +or even by +.I dviselect +itself. +.PP +A +.I range +is a string of the form +.IR even , +.IR odd , +or +.I first:last +where both +.I first +and +.I last +are optional numeric strings, with negative numbers indicated by +a leading underscore character ``_''. If both +.I first +and +.I last +are omitted, the colon may also be omitted, or may be replaced +with an asterisk ``*''. A +.I page range +is a list of ranges separated by periods. A +.I "list of pages" +is described by a set of page ranges separated by commas and/or white space. +.PP +.I Dviselect +actually looks at the ten +.I count +variables that TeX writes; the first of these (\ecount0) is the +page number, with \ecount1 through \ecount9 having varied uses +depending on which macro packages are in use. (Typically \ecount1 +might be a chapter or section number.) A page is included in +.IR dviselect 's +output if all its \ecount values match any one of the ranges +listed on the command line. For example, the command +``dviselect *.1,35:'' +might select everything in chapter 1, as well as pages 35 and up. +``dviselect 10:30'' would select pages 10 through 30 (inclusive). +``:43'' means everything up to and including page 43 (including +negative-numbered pages). +To get all even-numbered pages, use ``even''; +to get all odd-numbered pages, use ``odd''. +If a Table of Contents has negative page numbers, ``:_1'' will select it. +Note that ``*'' must be quoted from the shell; +the empty string is more convenient to use, if harder to read. +.PP +Instead of \ecount values, +.I dviselect +can also select by ``absolute page number'', where the first page +is page 1, the second page 2, and so forth. Absolute page numbers +are indicated by a leading equal sign ``=''. Ranges of absolute +pages are also allowed: ``dviselect =3:7'' will extract the third +through seventh pages. Dot separators are not legal in absolute +ranges, and there are no negative absolute page numbers. +Even/odd specifiers, however, are legal; +``dviselect =even'' selects every other page, +starting with the second. +.PP +More precisely, an asterisk or an empty string implies no limit; +an equal sign means absolute page number rather than \ecounts; +a leading colon means everything up to and including the given page; a +trailing colon means everything from the given page on; +the word ``even'' means only even values shall be accepted; +the word ``odd'' means only odd values shall be accepted; and +a period indicates that the next \ecount should be examined. +If fewer than 10 ranges are specified, the remaining \ecounts +are left unrestricted (that is, ``1:5'' and ``1:5.*'' are equivalent). +A single number \fIn\fP is treated as if it were the range \fIn:n\fP. +An arbitrary number of page selectors may be given, separated by commas +or whitespace; a page is selected if any of the selectors matches +its \ecounts or absolute page number. +.PP +Dviselect normally prints the page numbers of the pages selected; the +.I \-s +option suppresses this. +.SH AUTHOR +Chris Torek, University of Maryland +.SH "SEE ALSO" +dviconcat(1), latex(1), tex(1) +.br +.I "MC-TeX User's Guide" +.br +.I "The TeXbook" +.SH BUGS +A leading ``-'' ought to be allowed for negative numbers, but it +is currently used as a synonym for ``:'', for backwards compatibility. +.PP +Section or subsection selection will sometimes fail, for the DVI +file lists only the \ecount values that were active when the page +ended. Clever macro packages can alleviate this by making use of +other ``free'' \ecount registers. Chapters normally begin on new +pages, and do not suffer from this particular problem. +.PP +The heuristic that decides which arguments are page selectors +and which are file names is often wrong. +Using shell redirection or the \-i and \-o options is safest. +.PP +.I Dviselect +does not adjust the parameters in the postamble; however, since these +values are normally used only to size certain structures in the output +conversion programs, and the parameters never need to be adjusted upward, +this has not proven to be a problem. diff --git a/Master/texmf-dist/doc/man/man1/dviselect.man1.pdf b/Master/texmf-dist/doc/man/man1/dviselect.man1.pdf Binary files differnew file mode 100644 index 00000000000..95e56039095 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dviselect.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/dvisvgm.1 b/Master/texmf-dist/doc/man/man1/dvisvgm.1 new file mode 100644 index 00000000000..0be9c2352ea --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvisvgm.1 @@ -0,0 +1,961 @@ +'\" t +.\" Title: dvisvgm +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/> +.\" Date: 03/09/2012 +.\" Manual: dvisvgm Manual +.\" Source: dvisvgm 1.0.11 +.\" Language: English +.\" +.TH "DVISVGM" "1" "03/09/2012" "dvisvgm 1\&.0\&.11" "dvisvgm Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +dvisvgm \- converts DVI files to the XML\-based SVG format +.SH "SYNOPSIS" +.sp +\fBdvisvgm\fR [ \fIoptions\fR ] \fIfile\fR [\&.dvi] +.SH "DESCRIPTION" +.sp +The command\-line utility \fBdvisvgm\fR converts DVI files, as generated by TeX/LaTeX, to the XML\-based scalable vector graphics format SVG\&. Since the current SVG standard 1\&.1 doesn\(cqt specify multi\-page graphics, dvisvgm creates separate SVG files for each DVI page\&. Because of compatibility reasons, only the first page is converted by default\&. In order to select a different page or arbitrary page sequences, use option \fB\-p\fR which is described below\&. +.sp +dvisvgm should properly convert all pages that are made up of fonts and rules only\&. However, the utility also supports a couple of DVI extensions defined in terms of \fIDVI specials\fR\&. For a more detailed overview, see section \fBsupport of specials\fR below\&. +.sp +As SVG is a vector based graphics format, dvisvgm tries to convert the glyph outlines of all used fonts into scalable path descriptions\&. The fastest way to do that is to extract the path information from PFB (PostScript Type 1) files\&. So, if dvisvgm is able to find a PFB file for a required font, it will read the necessary information from this file\&. +.sp +TeX\(cqs main source for font descriptions is Metafont though, which produces bitmap output\&. That\(cqs why not all obtainable TeX fonts are available in PFB format\&. In these cases, dvisvgm tries to vectorize Metafont\(cqs output (GF fonts) by tracing the glyph bitmaps\&. The results are not as perfect as most (manually optimized) PFB outlines but are nonetheless really nice in most cases\&. +.SH "OPTIONS" +.PP +\fB\-a, \-\-trace\-all\fR=[\fIretrace\fR] +.RS 4 +This option forces dvisvgm to trace not only the actually needed glyphs but all glyphs of all bitmap fonts used in the DVI file\&. Since the tracing results are stored in the font cache, all following DVI conversions (without option +\fB\-\-trace\-all\fR) where these fonts are involved, will be much faster\&. By default, dvisvgm traces only the actually needed glyphs, and adds them to the cache\&. The boolean option +\fIretrace\fR +determines how to handle glyphs already stored in the cache\&. By default, these glyphs are skipped\&. Setting argument +\fIretrace\fR +to +\fIyes\fR +or +\fItrue\fR +forces dvisvgm to trace the corresponding bitmaps again\&. +.if n \{\ +.sp +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBNote\fR +.ps -1 +.br +This option only takes affect if font caching is active\&. Thus, +\fB\-\-trace\-all\fR +cannot be combined with option +\fB\-\-cache=none\fR\&. +.sp .5v +.RE +.RE +.PP +\fB\-b, \-\-bbox\fR=\fIfmt\fR +.RS 4 +Sets the bounding box of the generated graphic to the specified format\&. The parameter +\fIfmt\fR +takes either one of the format specifiers listed below, or a sequence of four comma\- or whitespace\-separated length values +\fIx1\fR, +\fIy1\fR, +\fIx2\fR +and +\fIy2\fR\&. The latter define two diagonal corners of the bounding box\&. Each length value consists of a floating point number and an optional length unit (pt, bp, cm, mm, in, or pc)\&. If the unit is omitted, TeX points (pt) are assumed\&. +.sp +It\(cqs also possible to give only one length value +\fIl\fR\&. In this case, the minimal bounding box is computed and enlarged by adding (\-\fIl\fR,\-\fIl\fR) to the upper left and (\fIl\fR,\fIl\fR) to the lower right corner\&. +.sp +Alternatively, the following format specifiers are supported: +.PP +\fBInternational DIN/ISO paper sizes\fR +.RS 4 +A\fIn\fR, B\fIn\fR, C\fIn\fR, D\fIn\fR, where +\fIn\fR +is a non\-negative integer, e\&.g\&. A4 or a4 for DIN/ISO A4 format (210mm \(mu 297mm)\&. +.RE +.PP +\fBNorth American paper sizes\fR +.RS 4 +invoice, executive, legal, letter, ledger +.RE +.PP +\fBSpecial bounding box sizes\fR +.RS 4 +.TS +tab(:); +lt lt +lt lt +lt lt. +T{ +\fBdvi\fR +T}:T{ +page size stored in the DVI file +T} +T{ +\fBmin\fR +T}:T{ +computes the minimal/tightest bounding box +T} +T{ +\fBnone\fR +T}:T{ +no bounding box is assigned +T} +.TE +.sp 1 +.RE +.RE +.PP +\fBPage orientation\fR +.RS 4 +The default page orientation for DIN/ISO and American paper sizes is +\fIportrait\fR, i\&.e\&. +\fIwidth\fR +< +\fIheight\fR\&. Appending +\fB\-landscape\fR +or simply +\fB\-l\fR +to the format string switches to +\fIlandscape\fR +mode (\fIwidth\fR +> +\fIheight\fR)\&. For symmetry reasons you can also explicitly add +\fB\-portrait\fR +or +\fB\-p\fR +to indicate the default portrait format\&. Note that these suffixes are part of the size string and not separate options\&. Thus, they must directly follow the size specifier without additional blanks\&. Furthermore, the orientation suffixes can\(cqt be used with +\fBdvi\fR, +\fBmin\fR, and +\fBnone\fR\&. +.if n \{\ +.sp +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBNote\fR +.ps -1 +.br +Option +\fB\-b, \-\-bbox\fR +only affects the bounding box and does not transform the page content\&. Hence, if you choose a landscape format, the page won\(cqt be rotated\&. +.sp .5v +.RE +.RE +.PP +\fB\-c, \-\-scale\fR=\fIsx\fR[,\fIsy\fR] +.RS 4 +Scales the page content horizontally by +\fIsx\fR +and vertically by +\fIsy\fR\&. This option is equivalent to +\fB\-TS\fR\fIsx\fR,\fIsy\fR\&. +.RE +.PP +\fB\-C, \-\-cache\fR[=\fIdir\fR] +.RS 4 +To speed up the conversion process of bitmap fonts, dvisvgm saves intermediate conversion information in cache files\&. By default, these files are stored in $HOME/\&.dvisvgm/cache\&. If you prefer a different location, use option +\fB\-\-cache\fR +to overwrite the default\&. Furthermore, it is also possible to disable the font caching mechanism completely with option +\fB\-\-cache=none\fR\&. If argument +\fIdir\fR +is omitted, dvisvgm prints the path of the default cache directory and some information about the stored fonts\&. Additionally, outdated and corrupted cache files are removed\&. +.RE +.PP +\fB\-\-color\fR +.RS 4 +Enables colorization of messages printed during the conversion process\&. The colors can be customized via the environment variable +DVISVGM_COLORS\&. See the ENVIRONMENT section below for further information\&. +.RE +.PP +\fB\-e, \-\-exact\fR +.RS 4 +If this option is given, dvisvgm computes the precise bounding box of each character\&. By default, the values stored in a font\(cqs TFM file are used to determine a glyph\(cqs extent\&. As these values are intended to realize optimal character placements and are not designed to represent the exact dimensions, they don\(cqt necessarily correspond with the bounds of the visual glyphs\&. Thus, width and/or height of some glyphs may be larger than the respective TFM values\&. As a result, this can lead to clipped characters at the bounds of the SVG graphic\&. With option +\fB\-\-exact\fR, dvisvgm analyzes the actual shape of each character and derives a usually tight bounding box\&. +.RE +.PP +\fB\-h, \-\-help\fR +.RS 4 +Prints a short summary of all available command\-line options\&. This is also the default action if dvisvgm is called without parameters\&. +.RE +.PP +\fB\-\-libgs=filename\fR +.RS 4 +This option is only available if the Ghostscript library is not directly linked to dvisvgm and if PostScript support was not completely disabled during compilation\&. In this case, dvisvgm tries to load the shared GS library dynamically during runtime\&. By default, it expects the library\(cqs name to be libgs\&.so (on Unix\-like systems) or gsdll32\&.dll (Windows)\&. Option +\fB\-\-libgs\fR +can be used to give a different name\&. Alternatively, it\(cqs also possible to set the GS library name by the environment variable +LIBGS\&. The latter has less precedence than the command\-line option\&. +.RE +.PP +\fB\-l, \-\-list\-specials\fR +.RS 4 +Prints a list of registered special handlers and exits\&. Each handler processes a set of special statements belonging to the same category\&. In most cases, the categories are identified by the prefix of the special statements\&. It\(cqs usually a leading word separated from the rest of the statement by a colon or a blank, e\&.g\&. +\fIcolor\fR +or +\fIps\fR\&. +.RE +.PP +\fB\-\-keep\fR +.RS 4 +Disables the removal of temporary files as created by Metafont (usually \&.gf, \&.tfm, and \&.log files)\&. +.RE +.PP +\fB\-m, \-\-map\-file\fR=\fIfile\fR +.RS 4 +Sets the map file used to look up font names and encodings\&. dvisvgm does not provide its own map file but tries to read available ones coming with dvips or dvipdfm\&. If option +\fB\-m\fR +is not given, dvisvgm looks for +ps2pk\&.map, +dvipdfm\&.map, and +psfonts\&.map +(in this order)\&. Without further options, the file specified by option +\fB\-m\fR +will be used instead of the default maps\&. If you want dvisgvm to load the given file additionally to the default maps, add a leading +\fI+\fR +to the file/path, e\&.g\&. +\-\-map\-file=+myfonts\&.map\&. For further information about the map file formats, see the manuals of dvips and dvipdfm\&. +.RE +.PP +\fB\-M, \-\-mag\fR=\fIfactor\fR +.RS 4 +Sets the maginfication factor applied in conjunction with Metafont calls prior tracing the glyphs\&. The larger this value, the better the tracing results\&. Nevertheless, large magnification values can cause Metafont arithmetic errors due to number overflows\&. So, use this option with care\&. The default setting usually produces nice results\&. +.RE +.PP +\fB\-n, \-\-no\-fonts\fR[=\fIvariant\fR] +.RS 4 +If this option is given, dvisvgm doesn\(cqt create SVG +\fIfont\fR +elements but uses +\fIpaths\fR +instead\&. The resulting SVG files tends to be larger but concurrently more compatible with most applications that don\(cqt support SVG fonts yet\&. The optional argument +\fIvariant\fR +selects the method how to substitute fonts by paths\&. Variant 0 creates +\fIpath\fR +and +\fIuse\fR +elements\&. Variant 1 creates +\fIpath\fR +elements only\&. Option +\fB\-\-no\-fonts\fR +implies +\fB\-\-no\-styles\fR\&. +.RE +.PP +\fB\-S, \-\-no\-specials\fR[=\fInames\fR] +.RS 4 +Disable processing of special commands embedded in the DVI file\&. If no further parameter is given, all specials are ignored\&. To selectively disable sets of specials, an optional comma\-separated list of names can be appended to this option\&. A +\fIname\fR +is the unique identifier referencing the intended special handler\&. Option +\fB\-\-list\-specials\fR +lists all currently available handlers and their names\&. All unsupported special statements are silently ignored\&. +.RE +.PP +\fB\-\-no\-styles\fR +.RS 4 +By default, dvisvgm creates CSS styles and class attributes to reference fonts because it\(cqs more compact than repeatedly set the complete font information in each text element\&. However, if you prefer direct font references, the default behavior can be disabled with option +\fB\-\-no\-styles\fR\&. +.RE +.PP +\fB\-\-no\-mktexmf\fR +.RS 4 +Suppresses the generation of missing font files\&. If dvisvgm can\(cqt find a font file through the kpathsea lookup mechanism, it calls the external tools mktextfm or mktexmf by\&. This option disables these calls\&. +.RE +.PP +\fB\-o, \-\-output\fR=\fIpattern\fR +.RS 4 +Sets the name pattern of the output file\&. Parameter +\fIpattern\fR +is a string that may contain the variables +\fB%f\fR +and +\fB%p\fR\&. +\fB%f\fR +stands for the base name of the DVI file, i\&.e\&. the DVI filename without suffix, and +\fB%p\fR +is the current page number\&. The default pattern is +\fB%f\-%p\&.svg\fR +if the DVI file consists of more than one page, and +\fB%f\&.svg\fR +otherwise\&. That means, a DVI file +\fIfoo\&.dvi\fR +is converted to +\fIfoo\&.svg\fR +if +\fIfoo\&.dvi\fR +is a single\-page document\&. Otherwise, multiple SVG files +\fIfoo\-01\&.svg\fR, +\fIfoo\-02\&.svg\fR, etc\&. are produced\&. In Windows environments, the percent sign indicates dereferenced environment variables, and must therefore be protected by a second percent sign, e\&.g\&. +\fB\-\-output=%%f\-%%p\fR\&. +.RE +.PP +\fB\-p, \-\-page\fR=\fIranges\fR +.RS 4 +This option sets the pages to be processed\&. Parameter +\fIranges\fR +consists of a comma\-separated list of single page numbers and/or page ranges\&. A page range is a pair of numbers separated by a hyphen, e\&.g\&. 5\-12\&. Thus, a page sequence might look like this: 2\-4,6,9\-12,15\&. It doesn\(cqt matter if a page is given more than once or if page ranges overlap\&. dvisvgm always extracts the page numbers in ascending order and converts them only once\&. In order to stay compatible with previous versions, the default page sequence is 1\&. dvisvgm therefore converts only the first page and not the whole document in case option +\fB\-\-page\fR +is omitted\&. Usually, page ranges consist of two numbers denoting the first and last page to be converted\&. If the conversion is to be started at page 1, or if it should continue up to the last DVI page, the first or second range number can be omitted, respectively\&. Example: +\fB\-\-page=\-10\fR +converts all pages up to page 10, +\fB\-\-page=10\-\fR +converts all pages starting with page 10\&. Please consider that the page values don\(cqt refer to the page numbers printed on the page\&. Instead, the physical page count is expected, where the first page always gets number 1\&. +.RE +.PP +\fB\-P, \-\-progress\fR[=\fIdelay\fR] +.RS 4 +Enables a simple progress indicator shown when time\-consuming operations like PostScript specials are processed\&. The indicator doesn\(cqt appear before the given delay (in seconds) has elapsed\&. The default delay value is 0\&.5 seconds\&. +.RE +.PP +\fB\-r, \-\-rotate\fR=\fIangle\fR +.RS 4 +Rotates the page content clockwise by +\fIangle\fR +degrees around the page center\&. This option is equivalent to +\fB\-TR\fR\fIangle\fR\&. +.RE +.PP +\fB\-s, \-\-stdout\fR +.RS 4 +Don\(cqt write the SVG output to a file but redirect it to +\fBstdout\fR\&. +.RE +.PP +\fB\-t, \-\-translate\fR=\fItx\fR[,\fIty\fR] +.RS 4 +Translates (moves) the page content in direction of vector (\fItx\fR,\fIty\fR)\&. This option is equivalent to +\fB\-TT\fR\fItx\fR,\fIty\fR\&. +.RE +.PP +\fB\-T, \-\-transform\fR=\fIcommands\fR +.RS 4 +Applies a sequence of transformations to the SVG content\&. Each transformation is described by a +\fIcommand\fR +beginning with a capital letter followed by a list of comma\-separated parameters\&. Following transformation commands are supported: +.PP +\fBT\fR \fItx\fR[,\fIty\fR] +.RS 4 +Translates (moves) the page in direction of vector (\fItx\fR,\fIty\fR)\&. If +\fIty\fR +is omitted, +\fIty\fR=0 is assumed\&. The expected unit length of +\fItx\fR +and +\fIty\fR +are TeX points (1pt = 1/72\&.27in)\&. However, there are several constants defined to simplify the unit conversion (see below)\&. +.RE +.PP +\fBS\fR \fIsx\fR[,\fIsy\fR] +.RS 4 +Scales the page horizontally by +\fIsx\fR +and vertically by +\fIsy\fR\&. If +\fIsy\fR +is omitted, +\fIsy\fR=\fIsx\fR +is assumed\&. +.RE +.PP +\fBR\fR \fIangle\fR[,\fIx\fR,\fIy\fR] +.RS 4 +Rotates the page clockwise by +\fIangle\fR +degrees around point (\fIx\fR,\fIy\fR)\&. If the optional arguments +\fIx\fR +and +\fIy\fR +are omitted, the page will be rotated around its center depending on the chosen page format\&. When option +\fB\-bnone\fR +is given, the rotation center is origin (0,0)\&. +.RE +.PP +\fBKX\fR \fIangle\fR +.RS 4 +Skews the page along the +\fIx\fR\-axis by +\fIangle\fR +degrees\&. Argument +\fIangle\fR +can take any value except 90+180\fIk\fR, where +\fIk\fR +is an integer\&. +.RE +.PP +\fBKY\fR \fIangle\fR +.RS 4 +Skews the page along the +\fIy\fR\-axis by +\fIangle\fR +degrees\&. Argument +\fIangle\fR +can take any value except 90+180\fIk\fR, where +\fIk\fR +is an integer\&. +.RE +.PP +\fBFH\fR [\fIy\fR] +.RS 4 +Mirrors (flips) the page at the horizontal line through point (0,\fIy\fR)\&. Omitting the optional argument leads to +\fIy\fR=\fIh\fR/2, where +\fIh\fR +denotes the page height (see +\fIpre\-defined constants\fR +below)\&. +.RE +.PP +\fBFV\fR [\fIx\fR] +.RS 4 +Mirrors (flips) the page at the vertical line through point (\fIx\fR,0)\&. Omitting the optional argument leads to +\fIx\fR=\fIw\fR/2, where +\fIw\fR +denotes the page width (see +\fIpre\-defined constants\fR +below)\&. +.RE +.PP +\fBM\fR \fIm1\fR,\&...,\fIm6\fR +.RS 4 +Applies a transformation described by the 3\(mu3 matrix ((\fIm1\fR,\fIm2\fR,\fIm3\fR),(\fIm4\fR,\fIm5\fR,\fIm6\fR),(0,0,1)), where the inner triples denote the rows\&. +.if n \{\ +.sp +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBNote\fR +.ps -1 +.br +All transformation commands of option +\fB\-T, \-\-transform\fR +are applied in the order of their appearance\&. Multiple commands can optionally be separated by spaces\&. In this case the whole transformation string has to be enclosed in double quotes\&. All parameters are expressions of floating point type\&. You can either give plain numbers or arithmetic terms combined by the operators +\fB+\fR +(addition), +\fB\-\fR +(subtraction), +\fB*\fR +(multiplication), +\fB/\fR +(division) or +\fB%\fR +(modulo) with common associativity and precedence rules\&. Parentheses may be used as well\&. +.sp +Additionally, some pre\-defined constants are provided: +.TS +tab(:); +lt lt +lt lt +lt lt +lt lt. +T{ +\fBux\fR +T}:T{ +horizontal position of upper left page corner in TeX point units +T} +T{ +\fBuy\fR +T}:T{ +vertical position of upper left page corner in TeX point units +T} +T{ +\fBh\fR +T}:T{ +page height in TeX point units (0 in case of +\fB\-bnone\fR) +T} +T{ +\fBw\fR +T}:T{ +page width in TeX point units (0 in case of +\fB\-bnone\fR) +T} +.TE +.sp 1 +Furthermore, you can use the length constants +\fBpt\fR, +\fBmm\fR, +\fBcm\fR +and +\fBin\fR, e\&.g\&. +2cm +or +1\&.6in\&. Thus, option +\-TT1in,0R45 +moves the page content 1 inch to the right and rotates it by 45 degrees around the page center afterwards\&. +.sp +For single transformations you can also use options +\fB\-c\fR, +\fB\-t\fR +and +\fB\-r\fR\&. Note that the order in which these options are given is not significant, i\&.e\&. you can\(cqt use them to describe transformation sequences\&. They are simply independent shorthand options for common transformations\&. +.sp .5v +.RE +.RE +.RE +.PP +\fB\-v, \-\-verbosity\fR=\fIlevel\fR +.RS 4 +Controls the type of messages printed during a dvisvgm run: +.TS +tab(:); +lt lt +lt lt +lt lt +lt lt. +T{ +\fB0\fR +T}:T{ +no message output +T} +T{ +\fB1\fR +T}:T{ +error messages only +T} +T{ +\fB2\fR +T}:T{ +warning messages only +T} +T{ +\fB4\fR +T}:T{ +informational messages only +T} +.TE +.sp 1 +.if n \{\ +.sp +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBNote\fR +.ps -1 +.br +By adding these values you can combine the categories\&. The default level is 7, i\&.e\&. all messages are printed\&. +.sp .5v +.RE +.RE +.PP +\fB\-V, \-\-version\fR[=\fIextended\fR] +.RS 4 +Prints the version of dvisvgm and exits\&. If the optional argument is set to +\fIyes\fR, the version numbers of the linked libraries are printed as well\&. +.RE +.PP +\fB\-z, \-\-zip\fR[=\fIlevel\fR] +.RS 4 +Creates a compressed SVG file with suffix \&.svgz\&. The optional argument specifies the compression level\&. Valid values are in the range of 1 to 9 (default value is 9)\&. Larger values cause better compression results but take more computation time\&. +.if n \{\ +.sp +.\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBCaution\fR +.ps -1 +.br +This option cannot be combined with +\fB\-s, \-\-stdout\fR\&. +.sp .5v +.RE +.RE +.SH "SUPPORT OF SPECIALS" +.sp +dvisvgm supports several sets of \fIspecial commands\fR that can be used to enrich DVI files with additional features, like color, graphics or hyperlinks\&. The evaluation of special commands is delegated to various handlers\&. Each handler is responsible for all special statements of the same command set, i\&.e\&. commands beginning with the same prefix\&. To get a list of actually provided special handlers, use option \fB\-\-list\-specials\fR (see above)\&. +.PP +\fBbgcolor\fR +.RS 4 +Special statement for changing the background/page color\&. Since SVG 1\&.1 doesn\(cqt support background colors, dvisvgm inserts a rectangle of the chosen color\&. In the current version, this rectangle always gets the size of the minimal bounding box\&. This command is part of the color special set but is handled separately in order to let the user turn it off\&. For an overview of the command syntax, see the documentation of dvips, for instance\&. +.RE +.PP +\fBcolor\fR +.RS 4 +Statements of this command set provide instructions to change the text/paint color\&. For an overview of the exact syntax, see the documentation of dvips, for instance\&. +.RE +.PP +\fBdvisvgm\fR +.RS 4 +dvisvgm offers its own small set of specials\&. The following list gives a brief overview\&. +.PP +\fBdvisvgm:raw\fR \fItext\fR +.RS 4 +Adds an arbitrary sequence of characters to the SVG output\&. dvisvgm does not perform any validation here, thus the user has to ensure that the resulting SVG is still valid\&. Parameter +\fItext\fR +may contain the macros +\fB{?x}\fR, +\fB{?y}\fR, and +\fB{?color}\fR +that are expanded to the current +\fIx\fR +or +\fIy\fR +coordinate and the current color, respectively\&. Also, macro +\fB{?nl}\fR +expands to a newline character\&. +.RE +.PP +\fBdvisvgm:img\fR \fIwidth\fR \fIheight\fR \fIfile\fR +.RS 4 +Creates an image element at the current graphic position referencing the given file\&. JPEG, PNG, and SVG images can be used here\&. However, dvisvgm does not check the file format or the file name suffix\&. The lengths +\fIwidth\fR +and +\fIheight\fR +must be given as plain floating point numbers in TeX point units (1in = 72\&.27pt)\&. +.RE +.PP +\fBdvisvgm:bbox\fR n[ew] \fIname\fR +.RS 4 +Defines or resets a local bounding box called +\fIname\fR\&. The name may consist of letters and digits\&. While processing a DVI page, dvisvgm continuously updates the (global) bounding box of the current page in order to determine the minimal rectangle containing all visible page components (characters, images, drawing elements etc\&.) Additionally to the global bounding box, the user can request an arbitrary number of named local bounding boxes\&. Once defined, these boxes are updated together with the global bounding box starting with the first character that follows the definition\&. Thus, the local boxes can be used to compute the extent of parts of the page\&. This is useful for scenarios where the generated SVG file is post\-processed\&. In conjunction with special dvisvgm:raw, the macro +\fB{?bbox \fR\fB\fIname\fR\fR\fB}\fR +expands to the four values +\fIx\fR, +\fIy\fR, +\fIw\fR, and +\fIh\fR +(separated by spaces) specifying the coordinates of the upper left corner, width, and height of the local box +\fIname\fR\&. If box +\fIname\fR +wasn\(cqt previously defined, all four values equal zero\&. +.RE +.PP +\fBdvisvgm:bbox\fR \fIwidth\fR \fIheight\fR [\fIdepth\fR] +.RS 4 +Updates the bounding box of the current page by embedding a virtual rectangle (\fIx\fR, +\fIy\fR, +\fIwidth\fR, +\fIheight\fR) where the lower left corner is located at the current DVI drawing position (\fIx\fR,\fIy\fR)\&. If the optional parameter +\fIdepth\fR +is specified, dvisvgm embeds a second rectangle (\fIx\fR, +\fIy\fR, +\fIwidth\fR, \-\fIdepth\fR)\&. The lengths +\fIwidth\fR, +\fIheight\fR +and +\fIdepth\fR +must be given as plain floating point numbers in TeX point units (1in = 72\&.27pt)\&. Depending on size and position of the virtual rectangle, this command either enlarges the overall bounding box or leaves it as is\&. It\(cqs not possible to reduce its extent\&. This special should be used in conjunction with +\fBdvisvgm:raw\fR +in order to update the viewport of the page properly\&. +.RE +.PP +\fBdvisvgm:bbox\fR a[bs] \fIx1\fR \fIy1\fR \fIx2\fR \fIy2\fR +.RS 4 +This variant of the bbox special updates the bounding box by embedding a virtual rectangle (\fIx1\fR,\fIy1\fR,\fIx2\fR,\fIy2\fR)\&. The points (\fIx1\fR,\fIy1\fR) and (\fIx2\fR,\fIy2\fR) denote two diagonal corners of the rectangle given in TeX point units\&. +.RE +.PP +\fBdvisvgm:bbox\fR f[ix] \fIx1\fR \fIy1\fR \fIx2\fR \fIy2\fR +.RS 4 +This variant of the bbox special assigns an absolute (final) bounding box to the resulting SVG\&. After executing this command, dvisvgm doesn\(cqt further alter the bounding box coordinates, except this special is called again later\&. The points (\fIx1\fR,\fIy1\fR) and (\fIx2\fR,\fIy2\fR) denote two diagonal corners of the rectangle given in TeX point units\&. +.sp +The following TeX snippet adds two raw SVG elements to the output and updates the bounding box accordingly: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\especial{dvisvgm:raw <circle cx=\*(Aq{?x}\*(Aq cy=\*(Aq{?y}\*(Aq r=\*(Aq10\*(Aq stroke=\*(Aqblack\*(Aq fill=\*(Aqred\*(Aq/>} +\especial{dvisvgm:bbox 20 10 10} + +\especial{dvisvgm:raw <path d=\*(AqM50 200 L10 250 H100 Z\*(Aq stroke=\*(Aqblack\*(Aq fill=\*(Aqblue\*(Aq/>} +\especial{dvisvgm:bbox abs 10 200 100 250} +.fi +.if n \{\ +.RE +.\} +.RE +.RE +.PP +\fBem\fR +.RS 4 +These specials were introduced with the emTeX distribution by Eberhard Mattes\&. They provide line drawing statements, instructions for embedding MSP, PCX, and BMP image files, as well as two PCL commands\&. dvisvgm supports only the line drawing statements and ignores all other em specials silently\&. A description of the command syntax can be found in the DVI driver documentation coming with emTeX (see CTAN)\&. +.RE +.PP +\fBps\fR +.RS 4 +The famous DVI driver dvips introduced its own set of specials in order to embed PostScript code into DVI files, which greatly improves the capabilities of DVI documents\&. One aim of dvisvgm is to completely evaluate all PostScript snippets and to convert a large amount of it to SVG\&. However, in contrast to dvips, dvisvgm uses floating point arithmetics to compute the precise position of each graphic element, i\&.e\&. it doesn\(cqt round the corrdinates\&. Therefore, the relative locations of the graphic elements may slightly differ from those computed by dvips\&. +.sp +Since PostScript is a rather complex language, dvisvgm does not try to implement its own PostScript interpreter but relies on Ghostscript instead\&. If the Ghostscript library was not linked while building dvisvgm, it is looked up and dynamically loaded during runtime\&. In this case, dvisvgm looks for +\fIlibgs\&.so\fR +on Unix\-like systems, and for +\fIgsdll32\&.dll\fR +on Windows\&. You can override these default file names with the environment variable +LIBGS\&. The library must be installed and must be reachable through the ld search path (*nix) or the PATH environment variable (Windows)\&. If it cannot be found, the evaluation of PostScript specials is disabled\&. Use option +\fB\-\-list\-specials\fR +to check whether PS support is available, i\&.e\&. the entry +\fIps\fR +is present\&. +.RE +.PP +\fBtpic\fR +.RS 4 +The TPIC special set defines instructions for drawing simple geometric objects\&. Some LaTeX packages, like eepic and tplot, use these specials to describe graphics\&. +.RE +.SH "EXAMPLES" +.sp +.if n \{\ +.RS 4 +.\} +.nf +dvisvgm file +.fi +.if n \{\ +.RE +.\} +.sp +Converts the first page of \fIfile\&.dvi\fR to \fIfile\&.svg\fR\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +dvisvgm \-z file +.fi +.if n \{\ +.RE +.\} +.sp +Converts the first page of \fIfile\&.dvi\fR to \fIfile\&.svgz\fR with default compression level 9\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +dvisvgm \-p5 \-z3 \-ba4\-l \-onewfile file +.fi +.if n \{\ +.RE +.\} +.sp +Converts the fifth page of \fIfile\&.dvi\fR to \fInewfile\&.svgz\fR with compression level 3\&. The bounding box is set to DIN/ISO A4 in landscape format\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +dvisvgm \-\-transform="R20,w/3,2h/5 T1cm,1cm S2,3" file +.fi +.if n \{\ +.RE +.\} +.sp +Converts the first page of \fIfile\&.dvi\fR to \fIfile\&.svg\fR where three transformations are applied\&. +.SH "ENVIRONMENT" +.sp +dvisvgm uses the \fBkpathsea\fR library for locating the files that it opens\&. Hence, the environment variables described in the library\(cqs documentation influence the converter\&. +.sp +If dvisvgm was linked without the Ghostscript library, and if PostScript support has not been disabled, the shared Ghostscript library is looked up during runtime via dlopen()\&. The environment variable LIBGS can be used to specify path and file name of the library\&. +.sp +The pre\-compiled Windows version of dvisvgm requires a working installation of MiKTeX 2\&.9 or above\&. To enable evaluation of PostScript specials, the original Ghostscript DLL \fIgsdll32\&.dll\fR must be present and reachable through the search path\&. +.sp +The environment variable DVISVGM_COLORS specifies the colors used to highlight various parts of dvisvgm\(cqs message output\&. It is only evaluated if option \fB\-\-color\fR is given\&. The value of DVISVGM_COLORS is a list of colon\-separated entries of the form \fIgg\fR=\fIBF\fR, where \fIgg\fR denotes one of the color group indicators listed below, and \fIBF\fR are two hexadecimal digits specifying the background (first digit) and foreground/text color (second digit)\&. The color color values are defined as follows: 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=gray, 8=bright red, 9=bright green, A=bright yellow, B=bright blue, C=bright magenta, D=bright cyan, E=bright gray, F=white\&. Depending on the terminal, the colors may differ\&. Rather than changing both the text and background color, it\(cqs also possible to change only one of them: An asterisk (*) in place of a hexadecimal digit indicates the default text or background color of the terminal\&. +.sp +All malformed entries in the list are silently ignored\&. +.TS +tab(:); +lt lt +lt lt +lt lt +lt lt +lt lt +lt lt +lt lt +lt lt. +T{ +.sp +\fBer\fR +T}:T{ +.sp +error messages +T} +T{ +.sp +\fBwn\fR +T}:T{ +.sp +warning messages +T} +T{ +.sp +\fBpn\fR +T}:T{ +.sp +messages about page numbers +T} +T{ +.sp +\fBps\fR +T}:T{ +.sp +page size messages +T} +T{ +.sp +\fBfw\fR +T}:T{ +.sp +information about the files written +T} +T{ +.sp +\fBsm\fR +T}:T{ +.sp +state messages +T} +T{ +.sp +\fBtr\fR +T}:T{ +.sp +messages of the glyph tracer +T} +T{ +.sp +\fBpi\fR +T}:T{ +.sp +progress indicator +T} +.TE +.sp 1 +.sp +\fBExample:\fR er=01:pi=*5 sets the colors of error messages (er) to red (1) on black (0), and those of progress indicators (pi) to cyan (5) on default background (*)\&. +.SH "FILES" +.sp +The location of the following files is determined by the kpathsea library\&. To check the actual kpathsea configuration you can use the \fBkpsewhich\fR utility\&. +.TS +tab(:); +lt lt +lt lt +lt lt +lt lt +lt lt +lt lt +lt lt +lt lt +lt lt. +T{ +.sp +\fB*\&.enc\fR +T}:T{ +.sp +Font encoding files +T} +T{ +.sp +\fB*\&.fgd\fR +T}:T{ +.sp +Font glyph data files (cache files created by dvisvgm) +T} +T{ +.sp +\fB*\&.map\fR +T}:T{ +.sp +Font map files +T} +T{ +.sp +\fB*\&.mf\fR +T}:T{ +.sp +Metafont input files +T} +T{ +.sp +\fB*\&.pfb\fR +T}:T{ +.sp +PostScript Type 1 font files +T} +T{ +.sp +\fB*\&.pro\fR +T}:T{ +.sp +PostScript header/prologue files +T} +T{ +.sp +\fB*\&.tfm\fR +T}:T{ +.sp +TeX font metric files +T} +T{ +.sp +\fB*\&.ttf\fR +T}:T{ +.sp +TrueType font files +T} +T{ +.sp +\fB*\&.vf\fR +T}:T{ +.sp +Virtual font files +T} +.TE +.sp 1 +.SH "SEE ALSO" +.sp +\fBtex(1), mf(1), mktexmf(1), grodvi(1), potrace(1)\fR, and the \fBkpathsea library\fR info documentation\&. +.SH "RESOURCES" +.PP +Project home page +.RS 4 + +http://dvisvgm\&.sourceforge\&.net +.RE +.PP +SourceForge project site +.RS 4 + +http://sourceforge\&.net/projects/dvisvgm +.RE +.SH "AUTHOR" +.sp +Written by Martin Gieseking <martin\&.gieseking@uos\&.de> +.SH "COPYING" +.sp +Copyright \(co 2005\-2012 Martin Gieseking\&. Free use of this software is granted under the terms of the GNU General Public License (GPL) version 3 or, (at your option) any later version\&. diff --git a/Master/texmf-dist/doc/man/man1/dvisvgm.man1.pdf b/Master/texmf-dist/doc/man/man1/dvisvgm.man1.pdf Binary files differnew file mode 100644 index 00000000000..4b26f30b533 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvisvgm.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/dvitodvi.1 b/Master/texmf-dist/doc/man/man1/dvitodvi.1 new file mode 100644 index 00000000000..20a22722ece --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvitodvi.1 @@ -0,0 +1,139 @@ +.\" Copyright (c) 1987-2012 UMD-CS, released under the X11 license; +.\" see README and source files. +.TH DVITODVI 1 +.SH NAME +dvitodvi \- rearrange pages in a DVI file +.SH SYNOPSIS +.B dvitodvi +[ +.B \-q +] [ +.B \-i +.I infile +] [ +.B \-o +.I outfile +] +[ +.B \-w\fIwidth\fR +] +[ +.B \-h\fIheight\fR +] +.I pagespecs +[ +.I infile +[ +.I outfile +] ] +.SH DESCRIPTION +.I Dvitodvi +rearranges pages from a DVI file, creating a new DVI file. +.I Dvitodvi +can be used to perform a large number of arbitrary re-arrangements of +Documents, including arranging for printing 2-up, 4-up, booklets, reversing, +selecting front or back sides of documents, scaling, etc. +.PP +.I pagespecs +follow the syntax: +.RS +.TP 12 +.I pagespecs +.I = [modulo:][mag@]specs +.TP +.I specs +.I = spec[+specs][,specs] +.TP +.I spec +.I = [-]pageno[(xoff,yoff)] +.RE +.sp +.I modulo +is the number of pages in each block. The value of +.I modulo +should be greater than 0; the default value is 1. +The optional +.I mag +parameter adjusts the file's magnification by the magnification specified. The +magnification and modulo can be specified in reverse order if desired. +.I specs +are the page specifications for the pages in each block. The value of the +.I pageno +in each +.I spec +should be between 0 (for the first page in the block) and \fImodulo\fR-1 +(for the last page in each block) inclusive. +The optional dimensions +.I xoff +and +.I yoff +shift the page by the specified (positive) amount. +.I xoff +and +.I yoff +are in PostScript's points, but may be followed by the units +.B "cm" +or +.B "in" +to convert to centimetres or inches, or the flag +.B "w" +or +.B "h" +to specify as a multiple of the width or height. +If the optional minus sign is specified, the page is relative to the end of +the document, instead of the start. + +If page \fIspec\fRs are separated by +.B + +the pages will be merged into one page; if they are separated by +.B , +they will be on separate pages. +If there is only one page specification, with +.I pageno +zero, the \fIpageno\fR may be omitted. +.PP +The +.I \-w +option gives the width which is used by the +.B "w" +dimension specifier, and the +.I \-h +option gives the height which is used by the +.B "h" +dimension specifier. These dimensions are also used (after scaling) to set the +clipping path for each page. +.PP +Dvitodvi normally prints the page numbers of the pages re-arranged; the +.I \-q +option suppresses this. +.SH EXAMPLES +This section contains some sample re-arrangements. To put two pages on one +sheet (of landscaped A3 paper), the pagespec to use is: +.sp +.ce +2:0+1(21cm,0) +.sp +To reduce an A3 page to A4 size, the pagespec to use is: +.sp +.ce +700@(-.3in,-.3in) +.sp +To select all of the odd pages in reverse order, use: +.sp +.ce +2:-0 +.sp +.SH AUTHOR +Angus Duggan, from dviselect(1), by +Chris Torek, University of Maryland +.SH "SEE ALSO" +dviconcat(1), dvibook(1), dviselect(1), latex(1), tex(1) +.br +.I "MC-TeX User's Guide" +.br +.I "The TeXbook" +.SH BUGS +.I Dvitodvi +does not adjust some of the parameters in the postamble. This may be a problem +if these values are used to size certain structures in the output +conversion programs. diff --git a/Master/texmf-dist/doc/man/man1/dvitodvi.man1.pdf b/Master/texmf-dist/doc/man/man1/dvitodvi.man1.pdf Binary files differnew file mode 100644 index 00000000000..1ee781413c5 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvitodvi.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/dvitomp.1 b/Master/texmf-dist/doc/man/man1/dvitomp.1 new file mode 100644 index 00000000000..452af4dc601 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvitomp.1 @@ -0,0 +1,26 @@ +.TH DVITOMP 1 "5 April 2011" "dvitomp 1.504" +.\" man page by Jim Van Zandt <jrv@vanzandt.mv.com> -*- nroff -*- +.SH NAME +dvitomp \- convert a TeX DVI file to a MetaPost MPXFILE +.SH SYNOPSIS +.B dvitomp +.RI [ OPTIONS ] +.IR dvifile [ \fB.dvi\fP ] +.RI [ mpxfile [ \fB.mpx\fP ]] +.PP +.B mpost +.B --dvitomp +.IR dvifile [ \fB.dvi\fP ] +.RI [ mpxfile [ \fB.mpx\fP ]] +.SH DESCRIPTION +\fBdvitomp\fP translates the given \fIdvifile\fP to a MetaPost +MPXFILE. The default \fImpxfile\fP is the basename of \fIdvifile\fP +extended with +.BR .mpx . +.SH OPTIONS +.IP \fB-help\fP +write usage summary and exit. +.IP \fB-version\fP +output version information and exit. +.SH BUGS +Email bug reports to metapost@tug.org. diff --git a/Master/texmf-dist/doc/man/man1/dvitomp.man1.pdf b/Master/texmf-dist/doc/man/man1/dvitomp.man1.pdf Binary files differnew file mode 100644 index 00000000000..311c3210dfd --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvitomp.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/dvitype.1 b/Master/texmf-dist/doc/man/man1/dvitype.1 new file mode 100644 index 00000000000..4eedcfc2a5d --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvitype.1 @@ -0,0 +1,102 @@ +.TH DVITYPE 1 "19 December 1994" "Web2C 2012" +.\"===================================================================== +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff +.el .ds OX TeX for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.\"===================================================================== +.SH NAME +dvitype, odvitype \- translate a dvi file for humans +.SH SYNOPSIS +.B dvitype +.IR dvi_name [ \fB.dvi\fP ] +.\"===================================================================== +.SH DESCRIPTION +This manual page is not meant to be exhaustive. The complete +documentation for this version of \*(TX can be found in the info file +or manual +.IR "Web2C: A TeX implementation" . +.PP +The +.B dvitype +program translates a DVI (DeVice Independent) file output by (for example) +.BR tex (1) +or +.BR gftodvi (1), +to a file that humans can read. It also serves as a DVI file-validating +program (i.e., if +.B dvitype +can read it, it's correct) and as an example of a DVI-reading +program for future device drivers. +.PP +The output file can include all commands, just the important +ones, or none at all (in which case only errors are reported). +A subinterval of pages may be selected for transliteration; the +magnification and resolution of the ``output device'' may be +changed; and so on. All options are specified with an on-line dialog. +.PP +The +.B .dvi +extension is supplied if omitted from +.IR dvi_name . +The output goes to +.IR stdout . +.\"===================================================================== +.SH OPTIONS +.TP +.BI \-dpi= REAL +Set resolution to +.I REAL +pixels per inch; default 300.0. +.PP +.TP +.BI \-magnification= NUMBER +Override existing magnification with +.IR NUMBER . +.PP +.TP +.BI \-max-pages= NUMBER +Process +.I NUMBER +pages; default one million. +.PP +.TP +.BI \-output-level= NUMBER +Verbosity level, from 0 to 4; default 4. +.PP +.TP +.BI \-page-start= PAGE-SPEC +Start at +.IR PAGE-SPEC , +for example `2' or `5.*.-2'. +.PP +.TP +.B \-show-opcodes +Show numeric opcodes (in decimal). +.\"===================================================================== +.SH ENVIRONMENT +The environment variable TEXFONTS is used to search for the TFM files +used in the DVI file. See +.BR tex (1) +for the details of the searching. +If TEXFONTS is not set, it uses the system default. +.\"===================================================================== +.SH "SEE ALSO" +.BR gftype (1), +.BR pktype (1). +.br +Donald E. Knuth, +.IR "\*(OXware" . +.\"===================================================================== +.SH AUTHORS +Donald E. Knuth wrote the program. It was published as part of the +.I \*(OXware +technical report, available from the \*(TX Users Group. +Howard Trickey and Pavel Curtis originally ported it to Unix. diff --git a/Master/texmf-dist/doc/man/man1/dvitype.man1.pdf b/Master/texmf-dist/doc/man/man1/dvitype.man1.pdf Binary files differnew file mode 100644 index 00000000000..9eb65a9170d --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/dvitype.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/e2pall.1 b/Master/texmf-dist/doc/man/man1/e2pall.1 new file mode 100644 index 00000000000..b102568b53a --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/e2pall.1 @@ -0,0 +1,55 @@ +.TH "e2pall" "1" "August 2000" "teTeX" "teTeX" +.PP +.SH "NAME" +e2pall \- convert all EPS files in a LaTeX document to PDF +.PP +.SH "SYNOPSIS" +.PP +\fBe2pall\fP \fITEXFILE\fP +.PP +.SH "DESCRIPTION" +.PP +\fBe2pall\fP searches through \fITEXFILE\fP for \eincludegraphics +commands to find the base names of image files\&. When it finds one, +\fBe2pall\fP runs \fBepstopdf\fP(1) to create a PDF file from the EPS +file\&. +.PP +\fBe2pall\fP will check to be sure that an existing PDF file is +up-to-date with the EPS file, and will not run \fBepstopdf\fP(1) if +the PDF file is newer than the EPS file\&. +.PP +.SH "BUGS" +.PP +.IP "" +Seems to be broken +.IP "" +Cannot handle \einput{\fIfilename\fP} or +\eincludegraphics{\fIfilename\fP} split over more than one +line +.IP "" +Must be run from same directory as the LaTeX file +.IP "" +Does not look down $TEXINPUTS +.IP "" +Cannot handle documents that use \einclude commands +.IP "" +Assumes \fIall\fP files included with \eincludegraphics are EPS +files +.IP +.PP +.SH "SEE ALSO" +.PP +\fBepstopdf\fP(1) +.PP +.SH "AUTHOR" +.PP +\fBe2pall\fP was written by Jody Klymak <jklymak@apl\&.washington\&.edu> and published in a posting to +the <pdftex@tug\&.org> (mailing list)\&. +.PP +This manual page was written by C\&.M\&. Connelly +<c@eskimo\&.com>, for +the Debian GNU/Linux system\&. It may be used by other distributions +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)\&. +.PP diff --git a/Master/texmf-dist/doc/man/man1/e2pall.man1.pdf b/Master/texmf-dist/doc/man/man1/e2pall.man1.pdf Binary files differnew file mode 100644 index 00000000000..8f3e4f51615 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/e2pall.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/ebb.1 b/Master/texmf-dist/doc/man/man1/ebb.1 new file mode 100644 index 00000000000..76ef525ec91 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ebb.1 @@ -0,0 +1 @@ +.so man1/extractbb.1 diff --git a/Master/texmf-dist/doc/man/man1/ebb.man1.pdf b/Master/texmf-dist/doc/man/man1/ebb.man1.pdf Binary files differnew file mode 100644 index 00000000000..8bdb4c85b2e --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ebb.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/eplain.1 b/Master/texmf-dist/doc/man/man1/eplain.1 new file mode 100644 index 00000000000..64193a5f4d6 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/eplain.1 @@ -0,0 +1,87 @@ +.TH EPLAIN 1 "7 February 2013" "Eplain 3.5" +.\"===================================================================== +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff +.el .ds OX TeX for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.if t .ds AX \fRA\\h'-0.1667m'\\v'0.20v'M\\v'-0.20v'\\h'-0.125m'S\fP\*(TX +.if n .ds AX AmSTeX +.if t .ds AY \fRA\\h'-0.1667m'\\v'0.20v'M\\v'-0.20v'\\h'-0.125m'S\fP\*(LX +.if n .ds AY AmSLaTeX +.\"===================================================================== +.SH NAME +eplain \- expanded plain TeX +.SH SYNOPSIS +.B eplain +[ first-line ] +.\"===================================================================== +.SH DESCRIPTION +.B eplain +is an extension of plain \*(TX originally described in the book +.IR "\*(OX for the Impatient" . +It adds these features (among others) to plain \*(TX: +.TP \w'\(bu'u+2n +\(bu +left-justified displays +.TP +\(bu +double-column output +.TP +\(bu +tables of contents +.TP +\(bu +.I \ehrule +and +.I \evrule +with a different default than 0.4pt +.TP +\(bu +time of day +.TP +\(bu +verbatim file listing +.TP +\(bu +generalized footnotes +.TP +\(bu +blank and black boxes +.TP +\(bu +citations using \*(BX +.\"===================================================================== +.SH FILES +.TP +.I eplain/doc/eplain.texi +\*(TXable documentation of +.B etex +macros in +.B texinfo +format. +.TP +.I eplain.info* +Online GNU Emacs +.BR info (1) +files produced from +.IR eplain.texi . +.\"===================================================================== +.SH "SEE ALSO" +.BR texinfo (5), +.BR tex (1), +.br +Karl Berry, +.IR eplain , +TUGboat 11(4), 571--572, 1990, +http://tug.org/TUGboat/tb11-4/tb30resources.pdf. +.br +Paul W. Abrahams with Karl Berry and Kathryn A. Hargreaves, +.IR "\*(OX for the Impatient" , +http://www.gnu.org/software/teximpatient. diff --git a/Master/texmf-dist/doc/man/man1/eplain.man1.pdf b/Master/texmf-dist/doc/man/man1/eplain.man1.pdf Binary files differnew file mode 100644 index 00000000000..c9d10369f9c --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/eplain.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/epsffit.1 b/Master/texmf-dist/doc/man/man1/epsffit.1 new file mode 100644 index 00000000000..68da969661a --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/epsffit.1 @@ -0,0 +1,51 @@ +.TH EPSFFIT 1 "PSUtils Release 1 Patchlevel 17" +.SH NAME +epsffit \- fit encapsulated PostScript file (EPSF) into constrained size +.SH SYNOPSIS +.B epsffit +[ +.B \-c +] [ +.B \-r +] [ +.B \-a +] [ +.B \-m +] [ +.B \-s +] +.I "llx lly urx ury" +[ +.B infile +[ +.B outfile +] ] +.SH DESCRIPTION +.I Epsffit +fits an EPSF file (encapsulated PostScript) to a given bounding box. +The coordinates of the box are given by \fB(llx,lly)\fR for the lower +left, and \fB(urx,ury)\fR for the upper right, in PostScript units (points). +.PP +If no input or output files are specified, +.I epsffit +read from the standard input and writes to the standard output. +.SH OPTIONS +.IP \fB\-c\fP 1i +Center the image in the given bounding box. +.IP \fB\-r\fP 1i +Rotate the image by 90 degrees counter-clockwise. +.IP \fB\-a\fP 1i +Adjust the aspect ratio to fit the bounding box. The default is to preserve +the aspect ratio. +.IP \fB\-m\fP 1i +Rotates the image to maximise the size if it would fit the specified bounding +box better. +.IP \fB\-s\fP 1i +Add a \fIshowpage\fP at the end of the file to force the image to print. +.SH AUTHOR +Copyright (C) Angus J. C. Duggan 1991-1995 +.SH "SEE ALSO" +epsffit(1), psbook(1), psnup(1), psresize(1), psselect(1), pstops(1), extractres(1), fixdlsrps(1), fixfmps(1), fixpsditps(1), fixpspps(1), fixscribeps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), includeres(1), psmerge(1), getafm(1) +.SH TRADEMARKS +.B PostScript +is a trademark of Adobe Systems Incorporated. diff --git a/Master/texmf-dist/doc/man/man1/epsffit.man1.pdf b/Master/texmf-dist/doc/man/man1/epsffit.man1.pdf Binary files differnew file mode 100644 index 00000000000..b7fd5d82307 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/epsffit.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/epstopdf.1 b/Master/texmf-dist/doc/man/man1/epstopdf.1 new file mode 100644 index 00000000000..ac57d1dc7d2 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/epstopdf.1 @@ -0,0 +1,88 @@ +.TH EPSTOPDF 1 "18 March 2010" +.\" $Id: epstopdf.1 18160 2010-05-09 00:02:00Z karl $ +.SH NAME +epstopdf, repstopdf \- convert an EPS file to PDF +.SH SYNOPSIS +\fBepstopdf\fP [\fIoptions\fP] [\fIepsfile\fP] +.SH DESCRIPTION +\fBepstopdf\fP transforms the Encapsulated PostScript file \fIepsfile\fP +(or standard input) so that it is guaranteed to start at the 0,0 +coordinate, and it sets a page size exactly corresponding to the +BoundingBox. This means that when Ghostscript renders it, the result +needs no cropping, and the PDF MediaBox is correct. By default, the +result is piped to Ghostscript and a PDF version written. +.P +If the bounding box is not right, of course, there are problems. +.SH OPTIONS +.IP "\fB--outfile\fP=\fIfile\fP" +write result to \fIfile\fP. If this option is not given, and +\fB--nogs\fP or \fB--filter\fP is specified, write to standard output; +otherwise, the default is to construct the output file name by replacing +any extension in the input file with \fI.pdf\fP. +.IP "\fB--\fP[\fBno\fP]\fBcompress\fP" +use compression (default: on). +.IP "\fB--\fP[\fBno\fP]\fBdebug\fP" +write debugging info (default: off). +.IP "\fB--\fP[\fBno\fP]\fBembed\fP" +embed fonts (default: on). +.IP "\fB--\fP[\fBno\fP]\fBexact\fP" +scan ExactBoundingBox (default: off). +.IP "\fB--\fP[\fBno\fP]\fBfilter\fP" +read standard input and (unless \fB--outfile\fP is given) write standard +output(default: off). +.IP "\fB--\fP[\fBno\fP]\fBgs\fP" +run Ghostscript (default: on). With \fB--nogs\fP, output (to standard +output by default) the PostScript that would normally be converted; that +is, the input PostScript as modified by \fBepstopdf\fP. +.IP "\fB--\fP[\fBno\fP]\fBhires\fP" +scan HiresBoundingBox (default: off). +.IP "\fB--gscmd\fP=\fIval\fP" +pipe output to \fIval\fP (default: [\fBgswin32c\fP on Windows, else \fBgs\fP]) +.IP "\fB--res\fP=\fIdpi\fP" +set image resolution (default: [use gs default]) +.IP "\fB--autorotate\fP=\fIval\fP" +set AutoRotatePages (default: None); recognized \fIval\fP choices: +None, All, PageByPage. For EPS files, PageByPage is equivalent to All. +.IP "\fB--restricted\fP=\fIval\fP" +turn on restricted mode (default: [on for repstopdf, else off]); +this forbids the use of \fB--gscmd\fP and imposes restrictions on the input and +output file names according to the values of openin_any and openout_any (see +the Web2c manual, http://tug.org/web2c). +.IP "\fB--help\fP +display help message and exit +.IP "\fB--version\fP +display version information and exit +.SH EXAMPLES +Examples which produce "test.pdf": +.nf +epstopdf test.eps +produce postscript | epstopdf --filter >test.pdf +produce postscript | epstopdf -f -d -o=test.pdf +.fi +Example: look for HiresBoundingBox and produce corrected PostScript: +.nf +epstopdf -d --nogs --hires test.ps >testcorr.ps +.fi +.SH BUGS +The case of "%%BoundingBox: (atend)" when input is not seekable (e.g., +from a pipe) is not supported. +.PP +Report bugs in the program or this man page to tex-k@tug.org. When +reporting bugs, please include an input file and the command line +options specified, so the problem can be reproduced. +.SH SEE ALSO +\fBgs\fP(1), +\fBpdfcrop\fP(1). +.PP +The epstopdf LaTeX package, part of the oberdiek bundle, which automates +running this script on the fly under TeX: http://ctan.org/pkg/epstopdf-pkg. +.SH AUTHOR +The script was originally written by Sebastian Rahtz, for Elsevier +Science, with subsequent contributions from Thomas Esser, Gerben Wierda +and many others. Currently maintained by Karl Berry. +.PP +Man page originally written by Jim Van Zandt. +.PP +epstopdf home page: http://tug.org/epstopdf. +.PP +You may freely use, modify and/or distribute this file. diff --git a/Master/texmf-dist/doc/man/man1/epstopdf.man1.pdf b/Master/texmf-dist/doc/man/man1/epstopdf.man1.pdf Binary files differnew file mode 100644 index 00000000000..6ce7b6592b2 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/epstopdf.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/etex.1 b/Master/texmf-dist/doc/man/man1/etex.1 new file mode 100644 index 00000000000..1cede7e4b7a --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/etex.1 @@ -0,0 +1,387 @@ +.TH ETEX 1 "1 March 2011" "Web2C 2011" +.\"===================================================================== +.if n .ds MF Metafont +.if t .ds MF M\s-2ETAFONT\s0 +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.if n .ds MF Metafont +.if t .ds MF M\s-2ETAFONT\s0 +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff +.el .ds OX TeX for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.if t .ds AX \fRA\\h'-0.1667m'\\v'0.20v'M\\v'-0.20v'\\h'-0.125m'S\fP\*(TX +.if n .ds AX AmSTeX +.if t .ds AY \fRA\\h'-0.1667m'\\v'0.20v'M\\v'-0.20v'\\h'-0.125m'S\fP\*(LX +.if n .ds AY AmSLaTeX +.if n .ds WB Web +.if t .ds WB W\s-2EB\s0 +.\"===================================================================== +.SH NAME +etex \- extended (plain) TeX +.SH SYNOPSIS +.B etex +.RI [ options ] +.RI [ \fB&\fPformat ] +.RI [ file | \fB\e\fPcommands ] +.\"===================================================================== +.SH DESCRIPTION +Run the e-\*(TX typesetter on +.IR file , +by default creating +.IR file.dvi . +If the file argument has no extension, ".tex" will be appended to it. +Instead of a filename, a set of e-\*(TX commands can be given, the first +of which must start with a backslash. +With a +.BI & format +argument e-\*(TX uses a different set of precompiled commands, +contained in +.IR format\fB.fmt\fP ; +it is usually better to use the +.B -fmt +.I format +option instead. +.PP +e-\*(TX is the first concrete result of an international research & +development project, the NTS Project, which was established under the +aegis of DANTE e.V. during 1992. The aims of the project are to +perpetuate and develop the spirit and philosophy of \*(TX, whilst +respecting Knuth's wish that \*(TX should remain frozen. +.PP +e-\*(TX can be used in two different modes: in +.I compatibility mode +it is supposed to be completely interchangable with standard \*(TX. +In +.I extended mode +several new primitives are added that facilitate (among other things) +bidirectional typesetting. +.PP +An extended mode format is generated by prefixing the name of the +source file for the format with an asterisk (*). +.PP +e-\*(TX's handling of its command-line arguments is similar to that of +the other \*(TX programs in the +.I web2c +implementation. +.\"===================================================================== +.SH OPTIONS +This version of e-\*(TX understands the following command line options. +.TP +.BI -fmt \ format +Use +.I format +as the name of the format to be used, instead of the name by which +e-\*(TX was called or a +.I %& +line. +.TP +.B -enc +Enable the enc\*(TX extensions. This option is only effective in +combination with +.BR -ini . +For documentation of the enc\*(TX extensions see +.BR http://www.olsak.net/enctex.html . +.TP +.B -etex +Enable the e-\*(TX extensions. This option is only effective in +combination with +.BR -ini . +.TP +.B -file-line-error +Print error messages in the form +.I file:line:error +which is similar to the way many compilers format them. +.TP +.B -no-file-line-error +Disable printing error messages in the +.I file:line:error +style. +.TP +.B -file-line-error-style +This is the old name of the +.B -file-line-error +option. +.TP +.B -halt-on-error +Exit with an error code when an error is encountered during processing. +.TP +.B -help +Print help message and exit. +.TP +.B -ini +Start in +.I INI +mode, which is used to dump formats. The +.I INI +mode can be used for typesetting, but no format is preloaded, and +basic initializations like setting catcodes may be required. +.TP +.BI -interaction \ mode +Sets the interaction mode. The mode can be either +.IR batchmode , +.IR nonstopmode , +.IR scrollmode , +and +.IR errorstopmode . +The meaning of these modes is the same as that of the corresponding +\ecommands. +.TP +.B -ipc +Send DVI output to a socket as well as the usual output file. Whether +this option is available is the choice of the installer. +.TP +.B -ipc-start +As +.BR -ipc , +and starts the server at the other end as well. Whether this option +is available is the choice of the installer. +.TP +.BI -jobname \ name +Use +.I name +for the job name, instead of deriving it from the name of the input file. +.TP +.BI -kpathsea-debug \ bitmask +Sets path searching debugging flags according to the bitmask. See the +.I Kpathsea +manual for details. +.TP +.BI -mktex \ fmt +Enable +.RI mktex fmt , +where +.I fmt +must be either +.I tex +or +.IR tfm . +.TP +.B -mltex +Enable ML\*(TX extensions. Only effective in combination with +.BR -ini . +.TP +.BI -no-mktex \ fmt +Disable +.RI mktex fmt , +where +.I fmt +must be either +.I tex +or +.IR tfm . +.TP +.BI -output-comment \ string +Use +.I string +for the +.I DVI +file comment instead of the date. +.TP +.BI -output-directory \ directory +Write output files in +.I directory +instead of the current directory. Look up input files in +.I directory +first, the along the normal search path. +.TP +.B -parse-first-line +If the first line of the main input file begins with +.I %& +parse it to look for a dump name or a +.B -translate-file +option. +.TP +.B -no-parse-first-line +Disable parsing of the first line of the main input file. +.TP +.BI -progname \ name +Pretend to be program +.IR name . +This affects both the format used and the search paths. +.TP +.B -recorder +Enable the filename recorder. This leaves a trace of the files opened +for input and output in a file with extension +.IR .fls . +.TP +.B -shell-escape +Enable the +.BI \ewrite18{ command } +construct. The +.I command +can be any shell command. This construct is normally +disallowed for security reasons. +.TP +.B -no-shell-escape +Disable the +.BI \ewrite18{ command } +construct, even if it is enabled in the +.I texmf.cnf +file. +.TP +.B -src-specials +Insert source specials into the +.I DVI +file. +.TP +.BI -src-specials \ where +Insert source specials in certain placed of the +.I DVI +file. +.I where +is a comma-separated value list: +.IR cr , +.IR display , +.IR hbox , +.IR math , +.IR par , +.IR parent , +or +.IR vbox . +.TP +.BI -translate-file \ tcxname +Use the +.I tcxname +translation table to set the mapping of input characters and +re-mapping of output characters. +.TP +.BI -default-translate-file \ tcxname +Like +.B -translate-file +except that a +.I %& +line can overrule this setting. +.TP +.B -version +Print version information and exit. +.\"===================================================================== +.SH ENVIRONMENT +See the Kpathsearch library documentation (the `Path specifications' +node) for precise details of how the environment variables are used. +The +.B kpsewhich +utility can be used to query the values of the variables. +.PP +One caveat: In most e-\*(TX formats, you cannot use ~ in a filename you +give directly to e-\*(TX, because ~ is an active character, and hence is +expanded, not taken as part of the filename. Other programs, such as +\*(MF, do not have this problem. +.PP +.TP +.B TEXMFOUTPUT +Normally, e-\*(TX puts its output files in the current directory. If +any output file cannot be opened there, it tries to open it in the +directory specified in the environment variable TEXMFOUTPUT. +There is no default value for that variable. For example, if you say +.I etex paper +and the current directory is not writable, if TEXMFOUTPUT has +the value +.IR /tmp , +e-\*(TX attempts to create +.I /tmp/paper.log +(and +.IR /tmp/paper.dvi , +if any output is produced.) TEXMFOUTPUT is also checked for input +files, as \*(TX often generates files that need to be subsequently +read; for input, no suffixes (such as ``.tex'') are added by default, +the input name is simply checked as given. +.TP +.B TEXINPUTS +Search path for +.I \einput +and +.I \eopenin +files. +This should start with ``.'', so +that user files are found before system files. An empty path +component will be replaced with the paths defined in the +.I texmf.cnf +file. For example, set TEXINPUTS to ".:/home/user/tex:" to prepend the +current direcory and ``/home/user/tex'' to the standard search path. +.TP +.B TEXFORMATS +Search path for format files. +.TP +.B TEXPOOL +search path for +.B etex +internal strings. +.TP +.B TEXEDIT +Command template for switching to editor. The default, usually +.BR vi , +is set when e-\*(TX is compiled. +.TP +.B TFMFONTS +Search path for font metric +.RI ( .tfm ) +files. +.\"===================================================================== +.SH FILES +The location of the files mentioned below varies from system to +system. Use the +.B kpsewhich +utility to find their locations. +.TP +.I etex.pool +Text file containing e-\*(TX's internal strings. +.TP +.I texfonts.map +Filename mapping definitions. +.TP +.I *.tfm +Metric files for e-\*(TX's fonts. +.TP +.I *.fmt +Predigested e-\*(TX format (.\|fmt) files. +.\"===================================================================== +.SH NOTES +Starting with version 1.40, pdf\*(TX incorporates the e-\*(TX +extensions, so in this installation e\*(TX may be just a symbolic link to +pdf\*(TX. See +.BR pdftex (1). +This manual page is not meant to be exhaustive. The complete +documentation for this version of e-\*(TX can be found in the info +manual +.IR "Web2C: A TeX implementation" . +.\"===================================================================== +.SH BUGS +This version of e-\*(TX implements a number of optional extensions. +In fact, many of these extensions conflict to a greater or lesser +extent with the definition of e-\*(TX. When such extensions are +enabled, the banner printed when e-\*(TX starts is changed to print +.B e-TeXk +instead of +.BR e-TeX . +.PP +This version of e-\*(TX fails to trap arithmetic overflow when +dimensions are added or subtracted. Cases where this occurs are rare, +but when it does the generated +.I DVI +file will be invalid. +.\"===================================================================== +.SH "SEE ALSO" +.BR pdftex (1), +.BR tex (1), +.BR mf (1). +.\"===================================================================== +.SH AUTHORS +e-\*(TX was developed by Peter Breitenlohner and the NTS team; Peter +later continued its development outside of the team. +.PP +\*(TX was designed by Donald E. Knuth, +who implemented it using his \*(WB system for Pascal programs. +It was ported to Unix at Stanford by Howard Trickey, and +at Cornell by Pavel Curtis. +The version now offered with the Unix \*(TX distribution is that +generated by the \*(WB to C system +.RB ( web2c ), +originally written by Tomas Rokicki and Tim Morgan. +.PP +The enc\*(TX extensions were written by Petr Olsak. diff --git a/Master/texmf-dist/doc/man/man1/etex.man1.pdf b/Master/texmf-dist/doc/man/man1/etex.man1.pdf Binary files differnew file mode 100644 index 00000000000..ef74336cd71 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/etex.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/extconv.1 b/Master/texmf-dist/doc/man/man1/extconv.1 new file mode 100644 index 00000000000..e09bfefb544 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/extconv.1 @@ -0,0 +1,111 @@ +.\" man page for bg5conv +.\" +.\" Copyright (C) 1994-2012 Werner Lemberg <wl@gnu.org> +.\" +.\" 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 2 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 in doc/COPYING; if not, write to the Free +.\" Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, +.\" MA 02110-1301 USA +. +.TH EXTCONV 1 07-May-2012 "CJK Version 4.8.3" +. +.\" ==== +.\" ==== macro definitions +.\" ==== +. +.\" here we define \TeX for troff and nroff +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +. +.\" and here the same for \LaTeX +.if t \{\ +.ie '\*(.T'dvi' \ +.ds LX \fRL\h'-0.36m'\v'-0.15v'\s-3A\s0\h'-0.15m'\v'0.15v'\fP\*(TX +.el .ds LX \fRL\h'-0.36m'\v'-0.22v'\s-2A\s0\h'-0.15m'\v'0.22v'\fP\*(TX +.\} +.if n .ds LX LaTeX +. +.\" \LaTeXe +.\" note that we need \vareps for TeX instead of \eps which can only be +.\" accessed with the \N escape sequence (in the Math Italic font) +.if t \{\ +.ie '\*(.T'dvi' .ds LE \*(LX\h'0.15m'2\v'0.20v'\f(MI\N'34'\fP\v'-0.20v' +.el .ds LE \*(LX\h'0.15m'2\v'0.20v'\(*e\v'-0.20v' +.\} +.if n .ds LE LaTeX\ 2e +. +.\" a typewriter font +.if t \{\ +.de C +\fC\\$1\fP\\$2 +.. +.\} +.if n \{\ +.de C +\\$1\\$2 +.. +.\} +. +.\" ==== +.\" ==== end of macro definitions +.\" ==== +. +. +. +.SH NAME +extconv \- convert a TeX document in either Big\ 5+ or GBK encoding into +`preprocessed' form. +. +. +.SH SYNOPSIS +.B extconv +< +.I infile +> +.I outfile +. +. +.SH DESCRIPTION +Big\ 5+ and GBK encodings use the characters +.C { , +.C } , +and +.C \e +which have special meanings in \*(TX +documents. +.PP +After processing a \*(LE +document which contains such characters with +.B \%extconv +you need not care about these special characters. +.PP +This filter is part of the +.B CJK +macro package for \*(LE. +. +. +.SH "SEE ALSO" +.BR bg5conv (1), +.BR \%sjisconv (1), +.BR \%cefconv (1), +.BR cef5conv (1), +.BR \%cefsconv (1), +.br +the +.B CJK +documentation files. +. +. +.SH AUTHOR +Werner Lemberg +.C <wl@gnu.org> diff --git a/Master/texmf-dist/doc/man/man1/extconv.man1.pdf b/Master/texmf-dist/doc/man/man1/extconv.man1.pdf Binary files differnew file mode 100644 index 00000000000..d43f99978b9 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/extconv.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/extractbb.1 b/Master/texmf-dist/doc/man/man1/extractbb.1 new file mode 100644 index 00000000000..34b6d348580 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/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\&. diff --git a/Master/texmf-dist/doc/man/man1/extractbb.man1.pdf b/Master/texmf-dist/doc/man/man1/extractbb.man1.pdf Binary files differnew file mode 100644 index 00000000000..933a82da09e --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/extractbb.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/extractres.1 b/Master/texmf-dist/doc/man/man1/extractres.1 new file mode 100644 index 00000000000..272b633794e --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/extractres.1 @@ -0,0 +1,47 @@ +.TH EXTRACTRES 1 "PSUtils Release 1 Patchlevel 17" +.SH NAME +extractres \- filter to extract resources from a PostScript document +.SH SYNOPSIS +.B extractres +[ +.B \-m +] < +.I document.ps +> +.I output.ps +.SH DESCRIPTION +.I Extractres +extracts resources (fonts, procsets, patterns, files, etc) appearing in a +PostScript document, and puts appropriate +.I %%IncludeResource +comments in the document prologue. The extracted resources are written to +files with the same name as the resource, and an appropriate extension. The +pipeline +.sp +.ce +extractres file.ps | includeres >out.ps +.sp +will move all resources appearing in a document to the document prologue, +removing redundant copies. The output file can then be put through page +re-arrangement filters such as +.I psnup +or +.I pstops +safely. +.PP +The +.B \-m +option combines the resources of the same name into one file; this must be +used for some programs which download fonts a bit at a time. +.SH AUTHOR +Copyright (C) Angus J. C. Duggan 1991-1995 +.SH "SEE ALSO" +epsffit(1), psbook(1), psnup(1), psresize(1), psselect(1), pstops(1), extractres(1), fixdlsrps(1), fixfmps(1), fixpsditps(1), fixpspps(1), fixscribeps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), includeres(1), psmerge(1), getafm(1) +.SH TRADEMARKS +.B PostScript +is a trademark of Adobe Systems Incorporated. +.SH BUGS +.I extractres +does not alter the +.I %%DocumentSuppliedResources +comments. diff --git a/Master/texmf-dist/doc/man/man1/extractres.man1.pdf b/Master/texmf-dist/doc/man/man1/extractres.man1.pdf Binary files differnew file mode 100644 index 00000000000..39debaaaa34 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/extractres.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/findhyph.1 b/Master/texmf-dist/doc/man/man1/findhyph.1 new file mode 100644 index 00000000000..4e46a4d311d --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/findhyph.1 @@ -0,0 +1,247 @@ +.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "FINDHYPH 1" +.TH FINDHYPH 1 "2012-11-21" "perl v5.10.1" "" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +\&\fBfindhyph\fR \*(-- find words hyphenated by TeX in a document +.SH "INSTALLATION" +.IX Header "INSTALLATION" +Copy \fBfindhyph\fR or \fBfindhyph.bat\fR (depending on \s-1OS\s0 used) to a directory +included in system \s-1PATH\s0. Perl interpreter is required to be in +\&\f(CW\*(C`/usr/bin/\*(C'\fR for Unix-like systems or in \s-1PATH\s0 when using \fBfindhyph.bat\fR. +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +.IP "1)" 4 +.IX Item "1)" +set \f(CW\*(C`\etracingparagraphs=1\*(C'\fR in a TeX document \fIfoo.tex\fR and run: +.IP "2)" 4 +.IX Item "2)" +\&\fBtex\fR \fIfoo.tex\fR +.IP "3)" 4 +.IX Item "3)" +\&\fBfindhyph [options]\fR \fIfoo.log\fR +.PP +If you are setting \f(CW\*(C`\elooseness=<N>\*(C'\fR to optimize paragraphs, +you need to pass that information to the file \fIfoo.log\fR in a form +\&\f(CW\*(C`@looseness=<N>\*(C'\fR (on a separate line). You can use a macro like +\&\f(CW\*(C`\edef\esetlooseness#1{\elooseness=#1 \eimmediate\ewrite\-1{@looseness=#1}}\*(C'\fR +for this purpose. If the paragraph contains material in display math mode, +you need to use the macro in all split parts of the paragraph. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-c\fR" 4 +.IX Item "-c" +display hyphenated words in context +.IP "\fB\-f\fR" 4 +.IX Item "-f" +display font selectors and other strings starting with a backslash character +.IP "\fB\-v\fR" 4 +.IX Item "-v" +display program version +.IP "\fB\-p\fR" 4 +.IX Item "-p" +generate file containing information about one-letter prepositions and +conjunctions left at the end of line +.IP "\fB\-l=STRING\fR" 4 +.IX Item "-l=STRING" +use prepositions/conjunctions listed in \s-1STRING\s0 instead of default list of +prepositions and conjunctions \f(CW\*(C`kKsSvVzZoOuUiIA\*(C'\fR used for Slovak and Czech +language +.SH "OUTPUT FILES" +.IX Header "OUTPUT FILES" +.IP "\fIfoo.hyph\fR" 4 +.IX Item "foo.hyph" +List of hyphenated words. All punctuation characters, parentheses and +other character immediately preceding or following displayed words are included +in this list. TeX constructs which are too difficult to display (\f(CW\*(C`\ehbox{}\*(C'\fR, +\&\f(CW\*(C`\emark{}\*(C'\fR etc.) are shown as \f(CW\*(C`[]\*(C'\fR. Math mode is indicated by \f(CW\*(C`$\*(C'\fR sign. +.Sp +Page numbers in square brackets refer to \s-1LOG\s0 file and may occasionally differ +from the typeset document. The reason is that TeX may need to break more +paragraphs than it would eventually fit on the page in order to find a page +break. +.Sp +Words hyphenated in footnotes are listed before the words hyphenated in the +paragraph in which the footnote is referenced. +.IP "\fIfoo.prep\fR" 4 +.IX Item "foo.prep" +List of prepositions if option \fB\-p\fR is used. +.SH "HISTORY" +.IX Header "HISTORY" +1.0 (2001\-04\-08) +.IX Subsection "1.0 (2001-04-08)" +.IP "\(bu" 4 +public release +.PP +2.0 (2009\-08\-10) +.IX Subsection "2.0 (2009-08-10)" +.IP "\(bu" 4 +fixes in line breaks detection algorithm; support for the third pass of line +breaking algorithm in TeX (positive \eemergencystretch); support for +discretionary breaks in the first pass +.IP "\(bu" 4 +page number detection improved (recognized negative page numbers, compound page +numbers when \f(CW\*(C`\ecount1\*(C'\fR to \f(CW\*(C`\ecount9\*(C'\fR registers are non-zero +and \f(CW\*(C`[nn{mapfile}]\*(C'\fR, \f(CW\*(C`[nn<picture>]\*(C'\fR and \f(CW\*(C`[nn<newline>\*(C'\fR +formats used by pdfTeX; false page number detection should be much more rare) +.IP "\(bu" 4 +configurable list of prepositions and conjunctions +.IP "\(bu" 4 +hyphenated words can be displayed in context +.IP "\(bu" 4 +suggestions and testing by Pavel Striz +.PP +3.0 (2012\-02\-01) +.IX Subsection "3.0 (2012-02-01)" +.IP "\(bu" 4 +fixed a bug when total paragraph demerits are negative +.IP "\(bu" 4 +\&\f(CW\*(C`\elooseness\*(C'\fR setting is now taken into account (thanks to Karel Horak +for identifying the issue) +.PP +3.1 (2012\-11\-03) +.IX Subsection "3.1 (2012-11-03)" +.IP "\(bu" 4 +fixed displaying of hyphenated ligatures (bug reported by Karel Horak) +.PP +3.2 (2012\-11\-21) +.IX Subsection "3.2 (2012-11-21)" +.IP "\(bu" 4 +improved example definition of the \f(CW\*(C`\esetlooseness\*(C'\fR macro +(thanks to Karl Berry) +.SH "LICENSE" +.IX Header "LICENSE" +This program is free software; you can redistribute it and/or modify +it under the terms of the \s-1GNU\s0 General Public License as published by +the Free Software Foundation; either version 2 of the License, or +any later version. +.SH "AUTHOR" +.IX Header "AUTHOR" +Copyright (c) Martin Budaj <m.b@speleo.sk> 2000, 2001, 2009, 2012 diff --git a/Master/texmf-dist/doc/man/man1/findhyph.man1.pdf b/Master/texmf-dist/doc/man/man1/findhyph.man1.pdf Binary files differnew file mode 100644 index 00000000000..b0884f47327 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/findhyph.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/fixdlsrps.1 b/Master/texmf-dist/doc/man/man1/fixdlsrps.1 new file mode 100644 index 00000000000..c59bea2ad71 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/fixdlsrps.1 @@ -0,0 +1,24 @@ +.TH FIXDLSRPS 1 "PSUtils Release 1 Patchlevel 17" +.SH NAME +fixdlsrps \- filter to fix DviLaser/PS documents to work with PSUtils +.SH SYNOPSIS +.B fixdlsrps +< +.I dvilaser.ps +> +.I Fixed.ps +.SH DESCRIPTION +.I Fixdlsrps +is a +.I perl +filter which "fixes" PostScript generated from the DviLaser/PS driver so +that it works correctly with Angus Duggan's +.B psutils +package. +.SH AUTHOR +Copyright (C) Angus J. C. Duggan 1991-1995 +.SH "SEE ALSO" +epsffit(1), psbook(1), psnup(1), psresize(1), psselect(1), pstops(1), extractres(1), fixdlsrps(1), fixfmps(1), fixpsditps(1), fixpspps(1), fixscribeps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), includeres(1), psmerge(1), getafm(1) +.SH TRADEMARKS +.B PostScript +is a trademark of Adobe Systems Incorporated. diff --git a/Master/texmf-dist/doc/man/man1/fixdlsrps.man1.pdf b/Master/texmf-dist/doc/man/man1/fixdlsrps.man1.pdf Binary files differnew file mode 100644 index 00000000000..9427ce49ff7 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/fixdlsrps.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/fixfmps.1 b/Master/texmf-dist/doc/man/man1/fixfmps.1 new file mode 100644 index 00000000000..1b7bbc060fe --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/fixfmps.1 @@ -0,0 +1,24 @@ +.TH FIXFMPS 1 "PSUtils Release 1 Patchlevel 17" +.SH NAME +fixfmps \- filter to fix Framemaker documents so PSUtils work +.SH SYNOPSIS +.B fixfmps +< +.I Framemaker.ps +> +.I Fixed.ps +.SH DESCRIPTION +.I Fixfmps +is a +.I perl +filter which "fixes" PostScript from Framemaker so +that it works correctly with Angus Duggan's +.B psutils +package. +.SH AUTHOR +Copyright (C) Angus J. C. Duggan 1991-1995 +.SH "SEE ALSO" +epsffit(1), psbook(1), psnup(1), psresize(1), psselect(1), pstops(1), extractres(1), fixdlsrps(1), fixfmps(1), fixpsditps(1), fixpspps(1), fixscribeps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), includeres(1), psmerge(1), getafm(1) +.SH TRADEMARKS +.B PostScript +is a trademark of Adobe Systems Incorporated. diff --git a/Master/texmf-dist/doc/man/man1/fixfmps.man1.pdf b/Master/texmf-dist/doc/man/man1/fixfmps.man1.pdf Binary files differnew file mode 100644 index 00000000000..796096a5669 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/fixfmps.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/fixpsditps.1 b/Master/texmf-dist/doc/man/man1/fixpsditps.1 new file mode 100644 index 00000000000..87df4171ab5 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/fixpsditps.1 @@ -0,0 +1,24 @@ +.TH FIXPSDITPS 1 "PSUtils Release 1 Patchlevel 17" +.SH NAME +fixpsditps \- filter to fix Transcript psdit documents so PSUtils work +.SH SYNOPSIS +.B fixpsditps +< +.I psdit.ps +> +.I Fixed.ps +.SH DESCRIPTION +.I Fixpsditps +is a +.I perl +filter which "fixes" PostScript from Transcript's psdit program so +that it works correctly with Angus Duggan's +.B psutils +package. +.SH AUTHOR +Copyright (C) Angus J. C. Duggan 1991-1995 +.SH "SEE ALSO" +epsffit(1), psbook(1), psnup(1), psresize(1), psselect(1), pstops(1), extractres(1), fixdlsrps(1), fixfmps(1), fixpsditps(1), fixpspps(1), fixscribeps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), includeres(1), psmerge(1), getafm(1) +.SH TRADEMARKS +.B PostScript +is a trademark of Adobe Systems Incorporated. diff --git a/Master/texmf-dist/doc/man/man1/fixpsditps.man1.pdf b/Master/texmf-dist/doc/man/man1/fixpsditps.man1.pdf Binary files differnew file mode 100644 index 00000000000..d38a0f09825 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/fixpsditps.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/fixpspps.1 b/Master/texmf-dist/doc/man/man1/fixpspps.1 new file mode 100644 index 00000000000..7309574b43b --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/fixpspps.1 @@ -0,0 +1,24 @@ +.TH FIXPSPPS 1 "PSUtils Release 1 Patchlevel 17" +.SH NAME +fixpspps \- filter to fix PSPrint PostScript so PSUtils work +.SH SYNOPSIS +.B fixpspps +< +.I PSPrint.ps +> +.I Fixed.ps +.SH DESCRIPTION +.I Fixpspps +is a +.I perl +filter which "fixes" PostScript from PSPrint so +that it works correctly with Angus Duggan's +.B psutils +package. +.SH AUTHOR +Copyright (C) Angus J. C. Duggan 1991-1995 +.SH "SEE ALSO" +epsffit(1), psbook(1), psnup(1), psresize(1), psselect(1), pstops(1), extractres(1), fixdlsrps(1), fixfmps(1), fixpsditps(1), fixpspps(1), fixscribeps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), includeres(1), psmerge(1), getafm(1) +.SH TRADEMARKS +.B PostScript +is a trademark of Adobe Systems Incorporated. diff --git a/Master/texmf-dist/doc/man/man1/fixpspps.man1.pdf b/Master/texmf-dist/doc/man/man1/fixpspps.man1.pdf Binary files differnew file mode 100644 index 00000000000..7995d1c0da6 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/fixpspps.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/fixscribeps.1 b/Master/texmf-dist/doc/man/man1/fixscribeps.1 new file mode 100644 index 00000000000..18c24a56276 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/fixscribeps.1 @@ -0,0 +1,24 @@ +.TH FIXSCRIBEPS 1 "PSUtils Release 1 Patchlevel 17" +.SH NAME +fixscribeps \- filter to fix Scribe documents so PSUtils work +.SH SYNOPSIS +.B fixscribeps +< +.I Scribe.ps +> +.I Fixed.ps +.SH DESCRIPTION +.I Fixscribeps +is a +.I perl +filter which "fixes" PostScript from Scribe so +that it works correctly with Angus Duggan's +.B psutils +package. +.SH AUTHOR +Copyright (C) Angus J. C. Duggan 1991-1995 +.SH "SEE ALSO" +epsffit(1), psbook(1), psnup(1), psresize(1), psselect(1), pstops(1), extractres(1), fixdlsrps(1), fixfmps(1), fixpsditps(1), fixpspps(1), fixscribeps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), includeres(1), psmerge(1), getafm(1) +.SH TRADEMARKS +.B PostScript +is a trademark of Adobe Systems Incorporated. diff --git a/Master/texmf-dist/doc/man/man1/fixscribeps.man1.pdf b/Master/texmf-dist/doc/man/man1/fixscribeps.man1.pdf Binary files differnew file mode 100644 index 00000000000..9177e9d10b8 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/fixscribeps.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/fixtpps.1 b/Master/texmf-dist/doc/man/man1/fixtpps.1 new file mode 100644 index 00000000000..7b3991c7ad4 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/fixtpps.1 @@ -0,0 +1,24 @@ +.TH FIXTPPS 1 "PSUtils Release 1 Patchlevel 17" +.SH NAME +fixtpps \- filter to fix Tpscript documents to work with PSUtils +.SH SYNOPSIS +.B fixtpps +< +.I Tpscript.ps +> +.I Fixed.ps +.SH DESCRIPTION +.I Fixtpps +is a +.I perl +filter which "fixes" PostScript generated from the Troff Tpscript driver so +that it works correctly with Angus Duggan's +.B psutils +package. +.SH AUTHOR +Copyright (C) Angus J. C. Duggan 1991-1995 +.SH "SEE ALSO" +epsffit(1), psbook(1), psnup(1), psresize(1), psselect(1), pstops(1), extractres(1), fixdlsrps(1), fixfmps(1), fixpsditps(1), fixpspps(1), fixscribeps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), includeres(1), psmerge(1), getafm(1) +.SH TRADEMARKS +.B PostScript +is a trademark of Adobe Systems Incorporated. diff --git a/Master/texmf-dist/doc/man/man1/fixtpps.man1.pdf b/Master/texmf-dist/doc/man/man1/fixtpps.man1.pdf Binary files differnew file mode 100644 index 00000000000..665a5e8d4eb --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/fixtpps.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/fixwfwps.1 b/Master/texmf-dist/doc/man/man1/fixwfwps.1 new file mode 100644 index 00000000000..00d147bc39a --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/fixwfwps.1 @@ -0,0 +1,24 @@ +.TH FIXWFWPS 1 "PSUtils Release 1 Patchlevel 17" +.SH NAME +fixwfwps \- filter to fix Word for Windows documents so PSUtils work +.SH SYNOPSIS +.B fixwfwps +< +.I WordforWindows.ps +> +.I Fixed.ps +.SH DESCRIPTION +.I Fixwfwps +is a +.I perl +filter which "fixes" PostScript from Word for Windows so +that it works correctly with Angus Duggan's +.B psutils +package. +.SH AUTHOR +Copyright (C) Angus J. C. Duggan 1991-1995 +.SH "SEE ALSO" +epsffit(1), psbook(1), psnup(1), psresize(1), psselect(1), pstops(1), extractres(1), fixdlsrps(1), fixfmps(1), fixpsditps(1), fixpspps(1), fixscribeps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), includeres(1), psmerge(1), getafm(1) +.SH TRADEMARKS +.B PostScript +is a trademark of Adobe Systems Incorporated. diff --git a/Master/texmf-dist/doc/man/man1/fixwfwps.man1.pdf b/Master/texmf-dist/doc/man/man1/fixwfwps.man1.pdf Binary files differnew file mode 100644 index 00000000000..a8dd34caa73 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/fixwfwps.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/fixwpps.1 b/Master/texmf-dist/doc/man/man1/fixwpps.1 new file mode 100644 index 00000000000..af2e2d87a14 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/fixwpps.1 @@ -0,0 +1,24 @@ +.TH FIXWPPS 1 "PSUtils Release 1 Patchlevel 17" +.SH NAME +fixwpps \- filter to fix WP documents so PSUtils work +.SH SYNOPSIS +.B fixwpps +< +.I WordPerfect.ps +> +.I Fixed.ps +.SH DESCRIPTION +.I Fixwpps +is a +.I perl +filter which "fixes" PostScript from WordPerfect 5.0 and 5.1 so +that it works correctly with Angus Duggan's +.B psutils +package. +.SH AUTHOR +Copyright (C) Angus J. C. Duggan 1991-1995 +.SH "SEE ALSO" +epsffit(1), psbook(1), psnup(1), psresize(1), psselect(1), pstops(1), extractres(1), fixdlsrps(1), fixfmps(1), fixpsditps(1), fixpspps(1), fixscribeps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), includeres(1), psmerge(1), getafm(1) +.SH TRADEMARKS +.B PostScript +is a trademark of Adobe Systems Incorporated. diff --git a/Master/texmf-dist/doc/man/man1/fixwpps.man1.pdf b/Master/texmf-dist/doc/man/man1/fixwpps.man1.pdf Binary files differnew file mode 100644 index 00000000000..f0dd52f8345 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/fixwpps.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/fixwwps.1 b/Master/texmf-dist/doc/man/man1/fixwwps.1 new file mode 100644 index 00000000000..99165c8b4c3 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/fixwwps.1 @@ -0,0 +1,24 @@ +.TH FIXWWPS 1 "PSUtils Release 1 Patchlevel 17" +.SH NAME +fixwwps \- filter to fix Windows Write documents so PSUtils work +.SH SYNOPSIS +.B fixwwps +< +.I WinWrite.ps +> +.I Fixed.ps +.SH DESCRIPTION +.I Fixwwps +is a +.I perl +filter which "fixes" PostScript from Windows Write so +that it works correctly with Angus Duggan's +.B psutils +package. +.SH AUTHOR +Copyright (C) Angus J. C. Duggan 1991-1995 +.SH "SEE ALSO" +epsffit(1), psbook(1), psnup(1), psresize(1), psselect(1), pstops(1), extractres(1), fixdlsrps(1), fixfmps(1), fixpsditps(1), fixpspps(1), fixscribeps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), includeres(1), psmerge(1), getafm(1) +.SH TRADEMARKS +.B PostScript +is a trademark of Adobe Systems Incorporated. diff --git a/Master/texmf-dist/doc/man/man1/fixwwps.man1.pdf b/Master/texmf-dist/doc/man/man1/fixwwps.man1.pdf Binary files differnew file mode 100644 index 00000000000..28ec9338205 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/fixwwps.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/fmtutil-sys.1 b/Master/texmf-dist/doc/man/man1/fmtutil-sys.1 new file mode 100644 index 00000000000..71c6a947903 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/fmtutil-sys.1 @@ -0,0 +1 @@ +.so man1/fmtutil.1 diff --git a/Master/texmf-dist/doc/man/man1/fmtutil-sys.man1.pdf b/Master/texmf-dist/doc/man/man1/fmtutil-sys.man1.pdf Binary files differnew file mode 100644 index 00000000000..a97fcdbfd73 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/fmtutil-sys.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/fmtutil.1 b/Master/texmf-dist/doc/man/man1/fmtutil.1 new file mode 100644 index 00000000000..39ed57bf8b5 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/fmtutil.1 @@ -0,0 +1,113 @@ +.TH FMTUTIL 1 "June 2011" "TeX Live" "TeX Live" +.SH "NAME" +fmtutil \- utility for maintaining TeX format files +.PP +fmtutil-sys \- utility for maintaining TeX format files system\-wide +.SH "SYNOPSIS" +.B fmtutil\fP +.RI [ OPTION .\|.\|.] +.I COMMAND +.PP +.B fmtutil-sys +.RI [ OPTION .\|.\|.] +.I COMMAND +.SH "DESCRIPTION" +\fBfmtutil\fP is used to create or recreate format and hyphenation +files or show information about format files\&. +.PP +\fICOMMAND\fP is one of: +.PP +.TP +.B --all +recreate all format files +.TP +.BI --byengine \ enginename +(re)create formats that depend on the +engine \fIenginename\fP +.TP +.BI --byfmt \ formatname +(re)create the format for +format \fIformatname\fP +.TP +.BI --byhyphen \ hyphenfile +(re)create formats that depend on the +hyphenation file \fIhyphenfile\fP +.TP +.B --catcfg +output the content of the config file +.TP +.BI --disablefmt \ formatname +disable +.I formatname +in config file +.TP +.B --edit +no-op in TeX Live +.TP +.BI --enablefmt \ formatname +ensable +.I formatname +in config file +.TP +.B --help +print a summary of commands and options +.TP +.B --listcfg +list (enabled and disabled) configurations, filtered to available formats +.TP +.B --missing +create all missing format files +.TP +.B --refresh +recreate only existing format files +.TP +.BI --showhyphen \ formatname +print the name of the +hyphenation file for the format +\fIformatname\fP +.TP +.B --version +show version info +.SH "OPTIONS" +.TP +.BI --cnffile \ file +specify the configuration +\fIfile\fP \fBfmtutil\fP should use +.TP +.B --dolinks +(not implemented, just for compatibility) +.TP +.BI --fmtdir \ directory +set the destination +directory for format files generated by +\fBfmtutil\fP to \fIdirectory\fP +.TP +.B --force +(not implemented, just for compatibility) +.TP +.B --no-engine-subdir +don't use engine-specific subdir of the fmtdir +.TP +.B --no-error-if-no-format +exit successfully if no format is selected +.TP +.B --quiet +be silent +.TP +.B --test +(not implemented, just for compatibility) +.SH "FILES" +.TP +.I fmtutil\&.cnf +default configuration file +.SH "SEE ALSO" +.BR kpsewhich (1) +.SH "BUGS" +None known, but report any bugs found to <tex-k@tug.org> (mailing list). +.SH "AUTHOR" +\fBfmtutil\fP was written by Thomas Esser +<te@dbs\&.uni-hannover\&.de> and is in the public domain. +.PP +This manual page was written by C\&.M\&. Connelly +<c@eskimo\&.com>, for +the Debian GNU/Linux system and later slightly adapted for the teTeX 3 release\&. diff --git a/Master/texmf-dist/doc/man/man1/fmtutil.man1.pdf b/Master/texmf-dist/doc/man/man1/fmtutil.man1.pdf Binary files differnew file mode 100644 index 00000000000..f3dfec982d3 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/fmtutil.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/fontinst.1 b/Master/texmf-dist/doc/man/man1/fontinst.1 new file mode 100644 index 00000000000..b907280d90d --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/fontinst.1 @@ -0,0 +1,45 @@ +.TH "fontinst" "1" "May 2000" "teTeX" "teTeX" +.PP +.SH "NAME" +fontinst \- utility to run TeX as fontinst +.PP +.SH "SYNOPSIS" +.PP +\fBfontinst\fP \fIpackage\fP +.PP +.SH "DESCRIPTION" +.PP +\fBfontinst\fP runs \fBtex\fP(1) with the \fB--progname\fP flag set to +pretend to be the program fontinst (affecting Karl Berry paths)\&. +.PP +Typing +.PP +\f(CWfontinst fontinst\&.sty\fP +.PP +will start \fBtex\fP(1) and give the user an interactive prompt +(\f(CW*\fP) where fontinst commands can be typed (such as +\f(CW\elatinfamily{ptm}{}\ebye\fP)\&. +.PP +.SH "SEE ALSO" +.PP +\fBtex\fP(1) +.PP +The fontinst manual, \fIfontinst\&.tex\fP\&. +.PP +Web page: <http://tug\&.org/applications/fontinst/> +.PP +.SH "BUGS" +.PP +None known, but report any bugs found to tex-fonts@tug\&.org (mailing list)\&. +.PP +.SH "AUTHOR" +.PP +Thomas Esser +<te@dbs\&.uni-hannover\&.de> +.PP +This manual page was written by C\&.M\&. Connelly +<c@eskimo\&.com>, for +the Debian GNU/Linux system\&. It may be used by other distributions +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/Master/texmf-dist/doc/man/man1/fontinst.man1.pdf b/Master/texmf-dist/doc/man/man1/fontinst.man1.pdf Binary files differnew file mode 100644 index 00000000000..358de905ac8 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/fontinst.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/getafm.1 b/Master/texmf-dist/doc/man/man1/getafm.1 new file mode 100644 index 00000000000..fd3e1d78e36 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/getafm.1 @@ -0,0 +1,29 @@ +.TH GETAFM 1 "PSUtils Release 1 Patchlevel 17" +.SH NAME +getafm \- create an AFM file for a PostScript font. +.SH SYNOPSIS +.B getafm +.I FontName +> +.I output.ps +.SH DESCRIPTION +.I Getafm +generates a PostScript file which prints an AFM file for a font to the +printer's output channel. The output of +.I getafm +should be sent to a printer, or to GhostScript. For example, +.sp +.ce +getafm Times-Roman | gsnd - >Times-Roman.afm +.sp +.SH AUTHOR +Robert Joop (rj@rainbow.in-berlin.de), Angus Duggan +.SH "SEE ALSO" +epsffit(1), psbook(1), psnup(1), psresize(1), psselect(1), pstops(1), extractres(1), fixdlsrps(1), fixfmps(1), fixpsditps(1), fixpspps(1), fixscribeps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), includeres(1), psmerge(1), getafm(1) +.SH TRADEMARKS +.B PostScript +is a trademark of Adobe Systems Incorporated. +.SH BUGS +Kerning information is not generated by +.I getafm; +it is best to use original AFM files if possible. diff --git a/Master/texmf-dist/doc/man/man1/getafm.man1.pdf b/Master/texmf-dist/doc/man/man1/getafm.man1.pdf Binary files differnew file mode 100644 index 00000000000..b379c0f1ea5 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/getafm.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/gftodvi.1 b/Master/texmf-dist/doc/man/man1/gftodvi.1 new file mode 100644 index 00000000000..9f6366e1e1f --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/gftodvi.1 @@ -0,0 +1,160 @@ +.TH GFTODVI 1 "20 April 2007" "Web2C 2012" +.\"===================================================================== +.if n .ds MF Metafont +.if t .ds MF M\s-2ETAFONT\s0 +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff +.el .ds OX TeX for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.\"===================================================================== +.SH NAME +gftodvi \- make proof sheets from generic font files +.SH SYNOPSIS +.B gftodvi +.RB [ \-overflow-label-offset=\fIreal\fP ] +.RB [ \-verbose ] +.I gf_file_name +.\"===================================================================== +.SH DESCRIPTION +This manual page is not meant to be exhaustive. The complete +documentation for this version of \*(TX can be found in the info file +or manual +.IR "Web2C: A TeX implementation" . +.PP +The +.B gftodvi +program converts a generic font +.RI ( gf ) +file output by, for example, +.BR mf (1), +to a device independent (DVI) file (that can then be typeset using the same +software that has already been written for \*(TX). The characters in the +.I gf +file will appear one per page, with labels, titles, and annotations +as specified in Appendix H (Hardcopy Proofs) of +.IR "The \*(MFbook" . +.PP +.B gftodvi +uses other fonts in addition to the main +.I gf +file. +A `gray' font is used to typeset the +pixels that actually make up the character. (We wouldn't +want all the pixels to be simply black, since then labels, +key points, and other information would be lost.) A `title' font +is used for the information at the top of the page. A `label' font +is used for the labels on key points of the figure. A `slant' +font is used to typeset diagonal lines, which +otherwise have to be simulated using horizontal and vertical rules. +The default gray, title, and label fonts are +.IR gray , +.IR cmr8 , +and +.IR cmtt10 , +respectively; there is no default slant font. +.PP +To change the default fonts, you can give +.BR special +commands in your +\*(MF source file, or you can change the fonts online. An online dialog +ensues if you end the +.I gf_file_name +with a `/'. For example, +.br +.ti +2 +gftodvi cmr10.300gf/ +.br +.ti +2 +Special font substitution: grayfont black +.br +.ti +2 +OK; any more? grayfontarea /home/art/don/ +.br +.ti +2 +OK; any more? slantfont /home/fonts/slantimagen6 +.br +.ti +2 +OK; any more? <RET> +.br +will use +.I /home/art/don/black +as the `gray' font and +.I /home/fonts/slantimagen6 +as the `slant' font (this name indicates +a font for lines with slope 1/6 at the resolution of an Imagen printer). +.PP +The +.I gf_file_name +on the command line must be complete. Because +the resolution is part of the extension, it would not make +sense to append a default extension as is done with \*(TX or +DVI-reading software. The output file name uses the same +root as the +.I gf +file, with the +.B .dvi +extension added. For example, the input file +.I cmr10.2602gf +would become +.IR cmr10.dvi . +.\"===================================================================== +.SH OPTIONS +The argument to +.B \-overflow-label-offset +specifies the distance from the right edge of the character +bounding box at which the overflow equations (if any) are typeset. +The value is given in \*(TX points. The default is a little over two +inches. +.PP +Without the +.B \-verbose +option, +.B gftodvi +operates silently. With it, a banner and progress report are printed on +.IR stdout . +.\"===================================================================== +.SH ENVIRONMENT +.B gftodvi +looks for +.I gf_file_name +using the +environment variable GFFONTS. If that is not set, it uses the variable +TEXFONTS. If that is not set, it uses the system default. +.PP +See +.BR tex (1) +for the details of the searching. +.\"===================================================================== +.SH FILES +.TP +.I {gray.tfm,.\|.\|.} +The default fonts. +.TP +.I {gray.mf,.\|.\|.} +The \*(MF sources. +.\"===================================================================== +.SH "SEE ALSO" +.BR tex (1), +.BR mf (1). +.br +Donald E. Knuth, +.I "The \*(MFbook" +(Volume C of +.IR "Computers and Typesetting" ), +Addison-Wesley, 1986, ISBN 0-201-13445-4. +.br +Donald E. Knuth et al., +.IR \*(MFware . +.\"===================================================================== +.SH AUTHORS +Donald E. Knuth wrote the program. It was published as part of the +.I \*(MFware +technical report, available from the \*(TX Users Group. +Paul Richards ported it to Unix. diff --git a/Master/texmf-dist/doc/man/man1/gftodvi.man1.pdf b/Master/texmf-dist/doc/man/man1/gftodvi.man1.pdf Binary files differnew file mode 100644 index 00000000000..a31b530b6a1 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/gftodvi.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/gftopk.1 b/Master/texmf-dist/doc/man/man1/gftopk.1 new file mode 100644 index 00000000000..61777acfb8e --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/gftopk.1 @@ -0,0 +1,99 @@ +.TH GFTOPK 1 "14 December 1993" "Web2C 2012" +.\"===================================================================== +.if n .ds MF Metafont +.if t .ds MF M\s-2ETAFONT\s0 +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff +.el .ds OX TeX for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.\"===================================================================== +.SH NAME +gftopk \- convert generic font files to packed font files +.SH SYNOPSIS +.B gftopk +.RB [ \-v ] +.I gf_file_name +.RI [ pk_file_name ] +.\"===================================================================== +.SH DESCRIPTION +This manual page is not meant to be exhaustive. The complete +documentation for this version of \*(TX can be found in the info file +or manual +.IR "Web2C: A TeX implementation" . +.PP +The +.B gftopk +program converts a generic font file output by, for example, +.BR mf (1), +to a +packed font file for use by DVI-reading programs. Packed +font files +.RI ( pk " files)" +are much smaller than the corresponding +.I gf +files, +so they are generally the font format of choice. +.PP +The +.I gf_file_name +on the command line must be complete. Because +the resolution is part of the extension, it would not make +sense to append a default extension as is done with \*(TX or +DVI-reading software. The +.I pk_file_name +defaults to the same (stripped) name as +.IR gf_file_name , +and it is placed in the current +working directory with the +.B pk +suffix replacing +.BR gf . +For example, the input file +.I cmr10.300gf +would become +.IR cmr10.300pk . +.\"===================================================================== +.SH OPTIONS +Unless the +.B \-v +switch is given, +.B gftopk +operates silently. With +.BR \-v , +the version number of the program and statistics about the +packing are output to +.IR stdout . +.\"===================================================================== +.SH ENVIRONMENT +.B gftopk +looks for +.I gf_file_name +first in the current directory. If it is not present there, it uses the +environment variable GFFONTS. If that is not set, it uses the variable +TEXFONTS. If that is not set, it uses the system default. +.PP +See +.BR tex (1) +for the details of the searching. +.\"===================================================================== +.SH "SEE ALSO" +.BR gftype (1), +.BR pktogf (1), +.BR pktype (1). +.br +Donald E. Knuth et al., +.IR \*(MFware . +.\"===================================================================== +.SH AUTHORS +Tomas Rokicki wrote the program. It was published as +part of the +.I \*(MFware +technical report, available from the \*(TX Users Group. +Paul Richards originally ported it to Unix. diff --git a/Master/texmf-dist/doc/man/man1/gftopk.man1.pdf b/Master/texmf-dist/doc/man/man1/gftopk.man1.pdf Binary files differnew file mode 100644 index 00000000000..05294ce5a5f --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/gftopk.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/gftype.1 b/Master/texmf-dist/doc/man/man1/gftype.1 new file mode 100644 index 00000000000..383f1b1b7d6 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/gftype.1 @@ -0,0 +1,91 @@ +.TH GFTYPE 1 "14 December 1993" "Web2C 2012" +.\"===================================================================== +.if n .ds MF Metafont +.if t .ds MF M\s-2ETAFONT\s0 +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff +.el .ds OX TeX for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.\"===================================================================== +.SH NAME +gftype \- translate a generic font file for humans to read +.SH SYNOPSIS +.B gftype +.RB [ \-i ] +.RB [ \-m ] +.I gf_file_name +.RI [ output_file_name ] +.\"===================================================================== +.SH DESCRIPTION +This manual page is not meant to be exhaustive. The complete +documentation for this version of \*(TX can be found in the info file +or manual +.IR "Web2C: A TeX implementation" . +.PP +The +.B gftype +program +translates a +.I gf +(generic font) file output by, for example, +.BR mf (1), +to a file that humans can read. +It also serves as a +.I gf +file-validating +program (i.e., if +.B gftype +can read it, it's correct) and as an example of a +.IR gf -reading +program for other software that wants to read +.I gf +files. +.PP +The +.I gf_file_name +on the command line must be complete. Because +the resolution is part of the extension, it would not make +sense to append a default extension as is done with \*(TX or +DVI-reading software. If no +.I output_file_name +is specified, the output goes to +.IR stdout . +.\"===================================================================== +.SH OPTIONS +The output file includes +bitmap images of the characters, if +.B \-i +is given on the command line, and a symbolic listing of the +.I gf +commands, if +.B \-m +is specified. +.\"===================================================================== +.SH ENVIRONMENT +.B gftype +looks for +.I gf_file_name +using the +environment variable GFFONTS. If that is not set, it uses the variable +TEXFONTS. If that is not set, it uses the system default. +.\"===================================================================== +.SH "SEE ALSO" +.BR dvitype (1), +.BR pktype (1). +.br +Donald E. Knuth et al., +.IR \*(MFware . +.\"===================================================================== +.SH AUTHORS +David Fuchs and Don Knuth wrote the program. It was published as +part of the +.I \*(MFware +technical report, available from the \*(TX Users Group. +Paul Richards originally ported it to Unix. diff --git a/Master/texmf-dist/doc/man/man1/gftype.man1.pdf b/Master/texmf-dist/doc/man/man1/gftype.man1.pdf Binary files differnew file mode 100644 index 00000000000..d9628a4d951 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/gftype.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/gsftopk.1 b/Master/texmf-dist/doc/man/man1/gsftopk.1 new file mode 100644 index 00000000000..cbbafa8e609 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/gsftopk.1 @@ -0,0 +1,301 @@ +.\" Copyright (c) 1993-1998 Paul Vojta +.\" +.\" Permission is hereby granted, free of charge, to any person obtaining a copy +.\" of this software and associated documentation files (the "Software"), to +.\" deal in the Software without restriction, including without limitation the +.\" rights to use, copy, modify, merge, publish, distribute, sublicense, and/or +.\" sell copies of the Software, and to permit persons to whom the Software is +.\" furnished to do so, subject to the following conditions: +.\" +.\" The above copyright notice and this permission notice shall be included in +.\" all copies or substantial portions of the Software. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL +.\" PAUL VOJTA BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +.\" IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +.\" CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +.\" + +.\" small and boldface (not all -man's provide it) +.de SB +\&\fB\s-1\&\\$1 \\$2\s0\fR +.. +.TH GSFTOPK 1 "28 November 1998" +.SH NAME +gsftopk \- render a ghostscript font in TeX pk form +.SH SYNOPSIS +.B gsftopk +[\-i \fIpath\fP] +[\-q] +[\-t] +[\-\-debug=\fIn\fP] +[\-\-dosnames] +[\-\-interpreter=\fIpath\fP] +[\-\-mapline=\fIline\fP] +[\-\-mapfile=\fIfile\fP] +[\-\-quiet] +[\-\-test] +[\-\-help] +[\-\-version] +.I font +.I dpi +.SH ARGUMENTS +.IP \fIfont\fP \w'\fIfont\fP'u+2m +Name of the font to be created. +.IP \fIdpi\fP +Desired resolution of the font to be created, in dots per inch. This may +be a real number. +.SH DESCRIPTION +.B gsftopk +is a program which calls up the ghostscript program +.BR gs (1) +to render a given font at a given resolution. It packs the resulting +characters into the +.B pk +file format and writes them to a file whose name is formed from the font +name and the resolution (rounded to the nearest integer). The font may +be in any format acceptable to Ghostscript, including +.RI . pfa , +.RI . pfb , +.RI . gsf , +and +.RI . ttf +files. +.PP +This program should normally be called by a script, such as +.BR mktexpk , +to create fonts on demand. +.PP +.B gsftopk +obtains the character widths from the +.RI . tfm +file, which must exist in the standard search path. It also must be +able to find the font in a map file (such as +.BR psfonts.map ), +formatted as in +.BR dvips (1)), +unless the +.B \-\-mapline +option is used. The set of map files is given by the +.B \-\-mapfile +option, or in the files +.BR config.ps , +.BR $HOME/.dvipsrc , +and +.B config.gsftopk +(as would be used by +.BR "dvips -Pgsftopk" ). +.PP +The following +.B pk +"specials" are added at the end of the output file, to provide an internal +check on the contents of the file: +"\fBjobname=\fP\fIfont\fP", +"\fBmag=1\fP", +"\fBmode=modeless\fP", and +"\fBpixels_per_inch=\fP\fIdpi\fP". +This is in accordance with the TeX Directory Standard (TDS). +.SH OPTIONS +.TP +.B \-\-debug=\fIn\fP +Set the +.B Kpathsea +debug flags according to the integer +.IR n . +.TP +.B \-\-dosnames +Use a name of the form +.IB font .pk +instead of +.IB font . dpi pk\fR.\fP +.TP +.B \-h\fR,\fP \-\-help +Print a brief help synopsis and exit. +.TP +.B \-i \fIpath\fP\fR,\fP \-\-interpreter=\fIpath\fP +Use +.I path +as the Ghostscript interpreter. +.TP +.B \-\-mapfile=\fIfile\fP +Use +.I file +to look for the map information for +.IR font . +This should be the full name of the file (in other words, no path searching +algorithms are applied). +.TP +.B \-\-mapline=\fIline\fP +Use +.I line +instead of looking for an entry in a map file. +The first word of +.I line +must match +.IR font . +.TP +.B \-q\fR,\fP \-\-quiet +Operate quietly; i.e., without writing any messages to the standard output. +.TP +.B \-t\fR,\fP \-\-test +Test run: return zero status if the font can be found in the map file(s), +and nonzero status if it cannot. If this option is specified, then the +.I dpi +argument is optional (since the font will not be generated). +.TP +.B \-v\fR,\fP \-\-version +Print the version number and exit. +.SH ENVIRONMENT VARIABLES +.IP \fBDVIPSRC\fP \w'\fBGSFTOPKHEADERS\fP'u+2m +Name of file to read instead of +.BR $HOME/.dvipsrc . +This should be the full name of the file (in other words, no path searching +algorithms are applied). +.IP \fBGSFTOPKFONTS\fP +See +.SB TFMFONTS. +.IP \fBGSFTOPKHEADERS\fP +See +.SB TEXPSHEADERS. +.IP \fBPSHEADERS\fP +See +.SB TEXPSHEADERS. +.IP \fBTEXCONFIG\fP +Colon-separated list of paths to search for map files. +An extra colon in the list will include the +compiled-in default paths at that point. A double slash will enable recursive +subdirectory searching at that point in the path. +.IP \fBTFMFONTS\fP +Colon-separated list of paths to search for the +.RI . tfm +file associated with the font. Double slashes and extra colons behave as with +.SB TEXCONFIG. +This information may also be supplied by using the environment variables +.SB TFMFONTS +or +.SB GSFTOPKFONTS. +These environment variables are checked in the order +.SB GSFTOPKFONTS, +.SB TFMFONTS, +.SB TFMFONTS; +the first one (if any) having a value is used. +.IP \fBTEXPSHEADERS\fP +Colon-separated list of paths to search for the Ghostscript driver file +.B render.ps +and for any PostScript header or font files +.RI (. enc , +.RI . pfa , +.RI . pfb , +.RI . gsf , +or +.RI . ttf +files). Double slashes and extra colons behave as with +.SB TEXCONFIG. +This information may also be supplied by using the environment variables +.SB PSHEADERS +or +.SB GSFTOPKHEADERS. +These environment variables are checked in the order +.SB GSFTOPKHEADERS, +.SB TEXPSHEADERS, +.SB PSHEADERS; +the first one (if any) having a value is used. +.IP \fBTFMFONTS\fP +See +.SB TFMFONTS. +.SH CONFIGURATION +In order to determine the set of map files to be used and the path for +finding PostScript files, +.B gsftopk +reads, in order, the files +.BR config.ps , +.BR .dvipsrc , +and +.BR config.gsftopk . +The files +.B config.ps +and +.B config.gsftopk +are searched for using the environment variable +.SB TEXCONFIG, +the +.B Kpathsea +configuration file, +or the compiled-in default paths. The file +.B .dvipsrc +is searched for in the user's home directory. +.PP +These files are in the same format as for +.B dvips +(as well as being in the same locations). The entries used by +.B gsftopk +are as follows. +.TP +.RI "H " path +Indicates that the Ghostscript driver file +.B render.ps +and the PostScript header and font files are to be searched for using +.IR path . +.TP +.RI "p " file +Indicates that the list of map files is to be erased and replaced by +.IR file . +.TP +.RI "p +" file +Indicates that +.I file +is to be added to the list of map files. +.PP +All other entries are ignored. +.PP +This is similar to the handling of these options when running +.BR "dvips -Pgsftopk" . +For more details, see the +.B Kpathsea +manual. +.SH BUGS +.B gsftopk +sometimes has trouble with fonts with very complicated characters +(such as the Seal of the University of California). This is because +.B gsftopk +uses the +.B charpath +operator to determine the bounding box of each character. If the character +is too complicated, then old versions of Ghostscript fail, causing +.B gsftopk +to terminate with an error message +.IP +.B "Call to gs stopped by signal 10" +.LP +(The number may vary from system to system; it corresponds to a bus error +or a segmentation fault.) The best way to fix this bug is to install a +current version of ghostscript. As an alternative, +.B gsftopk +can be instructed to use the bounding box provided with the font (if one +exists) instead of finding a bounding box for each character. To do this, +include the string +.IP +.B /usefontbbox true def +.LP +in the font map file; +.IR e.g. , +.IP +.B ucseal """/usefontbbox true def""" +.LP +This will not affect use of the font by +.BR dvips . +.SH SEE ALSO +.BR gs (1), +.BR gftopk (1), +.BR tex (1), +.BR xdvi (1), +.BR dvips (1) +.SH AUTHOR +Written by Paul Vojta. This program was inspired by Karl Berry's +.BR gsrenderfont . +.SH MODIFICATIONS +Modified by Yves Arrouye to use Karl Berry's +.B Kpathsea +library. diff --git a/Master/texmf-dist/doc/man/man1/gsftopk.man1.pdf b/Master/texmf-dist/doc/man/man1/gsftopk.man1.pdf Binary files differnew file mode 100644 index 00000000000..51ea11f7cc0 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/gsftopk.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/hbf2gf.1 b/Master/texmf-dist/doc/man/man1/hbf2gf.1 new file mode 100644 index 00000000000..55bfddf57fa --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/hbf2gf.1 @@ -0,0 +1,718 @@ +.\" man page for hbf2gf +.\" +.\" Copyright (C) 1994-2012 Werner Lemberg <wl@gnu.org> +.\" +.\" 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 2 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 in doc/COPYING; if not, write to the Free +.\" Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, +.\" MA 02110-1301 USA +.\" +. +.TH HBF2GF 1 07-May-2012 "CJK Version 4.8.3" +.SH NAME +hbf2gf \- convert a CJK bitmap font into subfonts usable by TeX and Omega. +. +. +.SH SYNOPSIS +.na +.nh +.B hbf2gf +.RB [ \-q ] +.IR \%configuration-file [ .cfg ] +.br +.B hbf2gf +'in +\n(.ku +.RB [ \-q ] +.RB [ \-p ] +.RB [ \-g ] +.RB [ \-n ] +.I \%subfont-name \%x-resolution +.RI [ \%y-scale \ | \ \%y-resolution ] +.br +.in +.B hbf2gf +.B \-t +.RB [ \-q ] +.I \%subfont-name +.br +.B "hbf2gf \-\-version" +| +.B \-\-help +.ad +.hy +. +. +. +.\" ==== +.\" ==== macro definitions +.\" ==== +. +.\" here we define \TeX for troff and nroff +.if t .ds TX \fRT\h'-0.1667m'\v'0.20v'E\v'-0.20v'\h'-0.125m'X\fP +.if n .ds TX TeX +. +.\" and here the same for \LaTeX +.if t \{\ +.ie '\*(.T'dvi' \ +.ds LX \fRL\h'-0.36m'\v'-0.15v'\s-3A\s0\h'-0.15m'\v'0.15v'\fP\*(TX +.el .ds LX \fRL\h'-0.36m'\v'-0.22v'\s-2A\s0\h'-0.15m'\v'0.22v'\fP\*(TX +.\} +.if n .ds LX LaTeX +. +.\" \LaTeXe +.\" note that we need \vareps for TeX instead of \eps which can only be +.\" accessed with the \N escape sequence (in the Math Italic font) +.if t \{\ +.ie '\*(.T'dvi' .ds LE \*(LX\h'0.15m'2\v'0.20v'\f(MI\N'34'\fP\v'-0.20v' +.el .ds LE \*(LX\h'0.15m'2\v'0.20v'\(*e\v'-0.20v' +.\} +.if n .ds LE LaTeX\ 2e +. +.\" a definition for \Delta +.if t .ds DE \(*D +.if n .ds DE Delta_ +. +.\" a typewriter font +.if t \{\ +.de C +\fC\\$1\fP\\$2 +.. +.\} +.if n \{\ +.de C +\\$1\\$2 +.. +.\} +. +.\" an addition to .TP to allow two labels for the same item +.de TQ +.br +.ns +.TP +.. +. +.\" ==== +.\" ==== end of macro definitions +.\" ==== +. +. +. +.SH DESCRIPTION +CJK bitmap fonts can't be directly used with \*(TX +because the number of characters in such fonts exceeds\ 256, the limit of a +\*(TX +font. +Thus it is necessary to split these fonts into subfonts, and this is +exactly what +.B hbf2gf +does. +.PP +As the name says, +.B hbf2gf +uses CJK fonts in a certain format which is called +.B Hanzi Bitmap Font +.RB ( HBF ) +format. +It simply consists of the CJK bitmap file(s) and a text file in a format +very similar to the BDF format of the X\ Window System which describes the +bitmap font files: the encoding, the size, etc. +The produced +.C GF +files can then be converted with +.B gftopk +into standard +.C PK +files. +.PP +.B hbf2gf +can be called in three modes: +. +.PP +.in +2m +.B hbf2gf +.RB [ \-q ] +.IR configuration-file [ .cfg ] +.PP +.in +5m +This call normally creates a set of +.C GF +files, one +.C PL +file, and a batch file which must be executed after +.B hbf2gf +has finished. +This script will then call +.B gftopk +to convert all +.C GF +files into +.C PK +files, and it will call +.B pltotf +to convert the +.C PL +file into a +.C TFM +file. +Finally it will copy the +.C TFM +file so that each +.C PK +file has its +.C TFM +file (which are all identical). +.PP +.in +5m +If +.B ofm_file +is set to \(oqyes\(cq in the configuration file, +.C OFM +and +.C OVF +files will be created too. +. +.PP +.in +5m +.B \-q +makes +.B hbf2gf +quiet. +.PP +.in +2m +.na +.nh +.B hbf2gf +'in +\n(.ku +.RB [ \-q ] +.RB [ \-p ] +.RB [ \-g ] +.RB [ \-n ] +.I \%subfont-name \%x-resolution +.RI [ \%y-scale \ | \ \%y-resolution ] +.ad +.hy +.PP +.in +5m +This mode is intended for use with +.B \%mktexpk +and its derivates. +Only one +.C GF +file together with a +.C PL +file for the given subfont will be computed, taking the horizontal +resolution and a vertical scaling factor (if the value is smaller than\ 10) +resp. the vertical resolution (otherwise) from the command line, ignoring +the +.B nmb_fonts +parameter of the configuration file. +The last two characters (which are interpreted as the subfont number) are +stripped to get the name for the configuration file (which must end with +\(oq\c +.C \&.cfg \(cq). +No job file will be created. +If option +.B \-p +is set, no +.C PL +file is created. +If +.B \-g +is set, no +.C GF +file is created. +The extension can be controlled with +.BR \-n ; +if set, the extension is \(oq\c +.C \&.gf \(cq, +otherwise \(oq\c +.C \&. <\c +.IR resolution >\c +.C gf \(cq. +.B \-q +makes +.B hbf2gf +quiet. +. +.PP +.in +2m +.na +.nh +.B hbf2gf +'in +\n(.ku +.B \-t +.RB [ \-q ] +.I \%subfont-name +.ad +.hy +.PP +.in +5m +This mode is intended for use with scripts like +.BR \%mktexpk ; +it tests whether the specified subfont name leads to an +.B hbf2gf +configuration file. +It returns 0 on success and prints out the name of that configuration file +(provided the +.B \-q +switch isn't set). +This test isn't a thorough one; it only removes the last two characters +and checks whether a configuration file with that name exists. +.PP +See the next section for more details about configuration files. +.PP +Specifying the option +.B \-\-version +returns the current version of +.B hbf2gf +and the used file search library (e.g.\ \c +.BR kpathsea ). +Usage information is shown with the +.B \-\-help +parameter. +. +. +.SH "CONFIGURATION FILE" +Here a sample configuration file (\c +.C gsfs14.cfg ) +for a 56\(mu56 Chinese font in GB encoding; note that all information +about the font is in the +.C jfs56.hbf +file. +See the +.B "FILE SEARCHING" +section how HBF fonts and +.B hbf2gf +configuration files are found. +See the +.B AVAILABILITY +section where to get CJK fonts together with its +.C HBF +files: +.PP +.if t \fC +.nf + hbf_header jfs56.hbf + mag_x 1 + threshold 128 + comment jianti fansongti 56x56 pixel font + + design_size 14.4 + + y_offset \-13 + + nmb_files \-1 + + output_name gsfs14 + + checksum 123456789 + + dpi_x 300 + + pk_files no + tfm_files yes + + coding codingscheme GuoBiao encoded TeX text + + pk_directory $HBF_TARGET/pk/modeless/gb2312/gsfs14/ + tfm_directory $HBF_TARGET/tfm/gb2312/gsfs14/ +.fi +.if t \fP +.PP +A configuration file is a plain text file consisting of keywords and its +arguments. +A keyword must start a line, otherwise the whole line will be ignored. +If the word starting a line is not a keyword, the line will be ignored too. +Empty lines will also be skipped. +The search for keywords is case insensitive; in contrast, the arguments will +be taken exactly as given (except \(oqyes\(cq and \(oqno\(cq which can be written with +uppercase or lowercase letters). +Each keyword has one argument which must be separated by whitespace (blanks +or tabs) from the keyword and must be on the same line. +Each line must not be longer than 256 characters. +.PP +You can use environment variables in the configuration file. +The escape character starting an environment variable in the configuration +file is always \(oq\c +.C $ \(cq, +even for operating systems like DOS which has other conventions. +.B hbf2gf +recognizes only environment variable names which start with a letter or an +underscore, followed by alphanumeric characters or underscores. +You can surround the variable with braces to indicate where the variable +name ends, for example +.C ${FOO} . +To get a dollar sign you must write \(oq\c +.C $$ \(cq. +The expansion of environment variables in hbf2gf itself (without the help of +either kpathsea, emtexdir, or MiKTeX searching routines) is very limited; +this feature has been carried over from previous versions. +It can't expand variables set in texmf.cnf; it also can't handle more than +one directory as the variable's value. +.B Don't use it except for the \(oqpk_directory\(cq and \(oqtfm_directory\(cq +.B parameters! +.PP +This is the list of all necessary keywords: +.TP +.B hbf_header +The HBF header file name of the input font(s). +.B hbf2gf +uses the given searching mechanism (kpathsea, emtexdir, or MiKTeX) to locate +this file. +.TP +.B output_name +The name stem of the output files. +A running two digit decimal number starting with \(oq\c +.C 01 \(cq +will be appended. +For Unicode fonts see the keyword +.B unicode +below. +This value is in almost all cases identical to the name of the configuration +file. +.PP +And now all optional keywords: +.TP +.B x_offset +Increases the character width. +Will be applied on both sides; default for non-rotated glyphs is the value +given in the HBF header +.RB ( HBF_BITMAP_BOUNDING_BOX ) +scaled to +.B design_size +(in pixels). +.TP +.B y_offset +Shifts all characters up or down; default for non-rotated glyphs is the value +given in the HBF header +.RB ( HBF_BITMAP_BOUNDING_BOX ) +scaled to +.B design_size +(in pixels). +.TP +.B design_size +The design size (in points) of the font. +.B x_offset +and +.B y_offset +refer to this size. +Default is\ 10.0. +.TP +.B slant +The slant of the font (given as \*(DEx\ /\ \*(DEy). +Only values in the range 0\ \(<=\ \fBslant\fP\ \(<=\ 1 are allowed. +Default is\ 0.0. +.TP +.B rotation +If set to \(oqyes\(cq, all glyphs will be rotated 90\ degrees counter-clockwise. +The default offsets as given in the HBF header will be ignored (and set +to\ 0). +Default is \(oqno\(cq. +.TP +.B mag_x +.TQ +.B mag_y +Scaling values of the characters to reach design size. +If only one magnification is given, x and y values are assumed to be equal. +Default is \fBmag_x\fP\ =\ \fBmag_y\fP\ =\ 1.0. +.PP +.TP +.B threshold +A value between 1 and\ 254 defining a threshold for converting the internal +graymap into the output bitmap; lower values cut more pixels. +Default value is\ 128. +.PP +.TP +.B comment +A comment describing the font; default is none. +.PP +.TP +.B nmb_fonts +The number of subfonts to create. +Default value is \-1 for creating all fonts. +.TP +.B unicode +If \(oqyes\(cq, a two digit hexadecimal number will be used as a running number, +starting with the value of the first byte of the first code range. +Default is \(oqno\(cq. +.TP +.B min_char +The minimum value of the encoding. +You should set this value to get correct subfile offsets if it is not +identical to the lowest character code in the HBF file. +.PP +.TP +.B dpi_x +.TQ +.B dpi_y +The horizontal and vertical resolution (in dpi) of the printer. +If only one resolution is given, x and y values are assumed to be equal. +Default is\ 300. +.TP +.B checksum +A checksum to identify the +.C GF +files with the appropriate +.C TFM +files. +The default value of this unsigned 32bit integer is\ 0. +.TP +.B coding +A comment describing the coding scheme; default is none. +.PP +.TP +.B pk_directory +The destination directory of the +.C PK +files; default: none. +Attention! +The batch file will not check whether this directory exists. +.TP +.B tfm_directory +The destination directory of the +.C TFM +files; default: none. +Attention! +The batch file will not check whether this directory exists. +.TP +.B pk_files +Whether to create +.C PK +files or not; default is \(oqyes\(cq. +.TP +.B tfm_files +Whether to create +.C TFM +files or not; default is \(oqyes\(cq. +.TP +.B ofm_file +Whether to create an +.C OPL +file or not; default is \(oqno\(cq. +The batch file will then use +.B ovp2ovf +of the Omega distribution to convert it into an +.C OFM +and an +.C OVF +file. +The +.C OPL +file simply maps all subfonts back to a single Omega font. +.TP +.B long_extension +If \(oqyes\(cq, +.C PK +files will include the resolution in the extension (e.g. +.C gsso1201.300pk ). +This affects the batch file only (default is \(oqyes\(cq). +.TP +.B rm_command +The shell command to remove files; default: \(oqrm\(cq. +.TP +.B cp_command +The shell command to copy files; default: \(oqcp\(cq. +.TP +.B job_extension +The extension of the batch file which calls +.B gftopk +and +.B pltotf +to convert the +.C GF +and the +.C PL +files into +.C PK +and +.C TFM +files respectively; default is none. +. +. +.SH "FILE SEARCHING" +.B hbf2gf +uses either the +.BR kpathsea , +.BR emtexdir , +or +.B MiKTeX +library for searching files +.RB ( emtexdir +will work only on operating systems which have an MS-DOSish background, +i.e., MS-DOS, OS/2, Windows; +.B MiKTeX +is for Win32 systems). +. +.SS kpathsea +The actual version of kpathsea is displayed on screen if you call +.B hbf2gf +.BR \-\-version . +.PP +Here is a table of the file type and the corresponding +.B kpathsea +variables. +.PP +.in +4m +.ta 2i +.br +.C "\&.hbf MISCFONTS" +.br +.C "\&.cfg HBF2GFINPUTS" +.PP +Please consult the info files of +.B kpathsea +for details on these variables. +The decision which naming scheme to use for variables will be done during +compilation. +.PP +You should set the +.C TEXMFCNF +variable to the directory where your +.C texmf.cnf +configuration file resides. +.PP +Here is the proper command to find out to which value a +.B kpathsea +variable is set (we use +.C MISCFONTS +as an example). +This is especially useful if a variable isn't set in +.C texmf.cnf +or in the environment, thus pointing to the default value which is +hard-coded into the +.B kpathsea +library. +.PP +.in +2m +.C "kpsewhich \-progname=hbf2gf \-expand\-var='$MISCFONTS'" +.PP +We select the program name also since it is possible to specify +variables which are searched only for a certain program \(en in our +example it would be +.C MISCFONTS.hbf2gf . +.PP +A similar but not identical method is to say +.PP +.in +2m +.C "kpsewhich \-progname=hbf2gf \-show\-path='misc fonts'" +.PP +[A full list of format types can be obtained by saying \(oq\c +.C "kpsewhich \-\-help" \(cq +on the command line prompt.] +This is exactly how +.B hbf2gf +searches for files; the disadvantage is that all variables are expanded +which can cause very long strings. +. +.SS emtexdir +.PP +Here the list of suffixes and its related environment variables to be set in +.C autoexec.bat +(resp. in +.C config.sys +for OS/2): +.PP +.in +4m +.ta 2i +.br +.C "\&.hbf HBFONTS" +.br +.C "\&.cfg HBFCFG" +.PP +If one of the variables isn't set, a warning message is emitted. +The current directory will always be searched. +As usual, one exclamation mark appended to a directory path causes +subdirectories one level deep to be searched, two exclamation marks causes +all subdirectories to be searched. +Example: +.PP +.in +2m +.C HBFONTS=c:\\\\fonts\\\\hbf!!;d:\\\\myfonts\\\\hbf! +.PP +Constructions like \(oq\c +.C c:\\\\fonts!!\\\\hbf \(cq +aren't possible. +. +.SS MikTeX +.PP +Please consult the documentation files of +.B MiKTeX +for more details. +. +. +.SH LIMITATIONS +The x and y output size must not exceed +.BR MAX_CHAR_SIZE , +which is defined at compile time; its default value is 1023\ (pixel). +. +. +.SH "SEE ALSO" +.BR ttf2pk (1) +.PP +.C hbf2gf.w : +'in +\n(.ku +this is the source code written in +.B CWEB +which can be converted into a pretty-printed \*(TX +document using +.BR cweave . +The CJK package also contains a preformatted +.C hbf2gf.pdf +file. +.PP +the +.B CJK +documentation files (\c +.C hbf2gf.txt ). +.PP +the +.B Hanzi Bitmap File +.RB ( HBF ) +standard version\ 1.3; available at +.C \%ftp.ifcss.org . +.PP +the Omega documentation available at +.C ftp.ens.fr +and the CTAN hosts and mirrors. +. +. +.SH FILES +.TP +.C *.cfg +The +.B hbf2gf +configuration scripts. +.TP +.C *.hbf +HBF header files which describe fixed-width bitmap fonts. +Note that the bitmap font name(s) themselves as specified in the header files +are irrelevant for +.BR hbf2gf . +. +. +.SH AVAILABILITY +.B hbf2gf +is part of the CJK macro package for \*(LE +available at the CTAN hosts and its mirrors. +.PP +CJK fonts together with HBF header files can be found at +.C ftp.ifcss.org +and its mirrors. +. +. +.SH AUTHORS +Werner Lemberg +.C <wl@gnu.org> +.br +Ross Paterson (the HBF API) +.C <ross@soi.city.ac.uk> diff --git a/Master/texmf-dist/doc/man/man1/hbf2gf.man1.pdf b/Master/texmf-dist/doc/man/man1/hbf2gf.man1.pdf Binary files differnew file mode 100644 index 00000000000..f5fca2e9233 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/hbf2gf.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/includeres.1 b/Master/texmf-dist/doc/man/man1/includeres.1 new file mode 100644 index 00000000000..e157716df36 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/includeres.1 @@ -0,0 +1,40 @@ +.TH INCLUDERES 1 "PSUtils Release 1 Patchlevel 17" +.SH NAME +includeres \- filter to include resources in a PostScript document +.SH SYNOPSIS +.B includeres +< +.I document.ps +> +.I output.ps +.SH DESCRIPTION +.I Includeres +includes resources (fonts, procsets, patterns, files, etc) in place of +.I %%IncludeResource +comments in a PostScript document. The resources are searched for in the +current directory and the system default directory under the resource name, +and with an appropriate extension. +The pipeline +.sp +.ce +extractres file.ps | includeres >out.ps +.sp +will move all resources appearing in a document to the document prologue, +removing redundant copies. The output file can then be put through page +re-arrangement filters such as +.I psnup +or +.I pstops +safely. +.SH AUTHOR +Copyright (C) Angus J. C. Duggan 1991-1995 +.SH "SEE ALSO" +epsffit(1), psbook(1), psnup(1), psresize(1), psselect(1), pstops(1), extractres(1), fixdlsrps(1), fixfmps(1), fixpsditps(1), fixpspps(1), fixscribeps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), includeres(1), psmerge(1), getafm(1) +.SH TRADEMARKS +.B PostScript +is a trademark of Adobe Systems Incorporated. +.SH BUGS +.I includeres +does not alter the +.I %%DocumentNeededResources +comments. diff --git a/Master/texmf-dist/doc/man/man1/includeres.man1.pdf b/Master/texmf-dist/doc/man/man1/includeres.man1.pdf Binary files differnew file mode 100644 index 00000000000..a3a2d561da5 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/includeres.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/install-tl.1 b/Master/texmf-dist/doc/man/man1/install-tl.1 new file mode 100644 index 00000000000..44cd5a8e78c --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/install-tl.1 @@ -0,0 +1,434 @@ +.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "INSTALL-TL 1" +.TH INSTALL-TL 1 "2012-10-31" "perl v5.16.2" "User Contributed Perl Documentation" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +install\-tl \- TeX Live cross\-platform installer +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +install-tl [\fIoption\fR]... +.PP +install\-tl.bat [\fIoption\fR]... +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +This installer creates a runnable TeX Live installation from various +media, including over the network. The installer works across all +platforms supported by TeX Live. For information on initially +downloading the TeX Live, see <http://tug.org/texlive/acquire.html>. +.PP +The basic idea of TeX Live installation is to choose one of the +top-level \fIschemes\fR, each of which is defined as a different set of +\&\fIcollections\fR and \fIpackages\fR, where a collection is a set of packages, +and a package is what contains actual files. +.PP +Within the installer, you can choose a scheme, and further customize the +set of collections to install, but not the set of the packages. To do +that, use \f(CW\*(C`tlmgr\*(C'\fR (reference below) after the initial installation is +completely. +.PP +The default is \f(CW\*(C`scheme\-full\*(C'\fR, to install everything, and this is highly +recommended. +.SH "REFERENCES" +.IX Header "REFERENCES" +Post-installation configuration, package updates, and much more, are +handled through \fBtlmgr\fR(1), the TeX Live Manager +(<http://tug.org/texlive/tlmgr.html>). +.PP +The most up-to-date version of this documentation is on the Internet at +http://tug.org/texlive/doc/install\-tl.html <http://tug.org/texlive/doc/install-tl.html>. +.PP +For the full documentation of TeX Live, see +<http://tug.org/texlive/doc>. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-gui\fR [[=]\fImodule\fR]" 4 +.IX Item "-gui [[=]module]" +If no \fImodule\fR is given starts the \f(CW\*(C`perltk\*(C'\fR (see below) \s-1GUI\s0 installer. +.Sp +If \fImodule\fR is given loads the given installer module. Currently the +following modules are supported: +.RS 4 +.ie n .IP """text""" 8 +.el .IP "\f(CWtext\fR" 8 +.IX Item "text" +The text mode user interface (default on Unix systems). Same as the +\&\f(CW\*(C`\-no\-gui\*(C'\fR option. +.ie n .IP """wizard""" 8 +.el .IP "\f(CWwizard\fR" 8 +.IX Item "wizard" +The wizard mode user interface (default on Windows), asking only minimal +questions before installing all of TeX Live. +.ie n .IP """perltk""" 8 +.el .IP "\f(CWperltk\fR" 8 +.IX Item "perltk" +The expert \s-1GUI\s0 installer, providing access to more options. +Can also be invoked on Windows by running \f(CW\*(C`install\-tl\-advanced.bat\*(C'\fR. +.RE +.RS 4 +.Sp +The \f(CW\*(C`perltk\*(C'\fR and \f(CW\*(C`wizard\*(C'\fR modules, and thus also when calling with a +bare \f(CW\*(C`\-gui\*(C'\fR (without \fImodule\fR), requires the Perl/Tk module +(<http://tug.org/texlive/distro.html#perltk>); if Perl/Tk is not +available, installation continues in text mode. +.RE +.IP "\fB\-no\-gui\fR" 4 +.IX Item "-no-gui" +Use the text mode installer (default except on Windows). +.IP "\fB\-lang\fR \fIllcode\fR" 4 +.IX Item "-lang llcode" +By default, the \s-1GUI\s0 tries to deduce your language from the environment +(on Windows via the registry, on Unix via \f(CW\*(C`LC_MESSAGES\*(C'\fR). If that fails +you can select a different language by giving this option with a +language code (based on \s-1ISO\s0 639\-1). Currently supported (but not +necessarily completely translated) are: English (en, default), Czech +(cs), German (de), French (fr), Italian (it), Japanese (ja), Dutch (nl), +Polish (pl), Brazilian Portuguese (pt_BR), Russian (ru), Slovak (sk), +Slovenian (sl), Serbian (sr), Vietnamese (vi), simplified Chinese +(zh_CN), and traditional Chinese (zh_TW). +.IP "\fB\-repository\fR \fIurl|path\fR" 4 +.IX Item "-repository url|path" +Specify the package repository to be used as the source of the +installation, either a local directory via \f(CW\*(C`/path/to/directory\*(C'\fR or a +\&\f(CW\*(C`file:/\*(C'\fR url, or a network location via a \f(CW\*(C`http://\*(C'\fR or \f(CW\*(C`ftp://\*(C'\fR url. +(No other protocols are supported.) +.Sp +The default is to pick a mirror automatically, using +<http://mirror.ctan.org/systems/texlive/tlnet>; the chosen mirror is +used for the entire download. You can use the special argument \f(CW\*(C`ctan\*(C'\fR +as an abbreviation for this. See <http://ctan.org> for more about \s-1CTAN\s0 +and its mirrors. +.Sp +If the repository is on the network, trailing \f(CW\*(C`/\*(C'\fR characters and/or +trailing \f(CW\*(C`/tlpkg\*(C'\fR and \f(CW\*(C`/archive\*(C'\fR components are ignored. For example, +you could choose a particular \s-1CTAN\s0 mirror with something like this: +.Sp +.Vb 1 +\& \-repository http://ctan.example.org/its/ctan/dir/systems/texlive/tlnet +.Ve +.Sp +Of course a real hostname and its particular top-level \s-1CTAN\s0 path +have to be specified. The list of \s-1CTAN\s0 mirrors is available at +<http://ctan.org/mirrors>. +.Sp +If the repository is local, the installation type (compressed or live) is +automatically determined, by checking for the presence of a +\&\f(CW\*(C`archive\*(C'\fR directory relative to the root. Compressed is +preferred if both are available, since it is faster. Here's an example +of using a local directory: +.Sp +.Vb 1 +\& \-repository /local/TL/repository +.Ve +.Sp +After installation is complete, you can use that installation as the +repository for another installation. If you chose to install less than +the full scheme containing all packages, the list of available schemes +will be adjusted accordingly. +.Sp +For backward compatibility and convenience, \f(CW\*(C`\-\-location\*(C'\fR and \f(CW\*(C`\-\-repo\*(C'\fR +are accepted as aliases for this option. +.IP "\fB\-select\-repository\fR" 4 +.IX Item "-select-repository" +This option allows manual selection of a mirror from the current list of +active \s-1CTAN\s0 mirrors. This option is supported in all installer modes +(text, wizard, perltk), and will also offer to install from local media +if available, or from a repository specified on the command line (see +above). It's useful when the (default) automatic redirection does not +choose a good host for you. +.IP "\fB\-all\-options\fR" 4 +.IX Item "-all-options" +Normally options not regarding the current platform are not shown. +Giving this cmd line option allows to configure settings in the +final tlpdb that do not have any immediate effect. +.IP "\fB\-custom\-bin\fR \fIpath\fR" 4 +.IX Item "-custom-bin path" +If you have built your own binaries for your system (probably because +your platform was not supported by TeX Live out of the box), this option +allows you to give the \fIpath\fR to a directory where the binaries for the +current system are present. The installation will continue as usual, but +at the end all files from \fIpath\fR are copied over to \f(CW\*(C`bin/custom\*(C'\fR in +your installation folder and this directory will be added to the path +for the post-install actions. +.IP "\fB\-debug\-translation\fR" 4 +.IX Item "-debug-translation" +In \s-1GUI\s0 mode, this switch makes \f(CW\*(C`tlmgr\*(C'\fR report any missing, or more +likely untranslated, messages to standard error. Helpful for +translators to see what remains to be done. +.IP "\fB\-\-help\fR, \fB\-help\fR, \fB\-?\fR" 4 +.IX Item "--help, -help, -?" +Display this help and exit. +.IP "\fB\-logfile\fR \fIfile\fR" 4 +.IX Item "-logfile file" +Write both all messages (informational, debugging, warnings) to \fIfile\fR, +in addition to standard output or standard error. +.Sp +If this option is not given, the installer will create a log file +in the root of the writable installation tree, +for example, \f(CW\*(C`/usr/local/texlive/YYYY/install\-tl.log\*(C'\fR for the \fI\s-1YYYY\s0\fR +release. +.IP "\fB\-force\-platform\fR \fIplatform\fR" 4 +.IX Item "-force-platform platform" +Instead of auto-detecting the current platform, use \fIplatform\fR. +Binaries for this platform must be present and they must actually be +runnable, or installation will fail. \f(CW\*(C`\-force\-arch\*(C'\fR is a synonym. +.IP "\fB\-no\-cls\fR" 4 +.IX Item "-no-cls" +(only for text mode installer) do not clear the screen when entering +a new menu (for debugging purposes). +.IP "\fB\-non\-admin\fR" 4 +.IX Item "-non-admin" +For Windows only: configure for the current user, not for all users. +.IP "\fB\-\-persistent\-downloads\fR" 4 +.IX Item "--persistent-downloads" +.PD 0 +.IP "\fB\-\-no\-persistent\-downloads\fR" 4 +.IX Item "--no-persistent-downloads" +.PD +For net installs, activating this option makes the installer try to set up a +persistent connection using the Net::LWP Perl module. +This opens only one connection between your computer and the server +per session and reuses it, instead of initiating a new download for +each package. +.Sp +This option is turned on by default, and the installation program will +fall back to using \f(CW\*(C`wget\*(C'\fR if this is not possible. To disable usage of +\&\s-1LWP\s0 and persistent connections, use \f(CW\*(C`\-\-no\-persistent\-downloads\*(C'\fR. +.IP "\fB\-portable\fR" 4 +.IX Item "-portable" +Install for portable use on e.g. a \s-1USB\s0 stick. Also selectable from +within the perltk\- and text installers. +.IP "\fB\-in\-place\fR" 4 +.IX Item "-in-place" +This is a quick-and-dirty installation option in case you already +have an rsync\- or svn checkout of TeX Live. It will use the checkout +as-is and will just do the necessary post-install. Be warned that +the file tlpkg/texlive.tlpdb may be rewritten, that removal has +to be done manually, and that the only realistic way to maintain +this installation is to redo it from time to time. This option is +not available via the installer interface. \s-1USE\s0 \s-1AT\s0 \s-1YOUR\s0 \s-1OWN\s0 \s-1RISK\s0. +.IP "\fB\-print\-platform\fR" 4 +.IX Item "-print-platform" +Print the TeX Live identifier for the detected platform +(hardware/operating system) combination to standard output, and exit. +\&\f(CW\*(C`\-print\-arch\*(C'\fR is a synonym. +.IP "\fB\-profile\fR \fIprofile\fR" 4 +.IX Item "-profile profile" +Load the file \fIprofile\fR and do the installation with no user +interaction, that is, a batch (unattended) install. +.Sp +A \fIprofile\fR file contains all the values needed to perform an +installation. After a normal installation has finished, a profile for +that exact installation is written to the file +DEST/tlpkg/texlive.profile. That file can be given as the argument to +\&\f(CW\*(C`\-profile\*(C'\fR to redo the exact same installation on a different system, +for example. Alternatively, you can use a custom profile, most easily +created by starting from a generated one and changing values, or an +empty file, which will take all the defaults. +.Sp +Normally a profile has to specify the value \f(CW1\fR for each collection to +be installed, even if the scheme is specified. This follows from the +logic of the installer in that you can first select a scheme and then +change the collections being installed. But there is one exception to +this, for convenience: If the profile contains a variable for +\&\f(CW\*(C`selected_scheme\*(C'\fR and \fIno\fR collection variables are defined in the +profile at all, then the collections which the specified scheme requires +are installed. +.Sp +Thus, a line \f(CW\*(C`selected_scheme scheme\-medium\*(C'\fR together with the +definitions of the installation directories (\f(CW\*(C`TEXDIR\*(C'\fR, \f(CW\*(C`TEXMFHOME\*(C'\fR, +\&\f(CW\*(C`TEXMFLOCAL\*(C'\fR, \f(CW\*(C`TEXMFSYSCONFIG\*(C'\fR, \f(CW\*(C`TEXMFSYSVAR\*(C'\fR) suffices to install +the medium scheme with all default options. +.IP "\fB\-q\fR" 4 +.IX Item "-q" +Omit normal informational messages. +.IP "\fB\-scheme\fR \fIscheme\fR" 4 +.IX Item "-scheme scheme" +Schemes are the highest level of package grouping in TeX Live; the +default is to use the \f(CW\*(C`full\*(C'\fR scheme, which includes everything. This +option overrides that default. You can change the scheme again before +the actual installation with the usual menu. The \fIscheme\fR argument may +optionally have a prefix \f(CW\*(C`scheme\-\*(C'\fR. The list of supported scheme names +depends on what your package repository provides; see the interactive +menu list. +.IP "\fB\-v\fR" 4 +.IX Item "-v" +Include debugging messages; repeat for maximum debugging, as in \f(CW\*(C`\-v +\&\-v\*(C'\fR. (Further repeats are accepted but ignored.) +.IP "\fB\-\-version\fR, \fB\-version\fR" 4 +.IX Item "--version, -version" +Output version information and exit. +If \f(CW\*(C`\-v\*(C'\fR has been given the revisions of the used modules are reported, too. +.PP +As usual, all options can be specified with either \f(CW\*(C`\-\*(C'\fR or \f(CW\*(C`\-\-\*(C'\fR, and +arguments can be separated from their options by either a space or \f(CW\*(C`=\*(C'\fR. +.SH "ENVIRONMENT VARIABLES" +.IX Header "ENVIRONMENT VARIABLES" +For ease in scripting and debugging, \f(CW\*(C`install\-tl\*(C'\fR will look for the +following environment variables. They are not of interest in normal +user installations. +.ie n .IP """TEXLIVE_INSTALL_ENV_NOCHECK""" 4 +.el .IP "\f(CWTEXLIVE_INSTALL_ENV_NOCHECK\fR" 4 +.IX Item "TEXLIVE_INSTALL_ENV_NOCHECK" +Omit the check for environment variables containing the string \f(CW\*(C`tex\*(C'\fR. +People developing TeX-related software are likely to have many such +variables. +.ie n .IP """TEXLIVE_INSTALL_NO_CONTEXT_CACHE""" 4 +.el .IP "\f(CWTEXLIVE_INSTALL_NO_CONTEXT_CACHE\fR" 4 +.IX Item "TEXLIVE_INSTALL_NO_CONTEXT_CACHE" +Omit creating the ConTeXt cache. This is useful for redistributors. +.ie n .IP """TEXLIVE_INSTALL_PREFIX""" 4 +.el .IP "\f(CWTEXLIVE_INSTALL_PREFIX\fR" 4 +.IX Item "TEXLIVE_INSTALL_PREFIX" +.PD 0 +.ie n .IP """TEXLIVE_INSTALL_TEXMFCONFIG""" 4 +.el .IP "\f(CWTEXLIVE_INSTALL_TEXMFCONFIG\fR" 4 +.IX Item "TEXLIVE_INSTALL_TEXMFCONFIG" +.ie n .IP """TEXLIVE_INSTALL_TEXMFHOME""" 4 +.el .IP "\f(CWTEXLIVE_INSTALL_TEXMFHOME\fR" 4 +.IX Item "TEXLIVE_INSTALL_TEXMFHOME" +.ie n .IP """TEXLIVE_INSTALL_TEXMFLOCAL""" 4 +.el .IP "\f(CWTEXLIVE_INSTALL_TEXMFLOCAL\fR" 4 +.IX Item "TEXLIVE_INSTALL_TEXMFLOCAL" +.ie n .IP """TEXLIVE_INSTALL_TEXMFSYSCONFIG""" 4 +.el .IP "\f(CWTEXLIVE_INSTALL_TEXMFSYSCONFIG\fR" 4 +.IX Item "TEXLIVE_INSTALL_TEXMFSYSCONFIG" +.ie n .IP """TEXLIVE_INSTALL_TEXMFSYSVAR""" 4 +.el .IP "\f(CWTEXLIVE_INSTALL_TEXMFSYSVAR\fR" 4 +.IX Item "TEXLIVE_INSTALL_TEXMFSYSVAR" +.ie n .IP """TEXLIVE_INSTALL_TEXMFVAR""" 4 +.el .IP "\f(CWTEXLIVE_INSTALL_TEXMFVAR\fR" 4 +.IX Item "TEXLIVE_INSTALL_TEXMFVAR" +.PD +Specify the respective directories. +.SH "AUTHORS AND COPYRIGHT" +.IX Header "AUTHORS AND COPYRIGHT" +This script and its documentation were written for the TeX Live +distribution (<http://tug.org/texlive>) and both are licensed under the +\&\s-1GNU\s0 General Public License Version 2 or later. diff --git a/Master/texmf-dist/doc/man/man1/install-tl.man1.pdf b/Master/texmf-dist/doc/man/man1/install-tl.man1.pdf Binary files differnew file mode 100644 index 00000000000..e5f608d5bae --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/install-tl.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/kpseaccess.1 b/Master/texmf-dist/doc/man/man1/kpseaccess.1 new file mode 100644 index 00000000000..35edd2312c2 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/kpseaccess.1 @@ -0,0 +1,66 @@ +.TH KPSEACCESS 1 "1 March 2011" "Kpathsea 6.1.0" +.\"===================================================================== +.if n .ds MP MetaPost +.if t .ds MP MetaPost +.if n .ds MF Metafont +.if t .ds MF M\s-2ETAFONT\s0 +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff +.el .ds OX TeX for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.\"===================================================================== +.SH NAME +kpseaccess \- determine whether a file can be accessed +.SH SYNOPSIS +.B kpseaccess +.I mode +.I file +.\"===================================================================== +.SH DESCRIPTION +Exit successfully if +.I file +can be accessed with the specified +.IR mode . +The +.I mode +is an optional dash +.RB (` \- ') +followed by zero or more letters of +.BR rwx , +where +.B r +is for readable, +.B w +is for writable, and +.B x +is for executable. +.PP +The difference between +.B kpseaccess +and +.B test +is that the latter looks at the permission bits, while the former +checks using the +.BR access (2) +system call. This makes a difference when file systems have been +mounted read-only. +.\"===================================================================== +.SH OPTIONS +.B kpseaccess +accepts the following options: +.TP +.B --help +Print help message and exit. +.TP +.B --version +Print version information and exit. +.\"===================================================================== +.SH "SEE ALSO" +.BR access (2) diff --git a/Master/texmf-dist/doc/man/man1/kpseaccess.man1.pdf b/Master/texmf-dist/doc/man/man1/kpseaccess.man1.pdf Binary files differnew file mode 100644 index 00000000000..1ba039a338e --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/kpseaccess.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/kpsepath.1 b/Master/texmf-dist/doc/man/man1/kpsepath.1 new file mode 100644 index 00000000000..8fb7435c2aa --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/kpsepath.1 @@ -0,0 +1 @@ +.so man1/kpsetool.1 diff --git a/Master/texmf-dist/doc/man/man1/kpsepath.man1.pdf b/Master/texmf-dist/doc/man/man1/kpsepath.man1.pdf Binary files differnew file mode 100644 index 00000000000..1ad20ed01a4 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/kpsepath.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/kpsereadlink.1 b/Master/texmf-dist/doc/man/man1/kpsereadlink.1 new file mode 100644 index 00000000000..f94c62ce161 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/kpsereadlink.1 @@ -0,0 +1,30 @@ +.TH KPSEREADLINK 1 "1 March 2011" "Kpathsea 6.1.0" +.\"===================================================================== +.SH NAME +kpsereadlink \- print contents of symbolic link +.SH SYNOPSIS +.B kpsereadlink +.I file +.\"===================================================================== +.SH DESCRIPTION +If +.I file +is a symbolic link, print its contents (what it links to), and exit +successfully. Exit with a failure otherwise. +.PP +On systems that do not support symbolic links, +.B kpsereadlink +will always fail. +.\"===================================================================== +.SH OPTIONS +.B kpsereadlink +accepts the following options: +.TP +.B --help +Print help message and exit. +.TP +.B --version +Print version information and exit. +.\"===================================================================== +.SH "SEE ALSO" +.BR readlink (2) diff --git a/Master/texmf-dist/doc/man/man1/kpsereadlink.man1.pdf b/Master/texmf-dist/doc/man/man1/kpsereadlink.man1.pdf new file mode 100644 index 00000000000..df406db62af --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/kpsereadlink.man1.pdf @@ -0,0 +1,116 @@ +%PDF-1.4 +%Çì¢ +5 0 obj +<</Length 6 0 R/Filter /FlateDecode>> +stream +xœ¥UËrÚ@¼ë+æ©Êlö¡ÕjssbĈÑ%9(BÅBÂ’ âȯä 3« cç’â@ÕnOO÷L³<% ¨ùtßÑÖz¯`]YÖ֣ŚKè¾¢-| àãÑ‚ÄjË(ÊåÄ…`kqå®<ö–}=›ïÇ—W7“»ë¥Í–œ8ÁkD ÇÚÉ50n˜ÜXöÝ¥óÅàS„úJc»`eÙ·cS7ÐÂ9‚È â m<쪸ŒÃU–æðveš×y çuEÕóö{‘¥DKÚk M\¦5rjB…ö›Öó¯wÓÙ|2?`{Gt§`ÑvwPºÖ’Ù ç[ð+=–z’¸>¹ßYüB£.Ñ”µB\ÊØÕxþé~2 &Ó»³aœi±'I :m‹—Èæ½l{º`E¸pý‡L›©.ì´‚p8º‹n¶)Žõ0ߥ½ß„æ¬TPKçÂ|±ÃÐ’§¥ý o«§(Š«*yʲçf< F@d tÂ=·“Hšµ·yÄçýÄ Ç>7vqbÌ`F—Dxâd Ix`ð±‡OeçIKš=•1õ&.÷i“†Ç
R0ÍÑ~UÇ[4e,® +È cd·+Êz8šêâ,+œ"«×Íõß99Ù†'P +n¿5½O³ Âlà˜+"“=âh–qâIuhø\Aâ /å¾²Ã4#]³cô%#.UÃÄM›°ýwòßr´°CŒÁ®6#!)²¬p¸Ä™ fó5»:-òêÃQlÏ3ê‰K6q¶{óÇÑ55¹5HØbÃu|’P_{&]ä•–¯½ ìù³¬® —ê=wýʼZ?›žšù])¤yR”ÛÐØ>¥ÜšÚ)ŸøFÇ`góñ.oæÓ>&Z Ú· ‹2>GÉ=Ù¿Ý ÏÞ^?F¥:ÐÒæÝ»ŽŠþ1ÀÈ•yšÛë]Xoª80B
Œ%ü&½Tî÷ùf·ÇôbŽÜXFà”±¦Øe„kÖט£q`}ÁÏ_4Aµ endstream +endobj +6 0 obj +774 +endobj +4 0 obj +<</Type/Page/MediaBox [0 0 612 792] +/Rotate 0/Parent 3 0 R +/Resources<</ProcSet[/PDF /Text] +/ExtGState 11 0 R +/Font 12 0 R +>> +/Contents 5 0 R +>> +endobj +3 0 obj +<< /Type /Pages /Kids [ +4 0 R +] /Count 1 +>> +endobj +1 0 obj +<</Type /Catalog /Pages 3 0 R +/Metadata 15 0 R +>> +endobj +7 0 obj +<</Type/ExtGState +/OPM 1>>endobj +11 0 obj +<</R7 +7 0 R>> +endobj +12 0 obj +<</R10 +10 0 R/R9 +9 0 R/R8 +8 0 R>> +endobj +10 0 obj +<</BaseFont/Times-Italic/Type/Font +/Encoding 13 0 R/Subtype/Type1>> +endobj +13 0 obj +<</Type/Encoding/Differences[ +140/fi]>> +endobj +9 0 obj +<</BaseFont/Times-Bold/Type/Font +/Subtype/Type1>> +endobj +8 0 obj +<</BaseFont/Times-Roman/Type/Font +/Encoding 14 0 R/Subtype/Type1>> +endobj +14 0 obj +<</Type/Encoding/Differences[ +173/minus]>> +endobj +15 0 obj +<</Type/Metadata +/Subtype/XML/Length 1344>>stream +<?xpacket begin='' id='W5M0MpCehiHzreSzNTczkc9d'?> +<?adobe-xap-filters esc="CRLF"?> +<x:xmpmeta xmlns:x='adobe:ns:meta/' x:xmptk='XMP toolkit 2.9.1-13, framework 1.6'> +<rdf:RDF xmlns:rdf='http://www.w3.org/1999/02/22-rdf-syntax-ns#' xmlns:iX='http://ns.adobe.com/iX/1.0/'> +<rdf:Description rdf:about='uuid:b66edcf7-e107-11ec-0000-9e06288d7e57' xmlns:pdf='http://ns.adobe.com/pdf/1.3/' pdf:Producer='GPL Ghostscript 9.05'/> +<rdf:Description rdf:about='uuid:b66edcf7-e107-11ec-0000-9e06288d7e57' xmlns:xmp='http://ns.adobe.com/xap/1.0/'><xmp:ModifyDate>2012-05-28T19:32:57+02:00</xmp:ModifyDate> +<xmp:CreateDate>2012-05-28T19:32:57+02:00</xmp:CreateDate> +<xmp:CreatorTool>groff version 1.21</xmp:CreatorTool></rdf:Description> +<rdf:Description rdf:about='uuid:b66edcf7-e107-11ec-0000-9e06288d7e57' xmlns:xapMM='http://ns.adobe.com/xap/1.0/mm/' xapMM:DocumentID='uuid:b66edcf7-e107-11ec-0000-9e06288d7e57'/> +<rdf:Description rdf:about='uuid:b66edcf7-e107-11ec-0000-9e06288d7e57' xmlns:dc='http://purl.org/dc/elements/1.1/' dc:format='application/pdf'><dc:title><rdf:Alt><rdf:li xml:lang='x-default'>Untitled</rdf:li></rdf:Alt></dc:title></rdf:Description> +</rdf:RDF> +</x:xmpmeta> + + +<?xpacket end='w'?> +endstream +endobj +2 0 obj +<</Producer(GPL Ghostscript 9.05) +/CreationDate(D:20120528193257+02'00') +/ModDate(D:20120528193257+02'00') +/Creator(groff version 1.21)>>endobj +xref +0 16 +0000000000 65535 f +0000001097 00000 n +0000003050 00000 n +0000001038 00000 n +0000000878 00000 n +0000000015 00000 n +0000000859 00000 n +0000001162 00000 n +0000001488 00000 n +0000001423 00000 n +0000001283 00000 n +0000001203 00000 n +0000001233 00000 n +0000001367 00000 n +0000001570 00000 n +0000001629 00000 n +trailer +<< /Size 16 /Root 1 0 R /Info 2 0 R +/ID [<CF80ABD85349F450E0D95E463B413486><CF80ABD85349F450E0D95E463B413486>] +>> +startxref +3202 +%%EOF diff --git a/Master/texmf-dist/doc/man/man1/kpsestat.1 b/Master/texmf-dist/doc/man/man1/kpsestat.1 new file mode 100644 index 00000000000..eb134a6c2f3 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/kpsestat.1 @@ -0,0 +1,51 @@ +.TH KPSESTAT 1 "1 March 2011" "Kpathsea 6.1.0" +.\"===================================================================== +.if n .ds MP MetaPost +.if t .ds MP MetaPost +.if n .ds MF Metafont +.if t .ds MF M\s-2ETAFONT\s0 +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff +.el .ds OX TeX for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.\"===================================================================== +.SH NAME +kpsestat \- compute octal mode from mode of existing file +.SH SYNOPSIS +.B kpsestat +.I mode +.I file +.\"===================================================================== +.SH DESCRIPTION +.B kpsestat +prints the octal permission of +.I file +modified according to +.I mode +on standard output. The +.I mode +parameter accepts a subset of the symbolic permissions accepted by +.BR chmod (1). +Use +.B = +as the mode to obtain the unchanged permissions. +.\"===================================================================== +.SH OPTIONS +.B kpsestat +accepts the following options: +.TP +.B --help +Print help message and exit. +.TP +.B --version +Print version information and exit. +.\"===================================================================== +.SH "SEE ALSO" +.BR chmod (1). diff --git a/Master/texmf-dist/doc/man/man1/kpsestat.man1.pdf b/Master/texmf-dist/doc/man/man1/kpsestat.man1.pdf new file mode 100644 index 00000000000..ea50836943f --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/kpsestat.man1.pdf @@ -0,0 +1,117 @@ +%PDF-1.4 +%Çì¢ +5 0 obj +<</Length 6 0 R/Filter /FlateDecode>> +stream +xœ•UËvÓ@ Ýû+´tæeÏ ç°(Ey´¥1 NËÂu&‰!ŽíRø~…D3¶ó¨Ã¡œ,œc]IWÒ•ü
(a@ݯfEðìZÁª (¬‚oóFè Y/h|ALÉ2èÜ(Jr"!)‚ðíÕ|6O&É—`ÊgÌ¡I$DŒàd„gÞJ "4ãAˆˆÊ!yÂÛÝNàt,CŒdÿˆÕðž”péìÏ®
yOe.L‘“_œí£(Bµ2}”÷3g8*šs"‡)¦óÎÔñ½ ¿VmÚ´…ß•EußZ(³6Ý@Q.,,ë²èþ•K°&‰Q1äM›oWðkc'Ÿ“7‡…!’ƒy ¡ÂhOgþéâòj~>ïH™=©=ºgµãÓAÝc%#Ré¾BN¸Ö¾ãž#2ÄîxhJ´Aˆç!Ýt0øëÙüÕõùUr~yñßTô1múQR"yì™Tu¾mh×C +[yÓäåÛ7.ˆ I ¿+áP¨1Q’é}¢h(9ÿefYY/Ü ÚòDxJQ½ªïÚ4ÖŠF©‚4±Üí"PÞ·¨â<†BÃdmÇY¦’1Â…õ×T2¢»R”é¦W¥uZØÖÖ®[aûRhîïÛ:ŹV6?‹»r“gÝlz0¶àîçxT«Ó‘ÎÖHgÄF0 Ùc„oÓn{ |lì(*Þ tZñbÑ¥t4 3mü +£ ˆ”úÑÒ…®,/Û¶„ò®Mó¯ô~›Óí +«:(•<ÒõÉýºô’þÿõ:Ö4y¿]7á0
ÇkYn6å„G˜O˜ðÁé¬ZGîù~ûôÐ:Z¼étm7Õx =¿>é•[ pH(lÓ¤+ (ÇþîhãÝAIŽSžêÉ
æü>A ‘ míšÙ»ž °kÐ@â»Ïi˜î]!ß.˺H]Ù¤”|Ä©’ÒD; ÇGp6ƒ³wóË'Lé ¢íµêe¦°å‘0•1b»o«´]76…˜ ÕÁ8QB»O§¯ç Uöþðbäî ¤u¶NóÎ8V¾»þÕ, >àï4ß!endstream +endobj +6 0 obj +799 +endobj +4 0 obj +<</Type/Page/MediaBox [0 0 612 792] +/Rotate 0/Parent 3 0 R +/Resources<</ProcSet[/PDF /Text] +/ExtGState 11 0 R +/Font 12 0 R +>> +/Contents 5 0 R +>> +endobj +3 0 obj +<< /Type /Pages /Kids [ +4 0 R +] /Count 1 +>> +endobj +1 0 obj +<</Type /Catalog /Pages 3 0 R +/Metadata 15 0 R +>> +endobj +7 0 obj +<</Type/ExtGState +/OPM 1>>endobj +11 0 obj +<</R7 +7 0 R>> +endobj +12 0 obj +<</R10 +10 0 R/R9 +9 0 R/R8 +8 0 R>> +endobj +10 0 obj +<</BaseFont/Times-Italic/Type/Font +/Encoding 13 0 R/Subtype/Type1>> +endobj +13 0 obj +<</Type/Encoding/Differences[ +140/fi]>> +endobj +9 0 obj +<</BaseFont/Times-Bold/Type/Font +/Subtype/Type1>> +endobj +8 0 obj +<</BaseFont/Times-Roman/Type/Font +/Encoding 14 0 R/Subtype/Type1>> +endobj +14 0 obj +<</Type/Encoding/Differences[ +140/fi +173/minus]>> +endobj +15 0 obj +<</Type/Metadata +/Subtype/XML/Length 1344>>stream +<?xpacket begin='' id='W5M0MpCehiHzreSzNTczkc9d'?> +<?adobe-xap-filters esc="CRLF"?> +<x:xmpmeta xmlns:x='adobe:ns:meta/' x:xmptk='XMP toolkit 2.9.1-13, framework 1.6'> +<rdf:RDF xmlns:rdf='http://www.w3.org/1999/02/22-rdf-syntax-ns#' xmlns:iX='http://ns.adobe.com/iX/1.0/'> +<rdf:Description rdf:about='uuid:ba9afa77-e107-11ec-0000-483378f4c7da' xmlns:pdf='http://ns.adobe.com/pdf/1.3/' pdf:Producer='GPL Ghostscript 9.05'/> +<rdf:Description rdf:about='uuid:ba9afa77-e107-11ec-0000-483378f4c7da' xmlns:xmp='http://ns.adobe.com/xap/1.0/'><xmp:ModifyDate>2012-05-28T19:33:04+02:00</xmp:ModifyDate> +<xmp:CreateDate>2012-05-28T19:33:04+02:00</xmp:CreateDate> +<xmp:CreatorTool>groff version 1.21</xmp:CreatorTool></rdf:Description> +<rdf:Description rdf:about='uuid:ba9afa77-e107-11ec-0000-483378f4c7da' xmlns:xapMM='http://ns.adobe.com/xap/1.0/mm/' xapMM:DocumentID='uuid:ba9afa77-e107-11ec-0000-483378f4c7da'/> +<rdf:Description rdf:about='uuid:ba9afa77-e107-11ec-0000-483378f4c7da' xmlns:dc='http://purl.org/dc/elements/1.1/' dc:format='application/pdf'><dc:title><rdf:Alt><rdf:li xml:lang='x-default'>Untitled</rdf:li></rdf:Alt></dc:title></rdf:Description> +</rdf:RDF> +</x:xmpmeta> + + +<?xpacket end='w'?> +endstream +endobj +2 0 obj +<</Producer(GPL Ghostscript 9.05) +/CreationDate(D:20120528193304+02'00') +/ModDate(D:20120528193304+02'00') +/Creator(groff version 1.21)>>endobj +xref +0 16 +0000000000 65535 f +0000001122 00000 n +0000003082 00000 n +0000001063 00000 n +0000000903 00000 n +0000000015 00000 n +0000000884 00000 n +0000001187 00000 n +0000001513 00000 n +0000001448 00000 n +0000001308 00000 n +0000001228 00000 n +0000001258 00000 n +0000001392 00000 n +0000001595 00000 n +0000001661 00000 n +trailer +<< /Size 16 /Root 1 0 R /Info 2 0 R +/ID [<9C7C36C0EC05715B340B03B4D980BD01><9C7C36C0EC05715B340B03B4D980BD01>] +>> +startxref +3234 +%%EOF diff --git a/Master/texmf-dist/doc/man/man1/kpsetool.1 b/Master/texmf-dist/doc/man/man1/kpsetool.1 new file mode 100644 index 00000000000..addd9b08344 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/kpsetool.1 @@ -0,0 +1,106 @@ +.TH "kpsetool" "1" "September 2000" "teTeX" "teTeX" +.PP +.SH "NAME" +kpsetool \- script to make teTeX-style \fBkpsetool\fP, +\fBkpsexpand\fP, and \fBkpsepath\fP available +.PP +.SH "SYNOPSIS" +.PP +\fBkpsetool \fP [ \fIOPTIONS\fP\&.\&.\&. ] \fICOMMAND\fP +.PP +\fBkpsexpand\fP [ \fIOPTIONS\fP\&.\&.\&. ] \fISTRING\fP +.PP +\fBkpsepath\fP [ \fIOPTIONS\fP\&.\&.\&. ] \fIPATHTYPE\fP +.PP +.SH "DESCRIPTION" +.PP +\fBkpsetool\fP is a Bourne shell script that makes a teTeX-style +\fBkpsetool\fP, \fBkpsexpand\fP, and \fBkpsepath\fP available\&. +\fBkpsetool\fP uses \fBweb2c\fP\'s (new) \fBkpsexpand\fP binary, so the +syntax for \fBkpsexpand\fP is incompatible with teTeX\'s as of version +0\&.4\&. +.PP +.SH "OPTIONS" +.PP +.IP "\fB-m\fP \fImode\fP" +set Metafont mode +.IP "\fB-n\fP \fIprogname\fP" +pretend to be \fIprogname\fP to kpathsea +.IP "\fB-p\fP" +act like \fBkpsepath\fP(1) +.IP "\fB-v\fP" +act like \fBkpsexpand\fP(1) +.IP "\fB-w\fP" +act like \fBkpsewhich\fP(1) +.PP +.SH "USAGE" +.PP +\fIPATHTYPE\fP can be +.PP +.IP "\fBbase\fP" +Metafont memory dump +.IP "\fBbib\fP" +BibTeX bibliography source +.IP "\fBbst\fP" +BibTeX style files +.IP "\fBcnf\fP" +Kpathsea runtime configuration files +.IP "\fBdvips_config\fP" +dvips config files +.IP "\fBdvips_header\fP" +dvips header files +.IP "\fBfmt\fP" +TeX memory dump +.IP "\fBgf\fP" +generic font bitmap +.IP "\fBmem\fP" +MetaPost memory dump +.IP "\fBmf\fP" +Metafont source +.IP "\fBmfpool\fP" +Metafont program strings +.IP "\fBmp\fP" +MetaPost source +.IP "\fBmppool\fP" +MetaPost program strings +.IP "\fBmpsupport\fP" +MetaPost support files +.IP "\fBpict\fP" +Other kinds of figures +.IP "\fBpk\fP" +packed bitmap font +.IP "\fBtex\fP" +TeX source +.IP "\fBtexpool\fP" +TeX program strings +.IP "\fBtfm\fP" +TeX font metrics +.IP "\fBtroff_font\fP" +troff fonts +.IP "\fBvf\fP" +virtual font +.PP +.SH "SEE ALSO" +.PP +\fBkpsewhich\fP(1) +.PP +\fIKpathsea: A library for path searching\fP (info or DVI file) +.PP +Web page: <http://tug\&.org/teTeX/> +.PP +.SH "BUGS" +.PP +None known, but report any bugs found to <tetex@dbs\&.uni-hannover\&.de> (mailing list)\&. +.PP +.SH "AUTHOR" +.PP +\fBkpsetool\fP was written by Thomas Esser +<te@dbs\&.uni-hannover\&.de> in March, 1997\&. \fBkpsetool\fP +is in the public domain\&. +.PP +This manual page was written by C\&.M\&. Connelly +<c@eskimo\&.com>, for +the Debian GNU/Linux system\&. It may be used by other distributions +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/Master/texmf-dist/doc/man/man1/kpsetool.man1.pdf b/Master/texmf-dist/doc/man/man1/kpsetool.man1.pdf Binary files differnew file mode 100644 index 00000000000..37dda84b47a --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/kpsetool.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/kpsewhere.1 b/Master/texmf-dist/doc/man/man1/kpsewhere.1 new file mode 100644 index 00000000000..76700ed33fe --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/kpsewhere.1 @@ -0,0 +1,50 @@ +.TH "kpsewhere" "1" "March 2004" "teTeX" "teTeX" +.PP +.SH "NAME" +kpsewhere \- Expanding \fBkpsewhich\fP to separately iterate over each +texmf tree listed in $TEXMF. +.PP +.SH "SYNOPSIS" +.PP +\fBkpsewhere \fP [ \fIkpsewhich-OPTIONS\fP\&.\&.\&. ] \fICOMMAND\fP +.PP +.SH "DESCRIPTION" +.PP +\fBkpsewhere\fP is an extension to \fBkpsewhich\fP (as \fBwhere\fP is +for \fBwhich\fP in tcsh). The intention is to provide a way to check +for conflicts/shadowed files. It will, however, only find \fBone\fP +file per TEXMF tree. +.PP +.SH "OPTIONS" +.PP +.IP "\fB-h|--help\fP" +show a short help message +.IP "\fB\&*\fP" +all other options are directly handed to kpsewhich +.PP +.SH "SEE ALSO" +.PP +\fBkpsewhich\fP(1) +.PP +\fIKpathsea: A library for path searching\fP (info or DVI file) +.PP +Web page: <http://tug\&.org/teTeX/> +.PP +.SH "BUGS" +.PP +None known, but report any bugs found to <tetex@dbs\&.uni-hannover\&.de> (mailing list)\&. +.PP +.SH "AUTHOR" +.PP +\fBkpsewhere\fP was written by Hans Fredrik Nordhaug +<hans\&.fredrik@nordhaug\&.no>, additions by +Thomas Esser +<te@dbs\&.uni-hannover\&.de>, in 2003 and 2004\&. \fBkpsewhere\fP +is in the public domain\&. +.PP +This manual page was written by Frank Küster <frank@kuesterei\&.ch>, +for the Debian GNU/Linux system\&. It is also in the public domain +and may be used and changed 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/Master/texmf-dist/doc/man/man1/kpsewhere.man1.pdf b/Master/texmf-dist/doc/man/man1/kpsewhere.man1.pdf Binary files differnew file mode 100644 index 00000000000..1186e8269ed --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/kpsewhere.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/kpsewhich.1 b/Master/texmf-dist/doc/man/man1/kpsewhich.1 new file mode 100644 index 00000000000..116347fac39 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/kpsewhich.1 @@ -0,0 +1,144 @@ +.TH KPSEWHICH 1 "1 March 2011" "Kpathsea 6.1.0" +.\"===================================================================== +.if n .ds MP MetaPost +.if t .ds MP MetaPost +.if n .ds MF Metafont +.if t .ds MF M\s-2ETAFONT\s0 +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff +.el .ds OX TeX for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.\"===================================================================== +.SH NAME +kpsewhich \- standalone path lookup and and expansion for kpathsea +.SH SYNOPSIS +.B kpsewhich +.RI [ options ] +.RI [ filenames ] +.\"===================================================================== +.SH DESCRIPTION +This manual page is not meant to be exhaustive. The complete +documentation for this version of \*(TX can be found in the info file +or manual +.IR "Kpathsea: A library for path searching" . +.PP +.B kpsewhich +is used as a standalone front-end of the kpathsea library that can be +used to examine variables and find files. When the +.B -format +option is not given, the search path used when looking for a file is +inferred from the name given, by looking for a known extension. If +no known extension is found, the search path for \*(TX source files is +used. +.\"===================================================================== +.SH OPTIONS +.B kpsewhich +accepts the following options: +.TP +.BI -debug \ num +Set debugging flags. +.TP +.BI -D \ num +Use a base resolution of +.IR num ; +the default, set by the installer, is typically 600. +.TP +.BI -dpi \ num +As +.BR -D. +.TP +.BI -engine \ string +Set +.I $engine +in the environment, which is used in some search paths. +.TP +.BI -expand-braces \ string +Print variable and brace expansion of +.IR string . +.TP +.BI -expand-path \ string +Print complete path expansion of +.IR string . +.TP +.BI -expand-var \ string +Print variable expansion of +.IR string . +.TP +.BI -format \ name +Use file type +.IR name . +See the info manual for a list of valid names, or use the +.B -help +option to print the list. +.TP +.B -help +Print help message and exit. +.TP +.B -interactive +Ask for additional filenames to look up. +.TP +.BI -mktex \ fmt +enable +.RI mktex fmt +generation. +.RI ( fmt =pk/mf/tex/tfm) +.TP +.BI -mode \ string +Set device name for +.I $MAKETEX_MODE +to +.IR string ; +no default. +.TP +.B -must-exist +Search the disk as well as ls-R if necessary. +.TP +.BI -no-mktex \ fmt +disable +.RI mktex fmt +generation. +.RI ( fmt =pk/mf/tex/tfm) +.TP +.BI -path \ string +Search in the path +.IR string . +.TP +.BI -progname \ string +Set program name to +.IR string . +.\" .TP +.\" .BI -separator \ string +.\" .rb +.\" .I string +.\" separates components in +.\" .B -path +.\" output; default is +.\" .I : +.\" on UNIX systems. +.TP +.BI -show-path \ name +Output search path for file type +.IR name . +See the info manual for a list of valid names, or use the +.B -help +option to print the list. +.TP +.BI -var-value \ variable +Print the expansion of +.IR variable . +.TP +.B -version +Print version information and exit. +.\"===================================================================== +.SH "SEE ALSO" +.BR mktexlsr (1), +.BR mktexmf (1), +.BR mktexpk (1), +.BR mktextfm (1). diff --git a/Master/texmf-dist/doc/man/man1/kpsewhich.man1.pdf b/Master/texmf-dist/doc/man/man1/kpsewhich.man1.pdf Binary files differnew file mode 100644 index 00000000000..d5a701044fc --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/kpsewhich.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/kpsexpand.1 b/Master/texmf-dist/doc/man/man1/kpsexpand.1 new file mode 100644 index 00000000000..8fb7435c2aa --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/kpsexpand.1 @@ -0,0 +1 @@ +.so man1/kpsetool.1 diff --git a/Master/texmf-dist/doc/man/man1/kpsexpand.man1.pdf b/Master/texmf-dist/doc/man/man1/kpsexpand.man1.pdf Binary files differnew file mode 100644 index 00000000000..e01719e075c --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/kpsexpand.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/lacheck.1 b/Master/texmf-dist/doc/man/man1/lacheck.1 new file mode 100644 index 00000000000..11064b28e54 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/lacheck.1 @@ -0,0 +1,110 @@ +.TH "LaCheck" "1" "2010-12-10" "Release 1.26" +.SH NAME +lacheck - A consistency checker for LaTeX documents. +.SH SYNOPSIS +.B lacheck +.IR filename [ \fB.tex\fP ] +.SH DESCRIPTION +LaCheck is a general purpose consistency checker for LaTeX documents. +It reads a LaTeX document and displays warning messages, if it finds +bad sequences. It should be noted, that the badness is +.I very +subjective. LaCheck is designed to help find common mistakes in LaTeX +documents, especially those made by beginners. +.LP +The things checked are: +.LP +Mismatched groups (braces), environments and math mode +delimiters. When a mismatch is found, line numbers for +.I "both" +start and end of the mismatch is given. The error messages comes in +pairs, one for the end match and one for the beginning, marked with +\`<-\' and \`->\' respectively. +.LP +Bad spacing including missing a \`\\ \' after an abbreviation, missing +an \`\\@\' before a punctuation mark in a paragraph that is ended by +an capital letter, double spaces like \` \~\', bad usage of ellipsis +(like using ... instead of \\ldots, or using \\ldots where \\cdots +should be used), missing \~ before a \\cite or \\ref commands, space +before footnotes, italic corrections before comma, point, or italic +text, italic correction after normal text, missing italic correction +when switching from italic to normal text, and double italic +correction. +.LP +Badly placed punctuation marks around end of math mode +delimiters. This is, punctuation placed right after display math end +or punctuation placed right before text math end. Sequences of +whitespace followed by punctuation marks are also caught. +.LP +Bad use of quotation characters, i.e. constructs like "\'word" or +"word\`" are warned about, tabs in verbatim environments are caught, +certain TeX primitives are frowned upon, attempts to give font +specifiers arguments such as \\em{text} are noted, and use of @ in +LaTeX macros are reported. +.LP +LaCheck will read files that are input using \\input or \\include. +Files with suffix \`.sty\' are omitted, as they probably will cause +LaCheck to crash. +.LP +LaCheck may be invoked from within Emacs(1) using compile: + +To run: +.B "M-x compile RET lacheck RET" +, and then +.B "C-x `" +to parse the messages + +.SH OUTPUT +The output is UNIX-error like, and may be parsed using Emacs(1) +compile mode. Here is a sample: + +.PD 0 +lacheck compiler +.TP +"/usr/mef/compiler.tex", line 34: missing \`\\\\\\\\ \' after "etc." +.TP +"/usr/mef/compiler.tex", line 179: double space at " ~" +.TP +"/usr/mef/compiler.tex", line 186: <- unmatched "}" +.TP +"/usr/mef/compiler.tex", line 181: -> unmatched "$$" +.PD 1 +.LP +A control space \`\\ \' should be inserted at line 34, to prevent an +end-of-sentence space. +Also, at line 179, the first space of the sequence " ~" should +probably be deleted. +The last two lines is an example, where the user mistyped, and +probably inserted an extra "}" somewhere. + +.SH DIAGNOSTICS +Some special cases should be explained. In cases where a sentence ends +with something that LaCheck thinks is an abbreviation an missing \`\\ +\' error may also occur, if the following sentence begins with a +lowercase letter. +.LP +A mismatch error may cause more to follow, due to the chosen +algorithm. In such cases just correct the +.I "first" +error and run LaCheck again +.LP +Braces, environments and math mode must be balanced within a file. +.LP +LaCheck may be confused by unmatched stuff placed inside verbatim-like +environments called something else than exactly \`verbatim\'. +.SH FILES +lacheck +.SH SEE ALSO +tex(1), emacs(1), latex(1) +.SH BUGS +LaCheck gets confused by advanced macros, is fooled by simple macros, +can't figure out if you use a non-standard way to switch italic on or +off, does not like TeX at all, does not provide any options to turn +off specific warnings, and is at best a crude approximation. +.LP +Ideas for improvements and bug reports are very welcome. Such +should be directed to the maintainers, their email address is +<auc-tex_mgr@sunsite.auc.dk>. +.SH AUTHOR +Kresten Krab Thorup with modifications by Per Abrahamsen. + diff --git a/Master/texmf-dist/doc/man/man1/lacheck.man1.pdf b/Master/texmf-dist/doc/man/man1/lacheck.man1.pdf Binary files differnew file mode 100644 index 00000000000..3e3e6367454 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/lacheck.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/lamed.1 b/Master/texmf-dist/doc/man/man1/lamed.1 new file mode 100644 index 00000000000..bda63f2adb8 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/lamed.1 @@ -0,0 +1 @@ +.so man1/aleph.1 diff --git a/Master/texmf-dist/doc/man/man1/lamed.man1.pdf b/Master/texmf-dist/doc/man/man1/lamed.man1.pdf Binary files differnew file mode 100644 index 00000000000..1242c5ed0e4 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/lamed.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/latex.1 b/Master/texmf-dist/doc/man/man1/latex.1 new file mode 100644 index 00000000000..8f9d255ec21 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/latex.1 @@ -0,0 +1,86 @@ +.TH LATEX 1 "14 May 2010" "Web2C 2012" +.\"===================================================================== +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP\" for troff +.el .ds OX TeX\" for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.\"===================================================================== +.SH NAME +latex, elatex, lambda, pdflatex \- structured text formatting and typesetting +.SH SYNOPSIS +.B latex +.RI [ first-line ] +.\"===================================================================== +.SH DESCRIPTION +.PP +This manual page is not meant to be exhaustive. The complete +documentation for this version of \*(TX can be found in the info file +or manual +.IR "Web2C: A TeX implementation" . +.PP +The \*(LX language is described in the book +.IR "\*(LX \- A Document Preparation System" . +\*(LX is a \*(TX macro package, not a modification to the \*(TX source +program, so all the capabilities described in +.BR tex (1) +are present. +.PP +The \*(LX macros encourage writers to think about the content of their +documents, rather than the form. The ideal, very difficult to realize, is to +have no formatting commands (like ``switch to italic'' or ``skip 2 +picas'') in the document at all; instead, everything is done +by specific markup instructions: ``emphasize'', ``start a section''. +.PP +The primary source of documentation for \*(LX is the \*(LX manual +referenced below, and the local guide in the file +.I local-guide.tex +or +.I local.tex +or some such. +.PP +.B elatex +is the e-\*(TX extended mode version of \*(LX format. +.PP +.B lambda +is the Omega version of the \*(LX format. +.PP +.B pdflatex +is the pdf\*(TX version of the \*(LX format. +.PP +On some systems +.B latex209 +and +.B slitex +are available for compatibility with older versions of \*(LX. These +should not be used for new texts. +.\"===================================================================== +.PP +.SH "SEE ALSO" +.BR amslatex (1), +.BR amstex (1), +.BR pdflatex (1), +.BR pdftex (1), +.BR tex (1). +.PP +Leslie Lamport, +.IR "\*(LX \- A Document Preparation System" , +Addison-Wesley, 1985, ISBN 020115790X. +.PP +Frank Mittelbach, Michel Goossens, Johannes Braams, David Carlisle, +and Chris Rowley, +.IR "LaTeX Companion" , +Addison-Wesley, 2004, ISBN 0201362996 (2nd edition). +.PP +\fILaTeX Graphics Companion\fP, available as part of a boxed set: +\fIThe LaTeX Companions, Revised Boxed Set : A Complete Guide and +Reference for Preparing, Illustrating, and Publishing Technical +Documents\fP (2nd Edition), by Frank Mittelbach, Michel Goossens, +Sebastian Rahtz, Helmut Kopka, Patrick W. Daly (Addison-Wesley, 2004, +ISBN 0321269446). diff --git a/Master/texmf-dist/doc/man/man1/latex.man1.pdf b/Master/texmf-dist/doc/man/man1/latex.man1.pdf Binary files differnew file mode 100644 index 00000000000..fc051d7dff4 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/latex.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/latexdiff-vc.1 b/Master/texmf-dist/doc/man/man1/latexdiff-vc.1 new file mode 100644 index 00000000000..497b8fed20b --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/latexdiff-vc.1 @@ -0,0 +1,246 @@ +.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "LATEXDIFF-VC 1" +.TH LATEXDIFF-VC 1 "2012-12-16" "perl v5.12.4" " " +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +latexdiff\-vc \- wrapper script that calls latexdiff for different versions of a file under version management (CVS, RCS or SVN) +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBlatexdiff-vc\fR [ \fIlatexdiff-options\fR ] [ \fIlatexdiff-vc-options\fR ] \fB\-r\fR [\fIrev1\fR] [\fB\-r\fR \fIrev2\fR] \fIfile1.tex\fR [ \fIfile2.tex\fR ...] +.PP +.Vb 1 +\& or +.Ve +.PP +\&\fBlatexdiff-vc\fR [ \fIlatexdiff-options\fR ] [ \fIlatexdiff-vc-options\fR ][ \fB\-\-postscript\fR | \fB\-\-pdf\fR ] \fIold.tex\fR \fInew.tex\fR +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +\&\fIlatexdiff-vc\fR is a wrapper script that applies \fIlatexdiff\fR to a +file, or multiple files under version control (\s-1CVS\s0, \s-1RCS\s0 or \s-1SVN\s0), and optionally runs the +sequence of \f(CW\*(C`latex\*(C'\fR and \f(CW\*(C`dvips\*(C'\fR or \f(CW\*(C`pdflatex\*(C'\fR commands necessary to +produce pdf or postscript output of the difference tex file(s). It can +also be applied to a pair of files to automatise the generation of difference +file in postscript or pdf format. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-\-rcs\fR, \fB\-\-svn\fR, \fB\-\-cvs\fR, or \fB\-\-git\fR" 4 +.IX Item "--rcs, --svn, --cvs, or --git" +Set the version system. +If no version system is specified, latexdiff-vc will venture a guess. +.Sp +latexdiff-cvs and latexdiff-rcs are variants of latexdiff-vc which default to +the respective versioning system. However, this default can still be overridden using the options above. +.IP "\fB\-r\fR, \fB\-r\fR \fIrev\fR or \fB\-\-revision\fR, \fB\-\-revision=\fR\fIrev\fR" 4 +.IX Item "-r, -r rev or --revision, --revision=rev" +Choose revision (under \s-1RCS\s0, \s-1CVS\s0, \s-1SVN\s0 or \s-1GIT\s0). One or two \fB\-r\fR options can be +specified, and they result in different behaviour: +.RS 4 +.IP "\fBlatexdiff-vc\fR \-r \fIfile.tex\fR ..." 4 +.IX Item "latexdiff-vc -r file.tex ..." +compares \fIfile.tex\fR with the most recent version checked into \s-1RCS\s0. +.IP "\fBlatexdiff-vc\fR \-r \fIrev1\fR \fIfile.tex\fR ..." 4 +.IX Item "latexdiff-vc -r rev1 file.tex ..." +compares \fIfile.tex\fR with revision \fIrev1\fR. +.IP "\fBlatexdiff-vc\fR \-r \fIrev1\fR \-r \fIrev2\fR \fIfile.tex\fR ..." 4 +.IX Item "latexdiff-vc -r rev1 -r rev2 file.tex ..." +compares revisions \fIrev1\fR and \fIrev2\fR of \fIfile.tex\fR. +.Sp +Multiple files can be specified for all of the above options. All files must have the +extension \f(CW\*(C`.tex\*(C'\fR, though. +.IP "\fBlatexdiff-vc\fR \fIold.tex\fR \fInew.tex\fR" 4 +.IX Item "latexdiff-vc old.tex new.tex" +compares two files. +.RE +.RS 4 +.Sp +The name of the difference file is generated automatically and +reported to stdout. +.RE +.IP "\fB\-d\fR or \fB\-\-dir\fR \fB\-d\fR \fIpath\fR or \fB\-\-dir=\fR\fIpath\fR" 4 +.IX Item "-d or --dir -d path or --dir=path" +Rather than appending the string \f(CW\*(C`diff\*(C'\fR and optionally the version +numbers given to the output-file, this will prepend a directory name \f(CW\*(C`diff\*(C'\fR +to the +original filename, creating the directory and subdirectories should they not exist already. This is particularly useful in order to clone a +complete directory hierarchy. Optionally, a pathname \fIpath\fR can be specified, which is prepended instead of \f(CW\*(C`diff\*(C'\fR. +.IP "\fB\-\-fast\fR or \fB\-\-so\fR" 4 +.IX Item "--fast or --so" +Use \f(CW\*(C`latexdiff\-fast\*(C'\fR or \f(CW\*(C`latexdiff\-so\*(C'\fR, respectively (instead of \f(CW\*(C`latexdiff\*(C'\fR). +.IP "\fB\-\-ps\fR or \fB\-\-postscript\fR" 4 +.IX Item "--ps or --postscript" +Generate postscript output from difference file. This will run the +sequence \f(CW\*(C`latex; latex; dvips\*(C'\fR on the difference file (do not use +this option in the rare cases, where three \f(CW\*(C`latex\*(C'\fR commands are +required if you care about correct referencing). If the difference +file contains a \f(CW\*(C`\ebibliography\*(C'\fR tag, run the sequence \f(CW\*(C`latex; +bibtex; latex; latex; dvips\*(C'\fR. +.IP "\fB\-\-pdf\fR" 4 +.IX Item "--pdf" +Generate pdf output from difference file using \f(CW\*(C`pdflatex\*(C'\fR. This will +run the sequence \f(CW\*(C`pdflatex; pdflatex\*(C'\fR on the difference file, or +\&\f(CW\*(C`pdflatex; bibtex; pdflatex; pdflatex\*(C'\fR for files requiring bibtex. +.IP "\fB\-\-force\fR" 4 +.IX Item "--force" +Overwrite existing diff files without asking for confirmation. Default +behaviour is to ask for confirmation before overwriting an existing difference +file. +.IP "\fB\-\-help\fR or \fB\-h\fR" 4 +.IX Item "--help or -h" +Show help text +.IP "\fB\-\-version\fR" 4 +.IX Item "--version" +Show version number +.PP +All other options are passed on to \f(CW\*(C`latexdiff\*(C'\fR. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +latexdiff +.SH "PORTABILITY" +.IX Header "PORTABILITY" +\&\fIlatexdiff-vc\fR uses external commands and is therefore +limited to Unix-like systems. It also requires the \s-1RCS\s0 version control +system and latex to be installed on the system. Modules from Perl 5.8 +or higher are required. +.SH "BUG REPORTING" +.IX Header "BUG REPORTING" +.Vb 6 +\& Please submit bug reports through +\&the latexdiff project page I<http://developer.berlios.de/projects/latexdiff/> or send +\&to I<tilmann@gfz\-potsdam.de>. Include the serial number of I<latexdiff\-vc> +\&(option C<\-\-version>) +\&. +\&=head1 AUTHOR +.Ve +.PP +Copyright (C) 2005,2012 Frederik Tilmann +.PP +This program is free software; you can redistribute it and/or modify +it under the terms of the \s-1GNU\s0 General Public License Version 3 +Contributors: S Utcke, H Bruyninckx diff --git a/Master/texmf-dist/doc/man/man1/latexdiff-vc.man1.pdf b/Master/texmf-dist/doc/man/man1/latexdiff-vc.man1.pdf Binary files differnew file mode 100644 index 00000000000..779eaa29e23 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/latexdiff-vc.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/latexdiff.1 b/Master/texmf-dist/doc/man/man1/latexdiff.1 new file mode 100644 index 00000000000..2f075daa0a9 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/latexdiff.1 @@ -0,0 +1,758 @@ +.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "LATEXDIFF 1" +.TH LATEXDIFF 1 "2012-12-16" "perl v5.12.4" " " +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +latexdiff \- determine and markup differences between two latex files +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBlatexdiff\fR [ \fB\s-1OPTIONS\s0\fR ] \fIold.tex\fR \fInew.tex\fR > \fIdiff.tex\fR +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +Briefly, \fIlatexdiff\fR is a utility program to aid in the management of +revisions of latex documents. It compares two valid latex files, here +called \f(CW\*(C`old.tex\*(C'\fR and \f(CW\*(C`new.tex\*(C'\fR, finds significant differences +between them (i.e., ignoring the number of white spaces and position +of line breaks), and adds special commands to highlight the +differences. Where visual highlighting is not possible, e.g. for changes +in the formatting, the differences are +nevertheless marked up in the source. +.PP +The program treats the preamble differently from the main document. +Differences between the preambles are found using line-based +differencing (similarly to the Unix diff command, but ignoring white +spaces). A comment, "\f(CW\*(C`%DIF\ >\*(C'\fR" is appended to each added line, i.e. a +line present in \f(CW\*(C`new.tex\*(C'\fR but not in \f(CW\*(C`old.tex\*(C'\fR. Discarded lines + are deactivated by prepending "\f(CW\*(C`%DIF\ <\*(C'\fR". Changed blocks are preceded by +comment lines giving information about line numbers in the original files. Where there are insignificant +differences, the resulting file \f(CW\*(C`diff.tex\*(C'\fR will be similar to +\&\f(CW\*(C`new.tex\*(C'\fR. At the end of the preamble, the definitions for \fIlatexdiff\fR markup commands are inserted. +In differencing the main body of the text, \fIlatexdiff\fR attempts to +satisfy the following guidelines (in order of priority): +.IP "1." 3 +If both \f(CW\*(C`old.tex\*(C'\fR and \f(CW\*(C`new.tex\*(C'\fR are valid LaTeX, then the resulting +\&\f(CW\*(C`diff.tex\*(C'\fR should also be valid LateX. (\s-1NB\s0 If a few plain TeX commands +are used within \f(CW\*(C`old.tex\*(C'\fR or \f(CW\*(C`new.tex\*(C'\fR then \f(CW\*(C`diff.tex\*(C'\fR is not +guaranteed to work but usually will). +.IP "2." 3 +Significant differences are determined on the level of +individual words. All significant differences, including differences +between comments should be clearly marked in the resulting source code +\&\f(CW\*(C`diff.tex\*(C'\fR. +.IP "3." 3 +If a changed passage contains text or text-producing commands, then +running \f(CW\*(C`diff.tex\*(C'\fR through LateX should produce output where added +and discarded passages are highlighted. +.IP "4." 3 +Where there are insignificant differences, e.g. in the positioning of +line breaks, \f(CW\*(C`diff.tex\*(C'\fR should follow the formatting of \f(CW\*(C`new.tex\*(C'\fR +.PP +For differencing the same algorithm as \fIdiff\fR is used but words +instead of lines are compared. An attempt is made to recognize +blocks which are completely changed such that they can be marked up as a unit. +Comments are differenced line by line +but the number of spaces within comments is ignored. Commands including +all their arguments are generally compared as one unit, i.e., no mark-up +is inserted into the arguments of commands. However, for a selected +number of commands (for example, \f(CW\*(C`\ecaption\*(C'\fR and all sectioning +commands) the last argument is known to be text. This text is +split into words and differenced just as ordinary text (use options to +show and change the list of text commands, see below). As the +algorithm has no detailed knowledge of LaTeX, it assumes all pairs of +curly braces immediately following a command (i.e. a sequence of +letters beginning with a backslash) are arguments for that command. +As a restriction to condition 1 above it is thus necessary to surround +all arguments with curly braces, and to not insert +extraneous spaces. For example, write +.PP +.Vb 1 +\& \esection{\etextem{This is an emphasized section title}} +.Ve +.PP +and not +.PP +.Vb 1 +\& \esection {\etextem{This is an emphasized section title}} +.Ve +.PP +or +.PP +.Vb 1 +\& \esection\etextem{This is an emphasized section title} +.Ve +.PP +even though all varieties are the same to LaTeX (but see +\&\fB\-\-allow\-spaces\fR option which allows the second variety). +.PP +For environments whose content does not conform to standard LaTeX or +where graphical markup does not make sense all markup commands can be +removed by setting the \s-1PICTUREENV\s0 configuration variable, set by +default to \f(CW\*(C`picture\*(C'\fR and \f(CW\*(C`DIFnomarkup\*(C'\fR environments; see \fB\-\-config\fR +option). The latter environment (\f(CW\*(C`DIFnomarkup\*(C'\fR) can be used to +protect parts of the latex file where the markup results in illegal +markup. You have to surround the offending passage in both the old and +new file by \f(CW\*(C`\ebegin{DIFnomarkup}\*(C'\fR and \f(CW\*(C`\eend{DIFnomarkup}\*(C'\fR. You must +define the environment in the preambles of both old and new +documents. I prefer to define it as a null-environment, +.PP +\&\f(CW\*(C`\enewenvironment{DIFnomarkup}{}{}\*(C'\fR +.PP +but the choice is yours. Any markup within the environment will be +removed, and generally everything within the environment will just be +taken from the new file. +.PP +It is also possible to difference files which do not have a preamble. + In this case, the file is processed in the main document +mode, but the definitions of the markup commands are not inserted. +.PP +All markup commands inserted by \fIlatexdiff\fR begin with "\f(CW\*(C`\eDIF\*(C'\fR". Added +blocks containing words, commands or comments which are in \f(CW\*(C`new.tex\*(C'\fR +but not in \f(CW\*(C`old.tex\*(C'\fR are marked by \f(CW\*(C`\eDIFaddbegin\*(C'\fR and \f(CW\*(C`\eDIFaddend\*(C'\fR. +Discarded blocks are marked by \f(CW\*(C`\eDIFdelbegin\*(C'\fR and \f(CW\*(C`\eDIFdelend\*(C'\fR. +Within added blocks all text is highlighted with \f(CW\*(C`\eDIFadd\*(C'\fR like this: +\&\f(CW\*(C`\eDIFadd{Added text block}\*(C'\fR +Selected `safe' commands can be contained in these text blocks as well +(use options to show and change the list of safe commands, see below). +All other commands as well as braces \*(L"{\*(R" and \*(L"}\*(R" are never put within +the scope of \f(CW\*(C`\eDIFadd\*(C'\fR. Added comments are marked by prepending +"\f(CW\*(C`%DIF\ >\ \*(C'\fR". +.PP +Within deleted blocks text is highlighted with \f(CW\*(C`\eDIFdel\*(C'\fR. Deleted +comments are marked by prepending "\f(CW\*(C`%DIF\ <\ \*(C'\fR\*(L". Non-safe command +and curly braces within deleted blocks are commented out with +\&\*(R"\f(CW\*(C`%DIFDELCMD\ <\ \*(C'\fR". +.SH "OPTIONS" +.IX Header "OPTIONS" +.SS "Preamble" +.IX Subsection "Preamble" +The following options determine the visual markup style by adding the appropriate +command definitions to the preamble. See the end of this section for a description of +available styles. +.IP "\fB\-\-type=markupstyle\fR or \fB\-t markupstyle\fR" 4 +.IX Item "--type=markupstyle or -t markupstyle" +Add code to preamble for selected markup style. This option defines +\&\f(CW\*(C`\eDIFadd\*(C'\fR and \f(CW\*(C`\eDIFdel\*(C'\fR commands. +Available styles: +.Sp +\&\f(CW\*(C`UNDERLINE CTRADITIONAL TRADITIONAL CFONT FONTSTRIKE INVISIBLE +CHANGEBAR CCHANGEBAR CULINECHBAR CFONTCBHBAR\*(C'\fR +.Sp +[ Default: \f(CW\*(C`UNDERLINE\*(C'\fR ] +.IP "\fB\-\-subtype=markstyle\fR or \fB\-s markstyle\fR" 4 +.IX Item "--subtype=markstyle or -s markstyle" +Add code to preamble for selected style for bracketing +commands (e.g. to mark changes in margin). This option defines +\&\f(CW\*(C`\eDIFaddbegin\*(C'\fR, \f(CW\*(C`\eDIFaddend\*(C'\fR, \f(CW\*(C`\eDIFdelbegin\*(C'\fR and \f(CW\*(C`\eDIFdelend\*(C'\fR commands. +Available styles: \f(CW\*(C`SAFE MARGINAL COLOR DVIPSCOL\*(C'\fR +.Sp +[ Default: \f(CW\*(C`SAFE\*(C'\fR ] +.IP "\fB\-\-floattype=markstyle\fR or \fB\-f markstyle\fR" 4 +.IX Item "--floattype=markstyle or -f markstyle" +Add code to preamble for selected style which +replace standard marking and markup commands within floats +(e.g., marginal remarks cause an error within floats +so marginal marking can be disabled thus). This option defines all +\&\f(CW\*(C`\eDIF...FL\*(C'\fR commands. +Available styles: \f(CW\*(C`FLOATSAFE TRADITIONALSAFE IDENTICAL\*(C'\fR +.Sp +[ Default: \f(CW\*(C`FLOATSAFE\*(C'\fR ] +.IP "\fB\-\-encoding=enc\fR or \fB\-e enc\fR" 4 +.IX Item "--encoding=enc or -e enc" +Specify encoding of old.tex and new.tex. Typical encodings are +\&\f(CW\*(C`ascii\*(C'\fR, \f(CW\*(C`utf8\*(C'\fR, \f(CW\*(C`latin1\*(C'\fR, \f(CW\*(C`latin9\*(C'\fR. A list of available encodings can be +obtained by executing +.Sp +\&\f(CW\*(C`perl \-MEncode \-e \*(Aqprint join ("\en",Encode\-\*(C'\fRencodings( \*(L":all\*(R" )) ;' > +.Sp +[Default encoding is utf8 unless the first few lines of the preamble contain +an invocation \f(CW\*(C`\eusepackage[..]{inputenc}\*(C'\fR in which case the +encoding chosen by this command is asssumed. Note that \s-1ASCII\s0 (standard +latex) is a subset of utf8] +.IP "\fB\-\-preamble=file\fR or \fB\-p file\fR" 4 +.IX Item "--preamble=file or -p file" +Insert file at end of preamble instead of generating +preamble. The preamble must define the following commands +\&\f(CW\*(C`\eDIFaddbegin, \eDIFaddend, \eDIFadd{..}, +\&\eDIFdelbegin,\eDIFdelend,\eDIFdel{..},\*(C'\fR +and varieties for use within floats +\&\f(CW\*(C`\eDIFaddbeginFL, \eDIFaddendFL, \eDIFaddFL{..}, +\&\eDIFdelbeginFL, \eDIFdelendFL, \eDIFdelFL{..}\*(C'\fR +(If this option is set \fB\-t\fR, \fB\-s\fR, and \fB\-f\fR options +are ignored.) +.IP "\fB\-\-packages=pkg1,pkg2,..\fR" 4 +.IX Item "--packages=pkg1,pkg2,.." +Tell latexdiff that .tex file is processed with the packages in list +loaded. This is normally not necessary if the .tex file includes the +preamble, as the preamble is automatically scanned for \f(CW\*(C`\eusepackage\*(C'\fR commands. +Use of the \fB\-\-packages\fR option disables automatic scanning, so if for any +reason package specific parsing needs to be switched off, use \fB\-\-packages=none\fR. +The following packages trigger special behaviour: +.RS 4 +.ie n .IP """amsmath""" 8 +.el .IP "\f(CWamsmath\fR" 8 +.IX Item "amsmath" +Configuration variable amsmath is set to \f(CW\*(C`align*\*(C'\fR (Default: \f(CW\*(C`eqnarray*\*(C'\fR) +.ie n .IP """endfloat""" 8 +.el .IP "\f(CWendfloat\fR" 8 +.IX Item "endfloat" +Ensure that \f(CW\*(C`\ebegin{figure}\*(C'\fR and \f(CW\*(C`\eend{figure}\*(C'\fR always appear by themselves on a line. +.ie n .IP """hyperref""" 8 +.el .IP "\f(CWhyperref\fR" 8 +.IX Item "hyperref" +Change name of \f(CW\*(C`\eDIFadd\*(C'\fR and \f(CW\*(C`\eDIFdel\*(C'\fR commands to \f(CW\*(C`\eDIFaddtex\*(C'\fR and \f(CW\*(C`\eDIFdeltex\*(C'\fR and +define new \f(CW\*(C`\eDIFadd\*(C'\fR and \f(CW\*(C`\eDIFdel\*(C'\fR commands, which provide a wrapper for these commands, +using them for the text but not for the link defining command (where any markup would cause +errors). +.RE +.RS 4 +.Sp +[ Default: scan the preamble for \f(CW\*(C`\e\eusepackage\*(C'\fR commands to determine + loaded packages.] +.RE +.IP "\fB\-\-show\-preamble\fR" 4 +.IX Item "--show-preamble" +Print generated or included preamble commands to stdout. +.SS "Configuration" +.IX Subsection "Configuration" +.ie n .IP "\fB\-\-exclude\-safecmd=exclude\-file\fR or \fB\-A exclude-file\fR or \fB\-\-exclude\-safecmd=""cmd1,cmd2,...""\fR" 4 +.el .IP "\fB\-\-exclude\-safecmd=exclude\-file\fR or \fB\-A exclude-file\fR or \fB\-\-exclude\-safecmd=``cmd1,cmd2,...''\fR" 4 +.IX Item "--exclude-safecmd=exclude-file or -A exclude-file or --exclude-safecmd=cmd1,cmd2,..." +.PD 0 +.IP "\fB\-\-replace\-safecmd=replace\-file\fR" 4 +.IX Item "--replace-safecmd=replace-file" +.ie n .IP "\fB\-\-append\-safecmd=append\-file\fR or \fB\-a append-file\fR or \fB\-\-append\-safecmd=""cmd1,cmd2,...""\fR" 4 +.el .IP "\fB\-\-append\-safecmd=append\-file\fR or \fB\-a append-file\fR or \fB\-\-append\-safecmd=``cmd1,cmd2,...''\fR" 4 +.IX Item "--append-safecmd=append-file or -a append-file or --append-safecmd=cmd1,cmd2,..." +.PD +Exclude from, replace or append to the list of regular expressions (RegEx) +matching commands which are safe to use within the +scope of a \f(CW\*(C`\eDIFadd\*(C'\fR or \f(CW\*(C`\eDIFdel\*(C'\fR command. The file must contain +one Perl-RegEx per line (Comment lines beginning with # or % are +ignored). Note that the RegEx needs to match the whole of +the token, i.e., /^regex$/ is implied and that the initial +\&\*(L"\e\*(R" of the command is not included. +The \fB\-\-exclude\-safecmd\fR and \fB\-\-append\-safecmd\fR options can be combined with the \-\fB\-\-replace\-safecmd\fR +option and can be used repeatedly to add cumulatively to the lists. + \fB\-\-exclude\-safecmd\fR +and \fB\-\-append\-safecmd\fR can also take a comma separated list as input. If a +comma for one of the regex is required, escape it thus \*(L"\e,\*(R". In most cases it +will be necessary to protect the comma-separated list from the shell by putting +it in quotation marks. +.ie n .IP "\fB\-\-exclude\-textcmd=exclude\-file\fR or \fB\-X exclude-file\fR or \fB\-\-exclude\-textcmd=""cmd1,cmd2,...""\fR" 4 +.el .IP "\fB\-\-exclude\-textcmd=exclude\-file\fR or \fB\-X exclude-file\fR or \fB\-\-exclude\-textcmd=``cmd1,cmd2,...''\fR" 4 +.IX Item "--exclude-textcmd=exclude-file or -X exclude-file or --exclude-textcmd=cmd1,cmd2,..." +.PD 0 +.IP "\fB\-\-replace\-textcmd=replace\-file\fR" 4 +.IX Item "--replace-textcmd=replace-file" +.ie n .IP "\fB\-\-append\-textcmd=append\-file\fR or \fB\-x append-file\fR or \fB\-\-append\-textcmd=""cmd1,cmd2,...""\fR" 4 +.el .IP "\fB\-\-append\-textcmd=append\-file\fR or \fB\-x append-file\fR or \fB\-\-append\-textcmd=``cmd1,cmd2,...''\fR" 4 +.IX Item "--append-textcmd=append-file or -x append-file or --append-textcmd=cmd1,cmd2,..." +.PD +Exclude from, replace or append to the list of regular expressions +matching commands whose last argument is text. See +entry for \fB\-\-exclude\-safecmd\fR directly above for further details. +.IP "\fB\-\-replace\-context1cmd=replace\-file\fR" 4 +.IX Item "--replace-context1cmd=replace-file" +.PD 0 +.ie n .IP "\fB\-\-append\-context1cmd=append\-file\fR or =item \fB\-\-append\-context1cmd=""cmd1,cmd2,...""\fR" 4 +.el .IP "\fB\-\-append\-context1cmd=append\-file\fR or =item \fB\-\-append\-context1cmd=``cmd1,cmd2,...''\fR" 4 +.IX Item "--append-context1cmd=append-file or =item --append-context1cmd=cmd1,cmd2,..." +.PD +Replace or append to the list of regex matching commands +whose last argument is text but which require a particular +context to work, e.g. \ecaption will only work within a figure +or table. These commands behave like text commands, except when +they occur in a deleted section, when they are disabled, but their +argument is shown as deleted text. +.IP "\fB\-\-replace\-context2cmd=replace\-file\fR" 4 +.IX Item "--replace-context2cmd=replace-file" +.PD 0 +.ie n .IP "\fB\-\-append\-context2cmd=append\-file\fR or =item \fB\-\-append\-context2cmd=""cmd1,cmd2,...""\fR As corresponding commands for context1. The only difference is that context2 commands are completely disabled in deleted sections, including their arguments." 4 +.el .IP "\fB\-\-append\-context2cmd=append\-file\fR or =item \fB\-\-append\-context2cmd=``cmd1,cmd2,...''\fR As corresponding commands for context1. The only difference is that context2 commands are completely disabled in deleted sections, including their arguments." 4 +.IX Item "--append-context2cmd=append-file or =item --append-context2cmd=cmd1,cmd2,... As corresponding commands for context1. The only difference is that context2 commands are completely disabled in deleted sections, including their arguments." +.IP "\fB\-\-config var1=val1,var2=val2,...\fR or \fB\-c var1=val1,..\fR" 4 +.IX Item "--config var1=val1,var2=val2,... or -c var1=val1,.." +.IP "\fB\-c configfile\fR" 4 +.IX Item "-c configfile" +.PD +Set configuration variables. The option can be repeated to set different +variables (as an alternative to the comma-separated list). +Available variables (see below for further explanations): +.Sp +\&\f(CW\*(C`MINWORDSBLOCK\*(C'\fR (integer) +.Sp +\&\f(CW\*(C`FLOATENV\*(C'\fR (RegEx) +.Sp +\&\f(CW\*(C`PICTUREENV\*(C'\fR (RegEx) +.Sp +\&\f(CW\*(C`MATHENV\*(C'\fR (RegEx) +.Sp +\&\f(CW\*(C`MATHREPL\*(C'\fR (String) +.Sp +\&\f(CW\*(C`MATHARRENV\*(C'\fR (RegEx) +.Sp +\&\f(CW\*(C`MATHARRREPL\*(C'\fR (String) +.Sp +\&\f(CW\*(C`ARRENV\*(C'\fR (RegEx) +.Sp +\&\f(CW\*(C`COUNTERCMD\*(C'\fR (RegEx) +.IP "\fB\-\-show\-safecmd\fR" 4 +.IX Item "--show-safecmd" +Print list of RegEx matching and excluding safe commands. +.IP "\fB\-\-show\-textcmd\fR" 4 +.IX Item "--show-textcmd" +Print list of RegEx matching and excluding commands with text argument. +.IP "\fB\-\-show\-config\fR" 4 +.IX Item "--show-config" +Show values of configuration variables. +.IP "\fB\-\-show\-all\fR" 4 +.IX Item "--show-all" +Combine all \-\-show commands. +.Sp +\&\s-1NB\s0 For all \-\-show commands, no \f(CW\*(C`old.tex\*(C'\fR or \f(CW\*(C`new.tex\*(C'\fR file needs to be specified, and no +differencing takes place. +.SS "Other configuration options:" +.IX Subsection "Other configuration options:" +.IP "\fB\-\-allow\-spaces\fR" 4 +.IX Item "--allow-spaces" +Allow spaces between bracketed or braced arguments to commands. Note +that this option might have undesirable side effects (unrelated scope +might get lumpeded with preceding commands) so should only be used if the +default produces erroneous results. (Default requires arguments to +directly follow each other without intervening spaces). +.IP "\fB\-\-math\-markup=level\fR" 4 +.IX Item "--math-markup=level" +Determine granularity of markup in displayed math environments: +Possible values for level are (both numerical and text labels are acceptable): +.Sp +\&\f(CW\*(C`off\*(C'\fR or \f(CW0\fR: suppress markup for math environments. Deleted equations will not +appear in diff file. This mode can be used if all the other modes +cause invalid latex code. +.Sp +\&\f(CW\*(C`whole\*(C'\fR or \f(CW1\fR: Differencing on the level of whole equations. Even trivial changes +to equations cause the whole equation to be marked changed. This +mode can be used if processing in coarse or fine mode results in +invalid latex code. +.Sp +\&\f(CW\*(C`coarse\*(C'\fR or \f(CW2\fR: Detect changes within equations marked up with a coarse +granularity; changes in equation type (e.g.displaymath to equation) +appear as a change to the complete equation. This mode is recommended +for situations where the content and order of some equations are still +being changed. [Default] +.Sp +\&\f(CW\*(C`fine\*(C'\fR or \f(CW3\fR: Detect small change in equations and mark up at fine granularity. +This mode is most suitable, if only minor changes to equations are +expected, e.g. correction of typos. +.IP "\fB\-\-disable\-citation\-markup\fR" 4 +.IX Item "--disable-citation-markup" +Suppress citation markup in styles using ulem (\s-1UNDERLINE\s0, +\&\s-1FONTSTRIKE\s0, \s-1CULINECHBAR\s0) +.IP "\fB\-\-enable\-citation\-markup\fR" 4 +.IX Item "--enable-citation-markup" +Protect citation commands in changed sections with \e\embox command [i.e. use default behaviour for ulem package for other packages] +.SS "Miscellaneous" +.IX Subsection "Miscellaneous" +.RS 4 +Output various status information to stderr during processing. +Default is to work silently. +.Sp +\&\fB\-\-driver=type\fR +.Sp +Choose driver for changebar package (only relevant for styles using + changebar: \s-1CCHANGEBAR\s0 \s-1CFONTCHBAR\s0 \s-1CULINECHBAR\s0 \s-1CHANGEBAR\s0). Possible +drivers are listed in changebar manual, e.g. pdftex,dvips,dvitops + [Default: dvips] +.Sp +\&\fB\-\-ignore\-warnings\fR +.Sp +Suppress warnings about inconsistencies in length between input and +parsed strings and missing characters. These warning messages are +often related to non-standard latex or latex constructions with a +syntax unknown to \f(CW\*(C`latexdiff\*(C'\fR but the resulting difference argument +is often fully functional anyway, particularly if the non-standard +latex only occurs in parts of the text which have not changed. +.Sp +\&\fB\-\-label=label\fR or +\&\fB\-L label\fR +.Sp +Sets the labels used to describe the old and new files. The first use +of this option sets the label describing the old file and the second +use of the option sets the label for the new file, i.e. set both +labels like this \f(CW\*(C`\-L labelold \-L labelnew\*(C'\fR. +[Default: use the filename and modification dates for the label] +.Sp +\&\fB\-\-no\-label\fR +.Sp +Suppress inclusion of old and new file names as comment in output file +.Sp +\&\fB\-\-visble\-label\fR +.Sp +Include old and new filenames (or labels set with \-\-label option) as +visible output. +.Sp +\&\fB\-\-flatten\fR +.Sp +Replace \f(CW\*(C`\einput\*(C'\fR and \f(CW\*(C`\einclude\*(C'\fR commands within body by the content +of the files in their argument. If \f(CW\*(C`\eincludeonly\*(C'\fR is present in the +preamble, only those files are expanded into the document. However, +no recursion is done, i.e. \f(CW\*(C`\einput\*(C'\fR and \f(CW\*(C`\einclude\*(C'\fR commands within +included sections are not expanded. The included files are assumed to + be located in the same directories as the old and new master files, +respectively, making it possible to organise files into old and new directories. +\&\-\-flatten is applied recursively, so inputted files can contain further +\&\f(CW\*(C`\einput\*(C'\fR statements. +.Sp +Use of this option might result in prohibitive processing times for +larger documents, and the resulting difference document +no longer reflects the structure of the input documents. +.Sp +\&\fB\-\-help\fR or +\&\fB\-h\fR +.Sp +Show help text +.Sp +\&\fB\-\-version\fR +.Sp +Show version number +.RE +.SS "Predefined styles" +.IX Subsection "Predefined styles" +.SS "Major types" +.IX Subsection "Major types" +The major type determine the markup of plain text and some selected latex commands outside floats by defining the markup commands \f(CW\*(C`\eDIFadd{...}\*(C'\fR and \f(CW\*(C`\eDIFdel{...}\*(C'\fR . +.ie n .IP """UNDERLINE""" 10 +.el .IP "\f(CWUNDERLINE\fR" 10 +.IX Item "UNDERLINE" +Added text is wavy-underlined and blue, discarded text is struck out and red +(Requires color and ulem packages). Overstriking does not work in displayed math equations such that deleted parts of equation are underlined, not struck out (this is a shortcoming inherent to the ulem package). +.ie n .IP """CTRADITIONAL""" 10 +.el .IP "\f(CWCTRADITIONAL\fR" 10 +.IX Item "CTRADITIONAL" +Added text is blue and set in sans-serif, and a red footnote is created for each discarded +piece of text. (Requires color package) +.ie n .IP """TRADITIONAL""" 10 +.el .IP "\f(CWTRADITIONAL\fR" 10 +.IX Item "TRADITIONAL" +Like \f(CW\*(C`CTRADITIONAL\*(C'\fR but without the use of color. +.ie n .IP """CFONT""" 10 +.el .IP "\f(CWCFONT\fR" 10 +.IX Item "CFONT" +Added text is blue and set in sans-serif, and discarded text is red and very small size. +.ie n .IP """FONTSTRIKE""" 10 +.el .IP "\f(CWFONTSTRIKE\fR" 10 +.IX Item "FONTSTRIKE" +Added tex is set in sans-serif, discarded text small and struck out +.ie n .IP """CCHANGEBAR""" 10 +.el .IP "\f(CWCCHANGEBAR\fR" 10 +.IX Item "CCHANGEBAR" +Added text is blue, and discarded text is red. Additionally, the changed text is marked with a bar in the margin (Requires color and changebar packages). +.ie n .IP """CFONTCHBAR""" 10 +.el .IP "\f(CWCFONTCHBAR\fR" 10 +.IX Item "CFONTCHBAR" +Like \f(CW\*(C`CFONT\*(C'\fR but with additional changebars (Requires color and changebar packages). +.ie n .IP """CULINECHBAR""" 10 +.el .IP "\f(CWCULINECHBAR\fR" 10 +.IX Item "CULINECHBAR" +Like \f(CW\*(C`UNDERLINE\*(C'\fR but with additional changebars (Requires color, ulem and changebar packages). +.ie n .IP """CHANGEBAR""" 10 +.el .IP "\f(CWCHANGEBAR\fR" 10 +.IX Item "CHANGEBAR" +No mark up of text, but mark margins with changebars (Requires changebar package). +.ie n .IP """INVISIBLE""" 10 +.el .IP "\f(CWINVISIBLE\fR" 10 +.IX Item "INVISIBLE" +No visible markup (but generic markup commands will still be inserted. +.SS "Subtypes" +.IX Subsection "Subtypes" +The subtype defines the commands that are inserted at the begin and end of added or discarded blocks, irrespectively of whether these blocks contain text or commands (Defined commands: \f(CW\*(C`\eDIFaddbegin, \eDIFaddend, \eDIFdelbegin, \eDIFdelend\*(C'\fR) +.ie n .IP """SAFE""" 10 +.el .IP "\f(CWSAFE\fR" 10 +.IX Item "SAFE" +No additional markup (Recommended choice) +.ie n .IP """MARGIN""" 10 +.el .IP "\f(CWMARGIN\fR" 10 +.IX Item "MARGIN" +Mark beginning and end of changed blocks with symbols in the margin nearby (using +the standard \f(CW\*(C`\emarginpar\*(C'\fR command \- note that this sometimes moves somewhat +from the intended position. +.ie n .IP """COLOR""" 10 +.el .IP "\f(CWCOLOR\fR" 10 +.IX Item "COLOR" +An alternative way of marking added passages in blue, and deleted ones in red. +(It is recommeneded to use instead the main types to effect colored markup, +although in some cases coloring with dvipscol can be more complete, for example +with citation commands). +.ie n .IP """DVIPSCOL""" 10 +.el .IP "\f(CWDVIPSCOL\fR" 10 +.IX Item "DVIPSCOL" +An alternative way of marking added passages in blue, and deleted ones in red. Note +that \f(CW\*(C`DVIPSCOL\*(C'\fR only works with the dvips converter, e.g. not pdflatex. +(it is recommeneded to use instead the main types to effect colored markup, +although in some cases coloring with dvipscol can be more complete). +.SS "Float Types" +.IX Subsection "Float Types" +Some of the markup used in the main text might cause problems when used within +floats (e.g. figures or tables). For this reason alternative versions of all +markup commands are used within floats. The float type defines these alternative commands. +.ie n .IP """FLOATSAFE""" 10 +.el .IP "\f(CWFLOATSAFE\fR" 10 +.IX Item "FLOATSAFE" +Use identical markup for text as in the main body, but set all commands marking the begin and end of changed blocks to null-commands. You have to choose this float type if your subtype is \f(CW\*(C`MARGIN\*(C'\fR as \f(CW\*(C`\emarginpar\*(C'\fR does not work properly within floats. +.ie n .IP """TRADITIONALSAFE""" 10 +.el .IP "\f(CWTRADITIONALSAFE\fR" 10 +.IX Item "TRADITIONALSAFE" +Mark additions the same way as in the main text. Deleted environments are marked by angular brackets \e[ and \e] and the deleted text is set in scriptscript size. This float type should always be used with the \f(CW\*(C`TRADITIONAL\*(C'\fR and \f(CW\*(C`CTRADITIONAL\*(C'\fR markup types as the \efootnote command does not work properly in floating environments. +.ie n .IP """IDENTICAL""" 10 +.el .IP "\f(CWIDENTICAL\fR" 10 +.IX Item "IDENTICAL" +Make no difference between the main text and floats. +.SS "Configuration Variables" +.IX Subsection "Configuration Variables" +.ie n .IP """MINWORDSBLOCK""" 10 +.el .IP "\f(CWMINWORDSBLOCK\fR" 10 +.IX Item "MINWORDSBLOCK" +Minimum number of tokens required to form an independent block. This value is +used in the algorithm to detect changes of complete blocks by merging identical text parts of less than \f(CW\*(C`MINWORDSBLOCK\*(C'\fR to the preceding added and discarded parts. +.Sp +[ Default: 3 ] +.ie n .IP """FLOATENV""" 10 +.el .IP "\f(CWFLOATENV\fR" 10 +.IX Item "FLOATENV" +Environments whose name matches the regular expression in \f(CW\*(C`FLOATENV\*(C'\fR are +considered floats. Within these environments, the \fIlatexdiff\fR markup commands +are replaced by their \s-1FL\s0 variaties. +.Sp +[ Default: \f(CW\*(C`(?:figure|table|plate)[\ew\ed*@]*\*(C'\fR\ ] +.ie n .IP """PICTUREENV""" 10 +.el .IP "\f(CWPICTUREENV\fR" 10 +.IX Item "PICTUREENV" +Within environments whose name matches the regular expression in \f(CW\*(C`PICTUREENV\*(C'\fR +all latexdiff markup is removed (in pathologic cases this might lead to + inconsistent markup but this situation should be rare). +.Sp +[ Default: \f(CW\*(C`(?:picture|DIFnomarkup)[\ew\ed*@]*\*(C'\fR\ ] +.ie n .IP """MATHENV"",""MATHREPL""" 10 +.el .IP "\f(CWMATHENV\fR,\f(CWMATHREPL\fR" 10 +.IX Item "MATHENV,MATHREPL" +If both \ebegin and \eend for a math environment (environment name matching \f(CW\*(C`MATHENV\*(C'\fR +or \e[ and \e]) +are within the same deleted block, they are replaced by a \ebegin and \eend commands for \f(CW\*(C`MATHREPL\*(C'\fR +rather than being commented out. +.Sp +[ Default: \f(CW\*(C`MATHENV\*(C'\fR=\f(CW\*(C`(?:displaymath|equation)\*(C'\fR\ , \f(CW\*(C`MATHREPL\*(C'\fR=\f(CW\*(C`displaymath\*(C'\fR\ ] +.ie n .IP """MATHARRENV"",""MATHARRREPL""" 10 +.el .IP "\f(CWMATHARRENV\fR,\f(CWMATHARRREPL\fR" 10 +.IX Item "MATHARRENV,MATHARRREPL" +as \f(CW\*(C`MATHENV\*(C'\fR,\f(CW\*(C`MATHREPL\*(C'\fR but for equation arrays +.Sp +[ Default: \f(CW\*(C`MATHARRENV\*(C'\fR=\f(CW\*(C`eqnarray\e*?\*(C'\fR\ , \f(CW\*(C`MATHREPL\*(C'\fR=\f(CW\*(C`eqnarray\*(C'\fR\ ] +.ie n .IP """ARRENV""" 10 +.el .IP "\f(CWARRENV\fR" 10 +.IX Item "ARRENV" +If a match to \f(CW\*(C`ARRENV\*(C'\fR is found within an inline math environment within a deleted or added block, then the inlined math +is surrounded by \f(CW\*(C`\embox{\*(C'\fR...\f(CW\*(C`}\*(C'\fR. This is necessary as underlining does not work within inlined array environments. +.Sp +[ Default: \f(CW\*(C`ARRENV\*(C'\fR=\f(CW\*(C`(?:array|[pbvBV]matrix)\*(C'\fR\ +.ie n .IP """COUNTERCMD""" 10 +.el .IP "\f(CWCOUNTERCMD\fR" 10 +.IX Item "COUNTERCMD" +If a command in a deleted block which is also in the textcmd list matches \f(CW\*(C`COUNTERCMD\*(C'\fR then an +additional command \f(CW\*(C`\eaddtocounter{\*(C'\fR\fIcntcmd\fR\f(CW\*(C`}{\-1}\*(C'\fR, where \fIcntcmd\fR is the matching command, is appended in the diff file such that the numbering in the diff file remains synchronized with the +numbering in the new file. +.Sp +[ Default: \f(CW\*(C`COUNTERCMD\*(C'\fR=\f(CW\*(C`(?:footnote|part|section|subsection\*(C'\fR ... +.Sp +\&\f(CW\*(C`|subsubsection|paragraph|subparagraph)\*(C'\fR ] +.SH "COMMON PROBLEMS" +.IX Header "COMMON PROBLEMS" +.IP "Citations result in overfull boxes" 10 +.IX Item "Citations result in overfull boxes" +There is an incompatibility between the \f(CW\*(C`ulem\*(C'\fR package, which \f(CW\*(C`latexdiff\*(C'\fR uses for underlining and striking out in the \s-1UNDERLINE\s0 style, +the default style. In order to be able to mark up citations properly, they are placed with an \f(CW\*(C`\embox\*(C'\fR command in post-processing. As mboxes +cannot be broken across lines, this procedure frequently results in overfull boxes, possibly obscuring the content as it extends beyond the right margin. If this is a problem, you have two possibilities: +.Sp +1. Use \f(CW\*(C`COLOR\*(C'\fR or \f(CW\*(C`DVIPSCOL\*(C'\fR subtype markup (option \f(CW\*(C`\-s COLOR\*(C'\fR): If this markup is chosen, then changed citations are no longer marked up +with the wavy line (additions) or struck out (deletions), but are still highlighted in the appropriate color. +.Sp +2. Choose option \f(CW\*(C`\-\-disable\-citation\-markup\*(C'\fR which turns off the marking up of citations: deleted citations are no longer shown, and +added ctations are shown without markup. (This was the default behaviour of latexdiff at versions 0.6 and older) +.IP "Changes in complicated mathematical equations result in latex processing errors" 10 +.IX Item "Changes in complicated mathematical equations result in latex processing errors" +Try options \f(CW\*(C`\-\-math\-markup=whole\*(C'\fR. If even that fails, you can turn off mark up for equations with \f(CW\*(C`\-\-math\-markup=off\*(C'\fR. +.SH "BUGS" +.IX Header "BUGS" +Option allow-spaces not implemented entirely consistently. It breaks +the rules that number and type of white space does not matter, as +different numbers of inter-argument spaces are treated as significant. +.PP +Please submit bug reports on the latexdiff project page \fIhttp://latexdiff.berlios.de\fR, +send them to user discussion list \f(CW\*(C`latexdiff\-users@lists.berlios,de\*(C'\fR (prior subscription +to list required, also on project webpage) +or send them to \fItilmann@gfz\-potsdam.de\fR. Include the serial number of \fIlatexdiff\fR +(from comments at the top of the source or use \fB\-\-version\fR). If you come across latex +files that are error-free and conform to the specifications set out +above, and whose differencing still does not result in error-free +latex, please send me those files, ideally edited to only contain the +offending passage as long as that still reproduces the problem. If your +file relies on non-standard class files, you must include those. I will not +look at examples where I have trouble to latex the original files. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +latexrevise, latexdiff-vc +.SH "PORTABILITY" +.IX Header "PORTABILITY" +\&\fIlatexdiff\fR does not make use of external commands and thus should run +on any platform supporting Perl 5.6 or higher. If files with encodings +other than \s-1ASCII\s0 or \s-1UTF\-8\s0 are processed, Perl 5.8 or higher is required. +.PP +The standard version of \fIlatexdiff\fR requires installation of the Perl package +\&\f(CW\*(C`Algorithm::Diff\*(C'\fR (available from \fIwww.cpan.org\fR \- +\&\fIhttp://search.cpan.org/~nedkonz/Algorithm\-Diff\-1.15\fR) but a stand-alone +version, \fIlatexdiff-so\fR, which has this package inlined, is available, too. +\&\fIlatexdiff-fast\fR requires the \fIdiff\fR command to be present. +.SH "AUTHOR" +.IX Header "AUTHOR" +Version 1.0.2 +Copyright (C) 2004\-2012 Frederik Tilmann +.PP +This program is free software; you can redistribute it and/or modify +it under the terms of the \s-1GNU\s0 General Public License Version 3 +.PP +Contributors of fixes and additions: V. Kuhlmann, J. Paisley, N. Becker, T. Doerges, K. Huebner, +T. Connors, Sebastian Gouezel and many others. +Thanks to the many people who send in bug reports, feature suggestions, and other feedback. +.SH "POD ERRORS" +.IX Header "POD ERRORS" +Hey! \fBThe above document had some coding errors, which are explained below:\fR +.IP "Around line 2942:" 4 +.IX Item "Around line 2942:" +=over should be: '=over' or '=over positive_number' +.Sp +You can't have =items (as at line 2948) unless the first thing after the =over is an =item diff --git a/Master/texmf-dist/doc/man/man1/latexdiff.man1.pdf b/Master/texmf-dist/doc/man/man1/latexdiff.man1.pdf Binary files differnew file mode 100644 index 00000000000..efa57b96109 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/latexdiff.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/latexmk.1 b/Master/texmf-dist/doc/man/man1/latexmk.1 new file mode 100644 index 00000000000..64567ed25f4 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/latexmk.1 @@ -0,0 +1,2511 @@ +.TH LATEXMK 1L "11 November 2012" "" +.SH NAME +latexmk \- generate LaTeX document +.SH SYNOPSIS +.B latexmk [options] [file ...] +.SH DESCRIPTION +.I Latexmk +completely automates the process of compiling a LaTeX document. +Essentially, it is like a specialized relative of the general +\fImake\fR utility, but one which determines dependencies +automatically and has some other very useful features. In its basic +mode of operation \fIlatexmk\fR is given the name of the primary +source file for a document, and it issues the appropriate sequence of +commands to generate a .dvi, .ps, .pdf and/or hardcopy version of the +document. +.PP +By default \fIlatexmk\fR will run the commands necessary to generate +a .dvi file. +.PP +\fILatexmk\fR can also be set to run continuously with a suitable +previewer. In that case the LaTeX program, etc, are rerun whenever +one of the source files is modified, and the previewer automatically +updates the on-screen view of the compiled document. +.PP +\fILatexmk\fR determines which are the source files by examining the +log file. (Optionally, it also examines the list of input and output +files generated by the \fB-recorder\fR option of modern versions of +\fIlatex\fR and \fIpdflatex\fR. See the documentation for the +\fB-recorder\fR option of \fIlatexmk\fR below.) +When \fIlatexmk\fR is run, it examines properties of the +source files, and if any have been changed since the last document +generation, \fIlatexmk\fR will run the various LaTeX processing +programs as necessary. In particular, it will repeat the run of LaTeX +(or pdflatex) often enough to resolve all cross references; depending +on the macro packages used. With some macro packages and document +classes, four, or even more, runs may be needed. If necessary, +\fIlatexmk\fR will also run bibtex, biber, and/or makeindex. In addition, +\fIlatexmk\fR can be configured to generate other necessary files. +For example, from an updated figure file it can automatically generate +a file in encapsulated postscript or another suitable format for +reading by LaTeX. +.PP +\fILatexmk\fR has two different previewing options. In the simple +\fB-pv\fR option, a dvi, postscript or pdf previewer is automatically +run after generating the dvi, postscript or pdf version of the +document. The type of file to view is selected according to +configuration settings and command line options. +.PP +The second previewing option is the powerful \fB-pvc\fR option +(mnemonic: "preview continuously"). In this case, \fIlatexmk\fR runs +continuously, regularly monitoring all the source files to see if any +have changed. Every time a change is detected, \fIlatexmk\fR runs all +the programs necessary to generate a new version of the document. A +good previewer (like \fIgv\fR) will then automatically update its +display. Thus the user can simply edit a file and, when the changes +are written to disk, \fIlatexmk\fR completely automates the cycle of +updating the .dvi (and possibly the .ps and .pdf) file, and refreshing +the previewer's display. It's not quite WYSIWYG, but usefully close. +.PP +For other previewers, the user may have to manually make the previewer +update its display, which can be (some versions of xdvi and gsview) as +simple as forcing a redraw of its display. +.PP +\fILatexmk\fR has the ability to print a banner in gray diagonally +across each page when making the postscript file. It can also, if +needed, call an external program to do other postprocessing on +generated dvi and postscript files. (See the options \fB-dF\fR and +\fB-pF\fR, and the documentation for the \fI$dvi_filter\fR and +\fI$ps_filter\fR configuration variables.) These capabilities are +leftover from older versions of \fIlatexmk\fR. More flexibility can +be obtained in current versions, since the command strings for running +latex, pdflatex, etc can now be configured to run multiple commands. +This also extends the possibility of postprocessing generated files to +pdf files. +files. +.PP +\fILatexmk\fR is highly configurable, both from the command line and +in configuration files, so that it can accommodate a wide variety of +user needs and system configurations. Default values are set +according to the operating system, so \fIlatexmk\fR often works +without special configuration on MS-Windows, cygwin, Linux, OS-X, and +other UNIX systems (notably Solaris). +.PP +A very annoying complication handled very reliably by \fILatexmk\fR, +is that LaTeX is a multiple pass system. On each run, LaTeX reads in +information generated on a previous run, for things like cross +referencing and indexing. In the simplest cases, a second run of +LaTeX suffices, and often the log file contains a message about the +need for another pass. However, there is a wide variety of add-on +macro packages to LaTeX, with a variety of behaviors. The result is +to break simple-minded determinations of how many runs are needed and +of which programs. In its new version, \fIlatexmk\fR has a highly +general and efficient solution to these issues. The solution involves +retaining between runs information on the source files, and a symptom +is that \fIlatexmk\fR generates an extra file (with extension +\fI.fdb_latexmk\fR, by default) that contains the source file +information. + +.SH LATEXMK OPTIONS AND ARGUMENTS ON COMMAND LINE +In general the command line to invoke \fIlatexmk\fR has the form + + latexmk [options] [file] + +All options can be introduced by single or double "-" characters, +e.g., "latexmk -help" or "latexmk --help". + +\fBNote\fR: In addition to the options in the list below, +\fIlatexmk\fR recognizes almost all the options recognized by the +\fIlatex\fR and \fIpdflatex\fR programs in one of both of their +current TeXLive and MiKTeX implementations. Some of the options for +these programs also trigger special action or behavior by +\fIlatexmk\fR, in which case they are in this list. Otherwise, they +are just passed through to a called \fIlatex\fR or \fIpdflatex\fR +program. Run \fIlatexmk\fR with the \fB-showextraoptions\fR to get a +list of the options that \fIlatexmk\fR accepts and that are simply +passed through to \fIlatex\fR or \fIpdflatex\fR. See also the +explanation of the \fB-showextraoptions\fR option for more +information. + +\fBDefinitions of options and arguments\fR + +.TP +.B file +One or more files can be specified. If no files are specified, +\fIlatexmk\fR will, by default, run on all files in the current working directory +with a ".tex" extension. This behavior can be changed: see the +description concerning the \fI@default_files\fR variable in the +section "List of configuration variables usable in initialization +files". +.PP +If a file is specified without an extension, then the ".tex" extension +is automatically added, just as LaTeX does. Thus, if you specify: + + latexmk foo + +then \fIlatexmk\fR will operate on the file "foo.tex". +.TP + +.B -auxdir=FOO or -aux-directory=FOO + +Sets the directory for auxiliary output files of (pdf)latex +(.aux, .log etc). This +achieves its effect by the \fB-aux-directory\fR option of (pdf)latex, +which currently is only implemented on the MiKTeX version of +(pdf)latex. + +See also the \fB-outdir\fR/\fB-output-directory\fR options, and the +\fI$aux_dir\fR, \fI$out_dir\fR, and \fI$search_path_separator\fR +configuration variables of \fIlatexmk\fR. In particular, see the +documentation of \fI$out_dir\fR for some complications on what +directory names are suitable. + +.TP + +.B -bibtex +When the source file uses bbl files for bibliography, run bibtex or +biber as needed to regenerate the bbl files. + +This property can also be configured by setting the \fI$bibtex_use\fR +variable to 2 in a configuration file +.TP +.B -bibtex- +Never run bibtex or biber. + +A common use for this option is when a document comes from an external +source, complete with its bbl file(s), and the user does not have the +corresponding bib files available. In this situation use of the +\fB-bibtex-\fR option will prevent \fIlatexmk\fR from trying to run +\fIbibtex\fR or \fIbiber\fR, which would result in overwriting of the +bbl files. +.TP +.B -bibtex-cond +When the source file uses bbl file(s) for the bibliography, run +\fIbibtex\fR or \fIbiber\fR as needed to regenerate the bbl files, but +only if the +relevant bib file(s) exist. Thus when the bib files are not +available, \fIbibtex\fR or \fIbiber\fR is not run, thereby avoiding +overwriting of +the bbl file(s). This is the default setting. + +(Note that it is possible for \fIlatexmk\fR to decide that the bib +file does not exist, even though the bib file does exist and +\fIbibtex\fR or \fIbiber\fR finds it. The problem is that the bib +file may not be in +the current directory but in some search path; the places +\fIlatexmk\fR and \fIbibtex\fR or \fIbiber\fR cause to be searched need not be +identical. On modern installations of TeX and related programs this +problem should not arise, since \fIlatexmk\fR uses the \fIkpsewhich\fR +program to do the search, and \fIkpsewhich\fR should use the same +search path as \fIbibtex\fR and \fIbiber\fR. If this problem arises, use the +\fB-bibtex\fR option when invoking \fIlatexmk\fR.) +.TP +.B -bm <message> +A banner message to print diagonally across each page when converting +the dvi file to postscript. The message must be a single argument on +the command line so be careful with quoting spaces and such. + +Note that if the \fB-bm\fR option is specified, the \fB-ps\fR option is +assumed. +.TP +.B -bi <intensity> +How dark to print the banner message. A decimal number between 0 and 1. +0 is black and 1 is white. The default is 0.95, which is OK unless your +toner cartridge is getting low. +.TP +.B -bs <scale> +A decimal number that specifies how large the banner message will be +printed. Experimentation is necessary to get the right scale for your +message, as a rule of thumb the scale should be about equal to 1100 +divided by the number of characters in the message. The default is 220.0 +which is just right for 5 character messages. +.TP +.B -commands +List the commands used by \fIlatexmk\fR for processing files, and then +exit. +.TP +.B -c +Clean up (remove) all regeneratable files generated by \fIlatex\fR and +\fIbibtex\fR or \fIbiber\fR except dvi, postscript and pdf. These files are a +combination of log files, aux files, \fIlatexmk\fR's database file of +source file information, +and those with extensions +specified in the \fI@generated_exts\fR configuration variable. In addition, +files with extensions by the \fI$clean_ext\fR configuration variable are +removed. + +This cleanup is instead of a regular make. See the \fB-gg\fR option +if you want to do a cleanup then a make. + +If \fI$bibtex_use\fR is set to 0 or 1, bbl files are counted as +non-regeneratable. + +If \fI$cleanup_includes_cusdep_generated\fR is nonzero, regeneratable +files are considered as including those generated by custom +dependencies and are also deleted. Otherwise these files are not deleted. +.TP +.B -C +Clean up (remove) all regeneratable files generated by \fIlatex\fR and +\fIbibtex\fR or \fIbiber\fR. This is the same as the \fB-c\fR option with the +addition of dvi, postscript and pdf files, and those with extensions +in the \fI$clean_full_ext\fR configuration variable. + +This cleanup is instead of a regular make. See the \fB-gg\fR option +if you want to do a cleanup than a make. + +If \fI$bibtex_use\fR is set to 0 or 1, bbl files are counted as +non-regeneratable. + +If \fI$cleanup_includes_cusdep_generated\fR is nonzero, regeneratable +files are considered as including those generated by custom +dependencies and are also deleted. Otherwise these files are not deleted. +.TP +.B -CA +(Obsolete). Now equivalent to the \fB-C\fR option. See that option +for details. +.TP +.B -CF +Remove the file containing the database of source file information, +before doing the other actions requested. +.TP +.B -d +Set draft mode. This prints the banner message "DRAFT" across your +page when converting the dvi file to postscript. Size and intensity +can be modified with the \fB-bs\fR and \fB-bi\fR options. The \fB-bm\fR +option will override this option as this is really just a short way of +specifying: + + latexmk -bm DRAFT + +Note that if the \fB-d\fR option is specified, the \fB-ps\fR option is +assumed. +.TP +.B -deps +Show a list of dependent files after processing. This is in the form +of a dependency list of the form used by the \fImake\fR program, and +it is therefore suitable for use in a Makefile. It gives an overall +view of the files without listing intermediate files, as well as +\fIlatexmk\fR can determine them. + +By default the list of dependent files is sent to stdout (i.e., +normally to the screen unless you've redirected \fIlatexmk\fR's +output). But you can set the filename where the list is sent by the +\fB-deps-out=\fR option. + +See the section "USING \fIlatexmk\fR WITH \fImake\fR" for +an example of how to use a dependency list with \fImake\fR. + +Users familiar with GNU \fIautomake\fR and \fIgcc\fR will find that +the \fB-deps\fR option is very similar in its purpose and results to +the \fB-M\fR option to \fIgcc\fR. (In fact, \fIlatexmk\fR also has +options \fB-M\fR, \fB-MF\fR, and \fB-MP\fR options that behave like +those of \fIgcc\fR.) +.TP +.B -dependents +Equivalent to \fB-deps\fR. +.TP +.B -deps- +Do not show a list of dependent files after processing. (This is the +default.) +.TP +.B -dependents- +Equivalent to \fB-deps-\fR. +.TP +.B -deps-out=FILENAME +Set the filename to which the list of dependent files is written. If +the FILENAME argument is omitted or set to "-", then the output is +sent to stdout. + +Use of this option also turns on the output of the list of dependent +files after processing. +.TP +.B -dF +Dvi file filtering. The argument to this option is a filter which will +generate a filtered dvi file with the extension ".dviF". All extra +processing (e.g. conversion to postscript, preview, printing) will then +be performed on this filtered dvi file. + +Example usage: To use dviselect to select only the even pages of the dvi file: + + latexmk -dF "dviselect even" foo.tex +.TP +.B -diagnostics +Print detailed diagnostics during a run. This may help for debugging +problems or to understand \fIlatexmk\fR's behavior in difficult +situations. +.TP +.B -dvi +Generate dvi version of document. +.TP +.B -dvi- +Turn off generation of dvi version of document. (This may get +overridden, if some other file is made (e.g., a .ps file) that is +generated from the dvi file, or if no generated file at all is +requested.) +.TP +.B -e <code> +Execute the specified initialization code before processing. The code +is \fIPerl\fR code of the same form as is used in \fIlatexmk\fR's +initialization files -- for more details, see the information on the +\fB-r\fR option, and the section about "Configuration/initialization +(RC) files". The code is typically a sequence of assignment +statements separated by semicolons. + +The code is executed when the \fB-e\fR option is encountered during +\fIlatexmk\fR's parsing of its command line. See the \fB-r\fR option +for a way of executing initialization code from a file. An error +results in \fIlatexmk\fR stopping. Multiple instances of the \fB-r\fR +and \fB-e\fR options can be used, and they are executed in the order +they appear on the command line. + +Some care is needed to deal with proper quoting of special characters +in the code on the command line. For example, suppose you want +to set the latex command to use its -shell-escape option, then under +UNIX/LINUX you could use the line + + latexmk -e '$latex=q/latex %O -shell-escape %S/' file.tex + +Note that the single quotes block normal UNIX/LINUX command shells +from treating the characters inside the quotes as special. +(In this example, the q/.../ construct is a +\fIPerl\fR idiom equivalent to using +single quotes. This avoids the complications of getting a quote +character inside an already quoted string in a way that is independent +of both the shell and the operating-system.) + +The above command line will NOT work under MS-Windows with cmd.exe or +command.com or 4nt.exe. For MS-Windows with these command shells you +could use + + latexmk -e "$latex=q/latex %O -shell-escape %S/" file.tex + +or + + latexmk -e "$latex='latex %O -shell-escape %S'" file.tex + +The last two examples will NOT work with UNIX/LINUX command shells. +.TP +.B -f +Force \fIlatexmk\fR to continue document processing despite errors. +Normally, when \fIlatexmk\fR detects that LaTeX or another program has +found an error which will not be resolved by further processing, no +further processing is carried out. +.TP +.B -f- +Turn off the forced processing-past-errors such as is set by the +\fB-f\fR option. This could be used to override a setting in a +configuration file. +.TP +.B -g +Force \fIlatexmk\fR to process document fully, even under situations +where \fIlatexmk\fR would normally decide that no changes in the +source files have occurred since the previous run. +This option is useful, for example, if you change some options and +wish to reprocess the files. +.TP +.B -g- +Turn off \fB-g\fR. +.TP +.B -gg +"Super go mode" or "clean make": clean out generated files as if +\fB-C\fR had been given, and then do a regular make. +.TP +.B -h, -help +Print help information. +.TP +.B -jobname=STRING +Set the basename of output files(s) to STRING, instead of the default, +which is the basename of the specified TeX file. + +This is like the same option for current implementations of the +\fIlatex\fR and \fIpdflatex\fR, and the passing of this option to +these programs is part of \fIlatexmk\fR's implementation of +\fB-jobname\fR. + +.TP +.B -l +Run in landscape mode, using the landscape mode for the previewers and +the dvi to postscript converters. This option is not normally needed +nowadays, since current previewers normally determine this information +automatically. +.TP +.B -l- +Turn off \fB-l\fR. +.TP +.B -latex="COMMAND" +This sets the string specifying the command to run latex, and is +typically used to add desired options. Since the string normally +contains spaces, it should be quoted, e.g., + + latex -latex="latex --shell-escape %O %S" foo.tex + +The specification of the contents of the string are the same as for +the \fI$latex\fR configuration variable. Depending on your +operating system and the command-line shell you are using, you may +need to change the single quotes to double quotes (or something +else). + +To set the command for running pdflatex (rather than the command for +latex) see the \fB-pdflatex\fR option. + +Note that the effect of this option can also be achieved by using +the \fB-e\fR option with a suitable line of Perl code to set the +\fI$latex\fR variable. See the explanation of the \fB-e\fR option. +.TP +.B -M +Show list of dependent files after processing. This is equivalent to +the \fB-deps\fR option. +.TP +.B -MF file +If a list of dependents is made, the \fB-MF\fR specifies the file to +write it to. +.TP +.B -MP +If a list of dependents is made, includes phony target for each source +file. If you use the dependents list in a Makefile, the dummy rules +work around errors make gives if you remove header files without +updating the Makefile to match. +.TP +.B -new-viewer +When in continuous-preview mode, always start a new viewer to view the +generated file. By default, \fIlatexmk\fR will, in continuous-preview +mode, test for a previously running previewer for the same file and +not start a new one if a previous previewer is running. However, its +test sometimes fails (notably if there is an already-running previewer +that is viewing a file of the same name as the current file, but in a +different directory). This option turns off the default behavior. +.TP +.B -new-viewer- +The inverse of the \fB-new-viewer\fR option. It puts \fIlatexmk\fR +in its normal behavior that in preview-continuous mode it checks for +an already-running previewer. +.TP +.B -nobibtex +Never run bibtex or biber. + +A common use for this option is when a document comes from an external +source, complete with its bbl file(s), and the user does not have the +corresponding bib files available. In this situation use of the +\fB-nobibtex\fR option will prevent \fIlatexmk\fR from trying to run +\fIbibtex\fR or \fIbiber\fR, which would result in overwriting of the +bbl files. +.TP +.B -norc +Turn off the automatic reading of initialization (rc) files. + +N.B. Normally the initialization files are read and obeyed, and then +command line options are obeyed in the order they are encountered. +Then \fB-norc\fR is an exception to this rule: it is acted on first, +no matter where is occurs on the command line. +.TP + +.B -outdir=FOO or -output-directory=FOO + +Sets the directory for the output files of (pdf)latex. This achieves +its effect by the \fB-output-directory\fR option of (pdf)latex, which +currently (Dec. 2011) is implemented on the common versions of +(pdf)latex, i.e., MiKTeX and TeXLive. It may not be present in other +versions. + +See also the \fB-auxdir\fR/\fB-aux-directory\fR options, and the +\fI$aux_dir\fR, \fI$out_dir\fR, and \fI$search_path_separator\fR +configuration variables of \fIlatexmk\fR. In particular, see the +documentation of \fI$out_dir\fR for some complications on what +directory names are suitable. + +.TP + +.B -p +Print out the document. By default it is +the generated postscript file that is printed. But you can use the +\fB-print=...\fR option to print the dvi or pdf files instead, and you +can configure this in a start up file (by setting the +\fI$print_type\fR variable). + +However, printing is enabled by default only under UNIX/LINUX systems, +where the default is to use the lpr command. In general, the correct +behavior for printing very much depends on your system's software. In +particular, under MS-Windows you must have suitable program(s) +available, and you must have configured the print commands used by +\fIlatexmk\fR. This can be non-trivial. See the documentation on the +\fI$lpr\fR, \fI$lpr_dvi\fR, and \fI$lpr_pdf\fR configuration variables +to see how to set the commands for printing. + +This option is incompatible with the \fB-pv\fR and \fB-pvc\fR options, +so it turns them off. +.TP +.B -pdf +Generate pdf version of document using pdflatex. (See the +\fB-xelatex\fR if you wish to use \fIxelatex\fR to make your pdf +file(s).) +.TP +.B -pdfdvi +Generate pdf version of document from the dvi file, by default using dvipdf. +.TP +.B -pdfps +Generate pdf version of document from the ps file, by default using +ps2pdf. +.TP +.B -pdf- +Turn off generation of pdf version of document. +(This can be used to override a setting in a configuration file. +It may get overridden if some other option requires the generation of +a pdf file.) +.TP +.B -pdflatex="COMMAND" +This sets the string specifying the command to run pdflatex, and is +typically used to add desired options. Since the string normally +contains spaces, it should be quoted, e.g., + + latex -pdf -pdflatex="pdflatex --shell-escape %O %S" foo.tex + +The specification of the contents of the string are the same as for +the \fI$pdflatex\fR configuration variable. Depending on your +operating system and the command-line shell you are using, you may +need to change the single quotes to double quotes (or something +else). + +To set the command for running latex (rather than the command for +pdflatex) see the \fB-latex\fR option. + +Note that the effect of this option can also be achieved by using +the \fB-e\fR option with a suitable line of Perl code to set the +\fI$pdflatex\fR variable. See the explanation of the \fB-e\fR option. +.TP +.B -print=dvi, -print=ps, -print=pdf +Define which kind of file is printed. This option also ensures that +the requisite file is made, and turns on printing. The default is to +print a postscript file. +.TP +.B -ps +Generate postscript version of document. +.TP +.B -ps- +Turn off generation of postscript version of document. +This can be used to override a setting in a configuration file. +(It may get overridden by some other option that requires a postscript +file, for example a request for printing.) +.TP +.B -pF +Postscript file filtering. The argument to this option is a filter +which will generate a filtered postscript file with the extension +".psF". All extra processing (e.g. preview, printing) will then be +performed on this filtered postscript file. + +Example of usage: Use psnup to print two pages on the one page: + + latexmk -ps -pF 'psnup -2' foo.tex + +or + + latexmk -ps -pF "psnup -2" foo.tex + +Whether to use single or double quotes round the "psnup -2" will +depend on your command interpreter, as used by the particular version +of perl and the operating system on your computer. +.TP +.B -pv +Run file previewer. If the \fB-view\fR option is used, this will select +the kind of file to be previewed (dvi, ps or pdf). +Otherwise the viewer views the "highest" kind of file selected, by the +\fB-dvi\fR, \fB-ps\fR, \fB-pdf\fR, \fB-pdfps\fR options, in the +order dvi, ps, pdf (low to high). +If no file type has been selected, the dvi previewer will be used. +This option is incompatible with the \fB-p\fR and \fB-pvc\fR options, +so it turns them off. +.TP +.B -pv- +Turn off \fB-pv\fR. +.TP +.B -pvc +Run a file previewer and continually update the .dvi, .ps, and/or .pdf +files whenever changes are made to source files (see the Description +above). Which of these files is generated and which is viewed is +governed by the other options, and is the same as for the \fB-pv\fR +option. +The preview-continuous option \fB-pvc\fR can only work with one file. +So in this case you will normally only specify one filename on +the command line. It is also incompatible with the +\fB-p\fR and \fB-pv\fR options, so it turns these options off. + +The \fB-pvc\fR option also turns off force mode (\fB-f\fR), as is +normally best for continuous preview mode. If you really want force +mode, use the options in the order \fB-pvc -f\fR. + +With a good previewer the display will be automatically updated. +(Under \fIsome but not all\fR versions of UNIX/Linux "gv -watch" does +this for postscript files; this can be set by a configuration +variable. This would also work for pdf files except for an apparent +bug in gv that causes an error when the newly updated pdf file is +read.) Many other previewers will need a manual update. + +\fBImportant note\fR: the acroread program on MS-Windows locks the pdf file, +and prevents new versions being written, so it is a bad idea to use +acroread to view pdf files in preview-continuous mode. +It is better to use a different viewer: SumatraPDF and gsview are +good possibilities. + +There are some other methods for arranging an update, notably useful +for many versions of xdvi and xpdf. These are best set in +\fIlatexmk\fR's configuration; see below. + +Note that if \fIlatexmk\fR dies or is stopped by the user, the +"forked" previewer will continue to run. Successive invocations with +the \fB-pvc\fR option will not fork new previewers, but \fIlatexmk\fR +will normally use the existing previewer. (At least this will happen +when \fIlatexmk\fR is running under an operating system where it knows +how to determine whether an existing previewer is running.) +.TP +.B -pvc- +Turn off \fB-pvc\fR. +.TP +.B -quiet +Same as -silent +.TP +.B -r <rcfile> +Read the specified initialization file ("RC file") before processing. + +Be careful about the ordering: (1) Standard initialization files -- +see the section below on "Configuration/initialization (RC) files" -- +are read first. (2) Then the options on the command line are acted on +in the order they are given. Therefore if an initialization file is +specified by the \fB-r\fR option, it is read during this second step. +Thus an initialization file specified with the \fB-r\fR option can +override both the standard initialization files and \fIpreviously\fR +specified options. But all of these can be overridden by \fIlater\fR +options. + +The contents of the RC file just comprise a piece of code in the +\fIPerl\fR programming language +(typically a sequence of assignment statements); they are executed +when the \fB-r\fR option is encountered during \fIlatexmk\fR's parsing +of its command line. See the \fB-e\fR option for a way of giving +initialization code directly on \fIlatexmk\fR's command line. An +error results in \fIlatexmk\fR stopping. Multiple instances of the +\fB-r\fR and \fB-e\fR options can be used, and they are executed in +the order they appear on the command line. +.TP +.B -recorder +Use the -recorder option with \fIlatex\fR and \fIpdflatex\fR. In +(most) modern versions of these programs, this results in a file of +extension \fI.fls\fR containing a list of the files that these +programs have read and written. \fILatexmk\fR will then use this file +to improve its detection of source files and generated files after a +run of \fIlatex\fR or \fIpdflatex\fR. + +For further information, see the documentation for the \fI$recorder\fR +configuration variable. +.TP +.B -recorder- +Do not use the -recorder option with \fIlatex\fR and \fIpdflatex\fR. +.TP +.B -rules +Show a list of \fIlatemk\fR's rules and dependencies after processing. +.TP +.B -rules- +Do not show a list of \fIlatexmk\fR's rules and dependencies after +processing. (This is the default.) +.TP +.B -showextraoptions +Show the list of extra \fIlatex\fR and \fIpdflatex\fR options that +\fIlatexmk\fR recognizes. These are options for the \fIlatex\fR and +\fIpdflatex\fR that \fIlatexmk\fR recognizes, but simply passes +through to these programs when they are run. These options are +(currently) a combination of those allowed by the TeXLive and MiKTeX +implementations. (If a particular option is given to \fIlatexmk\fR +but is not handled by the particular implementation of \fIlatex\fR or +\fIpdflatex\fR that is being used, that program will probably give an +error message.) These options are very numerous, but are not listed +in this documentation because they have no effect on \fIlatexmk\fR's +actions. + +There are a few options (\fB-includedirectory=dir\fR, +\fB-initialize\fR, \fB-ini\fR) that are not recognized, either because +they don't fit with \fIlatexmk\fR's intended operations, or because +they need special processing by \fIlatexmk\fR that isn't implemented +(at least, not yet). + +There are also options that are accepted by \fIlatex\fR etc, but +instead trigger actions by \fIlatexmk\fR: \fB-help\fR, +\fB-version\fR. + +Finally, there are certain options for \fIlatex\fR and \fIpdflatex\fR +(e.g., \fB-recorder\fR) that trigger special actions or behavior by +\fIlatexmk\fR itself as well as being passed in some form to the +called \fIlatex\fR and \fIpdflatex\fR program, or that affect other +programs as well. These options do have entries in this +documentation. These options are: +\fB-jobname=STRING\fR, \fB-aux-directory=dir\fR, +\fB-output-directory=DIR\fR, \fB-quiet\fR, and \fB-recorder\fR. + +.TP +.B -silent +Run commands silently, i.e., with options that reduce the amount of +diagnostics generated. For example, with the default settings, the +command "latex -interaction=batchmode" is used for latex. + +Also reduce the number of informational messages that \fIlatexmk\fR +generates. + +To change the options used to make the commands run silently, you need +to configure \fIlatexmk\fR with changed values of its configuration +variables, the relevant ones being \fI$bibtex_silent_switch\fR, +\fI$biber_silent_switch\fR, \fI$dvipdf_silent_switch\fR, +\fI$dvips_silent_switch\fR, \fI$latex_silent_switch\fR, +\fI$makeindex_silent_switch\fR, and \fI$pdflatex_silent_switch\fR. +.TP +.B -use-make +When after a run of \fIlatex\fR or \fIpdflatex\fR, there are warnings +about missing files (e.g., as requested by the LaTeX \\input, \\include, +and \\includgraphics), \fIlatexmk\fR tries to make them by a custom +dependency. If no relevant custom dependency with an appropriate +source file is found, and if the -use-make option is set, then +\fIlatexmk\fR will try as a resort using the make program to try to +make the missing files. + +Note that the filename may be specified without an extension, e.g., +by \\includegraphics{drawing} in a LaTeX file. In that case, +\fIlatexmk\fR will try making drawing.ext with ext set in turn to the +possible extensions that are relevant for \fIlatex\fR (or as +appropriate \fIpdflatex\fR). + +See also the documentation for the \fI$use_make_for_missing_files\fR +configuration variable. +.TP +.B -use-make- +Do not use the make program to try to make missing files. (Default.) +.TP +.B -v, -version +Print version number of \fIlatexmk\fR. +.TP +.B -verbose +Opposite of \fB-silent\fR. This is the default setting. +.TP +.B -view=default, -view=dvi, -view=ps, -view=pdf +Set the kind of file used when previewing is requested (e.g., by the +\fB-pv\fR or \fB-pvc\fR switches). The default is to view the "highest" +kind of requested file (in the order dvi, ps, pdf). +.TP +.B -xelatex +Use xelatex. That is, use xelatex to process the source file(s) to +pdf (in place of pdflatex). This option is exactly equivalent to +specifying the following sequence of options: + + -pdflatex="xelatex %O %S" -pdf -dvi- -ps + +.PP +The preview-continuous option \fB-pvc\fR can only work with one file. +So in this case you will normally only specify one filename on +the command line. +.PP +Options \fB-p\fR, \fB-pv\fR and \fB-pvc\fR are mutually exclusive. So +each of these options turns the others off. + +.SH EXAMPLES +.nf +.ta 2i +% \fBlatexmk thesis\fR \fI# run latex enough times to resolve + cross-references\fR + +% \fBlatexmk -pvc -ps thesis\fR \fI# run latex enough times to resolve + cross-references, make a postscript + file, start a previewer. Then + watch for changes in the source + file thesis.tex and any files it + uses. After any changes rerun latex + the appropriate number of times and + remake the postscript file. If latex + encounters an error, latexmk will + keep running, watching for + source file changes. + +% \fBlatexmk -c\fR \fI# remove .aux, .log, .bbl, .blg, .dvi, + .pdf, .ps & .bbl files\fR + + +.SH CONFIGURATION/INITIALIZATION (RC) FILES +.PP +\fILatexmk\fR can be customized using initialization files, which are +read at startup in the following order: +.PP +1) The system RC file, if it exists. + On a UNIX system, \fIlatexmk\fR searches for following places for its +system RC file, in the following order, and reads the first it finds: + "/opt/local/share/latexmk/LatexMk", + "/usr/local/share/latexmk/LatexMk", + "/usr/local/lib/latexmk/LatexMk". + On a MS-WINDOWS system it looks for "C:\\latexmk\\LatexMk". + On a cygwin system (i.e., a MS-Windows system in which perl is +that of cygwin), \fIlatexmk\fR reads for the first it finds of + "/cygdrive/c/latexmk/LatexMk", + "/opt/local/share/latexmk/LatexMk", + "/usr/local/share/latexmk/LatexMk", + "/usr/local/lib/latexmk/LatexMk". +.PP +2) The user's RC file, "$HOME/.latexmkrc", if it exists. Here $HOME +is the user's home directory. [\fILatexmk\fR determines the user's +home directory as follows: It is the value of the environment variable +HOME, if this variable exists, which normally is the case on UNIX-like +systems (including LINUX and OS-X). Otherwise the environment +variable USERPROFILE is used, if it exists, which normally is the case +on MS-Windows systems. Otherwise a blank string is used instead of $HOME.] +.PP +3) The RC file in the current working directory. This file can be +named either "latexmkrc" or ".latexmkrc", and the first of these to be +found is used, if any. +.PP +4) Any RC file(s) specified on the command line with the \fB-r\fR option. +.PP +Each RC file is a sequence of \fIPerl\fR commands. Naturally, a user can use +this in creative ways. But for most purposes, one simply uses a +sequence of assignment statements that override some of the built-in +settings of \fILatexmk\fR. Straightforward cases can be handled +without knowledge of the \fIPerl\fR language by using the examples in this +document as templates. Comment lines are introduced by the "#" +character. + +Note that command line options are obeyed in the order in which +they are written; thus any RC file specified on the command line with +the \fB-r\fR option can override previous options but can be itself +overridden by later options on the command line. There is also the +\fB-e\fR option, which allows initialization code to be specified in +\fIlatexmk\fR's command line. + +\fI +For possible examples of code for in an RC file, see the directory +example_rcfiles in the distribution of latexmk (e.g., at +http://ctan.tug.org/tex-archive/support/latexmk/example_rcfiles). +\fR + +.SH HOW TO SET VARIABLES IN INITIALIZATION FILES +.PP +The important variables that can be configured are described in the +section "List of configuration variables usable in initialization +files". Syntax for setting these variables is of the following forms: +.PP + $bibtex = 'bibtex %O %B'; +.PP +for the setting of a string variable, +.PP + $preview_mode = 1; +.PP +for the setting of a numeric variable, and +.PP + @default_files = ('paper', 'paper1'); +.PP +for the setting of an array of strings. It is possible to append an +item to an array variable as follows: + + push @default_files, 'paper2'; + +Note that simple "scalar" variables have names that begin with a $ +character and array variables have names that begin with a @ +character. Each statement ends with a semicolon. + +Strings should be enclosed in single quotes. (You could use double +quotes, as in many programming languages. But then the \fIPerl\fR +programming language brings into play some special rules for +interpolating variables into strings. People not fluent in \fIPerl\fR +will want to avoid these complications.) + +You can do much more complicated things, but for this you will need to +consult a manual for the \fIPerl\fR programming language. + + + +.SH FORMAT OF COMMAND SPECIFICATIONS + +Some of the variables set the commands that \fIlatexmk\fR uses for +carrying out its work, for example to generate a dvi file from a tex +file or to view a postscript file. This section describes some +important features of how the commands are specified. + +\fBPlaceholders\fR: Supposed you wanted \fIlatexmk\fR to use the +command elatex in place of the regular latex command, and suppose +moreover that you wanted to give it the option "--shell-escape". You +could do this by the following setting: +.PP + $latex = 'elatex --shell-escape %O %S'; +.PP +The two items starting with the % character are placeholders. These +are substituted by appropriate values before the command is run. Thus +%S will be replaced by the source file that elatex will be applied to, +and %O will be replaced by any options that \fIlatexmk\fR has decided +to use for this command. (E.g., if you used the -silent option it +would replace %O by "-interaction=batchmode".) + +The available placeholders are: +.TP +.B %B +base of filename for current command. E.g., if a postscript file +document.ps is being made from the dvi file document.dvi, then the +basename is document. +.TP +.B %D +destination file (e.g., the name of the postscript file when +converting a dvi file to postscript). +.TP +.B %O +options +.TP +.B %R +root filename. This is the base name for the main tex file. +.TP +.B %S +source file (e.g., the name of the dvi file when converting a dvi file +to ps). +.TP +.B %T +The name of the primary tex file. +.TP +.B %Y +Name of directory for auxiliary output files (see the configuration +variable \fI$aux_dir\fR). A directory separation character ('/') is +appended if \fI$aux_dir\fR is non-empty and does not end in a suitable +character, with suitable characters being those appropriate to UNIX +and MS-Windows, i.e., ':', '/' and '\\'. +.TP +.B %Z +Name of directory for output files (see the configuration +variable \fI$out_dir\fR). A directory separation character ('/') is +appended if \fI$out_dir\fR is non-empty and does not end in a suitable +character, with suitable characters being those appropriate to UNIX +and MS-Windows, i.e., ':', '/' and '\\'. +.PP +If for some reason you need a literal % character in your string not +subject to the above rules, use a pair of these characters. Thus with +the command specification $ps_previewer = 'latex -ad=%%Sfile.ad %S', +the %%S will become %S when the command is executed, but the %S will +be replaced by the source filename, which in this case would be the +name of a postscript file to be viewed. +.PP +Appropriate quoting will be applied to the filename substitutions, so +you mustn't supply them yourself even if the names of your files have +spaces in them. (But if your TeX filenames have spaces in them, +beware that many versions of the TeX program cannot correctly handle +filenames containing spaces.) In case latexmk's quoting does not work +correctly on your system, you can turn it off -- see the documentation +for the variable \fI$quote_filenames\fR. +.PP +The distinction between %B and %R needs a bit of care, since they are +often the same, but not always. For example on a simple document, the +basename of a bibtex run is the same as for the texfile. But in a +document with several bibliographies, the bibliography files will have +a variety of names. Since bibtex is invoked with the basename of the +bibliography file, the setting for the bibtex command should therefore +be +.PP + $bibtex = 'bibtex %O %B'; +.PP +Generally, you should use %B rather than %R. Similarly for most +purposes, the name %T of the primary texfile is not a useful +placeholder. + +See the default values in the section "List of configuration variables +usable in initialization files" for what is normally the most +appropriate usage. + +If you omit to supply any placeholders whatever in the specification +of a command, \fIlatexmk\fR will supply what its author thinks are +appropriate defaults. This gives compatibility with configuration +files for previous versions of \fIlatexmk\fR, which didn't use +placeholders. + +\fB"Detaching" a command\fR: Normally when \fIlatexmk\fR runs a +command, it waits for the command to run to completion. This is +appropriate for commands like latex, of course. But for previewers, +the command should normally run detached, so that \fIlatexmk\fR gets +the previewer running and then returns to its next task (or exits if +there is nothing else to do). To achieve this effect of detaching a +command, you need to precede the command name with "start ", as in +.PP + $dvi_previewer = 'start xdvi %O %S'; +.PP +This will be translated to whatever is appropriate for your operating +system. + +Notes: (1) In some circumstances, \fIlatex\fR will always run a +command detached. This is the case for a previewer in preview +continuous mode, since otherwise previewing continuously makes no +sense. (2) This precludes the possibility of running a command named +start. (3) If the word start occurs more than once at the beginning +of the command string, that is equivalent to having just one. (4) +Under cygwin, some complications happen, since cygwin amounts to a +complicated merging of UNIX and MS-Windows. See the source code for +how I've handled the problem. + +\fBCommand names containing spaces\fR: Under MS-Windows it is common +that the name of a command includes spaces, since software is often +installed in a subdirectory of "C:\\Program Files". Such command names +should be enclosed in double quotes, as in +.PP + $lpr_pdf = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p %S'; + $pdf_previewer = 'start "c:/Program Files/SumatraPDF/SumatraPDF.exe" %O %S'; + $pdf_previewer = 'start "c:/Program Files/SumatraPDF (x86)/SumatraPDF.exe" %O %S'; + +.PP +(Note about the above example: Forward slashes are equivalent to +backslashes in filenames under MS-Windows, provided that the filename +is inside double quotes. It is easier to use forward slashes in +examples like the one above, since then one does not have to worry +about the rules for dealing with forward slashes in strings in the +Perl language.) + +\fBCommand names under Cygwin\fR: If latexmk is executed by Cygwin's +perl, \fI be particularly certain that pathnames in commands have +\fBforward\fI slashes\fR not the usual backslashes for the separator +of pathname components. See the above examples. Backslashes often +get misinterpreted by the Unix shell used by Cygwin's Perl to execute +external commands. Forward slashes don't suffer from this problem, +and (when quoted, as above) are equally acceptable to MS-Windows. + +\fBUsing MS-Windows file associations\fR: A useful trick under modern +versions of MS-Windows (e.g., WinXP) is to use just the +command 'start' by itself: +.PP + $dvi_previewer = 'start %S'; +.PP +Under recent versions of MS-Windows, this will cause to be run +whatever program the system has associated with dvi files. (The same +applies for a postscript viewer and a pdf viewer.) But note that this +trick is not always suitable for the pdf previwer, if your system has +acroread for the default pdf viewer. As explained elsewhere, acroread +under MS-Windows does not work well with \fIlatex\fR and +\fIlatexmk\fR, because acroread locks the pdf file. + +\fBNot using a certain command\fR: If a command is not to be run, the +command name NONE is used, as in +.PP + $lpr = 'NONE lpr'; +.PP +This typically is used when an appropriate command does not exist on +your system. The string after the "NONE" is effectively a comment. + +\fBOptions to commands\fR: +Setting the name of a command can be used not only for changing the +name of the command called, but also to add options to command. +Suppose you want \fIlatexmk\fR to use latex with source specials +enabled. Then you might use the following line in an initialization +file: +.PP + $latex = 'latex --src-specials %O %S'; +.PP + +\fBRunning a subroutine instead of an external command\fR: Use a +specification starting with "internal", as in +.PP + $latex = 'internal mylatex %O %S'; + sub mylatex { + my @args = @_; + # Possible preprocessing here + return system 'latex', @args; + } +.PP + +\fBAdvanced tricks\fR: Normally one specifies a single command for the +commands invoked by \fIlatexmk\fR. Naturally, if there is some +complicated additional processing you need to do in your special +situation, you can write a script (or batch file) to do the +processing, and then configure \fIlatexmk\fR to use your script in +place of the standard program. + +It is also possible to configure \fIlatexmk\fR to run multiple +commands. For example, if when running pdflatex to generate a pdf +file from a tex file you need to run another program after pdflatex to +perform some extra processing, you could do something like: + + $pdflatex = 'pdflatex --shell-escape %O %S; pst2pdf_for_latexmk %B'; + +This definition assumes you are using a UNIX-like system (which +includes Linux and OS-X), so that the +two commands to be run are separated by the semicolon in the middle of +the string. + +If you are using MS-Windows, you would replace the above line by + + $pdflatex = 'cmd /c pdflatex --shell-escape %O %S' + . '&& pst2pdf_for_latexmk %B'; + +Here, the UNIX command separator ; is replaced by &&. In addition, +there is a problem that some versions of \fIPerl\fR on MS-Windows do +not obey the command separator; this problem is overcome by explicitly +invoking the MS-Windows command-line processor \fIcmd.exe\fR. + +.SH LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES +.PP +Default values are indicated in brackets. +.TP +.B $always_view_file_via_temporary [0] +Whether ps and pdf files are initially to be made in a temporary +directory and then moved to the final location. (This applies to +dvips, dvipdf, and ps2pdf operations, and the filtering operators on +dvi and ps files. It does not apply to pdflatex, unfortunately.) + +This use of a temporary file solves a problem that the making of these +files can occupy a substantial time. If a viewer sees that the file +has changed, it reads the new file, and this can cause havoc if the +program writing the file has not yet finished its work. + +See the \fI$pvc_view_file_via_temporary\fR variable for a setting that +applies only if preview-continuous mode (-pvc option) is used. See +\fI$tmpdir\fR for the setting of the directory where the temporary +file is created. + +.TP +.B $auto_rc_use [1] +Whether to automatically read the standard initialization (rc) files, +which are the system RC file, the user's RC file, and the RC file in +the current directory. The command line option \fB-norc\fR can be +used to turn this setting off. Each RC file could also turn this +setting off, i.e., it could set \fI$auto_rc_use\fR to zero to prevent +automatic reading of the later RC files. + +This variable does not affect the reading of RC files specified on the +command line by the \fB-r\fR option. + +.TP +.B $aux_dir [""] +The directory in which auxiliary files (aux, log, etc) are to be +written by a run of (pdf)latex. If this variable is not set, but +\fI$out_dir\fR is set, then \fI$aux_dir\fR is set to \fI$out_dir\fR, +which is the directory to which general output files are to be +written. + +\fBImportant note\fR: The effect of \fI$aux_dir\fR, if different from +\fI$out_dir\fR, is achieved by giving (pdf)latex the +\fB-aux-directory\fR. Currently (Dec. 2011) this only works on the +MiKTeX version of (pdf)latex. + +See also the documentation of \fI$out_dir\fR for some complications on +what directory names are suitable. + +.TP +.B $banner [0] +If nonzero, the banner message is printed across each page when +converting the dvi file to postscript. Without modifying the variable +\fI$banner_message\fR, this is equivalent to specifying the \fB-d\fR +option. + +Note that if \fB$banner\fR is nonzero, the \fB$postscript_mode\fR is +assumed and the postscript file is always generated, even if it is newer +than the dvi file. +.TP +.B $banner_intensity [0.95] +Equivalent to the \fB-bi\fR option, this is a decimal number between 0 +and 1 that specifies how dark to print the banner message. 0 is black, +1 is white. The default is just right if your toner cartridge isn't +running too low. +.TP +.B $banner_message ["DRAFT"] +The banner message to print across each page when converting the dvi +file to postscript. This is equivalent to the \fB-bm\fR option. +.TP +.B $banner_scale [220.0] +A decimal number that specifies how large the banner message will be +printed. Experimentation is necessary to get the right scale for your +message, as a rule of thumb the scale should be about equal to 1100 +divided by the number of characters in the message. The Default is +just right for 5 character messages. This is equivalent to the +\fB-bs\fR option. +.TP +.B @BIBINPUTS +This is an array variable, now mostly obsolete, that specifies +directories where +\fIlatexmk\fR should look for .bib files. By default it is set from +the BIBINPUTS environment variable of the operating system. If that +environment variable is not set, a single element list consisting of +the current directory is set. The format of the directory names +depends on your operating system, of course. Examples for setting +this variable are: + + @BIBINPUTS = ( ".", "C:\\bibfiles" ); + @BIBINPUTS = ( ".", "\\\\server\\bibfiles" ); + @BIBINPUTS = ( ".", "C:/bibfiles" ); + @BIBINPUTS = ( ".", "//server/bibfiles" ); + @BIBINPUTS = ( ".", "/usr/local/texmf/bibtex/bib" ); + +Note that under MS Windows, either a forward slash "/" or a backward +slash "\(rs" can be used to separate pathname components, so the first +two and the second two examples are equivalent. Each backward slash +should be doubled to avoid running afoul of \fIPerl\fR's rules for writing +strings. + +\fIImportant note:\fR This variable is now mostly obsolete in the +current version of \fIlatexmk\fR, +since it has a better method of searching for files using the +kpsewhich command. However, if your system is an unusual one without +the kpsewhich command, you may need to set the variable \fI@BIBINPUTS\fR. +.TP +.B $biber ["biber %O %S"] +The biber processing program. +.TP +.B $biber_silent_switch ["--onlylog"] +\fBSwitch(es)\fR for the biber processing program when silent mode is on. +.TP +.B $bibtex ["bibtex %O %S"] +The BibTeX processing program. +.TP +.B $bibtex_silent_switch ["-terse"] +\fBSwitch(es)\fR for the BibTeX processing program when silent mode is on. +.TP +.B $bibtex_use [1] +Under what conditions to run BibTeX or biber. When \fIlatexmk\fR discovers +from the log file that one (or more) BibTeX/biber-generated bibliographies +are used, it can run BibTeX or biber whenever it appears necessary to +regenerate the bbl file(s) from their source bib database file(s). + +But sometimes, the bib file(s) are not available (e.g., for a document +obtained from an external archive), but the bbl files are provided. +In that case use of BibTeX or biber will result in incorrect +overwriting of the precious bbl files. The variable \fI$bibtex_use\fR +controls whether this happens. Its possible values are: 0: never use +BibTeX or biber. 1: only use BibTeX or biber if the bib files exist. +2: run BibTeX or biber whenever it appears necessary to update the bbl +files, without testing for the existence of the bib files. +.TP +.B $cleanup_includes_cusdep_generated [0] +If nonzero, specifies that cleanup also deletes files that are +generated by custom dependencies. +(When doing a clean up, e.g., by use of the \fB-C\fR option, custom +dependencies are those listed in the \fI.fdb_latexmk\fR file from a +previous run.) +.TP +.B $cleanup_includes_generated [0] +If nonzero, specifies that cleanup also deletes files that are +detected in log file as being generated (see the \\openout lines in +the log file). It will also include files made from these first +generation generated files. +.TP +.B $cleanup_mode [0] +If nonzero, specifies cleanup mode: 1 for full cleanup, 2 for cleanup +except for dvi, ps and pdf files, 3 for cleanup except for dep and aux +files. (There is also extra cleaning as specified by the +\fI$clean_ext\fR, \fI$clean_full_ext\fR and \fI@generated_exts\fR +variables.) + +This variable is equivalent to specifying one of +the \fB-c\fR or \fB-C\fR options. But there should be no need +to set this variable from an RC file. +.TP +.B $clean_ext [""] +Extra extensions of files for \fIlatexmk\fR to remove when any of the +clean-up options (\fB-c\fR or \fB-C\fR) is selected. +The value of this variable is a string containing the extensions +separated by spaces. + +It is also possible to specify a more general pattern of file to be +deleted, by using the place holder %R, as in commands. Thus setting + + $clean_ext = "out %R-blx.bib"; + +in an initialization file will imply that when a clean-up operation is +specified, not only is the standard set of files deleted, but also +files of the form FOO.out and FOO-blx.bib, where FOO stands for the +basename of the file being processed (as in FOO.tex). + +.TP +.B $clean_full_ext [""] +Extra extensions of files for \fIlatexmk\fR to remove when the \fB-C\fR +option is selected, i.e., extensions of files to remove when the .dvi, +etc files are to be cleaned-up. + +More general patterns are allowed, as for \fI$clean_ext\fR. + +.TP +.B $compiling_cmd [undefined], $failure_cmd [undefined], $success_cmd [undefined] + +These variables specify commands that are executed at certain points +of compilations during preview-continuous mode. One motivation for +their existance is to allow convenient visual indications of +compilation status even when the window receiving the screen output of +the compilation is hidden. + +The commands are executed at the following points: +$compiling_cmd at the start of compilation, $success_cmd at the end of +a successful compilation, and $failure_cmd at the end of an +unsuccessful compilation. If any of above variables is undefined (the +default situation) or blank, then the corresponding command is not +executed. + +An example of a typical setting of these variables is as follows + + $compiling_cmd = "xdotool search --name \\"%D\\" set_window --name \\"%D compiling\\""; + $success_cmd = "xdotool search --name \\"%D\\" set_window --name \\"%D OK\\""; + $failure_cmd = "xdotool search --name \\"%D\\" set_window --name \\"%D FAILURE\\""; + +These assume that the program \fIxdotool\fR is installed, that the +previewer is using an X-Window system for display, and that the title +of the window contains the name of the displayed file, as it normally +does. When the commands are executed, the placeholder string %D is replaced by +the name of the destination file, which is the previewed file. The +above commands result in an appropriate string being appended to the +filename in the window title: " compiling", " OK", or " FAILURE". + +Other placeholders that can be used are %S, %T, and %R, with %S and %T +normally being identical. These can be useful for a command changing +the title of the edit window. The visual indication in a window title +can useful, since the user does not have to keep shifting attention to +the (possibly hidden) compilation window to know the status of the +compilation. + +.TP +.B @cus_dep_list [()] +Custom dependency list -- see section on "Custom Dependencies". + +.TP +.B @default_files [("*.tex")] +Default list of files to be processed. + +Normally, if no filenames are specified on the command line, +\fIlatexmk\fR processes all tex files specified in the \fI@default_files\fR +variable, which by default is set to all tex files ("*.tex") in the +current directory. This is a convenience: just run \fIlatexmk\fR and +it will process an appropriate set of files. But sometimes you want +only some of these files to be processed. In this case you set the +\fI@default_files\fR in an initialization file +(e.g., the file "latexmkrc" in the current directory). Then if no +files are specified on the command line then the files you specify by +setting \fI@default_files\fR are processed. + +Three examples: + + @default_files = ("paper_current"); + + @default_files = ("paper1", "paper2.tex"); + + @default_files = ("*.tex", "*.dtx"); + +Note that more than file may be given, and that the default extension +is ".tex". Wild cards are allowed. The parentheses are because +\fI@default_files\fR is an array variable, i.e., a sequence of +filename specifications is possible. +.TP +.B $dependents_phony [0] +If a list of dependencies is output, this variable determines whether +to include a phony target for each source file. If you use the +dependents list in a Makefile, the dummy rules work around errors make +gives if you remove header files without updating the Makefile to +match. +.TP +.B $dependents_list [0] +Whether to display a list(s) of dependencies at the end of a run. +.TP +.B $dvi_filter [empty] +The dvi file filter to be run on the newly produced dvi file before +other processing. Equivalent to specifying the \fB-dF\fR option. +.TP +.B $dvi_mode [See below for default] +If nonzero, generate a dvi version of the document. +Equivalent to the \fB-dvi\fR option. + +The variable $dvi_mode defaults to 0, but if no explicit requests are +made for other types of file (postscript, pdf), then $dvi_mode will be +set to 1. In addition, if a request for a file for which a .dvi file +is a prerequisite, then $dvi_mode will be set to 1. +.TP +.B $dvi_previewer ["start xdvi %O %S" under UNIX] +The command to invoke a dvi-previewer. +[Default is "start" under MS-WINDOWS; under more recent versions of +Windows, this will cause to be run whatever command the system has +associated with .dvi files.] + +\fBImportant note\fR: Normally you will want to have a previewer run +detached, so that \fIlatexmk\fR doesn't wait for the previewer to +terminate before continuing its work. So normally you should prefix +the command by "start ", which flags to \fIlatexmk\fR that it should +do the detaching of the previewer itself (by whatever method is +appropriate to the operating system). But sometimes letting +\fIlatexmk\fR do the detaching is not appropriate (for a variety of +non-trivial reasons), so you should put the "start " bit in +yourself, whenever it is needed. + +.TP +.B $dvi_previewer_landscape ["start xdvi %O %S"] +The command to invoke a dvi-previewer in landscape mode. +[Default is "start" under MS-WINDOWS; under more recent versions of +Windows, this will cause to be run whatever command the system has +associated with .dvi files.] +.TP +.B $dvipdf ["dvipdf %O %S %D"] +Command to convert dvi to pdf file. A common reconfiguration is to +use the dvipdfm command, which needs its arguments in a different order: + + $dvipdf = "dvipdfm %O -o %D %S"; + +WARNING: The default dvipdf script generates pdf files with bitmapped +fonts, which do not look good when viewed by acroread. That script +should be modified to give dvips the options "-P pdf" to ensure that +type 1 fonts are used in the pdf file. +.TP +.B $dvipdf_silent_switch ["-q"] +Switch(es) for dvipdf program when silent mode is on. + +N.B. The standard dvipdf program runs silently, so adding the silent +switch has no effect, but is actually innocuous. But if an +alternative program is used, e.g., dvipdfmx, then the silent switch +has an effect. The default setting is correct for dvipdfm and dvipdfmx. +.TP +.B $dvips ["dvips %O -o %D %S"] +The program to used as a filter to convert a .dvi file to a .ps file. +If pdf is going to be generated from pdf, then the value of the +$dvips_pdf_switch -- see below -- will be included in the options +substituted for "%O". +.TP +.B $dvips_landscape ["dvips -tlandscape %O -o %D %S"] +The program to used as a filter to convert a .dvi file to a .ps file +in landscape mode. +.TP +.B $dvips_pdf_switch ["-P pdf"] +Switch(es) for dvips program when pdf file is to be generated from +ps file. +.TP +.B $dvips_silent_switch ["-q"] +Switch(es) for dvips program when silent mode is on. +.TP +.B $dvi_update_command [""] +When the dvi previewer is set to be updated by running a command, this +is the command that is run. See the information for the variable +\fI$dvi_update_method\fR for further information, and see information +on the variable \fI$pdf_update_method\fR for an example for the +analogous case of a pdf previewer. +.TP +.B $dvi_update_method [2 under UNIX, 1 under MS-Windows] +How the dvi viewer updates its display when the dvi file has changed. +The values here apply equally to the \fI$pdf_update_method\fR and to +the \fI$ps_update_method\fR variables. + 0 => update is automatic, + 1=> manual update by user, which may only mean a mouse click on the +viewer's window or may mean a more serious action. + 2 => Send the signal, whose number is in the variable +\fI$dvi_update_signal\fR. The default value under UNIX is +suitable for xdvi. + 3 => Viewer cannot do an update, because it locks the file. (As with +acroread under MS-Windows.) + 4 => run a command to do the update. The command is specified by +the variable \fI$dvi_update_command\fR. + +See information on the variable \fI$pdf_update_method\fR for an +example of updating by command. +.TP +.B $dvi_update_signal [Under UNIX: SIGUSR1, which is a system-dependent value] +The number of the signal that is sent to the dvi viewer when it is +updated by sending a signal -- see the information on the variable +\fI$dvi_update_method\fR. The default value is the one appropriate +for xdvi on a UNIX system. +.TP +.B $failure_cmd [undefined] +See the documentation for $compiling_cmd. +.TP +.B $fdb_ext ["fdb_latexmk"] +The extension of the file which \fIlatexmk\fR generates to contain a +database of information on source files. You will not normally need +to change this. +.TP +.B $force_mode [0] +If nonzero, continue processing past minor \fIlatex\fR errors +including unrecognized cross references. Equivalent to specifying the +\fB-f\fR option. +.TP +.B @generated_exts [( "aux", "bbl", "idx", "ind", "lof", "lot", "out", "toc", $fdb_ext )] +This contains a list of extensions for files that are generated during +a LaTeX run and that are read in by LaTeX in later runs, either +directly or indirectly. + +This list has two uses: (a) to set the kinds of file to be deleted in +a cleanup operation (with the \fB-c\fR, \fB-C\fR, \fB-CA\fR, \fB-g\fR +and \fB-gg\fR options), and (b) in the determination of whether a +rerun of (pdf)LaTeX is needed after a run that gives an error. + +(Normally, a change of a source file during a run should provoke a +rerun. This includes a file generated by LaTeX, e.g., an aux file, +that is read in on subsequent runs. But after a run that results in +an error, a new run should occur until the user has made a change in +the files. But the user may have corrected an error in a source .tex +file during the run. So \fIlatexmk\fR needs to distinguish +user-generated and automatically generated files; it determines the +automatically generated files as those with extensions in the list in +@generated_exts.) + +A convenient way to add an extra extension to the list, without losing +the already defined ones is to use a push command in the line in an +RC file. E.g., + + push @generated_exts, "end"; + +adds the extension "end" to the list of predefined generated +extensions. (This extension is used by the RevTeX package, for +example.) +.TP +.B $go_mode [0] +If nonzero, process files regardless of timestamps, and is then +equivalent to the \fB-g\fR option. +.TP +.B %hash_calc_ignore_pattern +\fB!!!This variable is for experts only!!!\fR + +The general rule \fIlatexmk\fR uses for determining when an extra run +of some program is needed is that one of the source files has changed. +But consider for example a latex package that causes an encapsulated +postscript file (an "eps" file) to be made that is to be read in on +the next run. The file contains a comment line giving its creation +date and time. On the next run the time changes, \fIlatex\fR sees +that the eps file has changed, and therefore reruns latex. This +causes an infinite loop, that is only terminated becaues \fIlatexmk\fR +has a limit +on the number of runs to guard against pathological situations. + +But the changing line has no real effect, since it is a comment. You +can instruct \fIlatex\fR to ignore the offending line as follows: + + $hash_calc_ignore_pattern{'eps'} = '^%%CreationDate: '; + +This creates a rule for files with extension \fI.eps\fR about lines to +ignore. The left-hand side is a \fIPerl\fR idiom for setting an item +in a hash. Note that the file extension is specified without a +period. The value, on the right-hand side, is a string containing a +regular expresssion. (See documentation on \fIPerl\fR for how they +are to be specified in general.) This particular regular expression +specifies that lines beginning with "%%CreationDate: " are to be +ignored in deciding whether a file of the given extension \fI.eps\fR +has changed. + +There is only one regular expression available for each extension. If +you need more one pattern to specify lines to ignore, then you need to +combine the patterns into a single regular expression. The simplest +method is separate the different simple patterns by a vertical bar +character (indicating "alternation" in the jargon of regular +expressions). For example, + + $hash_calc_ignore_pattern{'eps'} = '^%%CreationDate: |^%%Title: '; + +causes lines starting with either "^%%CreationDate: " or "^%%Title: " +to be ignored. + +It may happen that a pattern to be ignored is specified in, for +example, in a system or user initialization file, and you wish to +remove this in a file read later. To do this, you use perl's delete +function, e.g., + + delete $hash_calc_ignore_pattern{'eps'}; + +.TP +.B $kpsewhich ["kpsewhich %S"] +The program called to locate a source file when the name alone is not +sufficient. Most filenames used by \fIlatexmk\fR have sufficient path +information to be found directly. But sometimes, notably +when .bib files are found from the log file of a bibtex or biber run, +the name of +the file, but not its path is known. The program specified by +$kpsewhich is used to find it. + +See also the \fI@BIBINPUTS\fR variable for another way that \fIlatexmk\fR +also uses to try to locate files; it applies only in the case of .bib +files. +.TP +.B $landscape_mode [0] +If nonzero, run in landscape mode, using the landscape mode previewers and +dvi to postscript converters. Equivalent to the \fB-l\fR option. +Normally not needed with current previewers. +.TP +.B $latex ["latex %O %S"] +The LaTeX processing program. Note that as with other programs, you +can use this variable not just to change the name of the program used, +but also specify options to the program. E.g., + + $latex = "latex --src-specials"; +.TP +.B %latex_input_extensions +This variable specifies the extensions tried by latexmk when it finds +that a LaTeX run resulted in an error that a file has not been found, +and the file is given without an extension. This typically happens when +LaTeX commands of the form \\input{file} or \\includegraphics{figure}, +when the relevant source file does not exist. + +In this situation, latexmk searches for custom dependencies to make +the missing file(s), but restricts it to the extensions specified by +the variable %latex_input_extensions. The default extensions +are 'tex' and 'eps'. + +(For Perl experts: %latex_input_extensions is a hash whose keys are +the extensions. The values are irrelevant.) Two subroutines are +provided for manipulating this and the related variable +%pdflatex_input_extensions, add_input_ext and remove_input_ext. They +are used as in the following examples are possible lines in an +initialization file: + + remove_input_ext( 'latex', 'tex' ); + +removes the extension 'tex' from latex_input_extensions + + add_input_ext( 'latex', 'asdf' ); + +add the extension 'asdf to latex_input_extensions. (Naturally with +such an extension, you should have made an appropriate custom +dependency for latexmk, and should also have done the appropriate +programming in the LaTeX source file to enable the file to be read. +The standard extensions are handled by LaTeX and its graphics/graphicx +packages. + +.TP +.B $latex_silent_switch ["-interaction=batchmode"] +Switch(es) for the LaTeX processing program when silent mode is on. + +If you use MikTeX, you may prefer the results if you configure the +options to include -c-style-errors, e.g., by the following line in an +initialization file + + $latex_silent_switch = "-interaction=batchmode -c-style-errors"; + +.TP +.B $lpr ["lpr %O %S" under UNIX/LINUX, \(dqNONE lpr\(dq under MS-WINDOWS] +The command to print postscript files. + +Under MS-Windows (unlike UNIX/LINUX), there is no standard program for +printing files. But there are ways you can do it. For example, if +you have gsview installed, you could use it with the option "/p": + + $lpr = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p'; + +If gsview is installed in a different directory, you will need to make +the appropriate change. Note the combination of single and double +quotes around the name. The single quotes specify that this is a +string to be assigned to the configuration variable \fI$lpr\fR. The double +quotes are part of the string passed to the operating system to get +the command obeyed; this is necessary because one part of the command +name ("Program Files") contains a space which would otherwise be +misinterpreted. +.TP +.B $lpr_dvi ["NONE lpr_dvi"] +The printing program to print dvi files. +.TP +.B $lpr_pdf ["NONE lpr_pdf"] +The printing program to print pdf files. + +Under MS-Windows you could set this to use gsview, if it is installed, +e.g., + + $lpr = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p'; + +If gsview is installed in a different directory, you will need to make +the appropriate change. Note the double quotes around the name: this +is necessary because one part of the command name ("Program Files") +contains a space which would otherwise be misinterpreted. + +.TP +.B $make ["make"] +The make processing program. + +.TP +.B $makeindex ["makeindex %O -o %D %S"] +The index processing program. +.TP +.B $makeindex_silent_switch ["-q"] +\fBSwitch(es)\fR for the index processing program when silent mode is on. +.TP +.B $max_repeat [5] +The maximum number of times \fIlatexmk\fR will run latex/pdflatex +before deciding that there may be an infinite loop and that it needs +to bail out, rather than rerunning latex/pdflatex again to resolve +cross-references, etc. The default value covers all normal cases. + +(Note that the "etc" covers a lot of cases where one run of +latex/pdflatex generates files to be read in on a later run.) +.TP +.B $MSWin_back_slash [1] +This configuration variable only has an effect when \fIlatexmk\fR is +running under MS-Windows. It determines whether, when a command is +executed under MS-Windows, there should be substituted "\\" for the +separator character between components of a directory name. +Internally, \fIlatexmk\fR uses "/" for the directory separator +character, which is the character used by Unix-like systems. + +For many programs under MS-Windows, both "\\" and "/" are acceptable +as the directory separator character. But some programs only accept +"\\". So for safety \fIlatexmk\fR makes a translation, by default. +It is conceivable that under certain situations this is undesirable, +so the configuration can be changed. (A possible example might be +when some of the software is implemented using Cygwin, which provides +an Unix-like environment inside MS-Windows.) + +.TP +.B $new_viewer_always [0] +This variable applies to \fIlatexmk\fR \fBonly\fR in +continuous-preview mode. If \fI$new_viewer_always\fR is 0, +\fIlatexmk\fR will check for a previously running previewer on the +same file, and if one is running will not start a new one. If +\fI$new_viewer_always\fR is non-zero, this check will be skipped, and +\fIlatexmk\fR will behave as if no viewer is running. +.TP + +.B $out_dir [""] +The directory in which output files are to be written by a run of +(pdf)latex. See also the variable \fI$aux_dir\fR. + +The effect of this variable (when non-blank) is achieved by using the +\fB-output-directory\fR option of (pdf)latex. This exists in the +usual current (Dec. 2011) implementations of TeX, i.e., MiKTeX and +TeXLive. But it may not be present in other versions. + +Commonly, the directory specified for output files is a subdirectory +of the current working directory. However, if you specify some other +directory, e.g., "/tmp/foo" or "../output", be aware that this could +cause problems, e.g., with \fImakeindex\fR or \fIbibtex\fR. This is +because modern versions of these programs, by default, will refuse to +work when they find that they are asked to write to a file in a +directory that appears not to be the current working directory or one +of its subdirectories. This is part of security measures by the whole +TeX system that try to prevent malicious or errant TeX documents from +incorrectly messing with a user's files. If for \fI$out_dir\fR or +\fI$aux_dir\fR you really do need to specify an absolute pathname +(e.g., "/tmp/foo") or a path (e.g., "../output") that includes a +higher-level directory, then you need to disable the security measures +(and assume any risks). This can be done by temporarily setting the +operating system's environment variable openout_any to "a" (as in +"all"), to override the default "paranoid" setting. +.TP + +.B $pdf_mode [0] +If zero, do NOT generate a pdf version of the document. +If equal to 1, generate a pdf version of the document using pdflatex. +If equal to 2, generate a pdf version of the document from the ps +file, by using the command specified by the \fI$ps2pdf\fR variable. +If equal to 3, generate a pdf version of the document from the dvi +file, by using the command specified by the \fI$dvipdf\fR variable. + +Equivalent to the \fB-pdf-\fR, \fB-pdf\fR, \fB-pdfdvi\fR, +\fB-pdfps\fR options. +.TP + +.B $pdflatex ["pdflatex %O %S"] +The LaTeX processing program in the version that makes a pdf file instead +of a dvi file. + +An example of the use of this variable is to arrange for \fIxelatex\fR +to be used instead of \fIpdflatex\fR, when you could set + + $pdflatex = "xelatex %O %S"; + +Note that \fIxelatex\fR only produces .pdf files (and not .dvi), so to +use it you will also need to turn on production of .pdf files, and to +turn off the production of .dvi (and .ps) files, either by command +line options or by the following settings in an initialization file + + $pdf_mode = 1; $postscript_mode = $dvi_mode = 0; + + +.TP +.B %pdflatex_input_extensions +This variable specifies the extensions tried by latexmk when it finds +that a pdfLaTeX run resulted in an error that a file has not been found, +and the file is given without an extension. This typically happens when +LaTeX commands of the form \\input{file} or \\includegraphics{figure}, +when the relevant source file does not exist. + +In this situation, latexmk searches for custom dependencies to make +the missing file(s), but restricts it to the extensions specified by +the variable %pdflatex_input_extensions. The default extensions +are 'tex', 'pdf', 'jpg, and 'png'. + +(For Perl experts: %pdflatex_input_extensions is a hash whose keys are +the extensions. The values are irrelevant.) Two subroutines are +provided for manipulating this and the related variable +%latex_input_extensions, add_input_ext and remove_input_ext. They +are used as in the following examples are possible lines in an +initialization file: + + remove_input_ext( 'pdflatex', 'tex' ); + +removes the extension 'tex' from pdflatex_input_extensions + + add_input_ext( 'pdflatex', 'asdf' ); + +add the extension 'asdf to pdflatex_input_extensions. (Naturally with +such an extension, you should have made an appropriate custom +dependency for latexmk, and should also have done the appropriate +programming in the LaTeX source file to enable the file to be read. +The standard extensions are handled by pdflatex and its graphics/graphicx +packages.) + +.TP +.B $pdflatex_silent_switch ["-interaction=batchmode"] +Switch(es) for the pdflatex program (specified in the variable +\fI$pdflatex\fR when silent mode is on. + +If you use MikTeX, you may prefer the results if you configure the +options to include -c-style-errors, e.g., by the following line in an +initialization file + + $latex_silent_switch = "-interaction=batchmode -c-style-errors"; + +.TP +.B $pdf_previewer ["start acroread %O %S"] +The command to invoke a pdf-previewer. + +On MS-WINDOWS, the default is changed to "cmd /c start """; under more recent versions of +Windows, this will cause to be run whatever command the system has +associated with .pdf files. But this may be undesirable if this +association is to \fIacroread\fR -- see the notes in the explanation +of the \fB-pvc\fR option.] + +On OS-X the default is changed to "open %S", which results in OS-X +starting up (and detaching) the viewer associated with the file. By +default, for pdf files this association is to OS-X's preview, which is +quite satisfactory. + +\fBWARNING\fR: Problem under MS-Windows: +if acroread is used as the pdf previewer, and it is +actually viewing a pdf file, the pdf file cannot be updated. Thus +makes acroread a bad choice of previewer if you use \fIlatexmk\fR's +previous-continuous mode (option \fB-pvc\fR) under MS-windows. +This problem does not occur if, for example, SumatraPDF or gsview is +used to view pdf files. + +\fBImportant note\fR: Normally you will want to have a previewer run +detached, so that \fIlatexmk\fR doesn't wait for the previewer to +terminate before continuing its work. So normally you should prefix +the command by "start ", which flags to \fIlatexmk\fR that it should +do the detaching of the previewer itself (by whatever method is +appropriate to the operating system). But sometimes letting +\fIlatexmk\fR do the detaching is not appropriate (for a variety of +non-trivial reasons), so you should put the "start " bit in +yourself, whenever it is needed. + +.TP +.B $pdf_update_command [""] +When the pdf previewer is set to be updated by running a command, this +is the command that is run. See the information for the variable +\fI$pdf_update_method\fR. +.TP +.B $pdf_update_method [1 under UNIX, 3 under MS-Windows] +How the pdf viewer updates its display when the pdf file has +changed. See the information on the variable \fI$dvi_update_method\fR +for the codes. (Note that information needs be changed slightly so +that for the value 4, to run a command to do the update, the command +is specified by the variable \fI$pdf_update_command\fR, and for the +value 2, to specify update by signal, the signal is specified by +\fI$pdf_update_signal\fR.) + +Note that acroread under MS-Windows (but not UNIX) locks the pdf file, so +the default value is then 3. + +Arranging to use a command to get a previewer explicitly updated +requires three variables to be set. For example: + + $pdf_previewer = "start xpdf -remote %R %O %S"; + $pdf_update_method = 4; + $pdf_update_command = "xpdf -remote %R -reload"; + +The first setting arranges for the xpdf program to be used in its +"remote server mode", with the server name specified as the rootname +of the TeX file. The second setting arranges for updating to be done +in response to a command, and the third setting sets the update command. + +.TP +.B $pdf_update_signal [Under UNIX: SIGHUP, which is a system-dependent value] +The number of the signal that is sent to the pdf viewer when it is +updated by sending a signal -- see the information on the variable +\fI$pdf_update_method\fR. The default value is the one appropriate +for gv on a UNIX system. +.TP +.B $pid_position[1 under UNIX, -1 under MS-Windows] +The variable \fI$pid_position\fR is used to +specify which word in lines of the output from \fI$pscmd\fR +corresponds to the process ID. The first word in the line is numbered +0. The default value of 1 (2nd word in line) is correct for Solaris +2.6 and Linux. Setting the variable to -1 is used to indicate that +\fI$pscmd\fR is not to be used. +.TP +.B $postscript_mode [0] +If nonzero, generate a postscript version of the document. +Equivalent to the \fB-ps\fR option. + +If some other request is made for which a postscript file is needed, +then $postscript_mode will be set to 1. +.TP +.B $preview_continuous_mode [0] +If nonzero, run a previewer to view the document, and +continue running \fIlatexmk\fR to keep .dvi up-to-date. Equivalent to +the \fB-pvc\fR option. +Which previewer is run depends on the other settings, see the command +line options \fB-view=\fR, and the variable \fI$view\fR. +.TP +.B $preview_mode [0] +If nonzero, run a previewer to preview the document. +Equivalent to the \fB-pv\fR option. +Which previewer is run depends on the other settings, see the command +line options \fB-view=\fR, and the variable \fI$view\fR. +.TP +.B $printout_mode [0] +If nonzero, print the document using \fIlpr\fR. Equivalent to the +\fB-p\fR option. This is recommended \fBnot\fR to be set from an RC +file, otherwise you could waste lots of paper. +.TP +.B $print_type = ["ps"] +Type of file to printout: possibilities are "dvi", "none", "pdf", or "ps". +.TP +.B $pscmd +Command used to get all the processes currently run by the user. The +-pvc option uses the command specified by the variable \fI$pscmd\fR to +determine if there is an already running previewer, and to find the +process ID (needed if \fIlatexmk\fR needs to signal the previewer +about file changes). + +Each line of the output of this command is assumed to correspond to +one process. See the \fI$pid_position\fR variable for how the process +number is determined. + +The default for \fIpscmd\fR is "NONE" under MS-Windows and cygwin +(i.e., the command is not used), "ps --width 200 -f -u $ENV{USER}" +under linux, "ps -ww -u $ENV{USER}" under darwin (Macintosh OS-X), and +"ps -f -u $ENV{USER}" under other operating systems (including other +flavors of UNIX). In these specifications "$ENV{USER}" is substituted +by the username. +.TP +.B $ps2pdf ["ps2pdf %O %S %D"] +Command to convert ps to pdf file. +.TP +.B $ps_filter [empty] +The postscript file filter to be run on the newly produced postscript +file before other processing. Equivalent to specifying the \fB-pF\fR +option. +.TP +.B $ps_previewer ["start gv %O %S", but "start %O %S" under MS-WINDOWS] +The command to invoke a ps-previewer. (The default under MS-WINDOWS +will cause to be run whatever command the system has associated +with .ps files.) + +Note that gv could be used with the -watch option updates its display +whenever the postscript file changes, whereas ghostview does not. +However, different versions of gv have slightly different ways of +writing this option. You can configure this variable apppropriately. + +\fBWARNING\fR: Linux systems may have installed one (or more) versions +of gv under different names, e.g., ggv, kghostview, etc, but perhaps +not one called gv. + +\fBImportant note\fR: Normally you will want to have a previewer run +detached, so that \fIlatexmk\fR doesn't wait for the previewer to +terminate before continuing its work. So normally you should prefix +the command by "start ", which flags to \fIlatexmk\fR that it should +do the detaching of the previewer itself (by whatever method is +appropriate to the operating system). But sometimes letting +\fIlatexmk\fR do the detaching is not appropriate (for a variety of +non-trivial reasons), so you should put the "start " bit in +yourself, whenever it is needed. + +.TP +.B $ps_previewer_landscape ["start gv -swap %O %S", but "start %O %S" under MS-WINDOWS] +The command to invoke a ps-previewer in landscape mode. +.TP +.B $ps_update_command [""] +When the postscript previewer is set to be updated by running a command, this +is the command that is run. See the information for the variable +\fI$ps_update_method\fR. +.TP +.B $ps_update_method [0 under UNIX, 1 under MS-Windows] +How the postscript viewer updates its display when the ps file has +changed. See the information on the variable \fI$dvi_update_method\fR +for the codes. (Note that information needs be changed slightly so +that for the value 4, to run a command to do the update, the command +is specified by the variable \fI$ps_update_command\fR, and for the +value 2, to specify update by signal, the signal is specified by +\fI$ps_update_signal\fR.) + +.TP +.B $ps_update_signal [Under UNIX: SIGHUP, which is a system-dependent value] +The number of the signal that is sent to the pdf viewer when it is +updated by sending a signal -- see \fI$ps_update_method\fR. The +default value is the one appropriate for gv on a UNIX system. + +.TP +.B $pvc_view_file_via_temporary [1] +The same as \fI$always_view_file_via_temporary\fR, except that it only +applies in preview-continuous mode (-pvc option). + +.TP +.B $quote_filenames [1] +This specifies whether substitutions for placeholders in command +specifications (as in \fI$pdflatex\fR) are surrounded by double +quotes. If this variable is 1 (or any other value Perl regards as +true), then quoting is done. Otherwise quoting is omitted. + +The quoting method used by latexmk is tested to work correctly under +UNIX systems (including Linux and Mac OS-X) and under MS-Windows. It +allows the use of filenames containing special characters, notably +spaces. (But note that many versions of LaTeX and PdfLaTeX cannot +correctly deal with TeX files whose names contain spaces. Latexmk's +quoting only ensures that such filenames are correctly treated by the +operating system in passing arguments to programs.) +.TP +.B $recorder [0] +Whether to use the \fB-recorder\fR option to \fIlatex\fR and +\fIpdflatex\fR. Use of this option results in a file of extension +\fI.fls\fR containing a list of the files that these programs have +read and written. \fILatexmk\fR will then use this file to improve +its detection of source files and generated files after a run of +\fIlatex\fR or \fIpdflatex\fR. + +It is generally recommended to use this option (or to configure the +\fI$recorder\fR variable to be on.) But it only works if +\fI(pdf)latex\fR supports the -recorder option, which is true for most +current implementations + +\fINote about the name of the .fls file:\fR Most implementations of +\fI(pdf)latex\fR produce an .fls file with the same basename as the +main document's LaTeX, e.g., for Document.tex, the .fls file is +Document.fls. However, some implementations instead produce files +named for the program, i.e., latex.fls or pdflatex.fls. In this +second case, \fIlatexmk\fR copies the latex.fls or pdflatex.fls to a +file with the basename of the main LaTeX document, e.g., Document.fls. + +.TP +.B $search_path_separator [See below for default] +The character separating paths in the environment variables TEXINPUTS, +BIBINPUTS, and BSTINPUTS. This variable is mainly used by +\fIlatexmk\fR when the \fB-outdir\fR, \fB-output-directory\fR, +\fB-auxdir\fR, and/or \fB-aux-directory\fR options are used. In that +case \fIlatexmk\fR needs to communicate appropriately modified search +paths to $\fIbibtex\fR, \fIdvipdf\fR, \fIdvips\fR, and +\fI(pdf)latex\fR. + +[Comment to technically savvy readers: \fI(pdf)latex\fR doesn't +actually need the modified search path, because it corrects it +internally. But, surprisingly, \fIdvipdf\fR and \fIdvips\fR do, +because sometimes graphics files get generated in the output or aux +directories.] + +The default under MSWin and Cygwin is ';' and under UNIX-like +operating systems (including Linux and OS-X) is ':'. Normally the +defaults give correct behavior. But there can be difficulties if your +operating system is of one kind, but some of your software is running +under an emulator for the other kind of operating system; in that case +you'll need to find out what is needed, and set +\fI$search_path_separator\fR explicitly. (The same goes, of course, +for unusual operating systems that are not in the MSWin, Linux, OS-X, +Unix collection.) + +.TP +.B $sleep_time [2] +The time to sleep (in seconds) between checking for source file +changes when running with the \fB-pvc\fR option. This is subject to a +minimum of one second delay, except that zero delay is also allowed. + +A value of exactly 0 gives no delay, and typically results in 100% CPU +usage, which may not be desirable. +.TP +.B $texfile_search [""] +This is an obsolete variable, replaced by the \fI@default_files\fR +variable. + +For backward compatibility, if you choose to set +\fI$texfile_search\fR, it is a string of space-separated filenames, and +then \fIlatexmk\fR replaces \fI@default_files\fR with the filenames in +\fI$texfile_search\fR to which is added "*.tex". + +.TP +.B $success_cmd [undefined] +See the documentation for $compiling_cmd. + +.TP +.B $tmpdir [See below for default] +Directory to store temporary files that \fIlatexmk\fR may generate while +running. + +The default under MSWindows (including cygwin), is to set +\fI$tmpdir\fR to the value of the first of whichever of the system +environment variables TMPDIR or TEMP exists, otherwise to the current +directory. Under other operating systems (expected to be UNIX/Linux, +including OS-X), the default is the value of the system environment +variable TMPDIR if it exists, otherwise "/tmp". +.TP +.B $use_make_for_missing_files [0] +Whether to use \fImake\fR to try and make files that are missing after +a run of \fIlatex\fR or \fIpdflatex\fR, and for which a custom +dependency has not been found. This is generally useful only when +\fIlatexmk\fR is used as part of a bigger project which is built by +using the \fImake\fR program. + +Note that once a missing file has been made, no further calls to +\fImake\fR will be made on a subsequent run of \fIlatexmk\fR to update +the file. Handling this problem is the job of a suitably defined +Makefile. See the section "USING \fIlatexmk\fR WITH \fImake\fR" for +how to do this. The intent of calling \fImake\fR from \fIlatexmk\fR +is merely to detect dependencies. +.TP +.B $view ["default"] +Which kind of file is to be previewed if a previewer is used. The +possible values are "default", "dvi", "ps", "pdf". The value +of "default" means that the "highest" of the kinds of file generated is +to be used (among dvi, ps and pdf). + +.SH CUSTOM DEPENDENCIES +.PP +In any RC file a set of custom dependencies can be set up to convert a +file with one extension to a file with another. An example use of this +would be to allow \fIlatexmk\fR to convert a \fI.fig\fR file to +\fI.eps\fR to be included in the \fI.tex\fR file. + +The old method of configuring \fIlatexmk\fR was to directly manipulate +the \fB@cus_dep_list\fR array that contains information defining the +custom dependencies. This method still works. But now there are +subroutines that allow convenient manipulations of the custom +dependency list. These are + + add_cus_dep( fromextension, toextension, must, subroutine ) + remove_cus_dep( fromextension, toextension ) + show_cus_dep() + +The custom dependency is a list of rules, each of which is specified +as follow: +.TP +.B from extension: +The extension of the file we are converting from (e.g. "fig"). +It is specified without a period. +.TP +.B to extension: +The extension of the file we are converting to (e.g. "eps"). +It is specified without a period. +.TP +.B must: +If non-zero, the file from which we are converting \fBmust\fR exist, if it +doesn't exist \fIlatexmk\fR will give an error message and exit unless +the \fB-f\fR option is specified. If \fImust\fR is zero and the file +we are converting from doesn't exist, then no action is taken. +.TP +.B function: +The name of the subroutine that \fIlatexmk\fR should call to perform the +file conversion. The first argument to the subroutine is the base name +of the file to be converted without any extension. The subroutines are +declared in the syntax of \fIPerl\fR. The function should return 0 if +it was successful and a nonzero number if it failed. +.PP +It is invoked whenever \fIlatexmk\fR detects that a run of +latex/pdflatex needs to read a file, like a graphics file, whose +extension is the to-extension of a custom dependency. Then +\fIlatexmk\fR examines whether a file exists with the same name, but +with the corresponding from-extension, as specified in the +custom-dependency rule. If it does, then whenever the destination +file (the one with the to-extension) is out-of-date with respect to +the corresponding source file. + +To make the new destination file, the \fIPerl\fR subroutine specified in the +rule is invoked, with an argument that is the base name of the files +in question. Simple cases just involve a subroutine invoking an +external program; this can be done by following the templates below, +even by those without knowledge of the \fIPerl\fR programming language. Of +course, experts could do something much more elaborate. + +One other item in each custom-dependency rule labelled "must" above +specifies how the rule should be applied when the source file fails to +exist. + +A simple and typical example of code in an initialization rcfile is + + add_cus_dep( 'fig', 'eps', 0, 'fig2eps' ); + sub fig2eps { + system( "fig2dev -Leps \"$_[0].fig\" \"$_[0].eps\"" ); + } + +The first line adds a custom dependency that converts a file with +extension "fig", as created by the xfig program, to an encapsulated +postscript file, with extension "eps". The remaining lines define a +subroutine that carries out the conversion. If a rule for converting +"fig" to "eps" files already exists (e.g., from a previously read-in +initialization file), the \fIlatexmk\fR will delete this rule before +making the new one. + +Suppose \fIlatexmk\fR is using this rule to convert a file +"figure.fig" to "figure.eps". Then it will invoke the fig2eps +subroutine defined in the above code with a single argument "figure", +which is the basename of each of the files (possibly with a path +component). This argument is referred to by \fIPerl\fR as $_[0]. In +the example above, the subroutine uses the \fIPerl\fR command system +to invoke the program fig2dev. The double quotes around the string +are a \fIPerl\fR idiom that signify that each string of the form of a +variable name, $_[0] in this case, is to be substituted by its value. + +If the return value of the subroutine is non-zero, then \fIlatexmk\fR +will assume an error occurred during the execution of the subroutine. +In the above example, no explicit return value is given, and instead +the return value is the value returned by the last (and only) +statement, i.e., the invocation of system, which returns the value 0 +on success. + +If you use pdflatex instead of latex, then you will probably prefer to +convert your graphics files to pdf format, in which case you would +replace the above code in an initialization file by + + add_cus_dep( 'fig', 'pdf, 0, 'fig2pdf' ); + sub fig2pdf { + system( "fig2dev -Lpdf \"$_[0].fig\" \"$_[0].pdf\"" ); + } + +\fBNote 1:\fR In the command lines given in the system commands in the +above examples, double quotes have been inserted around the file names +(implemented by '\"' in the Perl language). They immunize the running +of the program against special characters in filenames. Very often +these quotes are not necessary, i.e., they can be omitted. But it is +normally safer to keep them in. Even though the rules for quoting +vary between operating systems, command shells and individual pieces +of software, the quotes in the above examples do not cause problems in +the cases I have tested. + +\fBNote 2:\fR One case in which the quotes are important is when the +files are in a subdirectory and your operating system is Microsoft +Windows. Then the separator character for directory components can be +either a forward slash '/' or Microsoft's more usual backward slash +'\\'. Forward slashes are generated by latexmk, to maintain its +sanity from software like MiKTeX that mixes both directory +separators; but their correct use normally requires quoted filenames. +(See a log file from a run of MiKTeX (at least in v. 2.9) for an +example of the use of both directory separators.) + +If you have some general custom dependencies defined in the system or +user initialization file, you may find that for a particular project +they are undesirable. So you might want to delete the unneeded ones. +For example, you remove any "fig" to "eps" rule by the line + + remove_cus_dep( 'fig', 'eps' ); + +If you have complicated sets of custom dependencies, you may want to +get a listing of the custom dependencies. This is done by using the +line + + show_cus_dep(); + +in an initialization file. + +Another example of a custom dependency overcomes a limitation of +\fIlatexmk\fR concerning index files. The only index-file conversion +built-in to \fIlatexmk\fR is from an ".idx" file written on one run of +latex/pdflatex to an ".ind" file to be read in on a subsequent run. +But with the index.sty package you can create extra indexes with +extensions that you configure. \fILatexmk\fR does not know how to +deduce the extensions from the information it has. But you can easily +write a custom dependency. For example if your latex file uses the +command "\\newindex{special}{ndx}{nnd}{Special index}" you will need to +convert files with the extension \fI.ndx\fR to \fI.nnd\fR. The +following lines in an initialization RC file will cause this to +happen: + + add_cus_dep('ndx', 'nnd', 0, 'makendx2nnd'); + sub makendx2nnd { + system( "makeindex -o \"$_[0].nnd\" \"$_[0].ndx"\" ); + } + +(You will need to modify this code if you use filenames +with spaces in them, to provide correct quoting of the filenames.) + +Those of you with experience with Makefiles, will undoubtedly be +concerned that the \fI.ndx\fR file is written during a run of +latex/pdflatex and is always later than the \fI.nnd\fR last read in. +Thus the \fI.nnd\fR appears to be perpetually out-of-date. This +situation, of circular dependencies, is endemic to latex, and +\fIlatexmk\fR in its current version works correctly with circular +dependencies. It examines the contents of the files (by use of an md5 +checksum), and only does a remake when the file contents have actually +changed. + +Of course if you choose to write random data to the \fI.nnd\fR (or and +\fI.aux\fR file, etc) that changes on each new run, then you will have +a problem. For real experts: See the \fI%hash_cal_ignore_pattern\fR +if you have to deal with such problems. + +Glossaries can be dealt with similarly. + +.SH OLD METHOD OF DEFINING CUSTOM DEPENDENCIES +In previous versions of \fIlatexmk\fR, the only method of defining +custom dependencies was to directly manipulate the table of custom +dependencies. This is contained in the \fB@cus_dep_list\fR array. It +is an array of strings, and each string in the array has four items in +it, each separated by a space, the from-extension, the to-extension, +the "must" item, and the name of the subroutine for the custom +dependency. These were all defined above. +.PP +An example of the old method of defining custom dependencies is as +follows. It is the code in an RC file to ensure automatic conversion +of \fI.fig\fR files to \fI.eps\fR files: + + push @cus_dep_list, "fig eps 0 fig2eps"; + sub fig2eps { + system( "fig2dev -Lps \"$_[0].fig\" \"$_[0].eps\"" ); + } + +This method still works, and is equivalent to the earlier code using +the add_cus_dep subroutine, except that it doesn't delete any previous +custom-dependency for the same conversion. So the new method is +preferable. + + + +.SH USING \fIlatexmk\fR WITH \fImake\fR + +This section is targeted only at advanced users who use the \fImake\fR +program for complex projects, as for software development, with the +dependencies specified by a Makefile. + +Now the basic task of \fIlatexmk\fR is to run the appropriate programs +to make a viewable version of a LaTeX document. However, the usual +\fImake\fR program is not suited to this purpose for at least two +reasons. First is that the use of LaTeX involves circular +dependencies (e.g., via .aux files), and these cannot be handled by +the standard \fImake\fR program. Second is that in a large document +the set of source files can change quite frequently, particularly with +included graphics files; in this situation keeping a Makefile manually +updated is inappropriate and error-prone, especially when the +depedencies can be determined automatically. \fILatexmk\fR solves +both of these problems robustly. + +Thus for many standard LaTeX documents \fIlatexmk\fR can be used by +itself without the \fImake\fR program. In a complex project it simply +needs to be suitably configured. A standard configuration would be to +define custom dependencies to make graphics files from their source +files (e.g., as created by the \fIxfig\fR program). Custom +dependencies are \fIlatexmk\fR's equivalent of pattern rules in +Makefiles. + +Nevertheless there are projects for which a Makefile is appropriate, +and it is useful to know how to use \fIlatexmk\fR from a Makefile. A +typical example would be to generate documentation for a software +project. Potentially the interaction with the rest of the rules in +the Makefile could be quite complicated, for example if some of the +source files for a LaTeX document are generated by the project's +software. + +In this section, I give a couple of examples of how \fIlatexmk\fR can +be usefully invoked from a Makefile. The examples use specific +features of current versions of GNU \fImake\fR, which is the default +on both linux and OS-X systems. They may need modifications for other +versions of \fImake\fR. + +The simplest method is simply to delegate all the relevant tasks to +\fIlatexmk\fR, as is suitable for a straightforward LaTeX document. +For this a suitable Makefile is like + + .PHONY : FORCE_MAKE + all : try.pdf + %.pdf : %.tex FORCE_MAKE + latexmk -pdf -dvi- -ps- $< + +(Note: the last line must be introduced by a tab for the Makefile to +function correctly!) Naturally, if making try.pdf from its associated +LaTeX file try.tex were the only task to be performed, a direct use of +\fIlatexmk\fR without a Makefile would normally be better. The +benefit of using a Makefile for a LaTeX document would be in a larger +project, where lines such as the above would be only be a small part +of a larger Makefile. + +The above example has a pattern rule for making a .pdf file from +a .tex file, and it is defined to use latexmk in the obvious way. +There is a conventional default target named "all", with a +prerequisite of try.pdf. So when \fImake\fR is invoked, by default it +makes try.pdf. The only complication is that there may be many source +files beyond try.tex, but these aren't specified in the Makefile, so +changes in them will not by themselves cause \fIlatexmk\fR to be +invoked. Instead, the pattern rule is equipped with a "phony" +prerequisite FORCE_MAKE; this has the effect of causing the rule to be +always out-of-date, so that \fIlatexmk\fR is always run. It is +\fIlatexmk\fR that decides whether any action is needed, e.g., a rerun +of \fIpdflatex\fR. Effectively the Makefile delegates all decisions +to \fIlatexmk\fR, while \fImake\fR has no knowledge of the list of +source files except for primary LaTeX file for the document. If +there are, for example, graphics files to be made, these must be +made by custom dependencies configured in \fIlatexmk\fR. + +But something better is needed in more complicated situations, for +example, when the making of graphics files needs to be specified by +rules in the Makefile. To do this, one can use a Makefile like the +following: + + TARGETS = document1.pdf document2.pdf + DEPS_DIR = .deps + LATEXMK = latexmk -recorder -use-make -deps \\ + -e 'warn qq(In Makefile, turn off custom dependencies\n);' \\ + -e '@cus_dep_list = ();' \\ + -e 'show_cus_dep();' + all : $(TARGETS) + $(foreach file,$(TARGETS),$(eval -include $(DEPS_DIR)/$(file)P)) + $(DEPS_DIR) : + mkdir $@ + %.pdf : %.tex + if [ ! -e $(DEPS_DIR) ]; then mkdir $(DEPS_DIR); fi + $(LATEXMK) -pdf -dvi- -ps- -deps-out=$(DEPS_DIR)/$@P $< + %.pdf : %.fig + fig2dev -Lpdf $< $@ + +(Again, the lines containing the commands for the rules should be +started with tabs.) This example was inspired by how GNU +\fIautomake\fR handles automatic dependency tracking of C source +files. + +After each run of latexmk, dependency information is put in a file +in the .deps subdirectory. The Makefile causes these dependency files +to be read by \fImake\fR, which now has the full dependency +information for each target .pdf file. To make things less trivial it +is specificed that two files document1.pdf and document2.pdf are the +targets. The dependency files are .deps/document1.pdfP +and .deps/document2.pdfP. + +There is now no need for the phony prerequisite for the rule to +make .pdf files from .tex files. But I have added a rule to +make .pdf files from .fig files produced by the \fIxfig\fR program; +these are commonly used for graphics insertions in LaTeX documents. +\fILatexmk\fR is arranged to output a dependency file after each run. +It is given the \fB-recorder\fR option, which improves its detection +of files generated during a run of \fIpdflatex\fR; such files should +not be in the dependency list. The \fB-e\fR options are used to turn +off all custom dependencies, and to document this. Instead the +\fB-use-make\fR is used to delegate the making of missing files to +\fImake\fR itself. + +Suppose in the LaTeX file there is a command \\includegraphics{graph}, +and an \fIxfig\fR file "graph.fig" exists. On a first run, +\fIpdflatex\fR reports a missing file, named "graph". \fILatexmk\fR +succeeds in making "graph.pdf" by calling "make graph.pdf", and after +completion of its work, it lists "fig.pdf" among the dependents of the +file \fIlatexmk\fR is making. Then let "fig.fig" be updated, and then +let \fImake\fR be run. \fIMake\fR first remakes "fig.pdf", and only +then reruns \fIlatexmk\fR. + +Thus we now have a method by which all the subsidiary processing is +delegated to \fImake\fR. + +.SH SEE ALSO +latex(1), bibtex(1). +.SH BUGS +Sometimes a viewer (gv) tries to read an updated .ps or .pdf file +after its creation is started but before the file is complete. Work +around: manually refresh (or reopen) display. Or use one of the other +previewers and update methods. + +(The following isn't really a bug, but concerns features of previewers.) +Preview continuous mode only works perfectly with certain previewers: +Xdvi on UNIX/LINUX works for dvi files. +Gv on UNIX/LINUX works for both postscript and pdf. +Ghostview on UNIX/LINUX needs a manual update (reopen); it views +postscript and pdf. +Gsview under MS-Windows works for both postscript and pdf, +but only reads the updated file when its screen is refreshed. +Acroread under UNIX/LINUX views pdf, but the file needs to be closed +and reopened to view an updated version. +Under MS-Windows, acroread locks its input file and so the +pdf file cannot be updated. (Remedy: configure \fIlatexmk\fR to use +\fIsumatrapdf\fR instead.) +.SH THANKS TO +Authors of previous versions. Many users with their feedback, and +especially +David Coppit (username david at node coppit.org) who made many useful +suggestions that contributed to version 3, and Herbert Schulz. +(Please note that the +e-mail addresses are not written in their standard form to avoid being +harvested by worms and viruses.) +.SH AUTHOR +Current version, by John Collins (username collins at node phys.psu.edu). +(Version 4.35). + +Released version can be obtained from CTAN: +<http://www.tug.org/tex-archive/support/latexmk/>, and from the +author's website <http://www.phys.psu.edu/~collins/software/latexmk/>. +.br +Modifications and enhancements by Evan McLean (Version 2.0) +.br +Original script called "go" by David J. Musliner (RCS Version 3.2) + +\" LocalWords: fR fIlatexmk dvi ps fILatexmk pdflatex bibtex makeindex fB pv +\" LocalWords: pvc fIgv xdvi gsview cygwin fdb TP tex bm bs fIlatex fIbibtex +\" LocalWords: gg regeneratable dep exts dF dviF dviselect fI fR's lpr pdfps +\" LocalWords: pdfdvi dvipdf pF psF psnup fIsome gv acroread xpdf rcfile cus +\" LocalWords: batchmode latexmkrc elatex basename texfile WinXP BIBINPUTS +\" LocalWords: kpsewhich BibTeX dtx dvipdfm dvips fpTeX MikTeX fBWARNING pid +\" LocalWords: pscmd fIlpr fBnot ENV OSX SIGHUP tmpdir MSWindows tmp eps dev +\" LocalWords: fImust fIperl Lps fIfig diff --git a/Master/texmf-dist/doc/man/man1/latexmk.man1.pdf b/Master/texmf-dist/doc/man/man1/latexmk.man1.pdf Binary files differnew file mode 100644 index 00000000000..638b81efb45 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/latexmk.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/latexrevise.1 b/Master/texmf-dist/doc/man/man1/latexrevise.1 new file mode 100644 index 00000000000..b8d0d2da807 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/latexrevise.1 @@ -0,0 +1,235 @@ +.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "LATEXREVISE 1" +.TH LATEXREVISE 1 "2012-12-16" "perl v5.12.4" " " +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +latexrevise \- selectively remove markup and text from latexdiff output +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBlatexrevise\fR [ \fB\s-1OPTIONS\s0\fR ] [ \fIdiff.tex\fR ] > \fIrevised.tex\fR +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +\&\fIlatexrevise\fR reads a file \f(CW\*(C`diff.tex\*(C'\fR (output of \fIlatexdiff\fR), and remove the markup commands. +If no filename is given the input is read from standard input. The command can be used +in \fI\s-1ACCEPT\s0\fR, \fI\s-1DECLINE\s0\fR, or \fI\s-1SIMPLIFY\s0\fR mode, or can be used to remove user-defined +latex commands from the input (see \fB\-c\fR, \fB\-e\fR, \fB\-m\fR, and \fB\-n\fR below). +In \fI\s-1ACCEPT\s0\fR mode, all appended text fragments (or preamble lines) +are kept, and all discarded text fragments (or preamble lines) are +deleted. +In \fI\s-1DECLINE\s0\fR mode, all discarded text fragments are kept, and all appended +text fragments are deleted. +If you wish to keep some changes, edit the diff.tex file in +advance, and manually remove those tokens which would otherwise be +deleted. Note that \fIlatexrevise\fR only pays attention to the \f(CW\*(C`\eDIFaddbegin\*(C'\fR, +\&\f(CW\*(C`\eDIFaddend\*(C'\fR, \f(CW\*(C`\eDIFdelbegin\*(C'\fR, and \f(CW\*(C`\eDIFdelend\*(C'\fR tokens and corresponding \s-1FL\s0 +varieties. All \f(CW\*(C`\eDIFadd\*(C'\fR and \f(CW\*(C`\eDIFdel\*(C'\fR commands (but not their contents) are +simply deleted. The commands added by latexdiff to the preamble are also +removed. +In \fI\s-1SIMPLIFY\s0\fR mode, \f(CW\*(C`\eDIFaddbegin, \eDIFaddend, \eDIFdelbegin, \eDIFdelend\*(C'\fR +tokens and their corresponding \f(CW\*(C`FL\*(C'\fR varieties are kept but all other markup (e.g. \f(CW\*(C`DIFadd\*(C'\fR and <\eDIFdel>) is removed. The result +will not in general be valid latex-code but it will be easier to read and edit in +preparation for a subsequent run in \fI\s-1ACCEPT\s0\fR or \fI\s-1DECLINE\s0\fR mode. +In \fI\s-1SIMPLIFY\s0\fR mode the preamble is left unmodified. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-a\fR or \fB\-\-accept\fR" 4 +.IX Item "-a or --accept" +Run in \fI\s-1ACCEPT\s0\fR mode (delete all blocks marked by \f(CW\*(C`\eDIFdelbegin\*(C'\fR and \f(CW\*(C`\eDIFdelend\*(C'\fR). +.IP "\fB\-d\fR or \fB\-\-decline\fR" 4 +.IX Item "-d or --decline" +Run in \fI\s-1DECLINE\s0\fR mode (delete all blocks marked by \f(CW\*(C`\eDIFaddbegin\*(C'\fR +and \f(CW\*(C`\eDIFaddend\*(C'\fR). +.IP "\fB\-s\fR or \fB\-\-simplify\fR" 4 +.IX Item "-s or --simplify" +Run in \fI\s-1SIMPLIFY\s0\fR mode (Keep all \f(CW\*(C`\eDIFaddbegin\*(C'\fR, \f(CW\*(C`\eDIFaddend\*(C'\fR, +\&\f(CW\*(C`\eDIFdelbegin\*(C'\fR, \f(CW\*(C`\eDIFdelend\*(C'\fR tokens, but remove all other latexdiff +markup from body). +.PP +Note that the three mode options are mutually exclusive. If no mode option is given, +\&\fIlatexrevise\fR simply removes user annotations and markup according to the following four +options. +.IP "\fB\-c cmd\fR or \fB\-\-comment=cmd\fR" 4 +.IX Item "-c cmd or --comment=cmd" +Remove \f(CW\*(C`\ecmd{...}\*(C'\fR sequences. \f(CW\*(C`cmd\*(C'\fR is supposed to mark some explicit +anotations which should be removed from the file before +release. +.IP "\fB\-e envir\fR or \fB\-\-comment\-environment=envir\fR" 4 +.IX Item "-e envir or --comment-environment=envir" +Remove explicit annotation environments from the text, i.e. remove +.Sp +.Vb 3 +\& \ebegin{envir} +\& ... +\& \eend{envir} +.Ve +.Sp +blocks. +.IP "\fB\-m cmd\fR or \fB\-\-markup=cmd\fR" 4 +.IX Item "-m cmd or --markup=cmd" +Remove the markup command \f(CW\*(C`\ecmd\*(C'\fR but leave its argument, i.e. +turn \f(CW\*(C`\ecmd{abc}\*(C'\fR into \f(CW\*(C`abc\*(C'\fR. +.IP "\fB\-n envir\fR or \fB\-\-markup\-environment=envir\fR" 4 +.IX Item "-n envir or --markup-environment=envir" +Similarly, remove \f(CW\*(C`\ebegin{envir}\*(C'\fR and \f(CW\*(C`\eend{envir}\*(C'\fR commands but +leave content of the environment in the text. +.IP "\fB\-V\fR or \fB\-\-verbose\fR" 4 +.IX Item "-V or --verbose" +Verbose output +.IP "\fB\-q\fR or \fB\-\-no\-warnings\fR" 4 +.IX Item "-q or --no-warnings" +Do not warn users about \f(CW\*(C`\eDIDadd{..}\*(C'\fR or \f(CW\*(C`\eDIFdel{..}\*(C'\fR statements +which should have been removed already. +.SH "BUGS" +.IX Header "BUGS" +The current version is a beta version which has not yet been +extensively tested, but worked fine locally. Please submit bug reports through +the latexdiff project page \fIhttp://developer.berlios.de/projects/latexdiff/\fR or send +to \fItilmann@gfz\-potsdam.de\fR. Include the serial number of \fIlatexrevise\fR +(from comments at the top of the source). If you come across latexdiff +output which is not processed correctly by \fIlatexrevise\fR please include the +problem file as well as the old and new files on which it is based, +ideally edited to only contain the offending passage as long as that still +reproduces the problem. +.PP +Note that \fIlatexrevise\fR gets confused by commented \f(CW\*(C`\ebegin{document}\*(C'\fR or +\&\f(CW\*(C`\eend{document}\*(C'\fR statements +.SH "SEE ALSO" +.IX Header "SEE ALSO" +latexdiff +.SH "PORTABILITY" +.IX Header "PORTABILITY" +\&\fIlatexrevise\fR does not make use of external commands and thus should run +on any platform supporting \s-1PERL\s0 v5 or higher. +.SH "AUTHOR" +.IX Header "AUTHOR" +Copyright (C) 2004 Frederik Tilmann +.PP +This program is free software; you can redistribute it and/or modify +it under the terms of the \s-1GNU\s0 General Public License Version 3 diff --git a/Master/texmf-dist/doc/man/man1/latexrevise.man1.pdf b/Master/texmf-dist/doc/man/man1/latexrevise.man1.pdf Binary files differnew file mode 100644 index 00000000000..623a87d27af --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/latexrevise.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/luatex.1 b/Master/texmf-dist/doc/man/man1/luatex.1 new file mode 100644 index 00000000000..696e26d52f8 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/luatex.1 @@ -0,0 +1,251 @@ +.TH LUATEX 1 "12 April 2011" "luatex 0.70" "Web2C 2012" +.\"===================================================================== +.if n .ds MF Metafont +.if t .ds MF M\s-2ETAFONT\s0 +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.if n .ds WB Web +.if t .ds WB W\s-2EB\s0 +.\"===================================================================== +.SH NAME +luatex, texlua, texluac \- An extended version of pdfTeX using Lua as +an embedded scripting language +.\"===================================================================== +.SH SYNOPSIS +.B luatex +.RB [ \-\-lua=\fIFILE\fP ] +.RI [ OPTION ].\|.\|. +.RI [ TEXNAME [ \fB.tex\fP ]] +.RI [ COMMANDS ] +.br +.B luatex +.RB [ \-\-lua=\fIFILE\fP ] +.RI [ OPTION ].\|.\|. +.BI \e FIRST\-LINE +.br +.B luatex +.RB [ \-\-lua=\fIFILE\fP ] +.RI [ OPTION ].\|.\|. +.BI & FMT +.RI [ ARGS ] +.\"===================================================================== +.SH DESCRIPTION +Run the lua\*(TX typesetter on +.IR TEXNAME , +usually creating +.IR TEXNAME\fB.pdf\fP . +Any remaining +.I COMMANDS +are processed as lua\*(TX input, after +.I TEXNAME +is read. + +Alternatively, if the first non\-option argument begins with a backslash, +interpret all non\-option arguments as a line of lua\*(TX input. + +Alternatively, if the first non\-option argument begins with a \fB&\fR, +the +next word is taken as the \fIFMT\fR to read, overriding all else. Any +remaining arguments are processed as above. + +If no arguments or options are specified, prompt for input. + +If called as \fBtexlua\fR it acts as lua interpreter. +If called as \fBtexluac\fR it acts as lua bytecode compiler. + +Lua\*(TX is an extended version of pdf\*(TX with Unicode and OpenType +font support, embeded \fBLua\fR scripting language, the \fBe-\*(TX\fR +and \fBOmega\fR extensions, as well as integrated MetaPost engine, that +can create \fIPDF\fR files as well as \fIDVI\fR files. +For more information about luatex, see http://www.luatex.org, you can +read Lua\*(TX manual using texdoc utility (\fBtexdoc luatex\fR). + +All Lua\*(TX text input and output is considered to be Unicode text. + +In \fIDVI\fR mode, lua\*(TX can be used as a complete replacement for +the \*(TX engine. + +In \fIPDF\fR mode, lua\*(TX can natively handle the \fIPDF\fR, \fIJPG\fR, +\fIJBIG2\fR, and \fIPNG\fR graphics formats. lua\*(TX cannot include +PostScript or Encapsulated PostScript (EPS) graphics files; first convert +them to PDF using \fBepstopdf\fR (1). + +.\"===================================================================== +.SH "OPTIONS" +When the Lua\*(TX executable starts, it looks for the \fB\-\-lua\fR +commandline option. +If there is no \fB\-\-lua\fR option, the commandline is interpreted in a +similar fashion as in traditional pdf\*(TX and Aleph. But if the option +is present, Lua\*(TX will enter an alternative mode of commandline parsing +in comparison to the standard web2c programs. The presence of \fB--lua\fR +makes most of other options unreliable, because the lua initialization +file can disable kpathsea and/or hook functions into various callbacks. +.ig +Here is the list of possibly affected switches/functionality, and why: +.. +.TP +.BI "\-\-lua=" FILE +The lua initialization file. +.PP +The following two options alter the executable behaviour: +.TP +.B \-\-luaonly +Start Lua\*(TX as a Lua interpreter. In this mode, it will set Lua's +\fIarg[0]\fR to the found script name, pushing preceding options in +negative values and the rest of the commandline in the positive values, +just like the Lua interpreter. Lua\*(TX will exit immediately after +executing the specified Lua script. +.TP +.BI \-\-luaconly +Start Lua\*(TX as a Lua byte compiler. In this mode, Lua\*(TX is exactly +like \fBluac\fR from the standalone Lua distribution, except that it +does not have the \fB\-l\fR switch, and that it accepts (but ignores) +the \fB\-\-luaconly\fR switch. +.PP +Then the regular web2c options: +.TP +.B \-\-debug\-format +.br +Debug format loading. +.TP +.B \-\-draftmode +Sets \epdfdraftmode so lua\*(TX doesn't write a PDF and doesn't read +any included images, thus speeding up execution. +.TP +.B \-\-enable\-write18 +.br +Synonym for \fB\-\-shell\-escape\fR. +.TP +.B \-\-disable\-write18 +.br +Synonym for \fB\-\-no\-shell\-escape\fR. +.TP +.B \-\-shell\-escape +.br +Enable the +.BI \ewrite18{ command } +construct, and Lua functions \fBos.execute()\fR, \fBos.exec()\fR, +\fBos.spawn()\fR, and \fBio.popen()\fR. The \fIcommand\fR can be any +shell command. This construct is normally disallowed for security +reasons. +.TP +.B \-\-no\-shell-escape +.br +Disable the +.BI \ewrite18{ command } +construct and the other Lua functions, even if it is enabled in the +\fItexmf.cnf\fR file. +.TP +.B \-\-shell-restricted +Enable restricted version of \fB\ewrite18\fR, \fBos.execute()\fR, +\fBos.exec()\fR, \fBos.spawn()\fR, and \fBio.popen()\fR, only commands +listed in \fItexmf.cnf\fR file are allowed. +.TP +.B \-\-file\-line\-error +Print error messages in the form \fIfile:line:error\fR which is similar +to the way many compilers format them. +.TP +.B \-\-no\-file\-line\-error +Disable printing error messages in the \fIfile:line:error\fR style. +.TP +.BI "\-\-fmt=" FORMAT +Use \fIFORMAT\fR as the name of the format to be used, instead of the +name by which lua\*(TX was called or a \fI%&\fR line. +.TP +.B \-\-help +Print help message and exit. +.TP +.B \-\-ini +Start in \fIINI\fR mode, which is used to dump formats. The \fIINI\fR +mode can be used for typesetting, but no format is preloaded, and basic +initializations like setting catcodes may be required. +.TP +.BI "\-\-interaction=" MODE +Sets the interaction mode. The \fIMODE\fR can be either +.IR batchmode , +.IR nonstopmode , +.IR scrollmode , +and +.IR errorstopmode . +The meaning of these modes is the same as that of the corresponding +\ecommands. +.TP +.BI "\-\-jobname=" NAME +Use \fINAME\fR for the job name, instead of deriving it from the name +of the input file. +.TP +.BI "\-\-kpathsea-debug=" BITMASK +Sets path searching debugging flags according to the \fIBITMASK\fR. +See the \fIKpathsea\fR manual for details. +.TP +.BI "\-\-mktex=" FMT +Enable mktex\fIFMT\fR generation, where \fIFMT\fR must be either \fItex\fR +or \fItfm\fR. +.TP +.B \-\-nosocket +Disable the luasocket (network) library. +.TP +.TP +.BI "\-\-output\-comment=" STRING +In \fIDVI\fR mode, use \fISTRING\fR for the \fIDVI\fR file comment +instead of the date. This option is ignored in\fIPDF\fR mode. +.TP +.BI "\-\-output\-directory=" DIRECTORY +Write output files in \fIDIRECTORY\fR instead of the current directory. +Look up input files in \fIDIRECTORY\fR first, then along the normal +search path. +.TP +.BI "\-\-output\-format=" FORMAT +Set the output format mode, where \fIFORMAT\fR must be either \fIpdf\fR +or \fIdvi\fR. +This also influences the set of graphics formats understood by lua\*(TX. +.TP +.BI "\-\-progname=" NAME +Pretend to be program \fINAME\fR (only for kpathsea). +.TP +.B \-\-recorder +Enable the filename recorder. +This leaves a trace of the files opened for input and output +in a file with extension \fI.fls\fR. +.TP +.B \-\-safer +Disable some Lua commands that can easily be abused by a malicious +document. +.TP +.BI "\-\-synctex=" NUMBER +Enable/disable Sync\*(TX extension. +.TP +.B \-\-version +Print version information and exit. +.TP +.B \-\-credits +Print credits and version details. +.TP +The following options are ignored: +.TP +.BR \-\-8bit ,\ \-\-etex ,\ \-\-parse\-first\-line ,\ \-\-no\-parse\-first\-line +These are always on. +.TP +.BR \-\-default\-translate\-file=\fITCXNAME\fP ,\ \-\-translate\-file=\fITCXNAME\fP +These are always off. + +.\"===================================================================== +.SH "SEE ALSO" +.BR pdftex (1), +.BR etex (1), +.BR aleph (1), +.BR omega (1), +.BR lua (1). +.\"===================================================================== +.SH "AUTHORS" +The primary authors of Lua\*(TX are Hartmut Henkel, Taco Hoekwater, +and Hans Hagen, with help from Martin Schr\[:o]der, Karel Skoupy, and +Han The Thanh. +.PP +\*(TX was designed by Donald E. Knuth, who implemented it using his +\*(WB system for Pascal programs. +It was ported to Unix at Stanford by Howard Trickey, and at Cornell by +Pavel Curtis. +The version now offered with the Unix \*(TX distribution is that generated +by the \*(WB to C system (\fBweb2c\fR), originally written by Tomas +Rokicki and Tim Morgan. diff --git a/Master/texmf-dist/doc/man/man1/luatex.man1.pdf b/Master/texmf-dist/doc/man/man1/luatex.man1.pdf Binary files differnew file mode 100644 index 00000000000..98d4ed4b61c --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/luatex.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/m-tx.1 b/Master/texmf-dist/doc/man/man1/m-tx.1 new file mode 100644 index 00000000000..c9552ab3937 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/m-tx.1 @@ -0,0 +1,106 @@ +.\" This manpage is licensed under the GNU Public License +.TH m-tx 1 2012-04-09 "m-tx script, version 0.3" "" + +.SH NAME +m-tx \- This script processes mtx files then deletes intermediate files + +.SH SYNOPSIS +[ texlua ] +.B m-tx[.lua] +{ +.IR option +| +.IR jobname +[ .mtx ] +} ... +.TP +The default effect is to process each file using +.TP 12 +.BR prepmx (1) +(pre-pre-processing pass) +.TP +.BR pmxab (1) +(pre-processing pass) +.TP +.BR etex (1) +(first pass) +.TP +.BR musixflx (1) +(second pass) +.TP +.BR etex (1) +(third pass) +.TP +.BR dvips (1) +(dvi to Postscript) +.TP +.BR ps2pdf (1) +(Postscript to Portable Document Format) +.TP +followed by removal of intermediate files. + +.SH OPTIONS +.TP 8 +.B -v +output program name and version number, and quit +.TP +.B -h +output usage summary and quit +.TP +.B -l +changes the TeX processor to +.BR latex (1) +or +.BR pdflatex (1) +.TP +.B -p +changes the TeX processor to +.BR pdfetex (1) +or +.BR pdflatex (1) +(and doesn't run +.BR dvips (1) +and +.BR ps2pdf (1) +or +.BR dvipdfm (1) +) +.TP +.B -d +changes the dvi processor to +.BR dvipdfm (1) +.TP +.B -s +stops processing at the dvi file +.TP +.B -t +stops processing at the tex (and midi) files +.TP +.B -m +stops processing at the pmx file +.TP +.B -i +retain intermediate files +.TP +.B -f +default processing +.TP 0 +Options affect processing of all succeeding mtx files unless changed by another option. + +.SH SEE ALSO +.BR prepmx (1) +.BR pmxab (1) +.BR scor2prt (1) +.BR etex (1), +.BR latex (1), +.BR pdfetex (1), +.BR pdflatex (1), +.BR musixflx (1), +.BR dvipdfm (1), +.BR dvips (1), +.BR ps2pdf (1). +.br +mtx260.pdf + +.SH AUTHOR +This manual page was written by Bob Tennent <rdt@cs.queensu.ca>. diff --git a/Master/texmf-dist/doc/man/man1/m-tx.man1.pdf b/Master/texmf-dist/doc/man/man1/m-tx.man1.pdf Binary files differnew file mode 100644 index 00000000000..8e8f9d8e231 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/m-tx.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/mag.1 b/Master/texmf-dist/doc/man/man1/mag.1 new file mode 100644 index 00000000000..8d9f2d4a261 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mag.1 @@ -0,0 +1,68 @@ +.\" e +.TH MAG 1 UMFT +.de EX +.sp +.in +5 +.nf +.ft CW +.. +.de EE +.in -5 +.ft R +.sp +.fi +.. +.SH NAME +mag \- computes fontsizes and magsteps +.SH SYNOPSIS +.B +mag +[-\fBR\fIdpi\fP\fP] magstep . . . + +.B +mag +[-\fBr\fP] [-\fBR\fP\fIdpi\fP] fontsize . . . + +.SH DESCRIPTION +.EQ +delim $$ +.EN +This tool calculates fontsizes given magsteps. TeXfonts are provided as +true sized fonts or as magnifications. The fontsize of a true sized +font equals the resolution of the printer (ex. 300). The fontsize +of a font magnified $n$ \fImagsteps\fP equals: +.EQ +1.2 sup{n} times 300 +delim off +.EN +rounded to its nearest integer value. Fontnames for TeX fonts normally +consists of the name (\fIcmr\fP), pointsize (\fI10\fP), type (\fIpk\fP) +and fontsize (\fI360\fP), for example: \fIcmr10.360pk\fP. + +.SH EXAMPLES +The result of \fImag -R240 -2 0 0.5 1\fP will be: +.EX +167 240 263 288 +.EE + +The inverse function is computed with the \fI-r\fP option. The result of +\fImag -r -R240 167 240 263 288\fP +will be the fontsteps: +.EX +-2 0 0.5 1 +.EE + +The UNIX shells allow command substitution. One can write: +.EX +mag -r -R240 `mag -R240 -2 0 0.5 1` +.EE + +.SH DATE +18 December, 1989 + +.SH AUTHOR +.nf +Piet Tutelaers +University of Technology Eindhoven +<rcpt@urc.tue.nl> + diff --git a/Master/texmf-dist/doc/man/man1/mag.man1.pdf b/Master/texmf-dist/doc/man/man1/mag.man1.pdf Binary files differnew file mode 100644 index 00000000000..fd715cc1dd7 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mag.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/makeindex.1 b/Master/texmf-dist/doc/man/man1/makeindex.1 new file mode 100644 index 00000000000..92d641b32d3 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/makeindex.1 @@ -0,0 +1,1216 @@ +.if t .ds LX L\\h'-0.36m'\\v'-0.15v'\\s-2A\\s+2\\h'-0.15m'\\v'0.15v'T\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X +.if n .ds LX LaTeX +.if t .ds TX T\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X +.if n .ds TX TeX +.ds Ts T\s-2RAN\s+2S\s-2CRIPT\s+2 +.if t .ds Uc \fIU\\h'-0.12m'C\\v'0.27m'\\h'-.23m'S\\h'-0.11m'F\\v'-0.27m'\fP +.if n .ds Uc UCSF +.ds Et \\f(boE\\h'-0.1667m'\\v'-0.20v'T\\v'0.20v'\\h'-0.125m'T\\fP +.TH MAKEINDEX 1 "24 September 2011" "TeX Live" "TeX Live" +.\"===================================================================== +.SH NAME +makeindex \- a general purpose, formatter-independent index processor +.SH SYNOPSIS +.B makeindex +.RB [ \-c ] +.RB [ \-g ] +.RB [ \-i ] +.RB [ \-l ] +.RB [ \-o +.IR ind ] +.RB [ \-p +.IR num ] +.RB [ \-q ] +.RB [ \-r ] +.RB [ \-s +.IR sfile ] +.RB [ \-t +.IR log ] +.RB [ \-L ] +.RB [ \-T ] +.RI [ idx0 +.I idx1 +.IR idx2 .\|.\|.] +.\"===================================================================== +.SH DESCRIPTION +The program +.I makeindex +is a general purpose hierarchical index generator; it accepts one or +more input files (often produced by a text formatter such as \*(TX +.RI ( tex (1L)) +or +.IR troff (1), +sorts the entries, and produces an output file which can be formatted. +The index can have up to three levels (0, 1, and 2) of subitem nesting. +The way in which words are flagged for indexing within the main document +is specific to the formatter used; +.I makeindex +does +.I not +automate the process of selecting these words. As the output index +is hierarchical, +.I makeindex +can be considered complimentary to the +.IR awk (1)-based +.IR make.index (1L) +system of Bentley and Kernighan, which is specific to +.IR troff (1), +generates non-hierarchical indices, and employs a much simpler syntax +for indicating index entries. For illustration of use with +.I troff +and +.IR \*(TX , +see the section \s-2EXAMPLES\s+2 below. +.LP +The formats of the input and output files are +specified in a style file; by default, input is assumed to be a +.I \&.idx +file, as generated by \*(LX. +.LP +Unless specified explicitly, the base name of the first input file +.RI ( idx0 ) +is used to determine the names of other files. For each input file +name specified, a file of that name is sought. If this file is not +found and the file name has no extension, the extension +.I \&.idx +is appended. If no file with this name is found, +.I makeindex +aborts. +.LP +If exactly one input file was given and no explicit style file was +specified using +.BR \-s , +.I makeindex +uses a file with the extension +.I \&.mst +as default style file (when present). +.LP +For important notes on how to select index keywords, see the document +by Lamport cited below. As an issue separate from selecting index +keywords, a systematic mechanism for placing index terms in a document +is suggested in +.IR "Index Preparation and Processing" , +a paper cited below. +.\"===================================================================== +.SH OPTIONS +.TP 10 +.B \-c +Compress intermediate blanks (ignoring leading and trailing blanks and +tabs). By default, blanks in the index key are retained. +.TP 10 +.B \-g +Employ German word ordering in the index, in accord with rules set forth +in DIN 5007. By default, +.I makeindex +employs a word ordering in which precedence is: symbols, numbers, +uppercase letters, lowercase letters. The sequence in German word +ordering is: symbols, lowercase letters, uppercase letters, numbers. +Additionally, this option enables +.I makeindex +to recognize the German \*(TX-commands {"a, "o, "u and "s} as {ae, oe, +ue and ss} during the sorting of the entries. The quote character +must be redefined in a style file (for example, redefine quote +as '+'). If the quote character is not redefined, +.I makeindex +will produce an error message and abort. +.TP 10 +.B \-i +Take input from +.IR stdin . +When this option is specified and +.B \-o +is not, output is written to +.IR stdout . +.TP 10 +.B \-l +Letter ordering; by default, word ordering is used (see +the \s-2ORDERING\s+2 section). +.TP 10 +.BI \-o " ind" +Employ +.I ind +as the output index file. By default, the file name +is created by appending the extension +.I .ind +to the base name of +the first input file +.RI ( idx0 ). +.TP 10 +.BI \-p " num" +Set the starting page number of the output index file to be +.I num +(useful when the index file is to be formatted separately). The +argument +.I num +may be numerical or one of the following: +.RS +.TP 10 +.I any +The starting page is the last source page number plus 1. +.TP +.I odd +The starting page is the first odd page following the last source page +number. +.TP +.I even +The starting page is the first even page following the last source +page number. +.RE +.IP +The last source page is obtained by searching backward in the log file +for the first instance of a number included within paired square +brackets +.RB ( [ .\|.\|. ] ). +If a page number is missing or the log file is not found, no attempt +will be made to set the starting page number. The source log file +name is determined by appending the extension +.I \&.log +to the base name of the first input file +.RI ( idx0 ). +.TP 10 +.B \-q +Quiet mode; send no messages to +.IR stderr . +By default, progress +and error messages are sent to +.I stderr +as well as to the +transcript file. +.TP 10 +.B \-r +Disable implicit page range formation; page ranges must be created by +using explicit range operators; see \s-2SPECIAL EFFECTS\s+2 below. By +default, three or more successive pages are automatically abbreviated +as a range (e.g. 1\(em5). +.TP 10 +.BI \-s " sty" +Employ +.I sty +as the style file (no default). The environment +variable \s-2INDEXSTYLE\s+2 defines the path where the style file +should be found. +.TP 10 +.BI \-t " log" +Employ +.I log +as the transcript file. By default, the file name is +created by appending the extension +.I .ilg +to the base name of the +first input file +.RI ( idx0 ). +.TP 10 +.BR \-L +sort based on locale settings. Not available on all systems. +.TP 10 +.BR \-T +special support for Thai documents. Not available on all systems. +.\"===================================================================== +.SH "STYLE FILE" +The style file informs +.I makeindex +about the format of the +.I \&.idx +input files and the intended format of the final output file; examples +appear below. This file can reside anywhere in the path defined by +the environment variable \s-2INDEXSTYLE\s+2. The style file contains +a list of +.RI < specifier , " attribute" > +pairs. There are two types of specifiers: input and output. +Pairs do not have to appear in any particular order. +A line begun by `%' is a comment. In the following list of +specifiers and arguments, <string> is an arbitrary string delimited by +double quotes (".\|.\|."), <char> is a single letter embraced by +single quotes ('.\|.\|.'), and <number> is a nonnegative integer. +The maximum length of a <string> is 2048. A literal backslash or +quote must be escaped (by a backslash). Anything not specified in the +style file will be assigned a default value, which is shown at the +head of the rightmost column. +.\"---------------------------------------------------------------------- +.SS "INPUT STYLE SPECIFIERS" +.TP 25 +.BR actual " <char>" +\'@\' +.RS +Symbol indicating that the next entry is to appear in the output file. +.RE +.TP +.BR arg_close " <char>" +\'}\' +.RS +Closing delimiter for the index entry argument. +.RE +.TP +.BR arg_open " <char>" +\'{\' +.RS +Opening delimiter for the index entry argument. +.RE +.TP +.BR encap " <char>" +\'|\' +.RS +Symbol indicating that the rest of the argument list +is to be used as the encapsulating command for the page number. +.RE +.TP +.BR escape " <char>" +\'\\\\\' +.RS +Symbol which escapes the following letter, unless its preceding letter +is +.BR escape . +Note: +.B quote +is used to escape the letter which immediately follows it, but if it is +preceded by +.BR escape , +it is treated as a ordinary character. These two symbols +.I must +be distinct. +.RE +.TP +.BR keyword " <string>" +"\\\\indexentry" +.RS +Command which tells +.I makeindex +that its argument is an index entry. +.RE +.TP +.BR level " <char>" +\'!\' +.RS +Delimiter denoting a new level of subitem. +.RE +.TP +.BR page_compositor " <string>" +"-" +.RS +Delimiter separating parts of a composite page number (see +\s-2SPECIAL EFFECTS\s+2 below). +.RE +.TP +.BR quote " <char>" +\'"\' +.RS +Note: +.B quote +is used to escape the letter which immediately follows it, but if it is +preceded by +.BR escape , +it is treated as a ordinary character. These two symbols +.I must +be distinct. +.RE +.TP +.BR range_close " <char>" +\')\' +.RS +Closing delimiter indicating the end of an explicit page range. +.RE +.TP +.BR range_open " <char>" +\'(\' +.RS +Opening delimiter indicating the beginning of an explicit page range. +.RE +.\"--------------------------------------------------------------------- +.SS "OUTPUT STYLE SPECIFIERS" +.TP 25 +.BR preamble " <string>" +"\\\\begin{theindex}\\n" +.RS +Preamble of output file. +.RE +.TP +.BR postamble " <string>" +"\\n\\n\\\\end{theindex}\\n" +.RS +Postamble of output file. +.RE +.TP +.BR setpage_prefix " <string>" +"\\n \\\\setcounter{page}{" +.RS +Prefix of command which sets the starting page number. +.RE +.TP +.BR setpage_suffix " <string>" +"}\\n" +.RS +Suffix of command which sets the starting page number. +.RE +.TP +.BR group_skip " <string>" +"\\n\\n \\\\indexspace\\n" +.RS +Vertical space to be inserted before a new group begins. +.RE +.TP +.BR headings_flag " <string>" +0 +.RS +Flag indicating treatment of new group headers, which are inserted +when before a new group (symbols, numbers, and the 26 letters): +positive values cause an uppercase letter to be inserted between +prefix and suffix, and negative values cause a lowercase letter to be +inserted (default is 0, which produces no header). +.RE +.TP +.BR heading_prefix " <string>" +"" +.RS +Header prefix to be inserted before a new letter begins. +.RE +.TP +.BR symhead_positive " <string>" +"Symbols" +.RS +Heading for symbols to be inserted if +.B headings_flag +is positive. +.RE +.TP +.BR symhead_negative " <string>" +"symbols" +.RS +Heading for symbols to be inserted if +.B headings_flag +is negative. +.RE +.TP +.BR numhead_positive " <string>" +"Numbers" +.RS +Heading for numbers to be inserted if +.B headings_flag +is positive. +.RE +.TP +.BR numhead_negative " <string>" +"numbers" +.RS +Heading for numbers to be inserted if +.B headings_flag +is negative. +.RE +.TP +.BR item_0 " <string>" +"\\n \\\\item " +.RS +Command to be inserted between two primary (level 0) items. +.RE +.TP +.BR item_1 " <string>" +"\\n \\\\subitem " +.RS +Command to be inserted between two secondary (level 1) items. +.RE +.TP +.BR item_2 " <string>" +"\\n \\\\subsubitem " +.RS +Command to be inserted between two level 2 items. +.RE +.TP +.B item_01 " <string>" +"\\n \\\\subitem " +.RS +Command to be inserted between a level 0 item and a level 1 item. +.RE +.TP +.BR item_x1 " <string>" +"\\n \\\\subitem " +.RS +Command to be inserted between a level 0 item and a level 1 item, +where the level 0 item does not have associated page numbers. +.RE +.TP +.BR item_12 " <string>" +"\\n \\\\subsubitem " +.RS +Command to be inserted between a level 1 item and a level 2 item. +.RE +.TP +.BR item_x2 " <string>" +"\\n \\\\subsubitem " +.RS +Command to be inserted between a level 1 item and a level 2 item, +where the level 1 item does not have associated page numbers. +.RE +.TP +.BR delim_0 " <string>" +", " +.RS +Delimiter to be inserted between a level 0 key and its first page number +(default: comma followed by a blank). +.RE +.TP +.BR delim_1 " <string>" +", " +.RS +Delimiter to be inserted between a level 1 key and its first page number +(default: comma followed by a blank). +.RE +.TP +.BR delim_2 " <string>" +", " +.RS +Delimiter to be inserted between a level 2 key and its first page number +(default: comma followed by a blank). +.RE +.TP +.BR delim_n " <string>" +", " +.RS +Delimiter to be inserted between two page numbers for the same key +in any level (default: comma followed by a blank). +.RE +.TP +.BR delim_r " <string>" +"--" +.RS +Delimiter to be inserted between the starting and ending page numbers +of a range. +.RE +.TP +.BR delim_t " <string>" +"" +.RS +Delimiter to be inserted at the end of a page list. This delimiter +has no effect on entries which have no associated page list. +.RE +.TP +.BR encap_prefix " <string>" +"\\\\" +.RS +First part of prefix for the command which encapsulates the page number. +.RE +.TP +.BR encap_infix " <string>" +"{" +.RS +Second part of prefix for the command which encapsulates the page +number. +.RE +.TP +.BR encap_suffix " <string>" +"}". +.RS +Suffix for the command which encapsulates the page number. +.RE +.TP +.BR line_max " <number>" +72 +.RS +Maximum length of a line in the output, beyond which a line wraps. +.RE +.TP +.BR indent_space " <string>" +"\\t\\t" +.RS +Space to be inserted in front of a wrapped line (default: two tabs). +.RE +.TP +.BR indent_length " <number>" +16 +.RS +Length of +.B indent_space +(default: 16, equivalent to 2 tabs). +.RE +.TP +.BR suffix_2p " <string>" +"" +.RS +Delimiter to replace the range delimiter and the second page number of +a two page list. When present, it overrides +.BR delim_r . +Example: "f.". +.RE +.TP +.BR suffix_3p " <string>" +"" +.RS +Delimiter to replace the range delimiter and the second page number of +a three page list. When present, it overrides +.B delim_r +and +.BR suffix_mp . +Example: "ff.". +.RE +.TP +.BR suffix_mp " <string>" +"" +.RS +Delimiter to replace the range delimiter and the second page number of +a multiple page list (three or more pages). When present, it overrides +.BR delim_r . +Example: "f.". +.RE +.\"===================================================================== +.SH EXAMPLES +.\"--------------------------------------------------------------------- +.SS "\*(TX EXAMPLE" +The following example shows a style file called +.IR book.ist , +which defines an index for a book which can be formatted independently +of the main source: +.LP +.RS +.nf +\fCpreamble +"\\\\documentstyle[12pt]{book} +\\\\begin{document} +\\\\begin{theindex} +{\\\\small\\n" +postamble +"\\n\\n} +\\\\end{theindex} +\\\\end{document}\\n\fP" +.fi +.RE +.LP +Assuming that a particular book style requires the index (as well as any +chapters) to start from an odd page number, and that the input file is +named +.IR foo.idx , +the following command line produces output in file +.IR footmp.ind : +.LP +.RS +\fCmakeindex \-s book.ist \-o footmp.ind \-p odd foo\fP +.RE +.LP +Here a non-default output file name is used to avoid clobbering the +output for the book itself (presumably +.IR foo.dvi , +which would have been the default name for the index output file!). +.\"--------------------------------------------------------------------- +.SS "TROFF EXAMPLE" +A sample control file for creating an index, which we will assume +resides in the file +.IR sample.ist : +.LP +.RS +.nf +\&\fCkeyword "IX:" +\&preamble +\&".\\\\\\" start of index output +\&\\".\\\\\\" enter two column mode +\&.2C +\&.SH +\&.ce +\&INDEX +\&.XS +\&INDEX +\&.XE +\&.R +\&.ps 9p +\&.vs 11p +\&.sp +\&.de I1 +\&.ti 0.25i +\&.. +\&.de I2 +\&.ti 0.5i +\&.." +\&postamble "\\n.\\\\\\" end of index output" +\&setpage_prefix "\\n.nr % " +\&setpage_suffix "" +\&group_skip "\\n.sp 1.0" +\&headings_flag 1 +\&heading_prefix "\\n.IS\\n" +\&heading_suffix "\\n.IE" +\&item_0 "\\n.br\\n" +\&item_1 "\\n.I1\\n" +\&item_2 "\\n.I2\\n" +\&item_01 "\\n.I1\\n" +\&item_x1 "\\n.I1\\n" +\&item_12 "\\n.I2\\n" +\&item_x2 "\\n.I2\\n" +\&delim_0 ", " +\&delim_1 ", " +\&delim_2 ", " +\&delim_r "-" +\&delim_t "." +\&encap_prefix "\\\\fB" +\&encap_infix "" +\&encap_suffix "\\\\fP" +\&indent_space "" +\&indent_length 0\fP +.fi +.RE +.LP +The local macro package may require modification, as in this example +of an extension to the +.B \-ms +macros (note that at some sites, this macro should +.I replace +a pre-existing macro of the same name): +.LP +.RS +.nf +\fC\&.\" IX - index words to stderr +\&.de IX +\&.ie '\\\\n(.z'' .tm IX: \\\\$1 \\\\$2 \\\\$3 \\\\$4 \\\\$5 \\\\$6 \\\\$7 \\\\$8 \\\\$9 {\\\\n(PN} +\&.el \\\\!.IX \\\\$1 \\\\$2 \\\\$3 \\\\$4 \\\\$5 \\\\$6 \\\\$7 \\\\$8 \\\\$9 {\\\\n(PN} +\&..\fP +.fi +.RE +.LP +(note that the string {\fC\\\\n(PN\fP} is separated from the rest of the +line by a tab. +If your local macro package does not contain this extension, +just include those lines at the beginning of your file. +Here is a simple +.IR troff (1) +input file, which we will assume is named +.IR sample.txt : +.LP +.RS +.nf +\fC\&This is a sample file to test the \\fImakeindex\\fP(1L) +\&program, and see +\&.IX {indexing!programs!C language} +\&.IX {makeindex@\\fImakeindex\\fP(1L)} +\&.bp +\&.rs +\&.IX {Knuth} +\&.IX {typesetting!computer-aided} +\&how well it functions in the \\fItroff\\fP(1) environment.\fP +.fi +.RE +.LP +Note that index entries are indicated by the +.B .IX +macro, which +causes the following text to be written to +.I stdout +along with the +current page number. +.\"--------------------------------------------------------------------- +.SS "CREATING THE INDEX FILE IN THE BOURNE SHELL" +To create an input file for +.IR makeindex , +.B "in the Bourne shell" +environment, do the equivalent at your site of the command: +.LP +.nf +\fCpsroff -ms -Tpsc -t sample.txt > /dev/null 2> sample.tmp\fP +.fi +.LP +Some sites will require +.I ditroff +instead of +.IR psroff . +To filter out any genuine error messages, invoke +.IR grep (1): +.LP +.RS +\fCgrep '^IX: ' sample.tmp > sample.idx\fP +.RE +.\"--------------------------------------------------------------------- +.SS "CREATING THE INDEX FILE USING \*(Uc ENHANCED TROFF/\*(Ts" +With \*(Uc Enhanced troff/\*(Ts, the +.B \-I +option of +.IR psroff (1L) +can produce both formatter output and an index file: +.LP +.RS +\fCpsroff -ms -I sample.inp -Tpsc sample.txt\fP +.RE +.LP +If it is wished to suppress the formatter output: +.RS +.LP +.nf +\fCpsroff -ms -I sample.inp -Tpsc -t sample.txt > /dev/null\fP +.fi +.RE +.\"--------------------------------------------------------------------- +.SS "COMPLETING THE INDEX" +Any of the above procedures leaves the input for +.I makeindex +in +.IR sample.inp . +The next step is to invoke +.IR makeindex : +.LP +.RS +\fCmakeindex -s sample.ist sample.idx\fP +.RE +.LP +This leaves +.IR troff (1)-ready +output in the file +.IR sample.ind . +.\"===================================================================== +.SH "ORDERING" +By default, +.I makeindex +assumes +.IR "word ordering" ; +if the +.B \-l +option is in effect, +.I "letter ordering" +is used. In word ordering, a blank precedes any letter in the +alphabet, whereas in letter ordering, it does not count at all. This +is illustrated by the following example: +.LP +.RS +\fIword order letter order\fP +.br +sea lion seal +.br +seal sea lion +.RE +.LP +Numbers are always sorted in numeric order. For instance, +.LP +.RS +9 (nine), 123 +.br +10 (ten), see Derek, Bo +.RE +.LP +Letters are first sorted without regard to case; when words are +identical, the uppercase version precedes its lowercase counterpart. +.LP +A special symbol is defined here to be any character not appearing in +the union of digits and the English alphabetic characters. Patterns +starting with special symbols precede numbers, which precede patterns +starting with letters. As a special case, a string starting with a +digit but mixed with non-digits is considered to be a pattern starting +with a special character. +.\"===================================================================== +.SH "SPECIAL EFFECTS" +Entries such as +.LP +.RS +.nf +\fC\\indexentry{alpha}{1} +\\indexentry{alpha!beta}{3} +\\indexentry{alpha!beta!gamma}{10}\fP +.fi +.RE +.LP +in the input file will be converted to +.LP +.RS +.nf +\fC\\item alpha, 1 +\0\0\0\\subitem beta, 3 +\0\0\0\0\0\0\\subsubitem gamma, 10\fP +.fi +.RE +.LP +in the output index file. +Notice that the +.B level +symbol (`!') is used above to delimit +hierarchical levels. +.LP +It is possible to make an item appear in a designated form by +using the +.B actual +(`@') operator. For instance, +.LP +.RS +\fC\\indexentry{alpha@{\\it alpha\\/}}{1}\fP +.RE +.LP +will become +.LP +.RS +\fC\\item {\\it alpha\\/}, 1\fP +.RE +.LP +after processing. The pattern preceding `@' is +used as sort key, whereas the one following it is written to the +output file. Note that two appearances of the same key, one with and +one without the +.B actual +operator, are regarded as +.I distinct +entries. +.LP +The item, subitem, and subsubitem fields may have individual sort keys: +.LP +.RS +.nf +\fC\\indexentry{aa@{\\it aa\\/}!bb@{\\it bb\\/}!cc@{\\it cc\\/}}{1}\fP +.fi +.RE +.LP +This will be converted to +.LP +.RS +.nf +\fC\\item {\\it aa}, 1 +\0\0\0\\subitem {\\it bb}, 3 +\0\0\0\0\0\0\\subsubitem {\\it cc}, 10\fP +.fi +.RE +.LP +It is possible to encapsulate a page number with a designated +command using the +.B encap +(`|') operator: +.LP +.RS +\fC\\indexentry{alpha|bold}{1}\fP +.RE +.LP +will be converted to +.LP +.RS +\fC\\item alpha, \\bold{1}\fP +.RE +.LP +where, with a suitable definition for \*(TX, \fC\\bold{n}\fP +will expand to \fC{\\bf n}\fP. +In this example, the three output attributes associated with page +encapsulation +.BR encap_prefix , +.BR encap_infix , +and +.BR encap_suffix , +correspond to backslash, left brace, and right brace, respectively. +This mechanism allows page numbers to be set in different fonts. For +example, the page where the definition of a keyword appears can be in +one font, the location of a primary example can be in another font, +and other appearances in yet a third font. +.LP +The +.B encap +operator can also be used to create cross references in +the index: +.LP +.RS +\fC\\indexentry{alpha|see{beta}}{1}\fP +.RE +.LP +will become +.LP +.RS +\fC\\item alpha, \\see{beta}{1}\fP +.RE +.LP +in the output file, where +.LP +.RS +\fC\\see{beta}{1}\fP +.RE +.LP +will expand to +.LP +.RS +\fC{\\it see\\/} beta\fP +.RE +.LP +Note that in a cross reference like this the page number disappears. +.LP +A pair of +.B encap +concatenated with +.B range_open +(`|(') and +.B range_close +(`|)') creates an explicit page range: +.LP +.RS +.nf +\fC\\indexentry{alpha|(}{1} +\\indexentry{alpha|)}{5}\fP +.fi +.RE +.LP +will become +.LP +.RS +\fC\\item alpha, 1\(em5\fP +.RE +.LP +Intermediate pages indexed by the same key will be merged into the +range implicitly. This is especially useful when an entire section +about a particular subject is to be indexed, in which case only the +range opening and closing operators need to be inserted at the +beginning and end of the section. Explicit page range formation can +also include an extra command to set the page range in a designated +font: +.LP +.RS +.nf +\fC\\indexentry{alpha|(bold}{1} +\\indexentry{alpha|)}{5}\fP +.fi +.RE +.LP +will become +.LP +.RS +\fC\\item alpha, \\bold{1--5}\fP +.RE +.LP +Several potential problems are worth mentioning. First, entries like +.LP +.RS +.nf +\fC\\indexentry{alpha|(}{1} +\\indexentry{alpha|bold}{3} +\\indexentry{alpha|)}{5}\fP +.fi +.RE +.LP +will be interpreted as +.LP +.RS +\fC\\item alpha, \\bold{3}, 1--5\fP +.RE +.LP +but with a warning message in the transcript about encountering an +inconsistent page encapsulator. +An explicit range beginning in a Roman page number and ending +in Arabic is also considered an error. In this instance, (if +possible) the range is broken into two subranges, one in Roman and the +other in Arabic. For instance, +.LP +.RS +.nf +\fC\\indexentry{alpha|(}{i} +\\indexentry{alpha}{iv} +\\indexentry{alpha}{3} +\\indexentry{alpha|)}{7}\fP +.fi +.RE +.LP +will be turned into +.LP +.RS +\fC\\item alpha, i--iv, 3--7\fP +.RE +.LP +with a warning message in the transcript file complaining about an +illegal range formation. +.LP +Every special symbol mentioned in this section may be +escaped by the +.B quote +operator (`"'). Thus +.LP +.RS +\fC\\indexentry{alpha"@beta}{1}\fP +.RE +.LP +will actually become +.LP +.RS +\fC\\item alpha@beta, 1\fP +.RE +.LP +as a result of executing +.IR makeindex . +The quoting power of +.B quote +is eliminated if it is immediately preceded +by +.B escape +(`\\'). For example, +.LP +.RS +\fC\\indexentry{f\\"ur}{1}\fP +.RE +.LP +becomes +.LP +.RS +\fC\\item f\\"ur, 1\fP +.RE +.LP +which represents an umlaut-accented `u' to the \*(TX family of +processors. +.LP +A page number can be a composite of one or more fields +separated by the delimiter bound to +.B page_compositor +(`-'), e.g., II-12 for page 12 of Chapter II. Page numbers may +contain up to ten fields. +.PP +Since version 2.11 of +.IR makeindex , +the +.B quote +operator may quote +.I any +character in the range 1 .\|.\|. 255. Character 0 is excluded because +it is used internally in the +.I makeindex +source code as a string terminator. With this change, sort keys can +be created for all eight-bit characters except 0. The sorting order +is +.RS +.nf + +punctuation characters (in ASCII order), +digits, +control characters (1 .\|.\|. 31), +space (32), +letters (ignoring case), +characters 127 .\|.\|. 255. + +.fi +.RE +Here is an example showing the indexing of all printable ASCII +characters other than letters and digits, assuming the default +\*(TX format. For convenience, the page number references are +the corresponding ASCII ordinal values. +.RS +.nf + +\fC\\indexentry{" @" (space)}{32} +\\indexentry{"!@"! (exclamation point)}{33} +\\indexentry{""@"" (quotation mark)}{34} +\\indexentry{"#@"\\# (sharp sign)}{35} +\\indexentry{"$@"\\$ (dollar sign)}{36} +\\indexentry{"%@"\\% (percent sign)}{37} +\\indexentry{"&@"\\& (ampersand)}{38} +\\indexentry{"<@"$<$ (left angle bracket)}{60} +\\indexentry{"=@"= (equals)}{61} +\\indexentry{">@"$>$ (right angle bracket)}{62} +\\indexentry{"?@"? (query)}{63} +\\indexentry{"@@"@ (at sign)}{64} +\\indexentry{"[@"[ (left square bracket)}{91} +\\indexentry{"\\@"\\verb=\\= (backslash)}{92} +\\indexentry{"]@"] (right square bracket)}{93} +\\indexentry{"^@"\\verb=^= (caret)}{94} +\\indexentry{"_@"\\verb=_= (underscore)}{95} +\\indexentry{"`@"\\verb=~= (grave accent)}{96} +\\indexentry{"{@"\\"{ (left brace)}{123} +\\indexentry{"|@"\\verb="|= (vertical bar)}{124} +\\indexentry{"}@"\\"} (right brace)}{125} +\\indexentry{"~@"\\verb=~= (tilde)}{126}\fP + +.fi +.RE +Characters in the actual fields following the `@' character which +have special significance to \*(TX must be represented as control +sequences, or as math mode characters. Note particularly how the +entries for the at sign, left and right braces, and the vertical +bar, are coded. The index file output by +.I makeindex +for this example looks like this: +.RS +.nf + +\fC\\begin{theindex} + + \\item ! (exclamation point), 33 + \\item " (quotation mark), 34 + \\item \\# (sharp sign), 35 + \\item \\$ (dollar sign), 36 + \\item \\% (percent sign), 37 + \\item \\& (ampersand), 38 + \\item $<$ (left angle bracket), 60 + \\item = (equals), 61 + \\item $>$ (right angle bracket), 62 + \\item ? (query), 63 + \\item @ (at sign), 64 + \\item [ (left square bracket), 91 + \\item \\verb=\\= (backslash), 92 + \\item ] (right square bracket), 93 + \\item \\verb=^= (caret), 94 + \\item \\verb=_= (underscore), 95 + \\item \\verb=~= (grave accent), 96 + \\item \\{ (left brace), 123 + \\item \\verb=|= (vertical bar), 124 + \\item \\} (right brace), 125 + \\item \\verb=~= (tilde), 126 + + \\indexspace + + \\item (space), 32 + +\\end{theindex}\fP +.fi +.RE +.\"===================================================================== +.SH "FILES" +.TP 2.2i +.I makeindex +executable file +.TP +.I $TEXMFMAIN/tex/plain/misc/idxmac.tex +\*(TX macro file used by +.I makeindex +.TP +.I $TEXMFMAIN/tex/latex/base/makeidx.sty +\*(TX macro file used by +.I makeindex +.\"===================================================================== +.SH "SEE ALSO" +ditroff(1L), +latex(1L), +make.index (1L), +qsort(3), +tex(1L), +troff(1L) +.LP +.IR "\*(Uc Enhanced troff/\*(Ts \(em An Overview" , +R. P. C. Rodgers and Conrad Huang, LSMB Technical Report 90-2, +UCSF School of Pharmacy, San Francisco, 1990. +.LP +.IR "Index Preparation and Processing" , +Pehong Chen and Michael A. Harrison, +.IR "Software: Practice and Experience" , +.BR 19 (9), +897\(en915, +September 1988. +.LP +.IR "Automating Index Preparation" , +Pehong Chen and Michael A. Harrison. Technical Report 87/347, +Computer Science Division, University of California, Berkeley, 1987 +(a \*(LX document supplied with +.IR makeindex ). +.LP +.IR "MakeIndex: An Index Processor for \*(LX" , +Leslie Lamport, February 1987 (a \*(LX document supplied +with +.IR makeindex ). +.LP +.IR "Tools for Printing Indices" , +Jon L. Bentley and Brian W. Kernighan, +.IR "Electronic Publishing \(em Origination, Dissemination, and Design" , +1(1), 3\(en18, June 1988 (also available as: Computing Science +Technical Report No. 128, +AT&T Bell Laboratories, Murray Hill, NJ 07974, 1986). +.\"===================================================================== +.SH "AUTHOR" +Pehong Chen, Chen & Harrison International Systems, Inc. +Palo Alto, California, USA. +.br +Manual page extensively revised and corrected, and +.IR troff (1) +examples created by Rick P. C. Rodgers, UCSF School +of Pharmacy <rodgers@cca.ucsf.edu>. +.\"===================================================================== +.SH ACKNOWLEDGMENTS +Leslie Lamport contributed significantly to the design. +Michael Harrison provided valuable comments and suggestions. +Nelson Beebe improved on the portable version, and maintains the +source distribution for the \*(TX Users Group. +Andreas Brosig contributed to the German word ordering. +The modification to the +.B \-ms +macros was derived from a method proposed by Ravi Sethi of AT&T +Bell Laboratories. +The +.I LOG +and +.I CONTRIB +files in the +.I makeindex +source distribution record other contributions. diff --git a/Master/texmf-dist/doc/man/man1/makeindex.man1.pdf b/Master/texmf-dist/doc/man/man1/makeindex.man1.pdf Binary files differnew file mode 100644 index 00000000000..395944c181f --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/makeindex.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/mendex.1 b/Master/texmf-dist/doc/man/man1/mendex.1 new file mode 100644 index 00000000000..9b1f5e15bbc --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mendex.1 @@ -0,0 +1,496 @@ +.if t .ds TX "T\h'-.15m'\v'.2v'E\v'-.2v'\h'-.12m'X +.if t .ds LX L\v'-.22m'a\v'.22m'T\h'-.1667m'\v'.22m'E\h'-.125m'\v'-.22m'X +.TH MENDEX L +.SH ̾¾Î +mendex \- º÷°úÀ°·Á¥Ä¡¼¥ë +.SH »ÈÍÑË¡ +\fBmendex\fR [-ilqrcg] [\fB-s\fI sty\fR] [\fB-d\fI dic\fR] [\fB-o\fI ind\fR] [\fB-d\fI dic\fR] [\fB-t\fI log\fR] [\fB-p\fI no\fR] [\fI idx0 idx1 idx2 ...\fR] +.SH ²òÀâ +.PP +\fImendex\fR ¤Ïʸ½ñ¤Îº÷°ú¤òºîÀ®¤¹¤ë¥Ä¡¼¥ë¤Ç¤¹¡£ LaTeX ¤Ë¤è¤êÃê½Ð¤µ¤ì¤¿º÷°ú¥ê¥¹¥È¥Õ¥¡¥¤¥ë(\fI.idx\fR)¤òʤÙÂؤ¨¡¢¼ÂºÝ¤Îº÷°ú¤Î¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Î·Á¤ËÀ°·Á¤·¤Þ¤¹¡£ \fImakeindex\fR ¤È¸ß´¹À¤¬¤¢¤ê¡¢¤µ¤é¤Ë¡ÖÆɤߡפΰ·¤¤¤Î¼ê´Ö¤ò¸º¤é¤¹¤è¤¦¤ËÆü첽¤µ¤ì¤Æ¤¤¤Þ¤¹¡£ +.RE +½ÐÎϤµ¤ì¤ëº÷°ú¤Î·Á¼°¤Ï¡¢¥¹¥¿¥¤¥ë¥Õ¥¡¥¤¥ë¤Ë½¾¤Ã¤Æ·èÄꤵ¤ì¤Þ¤¹¡£¤Þ¤¿¡¢¼½ñ¥Õ¥¡¥¤¥ë¤òÍ¿¤¨¤ë¤³¤È¤Ë¤è¤ê¡¢º÷°úÃæ¤Î½Ï¸ì¤ÎÆɤߤ¬ÅÐÏ¿¤µ¤ì¤Þ¤¹¡£ +.RE +º÷°ú¤Î³¬Áؤϣ³Ãʳ¬¤Þ¤ÇºîÀ®¤¹¤ë¤³¤È¤¬¤Ç¤¤Þ¤¹¡£ +.SH ¥ª¥×¥·¥ç¥ó +.PP +.TP 10 +\fB-i\fR +º÷°ú¥ê¥¹¥È¥Õ¥¡¥¤¥ë¤¬»ØÄꤵ¤ì¤Æ¤¤¤ë¾ì¹ç¤Ç¤â¡¢É¸½àÆþÎϤòº÷°ú¥ê¥¹¥È¤È¤·¤Æ»ÈÍѤ·¤Þ¤¹¡£ +.TP 10 +\fB-l\fR +º÷°ú¤Î¥½¡¼¥È¤òʸ»ú½ç¤Ç¹Ô¤¤¤Þ¤¹¡£»ØÄꤵ¤ì¤Ê¤±¤ì¤Ðñ¸ì½ç¤Î¥½¡¼¥È¤Ë¤Ê¤ê¤Þ¤¹(¥½¡¼¥ÈÊýË¡¤Ë¤Ä¤¤¤Æ¤Ï¸å½Ò)¡£ +.TP 10 +\fB-q\fR +ÀŽͥ⡼¥É¤Ç¤¹¡£¥¨¥é¡¼¤ª¤è¤Ó·Ù¹ð°Ê³°¤Ïɸ½à¥¨¥é¡¼½ÐÎϤ˽ÐÎϤ·¤Þ¤»¤ó¡£ +.TP 10 +\fB-r\fR +¥Ú¡¼¥¸ÈÏ°Ïɽ¸½¤ò̵¸ú¤Ë¤·¤Þ¤¹¡£»ØÄꤷ¤Ê¤¤¤È¡¢Ï¢Â³¤·¤Æ½Ð¤Æ¤¯¤ëº÷°ú¤Ë¤Ä¤¤¤Æ¤Ï "1--5" ¤Î¤è¤¦¤Ë¥Ú¡¼¥¸ÈϰϤÇɽ¸½¤µ¤ì¤Þ¤¹¡£ +.TP 10 +\fB-c\fR +¥¹¥Ú¡¼¥¹¤ä¥¿¥Ö¤È¤¤¤Ã¤¿¥Ö¥é¥ó¥¯¤òû½Ì¤·¤Æ¡¢¤¹¤Ù¤Æ£±¸Ä¤ÎȾ³Ñ¥¹¥Ú¡¼¥¹¤Ë¤·¤Þ¤¹¡£¤Þ¤¿¡¢Á°¸å¤Î¥Ö¥é¥ó¥¯¤Ïºï½ü¤µ¤ì¤Þ¤¹¡£ +.TP 10 +\fB-g\fR +ÆüËܸì¤ÎƬʸ»ú¤Î¶èÀÚ¤ê¤ò "¤¢¤«¤µ¤¿¡¦¡¦¡¦¤ï" ¤Ë¤·¤Þ¤¹¡£»ØÄꤷ¤Ê¤¤¤È "¤¢¤¤¤¦¤¨¡¦¡¦¡¦¤ï¤ò¤ó" ¤Ë¤Ê¤ê¤Þ¤¹¡£ +.TP 10 +\fB-f\fR +¼½ñ¥Õ¥¡¥¤¥ë¤Ë¤Ê¤¤´Á»ú¤â¶¯À©Åª¤Ë½ÐÎϤ¹¤ë¥â¡¼¥É¤Ç¤¹¡£ +.TP 10 +\fB-s\fI sty\fR +\fIsty\fR ¥Õ¥¡¥¤¥ë¤ò¥¹¥¿¥¤¥ë¥Õ¥¡¥¤¥ë¤È¸«¤Ê¤·¤Þ¤¹¡£¥¹¥¿¥¤¥ë¥Õ¥¡¥¤¥ë¤ò»ØÄꤷ¤Ê¤±¤ì¤Ð¡¢¥Ç¥Õ¥©¥ë¥È¤Îº÷°ú·Á¼°¤ÇºîÀ®¤·¤Þ¤¹¡£ +.TP 10 +\fB-d\fI dic\fR +\fIdic\fR ¥Õ¥¡¥¤¥ë¤ò¼½ñ¥Õ¥¡¥¤¥ë¤È¸«¤Ê¤·¤Þ¤¹¡£¼½ñ¥Õ¥¡¥¤¥ë¤ÏÆüËܸì¤Î <\fI½Ï¸ì\fR\ \fIÆɤß\fR> ¤Î¥ê¥¹¥È¤Ç¹½À®¤µ¤ì¤Þ¤¹¡£ +.TP 10 +\fB-o\fI ind\fR +\fIind\fR ¥Õ¥¡¥¤¥ë¤ò½ÐÎÏ¥Õ¥¡¥¤¥ë¤È¸«¤Ê¤·¤Þ¤¹¡£»ØÄ꤬¤Ê¤¤¾ì¹ç¤ÏºÇ½é¤ÎÆþÎÏ¥Õ¥¡¥¤¥ë¤Î³ÈÄ¥»Ò¤ò.ind¤È¤·¤¿¤â¤Î¡¢ÆþÎÏ¥Õ¥¡¥¤¥ë¤¬É¸½àÆþÎϤΤߤǤ¢¤ì¤Ðɸ½à½ÐÎϤ˽ÐÎϤ·¤Þ¤¹¡£ +.TP 10 +\fB-t\fI log\fR +\fIlog\fR ¥Õ¥¡¥¤¥ë¤ò¥í¥°¥Õ¥¡¥¤¥ë¤È¸«¤Ê¤·¤Þ¤¹¡£»ØÄ꤬¤Ê¤¤¾ì¹ç¤ÏºÇ½é¤ÎÆþÎÏ¥Õ¥¡¥¤¥ë¤Î³ÈÄ¥»Ò¤ò.ilg¤È¤·¤¿¤â¤Î¡¢ÆþÎÏ¥Õ¥¡¥¤¥ë¤¬É¸½àÆþÎϤΤߤǤ¢¤ì¤Ðɸ½à¥¨¥é¡¼½ÐÎϤΤߤ˽ÐÎϤµ¤ì¤Þ¤¹¡£ +.TP 10 +\fB-p\fI no\fR +\fIno\fR ¤òº÷°ú¥Ú¡¼¥¸¤ÎÀèƬ¥Ú¡¼¥¸¤È¤·¤Æ»ØÄꤷ¤Þ¤¹¡£¤Þ¤¿¡¢TeX¤Î.log ¥Õ¥¡¥¤¥ë¤ò»²¾È¤¹¤ë¤³¤È¤Ë¤è¤ê \fIany\fR(ºÇ½ª¥Ú¡¼¥¸¤Î¼¡¤Î¥Ú¡¼¥¸¤«¤é)¡¢\fIodd\fR(ºÇ½ª¥Ú¡¼¥¸¤Î¼¡¤Î´ñ¿ô¥Ú¡¼¥¸¤«¤é)¡¢\fIeven\fR(ºÇ½ª¥Ú¡¼¥¸¤Î¼¡¤Î¶ö¿ô¥Ú¡¼¥¸¤«¤é)¤È¤¤¤Ã¤¿»ØÄê¤Î»ÅÊý¤â²Äǽ¤Ç¤¹¡£ +.TP 10 +\fB-E\fR +´Á»ú¥³¡¼¥É¤òEUC¤Ë»ØÄꤷ¤Þ¤¹¡£ÆþÎÏ¥Õ¥¡¥¤¥ë¡¢½ÐÎÏ¥Õ¥¡¥¤¥ë¤È¤âEUC¤È¤·¤Æ°·¤¤¤Þ¤¹¡£ +.TP 10 +\fB-J\fR +´Á»ú¥³¡¼¥É¤òJIS¤Ë»ØÄꤷ¤Þ¤¹¡£ÆþÎÏ¥Õ¥¡¥¤¥ë¡¢½ÐÎÏ¥Õ¥¡¥¤¥ë¤È¤âJIS¤È¤·¤Æ°·¤¤¤Þ¤¹¡£ +.TP 10 +\fB-S\fR +´Á»ú¥³¡¼¥É¤òShiftJIS¤Ë»ØÄꤷ¤Þ¤¹¡£ÆþÎÏ¥Õ¥¡¥¤¥ë¡¢½ÐÎÏ¥Õ¥¡¥¤¥ë¤È¤âShiftJIS¤È¤·¤Æ°·¤¤¤Þ¤¹¡£ +.TP 10 +\fB-U\fR +´Á»ú¥³¡¼¥É¤òUTF-8¤Ë»ØÄꤷ¤Þ¤¹¡£ÆþÎÏ¥Õ¥¡¥¤¥ë¡¢½ÐÎÏ¥Õ¥¡¥¤¥ë¤È¤âUTF-8¤È¤·¤Æ°·¤¤¤Þ¤¹¡£ + + +.SH ¥¹¥¿¥¤¥ë¥Õ¥¡¥¤¥ë +¥¹¥¿¥¤¥ë¥Õ¥¡¥¤¥ë¤Ï makeindex ¤Î¤â¤Î¤È¾å°Ì¸ß´¹¤Ç¤¹¡£ ·Á¼°¤Ï <\fI¥¹¥¿¥¤¥ë¥Ñ¥é¥á¡¼¥¿\fR\ \fI°ú¿ô\fR> ¤Î¥ê¥¹¥È¤Ç¹½À®¤µ¤ì¤Þ¤¹¡£¥Ñ¥é¥á¡¼¥¿¤Î½ç½ø¤Ï¼«Í³¤Ç¤¹¡£ +°Ê²¼¤Ë¥¹¥¿¥¤¥ë¥Ñ¥é¥á¡¼¥¿¤Î°ìÍ÷¤ò¼¨¤·¤Þ¤¹¡£ +`%'°Ê¹ß¤Ï¥³¥á¥ó¥È¤È¸«¤Ê¤µ¤ì¤Þ¤¹¡£ +.PP +\fB ÆþÎÏ¥Õ¥¡¥¤¥ë¥¹¥¿¥¤¥ë¥Ñ¥é¥á¡¼¥¿\fR +.TP 30 +\fBkeyword\fR <ʸ»úÎó> +"\\\\indexentry" +.RS +º÷°ú¥¨¥ó¥È¥ê¤ò°ú¿ô¤È¤·¤Æ»ý¤Ä¥³¥Þ¥ó¥É¡£ +.RE +.TP 30 +\fBarg_open\fR <ʸ»ú> +\'{\' +.RS +º÷°ú¥¨¥ó¥È¥êʸ»úÎ󳫻Ϥòɽ¤¹Ê¸»ú¡£ +.RE +.TP 30 +\fBarg_close\fR <ʸ»ú> +\'}\' +.RS +º÷°ú¥¨¥ó¥È¥êʸ»úÎó½ªÎ»¤òɽ¤¹Ê¸»ú¡£ +.RE +.TP 30 +\fBrange_open\fR <ʸ»ú> +\'(\' +.RS +¥Ú¡¼¥¸ÈϰϤγ«»Ï¤ò¼¨¤¹Ê¸»ú¡£ +.RE +.TP 30 +\fBrange_close\fR <ʸ»ú> +\')\' +.RS +¥Ú¡¼¥¸ÈϰϤνªÎ»¤ò¼¨¤¹Ê¸»ú¡£ +.RE +.TP 30 +\fBlevel\fR <ʸ»ú> +\'!\' +.RS +½¾Â°¥ì¥Ù¥ë¤Ç¤¢¤ë¤³¤È¤ò¼¨¤¹Ê¸»ú¡£ +.RE +.TP 30 +\fBactual\fR <ʸ»ú> +\'@\' +.RS +¤³¤Î¥·¥ó¥Ü¥ë¤Ë³¤¯Ê¸»úÎ󤬼ºݤκ÷°úʸ»úÎó¤È¤·¤Æ½ÐÎÏ¥Õ¥¡¥¤¥ë¤Ë½ñ¤«¤ì¤ë¡£ +.RE +.TP 30 +\fBencap\fR <ʸ»ú> +\'|\' +.RS +¤³¤Î¥·¥ó¥Ü¥ë¤Ë³¤¯Ê¸»úÎ󤬡¢¥Ú¡¼¥¸ÈÖ¹æ¤ËÉÕ¤¯¥³¥Þ¥ó¥É̾¤È¤·¤Æ»È¤ï¤ì¤ë¡£ +.RE +.TP 30 +\fBpage_compositor\fR <ʸ»úÎó> +"-" +.RS +³¬Áز½¤µ¤ì¤¿¥Ú¡¼¥¸ÈÖ¹æ¤Ë¤ª¤±¤ë³¬Áش֤ζèÀÚ¤êʸ»ú¡£ +.RE +.TP 30 +\fBpage_precedence\fR <ʸ»úÎó> +"rnaRA" +.RS +¥Ú¡¼¥¸ÈÖ¹æ¤ÎµË¡¤ÎÍ¥Àè½ç°Ì¡£\'R\'¤ª¤è¤Ó\'r\'¤Ï¥í¡¼¥Þ¿ô»ú¡¢\'n\'¤Ï¥¢¥é¥Ó¥¢¿ô»ú¡¢\'A\'¤ª¤è¤Ó\'a\'¤Ï¥¢¥ë¥Õ¥¡¥Ù¥Ã¥È¤Ë¤è¤ëµË¡¤òɽ¤¹¡£ +.RE +.TP 30 +\fBquote\fR <ʸ»ú> +\'"\' +.RS +mendex¤Î¥Ñ¥é¥á¡¼¥¿Ê¸»ú¤ËÂФ¹¤ë¥¨¥¹¥±¡¼¥×¥¥ã¥é¥¯¥¿¡£ +.RE +.TP 30 +\fBescape\fR <ʸ»ú> +\'\\\\\' +.RS +°ìÈÌŪ¤Êʸ»ú¤ËÂФ¹¤ë¥¨¥¹¥±¡¼¥×¥¥ã¥é¥¯¥¿¡£ +.RE + +\fB ½ÐÎÏ¥Õ¥¡¥¤¥ë¥¹¥¿¥¤¥ë¥Ñ¥é¥á¡¼¥¿\fR + +\fBpreamble\fR <ʸ»úÎó> +"\\\\begin{theindex}\\n" +.RS +½ÐÎÏ¥Õ¥¡¥¤¥ë¤Îʸ»úÎó¡£ +.RE +.TP 30 +\fBpostamble\fR <ʸ»úÎó> +"\\n\\n\\\\end{theindex}\\n" +.RS +½ÐÎÏ¥Õ¥¡¥¤¥ë¤ÎËöÈø¤Îʸ»úÎó¡£ +.RE +.TP 30 +\fBsetpage_prefix\fR <ʸ»úÎó> +"\\n \\\\setcounter{page}{" +.RS +³«»Ï¥Ú¡¼¥¸¤òÀßÄꤹ¤ë¤È¤¤Î¡¢¥Ú¡¼¥¸ÈÖ¹æ¤ÎÁ°¤ËÉÕ¤±¤ëʸ»úÎó¡£ +.RE +.TP 30 +\fBsetpage_suffix\fR <ʸ»úÎó> +"}\\n" +.RS +³«»Ï¥Ú¡¼¥¸¤òÀßÄꤹ¤ë¤È¤¤Î¡¢¥Ú¡¼¥¸ÈÖ¹æ¤Î¸å¤ËÉÕ¤±¤ëʸ»úÎó¡£ +.RE +.TP 30 +\fBgroup_skip\fR <ʸ»úÎó> +"\\n\\n \\\\indexsapce\\n" +.RS +¿·¹àÌÜ(Ƭʸ»ú)¤ÎÁ°¤ËÁÞÆþ¤¹¤ë½Ä¥¹¥Ú¡¼¥¹¤òɽ¤¹Ê¸»úÎó¡£ +.RE +.TP 30 +\fBlethead_prefix\fR <ʸ»úÎó> +"" +.RS +Ƭʸ»ú¤ÎÁ°¤ËÉÕ¤±¤ë¥³¥Þ¥ó¥Éʸ»úÎó¡£ +.RE +.TP 30 +\fBheading_prefix\fR <ʸ»úÎó> +"" +.RS +lethead_prefix¤ÈƱ¤¸¡£ +.RE +.TP 30 +\fBlethead_suffix\fR <ʸ»úÎó> +"" +.RS +Ƭʸ»ú¤Î¸å¤ËÉÕ¤±¤ë¥³¥Þ¥ó¥Éʸ»úÎó¡£ +.RE +.TP 30 +\fBheading_suffix\fR <ʸ»úÎó> +"" +.RS +lethead_suffix¤ÈƱ¤¸¡£ +.RE +.TP 30 +\fBlethead_flag\fR <ʸ»úÎó> +0 +.RS +Ƭʸ»ú¤Î½ÐÎϤΥե饰¡£0¤Î¤È¤½ÐÎϤ·¤Ê¤¤¡£0¤è¤êÂ礤¤¤È¤¤Ï±Ñ»ú¤òÂçʸ»ú¤Ç¡¢0¤è¤ê¾®¤µ¤¤¤È¤¤Ï¾®Ê¸»ú¤Ç½ÐÎϤ¹¤ë¡£ +.RE +.TP 30 +\fBheading_flag\fR <ʸ»úÎó> +0 +.RS +lethead_flag¤ÈƱ¤¸¡£ +.RE +.TP 30 +\fBitem_0\fR <ʸ»úÎó> +"\\n \\\\item " +.RS +¼ç¥¨¥ó¥È¥ê´Ö¤ËÁÞÆþ¤¹¤ë¥³¥Þ¥ó¥É¡£ +.RE +.TP 30 +\fBitem_1\fR <ʸ»úÎó> +"\\n \\\\subitem " +.RS +¥µ¥Ö¥¨¥ó¥È¥ê´Ö¤ËÁÞÆþ¤¹¤ë¥³¥Þ¥ó¥É¡£ +.RE +.TP 30 +\fBitem_2\fR <ʸ»úÎó> +"\\n \\\\subsubitem " +.RS +¥µ¥Ö¥µ¥Ö¥¨¥ó¥È¥ê´Ö¤ËÁÞÆþ¤¹¤ë¥³¥Þ¥ó¥É¡£ +.RE +.TP 30 +\fBitem_01\fR <ʸ»úÎó> +"\\n \\\\subitem " +.RS +¼ç¡Á¥µ¥Ö¥¨¥ó¥È¥ê´Ö¤ËÁÞÆþ¤¹¤ë¥³¥Þ¥ó¥É¡£ +.RE +.TP 30 +\fBitem_x1\fR <ʸ»úÎó> +"\\n \\\\subitem " +.RS +¼ç¡Á¥µ¥Ö¥¨¥ó¥È¥ê´Ö¤ËÁÞÆþ¤¹¤ë¥³¥Þ¥ó¥É¡£(¼ç¥¨¥ó¥È¥ê¤Ë¥Ú¡¼¥¸Èֹ椬¤Ê¤¤¤È¤) +.RE +.TP 30 +\fBitem_12\fR <ʸ»úÎó> +"\\n \\\\subsubitem " +.RS +¥µ¥Ö¡Á¥µ¥Ö¥µ¥Ö¥¨¥ó¥È¥ê´Ö¤ËÁÞÆþ¤¹¤ë¥³¥Þ¥ó¥É¡£ +.RE +.TP 30 +\fBitem_x2\fR <ʸ»úÎó> +"\\n \\\\subsubitem " +.RS +¥µ¥Ö¡Á¥µ¥Ö¥µ¥Ö¥¨¥ó¥È¥ê´Ö¤ËÁÞÆþ¤¹¤ë¥³¥Þ¥ó¥É¡£(¥µ¥Ö¥¨¥ó¥È¥ê¤Ë¥Ú¡¼¥¸Èֹ椬¤Ê¤¤¤È¤) +.RE +.TP 30 +\fBdelim_0\fR <ʸ»úÎó> +", " +.RS +¼ç¥¨¥ó¥È¥ê¤ÈºÇ½é¤Î¥Ú¡¼¥¸ÈÖ¹æ¤Î´Ö¤Î¶èÀÚ¤êʸ»úÎó¡£ +.RE +.TP 30 +\fBdelim_1\fR <ʸ»úÎó> +", " +.RS +¥µ¥Ö¥¨¥ó¥È¥ê¤ÈºÇ½é¤Î¥Ú¡¼¥¸ÈÖ¹æ¤Î´Ö¤Î¶èÀÚ¤êʸ»úÎó¡£ +.RE +.TP 30 +\fBdelim_2\fR <ʸ»úÎó> +", " +.RS +¥µ¥Ö¥µ¥Ö¥¨¥ó¥È¥ê¤ÈºÇ½é¤Î¥Ú¡¼¥¸ÈÖ¹æ¤Î´Ö¤Î¶èÀÚ¤êʸ»úÎó¡£ +.RE +.TP 30 +\fBdelim_n\fR <ʸ»úÎó> +", " +.RS +¥Ú¡¼¥¸ÈÖ¹æ´Ö¤Î¶èÀÚ¤êʸ»úÎ󡣤ɤΥ¨¥ó¥È¥ê¥ì¥Ù¥ë¤Ë¤â¶¦ÄÌ¡£ +.RE +.TP 30 +\fBdelim_r\fR <ʸ»úÎó> +"--" +.RS +¥Ú¡¼¥¸ÈϰϤò¼¨¤¹¤È¤¤Î¡¢¥Ú¡¼¥¸ÈÖ¹æ´Ö¤Î¶èÀÚ¤êʸ»úÎó¡£ +.RE +.TP 30 +\fBdelim_t\fR <ʸ»úÎó> +"" +.RS +¥Ú¡¼¥¸ÈÖ¹æ¤Î¥ê¥¹¥È¤Î½ªÃ¼¤Ë½ÐÎϤ¹¤ëʸ»úÎó¡£ +.RE +.TP 30 +\fBsuffix_2p\fR <ʸ»úÎó> +"" +.RS +¥Ú¡¼¥¸Èֹ椬2¥Ú¡¼¥¸Ï¢Â³¤¹¤ë¾ì¹ç¤Ë¡¢delim_n ¤È2¥Ú¡¼¥¸ÌܤÎÈÖ¹æ¤ÎÂå¤ï¤ê¤ËÉղ乤ëʸ»úÎó¡£ +.RE +ʸ»úÎó¤¬ÄêµÁ¤µ¤ì¤Æ¤¤¤ë¾ì¹ç¤Ë¤Î¤ß͸ú¡£ +.RE +.TP 30 +\fBsuffix_3p\fR <ʸ»úÎó> +"" +.RS +¥Ú¡¼¥¸Èֹ椬3¥Ú¡¼¥¸Ï¢Â³¤¹¤ë¾ì¹ç¤Ë¡¢delim_r ¤È3¥Ú¡¼¥¸ÌܤÎÈÖ¹æ¤ÎÂå¤ï¤ê¤ËÉղ乤ëʸ»úÎó¡£suffix_mp ¤è¤êÍ¥À褵¤ì¤ë¡£ +.RE +ʸ»úÎó¤¬ÄêµÁ¤µ¤ì¤Æ¤¤¤ë¾ì¹ç¤Ë¤Î¤ß͸ú¡£ +.RE +.TP 30 +\fBsuffix_mp\fR <ʸ»úÎó> +"" +.RS +¥Ú¡¼¥¸Èֹ椬3¥Ú¡¼¥¸¤Þ¤¿¤Ï¤½¤ì°Ê¾åϢ³¤¹¤ë¾ì¹ç¤Ë¡¢delim_r ¤ÈËöÈø¤Î¥Ú¡¼¥¸ÈÖ¹æ¤ÎÂå¤ï¤ê¤ËÉղ乤ëʸ»úÎó¡£ +.RE +ʸ»úÎó¤¬ÄêµÁ¤µ¤ì¤Æ¤¤¤ë¾ì¹ç¤Ë¤Î¤ß͸ú¡£ +.RE +.TP 30 +\fBencap_prefix\fR <ʸ»úÎó> +"\\\\" +.RS +¥Ú¡¼¥¸ÈÖ¹æ¤Ë¥³¥Þ¥ó¥É¤òÉÕ¤±¤ë¤È¤¤Î¡¢¥³¥Þ¥ó¥É̾¤ÎÁ°¤ËÉÕ¤±¤ëʸ»úÎó¡£ +.RE +.TP 30 +\fBencap_infix\fR <ʸ»úÎó> +"{" +.RS +¥Ú¡¼¥¸ÈÖ¹æ¤Ë¥³¥Þ¥ó¥É¤òÉÕ¤±¤ë¤È¤¤Î¡¢¥Ú¡¼¥¸ÈÖ¹æ¤ÎÁ°¤ËÉÕ¤±¤ëʸ»úÎó¡£ +.RE +.TP 30 +\fBencap_suffix\fR <ʸ»úÎó> +"}". +.RS +¥Ú¡¼¥¸ÈÖ¹æ¤Ë¥³¥Þ¥ó¥É¤òÉÕ¤±¤ë¤È¤¤Î¡¢¥Ú¡¼¥¸ÈÖ¹æ¤Î¸å¤ËÉÕ¤±¤ëʸ»úÎó¡£ +.RE +.TP 30 +\fBline_max\fR <¿ôÃÍ> +72 +.RS +£±¹Ô¤ÎºÇÂçʸ»ú¿ô¡£¤½¤ì¤òĶ¤¨¤ë¤ÈÀÞ¤êÊÖ¤¹¡£ +.RE +.TP 30 +\fBindent_space\fR <ʸ»úÎó> +"\t\t" +.RS +ÀÞ¤êÊÖ¤·¤¿¹Ô¤ÎƬ¤ËÁÞÆþ¤¹¤ë¥¹¥Ú¡¼¥¹¡£ +.RE +.TP 30 +\fBindent_length\fR <¿ôÃÍ> +16 +.RS +ÀÞ¤êÊÖ¤·¤¿¹Ô¤ÎƬ¤ËÁÞÆþ¤µ¤ì¤ë¥¹¥Ú¡¼¥¹¤ÎŤµ¡£ +.RE +.TP 30 +\fBsymhead_positive\fR <ʸ»úÎó> +"Symbols" +.RS +lethead_flag ¤Þ¤¿¤Ï heading_flag ¤¬Àµ¿ô¤Î¾ì¹ç¤Ë¿ô»ú¡¦µ¹æ¤ÎƬʸ»ú¤È¤·¤Æ½ÐÎϤ¹¤ëʸ»úÎó¡£ +.RE +.TP 30 +\fBsymhead_negative\fR <ʸ»úÎó> +"symbols" +.RS +lethead_flag ¤Þ¤¿¤Ï heading_flag ¤¬Éé¿ô¤Î¾ì¹ç¤Ë¿ô»ú¡¦µ¹æ¤ÎƬʸ»ú¤È¤·¤Æ½ÐÎϤ¹¤ëʸ»úÎó¡£ +.RE +.TP 30 +\fBsymbol\fR <ʸ»úÎó> +"" +.RS +symbol_flag ¤¬0¤Ç¤Ê¤¤¾ì¹ç¤Ë¡¢¿ô»ú¡¦µ¹æ¤ÎƬʸ»ú¤È¤·¤Æ½ÐÎϤ¹¤ëʸ»úÎó¡£ +.RE +ʸ»úÎó¤¬ÄêµÁ¤µ¤ì¤Æ¤¤¤ì¤Ð¡¢symhead_positive ¤ª¤è¤Ó symhead_negative ¤è¤êÍ¥À褵¤ì¤ë¡£(mendexÀìÍÑ) +.RE +¤³¤Î¥Ñ¥é¥á¡¼¥¿¤¬ÄêµÁ¤µ¤ì¤¿¾ì¹ç¡¢symhead_positive ¤ª¤è¤Ó symhead_negative ¤è¤êÍ¥À褵¤ì¤ë¡£(mendexÀìÍÑ) +.RE +.TP 30 +\fBsymbol_flag\fR <¿ôÃÍ> +1 +.RS +¿ô»ú¡¦µ¹æ¤ÎƬʸ»ú¤Î½ÐÎϥե饰¡£0¤Î¤È¤½ÐÎϤ·¤Ê¤¤¡£(mendexÀìÍÑ) +.RE +.TP 30 +\fBletter_head\fR <¿ôÃÍ> +1 +.RS +ÆüËܸì¤ÎƬʸ»ú¤Î½ÐÎϤΥե饰¡£0¤Î¤È¤½ÐÎϤ·¤Ê¤¤¡£1¤Î¤È¤¥«¥¿¥«¥Ê¡¢2¤Î¤È¤¤Ò¤é¤¬¤Ê¤Ç½ÐÎϤ¹¤ë¡£(mendexÀìÍÑ) +.RE +.TP 30 +\fBpriority\fR <¿ôÃÍ> +0 +.RS +±Ñ»ú¤ÈÆüËܸì¤È¤Îº®ºß¤·¤¿º÷°ú¸ì¤Î¥½¡¼¥ÈÊýË¡¤Ë¤Ä¤¤¤Æ¤Î¥Õ¥é¥°¡£0¤Ç¤Ê¤±¤ì¤Ð±Ñ»ú¤ÈÆüËܸì¤È¤Î´Ö¤ËȾ³Ñ¥¹¥Ú¡¼¥¹¤òÆþ¤ì¤¿¾õÂ֤ǥ½¡¼¥È¤¹¤ë¡£(mendexÀìÍÑ) +.RE +.TP 30 +\fBcharacter_order\fR <ʸ»úÎó> +"SEJ" +.RS +µ¹æ¡¢±Ñ»ú¡¢ÆüËܸì¤ÎÍ¥Àè½ç°Ì¡£\'S\'¤Ïµ¹æ¡¢\'E\'¤Ï±Ñ»ú¡¢\'J\'¤ÏÆüËܸì¤òɽ¤¹¡£(mendexÀìÍÑ) +.RE +.PP +.SH ÆüËܸì¤Î°·¤¤¤Ë¤Ä¤¤¤Æ +.PP +\fImendex\fR ¤ÏÆüËܸì¤Îº÷°ú¤ò¤Ç¤¤ë¤À¤±³Ú¤Ë°·¤¨¤ë¤è¤¦¤Ë¤Ê¤Ã¤Æ¤¤¤Þ¤¹¡£ +.RE +makeindex¤Ç¤ÏÆüËܸì¤Îº÷°ú¤¬Àµ¤·¤¯¼½ñ½ç¤Ë¥½¡¼¥È¤¹¤ë¤¿¤á¤Ë¤Ï¤Ò¤é¤¬¤Ê¤Þ¤¿¤Ï¥«¥¿¥«¥Ê¤Ë·¤¨¡¢Ù¹²»¡¢Ùû²»¡¢ÂùÅÀ¤ò½ü¤¤¤¿ÆɤߤòÉÕ¤±¤Ê¤±¤ì¤Ð¤Ê¤ê¤Þ¤»¤ó¤Ç¤·¤¿(¼«Æ°Åª¤Ë·¤¨¤ë¥Ð¡¼¥¸¥ç¥ó¤â¤¢¤ë)¡£ +.RE +mendex¤Ç¤Ï¥«¥Ê¤Ë¤Ä¤¤¤Æ¤Ï¤¹¤Ù¤Æ¼«Æ°Åª¤Ë·¤¨¡¢¤Þ¤¿´Á»ú¤Ë¤Ä¤¤¤Æ¤Ï¼½ñ¥Õ¥¡¥¤¥ë¤òÀßÄꤹ¤ë¤³¤È¤Ë¤è¤ê³Æº÷°ú¸ì¤´¤È¤ËÆɤߤòÉÕ¤±¤ëºî¶È¤ò¤«¤Ê¤ê²ò¾Ã¤Ç¤¤Þ¤¹¡£ + +.LP +°Ê²¼¤ËÆâÉô¤Ç¤Î¥«¥Ê¤ÎÊÑ´¹Îã¤ò¼¨¤·¤Þ¤¹¡£ +.PP +.RS +.br +¤«¤Ö¤·¤¤¬¤¤¤·¤ã ¤«¤Õ¤·¤¤«¤¤¤·¤ä +.br +¥Þ¥Ã¥¥ó¥È¥Ã¥·¥å ¤Þ¤Ä¤¤ó¤È¤Ä¤·¤æ +.br +¥ï¡¼¥×¥í ¤ï¤¢¤Õ¤í +.RE +.LP +¼½ñ¥Õ¥¡¥¤¥ë¤Ï<\fI½Ï¸ì\ \ Æɤß\fR>¤Î¥ê¥¹¥È¤Ç¹½À®¤µ¤ì¤Þ¤¹¡£ +½Ï¸ì¤ÈÆɤߤζèÀÚ¤ê¤Ï¥¿¥Ö¤Þ¤¿¤Ï¥¹¥Ú¡¼¥¹¤Ç¤¹¡£ +.RE +°Ê²¼¤Ë¼½ñ¤ÎÎã¤ò¼¨¤·¤Þ¤¹¡£ +.PP +.RS +.br +´Á»ú ¤«¤ó¤¸ +.br +ÆÉ¤ß ¤è¤ß +.br +´Ä¶ ¤«¤ó¤¤ç¤¦ +.br +¦Á ¥¢¥ë¥Õ¥¡ +.RE +.LP +¼½ñ¤ËÅÐÏ¿¤¹¤ë½Ï¸ì¤Ë¤Ä¤¤¤Æ¤Ï¡¢ÆɤßÊý¤¬£±Ä̤ê¤Ë¤Ê¤ë¤è¤¦Á÷¤ê²¾Ì¾¤òÉÕ¤±¤Æ¤¯¤À¤µ¤¤¡£ +¡Öɽ¡×¡¢¡ÖÀ¼Á¡×¤Î¤è¤¦¤ËÁ÷¤ê²¾Ì¾¤Ë¤è¤é¤º£²Ä̤ê¤ÎÆɤßÊý¤¬¤Ç¤¤ë¸ì¤Ë¤Ä¤¤¤Æ¤Ï¤É¤Á¤é¤«£±¤Ä¤·¤«ÅÐÏ¿¤Ç¤¤Þ¤»¤ó¡£Â¾¤ÎÆɤßÊý¤Ë¤Ä¤¤¤Æ¤Ï³Æº÷°ú¸ì¤ØÆɤߤòÉÕ¤±¤ë¤³¤È¤ÇÂбþ¤·¤Æ¤¯¤À¤µ¤¤¡£ +.RE +¤Þ¤¿¡¢´Ä¶ÊÑ¿ô<\fIINDEXDEFAULTDICTIONARY\fR>¤Ë¼½ñ¥Õ¥¡¥¤¥ë¤òÅÐÏ¿¤¹¤ë¤³¤È¤Ë¤è¤ê¡¢¼«Æ°Åª¤Ë¼½ñ¤ò»²¾È¤·¤Þ¤¹¡£´Ä¶ÊÑ¿ô¤ËÅÐÏ¿¤·¤¿¼½ñ¤Ï -d ¤Ç»ØÄꤷ¤¿¼½ñ¤ÈÊ»ÍѤǤ¤Þ¤¹¡£ +.PP +.SH ¥½¡¼¥ÈÊýË¡¤Ë¤Ä¤¤¤Æ +.PP +\fImendex\fR ¤ÏÄ̾ï¤ÏÆþÎϤµ¤ì¤¿º÷°ú¸ì¤ò¤½¤Î¤Þ¤Þ¥½¡¼¥È¤·¤Þ¤¹¡£\fI-l\fR¥ª¥×¥·¥ç¥ó¤¬ÉÕ¤±¤é¤ì¤¿¾ì¹ç¡¢Ê£¿ô¤Îñ¸ì¤Ç¹½À®¤µ¤ì¤ëº÷°ú¸ì¤Ë¤Ä¤¤¤Æ¤Ï¡¢¥½¡¼¥È¤¹¤ë¤È¤¤Ëñ¸ì¤Èñ¸ì¤Î´Ö¤Î¥¹¥Ú¡¼¥¹¤òµÍ¤á¤Æ¥½¡¼¥È¤·¤Þ¤¹¡£ +¤³¤³¤Ç¤ÏÁ°¼Ô¤òñ¸ì½ç¥½¡¼¥È¡¢¸å¼Ô¤òʸ»ú½ç¥½¡¼¥È¤È¸Æ¤Ö¤³¤È¤Ë¤·¤Þ¤¹¡£ +.RE +ʸ»ú½ç¥½¡¼¥È¤Î¾ì¹ç¡¢¼ÂºÝ¤Ë½ÐÎϤµ¤ì¤ëʸ»úÎó¤Ï¥¹¥Ú¡¼¥¹¤ò´Þ¤ó¤À¾õÂ֤Τâ¤Î¤Ç¤¹¤Î¤Ç¡¢º÷°ú¸ì¼«ÂΤ¬ÊѲ½¤¹¤ë¤³¤È¤Ï¤¢¤ê¤Þ¤»¤ó¡£ +.RE +°Ê²¼¤ËÎã¤ò¼¨¤·¤Þ¤¹¡£ +.PP +.RS +\fIñ¸ì½ç¥½¡¼¥È ʸ»ú½ç¥½¡¼¥È\fR +.br +X Window Xlib +.br +Xlib XView +.br +XView X Window +.RE +.LP +¤Þ¤¿¡¢ÆüËܸì¡Á±Ñ»ú´Ö¤Ç¤â»÷¤¿¤è¤¦¤Ê¥½¡¼¥ÈÊýË¡¤¬¤¢¤ê¤Þ¤¹¡£¥¹¥¿¥¤¥ë¥Õ¥¡¥¤¥ë¤Ç\fIpriority\fR¤ò£°°Ê³°¤Ë»ØÄꤷ¤¿¾ì¹ç¡¢ÎÙÀܤ·¤¿ÆüËܸì¤È±Ñ»ú¤Î´Ö¤Ë¥¹¥Ú¡¼¥¹¤òÆþ¤ì¤Æ¥½¡¼¥È¤·¤Þ¤¹¡£ +.RE +°Ê²¼¤ËÎã¤ò¼¨¤·¤Þ¤¹¡£ +.PP +.RS +\fIpriority=0 priority=1\fR +.br +index sort ind¥Õ¥¡¥¤¥ë +.br +ind¥Õ¥¡¥¤¥ë index sort +.RE +.PP +.SH ´Ä¶ÊÑ¿ô +\fImendex\fR ¤Ç¤Ï°Ê²¼¤Î¤è¤¦¤Ê´Ä¶ÊÑ¿ô¤ò»ÈÍѤ·¤Æ¤¤¤Þ¤¹¡£ +.PP +.TP 10 +\fIINDEXSTYLE\fR +º÷°ú¥¹¥¿¥¤¥ë¥Õ¥¡¥¤¥ë¤¬¤¢¤ë¥Ç¥£¥ì¥¯¥È¥ê +.TP 10 +\fIINDEXDEFAULTSTYLE\fR +¥Ç¥Õ¥©¥ë¥È¤Ç»²¾È¤¹¤ëº÷°ú¥¹¥¿¥¤¥ë¥Õ¥¡¥¤¥ë +.TP 10 +\fIINDEXDICTIONARY\fR +¼½ñ¤¬¤¢¤ë¥Ç¥£¥ì¥¯¥È¥ê +.TP 10 +\fIINDEXDEFAULTDICTIONARY\fR +¾ï¤Ë»²¾È¤¹¤ë¼½ñ¥Õ¥¡¥¤¥ë +.PP +.SH ¾ÜºÙ¤Ë¤Ä¤¤¤Æ +¤½¤Î¾¡¢¾ÜºÙ¤Ë¤Ä¤¤¤Æ¤Ï \fImakeindex\fR ¤Ë½àµò¡£ +.PP +.SH ÌäÂêÅÀÅù +¥Õ¥¡¥¤¥ë̾¤ÎÀèƬ¤Îʸ»ú¤¬ '-' ¤Ç¤¢¤ë¥Õ¥¡¥¤¥ë¤Ï°·¤¨¤Þ¤»¤ó¡£ + +Ê£¿ô¤Î¥Ú¡¼¥¸µË¡¤ò»ÈÍѤ¹¤ë¾ì¹ç¡¢¥Ú¡¼¥¸½ç¤Ë.idx¥Õ¥¡¥¤¥ë¤òÍ¿¤¨¤Ê¤¤¤È¥Ú¡¼¥¸ÈÖ¹æ¤ò¸íǧ¤¹¤ë¤³¤È¤¬¤¢¤ê¤Þ¤¹¡£ +.PP +.SH »²¾È +tex(l), latex(l), makeindex(l) +.RE diff --git a/Master/texmf-dist/doc/man/man1/mendex.man1.pdf b/Master/texmf-dist/doc/man/man1/mendex.man1.pdf Binary files differnew file mode 100644 index 00000000000..0c86d8a3eb5 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mendex.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/mf-nowin.1 b/Master/texmf-dist/doc/man/man1/mf-nowin.1 new file mode 100644 index 00000000000..3ba4214d4c6 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mf-nowin.1 @@ -0,0 +1 @@ +.so man1/mf.1 diff --git a/Master/texmf-dist/doc/man/man1/mf-nowin.man1.pdf b/Master/texmf-dist/doc/man/man1/mf-nowin.man1.pdf Binary files differnew file mode 100644 index 00000000000..b25a7ab3e43 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mf-nowin.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/mf.1 b/Master/texmf-dist/doc/man/man1/mf.1 new file mode 100644 index 00000000000..344020c1b02 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mf.1 @@ -0,0 +1,484 @@ +.\" t +.TH MF 1 "1 March 2011" "Web2C 2012" +.\"===================================================================== +.if n .ds MF Metafont +.if t .ds MF M\s-2ETAFONT\s0 +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff +.el .ds OX TeX for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.if n .ds WB Web +.if t .ds WB W\s-2EB\s0 +.\"===================================================================== +.SH NAME +mf, mf-nowin, inimf, virmf \- Metafont, a language for font and logo design +.SH SYNOPSIS +.B mf +.RI [ options ] +.RI [ commands ] +.\"===================================================================== +.SH DESCRIPTION +\*(MF reads the program in the specified files +and outputs font rasters (in +.I gf +format) and font metrics (in +.I tfm +format). The \*(MF +language is described in +.IR "The \*(MF\^book" . +.PP +Like +\*(TX, \*(MF +is normally used with a large body of precompiled macros, and font generation +in particular requires the support of several macro files. This +version of \*(MF looks at its command line to see what name it was +called under. Both +.B inimf +and +.B virmf +are symlinks to the +.B mf +executable. When called as +.BR inimf +(or when the +.B -ini +option is given) it can be used to precompile macros into a +.I .base +file. When called as +.B virmf +it will use the +.I plain +base. When called under any other name, \*(MF will use that name as +the name of the base to use. For example, when called as +.B mf +the +.I mf +base is used, which is identical to the +.I plain +base. Other bases than +.I plain +are rarely used. +.PP +The +.I commands +given on the command line to the \*(MF program are passed to it as the +first input line. (But it is often easier to type extended arguments +as the first input line, since UNIX shells tend to gobble up or +misinterpret \*(MF's favorite symbols, like semicolons, unless you +quote them.) As described in +.IR "The \*(MF\^book" , +that first line should begin with a filename, a +.RI \e controlsequence , +or a +.IR &basename . +.PP +The normal usage is to say +.IP +\fBmf\ \fP '\\\|mode=<printengine>\^;\^ [\^mag=magstep(\fI\^n\fP\^)\^;\^]' input\ \^\fI font \fP +.PP +to start processing +.IR font.mf . +The single quotes are the best way of keeping the Unix +shell from misinterpreting the semicolons and +from removing the \\ character, which is needed here to +keep \*(MF from thinking that you want to produce a font called +.IR mode . +(Or you can just say +.I mf +and give the other stuff on the next line, without quotes.) Other +control sequences, such as +.I batchmode +(for silent operation) can also appear. +The name +.I font +will be the ``jobname'', and is used in forming +output file names. +If \*(MF doesn't get a file name in the first line, +the jobname is +.IR mfput . +The default extension, +.IR .mf , +can be overridden by specifying an extension explicitly. +.PP +A log of error messages goes into the file \fIjobname\fP\fB\^.\^\fP\fIlog\fP. +The output files are \fIjobname\fP\fB\^.\^\fP\fItfm\fP and +\fIjobname\fP\fB\^.\^\fP\fI<\fP\^number\^\fI>gf\fP, where <number> depends on +the resolution and magnification of the font. The +.I mode +in this +example is shown generically as <printengine>, a symbolic term for which +the name of an actual device or, most commonly, the name +.I localfont +(see below) must +be substituted. If the mode is not specified or is not valid for your +site, \*(MF will default to +.I proof +mode which produces +large character images for use in font design and refinement. Proof +mode can be recognized by the suffix +.I .2602gf +after the jobname. Examples of proof mode output can be found +in +.I "Computer Modern Typefaces" +(Volume E of +.IR "Computers and Typesetting" ). +The system of +.I magsteps +is identical to the system used by +\*(TX, +with values generally in the range 0.5, 1.0, 2.0, 3.0, 4.0 and 5.0. +A listing of +.I gf +numbers for 118-dpi, 240-dpi and 300-dpi fonts +is shown below. +.TS +tab(:); +c c c c +l l l l. +MAGSTEP:118 dpi:240 dpi:300 dpi +mag=magstep(0):118:240:300 +mag=magstep(0.5):129:263:329 +mag=magstep(1):142:288:360 +mag=magstep(2):170:346:432 +mag=magstep(3):204:415:518 +mag=magstep(4):245:498:622 +mag=magstep(5):294:597:746 +.TE +.PP +Magnification can also be specified not as a magstep but as an +arbitrary value, such as 1.315, to create special character sizes. +.PP +Before font production can begin, it is necessary to set up the +appropriate base files. The minimum set of components for font +production for a given print-engine is the +.I plain.mf +macro file +and the local +.I mode_def +file. The macros in +.I plain.mf +can be +studied in an appendix to the +.IR "\*(MF\^book" ; +they were developed by Donald E. Knuth, and this file should never be +altered except when it is officially upgraded. +Each +.I mode_def +specification helps adapt fonts to a particular print-engine. +There is a regular discussion of +.IR mode_def s +in +.IR TUGboat , +the journal of the +\*(TX +Users Group. +The local ones in use on this computer should be in +.IR modes.mf . +.PP +The +.I e +response to \*(MF\|'s error-recovery mode invokes the +system default +editor at the erroneous line of the source file. +There is an environment variable, MFEDIT, +that overrides the default editor. +It should contain a string with "%s" indicating where the +filename goes and "%d" indicating where the decimal linenumber (if any) goes. +For example, an MFEDIT string for the +.B vi +editor can be set with the +.B csh +command +.RS +\fIsetenv MFEDIT "vi +%d %s"\fP +.RE +.PP +A convenient file in the library is +.IR null.mf , +containing nothing. +When +.B mf +can't find the file it thinks you want to input, it keeps +asking you for another file name; responding `null' gets you out +of the loop if you don't want to input anything. +.\"===================================================================== +.SH "ONLINE GRAPHICS OUTPUT" +\*(MF can use most modern displays, so you can see its output +without printing. Chapter 23 of +.I "The \*(MF\^book" +describes what you can do. This implementation of \*(MF uses +environment variables to determine which display device you want to use. +First it looks for a variable MFTERM, and then for TERM. +If it can't find either, you get no online output. Otherwise, the value +of the variable determines the device to use: +.BR hp2627 , +.B sun +(for old SunView), +.BR tek , +.B uniterm +(for an Atari ST Tek 4014 emulator), +.B xterm +(for either X10 or X11). +Some of these devices may not be supported in all \*(MF +executables; the choice is made at compilation time. +.PP +On some systems, there are two \*(MF binaries, +.B mf +and +.BR mf-nowin . +On those systems the +.B mf +binary supports graphics, while the +.B mf-nowin +binary does not. The +.B mf-nowin +binary is used by scripts like +.B mktexpk +where graphics support is a nuisance rather than something helpful. +.\"===================================================================== +.SH OPTIONS +This version of \*(MF understands the following command line options. +.TP +.BI -base \ base +Use +.I base +as the name of the base to be used, instead of the name by which +\*(MF was called or a +.I %& +line. +.TP +.B -file-line-error +Print error messages in the form +.I file:line:error +which is similar to the way many compilers format them. +.TP +.B -no-file-line-error +Disable printing error messages in the +.I file:line:error +style. +.TP +.B -file-line-error-style +This is the old name of the +.B -file-line-error +option. +.TP +.B -halt-on-error +Exit with an error code when an error is encountered during processing. +.TP +.B -help +Print help message and exit. +.TP +.B -ini +Be +.BR inimf , +for dumping bases; this is implicitly true if the program is called +as +.BR inimf . +.TP +.BI -interaction \ mode +Sets the interaction mode. The mode can be one of +.IR batchmode , +.IR nonstopmode , +.IR scrollmode , +and +.IR errorstopmode . +The meaning of these modes is the same as that of the corresponding +commands. +.TP +.BI -jobname \ name +Use +.I name +for the job name, instead of deriving it from the name of the input file. +.TP +.BI -kpathsea-debug \ bitmask +Sets path searching debugging flags according to the bitmask. See the +.I Kpathsea +manual for details. +.TP +.BI -maketex \ fmt +Enable +.RI mktex fmt , +where +.I fmt +must be +.IR mf . +.TP +.BI -no-maketex \ fmt +Disable +.RI mktex fmt , +where +.I fmt +must be +.IR mf . +.TP +.BI -output-directory \ directory +Write output files in +.I directory +instead of the current directory. Look up input files in +.I directory +first, the along the normal search path. +.TP +.B -parse-first-line +If the first line of the main input file begins with +.I %& +parse it to look for a dump name or a +.B -translate-file +option. +.TP +.B -no-parse-first-line +Disable parsing of the first line of the main input file. +.TP +.BI -progname \ name +Pretend to be program +.IR name . +This affects both the format used and the search paths. +.TP +.B -recorder +Enable the filename recorder. This leaves a trace of the files opened +for input and output in a file with extension +.IR .fls . +.TP +.BI -translate-file \ tcxname +Use the +.I tcxname +translation table. +.TP +.B -version +Print version information and exit. +.\"===================================================================== +.SH ENVIRONMENT +See the Kpathsearch library documentation (the `Path specifications' +node) for the details of how the environment variables are use when +searching. The +.B kpsewhich +utility can be used to query the values of the variables. +.PP +If the environment variable +.B TEXMFOUTPUT +is set, \*(MF attempts to put its output +files in it, if they cannot be put in the current directory. Again, see +.BR tex (1). +.TP +.B MFINPUTS +Search path for +.I input +and +.I openin +files. +.TP +.B MFEDIT +Command template for switching to editor. +.TP +.B MFTERM +Determines the online graphics display. If MFTERM is not set, +and DISPLAY is set, the Metafont window support for X is used. +(DISPLAY must be set to a valid X server specification, as usual.) +If neither MFTERM nor DISPLAY is set, TERM is used to guess the window +support to use. +.\"===================================================================== +.SH "FONT UTILITIES" +A number of utility programs are available. +The following is a partial list of available utilities and their purpose. +Consult your local \*(MF guru for details. +.br +.TP \w'gftodvi'u+2n +.B gftopk +Takes a +.I gf +file and produces a more tightly packed +.I pk +font file. +.TP +.B gftodvi +Produces proof sheets for fonts. +.TP +.B gftype +Displays the contents of a +.I gf +file in mnemonics and/or images. +.TP +.B pktype +Mnemonically displays the contents of a +.I pk +file. +.TP +.B mft +Formats a source file as shown in +.IR "Computer Modern Typefaces" . +.\"===================================================================== +.SH "FILES" +.TP +.I "mf.pool" +Encoded text of \*(MF's messages. +.TP +.I *.base +Predigested \*(MF base files. +.TP +.I $TEXMFMAIN/metafont/base/plain.mf +The standard base. +.TP +.I $TEXMFMAIN/metafont/misc/modes.mf +The file of +.IR mode_def s +for your site's various printers +.\"===================================================================== +.SH NOTES +This manual page is not meant to be exhaustive. The complete +documentation for this version of \*(MF can be found in the info manual +.IR "Web2C: A TeX implementation" . +.\"===================================================================== +.SH BUGS +On January 4, 1986 the ``final'' bug in \*(MF was discovered +and removed. If an error still lurks in the code, Donald E. Knuth promises to +pay a finder's fee which doubles every year to the first person who finds +it. Happy hunting. +.\"===================================================================== +.SH "SUGGESTED READING" +Donald E. Knuth, +.I "The \*(MF\^book" +(Volume C of +.IR "Computers and Typesetting" ), +Addison-Wesley, 1986, ISBN 0-201-13445-4. +.br +Donald E. Knuth, +.I "\*(MF:\^ The Program" +(Volume D of +.IR "Computers and Typesetting" ), +Addison-Wesley, 1986, ISBN 0-201-13438-1. +.br +Donald E. Knuth, +.I Computer Modern Typefaces +(Volume E of +.IR "Computers and Typesetting" ), +Addison-Wesley, 1986, ISBN 0-201-13446-2. +.br +.I TUGboat +(the journal of the \*(TX Users Group). +.\"===================================================================== +.SH COMMENTS +Warning: ``Type design can be hazardous to your other interests. +Once you get hooked, you will develop intense feelings about letterforms; +the medium will intrude on the messages that you read. +And you will perpetually be thinking of improvements to the fonts that +you see everywhere, especially those of your own design.'' +.\"===================================================================== +.SH "SEE ALSO" +.BR gftopk (1), +.BR gftodvi (1), +.BR gftype (1), +.BR mft (1), +.BR pltotf (1), +.BR tftopl (1). +.\"===================================================================== +.SH AUTHORS +\*(MF was designed by Donald E. Knuth, who implemented it +using his \*(WB system for Pascal programs. It was originally +ported to Unix by Paul Richards at the University of Illinois at +Urbana-Champaign. This page was mostly written by Pierre MacKay. diff --git a/Master/texmf-dist/doc/man/man1/mf.man1.pdf b/Master/texmf-dist/doc/man/man1/mf.man1.pdf Binary files differnew file mode 100644 index 00000000000..4b999616f6b --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mf.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/mft.1 b/Master/texmf-dist/doc/man/man1/mft.1 new file mode 100644 index 00000000000..dfcaebfb690 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mft.1 @@ -0,0 +1,134 @@ +.TH MFT 1 "14 December 1993" "Web2C 2012" +.\"===================================================================== +.if n .ds MP MetaPost +.if t .ds MP MetaPost +.if n .ds MF Metafont +.if t .ds MF M\s-2ETAFONT\s0 +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff +.el .ds OX TeX for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.\"===================================================================== +.SH NAME +mft \- translate Metafont or MetaPost code to TeX code for prettyprinting +.SH SYNOPSIS +.B mft +.RI [ OPTIONS ] +.BR \fImf_file_name\fP [ .mf | .mp ] +.\"===================================================================== +.SH DESCRIPTION +This manual page is not meant to be exhaustive. The complete +documentation for this version of \*(TX can be found in the info file +or manual +.IR "Web2C: A TeX implementation" . +.PP +The +.B mft +program creates a \*(TX file from a \*(MF or \*(MP program. +It takes appropriate care of typographic details like page +layout and the use of indentation, italics, boldface, etc., as illustrated +in the book +.IR "Computer Modern Typefaces" . +Special conventions in \*(MF and \*(MP comments allow you to control things that +would not otherwise come out right; section 1 of the MFT source program +in the +.I \*(MFware +report explains these rules. +.PP +The +.B mft +program uses an optional change file (which works just as the change files to +.BR tangle (1) +and +.BR weave (1) +do) +and one or several style files (which are prepended to everything). +If no style file is specified, the style file +.B plain.mft +for \*(MF (or +.B mplain.mft +for \*(MP) is automatically used. +.PP +The +.IR mf_file_name , +optional +.IR change_file_name , +and +.I style_file_name +files are searched for using the MFINPUTS (for \*(MF) or MPINPUTS (for +\*(MP) and MFTINPUTS environment variables if you have set them, or else the +corresponding system defaults. +.PP +The output \*(TX file name is formed by using +.B .tex +in place of the extension of +.IR mf_file_name . +.\"===================================================================== +.SH OPTIONS +.TP +.BI \-change= change_file_name \fR[\fP.ch\fR]\fP +Apply the change file +.I change_file_name +to +.IR mf_file_name . +.PP +.TP +.B \-metapost +Assume +.I mf_file_name +is a \*(MP source file (this is the default if +.I mf_file_name +has the extension +.BR .mp ). +.PP +.TP +.BI \-style= style_file_name \fR[\fP.mft\fR]\fP +Use the style file +.I style_file_name +insted of +.B plain.mft +(or +.BR mplain.mft ); +this option can be given more than once. +.\"===================================================================== +.SH FILES +.TP +.I mftmac.tex +\*(TX macros used by +.B mft +output. +.TP +.IR plain.mft ", " mplain.mft +Default style files. +.TP +.I cmbase.mft +Style file for Computer Modern. +.\"===================================================================== +.SH "SEE ALSO" +.BR mf (1), +.BR weave (1). +.br +Donald E. Knuth, +.I Computer Modern Typefaces +(Volume E of +.IR "Computers and Typesetting" ), +Addison-Wesley, 1986, ISBN 0-201-13446-2. +.br +Donald E. Knuth et al., +.IR \*(MFware . +.\"===================================================================== +.SH AUTHORS +Donald E. Knuth wrote the program, and he ported it to Unix with the help of +Pierre MacKay and the Unix port of +.B weave +by Howard Trickey and Pavel Curtis. +The program is published in the +.I \*(MFware +technical report, available from the \*(TX Users Group. diff --git a/Master/texmf-dist/doc/man/man1/mft.man1.pdf b/Master/texmf-dist/doc/man/man1/mft.man1.pdf Binary files differnew file mode 100644 index 00000000000..fefafb972ab --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mft.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/mkindex.1 b/Master/texmf-dist/doc/man/man1/mkindex.1 new file mode 100644 index 00000000000..503b70020fd --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mkindex.1 @@ -0,0 +1,42 @@ +.TH "mkindex" "1" "September 2000" "teTeX" "teTeX" +.PP +.SH "NAME" +mkindex \- script to process LaTeX index and glossary files +.PP +.SH "SYNOPSIS" +.PP +\fBmkindex\fP \fIBASENAME\fP[\&.idx] \&.\&.\&. +.PP +.SH "DESCRIPTION" +.PP +\fBmkindex\fP runs \fBmakeindex\fP(1) on any index +(\f(CW\&.idx\fP) or glossary (\f(CW\&.glo\fP) files created by TeXing the file +\fI\fIBASENAME\fP\&.tex\fP\&. +.PP +.SH "FILES" +.IP "\fIgind\&.ist\fP" +MakeIndex index style file +.IP +.IP "\fIgglo\&.ist\fP" +MakeIndex glossary style file +.IP +.PP +.SH "SEE ALSO" +.PP +\fBmakeindex\fP(1) +.PP +.SH "BUGS" +.PP +None known, but report any bugs found to <tetex@informatik\&.uni-hannover\&.de> (mailing list)\&. +.PP +.SH "AUTHOR" +.PP +Written by Thomas Esser +<te@informatik\&.uni-hannover\&.de>\&. +.PP +This manual page was written by C\&.M\&. Connelly +<c@eskimo\&.com>, for +the Debian GNU/Linux system\&. It may be used by other distributions +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/Master/texmf-dist/doc/man/man1/mkindex.man1.pdf b/Master/texmf-dist/doc/man/man1/mkindex.man1.pdf Binary files differnew file mode 100644 index 00000000000..f0ae1ca6489 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mkindex.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/mkjobtexmf.1 b/Master/texmf-dist/doc/man/man1/mkjobtexmf.1 new file mode 100644 index 00000000000..b3fa622580f --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mkjobtexmf.1 @@ -0,0 +1,501 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.13 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "MKJOBTEXMF 1" +.TH MKJOBTEXMF 1 "2011-11-10 v0.8" "perl v5.8.1" "User Contributed Perl Documentation" +.SH "NAME" +mkjobtexmf \-\- Generate a texmf tree for a particular job +.SH "VERSION" +.IX Header "VERSION" +2011\-11\-10 v0.8 +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +The progam \fBmkjobtexmf\fR runs a program and tries to +find the used file names. Two methods are available, +option \f(CW\*(C`\-recorder\*(C'\fR of TeX (Web2C) or the program \fBstrace\fR. +.PP +Then it generates a directory with a texmf tree. It checks +the found files and tries sort them in this texmf tree. +.PP +It can be used for archiving purposes or to speed up +following TeX runs. +.PP +.Vb 1 +\& mkjobtexmf [options] +.Ve +.PP +This runs TeX that can be configured by options. +Both methods for getting the used file names are available. +.PP +.Vb 1 +\& mkjobtexmf [options] -- <cmd> [args] +.Ve +.PP +The latter form runs program \fIcmd\fR with arguments \fIargs\fR +instead of TeX. As method only program \fBstrace\fR is available. +.PP +Options: +.PP +.Vb 25 +\& --jobname <name> Name of the job (mandatory). +\& Usually this is the TeX file +\& without extension +\& --texname <file> Input file for TeX. Default is the +\& job name with extension '.tex' +\& --texopt <option> Option for TeX run +\& --destdir <directory> Destination directory, +\& default is `<jobname>.mjt' +\& --output Add also output files +\& --strace Use strace instead of TeX's +\& option -recorder +\& --copy Copy files instead of creating +\& symbol links +\& --flat Junk paths, do not make directories +\& inside the destination directory +\& --(no)texhash Run texhash, use --notexhash for MiKTeX +\& --exclude-ext <ext> Exclude files with extension <ext>. +\& --cmd-tex <cmd> Command for the TeX compiler +\& --cmd-kpsewhich <cmd> Command for kpsewhich +\& --cmd-texhash <cmd> Command for texhash +\& --cmd-strace <cmd> Command for strace +\& --verbose Verbose output +\& --help Brief help message +\& --man Full documentation +\& --version Print version identification +.Ve +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +.Sh "Running the program" +.IX Subsection "Running the program" +First \fBmkjobtexmf\fR runs a program, usually TeX. The TeX compiler +is configured by option \f(CW\*(C`\-\-cmd\-tex\*(C'\fR. Option \f(CW\*(C`\-\-texname\*(C'\fR can +be used, if the file name extension differs from \fI.tex\fR: +.PP +.Vb 1 +\& mkjobtexmf --jobname foo --texname foo.ltx +.Ve +.PP +Even more complicate cases are possible: +.PP +.Vb 1 +\& mkjobtexmf --jobname foo --texname '\edef\eabc{...}\einput{foo}' +.Ve +.PP +If another program than TeX should be used (dvips, ...), +then this program can be given after \f(CW\*(C`\-\-\*(C'\fR: +.PP +.Vb 1 +\& mkjobtexmf --jobname foo -- dvips foo +.Ve +.Sh "File recording" +.IX Subsection "File recording" +Two methods are available to get the used file names: +.IP "Recorder of TeX" 4 +.IX Item "Recorder of TeX" +Some TeX distributions (e.g. Web2C) support the option \fB\-recorder\fR +for its TeX compilers. Then the TeX compiler generates a file with +extension \fI.fls\fR that records the used input and output files. +.IP "Program strace" 4 +.IX Item "Program strace" +This program traces system calls and signals. It is used here +to log the used files. +.Sh "Analyze and link/copy found files" +.IX Subsection "Analyze and link/copy found files" +The result directory \fI\fIjobname\fI.mjt\fR is generated. Inside the +result \s-1TEXMF\s0 tree is created. Each found file is compared against +a list of paths of \s-1TEXMF\s0 trees. If a match is found, the file is +linked/copied into the \s-1TEXMF\s0 tree. The list of paths is generated by +program \fBkpsewhich\fR. +.PP +If the file cannot be mapped to a \s-1TEXMF\s0 tree and the file is +a relative file name, then it is directly linked/copied into the +result directory \fI\fIjobname\fI.mjt\fR. Absolute file names +are not supported and neither paths with links to parent directories. +.PP +Symbolic links are created by default. The files are copied +if option \f(CW\*(C`\-\-copy\*(C'\fR is given or symbolic linking is not available. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-\fR\fB\-jobname\fR=<\fIjobname\fR>" 4 +.IX Item "--jobname=<jobname>" +It is the name of the job. `<\fIjobname\fR>.tex' serves as default for +the TeX file and <\fIjobname\fR> is used for naming various directories +and files. See section \*(L"\s-1FILES\s0\*(R". +.IP "\fB\-\fR\fB\-texname\fR=<\fIname\fR>" 4 +.IX Item "--texname=<name>" +The name of the TeX input file, if it differs from <\fIjobname\fR>.tex. +.IP "\fB\-\fR\fB\-texopt\fR=<\fIopt\fR>" 4 +.IX Item "--texopt=<opt>" +Additional option for the TeX compiler, examples are \f(CW\*(C`\-\-ini\*(C'\fR or +\&\f(CW\*(C`\-\-shell\-escape\*(C'\fR. This option can be given more than once. +.IP "\fB\-\fR\fB\-destdir\fR=<\fIdirectory\fR>" 4 +.IX Item "--destdir=<directory>" +Specifies the name of the destination directory where the result +is collected. As default a directory is generated in the current +directory with the job name and extension `.mjt'. +.IP "\fB\-\fR\fB\-output\fR" 4 +.IX Item "--output" +Also add output files. +.IP "\fB\-\fR\fB\-strace\fR" 4 +.IX Item "--strace" +Use method with program \fBstrace\fR, see \*(L"\s-1DESCRIPTION\s0\*(R". +.IP "\fB\-\fR\fB\-copy\fR" 4 +.IX Item "--copy" +Files are copied instead of creating symbolic links. +.IP "\fB\-\fR\fB\-flat\fR" 4 +.IX Item "--flat" +Files are linked or copied without path elements. +The destination directory will contain a flat list of +files or links without directory. +.Sp +The files `ls\-R' and `aliases' are ignored. +.IP "\fB\-\fR\fB\-exclude\-ext\fR=<\fIext\fR>" 4 +.IX Item "--exclude-ext=<ext>" +Files with extension <\fIext\fR> are excluded. The option can be +given several times or a comma separated list of extensions +can be used. Examples: +.Sp +.Vb 1 +\& --exclude-ext aux --exclude-ext log --exclude-ext toc +.Ve +.Sp +is the same as +.Sp +.Vb 1 +\& --exclude-ext aux,log,toc +.Ve +.IP "\fB\-\fR\fB\-(no)texhash\fR" 4 +.IX Item "--(no)texhash" +As default the file `ls\-R' is generated in the `texmf' tree, +because this is the file name database that might be used +in TeX Live. Because MiKTeX uses a different mechanism, its +`texhash' does not generate the `ls\-R' files and \f(CW\*(C`\-\-notexhash\*(C'\fR +suppresses the call of `texhash'. +.IP "\fB\-\fR\fB\-cmd\-tex\fR=<\fIcmd\fR>" 4 +.IX Item "--cmd-tex=<cmd>" +Command for the TeX compiler. Default is pdflatex. +.IP "\fB\-\fR\fB\-cmd\-kpsewhich\fR=<\fIcmd\fR>" 4 +.IX Item "--cmd-kpsewhich=<cmd>" +Command for kpsewhich. +.IP "\fB\-\fR\fB\-cmd\-texhash\fR=<\fIcmd\fR>" 4 +.IX Item "--cmd-texhash=<cmd>" +Command for updating the file name database of the generated +texmf tree. Default is texmf. +.IP "\fB\-\fR\fB\-cmd\-strace\fR=<\fIcmd\fR>" 4 +.IX Item "--cmd-strace=<cmd>" +Command for strace. +.IP "\fB\-\fR\fB\-verbose\fR" 4 +.IX Item "--verbose" +Verbose messages. +.IP "\fB\-\fR\fB\-help\fR" 4 +.IX Item "--help" +Display help screen. +.IP "\fB\-\fRB(\-man>" 4 +.IX Item "-B(-man>" +Print manual page. +.IP "\fB\-\fR\fB\-version\fR" 4 +.IX Item "--version" +Print version identification and exit. +.SH "EXAMPLES" +.IX Header "EXAMPLES" +TeX file \fItest.tex\fR using TeX's recorder method: +.PP +.Vb 1 +\& mkjobtexmf --jobname test +.Ve +.PP +TeX file \fItest.tex\fR using LaTeX: +.PP +.Vb 1 +\& mkjobtexmf --jobname test --cmd-tex latex +.Ve +.PP +Format generation: +.PP +.Vb 1 +\& mkjobtexmf --jobname test --texopt -ini --texname pdflatex.ini +.Ve +.PP +Example, how the new texmf tree (Linux/bash) can be used: +.PP +.Vb 1 +\& TEXMF=!!test.mjt/texmf pdflatex test +.Ve +.PP +Example for generating a zip archive (Linux/bash): +.PP +.Vb 1 +\& (cd test.mjt && zip -9r ../test .) +.Ve +.PP +Example for generating a tar archive: +.PP +.Vb 1 +\& tar cjhvf test.tar.bz2 -C test.mjt . +.Ve +.SH "UNSOLVED ISSUES, CAVEATS, TODOS" +.IX Header "UNSOLVED ISSUES, CAVEATS, TODOS" +.IP "Experimental software" 4 +.IX Item "Experimental software" +Options, defaults, how the program works might change in +future versions. +.IP "\fItexmf.cnf\fR" 4 +.IX Item "texmf.cnf" +Currently the method with \fBstrace\fR records this files. +TeX's recorder does not. Useful are \fItexmf.cnf\fR files for +variable settings. Because we have just one \s-1TEXMF\s0 tree, +the path sections should probably rewritten. +.IP "Settings in environment variables" 4 +.IX Item "Settings in environment variables" +They are not stored at all. +.IP "Collisions" 4 +.IX Item "Collisions" +The program uses one destination directory and at most +one \s-1TEXMF\s0 tree for the result. However, the source files +can come from different directories and \s-1TEXMF\s0 trees. +Therefore name collisions are possible. +.Sp +The program follows the strategy not to delete files +in the destination directory. That allows to collect files +from differnt runs. Thus collisions are resolved +in the manner that the first entry that is made in +the destination directory wins. +.IP "Configuration file" 4 +.IX Item "Configuration file" +It would save the user from retyping the same options again and again. +.IP "Uncomplete recording" 4 +.IX Item "Uncomplete recording" +Bugs in TeX's file recording might result in incomplete +file recording (e.g. pdfTeX 1.40.3 does not record .pfb and +\&.pk files). +.IP "..." 4 +.SH "FILES" +.IX Header "FILES" +.PD 0 +.IP "\fI<jobname>.mjt/\fR" 4 +.IX Item "<jobname>.mjt/" +.PD +Directory where the resulting texmf tree and symbol links +are stored. It can be changed by option \f(CW\*(C`\-\-destdir\*(C'\fR. +.IP "\fI<jobname>.fls\fR" 4 +.IX Item "<jobname>.fls" +Name of TeX's recorder file. +.IP "\fI<jobname>.strace\fR" 4 +.IX Item "<jobname>.strace" +Log file where the result of \fBstrace\fR is stored. +.SH "AUTHOR" +.IX Header "AUTHOR" +Heiko Oberdiek, email: heiko.oberdiek at googlemail.com +.SH "COPYRIGHT AND LICENSE" +.IX Header "COPYRIGHT AND LICENSE" +Copyright 2007, 2008, 2011 by Heiko Oberdiek. +.PP +This library is free software; you may redistribute it and/or +modify it under the same terms as Perl itself +(Perl Artistic License/GNU General Public License, version 2). +.SH "HISTORY" +.IX Header "HISTORY" +.IP "\fB2007/04/16 v0.1\fR" 2 +.IX Item "2007/04/16 v0.1" +.RS 2 +.PD 0 +.IP "* First experimental version." 2 +.IX Item "First experimental version." +.RE +.RS 2 +.RE +.IP "\fB2007/05/09 v0.2\fR" 2 +.IX Item "2007/05/09 v0.2" +.RS 2 +.IP "* Typo in option name fixed." 2 +.IX Item "Typo in option name fixed." +.RE +.RS 2 +.RE +.IP "\fB2007/09/03 v0.3\fR" 2 +.IX Item "2007/09/03 v0.3" +.RS 2 +.ie n .IP "* New options: ""\-\-copy""\fR, \f(CW""\-\-flat""\fR, \f(CW""\-\-destdir""" 2 +.el .IP "* New options: \f(CW\-\-copy\fR, \f(CW\-\-flat\fR, \f(CW\-\-destdir\fR" 2 +.IX Item "New options: --copy, --flat, --destdir" +.RE +.RS 2 +.RE +.IP "\fB2007/09/04 v0.4\fR" 2 +.IX Item "2007/09/04 v0.4" +.RS 2 +.IP "* Bug fix in map_files_texmf." 2 +.IX Item "Bug fix in map_files_texmf." +.RE +.RS 2 +.RE +.IP "\fB2007/09/06 v0.5\fR" 2 +.IX Item "2007/09/06 v0.5" +.RS 2 +.IP "* Support for `configure' added. (Thanks to Norbert Preining for writing a first version of the configure stuff.)" 2 +.IX Item "Support for `configure' added. (Thanks to Norbert Preining for writing a first version of the configure stuff.)" +.RE +.RS 2 +.RE +.IP "\fB2008/04/05 v0.6\fR" 2 +.IX Item "2008/04/05 v0.6" +.RS 2 +.IP "* Tiny fix in target `uninstall' in file `Makefile.in'. (Thanks to Karl Berry)" 2 +.IX Item "Tiny fix in target `uninstall' in file `Makefile.in'. (Thanks to Karl Berry)" +.RE +.RS 2 +.RE +.IP "\fB2008/06/28 v0.7\fR" 2 +.IX Item "2008/06/28 v0.7" +.RS 2 +.ie n .IP "* Fix for unknown option `""\-\-cmd\-strace""'. (Thanks to Juho Niemelä)" 2 +.el .IP "* Fix for unknown option `\f(CW\-\-cmd\-strace\fR'. (Thanks to Juho Niemelä)" 2 +.IX Item "Fix for unknown option `--cmd-strace'. (Thanks to Juho Niemelä)" +.RE +.RS 2 +.RE +.IP "\fB2011/11/10 v0.8\fR" 2 +.IX Item "2011/11/10 v0.8" +.RS 2 +.IP "* Remove colon from drive specification when making directories." 2 +.IX Item "Remove colon from drive specification when making directories." +.ie n .IP "* Option ""\-\-(no)texhash"" added." 2 +.el .IP "* Option \f(CW\-\-(no)texhash\fR added." 2 +.IX Item "Option --(no)texhash added." +.IP "* Some support for MiKTeX (thanks Ulrike Fischer)." 2 +.IX Item "Some support for MiKTeX (thanks Ulrike Fischer)." +.IP "* Various fixes in the generation of the documentation." 2 +.IX Item "Various fixes in the generation of the documentation." +.ie n .IP "* Options ""\-\-exclude\-ext""\fR and \f(CW""\-\-version"" added." 2 +.el .IP "* Options \f(CW\-\-exclude\-ext\fR and \f(CW\-\-version\fR added." 2 +.IX Item "Options --exclude-ext and --version added." +.RE +.RS 2 +.RE diff --git a/Master/texmf-dist/doc/man/man1/mkjobtexmf.man1.pdf b/Master/texmf-dist/doc/man/man1/mkjobtexmf.man1.pdf Binary files differnew file mode 100644 index 00000000000..bd42549a2cf --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mkjobtexmf.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/mkocp.1 b/Master/texmf-dist/doc/man/man1/mkocp.1 new file mode 100644 index 00000000000..74a90dc6581 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mkocp.1 @@ -0,0 +1,48 @@ +.TH "mkocp" "1" "September 2000" "Omega" "Omega" +.PP +.SH "NAME" +mkocp \- frontend to \fBotp2ocp\fP(1) +.SH "SYNOPSIS" +.B mkocp +.I OTPFILE +.SH "DESCRIPTION" +.PP +\fBmkocp\fP is used to create or recreate Omega Compiled Process files +(binary) from Omega Translation Process (text) files\&. +.PP +Omega Translation Processes are used to translate one character set to +another and to choose between characters with one or more +context-sensitive variants\&. OTPs could also be used to change the +case or hyphenation of text\&. +.PP +OTPs are defined in text files, and compiled into binary code (OCPs) +using \fBmkocp\fP (this script) or directly with \fBotp2ocp\fP(1)\&. +.PP +.SH "FILES" +.IP "\fIOTPFILE\fP" +An Omega Typesetting Process filter file\&. +.PP +.SH "SEE ALSO" +.PP +\fBomega\fP(1), \fBotp2ocp\fP(1)\&. +.PP +\fIDraft Manual for the Omega System\fP (\fIomega-manual\&.dvi\fP)\&. +.PP +Web page: <http://www\&.gutenberg\&.eu\&.org/omega/> +.PP +.SH "BUGS" +.PP +None known, but report any bugs found to <omega@ens\&.fr> (mailing list)\&. +.PP +.SH "AUTHOR" +.PP +\fBmkocp\fP is part of Omega\&. The primary authors of Omega are John Plaice +<plaice@cse\&.unsw\&.edu\&.au> and Yannis Haralambous +<yannis@fluxus-virus\&.com>\&. +.PP +This manual page was written by C\&.M\&. Connelly +<cmc@debian\&.org>, for +the Debian GNU/Linux system\&. It may be used by other distributions +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/Master/texmf-dist/doc/man/man1/mkocp.man1.pdf b/Master/texmf-dist/doc/man/man1/mkocp.man1.pdf Binary files differnew file mode 100644 index 00000000000..37c4ff0f02d --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mkocp.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/mkofm.1 b/Master/texmf-dist/doc/man/man1/mkofm.1 new file mode 100644 index 00000000000..f676d0e22f0 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mkofm.1 @@ -0,0 +1,31 @@ +.TH "mkofm" "1" "September 2000" "teTeX" "teTeX" +.PP +.SH "NAME" +mkofm \- front end to \fBmktextfm\fP(1) +.SH "SYNOPSIS" +.B mkofm +.I ARGS +.SH "DESCRIPTION" +.PP +\fBmkofm\fP takes all \fIARGS\fP and passes them to +\fBmktextfm\fP(1)\&. For more information about appropriate +arguments, see \fBmktextfm\fP(1)\&. +.PP +.SH "SEE ALSO" +.PP +\fBmktextfm\fP(1) +.PP +.SH "BUGS" +.PP +None known\&. +.PP +.SH "AUTHOR" +.PP +Author unknown\&. +.PP +This manual page was written by C\&.M\&. Connelly +<cmc@debian\&.org>, for +the Debian GNU/Linux system\&. It may be used by other distributions +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/Master/texmf-dist/doc/man/man1/mkofm.man1.pdf b/Master/texmf-dist/doc/man/man1/mkofm.man1.pdf new file mode 100644 index 00000000000..3bc6a079fea --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mkofm.man1.pdf @@ -0,0 +1,115 @@ +%PDF-1.4 +%Çì¢ +5 0 obj +<</Length 6 0 R/Filter /FlateDecode>> +stream +xœUÛnÛF}çWÌ[¨"Úì…ä.Ñ¢¨â¸‰ GN,h÷’V2k‘”É% }Tÿ1³»¤nP¸àòìÌ™3gf Ô>ý{Qon%¬Û€Â:x ˜û ýkQÂÛ +?4†løc $qAVaù0Êþ ˜ JEø7[L +’HÙSÖ«ò.dw#0:³8Î)I"u ä¨ÿ ‰SAhÂ<bÞþSÂ1çI¥À¸e4Ž„$q*`,‡ŸN,’Z“„*™ö>^Ú 'åpN„à0Fîî0µD¾Ú‚Bã$±Ùá_X5ue@WK0õèï쟈’biÊ£¿™Uù,Y“„&IÛ×tT +SœPÇ'Åwª pö×ôæÓìj¶ÇñDJ"–¦öžxDÒ„+K¼gÊèÑI˜à}—ÂÉíûÙ™8æÂSˆ(w¸w—³‹Û«OÙÕÍô³8B`…ù< “öá’õM§H"ö¦h!ßl|ÖãBxB’X>«ã8‹í`4@rìÝ6o[Œgîuiûx^‰’DH¿¨H:õîuý$ð»3°$Ñà[J䡲n4ÕªnÊÜuù¼î äÛmSo›bì<Îë'õÌ•¹Ñ7#4uª®»RW¦}
ÖÏ=©a ûørO’sS&Š°(=3åå%L®g7ÿm‡ÏθÍ|2ã*&”#ôÄ•o¿ 5¬”ð^À9W’˜tZW ªzÄ16S"|ªˆ“ó'géE I09I/¹VöáæöG ’”©c“ÎÜ£'ºj`!h¼g±ÏtbÌy,ûék˜Ý-”yÕåôóZÓ_Uœ…y OMaŒ®`¾ƒ ò‘ÀE]Uz³ÙÁ/‹rñÛRÏ‹¼"µ÷2׿¾4£ xçþÂûé—7×EÕ}ó4 Ûë ÂÒ¹¸ÝµF—®ÌèU£Vé~é[L™ï`®¡kõÒR©1|Ë¢5M1÷³N‰LÔá˜rÇ:;XDºàT,pçæ STkÇ/wr9w2Éq½ “:©ì7ËÐõÍ.6wå¡K +!ýgä’÷w
‰e4˜·ªcMÑ÷‘8ô iªÔb]m먕£vÜ '¼ÜÁʵ…+æÝÆüŒÈÇ®h +»ÎÜȣ苺iôÂ×lj tÚY§?õš£ ›¥•tYØ#ÚÞCPj¸s{ª —H™7»^,;̯Žì ºûë/c{ió´_vÒS1ÜÅ3½ÅFϵӃ Ô—ö2±Ô:Ž9 §·²…\fÁg|¾ +aendstream +endobj +6 0 obj +970 +endobj +4 0 obj +<</Type/Page/MediaBox [0 0 612 792] +/Rotate 0/Parent 3 0 R +/Resources<</ProcSet[/PDF /Text] +/ExtGState 11 0 R +/Font 12 0 R +>> +/Contents 5 0 R +>> +endobj +3 0 obj +<< /Type /Pages /Kids [ +4 0 R +] /Count 1 +>> +endobj +1 0 obj +<</Type /Catalog /Pages 3 0 R +/Metadata 14 0 R +>> +endobj +7 0 obj +<</Type/ExtGState +/OPM 1>>endobj +11 0 obj +<</R7 +7 0 R>> +endobj +12 0 obj +<</R10 +10 0 R/R9 +9 0 R/R8 +8 0 R>> +endobj +10 0 obj +<</BaseFont/Times-Italic/Type/Font +/Subtype/Type1>> +endobj +9 0 obj +<</BaseFont/Times-Bold/Type/Font +/Subtype/Type1>> +endobj +8 0 obj +<</BaseFont/Times-Roman/Type/Font +/Encoding 13 0 R/Subtype/Type1>> +endobj +13 0 obj +<</Type/Encoding/Differences[ +173/minus]>> +endobj +14 0 obj +<</Type/Metadata +/Subtype/XML/Length 1344>>stream +<?xpacket begin='' id='W5M0MpCehiHzreSzNTczkc9d'?> +<?adobe-xap-filters esc="CRLF"?> +<x:xmpmeta xmlns:x='adobe:ns:meta/' x:xmptk='XMP toolkit 2.9.1-13, framework 1.6'> +<rdf:RDF xmlns:rdf='http://www.w3.org/1999/02/22-rdf-syntax-ns#' xmlns:iX='http://ns.adobe.com/iX/1.0/'> +<rdf:Description rdf:about='uuid:c7b7e978-e107-11ec-0000-c3bd0edf572f' xmlns:pdf='http://ns.adobe.com/pdf/1.3/' pdf:Producer='GPL Ghostscript 9.05'/> +<rdf:Description rdf:about='uuid:c7b7e978-e107-11ec-0000-c3bd0edf572f' xmlns:xmp='http://ns.adobe.com/xap/1.0/'><xmp:ModifyDate>2012-05-28T19:33:26+02:00</xmp:ModifyDate> +<xmp:CreateDate>2012-05-28T19:33:26+02:00</xmp:CreateDate> +<xmp:CreatorTool>groff version 1.21</xmp:CreatorTool></rdf:Description> +<rdf:Description rdf:about='uuid:c7b7e978-e107-11ec-0000-c3bd0edf572f' xmlns:xapMM='http://ns.adobe.com/xap/1.0/mm/' xapMM:DocumentID='uuid:c7b7e978-e107-11ec-0000-c3bd0edf572f'/> +<rdf:Description rdf:about='uuid:c7b7e978-e107-11ec-0000-c3bd0edf572f' xmlns:dc='http://purl.org/dc/elements/1.1/' dc:format='application/pdf'><dc:title><rdf:Alt><rdf:li xml:lang='x-default'>Untitled</rdf:li></rdf:Alt></dc:title></rdf:Description> +</rdf:RDF> +</x:xmpmeta> + + +<?xpacket end='w'?> +endstream +endobj +2 0 obj +<</Producer(GPL Ghostscript 9.05) +/CreationDate(D:20120528193326+02'00') +/ModDate(D:20120528193326+02'00') +/Creator(groff version 1.21)>>endobj +xref +0 15 +0000000000 65535 f +0000001293 00000 n +0000003174 00000 n +0000001234 00000 n +0000001074 00000 n +0000000015 00000 n +0000001055 00000 n +0000001358 00000 n +0000001612 00000 n +0000001547 00000 n +0000001479 00000 n +0000001399 00000 n +0000001429 00000 n +0000001694 00000 n +0000001753 00000 n +trailer +<< /Size 15 /Root 1 0 R /Info 2 0 R +/ID [<B10BB8F7A5BA2D58C0EDF647E8329C81><B10BB8F7A5BA2D58C0EDF647E8329C81>] +>> +startxref +3326 +%%EOF diff --git a/Master/texmf-dist/doc/man/man1/mktexfmt.1 b/Master/texmf-dist/doc/man/man1/mktexfmt.1 new file mode 100644 index 00000000000..71c6a947903 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mktexfmt.1 @@ -0,0 +1 @@ +.so man1/fmtutil.1 diff --git a/Master/texmf-dist/doc/man/man1/mktexfmt.man1.pdf b/Master/texmf-dist/doc/man/man1/mktexfmt.man1.pdf Binary files differnew file mode 100644 index 00000000000..ea8b3517eb5 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mktexfmt.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/mktexlsr.1 b/Master/texmf-dist/doc/man/man1/mktexlsr.1 new file mode 100644 index 00000000000..d248d6a00a7 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mktexlsr.1 @@ -0,0 +1,44 @@ +.TH MKTEXLSR 1 "1 March 2011" "Kpathsea 6.1.0" +.\"===================================================================== +.if n .ds MP MetaPost +.if t .ds MP MetaPost +.if n .ds MF Metafont +.if t .ds MF M\s-2ETAFONT\s0 +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff +.el .ds OX TeX for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.\"===================================================================== +.SH NAME +mktexlsr \- create ls-R databases +.SH SYNOPSIS +.B mktexlsr +.RI [ directories ] +.\"===================================================================== +.SH DESCRIPTION +This manual page is not meant to be exhaustive. The complete +documentation for this version of \*(TX can be found in the info file +or manual +.IR "Kpathsea: A library for path searching" . +.PP +.B mktexlsr +is used to generate the ls-R databases used by the kpathsea library. +It will create them for the specified directories, or for a default +list if no directories are specified. +.\"===================================================================== +.SH OPTIONS +.B mktexlsr +accepts the following options: +.TP +.B --help +Print help message and exit. +.TP +.B --version +Print version information and exit. diff --git a/Master/texmf-dist/doc/man/man1/mktexlsr.man1.pdf b/Master/texmf-dist/doc/man/man1/mktexlsr.man1.pdf Binary files differnew file mode 100644 index 00000000000..8137fc3f22d --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mktexlsr.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/mktexmf.1 b/Master/texmf-dist/doc/man/man1/mktexmf.1 new file mode 100644 index 00000000000..0d12dd8ec9f --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mktexmf.1 @@ -0,0 +1,57 @@ +.TH MKTEXMF 1 "1 March 2011" "Kpathsea 6.1.0" +.\"===================================================================== +.if n .ds MP MetaPost +.if t .ds MP MetaPost +.if n .ds MF Metafont +.if t .ds MF M\s-2ETAFONT\s0 +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff +.el .ds OX TeX for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.\"===================================================================== +.SH NAME +mktexmf \- create a Metafont source file +.SH SYNOPSIS +.B mktexmf +.I font +.\"===================================================================== +.SH DESCRIPTION +This manual page is not meant to be exhaustive. The complete +documentation for this version of \*(TX can be found in the info file +or manual +.IR "Kpathsea: A library for path searching" . +.PP +.B mktexmf +is used to generate the \*(MF source file for +.IR font , +if possible. For example, +.I ecrm1200 +or +.IR cmr11 . +.PP +The name of the generated file is printed on standard output. +.PP +.B mktexmf +is typically called by other programs, rather than from the command +line. +.\"===================================================================== +.SH OPTIONS +.B mktexmf +accepts the following options: +.TP +.B --help +Print help message and exit. +.TP +.B --version +Print version information and exit. +.\"===================================================================== +.SH "SEE ALSO" +.BR mktexpk (1), +.BR mktextfm (1). diff --git a/Master/texmf-dist/doc/man/man1/mktexmf.man1.pdf b/Master/texmf-dist/doc/man/man1/mktexmf.man1.pdf Binary files differnew file mode 100644 index 00000000000..1331b33941d --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mktexmf.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/mktexpk.1 b/Master/texmf-dist/doc/man/man1/mktexpk.1 new file mode 100644 index 00000000000..c8147841227 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mktexpk.1 @@ -0,0 +1,115 @@ +.TH MKTEXPK 1 "1 March 2011" "Kpathsea 6.1.0" +.\"===================================================================== +.if n .ds MP MetaPost +.if t .ds MP MetaPost +.if n .ds MF Metafont +.if t .ds MF M\s-2ETAFONT\s0 +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff +.el .ds OX TeX for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.\"===================================================================== +.SH NAME +mktexpk \- create a PK file for a font +.SH SYNOPSIS +.B mktexpk +.RI [ options ] +.I font +.RI [ redirect ] +.\"===================================================================== +.SH DESCRIPTION +This manual page is not meant to be exhaustive. The complete +documentation for this version of \*(TX can be found in the info file +or manual +.IR "Kpathsea: A library for path searching" . +.PP +.B mktexpk +is used to generate a +.I pk +file from the \*(MF source files or type1 sources for +.IR font , +if possible. +.PP +If +.I redirect +is given, it must be string of the form +.BI >& n +where +.I n +is the number of the file descriptor which is to receive, instead of +standard output, the name of the generated file. +.PP +.B mktexpk +is typically called by other programs, rather than from the command +line. +.\"===================================================================== +.SH OPTIONS +.B mktexpk +accepts the following options: +.TP +.BI --bdpi \ num +Set the base device resolution. +.TP +.BI --dpi \ num +Generate the font at resolution +.IR num . +.TP +.B --help +Print help message and exit. +.TP +.BI --mag \ mag +The \*(MF magnification that corresponds to the combination of +.I bdpi +and +.I dpi +that has been specified. +.TP +.BI --mfmode \ mode +The \*(MF mode to use. +.TP +.BI --destdir \ dir +A directory name. If the directory is absolute, it is used as-is. +Otherwise, it is appended to the root destination directory set in the +script. +.TP +.B --version +Print version information and exit. +.\"===================================================================== +.SH BUGS +If the +.I mode +is not specified, +.B mktexpk +tries to determine it from +.IR bdpi . +The manner in which this is done is primitive. Since +.I bpdi +doesn't provide sufficient information to uniquely determine a +.I mode +it is strongly recommended that it be specified explicitly. +.PP +If the +.I mode +and +.I bpdi +don't match, the +.I mode +is discarded. +.PP +The +.I dpi +parameter is redundant, but is not checked for consistency. Worse, +the program will fail if the wrong +.I dpi +is specified. +.\"===================================================================== +.SH "SEE ALSO" +.BR mktexmf (1), +.BR mktextfm (1). diff --git a/Master/texmf-dist/doc/man/man1/mktexpk.man1.pdf b/Master/texmf-dist/doc/man/man1/mktexpk.man1.pdf Binary files differnew file mode 100644 index 00000000000..8f59b330ecb --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mktexpk.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/mktextfm.1 b/Master/texmf-dist/doc/man/man1/mktextfm.1 new file mode 100644 index 00000000000..14958a26c67 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mktextfm.1 @@ -0,0 +1,65 @@ +.TH MKTEXTFM 1 "1 March 2011" "Kpathsea 6.1.0" +.\"===================================================================== +.if n .ds MP MetaPost +.if t .ds MP MetaPost +.if n .ds MF Metafont +.if t .ds MF M\s-2ETAFONT\s0 +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff +.el .ds OX TeX for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.\"===================================================================== +.SH NAME +mktextfm \- create a TFM file for a font +.SH SYNOPSIS +.B mktextfm +.RI [ options ] +.I font +.\"===================================================================== +.SH DESCRIPTION +This manual page is not meant to be exhaustive. The complete +documentation for this version of \*(TX can be found in the info file +or manual +.IR "Kpathsea: A library for path searching" . +.PP +.B mktextfm +is used to generate a +.I tfm +file from the \*(MF source files for +.IR font , +if possible. If +.I destdir +is given, the generated file will be installed there, otherwise a +(rather complicated) heuristic is used. +.PP +The name of the generated file is printed on standard output. +.PP +.B mktextfm +is typically called by other programs, rather than from the command +line. +.\"===================================================================== +.SH OPTIONS +.B mktextfm +accepts the following options: +.TP +.BI --destdir \ dir +A directory name. If the directory is absolute, it is used as-is. +Otherwise, it is appended to the root destination directory set in the +script. +.TP +.B --help +Print help message and exit. +.TP +.B --version +Print version information and exit. +.\"===================================================================== +.SH "SEE ALSO" +.BR mktexmf (1), +.BR mktexpk (1). diff --git a/Master/texmf-dist/doc/man/man1/mktextfm.man1.pdf b/Master/texmf-dist/doc/man/man1/mktextfm.man1.pdf Binary files differnew file mode 100644 index 00000000000..cb009def8ee --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mktextfm.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/mmafm.1 b/Master/texmf-dist/doc/man/man1/mmafm.1 new file mode 100644 index 00000000000..82942ad329e --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mmafm.1 @@ -0,0 +1,178 @@ +.\" -*-nroff-*- +.ds V 2.92 +.de M +.BR "\\$1" "(\\$2)\\$3" +.. +.ds E " \-\- +.if t .ds E \(em +.de Op +.BR "\\$1" "\\$2" "\\$3" "\\$4" "\\$5" "\\$6" +.. +.de Oy +.BI "\\$1\fR=" "\\$2\fR, " "\\$3\& " "\\$4" "\\$5" "\\$6" +.. +.de Ol +.BI "\\$1\fR=" "\\$2" "\\$3" "\\$4" "\\$5" "\\$6" +.. +.de Sp +.if n .sp +.if t .sp 0.4 +.. +.de Es +.Sp +.RS 5 +.nf +.. +.de Ee +.fi +.RE +.PP +.. +.TH MMAFM 1 "LCDF Typetools" "Version \*V" +.SH NAME +mmafm \- creates AFM font metrics for multiple master fonts +' +.SH SYNOPSIS +.B mmafm +\%[OPTIONS...] +.I font +' +.SH DESCRIPTION +.B Mmafm +creates AFM font metrics for PostScript multiple master fonts by +interpolation. You pass it an AMFM file (multiple master font metrics) and +options specifying the design point you want, and it writes the resulting +AFM file to the standard output. +.PP +Each +.I font +argument is either the filename of an AFM or AMFM font metrics file, or a +PostScript font name. If you give a font name, +.B mmafm +will look up the actual font metrics file using the PSRESOURCEPATH +environment variable. This colon-separated path is searched for `PSres.upr' +files, an Adobe method for indexing PostScript resources. +.PP +You can also give the name of a multiple master font instance, like +`MinionMM_367_400_12_'. +.B Mmafm +will parse the font name and create that instance for you. `PSres.upr' +files must be set up for this to work. +.PP +Any multiple master font should be distributed with a single AMFM file and +several AFM files (one for each master). For Myriad, for example, the AMFM +file is MyriadMM.amfm and the AFM files are MyriadMM-LightCn.afm, +MyriadMM-LightSemiEx.afm, MyriadMM-BlackCn.afm, and +MyriadMM-BlackSemiEx.afm. +.B Mmafm +needs to find all these files to function. For fonts in the Adobe type +library, you can download the necessary files from +<http://www.lcdf.org/type>; look for the mm-metrics package. +.PP +You must always supply the AMFM file (or its font name) on the command +line, but +.B mmafm +will look for any required AFM files you don't supply yourself. It tries +the PSRESOURCEPATH environment variable, and also looks for files named +`\fIFontName\fR.afm' or `\fIFontName\fR.AFM' in the directory that +contained the AMFM file. (The Myriad filenames given above fit this +pattern.) +.PP +.B Mmafm +supports fonts with intermediate masters, like Adobe Jenson and Kepler. If +your PSRESOURCEPATH environment variable is set up, it will handle these +fonts automatically. Otherwise, you must first run +.RB ` "mmpfb \-\-amcp\-info" ' +on the font outline files to create auxiliary AMCP files for these fonts. +Each AMCP file should be in the same directory as its corresponding AMFM +file and should have the same root filename, but with a `.amcp' extension +instead of `.amfm'. See +.M mmpfb 1 +for more information. +' +' +.SH EXAMPLE +' +.nf +% mmafm \-\-weight=400 \-\-width=600 MyriadMM.amfm > MyriadMM_400_600_.afm +.fi +' +.SH OPTIONS +Long options may be abbreviated to their unique prefixes. +' +.TP 5 +.Oy \-\-output file \-o file +Send output to +.I file +instead of standard output. +' +.TP +.Oy \-\-weight N \-w N +Set the weight axis to +.IR N . +' +.TP +.Oy \-\-width N \-W N +Set the width axis to +.IR N . +' +.TP +.Oy \-\-optical\-size N \-O N +Set the optical size axis to +.IR N . +' +.TP +.Ol \-\-style N +Set the style axis to +.IR N . +.TP +\fB\-\-1\fR=\fIN\fR (\fB\-\-2\fR=\fIN\fR, \fB\-\-3\fR=\fIN\fR, \fB\-\-4\fR=\fIN\fR) +Set the first (second, third, fourth) axis to +.IR N . +' +.TP +.Oy \-\-precision N \-p N +Round output numbers so they have at most +.I N +digits after the decimal point. Smaller numbers are less precise; `\fB\-p +\fR0' rounds all numbers to integers. The default precision is 3. +' +.TP +.Oy \-\-min\-kern N \-k N +Only output kerning pairs whose absolute value is +.IR N +or larger. Smaller minimum kerns make kerning more precise and the output +AFM file bigger. The default minimum kern is 2.0. +' +.SH TROUBLESHOOTING +.PP +Some programs, such as TeX's +.BR fontinst , +can choke on AFM files that include fractional numbers. Therefore, if you +have trouble with an AFM file, try rerunning +.B mmafm +with the +.Op \-\-precision=0 +option. +' +.SH SEE ALSO +.M mmpfb 1 +' +.SH DIAGNOSTICS +.TP 5 +\fIFont\fR requires intermediate master conversion programs +You haven't yet created an AMCP file for \fIFont\fR. +' +.SH AUTHOR +.na +Eddie Kohler, ekohler@gmail.com +.PP +The latest version is available from: +.br +http://www.lcdf.org/type/ +.br +AMFM and AFM files for Adobe Type Library fonts are also available at that +URL. +.PP +Thanks to Melissa O'Neill for suggestions and patient +debugging. diff --git a/Master/texmf-dist/doc/man/man1/mmafm.man1.pdf b/Master/texmf-dist/doc/man/man1/mmafm.man1.pdf Binary files differnew file mode 100644 index 00000000000..7278392f823 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mmafm.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/mmpfb.1 b/Master/texmf-dist/doc/man/man1/mmpfb.1 new file mode 100644 index 00000000000..850be8e85f8 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mmpfb.1 @@ -0,0 +1,206 @@ +.\" -*-nroff-*- +.ds V 2.92 +.de M +.BR "\\$1" "(\\$2)\\$3" +.. +.ds E " \-\- +.if t .ds E \(em +.de Op +.BR "\\$1" "\\$2" "\\$3" "\\$4" "\\$5" "\\$6" +.. +.de Oy +.BI "\\$1\fR=" "\\$2\fR, " "\\$3\& " "\\$4" "\\$5" "\\$6" +.. +.de Ol +.BI "\\$1\fR=" "\\$2" "\\$3" "\\$4" "\\$5" "\\$6" +.. +.de Sp +.if n .sp +.if t .sp 0.4 +.. +.TH MMPFB 1 "LCDF Typetools" "Version \*V" +.SH NAME +mmpfb \- creates single-master fonts from multiple master fonts +' +.SH SYNOPSIS +.B mmpfb +\%[OPTIONS...] +.I font +' +.SH DESCRIPTION +.B Mmpfb +creates a normal, single-master PostScript font from a multiple master font +by interpolation. You pass it a PFB or PFA font and options specifying the +design point you want; it writes the resulting PFB or PFA font to the +standard output. +.PP +The fonts +.B mmpfb +creates are interpolated at a low level to remove multiple master +instructions from individual characters. Therefore, they can be used by +programs that don't normally understand multiple master fonts, like +.BR ps2pk (1). +.PP +.B Mmpfb +supports fonts with intermediate masters, like Adobe Jenson and Kepler. It +can also create AMCP (Adobe Multiple Master Conversion Program) files for +use by +.M mmafm 1 ; +see +.B \-\-amcp\-info +below. +.PP +The +.I font +argument is either the name of a PFA or PFB font file, or a PostScript font +name. If you give a font name, +.B mmpfb +will find the actual outline file using the PSRESOURCEPATH environment +variable. This colon-separated path is searched for `PSres.upr' files, an +Adobe method for indexing PostScript resources. +.PP +You can also give the name of a multiple +master font instance, like `MinionMM_367_400_12_'. +.B Mmpfb +will parse the font name and create that instance for you. `PSres.upr' +files must be set up for this to work. +' +' +.SH EXAMPLE +' +.nf +% mmpfb \-\-weight=400 \-\-width=600 MyriadMM.pfb > MyriadMM_400_600_.pfb +.fi +' +.SH OPTIONS +Long options may be abbreviated to their unique prefixes. +' +.TP 5 +.Oy \-\-output file \-o file +' +Send output to +.I file +instead of standard output. +' +.TP +.BR \-\-pfb ", " \-b +' +Output a PFB font. This is the default. +' +.TP +.BR \-\-pfa ", " \-a +' +Output a PFA font. +' +.TP +.Op \-\-amcp\-info +' +Do not create a font; instead, output an AMCP file for use by +.M mmafm 1 . +A message is printed if the font doesn't have intermediate masters, in +which case no AMCP file is necessary. +' +.TP +.Oy \-\-weight N \-w N +' +Set the weight axis to +.IR N . +' +.TP +.Oy \-\-width N \-W N +' +Set the width axis to +.IR N . +' +.TP +.Oy \-\-optical\-size N \-O N +' +Set the optical size axis to +.IR N . +' +.TP +.Ol \-\-style N +' +Set the style axis to +.IR N . +.TP +\fB\-\-1\fR=\fIN\fR (\fB\-\-2\fR=\fIN\fR, \fB\-\-3\fR=\fIN\fR, \fB\-\-4\fR=\fIN\fR) +' +Set the first (second, third, fourth) axis to +.IR N . +' +.TP +.Oy \-\-precision N \-p N +' +Set the output precision to +.IR N . +Higher values mean the control points in the output font will be more +exactly aligned; lower values (1 or 2) create smaller output font +files, and are close enough for most purposes. A precision of +.IR N +means that each point will be within +.RI 1/ N +font units of the exact interpolated value. (A font unit is generally +1/7200 inch for a 10-point font.) The default is 5. +' +.TP +.Ol \-\-subrs N +' +Limit the output font to at most +.IR N +subroutines. 256 is a good value for +.IR N . +' +.TP +.BR \-\-no\-minimize +' +Do not minimize the output font definition. By default, +.B mmpfb +removes extra PostScript code and dictionary definitions from the font. +Supply the +.B \-\-no\-minimize +option to avoid this behavior. +' +.SH TROUBLESHOOTING +.LP +The "IBM" Type 1 font interpreter shipped as part of the X font server and +.B ps2pk +(among others) is inappropriately strict about PostScript code embedded in +a font. The +.B \-\-minimize +option (now the default) fixes this problem. +.LP +Some versions of Adobe Acrobat Distiller may report "Warning: unable to +embed font X. Invalid character outline data" when distilling an instance +generated by +.BR mmpfb . +This is due to a limitation in the number of font subroutines Distiller can +accept. (Multiple master fonts, and the single-master fonts generated by +.BR mmpfb , +tend to have a lot of subroutines.) Try limiting the number of subroutines +in the generated font with the +.Op \-\-subrs +option. +' +.SH SEE ALSO +.M mmafm 1 +' +.SH DIAGNOSTICS +.TP 5 +reducing \fIfont\fR to minimum number of subroutines (\fIN\fR) +You tried to reduce the number of subroutines to less than \fIN\fR using +the +.Op \-\-subrs +option, but the font needs at least \fIN\fR to function. The output font +will have \fIN\fR subroutines. +' +.SH AUTHOR +.na +Eddie Kohler, ekohler@gmail.com +.PP +The latest version is available from: +.br +http://www.lcdf.org/type/ +.PP +Thanks to Melissa O'Neill for suggestions and patient +debugging. diff --git a/Master/texmf-dist/doc/man/man1/mmpfb.man1.pdf b/Master/texmf-dist/doc/man/man1/mmpfb.man1.pdf Binary files differnew file mode 100644 index 00000000000..47f6b40c391 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mmpfb.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/mpost.1 b/Master/texmf-dist/doc/man/man1/mpost.1 new file mode 100644 index 00000000000..d16a8f264e5 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mpost.1 @@ -0,0 +1,167 @@ +.TH MPOST 1 "5 April 2011" "MetaPost 1.504" +.\"===================================================================== +.de URL +\\$2 \(laURL: \\$1 \(ra\\$3 +.. +.if \n[.g] .mso www.tmac +.if n .ds MP MetaPost +.if t .ds MP MetaPost +.if n .ds MF Metafont +.if t .ds MF M\s-2ETAFONT\s0 +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff +.el .ds OX TeX for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.if n .ds WB Web +.if t .ds WB W\s-2EB\s0 +.\"===================================================================== +.SH NAME +mpost \- MetaPost, a system for creating graphics +.SH SYNOPSIS +.B mpost +.RI [ options ] +.RI [ commands ] +.PP +.B mpost +.B --dvitomp +.IR dvifile [\fB.dvi\fP] +.RI [ mpxfile [\fB.mpx\fP]] + +.\"===================================================================== +.SH DESCRIPTION +\*(MP interprets the \*(MP language and produces PostScript (EPS) +or Scalable Vector Graphics (SVG) pictures. The \*(MP language is similar +to Knuth's \*(MF with additional features for including +.BR tex (1) +or +.BR troff (1) +commands and accessing features of PostScript not found in \*(MF. +.PP +\*(MP is normally used with some preloaded macros, and it +will use its executable name as the name of the preload +file to use. For example, when called as +.B mpost +the +.I mpost.mp +file is used, which is identical to +.I plain.mp. +When the +.B --ini +option is given, preloading does not happen. +.PP +The +.I commands +given on the command line to the \*(MP program are passed to it as the +first input line. (But it is often easier to type extended arguments +as the first input line, since UNIX shells tend to gobble up or +misinterpret \*(MP's favorite symbols, like semicolons, unless you +quote them.) The normal usage is to say +.I mpost figs +to process the file +.IR figs.mp . +The basename of +.I figs +becomes the ``jobname'', +and is used in forming output file names. If no file is named, the +jobname becomes +.IR mpout . +The default extension, +.IR .mp , +can be overridden by specifying an extension explicitly. +.PP +When the +.B --dvitomp +option is given, \*(MP acts as DVI-to-MPX converter only. +See dvitomp (1) for details. +.PP +This manual page is not meant to be exhaustive. The complete +documentation for this version of \*(MP can be found in the +User Manual that should have been installed along with the program and +is also available from http://tug.org/metapost. +See the FILES section below. +.PP +The \*(MP language is similar to \*(MF, but the manual +assumes no knowledge of \*(MF. \*(MP does not have bitmap +output commands or \*(MF's online display mechanism. + +.\"===================================================================== +.SH FILES +.TP +.I plain.mp +The standard preload file. +.TP +.I mfplain.mp +The \*(MF-compatible preload file. +.TP +.I $TEXMFMAIN/metapost/base/*.mp +The standard \*(MP macros included in the original distribution. +.TP +.I $TEXMFMAIN/metapost/support/* +Various tables for handling included +.I tex +and +.IR troff . +.TP +.I $TEXMFMAIN/metapost/support/trfonts.map +Table of corresponding font names for +.I troff +and PostScript. +.TP +.I psfonts.map +Table of corresponding font names for +.I tex +and PostScript. +.TP +.I $TEXMFMAIN/doc/metapost/* +The \*(MP manual and tutorial source, also including sample figures +.\"===================================================================== +.SH "SUGGESTED READING" +Donald E. Knuth, +.I "The \*(MF\^book" +(Volume C of +.IR "Computers and Typesetting" ), +Addison-Wesley, 1986, ISBN 0-201-13445-4. +.br +.I TUGboat +(the journal of the \*(TX Users Group). +.\"===================================================================== +.SH "SEE ALSO" +.PP +.BR dvitomp (1), +.BR epstopdf (1), +.BR mf (1), +.BR mptopdf (1), +.BR tex (1), +.PP +.URL "http://foundry.supelec.fr/gf/project/metapost/" "MetaPost source code" . +.br +.URL "http://tug.org/metapost/" "MetaPost home page" . +.\"===================================================================== +.SH AUTHORS +\*(MP was designed by John D. Hobby, incorporating algorithms from +\*(MF by Donald E. Knuth. It was originally implemented on Unix, +incorporating system-dependent routines from +.BR web2c , +while not relying on it except for the actual \*(WB-to-C translator. +.PP +Ulrik Vieth adapted \*(MP to take advantage of the advanced path +searching features in more recent versions of +.B web2c +and worked towards fully integrating \*(MP into the canonical Unix +\*(TX distribution. +.PP +The current, CWEB based version of MetaPost is maintained by +Taco Hoekwater. +.PP +The manual and tutorial are maintained by Stephan Hennig and +Troy Henderson. +.\"===================================================================== +.SH BUGS +Email bug reports to metapost@tug.org. diff --git a/Master/texmf-dist/doc/man/man1/mpost.man1.pdf b/Master/texmf-dist/doc/man/man1/mpost.man1.pdf Binary files differnew file mode 100644 index 00000000000..8002ad29b86 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mpost.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/mptopdf.1 b/Master/texmf-dist/doc/man/man1/mptopdf.1 new file mode 100644 index 00000000000..3c547f06aa8 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mptopdf.1 @@ -0,0 +1,104 @@ +.TH "MPTOPDF" "1" "January 2007" "mptopdf 1.3.2" "ConTeXt" +.de URL +\\$2 \(laURL: \\$1 \(ra\\$3 +.. +.if \n[.g] .mso www.tmac +.de EX +.in +3 +.nf +.ft CW +.. +.de EE +.in -3 +.ft R +.fi +.. + +.SH "NAME" +mptopdf \- convert MetaPost to PDF + +.SH "SYNOPSIS" +\fBmptopdf\fP \fIFILE\fP [ ... ] + +.SH "DESCRIPTION" + +\fBmptopdf\fP can convert MetaPost-generated EPS files to PDF, or it +can process a MetaPost source file directly (see +.BR mpost (1)) +and convert the generated EPS files to PDF. + +.SH "OPTIONS" +All switches are specified in full here but can be abbreviated to the +shortest unique prefix. Thus, \fB--metaf\fP works the same as +\fB--metafun\fP. +.IP \fB--help\fP +Print a terse help message. +.IP "\fB--metafun\fP" +Use the metafun pre-compiled format to process the MetaPost source +file. You usually don't need this option, since metafun input is +usually produced and processed as part of a +.BR texexec (1) +run. Needs the \fB--rawmp\fP switch to take effect. +.IP \fB--rawmp\fP +Process the source file with +.BR mpost (1) +directly, rather than with +.BR texexec (1). +This option is needed if you want to specify \fB--metafun\fP. +.IP \fB--latex\fP +Typeseting labels using +.BR latex (1) +rather than plain +.BR tex (1). + +.SH "USAGE" + +To convert \fImanfig.20\fP to \fImanfig-20.pdf\fI: +.EX +mptopdf manfig.20 +.EE + +You can convert more than one EPS file at once: +.EX +mptopdf manfig.20 otherfig.17 finalfig.8 +.EE + +Or you can give +.BR mptopdf (1) +a pattern that it will expand: +.EX +mptopdf 'manfig.*' +.EE +Note the single quotes to protect the * from the shell. Of course, +usually you can let the shell do the wildcard expansion and therefore +leave off the quotes. + +To convert +.I figs.mp +to \fIfigs-1.pdf\fP, \fIfigs-2.pdf\fP, ... +.EX +mptopdf figs.mp +.EE + +If the labels are typeset with +.BR latex (1): +.EX +mptopdf --latex figs.mp +.EE + +.SH "SEE ALSO" +.PP +.BR tex (1), +.BR latex (1), +.BR mpost (1), +.BR pdftex (1), +.BR texexec (1). +.PP +.URL "http://www.contextgarden.net" "ConTeXt wiki" . + +.SH "AUTHOR" +.BR mptopdf (1) +is part of the ConTeXt system by Hans Hagen et al, which is available from +.URL "http://www.pragma-ade.com/" "PRAGMA ADE" . +This manpage was written by Sanjoy Mahajan <sanjoy@mit.edu> and is in +the public domain. diff --git a/Master/texmf-dist/doc/man/man1/mptopdf.man1.pdf b/Master/texmf-dist/doc/man/man1/mptopdf.man1.pdf Binary files differnew file mode 100644 index 00000000000..81e95d69381 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/mptopdf.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/musixflx.1 b/Master/texmf-dist/doc/man/man1/musixflx.1 new file mode 100644 index 00000000000..a3c214535e2 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/musixflx.1 @@ -0,0 +1,43 @@ +.\" This manpage is licensed under the GNU Public License +.TH MUSIXFLX 1 2011-04-21 "musixflx-0.83.3lua7" "" + +.SH NAME +musixflx \- process mx1 files (the second pass of 3-pass MusiXTeX typesetting) + +.SH SYNOPSIS +[ texlua ] +.B musixflx[.lua] +.I jobname +[ .mx1 | .tex ] +[ +.I debugmode +] + +where +.I debugmode +can be +.br + d output debugging information to the screen +.br + m output line numbers to the screen +.br + f output debugging information to jobname.mxl (not mx1) +.br + s output computed lines to the screen + +To allow for ease of use with a batch file, \fB musixflx.lua\fR +can be fed with either \fI jobname.mx1\fP, \fI jobname.tex\fP, +or just \fI jobname\fP, any of which open \fI jobname.mx1\fP +and create \fI jobname.mx2\fP. + +.SH SEE ALSO +.BR musixtex (1) +.br +musixdoc.pdf + +.SH AUTHOR +This manual page was written by Andreas Tille +<tille@debian.org> for the Debian GNU/Linux system (but may be used +by others). Corrections to the synopsis were pointed out by Peter +Breitenlohner <peb@mppmu.mpg.de> and implemented by Bob Tennent +<rdt@cs.queensu.ca>. diff --git a/Master/texmf-dist/doc/man/man1/musixflx.man1.pdf b/Master/texmf-dist/doc/man/man1/musixflx.man1.pdf Binary files differnew file mode 100644 index 00000000000..4f6c87f4a28 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/musixflx.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/musixtex.1 b/Master/texmf-dist/doc/man/man1/musixtex.1 new file mode 100644 index 00000000000..669f8bd2ff5 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/musixtex.1 @@ -0,0 +1,94 @@ +.\" This manpage is licensed under the GNU Public License +.TH MUSIXTEX 1 2012-09-14 "musixtex version 0.6" "" + +.SH NAME +musixtex \- processes MusiXTeX files, deleting intermediate files + +.SH SYNOPSIS +[ texlua ] +.B musixtex[.lua] +{ +.IR option +| +.IR jobname +[ .tex ] +} ... +.TP +The default effect is to process each file using +.TP 12 +.BR etex (1) +(first pass) +.TP +.BR musixflx (1) +(second pass) +.TP +.BR etex (1) +(third pass) +.TP +.BR dvips (1) +(dvi to Postscript) +.TP +.BR ps2pdf (1) +(Postscript to Portable Document Format) +.TP +followed by removal of intermediate files. + +.SH OPTIONS +.TP 8 +.B -v +output program name and version number, and quit +.TP +.B -h +output usage summary and quit +.TP +.B -l +changes the TeX processor to +.BR latex (1) +or +.BR pdflatex (1) +.TP +.B -p +changes the TeX processor to +.BR pdfetex (1) +or +.BR pdflatex (1) +(and doesn't run +.BR dvips (1) +and +.BR ps2pdf (1) +or +.BR dvipdfm (1) +) +.TP +.B -d +changes the dvi processor to +.BR dvipdfm (1) +.TP +.B -s +stops processing at the dvi file +.TP +.B -i +retain intermediate files +.TP +.B -1 +one-pass [pdf][la]tex processing +.TP +.B -f +default processing +.TP 0 +Options affect processing of all succeeding MusiXTeX files unless changed by another option. + +.SH SEE ALSO +.BR etex (1), +.BR latex (1), +.BR pdfetex (1), +.BR pdflatex (1), +.BR musixflx (1), +.BR dvipdfm (1), +.BR dvips (1), +.BR ps2pdf (1). +.br +musixdoc.pdf + +.SH AUTHOR +This manual page was written by Bob Tennent <rdt@cs.queensu.ca>. diff --git a/Master/texmf-dist/doc/man/man1/musixtex.man1.pdf b/Master/texmf-dist/doc/man/man1/musixtex.man1.pdf Binary files differnew file mode 100644 index 00000000000..a1a8bf2d114 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/musixtex.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/odvicopy.1 b/Master/texmf-dist/doc/man/man1/odvicopy.1 new file mode 100644 index 00000000000..95c66c4fde0 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/odvicopy.1 @@ -0,0 +1 @@ +.so man1/dvicopy.1 diff --git a/Master/texmf-dist/doc/man/man1/odvicopy.man1.pdf b/Master/texmf-dist/doc/man/man1/odvicopy.man1.pdf Binary files differnew file mode 100644 index 00000000000..be762d4d1cd --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/odvicopy.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/odvips.man1.pdf b/Master/texmf-dist/doc/man/man1/odvips.man1.pdf Binary files differnew file mode 100644 index 00000000000..95728fffbf0 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/odvips.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/odvitype.1 b/Master/texmf-dist/doc/man/man1/odvitype.1 new file mode 100644 index 00000000000..0841cb2a4c3 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/odvitype.1 @@ -0,0 +1 @@ +.so man1/dvitype.1 diff --git a/Master/texmf-dist/doc/man/man1/odvitype.man1.pdf b/Master/texmf-dist/doc/man/man1/odvitype.man1.pdf Binary files differnew file mode 100644 index 00000000000..9b2ad0149d6 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/odvitype.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/ofm2opl.1 b/Master/texmf-dist/doc/man/man1/ofm2opl.1 new file mode 100644 index 00000000000..5eb363d8ecc --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ofm2opl.1 @@ -0,0 +1,92 @@ +.TH "ofm2opl" "1" "September 2000" "Omega" "Omega" +.PP +.SH "NAME" +ofm2opl \- convert Omega and TeX font-metric files to property-list files +.PP +.SH "SYNOPSIS" +.PP +.B ofm2opl +.RI [ OPTIONS ] +.IR OFMNAME [ \fB.ofm\fP ] +.RI [ OPLFILE [ \fB.opl\fP ]] +.PP +.SH "DESCRIPTION" +.PP +\fBofm2opl\fP translates a binary Omega Font Metrics file, +\fIOFMNAME\fP, into a human-readable property-list form\&. The +program writes to standard output (by default) or to a file specified +as \fIOPLFILE\fP\&. +.PP +The program also works with TeX TFM files, producing TeX PL files\&. +(\fBofm2opl\fP is based on the WEB source code for \fBtftopl\fP(1)\&.) +.PP +.SH "OPTIONS" +.PP +.IP +.IP "\fB-charcode-format=\fP\fITYPE\fP" +output character codes +according to \fITYPE\fP, +which can be either `hex\&' +or `ascii\&'\&. Default is +`hex\&'\&. ascii specifes all +ASCII letters and digits; +hex gets you everything +else\&. +.IP +.IP "\fB-help\fP" +display a brief summary of syntax and options +.IP "\fB-verbose\fP" +display progress reports +.IP "\fB-version\fP" +output version information and exit +.IP +.PP +.SH "FILES" +.PP +.IP "\fIOFMNAME\fP" +an Omega Font Metric file +.IP "\fIOPLFILE\fP" +an Omega Property List file +.PP +.SH "BUGS" +.PP +None known, but report any found to <omega@ens\&.fr> (mailing list)\&. You may also want to +check to see if the same bug is present in \fBpltotf\fP(1)\&. +.PP +.SH "SEE ALSO" +.PP +\fBomega\fP(1), \fBopl2ofm\fP(1), \fBpltotf\fP(1), +\fBtftopl\fP(1)\&. +.PP +\fIDraft Manual for the Omega System\fP (\fIomega-manual\&.dvi\fP)\&. +.PP +Web page: <http://www\&.gutenberg\&.eu\&.org/omega/> +.PP +.SH "AUTHOR" +.PP +According to the WEB documentation: +.PP +.RS +The first \fBTFtoPL\fP program was designed by Leo Guibas in the +summer of 1978\&. Contributions by Frank Liang, Doug Wyatt, and Lyle +Ramshaw also had a significant effect on the evolution of the present +code\&. +.PP +Extensions for an enhanced ligature mechanism were added by D\&.E\&. Knuth +in 1989\&. +.PP +Extensions to handle extended font metric files (``OFM\&'\&') were added +by John Plaice in December 1995 and January 1996, resulting in the new +program \fBOFM2OPL\fP\&. +.RE +.PP +The primary authors of Omega are John Plaice +<plaice@cse\&.unsw\&.edu\&.au> and Yannis Haralambous +<yannis@fluxus-virus\&.com>\&. +.PP +This manual page was written by C\&.M\&. Connelly +<cmc@debian\&.org>, for +the Debian GNU/Linux system\&. It may be used by other distributions +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/Master/texmf-dist/doc/man/man1/ofm2opl.man1.pdf b/Master/texmf-dist/doc/man/man1/ofm2opl.man1.pdf Binary files differnew file mode 100644 index 00000000000..878a7b07616 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ofm2opl.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/opl2ofm.1 b/Master/texmf-dist/doc/man/man1/opl2ofm.1 new file mode 100644 index 00000000000..8aa00d8c104 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/opl2ofm.1 @@ -0,0 +1,75 @@ +.TH "opl2ofm" "1" "September 2000" "Omega" "Omega" +.PP +.SH "NAME" +opl2ofm \- convert Omega and TeX property-list files to font-metric files +.PP +.SH "SYNOPSIS" +.PP +.B opl2ofm +.RI [ OPTIONS ] +.IR OPLFILE [ \fB.opl\fP ] +.RI [ OFMFILE [ \fB.ofm\fP ]] +.PP +.SH "DESCRIPTION" +.PP +\fBopl2ofm\fP translates a property-list format file, \fIOPLFILE\fP, +into the binary Omega Font Metric format\&. The program writes to +standard output (by default) or to a file specified as +\fIOFMFILE\fP\&. +.PP +The program also works with TeX PL files, producing TeX TFM files\&. +(\fBopl2ofm\fP is based on the WEB source code for \fBpltotf\fP(1)\&.) +.PP +.SH "OPTIONS" +.PP +.IP +.IP "\fB-help\fP" +display a brief summary of syntax and options +.IP "\fB-verbose\fP" +display progress reports +.IP "\fB-version\fP" +output version information and exit +.IP +.PP +.SH "BUGS" +.PP +None known, but report any found to <omega@ens\&.fr> (mailing list)\&. You should also +check to see if the bug is present in \fBpltotf\fP(1)\&. +.PP +.SH "SEE ALSO" +.PP +\fBomega\fP(1), \fBofm2opl\fP(1), \fBpltotf\fP(1), +\fBtftopl\fP(1)\&. +.PP +\fIDraft Manual for the Omega System\fP (\fIomega-manual\&.dvi\fP)\&. +.PP +Web page: <http://www\&.gutenberg\&.eu\&.org/omega/> +.PP +.SH "AUTHOR" +.PP +According to the WEB documentation: +.PP +.RS +The first \fBPLtoTF\fP program was designed by Leo Guibas in the +summer of 1978\&. Contributions by Frank Liang, Doug Wyatt, and Lyle +Ramshaw also had a significant effect on the evolution of the present +code\&. +.PP +Extensions for an enhanced ligature mechanism were added by D\&.E\&. Knuth +in 1989\&. +.PP +Extensions to handle extended font metric files (``OFM\&'\&') were added +by John Plaice in December 1995 and January 1996, resulting in the new +program \fBOPL2OFM\fP\&. +.RE +.PP +The primary authors of Omega are John Plaice +<plaice@cse\&.unsw\&.edu\&.au> and Yannis Haralambous +<yannis@fluxus-virus\&.com>\&. +.PP +This manual page was written by C\&.M\&. Connelly +<cmc@debian\&.org>, for +the Debian GNU/Linux system\&. It may be used by other distributions +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/Master/texmf-dist/doc/man/man1/opl2ofm.man1.pdf b/Master/texmf-dist/doc/man/man1/opl2ofm.man1.pdf Binary files differnew file mode 100644 index 00000000000..b8c7561fa11 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/opl2ofm.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/ot2kpx.1 b/Master/texmf-dist/doc/man/man1/ot2kpx.1 new file mode 100644 index 00000000000..853982cfffb --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ot2kpx.1 @@ -0,0 +1,213 @@ +.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "OT2KPX 1" +.TH OT2KPX 1 "2012-03-06" "fontools" "Marc Penninga" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +ot2kpx \- extract kerning information from OpenType fonts +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +.IP "\fBot2kpx\fR" 8 +.IX Item "ot2kpx" +\&\fBfontfile\fR +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +\&\fBot2kpx\fR extract the kerning data from OpenType fonts (both \fIotf\fR +and \fIttf\fR formats) and prints it (in \fIafm\fR format) to \f(CW\*(C`stdout\*(C'\fR. +.SH "OPTIONS AND ARGUMENTS" +.IX Header "OPTIONS AND ARGUMENTS" +.IP "\fBfontfile\fR" 4 +.IX Item "fontfile" +The OpenType font (in either \fIotf\fR or \fIttf\fR format). +.SH "RESTRICTIONS" +.IX Header "RESTRICTIONS" +.IP "\fB\-\fR" 4 +.IX Item "-" +\&\fBot2kpx\fR doesn't implement all of the OpenType specification. +Things that are missing include: support for font files containing +multiple fonts, LookupTables with LookupTypes other than 2, +\&\*(L"kern\*(R" tables with format other than 0 and ValueRecords with +other types of data than just XAdvance data. +.Sp +Most of these limitations don't really matter, since the missing features +are rare (the only fonts I know of that use them are the non-western fonts +that come with Adobe Reader). Furthermore, some of these features concern +(according to the OpenType specification) \fI\*(L"define subtle, device-dependent +adjustments at specific font sizes or device resolutions\*(R"\fR. +Since there's no way to express such adjustments in \fIafm\fR format, +ignoring them seems to be the only option anyway. +.IP "\fB\-\fR" 4 +.IX Item "-" +\&\fBot2kpx\fR collects kerning data first from the \*(L"kern\*(R" table, then from +all LookupTables associated with the \*(L"kern\*(R" feature; if a kerning pair +occurs multiple times, the first value seen is chosen. +There are (or may be) several issues with this approach: +.RS 4 +.IP "\-" 4 +The OpenType specification says that fonts in \fIotf\fR format shouldn't +use the \*(L"kern\*(R" table at all, just the lookups from the \*(L"\s-1GPOS\s0\*(R" table. +Many such fonts do, however, contain a \*(L"kern\*(R" table, but no \*(L"\s-1GPOS\s0\*(R" table; +so we use the \*(L"kern\*(R" table anyway. +.IP "\-" 4 +Instead of reading all LookupTables, it might be better to let the user +specify a script and language and process only the LookupTables for +those values. +However, at least in the fonts I checked, all script/language combinations +eventually point to the \fIsame\fR \*(L"kern\*(R" LookupTables, so this approach +wouldn't make any difference (apart from further complicating the code). +.RE +.RS 4 +.RE +.SH "AUTHOR" +.IX Header "AUTHOR" +Marc Penninga <marcpenninga@gmail.com> +.SH "COPYRIGHT" +.IX Header "COPYRIGHT" +Copyright (C) 2005\-2012 Marc Penninga. +.SH "LICENSE" +.IX Header "LICENSE" +This program is free software; you can redistribute it and/or modify +it under the terms of the \s-1GNU\s0 General Public License as published +by the Free Software Foundation, either version 2 of the License, +or (at your option) any later version. +A copy of the \s-1GNU\s0 General Public License is included with \fBautoinst\fR; +see the file \fIGPLv2.txt\fR. +.SH "DISCLAIMER" +.IX Header "DISCLAIMER" +This program is distributed in the hope that it will be useful, +but \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of +\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0. +See the \s-1GNU\s0 General Public License for more details. +.SH "RECENT CHANGES" +.IX Header "RECENT CHANGES" +(See the source code for the rest of the story.) +.IP "\fI2012\-02\-01\fR" 12 +.IX Item "2012-02-01" +Refactored the code, and fixed a number of bugs in the process. +Updated the documentation. diff --git a/Master/texmf-dist/doc/man/man1/ot2kpx.man1.pdf b/Master/texmf-dist/doc/man/man1/ot2kpx.man1.pdf Binary files differnew file mode 100644 index 00000000000..e8cbce9096b --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ot2kpx.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/otangle.1 b/Master/texmf-dist/doc/man/man1/otangle.1 new file mode 100644 index 00000000000..6c242cba957 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/otangle.1 @@ -0,0 +1 @@ +.so man1/tangle.1 diff --git a/Master/texmf-dist/doc/man/man1/otangle.man1.pdf b/Master/texmf-dist/doc/man/man1/otangle.man1.pdf Binary files differnew file mode 100644 index 00000000000..3531a91345f --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/otangle.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/otfinfo.1 b/Master/texmf-dist/doc/man/man1/otfinfo.1 new file mode 100644 index 00000000000..c3f76691c5b --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/otfinfo.1 @@ -0,0 +1,195 @@ +'\"t +.ds V 2.92 +.de M +.BR "\\$1" "(\\$2)\\$3" +.. +.de Sp +.if n .sp +.if t .sp 0.4 +.. +.TH OTFINFO 1 "LCDF Typetools" "Version \*V" +.SH NAME +otfinfo \- report information about OpenType fonts +.SH SYNOPSIS +.B otfinfo +\%[\fB-sfzpvag\fR] +\%[\fIFILE...\fR] +' +.SH DESCRIPTION +.BR Otfinfo +reports information about the named OpenType font +.IR FILE s +(or standard input, if no +.IR FILE s +are given). Results are printed to standard output. Each line is prefaced +with the relevant +.I FILE +if more than one +.I FILE +was supplied. +' +.SH OPTIONS +With long options, you need type only as many characters as will make the +option unique. +.SS Query options +.PD 0 +.PD 0 +.TP 5 +.BR \-s ", " \-\-scripts +Print supported scripts and language systems. The scripts are printed one +per line, with human-readable descriptions; for example: +.nf + cyrl Cyrillic + grek Greek + latn Latin + latn.TUR Latin/Turkish +.fi +' +.Sp +.TP 5 +.BR \-f ", " \-\-features +Print GSUB and GPOS features supported by the selected script (see the +.B \-\-script +option below). The scripts are printed one per line, with human-readable +descriptions; for example: +.nf + aalt Access All Alternates + c2sc Small Capitals From Capitals + case Case-Sensitive Forms + cpsp Capital Spacing + \&... + zero Slashed Zero +.fi +' +.Sp +.TP 5 +.BR \-z ", " \-\-optical\-size +Print optical size information. For example: +.nf + design size 11 pt, size range (8.4 pt, 13 pt], subfamily ID 11, subfamily name Semibold Italic +.fi +' +.Sp +.TP 5 +.BR \-p ", " \-\-postscript\-name +Print each font's PostScript name. For example: +.nf + MinionPro-SemiboldItCapt +.fi +' +.Sp +.TP 5 +.BR \-a ", " \-\-family +Print each font's family name. For example: +.nf + Minion Pro +.fi +' +.Sp +.TP 5 +.BR \-v ", " \-\-font\-version +Print font version information, if available. For example: +.nf + OTF 1.013;PS 001.000;Core 1.0.27;makeotf.lib(1.11) +.fi +' +.Sp +.TP 5 +.BR \-i ", " \-\-info +Print each font's name, version, designer, vendor, copyright, and license +information. For example: +.nf + Family: Minion Pro + Subfamily: Regular + Full name: Minion Pro + PostScript name: MinionPro-Regular + Version: OTF 1.011;PS 001.000;Core 1.0.27;makeotf.lib1.3.1 + Unique ID: 1.011;ADBE;MinionPro-Regular + Designer: Robert Slimbach + Vendor URL: http://www.adobe.com/type/ + Trademark: Minion is either a registered trademark or a trademark of Adobe Systems Incorporated in the United States and/or other countries. + Copyright: \(co 2000 Adobe Systems Incorporated. All Rights Reserved. U.S. Patent Des. 337,604. Other patents pending. + License URL: http://www.adobe.com/type/legal.html +.fi +' +.Sp +.TP 5 +.BR \-g ", " \-\-glyphs +Print the name of every glyph in each font, one per line. For example: +.nf + \&.notdef + space + exclam + \&... + ncommaaccent.end + lje.alt +.fi +Works for PostScript-flavored OpenType fonts only. +' +.Sp +.TP 5 +.BR \-t ", " \-\-tables +Print the size and name of every OpenType table in the font. For example: +.nf + 52 BASE + 87723 CFF + 4940 DSIG + 21366 GPOS + \&... +.fi +' +.Sp +.TP 5 +.BR \-T ", " \-\-dump\-table \fItable\fR +Print the contents of the font's OpenType table \fItable\fR. +' +.PD +' +' +.SS Miscellaneous options +' +.PD 0 +.TP 5 +.BI \-\-script= "script\fR[.\fIlang\fR]" +Select the script system +.I script +and language system +.IR lang +used to look up features by +.BR \-\-features . +Examples include "latn" (Latin script), "grek" (Greek script), and "yi.YIC" +(Yi script with classic characters). If +.I lang +is not specified, otfinfo will use the default language system for that +script. Defaults to "latn". +' +.Sp +.TP 5 +.BR \-V ", " \-\-verbose +Write progress messages to standard error. +' +.Sp +.TP 5 +.BR \-q ", " \-\-quiet +Do not generate any error messages. +' +.Sp +.TP 5 +.BR \-h ", " \-\-help +Print usage information and exit. +' +.Sp +.TP 5 +.BR \-\-version +Print the version number and some short non-warranty information and exit. +.PD +' +.SH "SEE ALSO" +.LP +.M otftotfm 1 +.LP +.IR "OpenType Specification" , +Version 1.4 +' +.SH AUTHOR +Eddie Kohler (ekohler@gmail.com) diff --git a/Master/texmf-dist/doc/man/man1/otfinfo.man1.pdf b/Master/texmf-dist/doc/man/man1/otfinfo.man1.pdf Binary files differnew file mode 100644 index 00000000000..94ca01709ee --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/otfinfo.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/otftotfm.1 b/Master/texmf-dist/doc/man/man1/otftotfm.1 new file mode 100644 index 00000000000..d83263f40b4 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/otftotfm.1 @@ -0,0 +1,1654 @@ +'\"t +.ds V 2.92 +.de M +.BR "\\$1" "(\\$2)\\$3" +.. +.de Sp +.if n .sp +.if t .sp 0.4 +.. +.de Bp +.IP \(bu 3n +.. +.TH OTFTOTFM 1 "LCDF Typetools" "Version \*V" +.SH NAME +otftotfm \- create TeX font metrics from OpenType fonts +.SH SYNOPSIS +.B otftotfm +\%[\fB\-a\fR] +\%[\fBoptions\fR] +\%\fIfontfile\fR [\fItexname\fR] +' +.SH DESCRIPTION +.BR Otftotfm +creates the font metric and encoding files required to use an OpenType font +with TeX. You supply an OpenType ".otf" or ".ttf" font file, +a base ".enc" encoding, +and a TeX name "\fItexname\fR" for the resulting font, and say which +OpenType features should be turned on. Then +.B otftotfm +generates and installs the corresponding TeX-related metric files (".tfm" +TeX font metrics, ".vf" virtual fonts, and ".enc" encoding files). It +works on both PostScript-flavored and TrueType-flavored OpenType fonts, +although TrueType-flavor support will only work easily with pdftex. +.LP +The easiest way to use +.B otftotfm +is with the +.B \-a +option; see Automatic Mode below. Without +.BR \-a , +.B otftotfm +writes all its output files to the current directory. +.LP +After running "\fBotftotfm\fR \fIfontfile\fR \fItexname\fR" and +installing the results (manually or with +.BR \-a ), +you can use the OpenType font in plain TeX with a command like this: +.Sp +.nf + \efont\emyfont=\fItexname\fR at 10pt + {\emyfont This text uses the OpenType font.} +.fi +.Sp +LaTeX users will generally make a ".fd" input file so that commands like +"\erenewcommand{\ermdefault}{TeXName}" work correctly. See the EXAMPLE +section for more; check the DIAGNOSTICS and FREQUENTLY ASKED QUESTIONS +sections if you have trouble. +' +.SS "OpenType Features" +.LP +OpenType fonts support optional +.I features +that change their appearance. Use the +.B \-f +option to turn on selected features. For example, "\fB\-f\fRsmcp" replaces +lower-case letters with the corresponding small capitals, in fonts that +support this. +' +.PP +You'll generally provide at least the "\fB\-f\fRkern" and "\fB\-f\fRliga" +options, which activate pair kerns and f-ligatures. Other interesting +features include "\fB\-f\fRcpsp", for capital spacing; "\fB\-f\fRdlig", for +optional ligatures; "\fB\-f\fRlnum", "\fB\-f\fRonum", "\fB\-f\fRpnum", and +"\fB\-f\fRtnum", to control digit glyphs; "\fB\-f\fRsmcp", for small +capitals; "\fB\-f\fRswsh", for swash variants; and "\fB\-f\fRcswh", for +contextual swash. See the FEATURE DIRECTORY section below for more. The +.M otfinfo 1 +program will report which features a font supports; run "\fBotfinfo\fR +\fB\-f\fR \fIfontfile\fR". +' +.PP +Feature options can also apply a feature to a subset of characters in the +font. For example, "\fB\-\-lf\fR smcp" +.I only +replaces letters with small capitals, whereas "\fB\-f\fRsmcp" might +additionally replace digits and punctuation marks with small-capital +versions. +' +.SS Automatic Mode +.PP +Automatic mode, triggered by the +.BR \-a / \-\-automatic +option, installs font metrics and encoding files where TeX can find them, +and additionally installs a Type 1 font and mapping for +.M dvips 1 . +This requires a TeX installation that follows the TeX Directory Structure +standard (http://www.tug.org/tds/), such as most Unix TeX installations. +' +.PP +Automatic mode should run seamlessly out of the box. +.B Otftotfm +will install metrics files, encodings, map files, and Type\~1 fonts into +.I $HOME/.texmf-var +or any other writable TEXMF directory, and run +.M updmap 1 +to update the global lists of installed fonts. (On older teTeX +installations, you may first need to copy the system's +.I updmap.cfg +file to +.I $HOME/texmf/web2c +and run +.M mktexlsr 1 . +On newer TeXLive installations, you may need to set the TEXMFVAR environment +variable.) +You can then run "\fBotftotfm\fR +.B \-a +.IR fontfile +.IR texname \&" +and immediately refer to the font in TeX using the +.I texname +you supplied. Again, you will have to write ".fd" files and/or typescripts +to make the font conveniently accessible from LaTeX or ConTeXt. See the +DIAGNOSTICS section if you have problems with these instructions. +' +.PP +In automatic mode, +.B otftotfm +searches your $TEXMFVAR or $TEXMF path for a writable directory, then +installs files under that directory tree as follows: +' +.TS +l l l . +\fBFile type\fR \fBDirectory\fR \fBFilename\fR +TFM TEXMF/fonts/tfm/\fIvendor\fR/\fItypeface\fR/ \fItexname\fR[\-\-base].tfm +VF TEXMF/fonts/vf/\fIvendor\fR/\fItypeface\fR/ \fItexname\fR.vf +PL TEXMF/fonts/pl/\fIvendor\fR/\fItypeface\fR/ \fItexname\fR[\-\-base].pl +VPL TEXMF/fonts/vpl/\fIvendor\fR/\fItypeface\fR/ \fItexname\fR.vpl +encoding TEXMF/fonts/enc/dvips/\fIvendor\fR/ a_\fIsignature\fR.enc + or TEXMF/dvips/\fIvendor\fR/ +font map TEXMF/fonts/map/dvips/\fIvendor\fR/ \fIvendor\fR.map + or TEXMF/dvips/\fIvendor\fR/ +.TE +.PP +"TEXMF" stands for the writable TEXMF directory. \fITexname\fR is the +font name supplied as +.BR otftotfm 's +second argument. The \fIvendor\fR and \fItypeface\fR strings are required +by TDS; they default to "lcdftools" and the font's family name, +respectively, but see the +.B \-\-vendor +and +.B \-\-typeface +options. \fISignature\fR is an opaque 6-character encoding signature. +.PP +.B Otftotfm +also installs a font file suitable for printing. PostScript-flavored +OpenType fonts are translated to Type 1 format and installed as PFB fonts. +TrueType-flavored fonts are normally installed as is, since pdftex and +pdflatex can read TrueType directly; but if you provide the +.B \-\-type42 +option, +.B otftotfm +will translate TrueType fonts to Type 42 format, which dvips understands. +.B Otftotfm +does not overwrite existing font files. +.PP +The installation paths are as follows, where \fIPSname\fR is the font's +PostScript name. +.TS +l l l . +PFB TEXMF/fonts/type1/\fIvendor\fR/\fItypeface\fR/ \fIPSname\fR.pfb +TrueType TEXMF/fonts/truetype/\fIvendor\fR/\fItypeface\fR/ \fIfontfile\fR +Type 42 TEXMF/fonts/type42/\fIvendor\fR/\fItypeface\fR/ \fIPSname\fR.t42 +.TE +.PP +You can override these directories with environment variables and options +as follows. Options take precedence over environment variables. +' +.TS +l l l . +\fBFile type\fR \fBEnvironment variable\fR \fBOption\fR +TFM TFMDESTDIR \-\-tfm\-directory +VF VFDESTDIR \-\-vf\-directory +PL PLDESTDIR \-\-pl\-directory +VPL VPLDESTDIR \-\-vpl\-directory +encoding ENCODINGDESTDIR \-\-encoding\-directory +PFB T1DESTDIR \-\-type1\-directory +TrueType TRUETYPEDESTDIR \-\-truetype\-directory +Type 42 T42DESTDIR \-\-type42\-directory +font map \- \-\-map\-file +.TE +.PP +.B Otftotfm +will update the +.I TEXMF/ls-R +file when installing files under TEXMF. It will also run the +.M updmap 1 +program after changing a map file, unless the +.B \-\-no\-updmap +option was supplied. However, if an executable file called +.IR TEXMF/dvips/updmap +exists, this file is executed (from the +.I TEXMF/dvips +directory) rather than the global +.BR updmap . +This is so you can write a fast, customized version of +.B updmap +if desired. +' +.SH EXAMPLE +This section uses MinionPro to show one way to install OpenType fonts for +LaTeX. We begin with six fonts: "MinionPro-Regular.otf", +"MinionPro-It.otf", "MinionPro-Semibold.otf", "MinionPro-SemiboldIt.otf", +"MinionPro-Bold.otf", and "MinionPro-BoldIt.otf". +.PP +Our first task is to decide how to encode the fonts. The "encoding scheme" +is used by TeX to decide how to typeset accents and symbols like "$". The +"LY1" encoding scheme has reasonable accent support and is a good choice +for many OpenType fonts. LY1 corresponds to the "texnansx.enc" encoding +file, so we will supply +.B otftotfm +with the "\fB\-e\fR texnansx" option. +.RS +.LP +Expert note: Strictly speaking, LY1 corresponds to the "texnansi.enc" +encoding file. Since the "texnansx.enc" version omits duplicate +characters, it has more room for font-specific glyphs and is generally a +better choice; but if you plan to type characters like "ae" directly into +your editor, rather than using TeX commands like \eae, you should use +"texnansi.enc". +.RE +.PP +Next, we decide on a naming scheme for the font metric files. Let's use +the OpenType font names as a base. (There's generally no need to follow +the six-character "Karl Berry" naming scheme.) Just in case we come back +later and add a different encoding scheme, we'll prepend "LY1--" to each +name. +.PP +We're now ready to run +.B otftotfm +for the first set of fonts. Note the "\fB\-f\fRkern \fB\-f\fRliga" +options, which access pair kerns and the default "f" ligatures. +.Sp +.nf + \fBotftotfm\fR \fB\-a\fR \fB\-e\fR texnansx MinionPro\-Regular.otf \e + \fB\-f\fRkern \fB\-f\fRliga LY1\-\-MinionPro\-Regular + \fBotftotfm\fR \fB\-a\fR \fB\-e\fR texnansx MinionPro\-It.otf \e + \fB\-f\fRkern \fB\-f\fRliga LY1\-\-MinionPro\-It + \fBotftotfm\fR \fB\-a\fR \fB\-e\fR texnansx MinionPro\-Semibold.otf \e + \fB\-f\fRkern \fB\-f\fRliga LY1\-\-MinionPro\-Semibold + \fBotftotfm\fR \fB\-a\fR \fB\-e\fR texnansx MinionPro\-SemiboldIt.otf \e + \fB\-f\fRkern \fB\-f\fRliga LY1\-\-MinionPro\-SemiboldIt + \fBotftotfm\fR \fB\-a\fR \fB\-e\fR texnansx MinionPro\-Bold.otf \e + \fB\-f\fRkern \fB\-f\fRliga LY1\-\-MinionPro\-Bold + \fBotftotfm\fR \fB\-a\fR \fB\-e\fR texnansx MinionPro\-BoldIt.otf \e + \fB\-f\fRkern \fB\-f\fRliga LY1\-\-MinionPro\-BoldIt +.fi +.Sp +The small-caps fonts are generated with an additional "\fB\-f\fRsmcp" +option. We append "\-\-fsmcp" to the font metric names as well, +differentiating them from the regular fonts. Although MinionPro's italic +fonts support small-caps, the LaTeX font selection scheme can't access them +easily, so we've left them off. +.Sp +.nf + \fBotftotfm\fR \fB\-a\fR \fB\-e\fR texnansx MinionPro\-Regular.otf \e + \fB\-f\fRkern \fB\-f\fRliga \fB\-f\fRsmcp LY1\-\-MinionPro-Regular\-\-fsmcp + \fBotftotfm\fR \fB\-a\fR \fB\-e\fR texnansx MinionPro\-Semibold.otf \e + \fB\-f\fRkern \fB\-f\fRliga \fB\-f\fRsmcp LY1\-\-MinionPro\-Semibold\-\-fsmcp + \fBotftotfm\fR \fB\-a\fR \fB\-e\fR texnansx MinionPro\-Bold.otf \e + \fB\-f\fRkern \fB\-f\fRliga \fB\-f\fRsmcp LY1\-\-MinionPro\-Bold\-\-fsmcp +.fi +.Sp +To get old-style numerals, just add the "\fB\-f\fRonum" option to each +invocation -- and, to reduce confusion, append "\-\-fonum" to the font metric +names. +.PP +At this point, all our font metric files are installed, and it's finally +time to create the ".fd" file. (The ".fd" format is documented in +.IR "The LaTeX Companion" .) +Let's call the LaTeX font family "MinionPro". Then the ".fd" file is +"LY1MinionPro.fd", and it contains: +.Sp +.nf + \eDeclareFontFamily{LY1}{MinionPro}{} + \eDeclareFontShape{LY1}{MinionPro}{m}{n}% + { <\-> LY1\-\-MinionPro\-Regular }{} + \eDeclareFontShape{LY1}{MinionPro}{m}{it}{ <\-> LY1\-\-MinionPro\-It }{} + \eDeclareFontShape{LY1}{MinionPro}{m}{sc}% + { <\-> LY1\-\-MinionPro\-Regular\-\-fsmcp }{} + \eDeclareFontShape{LY1}{MinionPro}{sb}{n}% + { <\-> LY1\-\-MinionPro\-Semibold }{} + \eDeclareFontShape{LY1}{MinionPro}{sb}{it}% + { <\-> LY1\-\-MinionPro\-SemiboldIt }{} + \eDeclareFontShape{LY1}{MinionPro}{sb}{sc}% + { <\-> LY1\-\-MinionPro\-Semibold\-\-fsmcp }{} + \eDeclareFontShape{LY1}{MinionPro}{b}{n}{ <\-> LY1\-\-MinionPro-Bold }{} + \eDeclareFontShape{LY1}{MinionPro}{b}{it}% + { <\-> LY1\-\-MinionPro\-BoldIt }{} + \eDeclareFontShape{LY1}{MinionPro}{b}{sc}% + { <\-> LY1\-\-MinionPro\-Bold\-\-fsmcp }{} + \eDeclareFontShape{LY1}{MinionPro}{bx}{n}% + { <\-> ssub * MinionPro/b/n }{} + \eDeclareFontShape{LY1}{MinionPro}{bx}{it}% + { <\-> ssub * MinionPro/b/it }{} + \eDeclareFontShape{LY1}{MinionPro}{bx}{sc}% + { <\-> ssub * MinionPro/b/sc }{} +.fi +.PP +We're now ready to use MinionPro in LaTeX, with lines like this in the +document preamble: +.Sp +.nf + \eusepackage[LY1]{fontenc} + \erenewcommand{\ermdefault}{MinionPro} + \erenewcommand{\ebfdefault}{b} +.fi +.PP +Of course, we're free at any time to add more MinionPro variants with +.BR otftotfm ; +they'll become accessible to LaTeX as soon as we edit the "MinionPro.fd" +file. +' +.SH OPTIONS +With long options, you need type only as many characters as will make the +option unique. +.SS Font Feature and Transformation Options +.PD 0 +.TP 5 +.BI \-s " script\fR[.\fIlang\fR], " \-\-script= "script\fR[.\fIlang\fR]" +Apply features suitable to the script system +.I script +and language system +.IR lang . +Scripts and language systems are two-to-four-letter names assigned by +Microsoft and Adobe. Examples include "latn" (Latin script), "grek" (Greek +script), and "yi.YIC" (Yi script with classic characters). If +.I lang +is not specified, +.B otftotfm +will use the default language system for that +script. You can give this option multiple times. Run "\fBotfinfo\fR +\-s \fIfont\fR" to see the list of scripts and languages a +font supports. Defaults to "latn". +' +.Sp +.TP 5 +.BI \-f " feature\fR, " \-\-feature= "feature" +Activate the feature named +.IR feature . +Features are four-letter names assigned by Microsoft and Adobe; they are +meant to correspond to font behaviors, such as kerning or small-capitals. +Examples include "liga" (default ligatures), "dlig" (discretionary +ligatures), "kern" (kerning), and "c2sc" (replacing capitals with small +capitals). Give this option multiple times to apply multiple features. Run +"\fBotfinfo\fR \-f [\-\-script option] \fIfont\fR" to see the list +of features a font supports for a specified script. +Defaults to any features required by the selected scripts. +' +.Sp +.TP 5 +.BI \-\-lf " feature\fR, " \-\-letter\-feature= "feature" +Activate the feature named +.IR feature , +but only for letters. For instance, the "\-f smcp" option will apply the +small-caps feature to all characters in the encoding; this may result in +changes to punctuation and numbers as well as letters. The "\-\-lf smcp" +option will apply the small-caps feature only to letters, meaning +characters with the "Letter" Unicode property. +' +.Sp +.TP 5 +.BI \-\-subs\-filter " pattern" +.TP 5 +.BI \-\-include\-subs " pattern" +.TP 5 +.BI \-\-exclude\-subs " pattern" +.TP 5 +.BI \-\-clear\-subs +Limit the characters that +.B otftotfm +will substitute. Substitution is allowed on an input character if it +matches at least one of the +.B \-\-include +patterns, and none of the +.B \-\-exclude +patterns. Each pattern applies to all following features, except that the +.B \-\-clear +option clears any accumulated patterns. The +.BI \-\-subs\-filter " pattern" +option acts like +.B \-\-clear\-subs +followed by +.BI \-\-include\-subs " pattern\fR. " +For pattern syntax, see GLYPH PATTERNS, below. +.Sp +In the command line below, the \&'<Number>' pattern will force the "onum" +feature to substitute only numbers (and not, for example, punctuation). +The "salt" feature can still substitute any character. +.nf + \fBotftotfm\fR \fB\-f\fRsalt \fB\-\-include\-subs\fR="<Number>" \fB\-f\fRonum \.\.\. +.fi +' +.Sp +.TP 5 +.BI \-E " fac\fR, " \-\-extend= fac +Widen, or extend, the font by a factor of +.IR fac . +Like +.M afm2tfm 1 's +.B \-e +option. +' +.Sp +.TP 5 +.BI \-S " amt\fR, " \-\-slant= amt +Oblique, or slant, the font by +.IR amt . +Like +.M afm2tfm 1 's +.B \-s +option. +' +.Sp +.TP 5 +.BI \-L " amt\fR, " \-\-letterspacing= amt +Letterspace each character by +.IR amt +units, where 1000 units equals one em. The width of each character +increases by +.IR amt , +with half the space distributed to each sidebearing. Boundary-character +kerns are added to maintain alignment at the ends of lines. +' +.Sp +.TP 5 +.BR \-\-math\-spacing "[=\fIskewchar\fR]" +Ignore the font's claimed character widths, deriving horizontal metrics +from bounding boxes instead. This results in similar spacing as the +Computer Modern Math Italic font, with increased sidebearings for letters +like f and j. +.Sp +If you provide +.IR skewchar , +a number between 0 and 255 or a single character, then +.B otftotfm +adds heuristically-derived kerns to the font that may improve accent +positions in math mode. To get the benefits, you must tell TeX about the +.I skewchar +with a command like "\eskewchar\efont=\fIskewchar\fR". +' +.Sp +.TP 5 +.BI "\-k " "N\fR, " \-\-min\-kern= N +Only output kerning pairs whose absolute value is +.IR N +or larger. Larger minimum kerns make kerning less precise, but shrink the +output TFM file. The default minimum kern is 2.0, or 0.002 em. +' +.Sp +.TP 5 +.BI \-\-space\-factor= fac +Scale the width of the inter-word space by a factor of +.IR fac . +' +.Sp +.TP 5 +.BI \-\-design\-size= size +Set the output font's design size to +.IR size , +a value in TeX points. This value is mostly just documentation, since LaTeX +essentially ignores fonts' design sizes, but plain TeX may occasionally use +the design size to decide how large a font should be. (Loading a font in +TeX "at" a particular size effectively ignores the design size; loading a +font plain or "scaled" by a given factor uses the design size.) The default +is taken from the input font's optical size feature, or 10pt if it has no +such feature. +' +.Sp +.TP 5 +.BI \-\-fixed\-width +Set the font to fixed-width (its space character will have no stretch or +shrink). Normally you won't need this option; the font will tell +.B otftotfm +whether it is fixed width. The opposite of +.B \-\-fixed\-width +is +.BR \-\-proportional\-width . +' +.Sp +.TP 5 +.BI \-\-italic\-angle= angle +Set the output font's default italic angle to +.IR angle , +a number of degrees. This value is used by TeX to position +accents. Normally you won't need this option; the font will tell +.B otftotfm +its italic angle. +.PD +' +' +.SS Encoding Options +' +.PD 0 +.TP 5 +.BI \-e " encoding\fR, " \-\-encoding= encoding +Select the output metrics's base +.M dvips 1 +encoding. +.B Otftotfm +will search for +.IR encoding [.enc] +the same way that +.B dvips +would, so you may not need to give a full pathname. Say +.B \-e \- +to start with the font's default encoding. +See ENCODINGS, below, +for more information. +' +.Sp +.TP 5 +.BI \-\-boundary\-char= char +Set the font's boundary character to +.IR char , +which should either be a single non-digit character, or a number between \-1 +and 255. The default is taken from the encoding. +' +.Sp +.TP 5 +.BI \-\-altselector\-char= char +Set the font's alternate selector character to +.IR char , +which should either be a single non-digit character, or a number between +\&\-1 and 255. Alternate selectors let TeX authors explicitly choose +between versions of a character. For instance, the +\&'\-\-altselector\-char="*"' option turns the "*" character into a special +switch that cycles between alternates. For instance, the TeX input "A" +would produce the normal version of the "A" Unicode character, "A*" would +produce the first alternate, "A**" would produce the second alternate, and +so forth. Furthermore, "s*t" will activate any discretionary "s_t" +ligature in the font. +.Sp +The +.B \-\-altselector\-char +mechanism uses the features specified by +.BR \-\-altselector\-feature +options. +.Sp +The alternate-selector character may also be specified in the encoding; see +ENCODINGS, below. See Sivan Toledo's article cited in the SEE ALSO section +for more information. +' +.Sp +.TP 5 +.BI \-\-altselector\-feature= feature +Activate the feature named +.I feature +for the +.B \-\-altselector\-char +mechanism. Give this option multiple times to activate multiple +features. This option activates features only for use with +.BR \-\-altselector\-char ; +use the +.B \-\-feature +option to activate features globally. Defaults to the +.I salt +and +.I dlig +features. +' +.Sp +.TP 5 +.BI \-\-alternates\-filter= pattern +.TP 5 +.BI \-\-include\-alternates= pattern +.TP 5 +.BI \-\-exclude\-alternates= pattern +.TP 5 +.BI \-\-clear\-alternates +Limit the alternate characters that +.B otftotfm +will select. An alternate is used if it matches at least one of the +.B \-\-include +patterns, and none of the +.B \-\-exclude +patterns. Each pattern applies to all following features, except that the +.B \-\-clear +option clears any accumulated patterns. The +.BI \-\-alternates\-filter " pattern" +option acts like +.B \-\-clear\-alternates +followed by +.BI \-\-include\-alternates " pattern\fR. " +For pattern syntax, see GLYPH PATTERNS, below. +.Sp +OpenType fonts can have many alternates per character, most of which aren't +interesting. For example, the character "a" in WarnockPro-Regular has five +alternates, "ordfeminine", "Asmall", "asuperior", "a.end", and +"orn.013". The +.B \-\-altselector\-char +option lets you cycle through these alternates, but it's better to leave +out the ones you don't want, to avoid overfull encodings. Thus, if you were +only interested in ".end" variants, you might supply an +\&'\-\-include\-alternates="*.end"' +option. +.Sp +In the command line below, the \&'*.end' pattern will apply to "aalt" +alternates, but not to "salt" alternates. +.nf + \fBotftotfm\fR \fB\-f\fRsalt \fB\-\-include\-alternates\fR="*.end" \fB\-f\fRaalt \.\.\. +.fi +' +.Sp +.TP 5 +.BI \-\-ligkern= command +Add a LIGKERN +.IR command +to the encoding. For example, \&'\fB\-\-ligkern\fR "T {L} h"' suppresses any +T_h ligature in the font. You can supply multiple +.B \-\-ligkern +options. See ENCODINGS, below. +' +.Sp +.TP 5 +.BI \-\-position= command +Add a POSITION +.IR command +to the encoding. For example, \&'\fB\-\-position\fR "T 10 0 20"' adds ten +units of space to either side of the "T" character. You can supply +multiple +.B \-\-position +options. See ENCODINGS, below. +' +.Sp +.TP 5 +.BI \-\-unicoding= command +Add a UNICODING +.IR command +to the encoding. For example, \&'\fB\-\-unicoding\fR "pi1 =: uni03D6"' tells +.B otftotfm +to encode "/pi1" as U+03D6 GREEK PI SYMBOL. You can supply multiple +.B \-\-unicoding +options. See ENCODINGS, below. +' +.Sp +.TP 5 +.BI \-\-no\-encoding\-commands +Ignore any LIGKERN and/or UNICODING commands in the encoding file. +' +.Sp +.TP 5 +.BI \-\-no\-default\-ligkern +Don't include +.BR otftotfm 's +default LIGKERN commands. +' +.Sp +.TP 5 +.BI \-\-coding\-scheme= scheme +Add a CODINGSCHEME to the encoding. See ENCODINGS, below. +' +.Sp +.TP 5 +.BI \-\-warn\-missing +Warn about encoded characters not supported by the font. See the +WARNMISSING command in ENCODINGS, below. +' +.Sp +.TP 5 +.BI \-\-literal\-encoding= encoding +Select the +.M dvips 1 +encoding used for the font. No glyph substitutions will be permitted, so +the output encoding will equal the input encoding (and +.B otftotfm +will not generate an output encoding). +' +.Sp +.TP 5 +.BI \-\-base\-encodings= file +.B Experts only. +Allow the output font to refer to existing "base" fonts. This can greatly +reduce the number of base fonts generated by +.BR otftotfm ". " +Each line in the +.I file +argument contains a TeX font name (as for +.BR \-\-name ) +and a corresponding literal encoding file (as for +.BR \-\-literal\-encoding ); +for example: +.nf + WarnoProReg\-\-eka eka + WarnoProReg\-\-exp1 exp1 +.fi +The named fonts must have been created by prior runs of +.B otftotfm +on the same input OpenType font, with the same +.BR \-\-extend +and +.BR \-\-slant +options as the current run. The current output font will refer to glyphs +from the named base fonts when possible. If the base fonts cover all +glyphs required by the output font, +.B otftotfm +won't generate any new base fonts at all. The +.I file +can also refer to dotless-J fonts using the following syntax: +.nf + WarnoProReg\-\-lcdfj \- dotlessj +.fi +' +.PD +' +' +.SS Automatic Mode Options +' +.PD 0 +.TP 5 +.BI \-a "\fR, " \-\-automatic +Select automatic mode. +' +.Sp +.TP 5 +.BI \-v " vendor\fR, " \-\-vendor= vendor +Set the font vendor name, which is used to locate files within the TDS. +Defaults to "lcdftools". +.Sp +In automatic mode, TeX and friends will generally find required font files +independently of the vendor you select. +' +.Sp +.TP 5 +.BI \-\-typeface= typeface +Set the font typeface name, which is used to locate files within the TDS. +Defaults to the current font's family name with unsuiable characters +removed. +' +.Sp +.TP 5 +.BI \-\-no\-type1 +Do not use +.M cfftot1 1 +to create Type 1 fonts corresponding to the OpenType input fonts. +' +.Sp +.TP 5 +.BI \-\-no\-dotlessj +Do not use +.M t1dotlessj 1 +to create a special dotless-j font when the input font doesn't have +dotless-j. +' +.Sp +.TP 5 +.BI \-\-no\-truetype +Do not install TrueType-flavored fonts. +' +.Sp +.TP 5 +.BI \-\-type42 +Install TrueType-flavored fonts in translated Type 42 format. +' +.Sp +.TP 5 +.BI \-\-no\-updmap +Do not run an +.M updmap 1 +program. This can be useful if you're installing a bunch of fonts; it is +much faster to run +.B updmap +once, at the end, than to run it once per font. +.PD +' +' +.SS Output Options +.PD 0 +.TP 5 +.BI \-n " texname\fR, " \-\-name= texname +Set the TeX name of the output font, which is used in font map files and, +in automatic mode, to generate the output filename. The default is derived +from the OpenType font's name and the features you selected. +' +.Sp +.TP 5 +.BI \-p "\fR, " \-\-pl +Output human-readable PL and VPL metrics, not binary TFM and VF metrics. +Note: +.BR Otftotfm 's +PL and VPL output files are legal, but the +.B fontinst +program may not accept them (it has a picky parser). Make sure to supply a +.BR \-\-coding\-scheme ; +if that doesn't help, run the TFM output through +.M tftopl 1 . +' +.Sp +.TP 5 +.BI \-\-no\-virtual +Do not generate virtual fonts (VFs and VPLs). +.B Otftotfm +will warn if the selected font features cannot be implemented without +virtual fonts. +' +.Sp +.TP 5 +.BI \-\-no\-encoding +Do not generate an encoding file. +' +.Sp +.TP 5 +.BR \-\-output\-encoding [=\fIfile\fR] +Only generate an encoding file; do not generate any other output. The +encoding file is written to +.IR file , +or to standard output if no +.I file +argument is supplied. +' +.Sp +.TP 5 +.BI \-\-no\-map +Do not generate a font map line for the font. +' +.\" .Sp +.\" .TP 5 +.\" .BI \-\-base\-name name +.\" Experts only: Set the TeX name of the "base" output font. When +.\" .B otftotfm +.\" needs to make a virtual font (because of font features and/or +.\" letterspacing), it must generate at least two TFM metrics files, one for +.\" the base font and one for the virtual font. In some cases, multiple +.\" virtual fonts can share the same base metrics, reducing the number of +.\" installed metrics files. This option lets you explicitly set the name of +.\" the base output font independently from the main output font, and thus +.\" force fonts to share base metrics. The default base name is derived from +.\" the TeX name, with "\f(CW\-\-base\fR" appended. +.PD +' +' +.SS File Location Options +.PD 0 +.TP 5 +.BI \-\-tfm\-directory= dir +.TP 5 +.BI \-\-pl\-directory= dir +.TP 5 +.BI \-\-vf\-directory= dir +.TP 5 +.BI \-\-vpl\-directory= dir +.TP 5 +.BI \-\-encoding\-directory= dir +.TP 5 +.BI \-\-type1\-directory= dir +.TP 5 +.BI \-\-truetype\-directory= dir +.TP 5 +.BI \-\-type42\-directory= dir +Set the directory used for various output types. Each directory may be set +by an environment variable, and defaults to a TDS directory in automatic +mode, or to "." otherwise. Environment variable names and default TDS +locations are described in the Automatic Mode section above. +' +.Sp +.TP 5 +.BI \-\-map\-file= filename +Set file in which +.B otftotfm +will write a font map +line for the font. The default is the standard output in manual mode, and +"TEXMF/fonts/map/dvips/\fIvendor\fR/\fIvendor\fR.map" (or +"TEXMF/dvips/\fIvendor\fR/\fIvendor\fR.map" on older installations) in +automatic mode. +.PD +' +' +.SS Miscellaneous Options +.PD 0 +.TP 5 +.BI \-\-glyphlist= file +Use +.I file +as a Adobe glyph list, which helps translate glyph names to Unicode code +points. Give multiple options to include multiple files. +See ENCODINGS, below, for more information. +' +.Sp +.TP 5 +.BR \-V ", " \-\-verbose +Write progress messages to standard error. +' +.Sp +.TP 5 +.BR \-\-no\-create +Do not create or modify any files. Instead, write messages about the +program's hypothetical progress to standard error. +' +.Sp +.TP 5 +.BR \-\-force +Generate all files, even if it looks like versions are already installed. +' +.Sp +.TP 5 +.BR \-q ", " \-\-quiet +Do not generate any error messages. +' +.Sp +.TP 5 +.BI \-\-kpathsea\-debug= flags +Set path searching debugging flags. See the +.I Kpathsea +manual for details. +' +.Sp +.TP 5 +.BR \-h ", " \-\-help +Print usage information and exit. +' +.Sp +.TP 5 +.BR \-\-version +Print the version number and some short non-warranty information and exit. +.PD +' +.SH ENCODINGS +.B Otftotfm +interprets encoding files as Unicode. For example, say an input encoding +has "/dotlessi" at position 10. +.B Otftotfm +detects that position 10 should contain Unicode character U+0131 LATIN +SMALL LETTER DOTLESS I, and uses the font's glyph for that character +(possibly modified by any active features). The selected glyph might not +be named "dotlessi"; only the Unicode value matters. +.PP +.B Otftotfm +assigns Unicode values to glyph names using a table published by Adobe (SEE +ALSO has a reference), with extensions for TeX. For more fine-grained +control, add UNICODING commands to the input encoding file. These commands +have the following format: +.nf + % UNICODING \fIglyph\fR =: \fIchoice1\fR [\fIchoice2\fR ...] ; +.fi +This tells +.B otftotfm +that the glyph named +.I glyph +translates into the first Unicode value in the +.I choice +list that has a character in the font. \fIGlyph\fR and the +.IR choice s +are PostScript glyph names; the initial "%" sign is required; and each +UNICODING line can contain multiple commands, separated by spaced +semicolons. For example, +.nf + % UNICODING pi1 =: uni03D6 ; +.fi +encodes the character "/pi1" as U+03D6 GREEK PI SYMBOL, +and +.nf + % UNICODING Delta =: uni0394 uni2206 ; +.fi +makes U+0394 GREEK CAPITAL LETTER DELTA preferred to +U+2206 INCREMENT as an encoding for "/Delta". You can also supply +glyph names: +.nf + % UNICODING Delta =: Deltagreek Delta ; +.fi +A mapping with no Unicode values removes that glyph from the input +encoding. For instance, this erases any f-ligature characters from the +encoding: +.nf + % UNICODING ff =: ; fi =: ; fl =: ; ffi =: ; ffl =: ; +.fi +The slots are available for +.BR otftfm 's +own use, for example for other characters required by the font. (If the +f-ligatures themselves are required by the font, for instance by a \&'liga' +feature, then they will be stored into their old slots when possible.) Map +a glyph to \&'emptyslot' if you don't want +.B otftotfm +to use the slot. For example, this will leave the \&'ff' slot unused if +the font has no \&'ff' glyph: +.nf + % UNICODING ff =: ff emptyslot ; +.fi +(Note that most OpenType fonts provide a visible representation for unused +encoding slots, namely a box with an X inside.) +.PP +LIGKERN comments in the encoding can add ligatures and inhibit kerns, as in +.M afm2tfm 1 . +To add a ligature, say: +.nf + % LIGKERN \fIglyph1\fR \fIglyph2\fR =: \fIresult\fR ; +.fi +The "=:" operator indicates a normal ligature, where both the input glyphs +are removed and replaced by +.IR result . +To preserve the left-hand glyph, for an effect like "\fIglyph1\fR +\fIglyph2\fR =: \fIglyph1\fR \fIresult\fR", use "|=:" instead; to preserve +the right-hand glyph, use "=:|". +.\" The other five ligature operators are not yet supported. +To remove all kerns between two characters, say: +.nf + % LIGKERN \fIglyph1\fR {} \fIglyph2\fR ; +.fi +A "*" matches any character, so +.nf + % LIGKERN a {} * ; +.fi +removes all kerns with "a" as the left-hand character, and +.nf + % LIGKERN * {} * ; +.fi +removes all kerns. +.PP +.B Otftotfm +also supports extended syntax for setting kern values and inhibiting +ligatures. To add an \fIn\fR-unit kern between two glyphs, say: +.nf + % LIGKERNX \fIglyph1\fR {\fIn\fR} \fIglyph2\fR ; +.fi +where \fIn\fR is an integer. This: +.nf + % LIGKERNX \fIglyph1\fR {L} \fIglyph2\fR ; +.fi +inhibits any ligature between +.I glyph1 +and +.IR glyph2 . +"{LK}" and "{KL}" inhibit both ligatures and kerns. +.PP +You can set the +.B \-\-boundary\-char +and +.B \-\-altselector\-char +from an encoding file with commands like this: +.nf + % LIGKERN || = \fIboundarychar\fR ; + % LIGKERNX ^^ = \fIaltselectorchar\fR ; +.fi +As with UNICODING, each LIGKERN or LIGKERNX line can contain multiple +commands, separated by spaced semicolons. +.PP +.B Otftotfm +has a default set of eight ligatures, namely: +.nf + space l =: lslash ; space L =: Lslash ; + question quoteleft =: questiondown ; exclam quoteleft =: exclamdown ; + hyphen hyphen =: endash ; endash hyphen =: emdash ; + quoteleft quoteleft =: quotedblleft ; + quoteright quoteright =: quotedblright +.fi +LIGKERN commands in the encoding file and +.B \-\-ligkern +options can override these defaults, or supply the +.B \-\-no\-default\-ligkern +option to turn them off. +.PP +The POSITION command shifts a glyph within its bounding box. The syntax is +.nf + % POSITION \fIglyph\fR \fIpdx\fR \fIpdy\fR \fIadx\fR ; +.fi +This will add +.I pdx +units of space to +.IR glyph 's +left edge; raise it up by +.I pdy +units; and add +.I adx +units to its width. For example, to add 10 units of space to either side +of the "T" glyph, supply +.nf + % POSITION T 10 0 20 +.fi +To move the "degree" symbol up by 20 units, supply +.nf + % POSITION degree 0 20 0 +.fi +.PP +The CODINGSCHEME command specifies the coding scheme for fonts using this +encoding. This is a string, less than 40 characters long and containing no +parentheses, that classifies the encoding for TeX's purposes. Sample +coding schemes include "TEX TEXT", "TEX MATH ITALIC", and "EXTENDED TEX +FONT ENCODING - LATIN". For example: +.nf + % CODINGSCHEME EXTENDED TEX FONT ENCODING - LATIN +.fi +Most tools ignore the coding scheme; fontinst is an exception. +.B Otftotfm +uses the encoding's PostScript name for the default coding scheme. +.PP +Finally, the WARNMISSING command makes any glyphs not supported by the +input font appear as black boxes. The +.M dvips 1 +processor will also print a warning when encountering these glyphs. For +example: +.nf + % WARNMISSING yes +.fi +.PP +The +.BR \-\-unicoding , +.BR \-\-ligkern , +.BR \-\-position , +.BR \-\-coding\-scheme , +and +.B \-\-warn\-missing +options add UNICODING, LIGKERN/LIGKERNX, POSITION, CODINGSCHEME, and +WARNMISSING commands to an encoding, and can override commands in the +encoding itself. Some common encoding files have commands that are +inappropriate for OpenType fonts; for example, "t1.enc" hard-codes +f-ligatures, which can cause problems with small-cap fonts. Supply the +.B \-\-no\-encoding\-commands +option to ignore all commands from the encoding file. Commands from +options like +.B \-\-ligkern +are processed in any case. +' +.SS New Glyphs +.PP +New glyphs, such as ligatures and contextual substitutions, are added to +the encoding in any empty spaces, using their original locations when +possible. If the encoding doesn't have enough space for all new glyphs, +shorter ligatures composed of unaccented letters get precedence. +' +.SS Synthetic Glyphs +.PP +.B Otftotfm +can synthesize some glyphs using virtual font manipulations, if a required +glyph is not available in the input font. Specifically, it will synthesize: +.Sp +.PD 0 +.TP 22 +cwm +TeX's compound word mark (a zero-width "strut" rule with height equal to the font's x-height) +.TP +ascendercompwordmark +"cwm" with height equal to the font's ascenders +.TP +capitalcompwordmark +"cwm" with height equal to the font's capitals +.TP +visualspace +A square cup used to represent spaces +.TP +dotlessj +A dotless "j", synthesized with +.M t1dotlessj 1 +.TP +dblbracketleft +Kerned version of "[[" +.TP +dblbracketright +Kerned version of "]]" +.TP +bardbl +The parallel symbol "||" +.TP +asteriskmath +Vertically-centered "*" +.TP +ringfitted +Ring accent centered on the width of "A" +.TP +twelveudash +2/3-em-wide dash +.TP +threequartersemdash +3/4-em-wide dash +.TP +centigrade +"(degrees)C" +.TP +interrobang +Combined "?!" symbol +.TP +interrobangdown +Inverted interrobang +.TP +pertenthousand +Per-ten-thousand sign (% with two extra 0s) +.TP +IJ +"IJ" ligature +.TP +ij +"ij" ligature +.TP +Germandbls +"SS" (a capital sharp-s) +.TP +SSsmall +Small-capital version of "SS" +.TP +FFsmall +Small-capital version of "FF" +.TP +FIsmall +Small-capital version of "FI" +.TP +FLsmall +Small-capital version of "FL" +.TP +FFIsmall +Small-capital version of "FFI" +.TP +FFLsmall +Small-capital version of "FFL" +.PD +' +' +.SH "GLYPH PATTERNS" +.LP +The +.BR \-\-include\-subs +and +.BR \-\-include\-alternates +options, and their +.B \-\-exclude +and +.B \-\-*\-filter +variants, accept the following types of pattern. +.Bp +Glyph names. Example: "Aacute". For PostScript-flavored fonts, use +.M otfinfo 1 's +.B \-g +option to see a font's glyph names, and "\fBcfftot1\fR \fIfont\fR.otf | +\fBt1testpage\fR" to generate a PostScript file showing each glyph. +.Bp +Glyph name patterns using the shell-style glob-matching rules: "*" matches +any number of characters, "?" matches any single character, and "[...]" +matches any character in a set. Example: "*.end". +.Bp +Unicode category properties in angle brackets. Examples: "<Letter>", +"<UppercaseLetter>", "<Lu>". The complete list of both short and long +names: Letter/L, UppercaseLetter/Lu, LowercaseLetter/Ll, +TitlecaseLetter/Lt, ModifierLetter/Lm, OtherLetter/Lo; Number/N, +DecimalNumber/Nd, LetterNumber/Nl, OtherNumber/No; Punctuation/P, +ConnectorPunctuation/Pc, DashPunctuation/Pd, OpenPunctuation/Ps, +ClosePunctuation/Pe, InitialPunctuation/Pi, FinalPunctuation/Pf, +OtherPunctuation/Po; Symbol/S, MathSymbol/Sm, CurrencySymbol/Sc, +ModifierSymbol/Sk, OtherSymbol/So; Mark/M, SpacingMark/Mc, +EnclosingMark/Me, NonspacingMark/Mn; Separator/Z, SpaceSeparator/Zs, +LineSeparator/Zl, ParagraphSeparator/Zp; Other/C, Surrogate/Cs, Format/Cf, +Control/Cc, PrivateUse/Co, Unassigned/Cn. Category values current as of +Unicode 4.0. +.Bp +Unicode ranges. Example: "U+007f-U+008C". +.PP +The "!" prefix negates a pattern, and you can separate multiple patterns by +spaces. +' +.SH "FEATURE DIRECTORY" +.LP +This section lists features common to Western OpenType fonts and describes +how +.B otftotfm +handles them for common fonts. Please send the author mail if +.B otftotfm +does not handle a feature you need, or you believe it handles some feature +incorrectly. +.Sp +.PD 0 +.TP 5 +.IR aalt ", Access All Alternates" +Lets the user choose between all available alternate forms for a character. +This includes things like superscript and subscript variants, different +styles (swash, for example), and even ornaments. The +.BR \-\-altselector\-feature= aalt +option can help an +.BR \-\-altselector\-char +provide useful access to alternates, but the +.I aalt +feature isn't usually useful on its own. Try the +.IR salt " and " calt +features instead. +.TP 5 +.IR c2sc ", Small Capitals From Capitals" +Replaces capital letters with small capitals: a sort of converse of the +more conventional +.I smcp +feature, which replaces lower-case letters with small capitals. Supported. +.TP 5 +.IR calt ", Contextual Alternates" +Lets the user choose between context-appropriate swash forms for each +character. For example, given the word "DREW" in a cursive typeface, the "R +E W" might be translated to calmer forms than the initial "D". There may be +more than one choice for a given letter, in which case the user should be +able to select among them. TeX can't support complex contextual alternates, +or alternate selection, but +.B otftotfm +supports some fonts quite well. The input encoding should have lots of +empty space for variants, and it should specify a boundary character. See +also +.IR cswh . +.TP 5 +.IR case ", Case-Sensitive Forms" +Shifts punctuation marks up to a position that works well with +all-capital-letter sequences. For example, the hyphen character, which +generally centers vertically on the x-height, is raised up to center +vertically on a capital letter. Also replaces text figures with lining +figures, and accent marks with forms more appropriate for capitals. +Supported. +.TP 5 +.IR cpsp ", Capital Spacing" +Adds a bit of space on either side of each capital letter. Supported. +(However, the OpenType tag registry suggests that +.I cpsp +be on by default, but applying to all-caps text only; TeX cannot easily +implement that contextual intelligence.) +.TP 5 +.IR cswh ", Contextual Swash" +Lets the user choose between context-appropriate swash forms for each +character. For example, in the words "Ab AC", the first "A" might be +translated to a swash form, while the second might not. There may be more +than one choice for a given letter, in which case the user should be able +to select among them. +.B Otftotfm +supports some fonts quite well. The input encoding should have lots of +empty space for swash variants, and it should specify a boundary +character. See also +.IR calt " and " swsh . +.TP 5 +.IR dlig ", Discretionary Ligatures" +Activates uncommon ligatures, such as "c_t", "s_p", and "s_t". Supported. +.TP 5 +.IR dnom ", Denominators" +Replaces digits and some punctuation marks with smaller forms sitting on +the baseline, intended for fraction denominators. Supported. +.TP 5 +.IR fina ", Terminal Forms" +Substitutes appropriate forms for letters occurring at the ends of words. +This feature doesn't select swash variants; it's intended for normal use, +and the specification recommends that it be on by default. Partially +supported: TeX will only treat spaces as the ends of words, where a correct +implementation would probably include punctuation too. See +.IR cswh +for selecting swash variants active at the ends of words. +.TP 5 +.IR frac ", Fractions" +Replaces simple sequences like "1/2" with nice-looking fractions. +Supported, but beware: many fonts will translate "11/32" into "1" + "1/3" + +"2". +.TP 5 +.IR hist ", Historical Forms" +Replaces characters with historical variants. Usually, this means at least +translating regular "s" to long "s". Supported. +.TP 5 +.IR kern ", Kerning" +Adjusts the space between characters (pair kerning). Generally supported, +and you should probably turn it on. As a special case, "\fB\-f\fRkern" can +also read kerning information from the "kern" table in conventional +TrueType fonts. +.TP 5 +.IR liga ", Standard Ligatures" +Activates common ligatures, such as "f_f", "f_i", "f_f_j", and (in some +Adobe fonts) "T_h". Generally supported, and you should probably turn it +on. +.TP 5 +.IR lnum ", Lining Figures" +Uses lining figures, the set of digits that are all about as high as +capital letters. +Supported. Compare +.IR onum ; +see also +.IR pnum +and +.IR tnum. +.TP 5 +.IR numr ", Numerators" +Replaces digits and some punctuation marks with smaller, raised forms +intended for fraction numerators. Supported, but not usually useful. +.TP 5 +.IR onum ", Oldstyle Figures" +Uses old-style figures, also known as text figures. This is the set of +digits that have ascenders and descenders like lower-case letters. +Supported. Compare +.IR lnum ; +see also +.IR pnum +and +.IR tnum . +.TP 5 +.IR ordn ", Ordinals" +Designed for Spanish and French. Replaces ordinal numbers, such as "2.o", +with forms where the "o" is raised, and replaces the sequence "No" with an +integrated glyph. Supported. +.TP 5 +.IR ornm ", Ornaments" +Replaces some alphabetic characters in the font with ornaments, and links +the bullet character to a set of all bullet-like ornaments, from which the +user can choose. Partially supported: TeX can handle alphabetic +substitutions, but not bullet choice. +.TP 5 +.IR pnum ", Proportional Figures" +Digits will have different widths. Supported. Compare +.IR tnum ; +see also +.IR lnum +and +.IR onum. +.TP 5 +.IR salt ", Stylistic Alternates" +Lets the user choose between stylistic alternate forms for a character. +The +.BR \-\-altselector\-char +mechanism provides useful access to this feature. If you turn on +.IR salt +globally, +.B otftotfm +takes the first alternate form whenever there's more than one choice. See +also +.IR aalt +and +.IR ss01 ; +.IR salt +is generally more useful than +.IR aalt +for TeX, since it refers exclusively to stylistic alternates. +.TP 5 +.IR sinf ", Scientific Inferiors" +Replaces digits and some punctuation marks with smaller, lowered forms +intended for subscripts. Supported. Compare +.IR subs . +.TP 5 +.IR size ", Optical Size" +This feature stores information about the range of optical sizes for which +the font was intended. There is no point in selecting it with +.BR otftotfm , +since it should not change the font's appearance in any way. +.TP 5 +.IR smcp ", Small Capitals" +Replaces lower-case letters with small capitals. Supported. Compare +.IR c2sc . +.TP 5 +.IR ss01 - ss20 ", Stylistic Sets 1-20" +Replaces characters with a uniform set of stylistic alternates. Differs +from features like +.I salt +in that a Stylistic Set is uniform: an +.I ssXX +feature should never involve selection from a set of possible alternate +characters. Supported. +.TP 5 +.IR subs ", Subscript" +Replaces characters with smaller, lowered forms intended for subscripts. +Supported. Compare +.IR sinf ; +some fonts support +.I sinf +but not +.IR subs . +.TP 5 +.IR sups ", Superscript" +Replaces digits, some punctuation marks, and some lower-case letters with +smaller, raised forms intended for superscripts. Supported. +.TP 5 +.IR swsh ", Swash" +Activates all swash forms for each character. There may be more than one +swash form, in which case +.B otftotfm +will pick the first one listed. Supported, except that swash variants +other than the first are inaccessible. Note that some fonts with swash +variants support the +.I cswh +feature exclusively. +.TP 5 +.IR tnum ", Tabular Figures" +All digits will have the same width, so that tables and the like will align +visually. Supported. Compare +.IR pnum ; +see also +.IR lnum +and +.IR onum. +.TP 5 +.IR zero ", Slashed Zero" +Replaces the zero character with a slashed zero. Supported. +.PD +' +.SH "DIAGNOSTICS AND TROUBLESHOOTING" +' +.TP 5 +no writable directory found in $TEXMF +' +.B Otftotfm +could not find a writable directory in your $TEXMFVAR or $TEXMF path. Did +you create a +.I $HOME/.texmf-var +or +.I $HOME/texmf +directory? If so, run the command "kpsewhich \-\-expand\-path='$TEXMF'" to +verify that directory is not being found. You may need to set your TEXMF +environment variable, to \&'{!!'"$HOME"'/texmf,!!$TEXMFMAIN}', for instance +(note the different kinds of quotes; on my machine, this expands to +\&'{!!/home/kohler/texmf,!!$TEXMFMAIN}'). +' +.TP 5 +\&'\fIchar\fR' has no encoding, ignoring kern removal +.PD 0 +.TP 5 +(or ligature removal, lig/kern removal, or ligature) +.PD +' +These messages indicate a slight problem with your encoding file: one of +the LIGKERN commands referred to a character not present in the encoding. +This might be due to a misspelling in the LIGKERN command or the encoding +file, or it might be an oversight. Either fix the encoding file or ignore +the warning. +' +.TP 5 +can't map \&'\fIchar\fR' to Unicode +' +Another encoding file problem: One of the glyph names in an UNICODING block +could not be converted to Unicode. This is problematic since UNICODING +exists wholly to translate glyph names into Unicode. Fix the encoding file +or ignore the warning. +' +.TP 5 +not enough room in encoding, ignoring \fIN\fR glyph(s) ... +' +There wasn't space in the encoding for all the glyphs referred to by the +features you selected. For example, maybe the font had more ligatures than +there were empty slots in the encoding. Fix this warning by selecting fewer +features, or by using an encoding with more empty slots, such as the 7t.enc +encoding distributed with +.BR otftotfm . +' +.TP 5 +The \&'\fB\-a\fR' option did not install my font correctly. +' +Try again with the \&'\fB\-\-verbose\fR' option, which causes +.BR otftotfm +to explain its behavior. Note that by default, +.BR otftotfm +will not re-install files already present in your system's TeX search paths +(in the current directory, for instance). Use \&'\fB\-\-force\fR' to +override this behavior. +' +.SH "FREQUENTLY ASKED QUESTIONS" +.TP 5 +How can I get a small-caps "SS" in place of the German sharp-S? +' +Supply the option \&'\fB\-\-unicoding\fR "germandbls =: SSsmall"'. +' +.TP 5 +How can I prevent f-ligatures from forming in a small-caps font? +' +This should happen automatically, but some overzealous encoding files add +f-ligatures even when the font doesn't request them. Try the +"\fB\-\-no\-encoding\-commands\fR" option if this is a problem for you. +' +.TP 5 +\fBOtftotfm\fR seems to take a long time. +' +Use the +.B \-V +option to see what it's doing. Often the culprit is the +.M updmap 1 +program; if you're planning to run +.B otftotfm +multiple times, give it the +.B \-\-no\-updmap +option and run +.B updmap +manually when you're done. +' +.TP 5 +How can I refer to the different forms of phi? +' +\fBOtftotfm\fR follows TeX practice and widely-distributed TeX encoding +vectors, so "/phi" in an input encoding vector should map to a "straight" +phi and "/phi1" should map to a "loopy" phi. Note that TeX practice +differs from the PostScript standard naming conventions, in which "/phi" is +"loopy" and "/phi1" is "straight"; this means that \fBotftotfm\fR may map +"/phi" in an input encoding vector to a font's "/phi1" glyph, and vice +versa. Perhaps most unambiguously, you can use "/uni03D5" for the +"straight" form and "/uni03C6" for the "loopy" form. +' +.TP 5 +How can I get lining figures (that is, normal line-height digits) with small caps ('\fB\-f\fRsmcp')? +' +Many fonts use old-style figures by default with small caps. Since the +default is not specified, it's wise to explicitly supply \&'\fB\-f\fRlnum' or +\&'\fB-f\fRonum'. +' +.SH "BUGS" +.\" .LP +.\" Presumably some context-sensitive positionings and ligatures could be +.\" implemented with TeX's boundary character, but +.\" .B otftotfm +.\" doesn't do that yet. +.LP +See the documentation for +.B \-\-pl +above if you have problems running +.BR otftotfm 's +output through +.BR fontinst . +' +.SH "SEE ALSO" +.LP +.M pltotf 1 , +.M tftopl 1 , +.M vptovf 1 , +.M afm2tfm 1 , +.M dvips 1 , +.M cfftot1 1 , +.M otfinfo 1 , +.M t1dotlessj 1 , +.M t1testpage 1 , +.M ttftotype42 1 , +.M kpsewhich 1 , +.M updmap 1 +.LP +.I "Adobe Type 1 Font Format" +.LP +Adobe Technical Notes #5176, +.IR "The Compact Font Format Specification" , +and #5177, +.I "The Type 2 Charstring Format" +.LP +.IR "OpenType Specification" , +Version 1.4 +.LP +.IR "A Directory Structure for TeX Files" , +http://www.tug.org/tds/ +.LP +.IR "Kpathsea: A library for path searching" , +http://www.tug.org/kpathsea/ +.LP +Sivan Toledo, +.IR "Exploiting Rich Fonts" , +TUGboat 21(2), 2000, +http://www.tug.org/TUGboat/Articles/tb21-2/tb67tole.pdf +.LP +Michel Goossens, Frank Mittelbach, and Alexander Samarin, +.IR "The LaTeX Companion" +(for information on the .fd file format) +.LP +Adobe Systems, "Unicode and Glyph Names". Refers to the glyphlist.txt file +used to translate glyph names to Unicode code points. +http://partners.adobe.com/public/developer/opentype/index_glyph.html +' +.SH AUTHOR +Eddie Kohler (ekohler@gmail.com) +.PP +Thanks to Karl Berry, Marco Kuhlmann, Adam Lindsay, Bruce D'Arcus, Thomas +Esser, Claire Connelly, Nelson H.F. Beebe, and Ryuji Suzuki for +suggestions, bug reports, and help. Particular thanks to Achim Blumensath +and Michael Zedler for suggestions and patches, some of them extensive. diff --git a/Master/texmf-dist/doc/man/man1/otftotfm.man1.pdf b/Master/texmf-dist/doc/man/man1/otftotfm.man1.pdf Binary files differnew file mode 100644 index 00000000000..7296bef28f9 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/otftotfm.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/otp2ocp.1 b/Master/texmf-dist/doc/man/man1/otp2ocp.1 new file mode 100644 index 00000000000..fcb4d0ad117 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/otp2ocp.1 @@ -0,0 +1,40 @@ +.TH "otp2ocp" "1" "September 2000" "Omega" "Omega" +.PP +.SH "NAME" +otp2ocp \- convert Omega Translation Process files to Omega +Compiled Process files +.SH "SYNOPSIS" +.B otp2ocp +.IR OTPFILE [ \fB.otp\fP ] +.RI [ OCPFILE [ \fB.ocp\fP ]] +.SH "DESCRIPTION" +.PP +\fBotp2ocp\fP is used to create or recreate Omega Compiled Process +files (binary) from Omega Translation Process (text) files\&. +.PP +Omega Translation Processes are rules used to translate one character +set to another and to choose between characters with one or more +context-sensitive variants\&. OTPs could also be used to change the +case or hyphenation of text\&. +.PP +.SH "SEE ALSO" +.PP +\fBmkocp\fP(1), \fBomega\fP(1)\&. +.PP +\fIDraft Manual for the Omega System\fP (\fIomega-manual\&.dvi\fP)\&. +.PP +Web page: <http://www\&.gutenberg\&.eu\&.org/omega/> +.PP +.SH "AUTHOR" +.PP +The primary authors of Omega are John Plaice +<plaice@cse\&.unsw\&.edu\&.au> and Yannis Haralambous +<yannis@fluxus-virus\&.com>\&. +.PP +This manual page was written by C\&.M\&. Connelly +<cmc@debian\&.org>, for +the Debian GNU/Linux system\&. It may be used by other distributions +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)\&. +.PP diff --git a/Master/texmf-dist/doc/man/man1/otp2ocp.man1.pdf b/Master/texmf-dist/doc/man/man1/otp2ocp.man1.pdf Binary files differnew file mode 100644 index 00000000000..21af14f2653 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/otp2ocp.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/outocp.1 b/Master/texmf-dist/doc/man/man1/outocp.1 new file mode 100644 index 00000000000..9f41f3ba967 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/outocp.1 @@ -0,0 +1,42 @@ +.TH "outocp" "1" "September 2000" "Omega" "Omega" +.PP +.SH "NAME" +outocp \- debug an OCP file +.SH "SYNOPSIS" +.B outocp +.IR OCPFILE [ \fB.ocp\fP ] +.SH "DESCRIPTION" +.PP +\fBoutocp\fP is used for debugging Omega Compiled Translation Process +(OCP) files\&. It generates some statistics about the OCP file, and +then runs through the states that the file defines\&. +.PP +Omega Translation Processes are rules used to translate one character +set to another and to choose between characters with one or more +context-sensitive variants\&. OTPs could also be used to change the +case or hyphenation of text\&. +.PP +.SH "BUGS" +.PP +None known, but report any found to <omega@ens\&.fr> (mailing list)\&. +.PP +.SH "SEE ALSO" +.PP +\fBocp2otp\fP(1), \fBotp2ocp\fP(1), \fBomega\fP(1)\&. +.PP +\fIDraft Manual for the Omega System\fP (\fIomega-manual\&.dvi\fP)\&. +.PP +Web page: <http://www\&.gutenberg\&.eu\&.org/omega/> +.PP +.SH "AUTHOR" +.PP +The primary authors of Omega are John Plaice +<plaice@cse\&.unsw\&.edu\&.au> and Yannis Haralambous +<yannis@fluxus-virus\&.com>\&. +.PP +This manual page was written by C\&.M\&. Connelly +<cmc@debian\&.org>, for +the Debian GNU/Linux system\&. It may be used by other distributions +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/Master/texmf-dist/doc/man/man1/outocp.man1.pdf b/Master/texmf-dist/doc/man/man1/outocp.man1.pdf Binary files differnew file mode 100644 index 00000000000..f4252c66195 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/outocp.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/ovf2ovp.1 b/Master/texmf-dist/doc/man/man1/ovf2ovp.1 new file mode 100644 index 00000000000..ae60d5588e0 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ovf2ovp.1 @@ -0,0 +1,89 @@ +.TH "ovf2ovp" "1" "September 2000" "Omega" "Omega" +.PP +.SH "NAME" +ovf2ovp \- convert a virtual font file and its associated font metric file into property-list format +.PP +.SH "SYNOPSIS" +.PP +.B ovf2ovp +.RI [ OPTIONS ] +.IR OVFNAME [ \fB.ovf\fP ] +.RI [ OFMNAME [ \fB.ofm\fP ] +.RI [ OVPFILE [ \fB.ovp\fP ]]] +.PP +.SH "DESCRIPTION" +.PP +\fBovf2ovp\fP translates a virtual font (OVF) file, \fIOVFNAME\fP, +and its companion font metric (OFM) file, \fIOFMNAME\fP, into a +human-readable property-list format\&. The program writes to standard +output (by default) or to a file specified as \fIOVPNAME\fP\&. +.PP +The program also works with TeX VF and TFM files, producing TeX VP +files\&. (\fBovf2ovp\fP is based on the WEB source code for +\fBvftovp\fP(1)\&.) +.PP +.SH "OPTIONS" +.PP +.IP +.IP "\fB-charcode-format=\fP\fITYPE\fP" +output character codes +according to \fITYPE\fP, which can be either `hex\&' or `ascii\&'\&. +Default is `hex\&'\&. ascii specifes all ASCII letters and digits; hex +gets you everything else\&. +.IP +.IP "\fB-help\fP" +display a brief summary of syntax and options +.IP "\fB-verbose\fP" +display progress reports +.IP "\fB-version\fP" +output version information and exit +.IP +.PP +.SH "FILES" +.PP +.IP "\fIOVPFILE\fP" +Omega Virtual Property List file +.IP "\fIOFMNAME\fP" +Omega Font Metric file +.IP "\fIOVFNAME\fP" +Omega Virtual Font file +.PP +.SH "BUGS" +.PP +None known, but report any found to <omega@ens\&.fr> (mailing list)\&. You should also +check to see if the bug is also in \fBvftovp\fP(1)\&. +.PP +.SH "SEE ALSO" +.PP +\fBomega\fP(1), \fBofm2opl\fP(1), \fBovp2ovf\fP(1), +\fBpltotf\fP(1), \fBtftopl\fP(1), \fBvftovp\fP(1), +\fBvptovf\fP(1) +.PP +\fIDraft Manual for the Omega System\fP (\fIomega-manual\&.dvi\fP)\&. +.PP +Web page: <http://www\&.gutenberg\&.eu\&.org/omega/> +.PP +.SH "AUTHOR" +.PP +According to the WEB documentation: +.PP +.RS +\fBVFtoVP\fP is an extended version of the program \fBTFtoPL\fP, +which is part of the standard tex()ware library\&. The idea of a +virtual font was inspired by the work of David R\&. Fuchs who designed a +similar set of conventions in 1984 while developing a device driver +for ArborText, Inc\&. He wrote a somewhat similar program called +\fBAMFtoXPL\fP\&. +.RE +.PP +The primary authors of Omega are John Plaice +<plaice@cse\&.unsw\&.edu\&.au> and Yannis Haralambous +<yannis@fluxus-virus\&.com>\&. +.PP +This manual page was written by C\&.M\&. Connelly +<cmc@debian\&.org>, for +the Debian GNU/Linux system\&. It may be used by other distributions +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)\&. +.PP diff --git a/Master/texmf-dist/doc/man/man1/ovf2ovp.man1.pdf b/Master/texmf-dist/doc/man/man1/ovf2ovp.man1.pdf Binary files differnew file mode 100644 index 00000000000..f1c030cc8a9 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ovf2ovp.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/ovp2ovf.1 b/Master/texmf-dist/doc/man/man1/ovp2ovf.1 new file mode 100644 index 00000000000..558837e40f9 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ovp2ovf.1 @@ -0,0 +1,79 @@ +.TH "ovp2ovf" "1" "September 2000" "Omega" "Omega" +.PP +.SH "NAME" +ovp2ovf \- convert a virtual property-list file into a virtual font file and its associated font metric file +.PP +.SH "SYNOPSIS" +.B ovp2ovf +.RI [ OPTIONS ] +.IR OVPFILE [ \fB.ovp\fP ] +.RI [ OVFFILE [ \fB.ovf\fP ] +.RI [ OFMFILE [ \fB.ofm\fP ]]] +.PP +.SH "DESCRIPTION" +.PP +\fBovp2ovf\fP translates a human-readable virtual property list (OVP) +file, \fIOVPFILE\fP, into a virtual font (OVF) file, \fIOVFFILE\fP +and its companion font metric (OFM) file, \fIOFMFILE\fP\&. +.PP +The program also works with TeX VP files, producing VF and TFM files\&. +(\fBovp2ovf\fP is based on the WEB source code for \fBvptovf\fP(1)\&.) +.PP +.SH "OPTIONS" +.PP +.IP "\fB-help\fP" +display a brief summary of syntax and options +.IP "\fB-verbose\fP" +display progress reports +.IP "\fB-version\fP" +output version information and exit +.IP +.PP +.SH "FILES" +.IP "\fIOFMFILE\fP" +Omega Font Metric file +.IP "\fIOVFFILE\fP" +Omega Virtual Font file +.IP "\fIOVPFILE\fP" +Omega Virtual Property List file +.PP +.SH "BUGS" +.PP +None known, but report any found to <omega@ens\&.fr> (mailing list)\&. You should also +check to see if the bug is in \fBvptovf\fP(1)\&. +.PP +.SH "SEE ALSO" +.PP +\fBomega\fP(1), \fBofm2opl\fP(1), \fBovf2ovp\fP(1), +\fBpltotf\fP(1), \fBtftopl\fP(1), \fBvftovp\fP(1), +\fBvptovf\fP(1) +.PP +\fIDraft Manual for the Omega System\fP (\fIomega-manual\&.dvi\fP)\&. +.PP +Web page: <http://www\&.gutenberg\&.eu\&.org/omega/> +.PP +.SH "AUTHOR" +.PP +According to the WEB documentation: +.PP +.RS +\fBVPtoVF\fP is an extended version of the program \fBPLtoTF\fP, +which is part of the standard TeXware library\&. \fBOVP2OVF\fP is an +extended version of \fBVPtoVF\fP that allows much larger fonts\&. The +idea of a virtual font was inspired by the work of David R\&. Fuchs who +designed a similar set of conventions in 1984 while developing a +device driver for ArborText, Inc\&. He wrote a somewhat similar program +called \fBPLFONT\fP\&. +.RE +.PP +The primary authors of Omega are John Plaice +<plaice@cse\&.unsw\&.edu\&.au> and Yannis Haralambous +<yannis@fluxus-virus\&.com>\&. +.PP +This manual page was written by C\&.M\&. Connelly +<cmc@debian\&.org>, for +the Debian GNU/Linux system\&. It may be used by other distributions +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)\&. +.PP diff --git a/Master/texmf-dist/doc/man/man1/ovp2ovf.man1.pdf b/Master/texmf-dist/doc/man/man1/ovp2ovf.man1.pdf Binary files differnew file mode 100644 index 00000000000..54705cf0c2e --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ovp2ovf.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/patgen.1 b/Master/texmf-dist/doc/man/man1/patgen.1 new file mode 100644 index 00000000000..afc3a54c863 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/patgen.1 @@ -0,0 +1,191 @@ +.TH PATGEN 1 "7 April 2010" "Web2C 2012" +.\"===================================================================== +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff +.el .ds OX TeX +.\" that's for nroff. +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.\"===================================================================== +.SH NAME +patgen \- generate patterns for TeX hyphenation +.SH SYNOPSIS +.B patgen +.I dictionary_file pattern_file patout_file translate_file +.\"===================================================================== +.SH DESCRIPTION +This manual page is not meant to be exhaustive. +See also the Info file or manual +.IR "Web2C: A TeX implementation" . +.PP +The +.I patgen +program reads the +.I dictionary_file +containing a list of hyphenated words and the +.I pattern_file +containing previously-generated patterns (if any) for a particular +language (not a complete TeX source file; see below), and produces the +.I patout_file +with (previously- plus newly-generated) hyphenation patterns for that +language. The +.I translate_file +defines language specific values for the parameters +.IR left_hyphen_min " and " right_hyphen_min +used by \*(TX's hyphenation algorithm and the external representation +of the lower and upper case version(s) of all \`letters' of that +language. Further details of the pattern generation process such as +hyphenation levels and pattern lengths are requested interactively from +the user's terminal. Optionally +.I patgen +creates a new dictionary file +.BI pattmp. n +showing the good and bad hyphens found by the generated patterns, where +.I n +is the highest hyphenation level. +.PP +The patterns generated by +.I patgen +can be read by +.B initex +for use in hyphenating words. For a real-life example of +.IR patgen 's +output, see +.IR $TEXMFMAIN/tex/generic/hyphen/hyphen.tex , +which contains the patterns \*(TX uses for English by default. +At some sites, patterns for (many) other languages may be available, +and the local +.B tex +programs may have them preloaded. +.PP +All filenames must be complete; no adding of default +extensions or path searching is done. +.\"===================================================================== +.SH FILE FORMATS +.TP \w'@@'u+2n +.B Letters +When +.B initex +digests hyphenation patterns, \*(TX first expands macros and the result +must entirely consist of digits (hyphenation levels), dots (\`.', edge +of a word), and letters. In pattern files for non-English languages +letters are often represented by macros or other expandable constructs. +For the purpose of +.I patgen +these are just character sequences, subject to the condition that no +such sequence is a prefix of another one. +.TP \w'@@'u+2n +.B Dictionary file +A dictionary file contains a weighted list of hyphenated words, one word +per line starting in column 1. A digit in column 1 indicates a global +word weight (initially =1) applicable to all following words up to the +next global word weight. A digit at some intercharacter position +indicates a weight for that position only. + +The hyphens in a word are indicated by \`-', \`*', or \`.' (or their +replacements as defined in the translate file) for hyphens yet to be +found, \`good' hyphens (correctly found by the patterns), and \`bad' +hyphens (erroneously found by the patterns) respectively; when reading a +dictionary file \`*' is treated like \`-' and \`.' is ignored. +.TP +.B Pattern file +A pattern file contains only patterns in the format above, e.g., from a +previous run of patgen. It may \fInot\fR contain any \*(TX comments or +control sequences. For instance, this is not a valid pattern file: +.nf + +% this is a pattern file read by TeX. +\\patterns{% + .\|.\|. +} +.fi +It can only contain the actual patterns, i.e., the `.\|.\|.'. +.TP +.B Translate file +A translate file starts with a line containing the values of +.I left_hyphen_min +in columns 1-2, +.I right_hyphen_min +in columns 3-4, and either a blank or the replacement for one of the +"hyphen" characters \`-', \`*', and \`.' in columns 5, 6, and 7. (Input +lines are padded with blanks as for many \*(TX related programs.) + +Each following line defines one \`letter': an arbitrary delimiter +character in column 1, followed by one or more external representations +of that character (first the \`lower' case one used for output), each +one terminated by the delimiter and the whole sequence terminated by +another delimiter. + +If the translate file is empty, the values +.IR left_hyphen_min "=2, " right_hyphen_min "=3," +and the 26 lower case letters +.BR a .\|.\|. z +with their upper case representations +.BR A .\|.\|. Z +are assumed. +.TP +.B Terminal input +After reading the +.I translate_file +and any previously-generated patterns from +.IR pattern_file , +.I patgen +requests input from the user's terminal. + +First the integer values of +.IR hyph_start " and " hyph_finish , +the lowest and highest hyphenation level for which patterns are to be +generated. The value of +.I hyph_start +should be larger than any hyphenation level already present in +.IR pattern_file . + +Then, for each hyphenation level, the integer values of +.IR pat_start " and " pat_finish , +the smallest and largest pattern length to be analyzed, as well as +.IR "good weight" ", " "bad weight" ", and " threshold , +the weights for good and bad hyphens and a weight threshold for useful +patterns. + +Finally the decision (\`y' or \`Y' vs. anything else) whether or not to +produce a hyphenated word list. +.\"===================================================================== +.SH FILES +.TP \w'@@'u+2n +.I $TEXMFMAIN/tex/generic/hyphen/hyphen.tex +The original hyphenation patterns for English, by Donald Knuth and Frank +Liang. +.TP +.I $TEXMFMAIN/tex/generic/hyphen/ushyphmax.tex +Maximal hyphenation patterns for English, extended by Gerard Kuiken. +.TP +.I http://www.ctan.org/tex-archive/language/ +Patterns and support for many other languages +.\"===================================================================== +.SH "SEE ALSO" +Frank Liang and Peter Breitenlohner, +patgen.web. +.PP +Frank Liang, +.IR "Word hy-phen-a-tion by com-puter" , +STAN-CS-83-977, +Stanford University Ph.D. thesis, 1983, +http://tug.org/docs/liang. +.PP +Donald E. Knuth, +.IR "The \*(OXbook" , +Addison-Wesley, 1986, ISBN 0-201-13447-0, Appendix H. +.\"===================================================================== +.SH AUTHORS +Frank Liang wrote the first version of this program. Peter +Breitenlohner made a +substantial revision in 1991 for \*(TX 3. +The first version was published as the appendix to the +.I \*(OXware +technical report. Howard Trickey originally ported it to Unix. diff --git a/Master/texmf-dist/doc/man/man1/patgen.man1.pdf b/Master/texmf-dist/doc/man/man1/patgen.man1.pdf Binary files differnew file mode 100644 index 00000000000..b53063d1c8a --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/patgen.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/pdf180.1 b/Master/texmf-dist/doc/man/man1/pdf180.1 new file mode 100644 index 00000000000..08f47b5a9c0 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdf180.1 @@ -0,0 +1,74 @@ +.TH "pdf180" "1" "10 March 2010" "" "" +.SH "NAME" +pdf180 \- rotate the pages of pdf files +.SH "SYNOPSIS" +.PP +pdf180 [OPTION [OPTION] \&.\&.\&.] [SRC [PAGESPEC] [SRC [PAGESPEC]] \&.\&.\&.] +.PP +.SH "DESCRIPTION" +.PP +pdf180 rotates the pages of files in the Adobe Portable Document Format (PDF) +through 180 degrees\&. +.PP +If no source PDF file ('SRC') is specified, input +is from /dev/stdin. If 'PAGESPEC' is omitted, all pages are processed. +.PP +Source files are processed sequentially into a single output +unless the '--batch' option is used, in which case they are processed +separately. +.PP +pdf180 operates on one or more PDF files, and (either with the '--batch' +option or with '--outfile DIR' where 'DIR' is a directory) the +resulting files have +the suffix '-rotated180' applied to their names by default. To change +the suffix, +use the '--suffix' option, for example +.PP +.RS +.B pdf180 --suffix 'upturned' --batch myfile1.pdf myfile2.pdf +.RE +.PP +will result in files named 'myfile1-upturned.pdf' and 'myfile2-upturned.pdf'. +.PP +pdf180 is a simple wrapper for pdfjam, which is a front end to many of the capabilities of the pdfpages +package for pdflatex\&. A working installation of pdflatex with +the pdfpages package is required\&. +.PP +pdf180 is part of the "PDFjam" package of tools, whose homepage is at +http://go.warwick.ac.uk/pdfjam\&. +.PP +.SH "SETUP" +.PP +See http://go.warwick.ac.uk/pdfjam . +.PP +.SH "USAGE" +.PP +For the available options and site/user defaults, see the output of +.PP +.RS + pdfjam --help +.RE +.PP +For further information and some examples see +http://go.warwick.ac.uk/pdfjam \&. +.PP +.SH "LIMITATIONS AND BUGS" +.PP +pdf180 does not work with encrypted PDF files, and does not +preserve hyperlinks. +.PP +Please report bugs! See the website at +http://go.warwick.ac.uk/pdfjam \&. +.PP +.SH "SEE ALSO" +.PP +pdfjam(1)\&. +.PP +.SH "LICENSE" +.PP +PDFjam is distributed under the GNU public license\&. +.PP +.SH "AUTHOR" +.PP +pdf180 is written and maintained by David Firth as part of the PDFjam package\&. + diff --git a/Master/texmf-dist/doc/man/man1/pdf180.man1.pdf b/Master/texmf-dist/doc/man/man1/pdf180.man1.pdf Binary files differnew file mode 100644 index 00000000000..a843ddbc4bc --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdf180.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/pdf270.1 b/Master/texmf-dist/doc/man/man1/pdf270.1 new file mode 100644 index 00000000000..b229678cf82 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdf270.1 @@ -0,0 +1,74 @@ +.TH "pdf270" "1" "10 March 2010" "" "" +.SH "NAME" +pdf270 \- rotate the pages of pdf files +.SH "SYNOPSIS" +.PP +pdf270 [OPTION [OPTION] \&.\&.\&.] [SRC [PAGESPEC] [SRC [PAGESPEC]] \&.\&.\&.] +.PP +.SH "DESCRIPTION" +.PP +pdf270 rotates the pages of files in the Adobe Portable Document Format (PDF) +through 90 degrees (clockwise)\&. +.PP +If no source PDF file ('SRC') is specified, input +is from /dev/stdin. If 'PAGESPEC' is omitted, all pages are processed. +.PP +Source files are processed sequentially into a single output +unless the '--batch' option is used, in which case they are processed +separately. +.PP +pdf270 operates on one or more PDF files, and (either with the '--batch' +option or with '--outfile DIR' where 'DIR' is a directory) the +resulting files have +the suffix 'rotated270' applied to their names by default. To change +the suffix, +use the '--suffix' option, for example +.PP +.RS +.B pdf270 --suffix '-turned' --batch myfile1.pdf myfile2.pdf +.RE +.PP +will result in files named 'myfile1-turned.pdf' and 'myfile2-turned.pdf'. +.PP +pdf270 is a simple wrapper for pdfjam, which is a front end to many of the capabilities of the pdfpages +package for pdflatex\&. A working installation of pdflatex with +the pdfpages package is required\&. +.PP +pdf270 is part of the "PDFjam" package of tools, whose homepage is at +http://go.warwick.ac.uk/pdfjam\&. +.PP +.SH "SETUP" +.PP +See http://go.warwick.ac.uk/pdfjam . +.PP +.SH "USAGE" +.PP +For the available options and site/user defaults, see the output of +.PP +.RS + pdfjam --help +.RE +.PP +For further information and some examples see +http://go.warwick.ac.uk/pdfjam . +.PP +.SH "LIMITATIONS AND BUGS" +.PP +pdf270 does not work with encrypted PDF files, and does not +preserve hyperlinks. +.PP +Please report bugs! See the website at +http://go.warwick.ac.uk/pdfjam \&. +.PP +.SH "SEE ALSO" +.PP +pdfjam(1)\&. +.PP +.SH "LICENSE" +.PP +PDFjam is distributed under the GNU public license\&. +.PP +.SH "AUTHOR" +.PP +pdf270 is written and maintained by David Firth as part of the PDFjam package\&. + diff --git a/Master/texmf-dist/doc/man/man1/pdf270.man1.pdf b/Master/texmf-dist/doc/man/man1/pdf270.man1.pdf Binary files differnew file mode 100644 index 00000000000..f9f3c2f2bd1 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdf270.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/pdf90.1 b/Master/texmf-dist/doc/man/man1/pdf90.1 new file mode 100644 index 00000000000..c04a36137af --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdf90.1 @@ -0,0 +1,74 @@ +.TH "pdf90" "1" "10 March 2010" "" "" +.SH "NAME" +pdf90 \- rotate the pages of pdf files +.SH "SYNOPSIS" +.PP +pdf90 [OPTION [OPTION] \&.\&.\&.] [SRC [PAGESPEC] [SRC [PAGESPEC]] \&.\&.\&.] +.PP +.SH "DESCRIPTION" +.PP +pdf90 rotates the pages of files in the Adobe Portable Document Format (PDF) +through 90 degrees (anti-clockwise)\&. +.PP +If no source PDF file ('SRC') is specified, input +is from /dev/stdin. If 'PAGESPEC' is omitted, all pages are processed. +.PP +Source files are processed sequentially into a single output +unless the '--batch' option is used, in which case they are processed +separately. +.PP +pdf90 operates on one or more PDF files, and (either with the '--batch' +option or with '--outfile DIR' where 'DIR' is a directory) the +resulting files have +the suffix 'rotated90' applied to their names by default. To change +the suffix, +use the '--suffix' option, for example +.PP +.RS +.B pdf90 --suffix '-turned' --batch myfile1.pdf myfile2.pdf +.RE +.PP +will result in files named 'myfile1-turned.pdf' and 'myfile2-turned.pdf'. +.PP +pdf90 is a simple wrapper for pdfjam, which is a front end to many of the capabilities of the pdfpages +package for pdflatex\&. A working installation of pdflatex with +the pdfpages package is required\&. +.PP +pdf90 is part of the "PDFjam" package of tools, whose homepage is at +http://go.warwick.ac.uk/pdfjam\&. +.PP +.SH "SETUP" +.PP +See http://go.warwick.ac.uk/pdfjam . +.PP +.SH "USAGE" +.PP +For the available options and site/user defaults, see the output of +.PP +.RS + pdfjam --help +.RE +.PP +For further information and some examples see +http://go.warwick.ac.uk/pdfjam . +.PP +.SH "LIMITATIONS AND BUGS" +.PP +pdf90 does not work with encrypted PDF files, and does not +preserve hyperlinks. +.PP +Please report bugs! See the website at +http://go.warwick.ac.uk/pdfjam \&. +.PP +.SH "SEE ALSO" +.PP +pdfjam(1)\&. +.PP +.SH "LICENSE" +.PP +PDFjam is distributed under the GNU public license\&. +.PP +.SH "AUTHOR" +.PP +pdf90 is written and maintained by David Firth as part of the PDFjam package\&. + diff --git a/Master/texmf-dist/doc/man/man1/pdf90.man1.pdf b/Master/texmf-dist/doc/man/man1/pdf90.man1.pdf Binary files differnew file mode 100644 index 00000000000..faa6ce0be31 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdf90.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/pdfbook.1 b/Master/texmf-dist/doc/man/man1/pdfbook.1 new file mode 100644 index 00000000000..75f72bd5aef --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdfbook.1 @@ -0,0 +1,86 @@ +.TH "pdfbook" "1" "10 March 2010" "" "" +.SH "NAME" +pdfbook \- put the pages of PDF files into 2-up signatures +.SH "SYNOPSIS" +.PP +pdfbook [--short-edge] [OPTION [OPTION] \&.\&.\&.] [SRC [PAGESPEC] [SRC [PAGESPEC]] \&.\&.\&.] +.PP +.SH "DESCRIPTION" +.PP +pdfbook makes 2-up versions of PDF files, with the pages ordered as +signatures. The default signature size is 4: to change this, use the +option '--signature N', where N is a multiple of 4 (alternatively use '--signature* N' for +right-edge binding). +.PP +The default is to make pages suitable for long-edge binding. For short-edge +binding, use '--short-edge' as the first argument; this will only work if the LaTeX package 'everyshi' is installed. +.PP +The default output page orientation is +landscape. To change this, use the '--no-landscape' option. +.PP +By default, the option '--booklet true' is used (see the pdfpages manual +for details). To turn this off, just specify '--booklet false'. +.PP +If no source PDF file ('SRC') is specified, input +is from /dev/stdin. If 'PAGESPEC' is omitted, all pages are processed. +.PP +Source files are processed sequentially into a single output +unless the '--batch' option is used, in which case they are processed +separately. +.PP +pdfbook is a simple wrapper for pdfjam, which provides a front end to +many of the capabilities of the pdfpages +package for pdflatex\&. A working installation of pdflatex, with +the pdfpages package, is required\&. +.PP +pdfbook operates on one or more PDF files, and (either with the '--batch' +option or with '--outfile DIR' where 'DIR' is a directory) the +resulting files have +the suffix '-book' applied to their names by default. To change the suffix, +use the '--suffix' option, for example +.PP +.RS +.B pdfbook --suffix 'sig4' --batch myfile1.pdf myfile2.pdf +.RE +.PP +will result in files named 'myfile1-sig4.pdf' and 'myfile2-sig4.pdf'. +.PP +pdfbook is part of the "PDFjam" package of tools, whose homepage is at +http://www.warwick.ac.uk/go/pdfjam\&. +.PP +.SH "SETUP" +.PP +See http://go.warwick.ac.uk/pdfjam . +.PP +.SH "USAGE" +.PP +For the other available options and +site/user defaults, see the output of +.PP +.RS +.B pdfjam --help +.RE +.PP +For further information and some examples see +http://go.warwick.ac.uk/pdfjam . +.PP +.SH "LIMITATIONS AND BUGS" +.PP +pdfbook does not work with encrypted PDF files, and does not +preserve hyperlinks. +.PP +Please report bugs! See the website at +http://www.warwick.ac.uk/go/pdfjam \&. +.PP +.SH "LICENSE" +.PP +PDFjam is distributed under the GNU public license\&. +.PP +.SH "SEE ALSO" +.PP +pdfjam(1)\&. +.PP +.SH "AUTHOR" +.PP +pdfbook is written and maintained by David Firth as part of the PDFjam package\&. + diff --git a/Master/texmf-dist/doc/man/man1/pdfbook.man1.pdf b/Master/texmf-dist/doc/man/man1/pdfbook.man1.pdf Binary files differnew file mode 100644 index 00000000000..4462f827e67 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdfbook.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/pdfclose.1 b/Master/texmf-dist/doc/man/man1/pdfclose.1 new file mode 100644 index 00000000000..d6621f5f70d --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdfclose.1 @@ -0,0 +1 @@ +.so man1/pdfopen.1 diff --git a/Master/texmf-dist/doc/man/man1/pdfclose.man1.pdf b/Master/texmf-dist/doc/man/man1/pdfclose.man1.pdf Binary files differnew file mode 100644 index 00000000000..0c9a0b8fd60 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdfclose.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/pdfetex.1 b/Master/texmf-dist/doc/man/man1/pdfetex.1 new file mode 100644 index 00000000000..986192148ef --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdfetex.1 @@ -0,0 +1,37 @@ +.TH PDFETEX 1 "14 May 2010" "pdftex 1.40" "Web2C 2012" +.\"===================================================================== +.if n .ds MF Metafont +.if t .ds MF M\s-2ETAFONT\s0 +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.if n .ds MF Metafont +.if t .ds MF M\s-2ETAFONT\s0 +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP\" for troff +.el .ds OX TeX\" for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.if t .ds AX \fRA\\h'-0.1667m'\\v'0.20v'M\\v'-0.20v'\\h'-0.125m'S\fP\*(TX +.if n .ds AX AmSTeX +.if t .ds AY \fRA\\h'-0.1667m'\\v'0.20v'M\\v'-0.20v'\\h'-0.125m'S\fP\*(LX +.if n .ds AY AmSLaTeX +.\"===================================================================== +.SH NAME +pdfetex \- PDF output from e-TeX +.SH SYNOPSIS +.B pdfetex +.RI [ options ] +.RI [ \fB&\fPformat ] +.RI [ file | \fB\e\fPcommands ] +.\"===================================================================== +.SH DESCRIPTION +pdfe\*(TX is another name for pdf\*(TX; they behave identically. +See pdftex(1) for all information. +.\"===================================================================== +.SH "SEE ALSO" +.BR pdftex (1), +http://pdftex.org, http://tug.org/web2c. diff --git a/Master/texmf-dist/doc/man/man1/pdfetex.man1.pdf b/Master/texmf-dist/doc/man/man1/pdfetex.man1.pdf Binary files differnew file mode 100644 index 00000000000..744f738fdf2 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdfetex.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/pdfflip.1 b/Master/texmf-dist/doc/man/man1/pdfflip.1 new file mode 100644 index 00000000000..9761790d9f6 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdfflip.1 @@ -0,0 +1,73 @@ +.TH "pdfflip" "1" "10 March 2010" "" "" +.SH "NAME" +pdfflip \- rotate the pages of pdf files +.SH "SYNOPSIS" +.PP +pdfflip [OPTION [OPTION] \&.\&.\&.] [SRC [PAGESPEC] [SRC [PAGESPEC]] \&.\&.\&.] +.PP +.SH "DESCRIPTION" +.PP +pdfflip reflects (left-right) the pages of files in the Adobe Portable Document Format (PDF)\&. +.PP +If no source PDF file ('SRC') is specified, input +is from /dev/stdin. If 'PAGESPEC' is omitted, all pages are processed. +.PP +Source files are processed sequentially into a single output +unless the '--batch' option is used, in which case they are processed +separately. +.PP +pdfflip operates on one or more PDF files, and (either with the '--batch' +option or with '--outfile DIR' where 'DIR' is a directory) the +resulting files have +the suffix '-flipped' applied to their names by default. To change +the suffix, +use the '--suffix' option, for example +.PP +.RS +.B pdfflip --suffix 'reflected' --batch myfile1.pdf myfile2.pdf +.RE +.PP +will result in files named 'myfile1-reflected.pdf' and 'myfile2-reflected.pdf'. +.PP +pdfflip is a simple wrapper for pdfjam, which is a front end to many of the capabilities of the pdfpages +package for pdflatex\&. A working installation of pdflatex with +the pdfpages package is required\&. +.PP +pdfflip is part of the "PDFjam" package of tools, whose homepage is at +http://go.warwick.ac.uk/pdfjam\&. +.PP +.SH "SETUP" +.PP +See http://go.warwick.ac.uk/pdfjam . +.PP +.SH "USAGE" +.PP +For the available options and site/user defaults, see the output of +.PP +.RS + pdfjam --help +.RE +.PP +For further information and some examples see +http://go.warwick.ac.uk/pdfjam . +.PP +.SH "LIMITATIONS AND BUGS" +.PP +pdfflip does not work with encrypted PDF files, and does not +preserve hyperlinks. +.PP +Please report bugs! See the website at +http://go.warwick.ac.uk/pdfjam \&. +.PP +.SH "SEE ALSO" +.PP +pdfjam(1)\&. +.PP +.SH "LICENSE" +.PP +PDFjam is distributed under the GNU public license\&. +.PP +.SH "AUTHOR" +.PP +pdfflip is written and maintained by David Firth as part of the PDFjam package\&. + diff --git a/Master/texmf-dist/doc/man/man1/pdfflip.man1.pdf b/Master/texmf-dist/doc/man/man1/pdfflip.man1.pdf Binary files differnew file mode 100644 index 00000000000..4e77b43f4c0 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdfflip.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/pdfjam-pocketmod.1 b/Master/texmf-dist/doc/man/man1/pdfjam-pocketmod.1 new file mode 100644 index 00000000000..4c51ef78806 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdfjam-pocketmod.1 @@ -0,0 +1,63 @@ +.TH "pdfjam-pocketmod" "1" "10 March 2010" "" "" +.SH "NAME" +pdfjam-pocketmod +\- make an 8-page PDF document into a pocket-sized booklet +.SH "SYNOPSIS" +.PP +.B pdfjam-pocketmod SRC [PAGESPEC] [OPTION [OPTION] \&.\&.\&.] +.PP +.SH "DESCRIPTION" +.PP +pdfjam-pocketmod converts 8 pages of a PDF file into a single 8-up page, with pages ordered and oriented for folding into pocket-sized booklet +( as described at http://repocketmod.com/ )\&. +.PP +SRC must be a regular PDF file (not /dev/stdin). +.PP +If PAGESPEC is omitted, the first 8 pages are processed. +.PP +OPTION is any option to pdfjam(1) other than --batch. +.PP +pdfjam-pocketmod is a simple wrapper for pdfjam, which provides a front end to some of the capabilities of the pdfpages +package for pdflatex\&. A working installation of pdflatex, with +the pdfpages package, is required\&. +.PP +pdfjam-pocketmod is part of the "PDFjam" package of tools, whose homepage is at +http://go.warwick.ac.uk/pdfjam \&. +.PP +.SH "SETUP" +.PP +See http://go.warwick.ac.uk/pdfjam . +.PP +.SH "USAGE" +.PP +For the available options and site/user defaults, see the output of +.PP +.RS +.B pdfjam --help +.RE +.PP +For further information and some examples see +http://go.warwick.ac.uk/pdfjam \&. +.PP +.SH "LIMITATIONS AND BUGS" +.PP +pdfjam-pocketmod does not work with encrypted PDF files, and does not preserve hyperlinks. +.PP +The '--keepinfo' option does not work. +.PP +Please report bugs! See the website at +http://www.warwick.ac.uk/go/pdfjam\&. +.PP +.SH "LICENSE" +.PP +PDFjam is distributed under the GNU public license\&. +.PP +.SH "SEE ALSO" +.PP +pdfjam(1)\&. +.PP +.SH "AUTHOR" +.PP +pdfjam-pocketmod is written and maintained by David Firth as part of the PDFjam +package\&. + diff --git a/Master/texmf-dist/doc/man/man1/pdfjam-pocketmod.man1.pdf b/Master/texmf-dist/doc/man/man1/pdfjam-pocketmod.man1.pdf Binary files differnew file mode 100644 index 00000000000..43cc467d13b --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdfjam-pocketmod.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/pdfjam-slides3up.1 b/Master/texmf-dist/doc/man/man1/pdfjam-slides3up.1 new file mode 100644 index 00000000000..09227631a10 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdfjam-slides3up.1 @@ -0,0 +1,88 @@ +.TH "pdfjam-slides3up" "1" "10 March 2010" "" "" +.SH "NAME" +pdfjam-slides3up \- put presentation slides onto 3-up pages +.SH "SYNOPSIS" +.PP +pdfjam-slides3up [--pagenumbering SWITCH] [OPTION [OPTION] \&.\&.\&.] [SRC [PAGESPEC] [SRC [PAGESPEC]] \&.\&.\&.] +.PP +.SH "DESCRIPTION" +.PP +pdfjam-slides3up converts PDF files whose pages are presentation slides (with +4:3 aspect ratio) into 3-up versions suitable for making a handout with space +for handwritten side notes +(for example). By default, the 3-up pages do not themselves have page numbers. +.PP +To put page numbers on the output pages, use either '--pagenumbering true' +or, for example, '--pagenumbering 3.4cm' to place the page numbers a bit +lower on the page than the default position. The value of 'SWITCH' must +be either 'true', 'false' or a dimension that can be used by LateX. (To +be precise, it's the value of the 'footskip' dimension in LaTeX; by default, +pdfjam-slides3up sets that as 3.1cm, which works pretty well in +conjunction with both '--paper a4paper' and '--paper letterpaper'.) +.PP +If no source PDF file ('SRC') is specified, input +is from /dev/stdin. If 'PAGESPEC' is omitted, all pages are processed. +.PP +Source files are processed sequentially into a single output +unless the '--batch' option is used, in which case they are processed +separately. +.PP +pdfjam-slides3up is a simple wrapper for pdfjam, which provides a front end to +many of the capabilities of the pdfpages +package for pdflatex\&. A working installation of pdflatex, with +the pdfpages package, is required\&. +.PP +pdfjam-slides3up operates on one or more PDF files, and (either with +the '--batch' option or with '--outfile DIR' where 'DIR' is a directory) the +resulting files have +the suffix '-3up' applied to their names by default. To change the suffix, +use the '--suffix' option, for example +.PP +.RS +.B pdfjam-slides3up --suffix '1x3' --batch myslides1.pdf myslides2.pdf +.RE +.PP +will result in files named 'myslides1-1x3.pdf' and 'myslides2-1x3.pdf'. +.PP +By default a narrow line frame is printed around every slide. This can be +turned off if required by using the option '--frame false'. +.PP +pdfjam-slides3up is part of the "PDFjam" package of tools, whose homepage is at +http://www.warwick.ac.uk/go/pdfjam \&. +.PP +.SH "SETUP" +.PP +See http://go.warwick.ac.uk/pdfjam . +.PP +.SH "USAGE" +.PP +For the other available options and +site /user defaults, see the output of +.PP +.RS +.B pdfjam --help +.RE +.PP +For further information and some examples see +http://go.warwick.ac.uk/pdfjam \&. +.PP +.SH "LIMITATIONS AND BUGS" +.PP +pdfjam-slides3up does not work with encrypted PDF files, and does not +preserve hyperlinks. +.PP +Please report bugs! See the website at +http://www.warwick.ac.uk/go/pdfjam \&. +.PP +.SH "LICENSE" +.PP +PDFjam is distributed under the GNU public license\&. +.PP +.SH "SEE ALSO" +.PP +pdfjam(1) pdfjam-slides6up(1) \&. +.PP +.SH "AUTHOR" +.PP +pdfjam-slides3up is written and maintained by David Firth as part of the PDFjam package\&. + diff --git a/Master/texmf-dist/doc/man/man1/pdfjam-slides3up.man1.pdf b/Master/texmf-dist/doc/man/man1/pdfjam-slides3up.man1.pdf Binary files differnew file mode 100644 index 00000000000..0a59e160e35 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdfjam-slides3up.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/pdfjam-slides6up.1 b/Master/texmf-dist/doc/man/man1/pdfjam-slides6up.1 new file mode 100644 index 00000000000..6e90363bc6f --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdfjam-slides6up.1 @@ -0,0 +1,87 @@ +.TH "pdfjam-slides6up" "1" "10 March 2010" "" "" +.SH "NAME" +pdfjam-slides6up \- put presentation slides onto 6-up pages +.SH "SYNOPSIS" +.PP +pdfjam-slides6up [--pagenumbering SWITCH] [OPTION [OPTION] \&.\&.\&.] [SRC [PAGESPEC] [SRC [PAGESPEC]] \&.\&.\&.] +.PP +.SH "DESCRIPTION" +.PP +pdfjam-slides6up converts PDF files whose pages are presentation slides (with +4:3 aspect ratio) into 6-up versions suitable for making a handout +(for example). By default, the 6-up pages do not themselves have page numbers. +.PP +To put page numbers on the output pages, use either '--pagenumbering true' +or, for example, '--pagenumbering 3.0cm' to place the page numbers a bit +lower on the page than the default position. The value of 'SWITCH' must +be either 'true', 'false' or a dimension that can be used by LateX. (To +be precise, it's the value of the 'footskip' dimension in LaTeX; by default, +pdfjam-slides6up sets that as 2.7cm, which works pretty well in +conjunction with both '--paper a4paper' and '--paper letterpaper'.) +.PP +If no source PDF file ('SRC') is specified, input +is from /dev/stdin. If 'PAGESPEC' is omitted, all pages are processed. +.PP +Source files are processed sequentially into a single output +unless the '--batch' option is used, in which case they are processed +separately. +.PP +pdfjam-slides6up is a simple wrapper for pdfjam, which provides a front end to +many of the capabilities of the pdfpages +package for pdflatex\&. A working installation of pdflatex, with +the pdfpages package, is required\&. +.PP +pdfjam-slides6up operates on one or more PDF files, and (either with +the '--batch' option or with '--outfile DIR' where 'DIR' is a directory) the +resulting files have +the suffix '-6up' applied to their names by default. To change the suffix, +use the '--suffix' option, for example +.PP +.RS +.B pdfjam-slides6up --suffix '2x3' --batch myslides1.pdf myslides2.pdf +.RE +.PP +will result in files named 'myslides1-2x3.pdf' and 'myslides2-2x3.pdf'. +.PP +By default a narrow line frame is printed around every slide. This can be +turned off if required by using the option '--frame false'. +.PP +pdfjam-slides6up is part of the "PDFjam" package of tools, whose homepage is at +http://www.warwick.ac.uk/go/pdfjam \&. +.PP +.SH "SETUP" +.PP +See http://go.warwick.ac.uk/pdfjam . +.PP +.SH "USAGE" +.PP +For the other available options and +site/user defaults, see the output of +.PP +.RS +.B pdfjam --help +.RE +.PP +For further information and some examples see +http://go.warwick.ac.uk/pdfjam \&. +.PP +.SH "LIMITATIONS AND BUGS" +.PP +pdfjam-slides6up does not work with encrypted PDF files, and does not +preserve hyperlinks. +.PP +Please report bugs! See the website at +http://www.warwick.ac.uk/go/pdfjam \&. +.PP +.SH "LICENSE" +.PP +PDFjam is distributed under the GNU public license\&. +.PP +.SH "SEE ALSO" +.PP +pdfjam(1) pdfjam-slides3up(1) \&. +.PP +.SH "AUTHOR" +.PP +pdfjam-slides6up is written and maintained by David Firth as part of the PDFjam package\&. + diff --git a/Master/texmf-dist/doc/man/man1/pdfjam-slides6up.man1.pdf b/Master/texmf-dist/doc/man/man1/pdfjam-slides6up.man1.pdf Binary files differnew file mode 100644 index 00000000000..2d6c520fe87 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdfjam-slides6up.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/pdfjam.1 b/Master/texmf-dist/doc/man/man1/pdfjam.1 new file mode 100644 index 00000000000..49a0e4990c2 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdfjam.1 @@ -0,0 +1,58 @@ +.TH "pdfjam" "1" "10 March 2010" "" "" +.SH "NAME" +pdfjam \- A shell script for manipulating PDF files +.SH "SYNOPSIS" +.PP +pdfjam [OPTION [OPTION] \&.\&.\&.] [SRC [PAGESPEC] [SRC [PAGESPEC]] \&.\&.\&.] +.PP +.SH "DESCRIPTION" +.PP +pdfjam provides a front end to most capabilities of the +"pdfpages" package (by Andreas Matthias) of pdflatex. +Detailed information can be found via +"pdfjam --help", and also in the web page mentioned below \&. +.PP +A working installation of pdflatex, with +the pdfpages package, is required\&. +.PP +The pdfjam script is distributed as (the main) part of the PDFjam package. The homepage of PDFjam is at +http://go.warwick.ac.uk/pdfjam \&. +.PP +.SH "SETUP" +.PP +See http://go.warwick.ac.uk/pdfjam . +.PP +.PP +For further information and some examples see +http://go.warwick.ac.uk/pdfjam \&. +.PP +.SH "CONFIGURATION FILES" +.PP +Configuration of the PDFjam utilities +involves specifying the location of pdflatex, +the location of temporary files, specification of default page size, +etc. This is done in a block of lines near the top of the pdfjam script; +settings made there are over-ridden by any that +are found at a site-wide configuration file +(at /etc/pdfjam.conf, +/usr/share/etc/pdfjam.conf, /usr/local/share/pdfjam.conf, or +/usr/local/etc/pdfjam.conf), which +in turn are over-ridden by any that are found in a user-defaults +file at ~/.pdfjam.conf\&. +.PP +.SH "LIMITATIONS AND BUGS" +.PP +pdfjam does not work with encrypted PDF files, and does not +preserve hyperlinks. +.PP +Please report bugs! See the website at +http://go.warwick.ac.uk/pdfjam \&. +.PP +.SH "LICENSE" +.PP +PDFjam is distributed under the GNU public license\&. +.PP +.SH "AUTHOR" +.PP +The PDFjam package is written and maintained by David Firth\&. + diff --git a/Master/texmf-dist/doc/man/man1/pdfjam.man1.pdf b/Master/texmf-dist/doc/man/man1/pdfjam.man1.pdf Binary files differnew file mode 100644 index 00000000000..023726a7c7b --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdfjam.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/pdfjoin.1 b/Master/texmf-dist/doc/man/man1/pdfjoin.1 new file mode 100644 index 00000000000..c55b4a4938c --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdfjoin.1 @@ -0,0 +1,66 @@ +.TH "pdfjoin" "1" "10 March 2010" "" "" +.SH "NAME" +pdfjoin +\- join together pages from multiple PDF files +.SH "SYNOPSIS" +.PP +.B pdfjoin [OPTION [OPTION] \&.\&.\&.] [SRC [PAGESPEC] [SRC [PAGESPEC]] \&.\&.\&.] +.PP +.SH "DESCRIPTION" +.PP +pdfjoin +concatenates the pages of multiple Portable Document Format (PDF) +files together into a single file.\&. +.PP +If no source PDF file ('SRC') is specified, input (but just one file -- not +very useful here! +is from /dev/stdin. If 'PAGESPEC' is omitted, all pages are processed. +.PP +Source files are processed sequentially into a single output. +The '--batch' option of pdfjam(1) cannot be used. +.PP +pdfjoin is a simple wrapper for pdfjam, which provides a front end to many of the capabilities of the pdfpages +package for pdflatex\&. A working installation of pdflatex, with +the pdfpages package, is required\&. +.PP +pdfjoin is part of the "PDFjam" package of tools, whose homepage is at +http://go.warwick.ac.uk/pdfjam \&. +.PP +.SH "SETUP" +.PP +See http://go.warwick.ac.uk/pdfjam . +.PP +.SH "USAGE" +.PP +For the available options and site/user defaults, see the output of +.PP +.RS +.B pdfjam --help +.RE +.PP +For further information and some examples see +http://go.warwick.ac.uk/pdfjam \&. +.PP +.SH "LIMITATIONS AND BUGS" +.PP +The pages of the output file will all have the same size and orientation. +.PP +pdfjoin does not work with encrypted PDF files, and does not +preserve hyperlinks. The output pages are all one size. +.PP +Please report bugs! See the website at +http://www.warwick.ac.uk/go/pdfjam \&. +.PP +.SH "LICENSE" +.PP +PDFjam is distributed under the GNU public license\&. +.PP +.SH "SEE ALSO" +.PP +pdfjam(1)\&. +.PP +.SH "AUTHOR" +.PP +pdfjoin is written and maintained by David Firth as part of the PDFjam +package\&. + diff --git a/Master/texmf-dist/doc/man/man1/pdfjoin.man1.pdf b/Master/texmf-dist/doc/man/man1/pdfjoin.man1.pdf Binary files differnew file mode 100644 index 00000000000..83732dfb3fb --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdfjoin.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/pdflatex.1 b/Master/texmf-dist/doc/man/man1/pdflatex.1 new file mode 100644 index 00000000000..8e9a6b03670 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdflatex.1 @@ -0,0 +1 @@ +.so man1/pdftex.1 diff --git a/Master/texmf-dist/doc/man/man1/pdflatex.man1.pdf b/Master/texmf-dist/doc/man/man1/pdflatex.man1.pdf Binary files differnew file mode 100644 index 00000000000..25d38073d17 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdflatex.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/pdfnup.1 b/Master/texmf-dist/doc/man/man1/pdfnup.1 new file mode 100644 index 00000000000..86953387e89 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdfnup.1 @@ -0,0 +1,78 @@ +.TH "pdfnup" "1" "10 March 2010" "" "" +.SH "NAME" +pdfnup \- n-up the pages of pdf files +.SH "SYNOPSIS" +.PP +pdfnup [OPTION [OPTION] \&.\&.\&.] [SRC [PAGESPEC] [SRC [PAGESPEC]] \&.\&.\&.] +.PP +.SH "DESCRIPTION" +.PP +pdfnup converts files in the Adobe Portable Document Format (PDF) +to "n-up" PDF files, that is, with multiple input pages +per output page, for +more economical printing etc\&. The default processing is to 2-up +landscape output with no frame around pages, equivalent to using the +options '--nup 2x1 --landscape true --frame false'. +.PP +If no source PDF file ('SRC') is specified, input +is from /dev/stdin. If 'PAGESPEC' is omitted, all pages are processed. +.PP +Source files are processed sequentially into a single output +unless the '--batch' option is used, in which case they are processed +separately. +.PP +pdfnup operates on one or more PDF files, and (either with the '--batch' +option or with '--outfile DIR' where 'DIR' is a directory) the +resulting files have +the suffix '-nup' applied to their names by default. To change +the suffix, +use the '--suffix' option, for example +.PP +.RS +.B pdfnup --nup 2x2 --suffix '2x2' --batch myfile1.pdf myfile2.pdf +.RE +.PP +will result in files named 'myfile1-2x2.pdf' and 'myfile2-2x2.pdf'. +.PP +pdfnup is a simple wrapper for pdfjam, which provides a front end to many of the capabilities of the pdfpages +package for pdflatex\&. A working installation of pdflatex, with +the pdfpages and geometry packages, is required\&. +.PP +pdfnup is part of the "PDFjam" package of tools, whose homepage is at +http://www.warwick.ac.uk/go/pdfjam \&. +.PP +.SH "SETUP" +.PP +See http://go.warwick.ac.uk/pdfjam . +.PP +.SH "USAGE" +.PP +For the available options and site/user defaults, see the output of +.PP +.RS +.B pdfjam --help +.RE +.PP +For further information and some examples see +http://go.warwick.ac.uk/pdfjam . +.PP +.SH "LIMITATIONS AND BUGS" +.PP +pdfnup does not work with encrypted PDF files, and does not +preserve hyperlinks. +.PP +Please report bugs! See the website at +http://www.warwick.ac.uk/go/pdfjam \&. +.PP +.SH "LICENSE" +.PP +PDFjam is distributed under the GNU public license\&. +.PP +.SH "SEE ALSO" +.PP +pdfjam(1) pdfpun(1) \&. +.PP +.SH "AUTHOR" +.PP +pdfnup is written and maintained by David Firth as part of the PDFjam package\&. + diff --git a/Master/texmf-dist/doc/man/man1/pdfnup.man1.pdf b/Master/texmf-dist/doc/man/man1/pdfnup.man1.pdf Binary files differnew file mode 100644 index 00000000000..f387885524f --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdfnup.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/pdfopen.1 b/Master/texmf-dist/doc/man/man1/pdfopen.1 new file mode 100644 index 00000000000..82239785469 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdfopen.1 @@ -0,0 +1,160 @@ +.\" This manpage is licensed under the GNU Public License +.TH PDFOPEN 1 2012-01-28 "pdfopen 0.83" "" +. +.SH NAME +pdfopen, pdfclose \- open or close a PDF file viewer +. +.SH SYNOPSIS +.B pdfopen +[\fIOPTION\fP] +\fIFILE.PDF\fP +.br +.B pdfclose +\fIFILE.PDF\fP +. +.SH OPTIONS +.TP 8 +.B -h, --help +output help and exit +.TP +.B -v, --version +output the version number and exit +.TP +.B -r, --reset_focus +after sending commands to the PDF viewer, attempt to reset the input focus to +the window which had focus before the commands were sent +.TP +.B -viewer +<\fIar9\fP|\fIar9-tab\fP|\fIar8\fP|\fIar7\fP|\fIar5\fP|\fIxpdf\fP|\fIevince\fP> +use (respectively) Adobe Reader 9 (in a new window), Adobe Reader 9 +(in a new tab of a running AR9, if any), +Adobe Reader 8, Adobe Reader 7, Adobe Reader 5, xpdf or evince as the +PDF viewer program. +Adobe Reader 9 (in a new window) is the default. +. +.SH RATIONALE +At certain points of TeX document preparation, many people repeat a +"edit-compile-view" cycle. Since PDF viewers such as Adobe's Acrobat +Reader ("\fBacroread\fP") do not automatically refresh the display when the +PDF file changes, this cycle can be more cumbersome than desired. +The +.B pdfopen +program provides the ability to automate the reloading of the PDF +document when it is changed. + +Note: there seems to be little need for +.B pdfclose +under GNU/Linux, since (unlike the situation for MS windows) +.B acroread +does not lock the PDF file, which would prevent +.B pdftex +(or a DVI to PDF converter) from creating a new version of the PDF +output file. However, +.B pdfclose +is provided in case someone finds it useful. +. +.SH DESCRIPTION +.B pdfopen +searches for an instance of the specified (or default) PDF viewer +displaying the specified PDF file. +If there is already an instance of the given viewer displaying the +given file, the viewer is instructed to reload the file. If no such +instance is found, \fBpdfopen\fP attempts to run the specified viewer +on the specified document. + +The default viewer is "\fBacroread\fP", which could start any one +of a number of versions of Acrobat Reader, depending on what is +installed on your system. However, the commands to reload the current +document vary from one version of \fBacroread\fP to another; +consequently, if you are using a version of \fBacroread\fP other than +AR9, you should explicitly specify the viewer program. + +Version 0.83 of \fBpdfopen\fP accepts the following viewer options: +.br +\fIar9\fP, \fIar9-tab\fP, \fIar8\fP, \fIar7\fP, \fIar5\fP, \fIxpdf\fP, +and \fIevince\fP. +.br +The difference between \fIar9\fP and \fIar9-tab\fP is significant +when there is no instance of AR9 already displaying the requested +document. In this situation, while \fIar9\fP will +request \fBacroread\fP to create a new instance of \fBacroread\fP +(and thus open a new window) by using the \fB-openInNewInstance\fP +argument, \fIar9-tab\fP starts \fBacroread\fP without this argument; +if there is already an instance of \fBacroread\fP running, a new +tab will be opened in an existing window. + +.B pdfclose +searches for one of the above PDF viewers displaying the given file +and instructs the viewer to "close" the window. In most cases, the +PDF viewer continues to run, possibly now displaying just a blank +window. (This behaviour varies somewhat from one PDF viewer to another.) +. +.SH PORTABILITY AND AVAILABILITY +Users familiar with the Windows version of +.B pdfopen +might wonder about the lack of a +.B --page +.IR <pagenumber> +option. Unfortunately, to date no GNU/Linux versions of +.B acroread +support this feature. Anyone having a friend at Adobe is encouraged +to ask them to implement a +"\fB-page \fP\fI<pagenumber>\fP" +command line option for \fBacroread\fP. + +These programs have been tested on Slackware64 Version 13.37 and a few +other versions / distributions of GNU/Linux. The code is reasonably +generic and should work out of the box using most recent X11 +implementations. (Reports to the contrary are welcome, particularly +if they come with robust fixes.) + +These programs are designed for X11-based systems. If you somehow +find compiled versions of these programs on a system using another +window system, they are very unlikely to be of any use to you. + +Source and binaries of the programs can be downloaded from +CTAN://support/xpdfopen/ +(e.g., http://mirror.ctan.org/support/xpdfopen). +. +.SH CAVEATS +If you use +.I ar9-tab +to reload the PDF document and the instance +of +.B acroread +with the given document is currently displaying some other document, +the command causes your document to be displayed, but not reloaded. + +.B pdfopen +works by looking for a window with a name (window title) matching that +expected for the given viewer and document. If for some reason your +viewer's window name is not as expected, +.B pdfopen +may not work for you. + +With at least AR9 and some window managers, using +.B pdfopen +to reload the document gives focus to the +.B acroread +window, even though the mouse cursor is not necessarily in that +window. This can be annoying. The \fB-reset_focus\fP option can be +used to deal with this problem. +. +.SH AUTHOR +This manual page was written by Jim Diamond <Jim.Diamond@acadiau.ca>. +I am the current maintainer of the X11 versions of +.B pdfopen +and +\fBpdfclose\fP. +Report any bugs you find to me. Feature enhancement requests are +welcome, coded enhancements even more so. + +Past authors: +Fabrice Popineau wrote the MS-windows versions of +.B pdfopen +and +.B pdfclose +upon which these programs were originally based. +Taco Hoekwater created the GNU/Linux versions, up to Version 0.61 +(including some documentation which inspired parts of this man page). + diff --git a/Master/texmf-dist/doc/man/man1/pdfopen.man1.pdf b/Master/texmf-dist/doc/man/man1/pdfopen.man1.pdf Binary files differnew file mode 100644 index 00000000000..06fa98d5993 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdfopen.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/pdfpun.1 b/Master/texmf-dist/doc/man/man1/pdfpun.1 new file mode 100644 index 00000000000..0e4b3415429 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdfpun.1 @@ -0,0 +1,68 @@ +.TH "pdfpun" "1" "10 March 2010" "" "" +.SH "NAME" +pdfpun \- n-up the pages of a pdf file, with right-to-left ordering +.SH "SYNOPSIS" +.PP +pdfpun SRC [PAGESPEC] --outfile FILENAME [OPTION [OPTION] \&.\&.\&.] +.PP +.SH "DESCRIPTION" +.PP +pdfpun converts a file in the Adobe Portable Document Format (PDF) +to a "n-up" PDF file, that is, with multiple input pages +per output page, for +more economical printing etc\&. The pages are ordered right-to-left in the +output. The default processing is to 2-up +landscape output with no frame around pages, equivalent to using the +options '--nup 2x1 --landscape --frame false'. +.PP +SRC must be a PDF file; '/dev/stdin' can be used for PDF input via a pipeline. +.PP +If PAGESPEC is omitted, all pages are processed (equivalent to '-' as PAGESPEC) +.PP +OPTION is any option of pdfjam(1) other than --batch. +.PP +pdfpun is a simple wrapper for pdfjam, which provides a front end to many +of the capabilities of the pdfpages package for pdflatex\&. +A working installation of pdflatex, with +the pdfpages package, is required\&. +.PP +pdfpun is part of the "PDFjam" package of tools, whose homepage is at +http://www.warwick.ac.uk/go/pdfjam\&. +.PP +.SH "SETUP" +.PP +See http://go.warwick.ac.uk/pdfjam . +.PP +.SH "USAGE" +.PP +For the available options and site/user defaults, see the output of +.PP +.RS +.B pdfjam --help +.RE +.PP +For further information and some examples see +http://go.warwick.ac.uk/pdfjam \&. +.PP +.SH "LIMITATIONS AND BUGS" +.PP +pdfpun does not work with encrypted PDF files, and does not +preserve hyperlinks. +.PP +The '--keepinfo' option does not work. +.PP +Please report bugs! See the website at +http://www.warwick.ac.uk/go/pdfjam \&. +.PP +.SH "LICENSE" +.PP +PDFjam is distributed under the GNU public license\&. +.PP +.SH "SEE ALSO" +.PP +pdfjam(1) pdfnup(1)\&. +.PP +.SH "AUTHOR" +.PP +pdfpun is written and maintained by David Firth as part of the PDFjam package\&. + diff --git a/Master/texmf-dist/doc/man/man1/pdfpun.man1.pdf b/Master/texmf-dist/doc/man/man1/pdfpun.man1.pdf Binary files differnew file mode 100644 index 00000000000..3d11c6d8ad6 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdfpun.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/pdftex.1 b/Master/texmf-dist/doc/man/man1/pdftex.1 new file mode 100644 index 00000000000..d94e290be96 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdftex.1 @@ -0,0 +1,476 @@ +.TH PDFTEX 1 "1 March 2011" "pdftex 1.40" "Web2C 2012" +.\"===================================================================== +.if n .ds MF Metafont +.if t .ds MF M\s-2ETAFONT\s0 +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.if n .ds MF Metafont +.if t .ds MF M\s-2ETAFONT\s0 +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff +.el .ds OX TeX for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.if t .ds AX \fRA\\h'-0.1667m'\\v'0.20v'M\\v'-0.20v'\\h'-0.125m'S\fP\*(TX +.if n .ds AX AmSTeX +.if t .ds AY \fRA\\h'-0.1667m'\\v'0.20v'M\\v'-0.20v'\\h'-0.125m'S\fP\*(LX +.if n .ds AY AmSLaTeX +.if n .ds WB Web +.if t .ds WB W\s-2EB\s0 +.\"===================================================================== +.SH NAME +pdftex, pdfinitex, pdfvirtex \- PDF output from TeX +.SH SYNOPSIS +.B pdftex +.RI [ options ] +.RI [ \fB&\fPformat ] +.RI [ file | \fB\e\fPcommands ] +.\"===================================================================== +.SH DESCRIPTION +Run the pdf\*(TX typesetter on +.IR file , +usually creating +.IR file.pdf . +If the file argument has no extension, ".tex" will be appended to it. +Instead of a filename, a set of pdf\*(TX commands can be given, the first +of which must start with a backslash. +With a +.BI & format +argument pdf\*(TX uses a different set of precompiled commands, +contained in +.IR format\fB.fmt\fP ; +it is usually better to use the +.B -fmt +.I format +option instead. +.PP +pdf\*(TX is a version of \*(TX, with the e-\*(TX extensions, that can create +.I PDF +files as well as +.I DVI +files. +.PP +In +.I DVI +mode, pdf\*(TX can be used as a complete replacement for the \*(TX +engine. +.PP +The typical use of pdf\*(TX is with a pregenerated formats for which +PDF output has been enabled. The +.B pdftex +command uses the equivalent of the plain \*(TX format, and the +.B pdflatex +command uses the equivalent of the \*(LX format. +To generate formats, use the +.B -ini +switch. +.PP +The +.B pdfinitex +and +.B pdfvirtex +commands are pdf\*(TX's analogues to the +.B initex +and +.B virtex +commands. In this installation, if the links exist, they are symbolic +links to the +.B pdftex +executable. +.PP +In +.I PDF +mode, pdf\*(TX can natively handle the +.IR PDF , +.IR JPG , +.IR JBIG2 , +and +.I PNG +graphics formats. pdf\*(TX cannot include PostScript or Encapsulated +PostScript (EPS) graphics files; first convert them to PDF using +.BR epstopdf (1). +pdf\*(TX's handling of its command-line arguments is similar to that of +of the other \*(TX programs in the +.I web2c +implementation. +.\"===================================================================== +.SH OPTIONS +This version of pdf\*(TX understands the following command line options. +.TP +.B -draftmode +Sets \epdfdraftmode so pdf\*(TX doesn't write a PDF and doesn't read any +included images, thus speeding up execution. +.TP +.B -enc +Enable the enc\*(TX extensions. This option is only effective in +combination with +.BR -ini . +For documentation of the enc\*(TX extensions see +.BR http://www.olsak.net/enctex.html . +.TP +.B -etex +Enable the e-\*(TX extensions. This option is only effective in +combination with +.BR -ini . +See +.BR etex (1). +.TP +.B -file-line-error +Print error messages in the form +.I file:line:error +which is similar to the way many compilers format them. +.TP +.B -no-file-line-error +Disable printing error messages in the +.I file:line:error +style. +.TP +.B -file-line-error-style +This is the old name of the +.B -file-line-error +option. +.TP +.BI -fmt \ format +Use +.I format +as the name of the format to be used, instead of the name by which +pdf\*(TX was called or a +.I %& +line. +.TP +.B -halt-on-error +Exit with an error code when an error is encountered during processing. +.TP +.B -help +Print help message and exit. +.TP +.B -ini +Start in +.I INI +mode, which is used to dump formats. The +.I INI +mode can be used for typesetting, but no format is preloaded, and +basic initializations like setting catcodes may be required. +.TP +.BI -interaction \ mode +Sets the interaction mode. The mode can be either +.IR batchmode , +.IR nonstopmode , +.IR scrollmode , +and +.IR errorstopmode . +The meaning of these modes is the same as that of the corresponding +\ecommands. +.TP +.B -ipc +Send DVI or PDF output to a socket as well as the usual output file. +Whether this option is available is the choice of the installer. +.TP +.B -ipc-start +As +.BR -ipc , +and starts the server at the other end as well. Whether this option +is available is the choice of the installer. +.TP +.BI -jobname \ name +Use +.I name +for the job name, instead of deriving it from the name of the input file. +.TP +.BI -kpathsea-debug \ bitmask +Sets path searching debugging flags according to the bitmask. See the +.I Kpathsea +manual for details. +.TP +.BI -mktex \ fmt +Enable +.RI mktex fmt , +where +.I fmt +must be either +.I tex +or +.IR tfm . +.TP +.B -mltex +Enable ML\*(TX extensions. Only effective in combination with +.BR -ini . +.TP +.BI -no-mktex \ fmt +Disable +.RI mktex fmt , +where +.I fmt +must be either +.I tex +or +.IR tfm . +.TP +.BI -output-comment \ string +In +.I DVI +mode, use +.I string +for the +.I DVI +file comment instead of the date. This option is ignored +in +.I PDF +mode. +.TP +.BI -output-directory \ directory +Write output files in +.I directory +instead of the current directory. Look up input files in +.I directory +first, the along the normal search path. +.TP +.BI -output-format \ format +Set the output format mode, where +.I format +must be either +.I pdf +or +.IR dvi . +This also influences the set of graphics formats understood by pdf\*(TX. +.TP +.B -parse-first-line +If the first line of the main input file begins with +.I %& +parse it to look for a dump name or a +.B -translate-file +option. +.TP +.B -no-parse-first-line +Disable parsing of the first line of the main input file. +.TP +.BI -progname \ name +Pretend to be program +.IR name . +This affects both the format used and the search paths. +.TP +.B -recorder +Enable the filename recorder. +This leaves a trace of the files opened for input and output +in a file with extension +.IR .fls . +.TP +.B -shell-escape +Enable the +.BI \ewrite18{ command } +construct. The +.I command +can be any shell command. This construct is normally +disallowed for security reasons. +.TP +.B -no-shell-escape +Disable the +.BI \ewrite18{ command } +construct, even if it is enabled in the +.I texmf.cnf +file. +.TP +.B -src-specials +In +.I DVI +mode, insert source specials into the +.I DVI +file. +This option is ignored in +.I PDF +mode. +.TP +.BI -src-specials \ where +In +.I DVI +mode, insert source specials in certain placed of the +.I DVI +file. +.I where +is a comma-separated value list: +.IR cr , +.IR display , +.IR hbox , +.IR math , +.IR par , +.IR parent , +or +.IR vbox . +This option is ignored in +.I PDF +mode. +.TP +.BI -translate-file \ tcxname +Use the +.I tcxname +translation table to set the mapping of input characters and +re-mapping of output characters. +.TP +.BI -default-translate-file \ tcxname +Like +.B -translate-file +except that a +.I %& +line can overrule this setting. +.TP +.B -version +Print version information and exit. +.\"===================================================================== +.SH ENVIRONMENT +See the Kpathsearch library documentation (the `Path specifications' +node) for precise details of how the environment variables are used. +The +.B kpsewhich +utility can be used to query the values of the variables. +.PP +One caveat: In most pdf\*(TX formats, you cannot use ~ in a filename you +give directly to pdf\*(TX, because ~ is an active character, and hence is +expanded, not taken as part of the filename. Other programs, such as +\*(MF, do not have this problem. +.PP +.TP +.B TEXMFOUTPUT +Normally, pdf\*(TX puts its output files in the current directory. If +any output file cannot be opened there, it tries to open it in the +directory specified in the environment variable TEXMFOUTPUT. +There is no default value for that variable. For example, if you say +.I pdftex paper +and the current directory is not writable and TEXMFOUTPUT has +the value +.IR /tmp , +pdf\*(TX attempts to create +.I /tmp/paper.log +(and +.IR /tmp/paper.pdf , +if any output is produced.) TEXMFOUTPUT is also checked for input +files, as \*(TX often generates files that need to be subsequently +read; for input, no suffixes (such as ``.tex'') are added by default, +the input name is simply checked as given. +.TP +.B TEXINPUTS +Search path for +.I \einput +and +.I \eopenin +files. +This should start with ``.'', so +that user files are found before system files. An empty path +component will be replaced with the paths defined in the +.I texmf.cnf +file. For example, set TEXINPUTS to ".:/home/user/tex:" to prepend the +current directory and ``/home/user/tex'' to the standard search path. +.TP +.B TEXFORMATS +Search path for format files. +.TP +.B TEXPOOL +search path for +.B pdftex +internal strings. +.TP +.B TEXEDIT +Command template for switching to editor. The default, usually +.BR vi , +is set when pdf\*(TX is compiled. +.TP +.B TFMFONTS +Search path for font metric +.RI ( .tfm ) +files. +.\"===================================================================== +.SH FILES +The location of the files mentioned below varies from system to +system. Use the +.B kpsewhich +utility to find their locations. +.TP +.I pdftex.pool +Text file containing pdf\*(TX's internal strings. +.TP +.I pdftex.map +Filename mapping definitions. +.TP +.I *.tfm +Metric files for pdf\*(TX's fonts. +.TP +.I *.fmt +Predigested pdf\*(TX format (.\|fmt) files. +.br +.\"===================================================================== +.SH NOTES +Starting with version 1.40, pdf\*(TX incorporates the e-\*(TX +extensions, and pdfe\*(TX is just a copy of pdf\*(TX. See +.BR etex (1). +This manual page is not meant to be exhaustive. The complete +documentation for this version of pdf\*(TX can be found in the +.IR "pdf\*(TX manual" +and the info manual +.IR "Web2C: A TeX implementation" . +.\"===================================================================== +.SH BUGS +This version of pdf\*(TX implements a number of optional extensions. +In fact, many of these extensions conflict to a greater or lesser +extent with the definition of pdf\*(TX. When such extensions are +enabled, the banner printed when pdf\*(TX starts is changed to print +.B pdfTeXk +instead of +.BR pdfTeX . +.PP +This version of pdf\*(TX fails to trap arithmetic overflow when +dimensions are added or subtracted. Cases where this occurs are rare, +but when it does the generated +.I DVI +file will be invalid. Whether a generated +.I PDF +file would be usable is unknown. +.\"===================================================================== +.SH AVAILABILITY +pdf\*(TX is available for a large variety of machine architectures +and operation systems. +pdf\*(TX is part of all major \*(TX distributions. +.P +Information on how to get pdf\*(TX and related information +is available at the +.B http://www.pdftex.org +.IR "pdf\*(TX" +web site. +.P +The following pdfe\*(TX related mailing list is available: +.BR pdftex@tug.org . +This is a mailman list; +to subscribe send a message containing +.I subscribe +to +.BR pdftex-request@tug.org . +A web interface and list archives can be found at the +.B "http://lists.tug.org/pdftex" +mailing list web site. +.\"===================================================================== +.SH "SEE ALSO" +.BR epstopdf (1), +.BR etex (1), +.BR latex (1), +.BR mptopdf (1), +.BR tex (1), +.BR mf (1). +http://tug.org/applications/pdftex, http://tug.org/web2c. +.\"===================================================================== +.SH AUTHORS +The primary authors of pdf\*(TX are Han The Thanh, Petr Sojka, +Jiri Zlatuska, and Peter Breitenlohner (e\*(TX). +.PP +\*(TX was designed by Donald E. Knuth, +who implemented it using his \*(WB system for Pascal programs. +It was ported to Unix at Stanford by Howard Trickey, and +at Cornell by Pavel Curtis. +The version now offered with the Unix \*(TX distribution is that +generated by the \*(WB to C system +.RB ( web2c ), +originally written by Tomas Rokicki and Tim Morgan. +.PP +The enc\*(TX extensions were written by Petr Olsak. +.\" vim: syntax=nroff diff --git a/Master/texmf-dist/doc/man/man1/pdftex.man1.pdf b/Master/texmf-dist/doc/man/man1/pdftex.man1.pdf Binary files differnew file mode 100644 index 00000000000..e66da00c779 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdftex.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/pdftosrc.1 b/Master/texmf-dist/doc/man/man1/pdftosrc.1 new file mode 100644 index 00000000000..847f912e5f3 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdftosrc.1 @@ -0,0 +1,237 @@ +.\" Process this file with +.\" groff -man -Tascii pdftosrc.1 +.\" +.\" $Id: pdftosrc.1,v 1.5 2006/12/22 23:46:23 hhenkel Exp $ +.\" +.TH pdftosrc 1 "23 December 2006" "User Manuals" +.SH NAME +pdftosrc \- extract source file or stream from PDF file +.SH SYNOPSIS +.B pdftosrc +.I PDF-file +.RI [ stream-object-number ] +.SH DESCRIPTION +If only +.I PDF-file +is given as argument, +.B pdftosrc +extracts the embedded source file +from the first found stream object +with /Type /SourceFile within the +.I PDF-file +and writes it to a file with the name /SourceName +as defined in that PDF stream object +(see application example below). + +If both +.I PDF-file +and +.I stream-object-number +are given as arguments, and +.I stream-object-number +is positive, +.B pdftosrc +extracts and uncompresses the PDF stream of the object +given by its +.I stream-object-number +from the +.I PDF-file +and writes it to a file named +.IR PDF-file . stream-object-number +with the ending +.B .pdf +or +.B .PDF +stripped from the original +.I PDF-file +name. + +A special case is related to XRef object streams that are part +of the PDF standard from PDF-1.5 onward: +If +.I stream-object-number +equals -1, +then +.B pdftosrc +decompresses the XRef stream from the PDF file and writes it +in human-readable PDF cross-reference table format to a file named +.IB PDF-file .xref +(these XRef streams can not be extracted just by giving their object number). + +In any case +an existing file with the output file name will be overwritten. +.SH OPTIONS +None. +.SH FILES +Just the executable +.BR pdftosrc . +.SH ENVIRONMENT +None. +.SH DIAGNOSTICS +At success the exit code of +.B pdftosrc +is 0, else 1. + +All messages go to stderr. +At program invocation, +.B pdftosrc +issues the current version number of the program +.BR xpdf , +on which +.B pdftosrc +is based: + +.RS +pdftosrc version 3.01 + +.RE +When +.B pdftosrc +was successful with the output file writing, +one of the following messages will be issued: + +.RS +Source file extracted to +.I source-file-name + +.RE +or + +.RS +Stream object extracted to +.IR PDF-file . stream-object-number + +.RE +or + +.RS +Cross-reference table extracted to +.IR PDF-file .xref + +.RE + +.RE +When the object given by the +.I stream-object-number +does not contain a stream, +.B pdftosrc +issues the following error message: + +.RS +Not a Stream object + +.RE +When the +.I PDF-file +can't be opened, the error message is: + +.RS +Error: Couldn't open file +.RI ' PDF-file '. + +.RE +When +.B pdftosrc +encounters an invalid PDF file, +the error message (several lines) is: + +.RS +Error: May not be a PDF file (continuing anyway) +.RE +.RS +(more lines) +.RE +.RS +Invalid PDF file + +.RE +There are also more error messages from +.B pdftosrc +for various kinds of broken PDF files. +.SH NOTES +An embedded source file will be written out unchanged, +i. e. it will not be uncompressed in this process. + +Only the stream of the object will be written, +i. e. not the dictionary of that object. + +Knowing which +.I stream-object-number +to query requires information about the PDF file +that has to be gained elsewhere, +e. g. by looking into the PDF file with an editor. + +The stream extraction capabilities of +.B pdftosrc +(e. g. regarding understood PDF versions and filter types) +follow the capabilities of the underlying +.B xpdf +program version. + +Currently the generation number of the stream object +is not supported. +The default value 0 (zero) is taken. + +The wording +.I stream-object-number +has nothing to do with the `object streams' introduced +by the Adobe PDF Reference, +5th edition, version 1.6. +.SH EXAMPLES +When using pdftex, +a source file can be embedded into some +.I PDF-file +by using pdftex primitives, +as illustrated by the following example: + +\\immediate\\pdfobj +.RE + stream attr {/Type /SourceFile /SourceName (myfile.zip)} +.RS +.RE + file{myfile.zip} +.RS +.RE +\\pdfcatalog{/SourceObject \\the\\pdflastobj\\space 0 R} + +Then this zip file can be extracted from the +.I PDF-file +by calling +.B pdftosrc +.IR PDF-file . +.SH BUGS +Not all embedded source files will be extracted, +only the first found one. + +Email bug reports to +.B pdftex@tug.org. +.SH SEE ALSO +.BR xpdf (1), +.BR pdfimages (1), +.BR pdftotext (1), +.BR pdftex (1), +.SH AUTHORS +.B pdftosrc +written by Han The Thanh, using +.B xpdf +functionality from Derek Noonburg. + +Man page written by Hartmut Henkel. +.SH COPYRIGHT +Copyright (c) 1996-2006 Han The Thanh, <thanh@pdftex.org> + +This file is part of pdfTeX. + +pdfTeX 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 2 of the License, or +(at your option) any later version. + +pdfTeX 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 pdfTeX; if not, write to the Free Software +Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA diff --git a/Master/texmf-dist/doc/man/man1/pdftosrc.man1.pdf b/Master/texmf-dist/doc/man/man1/pdftosrc.man1.pdf Binary files differnew file mode 100644 index 00000000000..522d4fb7f05 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pdftosrc.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/perltex.1 b/Master/texmf-dist/doc/man/man1/perltex.1 new file mode 100644 index 00000000000..28c0508e680 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/perltex.1 @@ -0,0 +1,280 @@ +.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "PERLTEX 1" +.TH PERLTEX 1 "2010-07-10" "v2.1" " " +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +perltex \- enable LaTeX macros to be defined in terms of Perl code +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +perltex +[\fB\-\-help\fR] +[\fB\-\-latex\fR=\fIprogram\fR] +[\fB\-\-\fR[\fBno\fR]\fBsafe\fR] +[\fB\-\-permit\fR=\fIfeature\fR] +[\fB\-\-makesty\fR] +[\fIlatex options\fR] +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +LaTeX \*(-- through the underlying TeX typesetting system \*(-- produces +beautifully typeset documents but has a macro language that is +difficult to program. In particular, support for complex string +manipulation is largely lacking. Perl is a popular general-purpose +programming language whose forte is string manipulation. However, it +has no typesetting capabilities whatsoever. +.PP +Clearly, Perl's programmability could complement LaTeX's typesetting +strengths. \fBperltex\fR is the tool that enables a symbiosis between +the two systems. All a user needs to do is compile a LaTeX document +using \fBperltex\fR instead of \fBlatex\fR. (\fBperltex\fR is actually a +wrapper for \fBlatex\fR, so no \fBlatex\fR functionality is lost.) If the +document includes a \f(CW\*(C`\eusepackage{perltex}\*(C'\fR in its preamble, then +\&\f(CW\*(C`\eperlnewcommand\*(C'\fR and \f(CW\*(C`\eperlrenewcommand\*(C'\fR macros will be made +available. These behave just like LaTeX's \f(CW\*(C`\enewcommand\*(C'\fR and +\&\f(CW\*(C`\erenewcommand\*(C'\fR except that the macro body contains Perl code instead +of LaTeX code. +.SH "OPTIONS" +.IX Header "OPTIONS" +\&\fBperltex\fR accepts the following command-line options: +.IP "\fB\-\-help\fR" 4 +.IX Item "--help" +Display basic usage information. +.IP "\fB\-\-latex\fR=\fIprogram\fR" 4 +.IX Item "--latex=program" +Specify a program to use instead of \fBlatex\fR. For example, +\&\f(CW\*(C`\-\-latex=pdflatex\*(C'\fR would typeset the given document using +\&\fBpdflatex\fR instead of ordinary \fBlatex\fR. +.IP "\fB\-\-\fR[\fBno\fR]\fBsafe\fR" 4 +.IX Item "--[no]safe" +Enable or disable sandboxing. With the default of \fB\-\-safe\fR, +\&\fBperltex\fR executes the code from a \f(CW\*(C`\eperlnewcommand\*(C'\fR or +\&\f(CW\*(C`\eperlrenewcommand\*(C'\fR macro within a protected environment that +prohibits ``unsafe'' operations such as accessing files or executing +external programs. Specifying \fB\-\-nosafe\fR gives the LaTeX document +\&\fIcarte blanche\fR to execute any arbitrary Perl code, including that +which can harm the user's files. See Safe for more information. +.IP "\fB\-\-permit\fR=\fIfeature\fR" 4 +.IX Item "--permit=feature" +Permit particular Perl operations to be performed. The \fB\-\-permit\fR +option, which can be specified more than once on the command line, +enables finer-grained control over the \fBperltex\fR sandbox. See +Opcode for more information. +.IP "\fB\-\-makesty\fR" 4 +.IX Item "--makesty" +Generate a LaTeX style file called \fInoperltex.sty\fR. Replacing the +document's \f(CW\*(C`\eusepackage{perltex}\*(C'\fR line with \f(CW\*(C`\eusepackage{noperltex}\*(C'\fR +produces the same output but does not require PerlTeX, making the +document suitable for distribution to people who do not have PerlTeX +installed. The disadvantage is that \fInoperltex.sty\fR is specific to +the document that produced it. Any changes to the document's PerlTeX +macro definitions or macro invocations necessitates rerunning +\&\fBperltex\fR with the \fB\-\-makesty\fR option. +.PP +These options are then followed by whatever options are normally +passed to \fBlatex\fR (or whatever program was specified with +\&\f(CW\*(C`\-\-latex\*(C'\fR), including, for instance, the name of the \fI.tex\fR file to +compile. +.SH "EXAMPLES" +.IX Header "EXAMPLES" +In its simplest form, \fBperltex\fR is run just like \fBlatex\fR: +.PP +.Vb 1 +\& perltex myfile.tex +.Ve +.PP +To use \fBpdflatex\fR instead of regular \fBlatex\fR, use the \fB\-\-latex\fR +option: +.PP +.Vb 1 +\& perltex \-\-latex=pdflatex myfile.tex +.Ve +.PP +If LaTeX gives a ``\f(CW\*(C`trapped by operation mask\*(C'\fR'' error and you trust +the \fI.tex\fR file you're trying to compile not to execute malicious +Perl code (e.g., because you wrote it yourself), you can disable +\&\fBperltex\fR's safety mechansisms with \fB\-\-nosafe\fR: +.PP +.Vb 1 +\& perltex \-\-nosafe myfile.tex +.Ve +.PP +The following command gives documents only \fBperltex\fR's default +permissions (\f(CW\*(C`:browse\*(C'\fR) plus the ability to open files and invoke the +\&\f(CW\*(C`time\*(C'\fR command: +.PP +.Vb 2 +\& perltex \-\-permit=:browse \-\-permit=:filesys_open +\& \-\-permit=time myfile.tex +.Ve +.SH "ENVIRONMENT" +.IX Header "ENVIRONMENT" +\&\fBperltex\fR honors the following environment variables: +.IP "\s-1PERLTEX\s0" 4 +.IX Item "PERLTEX" +Specify the filename of the LaTeX compiler. The LaTeX compiler +defaults to ``\f(CW\*(C`latex\*(C'\fR''. The \f(CW\*(C`PERLTEX\*(C'\fR environment variable +overrides this default, and the \fB\-\-latex\fR command-line option (see +\&\*(L"\s-1OPTIONS\s0\*(R") overrides that. +.SH "FILES" +.IX Header "FILES" +While compiling \fIjobname.tex\fR, \fBperltex\fR makes use of the following +files: +.IP "\fIjobname.lgpl\fR" 4 +.IX Item "jobname.lgpl" +log file written by Perl; helpful for debugging Perl macros +.IP "\fIjobname.topl\fR" 4 +.IX Item "jobname.topl" +information sent from LaTeX to Perl +.IP "\fIjobname.frpl\fR" 4 +.IX Item "jobname.frpl" +information sent from Perl to LaTeX +.IP "\fIjobname.tfpl\fR" 4 +.IX Item "jobname.tfpl" +``flag'' file whose existence indicates that \fIjobname.topl\fR contains +valid data +.IP "\fIjobname.ffpl\fR" 4 +.IX Item "jobname.ffpl" +``flag'' file whose existence indicates that \fIjobname.frpl\fR contains +valid data +.IP "\fIjobname.dfpl\fR" 4 +.IX Item "jobname.dfpl" +``flag'' file whose existence indicates that \fIjobname.ffpl\fR has been +deleted +.IP "\fInoperltex\-#.tex\fR" 4 +.IX Item "noperltex-#.tex" +file generated by \fInoperltex.sty\fR for each PerlTeX macro invocation +.SH "NOTES" +.IX Header "NOTES" +\&\fBperltex\fR's sandbox defaults to what Opcode calls ``\f(CW\*(C`:browse\*(C'\fR''. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fIlatex\fR\|(1), \fIpdflatex\fR\|(1), \fIperl\fR\|(1), \fISafe\fR\|(3pm), \fIOpcode\fR\|(3pm) +.SH "AUTHOR" +.IX Header "AUTHOR" +Scott Pakin, \fIscott+pt@pakin.org\fR diff --git a/Master/texmf-dist/doc/man/man1/perltex.man1.pdf b/Master/texmf-dist/doc/man/man1/perltex.man1.pdf Binary files differnew file mode 100644 index 00000000000..1aab77154c5 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/perltex.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/pfb2pfa.1 b/Master/texmf-dist/doc/man/man1/pfb2pfa.1 new file mode 100644 index 00000000000..f81abb8ed2f --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pfb2pfa.1 @@ -0,0 +1,19 @@ +.TH PFB2PFA 1 TeX +.SH NAME +pfb2pfa \- convert a type1 pfb file (binary MSDOS) into a pfa (ASCII) +.SH SYNOPSIS +pfb2pfa [-v] pfbfile [pfafile] +.SH DESCRIPTION +Program converts a binary MSDOS representation for a type1 PostScript +font into a readable ASCII version. The MSDOS newline (\\r) is converted +into the UNIX newline (\\n). The output is written in a file whose name +is the name that is provided on the command line or the basename of the +input file plus extension ".pfa". +.PP +With the -v option you get some information about what the +program is doing. +.SH AUTHOR +.nf +Piet Tutelaers <rcpt@urc.tue.nl> + + diff --git a/Master/texmf-dist/doc/man/man1/pfb2pfa.man1.pdf b/Master/texmf-dist/doc/man/man1/pfb2pfa.man1.pdf Binary files differnew file mode 100644 index 00000000000..add89aa8a73 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pfb2pfa.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/pk2bm.1 b/Master/texmf-dist/doc/man/man1/pk2bm.1 new file mode 100644 index 00000000000..5b9c6d599db --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pk2bm.1 @@ -0,0 +1,39 @@ +.TH PK2BM 1 TeX +.SH NAME +pk2bm \- create a bitmap from a TeX pkfont +.SH SYNOPSIS: +pk2bm [-bh] [-W\fIwidth\fP] [-H\fIheight\fP] -c\fIchar\fP pkfont + +pk2bm [-bh] [-W\fIwidth\fP] [-H\fIheight\fP] -o\fIoctchar\fP pkfont +.SH DESCRIPTION +This program generates a bitmap (ASCII file) which can be used +to create X11 applications. The bitmap file consists of all pixels +of the specified character (via the -c or -o option) from +the given pkfont. The format is described in bitmap(X11). +.PP +The pkfont is a packed fontfile generated by gftopk(TeX) from a +gffont. A gffont is the output of METAFONT a program to design fonts +in a device independant way. +.PP +With the -b flag a bitmap is generated in which all black pixels are +drawn as a `*' and all white bits as a `.'. With the -h flag a +hexadecimal bitmap dump is generated. +.PP +The -W and/or -H options can be used to create a bitmap of +respectivally `width' and `height' pixels. The pk-bitmap will in +this case be centered according to these new dimensions. +.PP +The output is written to the standard output. +.SH SEE ALSO +.nf +`METAFONT', Donald Knuth. +`The PKtype processor', belonging to the METAFONTware. +bitmap(X11), +gftopk(TeX), +pktype(TeX), +ps2pk(1) + +.SH AUTHOR +.nf +Piet Tutelaers <rcpt@urc.tue.nl> + diff --git a/Master/texmf-dist/doc/man/man1/pk2bm.man1.pdf b/Master/texmf-dist/doc/man/man1/pk2bm.man1.pdf Binary files differnew file mode 100644 index 00000000000..1e2e52f0319 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pk2bm.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/pkfix-helper.1 b/Master/texmf-dist/doc/man/man1/pkfix-helper.1 new file mode 100644 index 00000000000..c0c170fdbe8 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pkfix-helper.1 @@ -0,0 +1,516 @@ +.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "PKFIX-HELPER 1" +.TH PKFIX-HELPER 1 "2011-06-11" "v1.4" " " +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +pkfix\-helper \- preprocess dvips\-produced PostScript documents before passing them to pkfix +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +pkfix-helper +[\fB\-\-help\fR] +[\fB\-\-verbose\fR] +[\fB\-\-force\fR=\fIname\fR=\fIfontspec\fR] +[\fB\-\-ps\fR=\fIfilename.ps\fR] +[\fB\-\-tex\fR=\fIfilename.tex\fR] +[\fB\-\-cache\fR=\fIfilename\fR] +[\fB\-\-include\fR=\fIfontspec\fR] +[\fB\-\-exclude\fR=\fIregexp\fR] +[\fB\-\-keep\fR=\fIfontspec\fR] +[\fB\-\-quiet\fR] +[\fB\-\-no\-repeats\fR] +[\fB\-\-spp\fR=\fInumber\fR] +[\fIinput.ps\fR [\fIoutput.ps\fR]] +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +.SS "Motivation" +.IX Subsection "Motivation" +PostScript documents created with old versions of \fBdvips\fR almost +invariably utilize bitmapped (PostScript Type\ 3) fonts. The +problem with bitmapped fonts is that they target a specific device +resolution; a PostScript file produced using 300\ \s-1DPI\s0 fonts will +look grainy on a 600\ \s-1DPI\s0 printer. Even worse, \fIall\fR bitmapped +fonts look grainy when zoomed in on screen. The solution is to use +vector (PostScript Type\ 1) fonts, which are resolution-independent +and appear crisp at any size or scale. +.PP +While it is no longer difficult to configure \fBdvips\fR to use vector +fonts, it is not always possible to rerun \fBdvips\fR on an old \fI.dvi\fR +file. The \fI.dvi\fR file and document source may have been lost; or, +the source may no longer compile because packages it depends upon may +no longer be available. +.PP +Heiko Oberdiek's \fBpkfix\fR script replaces bitmapped fonts in +\&\fBdvips\fR\-produced PostScript files with the corresponding vector +fonts. It works by parsing the PostScript comments with which +\&\fBdvips\fR surrounds bitmapped-font definitions. For example, a font +definition beginning with the comment \f(CW\*(C`%DVIPSBitmapFont: Fi cmss10 11 +28\*(C'\fR and ending with a matching \f(CW%EndDVIPSBitmapFont\fR is known to +define font \f(CW\*(C`Fi\*(C'\fR as \f(CW\*(C`cmss10\*(C'\fR (Computer Modern Sans Serif at a design +size of 10\ points) scaled to \f(CW11\fR\ points. Only the \f(CW28\fR +characters actually used by the document are defined. \fBpkfix\fR then +replaces the font definition with one that defines \f(CW\*(C`Fi\*(C'\fR using the +same set of characters but taken from the \fIcmss10.pfb\fR vector font +file. +.PP +Unfortunately, \fBpkfix\fR works only with versions of \fBdvips\fR newer +than v5.58 (ca.\ 1996). Naturally, the older a PostScript document, +the less likely its sources still exist and can still be recompiled. +Older versions of \fBdvips\fR lack \f(CW%DVIPSBitmapFont\fR comments and +various other PostScript comments on which \fBpkfix\fR relies. Without +PostScript comments to guide it, \fBpkfix\fR is unable to determine which +vector fonts correspond with which bitmapped fonts. +.SS "Overview" +.IX Subsection "Overview" +The \fBpkfix-helper\fR script is a preprocessor for \fBpkfix\fR that +attempts to determine the association between each document-font name +(e.g.,\ \f(CW\*(C`Fi\*(C'\fR) in a PostScript file and the original font (e.g.,\ \f(CW\*(C`cmss10\*(C'\fR) and fonts size (e.g., \f(CW11\fR\ points). It then +fabricates the PostScript comments that \fBpkfix\fR expects to see so +that \fBpkfix\fR can do its job. +.PP +\&\fBpkfix-helper\fR works by comparing every document font against every +\&\fI.tfm\fR font file it knows about (assuming that each such font has a +corresponding \fI.pfb\fR vector version) and selecting the best matching +\&\fI.tfm\fR file for every document font. \fBpkfix-helper\fR has access only +to the widths of characters and only to those characters actually used +in the document. Also, the program recognizes only a limited set of +the most popular \fI.tfm\fR files and scaling factors. Consequently, the +comparison is imperfect and \fBpkfix-helper\fR may attribute an incorrect +font to a given name. Fonts comprising only one or two characters +actually used in a document are particularly problematic for +\&\fBpkfix-helper\fR because many fonts may be near-enough matches to fool +the problem. +.PP +\&\fBpkfix-helper\fR is designed so that a user can guide the +font-selection process by manually designating matching fonts. With a +modicum of diligence and patience a user can correct any mismatched +fonts and help the program provide proper input to \fBpkfix\fR. +.SH "OPTIONS" +.IX Header "OPTIONS" +\&\fBpkfix-helper\fR accepts on the command line the filename of a +PostScript document to process (with the default being the standard +input device) and the filename of a modified PostScript document to +create (with the default being the standard output device). The +program also accepts the following command-line options: +.SS "Frequently Used Options" +.IX Subsection "Frequently Used Options" +.IP "\fB\-h\fR, \fB\-\-help\fR" 4 +.IX Item "-h, --help" +Display usage information and exit. The \fB\-\-verbose\fR and \fB\-\-quiet\fR +options can be used to increase and decrease the amount of information +presented. +.IP "\fB\-v\fR, \fB\-\-verbose\fR" 4 +.IX Item "-v, --verbose" +Increase the amount of status information that \fBpkfix-helper\fR +displays as it runs. Additional instances of \fB\-\-verbose\fR on the +command line further increase the program's verbosity. By default, +only major operations are displayed. A single \fB\-\-verbose\fR +additionally displays information about individual font comparisons. +A second \fB\-\-verbose\fR additionally displays details about some of the +program's internal operations. +.IP "\fB\-f\fR \fIname\fR=\fIfontspec\fR, \fB\-\-force\fR=\fIname\fR=\fIfontspec\fR" 4 +.IX Item "-f name=fontspec, --force=name=fontspec" +Force \fBpkfix-helper\fR to associate a specific font with a given font +name appearing the document. \fIname\fR is a two-character \fBdvips\fR font +name such as \f(CW\*(C`Fa\*(C'\fR. \fIfontspec\fR is a font specification such as +\&\f(CW\*(C`cmmi8\*(C'\fR or \f(CW\*(C`cmsy10\ @\ 1.1X\*(C'\fR. An asterisk used in the name of the +base font (e.g.,\ \f(CW\*(C`cmti*\*(C'\fR) will automatically try all integral test +font sizes from 5 to 17 points (\f(CW\*(C`cmti5\*(C'\fR, \f(CW\*(C`cmti6\*(C'\fR,\ ..., +\&\f(CW\*(C`cmti17\*(C'\fR). An asterisk used as a scale value (e.g.,\ \f(CW\*(C`cmsy10\ @\ *\*(C'\fR) will be replaced by the scale value that gives the best match to +the original font's metrics. The \fB\-\-force\fR option can be specified +repeatedly on the command line. +.IP "\fB\-p\fR \fIfilename.ps\fR, \fB\-\-ps\fR=\fIfilename.ps\fR" 4 +.IX Item "-p filename.ps, --ps=filename.ps" +Create a PostScript file called \fIfilename.ps\fR that shows the \fBdvips\fR +name and a font sample of every font used by the input document. +.IP "\fB\-t\fR \fIfilename.tex\fR, \fB\-\-tex\fR=\fIfilename.tex\fR" 4 +.IX Item "-t filename.tex, --tex=filename.tex" +Create a Plain TeX file called \fIfilename.tex\fR that shows the \fBdvips\fR +name and a font sample of every font that \fBpkfix-helper\fR used in the +output document. +.SS "Infrequently Used Options" +.IX Subsection "Infrequently Used Options" +.IP "\fB\-C\fR \fIfilename\fR, \fB\-\-cache\fR=\fIfilename\fR" 4 +.IX Item "-C filename, --cache=filename" +Speed up \s-1TFM\s0 file processing by caching character metrics into file +\&\fIfilename\fR. On some systems it takes a long time to read a \s-1TFM\s0 file, +spawn \fItftopl\fR to convert it to \s-1PL\s0 format, and extract from the \s-1PL\s0 +data the metrics for each character. The first time \fB\-\-cache\fR is +specified, \fBpkfix-helper\fR proceeds as normal then writes all of the +extracted character metrics to \fIfilename\fR. On subsequent runs in +which \fB\-\-cache\fR=\fIfilename\fR is specified, \fBpkfix-helper\fR reads the +previously extracted metrics from \fIfilename\fR, going through the +\&\fItftopl\fR\-based process only for \s-1TFM\s0 files that were not previously +encountered. +.IP "\fB\-q\fR, \fB\-\-quiet\fR" 4 +.IX Item "-q, --quiet" +Instruct \fBpkfix-helper\fR to produce no output during its run except +for fatal error messages. +.IP "\fB\-1\fR, \fB\-\-no\-repeats\fR" 4 +.IX Item "-1, --no-repeats" +Prevent \fBpkfix-helper\fR from associating the same \fIfontspec\fR with +more than one \fBdvips\fR font name. +.IP "\fB\-i\fR \fIfontspec\fR, \fB\-\-include\fR=\fIfontspec\fR" 4 +.IX Item "-i fontspec, --include=fontspec" +Add \fIfontspec\fR to the list of font specifications against which +\&\fBpkfix-helper\fR compares \fIevery\fR document font. (In contrast, +\&\fB\-\-force\fR designates a font specification to use only for a +\&\fIspecific\fR document font.) The \fB\-\-include\fR option can be specified +repeatedly on the command line. +.IP "\fB\-x\fR \fIregexp\fR, \fB\-\-exclude\fR=\fIregexp\fR" 4 +.IX Item "-x regexp, --exclude=regexp" +Remove all font specifications matching regular expression \fIregexp\fR +from \fBpkfix-helper\fR's list of known fonts. The \fB\-\-exclude\fR option +can be specified repeatedly on the command line. +.IP "\fB\-k\fR \fIfontspec\fR, \fB\-\-keep\fR=\fIfontspec\fR" 4 +.IX Item "-k fontspec, --keep=fontspec" +Do not substitute a vector font for bitmapped font \fIfontspec\fR (\f(CW\*(C`Fa\*(C'\fR, +\&\f(CW\*(C`Fb\*(C'\fR, etc.). This is useful when converting documents that use +obscure bitmapped fonts for which there is no vector equivalent. For +example, it was somewhat common in the past to include graphics such +as university or corporate logos into a document by converting the +bitmapped image into a single-character font and using that font in +LaTeX. \fB\-\-keep\fR prevents such fonts from being replaced. The +\&\fB\-\-keep\fR option can be specified repeatedly on the command line. +.IP "\fB\-a\fR, \fB\-\-any\-scale\fR" 4 +.IX Item "-a, --any-scale" +Allow any value to be used to scale a font when "\f(CW\*(C`*\*(C'\fR" is specified as +the scale factor. Normally, \fBpkfix-helper\fR considers only integer +multiples of 0.1 that are greater than or equal to 1.0 (i.e., +\&\fIfontname\fR\f(CW@1X\fR, \f(CW\*(C`@1.1X\*(C'\fR, \f(CW\*(C`@1.2X\*(C'\fR, \f(CW\*(C`@1.3X\*(C'\fR, etc.). +.IP "\fB\-s\fR, \fB\-\-spp\fR" 4 +.IX Item "-s, --spp" +Specify the number of font samples per page to print to the files +indicated using the \fB\-\-ps\fR and \fB\-\-tex\fR options. The default +value,\ 25, should work well in most circumstances. +.SH "DIAGNOSTICS" +.IX Header "DIAGNOSTICS" +.ie n .IP """Best match for \f(CIname\f(CW is rather poor""" 4 +.el .IP "\f(CWBest match for \f(CIname\f(CW is rather poor\fR" 4 +.IX Item "Best match for name is rather poor" +The best font \fBpkfix-helper\fR found for \fBdvips\fR font name \fIname\fR has +a mismatch value greater than or equal to\ 1.0. (The mismatch value +is the sum of the squares of the difference between the character +widths of a document font and a potential replacement font.) Use the +\&\fB\-\-force\fR option to designate an alternative replacement font or +scaling amount. +.SH "EXAMPLES" +.IX Header "EXAMPLES" +For the purpose of the following examples, assume that \fIoldfile.ps\fR +is the name of a PostScript file produced by an old version of +\&\fBdvips\fR and utilizing at least one bitmapped font. It's always worth +verifying that \fBpkfix\fR can't convert the file on its own: +.PP +.Vb 3 +\& $ pkfix oldfile.ps newfile.ps +\& PKFIX 1.3, 2005/02/25 \- Copyright (c) 2001, 2005 by Heiko Oberdiek. +\& ==> no fonts converted +.Ve +.PP +(Alternatively \fBpkfix\fR may issue an error message such as \f(CW\*(C`!!! +Error: Parse error (@start parameters)!\*(C'\fR.) Only when \fBpkfix\fR can't +replace bitmapped fonts with vector fonts is \fBpkfix-helper\fR needed. +In its simplest form, \fBpkfix-helper\fR takes the name of an input file +(\fIoldfile.ps\fR in this example) and the name of an output file +(\fIpkfix\-oldfile.ps\fR), which will have the same contents as the input +file but serve as suitable input for \fBpkfix\fR: +.PP +.Vb 10 +\& $ pkfix\-helper oldfile.ps pkfix\-oldfile.ps +\& Reading oldfile.ps ... done. +\& Number of Type 3 fonts encountered: 10 +\& Bitmapped fonts are typeset at 600 DPI. +\& Finding character widths ... done. +\& Reading TFM files ... done (103 TFMs in 193 scaling variations). +\& Matching fonts: +\& Processing Fi ... done (cmr10 @ 1X, mismatch=0.11683). +\& Processing Fa ... done (cmti10 @ 1X, mismatch=0.08892). +\& Processing Fb ... done (cmr8 @ 1X, mismatch=0.07133). +\& Processing Ff ... done (cmbx12 @ 1.2X, mismatch=0.02948). +\& Processing Fh ... done (cmtt10 @ 1X, mismatch=0.06895). +\& Processing Fd ... done (cmmi10 @ 1X, mismatch=0.03966). +\& Processing Fj ... done (cmbx12 @ 1X, mismatch=0.03972). +\& Processing Fe ... done (cmbx10 @ 1X, mismatch=0.00762). +\& Processing Fg ... done (cmsy10 @ 1X, mismatch=0.00875). +\& Processing Fc ... done (cmr6 @ 1X, mismatch=0.00284). +\& +\& $ pkfix pkfix\-oldfile.ps newfile.ps +\& PKFIX 1.3, 2005/02/25 \- Copyright (c) 2001, 2005 by Heiko Oberdiek. +\& *** Font conversion: \`cmti10\*(Aq \-> \`CMTI10\*(Aq. +\& *** Font conversion: \`cmr8\*(Aq \-> \`CMR8\*(Aq. +\& *** Font conversion: \`cmr6\*(Aq \-> \`CMR6\*(Aq. +\& *** Font conversion: \`cmmi10\*(Aq \-> \`CMMI10\*(Aq. +\& *** Font conversion: \`cmbx10\*(Aq \-> \`CMBX10\*(Aq. +\& *** Font conversion: \`cmbx12\*(Aq \-> \`CMBX12\*(Aq. +\& *** Font conversion: \`cmsy10\*(Aq \-> \`CMSY10\*(Aq. +\& *** Font conversion: \`cmtt10\*(Aq \-> \`CMTT10\*(Aq. +\& *** Font conversion: \`cmr10\*(Aq \-> \`CMR10\*(Aq. +\& *** Font conversion: \`cmbx12\*(Aq \-> \`CMBX12\*(Aq. +\& *** Merging font \`CMBX12\*(Aq (2). +\& ==> 10 converted fonts. +\& ==> 1 merged font. +.Ve +.PP +Although \fBpkfix-helper\fR tries to automate as much as possible the +font-detection process, some fonts will invariably be incorrectly +identified. The program outputs a warning message if it \fIknows\fR a +match is bad but the lack of a warning message does not necessarily +indicate that \fBpkfix-helper\fR did a good job. It is therefore +strongly recommended that the user produce \*(L"before\*(R" and \*(L"after\*(R" font +sheets: +.PP +.Vb 2 +\& $ pkfix\-helper \-q oldfile.ps pkfix\-oldfile.ps \e +\& \-\-ps=oldfonts.ps \-\-tex=newfonts.tex +\& +\& $ tex newfonts.tex +\& This is TeX, Version 3.14159 (Web2C 7.4.5) +\& (./newfonts.tex [1] ) +\& Output written on newfonts.dvi (1 page, 1292 bytes). +\& Transcript written on newfonts.log. +\& +\& $ dvips newfonts.dvi \-o newfonts.ps +\& This is dvips(k) 5.92b Copyright 2002 Radical Eye Software (www.radicaleye.com) +\& \*(Aq TeX output 2006.06.11:1636\*(Aq \-> newfonts.ps +\& <texc.pro><8r.enc><texps.pro>. <cmr6.pfb><cmsy10.pfb><cmbx10.pfb><cmbx12.pfb> +\& <cmmi10.pfb><cmtt10.pfb><cmr8.pfb><cmti10.pfb><cmr10.pfb>[1] +.Ve +.PP +After running the preceding commands, \fIoldfonts.ps\fR shows samples of +the fonts in \fIoldfile.ps\fR and \fInewfonts.ps\fR shows samples of the +replacement fonts that \fBpkfix-helper\fR used to produce +\&\fIpkfix\-oldfile.ps\fR. Print \fIoldfonts.ps\fR and \fInewfonts.ps\fR and +compare them carefully for incorrect fonts and sizes. +.PP +Suppose that the choice of \f(CW\*(C`cmbx12 @ 1.2X\*(C'\fR for font \f(CW\*(C`Ff\*(C'\fR looks +wrong; say the characters look taller in \fIoldfonts.ps\fR than in +\&\fInewfonts.ps\fR. This is where the trial-and-error stage begins. +Let's hypothesize that \f(CW\*(C`cmb12\*(C'\fR is a better match than \f(CW\*(C`cmbx12\*(C'\fR but +we don't know how much to scale the font. Fortunately, +\&\fBpkfix-helper\fR allows \f(CW\*(C`*\*(C'\fR to be used as a scaling factor to tell the +program to automatically detect an optimal scaling factor, even if +doing so means choosing a nonstandard font size: +.PP +.Vb 7 +\& $ pkfix\-helper oldfile.ps pkfix\-oldfile.ps \-\-force="Ff=cmb12 @ *" +\& Reading oldfile.ps ... done. +\& Number of Type 3 fonts encountered: 10 +\& Bitmapped fonts are typeset at 600 DPI. +\& Finding character widths ... done. +\& Reading TFM files ... failed. +\& pkfix\-helper: Unable to process user\-specified TFM file "cmb12" +.Ve +.PP +Oops, it looks like we don't have a \fIcmb12.tfm\fR file on our system. +Let's try scaling up \fIcmb10.tfm\fR instead: +.PP +.Vb 10 +\& $ pkfix\-helper oldfile.ps pkfix\-oldfile.ps \-\-force="Ff=cmb10 @ *" +\& Reading oldfile.ps ... done. +\& Number of Type 3 fonts encountered: 10 +\& Bitmapped fonts are typeset at 600 DPI. +\& Finding character widths ... done. +\& Reading TFM files ... done (103 TFMs in 193 scaling variations). +\& Matching fonts: +\& Processing Fi ... done (cmr10 @ 1X, mismatch=0.11683). +\& Processing Fa ... done (cmti10 @ 1X, mismatch=0.08892). +\& Processing Fb ... done (cmr8 @ 1X, mismatch=0.07133). +\& Processing Ff ... done (cmb10 @ 1.5X, mismatch=0.00035). +\& Processing Fh ... done (cmtt10 @ 1X, mismatch=0.06895). +\& Processing Fd ... done (cmmi10 @ 1X, mismatch=0.03966). +\& Processing Fj ... done (cmbx12 @ 1X, mismatch=0.03972). +\& Processing Fe ... done (cmbx10 @ 1X, mismatch=0.00762). +\& Processing Fg ... done (cmsy10 @ 1X, mismatch=0.00875). +\& Processing Fc ... done (cmr6 @ 1X, mismatch=0.00284). +.Ve +.PP +The match has definitely improved, although 15\ pt. is certainly an +odd size for a font. Then again, many documents \fIdo\fR use nonstandard +sizes so this may in fact be correct. The best way to verify is once +again to produce, print, and compare a pair of font samples and +iterate until all of the fonts look correct. Use one instance of +\&\fB\-\-force\fR for each font you want to alter. +.SH "ENVIRONMENT" +.IX Header "ENVIRONMENT" +\&\fBpkfix-helper\fR honors the following environment variables: +.IP "\s-1GS\s0" 8 +.IX Item "GS" +The name of the Ghostscript interpreter (default: \fIgs\fR) +.IP "\s-1TFTOPL\s0" 8 +.IX Item "TFTOPL" +The name of a utility for converting \fI.tfm\fR files to \fI.pl\fR files +(default: \fItftopl\fR) +.SH "BUGS" +.IX Header "BUGS" +Even when \fBpkfix-helper\fR finds a perfect match (i.e.,\ the correct +font in the correct size) the mismatch value is still typically +nonzero. The same error is probably what causes \fBpkfix-helper\fR +sometimes to consider the wrong font as being a better match than the +correct font. Suggestions for fixing these bugs are welcome. +.SH "RESTRICTIONS" +.IX Header "RESTRICTIONS" +\&\fBpkfix-helper\fR works only with PostScript files produced by \fBdvips\fR, +not with arbitrary PostScript files. The program has not been tested +with output from versions of \fBdvips\fR older than v5.490 (ca.\ 1992); +output from older versions may or may not work. Only bitmapped fonts +loaded by \fBdvips\fR can be analyzed, not bitmapped fonts loaded by +embedded graphics. +.PP +\&\fBpkfix-helper\fR works by comparing character widths, not the actual +glyphs. Consequently, it is misled by sets of fonts with similar +character widths (at least for those characters used by a given +document). As an extreme example, all Computer Modern Teletype fonts +of a given design size (e.g., \f(CW\*(C`cmtt10\*(C'\fR, \f(CW\*(C`cmsltt10\*(C'\fR, and \f(CW\*(C`cmitt10\*(C'\fR) +use exactly the same widths for all characters. Human assistance is +generally needed to guide \fBpkfix-helper\fR's font-matching procedures. +.SH "NOTES" +.IX Header "NOTES" +Files produced using the \fB\-\-tex\fR option are Plain TeX files and +therefore must be compiled with \fItex\fR (or a variation such as +\&\fIpdftex\fR, \fIluatex\fR, etc.), \fInot\fR with \fIlatex\fR. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fIpkfix\fR\|(1), \fIdvips\fR\|(1), \fItex\fR\|(1), \fIgs\fR\|(1) +.PP +PostScript Language Reference, Third Edition. +Published by Addison-Wesley, \s-1ISBN\s0 0\-201\-37922\-8, +<http://www.adobe.com/products/postscript/pdfs/PLRM.pdf>. +.SH "AUTHOR" +.IX Header "AUTHOR" +Scott Pakin, \fIscott+pkfh@pakin.org\fR +.SH "COPYRIGHT AND LICENSE" +.IX Header "COPYRIGHT AND LICENSE" +Copyright (C) 2011, Scott Pakin +.PP +This file may be distributed and/or modified under the conditions of +the LaTeX Project Public License, either version 1.3c of this license +or (at your option) any later version. The latest version of this +license is in <http://www.latex\-project.org/lppl.txt> and version +1.3c or later is part of all distributions of LaTeX version 2006/05/20 +or later. diff --git a/Master/texmf-dist/doc/man/man1/pkfix-helper.man1.pdf b/Master/texmf-dist/doc/man/man1/pkfix-helper.man1.pdf Binary files differnew file mode 100644 index 00000000000..cc8001d7d9c --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pkfix-helper.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/pktogf.1 b/Master/texmf-dist/doc/man/man1/pktogf.1 new file mode 100644 index 00000000000..d966aaa6349 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pktogf.1 @@ -0,0 +1,99 @@ +.TH PKTOGF 1 "14 December 1993" "Web2C 2012" +.\"===================================================================== +.if n .ds MF Metafont +.if t .ds MF M\s-2ETAFONT\s0 +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff +.el .ds OX TeX for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.\"===================================================================== +.SH NAME +pktogf \- convert packed font files to generic font files +.SH SYNOPSIS +.B pktogf +.RB [ \-v ] +.I pk_file_name +.RI [ gf_file_name ] +.\"===================================================================== +.SH DESCRIPTION +This manual page is not meant to be exhaustive. The complete +documentation for this version of \*(TX can be found in the info file +or manual +.IR "Web2C: A TeX implementation" . +.PP +The +.B pktogf +program converts a packed font file +.RI ( pk ) +to a generic font file +.RI ( gf ). +Packed +font files are much smaller than the corresponding +.I gf +files, +but some DVI readers only understand +.I gf +files. +.PP +The +.I pk_file_name +on the command line must be complete. Because +the resolution is part of the extension, it would not make +sense to append a default extension as is done with \*(TX or +DVI-reading software. The +.I gf_file_name +defaults to the same (stripped) name as +.IR pk_file_name , +and it is placed in the current +working directory with the +.B gf +suffix replacing +.BR pk . +For example, the input file +.I io.300pk +would become +.IR io.300gf . +.\"===================================================================== +.SH OPTIONS +Unless the +.B \-v +switch is given, +.B pktogf +operates silently. With +.BR \-v , +the version number of the program and statistics about the +unpacking are output to +.IR stdout . +.\"===================================================================== +.SH ENVIRONMENT +.B pktogf +looks for +.I pk_file_name +using the +environment variable PKFONTS. If that is not set, it uses the variable +TEXPKS. If that is not set, it uses TEXFONTS. If that is not set, it +uses the system default. +.PP +See +.BR tex (1) +for the details of the searching. +.\"===================================================================== +.SH "SEE ALSO" +.BR gftopk (1), +.BR gftype (1), +.BR pktype (1). +.br +Donald E. Knuth et al., +.IR \*(MFware . +.\"===================================================================== +.SH AUTHORS +Tomas Rokicki wrote the program. +Pierre MacKay adapted it for compilation with +.BR web2c . diff --git a/Master/texmf-dist/doc/man/man1/pktogf.man1.pdf b/Master/texmf-dist/doc/man/man1/pktogf.man1.pdf Binary files differnew file mode 100644 index 00000000000..85a532c2728 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pktogf.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/pktype.1 b/Master/texmf-dist/doc/man/man1/pktype.1 new file mode 100644 index 00000000000..7fad6d25411 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pktype.1 @@ -0,0 +1,76 @@ +.TH PKTYPE 1 "5 May 2011" "Web2C 2012" +.\"===================================================================== +.if n .ds MF Metafont +.if t .ds MF M\s-2ETAFONT\s0 +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff +.el .ds OX TeX for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.\"===================================================================== +.SH NAME +pktype \- verify and translate a packed font bitmap file to plain text +.SH SYNOPSIS +.B pktype +.IR pk_file [pk] +.\"===================================================================== +.SH DESCRIPTION +This manual page is not meant to be exhaustive. The complete +documentation for this version of \*(TX can be found in the info file +or manual +.IR "Web2C: A TeX implementation" . +.PP +The +.B pktype +program translates a packed font file +.RI ( pk ) +(output by, for example, +.BR gftopk (1) +to a file that humans can read. It also serves as a +.I pk +file-validating program (i.e., if +.B pktype +can read it, it's correct) and as an example of a +.IR pk -reading +program for other software that wants to read +.I pk +files. +.PP +The input +.I pk_file +on the command line may omit the suffix `pk. +The plain text translation is always written to standard output. +.PP +The output file gives a compact encoding of the packed encoding, using +conventions described in the source code. Run lengths of black pixels +alternate with parenthesized run lengths of white pixels, and brackets +are used to indicate when a row should be repeated. +.\"===================================================================== +.SH ENVIRONMENT +.B pktype +looks for +.I pk_file +in the usual places according to Kpathsea. +.PP +See +.BR tex (1) +for the details of the searching. +.\"===================================================================== +.SH "SEE ALSO" +.BR dvitype (1), +.BR gftopk (1), +.BR gftype (1). +.br +Donald E. Knuth et al., +.IR \*(MFware . +.\"===================================================================== +.SH AUTHORS +Tomas Rokicki wrote the program, +Donald E. Knuth originally ported it to Unix, +Pierre MacKay originally adapted it for compilation with Web2c. diff --git a/Master/texmf-dist/doc/man/man1/pktype.man1.pdf b/Master/texmf-dist/doc/man/man1/pktype.man1.pdf Binary files differnew file mode 100644 index 00000000000..e83ed33ca43 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pktype.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/pltotf.1 b/Master/texmf-dist/doc/man/man1/pltotf.1 new file mode 100644 index 00000000000..8be43fa518b --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pltotf.1 @@ -0,0 +1,84 @@ +.TH PLTOTF 1 "27 December 1992" "Web2C 2012" +.\"===================================================================== +.if n .ds MF Metafont +.if t .ds MF M\s-2ETAFONT\s0 +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff +.el .ds OX TeX for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.if n .ds WB Web +.if t .ds WB W\s-2EB\s0 +.\"===================================================================== +.SH NAME +pltotf \- convert property list files to TeX font metric (tfm) format +.SH SYNOPSIS +.B pltotf +.RB [ \-verbose ] +.IR pl_file_name [ \fB.pl\fP ] +.RI [ tfm_file_name [ \fB.tfm\fP ]] +.\"===================================================================== +.SH DESCRIPTION +This manual page is not meant to be exhaustive. The complete +documentation for this version of \*(TX can be found in the info file +or manual +.IR "Web2C: A TeX implementation" . +.PP +The +.B pltotf +program translates a (human-oriented) property list file to a +(program-oriented) \*(TX font metric file. Thus, after editing the property +list file, a TFM file can be generated for use with, for example, +.BR tex (1). +.PP +The +.I pl_file_name +is extended with +.B .pl +if it lacks a suffix. No path searching is done. +.PP +If no +.I tfm_file_name +is given, the basename of +.I pl_file_name +with suffix +.B .tfm +is used; otherwise +.I tfm_file_name +is extended with +.B .tfm +if it lacks a suffix. +.\"===================================================================== +.SH OPTIONS +Without the +.B \-verbose +option, +.B pltotf +operates silently. With it, a banner and progress report are printed on +.IR stdout . +.\"===================================================================== +.SH "SEE ALSO" +.BR tftopl (1). +.br +Donald E. Knuth, +.IR "\*(OXware" . +.br +Donald E. Knuth, +.IR "The \*(MFbook" , +(Volume C of +.IR "Computers and Typesetting" ), +Addison-Wesley, 1986, ISBN 0-201-13445-4. +.\"===================================================================== +.SH AUTHORS +Donald E. Knuth wrote the program. It was published as +part of the +.I \*(OXware +technical report, available from the \*(TX Users Group. +Howard Trickey, Pavel Curtis, and Richard Furuta originally ported it to +Unix. diff --git a/Master/texmf-dist/doc/man/man1/pltotf.man1.pdf b/Master/texmf-dist/doc/man/man1/pltotf.man1.pdf Binary files differnew file mode 100644 index 00000000000..6db4125bd0b --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pltotf.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/pmx2pdf.1 b/Master/texmf-dist/doc/man/man1/pmx2pdf.1 new file mode 100644 index 00000000000..9ffcf094377 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pmx2pdf.1 @@ -0,0 +1,101 @@ +.\" This manpage is licensed under the GNU Public License +.TH pmx2pdf 1 2012-05-15 "pmx2pdf script, version 0.2.1" "" + +.SH NAME +pmx2pdf \- This script processes pmx files and then deletes intermediate files + +.SH SYNOPSIS +[ texlua ] +.B pmx2pdf +{ +.IR option +| +.IR jobname +[ .pmx ] +} ... +.TP +The default effect is to process each file using +.TP 12 +.BR pmxab (1) +(pre-processing pass) +.TP +.BR etex (1) +(first pass) +.TP +.BR musixflx (1) +(second pass) +.TP +.BR etex (1) +(third pass) +.TP +.BR dvips (1) +(dvi to Postscript) +.TP +.BR ps2pdf (1) +(Postscript to Portable Document Format) +.TP +followed by removal of intermediate files. + +.SH OPTIONS +.TP 8 +.B -v +output program name and version number, and quit +.TP +.B -h +output usage summary and quit +.TP +.B -l +changes the TeX processor to +.BR latex (1) +or +.BR pdflatex (1) +.TP +.B -p +changes the TeX processor to +.BR pdfetex (1) +or +.BR pdflatex (1) +(and doesn't run +.BR dvips (1) +and +.BR ps2pdf (1) +or +.BR dvipdfm (1) +) +.TP +.B -d +changes the dvi processor to +.BR dvipdfm (1) +.TP +.B -s +stops processing at the dvi file +.TP +.B -t +stops processing at the tex (and midi) files +.TP +.B -i +retain intermediate files +.TP +.B -f +default processing +.TP 0 +Options affect processing of all succeeding PMX files unless changed by another option. + +.SH SEE ALSO +.BR pmxab (1) +.BR scor2prt (1) +.BR etex (1), +.BR latex (1), +.BR pdfetex (1), +.BR pdflatex (1), +.BR musixflx (1), +.BR dvipdfm (1), +.BR dvips (1), +.BR ps2pdf (1). +.br +pmx260.pdf +.br +pmxccn.pdf + +.SH AUTHOR +This manual page was written by Bob Tennent <rdt@cs.queensu.ca>. diff --git a/Master/texmf-dist/doc/man/man1/pmx2pdf.man1.pdf b/Master/texmf-dist/doc/man/man1/pmx2pdf.man1.pdf Binary files differnew file mode 100644 index 00000000000..501f47d9a35 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pmx2pdf.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/pmxab.1 b/Master/texmf-dist/doc/man/man1/pmxab.1 new file mode 100644 index 00000000000..806efcce76c --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pmxab.1 @@ -0,0 +1,24 @@ +.TH pmxab 1 "19 Jan 2013" "Version 2.6.19" "PMX Manual Page" +.SH NAME +pmxab \- a MusiXTeX preprocessor +.SH SYNOPSIS +.B pmxab +.RI basename [.pmx] + +.SH DESCRIPTION +pmxab is a preprocessor for MusiXTeX. +It's usually invoked by a frontend pmx2pdf(1). +To use it to its full benefit you should have installed MusiXTeX Version 1.15 +or higher, and TeX itself. +The goal of PMX is to faciliate the efficient typesetting of scores and parts +that have an almost professional appearance. To learn more about typesetting +with PMX, please read the PMX Manual. + +When invoked directly, pmxab produces tex output utilizing the MusiXTeX +macro set. +.SH SEE ALSO +pmx2pdf(1), scor2prt(1), musixtex(1) +.SH AUTHORS +PMX was written by Don Simons <dsimons@roadrunner.com>. +This manual page was written by Roland Stigge <stigge@antcom.de> for the Debian +project and revised by Bob Tennent <rdt@cs.queensu.ca>. diff --git a/Master/texmf-dist/doc/man/man1/pmxab.man1.pdf b/Master/texmf-dist/doc/man/man1/pmxab.man1.pdf Binary files differnew file mode 100644 index 00000000000..88cc83f46b4 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pmxab.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/pooltype.1 b/Master/texmf-dist/doc/man/man1/pooltype.1 new file mode 100644 index 00000000000..9a91fb8f5ae --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pooltype.1 @@ -0,0 +1,45 @@ +.TH POOLTYPE 1 "27 December 1992" "Web2C 2012" +.\"===================================================================== +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff +.el .ds OX TeX for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.if n .ds WB Web +.if t .ds WB W\s-2EB\s0 +.\"===================================================================== +.SH NAME +pooltype \- display a WEB pool file +.SH SYNOPSIS +.B pooltype +.I pool_file_name +.\"===================================================================== +.SH DESCRIPTION +This manual page is not meant to be exhaustive. The complete +documentation for this version of \*(TX can be found in the info file +or manual +.IR "Web2C: A TeX implementation" . +.PP +The +.B pooltype +program translates a (program-oriented) \*(WB string pool file to a +(human-oriented) text file. +.PP +The +.I pool_file_name +must be complete; no adding of default extensions or path searching is done. +.\"===================================================================== +.SH "SEE ALSO" +.BR tangle (1). +.\"===================================================================== +.SH AUTHORS +Donald E. Knuth wrote the program and originally ported it to Unix. It was +published as part of the +.I \*(OXware +technical report, available from the \*(TX Users Group. diff --git a/Master/texmf-dist/doc/man/man1/pooltype.man1.pdf b/Master/texmf-dist/doc/man/man1/pooltype.man1.pdf Binary files differnew file mode 100644 index 00000000000..62b2b2d73e9 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pooltype.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/prepmx.1 b/Master/texmf-dist/doc/man/man1/prepmx.1 new file mode 100644 index 00000000000..299591e2e9d --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/prepmx.1 @@ -0,0 +1,95 @@ +.TH prepmx 1 "01 September 2005" "M-Tx Version 0.60" "prepmx Manual Page" +.SH NAME +prepmx \- preprocessor for PMX, easy music typesetting program +.SH SYNOPSIS +.B prepmx +.RI [ options ] +.I jobname +.RI [ outdir/ ] +.RI [ stylefile ] +.SH DESCRIPTION +.B M-Tx +is an easy to use preprocessor language for the +.B PMX +music typesetting program, aimed at people who are not experts. For an +easy example, have a look at the following example: + + c2+ e4 g | b4d- c1 d c2 | + c8 g+ e g c- g+ e g | d g f g c- g+ e g | + +For syntax reference, please look at the M-Tx manual written by Dirk +Laurie, the creator of the M-Tx language and the author of prepmx, its +command line utility. + +.B prepmx +processes the file +.IR jobname .mtx +to generate +.IR jobname .pmx. +You can then process this file using the `pmx' command. +.B PMX +is a preprocessor for MusiXTeX. + +.I outdir/ +is the directory where `pmx' will put the final .tex file. Note that the +trailing slash is mandatory. You can provide a +.I stylefile +for M-Tx. If omitted, the file `mtxstyle.txt' in the current +directory is used, if there is one. +.SH OPTIONS +Options can also be specified in a `Options:' line in the preamble, +which takes precedence over the command line. +.TP +.B \-b +never unbeam eighth notes and shorter +.TP +.B \-c +main music lines only \- ignore chords +.TP +.B \-D +enable debug mode +.TP +.B \-f +use tonic sol\-fa note names +.TP +.B \-i +ignore errors +.TP +.B \-m +music only \- ignore lyrics +.TP +.B \-n +indent first system and print default instrument names +.TP +.B \-t +ignore uptext lines +.TP +.B \-u +uptext synchronizes with notes only, not rests +.TP +.B \-v +verbose progress report +.TP +.B \-w +enable pedantic warnings +.TP +.BI \- n +select specified case of multiple score +.SH EXIT STATUS +If no error was found, +.B prepmx +exits with return code 0. In case of an error, the line number of the +processed line is returned. This may not always be the line containing +the actual error. A return status of 10000 means that the input file was +empty or could not be opened. +.SH SEE ALSO +.B M-Tx +User's Guide (mtx060.pdf) +.br +pmx(1), musixtex(1) +.SH AUTHORS +prepmx was written by Dirk Laurie <dpl@sun.ac.za>. +This manual page was written by Roland Stigge <stigge@antcom.de> for the Debian +project. It was revised and extended by Nis Martensen +<nis.martensen@web.de>, mostly by copying text from Dirk Laurie's M-Tx +User's Guide. diff --git a/Master/texmf-dist/doc/man/man1/prepmx.man1.pdf b/Master/texmf-dist/doc/man/man1/prepmx.man1.pdf Binary files differnew file mode 100644 index 00000000000..d4cc74f0001 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/prepmx.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/ps2eps.1 b/Master/texmf-dist/doc/man/man1/ps2eps.1 new file mode 100644 index 00000000000..d74e88ca34f --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ps2eps.1 @@ -0,0 +1,366 @@ +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> +.\" Please send any bug reports, improvements, comments, patches, +.\" etc. to Steve Cheng <steve@ggi-project.org>. +.TH "PS2EPS" "1" "31 August 2010" "" "" + +.SH NAME +ps2eps \- convert PostScript to EPS (Encapsulated PostScript) files +.SH SYNOPSIS + +\fBps2eps\fR [ \fB-f\fR ] [ \fB-q\fR ] [ \fB-N\fR ] [ \fB-O\fR ] [ \fB-n\fR ] [ \fB-P\fR ] [ \fB-c\fR ] [ \fB-C\fR ] [ \fB-m\fR ] [ \fB-B\fR ] [ \fB-E\fR ] [ \fB-s \fIpagedim\fB\fR ] [ \fB-t \fIoffset\fB\fR ] [ \fB-r \fIresolution\fB\fR ] [ \fB-R \fI+|-|^\fB\fR ] [ \fB-l\fR ] [ \fB-g\fR ] [ \fB-H\fR ] [ \fB-d\fR ] [ \fB-h|--help\fR ] [ \fB-a\fR ] [ \fB-W\fR ] [ \fB-L\fR ] [ \fB-V|--version\fR ] [ \fB--\fR ] [ \fB\fIpsfile1\fB\fR ] [ \fB\fIpsfile2\fB\fR ] [ \fB\fI\&...\fB\fR ] + +.SH "DESCRIPTION" +.PP +This manual page documents \fBps2eps\fR version 1.68. +.PP +\fBps2eps\fR is a tool (written in Perl) to produce +Encapsulated PostScript Files (EPS/EPSF) from usual one-paged Postscript +documents. It calculates correct Bounding Boxes for those EPS files and +filters some special postscript command sequences that can produce +erroneous results on printers. EPS files are often needed for including +(scalable) graphics of high quality into TeX/LaTeX (or even Word) documents. +.PP +Without any argument, ps2eps reads from standard input +and writes to standard output. +If filenames are given as arguments they are processed +one by one and output files are written to filenames +with extension \fI\&.eps\fR\&. If input filenames have the +extension \fI\&.ps\fR or \fI\&.prn\fR, this extension is replaced with \fI\&.eps\fR\&. +In all other cases \fI\&.eps\fR is appended to the input filename. +Please note that PostScript files for input should contain +only one single page (you can possibly use the \fBpsselect\fR from the +psutils package to extract a single page from a document that +contains multiple pages). +.PP +If BoundingBox in output seems to be wrong, please try options \fB--size\fR or +\fB--ignoreBB\fR\&. See also section TROUBLESHOOTING. +.SH "OPTIONS" +.PP +\fBps2eps\fR follows the usual GNU command line syntax, +with long options starting with two dashes (`-'). A summary of +options is included below. +.TP +\fB-h, --help \fR +Show summary of options. +.TP +\fB-V, --version \fR +Show version of program. +.TP +\fB-f, --force \fR +Force overwriting existing files. \fBps2eps\fR +will not overwrite files by default to avoid deleting original EPS +files accidently. +.TP +\fB-q, --quiet \fR +quiet operation (no output while processing files, except errors). +.TP +\fB-N, --noinsert \fR +do not insert any postscript code. Normally a few postscript +instructions are added around the original postscript code by +\fBps2eps\fR which can be turned off by this option. +.TP +\fB-O, --preserveorientation \fR +do not filter %%Orientation: header comment. +.TP +\fB-n, --nofix \fR +do not try to fix postscript code by filtering some instructions. +.TP +\fB-P, --removepreview \fR +remove preview image (smaller file, but no preview anymore). +.TP +\fB-F, --fixps \fR +fix postscript code unconditionally. Otherwise, filtering is +usually triggered by detection of certain drivers only. +.TP +\fB-c, --comments \fR +preserve document structure comments. +.TP +\fB-C, --clip \fR +insert postscript code for clipping. Unless +\fB--nohires\fR is specified, the HiResBoundingBox +(enlarged by 0.1 points) is used for clipping. +.TP +\fB-m, --mono \fR +use black/white bitmap as base for calculation (default: off). +.TP +\fB-s, --size=pagedim \fR +where pagedim is a pre-defined standard page size +(e.g., a4,a0,b0,letter,...) or explicitly specified in a +format pagedim:=\fIX\fRx\fIY\fR[cm|in], +where \fIX\fR and \fIY\fR are numbers (floating points are accepted) followed by +units centimeter (cm) or inch (in), (default: cm). +Use \fB--size=list\fR to list pre-defined pagesizes. +See also environment variable PS2EPS_SIZE\&. +.TP +\fB-t, --translate=x,y \fR +specify an x,y offset (may be negative) in postscript points +(1/72 dpi) for drawing. This option may be required +if your drawing has negative coordinates which usually lets ghostscript +cut the negative part of your picture, because it starts to render +at positive coordinates. The resulting output will +also be shifted. +.TP +\fB-r, --resolution=dpi \fR +specify a resolution in dpi (dots per inch) for drawing under +ghostscript. Default +resolution is 144 dpi which is the double of the typical 72 dpi. +This option may help if there is a hardware dependent resolution +encoded in the postscript, e.g., 600dpi. Example: +\fBps2eps -l -r 600 test.ps\fR +.TP +\fB-R, --rotate=direction \fR +This option rotates the resulting EPS output. +The parameter direction determines the direction of +rotation: + means +90 degrees (clockwise),- means -90 degrees +(counter-clockwise), and ^ means 180 degrees (up-side down). +.TP +\fB-l, --loose \fR +expand the original tight bounding box by one point in each +direction. +.TP +\fB-B, --ignoreBB \fR +do not use existing bounding box as page size for +rendering. +.TP +\fB-E, --ignoreEOF \fR +do not use %%EOF as hint for end of file. Otherwise, \fBps2eps\fR assumes +that postscript code ends after the last %%EOF comment, because +some drivers add trailing binary ``garbage'' code which gets deleted +by \fBps2eps\fR by default. +.TP +\fB-g, --gsbbox \fR +use internal bbox device of ghostscript instead of the external C +program \fBbbox\fR\&. The internal bbox device of ghostscript +generates different values (sometimes even incorrect), +so using the provided \fBbbox\fR should be more robust. +See also environment variable PS2EPS_GSBBOX\&. +.TP +\fB-H, --nohires \fR +do not generate a %%HiResBoundingBox comment for output. +.TP +\fB-a, --accuracy \fR +increase the accuracy by turning subsample antialiasing on (may be slower) +.TP +\fB-L, --license \fR +show licensing information. +.TP +\fB-d, --debuggs \fR +show ghostscript call. This may be helpful for solving problems that +occur during a ghostscript call. +.TP +\fB-W, --warnings \fR +show warnings about sanity of generated EPS file. Certain +postscript commands should not be contained in an EPS file. +With this option set \fBps2eps\fR will issue a warning if it +detects at least one of them. +.SH "TROUBLESHOOTING" +.PP +Based on the given postscript source code (in most cases generated by +some postscript printer driver) there are many potential obstacles or +problems that may occur when trying to create proper EPS files. Please +read this section carefully to be aware of common pitfalls. +.SS "INCOMPLETE/CLIPPED IMAGES" +.PP +or how to determine the right size for ghostscript. +.PP +If you have documents that are larger than your +ghostscript default (usually A4 or US letter), you have to +specify the page dimensions explicitly using the +\fB-s\fR option. Otherwise your EPS +might be cut off during rasterizing by ghostscript resulting +in a wrongly calculated bounding box. You can pass +all pre-defined page sizes to \fB-s\fR that ghostscript understands. These are +currently: 11x17, ledger, legal, letter, lettersmall, archA, archB, archC, archD, archE +a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, isob0, isob1, isob2, isob3, isob4, isob5, isob6, +b0, b1, b2, b3, b4, b5, c0, c1, c2, c3, c4, c5, c6, jisb0, jisb1, +jisb2, jisb3, jisb4, jisb5, jisb6, flsa, flse, halfletter. +Unfortunately, all sizes are currently only available in portrait +orientation (not landscape). +.PP +By default, \fBps2eps\fR uses an already given %%BoundingBox +from the source file, which often corresponds to the size of +the physical page format for which the document was +printed. However, you should be aware that this already +specified bounding box may be not correct, thus resulting in a +wrongly cropped (or even no usable) \fI\&.eps\fR-file. +\fBps2eps\fR can only do as good as ghostscript does in rendering the original +postscript file (though \fBps2eps\fR even works with negative and +fractional values are contained in the original bounding box by using +automatic translation). Therefore, if the given bounding box is to +small or incorrect anyway, you can ignore the existing bounding box with the \fB-B\fR +option, which will cause ghostscript to use its internal +default size (or use \fB-s\fR). However, if the +BoundingBox has negative coordinates, which is not allowed by +the specification, \fBps2eps\fR will shift the output to positive values. +.PP +Hint: to avoid rotating the picture +if you have the original drawing in landscape format, you may +use the ``Encapsulated Postscript'' option in the printer driver +which should generate an EPS file (but with a bounding box of +the sheet size!). But some Windows printer drivers are drawing +the image with an offset from the bottom of the portrait page, +so that a part of it is drawn outside the landscape oriented +page. In this case, you'll have to specify a square size of +the page using the maximum length, e.g., 29.7cm x 29.7cm for +an A4 page. +.SS "CLIPPING" +.PP +or why gets some of my text deleted above the included \fI\&.eps\fR file? +.PP +Some postscript drivers draw a white rectangle from the top left +corner of the page to the right lower corner of the object. This may +erase some or even all text above your imported/included EPS file, +which is very annoying. In order to prevent this, most programs have a +clipping option for imported \fI\&.eps\fR files (within LaTeX you can use +\\includegraphics*{}) for this purpose. If this is unfortunately not +the case, you can use the \fB-C\fR option of \fBps2eps\fR which will (hopefully) +do it for you. Unfortunately, PScript.dll 5.2 (Windows XP) introduced +new very badly behaving Postscript code (initclip) which will even +override the outer clipping! Thus, a new filter had to be installed +in \fBps2eps\fR which will fix it. +.PP +However, because most programs clip directly on the bounding box, +you still may loose some pixels of your image, because the bounding +box is described in the coarse resolution of postscript points, +i.e. 72 dpi. In order to prevent this, you can use the \fB-l\fR +option or \fB-C\fR option (for the latter, clipping by the importing program +should be disabled then) to allow for a 1 point larger bounding box. +\fB-C\fR clips around a 1 point enlarged bounding box and \fB-l\fR enlarges the +bounding box values by 1 point (you can also combine both options). +.SS "INCLUDED FILTERS" +.PP +Some postscript sequences, e.g., for using specific printer +features (featurebegin ...), are not working well within an \fI\&.eps\fR +file, so \fBps2eps\fR tries to filter them out. But please note that +filters for postscript code may not work properly for your printer +driver (\fBps2eps\fR was mainly tested with HP and Adobe printer +drivers, although it may work for all printers using the +PScript.dll). In this case you can try to turn of filtering by +using option \fB-n\fR, or try to find the bad sequence in the postscript +code and adapt the filter rule in the \fBps2eps\fR script (variables +$linefilter, $rangefilter_begin, $rangefilter_end; linefilter is +an expression for filtering single lines, rangefilter_... are +expressions that filter all lines between a pattern matching +$rangefilter_begin and $rangefilter_end; drop me an e-mail with +your modifications). However, things may change as the printer +drivers (e.g., PScript.dll) or postscript language evolve. +.PP +Some applications or drivers generate postscript code with leading +or trailing binary code, which often confuses older postscript +interpreters. \fBps2eps\fR tries to remove such code, but it may +sometimes make a wrong guess about start and end of the real +postscript code (drop me an e-mail with a zipped postscript +source, see section BUGS). +.PP +Comment lines or even blank lines are removed +(which is the default to make .eps files smaller), which may corrupt your +output. Please check the next section how to fix this. +\fBps2eps\fR removes blank lines and also <CR> (carriage ceturn +``\\r'') at the end of lines. However, nicely formatted postscript code +gives a hint by using ``%%BeginBinary'' ``%%EndBinary'' comments. When +\fBps2eps\fR detects these comments it will refrain from any filtering +action within the marked binary sections. +.PP +\fBps2eps\fR filters also %%Orientation: comments by +default (you can use option \fB-O\fR to turn off filtering), +because ghostscript may ``automagically'' rotate images when generating PDF +images, which is not desired in most cases. Hint: you can turn off that +feature in ghostscript unconditionally by specifying -dAutoRotatePages=/None. +.SS "CORRUPTED OUTPUT" +.PP +Some postscript code may get corrupted when comment lines or even blank +lines are removed (which is the default to make .eps files smaller), +because those files may contain encoded images +which also have a % as first character in a line or use a special +comment as end of image delimiter. If this is the case, use the \fB-c\fR +option to prevent filtering comments. +.SS "COLOR AND MEMORY" +.PP +\fBps2eps\fR supports colored postscript, consequently +letting ghostscript consume more resources for drawing its bitmap +(roughly 6MBytes for an A4 page). \fBbbox\fR is reading +the bitmap line by line so it consumes only minimal memory. If you experience problems +with memory consumption of ghostscript, you may use the \fB-m\fR option +for using a monochrome image. But this will probably result in wrongly +determined bounding boxes with colored +images, because ghostscript has to do black/white dithering and may thus suppress +objects drawn in light colors. +.PP +Another option in case of memory problems and too long run times +is to use the much more memory efficient internal ghostscript bbox by using the +\fB-g\fR option. +.SH "ENVIRONMENT VARIABLES" +.PP +Please note that a command line option always takes precedence over +the related environment variable. +.PP +The environment variable PS2EPS_SIZE can be used +to specify a default page size and take any argument that +\fB--size\fR accepts. Examples: \fBexport PS2EPS_SIZE=a0\fR (bash-like syntax) +or \fBsetenv PS2EPS_SIZE letter\fR (csh syntax). +.PP +If the environment variable PS2EPS_GSBBOX is set +the internal bbox device of ghostscript will be used instead of the external +command \fBbbox\fR\&. Examples: \fBexport PS2EPS_GSBBOX=true\fR (bash-like syntax) +or \fBsetenv PS2EPS_GSBBOX 1\fR (csh syntax). +.SH "EXAMPLES" +.PP +The usual call is simply: +\fBps2eps -l \fIfile\fB\fR +.PP +A relatively failsafe call would be (if your postscript is smaller +than iso b0 [100cm x 141.4cm] and you have a fast computer with enough memory): +\fBps2eps -l -B -s b0 -c -n \fIfile\fB\fR +.PP +If output is not correct try: +\fBps2eps -l -B -s b0 -F \fIfile\fB\fR +.SH "AUTHOR" +.PP +\fBps2eps\fR was written by Roland Bless. +.SS "WHY?" +.PP +Other programs like \fBps2epsi\fR do not calculate the +bounding box always correctly (because the values are put on the +postscript stack which may get corrupted by bad postscript code) or +rounded it off so that clipping the EPS cut off some part of the +image. \fBps2eps\fR uses a double precision resolution +of 144 dpi and appropriate rounding to get a proper bounding +box. The internal bbox device of ghostscript generates different values +(sometimes even incorrect), so using the provided \fBbbox\fR +should be more robust. +However, because normal clipping has only a resolution of 1/72dpi +(postscript point), the clipping process may still erase parts of your +EPS image. In this case please use the \fB-l\fR option to add +an additional point of white space around the tight bounding box. +.SS "ACKNOWLEDGMENTS" +.PP +Some people contributed code or suggestions to improve \fBps2eps\fR\&. Here +are at least some names (sorry if I forgot your name): +Christophe Druet, Hans Ecke, Berend Hasselman, Erik Joergensen, Koji Nakamaru, Hans Fredrik Nordhaug, Michael Sharpe. +Special thanks goes to Michael Sharpe from UCSD who suggested a lot of useful features for ps2eps and +who fixed bbox to become more precise and robust. +.PP +An earlier version of this manual page was originally written by +Rafael Laboissiere <rafael at debian.org> for +the Debian system. Thank you Rafael! +.PP +Permission is granted to copy, distribute and/or modify this document under +the terms of the GNU Free Documentation +License, Version 1.1 or any later version published by the Free +Software Foundation; with no Invariant Sections, no Front-Cover +Texts and no Back-Cover Texts. +.SH "BUGS" +.PP +If you experience problems, please check carefully all hints in the section +TROUBLESHOOTING +first. Otherwise, check for an updated +version at <URL:http://www.tm.uka.de/~bless/ps2eps> +or send a gzipped file of +relevant postscript source code with your error description +and \fBps2eps\fR version number to <roland at bless.de> (please allow some time +to reply). +.SH "SEE ALSO" +.PP +bbox (1), gs (1), ps2epsi (1) diff --git a/Master/texmf-dist/doc/man/man1/ps2eps.man1.pdf b/Master/texmf-dist/doc/man/man1/ps2eps.man1.pdf Binary files differnew file mode 100644 index 00000000000..0a6f618c0dc --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ps2eps.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/ps2frag.1 b/Master/texmf-dist/doc/man/man1/ps2frag.1 new file mode 100644 index 00000000000..b572c5733c1 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ps2frag.1 @@ -0,0 +1,41 @@ +.TH ps2frag 1 "Feb 95" TeXware +.SH NAME +ps2frag - obsolete shell script for the PSfrag system. +.SH IMPORTANT NOTICE +The new PSfrag system no longer requires the ps2frag script; instead, it +handles the processing entirely within TeX/LaTeX and DVIPS. I'm sure you +will agree that never needing to run ps2frag again is a nice convenience! +.P +However, there are two significant differences in the way this new version +of PSfrag works. Please make yourself aware of them: +.P +1) XDvi is no longer able to determine where your PSfrag replacements +should +go, so instead it lines them up in a vertical list to the left of the +figure. This allows you to confirm that they have been typeset properly, at +least. However, to confirm that PSfrag +.B positions +your replacements properly, you will have to view the PostScript +version of your file with a viewer like GhostView, or print it out. +This seems to be the +only disadvantage to the elimination of the pre-processing step. +.P +2) If you embed '\\tex' commands inside your figures, you now need to +explicitly _tell_ PSfrag to process these commands. To do so, use +\\usepackage[scanall]{psfrag} +instead of +\\usepackage{psfrag} +at the beginning of your LaTeX file. +.P +If you only use '\\tex' commands in a small number of figures, then a +more efficient might be to turn on '\\tex'-scanning only for those +figures. To do that, add the command '\\psfragscanon' immediately before +each relevant \\includegraphics or \\epsfbox command. +.P +.SH NOTES +See the PSfrag documentation for further information. +.SH "SEE ALSO" +dvips(1), gs(1), ghostview(1), latex(1) +.SH AUTHORS +.IP psfrag@rascals.stanford.edu +The PSfrag maintainer's mailing list. diff --git a/Master/texmf-dist/doc/man/man1/ps2frag.man1.pdf b/Master/texmf-dist/doc/man/man1/ps2frag.man1.pdf Binary files differnew file mode 100644 index 00000000000..82dc2bffad8 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ps2frag.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/ps2pk.1 b/Master/texmf-dist/doc/man/man1/ps2pk.1 new file mode 100644 index 00000000000..dbeed0cdbfc --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ps2pk.1 @@ -0,0 +1,156 @@ +.TH PS2PK 1 TeX +.SH NAME +ps2pk \- creates a TeX pkfont from a type1 PostScript font +.SH SYNOPSIS +ps2pk +[ -v ] +[ -e\fIenc\fP ] +[ -X\fIxres\fP ] +[ -E\fIexpansion\fP ] +[ -S\fIslant\fP ] +[ -P\fIpointsize\fP ] +[ -R\fIbaseres\fP ] +[ -r\fIaspectratio\fP ] +[ -Y\fIyres\fP ] +[ -a\fIAFMfile\fP ] +[ -m\fImodename\fP ] +type1 [pkfont] +.SH DESCRIPTION +This program renders a given type1 PostScript font at a given pointsize +(default 10.0 points) and resolution (default 300dpi) into a TeX pkfont. +.PP +To generate the pkfont ps2pk needs a valid type1 font file (for +example Utopia-Regular, Utopia-Regula.pfb or Utopia-Regula.pfa) and +its corresponding AFM-file (Utopia-Regular.afm) with the font metrics. +The program accepts both the binary type1 format (Utopia-Regula.pfb) +and its ASCII equivalent (Utopia-Regular or Utopia-Regula.pfa). To +locate the files, ps2pk uses the kpathsea library (see the info page +on kpathsea). Additionally, pfb and pfa files are searched for in the +directory specified in the environment variable T1INPUTS, and afm +files are searched in AFMFONTS, if they are set (the -v flag will +report which filenames are looked for). +.PP +The program will make a pkfont in which the character codes are derived +from their AFM (Adobe Font Metrics) defined values. This can be +overruled by specifying an explicit encoding file via the -e option. +The encoding file \fIenc\fP +should contain a valid PostScript encoding containing PostScript names +like /hyphen. Here is an incomplete example (see afm2tfm for complete +syntax): + +.RS +.nf +% This is the EC encoding. +/ECEncoding [ % now 256 chars follow +% 0x00 + /grave /acute /circumflex /tilde /dieresis /hungarumlaut + /ring /caron /breve /macron /dotaccent /cedilla + /ogonek /quotesinglbase /guilsinglleft /guilsinglright + + (Rest of lines omitted.) + +% 0xF0 + /eth /ntilde /ograve /oacute /ocircumflex /otilde + /odieresis /oe /oslash /ugrave /uacute /ucircumflex + /udieresis /yacute /thorn /germandbls ] def +.fi +.RE +.PP +Options and arguments: +.IP -a\fIAFMfile\fP 12 +Overrules the name that is used to locate the AFM file. + +.IP -e\fIenc\fP 12 +Name of a file containing an encoding scheme +(default \- the encoding named in the AFM-file is used). +The actual PostScript name of the encoding scheme is written +as a "special" at the end of the pkfont. + +.IP -E\fIextension\fP 12 +The extension factor (real value, default 1.0). + +.IP -m\fImodename\fP 12 +A modename such as would be used by METAFONT (default "Unknown mode"). + +.IP -P\fIpointsize\fP 12 +The desired pointsize (real value, default 10.0 points). + +.IP -R\fIbaseres\fP 12 +The desired base resolution (integer value, default 300 dpi). +If this differs from the value of \fIxres\fP, the appropriate +magnification will be shown in the "specials" at the end +of the pkfont. If possible, this will be expressed as a +magstep, otherwise as a real number. For example, a pkfont with an \fIxres\fP +of 329, using the default base resolution of 300, +will include the "special" text "mag=magstep(0.5)" at the +end of the font. + +.IP -r\fIaspectratio\fP 12 +The desired aspect ratio (expression, integerY/integerX, default 300/300). +This will be shown in the "specials" at the end +of the pkfont. Setting the aspect ratio creates a value for +\fIyres\fP but an explicit \fIyres\fP value will take precedence. +Argument must be in "" if spaces are left around `/'. + +.IP -S\fIslant\fP 12 +The slant (real value, default 0.0). + +.IP -X\fIxres\fP 12 +The resolution in the X direction (integer value, default 300 dpi). + +.IP -Y\fIyres\fP 12 +The resolution in the Y direction (integer value, default the value +of \fIxres\fP). If \fIyres\fP differs from \fIxres\fP, a "special" +text giving the aspect ratio will be written at the end of the +pkfont. + +.IP -v 12 +Verbose flag. (Tells what the program is doing.) + +.IP type1 12 +The name of the PostScript type1 font. The name of the AFM-file will be +constructed from this name by removing the extension (if suplied) and +adding ".afm". The PostScript "FontName" is extracted from the +AFM-file and written into a "special" at the end of the pkfont. + +.IP [pkfont] 12 +The name of the resulting pkfont can be overruled with this name. The +default name of pkfont is derived from the basename of the type1 +font, the pointsize and \fIxres\fP. For example +`ps2pk -P17.28 Utopia-Regular' will result in `Utopia-Regular17.300pk'. +An explicit value for the name of the pkfont is necessary when +the type1 font name already shows the point size, otherwise +the \fIpointsize\fP value is catenated on to the pkfont basename +which is usually not what is wanted. + +.PP +The following PK "specials" provide an internal check on the +characteristics of the pkfont, in accordance with the recommendations +of the TeX Working Group on the TeX Directory Standard (TWG-TDS): +.br +"fontid=\fIFontName\fP", "codingscheme=\fIEncoding\fP", "fontfacebyte", "mag", +"mode=(ps2pk)\fImodename\fP", "pixels-per-inch", and "aspect-ratio" if it +is other than unity. + +.SH ACKNOWLEDGEMENT +This program uses the type1 hinting and rendering software IBM +has donated to the X-consortium. + +.SH SEE ALSO +.nf +`METAFONT: The Program', Donald Knuth. +`The GFtoPK processor', belonging to the METAFONTware. +`Adobe Font Metric Files', Version 3.0, PostScript Developer +Support Group. +afm2tfm(1) +pk2bm(1) +kpsewhich(1) +info kpathsea + +.SH VERSION +1.4 (January 1994) + +.SH AUTHOR +Piet Tutelaers <rcpt@urc.tue.nl>. +Modified for ps2pkm by Pierre A. Mackay <mackay@cs.washington.edu>, +This manpage was adapted to teTeX by Frank Kuester <frank@kuesterei.ch>. diff --git a/Master/texmf-dist/doc/man/man1/ps2pk.man1.pdf b/Master/texmf-dist/doc/man/man1/ps2pk.man1.pdf Binary files differnew file mode 100644 index 00000000000..62beb4f7847 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ps2pk.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/psbook.1 b/Master/texmf-dist/doc/man/man1/psbook.1 new file mode 100644 index 00000000000..de88949e4b6 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/psbook.1 @@ -0,0 +1,42 @@ +.TH PSBOOK 1 "PSUtils Release 1 Patchlevel 17" +.SH NAME +psbook \- rearrange pages in PostScript file into signatures +.SH SYNOPSIS +.B psbook +[ +.B \-q +] [ +.B \-s\fIsignature\fR +] [ +.I infile +[ +.I outfile +] ] +.SH DESCRIPTION +.I Psbook +rearranges pages from a PostScript document into ``signatures'' for +printing books or booklets, creating a new PostScript file. The +input PostScript file should follow the Adobe Document Structuring +Conventions. +.PP +The +.I \-s +option selects the size of signature which will be used. The signature size is +the number of sides which will be folded and bound together; the number given +should be a multiple of four. The default is to use one signature for the +whole file. Extra blank sides will be added if the file does not contain a +multiple of four pages. +.PP +Psbook normally prints the page numbers of the pages rearranged; the +.I \-q +option suppresses this. +.SH AUTHOR +Copyright (C) Angus J. C. Duggan 1991-1995 +.SH "SEE ALSO" +epsffit(1), psbook(1), psnup(1), psresize(1), psselect(1), pstops(1), extractres(1), fixdlsrps(1), fixfmps(1), fixpsditps(1), fixpspps(1), fixscribeps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), includeres(1), psmerge(1), getafm(1) +.SH TRADEMARKS +.B PostScript +is a trademark of Adobe Systems Incorporated. +.SH BUGS +.I Psbook +does not accept all DSC comments. diff --git a/Master/texmf-dist/doc/man/man1/psbook.man1.pdf b/Master/texmf-dist/doc/man/man1/psbook.man1.pdf Binary files differnew file mode 100644 index 00000000000..3dd7fe034e5 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/psbook.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/pslatex.1 b/Master/texmf-dist/doc/man/man1/pslatex.1 new file mode 100644 index 00000000000..c206596a6a0 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pslatex.1 @@ -0,0 +1,44 @@ +.TH "pslatex" "1" "September 2000" "teTeX" "teTeX" +.PP +.SH "NAME" +pslatex \- utility to typeset LaTeX files using PostScript fonts +.PP +.SH "SYNOPSIS" +.PP +\fBpslatex\fP [\fILATEXARGS\fP] \fILATEXFILE\fP[\&.tex] +.PP +.SH "DESCRIPTION" +.PP +\fBpslatex\fP allows you to typeset a LaTeX source file using basic +Adobe Type 1 PostScript fonts (Times, Helvetica, and Courier) +\fIwithout\fP editing the file to load the necessary packages\&. +.PP +It takes any arguments that \fBlatex\fP(1) can take\&. +.PP +.SH "OPTIONS" +.PP +None\&. +.PP +.SH "FILES" +.PP +Many\&. See the readme file for \fIpslatex\&.sty\fP\&. +.PP +.SH "SEE ALSO" +.PP +\fBlatex\fP(1), \fI\fITEXMF\fP/latex/pslatex/00readme\&.txt\fP +.PP +.SH "BUGS" +.PP +None known\&. Report any found to the author\&. +.PP +.SH "AUTHOR" +.PP +\fBpslatex\fP was written by David Carlisle +<david@dcarlisle\&.demon\&.co\&.uk>\&. +.PP +This manual page was written by C\&.M\&. Connelly +<c@eskimo\&.com>, for +the Debian GNU/Linux system\&. It may be used by other distributions +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/Master/texmf-dist/doc/man/man1/pslatex.man1.pdf b/Master/texmf-dist/doc/man/man1/pslatex.man1.pdf Binary files differnew file mode 100644 index 00000000000..f187da030ff --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pslatex.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/psmerge.1 b/Master/texmf-dist/doc/man/man1/psmerge.1 new file mode 100644 index 00000000000..55d95ff7d61 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/psmerge.1 @@ -0,0 +1,36 @@ +.TH PSMERGE 1 "PSUtils Release 1 Patchlevel 17" +.SH NAME +psmerge \- filter to merge several PostScript files into one +.SH SYNOPSIS +.B psmerge +[ +.B \-o\fIout.ps\fB +] +[ +.I file.ps ... +] +.SH DESCRIPTION +.I Psmerge +merges PostScript documents into a single document. It only works in the +specific case the the files were created using the same application, with the +same device setup and resources (fonts, procsets, patterns, files, etc) +loaded. + +If the +.B \-o +option is used, output will be sent to the file named, otherwise it will go to +standard output. + +.I Psmerge +will merge multiple files concatenated into a single file as if they +were in separate files. +.SH AUTHOR +Copyright (C) Angus J. C. Duggan 1991-1995 +.SH "SEE ALSO" +epsffit(1), psbook(1), psnup(1), psresize(1), psselect(1), pstops(1), extractres(1), fixdlsrps(1), fixfmps(1), fixpsditps(1), fixpspps(1), fixscribeps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), includeres(1), psmerge(1), getafm(1) +.SH TRADEMARKS +.B PostScript +is a trademark of Adobe Systems Incorporated. +.SH BUGS +.I psmerge +is for a very specific case; it does not merge files in the general case. diff --git a/Master/texmf-dist/doc/man/man1/psmerge.man1.pdf b/Master/texmf-dist/doc/man/man1/psmerge.man1.pdf Binary files differnew file mode 100644 index 00000000000..a8dda27ec33 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/psmerge.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/psnup.1 b/Master/texmf-dist/doc/man/man1/psnup.1 new file mode 100644 index 00000000000..06922e43575 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/psnup.1 @@ -0,0 +1,160 @@ +.TH PSNUP 1 "PSUtils Release 1 Patchlevel 17" +.SH NAME +psnup \- multiple pages per sheet +.SH SYNOPSIS +.B psnup +[ +.B \-w\fIwidth\fR +] [ +.B \-h\fIheight\fR +] [ +.B \-p\fIpaper\fR +] [ +.B \-W\fIwidth\fR +] [ +.B \-H\fIheight\fR +] [ +.B \-P\fIpaper\fR +] [ +.B \-l +] [ +.B \-r +] [ +.B \-f +] [ +.B \-c +] [ +.B \-m\fImargin\fR +] [ +.B \-b\fIborder\fR +] [ +.B \-d\fIlwidth\fR +] [ +.B \-s\fIscale\fR +] [ +.B \-\fInup\fR +] [ +.B \-q +] [ +.I infile +[ +.I outfile +] ] +.SH DESCRIPTION +.I Psnup +puts multiple logical pages onto each physical sheet of paper. +The input PostScript file should follow the Adobe Document Structuring +Conventions. +.PP +The +.I \-w +option gives the paper width, and the +.I \-h +option gives the paper height, +normally specified in +.B "cm" +or +.B "in" +to convert +PostScript's points (1/72 of an inch) +to centimeters or inches. +The +.I \-p +option can be used as an alternative, to set the paper size to +.B a3, a4, a5, b5, letter, legal, tabloid, statement, executive, folio, quarto +or +.B 10x14. +The default paper size is +.B a4. +The +.I \-W, \-H, +and +.I \-P +options set the input paper size, if it is different from the output +size. This makes it easy to impose pages of one size on a different size of +paper. +.PP +The +.I \-l +option should be used for pages which are in landscape orientation (rotated 90 +degrees anticlockwise). The +.I \-r +option should be used for pages which are in seascape orientation (rotated 90 +degrees clockwise), and the +.I \-f +option should be used for pages which have the width and height interchanged, +but are not rotated. +.PP +.I Psnup +normally uses `row-major' layout, where adjacent pages are placed in rows +across the paper. +The +.I \-c +option changes the order to `column-major', where successive pages are placed +in columns down the paper. +.PP +A margin to leave around the whole page can be specified with the +.I \-m +option. This is useful for sheets of `thumbnail' pages, because the normal +page margins are reduced by putting multiple pages on a single sheet. +.PP +The +.I \-b +option is used to specify an additional margin around each page on a sheet. +.PP +The +.I \-d +option draws a line around the border of each page, of the specified width. +If the \fIlwidth\fR parameter is omitted, a default linewidth of 1 point is +assumed. The linewidth is relative to the original page dimensions, +\fIi.e.\fR it is scaled down with the rest of the page. +.PP +The scale chosen by +.I psnup +can be overridden with the +.I \-s +option. This is useful to merge pages which are already reduced. +.PP +The +.I \-\fInup\fR +option selects the number of logical pages to put on each sheet of paper. This +can be any whole number; +.I psnup +tries to optimise the layout so that the minimum amount of space is wasted. If +.I psnup +cannot find a layout within its tolerance limit, it will abort with an error +message. The alternative form +.I \i \fInup\fR +can also be used, for compatibility with other n-up programs. +.PP +.I Psnup +normally prints the page numbers of the pages re-arranged; the +.I \-q +option suppresses this. +.SH EXAMPLES +The potential use of this utility is varied but one particular +use is in conjunction with +.I psbook(1). +For example, using groff to create a PostScript document and lpr as +the +.SM UNIX +print spooler a typical command line might look like this: +.sp +groff -Tps -ms \fIfile\fP | psbook | psnup -2 | lpr +.sp +Where file is a 4 page document this command will result in a +two page document printing two pages of \fIfile\fP per page and +rearranges the page order to match the input pages 4 and 1 +on the first output page and +pages 2 then 3 of the input document +on the second output page. +.SH AUTHOR +Copyright (C) Angus J. C. Duggan 1991-1995 +.SH "SEE ALSO" +epsffit(1), psbook(1), psnup(1), psresize(1), psselect(1), pstops(1), extractres(1), fixdlsrps(1), fixfmps(1), fixpsditps(1), fixpspps(1), fixscribeps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), includeres(1), psmerge(1), getafm(1) +.SH TRADEMARKS +.B PostScript +is a trademark of Adobe Systems Incorporated. +.SH BUGS +.I Psnup +does not accept all DSC comments. diff --git a/Master/texmf-dist/doc/man/man1/psnup.man1.pdf b/Master/texmf-dist/doc/man/man1/psnup.man1.pdf Binary files differnew file mode 100644 index 00000000000..77df07fb5a4 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/psnup.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/psresize.1 b/Master/texmf-dist/doc/man/man1/psresize.1 new file mode 100644 index 00000000000..2fa06f9f6d0 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/psresize.1 @@ -0,0 +1,81 @@ +.TH PSRESIZE 1 "PSUtils Release 1 Patchlevel 17" +.SH NAME +psresize \- multiple pages per sheet +.SH SYNOPSIS +.B psresize +[ +.B \-w\fIwidth\fR +] [ +.B \-h\fIheight\fR +] [ +.B \-p\fIpaper\fR +] [ +.B \-W\fIwidth\fR +] [ +.B \-H\fIheight\fR +] [ +.B \-P\fIpaper\fR +] [ +.B \-q +] [ +.I infile +[ +.I outfile +] ] +.SH DESCRIPTION +.I Psresize +rescales and centres a document on a different size of paper. +The input PostScript file should follow the Adobe Document Structuring +Conventions. +.PP +The +.I \-w +option gives the output paper width, and the +.I \-h +option gives the output paper height, normally specified in +.B "cm" +or +.B "in" +to convert +PostScript's points (1/72 of an inch) +to centimeters or inches. +The +.I \-p +option can be used as an alternative, to set the output paper size to +.B a3, a4, a5, b5, letter, legal, tabloid, statement, executive, folio, quarto +or +.B 10x14. +The default output paper size is +.B a4. +.PP +The +.I \-W +option gives the input paper width, and the +.I \-H +option gives the input paper height. +The +.I \-P +option can be used as an alternative, to set the input paper size. +The default input paper size is +.B a4. +.PP +.I Psresize +normally prints the page numbers of the pages output; the +.I \-q +option suppresses this. +.SH EXAMPLES +The following command can be used to convert a document on A4 size paper to +letter size paper: +.sp +psresize -PA4 -pletter in.ps out.ps +.sp +.SH AUTHOR +Copyright (C) Angus J. C. Duggan 1991-1995 +.SH "SEE ALSO" +epsffit(1), psbook(1), psnup(1), psresize(1), psselect(1), pstops(1), extractres(1), fixdlsrps(1), fixfmps(1), fixpsditps(1), fixpspps(1), fixscribeps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), includeres(1), psmerge(1), getafm(1) +.SH TRADEMARKS +.B PostScript +is a trademark of Adobe Systems Incorporated. +.SH BUGS +.I Psresize +does not accept all DSC comments. diff --git a/Master/texmf-dist/doc/man/man1/psresize.man1.pdf b/Master/texmf-dist/doc/man/man1/psresize.man1.pdf Binary files differnew file mode 100644 index 00000000000..5caf06fd1a2 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/psresize.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/psselect.1 b/Master/texmf-dist/doc/man/man1/psselect.1 new file mode 100644 index 00000000000..005888306b5 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/psselect.1 @@ -0,0 +1,84 @@ +.TH PSSELECT 1 "PSUtils Release 1 Patchlevel 17" +.SH NAME +psselect \- select pages from a PostScript file +.SH SYNOPSIS +.B psselect +[ +.B \-q +] [ +.B \-e +] [ +.B \-o +] [ +.B \-r +] [ +.B \-p\fIpages\fR +] [ +.I pages +] [ +.I infile +[ +.I outfile +] ] +.SH DESCRIPTION +.I Psselect +selects pages from a PostScript document, creating a new PostScript file. The +input PostScript file should follow the Adobe Document Structuring +Conventions. +.PP +The +.I \-e +option selects all of the even pages; it may be used in conjunction with the +other page selection options to select the even pages from a range of pages. +.PP +The +.I \-o +option selects all of the odd pages; it may be used in conjunction with the +other page selection options. +.PP +The +.I \-p\fIpages\fR +option specifies the pages which are to be selected. +.I Pages +is a comma separated list of page ranges, each of which may be a page number, +or a page range of the form \fIfirst\fR-\fIlast\fR. If \fIfirst\fR is omitted, +the +first page is assumed, and if \fIlast\fR is omitted, the last page is assumed. + +The prefix character `_' indicates that the page number is relative to the end +of the document, counting backwards. If just this character with no page +number is used, a blank page will be inserted. +.PP +The +.I \-r +option causes +.I psselect +to output the selected pages in reverse order. +.PP +Psselect normally prints the page numbers of the pages rearranged; the +.I \-q +option suppresses this. +.PP +If any of the +.I \-r, \-e, +or +.I \-o +options are specified, the page range must be given with the +.I \-p +option. This is for backwards compatibility with previous versions. + +.SH NOTES +The page number given to +.I psselect +is the number of the page counting from the start or end of the file, starting +at one. The actual page number in the document may be different. +.SH AUTHOR +Copyright (C) Angus J. C. Duggan 1991-1995 +.SH "SEE ALSO" +epsffit(1), psbook(1), psnup(1), psresize(1), psselect(1), pstops(1), extractres(1), fixdlsrps(1), fixfmps(1), fixpsditps(1), fixpspps(1), fixscribeps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), includeres(1), psmerge(1), getafm(1) +.SH TRADEMARKS +.B PostScript +is a trademark of Adobe Systems Incorporated. +.SH BUGS +.I Psselect +does not accept all DSC comments. diff --git a/Master/texmf-dist/doc/man/man1/psselect.man1.pdf b/Master/texmf-dist/doc/man/man1/psselect.man1.pdf Binary files differnew file mode 100644 index 00000000000..ca055be91fe --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/psselect.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/pstopdf.1 b/Master/texmf-dist/doc/man/man1/pstopdf.1 new file mode 100644 index 00000000000..972f364cb19 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pstopdf.1 @@ -0,0 +1,75 @@ +.TH "PSTOPDF" "1" "December 2006" "pstopdf 2.0" "ConTeXt" +.de URL +\\$2 \(laURL: \\$1 \(ra\\$3 +.. +.if \n[.g] .mso www.tmac +.de EX +.in +3 +.nf +.ft CW +.. +.de EE +.in -3 +.ft R +.fi +.. + +.SH "NAME" +pstopdf \- convert EPS to PDF + +.SH "SYNOPSIS" +\fBpstopdf\fP [ \fIOPTION\fP ... ] \fIFILE\fP [ ... ] + +.SH "DESCRIPTION" + +\fBpstopdf\fP converts EPS (encapsulated PostScript) to PDF. + +.SH OPTIONS +.TP +.B --help +Print usage and version information. +.TP +.B --convert +Convert EPS to PDF. This option is assumed if none is given. +.TP +.BI --method=\fIstring\fP +What method to use for bounding boxes when converting to PDF. +Specify one of \fBcrop\fP, \fBbounded\fP (the default), or \fBraw\fP. +Older versions of ConTeXt used numerical methods (1, 2, or 3). +.TP +.BI --resolution=\fIstring\fP +The resolution to use when when converting to pdf. +Specify one of \fBlow\fP, \fBnormal\fP, \fBmedium\fP, \fBhigh\fP, +\fBprinter\fP, \fBprint\fP, \fBscreen\fP, \fBebook\fP, or +\fBdefault\fP. +.TP +.B --request +Handle exa request file. +.TP +.B --watch +Watch folders for conversions (\fIuntested\fP). + +.SH EXAMPLES + +To make \fIcow.pdf\fP: +.EX +pstopdf cow.eps +.EE +or (one of several equivalents): +.EX +pstopdf --convert cow.eps cow.pdf +.EE + + +.SH "SEE ALSO" +.PP +.BR epstopdf (1), +.BR mptopdf (1), +.BR ps2pdf (1), +.BR texexec (1). +.PP +.URL "http://www.contextgarden.net" "ConTeXt wiki" . + +.SH "AUTHOR" +This (incomplete) manual page was written by Sanjoy Mahajan +<sanjoy@mit.edu>. It is in the public domain. diff --git a/Master/texmf-dist/doc/man/man1/pstopdf.man1.pdf b/Master/texmf-dist/doc/man/man1/pstopdf.man1.pdf Binary files differnew file mode 100644 index 00000000000..3c67c3ebcd4 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pstopdf.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/pstops.1 b/Master/texmf-dist/doc/man/man1/pstops.1 new file mode 100644 index 00000000000..cc4d160c890 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pstops.1 @@ -0,0 +1,166 @@ +.TH PSTOPS 1 "PSUtils Release 1 Patchlevel 17" +.SH NAME +pstops \- shuffle pages in a PostScript file +.SH SYNOPSIS +.B pstops +[ +.B \-q +] [ +.B \-b +] [ +.B \-w\fIwidth\fR +] [ +.B \-h\fIheight\fR +] [ +.B \-p\fIpaper\fR +] [ +.B \-d\fIlwidth\fR +] +.I pagespecs +[ +.I infile +[ +.I outfile +] ] +.SH DESCRIPTION +.I Pstops +rearranges pages from a PostScript document, creating a new PostScript file. +The input PostScript file should follow the Adobe Document Structuring +Conventions. +.I Pstops +can be used to perform a large number of arbitrary re-arrangements of +Documents, including arranging for printing 2-up, 4-up, booklets, reversing, +selecting front or back sides of documents, scaling, etc. +.PP +.I pagespecs +follow the syntax: +.RS +.TP 12 +.I pagespecs +.I = [modulo:]specs +.TP +.I specs +.I = spec[+specs][,specs] +.TP +.I spec +.I = [-]pageno[L][R][U][@scale][(xoff,yoff)] +.RE +.sp +.I modulo +is the number of pages in each block. The value of +.I modulo +should be greater than 0; the default value is 1. +.I specs +are the page specifications for the pages in each block. The value of the +.I pageno +in each +.I spec +should be between 0 (for the first page in the block) and \fImodulo\fR-1 +(for the last page in each block) inclusive. +The optional dimensions +.I xoff +and +.I yoff +shift the page by the specified amount. +.I xoff +and +.I yoff +are in PostScript's points, but may be followed by the units +.B "cm" +or +.B "in" +to convert to centimetres or inches, or the flag +.B "w" +or +.B "h" +to specify as a multiple of the width or height. +The optional parameters \fIL\fR, \fIR\fR, and \fIU\fR rotate the page left, +right, or upside-down. +The optional +.I scale +parameter scales the page by the fraction specified. +If the optional minus sign is specified, the page is relative to the end of +the document, instead of the start. + +If page \fIspec\fRs are separated by +.B \+ +the pages will be merged into one page; if they are separated by +.B \, +they will be on separate pages. +If there is only one page specification, with +.I pageno +zero, the \fIpageno\fR may be omitted. + +The shift, rotation, and scaling are performed +in that order regardless of which order +they appear on the command line. +.PP +The +.I \-w +option gives the width which is used by the +.B "w" +dimension specifier, and the +.I \-h +option gives the height which is used by the +.B "h" +dimension specifier. These dimensions are also used (after scaling) to set the +clipping path for each page. +The +.I \-p +option can be used as an alternative, to set the paper size to +.B a3, a4, a5, b5, letter, legal, tabloid, statement, executive, folio, quarto +or +.B 10x14. +The default paper size is +.B a4. +.PP +The +.I \-b +option prevents any +.B bind +operators in the PostScript prolog from binding. This may be needed in cases +where complex multi-page re-arrangements are being done. +.PP +The +.I \-d +option draws a line around the border of each page, of the specified width. +If the \fIlwidth\fR parameter is omitted, a default linewidth of 1 point is +assumed. The linewidth is relative to the original page dimensions, +\fIi.e.\fR it is scaled up or down with the rest of the page. +.PP +Pstops normally prints the page numbers of the pages re-arranged; the +.I \-q +option suppresses this. +.SH EXAMPLES +This section contains some sample re-arrangements. To put two pages on one +sheet (of A4 paper), the pagespec to use is: +.sp +.ce +2:0L@.7(21cm,0)+1L@.7(21cm,14.85cm) +.sp +To select all of the odd pages in reverse order, use: +.sp +.ce +2:-0 +.sp +To re-arrange pages for printing 2-up booklets, use +.sp +.ce +4:-3L@.7(21cm,0)+0L@.7(21cm,14.85cm) +.sp +for the front sides, and +.sp +.ce +4:1L@.7(21cm,0)+-2L@.7(21cm,14.85cm) +.sp +for the reverse sides (or join them with a comma for duplex printing). +.SH AUTHOR +Copyright (C) Angus J. C. Duggan 1991-1995 +.SH "SEE ALSO" +epsffit(1), psbook(1), psnup(1), psresize(1), psselect(1), pstops(1), extractres(1), fixdlsrps(1), fixfmps(1), fixpsditps(1), fixpspps(1), fixscribeps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), includeres(1), psmerge(1), getafm(1) +.SH TRADEMARKS +.B PostScript +is a trademark of Adobe Systems Incorporated. +.SH BUGS +.I Pstops +does not accept all DSC comments. diff --git a/Master/texmf-dist/doc/man/man1/pstops.man1.pdf b/Master/texmf-dist/doc/man/man1/pstops.man1.pdf Binary files differnew file mode 100644 index 00000000000..9b44ee48ab4 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/pstops.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/purifyeps.1 b/Master/texmf-dist/doc/man/man1/purifyeps.1 new file mode 100644 index 00000000000..0b3121ab24f --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/purifyeps.1 @@ -0,0 +1,350 @@ +.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "PURIFYEPS 1" +.TH PURIFYEPS 1 "2010-11-28" "v1.1" "" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +purifyeps \- make an Encapsulated PostScript file work with both dvips and +pdflatex +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +purifyeps +\&\fB\-\-help\fR +.PP +purifyeps +\&\fB\-\-version\fR +.PP +purifyeps +[\fB\-\-fontmap\fR=\fI.fmp file\fR] +[\fI.eps input file\fR [\fI.eps output file\fR]] +.PP +purifyeps +\&\fB\-\-make\-man\fR[=\fIfilename\fR] [\fB\-\-section\fR=\fIsection\fR] +.PP +purifyeps +\&\fB\-\-make\-ps\-man\fR[=\fIfilename\fR] [\fB\-\-section\fR=\fIsection\fR] +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +While \fBpdflatex\fR has a number of nice features, its primary +shortcoming relative to standard \fBlatex\fR+\fBdvips\fR is that it is +unable to read ordinary Encapsulated PostScript (\s-1EPS\s0) files, the most +common graphics format in the LaTeX world. \fBpdflatex\fR can read only +the following types of graphics files: +.IP "\s-1PDF\s0" 4 +.IX Item "PDF" +Most people who use \fBpdflatex\fR convert their documents to \s-1PDF\s0 using a +utility such as \fBepstopdf\fR. This works well and preserves the vector +nature of the original \s-1EPS\s0. Unfortunately, \fBdvips\fR does not read +\&\s-1PDF\s0, so two versions of the graphic must be maintained if the document +is to be processed with both \fBlatex\fR+\fBdvips\fR and \fBpdflatex\fR. +.IP "\s-1PNG\s0" 4 +.IX Item "PNG" +\&\s-1PNG\s0 is a bitmap format and therefore scales poorly. Also, \fBdvips\fR +does not read \s-1PNG\s0, so two versions of the graphic must be maintained +if the document is to be processed with both \fBlatex\fR+\fBdvips\fR and +\&\fBpdflatex\fR. +.IP "\s-1JPEG\s0" 4 +.IX Item "JPEG" +\&\s-1JPEG\s0 is a bitmap format and therefore scales poorly. Also, \fBdvips\fR +does not read \s-1JPEG\s0, so two versions of the graphic must be maintained +if the document is to be processed with both \fBlatex\fR+\fBdvips\fR and +\&\fBpdflatex\fR. +.IP "\s-1MPS\s0" 4 +.IX Item "MPS" +This is probably the least-used \fBpdflatex\fR\-compatible graphics +format. \s-1MPS\s0 is actually a stylized version of \s-1EPS\s0 that MetaPost +outputs. Like \s-1PDF\s0, \s-1MPS\s0 is a vector format and remains as such when +imported into a \fBpdflatex\fR document. Also like \s-1PDF\s0, \fBdvips\fR does +not read \s-1MPS\s0, so two versions of the graphic must be maintained if the +document is to be processed with both \fBlatex\fR+\fBdvips\fR and +\&\fBpdflatex\fR. +.PP +The insight behind \fBpurifyeps\fR is that there are only a few, small +differences between \s-1MPS\s0 and \s-1EPS\s0 and that a file can be converted into +a format that matches both the \s-1MPS\s0 and \s-1EPS\s0 specifications +simultaneously. \fBpurifyeps\fR inputs an \s-1EPS\s0 file, uses \fBpstoedit\fR's +\&\f(CW\*(C`mpost\*(C'\fR filter to convert the file to MetaPost (\fI.mp\fR), runs +\&\fBmpost\fR on the file to convert it to \s-1MPS\s0, and finally performs some +touchups on the result to convert the file back to \s-1EPS\s0, while +preserving its ability to be parsed by \fBpdflatex\fR. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-\-help\fR" 4 +.IX Item "--help" +Display \*(L"Usage\*(R" and \*(L"Options\*(R" from the \fBpurifyeps\fR documentation. +.IP "\fB\-V\fR, \fB\-\-version\fR" 4 +.IX Item "-V, --version" +Display the \fBpurifyeps\fR version number, copyright, and license. +.IP "\fB\-\-fontmap\fR=\fI.fmp file\fR" 4 +.IX Item "--fontmap=.fmp file" +Specify the name of a file that tells \fBpurifyeps\fR how to map from TeX +font names to PostScript font names. [Default: \fImpost.fmp\fR] +.IP "\fB\-\-make\-man\fR [=\fIfilename\fR]] [\fB\-\-section\fR=\fIsection\fR]" 4 +.IX Item "--make-man [=filename]] [--section=section]" +Automatically create a Unix man page for \fBpurifyeps\fR. \fIsection\fR +specifies the section [default: \f(CW1\fR (User Commands)]. \fIfilename\fR +defaults to \fIpurifyeps.1\fR or an analogous filename if \fIsection\fR is +specified. +.IP "\fB\-\-make\-ps\-man\fR [=\fIfilename\fR]] [\fB\-\-section\fR=\fIsection\fR]" 4 +.IX Item "--make-ps-man [=filename]] [--section=section]" +Automatically create a PostScript version of the \fBpurifyeps\fR +documentation. The documentation is formatted like a Unix man page. +\&\fIsection\fR specifies the section [default: \f(CW1\fR (User Commands)]. +\&\fIfilename\fR defaults to \fIpurifyeps.ps\fR. +.PP +In normal operation (i.e., when not run with \f(CW\*(C`\-\-help\*(C'\fR, \f(CW\*(C`\-\-make\-man\*(C'\fR, +or \f(CW\*(C`\-\-make\-ps\-man\*(C'\fR), \fBpurifyeps\fR takes the name of an input file and +output file. The same filename can safely be used for both files. If +the output filename is omitted, output will go to the standard output +device. If the input filename is omitted, \fBpurifyeps\fR will read from +the standard input device. +.SH "EXAMPLES" +.IX Header "EXAMPLES" +Create a PostScript version of the \fBpurifyeps\fR documentation, but +call it \fIhappydoc.ps\fR instead of the default, \fIpurifyeps.ps\fR: +.PP +.Vb 1 +\& purifyeps \-\-make\-ps\-man=happydoc.ps +.Ve +.PP +Create a Unix man page for \fBpurifyeps\fR (in the usual roff format), +but indicate that it belongs in section \f(CW\*(C`LOCAL\*(C'\fR instead of the +default of section \f(CW1\fR: +.PP +.Vb 1 +\& purifyeps \-\-make\-man \-\-section=LOCAL +.Ve +.PP +Purify \fIsample.eps\fR (\fImpost.fmp\fR is in the current directory): +.PP +.Vb 1 +\& purifyeps sample.eps sample.eps +.Ve +.PP +Purify \fIsample.eps\fR (\fImpost.fmp\fR is in a different location): +.PP +.Vb 1 +\& purifyeps \-\-fontmap=/usr/share/pstoedit/mpost.fmp sample.eps sample.eps +.Ve +.PP +Rename the purified version while purifying: +.PP +.Vb 1 +\& purifyeps sample.eps sample\-pure.eps +.Ve +.PP +Do the same, but in a Unix pipeline: +.PP +.Vb 1 +\& cat sample.eps | purifyeps > sample\-pure.eps +.Ve +.PP +When you run \fBpurifyeps\fR, you should see the output from both +\&\fBpstoedit\fR and \fBmpost\fR, followed by a success message from +\&\fBpurifyeps\fR: +.PP +.Vb 8 +\& % cat sample.eps | purifyeps > sample\-pure.eps +\& pstoedit: version 3.30 / DLL interface 107 (build Mar 14 2002) : +\& Copyright (C) 1993 \- 2001 Wolfgang Glunz +\& Interpreter finished. Return status 0 +\& This is MetaPost, Version 0.641 (Web2C 7.3.1) +\& (/tmp/purifyeps\-jdeGPkh9.mp [1] ) +\& 1 output file written: purifyeps\-jdeGPkh9.1 +\& Transcript written on purifyeps\-jdeGPkh9.log. +\& +\& File seems to have been purified successfully. +.Ve +.SH "FILES" +.IX Header "FILES" +.IP "\fImpost.fmp\fR" 4 +.IX Item "mpost.fmp" +File containing mappings between TeX and PostScript font names. See +\&\*(L"\s-1NOTES\s0\*(R" for a description of this file's contents. +.SH "BUGS" +.IX Header "BUGS" +Error reporting could definitely stand to be improved. Error messages +produced by \fBpstoedit\fR and \fBmpost\fR are sometimes silently ignored. +Also, errors sometimes cause \fBpurifyeps\fR to leave temporary files +(\fIpurifyeps\-\fR\fI#####\fR) lying around. +.PP +\&\fBpurifyeps\fR is subject to all of the limitations that affect +\&\fBpstoedit\fR and especially the \f(CW\*(C`mpost\*(C'\fR backend to \fBpstoedit\fR. As a +result, \fBpurifyeps\fR ignores certain PostScript constructs, such as +nonuniformly scaled text. +.SH "NOTES" +.IX Header "NOTES" +\&\fBpurifyeps\fR needs a file that tells it how to map from TeX font names +to PostScript font names. This file must contain two, space-separated +columns. The first lists a PostScript font name, and the second lists +the TeX equivalent. Blank lines and lines that start with \f(CW\*(C`%\*(C'\fR are +ignored. The following is a sample \fI.fmp\fR file: +.PP +.Vb 10 +\& % This is a sample font map for purifyeps. +\& Times\-Bold ptmb +\& Times\-Italic ptmri +\& Times\-Roman ptmr +\& Helvetica phvr +\& Helvetica\-Bold phvb +\& Helvetica\-Oblique phvro +\& Courier pcrr +\& Courier\-Bold pcrb +\& Courier\-Oblique pcrro +.Ve +.PP +Note that this is exactly the same format that \fBpstoedit\fR uses. By +default, \fBpurifyeps\fR looks in the current directory for a font map +called \fImpost.fmp\fR. The \f(CW\*(C`\-\-fontmap\*(C'\fR command-line option tells +\&\fBpurifyeps\fR to use a different font map, which will typically be the +\&\fImpost.fmp\fR file that comes with \fBpstoedit\fR. +.PP +Once you create purified \s-1EPS\s0 files with \fBpurifyeps\fR, you need to +instruct \fBpdflatex\fR to use them. The pdfLaTeX configuration of the +\&\f(CW\*(C`graphics\*(C'\fR and \f(CW\*(C`graphicx\*(C'\fR packages (\fIpdftex.def\fR) normally ignores +\&\fI.eps\fR files. Putting the following LaTeX code in your document's +preamble tells \fBpdflatex\fR that all \fI.eps\fR files are in \s-1MPS\s0 format: +.PP +.Vb 9 +\& % Tell pdfLaTeX that all .eps files were produced by MetaPost. +\& \eusepackage{graphicx} % or graphics +\& \eusepackage{ifpdf} +\& \eifpdf +\& \eDeclareGraphicsRule{.eps}{mps}{*}{} +\& \emakeatletter +\& \eg@addto@macro\eGin@extensions{,.eps} +\& \emakeatother +\& \efi +.Ve +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fIdvips\fR\|(1), \fIepstopdf\fR\|(1), \fIlatex\fR\|(1), \fImpost\fR\|(1), \fIpdflatex\fR\|(1), \fIpstoedit\fR\|(1) +.SH "AUTHOR" +.IX Header "AUTHOR" +Scott Pakin, \fIscott+peps@pakin.org\fR diff --git a/Master/texmf-dist/doc/man/man1/purifyeps.man1.pdf b/Master/texmf-dist/doc/man/man1/purifyeps.man1.pdf Binary files differnew file mode 100644 index 00000000000..b8ffd46d04e --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/purifyeps.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/repstopdf.1 b/Master/texmf-dist/doc/man/man1/repstopdf.1 new file mode 100644 index 00000000000..a48cf2cd9c3 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/repstopdf.1 @@ -0,0 +1 @@ +.so man1/epstopdf.1 diff --git a/Master/texmf-dist/doc/man/man1/repstopdf.man1.pdf b/Master/texmf-dist/doc/man/man1/repstopdf.man1.pdf Binary files differnew file mode 100644 index 00000000000..f504bf57450 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/repstopdf.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/rubibtex.1 b/Master/texmf-dist/doc/man/man1/rubibtex.1 new file mode 100644 index 00000000000..0142072a769 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/rubibtex.1 @@ -0,0 +1,63 @@ +.TH "rubibtex" "1" "October 2000" "teTeX" "teTeX" +.PP +.SH "NAME" +rubibtex \- make a bibliography for (La)TeX using Russian +letters as item names +.PP +.SH "SYNOPSIS" +.PP +\fBrubibtex\fP \fIBASENAME\fP +.PP +.SH "DESCRIPTION" +.PP +\fBrubibtex\fP is used to run \fBbibtex\fP(1) on auxiliary files with +Russian characters in item names (citation keys)\&. It is part of the +T2 package\&. +.PP +\fBrubibtex\fP copies the auxiliary file to \fI/tmp\fP, uses +\fBsed\fP(1) to convert Cyrillic character commands to their 8-bit +ASCII equivalents; runs \fBbibtex\fP(1) on the modified file; and +finally moves the original auxiliary file back (overwriting the +modified file)\&. +.PP +\fBrubibtex\fP assumes that the \fBbibtex\fP(1) database (\f(CWbib\fP) +files are encoded with the KOI8-R encoding\&. +.PP +.SH "FILES" +.PP +.IP +.IP "\fIbasename\&.aux\fP" +LaTeX auxiliary file +.IP +.PP +.SH "BUGS" +.PP +None known, but report any bugs found to the authors\&. +.PP +.SH "COPYRIGHT" +.PP +The T2 package is Copyright 1997-1999 Werner Lemberg, Vladimir +Volovich and any individual authors listed elsewhere in package files\&. +.PP +It may be distributed under the conditions of the LaTeX Project Public +License, either version 1\&.1 of this license or (at your option) any +later version\&. +.PP +.SH "SEE ALSO" +.PP +\fBbibtex\fP(1), \fBsed\fP(1), +<ftp://ftp\&.vsu\&.ru/pub/tex/T2/README>\&. +.PP +.SH "AUTHOR" +.PP +Werner Lemberg +<wl@gnu\&.org>, Vladimir Volovich +<TeX@vvv\&.vsu\&.ru>\&. +.PP +This manual page was written by C\&.M\&. Connelly +<c@eskimo\&.com>, for +the Debian GNU/Linux system\&. It may be used by other distributions +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)\&. +.PP diff --git a/Master/texmf-dist/doc/man/man1/rubibtex.man1.pdf b/Master/texmf-dist/doc/man/man1/rubibtex.man1.pdf Binary files differnew file mode 100644 index 00000000000..cab5d19f3ed --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/rubibtex.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/rumakeindex.1 b/Master/texmf-dist/doc/man/man1/rumakeindex.1 new file mode 100644 index 00000000000..0fb271841d0 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/rumakeindex.1 @@ -0,0 +1,63 @@ +.TH "rumakeindex" "1" "September 2000" "teTeX" "teTeX" +.PP +.SH "NAME" +rumakeindex \- process a LaTeX index using Russian Cyrillic +characters +.PP +.SH "SYNOPSIS" +.PP +\fBrumakeindex\fP \fIbasename\fP +.PP +.SH "DESCRIPTION" +.PP +\fBrumakeindex\fP is used to run \fBmakeindex\fP(1) on \f(CWidx\fP files +that use Russian characters\&. It is part of the T2 package\&. +.PP +\fBrumakeindex\fP runs \fBsed\fP(1) on the \f(CWidx\fP file to convert +Cyrillic character commands to 8-bit ASCII characters; pipes the +results through \fBmakeindex\fP(1); and then through \fBtr\fP(1) +to do some final conversions\&. The results are placed in a KOI8-R +encoded \f(CWind\fP file\&. +.PP +.SH "FILES" +.PP +.IP +.IP "\fIbasename\&.idx\fP" +LaTeX index entry file +.IP "\fIbasename\&.ilg\fP" +LaTeX index log file +.IP "\fIbasename\&.ind\fP" +LaTeX processed index file +.IP +.PP +.SH "BUGS" +.PP +None known, but report any bugs found to the authors\&. +.PP +.SH "COPYRIGHT" +.PP +The T2 package is Copyright 1997-1999 Werner Lemberg, Vladimir +Volovich and any individual authors listed elsewhere in package files\&. +.PP +It may be distributed under the conditions of the LaTeX Project Public +License, either version 1\&.1 of this license or (at your option) any +later version\&. +.PP +.SH "SEE ALSO" +.PP +\fBmakeindex\fP(1), \fBsed\fP(1), \fBtr\fP(1), +<ftp://ftp\&.vsu\&.ru/pub/tex/T2/README>\&. +.PP +.SH "AUTHOR" +.PP +Werner Lemberg +<wl@gnu\&.org>, Vladimir Volovich +<TeX@vvv\&.vsu\&.ru>\&. +.PP +This manual page was written by C\&.M\&. Connelly +<c@eskimo\&.com>, for +the Debian GNU/Linux system\&. It may be used by other distributions +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)\&. +.PP diff --git a/Master/texmf-dist/doc/man/man1/rumakeindex.man1.pdf b/Master/texmf-dist/doc/man/man1/rumakeindex.man1.pdf Binary files differnew file mode 100644 index 00000000000..3513d6a39c5 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/rumakeindex.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/scor2prt.1 b/Master/texmf-dist/doc/man/man1/scor2prt.1 new file mode 100644 index 00000000000..4e38a161cb0 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/scor2prt.1 @@ -0,0 +1,18 @@ +.TH scor2prt 1 "5 March 2012" "Version 2.6.17" "scor2prt Manual Page" +.SH NAME +scor2prt \- source-parts separation program for pmx, a MusiXTeX preprocessor +.SH SYNOPSIS +.B scor2prt +.RI basename [.pmx] +.SH DESCRIPTION +scor2prt is part of pmx(1), a preprocessor for MusiXTeX. It can automatically +create parts from a score by generating a set of .pmx files, one for each part, +from a single .pmx file for the score. The appearance of the parts can be +controlled by special commands in the main file. Read the PMX Manual for more +information about that. +.SH SEE ALSO +pmx(1), pmxab(1), musixtex(1), PMX Manual +.SH AUTHORS +PMX was written by Don Simons <dsimons@roadrunner.com>. +This manual page was written by Roland Stigge <stigge@antcom.de> for the Debian +project and revised by Bob Tennent <rdt@cs.queensu.ca>. diff --git a/Master/texmf-dist/doc/man/man1/scor2prt.man1.pdf b/Master/texmf-dist/doc/man/man1/scor2prt.man1.pdf Binary files differnew file mode 100644 index 00000000000..1ea46b9b310 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/scor2prt.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/sjisconv.1 b/Master/texmf-dist/doc/man/man1/sjisconv.1 new file mode 100644 index 00000000000..87eb59e4859 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/sjisconv.1 @@ -0,0 +1,110 @@ +.\" man page for sjisconv +.\" Copyright (C) 1994-2012 Werner Lemberg <wl@gnu.org> +.\" +.\" 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 2 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 in doc/COPYING; if not, write to the Free +.\" Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, +.\" MA 02110-1301 USA +. +.TH SJISCONV 1 07-May-2012 "CJK Version 4.8.3" +. +.\" ==== +.\" ==== macro definitions +.\" ==== +. +.\" here we define \TeX for troff and nroff +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +. +.\" and here the same for \LaTeX +.if t \{\ +.ie '\*(.T'dvi' \ +.ds LX \fRL\h'-0.36m'\v'-0.15v'\s-3A\s0\h'-0.15m'\v'0.15v'\fP\*(TX +.el .ds LX \fRL\h'-0.36m'\v'-0.22v'\s-2A\s0\h'-0.15m'\v'0.22v'\fP\*(TX +.\} +.if n .ds LX LaTeX +. +.\" \LaTeXe +.\" note that we need \vareps for TeX instead of \eps which can only be +.\" accessed with the \N escape sequence (in the Math Italic font) +.if t \{\ +.ie '\*(.T'dvi' .ds LE \*(LX\h'0.15m'2\v'0.20v'\f(MI\N'34'\fP\v'-0.20v' +.el .ds LE \*(LX\h'0.15m'2\v'0.20v'\(*e\v'-0.20v' +.\} +.if n .ds LE LaTeX\ 2e +. +.\" a typewriter font +.if t \{\ +.de C +\fC\\$1\fP\\$2 +.. +.\} +.if n \{\ +.de C +\\$1\\$2 +.. +.\} +. +.\" ==== +.\" ==== end of macro definitions +.\" ==== +. +. +. +.SH NAME +sjisconv \- convert a TeX document in SJIS encoding into `preprocessed' +form. +. +. +.SH SYNOPSIS +.B sjisconv +< +.I infile +> +.I outfile +. +. +.SH DESCRIPTION +SJIS encoding for Japanese uses the characters +.C { , +.C } , +and +.C \e +which have special meanings in \*(TX +documents. +.PP +After processing a \*(LE +document which contains SJIS characters with +.B \%sjisconv +you need not care about these special characters. +.PP +This filter is part of the +.B CJK +macro package for \*(LE. +. +. +.SH "SEE ALSO" +.BR bg5conv (1), +.BR \%cefconv (1), +.BR cef5conv (1), +.BR \%cefsconv (1), +.BR \%extconv (1), +.br +the +.B CJK +documentation files. +. +. +.SH AUTHOR +Werner Lemberg +.C <wl@gnu.org> diff --git a/Master/texmf-dist/doc/man/man1/sjisconv.man1.pdf b/Master/texmf-dist/doc/man/man1/sjisconv.man1.pdf Binary files differnew file mode 100644 index 00000000000..1950d4efc45 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/sjisconv.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/splitindex.1 b/Master/texmf-dist/doc/man/man1/splitindex.1 new file mode 100644 index 00000000000..ac8988b0cd8 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/splitindex.1 @@ -0,0 +1,64 @@ +.TH SPLITINDEX "1" "April 2013" "splitindex 0.2a" "User Commands" +.SH NAME +splitindex \- manual page for splitindex 0.2a +.SH SYNOPSIS +.B splitindex.pl +[\fIOPTION\fR] ... \fIINTERMEDIATE-INDEX-FILE \fR[\fIMAKEINDEX-OPTION\fR] ... +.PP +.B splitindex +[\fIOPTION\fR] ... \fIINTERMEDIATE-INDEX-FILE \fR[\fIMAKEINDEX-OPTION\fR] ... +.PP +.B java splitindex +[\fIOPTION\fR] ... \fIINTERMEDIATE-INDEX-FILE \fR[\fIMAKEINDEX-OPTION\fR] ... +.PP +.B tex splitindex +.SH DESCRIPTION +splitindex 0.2a +Copyright (c) 2002 Markus Kohm <kohm@gmx.de> +.PP +Split a single intermediate index file into multiple raw index files. +.PP +Example: splitindex.pl foo.idx. +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help and terminate +.TP +\fB\-m\fR, \fB\-\-makeindex\fR PROGNAME +call PROGNAME instead of default `makeindex'. +.TP +\fB\-i\fR, \fB\-\-identify\fR EXPRESSION +use regular EXPRESSION to match entries +(see also option \fB\-\-resultis\fR and \fB\-\-suffixis\fR). +Default is `^(\e\eindexentry)\e[([^]]*)\e](.*)$'. +.TP +\fB\-r\fR, \fB\-\-resultis\fR PATTERN +create line to be written from PATTERN after matching +lines (see also option \fB\-\-identify\fR). +Default is `$1$3'. +.TP +\fB\-s\fR, \fB\-\-suffixis\fR PATTERN +create suffix to be used from PATTERN after matching +lines (see also option \fB\-\-identify\fR). +Default is `-$2'. +.TP +\fB\-v\fR, \fB\-\-verbose\fR +be more verbose +(can be used multiple to increase verbosity) +.TP +\fB\-\-version\fR +show version and terminate +.SH COPYRIGHT +Copyright \(co 2002 Markus Kohm <kohm@gmx.de> +.SH "SEE ALSO" +The full documentation for +.B splitindex +is maintained as a LaTeX manual. If the +.B texdoc +and +.B splitindex +programs are properly installed at your site, the command +.IP +.B texdoc splitidx +.PP +should give you access to the complete manual. diff --git a/Master/texmf-dist/doc/man/man1/splitindex.man1.pdf b/Master/texmf-dist/doc/man/man1/splitindex.man1.pdf Binary files differnew file mode 100644 index 00000000000..854a85b8138 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/splitindex.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/sty2dtx.1 b/Master/texmf-dist/doc/man/man1/sty2dtx.1 new file mode 100644 index 00000000000..692dad8320e --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/sty2dtx.1 @@ -0,0 +1,340 @@ +.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "STY2DTX 1" +.TH STY2DTX 1 "2012-11-07" "perl v5.14.2" "User Contributed Perl Documentation" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +sty2dtx \-\- Converts a LaTeX .sty file to a documented .dtx file +.SH "VERSION" +.IX Header "VERSION" +Version: v2.3 +.SH "COPYRIGHT" +.IX Header "COPYRIGHT" +Copyright (c) 2010\-2012 Martin Scharrer <martin@scharrer\-online.de> +.PP +This program is free software: you can redistribute it and/or modify +it under the terms of the \s-1GNU\s0 General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. +.PP +This program is distributed in the hope that it will be useful, +but \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of +\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0. See the +\&\s-1GNU\s0 General Public License for more details. +.PP +You should have received a copy of the \s-1GNU\s0 General Public License +along with this program. If not, see <http://www.gnu.org/licenses/>. +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +Converts a .sty file (LaTeX package) to .dtx format (documented LaTeX source), +by surrounding macro definitions with 'macro' and 'macrocode' environments. +The macro name is automatically inserted as an argument to the 'macro' +environemnt. +Code lines outside macro definitions are wrapped only in 'macrocode' +environments. Empty lines are removed. +The script is not thought to be fool proof and 100% accurate but rather +as a good start to convert undocumented style files to .dtx files. +.SS "Basic Usage" +.IX Subsection "Basic Usage" +.Vb 1 +\& perl sty2dtx.pl infile [infile ...] outfile +.Ve +.PP +or +.PP +.Vb 1 +\& perl sty2dtx.pl < file.sty > file.dtx +.Ve +.SS "Supported Definitions" +.IX Subsection "Supported Definitions" +The following macro definitions are detected when they are at the start of a +line (can be prefixed by \eglobal, \elong, \eprotected and/or \eouter): +.PP +.Vb 8 +\& \edef \eedef \egdef \exdef +\& \enewcommand{\ename} \enewcommand*{\ename} +\& \enewcommand\ename \enewcommand*\ename +\& \erenewcommand{\ename} \erenewcommand*{\ename} +\& \erenewcommand\ename \erenewcommand*\ename +\& \eprovidecommand{\ename} \eprovidecommand*{\ename} +\& \eprovidecommand\ename \eprovidecommand*\ename +\& \e@namedef{\ename} \e@namedef\ename +.Ve +.PP +The following environment definitions are detected when they are at the start +of a line: +.PP +.Vb 1 +\& \enewenvironment{name} \erenewenvironemnt{name} \eprovideenvironment{name} +.Ve +.PP +The macro and environment definition must either end at the same line or with +a '\f(CW\*(C`}\*(C'\fR' on its own on a line. +.SH "USAGE" +.IX Header "USAGE" +.Vb 1 +\& sty2dtx [<options>] [\-\-<VAR>=<VALUE> ...] [\-\-] [<infile(s)>] [<outfile>] +.Ve +.SS "Files" +.IX Subsection "Files" +.IP "\(bu" 2 +can be '\f(CW\*(C`\-\*(C'\fR' for \s-1STDIN\s0 or \s-1STDOUT\s0, which is the default if no files are given +.IP "\(bu" 2 +multiple input files are merged to one output file +.SS "Variables" +.IX Subsection "Variables" +Variables can be defined using +.PP +.Vb 1 +\& \-\-<VAR>=<VALUE> +.Ve +.PP +or +.PP +.Vb 1 +\& \-\-<VAR> <VALUE> +.Ve +.PP +and will be used for substitutions in the template file. +.PP +\fICommon variables:\fR +.IX Subsection "Common variables:" +.PP +.Vb 4 +\& author, email, maintainer, year (for copyright), +\& version, date, description (of package/class), +\& type (either \*(Aqpackage\*(Aq default or \*(Aqclass\*(Aq), +\& filebase (automatically set from output or input file name), +.Ve +.SS "Options" +.IX Subsection "Options" +.IP "\fB\-h\fR \ \ \ \ \ \ \ \ \ \ Print this help text" 8 +.IX Item "-h Print this help text" +.PD 0 +.IP "\fB\-H\fR \ \ \ \ \ \ \ \ \ \ Print extended help" 8 +.IX Item "-H Print extended help" +.IP "\fB\-V\fR \ \ \ \ \ \ \ \ \ \ Print version and copyright" 8 +.IX Item "-V Print version and copyright" +.IP "\fB\-v\fR \ \ \ \ \ \ \ \ \ \ Be verbose" 8 +.IX Item "-v Be verbose" +.IP "\fB\-o\fR \fIoutput\fR \ \ \ Use given file as output" 8 +.IX Item "-o output Use given file as output" +.IP "\fB\-O\fR \ \ \ \ \ \ \ \ \ \ Overwrite already existing output file(s)" 8 +.IX Item "-O Overwrite already existing output file(s)" +.IP "\fB\-B\fR \ \ \ \ \ \ \ \ \ \ Use basename of single input file for output file" 8 +.IX Item "-B Use basename of single input file for output file" +.IP "\fB\-I\fR \ \ \ \ \ \ \ \ \ \ Also create .ins (install) file" 8 +.IX Item "-I Also create .ins (install) file" +.IP "\fB\-c\fR \ \ \ \ \ \ \ \ \ \ Only use code section (like v1.0)" 8 +.IX Item "-c Only use code section (like v1.0)" +.IP "\fB\-r\fR \ \ \ \ \ \ \ \ \ \ Remove existing 'macro', 'macrocode', etc. environments." 8 +.IX Item "-r Remove existing 'macro', 'macrocode', etc. environments." +.IP "\fB\-R\fR \ \ \ \ \ \ \ \ \ \ Do not remove existing 'macro', 'macrocode', etc. environments." 8 +.IX Item "-R Do not remove existing 'macro', 'macrocode', etc. environments." +.IP "\fB\-i\fR \fIins-file\fR \ Create .ins file with given name" 8 +.IX Item "-i ins-file Create .ins file with given name" +.IP "\fB\-t\fR \fItemplate\fR \ Use this file as template instead of the default one" 8 +.IX Item "-t template Use this file as template instead of the default one" +.IP "\fB\-T\fR \fItemplate\fR \ Use this file as template for the .ins file" 8 +.IX Item "-T template Use this file as template for the .ins file" +.IP "\fB\-e\fR \fIfile\fR \ \ \ \ \ Export default .dtx template to file and exit" 8 +.IX Item "-e file Export default .dtx template to file and exit" +.IP "\fB\-E\fR \fIfile\fR \ \ \ \ \ Export default .ins template to file and exit" 8 +.IX Item "-E file Export default .ins template to file and exit" +.IP "\fB\-D\fR \ \ \ \ \ \ \ \ \ \ Use current date as file date" 8 +.IX Item "-D Use current date as file date" +.IP "\fB\-F\fR \fIfile\fR \ \ \ \ \ Read more options and variables from file." 8 +.IX Item "-F file Read more options and variables from file." +.IP "\fB\-N\fR \ \ \ \ \ \ \ \ \ \ Do not read default config file; must be the first option" 8 +.IX Item "-N Do not read default config file; must be the first option" +.PD +.SS "Config files" +.IX Subsection "Config files" +A default config file either named 'sty2dtx.cfg' or '.sty2dtx.cfg' is searched +in the current directory, the users home directory and the directory of this +script, in this order. The first one found is loaded. If none is found the +\&'texmf' tree is searched for a 'sty2dtx.cfg' config file. As with \-F files the +config file should contain one option or variable per line. +Lines starting with '\f(CW\*(C`%\*(C'\fR' or '\f(CW\*(C`#\*(C'\fR' are ignored. +.SH "Examples" +.IX Header "Examples" +Produce 'file.dtx' from 'file.sty': +.PP +.Vb 1 +\& sty2dtx.pl < file.sty > file.dtx +.Ve +.PP +or +.PP +.Vb 1 +\& sty2dtx.pl file.sty file.dtx +.Ve +.PP +or +.PP +.Vb 1 +\& sty2dtx.pl \-B file.sty +.Ve +.PP +Produce 'file.dtx' and 'file.ins' from 'file.sty': +.PP +.Vb 1 +\& sty2dtx.pl \-I file.sty file.dtx +.Ve +.PP +or +.PP +.Vb 1 +\& sty2dtx.pl file.sty \-i file.sty file.dtx +.Ve +.PP +or +.PP +.Vb 1 +\& sty2dtx.pl \-IB file.sty +.Ve +.PP +Set custom variable values: +.PP +.Vb 1 +\& sty2dtx.pl \-\-author Me \-\-email me@there.com mypkg.sty mypkg.dtx +.Ve +.PP +Produce \s-1DTX\s0 file for a class: +.PP +.Vb 1 +\& sty2dtx.pl \-\-type class mycls.sty mycls.dtx +.Ve +.SH "AUTHOR" +.IX Header "AUTHOR" +Martin Scharrer +.PP +E\-mail: martin@scharrer\-online.de +.PP +\&\s-1WWW:\s0 http://www.scharrer\-online.de <http://www.scharrer-online.de> diff --git a/Master/texmf-dist/doc/man/man1/sty2dtx.man1.pdf b/Master/texmf-dist/doc/man/man1/sty2dtx.man1.pdf Binary files differnew file mode 100644 index 00000000000..962b7ebefaf --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/sty2dtx.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/synctex.1 b/Master/texmf-dist/doc/man/man1/synctex.1 new file mode 100644 index 00000000000..5bb2bf4f98e --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/synctex.1 @@ -0,0 +1,34 @@ +.Dd 03/13/12 \" DATE +.Dt synctex 1 \" Program name and manual section number +.Sh NAME +.Nm synctex +.Nd command line client tool to support the Synchronize TeXnology available in recent TeX engines. +.Sh SYNOPSIS +.Nm +\fIcommand\fP [\fIoptions\fP] [\fIargs\fP] +.Sh OVERVIEW +The Synchronization TeXnology is a new feature of recent TeX engines. +It allows to synchronize between input and output, +which means to navigate from the source document to the typeset material +and vice versa. +.Pp +Run `synctex help' to access the built-in tool documentation. +.Sh SEE ALSO +.\" List links in ascending order by section, alphabetically within a section. +.\" Please do not reference files that do not exist without filing a bug report +.Xr synctex 5 +.Xr tex 1 +.Sh AUTHOR +The Synchronize TeXnology is essentially due to Jerome Laurens, +with useful suggestions by some well known actors of the TeX world. +.\" .Sh BUGS \" Document known, unremedied bugs +.Sh HISTORY \" Document history if command behaves in a unique manner +This document has never been updated. +.\" nroff -man synctex.1 | less +.\"groff -man -Tascii synctex.1 | less +.\"To convert a man page to plain pre-formatted text (e.g for spell checking) use: +.\"nroff -man synctex.1 | col -b > synctex.1.txt +.\"To convert it to Postscript (for printing or further conversion to pdf) use: +.\"groff -man -Tps synctex.1 > synctex.1.ps +.\"To convert the man page to html use: +.\"man2html synctex.1 diff --git a/Master/texmf-dist/doc/man/man1/synctex.man1.pdf b/Master/texmf-dist/doc/man/man1/synctex.man1.pdf Binary files differnew file mode 100644 index 00000000000..c63e0f9e622 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/synctex.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/t1ascii.1 b/Master/texmf-dist/doc/man/man1/t1ascii.1 new file mode 100644 index 00000000000..0ee3b6e5db8 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/t1ascii.1 @@ -0,0 +1,51 @@ +.ds V 1.37 +.de M +.BR "\\$1" "(\\$2)\\$3" +.. +.TH T1ASCII 1 "" "Version \*V" +.SH NAME +t1ascii \- convert PostScript Type 1 font from binary to ASCII +.SH SYNOPSIS +.B t1ascii +\%[\fB\-l\fR \fIlength\fR] +\%[\fIinput\fR [\fIoutput\fR]] +.SH DESCRIPTION +.BR t1ascii +converts Adobe Type 1 font programs in PFB (binary) format to PFA +(hexadecimal) format. If the file +.I output +is not specified output goes to the standard output. +If the file +.I input +is not specified input comes from the standard input. +' +.SH OPTIONS +.TP 5 +.BI \-\-line\-length= "num\fR, " \-l " num" +Set the maximum length of encrypted lines in the output to +.I num. +(These are the lines consisting wholly of hexadecimal digits.) The default +is 64. +' +.TP 5 +.BR \-\-warnings ", " \-w +Warn when the input font contains lines longer than 255 characters. +Long lines don't strictly conform to Adobe's Document Structuring +Conventions, and may cause problems with older software. +' +.SH "SEE ALSO" +.LP +.M t1binary 1 , +.M t1unmac 1 , +.M t1mac 1 , +.M t1asm 1 , +.M t1disasm 1 +.LP +.I "Adobe Type 1 Font Format" +.SH AUTHORS +Lee Hetherington (ilh@lcs.mit.edu) +.br +Eddie Kohler (ekohler@gmail.com) +.PP +Ported to Microsoft C/C++ Compiler and MS-DOS operating system by +Kai-Uwe Herbing (herbing@netmbx.netmbx.de). diff --git a/Master/texmf-dist/doc/man/man1/t1ascii.man1.pdf b/Master/texmf-dist/doc/man/man1/t1ascii.man1.pdf Binary files differnew file mode 100644 index 00000000000..03647c0c020 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/t1ascii.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/t1asm.1 b/Master/texmf-dist/doc/man/man1/t1asm.1 new file mode 100644 index 00000000000..12e79a3729c --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/t1asm.1 @@ -0,0 +1,96 @@ +.ds V 1.37 +.de M +.BR "\\$1" "(\\$2)\\$3" +.. +.TH T1ASM 1 "" "Version \*V" +.SH NAME +t1asm \- assemble PostScript Type 1 font +.SH SYNOPSIS +.B t1asm +\%[\fB\-a\fR|\fB\-b\fR] +\%[\fB\-l\fR \fIlength\fR] +\%[\fIinput\fR [\fIoutput\fR]] +.SH DESCRIPTION +.B t1asm +assembles Adobe Type 1 font programs into either PFA (hexadecimal) or PFB +(binary) formats from a human-readable form. If the file +.I output +is not specified output goes to the standard output. If the file +.I input +is not specified input comes from the standard input. + +.B t1asm +tokenizes the charstring data and performs eexec and charstring encryption +as specified in the ``black book,'' +.I "Adobe Type 1 Font Format." + +The input must have a line of the form +.RS +.nf +.ft B +/-|{string currentfile exch readstring pop}executeonly def +.ft R +.fi +.RE +which defines the command, in this case `\-|', that is to start charstring +data. It is an error not to define such a command. Another common name for +this command is `RD'. + +After the start of the +.B Subrs +array in the input, all open braces `{' not in a comment begin a +charstring. Such a charstring is terminated by the next non-comment close +brace `}'. Within such a charstring, only comments, integers, and valid +charstring commands are allowed. Valid charstring command names can be +found in +.I "Adobe Type 1 Font Format" +and other documents describing the newer Type 2 opcodes. The format within +a charstring is unimportant as long as integers and commands are separated +by at least a one whitespace (space, tab, newline) character. Note that +within charstrings, comments are discarded because they cannot be encoded. +.SH OPTIONS +.TP 5 +.BR \-\-pfa ", " \-a +Output in PFA (ASCII) format. +.TP 5 +.BR \-\-pfb ", " \-b +Output in PFB (binary) format. This is the default. +.TP +.BI \-\-block\-length= "num\fR, " \-l " num" +PFB only: Set the maximum output block length to +.I num. +The default length is as large as memory allows. +.TP +.BI \-\-line\-length= "num\fR, " \-l " num" +PFA only: Set the maximum length of encrypted lines in the output to +.I num. +(These are the lines consisting wholly of hexadecimal digits.) The default +is 64. +.SH EXAMPLES +.LP +.nf +% t1asm Utopia-Regular.raw > Utopia-Regular.pfb +% t1asm -a Utopia-Regular.raw > Utopia-Regular.pfa +.fi +.SH "SEE ALSO" +.LP +.M t1disasm 1 , +.M t1ascii 1 , +.M t1binary 1 , +.M t1unmac 1 , +.M t1mac 1 +.LP +.I "Adobe Type 1 Font Format" +is available free from Adobe as a PDF file. +http://partners.adobe.com/asn/developer/PDFS/TN/T1_SPEC.PDF +.LP +.I "The Type 2 Charstring Format," +also available from Adobe as a PDF file, describes the newer Type 2 +operators, which are also used in some multiple-master Type 1 fonts like +Adobe Jenson and Kepler. +http://partners.adobe.com/asn/developer/PDFS/TN/5177.Type2.pdf +' +.SH AUTHORS +Lee Hetherington (ilh@lcs.mit.edu) +.br +Eddie Kohler (ekohler@gmail.com) diff --git a/Master/texmf-dist/doc/man/man1/t1asm.man1.pdf b/Master/texmf-dist/doc/man/man1/t1asm.man1.pdf Binary files differnew file mode 100644 index 00000000000..22a6a978a9f --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/t1asm.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/t1binary.1 b/Master/texmf-dist/doc/man/man1/t1binary.1 new file mode 100644 index 00000000000..8f55e93c48d --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/t1binary.1 @@ -0,0 +1,42 @@ +.ds V 1.37 +.de M +.BR "\\$1" "(\\$2)\\$3" +.. +.TH T1BINARY 1 "" "Version \*V" +.SH NAME +t1binary \- convert PostScript Type 1 font from ASCII to binary +.SH SYNOPSIS +.B t1binary +\%[\fB\-l\fR \fIlength\fR] +\%[\fIinput\fR [\fIoutput\fR]] +.SH DESCRIPTION +.B t1binary +converts Adobe Type 1 font programs in PFA (hexadecimal) format to PFB +(binary) format. If the file +.I output +is not specified output goes to the standard output. +If the file +.I input +is not specified input comes from the standard input. +.SH OPTIONS +.TP 5 +.BI \-\-block\-length= "length\fR, " \-l " length" +Set the maximum length of sections in PFB output to +.I length. +The default length is as large as memory allows. +.SH "SEE ALSO" +.LP +.M t1ascii 1 , +.M t1unmac 1 , +.M t1mac 1 , +.M t1disasm 1 , +.M t1asm 1 +.LP +.I "Adobe Type 1 Font Format" +.SH AUTHORS +Lee Hetherington (ilh@lcs.mit.edu) +.br +Eddie Kohler (ekohler@gmail.com) +.PP +Ported to Microsoft C/C++ Compiler and MS-DOS operating system by +Kai-Uwe Herbing (herbing@netmbx.netmbx.de). diff --git a/Master/texmf-dist/doc/man/man1/t1binary.man1.pdf b/Master/texmf-dist/doc/man/man1/t1binary.man1.pdf Binary files differnew file mode 100644 index 00000000000..1f5bca341ba --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/t1binary.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/t1disasm.1 b/Master/texmf-dist/doc/man/man1/t1disasm.1 new file mode 100644 index 00000000000..4458fb46ea1 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/t1disasm.1 @@ -0,0 +1,96 @@ +.ds V 1.37 +.de M +.BR "\\$1" "(\\$2)\\$3" +.. +.TH T1DISASM 1 "" "Version \*V" +.SH NAME +t1disasm \- disassemble PostScript Type 1 font +.SH SYNOPSIS +.B t1disasm +\%[\fIinput\fR [\fIoutput\fR]] +.SH DESCRIPTION +.B t1disasm +disassembles Adobe Type 1 font programs in either PFA (hexadecimal) or PFB +(binary) formats into human-readable form. If the file +.I output +is not specified output goes to the standard output. +If the file +.I input +is not specified input comes from the standard input. + +.B t1disasm +performs eexec and charstring decryption as specified in the ``black +book'', +.I "Adobe Type 1 Font Format." +Additionally, the charstring binary tokens are expanded into human-readable +text form, using the names given in the black book and later documents +describing Type 2 opcodes. +.SH EXAMPLES +.LP +.nf +% t1disasm Utopia-Regular.pfb Utopia-Regular.raw +% t1disasm Utopia-Regular.pfa Utopia-Regular.raw +.fi + +In +.B Subrs +entries in Utopia-Regular.raw will look like +.RS +.nf +.ft B +dup 5 { + 8 111 vstem + \-12 128 hstem + 707 \-20 hstem + return + } | +.ft R +.fi +.RE +and the +.B CharStrings +entries like +.RS +.nf +.ft B +/exclam { + 58 242 hsbw + 6 callsubr + 5 4 callsubr + 63 707 rmoveto + \-54 0 \-5 \-22 4 \-45 rrcurveto + 40 \-431 rlineto + 29 hlineto + 42 431 rlineto + 4 45 \-5 22 \-55 0 rrcurveto + closepath + 6 4 callsubr + \-719 vmoveto + 243 callsubr + endchar + } |\- +.ft R +.fi +.RE +.SH "SEE ALSO" +.LP +.M t1asm 1 , +.M t1ascii 1 , +.M t1binary 1 , +.M t1unmac 1 , +.M t1mac 1 +.LP +.I "Adobe Type 1 Font Format" +is available free from Adobe as a PDF file: +http://partners.adobe.com/asn/developer/PDFS/TN/T1_SPEC.PDF +.LP +.I "The Type 2 Charstring Format," +also available from Adobe as a PDF file, describes the newer Type 2 +operators, which are also used in some multiple-master Type 1 fonts like +Adobe Jenson and Kepler: +http://partners.adobe.com/asn/developer/PDFS/TN/5177.Type2.pdf +' +.SH AUTHORS +Lee Hetherington (ilh@lcs.mit.edu) +.br +Eddie Kohler (ekohler@gmail.com) diff --git a/Master/texmf-dist/doc/man/man1/t1disasm.man1.pdf b/Master/texmf-dist/doc/man/man1/t1disasm.man1.pdf Binary files differnew file mode 100644 index 00000000000..81c58b6a6a5 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/t1disasm.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/t1dotlessj.1 b/Master/texmf-dist/doc/man/man1/t1dotlessj.1 new file mode 100644 index 00000000000..779914d281f --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/t1dotlessj.1 @@ -0,0 +1,96 @@ +.ds V 2.92 +.de M +.BR "\\$1" "(\\$2)\\$3" +.. +.de Sp +.if n .sp +.if t .sp 0.4 +.. +.TH T1DOTLESSJ 1 "LCDF Typetools" "Version \*V" +.SH NAME +t1dotlessj \- create a dotless-j PostScript Type 1 font +.SH SYNOPSIS +.B t1dotlessj +\%[OPTIONS...] +.I font +.RI [ outputfile ] +.SH DESCRIPTION +.BR T1dotlessj +creates a PostScript Type\~1 font whose only character is a dotless 'j' +matching the input font's design. It works simply by removing the dot from +the input font's 'j'. The output font has three characters: '.notdef', +\&'space', and 'uni0237', where 'uni0237' is the dotless 'j'. The command +fails if the input font already has a dotless 'j' character, or if there +seems to be no dot to remove. T1dotlessj writes the created PFA or PFB font +to the standard output (but see the +.B \-\-output +option); if no input file is supplied, it reads a PFA or PFB font from the +standard input. +' +.SH OPTIONS +.PD 0 +.TP 5 +.BR \-\-output "=\fIfile\fR, " \-o " \fIfile" +Send output to +.I file +instead of standard output. +' +.Sp +.TP 5 +.BR \-\-pfb ", " \-b +Output a PFB font. This is the default. +' +.Sp +.TP 5 +.BR \-\-pfa ", " \-a +Output a PFA font. +' +.Sp +.TP 5 +.BR \-\-name "=\fIname\fR, " \-n " \fIname" +Set the output font's PostScript name to +.IR name . +The default is +.IR InputFontName "LCDFJ." +' +.Sp +.TP 5 +.BR \-q ", " \-\-quiet +Do not generate any error messages. +' +.Sp +.TP 5 +.BR \-h ", " \-\-help +Print usage information and exit. +' +.Sp +.TP 5 +.BR \-v ", " \-\-version +Print the version number and some short non-warranty information and exit. +.PD +' +.SH "RETURN VALUES" +.B T1dotlessj +exits with one of the following values: +.TP 5 +0 +A dotless-j font was successfully generated. +.TP 5 +1 +The font already contained a dotless-j character. +.TP 5 +2 +The font's "j" character had no dot to remove. +.TP 5 +3 +The font had no "j" character. +.TP 5 +>3 +An error occurred. +' +.SH "SEE ALSO" +.LP +.I "Adobe Type 1 Font Format" +' +.SH AUTHOR +Eddie Kohler (ekohler@gmail.com) diff --git a/Master/texmf-dist/doc/man/man1/t1dotlessj.man1.pdf b/Master/texmf-dist/doc/man/man1/t1dotlessj.man1.pdf Binary files differnew file mode 100644 index 00000000000..6014d534617 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/t1dotlessj.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/t1lint.1 b/Master/texmf-dist/doc/man/man1/t1lint.1 new file mode 100644 index 00000000000..bebd5fec146 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/t1lint.1 @@ -0,0 +1,48 @@ +.ds V 2.92 +.de M +.BR "\\$1" "(\\$2)\\$3" +.. +.de Sp +.if n .sp +.if t .sp 0.4 +.. +.TH T1LINT 1 "LCDF Typetools" "Version \*V" +.SH NAME +t1lint \- check a PostScript Type 1 font for correctness +.SH SYNOPSIS +.B t1lint +\%\fIfont\fR [\fIfont\fR...] +.SH DESCRIPTION +.BR T1lint +checks PostScript Type 1 font programs for correctness. Any errors or +variances from the specification are reported to standard error. If there +are no errors, the command prints nothing. It exits with status 0 if all +fonts were OK, and status 1 otherwise. If no input files are supplied, +t1lint reads a font from the standard input. +' +.SH OPTIONS +.PD 0 +.TP 5 +.BR \-q ", " \-\-quiet +Do not generate any error messages. The only output will be the exit +status. +' +.Sp +.TP 5 +.BR \-h ", " \-\-help +Print usage information and exit. +' +.Sp +.TP 5 +.BR \-v ", " \-\-version +Print the version number and some short non-warranty information and exit. +.PD +' +.SH "SEE ALSO" +.LP +.M t1disasm 1 +.LP +.I "Adobe Type 1 Font Format" +' +.SH AUTHOR +Eddie Kohler (ekohler@gmail.com) diff --git a/Master/texmf-dist/doc/man/man1/t1lint.man1.pdf b/Master/texmf-dist/doc/man/man1/t1lint.man1.pdf Binary files differnew file mode 100644 index 00000000000..452a0473995 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/t1lint.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/t1mac.1 b/Master/texmf-dist/doc/man/man1/t1mac.1 new file mode 100644 index 00000000000..4a759716e51 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/t1mac.1 @@ -0,0 +1,62 @@ +.ds V 1.37 +.de M +.BR "\\$1" "(\\$2)\\$3" +.. +.TH T1MAC 1 "" "Version \*V" +.SH NAME +t1mac \- translate a PFA or PFB PostScript Type 1 font into Macintosh format +.SH SYNOPSIS +.B t1mac +\%[\fB\-\-macbinary\fR | \fB\-\-applesingle\fR | +\fB\-\-appledouble\fR | \fB\-\-binhex\fR | \fB\-\-raw\fR] +\%[\fB\-\-filename\fR \fIname\fR] +\%[\fIinput\fR [\fIoutput\fR]] +.SH DESCRIPTION +.B t1mac +reads a PFA (hexadecimal) or PFB (binary) PostScript Type 1 font file and +generates an equivalent Macintosh Type 1 font file. The output file can be +in MacBinary II, AppleSingle, AppleDouble, or BinHex format, or it can be a +raw resource fork. The default is MacBinary II; use an option to choose a +different format. If the +.I output +file is not specified output goes to the standard output. +.PP +WARNING: The output of +.B t1mac +is not sufficient to use the font, since Macintoshes can't read raw Type 1 +fonts. You will need to create a font suitcase containing bitmap fonts if +you do not have such a suitcase for the font already. +.B t1mac +cannot help you do this. +.SH OPTIONS +.TP 5 +.BR \-\-raw ", " \-r +Indicates that output should be a raw resource fork. +.TP 5 +.BR \-\-macbinary +Indicates that output should be in MacBinary I or II format. This is the +default. +.TP 5 +.BR \-\-applesingle +Indicates that output should be in AppleSingle format. +.TP 5 +.BR \-\-appledouble +Indicates that output should be in AppleDouble format. +.TP 5 +.BR \-\-binhex +Indicates that output should be in BinHex 4.0 format. +.TP 5 +.BR \-\-filename "=\fIname\fR, " \-n " \fIname\fR" +Sets the Macintosh filename of the output font to \fIname\fR. The default +is to construct the filename from the font's name using established +Macintosh conventions. This option is not useful when output is a raw +resource fork. +.SH "SEE ALSO" +.LP +.M t1unmac 1 , +.M t1ascii 1 , +.M t1binary 1 , +.M t1asm 1 , +.M t1disasm 1 +.SH AUTHORS +Eddie Kohler (ekohler@gmail.com) diff --git a/Master/texmf-dist/doc/man/man1/t1mac.man1.pdf b/Master/texmf-dist/doc/man/man1/t1mac.man1.pdf Binary files differnew file mode 100644 index 00000000000..ee34f88affb --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/t1mac.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/t1rawafm.1 b/Master/texmf-dist/doc/man/man1/t1rawafm.1 new file mode 100644 index 00000000000..15925e273c3 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/t1rawafm.1 @@ -0,0 +1,59 @@ +.ds V 2.92 +.de M +.BR "\\$1" "(\\$2)\\$3" +.. +.de Sp +.if n .sp +.if t .sp 0.4 +.. +.TH T1RAWAFM 1 "LCDF Typetools" "Version \*V" +.SH NAME +t1rawafm \- produce raw AFM metrics from a PostScript Type 1 font +.SH SYNOPSIS +.B t1rawafm +\%\-e ENCODING +\%[OPTIONS...] +.I font +.RI [ outputfile ] +.SH DESCRIPTION +.BR T1rawafm +generates an AFM file with the information available in a PostScript +Type\~1 font. The AFM file will lack kerns, ligature information, and +composite characters, but is otherwise usable. The AFM file is written to +the standard output (but see the +.B \-\-output +option). If no input font file is supplied, +.B t1rawafm +reads a PFA or PFB font from the standard input. +' +.SH OPTIONS +.PD 0 +.TP 5 +.BR \-\-output "=\fIfile\fR, " \-o " \fIfile" +Send output to +.I file +instead of standard output. +' +.Sp +.TP 5 +.BR \-h ", " \-\-help +Print usage information and exit. +' +.Sp +.TP 5 +.BR \-\-version +Print the version number and some short non-warranty information and exit. +.PD +' +.SH "RETURN VALUES" +.B T1rawafm +exits with value 0 if an AFM metrics file was successfully generated, and 1 +otherwise. +' +.SH "SEE ALSO" +.LP +.IR "Adobe Type 1 Font Format" , +.IR "Adobe Font Metrics File Format Specification v4.1" +' +.SH AUTHOR +Eddie Kohler (ekohler@gmail.com) diff --git a/Master/texmf-dist/doc/man/man1/t1rawafm.man1.pdf b/Master/texmf-dist/doc/man/man1/t1rawafm.man1.pdf Binary files differnew file mode 100644 index 00000000000..e27e03b6b47 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/t1rawafm.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/t1reencode.1 b/Master/texmf-dist/doc/man/man1/t1reencode.1 new file mode 100644 index 00000000000..a5a6d98a06c --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/t1reencode.1 @@ -0,0 +1,205 @@ +.ds V 2.92 +.de M +.BR "\\$1" "(\\$2)\\$3" +.. +.de Sp +.if n .sp +.if t .sp 0.4 +.. +.TH T1REENCODE 1 "LCDF Typetools" "Version \*V" +.SH NAME +t1reencode \- reencode a PostScript Type 1 font +.SH SYNOPSIS +.B t1reencode +\%\-e ENCODING +\%[OPTIONS...] +.I font +.RI [ outputfile ] +.SH DESCRIPTION +.BR T1reencode +changes a PostScript Type\~1 font's embedded encoding. The reencoded font +is written to the standard output (but see the +.B \-\-output +option). If no input font file is supplied, +.B t1reencode +reads a PFA or PFB font from the standard input. +' +.SH OPTIONS +.PD 0 +.TP 5 +.BR \-\-encoding "=\fIfile\fR, " \-e " \fIfile" +Read the encoding from +.IR file , +which must contain an encoding in +.M dvips 1 +format. Alternatively, +.I file +can be one of the following special names, in which case the corresponding +standard encoding is used. +.Sp +.RS +.TP 23 +.B Name +.B Source +.TP +StandardEncoding +Adobe +.TP +ISOLatin1Encoding +Adobe/ISO (synonym: ISO_8859_1_Encoding) +.TP +ExpertEncoding +Adobe +.TP +ExpertSubsetEncoding +Adobe +.TP +SymbolEncoding +Adobe +.TP +ISOLatin2Encoding +ISO (synonym: ISO_8859_2_Encoding) +.TP +ISOLatin3Encoding +ISO (synonym: ISO_8859_3_Encoding) +.TP +ISOLatin4Encoding +ISO (synonym: ISO_8859_4_Encoding) +.TP +ISOCyrillicEncoding +ISO (synonym: ISO_8859_5_Encoding) +.TP +ISOGreekEncoding +ISO (synonym: ISO_8859_7_Encoding) +.TP +ISOLatin5Encoding +ISO (synonym: ISO_8859_9_Encoding) +.TP +ISOLatin6Encoding +ISO (synonym: ISO_8859_10_Encoding) +.TP +ISOThaiEncoding +ISO (synonym: ISO_8859_11_Encoding) +.TP +ISOLatin7Encoding +ISO (synonym: ISO_8859_13_Encoding) +.TP +ISOLatin8Encoding +ISO (synonym: ISO_8859_14_Encoding) +.TP +ISOLatin9Encoding +ISO (synonym: ISO_8859_15_Encoding) +.TP +KOI8REncoding +- +.RE +' +.Sp +.TP 5 +.BR \-\-encoding\-text "=\fItext\fR, " \-E " \fItext" +Use the encoding in the +.I text +argument, which must be formatted as a +.M dvips 1 +encoding. One of +.B \-\-encoding +and +.B \-\-encoding\-text +must be supplied. +' +.Sp +.TP 5 +.BR \-\-name "=\fIname\fR, " \-n " \fIname" +Set the output font's PostScript name to +.IR name . +The default is the input font name followed by the encoding's name. +' +.Sp +.TP 5 +.BR \-\-full-name "=\fIname\fR, " \-N " \fIname" +Set the output font's FullName to +.IR name . +The default is the input FullName followed by the encoding's name. +' +.Sp +.TP 5 +.BR \-\-output "=\fIfile\fR, " \-o " \fIfile" +Send output to +.I file +instead of standard output. +' +.Sp +.TP 5 +.BR \-\-pfb ", " \-b +Output a PFB font. This is the default. +' +.Sp +.TP 5 +.BR \-\-pfa ", " \-a +Output a PFA font. +' +.Sp +.TP 5 +.BR \-h ", " \-\-help +Print usage information and exit. +' +.Sp +.TP 5 +.BR \-\-version +Print the version number and some short non-warranty information and exit. +.PD +' +.SH "RETURN VALUES" +.B T1reencode +exits with value 0 if a reencoded font was successfully generated, and 1 +otherwise. +' +.SH "NOTES" +.LP +.B T1reencode +should be used only in special situations. It's generally much better to +use PostScript commands to reencode a font; for instance, executing the +PostScript commands to generate two differently-encoded versions of a +single font will take up much less memory than loading two +.BR t1reencode d +fonts. +' +.SH "EXAMPLES" +.PP +This command reencodes Frutiger Roman in the ISO Latin\~1 encoding. The new +font will have the PostScript name Frutiger-RomanISOLatin1Encoding. +.Sp +.nf + \fBt1reencode\fR \fB\-e\fR ISOLatin1Encoding FrutiRom.pfb \e + \fB\-o\fR FrutiRomISOL1.pfb +.fi +.Sp +This series of commands, which use +.M cfftot1 1 +and +.M otftotfm 1 +as well as +.B t1reencode +itself, generate a version of Warnock Pro Regular with old-style figures in +the slots for numbers (because of +.BR otftotfm 's +.BR \-f onum +option). The new font will be called WarnockPro-RegularOsF. +.Sp +.nf + \fBotftotfm\fR \fB\-f\fRonum WarnockPro-Regular.otf \e + \fB\-\-output\-encoding\fR /tmp/osf.enc + \fBcfftot1\fR WarnockPro-Regular.otf | \fBt1reencode\fR \fB\-e\fR /tmp/osf.enc \e + \fB\-n\fR WarnockPro-RegularOsF \fB\-N\fR "Warnock Pro Regular OsF" \e + \fB\-o\fR WarnoProRegOsF.pfb +.fi +' +.SH "SEE ALSO" +.LP +.IR "Adobe Type 1 Font Format" , +.M dvips 1 , +.M cfftot1 1 , +.M otftotfm 1 +' +.SH AUTHOR +Eddie Kohler (ekohler@gmail.com) diff --git a/Master/texmf-dist/doc/man/man1/t1reencode.man1.pdf b/Master/texmf-dist/doc/man/man1/t1reencode.man1.pdf Binary files differnew file mode 100644 index 00000000000..03265e55f30 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/t1reencode.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/t1testpage.1 b/Master/texmf-dist/doc/man/man1/t1testpage.1 new file mode 100644 index 00000000000..d9b328cc24c --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/t1testpage.1 @@ -0,0 +1,66 @@ +.ds V 2.92 +.de M +.BR "\\$1" "(\\$2)\\$3" +.. +.de Sp +.if n .sp +.if t .sp 0.4 +.. +.TH T1TESTPAGE 1 "LCDF Typetools" "Version \*V" +.SH NAME +t1testpage \- create a PostScript proof for a Type 1 font +.SH SYNOPSIS +.B t1testpage +\%[\fIfont...\fR] +.SH DESCRIPTION +.BR T1testpage +creates a PostScript proof document for the specified Type 1 font file and +writes it to the standard output. The proof shows every glyph in the +font, including its glyph name and encoding. The +.I font +argument should be the name of a PFA or PFB font file. If more than one +.I font +is given, the output proof contains all the fonts in order. If +.I font +is omitted, +t1testpage will read a font file from the standard input. +.PP +T1testpage is preliminary software. +' +.SH OPTIONS +.PD 0 +.TP 5 +.BR \-g " \fIglyphs\fR, " \-\-glyph= \fIglyphs +Print only glyphs matching +.IR glyphs . +The argument is a glyph pattern, using shell-like matching rules; thus, +.BR "\-g " 'A*' +will match the glyphs 'A', 'Atilde', and 'Ampersand', among others. You +can give this option multiple times, or supply multiple space-separated +patterns in a single option. +' +.Sp +.TP 5 +.BR \-s ", " \-\-smoke +Print smoke proofs, one glyph per page. This option is preliminary. +' +.Sp +.TP 5 +.BR \-o " \fIfile\fR, " \-\-output= \fIfile +Write the output proof to +.I file +instead of the standard output. +' +.Sp +.TP 5 +.BR \-h ", " \-\-help +Print usage information and exit. +' +.Sp +.TP 5 +.BR \-v ", " \-\-version +Print the version number and some short non-warranty information and exit. +.PD +' +.SH AUTHOR +Eddie Kohler (ekohler@gmail.com) diff --git a/Master/texmf-dist/doc/man/man1/t1testpage.man1.pdf b/Master/texmf-dist/doc/man/man1/t1testpage.man1.pdf Binary files differnew file mode 100644 index 00000000000..a030bbba5f0 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/t1testpage.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/t1unmac.1 b/Master/texmf-dist/doc/man/man1/t1unmac.1 new file mode 100644 index 00000000000..081ec31569f --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/t1unmac.1 @@ -0,0 +1,79 @@ +.ds V 1.37 +.de M +.BR "\\$1" "(\\$2)\\$3" +.. +.TH T1UNMAC 1 "" "Version \*V" +.SH NAME +t1unmac \- translate a Mac PostScript Type 1 font into PFA or PFB format +.SH SYNOPSIS +.B t1unmac +\%[\fB\-a\fR|\fB\-b\fR] +\%[\fB\-r\fR] +\%[\fIinput\fR [\fIoutput\fR]] +.SH DESCRIPTION +.B t1unmac +extracts POST resources from a Macintosh PostScript font file and creates a +PFA (hexadecimal) or PFB (binary) font file. The file +.I input +should be in MacBinary I or II, AppleSingle, AppleDouble, or BinHex format, +or it can be a raw resource fork. If the file is a raw resource fork, you +need to give the `\-\-raw' option; otherwise +.B t1unmac +should automatically figure out what kind of file you have. If the file +.I output +is not specified output goes to the standard output. +.SH OPTIONS +.TP 5 +.BR \-\-pfa ", " \-a +Output in PFA (ASCII) format. +.TP 5 +.BR \-\-pfb ", " \-b +Output in PFB (binary) format. This is the default. +.TP 5 +.BR \-\-raw ", " \-r +Indicates that the input is a raw resource fork. +.TP 5 +.BR \-\-macbinary +Indicates that the input is in MacBinary I or II format. +.TP 5 +.BR \-\-applesingle +Indicates that the input is in AppleSingle format. +.TP 5 +.BR \-\-appledouble +Indicates that the input is in AppleDouble format. +.TP 5 +.BR \-\-binhex +Indicates that the input is in BinHex 4.0 format. +.TP +.BI \-\-block\-length= "num\fR, " \-l " num" +PFB only: Set the maximum output block length to +.I num. +The default length is as large as memory allows. +.TP +.BI \-\-line\-length= "num\fR, " \-l " num" +PFA only: Set the maximum length of encrypted lines in the output to +.I num. +(These are the lines consisting wholly of hexadecimal digits.) The default +is 64. +.SH EXAMPLES +.LP +On Mac OS X, you can use +.B t1unmac +to translate a font into PFA or PFB format as follows: +.nf +% \fBt1unmac\fR \-\-raw FONTFILENAME/..namedfork/rsrc > OUTPUT +.fi +.SH "SEE ALSO" +.LP +.M t1mac 1 , +.M t1ascii 1 , +.M t1binary 1 , +.M t1asm 1 , +.M t1disasm 1 +.SH AUTHORS +Lee Hetherington (ilh@lcs.mit.edu) +.br +Eddie Kohler (ekohler@gmail.com) +.PP +Ported to Microsoft C/C++ Compiler and MS-DOS operating system by +Kai-Uwe Herbing (herbing@netmbx.netmbx.de). diff --git a/Master/texmf-dist/doc/man/man1/t1unmac.man1.pdf b/Master/texmf-dist/doc/man/man1/t1unmac.man1.pdf Binary files differnew file mode 100644 index 00000000000..5b54b01a89b --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/t1unmac.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/tangle.1 b/Master/texmf-dist/doc/man/man1/tangle.1 new file mode 100644 index 00000000000..a89f1726c41 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/tangle.1 @@ -0,0 +1,173 @@ +.TH TANGLE 1 "1 March 2011" "Web2C 2012" +.\"===================================================================== +.if n .ds MF Metafont +.if t .ds MF M\s-2ETAFONT\s0 +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff +.el .ds OX TeX for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.if n .ds WB Web +.if t .ds WB W\s-2EB\s0 +.\"===================================================================== +.SH NAME +tangle \- translate WEB to Pascal +.SH SYNOPSIS +.B tangle +.RI [ options ] +.IR webfile [ \fB.web\fP ] +.RI [ changefile [ \fB.ch\fP ]] +.\"===================================================================== +.SH DESCRIPTION +This manual page is not meant to be exhaustive. The complete +documentation for this version of \*(TX can be found in the info file +or manual +.IR "Web2C: A TeX implementation" . +.PP +The +.B tangle +program converts a \*(WB +source document into a Pascal program that may be compiled in the usual +way with the on-line Pascal compiler (e.g., +.BR pc (1)). +The output file is packed into lines of 72 characters or less, with +the only concession to readability being the termination of lines at +semicolons when this can be done conveniently. +.PP +The \*(WB language allows you to prepare a single document containing all +the information that is needed both to produce a compilable Pascal +program and to produce a well-formatted document describing the program +in as much detail as the writer may desire. The user of \*(WB must be +familiar with both \*(TX and Pascal. \*(WB also provides a relatively +simple, although adequate, macro facility that permits a Pascal program +to be written in small easily-understood modules. +.PP +The command line should have either one or two names on it. +The first is taken as the \*(WB file (and +.B .web +is added if there is no +extension). +If there is another name, it is a change file (and +.B .ch +is added if there is +no extension). The change file overrides parts of the \*(WB file, +as described in the \*(WB system documentation. +.PP +The output files are a Pascal file and a string pool file, +whose names are formed by adding +.B .p +and +.B .pool +respectively to the root of the \*(WB file name. +.\"===================================================================== +.SH "OPTIONS" +This version of +.B tangle +understands the following options. Note that some of these options +may render the output unsuitable for processing by a Pascal compiler. +.TP +.B --help +Print help message and exit. +.TP +.BI --length \ number +Compare only the first +.I number +characters of identifiers when checking for collisions. The default +is 32, the original +.B tangle +used 7. +.TP +.B --loose +When checking for collisions between identifiers, honor the settings +of the +.BR --lowercase , +.BR --mixedcase , +.BR --uppercase , +and +.B --underline +options. This is the default. +.TP +.B --lowercase +Convert all identifiers to lowercase. +.TP +.B --mixedcase +Retain the case of identifiers. This is the default. +.TP +.B --strict +When checking for collisions between identifiers, strip underlines and +convert all identifiers to uppercase first. +.TP +.B --underline +Retain underlines (also known as underscores) in identifiers. +.TP +.B --uppercase +Convert all identifiers to uppercase. This is the behaviour of the +original +.BR tangle . +.TP +.B --version +Print version information and exit. +.\"===================================================================== +.SH ENVIRONMENT +The environment variable WEBINPUTS is used to search for the input files, +or the system default if WEBINPUTS is not set. See +.BR tex (1) +for the details of the searching. +.\"===================================================================== +.SH "SEE ALSO" +.BR pc (1), +.BR pxp (1) +(for formatting +.B tangle +output when debugging), +.BR tex (1). +.PP +Donald E. Knuth, +.IR "The \*(WB System of Structured Documentation" . +.PP +Donald E. Knuth, +.IR "Literate Programming" , +Computer Journal +.BR 27 , +97\-111, 1984. +.PP +Wayne Sewell, +.IR "Weaving a Program" , +Van Nostrand Reinhold, 1989, ISBN 0-442-31946-0. +.PP +Donald E. Knuth, +.I "\*(OX: The Program" +(Volume B of +.IR "Computers and Typesetting" ), +Addison-Wesley, 1986, ISBN 0-201-13437-3. +.PP +Donald E. Knuth, +.I "\*(MF: The Program" +(Volume D of +.IR "Computers and Typesetting" ), +Addison-Wesley, 1986, ISBN 0-201-13438-1. +.PP +These last two are by far the largest extant examples of \*(WB +programs. +.PP +There is an active Internet electronic mail discussion list on the +subject of literate programming; send a subscription request to +.I litprog-request@shsu.edu +to join. +.\"===================================================================== +.SH AUTHORS +\*(WB was designed by Donald E. Knuth, based on an earlier system +called DOC (implemented by Ignacio Zabala). +The +.B tangle +and +.B weave +programs are themselves written in \*(WB. The system +was originally ported to Unix at Stanford by Howard Trickey, and at +Cornell by Pavel Curtis. diff --git a/Master/texmf-dist/doc/man/man1/tangle.man1.pdf b/Master/texmf-dist/doc/man/man1/tangle.man1.pdf Binary files differnew file mode 100644 index 00000000000..0b3a287d050 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/tangle.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/tex.1 b/Master/texmf-dist/doc/man/man1/tex.1 new file mode 100644 index 00000000000..cea6e08d54c --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/tex.1 @@ -0,0 +1,517 @@ +.TH TEX 1 "1 March 2011" "Web2C 2012" +.\"===================================================================== +.if n .ds MF Metafont +.if t .ds MF M\s-2ETAFONT\s0 +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.if n .ds MF Metafont +.if t .ds MF M\s-2ETAFONT\s0 +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff +.el .ds OX TeX for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.if n .ds WB Web +.if t .ds WB W\s-2EB\s0 +.\" EX and EE are used for displays that are pure code +.de EX +.nf +.ft CW +.. +.de EE +.ft R +.fi +.. +.\"===================================================================== +.SH NAME +tex, virtex, initex \- text formatting and typesetting +.SH SYNOPSIS +.B tex +.RI [ options ] +.RI [ \fB&\fPformat ] +.RI [ file | \fB\e\fPcommands ] +.\"===================================================================== +.SH DESCRIPTION +Run the \*(TX typesetter on +.IR file , +usually creating +.IR file.dvi . +If the file argument has no extension, ".tex" will be appended to it. +Instead of a filename, a set of \*(TX commands can be given, the first +of which must start with a backslash. +With a +.BI & format +argument \*(TX uses a different set of precompiled commands, +contained in +.IR format\fB.fmt\fP ; +it is usually better to use the +.B -fmt +.I format +option instead. +.PP +\*(TX +formats the interspersed text and commands contained in the named +files +and outputs a typesetter independent file (called +.IR DVI , +which is short for +.IR "DeVice Independent" ). +\*(TX's capabilities and language are described in +.IR "The \*(OXbook" . +\*(TX +is normally used with a large body of precompiled macros, +and there are several specific formatting systems, such as +\*(LX, +which require the support of several macro files. +.PP +This version of \*(TX looks at its command line to see what name it +was called under. If they exist, then both +.B initex +and +.B virtex +are symbolic links to the +.B tex +executable. When called as +.BR initex +(or when the +.B -ini +option is given) it can be used to precompile macros into a +.I .fmt +file. When called as +.B virtex +it will use the +.I plain +format. When called under any other name, \*(TX will use that name as +the name of the format to use. For example, when called as +.B tex +the +.I tex +format is used, which is identical to the +.I plain +format. The commands defined by the +.I plain +format are documented in +.IR "The \*(OXbook" . +Other formats that are often available include +.I latex +and +.IR amstex . +.PP +The non-option command line arguments to the +\*(TX +program are passed to it as the first input line. (But it is often +easier to type extended arguments as the first input line, since UNIX +shells tend to gobble up or misinterpret \*(TX's favorite symbols, +like backslashes, unless you quote them.) +As described in +.IR "The \*(OXbook" , +that first line should begin with a filename, a +.IR \econtrolsequence , +or a +.IR &formatname . +.PP +The normal usage is to say +.EX +tex paper +.EE +to start processing +.IR paper.tex . +The name +.I paper +will be the ``jobname'', and is used in forming +output filenames. +If \*(TX doesn't get a filename in the first line, the jobname is +.IR texput . +When looking for a file, \*(TX looks for the name with and without the +default extension +.RI ( .tex ) +appended, unless the name already contains that extension. If +.I paper +is the ``jobname'', +a log of error messages, with rather more detail than normally appears +on the screen, will appear in +.IR paper.log , +and the output file will be in +.IR paper.dvi . +.PP +This version of \*(TX can look in the first line of the file +.I paper.tex +to see if it begins with the magic sequence +.IR %& . +If the first line begins with +.BI %& format +.BI -translate-file \ tcxname +then \*(TX will use the named format and translation table +.I tcxname +to process the source file. Either the format name or the +.B -translate-file +specification may be omitted, but not both. This overrides the +format selection based on the name by which the program is invoked. +The +.B -parse-first-line +option or the +.B parse_first_line +configuration variable controls whether this behaviour is enabled. +.PP +The +.I e +response to \*(TX's error prompt causes the system default editor to +start up at the current line of the current file. The environment +variable TEXEDIT can be used to change the editor used. It may +contain a string with "%s" indicating where the filename goes and "%d" +indicating where the decimal line number (if any) goes. For example, +a TEXEDIT string for +.B emacs +can be set with the +.B sh +command +.EX +\fITEXEDIT="emacs +%d %s"; export TEXEDIT\fP +.EE +.PP +A convenient file in the library is +.IR null.tex , +containing nothing. +When \*(TX can't find a file it thinks you want to input, it keeps +asking you for another filename; responding `null' gets you out +of the loop if you don't want to input anything. You can also type your +EOF character (usually control-D). +.PP +.\"===================================================================== +.SH OPTIONS +This version of \*(TX understands the following command line options. +.TP +.B -enc +Enable the enc\*(TX extensions. This option is only effective in +combination with +.BR -ini . +For documentation of the enc\*(TX extensions see +.BR http://www.olsak.net/enctex.html . +.TP +.B -file-line-error +Print error messages in the form +.I file:line:error +which is similar to the way many compilers format them. +.TP +.B -no-file-line-error +Disable printing error messages in the +.I file:line:error +style. +.TP +.B -file-line-error-style +This is the old name of the +.B -file-line-error +option. +.TP +.BI -fmt \ format +Use +.I format +as the name of the format to be used, instead of the name by which +\*(TX was called or a +.I %& +line. +.TP +.B -halt-on-error +Exit with an error code when an error is encountered during processing. +.TP +.B -help +Print help message and exit. +.TP +.B -ini +Start in +.I INI +mode, which is used to dump formats. The +.I INI +mode can be used for typesetting, but no format is preloaded, and +basic initializations like setting catcodes may be required. +.TP +.BI -interaction \ mode +Sets the interaction mode. The mode can be either +.IR batchmode , +.IR nonstopmode , +.IR scrollmode , +and +.IR errorstopmode . +The meaning of these modes is the same as that of the corresponding +\ecommands. +.TP +.B -ipc +Send DVI output to a socket as well as the usual output file. Whether +this option is available is the choice of the installer. +.TP +.B -ipc-start +As +.BR -ipc , +and starts the server at the other end as well. Whether this option +is available is the choice of the installer. +.TP +.BI -jobname \ name +Use +.I name +for the job name, instead of deriving it from the name of the input file. +.TP +.BI -kpathsea-debug \ bitmask +Sets path searching debugging flags according to the bitmask. See the +.I Kpathsea +manual for details. +.TP +.BI -mktex \ fmt +Enable +.RI mktex fmt , +where +.I fmt +must be either +.I tex +or +.IR tfm . +.TP +.B -mltex +Enable ML\*(TX extensions. Only effective in combination with +.BR -ini . +.TP +.BI -no-mktex \ fmt +Disable +.RI mktex fmt , +where +.I fmt +must be either +.I tex +or +.IR tfm . +.TP +.BI -output-comment \ string +Use +.I string +for the +.I DVI +file comment instead of the date. +.TP +.BI -output-directory \ directory +Write output files in +.I directory +instead of the current directory. Look up input files in +.I directory +first, then along the normal search path. See also description of the +TEXMFOUTPUT environment variable. +.TP +.B -parse-first-line +If the first line of the main input file begins with +.I %& +parse it to look for a dump name or a +.B -translate-file +option. +.TP +.B -no-parse-first-line +Disable parsing of the first line of the main input file. +.TP +.BI -progname \ name +Pretend to be program +.IR name . +This affects both the format used and the search paths. +.TP +.B -recorder +Enable the filename recorder. This leaves a trace of the files opened +for input and output in a file with extension +.IR .fls . +.TP +.B -shell-escape +Enable the +.BI \ewrite18{ command } +construct. The +.I command +can be any shell command. This construct is normally +disallowed for security reasons. +.TP +.B -no-shell-escape +Disable the +.BI \ewrite18{ command } +construct, even if it is enabled in the +.I texmf.cnf +file. +.TP +.B -src-specials +Insert source specials into the +.I DVI +file. +.TP +.BI -src-specials \ where +Insert source specials in certain places of the +.I DVI +file. +.I where +is a comma-separated value list: +.IR cr , +.IR display , +.IR hbox , +.IR math , +.IR par , +.IR parent , +or +.IR vbox . +.TP +.BI -translate-file \ tcxname +Use the +.I tcxname +translation table to set the mapping of input characters and +re-mapping of output characters. +.TP +.BI -default-translate-file \ tcxname +Like +.B -translate-file +except that a +.I %& +line can overrule this setting. +.TP +.B -version +Print version information and exit. +.\"===================================================================== +.SH ENVIRONMENT +See the Kpathsearch library documentation (the `Path specifications' +node) for precise details of how the environment variables are used. +The +.B kpsewhich +utility can be used to query the values of the variables. +.PP +One caveat: In most \*(TX formats, you cannot use ~ in a filename you +give directly to \*(TX, because ~ is an active character, and hence is +expanded, not taken as part of the filename. Other programs, such as +\*(MF, do not have this problem. +.PP +.TP +.B TEXMFOUTPUT +Normally, \*(TX puts its output files in the current directory. If +any output file cannot be opened there, it tries to open it in the +directory specified in the environment variable TEXMFOUTPUT. +There is no default value for that variable. For example, if you say +.I tex paper +and the current directory is not writable, if TEXMFOUTPUT has +the value +.IR /tmp , +\*(TX attempts to create +.I /tmp/paper.log +(and +.IR /tmp/paper.dvi , +if any output is produced.) TEXMFOUTPUT is also checked for input +files, as \*(TX often generates files that need to be subsequently +read; for input, no suffixes (such as ``.tex'') are added by default, +the input name is simply checked as given. +.TP +.B TEXINPUTS +Search path for +.I \einput +and +.I \eopenin +files. +This probably start with ``.'', so +that user files are found before system files. An empty path +component will be replaced with the paths defined in the +.I texmf.cnf +file. For example, set TEXINPUTS to ".:/home/user/tex:" to prepend the +current directory and ``/home/user/tex'' to the standard search path. +.TP +.B TEXFORMATS +Search path for format files. +.TP +.B TEXPOOL +search path for +.B tex +internal strings. +.TP +.B TEXEDIT +Command template for switching to editor. The default, usually +.BR vi , +is set when \*(TX is compiled. +.TP +.B TFMFONTS +Search path for font metric +.RI ( .tfm ) +files. +.\"===================================================================== +.SH FILES +The location of the files mentioned below varies from system to +system. Use the +.B kpsewhich +utility to find their locations. +.TP +.I texmf.cnf +Configuration file. This contains definitions of search paths as well +as other configuration parameters like +.BR parse_first_line . +.TP +.I tex.pool +Text file containing \*(TX's internal strings. +.TP +.I texfonts.map +Filename mapping definitions. +.TP +.I *.tfm +Metric files for \*(TX's fonts. +.TP +.I *.fmt +Predigested \*(TX format (.\|fmt) files. +.TP +.I $TEXMFMAIN/tex/plain/base/plain.tex +The basic macro package described in the \*(OXbook. +.br +.\"===================================================================== +.SH NOTES +This manual page is not meant to be exhaustive. The complete +documentation for this version of \*(TX can be found in the info manual +.IR "Web2C: A TeX implementation" . +.\"===================================================================== +.SH BUGS +This version of \*(TX implements a number of optional extensions. +In fact, many of these extensions conflict to a greater or lesser +extent with the definition of \*(TX. When such extensions are +enabled, the banner printed when \*(TX starts is changed to print +.B TeXk +instead of +.BR TeX . +.PP +This version of \*(TX fails to trap arithmetic overflow when +dimensions are added or subtracted. Cases where this occurs are rare, +but when it does the generated +.I DVI +file will be invalid. +.\"===================================================================== +.SH "SEE ALSO" +.BR mf (1), +.br +Donald E. Knuth, +.IR "The \*(OXbook" , +Addison-Wesley, 1986, ISBN 0-201-13447-0. +.br +Leslie Lamport, +.IR "\*(LX \- A Document Preparation System" , +Addison-Wesley, 1985, ISBN 0-201-15790-X. +.br +K. Berry, +.IR "Eplain: Expanded plain \*(TX" , +ftp://ftp.cs.umb.edu/pub/tex/eplain/doc. +.br +Michael Spivak, +.IR "The Joy of \*(OX" , +2nd edition, Addison-Wesley, 1990, ISBN 0-8218-2997-1. +.br +.I TUGboat +(the journal of the \*(TX Users Group). +.\"===================================================================== +.SH TRIVIA +\*(TX, pronounced properly, rhymes with ``blecchhh.'' The proper +spelling in typewriter-like fonts is ``TeX'' and not ``TEX'' or ``tex.'' +.\"===================================================================== +.SH AUTHORS +\*(TX was designed by Donald E. Knuth, +who implemented it using his \*(WB system for Pascal programs. +It was ported to Unix at Stanford by Howard Trickey, and +at Cornell by Pavel Curtis. +The version now offered with the Unix \*(TX distribution is that +generated by the \*(WB to C system +.RB ( web2c ), +originally written by Tomas Rokicki and Tim Morgan. +.PP +The enc\*(TX extensions were written by Petr Olsak. diff --git a/Master/texmf-dist/doc/man/man1/tex.man1.pdf b/Master/texmf-dist/doc/man/man1/tex.man1.pdf Binary files differnew file mode 100644 index 00000000000..f276a2144cb --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/tex.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/tex2xindy.1 b/Master/texmf-dist/doc/man/man1/tex2xindy.1 new file mode 100644 index 00000000000..2a26a7ae265 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/tex2xindy.1 @@ -0,0 +1,213 @@ +.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "tex2xindy 1" +.TH tex2xindy 1 "2010-05-10" "Version 1.24" "xindy" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +tex2xindy \- a preprocessor of the xindy index processor +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +.Vb 1 +\& tex2xindy [\-o] [attr_file] +.Ve +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +\&\fBtex2xindy\fR transforms a LaTeX index file \f(CW\*(C`.idx\*(C'\fR (or an \f(CW\*(C`.aux\*(C'\fR +file) into a \fBxindy\fR raw index file. +.PP +It is a filter that reads from \fIstdin\fR a file in the input format of +LaTeX's raw index file, i.e., with \f(CW\*(C`\eindexentry\*(C'\fR tags. It outputs on +\&\fIstdout\fR a \fBxindy\fR raw index file, i.e., with \f(CW\*(C`indexentry\*(C'\fR clauses. +.PP +If the option \fB\-o\fR is not specified, \fBtex2xindy\fR handles ^^\-notation +of TeX and outputs the octet that is represented: \f(CW\*(C`^^ab\*(C'\fR in the input +gets output as the octet 0xab. If \f(CW\*(C`^^^^abcd\*(C'\fR or \f(CW\*(C`^^^^^^^^abcdefab\*(C'\fR +are detected, they are output as is. +.PP +If the option \fB\-o\fR is specified, \fBtex2xindy\fR operates in \fIOmega +mode\fR and handles its ^^\-notation: Then \f(CW\*(C`^^ab\*(C'\fR, \f(CW\*(C`^^^^abcd\*(C'\fR, and +\&\f(CW\*(C`^^^^^^^^abcdefab\*(C'\fR represent Unicode characters with code points +0xab, 0xabcd, and 0xabcdefab respectively. They are output in \s-1UTF\-8\s0 +encoding. +.PP +If the optional argument \fIattr_file\fR is specified, \fBtex2xindy\fR +writes all index key attributes into this file. +.SH "DEFICITS" +.IX Header "DEFICITS" +This program was written since it was not easily possible to extract +the parser from the old makeindex system. Therefore it does not find +all errors in the input as the \fImakeindex\fR\|(1) version. +.PP +Additionally it uses only the default input specifiers of +\&\fImakeindex\fR\|(1). If other input specifiers (cf. manual page of +\&\fImakeindex\fR\|(1)) are needed, the input specifiers (starting from the +pattern \f(CW\*(C`KEYWORD\*(C'\fR, see below) must be changed and the program must be +recompiled. +.PP +The particular missing feature is configuration of the quote and the +actual characters, maybe also the escape, subitem (level), and encap +characters. Argument and range delimiters seem to be less of a problem. +.PP +In fact, input markup handling (and thus \fBtex2xindy\fR) should be +incorporated into the \fBxindy\fR kernel, to be able to specify +configuration in xindy style files. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fItexindy\fR\|(1), +\&\fIxindy\fR\|(1), +\&\fImakeindex\fR\|(1) +.SH "AUTHOR" +.IX Header "AUTHOR" +Roger Kehr, Institut fuer Theoretische Informatik, \s-1TU\s0 Darmstadt +.SH "COPYRIGHT AND LICENSE" +.IX Header "COPYRIGHT AND LICENSE" +Copyright (c) 1996,1997 Roger Kehr. +Copyright (c) 2006 Joachim Schrod. +.PP +This program is free software; you can redistribute it and/or modify +it under the terms of the \s-1GNU\s0 General Public License as published by +the Free Software Foundation; either version 2 of the License, or (at +your option) any later version. +.PP +This program is distributed in the hope that it will be useful, but +\&\s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of +\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0. See the \s-1GNU\s0 +General Public License for more details. +.PP +You should have received a copy of the \s-1GNU\s0 General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 675 Mass Ave, Cambridge, \s-1MA\s0 02139, \s-1USA\s0. diff --git a/Master/texmf-dist/doc/man/man1/tex2xindy.man1.pdf b/Master/texmf-dist/doc/man/man1/tex2xindy.man1.pdf Binary files differnew file mode 100644 index 00000000000..240d5ce0e68 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/tex2xindy.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/texconfig-sys.1 b/Master/texmf-dist/doc/man/man1/texconfig-sys.1 new file mode 100644 index 00000000000..4a1ec004e56 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/texconfig-sys.1 @@ -0,0 +1 @@ +.so man1/texconfig.1 diff --git a/Master/texmf-dist/doc/man/man1/texconfig-sys.man1.pdf b/Master/texmf-dist/doc/man/man1/texconfig-sys.man1.pdf Binary files differnew file mode 100644 index 00000000000..12dae43ed2f --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/texconfig-sys.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/texconfig.1 b/Master/texmf-dist/doc/man/man1/texconfig.1 new file mode 100644 index 00000000000..8087f1e6dd1 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/texconfig.1 @@ -0,0 +1,215 @@ +.TH texconfig 1 "August 2011" "TeX Live" "TeX Live" +.SH NAME +texconfig \- configures teTeX or TeX Live +.LP +texconfig-sys \- configures teTeX or TeX Live system\-wide +.SH SYNOPSIS +.B texconfig +.LP +.B texconfig +[\fB commands\fR ...] +.LP +.B texconfig-sys +.SH DESCRIPTION +.I texconfig +allows one to configure and maintain TeX +in an easy and convenient manner, offering a series of dialog boxes to +the user. +.PP +The +.I tlmgr +program has subsumed this function for TeX Live. This program +is still supported, but the tlmgr interface is much more actively +developed and tested. +.PP +After choosing settings or options, the appropriate files +are changed automatically and the new settings are applied for the +user. If needed, copies of files in +.I TEXMFDIST +or +.I TEXMFMAIN +will be made in the user's +.I TEXMFCONFIG +tree. +.PP +.I texconfig +uses either the +.IR whiptail (1) +or +.IR dialog (1) +program to communicate with the user, so must be run in a terminal. +.PP +For making system-wide changes, which will apply to all users of TeX +(for example, default paper size and so on), run +.I texconfig-sys +instead. Changed or generated files will be placed in +.IR TEXMFSYSCONFIG . +(You may need to be root to do this.) +.PP +.I texconfig +also offers a non-interactive batch mode which can be accessed with +the following commands +.SH COMMANDS +Commands that accept further options usually display available options +if called without them. For example, +.B texconfig dvipdfm paper +will inform about valid paper settings. +.PP +.B +.IP conf +Display the system configuration. +.PP +.TP +.B dvipdfm paper [letter|legal|ledger|tabloid|a4|a3] +Set up dvipdfm to use papersize PAPER by default. +.TP +.B dvips add PRINTERNAME +Create a new (empty) configuration file +.I TEXMFCONFIG/dvips/config/config.PRINTERNAME. +This file can later be filled with the +.B mode, offset +or +.B printcmd +options +.TP +.B dvips del PRINTERNAME +Remove +.I config.PRINTERNAME +.TP +.B dvips mode +List available MetaFont modes. +.TP +.B dvips [-P PRINTER] mode MODE +Change the MetaFont mode to +.I MODE +for +.I PRINTER +or for all output files +.I (config.ps), +if no +.B -P +option is given. +.TP +.B dvips [-P PRINTER] offset x-OFFSET,y-OFFSET +Set printer offset for +.I PRINTER +or for all output files +.I (config.ps), +if no +.B -P +option is given. Offsets must be given with units, e.g. +.I 0pt,10pt +You can use testpage.tex from the LaTeX distribution to find these +numbers. +.TP +.B dvips [-P PRINTER] printcmd CMD +Set the printing command for +.I PRINTER +or for all output files +.I (config.ps), +if no +.B -P +option is given. Commands might be +.B lp +or +.B lpr. +See the description of the +.I o +option in +.B info dvips +or the +.I -O +option in +.B dvips(1). +.TP +.B faq +Display the list of Frequently Asked Questions about +.B teTeX +(and their answers). +.TP +.B font vardir DIR, font ro, font rw +.TP +.B formats +This command allows to edit +.B fmtutil.cnf(5) +and (re)creates any new or changed formats afterwards. +.TP +.B hyphen FORMAT +This command allows to edit the hyphenation configuration file for +formats that support this, and recreates the formats afterwards to +enable the new languages. Available formats are shown when no +.I FORMAT +is given. +.IP +Note that for formats that use LaTeX's +.I language.dat, + e.g. +.I (pdf)jadetex +and +.I latex +itself, this change is not persistent, since this file is a generated +file. You should not use this command in these cases, read +.B update-language(1) +for alternatives. +.TP +.B init [format] +Recreate +.I format +or all formats if none is given, and the font information. This is +the same as calling +.B fmtutil --byfmt format +or +.B fmtutil --all, +respectively, followed by +.B updmap. +.TP +.B mode-list +List available printer modes, together with the printers they were +developed for, and their DPI resolution +.TP +.B mode MODE +Set the default printer mode in +.I /etc/texmf/web2c/mktex.cnf +or the respective user file in +.I $TEXMFCONFIG/web2c +to +.B MODE. +.TP +.B paper [a4|letter] +Set the default papersize for +.B dvips, dvipdfm, pdftex +and +.B xdvi. +The set is restricted because not all programs understand all sizes. +.TP +.B pdftex paper [a4|letter] +Set the default paper size for +.B pdftex. +.TP +.B rehash +Call +.B mktexlsr. +.TP +.B xdvi paper PAPER +Set the default paper size for +.B xdvi. +The (long) list is available with +.B texconfig xdvi paper. + +.SH ENVIRONMENT +To let you change files, +.B texconfig +will open the editor specified in the VISUAL or EDITOR variables, or +.B sensible-editor +if both are unset. +.SH "SEE ALSO" +.IR whiptail (1), +.IR dialog (1), +.IR tlmgr (1), +.IR tex (1), +.IR mf (1), +.IR vi (1), +.IR EDITOR +environment variable. +.SH AUTHOR +Thomas Esser diff --git a/Master/texmf-dist/doc/man/man1/texconfig.man1.pdf b/Master/texmf-dist/doc/man/man1/texconfig.man1.pdf Binary files differnew file mode 100644 index 00000000000..61fad807ac1 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/texconfig.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/texdiff.1 b/Master/texmf-dist/doc/man/man1/texdiff.1 new file mode 100644 index 00000000000..32317947d83 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/texdiff.1 @@ -0,0 +1,220 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "TEXDIFF 1" +.TH TEXDIFF 1 "2009-09-24" "perl v5.8.8" "User Contributed Perl Documentation" +.SH "NAME" +\&\fBtexdiff\fR \- Compares two (La)TeX documents to create a merged version showing changes, similar to that of 'Change Tracking' in some word processors. +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +texdiff [\-\-nofloats|\-n] old.tex new.tex [diff.tex] +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +The first two files are compared and a new TeX file is output. When +the output file is processed with (La)TeX it marks new changes with +blue and old text with red with a strike-through line. Furthermore, +passages with changes are marked at the margin with grey bars by the +LaTeX \f(CW\*(C`changebar\*(C'\fR package (although only after running \f(CW\*(C`dvips\*(C'\fR, in +\&\f(CW\*(C`xdvi\*(C'\fR the bars are one inch too far left to compensate the one inch +offset inserted by TeX printer drivers). +.PP +\&\f(CW\*(C`texdiff\*(C'\fR uses and therefore requires the \f(CW\*(C`wdiff\*(C'\fR command to insert +these marks. If LaTeX macros are included in those striked out or +underlined passages, the latex run will most likely fail. The source +of most problems lies in \f(CW\*(C`wdiff\*(C'\fR tearing apart pairs of +braces. Therefore \f(CW\*(C`texdiff\*(C'\fR is a perl script that calls \f(CW\*(C`wdiff\*(C'\fR internally +and fixes \f(CW\*(C`wdiff\*(C'\fR's output by re-pairing braces again and handling some +commonly used LaTeX macros. +.PP +For texdiff to work, the following LaTeX code must be inserted in the +preamble of the LaTeX document: +.PP +.Vb 3 +\& \eusepackage{xcolor} \eusepackage{ulem} \eusepackage{changebar} +\& \enewcommand\eTLSins[1]{\ecbstart{}\etextcolor{ins}{\euline{#1}}\ecbend{}} +\& \enewcommand\eTLSdel[1]{\ecbdelete{}\etextcolor{del}{\esout{#1}}} +.Ve +.PP +Define editing colors \f(CW\*(C`ins\*(C'\fR and \f(CW\*(C`del\*(C'\fR with existing \f(CW\*(C`xcolor\*(C'\fR color names: + \ecolorlet{ins}{blue} \ecolorlet{del}{red} +.PP +Or from scratch: + \edefinecolor{ins}{rgb}{0, 0.5, 0} +.PP +These macros are \s-1NOT\s0 automatically interted at \ebegin{document} like +the original scripts did (see the \fB\s-1ACKNOWLEDGMENTS\s0\fR section below), +because this will not work on files of a multi-file document (those +included by \einclude or \einput). Furthermore, if you insert the +macros manually, you can tune them as you like, i. e. change text +color or position of changebars. Have a look at the documentation of +the ulem and changebar packages on how to do this! +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-\-nofloats\fR, \fB\-n\fR" 4 +.IX Item "--nofloats, -n" +If given, skips contents of figure environments, but does show +insertions and deletions in the caption commands. This is done to +avoid complex messups in subfloat or complex figure environments. +.IP "\fB\-\-debug\fR, \fB\-d\fR" 4 +.IX Item "--debug, -d" +Turns on debugging. Temporary files that contain numbered braces are +kept and a raw difference file is written as output file name appended +with '\-wdiff.tex'. In addition, several regular expression diagnostics +are printed. \fBWarning: produces a lot of output.\fR +.SH "AUTHOR" +.IX Header "AUTHOR" +Mark Doll <markdoll<\s-1AT\s0>gmx.net>, Cengiz Gunay <cengique<\s-1AT\s0>users.sf.net>. +.SH "ACKNOWLEDGMENTS" +.IX Header "ACKNOWLEDGMENTS" +.IP "\fB*\fR" 4 +.IX Item "*" +Version 0.4, by \s-1CG\s0, 2009/09/15. Added use of GetOpt to take an optional +parameter to skip float (e.g., figure or table) contents. Added an +optional debug mode. Embedded \s-1POD\s0 documentation. Fixed problem +with insertion and deletions appearing in the middle of sectioning +commands by throwing off LaTeX. +.IP "\fB*\fR" 4 +.IX Item "*" +Version 0.3, modified by Cengiz Gunay <cengique@users.sf.net>, +2009/06/30. Added some Latex commands that should be excluded and +fixed handling of '\e%' characters. +.IP "\fB*\fR" 4 +.IX Item "*" +Version 0.2, is a perl implementation of TeXdiff by Mark Doll +<markdoll@gmx.net>, 2006/08/09. It was derived from the original bash +and perl scripts created by Robert Maron <robmar@mimuw.edu.pl>, +available at http://www.robmar.net/TexDiff/. This version of texdiff +is available at http://mark.doll.name/texdiff/. +.SH "COPYRIGHT AND LICENSE" +.IX Header "COPYRIGHT AND LICENSE" +Copyleft 2006\-2009, Mark Doll and Cengiz Gunay +.PP +This library is free software; you may redistribute it and/or modify +it under the same terms as Perl itself. diff --git a/Master/texmf-dist/doc/man/man1/texdiff.man1.pdf b/Master/texmf-dist/doc/man/man1/texdiff.man1.pdf Binary files differnew file mode 100644 index 00000000000..5eeaf01aaa3 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/texdiff.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/texdirflatten.1 b/Master/texmf-dist/doc/man/man1/texdirflatten.1 new file mode 100644 index 00000000000..0da2a4fa74f --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/texdirflatten.1 @@ -0,0 +1,176 @@ +.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "TEXDIRFLATTEN 1" +.TH TEXDIRFLATTEN 1 "2009-04-17" "perl v5.10.0" "User Contributed Perl Documentation" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +\&\fBtexdirflatten\fR \- Collects all components of a (La)TeX file in a +single output directory \*(-- i.e., flattens its hierarchy. +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +texdirflatten \-f input.tex [\-o outputdir] +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +It parses the source file, following its included children (La)TeX +files recursively, to collect together its components, such as +graphics and BiBTeX bibliography files in different directories. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-f\fR \fIinput.tex\fR" 4 +.IX Item "-f input.tex" +Specifies input (La)TeX file. +.IP "\fB\-o\fR \fIoutputdir\fR" 4 +.IX Item "-o outputdir" +Directory to collect all files. \fBtexdirflatten\fR will copy each source +file, graphics and bibliography file to this directory. It will be +created if it is unexistent. If unspecified, it defaults to \f(CW\*(C`flat/\*(C'\fR. +.SH "EXAMPLES" +.IX Header "EXAMPLES" +The following example scans \f(CW\*(C`manuscript.tex\*(C'\fR in the current directory +and gathers it and all its components in the \f(CW\*(C`submit_01/\*(C'\fR directory: +.PP +.Vb 1 +\& $ texdirflatten \-f manuscript.tex \-o submit_01 +.Ve +.SH "CAVEATS" +.IX Header "CAVEATS" +Please take backups before running this command. No warranties +whatsoever provided. +.SH "BUGS" +.IX Header "BUGS" +Bug reports and patches are welcome. +.SH "AUTHOR" +.IX Header "AUTHOR" +Cengiz Gunay <cengique<\s-1AT\s0>users.sf.net> +.SH "COPYRIGHT AND LICENSE" +.IX Header "COPYRIGHT AND LICENSE" +Copyleft 2003\-2009, Cengiz Gunay +.PP +This library is free software; you may redistribute it and/or modify +it under the same terms as Perl itself. diff --git a/Master/texmf-dist/doc/man/man1/texdirflatten.man1.pdf b/Master/texmf-dist/doc/man/man1/texdirflatten.man1.pdf Binary files differnew file mode 100644 index 00000000000..69bea837ba7 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/texdirflatten.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/texdoc.1 b/Master/texmf-dist/doc/man/man1/texdoc.1 new file mode 100644 index 00000000000..bfaba2396af --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/texdoc.1 @@ -0,0 +1,80 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.9. +.TH TEXDOC "1" "June 2012" "texdoc 0.84" "User Commands" +.SH NAME +texdoc \- find & view documentation in TeX Live +.SH SYNOPSIS +.B texdoc +[\fIOPTION\fR]... \fINAME\fR... +.br +.B texdoc +\fIACTION\fR +.SH DESCRIPTION +Try to find appropriate TeX documentation for the specified NAME(s). +Alternatively, perform the given ACTION and exit. +.SS "Actions:" +.TP +\fB\-h\fR, \fB\-\-help\fR +Print this help message. +.TP +\fB\-V\fR, \fB\-\-version\fR +Print the version number. +.TP +\fB\-f\fR, \fB\-\-files\fR +Print the list of configuration files used. +.TP +\fB\-\-just\-view\fR file +Display file, given with full path (no searching). +.SH OPTIONS +.TP +\fB\-w\fR, \fB\-\-view\fR +Use view mode: start a viewer. (default) +.TP +\fB\-m\fR, \fB\-\-mixed\fR +Use mixed mode (view or list). +.TP +\fB\-l\fR, \fB\-\-list\fR +Use list mode: show a list of results. +.TP +\fB\-s\fR, \fB\-\-showall\fR +Use showall mode: show also "bad" results. +.TP +\fB\-i\fR, \fB\-\-interact\fR +Use interactive menus. (default) +.TP +\fB\-I\fR, \fB\-\-nointeract\fR +Use plain lists, no interaction required. +.TP +\fB\-M\fR, \fB\-\-machine\fR +Machine\-readable output for lists (implies \fB\-I\fR). +.TP +\fB\-q\fR, \fB\-\-quiet\fR +Suppress warnings and most error messages. +.TP +\fB\-v\fR, \fB\-\-verbose\fR +Print additional information (eg, viewer command). +.TP +\fB\-d\fR, \fB\-\-debug\fR[=\fIlist\fR] +Activate debug output (restricted to list). +.SH ENVIRONMENT +.IP +PAGER, BROWSER, PDFVIEWER, PSVIEWER, DVIVIEWER. +.SH FILES +.IP +<texmf>/texdoc/texdoc.cnf, see output of the \fB\-\-files\fR option. +.SH "REPORTING BUGS" +Report bugs to <texdoc@tug.org>. +.br +Texdoc home page: <http://tug.org/texdoc/> +.br +Source: <https://github.com/mpg/texdoc> +.SH COPYRIGHT +Copyright \(co 2008\-2011 Manuel P'egouri'e\-Gonnard. +License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>. +.br +This is free software: you are free to change and redistribute it. +.SH "SEE ALSO" +The full documentation is maintained as a PDF manual. The command +.IP +.B texdoc texdoc +.PP +should give you access to the complete manual. diff --git a/Master/texmf-dist/doc/man/man1/texdoc.man1.pdf b/Master/texmf-dist/doc/man/man1/texdoc.man1.pdf Binary files differnew file mode 100644 index 00000000000..516ce867e32 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/texdoc.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/texdoctk.1 b/Master/texmf-dist/doc/man/man1/texdoctk.1 new file mode 100644 index 00000000000..e7aebb7098a --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/texdoctk.1 @@ -0,0 +1,217 @@ +.TH TEXDOCTK 1 +.SH NAME +texdoctk \- GUI for easier access of TeX package and program documentations +.SH SYNOPSIS +.B texdoctk +-[aq] +.SH "DESCRIPTION" +.B texdoctk +is a GUI for easier access to a large part of the vast amount +of package and program documentations and tutorials for TeX and its +different derivatives (mainly LaTeX). It is optimized and included in +the teTeX and fpTeX distributions and also available with TeXLive. +.PP +The documentation is grouped into 17 categories; the 18th button of the main +panel is inactive by default and intended for use with local additions (see +section +.B CONFIGURATION +below). +.PP +In the settings window you see a checkbox in the html->ps and text->ps +converter menus for switching on/off output redirect. This is due to the fact +that some converters do not write their output into a file but to stdout by +default, so a redirect is needed, e.g. +.PP +a2ps myfile.txt >myfile.ps +.SH "OPTIONS" +.TP +.I "\-v" +verbose: enable some viewer messages which are otherwise sent to stderr, +as well as some warning popup windows. This can also be set in a +configuration file. +.TP +.I "\-a" +autoview: autostart viewer if a listbox contains only one item (this will +frequently happen in search results). This can also be set in a configuration +file. +.SH "CONFIGURATION" +.PP +The configuration is controlled by the system default configuration file +($TEXMFMAIN)/texdoctk/texdocrc.defaults, most of whose entries can though be +overridden by the users' own optional ~/.texdocrc files and/or command line +options. +.SS The Settings menu and configuration files +.PP +The Settings menu is used to change the user-definable settings of \fBtexdoctk\fP +for the duration of the program call or as new defaults. The latter case is +the purpose of the Save button, which generates or rewrites the user's own +~/.texdocrc file. The system defaults cannot be edited with the Settings +menu. +.TP +Paths +The TEXMF-type paths on the system are reported, and the user can specify the +name of the subdirectory of $HOMETEXMF, where the personal documentation is +stored. +.TP +General viewer behaviour + +.I Suppress error messages +toggle verbose mode (see option -v); default is off. + +.I Autostart viewer for one-item listboxes +if a listbox contains only one item (see option -a) + +.I Use text viewer for unknown file format +i.e. treat the file as plain text. \fBtexdoctk\fP should recognize the usual file +formats and also relate names like README to plain text, but some docs may have +freely invented names. Default is on; if switched off, trying to view such +files will raise an error. The switch does not influence printing: unrecognized +formats cannot be printed. + +.I Change viewer colours +using either RGB triplets in the format #rrggbb or the standardized names. +.TP +DVI/PostScript/PDF/HTML/Plain text +For text files, \fBtexdoctk\fP provides an own viewer. If this viewer is disabled, +but no alternative viewer is specified, \fBtexdoctk\fP tries to read the content +of the environment variable $PAGER. + +If you want to print the documentations, you will need converters to turn +non-PS files into PostScript. Here are some suggestions: + +\& dvi->ps: +dvips (is part of teTeX) (http://www.radicaleye.com/dvips.html) + +\& pdf->ps: +pdf2ps (http://www.cs.wisc.edu/~ghost) or +Acrobat Reader (http://www.adobe.com) + +\& html->ps: html2ps (http://user.it.uu.se/~jan/html2ps.html) + +\& plain text->ps: a2ps (http://www-inf.enst.fr/~demaille/a2ps/) + +The html->ps and text->ps converter menus for switching on/off output redirect. +This is due to the fact that some converters do not write their output into a +file but to stdout by default, so a redirect is needed, e.g. +.B a2ps myfile.txt >myfile.ps +.PP +The system-wide configuration file is ($TEXMFMAIN)/texdoctk/texdocrc.defaults +and should only be writable by the administrator of the installation using any +text editor. The optional user configuration file is ~/.texdocrc and can +override all but those system settings which affect the installation as a +whole. The preferred way of changing it is through the Settings menu. +.SS The databases +\fBtexdoctk\fP comes with a default database file ($TEXMFMAIN)/texdoctk/texdoctk.dat +with a special format. It is divided into 17 sections corresponding to the +17 buttons that are active by default. Each section begins with a line + +@\fIsection_name\fP + +where +.I section_name +is the text as it appears in the button. This title is +followed by the descriptive entries for each documentation, which have this +format: + +\fIpackage-label\fP;Short description for listbox (opt. \fIpackage-name\fP);path in doc directory;optional keywords + +(without breaking the line!). Comments (initiated with a #) and empty lines +are ignored by the program. The second field is the text displayed in the +selection listboxes of \fBtexdoctk\fP, and you will usually want to mention the name +of the package in parens along with it; the first field is a \fBunique\fP label +for the package for internal use of the program which will usually be chosen +identical to the package name, but can be different if there is more than one +documentation file coming with a package. +.PP +The administrator will probably install additional packages in the local texmf +tree. The corresponding documentation can be made accessible by an additional +database $TEXMFLOCAL/texdoctk/texdoctk-local.dat. Furthermore, individual +users possibly install additional packages in an texmf subdirectory of their +$HOME, for which they can make an individual database themselves as +$TEXMFHOME/texdoctk/texdoctk-pers.dat. After creating such files, texhash +must be executed. +.PP +Both types of databases must have the same structure as the system database, +although they need (and should) not include all its sections if there are no +additional entries. For example, if the the package +.I foo +is added to the local tree such that its documentation file is +($TEXMFLOCAL)/doc/latex/foo/foo.dvi and it is decided that it fits best into +the existing category Graphics, texdoctk-local.dat would look like this: + +@Graphics +.br +foo;Create bells and whistles (foo);latex/foo/foo.dvi;decoration + +The entry for +.I foo +will then be appended to the list of entries in the Graphics category. The 18th +button can be activated in the same way, but using a new category name; +possible entries at the beginning of the database which have not been assigned +to a category will be assigned to the default Miscellaneous, making the 18th +button active with that label. Note that you cannot have more than 18 +categories; if there are more, only the one defined last will appear and be +used. +.PP +If the documentation is included in the .sty file instead of a proper +documentation file, the optional keywords should start with +-?- directly after the semicolon, where ? is 0, 1, 2 or 3; these are flags +which indicate in which part of the .sty the instructions are placed and +should help \fBtexdoctk\fP to extract the documentation from the style and present +it without the code, which would normally be of little use. +.TP +0 +no specific place, scattered between the code +.TP +1 +at end, behind \\endinput; some .sty files have well-organized documentation +behind the end of the actual code, where TeX doesn't see it upon compilation +.TP +2 +at beginning, terminated by %%%%%%; in some other cases, some usage information +is at the beginning of the .sty as a comment terminated by a line full of % +.TP +3 +as 2, but with a blank line as termination +.PP +See the system database for plenty of examples. + +.SH "FILES" +.PP +\& $TEXMFMAIN/texdoctk/texdocrc.defaults +system-wide configuration file +.PP +\& ~/.texdocrc +(optional) personal configuration file; can also be created with the Settings menu +.PP +\& $TEXMFMAIN/texdoctk/texdoctk.dat +default database file for documentation files of the distribution +.PP +\& $TEXMFLOCAL/texdoctk/texdoctk-local.dat +(optional) local database file for documentation files +.PP +\& $TEXMFHOME/texdoctk/texdoctk-pers.dat +(optional) personal database file of individual users for documentation files +.SH BUGS +Widget placement in topic toplevels becomes ugly when the toplevel is stretched +or shrunk. +.PP +The font in the frame labels of the Settings menu are not forced to the default +font; this will become visible e.g. at hi-res screens, where the label font is +not scaled up. +.PP +Netscape and Mozilla error output will be written to stderr even if the quiet +mode was set. +.SH AUTHOR +.B texdoctk +was written by Thomas Ruedas <tr@geol.ku.dk>. +.PP +This manual page was originally written by Adrian Bunk <bunk@fs.tum.de> for +the Debian GNU/Linux system (but may be used by others). It is now maintained +by Thomas Ruedas. + +.SH COPYRIGHT +Copyright (C) 2000-2004 Thomas Ruedas +.br +This is free software; see the source for copying conditions. There is NO +warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. diff --git a/Master/texmf-dist/doc/man/man1/texdoctk.man1.pdf b/Master/texmf-dist/doc/man/man1/texdoctk.man1.pdf Binary files differnew file mode 100644 index 00000000000..e756cd7b8da --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/texdoctk.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/texexec.1 b/Master/texmf-dist/doc/man/man1/texexec.1 new file mode 100644 index 00000000000..19f56dab96b --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/texexec.1 @@ -0,0 +1,602 @@ +.TH "TEXEXEC" "1" "December 2006" "texexec 6.2" "ConTeXt" +.de URL +\\$2 \(laURL: \\$1 \(ra\\$3 +.. +.if \n[.g] .mso www.tmac +.de EX +.in +3 +.nf +.ft CW +.. +.de EE +.in -3 +.ft R +.fi +.. + +.SH "NAME" +texexec \- front end to the ConTeXt typesetting system + +.SH "SYNOPSIS" +\fBtexexec\fP [ \fIOPTION\fP ... ] \fIFILE\fP [ ... ] + +.SH "DESCRIPTION" + +\fBtexexec\fP, a \fBruby\fP(1) script, +is the command-line front end to the ConTeXt typesetting +system, an extensive macro package +built on the \fBtex\fP(1) family of typesetting programs. +\fBtexexec\fP provides several facilties: +.IP \(bu +Process a ConTeXt source file, +performing as many runs as +necessary of \fBtex\fP(1), \fBtexutil\fP(1), and +MetaPost (\fBmpost\fP(1)). Options control the output +format, the pages to process, paper size, and so forth. +.IP \(bu +Create new ConTeXt formats, useful during installation. +.IP \(bu +Post-process existing PDF files, including merging multiple +files, and extracting and rearranging pages within a file, +similar to the facilities provided for PostScript files by +\fBpsnup\fP(1) or for PDF files by \fBpdftk\fP(1). +.IP \(bu +Extract or strip documentation from ConTeXt source files +using \fBtexutil\fP(1). +.IP \(bu +Run MetaPost (\fBmpost\fP(1)) to generate figures from MetaPost source. +.IP \(bu +Produce proof sheets of figures used in a ConTeXt source file. +.IP +.SH "OPTIONS" + +All switches are specified in full here but can be abbreviated to the +shortest unique prefix. Thus, \fB--env\fP works the same as +\fB--environment\fP. With no options, \fBtexexec\fP assumes that +the file on the command line is a ConTeXt source file, i.e. a TeX file +in the ConTeXt dialect, and produces a PDF file using the source file. + +.SS "General Options" + +.IP "\fB--alone\fP" +Avoid calling other programs when possible. For +example, \fB--alone\fP will prevent \fBtexexec\fP from +using \fBfmtutil\fP(1) to generate formats (this prevention can +be handy when tracing installation problems). +.IP "\fB--environments\fP\fI=\fP\fIfile[,file[,...]]\fP" +Specify ConTeXt environment file(s), separated by commas, to use when +processing the source file. This option is useful when converting +from non-ConTeXt file formats without environment or layout settings. +.IP "\fB--help\fP" +Produce a summary of switches +and arguments. A more detailed help is produced by including +\fB--all\fP. +.IP "\fB--interface=\fP\fIlanguage\fP" +Specify the language +ConTeXt should use to communicate with you. +Options are +.IP +.RS +.IP "\fBen\fP" +US English +.IP "\fBnl\fP" +Dutch +.IP "\fBde\fP" +German +.IP "\fBuk\fP" +British English +.IP "\fBcz\fP" +Czech +.IP "\fBit\fP" +Italian +.RE +.IP "\fB--keep\fP" +Preserve a few of the temporary files generated while processing by +appending \fI.keep\fP to their name. For example, after +.EX +texexec --keep document.tex +.EE +you will find (besides \fIdocument.pdf\fP) \fIdocument.log.keep\fP +and \fIdocument.top.keep\fP. The \fIdocument.top\fP file is where +\fBtexexec\fP wraps \fIdocument.tex\fP with the proper ConTeXt macro +commands to set the output format, etc. +.IP "\fB--once\fP" +Process a file exactly once. (By default, +\fBtexexec\fP processes the file as many times as +necessary to sort out all references, typeset +\fBMetaPost\fP code, and so forth.) +.IP "\fB--purge\fP" +Get rid of most temporary files generated while processing the source +file. For example, +.EX +texexec --purge somefile.tex +.EE +will generate \fIsomefile.pdf\fP, cleaning up after itself and leaving +only one extra file, \fIsomefile.tuo\fP. See also the \fB--purge\fP +option of +.BR ctxtools (1) +.IP "\fB--purgeall\fP" +Get rid of all temporary files generated while processing the source +file, including the \fIfilename.tuo\fP file. See also the \fB--purge +--all\fP option combination of +.BR ctxtools (1) +.IP "\fB--randomseed=\fP\fINNNN\fP" +Set the random seed. +.IP "\fB--result=\fP\fIFILENAME\fP" +Allows you to change the +basename of the output file. See +\fB--mode\fP for an example. +.IP "\fB--runs=\fP\fINUMBER\fP" +Specify the number of runs to +perform on a file. Overrides +\fBtexexec\fP's calculations. +.IP "\fB--separation\fP" +Perform color separations. +.IP "\fB--silent\fP" +Suppress a few diagnostic and progress messages. +.IP "\fB--timeout=\fP\fINNN\fP" +Abort the run if a subprocess waits for more than \fINNN\fP seconds; +e.g. while waiting for user input when \fBtex\fP reports an undefined +control sequence. Useful for automated testing scripts, to make sure +the runs finish. +.IP "\fB--usemodules=\fP\fImodule1[,module2,[...]]\fP +Use the comma-separated list of modules. For example, to typeset +\fIdocument.tex\fP using the \fIbib\fP and \fIunits\fP modules: +.EX +texexec --usemodules=bib,units document.tex +.EE +.IP "\fB--verbose\fP" +Output extra diagnostic information. +.IP "\fB--version\fP" +Print the version number. +.IP + +.SS "Processing ConTeXt Source Files" + +Including specifying paper sizes, formats, and so forth. + +.IP "\fB--arrange\fP" +Perform page rearrangements, which are used to produce booklets. This +option tells ConTeXt to the first \fIn\fP-1 runs without taking +account of arrangements, then on the last run to pay attention to +the arrangement commands in the source file. +.IP "\fB--batchmode\fP" +Process the file in batchmode, which means +to typeset the whole document even if there are errors. More +imformation about \f(CWbatchmode\fP can be found in Donald +E. Knuth's \fITeXbook\fP. +.IP "\fB--nonstopmode\fP" +Process the file in nonstopmode, which means +to typeset the document and report errors, but not to stop at any +error. It is similar to batchmode but more verbose. More +imformation about \f(CWnonstopmode\fP can be found in Donald +E. Knuth's \fITeXbook\fP. +.IP "\fB--bodyfont=\fP\fIfont\fP" +The name of a font to preload for use in +setting the body of the text (OBSOLETE). +.IP "\fB--centerpage\fP" +Center the document on the page. +.IP "\fB--color\fP" +Turn on color mode. Color mode can also be set by +commands embedded in the document. These commands +override the \fB--color\fP option. +.IP "\fB--convert=\fP\fIFORMAT\fP" +Convert the input file to +ConTeXt format from \fIFORMAT\fP before +processing. In most cases, this conversion will result +in a TeX file. Currently supported input +\fIFORMAT\fPs are \fBxml\fP and +\fBsgml\fP. +.IP "\fB--dvipdfmx, --dvipdfm, --dpx, --dpm\fP" +Use the TeX engine (e.g. \fBpdftex\fP or \fBpdfetex\fP) +to make a DVI file and \fBdvipdfmx\fP(1) to turn it +into PDF. +.IP "\fB--dvi, --ps, --dvips\fP" +Use the TeX engine (e.g. \fBpdftex\fP or \fBpdfetex\fP) +to make a DVI file and \fBdvips\fP(1) to turn it +into PostScript. It's counterintuitive that \fB--dvi\fP produces +a PostScript file in addition to the DVI file. But that's because +\fB--dvi\fP is shorthand for \fB--dvips\fP; adding the \fB--nobackend\fP +option prevents \fBtexexec\fP's running \fBdvips\fP(1). See also the +\fB--engine\fP option. +.IP "\fB--fast\fP" +Typeset the document(s) as fast as possible without +causing problems. +.IP "\fB--final\fP" +Perform a final run without skipping anything. +This option is typically used with \fB--fast\fP. +.IP "\fB--language=\fP\fILANGUAGE\fP" +Set the language for +hyphenation. Can be specified in your source file. +Options are the same as those for \fB--interface\fP. +.IP "\fB--mode=\fP\fIMODELIST\fP, \fB--modes=\fP\fIMODELIST\fP" +Allows you to change the mode used while typesetting the +source file. The \fIMODELIST\fP is a comma separated list of modes. +Modes are a conditional-compilation facility +like \f(CW#ifdef\fP in C. So one source file can be used to produce +several typeset documents: one for A4 paper, one for +screen display in full color, one for letter paper, etc. For +example: +.IP +.EX +\f(CWtexexec --pdf --mode=A4 --result=manual-a manual-t.tex\fP +\f(CWtexexec --pdf --mode=letter --result=manual-l manual-t.tex\fP +\f(CWtexexec --pdf --mode=screen --result=manual-s manual-t.tex\fP +.EE +.IP +Here the \fB--mode\fP tells ConTeXt which +mode directives to use when typesetting the source file. The +\fB--result\fP option tells ConTeXt +where to put the output file. +.IP "\fB--modefile=\fP\fIfile\fP" +Load this file before most of the usual processing; usually used for +mode-related material. +.IP "\fB--noarrange\fP" +Ignore arrangement commands in the source file. +.IP "\fB--nobackend\fP" +Do not run the backend, e.g. \fBdvips\fP(1) or \fBdvipdfmx\fP(1). See +the \fB--dvips\fP or \fB--dvipdfmx\fP options. Why would you give one +of those options to choose a backend, yet tell \fBtexexec\fP not to +run the backend? Because each backend has its own syntax for +\f(CW\\special\fP calls. Specifying the backend allows the ConTeXt +macros to use the correct syntax so that when you later run the +backend to produce PostScript or PDF, the specials will be interpreted +correctly. +.IP "\fB--pages=\fP\fIPAGENUMBERLIST\fP" +Specify the pages or page +range to appear in the output file. +\fIPAGENUMBERLIST\fP may be the keyword \fBodd\fP +or \fBeven\fP; or one or more pages or page ranges separated by commas. +For example, +.EX +\f(CWtexexec --pages=1,7,8-11,14 somefile.tex\fP +.EE +.IP "\fB--paperformat=\fP\fIKEY\fP" +For typesetting multiple pages on a +single piece of paper. \fIKEY\fP has the form \fBa4a3\fP +(for printing A4 pages on A3 paper), \fBa5a4\fP +(for printing A5 pages on A4 paper), or in general \fBaMaN\fP. +The actual layout of the pages is specified with the +\fB--printformat\fP option. +.IP "\fB--pdf, --pdftex\fP" +Use \fBpdftex\fP(1) to produce a pdf document (the default). +.IP "\fB--printformat=\fP\fIKEY\fP" +Specify the layout of the final +output. \fIKEY\fP can be \fBup\fP, resulting in 2 +pages per sheet, double sided; or \fBdown\fP, resulting +in 2 rotated pages per sheet, double sided. Use the +\fB--paperformat\fP option to specify the original page +and sheet size. +.IP "\fB--utfbom\fP" +Turn on UTF-8 encoding. +.IP "\fB--xetex, --xtx\fP" +Use \fBxetex\fP(1) to produce a pdf document. +.IP + +.SS "Creating ConTeXt Format Files" + +.IP "\fB--make\fP" +Generate a ConTeXt format file. For example, to make +\fIcont-en.fmt\fP and have it placed in a default format directory: +.EX +texexec --make de +.EE +The most common invocation, which is used by scripts that install a new version +of ConTeXt (see \fBctxtools\fP(1)), uses \fB--all\fP +so that \fBtexexec\fP makes the usual formats: +.EX +texexec --make --all +.EE +.IP "\fB--local\fP" +When searching for TeX or MetaPost formats, look in the current directory +rather than in the location set by the kpse library. See +.BR kpathsea (1) +for more information on path searching. +.IP "\fB--check\fP" +Check and report information about the ConTeXt version, the +distribution, the TeX engine, and the language interfaces/formats. + +.SS "Expert options" + +You should know what you're doing if you use these options! +.IP "\fB--alpha" +Use the TEXMFALPHA environment variable to find and +run an alpha release of ConTeXt. +.IP "\fB--beta" +Use the TEXMFBETA environment variable to find and +run a beta release of ConTeXt. +.IP "\fB--distribution\fP\fI=dist\fP" +Usually one of \fBstandard\fP, \fBweb2c\fP, or \fBmiktex\fP. +\fBtexexec\fP should figure it out automatically, and you shouldn't +need to use this option. +.IP "\fB--engine\fP\fI=texengine\fP" +Specify the program to do the hard work of typesetting. Currently +either \fBpdftex\fP (the default), \fBxetex\fP, or \fBaleph\fP. +The \fBluatex\fP value is experimental. The \fB--engine\fP +option is not usually needed. Instead, let +\fBtexexec\fP figure out the setting based on other command-line +information. See for example the \fB--xetex\fP or \fB--pdf\fP +switches. + +.SS "Postprocess PDF Files" + +.IP "\fB--combination=\fP\fIROWS\fP\fB*\fP\fICOLS\fP" +Specify the number of pages to show on a single page. Use with +\fB--pdfcombine\fP. +.IP "\fB--pdfarrange\fP" +For rearranging pages in PDF files. +.EX +\f(CWtexexec --pdfarrange --paperformat=a5a4 --printformat=up foo.pdf\fP +.EE +This command creates an A5 booklet from a PDF file +\fIfoo.pdf\fP. \fB--pdfarrange\fP is used in +conjunction with the following options. +.IP "\fB--pdfcopy\fP" +Copy and perhaps process pages from the pdf file. +The resulting file is \fItexexec.pdf\fP by default, but you can change +that using \fB--result\fP. Use the \fB--scale\fP option to magnify or +demagnify the original pages and the \fB--pages\fP option to select +the pages to copy. Here is an example using all these options: +.EX +texexec --pages=4-7 --pdfcopy --scale=750 --result=one images.pdf +.EE +It takes pages 4-7 from \fIimages.pdf\fP, scales them by 75%, +and copies them to \fIone.pdf\fP. +.IP "\fB--scale=\fP\fIinteger\fP" +If the integer is less than 10, then it is taken as an (integer) +magnification factor. Otherwise, it is taken as a magnification +factor in TeX terms, i.e. with 1000 meaning full scale. +.IP "\fB--paperoffset=\fP\fIdimen\fP" +Specify the space between the +edge of the pages and the beginning of the text block. +.IP "\fB--backspace=\fP\fIdimen\fP" +Specify the inside (gutter) margins. +.IP "\fB--topspace=\fP\fIdimen\fP" +Specify the top and bottom margin. +.IP "\fB--markings\fP" +Add crop marks. +.IP "\fB--addempty=\fP\fIPAGES\fP" +Add empty pages after the pages specified in \fIPAGES\fP. (Useful +for, among other things, adding blank pages after a table of +contents.) +.IP "\fB--textwidth=\fP\fIWIDTH\fP" +Set the width of +the original text. Specifying this parameter with a +single-sided original will allow ConTeXt to adjust +the page layout for double-sided output, producing much +more attractive results. + +With the \fB--pdfarrange\fP flag, specifying more +than one file will result in all of the files being +combined in the final result, allowing you to add title +pages, decorated part separators, and so forth. + +You can also do more complex manipulations, such as +adding additional text to the page by setting up a +small file with layout definitions and a simple figure +insertion loop. +.IP "\fB--pdfcombine\fP" +Combine multiple pages. Requires the \fB--combination\fP option. +.IP "\fB--pdfselect\fP" +Extract pages from a file. Use in combination with the +\fB--selection\fP switch, as in +.EX +\f(CWtexexec --pdfselect --paperformat=S6 +--selection=1,9,14 file-1\fP +.EE +which extracts pages 1, 9, and 14 from +\fIfile-1.pdf\fP, and places them in +\fItexexec.pdf\fP (the default output filename if +an output file isn't specified). + +See \fB--pdfarrange\fP for other +options. +.IP "\fB--selection=\fP\fIPAGES\fP" +Specify pages to be affected by +another option. See \fB--pdfarrange\fP and +\fB--pdfselect\fP for examples. + +.SS "XML handling" +.IP "\fB--filters=\fP\fIfilter1[,filter2[,...]]\fP +Specify XML filters to use. + +.SS "Extract or Strip Out Documentation" + +.IP "\fB--listing\fP" +Produce a typeset version of the source code in +\fIFILE\fP. You can specify the format of the output +file. For example, use +.EX +\f(CWtexexec --ps --listing readme.now\fP +.EE +to produce a PostScript file called +\fItexexec.ps\fP. + +See also \fB--backspace\fP, \fB--topspace\fP, and \fB--result\fP. +.IP "\fB--module\fP" +Create documentation for ConTeXt, +MetaPost (see \fBmpost\fP(1)), +.BR perl (1), +and +.BR ruby (1) +modules. +Converts the documentation to ConTeXt format and +then typesets a documentated version of the source file. + +Documentation lines in ConTeXt source files are +specified by beginning lines with these strings: + +\f(CW%C\fP : Copyright information + +\f(CW%D\fP : Documentation lines + +\f(CW%I\fP : TeXEdit information lines (mostly in Dutch) + +\f(CW%M\fP : Macro code needed to processs the documentation + +\f(CW%S\fP : Suppressed lines + +The same forms can be used for Perl or ruby scripts, except that the \f(CW%\fP +character (the TeX comment character) is replaced by \f(CW#\fP (the +Perl comment character). + +See also the \fB--documentation\fP option to +.BR ctxtools (1). + +.SS "Process MetaPost Figures" + +.IP "\fB--mpsformats=\fP\fIname\fP" +The name of a MetaPost format file, e.g. \fBmetafun\fP (the default). +.IP "\fB--mptex\fP" +Strips out and typesets TeX code embedded in a +MetaPost file. +.IP "\fB--nomp\fP" +Do not run \fBmpost\fP(1), even if needed. +.IP "\fB--nomprun\fP" +Do not run \fBmpost\fP(1) on embedded +MetaPost code. + +.SS "Producing Proof Sheets of Figures" + +Generate information and proof sheets of one or more (non-EPS) +graphics files. For example, +.EX +texexec --figures *.png *.jpg +.EE +scans the current directory for PNG and JPG files +and extracts useful information about their sizes and types. By +default, this information is stored in +.IR rlxtools.rli . +Then the given figures are made into a proof sheet (by default +\fItexexec.pdf\fP) according to the method specified by the +\fB--method\fP option. Note that newer versions of +.BR pdftex (1) +do not support TIFF inclusion. +.IP "\fB--method=\fP\fIALTERNATIVE\fP" +Specify one of three options to produce the document containing the images +used in the source file: + +\fBa\fP : A proof sheet with additional +information provided for each figure (the default) + +\fBb\fP : A proof sheet with the graphics only + +\fBc\fP : One figure per page, with the page +clipped to the bounding box of the +figure + +See also \fB--paperoffset\fP, +which allows you to specify an offset to be added to +the page, as in +.EX +texexec --figures --method=c --paperoffset=.5cm *.pdf *.png *.jpg +.EE + +.SH "USAGE" + +Each ConTeXt user interface (language) has its own format. The +following command generates two formats, one using the English +interface for typesetting in English, and one for Dutch: +.EX +\f(CWtexexec --make en nl\fP +.EE + +By default, the language used for typesetting matches the +user-interface language (set with +\fB--interface\fP. It is possible to use one +language for typesetting and another for messages by changing the +relevant settings in \fIcont-usr.tex\fP. These languages can +also be changed on the command line with a command such as +.IP +.RS +\f(CWtexexec --make --language=pl,cz,sk en\fP +.RE +.IP +That command generates a ConTeXt format file with an English user +interface, and the main language set to Polish (\fBpl\fP). Czech +and Slovak hyphenation patterns are also loaded +so that Czech and Slovak text included in a source file will be +typeset properly (\fBcz\fP and \fBsk\fP). +.IP o +When the appropriate formats are present, a file can be typeset +by typing +.EX +\f(CWtexexec test\fP +.EE +.IP +\fBtexexec\fP tries to determine what interface it should use to +typeset \fItest.tex\fP by looking for a line such as +.IP +.EX +\f(CW% interface=en tex=pdftex output=pdftex\fP +.EE +.IP +at the top of the file (i.e., on the very first line). This line is +equivalent to \fBTeX\fP's format line, ``&\fIFORMAT\fP''). +.IP +By default, \fBtexexec\fP will produce a PDF file using \fBpdftex\fP(1). The +\fB--dvips\fP flag tells \fBtexexec\fP to produce a PostScript +file instead. +.IP +After an error-free run, \fBtexexec\fP will run \fBtexutil\fP(1) to +determine whether additional runs of \fBtex\fP(1) (or +\fBpdftex\fP(1)) or any utility programs (e.g., \fBbibtex\fP(1), +\fBmakeindex\fP(1)) are necessary. You can suppress these +additional runs by specifying the \fB--once\fP or +\fB--runs\fP flags: +.IP +.EX +\f(CWtexexec --once test\fP +\f(CWtexexec --runs=2 test\fP +.EE +.IP + +.SH EXAMPLES +.TP +Produce PDF from ConTeXt source (the .tex extension is optional): +\f(CWtexexec file.tex\fP +.TP +Same as the above but without rerunning for crossreferences, etc.: +\f(CWtexexec --once file.tex\fP +.TP +Produce PostScript from ConTeXt source: +\f(CWtexexec --ps file.tex\fP +.TP +Produce file-a4.pdf using conditional compilation (modes): +\f(CWtexexec --mode=a4 --result=file-a4 file.tex\fP +.TP +Generate format (.fmt) files used by ConTeXt (used during installation): +\f(CWtexexec --make --all\fP + + +.SH "INITIALIZATION" +.IP +\fBtexexec\fP requires ruby. On Unix and Unix-like systems, no special +steps have to be taken to get \fBtexexec\fP to work beyond installing +ruby and having the \fBruby\fP(1) binary in your path. + +.SH "SEE ALSO" +.PP +\fBbibtex\fP(1), \fBctxtools\fP(1), \fBdvipdfmx\fP(1), \fBdvips\fP(1), +\fBfmtutil\fP(1), \fBmakeindex\fP(1), \fBmpost\fP(1), +\fBmptopdf\fP(1), \fBpdftex\fP(1), \fBpdftk\fP(1), \fBruby\fP(1), +\fBpsnup\fP(1), \fBtex\fP(1), \fBtexfont\fP(1), \fBtexmfstart\fP(1), +\fBtexshow\fP(1), +\fBtexutil\fP(1), \fBxetex\fP(1). +.PP +The texexec manual +.IR mtexexec.pdf , +available from +.URL "http://www.pragma-ade.com/dir/general/manuals/" "PRAGMA ADE" . +.PP +Donald E. Knuth's \fIThe TeXbook\fP. +.PP +.URL "http://www.contextgarden.net" "ConTeXt wiki" . + +.SH "AUTHOR" +This manpage was written by Tobias Burnus +<burnus@gmx.de> and C.M. Connelly +<c@eskimo.com> and updated by Sanjoy Mahajan <sanjoy@mit.edu>. +It is based on the +.I mtexexec.pdf +manual written by Hans Hagen <pragma@wxs.nl>. diff --git a/Master/texmf-dist/doc/man/man1/texexec.man1.pdf b/Master/texmf-dist/doc/man/man1/texexec.man1.pdf Binary files differnew file mode 100644 index 00000000000..5823672f6af --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/texexec.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/texhash.1 b/Master/texmf-dist/doc/man/man1/texhash.1 new file mode 100644 index 00000000000..9ef4b884346 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/texhash.1 @@ -0,0 +1 @@ +.so man1/mktexlsr.1 diff --git a/Master/texmf-dist/doc/man/man1/texhash.man1.pdf b/Master/texmf-dist/doc/man/man1/texhash.man1.pdf Binary files differnew file mode 100644 index 00000000000..c620703b914 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/texhash.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/texindy.1 b/Master/texmf-dist/doc/man/man1/texindy.1 new file mode 100644 index 00000000000..d1b4417af93 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/texindy.1 @@ -0,0 +1,446 @@ +.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.04) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "texindy 1" +.TH texindy 1 "2010-05-10" "Version 1.11" "xindy" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +texindy \- create sorted and tagged index from raw LaTeX index +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +.Vb 2 +\& texindy [\-V?h] [\-qv] [\-iglr] [\-d magic] [\-o outfile.ind] [\-t log] \e +\& [\-L lang] [\-C codepage] [\-M module] [idx0 idx1 ...] +.Ve +.Sh "GNU-Style Long Options for Short Options:" +.IX Subsection "GNU-Style Long Options for Short Options:" +.Vb 10 +\& \-V / \-\-version +\& \-? / \-h / \-\-help +\& \-q / \-\-quiet +\& \-v / \-\-verbose +\& \-i / \-\-stdin +\& \-g / \-\-german +\& \-l / \-\-letter\-ordering +\& \-r / \-\-no\-ranges +\& \-d / \-\-debug (multiple times) +\& \-o / \-\-out\-file +\& \-t / \-\-log\-file +\& \-L / \-\-language +\& \-C / \-\-codepage +\& \-M / \-\-module (multiple times) +\& \-I / \-\-input\-markup (supported: latex, omega) +.Ve +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +\&\fBtexindy\fR is the LaTeX-specific command of xindy, the flexible +indexing system. It takes a raw index as input, and produces a merged, +sorted and tagged index. Merging, sorting, and tagging is controlled +by xindy modules, with a convenient set already preloaded. +.PP +Files with the raw index are passed as arguments. If no arguments are +passed, the raw index will be read from standard input. +.PP +A good introductionary description of \fBtexindy\fR appears in the +indexing chapter of the LaTeX Companion (2nd ed.) +.PP +If you want to produce an index for LaTeX documents with special index +markup, the command \fIxindy\fR\|(1) is probably more of interest for you. +.PP +\&\fBtexindy\fR is an approach to merge support for the \fImake-rules\fR +framework, own xindy modules (e.g., for special LaTeX commands in the +index), and a reasonable level of MakeIndex compatibility. There are +other older approaches, eventually they will get a description on the +xindy Web Site, http://www.xindy.org/. +.SH "OPTIONS" +.IX Header "OPTIONS" +.ie n .IP """\-\-version""\fR / \fB\-V" 4 +.el .IP "\f(CW\-\-version\fR / \fB\-V\fR" 4 +.IX Item "--version / -V" +output version numbers of all relevant components and exit. +.ie n .IP """\-\-help""\fR / \fB\-h\fR / \fB\-?" 4 +.el .IP "\f(CW\-\-help\fR / \fB\-h\fR / \fB\-?\fR" 4 +.IX Item "--help / -h / -?" +output usage message with options explanation. +.ie n .IP """\-\-quiet""\fR / \fB\-q" 4 +.el .IP "\f(CW\-\-quiet\fR / \fB\-q\fR" 4 +.IX Item "--quiet / -q" +Don't output progress messages. Output only error messages. +.ie n .IP """\-\-verbose""\fR / \fB\-v" 4 +.el .IP "\f(CW\-\-verbose\fR / \fB\-v\fR" 4 +.IX Item "--verbose / -v" +Output verbose progress messages. +.ie n .IP """\-\-debug""\fR \fImagic\fR / \fB\-d\fR \fImagic" 4 +.el .IP "\f(CW\-\-debug\fR \fImagic\fR / \fB\-d\fR \fImagic\fR" 4 +.IX Item "--debug magic / -d magic" +Output debug messages, this option may be specified multiple times. +\&\fImagic\fR determines what is output: +.Sp +.Vb 6 +\& magic remark +\& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +\& script internal progress messages of driver scripts +\& keep_tmpfiles don\*(Aqt discard temporary files +\& markup output markup trace, as explained in xindy manual +\& level=n log level, n is 0 (default), 1, 2, or 3 +.Ve +.ie n .IP """\-\-out\-file""\fR \fIoutfile.ind\fR / \fB\-o\fR \fIoutfile.ind" 4 +.el .IP "\f(CW\-\-out\-file\fR \fIoutfile.ind\fR / \fB\-o\fR \fIoutfile.ind\fR" 4 +.IX Item "--out-file outfile.ind / -o outfile.ind" +Output index to file \fIoutfile.ind\fR. If this option is not passed, the +name of the output file is the base name of the first argument and the +file extension \fIind\fR. If the raw index is read from standard input, +this option is mandatory. +.ie n .IP """\-\-log\-file""\fR \fIlog.ilg\fR / \fB\-t\fR \fIlog.ilg" 4 +.el .IP "\f(CW\-\-log\-file\fR \fIlog.ilg\fR / \fB\-t\fR \fIlog.ilg\fR" 4 +.IX Item "--log-file log.ilg / -t log.ilg" +Output log messages to file \fIlog.ilg\fR. These log messages are +independent from the progress messages that you can influence with +\&\f(CW\*(C`\-\-debug\*(C'\fR or \f(CW\*(C`\-\-verbose\*(C'\fR. +.ie n .IP """\-\-language""\fR \fIlang\fR / \fB\-L\fR \fIlang" 4 +.el .IP "\f(CW\-\-language\fR \fIlang\fR / \fB\-L\fR \fIlang\fR" 4 +.IX Item "--language lang / -L lang" +The index is sorted according to the rules of language \fIlang\fR. These +rules are encoded in a xindy module created by \fImake-rules\fR. +.Sp +If no input encoding is specified via \f(CW\*(C`\-\-codepage\*(C'\fR, a xindy module +for that language is searched with a latin, a cp, an iso, or ascii +encoding, in that order. +.ie n .IP """\-\-codepage""\fR \fIenc\fR / B <\-C> \fIenc" 4 +.el .IP "\f(CW\-\-codepage\fR \fIenc\fR / B <\-C> \fIenc\fR" 4 +.IX Item "--codepage enc / B <-C> enc" +The raw input is in input encoding \fIenc\fR. This information is used to +select the correct xindy sort module and also the \fIinputenc\fR target +encoding for \f(CW\*(C`latex\*(C'\fR input markup. +.Sp +When \f(CW\*(C`omega\*(C'\fR input markup is used, \f(CW\*(C`utf8\*(C'\fR is always used as the sort +codepage and no inputenc module is loaded. Then this option is +ignored. +.ie n .IP """\-\-module""\fR \fImodule\fR / \fB\-M\fR \fImodule" 4 +.el .IP "\f(CW\-\-module\fR \fImodule\fR / \fB\-M\fR \fImodule\fR" 4 +.IX Item "--module module / -M module" +Load the xindy module \fImodule.xdy\fR. This option may be specified +multiple times. The modules are searched in the xindy search path that +can be changed with the environment variable \f(CW\*(C`XINDY_SEARCHPATH\*(C'\fR. +.ie n .IP """\-\-input\-markup""\fR \fIinput\fR / \fB\-I\fR \fIinput" 4 +.el .IP "\f(CW\-\-input\-markup\fR \fIinput\fR / \fB\-I\fR \fIinput\fR" 4 +.IX Item "--input-markup input / -I input" +Specifies the input markup of the raw index. Supported values for +\&\fIinput\fR are \f(CW\*(C`latex\*(C'\fR and \f(CW\*(C`omega\*(C'\fR. +.Sp +\&\f(CW\*(C`latex\*(C'\fR input markup is the one that is emitted by default from the +LaTeX kernel, or by the \f(CW\*(C`index\*(C'\fR macro package of David Jones. +^^\-notation of single byte characters is supported. Usage of LaTeX's +\&\fIinputenc\fR package is assumed as well. +.Sp +\&\f(CW\*(C`omega\*(C'\fR input markup is like \f(CW\*(C`latex\*(C'\fR input markup, but with Omega's +^^\-notation as encoding for non-ASCII characters. LaTeX \fIinputenc\fR +encoding is not used then, and \f(CW\*(C`utf8\*(C'\fR is enforced to be the codepage +for sorting. +.SH "SUPPORTED LANGUAGES / CODEPAGES" +.IX Header "SUPPORTED LANGUAGES / CODEPAGES" +The following languages are supported: +.Sh "Latin scripts" +.IX Subsection "Latin scripts" +.Vb 10 +\& albanian gypsy portuguese +\& croatian hausa romanian +\& czech hungarian russian\-iso +\& danish icelandic slovak\-small +\& english italian slovak\-large +\& esperanto kurdish\-bedirxan slovenian +\& estonian kurdish\-turkish spanish\-modern +\& finnish latin spanish\-traditional +\& french latvian swedish +\& general lithuanian turkish +\& german\-din lower\-sorbian upper\-sorbian +\& german\-duden norwegian vietnamese +\& greek\-iso polish +.Ve +.PP +German recognizes two different sorting schemes to handle umlauts: +normally, \f(CW\*(C`a\*:\*(C'\fR is sorted like \f(CW\*(C`ae\*(C'\fR, but in phone books or +dictionaries, it is sorted like \f(CW\*(C`a\*(C'\fR. The first scheme is known as +\&\fI\s-1DIN\s0 order\fR, the second as \fIDuden order\fR. +.PP +\&\f(CW\*(C`*\-iso\*(C'\fR language names assume that the raw index entries are in \s-1ISO\s0 +8859\-9 encoding. +.PP +\&\f(CW\*(C`gypsy\*(C'\fR is a northern Russian dialect. +.Sh "Cyrillic scripts" +.IX Subsection "Cyrillic scripts" +.Vb 3 +\& belarusian mongolian serbian +\& bulgarian russian ukrainian +\& macedonian +.Ve +.Sh "Other scripts" +.IX Subsection "Other scripts" +.Vb 1 +\& greek klingon +.Ve +.Sh "Available Codepages" +.IX Subsection "Available Codepages" +This is not yet written. You can look them up in your xindy +distribution, in the \fImodules/lang/language/\fR directory (where +\&\fIlanguage\fR is your language). They are named +\&\fIvariant\-codepage\-lang.xdy\fR, where \fIvariant\-\fR is most often empty +(for german, it's \f(CW\*(C`din5007\*(C'\fR and \f(CW\*(C`duden\*(C'\fR; for spanish, it's \f(CW\*(C`modern\*(C'\fR +and \f(CW\*(C`traditional\*(C'\fR, etc.) +.PP +.Vb 1 +\& < Describe available codepages for each language > +\& +\& < Describe relevance of codepages (as internal representation) for +\& LaTeX inputenc > +.Ve +.SH "TEXINDY STANDARD MODULES" +.IX Header "TEXINDY STANDARD MODULES" +There is a set of \fBtexindy\fR standard modules that help to process +LaTeX index files. Some of them are automatically loaded. Some of them +are loaded by default, this can be turned off with a \fBtexindy\fR +option. Others may be specified as \f(CW\*(C`\-\-module\*(C'\fR argument to achieve a +specific effect. +.PP +.Vb 1 +\& xindy Module Category Description +.Ve +.Sh "Sorting" +.IX Subsection "Sorting" +.Vb 10 +\& word\-order Default A space comes before any letter in the +\& alphabet: \`\`index style\*(Aq\*(Aq is listed before +\& \`\`indexing\*(Aq\*(Aq. Turn it off with option \-l. +\& letter\-order Add\-on Spaces are ignored: \`\`index style\*(Aq\*(Aq +\& is sorted after \`\`indexing\*(Aq\*(Aq. +\& keep\-blanks Add\-on Leading and trailing white space (blanks +\& and tabs) are not ignored; intermediate +\& white space is not changed. +\& ignore\-hyphen Add\-on Hyphens are ignored: +\& \`\`ad\-hoc\*(Aq\*(Aq is sorted as \`\`adhoc\*(Aq\*(Aq. +\& ignore\-punctuation Add\-on All kinds of punctuation characters are +\& ignored: hyphens, periods, commas, slashes, +\& parentheses, and so on. +\& numeric\-sort Auto Numbers are sorted numerically, not like +\& characters: \`\`V64\*(Aq\*(Aq appears before \`\`V128\*(Aq\*(Aq. +.Ve +.Sh "Page Numbers" +.IX Subsection "Page Numbers" +.Vb 10 +\& page\-ranges Default Appearances on more than two consecutive +\& pages are listed as a range: \`\`1\-\-4\*(Aq\*(Aq. +\& Turn it off with option \-r. +\& ff\-ranges Add\-on Uses implicit \`\`ff\*(Aq\*(Aq notation for ranges +\& of three pages, and explicit ranges +\& thereafter: 2f, 2ff, 2\-\-6. +\& ff\-ranges\-only Add\-on Uses only implicit ranges: 2f, 2ff. +\& book\-order Add\-on Sorts page numbers with common book numbering +\& scheme correctly \-\- Roman numerals first, then +\& Arabic numbers, then others: i, 1, A. +.Ve +.Sh "Markup and Layout" +.IX Subsection "Markup and Layout" +.Vb 10 +\& tex Auto Handles basic TeX conventions. +\& latex\-loc\-fmts Auto Provides LaTeX formatting commands +\& for page number encapsulation. +\& latex Auto Handles LaTeX conventions, both in raw +\& index entries and output markup; implies +\& tex. +\& makeindex Auto Emulates the default MakeIndex input syntax +\& and quoting behavior. +\& latin\-lettergroups Auto Layout contains a single Latin letter +\& above each group of words starting with the +\& same letter. +\& german\-sty Add\-on Handles umlaut markup of babel\*(Aqs german +\& and ngerman options. +.Ve +.SH "COMPATIBILITY TO MAKEINDEX" +.IX Header "COMPATIBILITY TO MAKEINDEX" +\&\fBxindy\fR does not claim to be completely compatible with MakeIndex, +that would prevent some of its enhancements. That said, we strive to +deliver as much compatibility as possible. The most important +incompatibilities are +.IP "\(bu" 4 +For raw index entries in LaTeX syntax, \f(CW\*(C`\eindex{aaa|bbb}\*(C'\fR is +interpreted differently. For MakeIndex \f(CW\*(C`bbb\*(C'\fR is markup that is output +as a LaTeX tag for this page number. For \fBxindy\fR, this is a location +attribute, an abstract identifier that will be later associated with +markup that should be output for that attribute. +.Sp +For straight-forward usage, when \f(CW\*(C`bbb\*(C'\fR is \f(CW\*(C`textbf\*(C'\fR or similar, we +supply location attribute definitions that mimic MakeIndex's +behaviour. +.Sp +For more complex usage, when \f(CW\*(C`bbb\*(C'\fR is not an identifier, no such +compatibility definitions exist and may also not been created with +current \fBxindy\fR. In particular, this means that by default the LaTeX +package \f(CW\*(C`hyperref\*(C'\fR will create raw index files that cannot be +processed with \fBxindy\fR. This is not a bug, this is the unfortunate +result of an intented incompatibility. It is currently not possible to +get both hyperref's index links and use \fBxindy\fR. +.Sp +A similar situation is reported to exist for the \f(CW\*(C`memoir\*(C'\fR LaTeX +class. +.Sp +Programmers who know Common Lisp and Lex and want to work on a remedy +should please contact the author. +.IP "\(bu" 4 +The MakeIndex compatibility definitions support only the default raw +index syntax and markup definition. It is not possible to configure +raw index parsing or use a MakeIndex style file to describe output +markup. +.SH "ENVIRONMENT" +.IX Header "ENVIRONMENT" +.ie n .IP """TEXINDY_AUTO_MODULE""" 4 +.el .IP "\f(CWTEXINDY_AUTO_MODULE\fR" 4 +.IX Item "TEXINDY_AUTO_MODULE" +This is the name of the xindy module that loads all auto-loaded +modules. The default is \f(CW\*(C`texindy\*(C'\fR. +.SH "AUTHOR" +.IX Header "AUTHOR" +Joachim Schrod +.SH "LEGALESE" +.IX Header "LEGALESE" +\&\fBtexindy\fR is free software; you can redistribute it and/or modify it +under the terms of the \s-1GNU\s0 General Public License as published by the +Free Software Foundation; either version 2 of the License, or (at your +option) any later version. +.PP +This program is distributed in the hope that it will be useful, +but \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of +\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0. See the +\&\s-1GNU\s0 General Public License for more details. diff --git a/Master/texmf-dist/doc/man/man1/texindy.man1.pdf b/Master/texmf-dist/doc/man/man1/texindy.man1.pdf Binary files differnew file mode 100644 index 00000000000..a5dea855ff8 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/texindy.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/texlinks.1 b/Master/texmf-dist/doc/man/man1/texlinks.1 new file mode 100644 index 00000000000..75e7effcb15 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/texlinks.1 @@ -0,0 +1,66 @@ +.TH "texlinks" "8" "November 2007" "teTeX" "teTeX" +.PP +.SH "NAME" +texlinks \- maintain symbolic links from format to engine +.PP +.SH "SYNOPSIS" +.PP +\fBtexlinks\fP [ \fIOPTIONS\fP\&.\&.\&. ] \fIDIRECTORIES\fP\&.\&.\&. +.PP +.SH "DESCRIPTION" +.PP +\fBtexlinks\fP is used to create or recreate symbolic links from +formats to engines according to the information in +\fIfmtutil\&.cnf\fP or a file specified with \fB--cnffile\fP\&. +.PP +\fIDIRECTORIES\fP is an optional list of directories in which to +operate\&. If no directories are specified the list of directories +depends on the \fB--multiplatform\fP option\&. +.PP +.SH "OPTIONS" +.PP +.IP "\fB--cnffile\fP \fIFILE\fP or \fB-f\fP \fIFILE\fP" +use file as configuration file (default: +\fIfmtutil\&.cnf\fP) +.IP "\fB--help\fP or \fB-h\fP" +show some help text +.IP "\fB--multiplatform\fP or \fB-m\fP" +operate in all +platform-specific directories (default: +operate only in the directory for this +platform) +.IP "\fB--silent\fP or \fB-s\fP" +silently skip over existing +scripts/binaries instead of printing a warning +.IP "\fB--unlink\fP or \fB-u\fP" +Unlink previously created symlinks +.IP "\fB--verbose\fP or \fB-v\fP" ++set verbose mode on (default: off) +.PP +.SH "FILES" +.PP +.IP "\fIfmtutil\&.cnf\fP" +default configuration file +.PP +.SH "SEE ALSO" +.PP +\fBfmtutil\fP(1), \fBfmtutil\&.cnf\fP(5) +.PP +Web page: <http://tug\&.org/teTeX/> +.PP +.SH "BUGS" +.PP +None known, but report any bugs found to <tex-k@tug\&.org> (mailing list)\&. +.PP +.SH "AUTHOR" +.PP +\fBtexlinks\fP was written by Thomas Esser +<te@dbs\&.uni-hannover\&.de> in 1999\&. +\fBtexlinks\fP has been released into the public domain\&. +.PP +This manual page was written by C\&.M\&. Connelly +<c@eskimo\&.com>, for +the Debian GNU/Linux system\&. It may be used by other distributions +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/Master/texmf-dist/doc/man/man1/texlinks.man1.pdf b/Master/texmf-dist/doc/man/man1/texlinks.man1.pdf Binary files differnew file mode 100644 index 00000000000..b6be384c6f9 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/texlinks.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/texlua.1 b/Master/texmf-dist/doc/man/man1/texlua.1 new file mode 100644 index 00000000000..0dbf6fb682e --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/texlua.1 @@ -0,0 +1 @@ +.so man1/luatex.1 diff --git a/Master/texmf-dist/doc/man/man1/texlua.man1.pdf b/Master/texmf-dist/doc/man/man1/texlua.man1.pdf Binary files differnew file mode 100644 index 00000000000..b3ac63389c1 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/texlua.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/texluac.1 b/Master/texmf-dist/doc/man/man1/texluac.1 new file mode 100644 index 00000000000..0dbf6fb682e --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/texluac.1 @@ -0,0 +1 @@ +.so man1/luatex.1 diff --git a/Master/texmf-dist/doc/man/man1/texluac.man1.pdf b/Master/texmf-dist/doc/man/man1/texluac.man1.pdf Binary files differnew file mode 100644 index 00000000000..6ac45a45ef8 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/texluac.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/texmfstart.1 b/Master/texmf-dist/doc/man/man1/texmfstart.1 new file mode 100644 index 00000000000..e99ab230bd1 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/texmfstart.1 @@ -0,0 +1,362 @@ +.TH "TEXMFSTART" "1" "December 2006" "texmfstart 2.0" "ConTeXt" +.de URL +\\$2 \(laURL: \\$1 \(ra\\$3 +.. +.if \n[.g] .mso www.tmac +.de EX +.in +3 +.nf +.ft CW +.. +.de EE +.in -3 +.ft R +.fi +.. + +.SH "NAME" +texmfstart \- run ConTeXt scripts, make ConTeXt wrapper scripts, view documents + +.SH "SYNOPSIS" +\fB texmfstart\fP [ \fIoptions ...\fP ] [ \fIfilename\fP ] [ \fIarguments ...\fP ] + +.SH "DESCRIPTION" +ConTeXt is a typesetting system based on the +.BR tex (1) +family of programs. +.B texmfstart +is a ConTeXt meta-script that can run subordinate +scripts (subscripts?) such as +.BR texexec (1), +.BR ctxtools (1), +or +.BR pdftools (1). +It can also generate short wrapper scripts to simplify common uses. +These scripts are often called +.I stubs +in the ConTeXt documentation. The options control +.BR texmfstart 's +behaviour, and the arguments are passed +to the program identified by +.IR filename . + +If the filename is a document, then +.B texmfstart +will start a viewer for that document. For example: +.EX +texmfstart showcase.pdf +.EE +will start an appropriate viewer for +.IR showcase.pdf . +See the +.B EXAMPLES +section. + +.SH OPTIONS + +.SS General: +.TP +.B --help, --version +print version information, usage, and examples. +.TP +.B --verbose +print status and progress information, for example what commands are +being executed. +.TP +.B --clear +don't pass info about locations to child processes. + +.SS Running a program: +.TP +.B --arguments=\fIstr\fP +an alternative for providing the arguments to be passed. For example, +.EX +texmfstart --arguments=b.tex texexec +.EE +will pass +.I b.tex +as the argument to +.BR texexec . +.TP +.B --report +dry run: report what command would be run, but do not run it +.TP +.B --locate +dry run: like \f(CW--report\fP but doesn't print the trailing newline. +.TP +.B --browser +view the document in a web browser (for Windows). +.TP +.B --file=\fIfilename\fP +an alternative way to specify the file (the program to run or document +to open). +.TP +.B --direct +run a program without searching for its location (assumes that the +program is on the PATH). +.TP +.B --execute +use the +.BR ruby (1) +.I exec +function instead of its +.I system +function. +.TP +.B --program=\fIstr\fP +the program space where +.BR kpsewhich (1) +will search (default: context). This information is given to +.B kpsewhich +as its \f(CW-progname\fP option. Usually you don't need this option. + +.SS Creating startup scripts: +.TP +.B --make +create a wrapper script or batch file to run the given file. +The wrapper scripts are put in the current path, which usually means +the current directory. If +\fIall\fP is given as the file, e.g. +.EX +texmfstart --make all +.EE +then make all the ConTeXt wrapper scripts (the stubs). +.TP +.B --windows +when making a wrapper script (stub), create a Windows batch (.bat) file. +Usually you +do not need to specify this option, as +.B texmfstart +will figure out what operating system you are using. +.TP +.B --linux +when making a wrapper script, create a Unix shell script. Usually you +do not need to specify this option, as +.B texmfstart +will figure out what operating system you are using. +.TP +.B --stubpath=\fIpath\fP +specify where to put the wrapper scripts (stubs). +.TP +.B --indirect +always use +.I texmfstart +in the wrapper script (stub). + +.SS Document viewing: +.TP +.B --page=\fInumber\fP +open the document at this page. + +.SS Environments and paths: +.TP +.B --path=\fIstr\fP +change to the specified path. +.TP +.B --tree=\fIstr\fP +use the given TEXMF tree. +.TP +.B --autotree +automatically determine the TEXMF tree to use (the default). +.TP +.B --environment=\fIstr\fP +use the given environment file. Its syntax is given in the +.I mtexmfstart.pdf +manual. +.TP +.B --showenv +print the environment variables known at runtime + +.SS Conditional execution: +.TP +.B --iftouched=\fIfile1,file2\fP +run only when the given files have different timestamps. +.TP +.B --ifchanged=\fIstr\fP +run only when the given file has changed (based on its last-computed MD5 +checksum). + +.SS Special features: +.TP +.B --edit +open the given file in an editor. + +.SH "FILENAME PREFIXES" +.SS +Optional prefixes determine the method used to search for the specified file: +.TP +.I bin:filename +expanded name based on the PATH environment variable +.TP +.I kpse:filename +expanded name based on +.BR kpsewhich (1) +result +.TP +.I rel:filename +expanded name relative to the current directory +.TP +.I env:name +expanded pathname based on environment variable +.I name +.TP +.I path:filename +path part of filename as located by +.BR kpsewhich (1) + +.SH EXAMPLES +.TP +\f(CWtexmfstart texexec.rb file.tex\fP +Locate the +.I texexec.rb +script and run it with +.I file.tex +as its argument. In other words, make +.I file.pdf +from +.IR file.tex . +If +.BR texexec (1) +is properly installed on your system, +this common invocation can be shortened to +.EX +\f(CWtexexec file.tex\fP +.EE +.TP +\f(CWtexmfstart texexec file.tex\fP +Locate the +.BR texexec (1) +program (currently a +.BR ruby (1) +script, +.IR texexec.rb ) +and run it with +.I file.tex +as its argument, producing +.I file.pdf. +This invocation can be shortened to +.EX +texexec file.tex +.EE +.TP +\f(CWtexmfstart ctxtools --updatecontext\fP +Run the +.BR ctxtools (1) +script, updating the ConTeXt installation. This +invocation is equivalent to +.EX +ctxtools --updatecontext +.EE +.TP +\f(CWtexmfstart pstopdf --method=3 cow.eps\fP +Convert +.I cow.eps +to PDF using method 3 of +.BR pstopdf (1). +This invocation is equivalent to +.EX +pstopdf --method=3 cow.eps +.EE +.TP +\f(CWtexmfstart --make --stubpath=/usr/local/bin texexec\fP +Make a wrapper script (stub), either a shell script +.I /usr/local/bin/texexec +on Unix, or a batch file \fI\\usr\\local\\bin\\texexec.bat\fP +on Windows. On Unix (and maybe on Windows?), you need to make +the script executable; see +.BR chmod (1). +.TP +\f(CWtexmfstart --edit kpse:cont-sys.tex\fP +Locate and edit the \fIcont-sys.tex\fP configuration file. +.TP +\f(CWtexmfstart --ifchanged=whatever.mp texexec --mpgraphic whatever.mp\fP +Rerun +.B texexec +if +.I whatever.mp +has changed since the last use of +.IR --ifchanged . +.TP +\f(CWtexmfstart --ifchanged=whatever.mp bin:echo rerun MetaPost\fP +If the +.I whatever.mp +source file has changed since the last use of +.IR --ifchanged , +then use the +.BR echo (1) +command to tell the user to rerun MetaPost +.RB "(see " mpost (1)). +This example shows that +.B texmfstart +can be used to run any script, not just ConTeXt scripts. The +\f(CWbin:\fP prefix tells +.B texmfstart +not to search for +.I echo +in the TEXMF tree(s), but to assume that it's an executable somewhere +on the PATH. +.TP +\f(CWtexmfstart --ifchanged=whatever.mp --direct echo rerun MetaPost\fP +This invocation has the same effect as the preceding example, but +using \f(CW--direct\fP instead of the \f(CWbin:\fP prefix, again to tell +.B texmfstart +not to search for the +.I echo +command. + +.SH FILES +.TP +.I file.md5 +MD5 checksum file used for the \f(CW--ifchanged\fP option. + +.SH ENVIRONMENT +.TP +PATH +For expanding filenames given with a +.I bin +prefix. +.TP +TEXMFSTART_EDITOR, EDITOR, editor +Editor to use with +.IR --edit . +The environment variables are looked up in that order, with the first +setting found taking priority. + +.SH "SEE ALSO" +.PP +.BR ctxtools (1), +.BR kpsewhich (1), +.BR makempy (1), +.BR mpost (1), +.BR pdftools (1), +.BR pstopdf (1), +.BR texexec (1), +.BR texfont (1), +.BR texutil (1). +.PP +.URL "http://www.contextgarden.net" "ConTeXt wiki" . +.PP +The +.B texmfstart +manual, +.IR mtexmfstart.pdf , +available from +.URL "http://www.pragma-ade.com/dir/general/manuals/" "PRAGMA ADE" . + +.SH BUGS +On Unix, opening a PDF document first tries +.B pdfopen +then +.BR acroread , +neither of which may be present on your system. + +The \f(CW--report\fP option doesn't work if you specify a filename +prefix (i.e. it does a real run instead of a dry run). + +.SH "AUTHOR" +ConTeXt is written and maintained by +.URL "http://www.pragma-ade.com" "Hans Hagen" . +This man page, which is in the public domain, was written by Sanjoy +Mahajan <sanjoy@mit.edu> based on the +.I mtexmfstart.pdf +manual. diff --git a/Master/texmf-dist/doc/man/man1/texmfstart.man1.pdf b/Master/texmf-dist/doc/man/man1/texmfstart.man1.pdf Binary files differnew file mode 100644 index 00000000000..9e34aaa82b2 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/texmfstart.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/tftopl.1 b/Master/texmf-dist/doc/man/man1/tftopl.1 new file mode 100644 index 00000000000..45a872b363a --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/tftopl.1 @@ -0,0 +1,108 @@ +.TH TFTOPL 1 "17 December 1994" "Web2C 2012" +.\"===================================================================== +.if n .ds MF Metafont +.if t .ds MF M\s-2ETAFONT\s0 +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff +.el .ds OX TeX for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.\"===================================================================== +.SH NAME +tftopl \- convert TeX font metric (tfm) files to property lists +.SH SYNOPSIS +.B tftopl +.RI [ OPTIONS ] +.IR tfm_name [ \fB.tfm\fP ] +.RI [ pl_name [ \fB.pl\fP ]] +.\"===================================================================== +.SH DESCRIPTION +This manual page is not meant to be exhaustive. The complete +documentation for this version of \*(TX can be found in the info file +or manual +.IR "Web2C: A TeX implementation" . +.PP +The +.B tftopl +program translates a (program-oriented) font metric file to a +(human-oriented) property list file. Thus, you can edit the contents of +the TFM files, if the font designer has not done his or her job +properly, or if you're encountering strange difficulties, or if you're +just curious. It also serves as a TFM-file validating program, i.e., if +no error messages are given, the input file is correct. +.PP +The +.I pl_name +is extended with +.B .pl +if it lacks a suffix. +If +.I pl_name +is not given, standard output is used. Likewise, +.I tfm_name +is extended with +.B .tfm +if it lacks a suffix. Also, path searching is done for the TFM file +using the environment variable TEXFONTS. If that is not set, +.B tftopl +uses the system default. +.PP +See +.BR tex (1) +for the details of the searching. +.\"===================================================================== +.SH OPTIONS +.TP +.BI \-charcode-format= format +The argument +.I format +specifies how character codes are output in the PL file. By +default, only letters and digits are output using the +.B C +integer code (i.e., in ASCII); the others are output in octal. (Unless +the font's coding scheme starts with +.B "TeX math sy" +or +.BR "TeX math ex" , +in which case all character codes are output in octal.) If +.I format +is +.BR ascii , +all character codes that correspond to graphic characters, besides the +left and right parentheses, are output in ASCII. Finally, if +.I format +is +.BR octal , +all character codes are output in octal. +.PP +.TP +.B \-verbose +Without this option, +.B tftopl +operates silently. With it, a banner and progress report are printed on +.IR stdout . +.\"===================================================================== +.SH "SEE ALSO" +.BR pltotf (1), +.br +Donald E. Knuth, +.IR "\*(OXware" . +.br +Donald E. Knuth, +.I "The \*(MFbook" +(Volume C of +.IR "Computers and Typesetting" ), +Addison-Wesley, 1986, ISBN 0-201-13445-4. +.\"===================================================================== +.SH AUTHORS +Donald E. Knuth wrote the program. It was published as +part of the +.I \*(OXware +technical report, available from the \*(TX Users Group. +Howard Trickey and Pavel Curtis originally ported it to Unix. diff --git a/Master/texmf-dist/doc/man/man1/tftopl.man1.pdf b/Master/texmf-dist/doc/man/man1/tftopl.man1.pdf Binary files differnew file mode 100644 index 00000000000..b9deb0a252d --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/tftopl.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/thumbpdf.1 b/Master/texmf-dist/doc/man/man1/thumbpdf.1 new file mode 100644 index 00000000000..d1d7e358f9a --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/thumbpdf.1 @@ -0,0 +1,100 @@ +.TH "thumbpdf" "1" "September 2000" "teTeX" "teTeX" +.PP +.SH "NAME" +thumbpdf \- generate thumbnail images for a PDF file +created with \fBpdftex\fP +.PP +.SH "SYNOPSIS" +.PP +\fBthumbpdf\fP [ \fIOPTION\fP\&.\&.\&. ] \fIPDF_FILE\fP +.PP +.SH "DESCRIPTION" +.PP +\fBthumbpdf\fP is used to create thumbnail images of individual pages +within a PDF (Portable Document Format) document\&. +.PP +.SH "USAGE" +.PP +First run \fBpdftex\fP(1) on your document to create a PDF file\&. +Then run \fBthumbpdf\fP to generate the thumbnails, a PDF file +containing the thumbnails, and a pdfTeX file to include the thumbnails +in the PDF file\&. Finally, run \fBpdftex\fP(1) on your file again to +create the final PDF file\&. +.PP +\fBthumbpdf\fP calls \fBgs\fP(1) to generate PNG images of the pages +within \fIPDF_FILE\fP, and \fBpdftex\fP(1) to create a PDF file +containing the thumbnail images\&. +.PP +.SH "OPTIONS" +.PP +.IP "\fB--help\fP" +print usage +.IP "\fB--(no)makepng\fP" +make PNG thumbnail images (default: true) +.IP "\fB--(no)makepdf\fP" +generate new PDF file containing the +thumbnails (default: true) +.IP "\fB--(no)makedef\fP" +create a TeX file for \fBpdftex\fP(1) to +read in (default: true) +.IP "\fB--(no)quiet\fP" +suppress messages (default: false) +.IP "\fB--(no)verbose\fP" +verbose messages (default: false) +.IP "\fB--(no)debug\fP" +print debugging information while parsing +(default: false) +.IP "\fB--resolution\fP \fIres\fP" +resolution for GhostScript step +(default: 9) +.IP "\fB--compress\fP \fIn\fP" +\epdfcompresslevel for \fBthumbpdf\&.pdf\fP +(0-9; default: 9) +.IP "\fB--device\fP | \fBpng\fP\fIdev\fP" +GhostScript PNG device; +\fIdev\fP = `mono\', `gray\', +`16\', `256\', `16m\' (default: +`png16m\') +.PP +.SH "FILES" +.PP +.IP "\fIthumb\fPnn\fI\&.png\fP" +PNG thumbnail images +.IP "\fIthumbpdf\&.pdf\fP" +PDF file containing thumbnail images +.IP "\fIthumbpdf\&.tex\fP" +A pdfTeX program to include the thumbnails +file +.IP "\fIthumbpdf\&.log\fP" +pdfTeX log file +.IP "\fIthumbpdf\&.sty\fP" +a LaTeX package to be included in files +for which a user wants to generate thumbnails +.PP +.SH "SEE ALSO" +.PP +\fBgs\fP(1), \fBpdftex\fP(1)\&. +.PP +Web page: <http://tug\&.org/teTeX/> +.PP +.SH "BUGS" +.PP +None known, but report any bugs found to the author\&. +.PP +.SH "COPYRIGHT" +.PP +Copyright © 1999\&. \fBthumbpdf\fP is distributed under +version 1, or (at your option) a later version of the LaTeX Project +Public License\&. +.PP +.SH "AUTHOR" +.PP +\fBthumbpdf\fP was written by Heiko Oberdiek +<oberdiek@ruf\&.uni-freiburg\&.de>\&. +.PP +This manual page was written by C\&.M\&. Connelly +<c@eskimo\&.com>, for +the Debian GNU/Linux system\&. It may be used by other distributions +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/Master/texmf-dist/doc/man/man1/thumbpdf.man1.pdf b/Master/texmf-dist/doc/man/man1/thumbpdf.man1.pdf Binary files differnew file mode 100644 index 00000000000..a9364053792 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/thumbpdf.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/tie.1 b/Master/texmf-dist/doc/man/man1/tie.1 new file mode 100644 index 00000000000..ca00ca77c70 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/tie.1 @@ -0,0 +1,52 @@ +.TH TIE 1 "7 April 2010" "Web2C 2012" +.\"===================================================================== +.SH NAME +tie \- merge or apply WEB change files +.\"===================================================================== +.SH SYNOPSIS +.B tie +.BR \-c | \-m +.I outputfile masterfile +.IR changefile .\|.\|. +.\"===================================================================== +.SH DESCRIPTION +The +.B tie +program is used to process multiple change files used with the WEB +system for literate programming. The WEB programs allow to apply +patches to a source file (the +.IR masterfile ) +by means of a number of change files (often only a single change file +is allowed). +.B Tie +can be used to either merge up to 32 change files into a single one +or to apply the changes to the +.I masterfile +in order to create a new one. Output of either the new change file or +the patched master file goes into +.IR outputfile . +.\"===================================================================== +.SH OPTIONS +.TP +.B \-c +Create a single change file from the given +.IR changefile s. +.TP +.B \-m +Create a new master file by applying the given +.IR changefile s. +.\"===================================================================== +.SH ENVIRONMENT +The environment variable WEBINPUTS is used to search for the input files, +or the system default if WEBINPUTS is not set. See +.BR tex (1) +for the details of the searching. +.\"===================================================================== +.SH "SEE ALSO" +.BR web (1), +.BR ctie (1), +.BR cweb (1). +.\"===================================================================== +.SH "AUTHOR" +Klaus Guntermann, TH Darmstadt, Institut f. Theoretische Informatik. Man page +by Joachim Schnitter, TH Darmstadt, Phys. Chemie I. diff --git a/Master/texmf-dist/doc/man/man1/tie.man1.pdf b/Master/texmf-dist/doc/man/man1/tie.man1.pdf Binary files differnew file mode 100644 index 00000000000..8da238113cf --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/tie.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/tlmgr.1 b/Master/texmf-dist/doc/man/man1/tlmgr.1 new file mode 100644 index 00000000000..a30588224e3 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/tlmgr.1 @@ -0,0 +1,1655 @@ +.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "TLMGR 1" +.TH TLMGR 1 "2013-04-02" "perl v5.16.3" "User Contributed Perl Documentation" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +tlmgr \- the TeX Live Manager +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +tlmgr [\fIoption\fR]... \fIaction\fR [\fIoption\fR]... [\fIoperand\fR]... +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +\&\fBtlmgr\fR manages an existing TeX Live installation, both packages and +configuration options. For information on initially downloading and +installing TeX Live, see <http://tug.org/texlive/acquire.html>. +.PP +The most up-to-date version of this documentation (updated nightly from +the development sources) is available at +<http://tug.org/texlive/tlmgr.html>, along with procedures for updating +\&\f(CW\*(C`tlmgr\*(C'\fR itself and information about test versions. +.PP +TeX Live is organized into a few top-level \fIschemes\fR, each of which is +specified as a different set of \fIcollections\fR and \fIpackages\fR, where a +collection is a set of packages, and a package is what contains actual +files. Schemes typically contain a mix of collections and packages, but +each package is included in exactly one collection, no more and no less. +A TeX Live installation can be customized and managed at any level. +.PP +See <http://tug.org/texlive/doc> for all the TeX Live documentation +available. +.SH "EXAMPLES" +.IX Header "EXAMPLES" +After successfully installing TeX Live, here are a few common operations +with \f(CW\*(C`tlmgr\*(C'\fR: +.ie n .IP """tlmgr option repository http://mirror.ctan.org/systems/texlive/tlnet""" 4 +.el .IP "\f(CWtlmgr option repository http://mirror.ctan.org/systems/texlive/tlnet\fR" 4 +.IX Item "tlmgr option repository http://mirror.ctan.org/systems/texlive/tlnet" +Tell \f(CW\*(C`tlmgr\*(C'\fR to use a nearby \s-1CTAN\s0 mirror for future updates; useful if +you installed TeX Live from the \s-1DVD\s0 image and want continuing updates. +.ie n .IP """tlmgr update \-\-list""" 4 +.el .IP "\f(CWtlmgr update \-\-list\fR" 4 +.IX Item "tlmgr update --list" +Report what would be updated without actually updating anything. +.ie n .IP """tlmgr update \-\-all""" 4 +.el .IP "\f(CWtlmgr update \-\-all\fR" 4 +.IX Item "tlmgr update --all" +Make your local TeX installation correspond to what is in the package +repository (typically useful when updating from \s-1CTAN\s0). +.ie n .IP """tlmgr info"" \fIpkg\fR" 4 +.el .IP "\f(CWtlmgr info\fR \fIpkg\fR" 4 +.IX Item "tlmgr info pkg" +Display detailed information about \fIpkg\fR, such as the installation +status and description. +.PP +For all the capabilities and details of \f(CW\*(C`tlmgr\*(C'\fR, please read the +following voluminous information. +.SH "OPTIONS" +.IX Header "OPTIONS" +The following options to \f(CW\*(C`tlmgr\*(C'\fR are global options, not specific to +any action. All options, whether global or action-specific, can be +given anywhere on the command line, and in any order. The first +non-option argument will be the main action. In all cases, +\&\f(CW\*(C`\-\-\*(C'\fR\fIoption\fR and \f(CW\*(C`\-\*(C'\fR\fIoption\fR are equivalent, and an \f(CW\*(C`=\*(C'\fR is optional +between an option name and its value. +.IP "\fB\-\-repository\fR \fIurl|path\fR" 4 +.IX Item "--repository url|path" +Specifies the package repository from which packages should be installed +or updated, overriding the default package repository found in the +installation's TeX Live Package Database (a.k.a. the \s-1TLPDB\s0, defined +entirely in the file \f(CW\*(C`tlpkg/texlive.tlpdb\*(C'\fR). The documentation for +\&\f(CW\*(C`install\-tl\*(C'\fR has more details about this +(http://tug.org/texlive/doc/install\-tl.html <http://tug.org/texlive/doc/install-tl.html>). +.Sp +\&\f(CW\*(C`\-\-repository\*(C'\fR changes the repository location only for the current +run; to make a permanent change, use \f(CW\*(C`option repository\*(C'\fR (see the +option action). +.Sp +For backward compatibility and convenience, \f(CW\*(C`\-\-location\*(C'\fR and \f(CW\*(C`\-\-repo\*(C'\fR +are accepted as aliases for this option. +.IP "\fB\-\-gui\fR [\fIaction\fR]" 4 +.IX Item "--gui [action]" +\&\f(CW\*(C`tlmgr\*(C'\fR has a graphical interface as well as the command-line +interface. You can give this option, \f(CW\*(C`\-\-gui\*(C'\fR, together with an action +to be brought directly into the respective screen of the \s-1GUI\s0. For +example, running +.Sp +.Vb 1 +\& tlmgr \-\-gui update +.Ve +.Sp +starts you directly at the update screen. Without any action, the +\&\s-1GUI\s0 will be started at the main screen. +.IP "\fB\-\-gui\-lang\fR \fIllcode\fR" 4 +.IX Item "--gui-lang llcode" +By default, the \s-1GUI\s0 tries to deduce your language from the environment +(on Windows via the registry, on Unix via \f(CW\*(C`LC_MESSAGES\*(C'\fR). If that fails +you can select a different language by giving this option with a +language code (based on \s-1ISO\s0 639\-1). Currently supported (but not +necessarily completely translated) are: English (en, default), Czech +(cs), German (de), French (fr), Italian (it), Japanese (ja), Dutch (nl), +Polish (pl), Brazilian Portuguese (pt_BR), Russian (ru), Slovak (sk), +Slovenian (sl), Serbian (sr), Vietnamese (vi), simplified Chinese +(zh_CN), and traditional Chinese (zh_TW). +.IP "\fB\-\-machine\-readable\fR" 4 +.IX Item "--machine-readable" +Instead of the normal output intended for human consumption, write (to +standard output) a fixed format more suitable for machine parsing. See +the \*(L"MACHINE-READABLE \s-1OUTPUT\s0\*(R" section below. +.IP "\fB\-\-package\-logfile\fR \fIfile\fR" 4 +.IX Item "--package-logfile file" +\&\f(CW\*(C`tlmgr\*(C'\fR logs all package actions (install, remove, update, failed +updates, failed restores) to a separate log file, by default +\&\f(CW\*(C`TEXMFSYSVAR/web2c/tlmgr.log\*(C'\fR. This option allows you to specific a +different file for the log. +.IP "\fB\-\-pause\fR" 4 +.IX Item "--pause" +This option makes \f(CW\*(C`tlmgr\*(C'\fR wait for user input before exiting. Useful on +Windows to avoid disappearing command windows. +.IP "\fB\-\-persistent\-downloads\fR" 4 +.IX Item "--persistent-downloads" +.PD 0 +.IP "\fB\-\-no\-persistent\-downloads\fR" 4 +.IX Item "--no-persistent-downloads" +.PD +For network-based installations, this option (on by default) makes +\&\f(CW\*(C`tlmgr\*(C'\fR try to set up a persistent connection (using the Net::LWP +Perl module). The idea is to open and reuse only one connection per +session between your computer and the server, instead of initiating a +new download for each package. +.Sp +If this is not possible, \f(CW\*(C`tlmgr\*(C'\fR will fall back to using \f(CW\*(C`wget\*(C'\fR. To +disable these persistent connections, use \f(CW\*(C`\-\-no\-persistent\-downloads\*(C'\fR. +.IP "\fB\-\-no\-execute\-actions\fR" 4 +.IX Item "--no-execute-actions" +Suppress the execution of the execute actions as defined in the tlpsrc +files. Documented only for completeness, as this is only useful in +debugging. +.IP "\fB\-\-debug\-translation\fR" 4 +.IX Item "--debug-translation" +In \s-1GUI\s0 mode, this switch makes \f(CW\*(C`tlmgr\*(C'\fR report any missing, or more +likely untranslated, messages to standard error. This can help +translators to see what remains to be done. +.PP +The standard options for TeX Live programs are also accepted: +\&\f(CW\*(C`\-\-help/\-h/\-?\*(C'\fR, \f(CW\*(C`\-\-version\*(C'\fR, \f(CW\*(C`\-q\*(C'\fR (no informational messages), \f(CW\*(C`\-v\*(C'\fR +(debugging messages, can be repeated). For the details about these, see +the TeXLive::TLUtils documentation. +.PP +The \f(CW\*(C`\-\-version\*(C'\fR option shows version information about the TeX Live +release and about the \f(CW\*(C`tlmgr\*(C'\fR script itself. If \f(CW\*(C`\-v\*(C'\fR is given as +well, revision number for the used TeX Live Perl modules are shown, too. +.SH "ACTIONS" +.IX Header "ACTIONS" +.SS "help" +.IX Subsection "help" +Gives this help information (same as \f(CW\*(C`\-\-help\*(C'\fR). +.SS "version" +.IX Subsection "version" +Gives version information (same as \f(CW\*(C`\-\-version\*(C'\fR). +.PP +If \f(CW\*(C`\-v\*(C'\fR has been given the revisions of the used modules are reported, too. +.SS "backup [\-\-clean[=\fIN\fP]] [\-\-backupdir \fIdir\fP] [\-\-all | \fIpkg\fP]..." +.IX Subsection "backup [--clean[=N]] [--backupdir dir] [--all | pkg]..." +If the \f(CW\*(C`\-\-clean\*(C'\fR option is not specified, this action makes a backup of +the given packages, or all packages given \f(CW\*(C`\-\-all\*(C'\fR. These backups are +saved to the value of the \f(CW\*(C`\-\-backupdir\*(C'\fR option, if that is an existing and +writable directory. If \f(CW\*(C`\-\-backupdir\*(C'\fR is not given, the \f(CW\*(C`backupdir\*(C'\fR +option setting in the \s-1TLPDB\s0 is used, if present. If both are missing, +no backups are made. +.PP +If the \f(CW\*(C`\-\-clean\*(C'\fR option is specified, backups are pruned (removed) +instead of saved. The optional integer value \fIN\fR may be specified to +set the number of backups that will be retained when cleaning. If \f(CW\*(C`N\*(C'\fR +is not given, the value of the \f(CW\*(C`autobackup\*(C'\fR option is used. If both are +missing, an error is issued. For more details of backup pruning, see +the \f(CW\*(C`option\*(C'\fR action. +.PP +Options: +.IP "\fB\-\-backupdir\fR \fIdirectory\fR" 4 +.IX Item "--backupdir directory" +Overrides the \f(CW\*(C`backupdir\*(C'\fR option setting in the \s-1TLPDB\s0. +The \fIdirectory\fR argument is required and must specify an existing, +writable directory where backups are to be placed. +.IP "\fB\-\-all\fR" 4 +.IX Item "--all" +If \f(CW\*(C`\-\-clean\*(C'\fR is not specified, make a backup of all packages in the TeX +Live installation; this will take quite a lot of space and time. If +\&\f(CW\*(C`\-\-clean\*(C'\fR is specified, all packages are pruned. +.IP "\fB\-\-clean\fR[=\fIN\fR]" 4 +.IX Item "--clean[=N]" +Instead of making backups, prune the backup directory of old backups, as +explained above. The optional integer argument \fIN\fR overrides the +\&\f(CW\*(C`autobackup\*(C'\fR option set in the \s-1TLPDB\s0. You must use \f(CW\*(C`\-\-all\*(C'\fR or a list +of packages together with this option, as desired. +.IP "\fB\-\-dry\-run\fR" 4 +.IX Item "--dry-run" +Nothing is actually backed up or removed; instead, the actions to be +performed are written to the terminal. +.SS "candidates" +.IX Subsection "candidates" +.IP "\fBcandidates \f(BIpkg\fB\fR" 4 +.IX Item "candidates pkg" +Shows the available candidate repositories for package \fIpkg\fR. +See \*(L"\s-1MULTIPLE\s0 \s-1REPOSITORIES\s0\*(R" below. +.SS "check [\fIoption\fP]... [files|depends|executes|runfiles|all]" +.IX Subsection "check [option]... [files|depends|executes|runfiles|all]" +Executes one (or all) check(s) on the consistency of the installation. +.IP "\fBfiles\fR" 4 +.IX Item "files" +Checks that all files listed in the local \s-1TLPDB\s0 (\f(CW\*(C`texlive.tlpdb\*(C'\fR) are +actually present, and lists those missing. +.IP "\fBdepends\fR" 4 +.IX Item "depends" +Lists those packages which occur as dependencies in an installed collections, +but are themselves not installed, and those packages that are not +contained in any collection. +.Sp +If you call \f(CW\*(C`tlmgr check collections\*(C'\fR this test will be carried out +instead since former versions for \f(CW\*(C`tlmgr\*(C'\fR called it that way. +.IP "\fBexecutes\fR" 4 +.IX Item "executes" +Check that the files referred to by \f(CW\*(C`execute\*(C'\fR directives in the TeX +Live Database are present. +.IP "\fBrunfiles\fR" 4 +.IX Item "runfiles" +List those filenames that are occurring more than one time in the runfiles. +.PP +Options: +.IP "\fB\-\-use\-svn\fR" 4 +.IX Item "--use-svn" +Use the output of \f(CW\*(C`svn status\*(C'\fR instead of listing the files; for +checking the \s-1TL\s0 development repository. +.SS "conf [texmf|tlmgr [\fIkey\fP [\fIvalue\fP]]]" +.IX Subsection "conf [texmf|tlmgr [key [value]]]" +With only \f(CW\*(C`conf\*(C'\fR, show general configuration information for TeX Live, +including active configuration files, path settings, and more. This is +like the \f(CW\*(C`texconfig conf\*(C'\fR call, but works on all supported platforms. +.PP +With either \f(CW\*(C`conf texmf\*(C'\fR or \f(CW\*(C`conf tlmgr\*(C'\fR given in addition, shows all +key/value pairs (i.e., all settings) as saved in \f(CW\*(C`ROOT/texmf.cnf\*(C'\fR or +the tlmgr configuration file (see below), respectively. +.PP +If \fIkey\fR is given in addition, shows the value of only that given +\&\fIkey\fR in the respective file. +.PP +If \fIvalue\fR is given in addition, \fIkey\fR is set to \fIvalue\fR in the +respective file. \fINo error checking is done!\fR +.PP +Practical application: if the execution of (some or all) system commands +via \f(CW\*(C`\ewrite18\*(C'\fR was left enabled during installation, you can disable +it afterwards: +.PP +.Vb 1 +\& tlmgr conf texmf shell_escape 0 +.Ve +.PP +Warning: The general facility is here, but tinkering with settings in +this way is very strongly discouraged. Again, no error checking is +done, so any sort of breakage is possible. +.SS "dump-tlpdb [\-\-local|\-\-remote]" +.IX Subsection "dump-tlpdb [--local|--remote]" +Dump complete local or remote \s-1TLPDB\s0 to standard output, as-is. The +output is analogous to the \f(CW\*(C`\-\-machine\-readable\*(C'\fR output; see +\&\*(L"MACHINE-READABLE \s-1OUTPUT\s0\*(R" section. +.PP +Options: +.IP "\fB\-\-local\fR" 4 +.IX Item "--local" +Dump the local tlpdb. +.IP "\fB\-\-remote\fR" 4 +.IX Item "--remote" +Dump the remote tlpdb. +.PP +Exactly one of \f(CW\*(C`\-\-local\*(C'\fR and \f(CW\*(C`\-\-remote\*(C'\fR must be given. +.PP +In either case, the first line of the output specifies the repository +location, in this format: +.PP +.Vb 1 +\& "location\-url" "\et" location +.Ve +.PP +where \f(CW\*(C`location\-url\*(C'\fR is the literal field name, followed by a tab, and +\&\fIlocation\fR is the file or url to the repository. +.PP +Line endings may be either \s-1LF\s0 or \s-1CRLF\s0 depending on the current platform. +.SS "generate [\fIoption\fP]... \fIwhat\fP" +.IX Subsection "generate [option]... what" +.IP "\fBgenerate language\fR" 4 +.IX Item "generate language" +.PD 0 +.IP "\fBgenerate language.dat\fR" 4 +.IX Item "generate language.dat" +.IP "\fBgenerate language.def\fR" 4 +.IX Item "generate language.def" +.IP "\fBgenerate language.dat.lua\fR" 4 +.IX Item "generate language.dat.lua" +.IP "\fBgenerate fmtutil\fR" 4 +.IX Item "generate fmtutil" +.PD +.PP +The \f(CW\*(C`generate\*(C'\fR action overwrites any manual changes made in the +respective files: it recreates them from scratch based on the +information of the installed packages, plus local adaptions. +The TeX Live installer and \f(CW\*(C`tlmgr\*(C'\fR routinely call \f(CW\*(C`generate\*(C'\fR for +all of these files. +.PP +For managing your own fonts, please read the \f(CW\*(C`updmap \-\-help\*(C'\fR +information and/or <http://tug.org/fonts/fontinstall.html>. +.PP +In more detail: \f(CW\*(C`generate\*(C'\fR remakes any of the configuration files +\&\f(CW\*(C`language.dat\*(C'\fR, \f(CW\*(C`language.def\*(C'\fR, \f(CW\*(C`language.dat.lua\*(C'\fR, and +\&\f(CW\*(C`fmtutil.cnf\*(C'\fR, from the information present in the local \s-1TLPDB\s0, plus +locally-maintained files. +.PP +The locally-maintained files are \f(CW\*(C`language\-local.dat\*(C'\fR, +\&\f(CW\*(C`language\-local.def\*(C'\fR, \f(CW\*(C`language\-local.dat.lua\*(C'\fR, or +\&\f(CW\*(C`fmtutil\-local.cnf\*(C'\fR, searched for in \f(CW\*(C`TEXMFLOCAL\*(C'\fR in the respective +directories. If local additions are present, the final file is made by +starting with the main file, omitting any entries that the local file +specifies to be disabled, and finally appending the local file. +.PP +(Historical note: The formerly supported \f(CW\*(C`updmap\-local.cfg\*(C'\fR is no longer +read, since \f(CW\*(C`updmap\*(C'\fR now supports multiple \f(CW\*(C`updmap.cfg\*(C'\fR files. Thus, +local additions can and should be put into an \f(CW\*(C`updmap.cfg\*(C'\fR file in +\&\f(CW\*(C`TEXMFLOCAL\*(C'\fR. The \f(CW\*(C`generate updmap\*(C'\fR action no longer exists.) +.PP +Local files specify entries to be disabled with a comment line, namely +one of these: +.PP +.Vb 3 +\& #!NAME +\& %!NAME +\& \-\-!NAME +.Ve +.PP +where \f(CW\*(C`fmtutil.cnf\*(C'\fR uses \f(CW\*(C`#\*(C'\fR, \f(CW\*(C`language.dat\*(C'\fR and \f(CW\*(C`language.def\*(C'\fR use +\&\f(CW\*(C`%\*(C'\fR, and \f(CW\*(C`language.dat.lua\*(C'\fR use \f(CW\*(C`\-\-\*(C'\fR. In all cases, the \fIname\fR is +the respective format name or hyphenation pattern identifier. +Examples: +.PP +.Vb 3 +\& #!pdflatex +\& %!german +\& \-\-!usenglishmax +.Ve +.PP +(Of course, you're not likely to actually want to disable those +particular items. They're just examples.) +.PP +After such a disabling line, the local file can include another entry +for the same item, if a different definition is desired. In general, +except for the special disabling lines, the local files follow the same +syntax as the master files. +.PP +The form \f(CW\*(C`generate language\*(C'\fR recreates all three files \f(CW\*(C`language.dat\*(C'\fR, +\&\f(CW\*(C`language.def\*(C'\fR, and \f(CW\*(C`language.dat.lua\*(C'\fR, while the forms with an +extension recreates only that given language file. +.PP +Options: +.IP "\fB\-\-dest\fR \fIoutput_file\fR" 4 +.IX Item "--dest output_file" +specifies the output file (defaults to the respective location in +\&\f(CW\*(C`TEXMFSYSVAR\*(C'\fR). If \f(CW\*(C`\-\-dest\*(C'\fR is given to \f(CW\*(C`generate language\*(C'\fR, it +serves as a basename onto which \f(CW\*(C`.dat\*(C'\fR will be appended for the name of +the \f(CW\*(C`language.dat\*(C'\fR output file, \f(CW\*(C`.def\*(C'\fR will be appended to the value +for the name of the \f(CW\*(C`language.def\*(C'\fR output file, and \f(CW\*(C`.dat.lua\*(C'\fR to the +name of the \f(CW\*(C`language.dat.lua\*(C'\fR file. (This is just to avoid +overwriting; if you want a specific name for each output file, we +recommend invoking \f(CW\*(C`tlmgr\*(C'\fR twice.) +.IP "\fB\-\-localcfg\fR \fIlocal_conf_file\fR" 4 +.IX Item "--localcfg local_conf_file" +specifies the (optional) local additions (defaults to the respective +location in \f(CW\*(C`TEXMFLOCAL\*(C'\fR). +.IP "\fB\-\-rebuild\-sys\fR" 4 +.IX Item "--rebuild-sys" +tells tlmgr to run necessary programs after config files have been +regenerated. These are: +\&\f(CW\*(C`fmtutil\-sys \-\-all\*(C'\fR after \f(CW\*(C`generate fmtutil\*(C'\fR, +\&\f(CW\*(C`fmtutil\-sys \-\-byhyphen .../language.dat\*(C'\fR after \f(CW\*(C`generate language.dat\*(C'\fR, +and +\&\f(CW\*(C`fmtutil\-sys \-\-byhyphen .../language.def\*(C'\fR after \f(CW\*(C`generate language.def\*(C'\fR. +.Sp +These subsequent calls cause the newly-generated files to actually take +effect. This is not done by default since those calls are lengthy +processes and one might want to made several related changes in +succession before invoking these programs. +.PP +The respective locations are as follows: +.PP +.Vb 4 +\& tex/generic/config/language.dat (and language\-local.dat); +\& tex/generic/config/language.def (and language\-local.def); +\& tex/generic/config/language.dat.lua (and language\-local.dat.lua); +\& web2c/fmtutil.cnf (and fmtutil\-local.cnf); +.Ve +.SS "gui" +.IX Subsection "gui" +Start the graphical user interface. See \fB\s-1GUI\s0\fR below. +.SS "info [\fIoption\fP...] [collections|schemes|\fIpkg\fP...]" +.IX Subsection "info [option...] [collections|schemes|pkg...]" +With no argument, lists all packages available at the package +repository, prefixing those already installed with \f(CW\*(C`i\*(C'\fR. +.PP +With the single word \f(CW\*(C`collections\*(C'\fR or \f(CW\*(C`schemes\*(C'\fR as the argument, lists +the request type instead of all packages. +.PP +With any other arguments, display information about \fIpkg\fR: the name, +category, short and long description, installation status, and TeX Live +revision number. If \fIpkg\fR is not locally installed, searches in the +remote installation source. +.PP +It also displays information taken from the TeX Catalogue, namely the +package version, date, and license. Consider these, especially the +package version, as approximations only, due to timing skew of the +updates of the different pieces. By contrast, the \f(CW\*(C`revision\*(C'\fR value +comes directly from \s-1TL\s0 and is reliable. +.PP +The former actions \f(CW\*(C`show\*(C'\fR and \f(CW\*(C`list\*(C'\fR are merged into this action, +but are still supported for backward compatibility. +.PP +Options: +.IP "\fB\-\-list\fR" 4 +.IX Item "--list" +If the option \f(CW\*(C`\-\-list\*(C'\fR is given with a package, the list of contained +files is also shown, including those for platform-specific dependencies. +When given with schemes and collections, \f(CW\*(C`\-\-list\*(C'\fR outputs their +dependencies in a similar way. +.IP "\fB\-\-only\-installed\fR" 4 +.IX Item "--only-installed" +If this options is given, the installation source will +not be used; only locally installed packages, collections, or schemes +are listed. +(Does not work for listing of packages for now) +.IP "\fB\-\-taxonomy\fR" 4 +.IX Item "--taxonomy" +.PD 0 +.IP "\fB\-\-keyword\fR" 4 +.IX Item "--keyword" +.IP "\fB\-\-functionality\fR" 4 +.IX Item "--functionality" +.IP "\fB\-\-characterization\fR" 4 +.IX Item "--characterization" +.PD +In addition to the normal data displayed, also display information for +given packages from the corresponding taxonomy (or all of them). See +\&\*(L"\s-1TAXONOMIES\s0\*(R" below for details. +.SS "install [\fIoption\fP]... \fIpkg\fP..." +.IX Subsection "install [option]... pkg..." +Install each \fIpkg\fR given on the command line. By default this installs +all packages on which the given \fIpkg\fRs are dependent, also. Options: +.IP "\fB\-\-file\fR" 4 +.IX Item "--file" +Instead of fetching a package from the installation repository, use +the packages files given on the command line. These files need +to be proper TeX Live package files (with contained tlpobj file). +.IP "\fB\-\-reinstall\fR" 4 +.IX Item "--reinstall" +Reinstall a package (including dependencies for collections) even if it +seems to be already installed (i.e, is present in the \s-1TLPDB\s0). This is +useful to recover from accidental removal of files in the hierarchy. +.Sp +When re-installing, only dependencies on normal packages are followed +(not those of category Scheme or Collection). +.IP "\fB\-\-no\-depends\fR" 4 +.IX Item "--no-depends" +Do not install dependencies. (By default, installing a package ensures +that all dependencies of this package are fulfilled.) +.IP "\fB\-\-no\-depends\-at\-all\fR" 4 +.IX Item "--no-depends-at-all" +When you install a package which ships binary files the respective +binary package will also be installed. That is, for a package \f(CW\*(C`foo\*(C'\fR, +the package \f(CW\*(C`foo.i386\-linux\*(C'\fR will also be installed on an \f(CW\*(C`i386\-linux\*(C'\fR +system. This switch suppresses this behavior, and also implies +\&\f(CW\*(C`\-\-no\-depends\*(C'\fR. Don't use it unless you are sure of what you are +doing. +.IP "\fB\-\-dry\-run\fR" 4 +.IX Item "--dry-run" +Nothing is actually installed; instead, the actions to be performed are +written to the terminal. +.IP "\fB\-\-force\fR" 4 +.IX Item "--force" +If updates to \f(CW\*(C`tlmgr\*(C'\fR itself (or other parts of the basic +infrastructure) are present, \f(CW\*(C`tlmgr\*(C'\fR will bail out and not perform the +installation unless this option is given. Not recommended. +.SS "option" +.IX Subsection "option" +.IP "\fBoption [show]\fR" 4 +.IX Item "option [show]" +.PD 0 +.IP "\fBoption showall\fR" 4 +.IX Item "option showall" +.IP "\fBoption \f(BIkey\fB [\f(BIvalue\fB]\fR" 4 +.IX Item "option key [value]" +.PD +.PP +The first form shows the global TeX Live settings currently saved in the +\&\s-1TLPDB\s0 with a short description and the \f(CW\*(C`key\*(C'\fR used for changing it in +parentheses. +.PP +The second form is similar, but also shows options which can be defined +but are not currently set to any value. +.PP +In the third form, if \fIvalue\fR is not given, the setting for \fIkey\fR is +displayed. If \fIvalue\fR is present, \fIkey\fR is set to \fIvalue\fR. +.PP +Possible values for \fIkey\fR are (run \f(CW\*(C`tlmgr option showall\*(C'\fR for +the definitive list): +.PP +.Vb 10 +\& repository (default package repository), +\& formats (create formats at installation time), +\& postcode (run postinst code blobs) +\& docfiles (install documentation files), +\& srcfiles (install source files), +\& backupdir (default directory for backups), +\& autobackup (number of backups to keep). +\& sys_bin (directory to which executables are linked by the path action) +\& sys_man (directory to which man pages are linked by the path action) +\& sys_info (directory to which Info files are linked by the path action) +\& desktop_integration (Windows\-only: create Start menu shortcuts) +\& fileassocs (Windows\-only: change file associations) +\& multiuser (Windows\-only: install for all users) +.Ve +.PP +One common use of \f(CW\*(C`option\*(C'\fR is to permanently change the installation to +get further updates from the Internet, after originally installing from +\&\s-1DVD\s0. To do this, you can run +.PP +.Vb 1 +\& tlmgr option repository http://mirror.ctan.org/systems/texlive/tlnet +.Ve +.PP +The \f(CW\*(C`install\-tl\*(C'\fR documentation has more information about the possible +values for \f(CW\*(C`repository\*(C'\fR. (For backward compatibility, \f(CW\*(C`location\*(C'\fR can +be used as alternative name for \f(CW\*(C`repository\*(C'\fR.) +.PP +If \f(CW\*(C`formats\*(C'\fR is set (this is the default), then formats are regenerated +when either the engine or the format files have changed. Disable this +only when you know what you are doing. +.PP +The \f(CW\*(C`postcode\*(C'\fR option controls execution of per-package +postinstallation action code. It is set by default, and again disabling +is not likely to be of interest except perhaps to developers. +.PP +The \f(CW\*(C`docfiles\*(C'\fR and \f(CW\*(C`srcfiles\*(C'\fR options control the installation of +their respective files of a package. By default both are enabled (1). +This can be disabled (set to 0) if disk space is (very) limited. +.PP +The options \f(CW\*(C`autobackup\*(C'\fR and \f(CW\*(C`backupdir\*(C'\fR determine the defaults for +the actions \f(CW\*(C`update\*(C'\fR, \f(CW\*(C`backup\*(C'\fR and \f(CW\*(C`restore\*(C'\fR. These three actions +need a directory in which to read or write the backups. If +\&\f(CW\*(C`\-\-backupdir\*(C'\fR is not specified on the command line, the \f(CW\*(C`backupdir\*(C'\fR +option value is used (if set). +.PP +The \f(CW\*(C`autobackup\*(C'\fR option (de)activates automatic generation of backups. +Its value is an integer. If the \f(CW\*(C`autobackup\*(C'\fR value is \f(CW\*(C`\-1\*(C'\fR, no +backups are removed. If \f(CW\*(C`autobackup\*(C'\fR is 0 or more, it specifies the +number of backups to keep. Thus, backups are disabled if the value is +0. In the \f(CW\*(C`\-\-clean\*(C'\fR mode of the \f(CW\*(C`backup\*(C'\fR action this option also +specifies the number to be kept. +.PP +To setup \f(CW\*(C`autobackup\*(C'\fR to \f(CW\*(C`\-1\*(C'\fR on the command line, use either: +.PP +.Vb 1 +\& tlmgr option autobackup infty +.Ve +.PP +or: +.PP +.Vb 1 +\& tlmgr option \-\- autobackup \-1 +.Ve +.PP +The \f(CW\*(C`\-\-\*(C'\fR avoids having the \f(CW\*(C`\-1\*(C'\fR treated as an option. (\f(CW\*(C`\-\-\*(C'\fR stops +parsing for options at the point where it appears; this is a general +feature across most Unix programs.) +.PP +The \f(CW\*(C`sys_bin\*(C'\fR, \f(CW\*(C`sys_man\*(C'\fR, and \f(CW\*(C`sys_info\*(C'\fR options are used on +Unix-like systems to control the generation of links for executables, +info files and man pages. See the \f(CW\*(C`path\*(C'\fR action for details. +.PP +The last three options control behaviour on Windows installations. If +\&\f(CW\*(C`desktop_integration\*(C'\fR is set, then some packages will install items in +a sub-folder of the Start menu for \f(CW\*(C`tlmgr gui\*(C'\fR, documentation, etc. If +\&\f(CW\*(C`fileassocs\*(C'\fR is set, Windows file associations are made (see also the +\&\f(CW\*(C`postaction\*(C'\fR action). Finally, if \f(CW\*(C`multiuser\*(C'\fR is set, then adaptions +to the registry and the menus are done for all users on the system +instead of only the current user. All three options are on by default. +.SS "paper" +.IX Subsection "paper" +.IP "\fBpaper [a4|letter]\fR" 4 +.IX Item "paper [a4|letter]" +.PD 0 +.IP "\fB[xdvi|pdftex|dvips|dvipdfmx|dvipdfm|context]\ paper\ [\f(BIpapersize\fB|\-\-list]\fR" 4 +.IX Item "[xdvi|pdftex|dvips|dvipdfmx|dvipdfm|context]paper[papersize|--list]" +.PD +.PP +With no arguments (\f(CW\*(C`tlmgr paper\*(C'\fR), shows the default paper size setting +for all known programs. +.PP +With one argument (e.g., \f(CW\*(C`tlmgr paper a4\*(C'\fR), sets the default for all +known programs to that paper size. +.PP +With a program given as the first argument and no paper size specified +(e.g., \f(CW\*(C`tlmgr dvips paper\*(C'\fR), shows the default paper size for that +program. +.PP +With a program given as the first argument and a paper size as the last +argument (e.g., \f(CW\*(C`tlmgr dvips paper a4\*(C'\fR), set the default for that +program to that paper size. +.PP +With a program given as the first argument and \f(CW\*(C`\-\-list\*(C'\fR given as the +last argument (e.g., \f(CW\*(C`tlmgr dvips paper \-\-list\*(C'\fR), shows all valid paper +sizes for that program. The first size shown is the default. +.PP +Incidentally, this syntax of having a specific program name before the +\&\f(CW\*(C`paper\*(C'\fR keyword may seem strange. It is inherited from the +longstanding \f(CW\*(C`texconfig\*(C'\fR script, which supports other configuration +settings for some programs, notably \f(CW\*(C`dvips\*(C'\fR. \f(CW\*(C`tlmgr\*(C'\fR does not support +those extra settings at present. +.SS "path [\-\-w32mode=user|admin] [add|remove]" +.IX Subsection "path [--w32mode=user|admin] [add|remove]" +On Unix, merely adds or removes symlinks for binaries, man pages, and +info pages in the system directories specified by the respective options +(see the option description above). Does not change any +initialization files, either system or personal. +.PP +On Windows, the registry part where the binary directory is added or +removed is determined in the following way: +.PP +If the user has admin rights, and the option \f(CW\*(C`\-\-w32mode\*(C'\fR is not given, +the setting \fIw32_multi_user\fR determines the location (i.e., if it is +on then the system path, otherwise the user path is changed). +.PP +If the user has admin rights, and the option \f(CW\*(C`\-\-w32mode\*(C'\fR is given, this +option determines the path to be adjusted. +.PP +If the user does not have admin rights, and the option \f(CW\*(C`\-\-w32mode\*(C'\fR +is not given, and the setting \fIw32_multi_user\fR is off, the user path +is changed, while if the setting \fIw32_multi_user\fR is on, a warning is +issued that the caller does not have enough privileges. +.PP +If the user does not have admin rights, and the option \f(CW\*(C`\-\-w32mode\*(C'\fR +is given, it must be \fBuser\fR and the user path will be adjusted. If a +user without admin rights uses the option \f(CW\*(C`\-\-w32mode admin\*(C'\fR a warning +is issued that the caller does not have enough privileges. +.SS "pinning" +.IX Subsection "pinning" +The \f(CW\*(C`pinning\*(C'\fR action manages the pinning file, see Pinning below. +.ie n .IP """pinning show""" 4 +.el .IP "\f(CWpinning show\fR" 4 +.IX Item "pinning show" +Shows the current pinning data. +.ie n .IP """pinning add \f(CIrepo\f(CW \f(CIpkgglob\f(CW...""" 4 +.el .IP "\f(CWpinning add \f(CIrepo\f(CW \f(CIpkgglob\f(CW...\fR" 4 +.IX Item "pinning add repo pkgglob..." +Pins the packages matching the \fIpkgglob\fR(s) to the repository +\&\fIrepo\fR. +.ie n .IP """pinning remove \f(CIrepo\f(CW \f(CIpkgglob\f(CW...""" 4 +.el .IP "\f(CWpinning remove \f(CIrepo\f(CW \f(CIpkgglob\f(CW...\fR" 4 +.IX Item "pinning remove repo pkgglob..." +Any packages recorded in the pinning file matching the <pkgglob>s for +the given repository \fIrepo\fR are removed. +.ie n .IP """pinning remove \f(CIrepo\f(CW \-\-all""" 4 +.el .IP "\f(CWpinning remove \f(CIrepo\f(CW \-\-all\fR" 4 +.IX Item "pinning remove repo --all" +Remove all pinning data for repository \fIrepo\fR. +.SS "platform list|add|remove \fIplatform\fP..." +.IX Subsection "platform list|add|remove platform..." +.SS "platform set \fIplatform\fP" +.IX Subsection "platform set platform" +.SS "platform set auto" +.IX Subsection "platform set auto" +\&\f(CW\*(C`platform list\*(C'\fR lists the TeX Live names of all the platforms +(a.k.a. architectures), (\f(CW\*(C`i386\-linux\*(C'\fR, ...) available at the package +repository. +.PP +\&\f(CW\*(C`platform add\*(C'\fR \fIplatform\fR... adds the executables for each given platform +\&\fIplatform\fR to the installation from the repository. +.PP +\&\f(CW\*(C`platform remove\*(C'\fR \fIplatform\fR... removes the executables for each given +platform \fIplatform\fR from the installation, but keeps the currently +running platform in any case. +.PP +\&\f(CW\*(C`platform set\*(C'\fR \fIplatform\fR switches TeX Live to always use the given +platform instead of auto detection. +.PP +\&\f(CW\*(C`platform set auto\*(C'\fR switches TeX Live to auto detection mode for platform. +.PP +Platform detection is needed to select the proper \f(CW\*(C`xz\*(C'\fR, \f(CW\*(C`xzdec\*(C'\fR and +\&\f(CW\*(C`wget\*(C'\fR binaries that are shipped with TeX Live. +.PP +\&\f(CW\*(C`arch\*(C'\fR is a synonym for \f(CW\*(C`platform\*(C'\fR. +.PP +Options: +.IP "\fB\-\-dry\-run\fR" 4 +.IX Item "--dry-run" +Nothing is actually installed; instead, the actions to be performed are +written to the terminal. +.SS "postaction [\-\-w32mode=user|admin] [\-\-fileassocmode=1|2] [\-\-all] [install|remove] [shortcut|fileassoc|script] [\fIpkg\fP]..." +.IX Subsection "postaction [--w32mode=user|admin] [--fileassocmode=1|2] [--all] [install|remove] [shortcut|fileassoc|script] [pkg]..." +Carry out the postaction \f(CW\*(C`shortcut\*(C'\fR, \f(CW\*(C`fileassoc\*(C'\fR, or \f(CW\*(C`script\*(C'\fR given +as the second required argument in install or remove mode (which is the +first required argument), for either the packages given on the command +line, or for all if \f(CW\*(C`\-\-all\*(C'\fR is given. +.PP +If the option \f(CW\*(C`\-\-w32mode\*(C'\fR is given the value \f(CW\*(C`user\*(C'\fR, all actions will +only be carried out in the user-accessible parts of the +registry/filesystem, while the value \f(CW\*(C`admin\*(C'\fR selects the system-wide +parts of the registry for the file associations. If you do not have +enough permissions, using \f(CW\*(C`\-\-w32mode=admin\*(C'\fR will not succeed. +.PP +\&\f(CW\*(C`\-\-fileassocmode\*(C'\fR specifies the action for file associations. If it is +set to 1 (the default), only new associations are added; if it is set to +2, all associations are set to the TeX Live programs. (See also +\&\f(CW\*(C`option fileassocs\*(C'\fR.) +.SS "print-platform" +.IX Subsection "print-platform" +Print the TeX Live identifier for the detected platform +(hardware/operating system) combination to standard output, and exit. +\&\f(CW\*(C`\-\-print\-arch\*(C'\fR is a synonym. +.SS "restore [\-\-backupdir \fIdir\fP] [\-\-all | \fIpkg\fP [\fIrev\fP]]" +.IX Subsection "restore [--backupdir dir] [--all | pkg [rev]]" +Restore a package from a previously-made backup. +.PP +If \f(CW\*(C`\-\-all\*(C'\fR is given, try to restore the latest revision of all +package backups found in the backup directory. +.PP +Otherwise, if neither \fIpkg\fR nor \fIrev\fR are given, list the available backup +revisions for all packages. +.PP +With \fIpkg\fR given but no \fIrev\fR, list all available backup revisions of +\&\fIpkg\fR. +.PP +When listing available packages tlmgr shows the revision and in +parenthesis the creation time if available (in format yyyy-mm-dd hh:mm). +.PP +With both \fIpkg\fR and \fIrev\fR, tries to restore the package from the +specified backup. +.PP +Options: +.IP "\fB\-\-all\fR" 4 +.IX Item "--all" +Try to restore the latest revision of all package backups found in the +backup directory. Additional non-option arguments (like \fIpkg\fR) are not +allowed. +.IP "\fB\-\-backupdir\fR \fIdirectory\fR" 4 +.IX Item "--backupdir directory" +Specify the directory where the backups are to be found. If not given it +will be taken from the configuration setting in the \s-1TLPDB\s0. +.IP "\fB\-\-dry\-run\fR" 4 +.IX Item "--dry-run" +Nothing is actually restored; instead, the actions to be performed are +written to the terminal. +.IP "\fB\-\-force\fR" 4 +.IX Item "--force" +Don't ask questions. +.SS "remove [\fIoption\fP]... \fIpkg\fP..." +.IX Subsection "remove [option]... pkg..." +Remove each \fIpkg\fR specified. Removing a collection removes all package +dependencies (unless \f(CW\*(C`\-\-no\-depends\*(C'\fR is specified), but not any +collection dependencies of that collection. However, when removing a +package, dependencies are never removed. Options: +.IP "\fB\-\-no\-depends\fR" 4 +.IX Item "--no-depends" +Do not remove dependent packages. +.IP "\fB\-\-no\-depends\-at\-all\fR" 4 +.IX Item "--no-depends-at-all" +See above under \fBinstall\fR (and beware). +.IP "\fB\-\-force\fR" 4 +.IX Item "--force" +By default, removal of a package or collection that is a dependency of +another collection or scheme is not allowed. With this option, the +package will be removed unconditionally. Use with care. +.Sp +A package that has been removed using the \f(CW\*(C`\-\-force\*(C'\fR option because it +is still listed in an installed collection or scheme will not be +updated, and will be mentioned as \fBforcibly removed\fR in the output of +\&\fBtlmgr update \-\-list\fR. +.IP "\fB\-\-dry\-run\fR" 4 +.IX Item "--dry-run" +Nothing is actually removed; instead, the actions to be performed are +written to the terminal. +.SS "repository" +.IX Subsection "repository" +.IP "\fBrepository list\fR" 4 +.IX Item "repository list" +.PD 0 +.IP "\fBrepository list \f(BIpath|tag\fB\fR" 4 +.IX Item "repository list path|tag" +.IP "\fBrepository add \f(BIpath\fB [\f(BItag\fB]\fR" 4 +.IX Item "repository add path [tag]" +.IP "\fBrepository remove \f(BIpath|tag\fB\fR" 4 +.IX Item "repository remove path|tag" +.IP "\fBrepository set \f(BIpath\fB[#\f(BItag\fB] [\f(BIpath\fB[#\f(BItag\fB] ...]\fR" 4 +.IX Item "repository set path[#tag] [path[#tag] ...]" +.PD +This action manages the list of repositories. See \*(L"\s-1MULTIPLE\s0 +\&\s-1REPOSITORIES\s0\*(R" below for detailed explanations. +.Sp +The first form (\f(CW\*(C`list\*(C'\fR) lists all configured repositories and the +respective tags if set. If a path, url, or tag is given after the +\&\f(CW\*(C`list\*(C'\fR keyword, it is interpreted as source from where to +initialize a TeX Live Database and lists the contained packages. +This can also be an up-to-now not used repository, both locally +and remote. If one pass in addition \f(CW\*(C`\-\-with\-platforms\*(C'\fR, for each +package the available platforms (if any) are listed, too. +.Sp +The third form (\f(CW\*(C`add\*(C'\fR) adds a repository +(optionally attaching a tag) to the list of repositories. The forth +form (\f(CW\*(C`remove\*(C'\fR) removes a repository, either by full path/url, or by +tag. The last form (\f(CW\*(C`set\*(C'\fR) sets the list of repositories to the items +given on the command line, not keeping previous settings +.Sp +In all cases, one of the repositories must be tagged as \f(CW\*(C`main\*(C'\fR; +otherwise, all operations will fail! +.SS "search [\fIoption\fP...] \fIwhat\fP" +.IX Subsection "search [option...] what" +\fIsearch [\fIoption\fI...] \-\-file \fIwhat\fI\fR +.IX Subsection "search [option...] --file what" +.PP +\fIsearch [\fIoption\fI...] \-\-taxonomy \fIwhat\fI\fR +.IX Subsection "search [option...] --taxonomy what" +.PP +\fIsearch [\fIoption\fI...] \-\-keyword \fIwhat\fI\fR +.IX Subsection "search [option...] --keyword what" +.PP +\fIsearch [\fIoption\fI...] \-\-functionality \fIwhat\fI\fR +.IX Subsection "search [option...] --functionality what" +.PP +\fIsearch [\fIoption\fI...] \-\-characterization \fIwhat\fI\fR +.IX Subsection "search [option...] --characterization what" +.PP +\fIsearch [\fIoption\fI...] \-\-all \fIwhat\fI\fR +.IX Subsection "search [option...] --all what" +.PP +By default, search the names, short descriptions, and long descriptions +of all locally installed packages for the argument \fIwhat\fR, interpreted +as a regular expression. +.PP +Options: +.IP "\fB\-\-global\fR" 4 +.IX Item "--global" +Search the TeX Live Database of the installation medium, instead of the +local installation. +.IP "\fB\-\-word\fR" 4 +.IX Item "--word" +Restrict the search to match only full words. For example, searching for +\&\f(CW\*(C`table\*(C'\fR with this option will not output packages containing the +word \f(CW\*(C`tables\*(C'\fR (unless they also contain the word \f(CW\*(C`table\*(C'\fR on its own). +.IP "\fB\-\-list\fR" 4 +.IX Item "--list" +If a search for any (or all) taxonomies is done, by specifying one of +the taxonomy options below, then instead of searching for packages, list +the entire corresponding taxonomy (or all of them). See +\&\*(L"\s-1TAXONOMIES\s0\*(R" below. +.PP +Other search options are selected by specifying one of the following: +.IP "\fB\-\-file\fR" 4 +.IX Item "--file" +List all filenames containing \fIwhat\fR. +.IP "\fB\-\-taxonomy\fR" 4 +.IX Item "--taxonomy" +.PD 0 +.IP "\fB\-\-keyword\fR" 4 +.IX Item "--keyword" +.IP "\fB\-\-functionality\fR" 4 +.IX Item "--functionality" +.IP "\fB\-\-characterization\fR" 4 +.IX Item "--characterization" +.PD +Search in the corresponding taxonomy (or all) instead of the package +descriptions. See \*(L"\s-1TAXONOMIES\s0\*(R" below. +.IP "\fB\-\-all\fR" 4 +.IX Item "--all" +Search for package names, descriptions, and taxonomies, but not files. +.SS "uninstall" +.IX Subsection "uninstall" +Uninstalls the entire TeX Live installation. Options: +.IP "\fB\-\-force\fR" 4 +.IX Item "--force" +Do not ask for confirmation, remove immediately. +.SS "update [\fIoption\fP]... [\fIpkg\fP]..." +.IX Subsection "update [option]... [pkg]..." +Updates the packages given as arguments to the latest version available +at the installation source. Either \f(CW\*(C`\-\-all\*(C'\fR or at least one \fIpkg\fR name +must be specified. Options: +.IP "\fB\-\-all\fR" 4 +.IX Item "--all" +Update all installed packages except for \f(CW\*(C`tlmgr\*(C'\fR itself. Thus, if +updates to \f(CW\*(C`tlmgr\*(C'\fR itself are present, this will simply give an error, +unless also the option \f(CW\*(C`\-\-force\*(C'\fR or \f(CW\*(C`\-\-self\*(C'\fR is given. (See below.) +.Sp +In addition to updating the installed packages, during the update of a +collection the local installation is (by default) synchronized to the +status of the collection on the server, for both additions and removals. +.Sp +This means that if a package has been removed on the server (and thus +has also been removed from the respective collection), \f(CW\*(C`tlmgr\*(C'\fR will +remove the package in the local installation. This is called +``auto\-remove'' and is announced as such when using the option +\&\f(CW\*(C`\-\-list\*(C'\fR. This auto-removal can be suppressed using the option +\&\f(CW\*(C`\-\-no\-auto\-remove\*(C'\fR. +.Sp +Analogously, if a package has been added to a collection on the server +that is also installed locally, it will be added to the local +installation. This is called ``auto\-install'' and is announced as such +when using the option \f(CW\*(C`\-\-list\*(C'\fR. This auto-installation can be +suppressed using the option \f(CW\*(C`\-\-no\-auto\-install\*(C'\fR. +.Sp +An exception to the collection dependency checks (including the +auto-installation of packages just mentioned) are those that have been +``forcibly removed'' by you, that is, you called \f(CW\*(C`tlmgr remove \-\-force\*(C'\fR +on them. (See the \f(CW\*(C`remove\*(C'\fR action documentation.) To reinstall any +such forcibly removed packages use \f(CW\*(C`\-\-reinstall\-forcibly\-removed\*(C'\fR. +.Sp +If you want to exclude some packages from the current update run (e.g., +due to a slow link), see the \f(CW\*(C`\-\-exclude\*(C'\fR option below. +.IP "\fB\-\-self\fR" 4 +.IX Item "--self" +Update \f(CW\*(C`tlmgr\*(C'\fR itself (that is, the infrastructure packages) if updates +to it are present. On Windows this includes updates to the private Perl +interpreter shipped inside TeX Live. +.Sp +If this option is given together with either \f(CW\*(C`\-\-all\*(C'\fR or a list of +packages, then \f(CW\*(C`tlmgr\*(C'\fR will be updated first and, if this update +succeeds, the new version will be restarted to complete the rest of the +updates. +.Sp +In short: +.Sp +.Vb 4 +\& tlmgr update \-\-self # update infrastructure only +\& tlmgr update \-\-self \-\-all # update infrastructure and all packages +\& tlmgr update \-\-force \-\-all # update all packages but *not* infrastructure +\& # ... this last at your own risk, not recommended! +.Ve +.IP "\fB\-\-dry\-run\fR" 4 +.IX Item "--dry-run" +Nothing is actually installed; instead, the actions to be performed are +written to the terminal. This is a more detailed report than \f(CW\*(C`\-\-list\*(C'\fR. +.IP "\fB\-\-list\fR [\fIpkg\fR]" 4 +.IX Item "--list [pkg]" +Concisely list the packages which would be updated, newly installed, or +removed, without actually changing anything. +If \f(CW\*(C`\-\-all\*(C'\fR is also given, all available updates are listed. +If \f(CW\*(C`\-\-self\*(C'\fR is given, but not \f(CW\*(C`\-\-all\*(C'\fR, only updates to the +critical packages (tlmgr, texlive infrastructure, perl on Windows, etc.) +are listed. +If neither \f(CW\*(C`\-\-all\*(C'\fR nor \f(CW\*(C`\-\-self\*(C'\fR is given, and in addition no \fIpkg\fR is +given, then \f(CW\*(C`\-\-all\*(C'\fR is assumed (thus, \f(CW\*(C`tlmgr update \-\-list\*(C'\fR is the +same as \f(CW\*(C`tlmgr update \-\-list \-\-all\*(C'\fR). +If neither \f(CW\*(C`\-\-all\*(C'\fR nor \f(CW\*(C`\-\-self\*(C'\fR is given, but specific package names are +given, those packages are checked for updates. +.IP "\fB\-\-exclude\fR \fIpkg\fR" 4 +.IX Item "--exclude pkg" +Exclude \fIpkg\fR from the update process. If this option is given more +than once, its arguments accumulate. +.Sp +An argument \fIpkg\fR excludes both the package \fIpkg\fR itself and all +its related platform-specific packages \fIpkg.ARCH\fR. For example, +.Sp +.Vb 1 +\& tlmgr update \-\-all \-\-exclude a2ping +.Ve +.Sp +will not update \f(CW\*(C`a2ping\*(C'\fR, \f(CW\*(C`a2ping.i386\-linux\*(C'\fR, or +any other \f(CW\*(C`a2ping.\*(C'\fR\fI\s-1ARCH\s0\fR package. +.Sp +If this option specifies a package that would otherwise be a candidate +for auto-installation, auto-removal, or reinstallation of a forcibly +removed package, \f(CW\*(C`tlmgr\*(C'\fR quits with an error message. Excludes are not +supported in these circumstances. +.IP "\fB\-\-no\-auto\-remove\fR [\fIpkg\fR]..." 4 +.IX Item "--no-auto-remove [pkg]..." +Under normal circumstances \f(CW\*(C`tlmgr\*(C'\fR tries to remove packages which have +disappeared on the server, as described above under \f(CW\*(C`\-\-all\*(C'\fR. This +option prevents any such removals, either for all packages (with +\&\f(CW\*(C`\-\-all\*(C'\fR), or the given \fIpkg\fR names. +.IP "\fB\-\-no\-auto\-install\fR [\fIpkg\fR]..." 4 +.IX Item "--no-auto-install [pkg]..." +Under normal circumstances \f(CW\*(C`tlmgr\*(C'\fR will install packages which are new +on the server, as described above under \f(CW\*(C`\-\-all\*(C'\fR. This option prevents +any such automatic installation, either for all packages (with +\&\f(CW\*(C`\-\-all\*(C'\fR), or the given \fIpkg\fR names. +.Sp +Furthermore, after the \f(CW\*(C`tlmgr\*(C'\fR run using this has finished, the +packages that would have been auto-installed \fIwill be considered as +forcibly removed\fR. So, if \f(CW\*(C`foobar\*(C'\fR is the only new package on the +server, then +.Sp +.Vb 1 +\& tlmgr update \-\-all \-\-no\-auto\-install +.Ve +.Sp +is equivalent to +.Sp +.Vb 2 +\& tlmgr update \-\-all +\& tlmgr remove \-\-force foobar +.Ve +.IP "\fB\-\-reinstall\-forcibly\-removed\fR" 4 +.IX Item "--reinstall-forcibly-removed" +Under normal circumstances \f(CW\*(C`tlmgr\*(C'\fR will not install packages that have +been forcibly removed by the user; that is, removed with \f(CW\*(C`remove +\&\-\-force\*(C'\fR, or whose installation was prohibited by \f(CW\*(C`\-\-no\-auto\-install\*(C'\fR +during an earlier update. +.Sp +This option makes \f(CW\*(C`tlmgr\*(C'\fR ignore the forcible removals and re-install +all such packages. This can be used to completely synchronize an +installation with the server's idea of what is available: +.Sp +.Vb 1 +\& tlmgr update \-\-reinstall\-forcibly\-removed \-\-all +.Ve +.IP "\fB\-\-backup\fR and \fB\-\-backupdir\fR \fIdirectory\fR" 4 +.IX Item "--backup and --backupdir directory" +These two options control the creation of backups of packages \fIbefore\fR +updating; that is, backup of packages as currently installed. If +neither of these options are given, no backup package will be saved. If +\&\f(CW\*(C`\-\-backupdir\*(C'\fR is given and specifies a writable directory then a backup +will be made in that location. If only \f(CW\*(C`\-\-backup\*(C'\fR is given, then a +backup will be made to the directory previously set via the \f(CW\*(C`option\*(C'\fR +action (see below). If both are given then a backup will be made to the +specified \fIdirectory\fR. +.Sp +You can set options via the \f(CW\*(C`option\*(C'\fR action to automatically create +backups for all packages, and/or keep only a certain number of +backups. Please see the \f(CW\*(C`option\*(C'\fR action for details. +.Sp +\&\f(CW\*(C`tlmgr\*(C'\fR always makes a temporary backup when updating packages, in case +of download or other failure during an update. In contrast, the purpose +of this \f(CW\*(C`\-\-backup\*(C'\fR option is to allow you to save a persistent backup +in case the actual \fIcontent\fR of the update causes problems, e.g., +introduces an incompatibility. +.Sp +The \f(CW\*(C`restore\*(C'\fR action explains how to restore from a backup. +.IP "\fB\-\-no\-depends\fR" 4 +.IX Item "--no-depends" +If you call for updating a package normally all depending packages +will also be checked for updates and updated if necessary. This switch +suppresses this behavior. +.IP "\fB\-\-no\-depends\-at\-all\fR" 4 +.IX Item "--no-depends-at-all" +See above under \fBinstall\fR (and beware). +.IP "\fB\-\-force\fR" 4 +.IX Item "--force" +Force update of normal packages, without updating \f(CW\*(C`tlmgr\*(C'\fR itself +(unless the \f(CW\*(C`\-\-self\*(C'\fR option is also given). Not recommended. +.Sp +Also, \f(CW\*(C`update \-\-list\*(C'\fR is still performed regardless of this option. +.PP +If the package on the server is older than the package already installed +(e.g., if the selected mirror is out of date), \f(CW\*(C`tlmgr\*(C'\fR does not +downgrade. Also, packages for uninstalled platforms are not installed. +.SH "TLMGR CONFIGURATION FILE" +.IX Header "TLMGR CONFIGURATION FILE" +A small subset of the command line options can be set in a config file +for \f(CW\*(C`tlmgr\*(C'\fR which resides in \f(CW\*(C`TEXMFCONFIG/tlmgr/config\*(C'\fR. By default, the +config file is in \f(CW\*(C`~/.texliveYYYY/texmf\-config/tlmgr/config\*(C'\fR (replacing +\&\f(CW\*(C`YYYY\*(C'\fR with the year of your TeX Live installation). This is \fInot\fR +\&\f(CW\*(C`TEXMFSYSVAR\*(C'\fR, so that the file is specific to a single user. +.PP +In this file, empty lines and lines starting with # are ignored. All +other lines must look like +.PP +.Vb 1 +\& key = value +.Ve +.PP +where the allowed keys are +\&\f(CW\*(C`gui\-expertmode\*(C'\fR (values 0 or 1), +\&\f(CW\*(C`persistent\-downloads\*(C'\fR (values 0 or 1), \f(CW\*(C`auto\-remove\*(C'\fR (values 0 or 1), +and \f(CW\*(C`gui\-lang\*(C'\fR (values like the command line arguments). +\&\f(CW\*(C`persistent\-downloads\*(C'\fR, \f(CW\*(C`gui\-lang\*(C'\fR, and \f(CW\*(C`auto\-remove\*(C'\fR correspond to the +respective command line options of the same name. +\&\f(CW\*(C`gui\-expertmode\*(C'\fR switches between the full +\&\s-1GUI\s0 and a simplified \s-1GUI\s0 with only the important and mostly used +settings. +.SH "TAXONOMIES" +.IX Header "TAXONOMIES" +tlmgr allows searching and listing of various categorizations, which we +call \fItaxonomies\fR, as provided by an enhanced TeX Catalogue (available +for testing at <http://az.ctan.org>). This is useful when, for +example, you don't know a specific package name but have an idea of the +functionality you need; or when you want to see all packages relating to +a given area. +.PP +There are three different taxonomies, specified by the following +options: +.IP "\fB\-\-keyword\fR" 4 +.IX Item "--keyword" +The keywords, as specified at <http://az.ctan.org/keyword>. +.IP "\fB\-\-functionality\fR" 4 +.IX Item "--functionality" +The ``by\-topic'' categorization created by J\e"urgen Fenn, as specified +at http://az.ctan.org/characterization/by\-function <http://az.ctan.org/characterization/by-function>. +.IP "\fB\-\-characterization\fR" 4 +.IX Item "--characterization" +Both the primary and secondary functionalities, as specified at +<http://az.ctan.org/characterization/choose_dimen>. +.IP "\fB\-\-taxonomy\fR" 4 +.IX Item "--taxonomy" +Operate on all the taxonomies. +.PP +The taxonomies are updated nightly and stored within TeX Live, so +Internet access is not required to search them. +.PP +Examples: +.PP +.Vb 5 +\& tlmgr search \-\-taxonomy exercise # check all taxonomies for "exercise" +\& tlmgr search \-\-taxonomy \-\-word table # check for "table" on its own +\& tlmgr search \-\-list \-\-keyword # dump entire keyword taxonomy +\& tlmgr show \-\-taxonomy pdftex # show pdftex package information, +\& # including all taxonomy entries +.Ve +.SH "MULTIPLE REPOSITORIES" +.IX Header "MULTIPLE REPOSITORIES" +The main TeX Live repository contains a vast array of packages. +Nevertheless, additional local repositories can be useful to provide +locally-installed resources, such as proprietary fonts and house styles. +Also, alternative package repositories distribute packages that cannot +or should not be included in TeX Live, for whatever reason. +.PP +The simplest and most reliable method is to temporarily set the +installation source to any repository (with the \f(CW\*(C`\-repository\*(C'\fR or +\&\f(CW\*(C`option repository\*(C'\fR command line options), and perform your operations. +.PP +When you are using multiple repositories over a sustained time, however, +explicitly switching between them becomes inconvenient. Thus, it's +possible to tell \f(CW\*(C`tlmgr\*(C'\fR about additional repositories you want to use. +The basic command is \f(CW\*(C`tlmgr repository add\*(C'\fR. The rest of this section +explains further. +.PP +When using multiple repositories, one of them has to be set as the main +repository, which distributes most of the installed packages. When you +switch from a single repository installation to a multiple repository +installation, the previous sole repository will be set as the main +repository. +.PP +By default, even if multiple repositories are configured, packages are +\&\fIstill\fR \fIonly\fR installed from the main repository. Thus, simply +adding a second repository does not actually enable installation of +anything from there. You also have to specify which packages should be +taken from the new repository, by specifying so-called ``pinning'' +rules, described next. +.SS "Pinning" +.IX Subsection "Pinning" +When a package \f(CW\*(C`foo\*(C'\fR is pinned to a repository, a package \f(CW\*(C`foo\*(C'\fR in any +other repository, even if it has a higher revision number, will not be +considered an installable candidate. +.PP +As mentioned above, by default everything is pinned to the main +repository. Let's now go through an example of setting up a second +repository and enabling updates of a package from it. +.PP +First, check that we have support for multiple repositories, and have +only one enabled (as is the case by default): +.PP +.Vb 3 +\& $ tlmgr repository list +\& List of repositories (with tags if set): +\& /var/www/norbert/tlnet +.Ve +.PP +Ok. Let's add the \f(CW\*(C`tlcontrib\*(C'\fR repository (this is a real +repository, hosted at <http://tlcontrib.metatex.org>, maintained by +Taco Hoekwater et al.), with the tag \f(CW\*(C`tlcontrib\*(C'\fR: +.PP +.Vb 1 +\& $ tlmgr repository add http://tlcontrib.metatex.org/2012 tlcontrib +.Ve +.PP +Check the repository list again: +.PP +.Vb 4 +\& $ tlmgr repository list +\& List of repositories (with tags if set): +\& http://tlcontrib.metatex.org/2012 (tlcontrib) +\& /var/www/norbert/tlnet (main) +.Ve +.PP +Now we specify a pinning entry to get the package \f(CW\*(C`context\*(C'\fR from +\&\f(CW\*(C`tlcontrib\*(C'\fR: +.PP +.Vb 1 +\& $ tlmgr pinning add tlcontrib context +.Ve +.PP +Check that we can find \f(CW\*(C`context\*(C'\fR: +.PP +.Vb 6 +\& $ tlmgr show context +\& tlmgr: package repositories: +\& ... +\& package: context +\& repository: tlcontrib/26867 +\& ... +.Ve +.PP +\&\- install \f(CW\*(C`context\*(C'\fR: +.PP +.Vb 4 +\& $ tlmgr install context +\& tlmgr: package repositories: +\& ... +\& [1/1, ??:??/??:??] install: context @tlcontrib [ +.Ve +.PP +In the output here you can see that the \f(CW\*(C`context\*(C'\fR package has been +installed from the \f(CW\*(C`tlcontrib\*(C'\fR repository (\f(CW@tlcontrib\fR). +.PP +Finally, \f(CW\*(C`tlmgr pinning\*(C'\fR also supports removing certain or all packages +from a given repository: +.PP +.Vb 2 +\& $ tlmgr pinning remove tlcontrib context # remove just context +\& $ tlmgr pinning remove tlcontrib \-\-all # take nothing from tlcontrib +.Ve +.PP +A summary of the \f(CW\*(C`tlmgr pinning\*(C'\fR actions is given above. +.SH "GUI FOR TLMGR" +.IX Header "GUI FOR TLMGR" +The graphical user interface for \f(CW\*(C`tlmgr\*(C'\fR needs Perl/Tk to be installed. +For Windows the necessary modules are shipped within TeX Live, for all +other (i.e., Unix-based) systems Perl/Tk (as well as Perl of course) has +to be installed. <http://tug.org/texlive/distro.html#perltk> has a +list of invocations for some distros. +.PP +When started with \f(CW\*(C`tlmgr gui\*(C'\fR the graphical user interface will be +shown. The main window contains a menu bar, the main display, and a +status area where messages normally shown on the console are displayed. +.PP +Within the main display there are three main parts: the \f(CW\*(C`Display +configuration\*(C'\fR area, the list of packages, and the action buttons. +.PP +Also, at the top right the currently loaded repository is shown; this +also acts as a button and when clicked will try to load the default +repository. To load a different repository, see the \f(CW\*(C`tlmgr\*(C'\fR menu item. +.PP +Finally, the status area at the bottom of the window gives additional +information about what is going on. +.SS "Main display" +.IX Subsection "Main display" +\fIDisplay configuration area\fR +.IX Subsection "Display configuration area" +.PP +The first part of the main display allows you to specify (filter) which +packages are shown. By default, all are shown. Changes here are +reflected right away. +.IP "Status" 4 +.IX Item "Status" +Select whether to show all packages (the default), only those installed, +only those \fInot\fR installed, or only those with update available. +.IP "Category" 4 +.IX Item "Category" +Select which categories are shown: packages, collections, and/or +schemes. These are briefly explained in the \*(L"\s-1DESCRIPTION\s0\*(R" section +above. +.IP "Match" 4 +.IX Item "Match" +Select packages matching for a specific pattern. By default, this uses +the same algorithm as \f(CW\*(C`tlmgr search\*(C'\fR, i.e., searches everything: +descriptions, taxonomies, and/or filenames. You can also select any +subset for searching. +.IP "Selection" 4 +.IX Item "Selection" +Select packages to those selected, those not selected, or all. Here, +``selected'' means that the checkbox in the beginning of the line of a +package is ticked. +.IP "Display configuration buttons" 4 +.IX Item "Display configuration buttons" +To the right there are three buttons: select all packages, select none +(a.k.a. deselect all), and reset all these filters to the defaults, +i.e., show all available. +.PP +\fIPackage list area\fR +.IX Subsection "Package list area" +.PP +The second are of the main display lists all installed packages. If a +repository is loaded, those that are available but not installed are +also listed. +.PP +Double clicking on a package line pops up an informational window with +further details: the long description, included files, etc. +.PP +Each line of the package list consists of the following items: +.IP "a checkbox" 4 +.IX Item "a checkbox" +Used to select particular packages; some of the action buttons (see +below) work only on the selected packages. +.IP "package name" 4 +.IX Item "package name" +The name (identifier) of the package as given in the database. +.IP "local revision (and version)" 4 +.IX Item "local revision (and version)" +If the package is installed the TeX Live revision number for the +installed package will be shown. If there is a catalogue version given +in the database for this package, it will be shown in parentheses. +However, the catalogue version, unlike the \s-1TL\s0 revision, is not +guaranteed to reflect what is actually installed. +.IP "remote revision (and version)" 4 +.IX Item "remote revision (and version)" +If a repository has been loaded the revision of the package in the +repository (if present) is shown. As with the local column, if a +catalogue version is provided it will be displayed. And also as with +the local column, the catalogue version may be stale. +.IP "short description" 4 +.IX Item "short description" +The short description of the package. +.PP +\fIMain display action buttons\fR +.IX Subsection "Main display action buttons" +.PP +Below the list of packages are several buttons: +.IP "Update all installed" 4 +.IX Item "Update all installed" +This calls \f(CW\*(C`tlmgr update \-\-all\*(C'\fR, i.e., tries to update all available +packages. Below this button is a toggle to allow reinstallation of +previously removed packages as part of this action. +.Sp +The other four buttons only work on the selected packages, i.e., those +where the checkbox at the beginning of the package line is ticked. +.IP "Update" 4 +.IX Item "Update" +Update only the selected packages. +.IP "Install" 4 +.IX Item "Install" +Install the selected packages; acts like \f(CW\*(C`tlmgr install\*(C'\fR, i.e., also +installs dependencies. Thus, installing a collection installs all its +constituent packages. +.IP "Remove" 4 +.IX Item "Remove" +Removes the selected packages; acts like \f(CW\*(C`tlmgr remove\*(C'\fR, i.e., it will +also remove dependencies of collections (but not dependencies of normal +packages). +.IP "Backup" 4 +.IX Item "Backup" +Makes a backup of the selected packages; acts like \f(CW\*(C`tlmgr backup\*(C'\fR. This +action needs the option \f(CW\*(C`backupdir\*(C'\fR set (see \f(CW\*(C`Options \-\*(C'\fR General>). +.SS "Menu bar" +.IX Subsection "Menu bar" +The following entries can be found in the menu bar: +.IP "\fBtlmgr\fR menu" 4 +.IX Item "tlmgr menu" +The items here load various repositories: the default as specified in +the TeX Live database, the default network repository, the repository +specified on the command line (if any), and an arbitrarily +manually-entered one. Also has the so-necessary \f(CW\*(C`quit\*(C'\fR operation. +.IP "\fBOptions menu\fR" 4 +.IX Item "Options menu" +Provides access to several groups of options: \f(CW\*(C`Paper\*(C'\fR (configuration of +default paper sizes), \f(CW\*(C`Platforms\*(C'\fR (only on Unix, configuration of the +supported/installed platforms), \f(CW\*(C`GUI Language\*(C'\fR (select language used in +the \s-1GUI\s0 interface), and \f(CW\*(C`General\*(C'\fR (everything else). +.Sp +Several toggles are also here. The first is \f(CW\*(C`Expert options\*(C'\fR, which is +set by default. If you turn this off, the next time you start the \s-1GUI\s0 a +simplified screen will be shown that display only the most important +functionality. This setting is saved in the configuration file of +\&\f(CW\*(C`tlmgr\*(C'\fR; see \*(L"\s-1CONFIGURATION\s0 \s-1FILE\s0\*(R" for details. +.Sp +The other toggles are all off by default: for debugging output, to +disable the automatic installation of new packages, and to disable the +automatic removal of packages deleted from the server. Playing with the +choices of what is or isn't installed may lead to an inconsistent TeX Live +installation; e.g., when a package is renamed. +.IP "\fBActions menu\fR" 4 +.IX Item "Actions menu" +Provides access to several actions: update the filename database (aka +\&\f(CW\*(C`ls\-R\*(C'\fR, \f(CW\*(C`mktexlsr\*(C'\fR, \f(CW\*(C`texhash\*(C'\fR), rebuild all formats (\f(CW\*(C`fmtutil\-sys +\&\-\-all\*(C'\fR), update the font map database (\f(CW\*(C`updmap\-sys\*(C'\fR), restore from a backup +of a package, and use of symbolic links in system directories (not on +Windows). +.Sp +The final action is to remove the entire TeX Live installation (also not +on Windows). +.IP "\fBHelp menu\fR" 4 +.IX Item "Help menu" +Provides access to the TeX Live manual (also on the web at +<http://tug.org/texlive/doc.html>) and the usual ``About'' box. +.SH "MACHINE-READABLE OUTPUT" +.IX Header "MACHINE-READABLE OUTPUT" +With the \f(CW\*(C`\-\-machine\-readable\*(C'\fR option, \f(CW\*(C`tlmgr\*(C'\fR writes to stdout in the +fixed line-oriented format described here, and the usual informational +messages for human consumption are written to stderr (normally they are +written to stdout). The idea is that a program can get all the +information it needs by reading stdout. +.PP +Currently this option only applies to the +update, the +install, and the +option actions. +.SS "update and install actions" +.IX Subsection "update and install actions" +The output format is as follows: +.PP +.Vb 7 +\& fieldname "\et" value +\& ... +\& "end\-of\-header" +\& pkgname status localrev serverrev size runtime esttot +\& ... +\& "end\-of\-updates" +\& other output from post actions, not in machine readable form +.Ve +.PP +The header section currently has two fields: \f(CW\*(C`location\-url\*(C'\fR (the +repository source from which updates are being drawn), and +\&\f(CW\*(C`total\-bytes\*(C'\fR (the total number of bytes to be downloaded). +.PP +The \fIlocalrev\fR and \fIserverrev\fR fields for each package are the +revision numbers in the local installation and server repository, +respectively. The \fIsize\fR field is the number of bytes to be +downloaded, i.e., the size of the compressed tar file for a network +installation, not the unpacked size. The runtime and esttot fields +are only present for updated and auto-install packages, and contain +the currently passed time since start of installation/updates +and the estimated total time. +.PP +Line endings may be either \s-1LF\s0 or \s-1CRLF\s0 depending on the current platform. +.ie n .IP """location\-url"" \fIlocation\fR" 4 +.el .IP "\f(CWlocation\-url\fR \fIlocation\fR" 4 +.IX Item "location-url location" +The \fIlocation\fR may be a url (including \f(CW\*(C`file:///foo/bar/...\*(C'\fR), or a +directory name (\f(CW\*(C`/foo/bar\*(C'\fR). It is the package repository from which +the new package information was drawn. +.ie n .IP """total\-bytes"" \fIcount\fR" 4 +.el .IP "\f(CWtotal\-bytes\fR \fIcount\fR" 4 +.IX Item "total-bytes count" +The \fIcount\fR is simply a decimal number, the sum of the sizes of all the +packages that need updating or installing (which are listed subsequently). +.PP +Then comes a line with only the literal string \f(CW\*(C`end\-of\-header\*(C'\fR. +.PP +Each following line until a line with literal string \f(CW\*(C`end\-of\-updates\*(C'\fR +reports on one package. The fields on +each line are separated by a tab. Here are the fields. +.IP "\fIpkgname\fR" 4 +.IX Item "pkgname" +The TeX Live package identifier, with a possible platform suffix for +executables. For instance, \f(CW\*(C`pdftex\*(C'\fR and \f(CW\*(C`pdftex.i386\-linux\*(C'\fR are given +as two separate packages, one on each line. +.IP "\fIstatus\fR" 4 +.IX Item "status" +The status of the package update. One character, as follows: +.RS 4 +.ie n .IP """d""" 8 +.el .IP "\f(CWd\fR" 8 +.IX Item "d" +The package was removed on the server. +.ie n .IP """f""" 8 +.el .IP "\f(CWf\fR" 8 +.IX Item "f" +The package was removed in the local installation, even though a +collection depended on it. (E.g., the user ran \f(CW\*(C`tlmgr remove +\&\-\-force\*(C'\fR.) +.ie n .IP """u""" 8 +.el .IP "\f(CWu\fR" 8 +.IX Item "u" +Normal update is needed. +.ie n .IP """r""" 8 +.el .IP "\f(CWr\fR" 8 +.IX Item "r" +Reversed non-update: the locally-installed version is newer than the +version on the server. +.ie n .IP """a""" 8 +.el .IP "\f(CWa\fR" 8 +.IX Item "a" +Automatically-determined need for installation, the package is new on +the server and is (most probably) part of an installed collection. +.ie n .IP """i""" 8 +.el .IP "\f(CWi\fR" 8 +.IX Item "i" +Package will be installed and isn't present in the local installation +(action install). +.ie n .IP """I""" 8 +.el .IP "\f(CWI\fR" 8 +.IX Item "I" +Package is already present but will be reinstalled (action install). +.RE +.RS 4 +.RE +.IP "\fIlocalrev\fR" 4 +.IX Item "localrev" +The revision number of the installed package, or \f(CW\*(C`\-\*(C'\fR if it is not +present locally. +.IP "\fIserverrev\fR" 4 +.IX Item "serverrev" +The revision number of the package on the server, or \f(CW\*(C`\-\*(C'\fR if it is not +present on the server. +.IP "\fIsize\fR" 4 +.IX Item "size" +The size in bytes of the package on the server. The sum of all the +package sizes is given in the \f(CW\*(C`total\-bytes\*(C'\fR header field mentioned above. +.IP "\fIruntime\fR" 4 +.IX Item "runtime" +The run time since start of installations or updates. +.IP "\fIesttot\fR" 4 +.IX Item "esttot" +The estimated total time. +.SS "option action" +.IX Subsection "option action" +The output format is as follows: +.PP +.Vb 1 +\& key "\et" value +.Ve +.PP +If a value is not saved in the database the string \f(CW\*(C`(not set)\*(C'\fR is shown. +.PP +If you are developing a program that uses this output, and find that +changes would be helpful, do not hesitate to write the mailing list. +.SH "AUTHORS AND COPYRIGHT" +.IX Header "AUTHORS AND COPYRIGHT" +This script and its documentation were written for the TeX Live +distribution (<http://tug.org/texlive>) and both are licensed under the +\&\s-1GNU\s0 General Public License Version 2 or later. +.SH "POD ERRORS" +.IX Header "POD ERRORS" +Hey! \fBThe above document had some coding errors, which are explained below:\fR +.IP "Around line 6509:" 4 +.IX Item "Around line 6509:" +Unterminated C<...> sequence +.IP "Around line 6514:" 4 +.IX Item "Around line 6514:" +Unterminated C<...> sequence diff --git a/Master/texmf-dist/doc/man/man1/tlmgr.man1.pdf b/Master/texmf-dist/doc/man/man1/tlmgr.man1.pdf Binary files differnew file mode 100644 index 00000000000..cc1effc84b2 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/tlmgr.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/tpic2pdftex.1 b/Master/texmf-dist/doc/man/man1/tpic2pdftex.1 new file mode 100644 index 00000000000..2be7c0737e1 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/tpic2pdftex.1 @@ -0,0 +1,73 @@ +.TH TPIC2PDFTEX 1 2008-08-01 GNU "Tex Live Manpage" + +.\"$Id: tpic2pdftex.1,v 1.15 2010/01/16 12:13:17 hahe Exp hahe $ +.\" +.\" Copyright (C) 2002--2008 by Hartmut Henkel +.\" +.\" 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 2 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, write to the +.\" Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, +.\" MA 02111-1307 USA + +.SH NAME +tpic2pdftex \- convert tpic \\specials for use by pdftex + +.SH SYNOPSIS +.B pic +-t +.I somefile.pic +| +.B tpic2pdftex +> +.I somefile.tex + +Process +.IR somefile.tex +by +.BR pdftex/pdflatex. + +.SH DESCRIPTION +Experimental +.B awk +script for conversion of +.B tpic +\\specials as produced +by +.B (groff-)pic +into +.B pdfTeX +\\pdfliteral sections for further processing +by +.B pdftex. + +.SH NOTES +Current version: 1.97. + +.B tpic +\\special +description see e. g.: +Goossens, Rahtz, Mittelbach: The LaTeX Graphics Companion, +Addison-Wesley, 1997, pp. 464. + +.SH BUGS +Spline curve shapes not fully authentic (unknown algorithm). +Bounding box does not care for line thickness (groff pic feature). +Splines might be outside bounding box. +Fill color does not work correctly for arrowheads (pic limitation). + +.SH SEE ALSO +.BR pic (1), +.BR grap (1), +.BR groff (1), +.BR awk (1), +.BR pdftex (1). diff --git a/Master/texmf-dist/doc/man/man1/tpic2pdftex.man1.pdf b/Master/texmf-dist/doc/man/man1/tpic2pdftex.man1.pdf Binary files differnew file mode 100644 index 00000000000..76bdd705644 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/tpic2pdftex.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/ttf2afm.1 b/Master/texmf-dist/doc/man/man1/ttf2afm.1 new file mode 100644 index 00000000000..5c5d059ae54 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ttf2afm.1 @@ -0,0 +1,75 @@ +.TH "ttf2afm" "1" "September 2000" "pdfTeX" "pdfTeX" +.PP +.SH "NAME" +ttf2afm \- utility to generate AFM files for TrueType fonts +.PP +.SH "SYNOPSIS" +.B ttf2afm +.RI [ OPTIONS ] +.I FONTFILE +.PP +.SH "DESCRIPTION" +.PP +\fBttf2afm\fP is used to generate Adobe Font Metrics (AFM) files for +TrueType (TTF) fonts to allow them to be used with TeX\&. +.PP +\fBttf2afm\fP takes the name of a TrueType font file as a required +argument\&. It may also take one or more options from the list below +(note that \fB-d\fP and \fB-h\fP are mutually exclusive)\&. +.PP +.SH "OPTIONS" +.PP +.IP "\fB-a\fP" +print all glyphs +.IP "\fB-i\fP" +read names in encoding vector in form +`index\fInum\fP\&' +.IP "\fB-d\fP" +print glyph names in the form +`index\fIdecimal_num\fP\&' +.IP "\fB-h\fP" +print glyph names in the form +`index\fIhex_num\fP\&' +.IP "\fB-c\fP \fIname\fP" +print encoding tables to file +\fIname\&.eMN\fP, where \fIM\fP is the platform +number and \fIN\fP is the encoding +.IP "\fB-e\fP \fIenc\fP" +use encoding from file \fIenc\fP +.IP "\fB-o\fP \fIoutput\fP" +output to file \fIoutput\fP instead +of stdout +.PP +Platform numbers can be one of +.IP "0" +Apple Unicode +.IP "1" +Macintosh +.IP "2" +ISO +.IP "3" +Microsoft +.PP +Encodings can be +.IP "0" +Roman (if platform is Macintosh) +.IP "0" +Symbol (if platform is Microsoft) +.IP "1" +Unicode (if platform is Microsoft) +.PP +.SH "BUGS" +.PP +None known, but submit bug reports to <pdftex@tug\&.org> (mailing list)\&. +.PP +.SH "AUTHOR" +.PP +\fBttf2afm\fP is part of pdfTeX and was written by Han The Thanh +<thanh@informatics\&.muni\&.cz>\&. +.PP +This manual page was written by C\&.M\&. Connelly +<cmc@debian\&.org>, for +the Debian GNU/Linux system\&. It may be used by other distributions +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/Master/texmf-dist/doc/man/man1/ttf2afm.man1.pdf b/Master/texmf-dist/doc/man/man1/ttf2afm.man1.pdf Binary files differnew file mode 100644 index 00000000000..628c49af597 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ttf2afm.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/ttf2pk.1 b/Master/texmf-dist/doc/man/man1/ttf2pk.1 new file mode 100644 index 00000000000..516a3081223 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ttf2pk.1 @@ -0,0 +1,311 @@ +.\" man page for ttf2pk +. +.TH TTF2PK 1 10-Jan-2002 "FreeType version 1.5" +.SH NAME +ttf2pk \- convert a TrueType font into TeX's PK format +.SH SYNOPSIS +.na +.nh +.B ttf2pk +.RB [ \-q ] +.RB [ \-n ] +.I "\%font-name \%resolution" +.br +.B ttf2pk +.B \-t +.RB [ \-q ] +.I \%font-name +.br +.B "ttf2pk \-\^\-version" +| +.B \-\^\-help +.ad +.hy +. +. +. +.\" ==== +.\" ==== macro definitions +.\" ==== +. +.\" here we define \TeX for troff and nroff +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +. +.\" and here the same for \LaTeX +.if t \{\ +.ie '\*(.T'dvi' \ +.ds LX \fRL\h'-0.36m'\v'-0.15v'\s-3A\s0\h'-0.15m'\v'0.15v'\fP\*(TX +.el .ds LX \fRL\h'-0.36m'\v'-0.22v'\s-2A\s0\h'-0.15m'\v'0.22v'\fP\*(TX +.\} +.if n .ds LX LaTeX +. +.\" \LaTeXe +.\" note that we need \vareps for TeX instead of \eps which can only be +.\" accessed with the \N escape sequence (in the Math Italic font) +.if t \{\ +.ie '\*(.T'dvi' .ds LE \*(LX\h'0.15m'2\v'0.20v'\f(MI\N'34'\fP\v'-0.20v' +.el .ds LE \*(LX\h'0.15m'2\v'0.20v'\(*e\v'-0.20v' +.\} +.if n .ds LE LaTeX\ 2e +. +.\" a typewriter font +.if t \{\ +.de C +\fC\\$1\fP\\$2 +.. +.\} +.if n \{\ +.de C +\\$1\\$2 +.. +.\} +. +.\" ==== +.\" ==== end of macro definitions +.\" ==== +. +. +. +.SH DESCRIPTION +This program converts a TrueType font into a +.C PK +file; the created font can then be used with \*(TX +or \*(LX. +.PP +CJKV (Chinese/Japanese/Korean/old Vietnamese) subfonts as created by +.B ttf2tfm +are also supported. +.PP +.B ttf2pk +always assumes 10pt as the design size for the written \*(TX +font. +. +. +.SH PARAMETERS +.TP +.B \-q +This optional switch makes +.B ttf2pk +quiet. +It suppresses any informational output except warning and error +messages. +.TP +.B \-n +Use only `\c +.C \&.pk ' +as the extension instead of `\c +.C \&. \c +.RI < \%resolution >\c +.C pk '. +.TP +.B \-t +Test for the existence of +.IR \%font-name . +Returns 0 on success and prints out the corresponding line of +a map file (default: +.C \%ttfonts.map ), +provided the +.B \-q +switch isn't set. +.TP +.I font-name +The \*(TX +name of the font. +.B ttf2pk +looks this name up in a map file (see below) for further information how +to process the font. +.TP +.I resolution +The resolution, given in dots per inch. +Currently the horizontal resolution is equal to the vertical +resolution. +The design size is always assumed to be 10pt. +.TP +.B \-\^\-version +Shows the current version of +.B ttf2pk +and the used file search library (e.g.\ \c +.BR kpathsea ). +.TP +.B \-\^\-help +Shows usage information. +.PP +Environment variables for file searching are described in the manual page +of +.BR ttf2tfm . +. +. +.SH "THE CONFIGURATION FILE" +.B ttf2pk +uses a small configuration file called +.C ttf2pk.cfg ; +in each line it contains a keyword with its value, separated by whitespace. +Comment lines can start with any of the following characters: `*', `#', +`;', and `%'. +Leading whitespace is ignored. +.PP +Currently, only one keyword, `map', is recognized in this file; it takes +a map file name as a parameter. +If no extension is given to the map file name, +.C \&.map +is appended. +No whitespace is allowed in the map file name. +The `map' keyword can be given more than once to specify multiple map +files; if the map file name is prepended by a plus sign, it is added to +the list of map files to be used. +Example: +.PP +.in +2m +.C "map foo" +.br +.C "map +bar" +.PP +This makes +.B ttf2pk +to first read +.C foo.map , +then +.C bar.map . +.PP +If the configuration file is not found, +.B ttf2pk +tries to use +.C \%ttfonts.map +instead. +. +. +.SH "MAP FILES" +Parameters specified to +.B ttf2tfm +are preserved for +.B ttf2pk +in map files\(em\c +.B ttf2tfm +writes out to standard output, as the last line, a proper entry for a +map file. +.PP +As an example, a call to +.PP +.in +2m +.C "ttf2tfm arial -p T1.enc -s 0.25 -P 1 -E 0 arials" +.PP +will produce the following line: +.PP +.in +2m +.C "arials arial Slant=0.25 Pid=1 Eid=0 Encoding=T1.enc" +.PP +See +.BR ttf2tfm (1) +and +.BR afm2tfm (1) +of the +.B dvips +package for a detailed description of encoding files. +.PP +Here a table listing the various +.B ttf2tfm +parameters and the corresponding entries in a map file: +.PP +.in +4m +.ta 2i +-s Slant +.br +-e Extend +.br +-p Encoding +.br +-f Fontindex +.br +-P Pid +.br +-E Eid +.br +-n PS=Yes +.br +-N PS=Only +.br +-R Replacement +.br +-x Rotate=Yes +.br +-y Y-Offset +.PP +Single replacement glyph names given to +.B ttf2tfm +with `\c +.BI \-r \ old-glyphname\ new-glyphname\c +\&' +are directly specified with `\c +.IR old-glyphname = new-glyphname '. +They will be ignored if in subfont mode or if no encoding file is given. +.PP +One additional parameter in a map file is unique to +.BR ttf2pk : +`Hinting', which can take the values `On' or `Off'. +Some fonts (e.g.\ the CJK part of +.C \%cyberbit.ttf ) +are rendered incorrectly if hinting is activated. +Default is `On' (you can also use `Yes', `No', `1', and `0'). +.PP +For a description of subfonts (i.e., entries of the form `\c +.I <namestem>\c +.C @\c +.I <sfd-filename>\c +.C @ ') +please refer to +.BR ttf2tfm (1). +.PP +The format of a map file is simple. +Each line defines a font; first comes the \*(TX +font name, then its TrueType font file name, followed by the +parameters in any order. +Case is significant (even for parameter names); the parameters are +separated from its values by an equal sign, with whitespace possibly +surrounding it. +.B ttf2pk +reads in all map files line by line in the order given in the +configuration file, continuing until the \*(TX font specified on the +command line is found, otherwise the programs exits with error code\ 2. +Thus you can use any character invalid in a \*(TX +font name to start a comment line. +.PP +You can use `\\' as the final character of a line to indicate that the +input is continued on the next line. +The backslash and the following newline character will be removed. +.PP +.B ttf2pk +will abort if it can't find or read the \*(TX +font metrics file of the given \*(TX +font name. +. +. +.SH "RETURN VALUE" +If the call was successful, 0\ will be returned. +In case of error, the return value is\ 1. +Finally, if the font can't be found in the map files, +2\ is returned. +This simplifies the inclusion of +.B ttf2pk +into scripts like +.B mktexpk +for automatic font generation. +. +. +.SH "SEE ALSO" +.BR ttf2tfm (1), +.BR afm2tfm (1) +. +. +.SH AVAILABILITY +.B ttf2pk +is part of the FreeType\ 1 package, a high quality TrueType rendering +library. +. +. +.SH AUTHORS +Werner LEMBERG +.C <wl@gnu.org> +.br +Fr\('ed\('eric LOYER +.C <loyer@ensta.fr> diff --git a/Master/texmf-dist/doc/man/man1/ttf2pk.man1.pdf b/Master/texmf-dist/doc/man/man1/ttf2pk.man1.pdf Binary files differnew file mode 100644 index 00000000000..9cdb3301cb8 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ttf2pk.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/ttf2tfm.1 b/Master/texmf-dist/doc/man/man1/ttf2tfm.1 new file mode 100644 index 00000000000..482f2ee1ff4 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ttf2tfm.1 @@ -0,0 +1,1189 @@ +.\" man page for ttf2tfm +. +.TH TTF2TFM 1 10-Jan-2002 "FreeType version 1.5" +.SH NAME +ttf2tfm \- build TeX metric files from a TrueType font +.SH SYNOPSIS +.na +.nh +.B ttf2tfm +'in +\n(.ku +.IR ttffile [ .ttf | .ttc ] +[\c +.BI \-c \ \%caps-height-factor\c +] +[\c +.BI \-e \ \%extension-factor\c +] +[\c +.BI \-E \ \%encoding-id\^\c +] +[\c +.BI \-f \ \%font-index\c +] +[\c +.B \-l\c +] +[\c +.B \-L\ \c +.IR \%ligature-file [ .sfd ]\c +] +[\c +.B \-n\c +] +[\c +.B \-N\c +] +[\c +.B \-O\c +] +[\c +.B \-p\ \c +.IR \%inencfile [ .enc ]\c +] +[\c +.BI \-P \ \%platform-id\^\c +] +[\c +.B \-q\c +] +[\c +.BI \-r \ \%old-glyphname\ \%new-glyphname\c +] +[\c +.B \-R\ \c +.IR \%replacement-file [ .rpl ]\c +] +[\c +.BI \-s \ \%slant-factor\c +] +[\c +.B \-t\ \c +.IR \%outencfile [ .enc ]\c +] +[\c +.B \-T\ \c +.IR \%inoutencfile [ .enc ]\c +] +[\c +.B \-u\c +] +[\c +.B \-v\ \c +.IR \%vplfile [ .vpl ]\c +] +[\c +.B \-V\ \c +.IR \%scvplfile [ .vpl ]\c +] +[\c +.B \-w\c +] +[\c +.B \-x\c +] +[\c +.BI \-y \ \%vertical-shift-factor\c +] +[\c +.IR \%tfmfile [ .tfm ]\c +] +.br +.in +.B "ttf2tfm \-\^\-version" +| +.B \-\^\-help +.ad +.hy +. +. +. +.\" ==== +.\" ==== macro definitions +.\" ==== +. +.\" here we define \TeX for troff and nroff +.if t .ds TX T\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X +.if n .ds TX TeX +. +.\" and here the same for \LaTeX +.if t \{\ +.ie '\*(.T'dvi' \ +.ds LX L\h'-0.36m'\v'-0.15v'\s-3A\s0\h'-0.15m'\v'0.15v'\*(TX +.el .ds LX L\h'-0.36m'\v'-0.22v'\s-2A\s0\h'-0.15m'\v'0.22v'\*(TX +.\} +.if n .ds LX LaTeX +. +.\" \LaTeXe +.\" note that we need \vareps for TeX instead of \eps which can only be +.\" accessed with the \N escape sequence (in the Math Italic font) +.if t \{\ +.ie '\*(.T'dvi' .ds LE \*(LX\h'0.15m'2\v'0.20v'\f(MI\N'34'\fP\v'-0.20v' +.el .ds LE \*(LX\h'0.15m'2\v'0.20v'\(*e\v'-0.20v' +.\} +.if n .ds LE LaTeX\ 2e +. +.\" a typewriter font +.if t \{\ +.de C +\fC\\$1\fP\\$2\fC\\$3\fP\\$4 +.. +.\} +.if n \{\ +.de C +\\$1\\$2\\$3\\$4 +.. +.\} +. +.\" ==== +.\" ==== end of macro definitions +.\" ==== +. +. +. +.SH DESCRIPTION +This program extracts the metric and kerning information of a TrueType +font and converts it into metric files usable by \*(TX +(quite similar to +.B afm2tfm +which is part of the +.B dvips +package; please consult its info files for more details on the various +parameters (especially encoding files). +.PP +Since a TrueType font often contains more than 256\ glyphs, some means +are necessary to map a subset of the TrueType glyphs onto a \*(TX +font. +To do this, two mapping tables are needed: the first (called `input' or +`raw' encoding) maps the TrueType font to a raw \*(TX font (this mapping +table is used by both +.B ttf2tfm +and +.BR ttf2pk ), +and the second (called `output' or `virtual' encoding) maps the raw \*(TX +font to another (virtual) \*(TX +font, providing all kerning and ligature information needed by \*(TX. +.PP +This two stage mapping has the advantage that one raw font can be +accessed with various \*(LX +encodings (e.g.\ T1 and OT1) via the virtual font mechanism, and just +one +.C PK +file is necessary. +.PP +For CJKV (Chinese/Japanese/Korean/old Vietnamese) fonts, a different +mechanism is provided (see +.B "SUBFONT DEFINITION FILES" +below). +. +. +.SH PARAMETERS +Most of the command line switch names are the same as in +.B afm2tfm +for convenience. +One or more space characters between an option and its value is mandatory; +options can't be concatenated. +For historical reasons, the first parameter can +.I not +be a switch but must be the font name. +.TP +.BI \-c \ caps-height-factor +The height of small caps made with the +.B \-V +switch. +Default value of this real number is\ 0.8 times the height of uppercase +glyphs. +.IP +Will be ignored in subfont mode. +.TP +.BI \-e \ extension-factor +The extension factor to stretch the characters horizontally. +Default value of this real number is\ 1.0; if less than\ 1.0, you get a +condensed font. +.TP +.BI \-E \ encoding-id +The TrueType encoding ID. +Default value of this non-negative integer is\ 1. +.IP +Will be ignored if +.B \-N +is used. +.TP +.BI \-f \ font-index +The font index in a TrueType Collection. +Default is the first font (index\ 0). +[TrueType collections are usually found in some CJK fonts; e.g.\ the first +font index specifies glyphs and metrics for horizontal writing, and the +second font index does the same for vertical writing. +TrueType collections usually have the extension `\c +.C \&.ttc '.] +.IP +Will be ignored for ordinary TrueType fonts. +.TP +.B \-l +Create ligatures in subfonts between first and second bytes of all the +original character codes. +Example: Character code\ 0xABCD maps to character position\ 123 in +subfont\ 45. +Then a ligature in subfont\ 45 between position 0xAB and\ 0xCD pointing +to character\ 123 will be produced. +The fonts of the Korean H\*(LX +package use this feature. +Note that this option generates correct ligatures only for TrueType fonts +where the input cmap is identical to the output encoding. +In case of H\*(LX, TTFs must have platform ID\ 3 and encoding ID\ 5. +.IP +Will be ignored if not in subfont mode. +.TP +.BI \-L \ ligature-file +Same as +.BR \-l , +but character codes for ligatures are specified in +.IR \%ligature-file . +For example, `\c +.C \-L\ \%KS-HLaTeX ' +generates correct ligatures for the Korean H\*(LX +package regardless of the platform and encoding ID of the used TrueType +font (the file +.C KS-HLaTeX.sfd +is part of the ttf2pk package). +.IP +Ligature files have the same format and extension as +.C SFD +files. +This option will be ignored if not in subfont mode. +.TP +.B \-n +Use PS names (of glyphs) of the TrueType font. +Only glyphs with a valid entry in the selected cmap are used. +.IP +Will be ignored in subfont mode. +.TP +.B \-N +Use only PS names of the TrueType font. +No cmap is used, thus the switches +.B \-E +and +.B \-P +have no effect, causing a warning message. +.IP +Will be ignored in subfont mode. +.TP +.B \-O +Use octal values for all character codes in the +.C VPL +file rather than names; this is useful for symbol or CJK fonts where +character names such as `A' are meaningless. +.TP +.BI \-p \ inencfile +The input encoding file name for the TTF\(->raw\ \*(TX +mapping. +This parameter has to be specified in a map file +(default: +.C \%ttfonts.map ) +recorded in +.C \%ttf2pk.cfg +for successive +.B ttf2pk +calls. +.IP +Will be ignored in subfont mode. +.TP +.BI \-P \ platform-id +The TrueType platform ID. +Default value of this non-negative integer is\ 3. +.IP +Will be ignored if +.B \-N +is used. +.TP +.B \-q +Make +.B ttf2tfm +quiet. +It suppresses any informational output except warning and error +messages. +For CJK fonts, the output can get quite large if you don't specify +this switch. +.TP +.BI \-r \ old-glyphname\ new-glyphname +Replaces +.I \%old-glyphname +with +.IR \%new-glyphname . +This switch is useful if you want to give an unnamed glyph (i.e., a glyph +which can be represented with `.gXXX' or `.cXXX' only) a name or if you want +to rename an already existing glyph name. +You can't use the `.gXXX' or `.cXXX' glyph name constructs for +.IR \%new-glyphname ; +multiple occurrences of +.B \-r +are possible. +.IP +If in subfont mode or if no encoding file is specified, this switch is +ignored. +.TP +.BI \-R \ replacement-file +Use this switch if you have many replacement pairs; they can be collected +in a file which should have `\c +.C \&.rpl ' +as extension. +The syntax used in such replacement files is simple: Each non-empty +line must contain a pair `\c +.IR "\%old-glyphname \%new-glyphname" ' +separated by whitespace (without the quotation marks). +A percent sign starts a line comment; you can continue a line on the next +line with a backslash as the last character. +.IP +If in subfont mode or if no encoding file is specified, this switch is +ignored. +.TP +.BI \-s \ slant-factor +The obliqueness factor to slant the font, usually much smaller than\ 1. +Default of this real number is\ 0.0; if the value is larger than zero, +the characters slope to the right, otherwise to the left. +.TP +.BI \-t \ outencfile +The output encoding file name for the virtual font(s). +Only characters in the raw \*(TX +font are used. +.IP +Will be ignored in subfont mode. +.TP +.BI \-T \ inoutencfile +This is equivalent to +.RB ` \-p +.I inoutencfile +.B \-t +.IR inoutencfile '. +.IP +Will be ignored in subfont mode. +.TP +.B \-u +Use only those characters specified in the output encoding, and no +others. +By default, +.B ttf2tfm +tries to include all characters in the virtual font, even those not +present in the encoding for the virtual font (it puts them into +otherwise-unused positions, rather arbitrarily). +.IP +Will be ignored in subfont mode. +.TP +.BI \-v \ vplfile +Output a +.C VPL +file in addition to the +.C TFM +file. +If no output encoding file is specified, +.B ttf2tfm +uses a default font encoding (cmtt10). +.B Note: +Be careful to use different names for the virtual font and the raw font! +.IP +Will be ignored in subfont mode. +.TP +.BI \-V \ scvplfile +Same as +.BR \-v , +but the virtual font generated is a pseudo small caps font obtained by +scaling uppercase letters by\ 0.8 (resp. the value specified with +.BR \-c ) +to typeset lowercase. +This font handles accented letters and retains proper kerning. +.IP +Will be ignored in subfont mode. +.TP +.B \-w +Generate PostScript encoding vectors containing glyph indices, primarily +used to embed TrueType fonts in pdf\*(TX. +.B ttf2tfm +takes the +.C TFM +names and replaces the suffix with +.C \&.enc ; +that is, for files +.C foo01.tfm , +.C foo02.tfm ,\ \&.\|.\|.\& +it creates +.C foo01.enc , +.C foo02.enc ,\ \&.\|.\|.\|\& +at the same place. +.IP +Will be ignored if not in subfont mode. +.TP +.B \-x +Rotate all glyphs by 90 degrees counter-clockwise. +If no +.B \-y +parameter is given, the rotated glyphs are shifted down vertically +by\ 0.25em. +.IP +Will be ignored if not in subfont mode. +.TP +.BI \-y \ vertical-shift-factor +Shift down rotated glyphs by the given amount (the unit is +.IR em ). +.IP +Ignored if not in subfont mode or glyphs are not rotated. +.TP +.B \-\^\-version +Shows the current version of +.B ttf2tfm +and the used file search library (e.g. +.BR kpathsea ). +.TP +.B \-\^\-help +Shows usage information. +.PP +If no +.C TFM +file name is given, the name of the +.C TTF +file is used, including the full path and replacing the extension with `\c +.C \&.tfm '. +. +. +.SH CMAPS +Contrary to Type\ 1 PostScript fonts (but similar to the new CID +PostScript font format), most TrueType fonts have more than one native +mapping table, also called `cmap', which maps the (internal) TTF glyph +indices to the (external) TTF character codes. +Common examples are a mapping table to Unicode encoded character +positions, and the standard Macintosh mapping. + +To specify a TrueType mapping table, use the options +.B \-P +and +.BR \-E . +With +.B \-P +you specify the platform ID; defined values are: +.PP +.in +4m +.ta 3iC +.I "platform platform ID (pid)" +.sp +.ta 3iR +Apple Unicode 0 +.br +Macintosh 1 +.br +ISO 2 +.br +Microsoft 3 +.PP +The encoding ID depends on the platform. +For pid=0, we ignore the +.B \-E +parameter (setting it to zero) since the mapping table is always +Unicode version\ 2.0. +For pid=1, the following table lists the defined values: +.PP +.in +4m +.ta 3iC +.ti -2m +platform ID = 1 +.sp +.I "script encoding ID (eid)" +.sp +.ta 3iR +Roman 0 +.br +Japanese 1 +.br +Chinese 2 +.br +Korean 3 +.br +Arabic 4 +.br +Hebrew 5 +.br +Greek 6 +.br +Russian 7 +.br +Roman Symbol 8 +.br +Devanagari 9 +.br +Gurmukhi 10 +.br +Gujarati 11 +.br +Oriya 12 +.br +Bengali 13 +.br +Tamil 14 +.br +Telugu 15 +.br +Kannada 16 +.br +Malayalam 17 +.br +Sinhalese 18 +.br +Burmese 19 +.br +Khmer 20 +.br +Thai 21 +.br +Laotian 22 +.br +Georgian 23 +.br +Armenian 24 +.br +Maldivian 25 +.br +Tibetan 26 +.br +Mongolian 27 +.br +Geez 28 +.br +Slavic 29 +.br +Vietnamese 30 +.br +Sindhi 31 +.br +Uninterpreted 32 +.PP +Here are the ISO encoding IDs: +.PP +.in +4m +.ta 3iC +.ti -2m +platform ID = 2 +.sp +.I "encoding encoding ID (eid)" +.sp +.ta 3iR +ASCII 0 +.br +ISO 10646 1 +.br +ISO 8859-1 2 +.PP +And finally, the Microsoft encoding IDs: +.PP +.in +4m +.ta 3iC +.ti -2m +platform ID = 3 +.sp +.I "encoding encoding ID (eid)" +.sp +.ta 3iR +Symbol 0 +.br +Unicode 2.0 1 +.br +Shift JIS 2 +.br +GB 2312 (1980) 3 +.br +Big 5 4 +.br +KS X 1001 (Wansung) 5 +.br +KS X 1001 (Johab) 6 +.br +UCS-4 10 +.PP +The program will abort if you specify an invalid platform/encoding ID +pair. +It will then show the possible pid/eid pairs. +Please note that most fonts have at most two or three cmaps, usually +corresponding to the pid/eid pairs (1,0), (3,0), or (3,1) in case of +Latin based fonts. +Valid Microsoft fonts should have a (3,1) mapping table, but some +fonts exist (mostly Asian fonts) which have a (3,1) cmap not encoded +in Unicode. +The reason for this strange behavior is the fact that some old +MS\ Windows versions will reject fonts having a non-(3,1) cmap (since +all non-Unicode Microsoft encoding IDs are for Asian MS\ Windows +versions). +.PP +The +.B \-P +and +.B \-E +options of +.B ttf2tfm +must be equally specified for +.BR ttf2pk ; +the corresponding parameters in a map file are `Pid' and `Eid', +respectively. +.PP +The default pid/eid pair is (3,1). +.PP +Similarly, an +.B \-f +option must be specified as `Fontindex' parameter in a map file. +.PP +If you use the +.B \-N +switch, all cmaps are ignored, using only the PostScript names in the +TrueType font. +The corresponding option in a map file is \%`PS=Only'. +If you use the +.B \-n +switch, the default glyph names built into +.B ttf2tfm +are replaced with the PS glyph names found in the font. +In many cases this is not what you want because the glyph names in the +font are often incorrect or non-standard. +The corresponding option in a map file is \%`PS=Yes'. +.PP +Single replacement glyph names specified with +.B \-r +must be given directly as `\c +.IR "old-glyphname new-glyphname" ' +in a map file; +.B \-R +is equivalent to the `Replacement' option. +. +. +.SH INPUT AND OUTPUT ENCODINGS +You must specify the encoding vectors from the TrueType font to the +raw \*(TX +font and from the raw \*(TX +font to the virtual \*(TX +font exactly as with +.BR afm2tfm , +but you have more possibilities to address the character codes. +[With `encoding vector' a mapping table with 256\ entries in form of a +PostScript vector is meant; see the file +.C \%T1-WGL4.enc +of this package for an example.] +With +.BR afm2tfm , +you must access each glyph with its Adobe glyph name, e.g.\ \c +\%`/quotedsingle' or \%`/Acircumflex'. +This has been extended with +.BR ttf2tfm ; +now you can (and sometimes must) access the code points and/or glyphs +directly, using the following syntax for specifying the character position +in decimal, octal, or hexadecimal notation: +`/.c\c +.IR <decimal-number> ', +`/.c0\c +.IR <octal-number> ', +or `/.c0x\c +.IR <hexadecimal-number> '. +Examples: \%`/.c72', \%`/.c0646', \%`/.c0x48'. +To access a glyph index directly, use the character `g' instead of `c' in +the just introduced notation. +Example: \%`/.g0x32'. +[Note: The `.cXXX' notation makes no sense if +.B \-N +is used.] +.PP +For pid/eid pairs (1,0) and (3,1), both +.B ttf2tfm +and +.B ttf2pk +recognize built-in default Adobe glyph names; the former follows the names +given in Appendix\ E of the book `Inside Macintosh', volume\ 6, the latter +uses the names given in the TrueType Specification (WGL4, a Unicode subset). +Note that Adobe names for a given glyph are often not unique and do +sometimes differ, e.g., many PS fonts have the glyph `mu', whereas this +glyph is called `mu1' in the WGL4 character set to distinguish it from the +real Greek letter mu. +Be also aware that OpenType (i.e. TrueType\ 2.0) fonts use an updated WGL4 +table; we use the data from the latest published TrueType specification +(1.66). +You can find those mapping tables in the source code file +.C \%ttfenc.c . +.PP +On the other hand, the switches +.B \-n +and +.B \-N +makes +.B ttf2tfm +read in and use the PostScript names in the TrueType font itself (stored +in the `post' table) instead of the default Adobe glyph names. +.PP +Use the +.B \-r +switch to remap single glyph names and +.B \-R +to specify a file containing replacement glyph name pairs. +.PP +If you don't select an input encoding, the first 256\ glyphs of the +TrueType font with a valid entry in the selected cmap will be mapped +to the \*(TX +raw font (without the +.B \-q +option, +.B ttf2tfm +prints this mapping table to standard output), followed by all glyphs +not yet addressed in the selected cmap. +However, some code points for the (1,0) pid/eid pair are omitted since +they do not represent glyphs useful for \*(TX: +0x00 (null), 0x08 (backspace), 0x09 (horizontal tabulation), 0x0d +(carriage return), and 0x1d (group separator). +The `invalid character' with glyph index\ 0 will be omitted too. +.PP +If you select the +.B \-N +switch, the first 256\ glyphs of the TrueType font with a valid PostScript +name will be used in case no input encoding is specified. +Again, some glyphs are omitted: `.notdef', `.null', and +`nonmarkingreturn'. +.PP +If you don't select an output encoding, +.B ttf2tfm +uses the same mapping table as +.B afm2tfm +would use (you can find it in the source code file +.C \%texenc.c ); +it corresponds to \*(TX +typewriter text. +Unused positions (either caused by empty code points in the mapping +table or missing glyphs in the TrueType font) will be filled (rather +arbitrarily) with characters present in the input encoding but not +specified in the output encoding (without the +.B \-q +option +.B ttf2tfm +prints the final output encoding to standard output). +Use the +.B \-u +option if you want only glyphs in the virtual font which are defined +in the output encoding file, and nothing more. +.PP +One feature missing in +.B afm2tfm +has been added which is needed by \*(LX's T1 encoding: +.B ttf2tfm +will construct the glyph `Germandbls' (by simply concatenating two `S' +glyphs) even for normal fonts if possible. +It appears in the glyph list as the last item, marked with an asterisk. +Since this isn't a real glyph it will be available only in the virtual +font. +.PP +For both input and output encoding, an empty code position is +represented by the glyph name \%`/.notdef'. +.PP +In encoding files, you can use `\\' as the final character of a line to +indicate that the input is continued on the next line. +The backslash and the following newline character will be removed. +.PP +. +. +.SH SUBFONT DEFINITION FILES +CJKV (Chinese/Japanese/Korean/old Vietnamese) fonts usually contain +several thousand glyphs; to use them with \*(TX +it is necessary to split such large fonts into subfonts. +Subfont definition files (usually having the extension `\c +.C \&.sfd ') +are a simple means to do this smoothly. +.PP +A subfont file name usually consists of a prefix, a subfont infix, and +a postfix (which is empty in most cases), e.g. +.PP +.in +2m +ntukai23 \(-> prefix: ntukai, infix: 23, postfix: (empty) +.PP +Here the syntax of a line in an +.C SFD +file, describing one subfont: +.in +2m +.TP +.I <whitespace> <infix> <whitespace> <ranges> <whitespace> +.sp +.TP +.IR <infix> \ := +anything except whitespace. +It is best to use only alphanumerical characters. +.TP +.IR <whitespace> \ := +space, formfeed, carriage return, horizontal and vertical tabs -- no +newline characters. +.TP +.IR <ranges> \ := +.IR "<ranges> <whitespace> <codepoint>" \ | +.br +.IR "<ranges> <whitespace> <range>" \ | +.br +.I <ranges> <whitespace> <offset> <whitespace> <range> +.TP +.IR <codepoint> \ := +.I <number> +.br +.TP +.IR <range> \ := +.IR <number> \ `_' \ <number> +.br +.TP +.IR <offset> \ := +.IR <number> \ `:' +.TP +.IR <number> \ := +hexadecimal (prefix `0x'), decimal, or octal (prefix `0') +.PP +A line can be continued on the next line with a backslash ending the line. +The ranges must not overlap; offsets have to be in the range 0-255. +.PP +Example: +.PP +.in +2m +The line +.PP +.in +4m +.C "03 10: 0x2349 0x2345_0x2347" +.PP +.in +2m +assigns to the code positions 10, 11, 12, and\ 13 of the subfont +having the infix `03' the character codes 0x2349, 0x2345, 0x2346, and +0x2347 respectively. +.PP +The +.C SFD +files in the distribution are customized for the CJK package for +\*(LX. +.PP +You have to embed the +.C SFD +file name into the +.C TFM +font name (at the place where the infix will appear) surrounded by two +`@' signs, on the command line resp.\ a map file; +both +.B ttf2tfm +and +.B ttf2pk +switch then to subfont mode. +.PP +It is possible to use more than a single +.C SFD +file by separating them with commata and no whitespace; for a given +subfont, the first file is scanned for an entry, then the next file, +and so on. +Later entries override entries found earlier (possibly only partially). +For example, the first +.C SFD +file sets up range 0x10-0xA0, and the next one modifies entries +0x12 and 0x25. +As can be easily seen, this algorithm allows for adding and replacing, +but not for removing entries. +.PP +Subfont mode disables the options +.BR \-n , +.BR \-N , +.BR \-p , +.BR \-r , +.BR \-R , +.BR \-t , +.BR \-T , +.BR \-u , +.BR \-v , +.BR \-V +and +.B \-w +for +.BR ttf2tfm ; +similarly, no `Encoding' or `Replacement' parameter is allowed in +a map file. +Single replacement glyph names are ignored too. +.PP +.B ttf2tfm +will create all subfont +.C TFM +files specified in the +.C SFD +files (provided the subfont contains glyphs) in one run. +.PP +Example: +.PP +.in +2m +The call +.PP +.in +4m +.C "ttf2tfm ntukai.ttf ntukai@Big5,Big5-supp@" +.PP +.in +2m +will use +.C Big5.sfd +and +.C Big5-supp.sfd , +producing +.I all +subfont files +.C ntukai01.tfm , +.C ntukai02.tfm , +etc. +. +. +.SH "RETURN VALUE" +ttf2tfm returns 0 on success and 1 on error; warning and error +messages are written to standard error. +. +. +.SH "SOME NOTES ON FILE SEARCHING" +Both +.B ttf2pk +and +.B ttf2tfm +use either the +.BR kpathsea , +.BR emtexdir , +or +.B MiK\*(TX +library for searching files +.RB ( emtexdir +will work only on operating systems which have an MS-DOSish background, i.e. +MS-DOS, OS/2, Windows; +.B Mik\*(TX +is specific to MS Windows). +.PP +As a last resort, both programs can be compiled without a search library; +the searched files must be then in the current directory or specified with a +path. +Default extensions will be appended also (with the exception that only `\c +.C \&.ttf ' +is appended and not `\c +.C \&.ttc '). +. +. +.SS kpathsea +Please note that older versions of +.B kpathsea +(<3.2) have no special means to seach for TrueType fonts and related +files, thus we use the paths for PostScript related stuff. +The actual version of kpathsea is displayed on screen if you call +either +.B ttf2pk +or +.B ttf2tfm +with the +.B \-\^\-version +command line switch. +.PP +Here is a table of the file type and the corresponding +.B kpathsea +variables. +.C TTF2PKINPUTS +and +.C TTF2TFMINPUTS +are program specific environment variables introduced in +.B kpathsea +version\ 3.2: +.PP +.in +4m +.ta 2i +.C \&.ttf \ and "\ .ttc TTFONTS" +.br +.C "ttf2pk.cfg TTF2PKINPUTS" +.br +.C "\&.map TTF2PKINPUTS" +.br +.C "\&.enc TTF2PKINPUTS, TTF2TFMINPUTS" +.br +.C "\&.rpl TTF2PKINPUTS, TTF2TFMINPUTS" +.br +.C "\&.tfm TFMFONTS" +.br +.C "\&.sfd TTF2PKINPUTS, TTF2TFMINPUTS" +.PP +And here the same for pre-3.2-versions of +.B kpathsea: +.PP +.in +4m +.ta 2i +.C \&.ttf \ and "\ .ttc T1FONTS" +.br +.C "ttf2pk.cfg TEXCONFIG" +.br +.C "\&.map TEXCONFIG" +.br +.C "\&.enc TEXPSHEADERS" +.br +.C "\&.rpl TEXPSHEADERS" +.br +.C "\&.tfm TFMFONTS" +.br +.C "\&.sfd TEXPSHEADERS" +.PP +Finally, the same for pre-3.0-versions (as used e.g. in te\*(TX\ 0.4): +.PP +.in +4m +.ta 2i +.C \&.ttf \ and "\ .ttc DVIPSHEADERS" +.br +.C "ttf2pk.cfg TEXCONFIG" +.br +.C "\&.map TEXCONFIG" +.br +.C "\&.enc DVIPSHEADERS" +.br +.C "\&.rpl DVIPSHEADERS" +.br +.C "\&.tfm TFMFONTS" +.br +.C "\&.sfd DVIPSHEADERS" +.PP +Please consult the info files of +.B kpathsea +for details on these variables. +The decision whether to use the old or the new scheme will be done +during compilation. +.PP +You should set the +.C TEXMFCNF +variable to the directory where your +.C texmf.cnf +configuration file resides. +.PP +Here is the proper command to find out to which value a +.B kpathsea +variable is set (we use +.C TTFONTS +as an example). +This is especially useful if a variable isn't set in +.C texmf.cnf +or in the environment, thus pointing to the default value which is +hard-coded into the +.B kpathsea +library. +.PP +.in +2m +.C "kpsewhich -progname=ttf2tfm -expand-var='$TTFONTS'" +.PP +We select the program name also since it is possible to specify +variables which are searched only for a certain program -- in our +example it would be +.C TTFONTS.ttf2tfm . +.PP +A similar but not identical method is to say +.PP +.in +2m +.C "kpsewhich -progname=ttf2tfm -show-path='truetype fonts'" +.PP +[A full list of format types can be obtained by saying `\c +.C "kpsewhich --help" ' +on the command line prompt.] +This is exactly how +.B ttf2tfm +(and +.BR ttf2pk ) +searches for files; the disadvantage is that all variables are expanded +which can cause very long strings. +. +. +.SS emtexdir +Here the list of suffixes and their related environment variables to be +set in +.C autoexec.bat +(resp. in +.C config.sys +for OS/2): +.PP +.in +4m +.ta 2i +.C \&.ttf \ and "\ .ttc TTFONTS" +.br +.C "ttf2pk.cfg TTFCFG" +.br +.C "\&.map TTFCFG" +.br +.C "\&.enc TTFCFG" +.br +.C "\&.rpl TTFCFG" +.br +.C "\&.tfm TEXTFM" +.br +.C "\&.sfd TTFCFG" +.PP +If one of the variables isn't set, a warning message is emitted. +The current directory will always be searched. +As usual, one exclamation mark appended to a directory path causes +subdirectories one level deep to be searched, two exclamation marks cause +all subdirectories to be searched. +Example: +.PP +.in +2m +.C TTFONTS=c:\\\\fonts\\\\truetype!!;d:\\\\myfonts\\\\truetype! +.PP +Constructions like `\c +.C c:\\\\fonts!!\\\\truetype ' +aren't possible. +. +. +.SS MiK\*(TX +Both +.B ttf2tfm +and +.B ttf2pk +have been fully integrated into +.BR MiK\*(TX . +Please refer to the documentation of +.B MiK\*(TX +for more details on file searching. +. +. +.SH PROBLEMS +Many +.B vptovf +implementations allow only 100\ bytes for the +.C TFM +header (the limit is 1024 in the +.C TFM +file format itself): 8\ bytes for checksum and design size, 40\ bytes for the +family name, 20\ bytes for the encoding, and 4\ bytes for a face byte. +There remain only 28\ bytes for some additional information which is used by +.B ttf2tfm +for an identification string (which is essentially a copy of the command +line), and this limit is always exceeded. + +The optimal solution is to increase the value of +.I \%max_header_bytes +in the file +.C vptovf.web +(and probably +.C pltotf.web +too) to, say,\ 400 +and recompile +.B vptovf +(and +.BR pltotf ). +Otherwise you'll get some (harmless) error messages like +.PP +.in +2m +.C "This HEADER index is too big for my present table size" +.PP +which can be safely ignored. +. +. +.SH "SEE ALSO" +.BR ttf2pk (1), +.BR afm2tfm (1), +.BR vptovf (1), +.br +the info pages for +.B dvips +and +.B kpathsea +. +. +.SH AVAILABILITY +.B ttf2tfm +is part of the FreeType\ 1 package, a high quality TrueType rendering +library. +. +. +.SH AUTHORS +Werner LEMBERG +.C <wl@gnu.org> +.br +Fr\('ed\('eric LOYER +.C <loyer@ensta.fr> diff --git a/Master/texmf-dist/doc/man/man1/ttf2tfm.man1.pdf b/Master/texmf-dist/doc/man/man1/ttf2tfm.man1.pdf Binary files differnew file mode 100644 index 00000000000..63b2716fef4 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ttf2tfm.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/ttfdump.1 b/Master/texmf-dist/doc/man/man1/ttfdump.1 new file mode 100644 index 00000000000..f0d5e4cd4d8 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ttfdump.1 @@ -0,0 +1,143 @@ +.TH TTFDUMP 1 "14 November 2011" "ILX Project" +.SH NAME +ttfdump \- Dumping the contents of a TrueType Font file +.SH SYNOPSIS +.B ttfdump +.RB [ \-h ] +.RB [ \-t +.IR tablename ] +.RB [ \-g +.IR glyphnumber ] +.RB [ \-c +.IR collection ] +.RB [ \-o +.IR dumpfile ] +.RB [ \-i ] +.I ttfile +.SH DESCRIPTION +\fBttfdump\fP dumps the contents of a TrueType font file in ASCII form. +A TrueType font file is consist of various tables. Those table are divided into +two categories - \fIRequired Tables\fP and \fIOptional Tables\fP. Mulitiple +TrueType fonts can be merged to a TrueType Collection. +.SS Options +.TP +\fB-h\fP +Print a help message on standard output and exit. +.TP +\fB-t\fI tablename\fR +If this option is specified then dump the table \fI"tablename"\fP, otherwise +dump every tables in \fIttfile\fP. +\fITablename\fP can be one of the following: +.RS +.TP +\fBRequired Tables\fR +.TP +\fIcmap\fP +character to glyph mapping table +.TP +\fIglyf\fP +glyph data +.TP +\fIhead\fP +font header +.TP +\fIhhea\fP +horizontal header +.TP +\fIhmtx\fP +horizontal metrics +.TP +\fIloca\fP +index to location +.TP +\fImaxp\fP +maximum profile +.TP +\fIname\fP +naming table +.TP +\fIpost\fP +PostScript information +.TP +\fIOS/2\fP +OS/2 and windows specific metrics +.TP +\fBOptional Tables\fR +.TP +\fIcvt\fP +control value table +.TP +\fIfpgm\fP +font program; \fInot implemented yet.\fP +.TP +\fIgasp\fP +grid-fitting and scan conversion procedure (grayscale) +.TP +\fIhdmx\fP +horizontal device metrics +.TP +\fIkern\fP +kerning table +.TP +\fILTSH\fP +Linear threshold table +.TP +\fIprep\fP +CVT program; \fInot implemented yet\fP +.TP +\fIPCLT\fP +PCL5 table +.TP +\fIVDMX\fP +Vertical Device Metrics table +.TP +\fIvhea\fP +vertical metrics header +.TP +\fIvmtx\fP +vertical metrics +.TP +\fBAdditional OpenType Tables\fR +.TP +\fIGPOS\fP +glyph positioning table +.TP +\fIGSUB\fP +glyph substitution table +.RE +.TP +\fB-g\fI glyphnumber\fR +If this option is specified then dump the glyph with index \fIglyphnumber\fP, +otherwise dump all glyphs in \fIttfile\fP. +.TP +\fB-c\fI collection\fR +Select a TrueType font in a TrueType Collection. +.TP +\fB-o\fI dumpfile\fR +Output of the dump. If this option is not specified, dump to stdout. +.TP +\fB-i\fI ttfile\fR +TrueType font file to be dumped. +.RE +.SH EXAMPLE +To dump all information in the TrueType font file times.ttf: +.RS +ttfdump times.ttf +.RE + +To dump the required table \fIcmap\fP in the file: +.RS +ttfdump -t cmap times.ttf +.RE + +To dump a single glyph with index 50: +.RS +ttfdump -g 50 times.ttf +.RE + +.SH SEE ALSO +TrueType 1.0 Font Files, \fI Technical Specification Revision 1.66 November 1995\fR +.SH NOTE +Instruction disassembler in not implemented. +.SH AUTHOR +Li-Da Lho, ollie@ms1.hinet.net diff --git a/Master/texmf-dist/doc/man/man1/ttfdump.man1.pdf b/Master/texmf-dist/doc/man/man1/ttfdump.man1.pdf Binary files differnew file mode 100644 index 00000000000..698572a1ffd --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ttfdump.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/ttftotype42.1 b/Master/texmf-dist/doc/man/man1/ttftotype42.1 new file mode 100644 index 00000000000..9a63e69ac09 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ttftotype42.1 @@ -0,0 +1,78 @@ +.ds V 2.92 +.de M +.BR "\\$1" "(\\$2)\\$3" +.. +.de Sp +.if n .sp +.if t .sp 0.4 +.. +.TH TTFTOTYPE42 1 "LCDF Typetools" "Version \*V" +.SH NAME +ttftotype42 \- create PostScript Type 42 wrapper of TrueType font +.SH SYNOPSIS +.B ttftotype42 +\%[\fIinput\fR [\fIoutput\fR]] +.SH DESCRIPTION +.BR Ttftotype42 +converts TrueType or TrueType-flavored OpenType font programs into +PostScript Type 42 format, which is a wrapper for the TrueType outlines. +This conversion preserves all outlines and hint information from the +original TrueType font. The Type 42 wrapper uses glyph names identical to +those expected by +.M pdflatex 1 +or +.M otftotfm 1 , +so encoding files suitable for TrueType fonts and +.B pdflatex +will also work for the Type 42 fonts and +.M dvips 1 . +If the file +.I output +is not specified output goes to the standard output. +If the file +.I input +is not specified input comes from the standard input. +' +.SH OPTIONS +.PD 0 +.TP 5 +.BI \-o " file\fR, " \-\-output " file" +Write output font to +.IR file +instead of the standard output. +' +.Sp +.TP 5 +.BR \-q ", " \-\-quiet +Do not generate any error messages. +' +.Sp +.TP 5 +.BR \-h ", " \-\-help +Print usage information and exit. +' +.Sp +.TP 5 +.BR \-v ", " \-\-version +Print the version number and some short non-warranty information and exit. +.PD +' +.SH "SEE ALSO" +.LP +.M cfftot1 1 , +.M otftotfm 1 , +.M pdftex 1 , +.M dvips 1 +.LP +Adobe Technical Note #5012, +.IR "The Type 42 Font Format Specification" +.LP +.IR "OpenType Specification" , +Version 1.4 +' +.SH AUTHOR +Eddie Kohler (ekohler@gmail.com) +.PP +The latest version is available from: +.br +http://www.lcdf.org/type/ diff --git a/Master/texmf-dist/doc/man/man1/ttftotype42.man1.pdf b/Master/texmf-dist/doc/man/man1/ttftotype42.man1.pdf Binary files differnew file mode 100644 index 00000000000..7a096fdc0e0 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/ttftotype42.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/updmap-sys.1 b/Master/texmf-dist/doc/man/man1/updmap-sys.1 new file mode 100644 index 00000000000..07038dda3c4 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/updmap-sys.1 @@ -0,0 +1 @@ +.so man1/updmap.1 diff --git a/Master/texmf-dist/doc/man/man1/updmap-sys.man1.pdf b/Master/texmf-dist/doc/man/man1/updmap-sys.man1.pdf Binary files differnew file mode 100644 index 00000000000..fb87dbd51c6 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/updmap-sys.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/updmap.1 b/Master/texmf-dist/doc/man/man1/updmap.1 new file mode 100644 index 00000000000..41b80248ec3 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/updmap.1 @@ -0,0 +1,360 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.10. +.TH UPDMAP "1" "June 2012" "TeX Live" "User Commands" +.SH NAME +updmap \- manage TeX font maps, per-user +.br +updmap-sys \- manage TeX font maps, system-wide +.SH SYNOPSIS +.B updmap +[\fIOPTION\fR] ... [\fICOMMAND\fR] +.br +.B updmap-sys +[\fIOPTION\fR] ... [\fICOMMAND\fR] +.SH DESCRIPTION +updmap (TeX Live, multi) version $Id: updmap.pl 26891 2012\-06\-10 22:41:49Z karl $ +.PP +Update the default font map files used by pdftex, dvips, and dvipdfm(x), +and optionally pxdvi, as determined by all configuration files updmap.cfg +(the ones returned by running "kpsewhich \fB\-\-all\fR updmap.cfg", but see below). +.PP +Among other things, these map files are used to determine which fonts +should be used as bitmaps and which as outlines, and to determine which +font files are included in the PDF or PostScript output. +.PP +By default, the TeX filename database (ls\-R) is also updated. +.SH OPTIONS +.TP +\fB\-\-cnffile\fR FILE +read FILE for the updmap configuration +(can be given multiple times, in which case +all the files are used) +.TP +\fB\-\-dvipdfmxoutputdir\fR DIR +specify output directory (dvipdfm(x) syntax) +.TP +\fB\-\-dvipsoutputdir\fR DIR +specify output directory (dvips syntax) +.TP +\fB\-\-pdftexoutputdir\fR DIR +specify output directory (pdftex syntax) +.TP +\fB\-\-pxdvioutputdir\fR DIR +specify output directory (pxdvi syntax) +.TP +\fB\-\-outputdir\fR DIR +specify output directory (for all files) +.TP +\fB\-\-copy\fR +cp generic files rather than using symlinks +.TP +\fB\-\-force\fR +recreate files even if config hasn't changed +.TP +\fB\-\-nomkmap\fR +do not recreate map files +.TP +\fB\-\-nohash\fR +do not run texhash +.TP +\fB\-n\fR, \fB\-\-dry\-run\fR +only show the configuration, no output +.TP +\fB\-\-quiet\fR, \fB\-\-silent\fR +reduce verbosity +.SS "Commands:" +.TP +\fB\-\-help\fR +show this message and exit +.TP +\fB\-\-version\fR +show version information and exit +.TP +\fB\-\-showoption\fR OPTION +show the current setting of OPTION +.TP +\fB\-\-showoptions\fR OPTION +show possible settings for OPTION +.TP +\fB\-\-setoption\fR OPTION VALUE +set OPTION to value; option names below +.TP +\fB\-\-setoption\fR OPTION=VALUE +as above, just different syntax +.TP +\fB\-\-enable\fR MAPTYPE MAPFILE +add "MAPTYPE MAPFILE" to updmap.cfg, +where MAPTYPE is Map, MixedMap, or KanjiMap +.TP +\fB\-\-enable\fR Map=MAPFILE +add "Map MAPFILE" to updmap.cfg +.HP +\fB\-\-enable\fR MixedMap=MAPFILE add "MixedMap MAPFILE" to updmap.cfg +.HP +\fB\-\-enable\fR KanjiMap=MAPFILE add "KanjiMap MAPFILE" to updmap.cfg +.TP +\fB\-\-disable\fR MAPFILE +disable MAPFILE, of whatever type +.TP +\fB\-\-listmaps\fR +list all active and inactive maps +.TP +\fB\-\-listavailablemaps\fR +same as \fB\-\-listmaps\fR, but without +unavailable map files +.TP +\fB\-\-syncwithtrees\fR +disable unavailable map files in updmap.cfg +.PP +Explanation of the map types: the (only) difference between Map and +MixedMap is that MixedMap entries are not added to psfonts_pk.map. +The purpose is to help users with devices that render Type 1 outline +fonts worse than mode\-tuned Type 1 bitmap fonts. So, MixedMap is used +for fonts that are available as both Type 1 and Metafont. +KanjiMap entries are added to psfonts_t1.map and kanjix.map. +.PP +Explanation of the OPTION names for \fB\-\-showoptions\fR, \fB\-\-showoptions\fR, \fB\-\-setoption\fR: +.TP +dvipsPreferOutline +true|false (default true) +.IP +Whether dvips uses bitmaps or outlines, when both are available. +.TP +dvipsDownloadBase35 +true|false (default true) +.IP +Whether dvips includes the standard 35 PostScript fonts in its output. +.TP +pdftexDownloadBase14 +true|false (default true) +.IP +Whether pdftex includes the standard 14 PDF fonts in its output. +.TP +pxdviUse +true|false (default false) +.IP +Whether maps for pxdvi (Japanese\-patched xdvi) are under updmap's control. +.TP +kanjiEmbed +(any string) +.TP +kanjiVariant +(any string) +.IP +See below. +.TP +LW35 +URWkb|URW|ADOBEkb|ADOBE (default URWkb) +.IP +Adapt the font and file names of the standard 35 PostScript fonts. +URWkb URW fonts with "berry" filenames (e.g. uhvbo8ac.pfb) +URW URW fonts with "vendor" filenames (e.g. n019064l.pfb) +ADOBEkb Adobe fonts with "berry" filenames (e.g. phvbo8an.pfb) +ADOBE Adobe fonts with "vendor" filenames (e.g. hvnbo___.pfb) +.IP +These options are only read and acted on by updmap; dvips, pdftex, etc., +do not know anything about them. They work by changing the default map +file which the programs read, so they can be overridden by specifying +command\-line options or configuration files to the programs, as +explained at the beginning of updmap.cfg. +.IP +The options kanjiEmbed and kanjiVariant specify special replacements +in the map lines. If a map contains the string @kanjiEmbed@, then +this will be replaced by the value of that option; similarly for +kanjiVariant. In this way, users of Japanese TeX can select different +fonts to be included in the final output. +.SH ENVIRONMENT +.PP +Explanation of trees and files normally used: +.IP +If \fB\-\-cnffile\fR is specified on the command line (possibly multiple +times), its value(s) are used. Otherwise, updmap reads all the +updmap.cfg files found by running `kpsewhich \fB\-all\fR updmap.cfg', in the +order returned by kpsewhich, with one exception: an updmap.cfg found +in TEXMFLOCAL is given higher priority than the updmap.cfg in +TEXMFMAIN, to ensure that local adjustments by administrators take +precedence over what is shipped in TeX Live. +.IP +In any case, if multiple updmap.cfg files are found, all the maps +mentioned in all the updmap.cfg files are merged. +.IP +Thus, if updmap.cfg files are present in all trees, and the default +layout is used as shipped with TeX Live, the following files are +read, in the given order. +.nf +.IP +For updmap\-sys: +TEXMFSYSCONFIG $TEXLIVE/YYYY/texmf\-config/web2c/updmap.cfg +TEXMFSYSVAR $TEXLIVE/YYYY/texmf\-var/web2c/updmap.cfg +TEXMFLOCAL $TEXLIVE/texmf\-local/web2c/updmap.cfg +TEXMFMAIN $TEXLIVE/YYYY/texmf/web2c/updmap.cfg +TEXMFDIST $TEXLIVE/YYYY/texmf\-dist/web2c/updmap.cfg +.IP +For updmap: +TEXMFCONFIG $HOME/.texliveYYYY/texmf\-config/web2c/updmap.cfg +TEXMFVAR $HOME/.texliveYYYY/texmf\-var/web2c/updmap.cfg +TEXMFHOME $HOME/texmf/web2c/updmap.cfg +TEXMFSYSCONFIG $TEXLIVE/YYYY/texmf\-config/web2c/updmap.cfg +TEXMFSYSVAR $TEXLIVE/YYYY/texmf\-var/web2c/updmap.cfg +TEXMFLOCAL $TEXLIVE/texmf\-local/web2c/updmap.cfg +TEXMFMAIN $TEXLIVE/YYYY/texmf/web2c/updmap.cfg +TEXMFDIST $TEXLIVE/YYYY/texmf\-dist/web2c/updmap.cfg +.IP +(where YYYY is the TeX Live release version). +.fi +.IP +There is another exception to keep upgradability from earlier versions +of TeX Live: if a file TEXMFLOCAL/web2c/updmap\-local.cfg exists +(formerly used by tlmgr to merge local fonts), then the file +TEXMFLOCAL/web2c/updmap.cfg is ignored (if it exists) and that +updmap\-local.cfg is used instead. In this case, updmap recognizes the +previous syntax for disabling map files in updmap\-local.cfg (this +syntax is different from what is used now). +.IP +According to the actions, updmap might write to one of the given files +or create a new updmap.cfg, described further below. +.IP +Where changes are saved: if config files are given on the command +line, then the first one given will be used to save any changes from +\fB\-\-setoption\fR, \fB\-\-enable\fR or \fB\-\-disable\fR. If the config files are taken +from kpsewhich output, then the algorithm is more complex: +.IP +1) If $TEXMFCONFIG/web2c/updmap.cfg or $TEXMFHOME/web2c/updmap.cfg +appears in the list of used files, then the one listed first by +kpsewhich \fB\-\-all\fR (equivalently, the one returned by kpsewhich +updmap.cfg), is used. +.IP +2) If neither of the above two are present and changes are made, a +new config file is created in $TEXMFCONFIG/web2c/updmap.cfg. +.IP +Resolving multiple definitions of a font: +.IP +If a font is defined in more than one map file, then the definition +coming from the first\-listed updmap.cfg is used. If a font is +defined multiple times within the same map file, one is chosen +arbitrarily. In both cases a warning is issued. +.IP +Disabling maps: +.IP +updmap.cfg files with higher priority (listed earlier) can disable +maps mentioned in lower priority (listed later) updmap.cfg files by +writing, e.g., +.IP +#! Map mapname.map +.IP +or +.IP +#! MixedMap mapname.map +.IP +in the higher\-priority updmap.cfg file. +.IP +As an example, suppose you have a copy of MathTime Pro fonts +and want to disable the Belleek version of the fonts; that is, +disable the map belleek.map. You can create the file +$TEXMFCONFIG/web2c/updmap.cfg with the content +.IP +#! Map belleek.map +Map mt\-plus.map +Map mt\-yy.map +.IP +and call updmap. +.IP +updmap writes the map files for dvips (psfonts.map) and pdftex +(pdftex.map) to the TEXMFVAR/fonts/map/updmap/{dvips,pdftex}/ +directories. +.IP +The log file is written to TEXMFVAR/web2c/updmap.log. +.IP +When updmap\-sys is run, TEXMFSYSCONFIG and TEXMFSYSVAR are used +instead of TEXMFCONFIG and TEXMFVAR, respectively. This is the only +difference between updmap\-sys and updmap. +.IP +Other locations may be used if you give them on the command line, or +these trees don't exist, or you are not using the original TeX Live. +.IP +To see the precise locations of the various files that +will be read and written, give the \fB\-n\fR option (or read the source). +.SH EXAMPLES +.PP +For step\-by\-step instructions on making new fonts known to TeX, read +http://tug.org/fonts/fontinstall.html. For even more terse +instructions, read the beginning of updmap.cfg. +.SH FILES +Configuration and input files: +.IP "\fIupdmap\&.cfg\fP" +Main configuration file\&. In +\fItexmf/web2c\fP by default, but may be located elsewhere +depending on your distribution\&. Each texmf tree read should have its +own \fIupdmap.cfg\fP. +.IP "\fIdvips35\&.map\fP" +Map file for standard 35 PostScript fonts for +use with \fBdvips\fP(1)\&. +.IP "\fIpdftex35\&.map\fP" +Map file for standard 35 PostScript fonts for +use with \fBpdftex\fP(1)\&. +.IP "\fIps2pk35\&.map\fP" +Map file for standard 35 PostScript fonts for +use with \fBps2pk\fP(1)\&. +.PP +Output files: +.IP "\fIpsfonts\&.map\fP" +For \fBdvips\fP(1)\&. +Same as \fIpsfonts_t1\&.map\fP if option \fBdvipsPreferOutline\fP active, +else as \fIpsfonts_pk\&.map\fP. +.IP "\fIpsfonts_pk\&.map\fP" +For \fBdvips\fP(1)\&. +Without information from MixedMap files\&. +(Setting of \fBdvipsPreferOutline\fP ignored\&.) +.IP "\fIpsfonts_t1\&.map\fP" +For \fBdvips\fP(1)\&. +With information from MixedMap files\&. +(Setting of \fBdvipsPreferOutline\fP ignored\&.) +.IP "\fIdownload35\&.map\fP" +For \fBdvips\fP(1)\&. +Always downloads the standard 35 fonts\&. +(Setting of \fBdvipsDownloadBase35\fP ignored\&.) +.IP "\fIbuiltin35\&.map\fP" +For \fBdvips\fP(1)\&. +Never downloads the standard 35 fonts\&. +(Setting of \fBdvipsDownloadBase35\fP ignored\&.) +.IP "\fIpdftex\&.map\fP" +For \fBpdftex\fP(1)\&. +Same as \fIpdftex_dl14\&.map\fP if option \fBpdftexDownloadBase14\fP active, +else as \fIpdftex_ndl14\&.map\fP. +.IP "\fIpdftex_dl14\&.map\fP" +For \fBpdftex\fP(1)\&. +Always downloads the standard 14 fonts\&. +.IP "\fIpdftex_ndl14\&.map\fP" +For \fBpdftex\fP(1)\&. +Never downloads the standard 14 fonts\&. +.IP "\fIps2pk\&.map\fP" +Similar to \fIpsfonts.map\fP file, but +forces all fonts to be downloaded, so this map file can be used with +\fBxdvi\fP(1) and \fBps2pk\fP(1)\&. +.PP +Configuration files for \fBdvips\fP(1): +.IP "\fIconfig\&.builtin35\fP" +Loads \fIbuiltin35\&.map\fP instead +of \fIpsfonts\&.map\fP\&. +.IP "\fIconfig\&.download35\fP" +Loads \fIdownload35\&.map\fP instead +of \fIpsfonts\&.map\fP\&. +.IP "\fIconfig\&.outline\fP" +Loads \fIpsfonts_t1\&.map\fP instead +of \fIpsfonts\&.map\fP\&. +.IP "\fIconfig\&.pdf\fP" +Loads \fIpsfonts_t1\&.map\fP instead +of \fIpsfonts\&.map\fP and has additional optimizations for PDF generation\&. +.IP "\fIconfig\&.pk\fP" +Loads \fIpsfonts_pk\&.map\fP instead +of \fIpsfonts\&.map\fP\&. +.IP "\fIconfig\&.www\fP" +Loads \fIpsfonts_t1\&.map\fP instead +of \fIpsfonts\&.map\fP\&. +(For compatibility with old versions\&.) +.IP "\fIconfig\&.gstopk\fP" +Loads \fIpsfonts_t1\&.map\fP instead +of \fIpsfonts\&.map\fP\&. +.SH "REPORTING BUGS" +Report bugs to: tex\-k@tug.org +.br +TeX Live home page: <http://tug.org/texlive/> diff --git a/Master/texmf-dist/doc/man/man1/updmap.man1.pdf b/Master/texmf-dist/doc/man/man1/updmap.man1.pdf Binary files differnew file mode 100644 index 00000000000..12d6c9327f6 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/updmap.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/vftovp.1 b/Master/texmf-dist/doc/man/man1/vftovp.1 new file mode 100644 index 00000000000..9fe58331fdb --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/vftovp.1 @@ -0,0 +1,93 @@ +.TH VFTOVP 1 "19 December 1994" "Web2C 2012" +.\"===================================================================== +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff +.el .ds OX TeX for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.\"===================================================================== +.SH NAME +vftovp \- convert virtual font (vf) files to virtual property lists (vpl) +.SH SYNOPSIS +.B vftovp +.RI [ OPTIONS ] +.IR vf_name [ \fB.vf\fP ] +.RI [ tfm_name [ \fB.tfm\fP ] +.RI [ vpl_name [ \fB.vpl\fP ]]] +.\"===================================================================== +.SH DESCRIPTION +This manual page is not meant to be exhaustive. The complete +documentation for this version of \*(TX can be found in the info file +or manual +.IR "Web2C: A TeX implementation" . +.PP +The +.B vftovp +program translates a (program-oriented) virtual font file and its +accompanying \*(TX font metric file to a (human-oriented) property list file. +Thus, the virtual font can be edited, and its exact contents can be +displayed mnemonically. It also serves as a VF-file validating program; +if no error messages are given, the input files are correct. +.PP +The filenames are extended with the appropriate extension if necessary. +.\"===================================================================== +.SH OPTIONS +.TP +.BI \-charcode-format= format +The argument +.I format +specifies how character codes are output in the VPL file. By +default, only letters and digits are output using the +.B C +integer code (i.e., in ASCII); the others are output in octal. (Unless +the font's coding scheme starts with +.B "TeX math sy" +or +.BR "TeX math ex" , +when all are output in octal.) If +.I format +is +.BR ascii , +all character codes that correspond to graphic characters, besides the +left and right parentheses, are output in ASCII. On the other hand, if +.I format +is +.BR octal , +all character codes are output in octal. +.PP +.TP +.B \-verbose +Without this option, +.B vftovp +operates silently. With it, a banner and progress report are printed on +.IR stdout . +.\"===================================================================== +.SH ENVIRONMENT +.B vftovp +looks for +.I vf_name +using the +environment variable VFFONTS. If that is not set, it uses the variable +TEXFONTS. If that is not set, it uses the system default. +.PP +See +.BR tex (1) +for the details of the searching. +.\"===================================================================== +.SH "SEE ALSO" +.BR pltotf (1), +.BR tftopl (1), +.BR vptovf (1). +.\"===================================================================== +.SH AUTHORS +Donald E. Knuth wrote the program, based in part on an idea of David Fuchs, +starting with the code for +.BR tftopl (1). +Karl Berry adapted it for compilation with +.BR web2c . diff --git a/Master/texmf-dist/doc/man/man1/vftovp.man1.pdf b/Master/texmf-dist/doc/man/man1/vftovp.man1.pdf Binary files differnew file mode 100644 index 00000000000..deb7719819d --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/vftovp.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/vlna.1 b/Master/texmf-dist/doc/man/man1/vlna.1 new file mode 100644 index 00000000000..691b3cb7128 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/vlna.1 @@ -0,0 +1,163 @@ +.\" $Id$ +.TH VLNA 1 "March 30 2009" +.nh +.SH NAME +vlna \- adds tilde after each non-syllabic preposition +.SH USAGE +.B vlna +[\fIoptions\fP] +[\fIfilenames\fP] +.SH PREFACE +There exists a special Czech and Slovak typographical rule: you cannot +leave the non-syllabic preposition on the end of one line and continue +writting text on next line. For example, +you cannot write down the text "v lese" (in a forest) like +"v<new-line>lese". The program vlna adds the asciitilde +between such preposition and the next word and removes the space(s) in +this place. It means, the program converts "v lese" to "v~lese". You +can use this program as a preporcessor before TeXing. Moreower, you +can set another sequence to store instead asciitilte (see the +\fB\-x\fP option). +.SH DESCRIPTION +The program +.B vlna +processes one or more files, searches the non-syllabic prepositions +followed by space(s) in these files and converts this/these space(s) +to asciitilde for each such occurrence. +.PP +In the processed file, the activity of the program can be blocked by +\fB%~-\fP sequence and the activity can be restored again by the +\fB%~+\fP sequence. These sequences can include spaces, it means that +\fB% ~-\fP is a correct sequence too. +.PP +The rule to recognize a preposition follows: +The arbitrary number of opening parentheses can be written before the +preposition and before these (optional) parentheses must be the space, +tabelator or new-line. The preposition itself is one-letter word, the letters +have to be from this set: {KkSsVvZzOoUuAI}. See the \fB\-v\fP option if you +want to change this set of letters. From version 1.2, the TeX sequence +can be written before preposition and before the brace. Example: +"<new-line>([V lese" is converted to "<new-line>([V~lese". +Another example: "\\uv{V lese}" is converted to "\\uv{V~lese}". +.PP +One or more blank-spaces have to be included after preposition +before next word. The blank-space means space or tabelator. +One <new-line> can be here too. +All these characters are removed and replaced by asciitilde (or by +another string, see \fB\-x\fP option). If <new-line> is deleted, another +<new-line> is created before preposition (and before optional parentheses) +in order to the number of lines is kept unchanged. +Example: "... V<new-line><tabelator>lese" is converted to +"...<new-line>V~lese". +.PP +The program checks the consintence of TeX's math environments +(if \fB\-m\fP option isn't used). For example the "$...$$...$" sequence +(it means the display mode switch inside the text-math mode) +generates a warning. Empty line inside display mode generates +a warning too and the program processes next text like +in normal (non-math) mode. The existence of the "$" inside display mode +are accepted because the constructions like +$$..\\hbox{..$..$}..$$ are allowed and common. +.PP +The consistence of verbatim mode is checked on the end of the file. +If the file ends but the verbatim mode does not end the warning is printed. +This behavior can be switched off by \fB\-n\fP or \fB\-w\fP options. +.PP +The program suppresses the tilde changing after letters like prepositions +but they are not prepositions because the \fB\\TeX\fP or \fB\\LaTeX\fP +sequence precedes. Example: "vlastnosti \\TeX u jsou" is not converted to +"vlastnosti \\TeX u~jsou", because this text is printed (after TeX +processing) like "vlastnosti TeXu jsou". The letter "u" is a suffix here, +no preposition. +.SH OPTIONS +The options are optional and can be written in arbitrarty order separated +by space. +.TP +.B \-f +Filter. The [\fIfilenames\fP] are treated as follows: +.RS +.TP 4 +.B vlna \-f \fIfilename1 filename2\fP +Input is \fIfilename1\fP, output is \fIfilename2\fP. +.TP 4 +.B vlna \-f \fIfilename1\fP +Input is \fIfilename1\fP, output is \fIstdout\fP. +.TP 4 +.B vlna \-f +Input is \fIstdin\fP, output is \fIstdout\fP. +.TP 4 +\fBvlna\fP \fIfilename1\fP [\fIfilename2\fP [\fIfilename3\fP ...]] +If the \fB\-f\fP option is omitted then each file is processed +independently and it is re-written. +.RE +.TP +.B \-s +The silent mode. No messages, warnings, statistics are printed. +Only errors which terminates the program untimely are printed. +If this parameter is omitted then banner, warnings and statistics +are printed to \fIstderr\fP. +.TP +.B \-r +Do not create the backups. The option \fB\-r\fP is irrelevant if +the \fB\-f\fP option is used. If the \fB\-f\fP and \fB\-r\fP options +aren't used then each re-written file is stored with its original contents +to a backup file (the name of backup file is the same as filename, only +the tilde is used instead of the last character). +.TP +.B \-v \fIcharacters\fP +The set of characters treated as non-syllabic prepositions is declared +by this option. Default: \fB\-v\ KkSsVvZzOoUuAI\fP. +The space between \fB\-v\fP and \fIcharacters\fP is required. +.TP +.B \-x \fIcode\fP +The \fIcode\fP is a string written in hexadecimal notation +(even hexa digits is required). This string will be saved after prepositions +instead asciitilde which is default. +The example: \fB\-x C2A0\fP two bytes are stored after each +non-syllabic preposition, first byte has C2 code and second byte +has A0 code. This example means that +NO-BREAK SPACE in UTF8 encoding will be used after prepositions. +Another example: \fB\-x 00A0\fP the NO-BREAK SPACE in UTF16 encoding. +Another example: \fB\-x 48454C4C4F\fP the string HELLO will be used. +The space between \fB\-x\fP and \fIcode\fP is required. +.TP +.B \-m +The math-modes (\fB$\fP...\fB$\fP and \fB$$\fP...\fB$$\fP) are ignored. +It means that non-syllabic prepositions is searched in math-mode too. +Default (without \fB\-m\fP option): no changes in math modes are done +because (for example) "v" is variable in math-mode, no preposition. +.TP +.B \-n +The verbatim mode (\fB\\verb\fP\fI<char>\fP...\fI<char>\fP, +\fB\\begtt\fP...\fB\\endtt\fP) is ignored, it means the program can +do a changes in verbatim environment. +Default (without \fB\-n\fP option): no changes in verbatim mode are done. +.TP +.B \-l +The LaTeX mode. The following environments are treated as display mode: +\fB\\begin{display}\fP...\fB\\end{display}\fP and +\fB\\begin{equation}\fP...\fB\\end{equation}\fP and the following +environment is treated as verbatim mode: +\fB\\begin{verbatim}\fP...\fB\\end{verbatim}\fP. +.TP +.B \-w +The web mode (Knuth's web, no www:-). The following sequences are +treated as verbatim: +\fB@<\fP, \fB@d\fP...\fB@*\fP, \fB@\fP\fIspace\fP or \fB@>|\fP. +It means program code is unchanged in *.w or *.web files, only +web-comments are processed. +.SH EXAMPLES +.TP +.B vlna \-m \-n \-s \-r \fIfile\fP +The program has a behavior similar to the old \fBvlnka\fP program. +.TP +.B vlna *.tex +All files with .tex suffix in current directory will be processed +(and possibly changed). (The "*" is UNIX-shell feautre). +.TP +.B vlna \-f file > /dev/null +Only the consistence checking of math and verbatim modes is processed. +No changes are done. +.SH AUTHORS +Petr Olsak <olsak@math.feld.cvut.cz>. +Man page (Czech original) and Makefile is created by Rulolf Cejka diff --git a/Master/texmf-dist/doc/man/man1/vlna.man1.pdf b/Master/texmf-dist/doc/man/man1/vlna.man1.pdf Binary files differnew file mode 100644 index 00000000000..2a6e6411c42 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/vlna.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/vptovf.1 b/Master/texmf-dist/doc/man/man1/vptovf.1 new file mode 100644 index 00000000000..5883eeeed43 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/vptovf.1 @@ -0,0 +1,66 @@ +.TH VPTOVF 1 "16 December 1994" "Web2C 2012" +.\"===================================================================== +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.if n .ds TX TeX +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff +.el .ds OX TeX for nroff +.\" the same but obliqued +.\" BX definition must follow TX so BX can use TX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.if n .ds BX BibTeX +.\" LX definition must follow TX so LX can use TX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds LX LaTeX +.\"===================================================================== +.SH NAME +vptovf \- convert virtual property lists to virtual font metrics +.SH SYNOPSIS +.B vptovf +.RB [ \-verbose ] +.IR vpl_name [ \fB.vpl\fP ] +.RI [ vfm_name [ \fB.vf\fP ] +.RI [ tfm_name [ \fB.tfm\fP ]]] +.\"===================================================================== +.SH DESCRIPTION +This manual page is not meant to be exhaustive. The complete +documentation for this version of \*(TX can be found in the info file +or manual +.IR "Web2C: A TeX implementation" . +.PP +The +.B vptovf +program translates a (human-oriented) property list file to a pair of +(program-oriented) files in the VF (virtual font) and TFM (\*(TX font metric) +formats. Thus, a virtual font +file can be edited and its exact contents +can be displayed mnemonically. +New virtual fonts, which map characters as seen by \*(TX into an arbitrary +sequence of low-level typesetting operations, +can also be created in this way. +.PP +All three filenames, +.IR vpl_name , +.IR vf_name , +and +.IR tfm_name , +are extended with the appropriate suffix, if they lack one. +.\"===================================================================== +.SH OPTIONS +Without the +.B \-verbose +option, +.B vptovf +operates silently. With it, a banner and progress report are printed on +.IR stdout . +.\"===================================================================== +.SH "SEE ALSO" +.BR pltotf (1), +.BR tftopl (1), +.BR vftovp (1). +.\"===================================================================== +.SH AUTHORS +Donald E. Knuth wrote the program, based in part on an idea of David Fuchs, +starting with the code for +.BR pltotf (1). +Karl Berry adapted it for compilation with +.BR web2c . diff --git a/Master/texmf-dist/doc/man/man1/vptovf.man1.pdf b/Master/texmf-dist/doc/man/man1/vptovf.man1.pdf Binary files differnew file mode 100644 index 00000000000..f6674a03303 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/vptovf.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/weave.1 b/Master/texmf-dist/doc/man/man1/weave.1 new file mode 100644 index 00000000000..0e137613f9e --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/weave.1 @@ -0,0 +1,79 @@ +.TH WEAVE 1 "7 April 2010" "Web2C 2012" +.\"===================================================================== +.if n .ds MF Metafont +.if t .ds MF M\s-2ETAFONT\s0 +.if n .ds TX TeX +.if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP +.\" the same but obliqued +.el .ds OX TeX for nroff +.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff +.\" BX definition must follow TX so BX can use TX +.if n .ds BX BibTeX +.if t .ds BX \fRB\s-2IB\s0\fP\*(TX +.\" LX definition must follow TX so LX can use TX +.if n .ds LX LaTeX +.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX +.if n .ds WB Web +.if t .ds WB W\s-2EB\s0 +.\"===================================================================== +.SH NAME +weave \- translate WEB to TeX +.SH SYNOPSIS +.B weave +.RB [ \-x ] +.IR webfile [ \fB.web\fP ] +.RI [ changefile [ \fB.ch\fP ]] +.\"===================================================================== +.SH DESCRIPTION +This manual page is not meant to be exhaustive. The complete +documentation for this version of \*(TX can be found in the info file +or manual +.IR "Web2C: A TeX implementation" . +.PP +The +.B weave +program is used to create a \*(TX file for viewing a \*(WB program. +It takes appropriate care of typographic details like page +layout and the use of indentation, italics, boldface, etc., and it supplies +extensive cross-index information that it gathers automatically. +The command line arguments are the same as for +.B tangle +except for the option: +.B \-x +says to omit the index, module name list, and table of contents pages. +(A +.I CONTENTS.tex +file will still be written when the \*(TX file is processed, +however, unless some macros in +.I webmac.tex +are redefined.) +.PP +The output \*(TX file name is formed by adding +.B .tex +to the root of the \*(WB file name. +.PP +There are several macros +that probably should be redefined by +the programmer at the beginning of the \*(WB file. +It is a good idea to set \\title +to the name of the program. +And, to cause output of only changed modules, one can say +\\let\\maybe=\\iffalse (usually as the first change in the +change file). +.\"===================================================================== +.SH ENVIRONMENT +The environment variable WEBINPUTS is used to search for the input files, +or the system default if WEBINPUTS is not set. See +.BR tex (1) +for the details of the searching. +.\"===================================================================== +.SH FILES +.TP \w'@@'u+2n +.I $TEXMFMAIN/tex/plain/base/webmac.tex +\*(TX macros used by +.B weave +output. +.\"===================================================================== +.SH "SEE ALSO" +.BR tangle (1) +for references, authors, and other information. diff --git a/Master/texmf-dist/doc/man/man1/weave.man1.pdf b/Master/texmf-dist/doc/man/man1/weave.man1.pdf Binary files differnew file mode 100644 index 00000000000..4d50f3095cd --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/weave.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/xasy.1 b/Master/texmf-dist/doc/man/man1/xasy.1 new file mode 100644 index 00000000000..e882db25212 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/xasy.1 @@ -0,0 +1,27 @@ +.\" Hey, EMACS: -*- nroff -*- +.TH XASY 1x "27 Nov 2007" +.SH NAME +asy \- script-based vector graphics language +.SH SYNOPSIS +.B xasy +.RI " [-x magnification] [filename]" +.SH DESCRIPTION +\fBAsymptote\fP is a powerful descriptive vector graphics language for +technical drawing, inspired by MetaPost but with an improved C++\-like syntax. +Asymptote provides for figures the same high\-quality level of typesetting that +LaTeX does for scientific text. +.PP +\fBxasy\fP is a GUI for Asymptote that allows for final figure adjustments. + +.SH OPTIONS +.TP +.B \-x magnification +Initial zoom. + +.SH SEE ALSO +Asymptote and xasy are documented fully in the Asymptote Info page. +.SH AUTHOR +Asymptote was written by Andy Hammerlindl, John Bowman, and Tom Prince. +.PP +This manual page was written by Hubert Chan for the Debian project (but may +be used by others). diff --git a/Master/texmf-dist/doc/man/man1/xasy.man1.pdf b/Master/texmf-dist/doc/man/man1/xasy.man1.pdf Binary files differnew file mode 100644 index 00000000000..ebad4890ee3 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/xasy.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/xdvi.1 b/Master/texmf-dist/doc/man/man1/xdvi.1 new file mode 100644 index 00000000000..32933b9d63f --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/xdvi.1 @@ -0,0 +1,4075 @@ +.\" Copyright (c) 1990-2004 Paul Vojta and others +.\" +.\" This is Paul's license, included here only for reference, it does not apply +.\" to all parts of the k version. +.\" ---- +.\" Permission is hereby granted, free of charge, to any person obtaining a copy +.\" of this software and associated documentation files (the "Software"), to +.\" deal in the Software without restriction, including without limitation the +.\" rights to use, copy, modify, merge, publish, distribute, sublicense, and/or +.\" sell copies of the Software, and to permit persons to whom the Software is +.\" furnished to do so, subject to the following conditions: +.\" +.\" The above copyright notice and this permission notice shall be included in +.\" all copies or substantial portions of the Software. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL +.\" PAUL VOJTA OR ANY OTHER AUTHOR OF THIS SOFTWARE BE LIABLE FOR ANY CLAIM, +.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, +.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +.\" DEALINGS IN THE SOFTWARE. +.\" ---- +.\" This is the xdvik license: +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" following is UGLY ... use La\*(Te\& instead: +.\" .if t .ds La L\\h'-0.1667m'\\v'-0.20v'A\\v'0.20v'\\h'-0.1667m'T\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X +.\" .if n .ds La LaTeX +.if t .ds Te T\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X +.if n .ds Te TeX +.\" # small and boldface (not all -man's provide it) +.de SB +\&\fB\s-1\&\\$1 \\$2\s0\fR +.. +.TH XDVI 1 "2012-04-01" "Xdvik 22.85" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH NAME +xdvi \- DVI Previewer for the X Window System +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH SYNOPSIS +.B xdvi +.nh +[\fB+\fP[\fIpage\fP]] +[\fB\--help\fP] +[\fB\-allowshell\fP] +[\fB\-altfont\fP \fIfont\fP] +[\fB\-bg\fP \fIcolor\fP] +[\fB\-browser\fP \fIWWWbrowser\fP] +[\fB\-copy\fP] +[\fB\-cr\fP \fIcolor\fP] +[\fB\-debug\fP \fIbitmask\fP|\fIstring[,string ...]\fP] +[\fB\-display\fP \fIhost:display\fP] +[\fB\-dvipspath\fP \fIpath\fP] +[\fB\-editor\fP \fIcommand\fP] +[\fB\-expert\fP] +[\fB\-expertmode\fP \fIflag\fP] +[\fB\-fg\fP \fIcolor\fP] +[\fB\-findstring\fP \fIstring\fP] +[\fB\-text-encoding\fP \fIencoding\fP] +[\fB\-font\fP \fIfont\fP] +[\fB\-fullscreen \fP] +[\fB\-gamma\fP \fIg\fP] +[\fB\-geometry\fP \fIgeometry\fP] +[\fB\-gsalpha\fP] +[\fB\-gspalette\fP \fIpalette\fP] +[\fB\-h\fP] +[\fB\-help\fP] +[\fB\-hl\fP \fIcolor\fP] +[\fB\-anchorposition\fP \fIanchor\fP] +[\fB\-hush\fP] +[\fB\-hushchars\fP] +[\fB\-hushchecksums\fP] +[\fB\-warnpecials\fP] +[\fB\-hushstdout\fP] +[\fB\-hushbell\fP] +[\fB\-icongeometry\fP \fIgeometry\fP] +[\fB\-iconic\fP] +[\fB\-install\fP] +[\fB\-interpreter\fP \fIpath\fP] +[\fB\-keep\fP] +[\fB\-l\fP] +[\fB\-license\fP] +[\fB\-linkcolor\fP \fIcolor\fP] +[\fB\-linkstyle\fP \fI0|1|2|3\fP] +[\fB\-margins\fP \fIdimen\fP] +[\fB\-mfmode\fP \fImode-def\fP[\fB:\fP\fIdpi\fP]] +[\fB\-mgs\fP[\fIn\fP] \fIsize\fP] +[\fB\-mousemode\fP \fI0|1|2\fP] +[\fB\-nocolor\fP] +[\fB\-nofork\fP] +[\fB\-noghostscript\fP] +[\fB\-nogrey\fP] +[\fB\-nogssafer\fP] +[\fB\-noinstall\fP] +[\fB\-nomakepk\fP] +[\fB\-nomatchinverted\fP] +[\fB\-noomega\fP] +[\fB\-noscan\fP] +[\fB\-not1lib\fP] +[\fB\-notempfile\fP] +[\fB\-offsets\fP \fIdimen\fP] +[\fB\-p\fP \fIpixels\fP] +[\fB\-paper\fP \fIpapertype\fP] +[\fB\-pause\fP] +[\fB\-pausespecial\fP \fIspecial-string\fP] +[\fB\-postscript\fP \fIflag\fP] +[\fB\-rulecolor\fP \fIcolor\fP] +[\fB\-rv\fP] +[\fB\-S\fP \fIdensity\fP] +[\fB\-s\fP \fIshrink\fP] +[\fB\-safer\fP] +[\fB\-sidemargin\fP \fIdimen\fP] +[\fB\-sourceposition\fP \fIline\fP[\fB:\fP\fIcol\fP][\ ]\fIfilename\fP] +[\fB\-statusline\fP] +[\fB\-thorough\fP] +[\fB\-topmargin\fP \fIdimen\fP] +[\fB\-unique\fP] +[\fB\-version\fP] +[\fB\-visitedlinkcolor\fP \fIcolor\fP] +[\fB\-warnspecials\fP] +[\fB\-watchfile\fP \fIsecs\fP] +[\fB\-wheelunit\fP \fIpixels\fP] +[\fB\-xoffset\fP \fIdimen\fP] +[\fB\-yoffset\fP \fIdimen\fP] +[\fIdvi_file\fP] +.hy +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH DESCRIPTION +.B Xdvi +is a program for previewing +.I dvi +files, as produced e.g. by the +.BR tex (1) +program, under the X window system. +.PP +.B Xdvi +can show the file shrunken by various +integer factors, and it has a ``magnifying glass'' for viewing +parts of the page enlarged (see the section MAGNIFIER below). This version +of +.B xdvi +is also referred to as +.B xdvik +since it uses the kpathsea library to locate and generate font files. +In addition to that, it supports the following features: +.RS 2 +.TP 2 +- +hyperlinks in DVI files (section HYPERLINKS), +.TP +- +direct rendering of Postscript<tm> Type1 fonts (section T1LIB), +.TP +- +source specials in the DVI file (section SOURCE SPECIALS), +.TP +- +string search in DVI files (section STRING SEARCH), +.TP +- +saving or printing (parts of) the DVI file (sections PRINT DIALOG and SAVE DIALOG). +.RE +.PP +.B Xdvi +can be compiled with the Motif toolkit or the Xaw (Athena) toolkit +(and variants of it), and the Motif version has a slightly different GUI; +these differences are noted below. +.PP +Before displaying a page of a DVI file, +.B xdvi +will check to see if the file has changed since the last time it was +displayed. If this is the case, it will reload the file. This +feature allows you to preview many versions of the same file while +running +.B xdvi +only once. Since it cannot read partial DVI files, +.B xdvik +versions starting from 22.74.3 will create a temporary copy of the +DVI file being viewed, to ensure that the file can be viewed without +interruptions. (The +.B \-notempfile +can be used to turn off this feature). +.PP +.B Xdvi +can show PostScript<tm> specials by any of three methods. +It will try first to use Display PostScript<tm>, then NeWS, then it +will try to use Ghostscript to render the images. All of these options +depend on additional software to work properly; moreover, some of them +may not be compiled into this copy of +.BR xdvi . +.PP +For performance reasons, +.B xdvi +does not render PostScript specials in the magnifying glass. +.PP +If no file name has been specified on the command line, +xdvi will try to open the most recently opened file; if the file +history (accessible via the +.B File > Open Recent +menu) is empty, or if none of the files in the history are valid DVI files, +it will pop up a file selector for choosing a file name. +(In previous versions, which didn't have a file history, the file selector +was always used; you can set the X resource +.B noFileArgUseHistory +to +.I false +to get back the old behaviour.) +.PP +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH OPTIONS +In addition to specifying the +.I dvi +file (with or without the +.B .dvi +extension), +.B xdvi +supports the following command line options. If the option begins with a +.RB ` + ' +instead of a +.RB ` \- ', +the option is restored to its default value. By default, these options can +be set via the resource names given in parentheses in the description of +each option. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI + page +Specifies the first page to show. If +.B + +is given without a number, the last page is assumed; the first page is +the default. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-allowshell +.RB ( .allowShell ) +This option enables the shell escape in PostScript specials. +(For security reasons, shell escapes are disabled by default.) +This option should be rarely used; in particular it should not be used just +to uncompress files: that function is done automatically if the file name +ends in +.BR .Z , +.BR .gz , +or +.BR .bz2 . +Shell escapes are always turned off if the +.B \-safer +option is used. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-altfont " font" +.RB ( .altFont ) +Declares a default font to use when the font in the +.I dvi +file cannot be found. This is useful, for example, with PostScript <tm> fonts. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-background " color" +.RB ( .background ) +Determines the color of the background. Same as +.BR -bg . +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-bg " color" +.RB ( .background ) +Determines the color of the background. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-browser " browser" +.RB ( .wwwBrowser ) +Defines the web browser used for handling external URLs. The value of this +option or resource has the same syntax as the +.B BROWSER +environment variable; see the explanation of that variable in the +section `ENVIRONMENT' below for a detailed description. +If neither the option nor the X resource +.I wwwBrowser +is specified, the environment variables +.B BROWSER +and +.B WWWBROWSER +(in that order) are used to determine the browser command. If these are +not set either, the following default value is used: +\fBxdg-open %s:htmlview %s:firefox -remote -remote "openURL(%s,new-window)":mozilla -remote "openURL(%s,new-window)":netscape -raise -remote "openURL(%s,new-window)":xterm -e w3m %s:xterm -e lynx %s:xterm -e wget %s\fP +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-copy +.RB ( .copy ) +Always use the +.I copy +operation when writing characters to the display. +This option may be necessary for correct operation on a color display, but +overstrike characters will be incorrect. +If greyscale anti-aliasing is in use, the +.B \-copy +operation will disable the use of colorplanes and make overstrikes come +out incorrectly. +See also +.BR \-thorough . +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-cr " color" +.RB ( .cursorColor ) +Determines the color of the mouse cursor. The default is the same as +the foreground color. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-debug " bitmask|string[,string ...]" +.RB ( .debugLevel ) +If nonzero, prints additional information on standard output. The +argument can be either a bitmask specified as a decimal number, or +comma-separated list of strings. +.br +For the bitmask representation, multiple values can +be specified by adding the numbers that represent the individual bits; +e.g. to debug all all file searching and opening commands, use 4032 +(= 2048 + 1024 + 512 + 256 + 128 + 64). Use -1 to turn on debugging +of everything (this will produce huge output). +.br +For the string representation, use the strings listed in the following +table, with a comma to separate the values; e.g. to debug +all file searching and opening commands, use +.BR search,expand,paths,hash,stat,open . +(The option `kpathsea' is provided as a shorthand for these.) +Note that such a list may need to be quoted to prevent the shell +from interpreting commas or spaces in the list. +.br +The individual numbers and strings have the following meanings: +.nf +.sp 1n +.ta 1L +8L +12L + 1 bitmap Bitmap creation + 2 dvi DVI translation + 4 pk PK fonts + 8 batch Batch mode: Exit after + reading the DVI file + 16 event Event handling + 32 ps PostScript interpreter calls + 64 stat Kpathsea stat(2) calls + 128 hash Kpathsea hash table lookups + 256 open Kpathsea file opening + 512 paths Kpathsea path definitions + 1024 expand Kpathsea path expansion + 2048 search Kpathsea searching + 4032 kpathsea All Kpathsea options + 4096 htex Hypertex specials + 8192 src Source specials + 16384 client Client/server mode (see -unique + and -sourceposition options) + 32768 t1 Type1 font library messages + 65536 t1_verbose Verbose Type1 library messages + 131072 gui GUI elements +.sp 1n +.fi +Some of the Kpathsea debugging options are actually provided by Kpathsea; +see the Debugging section in the Kpathsea manual for more information on +these. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-density " density" +.RB ( .densityPercent ) +Determines the density used when shrinking bitmaps for fonts. +A higher value produces a lighter font. The default value is 40. +If greyscaling is in use, this argument does not apply; use +.B \-gamma +instead. +See also the +.RB ` S ' +keystroke. +Same as +.BR \-S . +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-display " host" : display +Specifies the host and screen to be used for displaying the +.I dvi +file. By default this is obtained from the environment variable +.SB DISPLAY. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-dvipspath " path" +.RB ( .dvipsPath ) +Use +.I path +as the +.B dvips +program to use when printing. The default for this is +.BR dvips . +The program or script should read the DVI file from standard input, +and write the Postscript file to standard output. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-editor " editor" +.RB ( .editor ) +Specifies the editor that will be invoked when the +.I source-special() +action is triggered to start a reverse search (by default via Ctrl-Mouse 1). +The argument to this option is a format string in which occurrences of +.RB `` %f '' +are replaced by the file name, occurrences of +.RB `` %l '' +are replaced by the line number within the file, and optional +occurrences of +.RB `` %c '' +are replaced by the column number within the line. +.sp +If neither the option nor the X resource +.I .editor +is specified, the following environment variables are checked +to determine the editor command: +.BR XEDITOR , +.BR VISUAL , +and +.B EDITOR +(in this sequence). If the string is found as the value +of the +.SB VISUAL +or +.SB EDITOR +environment variables, then +.RI `` "xterm -e "'' +is prepended to the string; if the editor is specified by other means, then +it must be in the form of a shell command to pop up an X window with an +editor in it. If none of these variables is set, a warning message is displayed +and the command +.RI `` "xterm -e vi +%l %f"'' +is used. +.sp +If no +.RB `` %f '' +or +.RB `` %l '' +occurs in the string, the missing format strings are appended automatically. +(This is for compatibility with other programs when using one of the environment +variables). +.sp +A new instance of the editor is started each time this command is used; +therefore it is preferable to use an editor that can be invoked in +`client' mode to load new files into the same instance. Example +settings are: +.RS 7 +.TP 7 +.SB emacsclient --no-wait +(older Emacsen) +.TP +.SB gnuclient -q +(XEmacs and newer Emacsen) +.TP +.SB gvim --servername xdvi --remote +(VIM v6.0+; the `--servername xdvi' option will cause gvim to run a +dedicated instance for the files opened by xdvi.) +.TP +.SB nc +(nedit) +.PP +.sp +Note that those strings need to be enclosed +into quotes when using them on the command-line +to protect them from the shell; when using them +as argument for the +.I .editor +resource in an X resource file, no quotes should be used. +.sp +.B NOTE ON SECURITY: +The argument of this option isn't executed as a shell command, +but via +.I exec() +to prevent evil tricks with the contents of source specials. +.RE +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-expert +This option is only supported for backwards compatibility; +it is equivalent to +.BR "\-expertmode 0" , +which should be preferred. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-expertmode " flag" +.RB ( .expertMode ) +With an argument of +.IR 0 , +this option switches off the display of the buttons, scrollbars, +the toolbar (Motif only), +the statusline and the page list. These GUI elements +can also be (de)activated separately, by combining the +appropriate values in the +.I flag +argument. This acts similar to the +.B \-debug +option: The integer +.I flag +is treated as a bitmap where each bit represents one +element. If the bit has the value +.IR 1 , +the element is switched on, if it has the value +.IR 0 , +the element is switched off. The meaning of the bits +is as follows: +.nf +.sp 1n +.ta 1L +8L +12L + 1 statusline + 2 scrollbars + 4 Motif: pagelist, Xaw: buttons and pagelist + 8 toolbar (Motif only) + 16 menubar (Motif only) +.sp 1n +.fi +For example, to turn on only the statusline and the scrollbars, +use 3 (= 1 + 2). +See also the +.RB ` x ' +keystroke, where the bits are addressed by their positions, from 1 to +3 (Xaw) or 5 (Motif), respectively. +.PP +If the statusline is not active, all messages +that would normally be printed to the statusline will be printed to +.IR stdout , +unless the +.B \-hushstdout +option is used. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-fg " color" +.RB ( .foreground ) +Determines the color of the text (foreground). +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-text-encoding " encoding" +.RB ( .textEncoding ) +Use +.I encoding +as text encoding of the string in the "Find" window. Usually, +this shouldn't be needed since the encoding is determined from the locale settings. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-findstring\fP \fIstring\fP +This option triggers a search for +.I string +in the DVI file mentioned on the command-line, similar to forward search +(see the description of the +.B sourceposition +option): +If there is already another +instance of +.B xdvi +running on the displaying that DVI file, it will cause that instance +to perform the search instead. The search starts at the top of the current +page of the DVI file. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-font " font" +.RB ( *font ) +Sets the font used in menus, buttons etc., as described in the +.I X(7x) +man page. The font for child windows can be set separately, +e.g.: +.RS 7 +.nf +.ft 3 +.sp 1n +xdvi*statusline*font: \e + -*-helvetica-medium-r-*-*-12-*-*-*-*-*-*-* +.sp 1n +.ft +.fi +.RE +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-foreground " color" +Same as +.BR -fg . +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-fullscreen +When this option is used, xdvi will (try to) run in fullscreen mode, with +no window decorations. +This option is not guaranteed to work with all windowmanagers/desktops; +if you're experiencing problems with it, please use the +.B \-geometry +option instead, and a suitable window manager setting to remove +the window decorations. +When using this option for presentations, you might want +to get rid of all the control widgets as well, using the +.B -expertmode +option. This option can also be toggled at runtime using the +.B fullscreen +action (by default bound to Ctrl-l). +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-gamma " gamma" +.RB ( .gamma ) +Controls the interpolation of colors in the greyscale anti-aliasing color +palette. Default value is 1.0. For 0 < +.I gamma +< 1, the fonts will be lighter (more like the background), and for +.I gamma +> 1, the fonts will be darker (more like the foreground). Negative +values behave the same way, but use a slightly different algorithm. +For color and grayscale displays; for monochrome, see +.BR \-density . +See also the +.RB ` S ' +keystroke. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-geometry " geometry" +.RB ( .geometry ) +Specifies the initial geometry of the main window, +as described in the +.I X(7x) +man page. The geometry of child windows can be set +separately, e.g.: +.br +.I xdvi*helpwindow.geometry: 600x800 +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-gsalpha +.RB ( .gsAlpha ) +Causes +.B Ghostscript +to be called with the +.B x11alpha +driver instead of the +.B x11 +driver. The +.B x11alpha +driver enables anti-aliasing in PostScript specials, for a nicer appearance. +It is available on newer versions of +.BR Ghostscript . +This option can also be toggled with the +.RB ` V ' +keystroke. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-gspalette " palette" +.RB ( .palette ) +Specifies the palette to be used when using Ghostscript for rendering +PostScript specials. Possible values are +.BR Color , +.BR Greyscale , +and +.BR Monochrome . +The default is +.BR Color . +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BR \-h , " \-help" , " \--help" +Prints a short help text with an overview of the command-line options +to standard output. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-hl " color" +.RB ( .highlight ) +Determines the color of the page border, of the ruler in `ruler mode', +and of the highlighting markers in forward search and string search. +The default is the foreground color. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-anchorposition " anchor" +Jump to +.I anchor +after opening the DVI file. This is only useful when invoking +.B xdvi +from other applications. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-hush +.RB ( .Hush ) +Causes +.B xdvi +to suppress all suppressible warnings. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-hushchars +.RB ( .hushLostChars ) +Causes +.B xdvi +to suppress warnings about references to characters which are not defined +in the font. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-hushchecksums +.RB ( .hushChecksums ) +Causes +.B xdvi +to suppress warnings about checksum mismatches between the +.I dvi +file and the font file. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-hushstdout +.RB ( .hushStdout ) +Suppresses printing of status messages to +.IR stdout . +Note that errors or warnings will still be printed to +.I stderr +even if this option is used. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-hushbell +.RB ( .hushBell ) +Don't sound the X bell when an error occurs. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-icongeometry " geometry" +.RB ( .iconGeometry ) +Specifies the initial position for the icon. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-iconic +.RB ( .iconic ) +Causes the +.B xdvi +window to start in the iconic state. The default is to start with the +window open. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-install +.RB ( .install ) +If +.B xdvi +is running under a +.B PseudoColor +visual, then (by default) it will check for +.B TrueColor +visuals with more bits per pixel, and switch to such a visual if one exists. +If no such visual exists, it will use the current visual and colormap. If +.B \-install +is selected, however, it will still use a +.B TrueColor +visual with a greater depth, if one is available; otherwise, it will +install its own colormap on the current visual. If the current visual is not +.BR PseudoColor , +then +.B xdvi +will not switch the visual or colormap, regardless of its options. +The default value of the +.B install +resource is the special value, +.BR maybe . +There is no +.B +install +option. See also +.BR \-noinstall , +and the GREYSCALING AND COLORMAPS section. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-interpreter " filename" +.RB ( .interpreter ) +Use +.I filename +as the Ghostscript interpreter. By default it uses +.BR gs . +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-keep +.RB ( .keepPosition ) +Sets a flag to indicate that +.B xdvi +should not move to the home position when moving to a new page. See also the +.RB ` k ' +keystroke. This flag is honored by all page switching actions and by +.B up-or-previous() / +.BR down-or-next() , +although the latter only honor the horizontal postion, not the vertical one. +This allows for a "continuous" scrolling back an forth through a document with +a display window narrower than a page width. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-l +.RB ( .listFonts ) +List the names of all fonts used. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-license +Prints licensing information. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-linkcolor +.RB ( .linkColor ) +Color used for unvisited hyperlinks (`Blue2' by default). Hyperlinks +are unvisited before you click on them, or after the DVI file has been reloaded. +The value should be either a valid X color name (such as +.IR DarkGoldenrod4 ) +or a hexadecimal color string (such as +.IR #8b6508 ). +See also +.B \-visitedlinkcolor +and +.BR \-linkstyle . +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-linkstyle +.RB ( .LinkStyle ) +Determines the style in which hyperlinks are displayed. Possible +values and their meanings are: +.nf +.sp 1n +.ta 1L +8L + 0 No highlighting of links + 1 Underline links with \fIlink color\fR + 2 No underlining, color text with \fIlink color\fR + 3 Underline and display text colored with + \fIlink color\fR +.sp 1n +.fi +The values for \fIlink color\fR are specified by the options/resources +.BI \-linkcolor +and +.BI \-visitedlinkcolor +(which see). +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-margins " dimen" +.RB ( .Margin ) +Specifies the size of both the top margin and side margin. +This determines the ``home'' position of the page within the window as +follows. If the entire page fits in the window, then the margin settings +are ignored. If, even after removing the margins from the left, right, +top, and bottom, the page still cannot fit in the window, then the page +is put in the window such that the top and left margins are hidden, and +presumably the upper left-hand corner of the text on the page will be +in the upper left-hand corner of the window. +Otherwise, the text is centered in the window. +The dimension should be a decimal number optionally followed by +any of the two-letter abbreviations for units accepted by \*(Te\& +.RB ( pt , +.BR pc , +.BR in , +.BR bp , +.BR cm , +.BR mm , +.BR dd , +.BR cc , +or +.BR sp ). +By default, the unit will be +.BR cm " (centimeters)". +See also +.BR \-sidemargin ", " \-topmargin , +and the keystroke +.RB ` M .' +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-mfmode " mode-def" +.RB ( .mfMode ) +Specifies a +.I mode-def +string, which can be used in searching for fonts (see ENVIRONMENT, below). +Generally, when changing the +.IR mode-def , +it is also necessary to change the font size to the appropriate value +for that mode. This is done by adding a colon and the value in dots per inch; +for example, +.BR "\-mfmode ljfour:600" . +This method overrides any value given by the +.B pixelsPerInch +resource or the +.B \-p +command-line argument. +The metafont mode is also passed to +.B metafont +during automatic creation of fonts. +By default, it is +.BR "unspecified" . +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-mgs " size" +Same as +.BR \-mgs1 . +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-mgs[ n ] " size" +.RB ( .magnifierSize\fR[\fIn\fR] ) +Specifies the size of the window to be used for the ``magnifying glass'' +for Button +.IR n . +The size may be given as an integer (indicating that the magnifying glass +is to be square), or it may be given in the form +.IR width x height . +See the MOUSE ACTIONS section. Defaults are 200x150, 400x250, 700x500, +1000x800, and 1200x1200. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-mousemode " " [ 0 | 1 | 2 ] +.RB ( .mouseMode ) +Specifies the default mode of xdvi at startup: Magnifier (0), Text Selection Mode (1) +or Ruler Mode (2). See the section +.BR MODES , +below, for more information. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-nocolor +.RB ( .color ) +Turns off the use of color specials. This option can be toggled with the +.RB ` C ' +keystroke. +(Note: +.B \-nocolor +corresponds to +.BR color:off ; +.B +nocolor +to +.BR color:on .) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-nofork +.RB ( .fork ) +With the +.B \-sourceposition +and +.B \-unique +options, the default behavior is for +.B xdvi +to put itself into the background (like a daemon) if there +is no appropriate instance of +.B xdvi +already running. +This argument makes it run in the foreground instead. This is useful +for debugging, or if your client application cannot deal well with +a program self-backgrounding itself in this way -- e.g., the IPC functions +in +.B emacs +are known to have problems with this. +If no +.B \-sourceposition +or +.B \-unique +argument is given, then this option has no effect. +(Note: +.B \-nofork +corresponds to +.BR fork:off ; +.B +nofork +to +.BR fork:on .) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-noghostscript +.RB ( .ghostscript ) +Inhibits the use of Ghostscript for displaying PostScript<tm> specials. +(Note: +.B \-noghostscript +corresponds to +.BR ghostscript:off ; +.B +noghostscript +to +.BR ghostscript:on .) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-nogrey +.RB ( .grey ) +Turns off the use of greyscale anti-aliasing when printing shrunken bitmaps. +(Note: +.B \-nogrey +corresponds to +.BR grey:off ; +.B +nogrey +to +.BR grey:on .) +See also the +.RB ` G ' +keystroke. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-nogssafer +.RB ( .gsSafer ) +Normally, if Ghostscript is used to render PostScript specials, the Ghostscript +interpreter is run with the option +.BR \-dSAFER . +The +.B \-nogssafer +option runs Ghostscript without +.BR \-dSAFER . +The +.B \-dSAFER +option in Ghostscript disables PostScript operators such as +.BR deletefile , +to prevent possibly malicious PostScript programs from having any effect. +If the +.B \-safer +option is specified, then this option has no effect; in that case Ghostscript +is always run with +.BR \-dSAFER . +(Note: +.B \-nogssafer +corresponds to +.BR gsSafer:off ; +.B +nogssafer +to +.BR gsSafer:on .) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-noinstall +.RB ( .install ) +Inhibit the default behavior of switching to a +.B TrueColor +visual if one is available with more bits per pixel than the current visual. +(Note: +\-noinstall +corresponds +.BR install:off ; +there is no +.B +noinstall +option.) +See also +.BR \-install , +and the GREYSCALING AND COLORMAPS section. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-nomakepk +.RB ( .makePk ) +Turns off automatic generation of font files that cannot be found by other +means. +(Note: +.B \-nomakepk +corresponds to +.BR makePk:off ; +.B +nomakepk +to +.BR makePK:on .) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-nomatchinverted +.RB ( .matchInverted ) +Don't highlight string search matches in inverted color; instead, draw a rectangle in +.I highlight +color (see the +.B \-hl +option) around the match. This option is activated automatically if +the display isn't running in TrueColor. +(Note: +.B \-nomatchinverted +corresponds to +.BR matchInverted:off ; +.B +nomatchinverted +to +.BR matchInverted:on .) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-noomega +.RB ( .omega ) +This will disable the use of Omega extensions when interpreting DVI files. +By default, the additional opcodes +.I 129 +and +.I 134 +are recognized by xdvi as Omega extensions and interpreted as requests +to set 2-byte characters. The only drawback is that the virtual font +array will require 65536 positions instead of the default 256 positions, +i.e. the memory requirements of xdvi will be slightly larger. If you find +this unacceptable or encounter another problem with the Omega extensions, +you can switch this extension off by using +.B \-noomega +(but please do send a bug report if you find such problems - see the bug +address in the +.B AUTHORS +section below). +.br +(Note: +.B \-noomega +corresponds to +.BR "omega: off" ; +.B +noomega +to +.BR "omega: on" .) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-noscan +.RB ( .prescan ) +By default, +.B xdvi +does a preliminary scan of the +.I dvi +file to process any +.B papersize +specials; this is especially important at startup since the paper size may be +needed to determine the window size. +If PostScript<tm> is in use, then prescanning is also necessary in order to +properly process header files. +In addition, prescanning is needed to correctly determine the background color +of a page. +This option turns off such prescanning. +(Prescanning will be automatically be turned back on if +.B xdvi +detects any of the specials mentioned above.) +(Note: +.B \-noscan +corresponds to +.BR prescan:off ; +.B +noscan +to +.BR prescan:on .) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-not1lib +.RB ( .t1lib ) +This will disable the use of T1Lib to display PostScript<tm> fonts. +Use this option as a workaround when you encounter problems with the +display of T1Lib (but please don't forget to send a bug report in +this case, to the URL mentioned in the section AUTHORS below). +.br +(Note: +.B \-not1lib +corresponds to +.BR t1lib:off ; +.B +not1lib +to +.BR t1lib:on .) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-notempfile +.RB ( .tempFile ) +As mentioned in the section +.B DESCRIPTION +above, xdvi will create a temporary copy of the DVI file so that it +can be accessed without interruptions even while the file is being +rewritten by +.BR TeX . +Since this introduces the overhead of copying the file every time +it has changed, the +.B \-notempfile +allows you to turn off this behaviour. In this case, exposing parts of the +window while the DVI file is being written by \*(Te\& will erase the current +window contents until the DVI file can be completely reread. +.br +(Note: +.B \-notempfile +corresponds to +.BR tempFile:off ; +.B +notempfile +to +.BR tempFile:on .) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-offsets " dimen" +.RB ( .Offset ) +Specifies the size of both the horizontal and vertical offsets of the +output on the page. By decree of the Stanford \*(Te\& Project, +the default \*(Te\& page origin is always 1 inch over and down from +the top-left page corner, even when non-American paper sizes are used. +Therefore, the default offsets are 1.0 inch. +The argument +.I dimen +should be a decimal number optionally followed by any of the two-letter +abbreviations for units accepted by \*(Te\& +.RB ( pt , +.BR pc , +.BR in , +.BR bp , +.BR cm , +.BR mm , +.BR dd , +.BR cc , +or +.BR sp ). +By default, the unit will be +.BR cm " (centimeters)". +See also +.B \-xoffset +and +.BR \-yoffset . +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-p " pixels" +.RB ( .pixelsPerInch ) +Defines the size of the fonts to use, in pixels per inch. The +default value is 600. This option is provided only for backwards +compatibility; the preferred way is to set both the resolution +and the Metafont mode via the +.B \-mfmode +option (which see). +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-paper " papertype" +.RB ( .paper ) +Specifies the size of the printed page. Note that in most cases it's +best to specify the paper size in the TeX input file via the line +.sp +.B \eusepackage[dvips]{geometry} +.sp +which will be recognized by both dvips and xdvi; in that case the +use of a `-paper' option should be unnecessary. +.br +The paper size may be specified in the form +\fIwidth\fBx\fIheight\fR optionally followed by a unit, where +.I width +and +.I height +are decimal numbers giving the width and height of the paper, respectively, +and the unit is any of the two-letter abbreviations for units accepted +by \*(Te\& +.RB ( pt , +.BR pc , +.BR in , +.BR bp , +.BR cm , +.BR mm , +.BR dd , +.BR cc , +or +.BR sp ). +By default, the unit is +.BR cm " (centimeters)"\fR. +.br +There are also synonyms which may be used: +.B us +(8.5x11in), +.B legal +(8.5x14in), +.B foolscap +(13.5x17in), +as well as the ISO sizes +.BR a1 - a7 , +.BR b1 - b7 , +.BR c1 - c7 . +Each of these also has a landscape or `rotated' variant: +.B usr +(11x8.5in), +.BR a1r - a7r , +etc. For compatibility with +.BR dvips , +the formats +.B letter +(8.5x11in), +.B ledger +(17x11in) +and +.B tabloid +(11x17in) +are also supported (these don't have rotated variants). +.br +Any of the above sizes may be preceded by a plus sign +.RB (` + '); +this causes the paper size given here to override any paper size given in the +.I dvi +file. The default paper size is 21 x 29.7 cm (A4 size). +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-pause +.RB ( .pause ) +This option provides a simple implementation of incremental +(stepwise) display, which can be used for presentations. +When this option is used, +.B xdvi +will pause the display of the current page whenever it encounters a +special +.I special-string +.RI ( xdvi:pause +by default; the string can be customized via +.IR \-pausespecial , +see below), and the cursor will change its shape. The action +.B unpause-or-next() +(by default bound to the +.B Space +key) will display the next portion of the page up to the following +.IR special-string , +or until the end of the page is reached. +When the option is not used, specials containing +.I special-string +will be ignored. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-pausespecial " special-string" +.RB ( .pauseSpecial ) +Sets the special string that causes xdvi to pause when the +.I -pause +option is active. The default value of +.I special-string +is +.IR xdvi:pause . +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-postscript " flag" +.RB ( .postscript ) +If +.I flag = 0, +rendering of PostScript<tm> specials is disabled; instead, bounding +boxes will be displayed (if available). A value of +.I 1 +(the default) switches PostScript<tm> specials on. With a value of +.IR 2 , +the PostScript<tm> specials are displayed along with their +bounding boxes; this allows you to visually check the correctness +of the bounding boxes. The values can also be toggled at runtime +with the +.RB ` v ' +keystroke and the corresponding numerical prefix arguments 0, 1 and 2. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-ps2pdfpath " path" +.RB ( .ps2pdfPath ) +Use +.I path +as a conversion program from Postscript to PDF. The program or script +should accept two command-line arguments: The Postscript file as first +argument, and the PDF output file as second argument. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-rulecolor " color" +.RB ( .ruleColor ) +Determines the color of the rules used for the the magnifier +(default: foreground color). +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-q +.RB ( .noInitFile ) +Ignore the +.I $HOME/.xdvirc +startup file (i.e. don't read it at startup, and don't write it +at exit). This forces the defaults defined in +.I $HOME/.Xdefaults +to be used. See +.B FILES +for more information on +.IR $HOME/.xdvirc . +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-rv +.RB ( .reverseVideo ) +Causes the page to be displayed with white characters on a black background, +instead of vice versa. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-S " density" +.RB ( .densityPercent ) +Same as +.B \-density +(which see). +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-s " shrink" +.RB ( .shrinkFactor ) +Defines the initial shrink factor. The default value is 8. If +.I shrink +is given as 0, then the initial shrink factor is computed so that the +page fits within the window (as if the `s' keystroke were given without +a number). +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-safer +.RB ( .safer ) +This option turns on all available security options; it is designed for use when +.B xdvi +is called by a browser that obtains a +.I dvi +or \*(Te\& file from another site. +This option selects +.B +nogssafer +and +.BR +allowshell . +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-sidemargin " dimen" +.RB ( .sideMargin ) +Specifies the side margin (see +.BR \-margins ). +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-sourceposition " line" [: col "][ ]" filename +This option makes +.B xdvi +search in the +.I dvi +file for the place corresponding to the indicated line (and, optionally, +column) in the .tex source file, and highlight the place found by drawing a +rectangle in the +.I highlight +color (see the +.B \-hl +option) around the corresponding text. In addition, when run with this +argument (and the +.B \-nofork +option is not given, which see), +.B xdvi +will always return immediately: if it finds another instance of +.B xdvi +already showing +.I dvi_file, +then it will cause that instance to raise its window and move to the given +place in the +.I dvi +file; otherwise it will start up its own instance in the background. +If several instances of xdvi are displaying the respective +.I dvi +file, the instance which was last raised to the foreground will be used. +.sp +The space before +.I filename +is only needed if the filename starts +with a digit. When the space is used, the argument +needs to be enclosed in quotes to prevent the shell from +misinterpreting the space as argument separator. +.sp +This option requires that +.I dvi_file +be prepared with source special information. See the section on SOURCE SPECIALS +for details on how to do this. +.sp +Here is a more detailed description of how the filename in the +.I \-sourceposition +argument is matched with the filename in the source specials: +.RS 7 +.TP 3 +1. +If neither of the filenames contains a path name component, the filenames +are compared ignoring the +.RI ` .tex ' +extensions in both filenames. +.TP +2. +Otherwise, if one of the filenames does contain a path component (e.g.: +.IR ./test.tex , +.IR ../test.tex , +.IR /my/homedir/tex/test.tex +or any combination of these), both filenames are expanded to a full path, +with any occurrences of +.I ../ +and +.I ./ +expanded, and multiple slashes removed. +.br +The pathname in the +.I \-sourceposition +is expanded relative to the current working directory of the +.I xdvi \-sourceposition +invocation, and the pathnames in the source specials are expanded +relative to the path of the current DVI file being viewed. +.br +The path names are then compared ignoring the +.RI ` .tex ' +extensions in both path names. +.RE +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-statusline\fP +.RB ( .statusline ) +This option is obsolete; use +\fB\-expertmode \fP \fIflag\fP +instead (which see). +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-thorough +.RB ( .thorough ) +.B Xdvi +will usually try to ensure that overstrike characters (e.g., +.BR \enotin ) +are printed correctly. On monochrome displays, this is always possible +with one logical operation, either +.I and +or +.IR or . +On color displays, however, this may take two operations, one to set the +appropriate bits and one to clear other bits. If this is the case, then +by default +.B xdvi +will instead use the +.I copy +operation, which does not handle overstriking correctly. The +.B \-thorough +option chooses the slower but more correct choice. See also +.BR \-copy . +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-topmargin " dimen" +.RB ( .topMargin ) +Specifies the top and bottom margins (see +.BR \-margins ). +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-unique +.RB ( .unique ) +This option will make another instance of xdvi running on the same display +act as a `server'. For example, the invocation +.sp +.B xdvi -unique +5 file.dvi +.sp +will cause this other instance to load +.I file.dvi +on page 5 in place of the file that it is currently displaying. If there is +already another instance of xdvi already displaying the file +.IR file.dvi , +then it will just jump to page 5. +If the other instance of xdvi is displaying a different file, it will load +.I file.dvi +instead. Otherwise, if no other instance of +xdvi is currently running on the display, this option instead +starts a new instance of xdvi in the background (unless the +.I \-nofork +option is specified, which see) displaying page 5 of +.IR file.dvi . +.br +The filename and the +.B +n +option for the page number are the only options available for +controlling a remote instance of xdvi like this; all other options are +currently ignored. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-useTeXpages +Use logical \*(Te\& pages (the values of the +.I \ecount0 +register) instead of physical pages for the pagelist labels and +when jumping to a page in a document with the `g' keystroke (or the +.B goto-page() +action). +This option can be toggled via the +.RB ` T ' +keystroke. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-version +Print information on the version of +.BR xdvi . +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-visitedlinkcolor +.RB ( .visitedLinkColor ) +Color used for visited hyperlinks (`Purple4' by default). Hyperlinks become +visited once you click on them. As for +.BR linkColor , +the value should be either a valid X color name or a hexadecimal color string. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-warnspecials +.RB ( .warnSpecials ) +Causes +.B xdvi +to print warnings about +.B \especial +strings that it cannot process to stderr. These warnings are suppressed by default. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-watchfile " n" +.RB ( .watchFile ) +If this option is set to a value larger than 0, xdvi will check +the DVI file for changes every +.I n +seconds. If the DVI file has been completely written by TeX, it will +be reloaded automatically. Fractional values (e.g. `2.5') are +possible. The default for this option is 0, i.e. no watching. +.br +Since xdvi cannot handle partial DVI files, it tries not to reload +the file while it is being rewritten. However, use of the magnifier +or switching of pages requires reading (a part of) the DVI file, and +if the +.B tempfile +option is switched off, this will erase the current contents of the window +until the DVI file can be read entirely. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-wheelunit " pixels" +.RB ( .wheelUnit ) +Sets the number of pixels that a motion of a wheel mouse will move the +image up, down, left, or right. (See the +.B wheel +and +.B hwheel +actions, below, for more information on this.) +If set to zero, the wheel mouse functionality is (essentially) disabled. +The default value is 80. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-xoffset " dimen" +.RB ( .xOffset ) +Specifies the size of the horizontal offset of the output on the page. See +.BR \-offsets . +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-yoffset " dimen" +.RB ( .yOffset ) +Specifies the size of the vertical offset of the output on the page. See +.BR -offsets . +.PP + + + +.SH KEYSTROKES +.B Xdvi +recognizes the following keystrokes when typed in its window. +Each may optionally be preceded by a (positive or negative) number, a +`prefix argument', whose interpretation will depend on the particular keystroke. +This prefix argument can be discarded by pressing the ``Escape'' key. +If present, the ``Help'', ``Prior'' and ``Next'' keys are synonyms for +.RB ` ? ', +.RB ` b ', +and +.RB ` f ' +keys, respectively. +.PP +The key bindings listed here are those that +.B xdvi +assigns by default. The names appearing in brackets at the beginning +of the descriptions are the names of the actions associated with the +keys; these can be used to customize the key bindings, as explained in +more detail in the section +.B CUSTOMIZATION +below. If only a lowercase binding is listed, both upper- and lowercase +keys will work for that binding. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\" +.\" SPECIAL KEYS +.\" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BR ESC " key" +.RB [ discard-number() ] +The escape key discards the numerical prefix for all actions +(useful when you mistyped a number). +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BR Return " key" +.RB [ forward-page() ] +Moves to the next page (or to the +.IR n th +next page if a number is given). Synonyms are +.RB ` n ', +.RB ` f ' +and Line Feed. +.TP +.BR Backspace " key" +.RB [ back-pagee() ] +Moves to the previous page (or back +.I n +pages). Synonyms are +.RB ` p ', +.RB ` b ' +and +.BR Ctrl-h . +.TP +.BR Delete " key" +.RB [ up-or-previous() ] +Moves up two-thirds of a window-full, or to the top of the previous page +if already at the top of the page. With a float argument, moves up the +corresponding fraction of a window-full. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BR Space " key" +.RB [ unpause-or-next() ] +Moves down two-thirds of a window-full, or to the next page if already at +the bottom of the page. +.br +When the option +.BI \-pause " special-string" +is used and the display is currently paused, this key will instead +display the next portion of the page until the next +.I special-string +or the end of the page is encountered. See the description of the +.B \-pause +option for details. The action +.RB [ down-or-next() ] +does a similar thing, but without pausing; it is not bound to a key +by default. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BR Ctrl-Home " (Xaw), " Ctrl-osfBeginLine " (Motif)" +.RB [ goto-page(1) ] +Moves to the first page of the document. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BR Ctrl-End " (Xaw), " Ctrl-osfEndLine " (Motif)" +.RB [ goto-page() ] +Moves to the last page of the document. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BR Home " (Xaw), " osfBeginLine " (Motif)" +.RB [ home-or-top() ] +Move to the ``home'' position of the page, or to the top of the page if +the +.I keep +flag is set (in this case, the page doesn't scroll horizontally). +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BR End " (Xaw), " osfEndLine " (Motif)" +.RB [ end-or-bottom() ] +Move to the ``end'' position of the page (the lower right-hand corner), +or to the bottom of the page if the +.I keep +flag is set (in this case, the page doesn't scroll horizontally). +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\" +.\" ARROW KEYS +.\" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B Down arrow +.RB [ down(0.015) ] +Scrolls page down. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B Up arrow +.RB [ up(0.015) ] +Scrolls page up. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B Right arrow +.RB [ right(0.015) ] +Scrolls page right. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B Left arrow +.RB [ left(0.015) ] +Scrolls page left. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\" +.\" ORDINARY KEYS. Note that the special symbols ([ ] + - etc.) are not in +.\" strict ASCII order (found that more intuitive). Sequence for each letter +.\" is: Alt-Ctrl, Ctrl, uppercase, lowercase. +.\" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B Alt-Ctrl-+ +.RB [ change-density(25) ] +Increase the darkness of the fonts in the DVI window by adding to the gamma value +(see also the +.RB ` S ' +keystroke). +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B Alt-Ctrl-- +.RB [ change-density(-25) ] +Decrease the darkness of the fonts in the DVI window by subtracting from the gamma value +(see also the +.RB ` S ' +keystroke). +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B Ctrl-+ +.RB [ set-shrink-factor(+) ] +Increase the shrink factor (see also the +.RB ` s ' +keystroke). +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B Ctrl-- +.RB [ set-shrink-factor(-) ] +Decrease the shrink factor (see also the +.RB ` s ' +keystroke). +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B Ctr-[ +.RB [ pagehistory-delete-backward() ] +Delete the current item in the page history and move to the history +item before the deleted one. With a prefix argument +.BR n , +delete +.B n +previous history items. See +.B PAGE HISTORY +for details. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B [ +.RB [ pagehistory-back() ] +Move back in the page history (see +.B PAGE HISTORY +for details). With a prefix argument +.BR n , +move back +.B n +history items. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B Ctr-] +.RB [ pagehistory-delete-forward() ] +Delete the current item in the page history and move to the history +item after the deleted one. With a prefix argument +.BR n , +delete +.B n +next history items. See +.B PAGE HISTORY +for details. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B ] +.RB [ pagehistory-forward() ] +Move forward in the page history (see +.B PAGE HISTORY +for details). With a prefix argument +.BR n , +move forward +.B n +history items. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BR ^ +.RB [ home() ] +Move to the ``home'' position of the page. This is normally the upper +left-hand corner of the page, depending on the margins as described in the +.B \-margins +option, above. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B ? +.RB [ help() ] +Same as the +.B h +key (which see). +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B B +.RB [ htex-back() ] +This key jumps back to the previous hyperlink anchor. See the +section +.B HYPERLINKS +for more information on navigating the links. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B b +.RB [ back-page() ] +Moves to the previous page (or back +.I n +pages). Synonyms are +.RB ` p ', +.B Ctrl-h +and +.BR Backspace . +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B C +.RB [ set-color() ] +This key toggles the use of color specials. The key sequences +.RB ` 0C ' +and +.RB ` 1C ' +turn interpretation of color specials off and on, respectively. +See also the +.B \-nocolor +option. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B c +.RB [ center() ] +Moves the page so that the point currently beneath the mouse cursor is moved to +the middle of the window, and warps the mouse cursor to the same place. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B D +.RB [ toggle-grid-mode() ] +This key toggles the use of a grid on the displayed page. +If no number is given, the grid mode is switched on or off. +By prepending a number from 1 to 3, 3 different grid levels can be set. +The units of the grid are inches or centimeters, depending +on whether the paper format is letter (in) or a4 (cm). +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B d +.RB [ down() ] +Moves page down two thirds of a window-full. With a float argument to ``down'', +moves down the corresponding fraction of a window-full. +.\" Therefore, a more +.\" ``smooth'' scrolling using the ``Up'' and ``Down'' keys can be +.\" achieved by the the following setting: +.\" .sp +.\" xdvi.mainTranslations: #override\e +.\" .br +.\" <Key>Up:up(0.01)\en\e +.\" .br +.\" <Key>Down:down(0.01)\en +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B Ctrl-f +.RB [ find() ] +Pop up a window to search for a string in the DVI file. See the section +.BR "STRING SEARCH" , +below, for more details. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B f +.RB [ forward-page() ] +Moves to the next page (or to the +.IR n th +next page if a number is given). Synonyms are +.RB ` n ', +Return, and Line Feed. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B G +.RB [ set-greyscaling() ] +This key toggles the use of greyscale anti-aliasing for displaying shrunken +bitmaps. In addition, the key sequences +.RB ` 0G ' +and +.RB ` 1G ' +clear and set this flag, respectively. See also the +.B \-nogrey +option. +.sp +If given a numeric argument that is not 0 or 1, greyscale anti-aliasing is +turned on, and the gamma resource is set to the value divided by +100. E.g., +.RB ` 150G ' +turns on greyscale and sets gamma to 1.5. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B Ctrl-g +.RB [ find-next() ] +Find the next match string in the DVI file; this can be used instead +of pressing the `Find' button in the search window. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B g +.RB [ goto-page() ] +Moves to the page with the given number. If no page number is given, xdvi jumps to the last page. +.br +If the option/resource +.B useTeXpages +is active, the numbers correspond to the actual page numbers in the TeX file; +otherwise, absolute page numbers (starting from 1) are used. In the latter case, +the page numbers can be changed with the +.RB ` P ' +keystroke, below. +Note that with the +.B useTeXpages +option it is possible that the same page number occurs multiple +times; in such a case, xdvi will use the first page number that matches. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B h +Pops up a help window with a short explanation of the most important key +bindings and concepts. +.\" +.\" Ummh, surely nobody will use the following ... +.\" +.\" For I18n purposes, the help texts and menu entries are configurable +.\" via the following X resources: +.\" .BR helpGeneral , +.\" #ifhyper +.\" .BR helpHypertex , +.\" #endif +.\" .BR helpOthercommands , +.\" .BR helpMarking , +.\" .BR helpPagemotion , +.\" .BR helpMousebuttons , +.\" .BR helpRulermode , +.\" .BR helpSearch and +.\" .BR helpSourcespecials . +.\" The values of this resource should be a text string, the first line of +.\" which should contain two fields separated by `\en'. The first field is +.\" used as list entry for the list of help topics on the left of the help +.\" window, and the second field is used as the heading on the right-hand side. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B k +.RB [ set-keep-flag() ] +Normally when +.B xdvi +switches pages, it moves to the home position as well. The +.RB ` k ' +keystroke toggles a `keep-position' flag which, when set, will keep +the same position when moving between pages. Also +.RB ` 0k ' +and +.RB ` 1k ' +clear and set this flag, respectively. See also the +.B \-keep +option. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B Ctrl-l +.RB [ fullscreen(toggle) ] +Toggles fullscreen mode (see the description of the +.B \-fullscreen +option for more information on this). This is even more flaky than +using the command-line option: There is no universal standard +how a window could change its own geometry or window decorations at +run-time, so this will not work with most window managers or +desktops. Generally, it's better to use the window manager controls to +change the size or decorations of the xdvi window. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B l +.RB [ left() ] +Moves page left two thirds of a window-full. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B M +.RB [ set-margins() ] +Sets the margins so that the point currently under the mouse cursor defines +the upper left-hand corner of the text in the page. Note that the command +does +.I not +move the image, but only determines the margins +for the page switching commands. For details on how the margins +are used, see the +.B \-margins +option. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B m +.RB [ toggle-mark() ] +Toggles the mark for the current page in the page list. When a page +is marked, it is displayed with a small star `*' next to the page number. +The marked pages can then be printed or saved to a file. +A page or several pages can also be marked by clicking or dragging +.B Mouse-2 +in the page list. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B Ctrl-n +.RB [ toggle-mark()forward-page() ] +Toggles the mark for the current page in the page list, and moves to +the next page. This lets you quickly mark a series of subsequent pages. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B n +.RB [ forward-page() ] +Moves to the next page (or to the +.IR n th +next page if a number is given). Synonyms are +.RB ` f ', +Return, and Line Feed. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B Ctrl-o +.RB [ select-dvi-file() ] +Read a new +.I dvi +file. A file-selection widget is popped up for you to choose the DVI +file from. If a prefix argument +.I n +is given, the +.I n th +file from the file history is opened instead. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B P +.RB [ declare-page-number() ] +``This is page number +.IR n .'' +This can be used to make the +.RB ` g ' +keystroke refer to a different page number than the physical page. +(If you want to use `logical' or \*(Te\& page numbers instead of physical pages, +consider using the option +.B \-useTeXpages +instead.) +The argument +.I n +should be given as prefix to this key. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B Ctrl-p +.RB [ print() ] +Opens a popup window for printing the DVI file, or parts of it. +See the section +.B PRINT DIALOG +for an explanation of the options available, and the resources to customize +the default behaviour. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B p +.RB [ back-page() ] +Moves to the previous page (or back +.I n +pages). Synonyms are +.RB ` b ', +.B Ctrl-h +and +.BR Backspace . +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B q +.RB [ quit() ] +Quits the program. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B Ctrl-r +.RB [ forward-page(0) ] +Redisplays the current page. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B R +.RB [ reread-dvi-file() ] +Forces the +.I dvi +file to be reread. This allows you to preview many versions of the same +file while running +.B xdvi +only once. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B r +.RB [ right() ] +Moves page right two thirds of a window-full. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B Ctrl-s +.RB [ save() ] +Opens a popup window for saving the DVI file, or parts of it. See the section +SAVE DIALOG below for more information on this. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B S +.RB [ set-density() ] +Sets the density factor to be used when shrinking bitmaps. This should +be a number between 0 and 100; higher numbers produce lighter characters. +If greyscaling mode is in effect, this changes the value of gamma instead. +The new value of gamma is the given number divided by 100; negative values +are allowed. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B s +.RB [ set-shrink-factor() ] +Changes the shrink factor to the given number. If no number is given, the +smallest factor that makes the entire page fit in the window will be used. +(Margins are ignored in this computation.) +.\" NOTE: following only works in action string, not interactively!!! +.\" Two special values are +.\" .B + +.\" and +.\" .B - +.\" which zoom in and out respectively, by decrementing/incrementing the +.\" shrinkfactor by one step. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B T +.RB [ use-tex-pages() ] +Use logical \*(Te\& pages (the values of the +.I \ecount0 +register) instead of physical pages for the pagelist labels and +when jumping to a page in a document via +.BR goto-page() . +See also the +.B \-useTeXpages +option. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B t +.RB [ switch-magnifier-units() ] +Switches the units used for the magnifier tick marks, and for reporting +the distance between the mouse pointer and the ruler centre in +ruler mode (see the section +.BR MODES ). +The default value is specified by the X resource +.B tickUnits +(`mm' by default). The units toggle through the following +values; except for `px', they all correspond to \*(Te\&'s units: +.I mm +(millimeters) +.I pt +(\*(Te\& points), +.I in +(inches), +.I sp +(scaled points, the unit used internally by \*(Te\&) +.I bp +(big points or `Postscript points'), +.I cc +(cicero points), +.I dd +(didot points), +.I pc +(pica), and +.I px +(screen pixels). +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B Ctrl-u +.RB [ back-page()toggle-mark() ] +Moves to the previous page, and toggles the mark for that page. This +is the dual action to +.BR Ctrl-n . +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B u +.RB [ up() ] +Moves page up two thirds of a window-full. With a float argument to ``up'', +moves up the corresponding fraction of a window-full. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B Ctrl-v +.RB [ show-source-specials() ] +Show bounding boxes for every source special on the current page, and print +the strings contained in these specials to stderr. With prefix 1, +show every bounding box on the page. This is for debugging purposes mainly. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B V +.RB [ set-gs-alpha() ] +This key toggles the anti-aliasing of PostScript<tm> specials when +.B Ghostscript +is used as renderer. In addition the key sequences +.RB ` 0V ' +and +.RB ` 1V ' +clear and set this flag, respectively. See also the +.B \-gsalpha +option. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B v +.RB [ set-ps() ] +This key toggles the rendering of PostScript<tm> specials between 3 states: +.RS 7 +.TP 0 +.SB - specials (like EPS graphics) are displayed; +.TP +.SB - specials are displayed along with their bounding box (if available); +.TP +.SB - only the bounding box is displayed. +.PP +.sp +The states can also be selected directly by using +.RB ` 1v ', +.RB ` 2v ' +and +.RB ` 0v ' +respectively. +See also the +.B \-postscript +option. +.RE +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B Ctrl-x +.RB [ source-what-special() ] +Display information about the source special next to the mouse cursor in the +statusline. This is the same special that would be found by +.IR source-special() , +but without invoking the editor. For debugging purposes. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B x +.RB [ set-expert-mode() ] +Toggles expert mode, in which +the statusline, the scrollbars, the menu buttons, the toolbar (Motif only) +and the page list are not shown. +Typing +.RB ` 1x ' +toggles the display of the statusline at the bottom of +the window. Typing +.RB ` 2x ' +toggles the scrollbars (if available). For Xaw, +.RB ` 3x ' +toggles the menu buttons and the page list, for Motif, +it toggles the page list. In Motif, the additional bindings +.RB ` 4x ' +toggle the toolbar, and +.RB ` 5x ' +the menu bar. +.br +Without a prefix argument, all of the mentioned GUI elements are either +switched on (if they had been invisible before) or off. +.br +Toggling the scrollbars may behave erratically with the +Xaw widgets; e.g. the scrollbars may reappear after +resizing the window, and at certain window sizes one of the +scrollbars may fail to disappear. +.br +See also the option +.B \-expertmode +(the numbers above correspond to the bits in the argument to +.BR \-expertmode ). +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH MOUSE ACTIONS IN THE MAIN WINDOW +The mouse actions can be customized by setting the X resource +.BR mouseTranslations . +Since there are three different mouse modes (see the section +.B MODES +below), there is a special action +.B mouse-modes +which lists the actions for each of the three modes: +\fBmouse-modes("ACTIONS-FOR-MODE1", "ACTIONS-FOR-MODE2", "ACTIONS-FOR-MODE3")\fR. +If only one argument is specified, this action is used for all modes. +The default bindings are as follows: +.RS 5 +.nf +.ft 3 +.sp 1n +xdvi.mouseTranslations: \e +Shift<Btn1Down>:mouse-modes("drag(+)")\en\e +Shift<Btn2Down>:mouse-modes("drag(|)")\en\e +Shift<Btn3Down>:mouse-modes("drag(-)")\en\e +Ctrl<Btn1Down>:mouse-modes("source-special()")\en\e +<Btn1Down>: mouse-modes("do-href()magnifier(*2)", "text-selection()", "ruler()")\en\e +<Btn2Down>: mouse-modes("do-href-newwindow()magnifier(*2)", "text-selection()", "ruler()")\en\e +<Btn3Down>: mouse-modes("magnifier(*3)")\en\e +<Btn4Down>: mouse-modes("wheel(-0.2)")\en\e +<Btn5Down>: mouse-modes("wheel(0.2)")\en\e +<Btn6Down>: mouse-modes("hwheel(-0.2)")\en\e +<Btn7Down>: mouse-modes("hwheel(0.2)")\en\e +.sp 1n +.ft +.fi +.RE +All of these actions are described in more detail below. +Note the use of quote symbols around the action strings, which are necessary +to group them into one argument. +Buttons 4, 5, 6, and 7 refer to wheel movements (wheel up/down/left/right) +on wheel mice. Not all mice support horizontal scrolling. +.PP +The X Toolkit routines that implement translations do not support event +types of +.B Btn6Down +or +.BR Btn7Down . +Because of this, +.B xdvi +implements its own parser for translations given in +.BR mouseTranslations . +This parser is more limited than the parser built in to the X Toolkit. +The string given in +.B mouseTranslations +should not begin with +.RB `` #replace '', +.RB `` #augment '', +or +.RB `` #override ''. +Modifiers of the form +.BI @ keysym +are not supported, and the event type must be of the form +.B BtnDown +or +.BI Btn n Down\fR,\fP +where +.I n +is a positive integer without leading zeroes. Also, some limitations apply +to the action field. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B do-href() +.TP +.B do-href-newwindow() +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +Usually, if a binding specifies more then one action, all actions +are executed in a sequence. The hyperlink bindings +.B do-href() +and +.B do-href-newwindow() +are special in that they are used as an +.I alternative +to other actions that might follow them +.I if +the mouse is currently located on a hyperlink. +In this case, none of the other actions will be executed; +otherwise, only the other actions are executed. +.br +The action +.B do-href() +jumps to the link target in the current xdvi +window (eventually switching to another page), and +.B do-href-newwindow() +opens a new instance of xdvi for the link target. +In both cases, the location of the target is +indicated by a small arrow drawn in the same color +as a visited link +in the left corner of the window. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B magnifier(n x m) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B magnifier(*n) +This action will pop up a ``magnifying glass'' which shows the unshrunk +image of the region around the mouse pointer. The magnifier disappears when +the mouse button is released. Moving the mouse cursor while holding the button down will move the +magnifier. +.br +Different mouse buttons produce different sized +windows, as indicated by the +the argument of the +.I magnifier() +action. Its argument is either a string of the form +.IR width x height , +as in the +.BI \-mgs n +command-line option, or one of the strings +.B *1 +through +.BR *5 , +referring to the value specified by the corresponding +.BI \-mgs n +option. +.\" Note that in order to assign magnifier actions to +.\" the buttons 4 or 5, you need to use the resource +.\" .B wheelTranslations +.\" (more about this resource below), e.g.: +.\" .sp +.\" xdvi.wheelTranslations: <Btn4Down>: magnifier(*4)\en\e +.\" <Btn5Down>: magnifier(*5)\en +.\" .sp +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B drag(+) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B drag(|) +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B drag(-) +Drags the page with the mouse. This action should have one parameter, the character +.RB `` | '', +.RB `` - '', +or +.RB `` + '', +indicating vertical dragging only, horizontal dragging only, or dragging in all +directions. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B source-special() +This action starts a ``reverse search'', +opening the editor at the location in the \*(Te\& file corresponding +to the pointer location in the DVI file. +See the section on SOURCE SPECIALS, below, for more information on this. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B wheel() +This action can be used to scroll the image with a wheel mouse, where it +is usually bound to mouse button 4 (wheel up) or 5 (wheel down). +The action takes one parameter, giving the distance to scroll the +image. If the parameter contains a decimal point, the distance is +given in wheel units; otherwise, pixels. A negative value scrolls up, +a positive value scrolls down. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B hwheel() +This action can be used to scroll the image horizontally with a wheel mouse, +where it is usually bound to mouse button 6 (wheel left) or 7 (wheel right). +The action takes one parameter, giving the distance to scroll the +image. If the parameter contains a decimal point, the distance is +given in wheel units; otherwise, pixels. A negative value scrolls left, +a positive value scrolls right. Not all mice support horizontal scrolling; +this is mostly for touchpads, trackpads, etc. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B text-selection() +This action allows you to mark a rectangular region of text in the DVI file. +The text is put into the X selection buffer and can be pasted into other +applictions (e.g. text editors). This works similar to the Plain text option +in the +.B Save +dialog; see the discussion there for more information on encoding issues. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B ruler() +This action creates a cross-shaped ruler. Moving the mouse and holding +the button down drags the ruler and lets you measure distances on the page. +See the section +.B Ruler Mode +for more information on this. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH UNBOUND ACTIONS +The following actions are not bound to a key by default, but are available +for customization. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B quit-confirm() +Pops up a confirmation window to quit xdvi. To bind it to the +.RB ` q ' +key instead of the default `quit()' action, put the following into your +.I ~/.Xdefaults +file: +.sp +xdvi.mainTranslations: #override\e +.br +<Key>q: quit-confirm()\en +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B down-or-next() +Similar to +.IR unpause-or-next() : +Moves down two-thirds of a window-full, or to the next page if already +at the bottom of the page. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B shrink-to-dpi() +This action takes one (required) argument. It sets the shrink factor to +an integer so as to approximate the use of fonts with the corresponding +number of dots per inch. If +.B xdvi +is using fonts scaled for +.I p +dots per inch, and the argument to +.B shrink-to-dpi +is +.IR n , +then the corresponding shrink factor is the ratio +.IR p / n , +rounded to the nearest integer. +.PP +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH CUSTOMIZATION +Key and mouse button assignments can be changed by setting the +.B mainTranslations +resource to a string of translations as defined in the documentation for the +X toolkit. The actions should take the form of action names listed in the +KEYSTROKES and MOUSE ACTIONS sections. +.PP +An exception to this are the Motif keys +.IR osfPageUp " (" PgUp ), +.IR osfPageDown " (" PgDown ), +.IR osfBeginLine " (" Home ) +and +.IR osfEndLine " (" End ) +which are currently not customizable in the Motif version. +.PP +Key actions will usually be without arguments; if they are passed an argument, +it represents the optional number or `prefix argument' typed prior to the action. +.PP +Some key actions may take special arguments, as follows: The argument of +.B goto-page +may be the letter +.RB ` e ', +indicating the action of going to the end of the document. +The argument of +.B set-shrink-factor +may be the letter +.RB ` a ', +indicating that the shrink factor should be set to the smallest value such that +the page will fit in the window, or one of the signs +.RB ` + ' +or +.RB ` - ', +indicating that the shrink factor should be increased or decreased, respectively. +Finally, actions that would perform a toggle, such as +.BR set-keep-flag , +may receive an argument +.RB ` t ', +indicating that the action should toggle regardless of the current prefix argument. +.PP +Mouse actions should refer only to +.B ButtonPress +events (e.g., +.BR "<Btn1Down>:magnifier(*1)" ). +The corresponding motion and release events will be handled internally. +A key action may be bound to a mouse event, but not vice versa. +.PP +Usually the string of translations should begin with +.RB `` #override '', +indicating that the default key and mouse button assignments should not +be discarded. +.PP +When keys or mouse buttons involving modifiers (such as Ctrl or Shift) +are customized together with their non-modified equivalents, the modified +keys should come first, for example: +.RS 5 +.nf +.ft 3 +.sp 1n +xdvi.mainTranslations: #override \e +Shift<Key>s: select-dvi-file()\en\e +Ctrl<Key>s: save()\en\e +<Key>s: find()\en +.sp 1n +.ft +.fi +.RE +.PP +Because +.B xdvi +needs to capture pointer motion events, and because the X Toolkit +translations mechanism cannot accommodate both motion events and double-click +events at the same time, it is not possible to specify double-click +actions in +.B xdvi +customizations. For information on this and other aspects of translations, +see the X Toolkit Intrinsics documentation. +.PP +There is no command-line option to set the +.B mainTranslations +resource, since changing this resource on the command line would be cumbersome. +To set the resource for testing purposes, use the +.B -xrm +command-line option provided by the X toolkit. For example, +\fBxdvi \-xrm 'XDvi.mainTranslations: #override "z":quit()' ...\fR +or +.B "xdvi \-xrm 'XDvi.mainTranslations: #override <Key>z:quit()' ..." +will cause the key +.RB ` z ' +to quit +.BR xdvi . +.PP +Some resources are provided to allow customization of the geometry of +the Xaw command buttons. Again, they are not changeable via command-line +options, other than via the +.B \-xrm +option. All of these resources take integer values. +.TP +.B buttonSideSpacing +The number of pixels to be placed on either side of the buttons. +The default value is 6. +.TP +.B buttonTopSpacing +The number of pixels between the top button and the top of the window. +The default value is 50. +.TP +.B buttonBetweenSpacing +The number of pixels between the buttons. +The default value is 20. +.TP +.B buttonBetweenExtra +The number of pixels of additional space to be inserted if the +.B buttonTranslations +resource string contains an extra newline character. +The default value is 50. +.TP +.B buttonBorderWidth +The border width of the button windows. The default value is 1. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH PAGE LIST +The scrollable page list on the right of the main window allows you to +jump directly to a page in the DVI file. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B Mouse-1 +Jumps to the page the mouse is located on. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B Mouse-2 +.RB [ toggle-mark() ] +Toggle the mark of the current page. The marks are used by the `Print' +and `Save to file' dialogs to select only marked pages from the DVI file. +.PP +When the mouse pointer is inside the page list, the mouse wheel switches +to the next or previous page. +.PP +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH SCROLLBARS +The scrollbars (if present) behave in the standard way: pushing Button 2 +in a scrollbar moves the top or left edge of the scrollbar to that point +and optionally drags it; +pushing Button 1 moves the image up or right by an amount equal to the distance +from the button press to the upper left-hand corner of the window; pushing +Button 3 moves the image down or left by the same amount. +.PP +The scrollbars can be removed via the +.I -expertmode +flag/keystroke (which see). +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH MAGNIFIER +By default, the mouse buttons 1 to 5 will pop up a ``magnifying glass'' +that shows an unshrunken image of the page (i.e. an image at the resolution +determined by the option/X resource +.B pixels +or +.BR mfmode ) +at varying sizes. When the magnifier is moved, small ruler-like +tick marks are displayed at the edges of the magnifier (unless +the X resource +.B delayRulers +is set to false, in which case the tick marks will always be displayed). +The unit of the marks is determined by the X resource +.B tickUnits +(mm by default). This unit can be changed at runtime via the action +.BR switch-magnifier-units() , +by default bound to the keystroke +.RB ` t ' +(see the description of that key, and of switch-magnifier-units() for +more details on the units available). +.br +The length of the tick marks can be changed via the X resource +.B tickLength +(4 by default). A zero or negative value suppresses the tick marks. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH PAGE HISTORY +.B Xdvi +keeps a history of viewed pages, and you can move through the history +and delete items using the keys +.B [ +.RI ( pagehistory-back() ), +.B ] +.RI ( pagehistory-forward() ), +.B Ctr-[ +.RI ( pagehistory-delete-backward() ) +and +.B Ctr-] +.RI ( pagehistory-delete-forward() ). +.PP +When one of the history commands is used, the page history is displayed +in the status line at the bottom of the window, with the current list +item marked by square brackets `[', `]' and a left and right context of +at most 10 items. File boundaries are marked by `#'. +.PP +The size of the history can be customized with the X resource +.B pageHistorySize +(the default size is 1000 items). If the size is set to 0, the +history commands are disabled. +.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH HYPERLINKS +The actions +.B do-href() +and +.B do-href-newwindow() +(by default bound to Mouse-1 and Mouse-2 if the pointer is currently located +on a hyperlink) can be used to open the link target in the same window +.RB ( do-href() ) +or in a new window +.RB ( do-href-newwindow() ). +.PP +If the link target is not a file on the local disk, +xdvi tries to launch a web browser (as specified by the +.B -browser +command line option, the +.B BROWSER +environment variable or the +.B wwwBrowser +X resource, in this order) to retrieve the document. See the description +of the +.B BROWSER +environment variable, below, for an example setting. +.PP +If the file is a local file, xdvi tries to determine if it is a DVI +file. If it is, xdvi will try to display the file; otherwise it will +try to determine the MIME type of the file, and from that an +application suitable for opening the file. +This is done by parsing the files specified by the environment variable +.B EXTENSIONMAPS +for a mapping of filename extensions to MIME types, +and the files determined by the environment variable +.B MAILCAPS +for a mapping of MIME types to application programs. +See the descriptions of these variables in the section +.BR ENVIRONMENT , +below, for a more detailed description and the default values of these +variables. If no suitable files are found, a set of built-in default +MIME types and applications is used. +.PP +.B Xdvi +currently uses no heuristics apart from the filename suffix +to determine the mime type of a file. If a filename has no suffix, +the value of the resource +.B noMimeSuffix +is used (by default +.IR application/x-unknown ). +If the suffix doesn't match any of the suffixes in +.BR mime.types , +the value of the resource +.B unknownMimeSuffix +is used (by default +.IR application/x-unknown ). +If the +.B mailcap +entries do not list a viewer for a given mime type, xdvi will show +a warning popup. If you want to avoid this warning, and for example +want to always use the netscape browser for unknown MIME types, +you could add the following line to your ~/.mailcap file: +.RS 4 +.nf +.ft 3 +.sp 1n +application/xdvi-unknown; \e + netscape -raise -remote 'openURL(%s,new-window)' +.sp 1n +.ft +.fi +.RE +.\" As an example, consider the following settings, which are the default +.\" settings for buttons 1 and 2: +.\" .RS 5 +.\" .nf +.\" .ft 3 +.\" .sp 1n +.\" xdvi.mainTranslations: #override \e +.\" <Btn1Down>: do-href()magnifier(*1)\en\e +.\" <Btn2Down>: do-href-newwindow()magnifier(*2)\en\e +.\" <Btn3Down>: magnifier(*3)\en +.\" .sp 1n +.\" .ft +.\" .fi +.\" .RE +.\" .PP +.\" If a link points to a file which is not a DVI file (e.g. HTML, or +.\" PostScript), the files +.\" .B mime.types +.\" and +.\" .B mailcap +.\" are parsed to determine a suitable viewer; if no suitable +.\" .B mailcap +.\" entry was found, if the +.\" .SB WWWBROWSER +.\" environment variable is set, or +.\" .B \-browser +.\" was specified on the command line, the browser is launched to load the file. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH STRING SEARCH +The keystroke +.I Ctrl-f +or the menu entry +.I File > Find ... +(or the `Binoculars' symbol in the toolbar, for Motif) +opens a dialog window to search for a text string or +a regular expression in the DVI file. +The keystroke +.I Ctrl-g +jumps to the next match (like pressing the `Find' button in the search window). +.PP +By default, the matches are highlighted in inverted color. +If the display isn't running in TrueColor, or if the X resource +.B matchHighlightInverted +is set to false or the command-line option +.B \-nomatchinverted +is used, xdvi will instead draw a rectangle in +.I highlight +color (see the +.B \-hl +option) around the match. +.PP +If a match crosses a page boundary, only the part on the +first page is highlighted. +.B Xdvi +will scan up to 2 adjacent pages to match strings crossing page +boundaries; but note that header or footer +lines, or intervening float pages will be treated as parts of the +scanned text. Such text will usually cause multi-page matching to fail. +.PP +This emphasizes the fact that searching in the +formatted text (the DVI output) works differently from +searching in the source text: Searching in the DVI file makes it easier to +skip formatting instructions, and makes it possible to search for e.g. +hyphenation and equation numbers; but sometimes the +formatting results can also get in the way, e.g. in the case of +footnotes. In these cases it's better to search in the \*(Te\& source +instead. The use of +.I source specials +will make switching between the +xdvi display and the editor with the \*(Te\& source easier; see the +section +.B SOURCE SPECIALS +below for more information on this. +.PP +The text extracted from the DVI file is in encoded in UTF-8 +(you can view that text by saving the file in UTF-8 format via the +.I File > Save as ... +menu item). +If xdvi has been compiled with locale, +.I nl_langinfo() +and +.I iconv +support, the search term is converted from the character set +specified by the current locale into UTF-8. (See the output of +.B locale -a +for a list of locale settings available on your system). +If +.I nl_langinfo() +is not available, but +.I iconv +is, you can specify the input encoding for +.I iconv +via the X resource +.I textEncoding +(see the output of +.B iconv -l +for a list of valid encodings). If +.I iconv +support is not available, only the encodings +.I ISO-8859-1 +and +.I UTF-8 +are supported (these names are case-insensitive). +.PP +Ideographic characters from CJKV fonts are treated specially: All white space +(spaces and newlines) before and after such characters is ignored in +the search string and in the DVI file. +.PP +To match a newline character, use \fI\en\fR in the search string; +to match the string \fI\en\fR, use \fI\e\en\fR. +.PP +If the checkbox +.I Regular Expression +is activated, the string is treated as a regular expression in +extended POSIX syntax, with the following properties: +.RS 2 +.TP 2 +- +\fIa?\fR matches \fIa\fR zero or one times. +.TP +- +\fIa*\fR matches \fIa\fR zero or more times. +.TP +- +\fIa+\fR matches \fIa\fR one or more times. +Note that \fI*\fR and \fI+\fR are greedy, i.e. they match the longest possible substring. +.TP +- +The pattern \fI.\fR matches any character except for newline. To also match a newline, use `\fI(.|\en)\fR'. +.TP +- +\fIa{n}\fR matches \fIa\fR exactly n times. +.TP +- +\fIa{n,m}\fR matches \fIa\fR at least n and no more than m times. +.TP +- +\fIa|b\fR matches \fIa\fR or \fIb\fR. Brackets can be used +for grouping, e.g.: \fI(a|b)|c\fR. +.TP +- +The string matched by the nth group can be referenced by \fI\en\fR, e.g. \fI\e1\fR refers to the +first match. +.TP +- +The characters \fI^\fR and \fI$\fR match the beginning and the end of a line, respectively. +.TP +- +\fI[abc]\fR matches any of the letters a, b, c, and \fI[a-z]\fR matches all characters from a to z. +.TP +- +Each item in a regular expression can also be one of the following POSIX +character classes: +.br +.nf +.I [[:alnum:]] [[:alpha:]] [[:blank:]] [[:cntrl:]] [[:digit:]] +.I [[:graph:]] [[:lower:]] [[:print:]] [[:space:]] [[:upper:]] +.fi + + +These can be negated by inserting a \fI^\fR symbol after the first bracket: +.I [^[:alpha:]] + +For more details on POSIX regular expressions, see e.g. the +.B IEEE Std 1003.1 +standard definition available online from: + +.nf +http://www.opengroup.org/onlinepubs/007904975/basedefs/xbd_chap09.html +.fi +.TP +- +As a non-standard extension, the following Perl-like abbreviations +can be used instead of the POSIX classes: +.nf +.sp 1n +.ta 1L +8L +30L +Symbol Meaning POSIX Class + + \fI\ew\fR an alphanumeric character \fI[[:alnum:]]\fR + \fI\eW\fR a non-alphanumeric character \fI[^[:alnum:]]\fR + \fI\ed\fR a digit character \fI[[:digit:]]\fR + \fI\eD\fR a non-digit character \fI[^[:digit:]]\fR + \fI\es\fR a whitespace character \fI[[:space:]]\fR + \fI\eS\fR a non-whitespace character \fI[^[:space:]]\fR +.sp 1n +.fi +.TP +- +The following characters are special symbols; they need to be escaped +with \fI\e\fR in order to match them literally: \fI ( ) [ ] . * ? + ^ $ \e\fR. +.TP +- +Matches of length zero are silently skipped. +.RE +.PP +The dialog also provides checkboxes to: +.RS 2 +.TP 2 +- +search backwards; +.TP +- +match in a case-sensitive manner (the default is to ignore case, i.e. a search +string +.I Test +will match both the strings +.I test +and +.I TEST +in the DVI file); +.TP +- +ignore line breaks and hyphens: This removes all hyphens at the ends +of lines and the following newline characters, and replaces all +remaining newline characters by white spaces. So hyphenated words will +appear as one word to the search, and a search for two words with a space +in between will also match the words if they are separated by a linebreak. +.br +Note that the hyphen removal may cause unwanted side effects for compound words +containing hyphens that are wrapped after the hyphen, and that replacing the +newlines affects the interpretation of regular expressions as follows: +The \fI.\fR pattern will also match newlines, and \fI^\fR and \fI$\fR won't match +begin and end of lines any more. (Since currently there is no option for turning +off the greediness of \fI*\fR and \fI+\fR, turning on this option will usually +result in matches that are longer than desired.) +.RE +.PP +The current checkbox settings are saved in the +.I ~/.xdvirc +file. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH PRINT DIALOG +The print dialog window allows you to print all pages, marked pages +(click or drag Mouse-2 in the page list to mark them), or a range +of pages. Note that the page numbers always refer to physical pages, +so if you're using the option `use TeX pages', you may want to disable +it to make it easier to determine the correct page numbers (or avoid this +problem altogether by marking the pages to be printed). +.PP +The value of the +.B Printer +text filed is passed to +.B dvips +via the +.B -o! +mechanism, as a single argument after the `!'. Any arguments +listed in the +.B Dvips options +field are segmented at whitespaces and passed as separate arguments to dvips. +If you e.g. want to print the file 2-up, you should enter +the following string into the +.B Printer +field: +.RS 5 +.nf +.sp 1n + \fIpsnup -2 -q | lpr -Plp\fP +.sp 1n +.fi +.RE +.PP +There are several resources for customizing the behaviour and the default entries +of the print dialog: +.TP +.B dvipsPrinterString +.TP +.B dvipsOptionsString +These can be used to provide default entries for the +.B Printer +and the +.B Dvips options +text fields, respectively. If no paper size is specified in the DVI file +(via e.g. \eusepackage[dvips]{geometry} - this is the preferred method), +the input field is initialized with the current value of the +command line option/X resource +.BR paper . +E.g., the option +.I -paper a4r +is translated into the dvips options +.IR "-t a4 -t landscape" . +Note that no check is performed whether dvips actually understands these +options (it will ignore them if it can't); currently not all options +used by xdvi are also covered by dvips. +.TP +.B dvipsHangTime +.TP +.B dvipsFailHangTime +These specify the time (in milliseconds) that the printing progress window will +stay open after the +.B dvips +process has terminated. The value of +.BR dvipsHangTime +is used if the process terminates successfully; +.B dvipsFailHangTime +is used if it terminates with an error. The default values are 1.5 and 5 seconds, respectively. +If both values are negative, the window will stay open until it is closed by the user. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH SAVE DIALOG +This dialog allows you to save all or selected/marked pages in the current +DVI file. You can save in one of the following formats: +.RS 2 +.TP 2 +- +Postscript (uses +.B dvips +to convert the DVI file to a Postscript file, just like when printing +to a Postscript file). +.TP +- +PDF (first uses +.B dvips +to convert the DVI file to a Postscript file, then uses +.B ps2pdf +to convert the Postscript file to PDF). +.TP +- +Plain text in ISO-8859-1 or UTF-8 encoding. The latter will preserve more +of the special LaTeX characters e.g. from mathematical mode. Note however +that e.g. only few of LaTeX's mathematical symbols can be rendered correctly +as text; so this funcionality works best for plain text documents. +If a character cannot be displayed in the selected +charset, it is replaced by `\e' followed by the hexadecimal character code. +If a character is not recognized at all, it is replaced by `?'. +.RE +.PP +The programs for Postscript and PDF conversion can be customized via +the command line options or X resources +.BR -dvipspath / .dvipsPath +and +.BR -ps2pdfpath / .ps2pdfPath , +respectively; see the explanation of these options above for more details. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH MODES +The keystroke +.B Ctrl-m +[\fBswitch-mode()\fR] +switches between three different mouse bindings, +which can also be activated via the +.B Modes +menu (in Motif, this is a submenu of the +.B Options +menu called +.BR "Mouse Mode" ). +The default mode at startup can be customized via the X resource +.B mouseMode +or the command-line option +.BR \-mousemode . +The default startup mode is Magnifier Mode. +.PP +.B Note: +The modes are implemented by changing the +.I magnifier() +action. Switching the mode will not work if +.B Mouse-1 +has been customized to an action sequence that does +not contain the magnifier() action. +.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B "Magnifier Mode" +In this mode, the mouse buttons 1 to 5 pop up a ``magnifying glass'' +that shows an unshrunken image of the page (i.e. an image at the resolution +determined by the option/X resource +.B pixels +or +.BR mfmode ) +at varying sizes. When the magnifier is moved, small ruler-like +tick marks are displayed at the edges of the magnifier (unless +the X resource +.B delayRulers +is set to false, in which case the tick marks are always displayed). +The unit of the marks is determined by the X resource +.B tickUnits +(mm by default). This unit can be changed at runtime via the action +.BR switch-magnifier-units() , +by default bound to the keystroke +.RB ` t ' +(see the description of that key, and of switch-magnifier-units() for +more details on the units available). +.br +The length of the tick marks can be changed via the X resource +.B tickLength +(4 by default). A zero or negative value suppresses the tick marks. +.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B "Text Selection Mode" +This mode allows you to select a rectangular region of text in the DVI +file by holding down +.B Mouse-1 +and moving the mouse. The text is put into +the X primary selection so that it can be pasted into other X applications +with +.B Mouse-2 +as usual. +.br +If xdvi has been compiled with locale, +.I nl_langinfo() +and +.I iconv +support, the selected text is converted into the character set of the +current locale (see the output of +.B locale -a +for a list of locale settings available on your system). +If +.I nl_langinfo() +is not available, but +.I iconv +is, you can specify the input encoding for +.I iconv +via the X resource +.I textEncoding +(see the output of +.B iconv -l +for a list of valid encodings). If +.I iconv +support is not available, only the encodings +.I ISO-8859-1 +and +.I UTF-8 +are supported (these names are case-insensitive). +.br +Note that UTF-8 is +the only encoding that can render all characters (e.g. mathematical +symbols) of a DVI file. If ISO-8859-1 is active, characters that cannot be displayed +are replaced by `\e' followed by the hexadecimal character code. +For other encodings, such characters may trigger iconv error messages. +If a character is not recognized at all, it is replaced by `?'. +.br +To extract larger portions of text, you can alternatively +save selected pages or the entire file in text format via the +.B File > Save as ... +menu. +.\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B "Ruler Mode" +This mode provides a simple way of measuring distances on the page. +.br +When this mode is activated, the mouse cursor changes into a +thin cross, and a larger, cross-shaped ruler is drawn in the +highlight color at the mouse location. The ruler doesn't have +units attached to it; instead, the current distance between the +ruler and the mouse cursor is continuously printed to the +statusline. +.br +When activating Ruler Mode, the ruler is at first attached to +the mouse and can be moved around. It can then be positioned at +a fixed place by clicking +.BR Mouse-1 . +After that, the mouse cursor +can be moved to measure the horizontal +.RI ( dx ), +vertical +.RI ( dy ) +and direct (shortest) +.RI ( dr ) +distance between the ruler center point and the mouse. +.br +Clicking +.B Mouse-1 +again will move the ruler to the current mouse +position, and holding down +.B Mouse-1 +will drag the ruler around. +.br +In Ruler Mode, the following special keybindings extend or +replace the default bindings: +.RS 7 +.TP 7 +.B o +.RB [ ruler-snap-origin() ] +Snap the ruler back to the origin coordinate (0,0). +.TP +.B t +\fR[overrides \fBswitch-magnifier-units()\fP] +Toggle between various ruler units, which can be specified by the X +resource +.B tickUnits +(`mm' by default). +.TP +.B P +\fR[overrides \fBdeclare-page-number()\fP] +Print the distances shown in the statusline to standard output. +.RE +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH TOOLBAR (Motif only) +The Motif toolbar can also be customized. The XPM file used for the +toolbar icons can be specified via the resource +.BR toolbarPixmapFile , +which should contain a filename that can be found in one of +.B XFILESEARCHPATH +or +.B XDVIINPUTS +(see the section +.B FILE SEARCHING +below for more information on these variables). +.B Xdvi +will try to split this pixmap horizontally into +.I n +pieces, where each piece is as wide as the pixmap is high +and is treated as an image for toolbar button +.IR n . +This means that each icon should be a square, and that the entire +pixmap should have width +\fIn\fR x \fIh\fR if \fIh\fR is the height of the pixmap. +.PP +The resource +.B toolbarTranslations +can be used to map icons/buttons to specific actions. +The resource should contain a string separated by newline characters, +similar to the resources +.B mainTranslations +and +.BR menuTranslations . +Every line must contain either a spacer definition, or an icon definition: +.PP +A spacer definition is a string \fBSPACER(\fIn\fB)\fR, +where +.I n +is the number of pixels inserted as separator to the following button. +.PP +An icon definition is a colon-separated list containing the following elements: +.RS 2 +.TP 2 +.SB - the index of an icon in the pixmap file (starting from zero); +.TP +.SB - a long tooltip string, displayed in the status area; +.TP +.SB - a short tooltip string, displayed as popup; +.TP +.SB - a sequence of actions to be performed when the corresponding toolbar button is pushed. +.RE +.PP +To illustrate this, the default value of +.B toolbarTranslations +looks as follows: +.RS 5 +.nf +.ft 3 +.sp 1n +xdvi.toolbarTranslations: \e + SPACER(5)\en\e + 0:Open a new document (Key\e\e: Ctrl-f):\e + Open file:select-dvi-file()\en\e + SPACER(10)\en\e + 1:Reread this document (Key\e\e: R):\e + Reread file:reread-dvi-file()\en\e + SPACER(10)\en\e + 2:Go to the first page of this document (Key\e\e: 1g):\e + Go to first page:goto-page(1)\en\e + 3:Go to the previous page of this document (Key\e\e: p):\e + Go to previous page:back-page(1)\en\e + 4:Go to the next page of this document (Key\e\e: n):\e + Go to next page:forward-page(1)\en\e + 5:Go to the last page of this document (Key\e\e: g):\e + Go to last page:goto-page()\en\e + SPACER(10)\en\e + 6:Enlarge the display (Key\e\e: Ctrl-+):Zoom in:\e + set-shrink-factor(+)\en\e + 7:Shrink the display (Key\e\e: Ctrl--):Zoom out:\e + set-shrink-factor(-)\en\e + SPACER(10)\en\e + 8:Jump back to the previous hyperlink (Key\e\e: B):\e + Back hyperlink:htex-back()\en\e + SPACER(10)\en\e + 10:Print this document:Print:print()\en\e + SPACER(10)\en\e + 11:Toggle marks for odd pages (Key\e\e: 1m):\e + Toggle odd:toggle-mark(1)\en\e + 12:Toggle marks for even pages (Key\e\e: 2m):\e + Toggle even:toggle-mark(2)\en\e + 13:Toggle mark for current page (Key\e\e: 2m):\e + Toggle current:toggle-mark()\en\e + 14:Unmark all pages (Key\e\e: 0m):\e + Unmark all:toggle-mark(0)\en\e + SPACER(10)\en\e + 18:Display fonts darker (Key\e\e: Alt-Ctrl-+):\e + Fonts darker:change-density(5)\en\e + 19:Display fonts lighter (Key\e\e: Alt-Ctrl--):\e + Fonts lighter:change-density(-5)\en +.sp 1n +.ft +.fi +.RE +.PP +When the mouse remains over a toolbar button for a certain period, a `tooltip' +window is shown, describing what the button does using the +.I short tooltip string +from the above resource. At the same time, the +.I long tooltip string +is displayed in the statusline. +The appearance and behaviour of these tooltips can be customized via +the following resources: +.TP +.B tipShell.background +Background color of the tooltip window. +.TP +.B tipShell.fontSet +Font used for the tooltip. +.TP +.B tipShell.waitPeriod +The time (in milliseconds) the mouse pointer needs to be over +the button before the tooltip is shown. Set it to a negative value +to suppress the tooltips altogether. + +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH GREYSCALING AND COLORMAPS +The greyscale anti-aliasing feature in +.B xdvi +will not work at its best if the display does not have enough colors available. +This can happen if other applications are using most of the colormap +(even if they are iconified). If this occurs, then +.B xdvi +will print an error message and turn on the +.B -copy +option. This will result in overstrike characters appearing wrong; +it may also result in poor display quality if the number of available +colors is very small. +.PP +Typically this problem occurs on displays that allocate eight bits +of video memory per pixel. To see how many bits per pixel your display +uses, type +.B xwininfo +in an +.B xterm +window, and then click the mouse on the root window when asked. The +``Depth:'' entry will tell you how many bits are allocated per pixel. +.PP +Displays using at least 15 bits per pixel are typically +.B TrueColor +visuals, which do not have this problem, since their colormap is +permanently allocated and available to all applications. (The visual +class is also displayed by +.BR xwininfo .) +For more information on visual classes see the documentation for the +X Window System. +.PP +To alleviate this problem, therefore, one may (a) run with more bits +per pixel (this may require adding more video memory or replacing the video +card), (b) shut down other applications that may be using much of the colormap +and then restart +.BR xdvi , +or (c) run +.B xdvi +with the +.B \-install +option. +.PP +One application which is often the cause of this problem is +.BR Netscape . +In this case there are two more alternatives to remedying the situation. +One can run +.RB `` "netscape -install" '' +to cause +.B Netscape +to install a private colormap. This can cause colors to change in +bizarre ways when the mouse is moved to a different window. +Or, one can run +.RB `` "netscape -ncols 220" '' +to limit +.B Netscape +to a smaller number of colors. A smaller number will ensure that +other applications have more colors available, but will degrade the +color quality in the +.B Netscape +window. + +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH HANDLING OF POSTSCRIPT FIGURES +.B Xdvi +can display Encapsulated PostScript (EPS) files included in the +.I dvi +file. Such files are first searched for in the directory where the +.I dvi +file is, and then using normal +.B Kpathsea +rules. There is an exception to this, however: if the file name begins +with a backtick +.RB ( ` ), +then the remaining characters in the file name give a shell command (often +.BR zcat ) +which is executed; its standard output is then sent to be interpreted as +PostScript. +Since the execution of arbitrary shell commands with the user's +permissions is a huge security risk, evaluation of these backtick +commands is disabled by default. It needs to be activated via the +.B \-allowshell +command-line option. +.B NOTE: +You should never use this option when viewing documents that you +didn't compile yourself. The backtick specials are not needed for +uncompressing gzipped Postscript files, since +.B xdvi +can do that on the fly if the filename ends with +.I .eps.gz +or +.I .eps.Z +(and if the first bytes of the file indicate that the file is indeed +compressed). This is both safer and more flexible than the backtick +approach, since the default file searching rules will apply to such +filenames too. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH T1LIB +Using T1Lib, a library written by Rainer Menzner +(see ftp://sunsite.unc.edu/pub/Linux/libs/graphics/), +.B xdvi +can render Postscript<tm> Type1 fonts directly, without the +route via \*(Te\& pixel (pk) +fonts. The advantage of this is that only one size of each font needs +to be stored on disk. +Unless the +.B -not1lib +option is used, +.B xdvi +will try to render every font using T1Lib. Only as a fallback it will +invoke an external program (like +.BR mktexpk , +which in turn may invoke utilities like +.B ps2pk +or +.BR gsftopk ) +to generate a pixel font from the Type1 source. The direct rendering +of the +.B Computer Modern +fonts should work out-of-the box, whereas other Type1 fonts such as +the 35 `standard' Postscript<tm> fonts resident in printers may need +to be made accessible for use with xdvi, unless your system +administrator or TeX distribution has already done so (which is the case +e.g. for current teTeX systems). The +.B xdvik +distribution comes with a utility called +.B t1mapper +to make these fonts available for xdvi; +see the manual page for t1mapper(1) for usage details. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH SPECIALS (GENERALLY) +Any of the specials used by +.B xdvi +may be preceded by the characters +.RB `` xdvi: ''. +Doing so does not change the behavior of the special under +.BR xdvi , +but it tells other dvi drivers (such as e.g. dvips) to ignore the special. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH SOURCE SPECIALS +Some \*(Te\& implementations or macro packages provide the facility to +automatically include so-called `source specials' into a DVI file. +These contain the line number, eventually a column number, and the +filename of the .tex source. This makes it possible to jump from a .dvi +file to the corresponding place in the .tex source and vice versa (also +called `inverse search' - jumping from the DVI file to the TeX file is +also known as `reverse search', and jumping from the TeX file to the +DVI file as `forward search'). +.P +To be usable with +.BR xdvi , +source specials in the +.I dvi +file must have one of the following formats: +.RS 5 +.nf +.sp 1n + \fBsrc:\fP\fIline\fP[ ]\fIfilename\fP + \fBsrc:\fP\fIline\fP\fB:\fP\fIcol\fP[ ]\fIfilename\fP + \fBsrc:\fP\fIline\fP + \fBsrc:\fP\fIline\fP\fB:\fP\fIcol\fP + \fBsrc::\fP\fIcol\fP +.sp 1n +.fi +.RE +If +.I filename +or +.I line +are omitted, the most recent values are used. The first source special on +each page must be in one of the first two forms, since defaults are not +inherited across pages. +.sp +You will need a \*(Te\& implementation that provides an appropriate +switch (e.g. +.IR -src ) +or a macro package +(such as +.I srcltx.sty +or +.IR srctex.sty , +available from CTAN:macros/latex/contrib/supported/srcltx/) +to insert such source specials into the DVI file. +.sp +For reverse search, the combination +.I Ctrl-Mouse 1 +will make xdvi open an editor (the value of the +.I \-editor +command line option) with the file and the line number of the .tex +source. See the description of the +.I \-editor +option for more information +and example settings. +.P +For forward search, +.B xdvi +has a +.I \-sourceposition +option that makes +.B xdvi +jump to the page in +the DVI file corresponding to the given line (or the closest +line having a source special) of the specified file and highlight +the found region. See the description of the +.I \-sourceposition +option for more details. +.PP +More information on setting up various editors for use with source +specials can be found at: +.RS 5 +.nf +.sp 1n +http://xdvi.sourceforge.net/inverse-search.html +.sp 1n +.fi +.RE +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH PAPERSIZE SPECIALS +.B xdvi +accepts specials to set the paper size for the document. These specials +should be of the form +.RS 5 +.nf +.sp 1n + \fBpapersize=\fP[\fB*\fP]\fIwidth\fP,\fIheight\fP +.sp 1n +.fi +.RE +.PP +where +.I width +and +.I height +give the width and height of the paper, respectively. Each of these should +appear in the form of a decimal number followed by any of the two-letter +abbreviations for units accepted by \*(Te\& +.RB ( pt , +.BR pc , +.BR in , +.BR bp , +.BR cm , +.BR mm , +.BR dd , +.BR cc , +or +.BR sp ). +If an asterisk +.RB ( * ) +appears just before the width, then the measurements refer to the document +dimensions (e.g., +.B pt +as opposed to +.BR truept ). +This allows a macro package to vary the page size according to elements +of the document; e.g., +.RS 5 +.ft 3 +.nf +.sp 1n +\especial{xdvi: papersize=*\enumber\ewd\emybox sp, + \enumber\eht\emybox sp} +.sp 1n +.ft +.fi +.RE +.PP +Except for the asterisk, this format is compatible with +.BR dvips . +.P +The last +.B papersize +special on a page determines the size of that page. If there is no such +special on a given page, the most recent +.B papersize +is used, or, if there are no +.B papersize +specials on any preceding page, then the value of the +.B paper +resource (or +.B \-paper +option on the command line) is used. Thus the paper size may vary for +different pages of the +.I dvi +file. +.P +If the +.B paper +resource (or +.B \-paper +command-line option) begins with a plus sign +.RB (` + '), +then all +.B papersize +specials in the +.I dvi +file are ignored. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH COLOR SPECIALS +The color specials supported by +.B xdvi +are the same as those supported by +.BR dvips , +except that the literal PostScript color specification (as in the +.B AggiePattern +example in the +.B dvips +documentation) is not supported. +There are also some restrictions due to the way xdvi's drawing routines +are implemented; e.g. the +.B \ecolorbox +and +.B \efcolorbox +macros don't work with +.BR xdvi . +See the section LIMITATIONS below for more information on these restrictions. +.B Xdvi +supports the same list of named colors as +.B dvips +does, namely: +.P +.BR Apricot , +.BR Aquamarine , +.BR Bittersweet , +.BR Black , +.BR Blue , +.BR BlueGreen , +.BR BlueViolet , +.BR BrickRed , +.BR Brown , +.BR BurntOrange , +.BR CadetBlue , +.BR CarnationPink , +.BR Cerulean , +.BR CornflowerBlue , +.BR Cyan , +.BR Dandelion , +.BR DarkOrchid , +.BR Emerald , +.BR ForestGreen , +.BR Fuchsia , +.BR Goldenrod , +.BR Gray , +.BR Green , +.BR GreenYellow , +.BR JungleGreen , +.BR Lavender , +.BR LimeGreen , +.BR Magenta , +.BR Mahogany , +.BR Maroon , +.BR Melon , +.BR MidnightBlue , +.BR Mulberry , +.BR NavyBlue , +.BR OliveGreen , +.BR Orange , +.BR OrangeRed , +.BR Orchid , +.BR Peach , +.BR Periwinkle , +.BR PineGreen , +.BR Plum , +.BR ProcessBlue , +.BR Purple , +.BR RawSienna , +.BR Red , +.BR RedOrange , +.BR RedViolet , +.BR Rhodamine , +.BR RoyalBlue , +.BR RoyalPurple , +.BR RubineRed , +.BR Salmon , +.BR SeaGreen , +.BR Sepia , +.BR SkyBlue , +.BR SpringGreen , +.BR Tan , +.BR TealBlue , +.BR Thistle , +.BR Turquoise , +.BR Violet , +.BR VioletRed , +.BR White , +.BR WildStrawberry , +.BR Yellow , +.BR YellowGreen , +.BR YellowOrange . +.P +Note that these names are case sensitive. +.P +The documentation of the La\*(Te\& +.B color +package provides more details on how to use such specials with +La\*(Te\&; see the +.B dvips +documentation for a detailed description of the +syntax and semantics of the color specials. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH SIGNALS +When +.B xdvi +receives a +.SB SIGUSR1 +signal, it rereads the +.I dvi +file. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH ENVIRONMENT +.B Xdvik +uses the same environment variables and algorithms for searching for +font files as \*(Te\& and friends. See the documentation for the +.B Kpathsea +library, +.BR kpathsea.dvi , +for a detailed description of these. +.PP +In addition, +.B xdvik +accepts the following variables: +.TP +.SB DISPLAY +Specifies which graphics display terminal to use. +.TP +.SB KPATHSEA_DEBUG +Trace +.B Kpathsea +lookups; set it to +.B -1 +(= all bits on) for complete tracing. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.SB EXTENSIONMAPS +A list of files to be searched for mime types entries (as for Acrobat Reader). +Earlier entries in one of these files override later ones. +If this variable is not set, the following default path is used: +.RS 7 +.nf +.ft 3 +.sp 1n +$HOME/.mime.types:/etc/mime.types:\e + /usr/etc/mime.types:/usr/local/etc/mime.types +.sp 1n +.ft +.fi +.RE + +.TP +.SB MAILCAPS +A list of files to be searched for mailcap entries, as defined by RFC +1343. See this RFC or the +.BR mailcap (4) +manual page for a detailed description of the mailcap file format. +Currently, only the following mailcap features are supported: +.RS 7 +.TP 7 +.BI test= command +The entry is only used if +.I command +can be executed via the +.B system() +call and if the system() call returns with value 0 (success). +The +.I command +string may contain the format string +.IR %s , +which will be replaced by the file name. +.TP +.BI needsterminal +If this flag is used, the command will be executed in a new xterm +window by prepending +.RI `` "xterm -e "'' +to the command string. +.RE +.PP +.RS 7 +All other fields in the mailcap entry are ignored by xdvi. +Earlier entries in one of these files override later ones. +If the variable is not defined, the following default path is used: +.RS 4 +.nf +.ft 3 +.sp 1n +$HOME/.mailcap:/etc/mailcap:/usr/etc/mailcap:\e + /usr/local/etc/mailcap +.sp 1n +.ft +.fi +.RE +.br +For security reasons, some special characters (i.e.: ( ) ` \e ;) +are escaped in the argument before passing it to +.BR system() . +.RE +.TP +.SB BROWSER +Determines the web browser used to open external links (i.e., all URLs that don't +start with the +.RI ` file: ' +scheme and are not relative links in the local DVI file), and to open links +for which no viewer has been specified in the +.B mailcap +files. The value of this variable is a colon-separated list of commands. Xdvi +will try each of them in sequence until one succeeds (i.e. doesn't immediately +return with status 0). This allows you to +specify your favourite browser at the beginning, +and fallback browsers at the end. Every occurrence of +.I %s +in the string is replaced by the target URL; every occurrence of +.I %% +is replaced by a single +.IR % . +If no +.I %s +is present, the URL string is added as an extra argument. +.br +An example setting is: +.RS 7 +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP 7 +.SB "netscape -raise -remote 'openURL(%s,new-window)':xterm -e lynx %s:xterm -e wget %s:lynx %s:wget %s" +.TP +See +.TP +.SB http://www.catb.org/~esr/BROWSER/ +.PP +for more details on the +.B BROWSER +environment variable. +.RE +.TP +.SB TMPDIR +The directory to use for storing temporary files created when uncompressing +PostScript files. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.SB XEDITOR +Determines the editor command used for source special `reverse +search', if neither the +.I \-editor +command-line option +nor the +.I .editor +resource are specified. See the description of the +.I \-editor +command line option for details on the format. +.TP +.SB VISUAL +Determines an editor to be opened in an xterm +window if neither of +.IR -editor , +.IR .editor , +or +.I XEDITOR +is specified. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.SB EDITOR +Determines an editor to be opened in an xterm +window if neither of +.IR -editor , +.IR .editor , +.I XEDITOR +or +.I VISUAL +is specified. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.SB WWWBROWSER +Obsolete; use +.B BROWSER +instead. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.SH LIMITATIONS +.B xdvi +accepts many but not all types of PostScript specials accepted by +.BR dvips . +For example, it accepts most specials generated by +.B epsf +and +.BR psfig . +It does not, however, support +.B bop\-hook +or +.BR eop\-hook , +nor does it allow PostScript commands to affect the rendering of things that +are not PostScript (for example, the ``NEAT'' and rotated ``A'' examples in the +.B dvips +manual). These restrictions are due to the design of +.BR xdvi ; +in all likelihood they will always remain. +.PP +La\*(Te\&2e rotation specials are currently not supported. +.PP +.B MetaPost +files containing included text are not supported. +.PP +.BR Xdvi 's +color handling doesn't support the +.B \ecolorbox +and +.B \efcolorbox +macros; this is not likely to change in the near future. This also +means that e.g. colored tables (as created by the +.I colortbl +package) may render incorrectly: Text in colors different from the +default foreground color may not be displayed. When the page is +redrawn (e.g. after using the magnifier), the background color of the +cells may overdraw the text. +.SH FILES +.TP +.SB $HOME/.xdvirc +A file that holds all settings that the user changed via the keys, the `Options' +and the Xaw `Modes' menu and the dialogs, as X resources. These resources override the +settings in +.BR $HOME/.Xdefaults . +This file is ignored if the +.B \-q +option is used or the +.B noInitFile +X resource is set. +.TP +.SB xdvi.cfg +A configuration file for the T1 font setup which needs to be supplied +in the directory determined by the +.B XDVIINPUTS +environment variable. Please see the file +.B http://xdvi.sourceforge.net/README.t1fonts +if that file is missing. +.SH SEE ALSO +.BR X (1), +.BR dvips (1), +.BR mktexpk (1), +.BR ps2pk (1), +.BR gsftopk (1), +.BR t1mapper (1), +.BR mailcap (4), +the +.B Kpathsea +documentation, +and the Xdvik home page at +.BR http://xdvi.sourceforge.net/ . +.SH AUTHORS +Eric Cooper, CMU, did a version for direct output to a QVSS. Modified +for X by Bob Scheifler, MIT Laboratory for Computer Science. Modified +for X11 by Mark Eichin, MIT SIPB. Additional enhancements by many +others. +.PP +The current maintainer of the original +.B xdvi +is Paul Vojta, U.C. Berkeley. +.PP +Code for the xdvik variant has been contributed +by many people, whose names are scattered across the +source files. Xdvik is hosted on +.B CTAN:dviware/xdvik +and on SourceForge; for the most up-to-date information, please +visit: +.PP +.B http://xdvi.sourceforge.net +.PP +Please report all bugs to the SourceForge bug tracker: +.PP +.nf +.B http://sourceforge.net/tracker/?func=add&group_id=23164&atid=377580 +.PP + diff --git a/Master/texmf-dist/doc/man/man1/xdvi.man1.pdf b/Master/texmf-dist/doc/man/man1/xdvi.man1.pdf Binary files differnew file mode 100644 index 00000000000..d3498c813db --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/xdvi.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/xindy.1 b/Master/texmf-dist/doc/man/man1/xindy.1 new file mode 100644 index 00000000000..506fcf972e9 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/xindy.1 @@ -0,0 +1,422 @@ +.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.04) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "xindy 1" +.TH xindy 1 "2010-05-10" "Version 1.16" "xindy" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +xindy \- create sorted and tagged index from raw index +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +.Vb 4 +\& xindy [\-V?h] [\-qv] [\-d magic] [\-o outfile.ind] [\-t log] \e +\& [\-L lang] [\-C codepage] [\-M module] [\-I input] \e +\& [\-\-interactive] [\-\-mem\-file=xindy.mem] \e +\& [idx0 idx1 ...] +.Ve +.Sh "GNU-Style Long Options for Short Options:" +.IX Subsection "GNU-Style Long Options for Short Options:" +.Vb 11 +\& \-V / \-\-version +\& \-? / \-h / \-\-help +\& \-q / \-\-quiet +\& \-v / \-\-verbose +\& \-d / \-\-debug (multiple times) +\& \-o / \-\-out\-file +\& \-t / \-\-log\-file +\& \-L / \-\-language +\& \-C / \-\-codepage +\& \-M / \-\-module (multiple times) +\& \-I / \-\-input\-markup (supported: latex, omega, xindy) +.Ve +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +\&\fBxindy\fR is the formatter-indepedent command of xindy, the flexible +indexing system. It takes a raw index as input, and produces a merged, +sorted and tagged index. Merging, sorting, and tagging is controlled +by xindy style files. +.PP +Files with the raw index are passed as arguments. If no arguments are +passed, the raw index will be read from standard input. +.PP +\&\fBxindy\fR is completely described in its manual that you will find on +its Web Site, http://www.xindy.org/. A good introductionary +description appears in the indexing chapter of the LaTeX Companion (2nd ed.) +.PP +If you want to produce an index for LaTeX documents, the command +\&\fItexindy\fR\|(1) is probably more of interest for you. It is a wrapper for +\&\fBxindy\fR that turns on many LaTeX conventions by default. +.SH "OPTIONS" +.IX Header "OPTIONS" +.ie n .IP """\-\-version""\fR / \fB\-V" 4 +.el .IP "\f(CW\-\-version\fR / \fB\-V\fR" 4 +.IX Item "--version / -V" +output version numbers of all relevant components and exit. +.ie n .IP """\-\-help""\fR / \fB\-h\fR / \fB\-?" 4 +.el .IP "\f(CW\-\-help\fR / \fB\-h\fR / \fB\-?\fR" 4 +.IX Item "--help / -h / -?" +output usage message with options explanation. +.ie n .IP """\-\-quiet""\fR / \fB\-q" 4 +.el .IP "\f(CW\-\-quiet\fR / \fB\-q\fR" 4 +.IX Item "--quiet / -q" +Don't output progress messages. Output only error messages. +.ie n .IP """\-\-verbose""\fR / \fB\-v" 4 +.el .IP "\f(CW\-\-verbose\fR / \fB\-v\fR" 4 +.IX Item "--verbose / -v" +Output verbose progress messages. +.ie n .IP """\-\-debug""\fR \fImagic\fR / \fB\-d\fR \fImagic" 4 +.el .IP "\f(CW\-\-debug\fR \fImagic\fR / \fB\-d\fR \fImagic\fR" 4 +.IX Item "--debug magic / -d magic" +Output debug messages, this option may be specified multiple times. +\&\fImagic\fR determines what is output: +.Sp +.Vb 6 +\& magic remark +\& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +\& script internal progress messages of driver scripts +\& keep_tmpfiles don\*(Aqt discard temporary files +\& markup output markup trace, as explained in xindy manual +\& level=n log level, n is 0 (default), 1, 2, or 3 +.Ve +.ie n .IP """\-\-out\-file""\fR \fIoutfile.ind\fR / \fB\-o\fR \fIoutfile.ind" 4 +.el .IP "\f(CW\-\-out\-file\fR \fIoutfile.ind\fR / \fB\-o\fR \fIoutfile.ind\fR" 4 +.IX Item "--out-file outfile.ind / -o outfile.ind" +Output index to file \fIoutfile.ind\fR. If this option is not passed, the +name of the output file is the base name of the first argument and the +file extension \fIind\fR. If the raw index is read from standard input, +this option is mandatory. +.ie n .IP """\-\-log\-file""\fR \fIlog.ilg\fR / \fB\-t\fR \fIlog.ilg" 4 +.el .IP "\f(CW\-\-log\-file\fR \fIlog.ilg\fR / \fB\-t\fR \fIlog.ilg\fR" 4 +.IX Item "--log-file log.ilg / -t log.ilg" +Output log messages to file \fIlog.ilg\fR. These log messages are +independent from the progress messages that you can influence with +\&\f(CW\*(C`\-\-debug\*(C'\fR or \f(CW\*(C`\-\-verbose\*(C'\fR. +.ie n .IP """\-\-language""\fR \fIlang\fR / \fB\-L\fR \fIlang" 4 +.el .IP "\f(CW\-\-language\fR \fIlang\fR / \fB\-L\fR \fIlang\fR" 4 +.IX Item "--language lang / -L lang" +The index is sorted according to the rules of language \fIlang\fR. These +rules are encoded in a xindy module created by \fImake-rules\fR. +.Sp +If no input encoding is specified via \f(CW\*(C`\-\-codepage\*(C'\fR, a xindy module +for that language is searched with a latin, a cp, an iso, or ascii +encoding, in that order. +.ie n .IP """\-\-codepage""\fR \fIenc\fR / \fB\-C\fR \fIenc" 4 +.el .IP "\f(CW\-\-codepage\fR \fIenc\fR / \fB\-C\fR \fIenc\fR" 4 +.IX Item "--codepage enc / -C enc" +The raw input is in input encoding \fIenc\fR. This information is used to +select the correct xindy sort module and also the \fIinputenc\fR target +encoding for \f(CW\*(C`latex\*(C'\fR input markup. +.Sp +When \f(CW\*(C`omega\*(C'\fR input markup is used, \f(CW\*(C`utf8\*(C'\fR is always used as +codepage, this option is then ignored. +.ie n .IP """\-\-module""\fR \fImodule\fR / \fB\-M\fR \fImodule" 4 +.el .IP "\f(CW\-\-module\fR \fImodule\fR / \fB\-M\fR \fImodule\fR" 4 +.IX Item "--module module / -M module" +Load the xindy module \fImodule.xdy\fR. This option may be specified +multiple times. The modules are searched in the xindy search path that +can be changed with the environment variable \f(CW\*(C`XINDY_SEARCHPATH\*(C'\fR. +.ie n .IP """\-\-input\-markup""\fR \fIinput\fR / \fB\-I\fR \fIinput" 4 +.el .IP "\f(CW\-\-input\-markup\fR \fIinput\fR / \fB\-I\fR \fIinput\fR" 4 +.IX Item "--input-markup input / -I input" +Specifies the input markup of the raw index. Supported values for +\&\fIinput\fR are \f(CW\*(C`latex\*(C'\fR, \f(CW\*(C`omega\*(C'\fR, and \f(CW\*(C`xindy\*(C'\fR. +.Sp +\&\f(CW\*(C`latex\*(C'\fR input markup is the one that is emitted by default from the +LaTeX kernel, or by the \f(CW\*(C`index\*(C'\fR macro package of David Jones. +^^\-notation of single byte characters is supported. Usage of LaTeX's +\&\fIinputenc\fR package is assumed as well. +.Sp +\&\f(CW\*(C`omega\*(C'\fR input markup is like \f(CW\*(C`latex\*(C'\fR input markup, but with Omega's +^^\-notation as encoding for non-ASCII characters. LaTeX \fIinputenc\fR +encoding is not used then, and \f(CW\*(C`utf8\*(C'\fR is enforced to be the codepage. +.Sp +\&\f(CW\*(C`xindy\*(C'\fR input markup is specified in the xindy manual. +.ie n .IP """\-\-interactive""" 4 +.el .IP "\f(CW\-\-interactive\fR" 4 +.IX Item "--interactive" +Start xindy in interactive mode. You will be in a xindy read-eval-loop +where xindy language expressions are read and evaluated interactively. +.ie n .IP """\-\-mem\-file""\fR \fIxindy.mem" 4 +.el .IP "\f(CW\-\-mem\-file\fR \fIxindy.mem\fR" 4 +.IX Item "--mem-file xindy.mem" +This option is only usable for developers or in very rare situations. +The compiled xindy kernel is stored in a so-called \fImemory file\fR, +canonically named \fIxindy.mem\fR, and located in the xindy library +directory. This option allows to use another xindy kernel. +.SH "SUPPORTED LANGUAGES / CODEPAGES" +.IX Header "SUPPORTED LANGUAGES / CODEPAGES" +The following languages are supported: +.Sh "Latin scripts" +.IX Subsection "Latin scripts" +.Vb 10 +\& albanian gypsy portuguese +\& croatian hausa romanian +\& czech hungarian russian\-iso +\& danish icelandic slovak\-small +\& english italian slovak\-large +\& esperanto kurdish\-bedirxan slovenian +\& estonian kurdish\-turkish spanish\-modern +\& finnish latin spanish\-traditional +\& french latvian swedish +\& general lithuanian turkish +\& german\-din lower\-sorbian upper\-sorbian +\& german\-duden norwegian vietnamese +\& greek\-iso polish +.Ve +.PP +German recognizes two different sorting schemes to handle umlauts: +normally, \f(CW\*(C`a\*:\*(C'\fR is sorted like \f(CW\*(C`ae\*(C'\fR, but in phone books or +dictionaries, it is sorted like \f(CW\*(C`a\*(C'\fR. The first scheme is known as +\&\fI\s-1DIN\s0 order\fR, the second as \fIDuden order\fR. +.PP +\&\f(CW\*(C`*\-iso\*(C'\fR language names assume that the raw index entries are in \s-1ISO\s0 +8859\-9 encoding. +.PP +\&\f(CW\*(C`gypsy\*(C'\fR is a northern Russian dialect. +.Sh "Cyrillic scripts" +.IX Subsection "Cyrillic scripts" +.Vb 3 +\& belarusian mongolian serbian +\& bulgarian russian ukrainian +\& macedonian +.Ve +.Sh "Other scripts" +.IX Subsection "Other scripts" +.Vb 1 +\& greek klingon +.Ve +.Sh "Available Codepages" +.IX Subsection "Available Codepages" +This is not yet written. You can look them up in your xindy +distribution, in the \fImodules/lang/language/\fR directory (where +\&\fIlanguage\fR is your language). They are named +\&\fIvariant\-codepage\-lang.xdy\fR, where \fIvariant\-\fR is most often empty +(for german, it's \f(CW\*(C`din5007\*(C'\fR and \f(CW\*(C`duden\*(C'\fR; for spanish, it's \f(CW\*(C`modern\*(C'\fR +and \f(CW\*(C`traditional\*(C'\fR, etc.) +.PP +.Vb 1 +\& < Describe available codepages for each language > +\& +\& < Describe relevance of codepages (as internal representation) for +\& LaTeX inputenc > +.Ve +.SH "ENVIRONMENT" +.IX Header "ENVIRONMENT" +.ie n .IP """XINDY_SEARCHPATH""" 4 +.el .IP "\f(CWXINDY_SEARCHPATH\fR" 4 +.IX Item "XINDY_SEARCHPATH" +A list of directories where the xindy modules are searched in. No +subtree searching is done (as in TDS-conformant TeX). +.Sp +If this environment variable is not set, the default is used: +\&\f(CW\*(C`.:\*(C'\fR\fImodules_dir\fR\f(CW\*(C`:\*(C'\fR\fImodules_dir\fR\f(CW\*(C`/base\*(C'\fR. \fImodules_dir\fR is +determined at run time, relative to the \fBxindy\fR command location: +Either it's \fI../modules\fR, that's the case for \fIopt\fR\-installations. +Or it's \fI../lib/xindy/modules\fR, that's the case for +\&\fIusr\fR\-installations. +.ie n .IP """XINDY_LIBDIR""" 4 +.el .IP "\f(CWXINDY_LIBDIR\fR" 4 +.IX Item "XINDY_LIBDIR" +Library directory where \fIxindy.mem\fR is located. +.Sp +The modules directory may be a subdirectory, too. +.SH "COMPATIBILITY TO MAKEINDEX" +.IX Header "COMPATIBILITY TO MAKEINDEX" +\&\fBxindy\fR does not claim to be completely compatible with MakeIndex, +that would prevent some of its enhancements. That said, we strive to +deliver as much compatibility as possible. The most important +incompatibilities are +.IP "\(bu" 4 +For raw index entries in LaTeX syntax, \f(CW\*(C`\eindex{aaa|bbb}\*(C'\fR is +interpreted differently. For MakeIndex \f(CW\*(C`bbb\*(C'\fR is markup that is output +as a LaTeX tag for this page number. For \fBxindy\fR, this is a location +attribute, an abstract identifier that will be later associated with +markup that should be output for that attribute. +.Sp +For straight-forward usage, when \f(CW\*(C`bbb\*(C'\fR is \f(CW\*(C`textbf\*(C'\fR or similar, we +supply location attribute definitions that mimic MakeIndex's +behaviour. +.Sp +For more complex usage, when \f(CW\*(C`bbb\*(C'\fR is not an identifier, no such +compatibility definitions exist and may also not been created with +current \fBxindy\fR. In particular, this means that by default the LaTeX +package \f(CW\*(C`hyperref\*(C'\fR will create raw index files that cannot be +processed with \fBxindy\fR. This is not a bug, this is the unfortunate +result of an intented incompatibility. It is currently not possible to +get both hyperref's index links and use \fBxindy\fR. +.Sp +A similar situation is reported to exist for the \f(CW\*(C`memoir\*(C'\fR LaTeX +class. +.Sp +Programmers who know Common Lisp and Lex and want to work on a remedy +should please contact the author. +.IP "\(bu" 4 +The MakeIndex compatibility definitions support only the default raw +index syntax and markup definition. It is not possible to configure +raw index parsing or use a MakeIndex style file to describe output +markup. +.SH "KNOWN ISSUES" +.IX Header "KNOWN ISSUES" +Option \fB\-q\fR also prevents output of error messages. Error messages +should be output on stderr, progress messages on stdout. +.PP +There should be a way to output the final index to stdout. This would +imply \fB\-q\fR, of course. +.PP +LaTeX raw index parsing should be configurable. +.PP +Codepage \f(CW\*(C`utf8\*(C'\fR should be supported for all languages, and should be +used as internal codepage for LaTeX inputenc re-encoding. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fItexindy\fR\|(1), +\&\fItex2xindy\fR\|(1) +.SH "AUTHOR" +.IX Header "AUTHOR" +Joachim Schrod +.SH "LEGALESE" +.IX Header "LEGALESE" +Copyright (c) 2004\-2010 by Joachim Schrod. +.PP +\&\fBxindy\fR is free software; you can redistribute it and/or modify it +under the terms of the \s-1GNU\s0 General Public License as published by the +Free Software Foundation; either version 2 of the License, or (at your +option) any later version. +.PP +This program is distributed in the hope that it will be useful, +but \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of +\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0. See the +\&\s-1GNU\s0 General Public License for more details. diff --git a/Master/texmf-dist/doc/man/man1/xindy.man1.pdf b/Master/texmf-dist/doc/man/man1/xindy.man1.pdf Binary files differnew file mode 100644 index 00000000000..ce63a6b3d37 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/xindy.man1.pdf diff --git a/Master/texmf-dist/doc/man/man5/Makefile b/Master/texmf-dist/doc/man/man5/Makefile new file mode 100644 index 00000000000..c0afb8965a5 --- /dev/null +++ b/Master/texmf-dist/doc/man/man5/Makefile @@ -0,0 +1,17 @@ +# Public domain. Originally written by Manuel Pegourie-Gonnard, 2008. + +SRC = $(wildcard man5/*.5) +PDF = $(patsubst %.5, %.man5.pdf, $(SRC)) + +MKPDF = $(GROFF) $(PDFOPTS) $< | $(PSPDF) - $@.tmp && mv $@.tmp $@ || rm $@.tmp + +all: pdf +pdf: $(PDF) + +clean: + @echo 'Removing pdf files.' + @rm -f -- $(PDF) + +%.man5.pdf: %.5 + $(MKPDF) + diff --git a/Master/texmf-dist/doc/man/man5/fmtutil.cnf.5 b/Master/texmf-dist/doc/man/man5/fmtutil.cnf.5 new file mode 100644 index 00000000000..4efedcf590c --- /dev/null +++ b/Master/texmf-dist/doc/man/man5/fmtutil.cnf.5 @@ -0,0 +1,77 @@ +.TH "fmtutil\&.cnf" "5" "October 2000" "teTeX" "teTeX" +.PP +.SH "NAME" +fmtutil\&.cnf \- configuration file for fmtutil +.PP +.SH "DESCRIPTION" +.PP +The \fIfmtutil\&.cnf\fP file contains the configuration information +for \fBfmtutil\fP(8)\&. Each line contains the name of the format +(e\&.g\&., ``tex\'\', ``latex\'\', ``omega\'\'), the name of the engine that +is used by that format (e\&.g\&., ``tex\'\', ``etex\'\', ``omega\'\'), the pattern +file (e\&.g\&., \fIlanguage\&.dat\fP, \fIlanguage\&.def\fP), and any +arguments (name of an \fI\&.ini\fP file)\&. +.PP +Fields are separated by whitespace\& and complete lines can be commented +out with ``#\'\'\&. The ``pattern file\'\' field cannot be used to +define a file that is used while building the format\&. +It tells \fBfmtutil\fP which files (separated by commas) the +format creation procedure reads\& and it has an effect to the options +\fI--showhyphen\fP and \fI--byhyphen\fP\&. +If the format has no way to +customize hyphenation, a ``-\'\' can be used to indicate this\&. +.PP +.SH "NOTES" +.PP +The \fBtex\fP(1) and \fBamstex\fP(1) formats always load +\fIhyphen\&.tex\fP\&. No customization by a pattern file is available +for these formats\&. Therefore, the pattern-file field for the +\fBtex\fP and \fBamstex\fP is usually indicated to be empty (``-\'\')\&. +.PP +You can, however, build customized formats on top of plain +\fBtex\fP(1) or \fBamstex\fP(1) by using \fIbplain\&.tex\fP instead of +\fIplain\&.tex\fP (b for the \fIBabel\fP system). See, for example, +the \fIbplain\&.ini\fP file for the bplain format)\&. +.PP +\fBetex\fP(1) loads \fIlanguage\&.def\fP, not +\fIlanguage\&.dat\fP\&. +.PP +Symbolic links to the correct engines (e\&.g\&., bplain -> tex) +are generated by the \fBtexlinks\fP(8) script\&. Remember to run +\fBtexlinks\fP(8) if you run \fBfmtutil\fP(8) yourself, rather +than using the FORMATS option in \fBtexconfig\fP(8)\&. +.PP +.SH "FILES" +.PP +.IP "\fIfmtutil\&.cnf\fP" +default configuration file +.IP "\fIlanguage\&.dat\fP" +hyphenation pattern file +.IP "\fIlanguage\&.def\fP" +hyphenation pattern file +.IP "\fIlanguage\&.dat.lua\fP" +hyphenation pattern file +.PP +.SH "SEE ALSO" +.PP +\fBamstex\fP(1), \fBetex\fP(1), \fBfmtutil\fP(8), +\fBtex\fP(1), \fBtexconfig\fP(8), \fBtexlinks\fP(8)\&. +.PP +Web page: <http://tug\&.org/teTeX/> +.PP +.SH "BUGS" +.PP +None known, but report any bugs found to <tetex@dbs\&.uni-hannover\&.de> (mailing list)\&. +.PP +.SH "AUTHOR" +.PP +\fIfmtutil\&.cnf\fP was written by Thomas Esser +<te@dbs\&.uni-hannover\&.de>, and is Copyright 1998, +1999 but released into the public domain\&. +.PP +This manual page was written by C\&.M\&. Connelly +<c@eskimo\&.com>, for +the Debian GNU/Linux system\&. It may be used by other distributions +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/Master/texmf-dist/doc/man/man5/fmtutil.cnf.man5.pdf b/Master/texmf-dist/doc/man/man5/fmtutil.cnf.man5.pdf Binary files differnew file mode 100644 index 00000000000..0409ae0ec49 --- /dev/null +++ b/Master/texmf-dist/doc/man/man5/fmtutil.cnf.man5.pdf diff --git a/Master/texmf-dist/doc/man/man5/synctex.5 b/Master/texmf-dist/doc/man/man5/synctex.5 new file mode 100644 index 00000000000..3b331efe0bd --- /dev/null +++ b/Master/texmf-dist/doc/man/man5/synctex.5 @@ -0,0 +1,319 @@ +.Dd Mar 13, 2012 +.Dt SYNCTEX 5 +.Os "Independant" +.\" +.\" +.Sh NAME +.Nm synctex +.Nd Synchronize TeXnology help file +.\" +.\" +.Sh DESCRIPTION +Synchronize TeXnology help file +.Pq synctexs +are text files that help input/output synchronization during document preparation with the TeX typesetting system. +.Sh BASICS +The structure of this file should not be considered public, in the sense that no one should need to parse its contents, except the synctex command line utility, and the synctex_parser library. +Unless it is absolutely not avoidable, access to the contents of the synctex file should only be made through requests made to the synctex command line utility. +.\" +.Sh STRUCTURE +The element structure of a synctex file is a list of text line records as follows. +.Sq \&* , +.Sq \&+ , +and +.Sq \&? +have their usual EBNF meanings: +.Sq \&* +means zero or more, +.Sq \&+ +means one or more, and +.Sq \&? +means zero or one +.Pq i.e., optional . +.Pp +.Bl -item -offset indent +.\" +.It +.Li <SyncTeX> ::= +.Pq The whole contents in 4 sections +.Bl -item -offset indent +.It +.Li <Preamble> +.It +.Li <Content> +.It +.Li <Postamble> +.It +.Li <Post Scriptum> +.El +.\" +.El +.Pp +Each section starts with the first occurrence of a sectioning line, and ends with the next section, if any. +In the following definitions, we do not mention the section ending condition. +.Sh The preamble +.Bl -item -offset indent +.\" +.It +.Li <Preamble> ::= +.Bl -item -offset indent +.It +.Qq SyncTeX Version: +<Version Number> <EOL> +.It +.Li <Input Line>* +.It +.Qq Magnification: +<TeX magnification> <EOL> +.It +.Qq Unit: +<unit in scaled point> <EOL> +.It +.Qq X Offset: +<horizontal offset in scaled point> <EOL> +.It +.Qq Y Offset: +<vertical offset in scaled point> <EOL> +.El +.It +.Li <Input Line> ::= +.Qq Input: +<tag> +.Qq \&: +<File Name> <EOL> +.\" +.El +.Sh The content +.Bl -item -offset indent +.It +.Li <Content> ::= +.Bl -item -offset indent +.It +.Li <byte offset record> +.It +.Qq Content: +<EOL> +.It +.Li <sheet(1)> +.It +.Li <Input Line>* +.It +.Li <sheet(2)> +.It +.Li <Input Line>* +.It +.Li ... +.It +.Li <sheet(N)> +.It +.Li <Input Line>* +.El +.It +.Li <byte offset record> ::= +.Qq \&! +<byte offset> <end of record> +.Pp +.El +.Pp +.Bl -item -offset indent +.It +.Li <sheet(n)> ::= +.Bl -item -offset indent +.It +.Li <byte offset record> +.It +.Qq \&{ +<the integer n> <end of record>/ +.It +.Li <box content>* +.It +.Li <byte offset record> +.It +.Qq \&} +<the integer n> <end of record> +.El +.El +.Pp +The <box content> describes what is inside a box. +It is either a vertical or horizontal box, +with some records related to glue, kern or math nodes. +.Bl -item -offset indent +.It +.Li <box content> ::= +.Bl -item -offset indent +.It +.Li <vbox section>|<hbox section> +.It +.Li |<void vbox record>|<void hbox record> +.It +.Li |<current record>|<glue record>|<kern record>|<math record> +.El +.It +.Li <vbox section> ::= +.Bl -item -offset indent +.It +.Qq \&[ +<link> +.Qq \&: +<point> +.Qq \&: +<size> <end of record> +.It +.Li <box content>* +.It +.Qq \&] +<end of record> +.El +.It +.Li <hbox section> ::= +.Bl -item -offset indent +.It +.Li \&( +<link> +.Qq \&: +<point> +.Qq \&: +<size> <end of record> +.It +.Li <box content>* +.It +.Qq \&) +<end of record> +.El +.El +.Pp +Void boxes: +.Bl -item -offset indent +.It +.Li <void vbox record> ::= +.Qq v +<link> +.Qq \&: +<point> +.Qq \&: +<size> <end of record> +.It +.Li <void hbox record> ::= +.Qq h +<link> +.Qq \&: +<point> +.Qq \&: +<size> <end of record> +.It +.Li <size> ::= <Width> +.Qq \&, +<Height> +.Qq \&, +<Depth> +.It +.Li <Width> ::= <integer> +.It +.Li <Height> ::= <integer> +.It +.Li <Depth> ::= <integer> +.It +.Li <link> ::= <tag> +.Qq \&, +<line>( +.Qq \&, +<column>)? +.It +.Li <line> ::= <integer> +.It +.Li <column> ::= <integer> +.El +.Pp +The forthcoming records are basic one liners. +.Bl -item -offset indent +.It +.Li <current record> ::= +.Qq x +<link> +.Qq \&: +<point> <end of record> +.It +.Li <kern record> ::= +.Qq k +<link> +.Qq \&: +<point> +.Qq \&: +<Width> <end of record> +.It +.Li <glue record> ::= +.Qq g +<link> +.Qq \&: +<point> <end of record> +.It +.Li <math record> ::= +.Qq $ +<link> +.Qq \&: +<point> <end of record> +.El +.Pp +.\" .Sx underline, .Dq double quotes, .Pq enclosed in parenthesis +.Sh The postamble +The postamble closes the file +If there is no postamble, it means that the typesetting process did not end correctly. +.Bl -item -offset indent +.\" +.It +.Li <Postamble>::= +.Bl -item -offset indent +.It +.Li <byte offset record> +.It +.Qq Count: +<Number of records> <EOL> +.El +.El +.Sh The post scriptum +The post scriptum contains material possibly added by 3rd parties. +It allows to append some transformation (shift and magnify). +Typically, one applies a dvi to pdf filter with offset options and magnification, +then he appends the same options to the synctex file, for example +.Bd -literal -offset indent + synctex update -o foo.pdf -m 0.486 -x 9472573sp -y 13.3dd source.dvi +.Ed +.Bl -item -offset indent +.\" +.It +.Li <Post Scriptum>::= +.\" +.Bl -item -offset indent +.It +.Li <byte offset record> +.It +.Qq Post Scriptum: +<EOL> +.It +.Qq Magnification: +<number> <EOL> +.Pq Set additional magnification +.It +.Qq X Offset: +<dimension> <EOL> +.Pq Set horizontal offset +.It +.Qq Y Offset: +<dimension> <EOL> +.Pq Set vertical offset +.El +.El +This second information will override the offset and magnification previously available in the preamble section. +All the numbers are encoded using the decimal representation with "C" locale. +.Sh USAGE +.Pp +The <current record> is used to compute the visible size of hbox's. +The byte offset is an implicit anchor to navigate the synctex file from sheet to sheet. +.\" nroff -man synctex.5 | less +.\"groff -man -Tascii synctex.5 | less +.\"To convert a man page to plain pre-formatted text (e.g for spell checking) use: +.\"nroff -man synctex.5 | col -b > synctex.5.txt +.\"To convert it to Postscript (for printing or further conversion to pdf) use: +.\"groff -man -Tps synctex.5 > synctex.5.ps +.\"To convert the man page to html use: +.\"man2html synctex.5 diff --git a/Master/texmf-dist/doc/man/man5/synctex.man5.pdf b/Master/texmf-dist/doc/man/man5/synctex.man5.pdf Binary files differnew file mode 100644 index 00000000000..e1c12badd77 --- /dev/null +++ b/Master/texmf-dist/doc/man/man5/synctex.man5.pdf diff --git a/Master/texmf-dist/doc/man/man5/updmap.cfg.5 b/Master/texmf-dist/doc/man/man5/updmap.cfg.5 new file mode 100644 index 00000000000..43a7cc2d23f --- /dev/null +++ b/Master/texmf-dist/doc/man/man5/updmap.cfg.5 @@ -0,0 +1,155 @@ +.\" Hey, Emacs! This is an -*- nroff -*- source file. +.\" +.\" Copyright (C) 2004, 2012 Hilmar Preusse <hille42@web.de> +.\" Copyright (C) 2012 Norbert Preining <preining@logic.at> +.\" +.\" This 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 2, or (at your option) any later +.\" version. +.\" +.\" This 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 "UPDMAP.CFG" "20" "November 2012" "TeX Live" "TeX Live" +.SH "NAME" +\fBupdmap.cfg\fR \- configuration of font mapping/inclusion for dvips and +friends. +.SH "DESCRIPTION" +The file \fBupdmap.cfg\fR is the central font configuration file of a +teTeX system and is read by \fBupdmap\fP(1). It describes if and how +fonts should be included (or not included) into PS-/PDF-files. This +works for Outline (Postscript Type1) and Bitmap Fonts (Postscript +Type3) mostly coming from MetaFont. +.PP +\fBupdmap\fP is a utility that creates font configuration files for +\fBdvips\fP(1), \fBpdftex\fP(1), \fBxdvi\fP(1), \fBps2pk\fP(1), +\fBgsftopk\fP(1), and \fBdvipdfmx\fP(1)\&. In +an ideal world, updmap would be unnecessary -- each of these programs +would read the same configuration file to learn what fonts are +available and how they should be treated\&. As things stand, however, +each of these tools has subtly different requirements and thereby +needs its own font configuration file\&. \fBupdmap\fP creates font +configuration files for all of these programs from several sources, +namely all \fBupdmap.cfg\fR, allowing you to easily keep all the different +configuration files in sync\&. +.P +Running "updmap --help" will output the main documentation for using +\fBupdmap\fR. +.P +\fBdvipsPreferOutline\fR +.br +Configures if \fBdvips\fR (by default) should prefer bitmap fonts or outline fonts +if both are available? Independent of this setting, outlines can be forced +by putting "p psfonts_t1.map" into a config file that dvips reads. Bitmaps +can be forced by putting "p psfonts_pk.map" into a config file. We provide +such config files which can be enabled via +\fBdvips\fR \fI-Poutline\fR (resp. \fBdvips\fR \fI-Ppk\fR). +.br +Valid settings for dvipsPreferOutline are \fItrue\fR / \fIfalse\fR. +.P +\fBLW35\fR +.br +Which fonts of the "Basic 35 Laserwriter Fonts" do you want to use and +how are the filenames chosen? Valid settings: +.br +URW: URW fonts with "vendor" filenames (e.g. n019064l.pfb) +.br +URWkb: URW fonts with "berry" filenames (e.g. uhvbo8ac.pfb) +.br +ADOBE: Adobe fonts with "vendor" filenames (e.g. hvnbo___.pfb) +.br +ADOBEkb: Adobe fonts with "berry" filenames (e.g. phvbo8an.pfb) +.P +\fBdvipsDownloadBase35\fR +.br +Configures if \fBdvips\fR (by default) should download the 35 base +PostScript fonts into the document (set \fItrue\fR) or should these +fonts be used from the ps interpreter / printer (set \fIfalse\fR). +.br +The user can override the default by specifying \fBdvips\fR \fI-Pdownload35\fR +(resp. \fBdvips\fR \fI-Pbuiltin35\fR) to download the LW35 fonts +(resp. use the built-in fonts). +.br +Valid settings are \fItrue\fR / \fIfalse\fR. +.P +\fBpdftexDownloadBase14\fR +.br +Should \fBpdftex\fR download the 14 base PDF fonts? Since some configurations +(ps / pdf tools / printers) use bad default fonts, it is safer to download +the fonts. The pdf files get bigger, but that is the cost. +.br +Valid settings are \fItrue\fR (download the fonts) or \fIfalse\fR (don't +download the fonts). Adobe recommends embedding all fonts. +.P +\fBpxdviUse\fR +.br +Should special map files for pxdvi be created? pxdvi is an adaption of xdvi +with support for reading and displaying files generated by the ptex family +of engines. +.br +Valid settings are \fItrue\fR (generate configuration) or \fIfalse\fR. See +http://www.tug.org/texlive/updmap-kanji.html for detailed discussion. +.P +\fBkanjiEmbed\fR +.br +\fBkanjiVariant\fR +.br +The options \fBkanjiEmbed\fR and \fBkanjiVariant\fR specify special +replacements in the map lines. In a map, the string "@kanjiEmbed@" +will be replaced by the value of that option; similarly for +\fBkanjiVariant\fR. In this way, users of Japanese TeX can select +different fonts to be included in the final output. +.P +\fBMap\fR +.br +Points to a map file, which describes a mapping from a font (called in the TeX +document) to the pfb file containing the Postscript code. +.br +Usage: \fBMap\fR filename.map +.P +The syntax of map files is the same as \fBdvips\fP(1) uses, see the +section "psfonts.map" in the manual of \fBdvips\fP(1). +.P +\fBMixedMap\fR +.br +Similar to \fBMap\fR. It should be used when there is Type1 and a bitmap +implementation of the font (the latter mostly coming from MetaFont). These +entries will not be used in the default map of \fBdvips\fR if +\fBdvipsPreferOutline\fR is set to \fIfalse\fR. +.br +Usage: \fBMixedMap\fR filename.map +.P +\fBKanjiMap\fR +.br +Similar to \fBMap\fR. This should be used for kanji fonts. +.br +Usage: \fBKanjiMap\fR filename.map +.P +The sign \fB#\fR precedes a comment. +.P +Map files not to be used should be commented out using the string +\fB#!\fR at the beginning of the line. Such entries can be +(de-)activated using \fBupdmap\fR with the options \fI--enable\fR and +\fI--disable\fR, respectively. + +.SH "AUTHOR" +This manual page was written by Hilmar Preusse <hille42@web.de> and +extended by Norbert Preining <preining@logic.at>, for +the Debian GNU/Linux system by simply copying the comments from +\fBupdmap.cfg\fR and rewriting some of them. It may be used by other +distributions without contacting the author. Any mistakes or omissions in +the manual page are our fault; inquiries about or corrections to this manual +page should be directed to tex-live@tug.org. + +.SH "SEE ALSO" +updmap(1), dvips(1) + +.SH "THANKS TO" +Frank Kuester, +Thomas Esser. diff --git a/Master/texmf-dist/doc/man/man5/updmap.cfg.man5.pdf b/Master/texmf-dist/doc/man/man5/updmap.cfg.man5.pdf Binary files differnew file mode 100644 index 00000000000..3fff19ac64c --- /dev/null +++ b/Master/texmf-dist/doc/man/man5/updmap.cfg.man5.pdf |