diff options
author | Karl Berry <karl@freefriends.org> | 2006-01-03 00:00:18 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2006-01-03 00:00:18 +0000 |
commit | a540e256be85df29c60ac323d4460c6cde1d9350 (patch) | |
tree | d83a3a57112a9ec6966691569ecc2dfe78d82b81 /Master/texmf/doc/man | |
parent | 84a45ba83a3095eb4908d4325981b11fc1b31b05 (diff) |
trunk/Master/texmf/doc
git-svn-id: svn://tug.org/texlive/trunk@42 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf/doc/man')
196 files changed, 31521 insertions, 0 deletions
diff --git a/Master/texmf/doc/man/man1/a2ping.1 b/Master/texmf/doc/man/man1/a2ping.1 new file mode 100644 index 00000000000..ec06d892da8 --- /dev/null +++ b/Master/texmf/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/doc/man/man1/afm2pl.1 b/Master/texmf/doc/man/man1/afm2pl.1 new file mode 100644 index 00000000000..91c8282166d --- /dev/null +++ b/Master/texmf/doc/man/man1/afm2pl.1 @@ -0,0 +1,275 @@ +.\"Generated by db2man.xsl. Don't modify this, modify the source. +.de Sh \" Subsection +.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 Ip \" List item +.br +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 +.. +.TH "AFM2PL" 1 "February 2004" "" "afm2pl" +.SH NAME +afm2pl \- convert AFM font metrics to TeX pl font metrics +.SH "SYNOPSIS" +.ad l +.hy 0 +.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] {\fIinput_file[\&.afm]\fR} [\fIoutput_file[\&.pl]\fR] +.ad +.hy +.ad l +.hy 0 +.HP 7 +\fBafm2pl\fR {\fB\-\-help\fR | \fB\-\-version\fR} +.ad +.hy + +.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 preserves kerns and ligatures\&. + +.PP +afm2pl is meant to be a replacement for afm2tfm, on which it is based\&. With afm2tfm, preserving kerns and ligatures is possible only in a roundabout way\&. + +.PP +For text fonts, Y&Y's texnansi is the recommended encoding to be used with afm2pl\&. This gives you a good character set with all the more important accented characters and many typographic symbols available as single characters, 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\&.enc and texnanlc\&.enc, 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)\&. + +.PP +Return value: 0 if no error; a negative number indicating the number of missing glyphs if conversion was successfull but glyphs are missing, and 1 in case of error\&. + +.SH "OPTIONS" + +.TP +\fB\-p\fR \fIencoding_file\fR +The default is the encoding specified in the afm file, which had better match the encoding in the fontfile (pfa or pfb)\&. 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\&. + +.TP +\fB\-o\fR +Use octal for all character codes in the pl file\&. + +.TP +\fB\-e\fR \fIextend_factor\fR +Widen or narrow characters by \fIextend_factor\fR\&. Default is 1\&.0 (natural width)\&. Not recommended, 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\&. + +.TP +\fB\-s\fR \fIslant_factor\fR +Oblique (slant) characters by \fIslant_factor\fR\&. Not recommended\&. + +.TP +\fB\-f\fR \fIfont_dimensions\fR +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\&. 'Space' 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\&. + +.PP +.TS +lll +___ +lll. +Font dimension Default value Afm2tfm value +\fIstretch\fR space div 2 300 x \fIextend_factor\fR +\fIshrink\fR space div 3 100 x \fIextend_factor\fR +\fIextra space\fR space div 3 missing +\fIquad\fR 2 x width of '0' 1000 x \fIextend_factor\fR +\fIspace\fR (space source font) x \fIextend_factor\fR (space source font) x \fIextend_factor\fR +.TE +For fixed\-pitch fonts, different values apply: + +.PP +.TS +lll +___ +lll. +Font dimension Default value Afm2tfm value +\fIstretch\fR 0 0 +\fIshrink\fR 0 0 +\fIextra space\fR space missing +\fIquad\fR 2 x character width 1000 x \fIextend_factor\fR +\fIspace\fR character width character width +.TE +Specify just a non\-default stretch and shrink with e\&.g\&. 150,70 and just a non\-default extra space with ,,10\&. + +.TP +\fB\-k\fR +Keep original ligatures\&. This option only has effect in combination with positive letterspacing; see the section on letterspacing and extra ligkern info\&. + +.TP +\fB\-m\fR \fIletter_spacing\fR +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\&. + +.TP +\fB\-l\fR \fIligkern_spec\fR, \fB\-L\fR \fIligkern_spec\fR +See the section on extra ligkern info for details\&. + +.TP +\fB\-V\fR +Verbose\&. If turned on, it reports the number of missing glyphs to stderr and their names to stdout\&. This is not particularly logical, but this way the glyph names can be captured even under Windows\&. + +.TP +\fB\-\-help\fR +Display a short usage message\&. + +.TP +\fB\-\-version\fR +Display the version number of afm2pl\&. + +.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, although, in case of a geometrically transformed font, it may be better to remove the PostScript name for a pdftex mapfile entry\&. It is assumed that the pfb file has the same basename as the afm file and must be downloaded\&. You may have to hand\-edit this entry\&. + +.PP +You can configure dvips and pdftex to read this additional mapfile or otherwise add the entry to an existing mapfile\&. It appears that pdftex automatically will consult a mapfile xxx\&.map for a font xxx\&. + +.SH "EXTRA LIGKERN INFO" + +.PP +Most users are well\-advised to leave this mess alone and to accept the default behavior\&. + +.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 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 +Note 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\&. + +.PP +The parser for ligkern info has been inherited from afm2tfm virtually without change\&. A ligkern specification can have one of the following forms: + +.IP + +\fIglyph_name1\fR \fIglyph_name2\fR \fIlig_op\fR \fIglyph_name3\fR ; + +.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\&. + +.IP + +\fIglyph_name1\fR <> \fIglyph_name2\fR ; + +.PP +Kern \fIglyph_name1\fR as \fIglyph_name2\fR\&. + +.IP + +\fIglyph_name1\fR {} \fIglyph_name2\fR ; + +.PP +Remove the kern between \fIglyph_name1\fR and \fIglyph_name2\fR\&. A value of * for either glyph name is interpreted as a wildcard\&. + +.IP + +|| = \fIglyph\fR ; + +.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: + +.IP + +|| <> space ; + +.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: + +.IP + +one {} * ; * {} one ; two {} * ; * {} two ; + +.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: + +.TP 3 +1. +In case of positive letterspacing, native ligatures are removed, unless the \-k option is specified\&. +.TP +2. +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\&. +.TP +3. +Letterspacing is applied\&. This adds a lot of kerns, and modifies existing kerns\&. +.TP +4. +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\&. The tfm format has room for only about 180x180 ligatures and kerning pairs\&. This is enough for OT1 encoding, but for texnansi encoding quite a few ligkern specifications have to be removed\&. The pltotf program will remove all 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\&. +.LP + +.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\&. The distribution contains an example ucshape\&.tex on how to use such fonts with LaTeX font selection\&. + +.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\&. + +.SS "The sz ligature" + +.PP +Note that the texnanuc encoding provides no glyph for the sz ligature; 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: + +.nf + + +\\def\\ss{% + \\setbox0\\hbox{\\char25}% + \\ifnum\\wd0=0 ss\\else\\box0\\fi +} + + +.fi + +.PP +In LaTeX, this code appears to work well enough, although on occasion you may need to insert \\protect\&. A better solution might involve the sixth parameter of the \\DeclareFontShape macro, but I failed to get that to work\&. + +.SH "AFM2PL, FONTINST AND ARTIFICIAL SMALLCAPS" + +.PP +Afm2pl currently 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 "FUTURE PLANS" + +.PP +I am considering a revision which makes afm2pl a more complete replacement for afm2tfm\&. In that version, afm2pl can optionally create a second, virtual font, possibly with a different encoding and possibly letterspaced\&. The current option of non\-virtual letterspacing via kerns will be dropped\&. If the encodings differ then it is assumed that the virtual font is intended as a small\-caps version of the main font, and a scaling parameter can be specified for non\-matching glyphs\&. + +.SH "COPYRIGHT" + +.PP +The afm2pl distribution is subject to the GNU General Public Licence (GPL)\&. Please refer to the file COPYING for details\&. + +.PP +The afm2pl homepage is http://www\&.ntg\&.nl/afm2pl\&.html: \fIhttp://www.ntg.nl/afm2pl.html\fR\&. + +.SH AUTHOR +Siep Kroonenberg <ntg\-afm2pl@ntg\&.nl>. diff --git a/Master/texmf/doc/man/man1/afm2tfm.1 b/Master/texmf/doc/man/man1/afm2tfm.1 new file mode 100644 index 00000000000..32822173aa4 --- /dev/null +++ b/Master/texmf/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/doc/man/man1/allcm.1 b/Master/texmf/doc/man/man1/allcm.1 new file mode 100644 index 00000000000..fe75f4ef6d3 --- /dev/null +++ b/Master/texmf/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/doc/man/man1/allec.1 b/Master/texmf/doc/man/man1/allec.1 new file mode 120000 index 00000000000..fa06b6c24bd --- /dev/null +++ b/Master/texmf/doc/man/man1/allec.1 @@ -0,0 +1 @@ +allcm.1
\ No newline at end of file diff --git a/Master/texmf/doc/man/man1/allneeded.1 b/Master/texmf/doc/man/man1/allneeded.1 new file mode 100644 index 00000000000..7d9a67548b7 --- /dev/null +++ b/Master/texmf/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/doc/man/man1/amstex.1 b/Master/texmf/doc/man/man1/amstex.1 new file mode 100644 index 00000000000..68697a02901 --- /dev/null +++ b/Master/texmf/doc/man/man1/amstex.1 @@ -0,0 +1,69 @@ +.TH AMSTEX 1 "27 December 1992" "Web2C 7.5.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 +amstex \- structured text formatting and typesetting +.SH SYNOPSIS +.B amstex +[ 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 ``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 +\*(AX is the official typesetting system of the American Mathematical +Society, and nearly all of its publications are typeset using \*(AX. The +online version of AMS Math Reviews uses \*(AX input syntax for display of +mathematical material. AMS authors can provide editors with +computer-readable \*(AX files. +.PP +For authors more familiar with \*(LX, an AMS-supported package called +.I amsmath.sty +is is available. +.\"===================================================================== +.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, Addison-Wesley, 1990, ISBN 0-8218-2997-1. diff --git a/Master/texmf/doc/man/man1/bg5conv.1 b/Master/texmf/doc/man/man1/bg5conv.1 new file mode 100644 index 00000000000..a1925691345 --- /dev/null +++ b/Master/texmf/doc/man/man1/bg5conv.1 @@ -0,0 +1,94 @@ +.\" man page for bg5conv +. +.TH BG5CONV 1 11-Aug-2005 "CJK Version 4.6.0" +. +.\" ==== +.\" ==== 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/doc/man/man1/bibtex.1 b/Master/texmf/doc/man/man1/bibtex.1 new file mode 100644 index 00000000000..4be5efd8bb5 --- /dev/null +++ b/Master/texmf/doc/man/man1/bibtex.1 @@ -0,0 +1,146 @@ +.TH BIBTEX 1 "24 November 1994" "Web2C 7.5.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 +.\"===================================================================== +.SH NAME +bibtex \- make a bibliography for (La)TeX +.SH SYNOPSIS +.B bibtex +[ +.BI -min-crossrefs =number +] +[ +.B -terse +] +[ +.I auxname +] +.\"===================================================================== +.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 +.RI ( .aux ) +file that was output during the running of +.BR latex (1) +or +.BR tex (1) +and creates a bibliography +.RI ( .bbl ) +file that will be incorporated into the document on subsequent runs of +\*(LX or \*(TX. The +.I auxname +on the command line must be given without the +.I .aux +extension. If you don't give the +.IR auxname , +the program prompts you for it. +.PP +\*(BX looks up, in bibliographic database +.RI ( .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 +.RI ( .bst ) +file (specified by the \\bibliographystyle command, +and it outputs the results to the +.I .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 +.I .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 +.I .bst +files. If BSTINPUTS is not set, it uses the system default. +For +.I .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 +.I .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 +.I .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/doc/man/man1/bzip2.1 b/Master/texmf/doc/man/man1/bzip2.1 new file mode 100644 index 00000000000..623435c2427 --- /dev/null +++ b/Master/texmf/doc/man/man1/bzip2.1 @@ -0,0 +1,453 @@ +.PU +.TH bzip2 1 +.SH NAME +bzip2, bunzip2 \- a block-sorting file compressor, v1.0.2 +.br +bzcat \- decompresses files to stdout +.br +bzip2recover \- recovers data from damaged bzip2 files + +.SH SYNOPSIS +.ll +8 +.B bzip2 +.RB [ " \-cdfkqstvzVL123456789 " ] +[ +.I "filenames \&..." +] +.ll -8 +.br +.B bunzip2 +.RB [ " \-fkvsVL " ] +[ +.I "filenames \&..." +] +.br +.B bzcat +.RB [ " \-s " ] +[ +.I "filenames \&..." +] +.br +.B bzip2recover +.I "filename" + +.SH DESCRIPTION +.I bzip2 +compresses files using the Burrows-Wheeler block sorting +text compression algorithm, and Huffman coding. Compression is +generally considerably better than that achieved by more conventional +LZ77/LZ78-based compressors, and approaches the performance of the PPM +family of statistical compressors. + +The command-line options are deliberately very similar to +those of +.I GNU gzip, +but they are not identical. + +.I bzip2 +expects a list of file names to accompany the +command-line flags. Each file is replaced by a compressed version of +itself, with the name "original_name.bz2". +Each compressed file +has the same modification date, permissions, and, when possible, +ownership as the corresponding original, so that these properties can +be correctly restored at decompression time. File name handling is +naive in the sense that there is no mechanism for preserving original +file names, permissions, ownerships or dates in filesystems which lack +these concepts, or have serious file name length restrictions, such as +MS-DOS. + +.I bzip2 +and +.I bunzip2 +will by default not overwrite existing +files. If you want this to happen, specify the \-f flag. + +If no file names are specified, +.I bzip2 +compresses from standard +input to standard output. In this case, +.I bzip2 +will decline to +write compressed output to a terminal, as this would be entirely +incomprehensible and therefore pointless. + +.I bunzip2 +(or +.I bzip2 \-d) +decompresses all +specified files. Files which were not created by +.I bzip2 +will be detected and ignored, and a warning issued. +.I bzip2 +attempts to guess the filename for the decompressed file +from that of the compressed file as follows: + + filename.bz2 becomes filename + filename.bz becomes filename + filename.tbz2 becomes filename.tar + filename.tbz becomes filename.tar + anyothername becomes anyothername.out + +If the file does not end in one of the recognised endings, +.I .bz2, +.I .bz, +.I .tbz2 +or +.I .tbz, +.I bzip2 +complains that it cannot +guess the name of the original file, and uses the original name +with +.I .out +appended. + +As with compression, supplying no +filenames causes decompression from +standard input to standard output. + +.I bunzip2 +will correctly decompress a file which is the +concatenation of two or more compressed files. The result is the +concatenation of the corresponding uncompressed files. Integrity +testing (\-t) +of concatenated +compressed files is also supported. + +You can also compress or decompress files to the standard output by +giving the \-c flag. Multiple files may be compressed and +decompressed like this. The resulting outputs are fed sequentially to +stdout. Compression of multiple files +in this manner generates a stream +containing multiple compressed file representations. Such a stream +can be decompressed correctly only by +.I bzip2 +version 0.9.0 or +later. Earlier versions of +.I bzip2 +will stop after decompressing +the first file in the stream. + +.I bzcat +(or +.I bzip2 -dc) +decompresses all specified files to +the standard output. + +.I bzip2 +will read arguments from the environment variables +.I BZIP2 +and +.I BZIP, +in that order, and will process them +before any arguments read from the command line. This gives a +convenient way to supply default arguments. + +Compression is always performed, even if the compressed +file is slightly +larger than the original. Files of less than about one hundred bytes +tend to get larger, since the compression mechanism has a constant +overhead in the region of 50 bytes. Random data (including the output +of most file compressors) is coded at about 8.05 bits per byte, giving +an expansion of around 0.5%. + +As a self-check for your protection, +.I +bzip2 +uses 32-bit CRCs to +make sure that the decompressed version of a file is identical to the +original. This guards against corruption of the compressed data, and +against undetected bugs in +.I bzip2 +(hopefully very unlikely). The +chances of data corruption going undetected is microscopic, about one +chance in four billion for each file processed. Be aware, though, that +the check occurs upon decompression, so it can only tell you that +something is wrong. It can't help you +recover the original uncompressed +data. You can use +.I bzip2recover +to try to recover data from +damaged files. + +Return values: 0 for a normal exit, 1 for environmental problems (file +not found, invalid flags, I/O errors, &c), 2 to indicate a corrupt +compressed file, 3 for an internal consistency error (eg, bug) which +caused +.I bzip2 +to panic. + +.SH OPTIONS +.TP +.B \-c --stdout +Compress or decompress to standard output. +.TP +.B \-d --decompress +Force decompression. +.I bzip2, +.I bunzip2 +and +.I bzcat +are +really the same program, and the decision about what actions to take is +done on the basis of which name is used. This flag overrides that +mechanism, and forces +.I bzip2 +to decompress. +.TP +.B \-z --compress +The complement to \-d: forces compression, regardless of the +invocation name. +.TP +.B \-t --test +Check integrity of the specified file(s), but don't decompress them. +This really performs a trial decompression and throws away the result. +.TP +.B \-f --force +Force overwrite of output files. Normally, +.I bzip2 +will not overwrite +existing output files. Also forces +.I bzip2 +to break hard links +to files, which it otherwise wouldn't do. + +bzip2 normally declines to decompress files which don't have the +correct magic header bytes. If forced (-f), however, it will pass +such files through unmodified. This is how GNU gzip behaves. +.TP +.B \-k --keep +Keep (don't delete) input files during compression +or decompression. +.TP +.B \-s --small +Reduce memory usage, for compression, decompression and testing. Files +are decompressed and tested using a modified algorithm which only +requires 2.5 bytes per block byte. This means any file can be +decompressed in 2300k of memory, albeit at about half the normal speed. + +During compression, \-s selects a block size of 200k, which limits +memory use to around the same figure, at the expense of your compression +ratio. In short, if your machine is low on memory (8 megabytes or +less), use \-s for everything. See MEMORY MANAGEMENT below. +.TP +.B \-q --quiet +Suppress non-essential warning messages. Messages pertaining to +I/O errors and other critical events will not be suppressed. +.TP +.B \-v --verbose +Verbose mode -- show the compression ratio for each file processed. +Further \-v's increase the verbosity level, spewing out lots of +information which is primarily of interest for diagnostic purposes. +.TP +.B \-L --license -V --version +Display the software version, license terms and conditions. +.TP +.B \-1 (or \-\-fast) to \-9 (or \-\-best) +Set the block size to 100 k, 200 k .. 900 k when compressing. Has no +effect when decompressing. See MEMORY MANAGEMENT below. +The \-\-fast and \-\-best aliases are primarily for GNU gzip +compatibility. In particular, \-\-fast doesn't make things +significantly faster. +And \-\-best merely selects the default behaviour. +.TP +.B \-- +Treats all subsequent arguments as file names, even if they start +with a dash. This is so you can handle files with names beginning +with a dash, for example: bzip2 \-- \-myfilename. +.TP +.B \--repetitive-fast --repetitive-best +These flags are redundant in versions 0.9.5 and above. They provided +some coarse control over the behaviour of the sorting algorithm in +earlier versions, which was sometimes useful. 0.9.5 and above have an +improved algorithm which renders these flags irrelevant. + +.SH MEMORY MANAGEMENT +.I bzip2 +compresses large files in blocks. The block size affects +both the compression ratio achieved, and the amount of memory needed for +compression and decompression. The flags \-1 through \-9 +specify the block size to be 100,000 bytes through 900,000 bytes (the +default) respectively. At decompression time, the block size used for +compression is read from the header of the compressed file, and +.I bunzip2 +then allocates itself just enough memory to decompress +the file. Since block sizes are stored in compressed files, it follows +that the flags \-1 to \-9 are irrelevant to and so ignored +during decompression. + +Compression and decompression requirements, +in bytes, can be estimated as: + + Compression: 400k + ( 8 x block size ) + + Decompression: 100k + ( 4 x block size ), or + 100k + ( 2.5 x block size ) + +Larger block sizes give rapidly diminishing marginal returns. Most of +the compression comes from the first two or three hundred k of block +size, a fact worth bearing in mind when using +.I bzip2 +on small machines. +It is also important to appreciate that the decompression memory +requirement is set at compression time by the choice of block size. + +For files compressed with the default 900k block size, +.I bunzip2 +will require about 3700 kbytes to decompress. To support decompression +of any file on a 4 megabyte machine, +.I bunzip2 +has an option to +decompress using approximately half this amount of memory, about 2300 +kbytes. Decompression speed is also halved, so you should use this +option only where necessary. The relevant flag is -s. + +In general, try and use the largest block size memory constraints allow, +since that maximises the compression achieved. Compression and +decompression speed are virtually unaffected by block size. + +Another significant point applies to files which fit in a single block +-- that means most files you'd encounter using a large block size. The +amount of real memory touched is proportional to the size of the file, +since the file is smaller than a block. For example, compressing a file +20,000 bytes long with the flag -9 will cause the compressor to +allocate around 7600k of memory, but only touch 400k + 20000 * 8 = 560 +kbytes of it. Similarly, the decompressor will allocate 3700k but only +touch 100k + 20000 * 4 = 180 kbytes. + +Here is a table which summarises the maximum memory usage for different +block sizes. Also recorded is the total compressed size for 14 files of +the Calgary Text Compression Corpus totalling 3,141,622 bytes. This +column gives some feel for how compression varies with block size. +These figures tend to understate the advantage of larger block sizes for +larger files, since the Corpus is dominated by smaller files. + + Compress Decompress Decompress Corpus + Flag usage usage -s usage Size + + -1 1200k 500k 350k 914704 + -2 2000k 900k 600k 877703 + -3 2800k 1300k 850k 860338 + -4 3600k 1700k 1100k 846899 + -5 4400k 2100k 1350k 845160 + -6 5200k 2500k 1600k 838626 + -7 6100k 2900k 1850k 834096 + -8 6800k 3300k 2100k 828642 + -9 7600k 3700k 2350k 828642 + +.SH RECOVERING DATA FROM DAMAGED FILES +.I bzip2 +compresses files in blocks, usually 900kbytes long. Each +block is handled independently. If a media or transmission error causes +a multi-block .bz2 +file to become damaged, it may be possible to +recover data from the undamaged blocks in the file. + +The compressed representation of each block is delimited by a 48-bit +pattern, which makes it possible to find the block boundaries with +reasonable certainty. Each block also carries its own 32-bit CRC, so +damaged blocks can be distinguished from undamaged ones. + +.I bzip2recover +is a simple program whose purpose is to search for +blocks in .bz2 files, and write each block out into its own .bz2 +file. You can then use +.I bzip2 +\-t +to test the +integrity of the resulting files, and decompress those which are +undamaged. + +.I bzip2recover +takes a single argument, the name of the damaged file, +and writes a number of files "rec00001file.bz2", +"rec00002file.bz2", etc, containing the extracted blocks. +The output filenames are designed so that the use of +wildcards in subsequent processing -- for example, +"bzip2 -dc rec*file.bz2 > recovered_data" -- processes the files in +the correct order. + +.I bzip2recover +should be of most use dealing with large .bz2 +files, as these will contain many blocks. It is clearly +futile to use it on damaged single-block files, since a +damaged block cannot be recovered. If you wish to minimise +any potential data loss through media or transmission errors, +you might consider compressing with a smaller +block size. + +.SH PERFORMANCE NOTES +The sorting phase of compression gathers together similar strings in the +file. Because of this, files containing very long runs of repeated +symbols, like "aabaabaabaab ..." (repeated several hundred times) may +compress more slowly than normal. Versions 0.9.5 and above fare much +better than previous versions in this respect. The ratio between +worst-case and average-case compression time is in the region of 10:1. +For previous versions, this figure was more like 100:1. You can use the +\-vvvv option to monitor progress in great detail, if you want. + +Decompression speed is unaffected by these phenomena. + +.I bzip2 +usually allocates several megabytes of memory to operate +in, and then charges all over it in a fairly random fashion. This means +that performance, both for compressing and decompressing, is largely +determined by the speed at which your machine can service cache misses. +Because of this, small changes to the code to reduce the miss rate have +been observed to give disproportionately large performance improvements. +I imagine +.I bzip2 +will perform best on machines with very large caches. + +.SH CAVEATS +I/O error messages are not as helpful as they could be. +.I bzip2 +tries hard to detect I/O errors and exit cleanly, but the details of +what the problem is sometimes seem rather misleading. + +This manual page pertains to version 1.0.2 of +.I bzip2. +Compressed data created by this version is entirely forwards and +backwards compatible with the previous public releases, versions +0.1pl2, 0.9.0, 0.9.5, 1.0.0 and 1.0.1, but with the following +exception: 0.9.0 and above can correctly decompress multiple +concatenated compressed files. 0.1pl2 cannot do this; it will stop +after decompressing just the first file in the stream. + +.I bzip2recover +versions prior to this one, 1.0.2, used 32-bit integers to represent +bit positions in compressed files, so it could not handle compressed +files more than 512 megabytes long. Version 1.0.2 and above uses +64-bit ints on some platforms which support them (GNU supported +targets, and Windows). To establish whether or not bzip2recover was +built with such a limitation, run it without arguments. In any event +you can build yourself an unlimited version if you can recompile it +with MaybeUInt64 set to be an unsigned 64-bit integer. + + + +.SH AUTHOR +Julian Seward, jseward@acm.org. + +http://sources.redhat.com/bzip2 + +The ideas embodied in +.I bzip2 +are due to (at least) the following +people: Michael Burrows and David Wheeler (for the block sorting +transformation), David Wheeler (again, for the Huffman coder), Peter +Fenwick (for the structured coding model in the original +.I bzip, +and many refinements), and Alistair Moffat, Radford Neal and Ian Witten +(for the arithmetic coder in the original +.I bzip). +I am much +indebted for their help, support and advice. See the manual in the +source distribution for pointers to sources of documentation. Christian +von Roques encouraged me to look for faster sorting algorithms, so as to +speed up compression. Bela Lubkin encouraged me to improve the +worst-case compression performance. +The bz* scripts are derived from those of GNU gzip. +Many people sent patches, helped +with portability problems, lent machines, gave advice and were generally +helpful. diff --git a/Master/texmf/doc/man/man1/cef5conv.1 b/Master/texmf/doc/man/man1/cef5conv.1 new file mode 100644 index 00000000000..7f3a8dc87cf --- /dev/null +++ b/Master/texmf/doc/man/man1/cef5conv.1 @@ -0,0 +1,111 @@ +.\" man page for cef5conv +. +.TH CEF5CONV 1 11-Aug-2005 "CJK Version 4.6.0" +. +.\" ==== +.\" ==== 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/doc/man/man1/cefconv.1 b/Master/texmf/doc/man/man1/cefconv.1 new file mode 100644 index 00000000000..d5ff6b17abe --- /dev/null +++ b/Master/texmf/doc/man/man1/cefconv.1 @@ -0,0 +1,101 @@ +.\" man page for cefconv +. +.TH CEFCONV 1 11-Aug-2005 "CJK Version 4.6.0" +. +.\" ==== +.\" ==== 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/doc/man/man1/cefsconv.1 b/Master/texmf/doc/man/man1/cefsconv.1 new file mode 100644 index 00000000000..0dddcecb143 --- /dev/null +++ b/Master/texmf/doc/man/man1/cefsconv.1 @@ -0,0 +1,111 @@ +.\" man page for cefsconv +. +.TH CEFSCONV 1 11-Aug-2005 "CJK Version 4.6.0" +. +.\" ==== +.\" ==== 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/doc/man/man1/cfftot1.1 b/Master/texmf/doc/man/man1/cfftot1.1 new file mode 100644 index 00000000000..dbe0512c1da --- /dev/null +++ b/Master/texmf/doc/man/man1/cfftot1.1 @@ -0,0 +1,87 @@ +.ds V 2.34 +.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 (kohler@icir.org) diff --git a/Master/texmf/doc/man/man1/cont-de.1 b/Master/texmf/doc/man/man1/cont-de.1 new file mode 100644 index 00000000000..e28b87d88e4 --- /dev/null +++ b/Master/texmf/doc/man/man1/cont-de.1 @@ -0,0 +1,458 @@ +.TH PDFETEX 1 "21 August 2004" "Web2C 7.5.3" +.\"===================================================================== +.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, pdfeinitex, pdfevirtex \- PDF output from e-TeX +.SH SYNOPSIS +.B pdfetex +.RI [ options ] +.RI [ commands ] +.\"===================================================================== +.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 +pdfe\*(TX is a version of e-\*(TX that can create +.I PDF +files as well as +.I DVI +files. +.PP +In +.I DVI +mode, pdfe\*(TX can be used as a complete replacement of the e-\*(TX +engine. +.PP +The typical use of pdfe\*(TX is with a pregenerated formats for which +PDF output has been enabled. The +.B pdfetex +command uses the equivalent of the plain e-\*(TX format, and the +.B pdfelatex +command uses the equivalent of the e-\*(LX format. +To generate formats, use the +.B -ini +switch. +.PP +The +.B pdfeinitex +and +.B pdfevirtex +commands are pdfe\*(TX's analogues to the +.B einitex +and +.B evirtex +commands. In this installation, they are symbolic links to the +.B pdfetex +executable. These symbolic links may not exist at all. +.PP +In +.I PDF +mode, pdfe\*(TX can natively handle the +.IR PDF , +.IR JPG , +and +.I PNG +graphics formats. +pdfe\*(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 pdfe\*(TX understands the following command line options. +.TP +.BI -fmt \ format +.rb +Use +.I format +as the name of the format to be used, instead of the name by which +pdfe\*(TX was called or a +.I %& +line. +.TP +.B -enc +.rb +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 +.rb +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 +.rb +Disable printing error messages in the +.I file:line:error +style. +.TP +.B -file-line-error-style +.rb +This is the old name of the +.B -file-line-error +option. +.TP +.B -halt-on-error +.rb +Exit with an error code when an error is encountered during processing. +.TP +.B -help +.rb +Print help message and exit. +.TP +.B -ini +.rb +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 +.rb +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 +.rb +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 +.rb +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 +.rb +Use +.I name +for the job name, instead of deriving it from the name of the input file. +.TP +.BI -kpathsea-debug \ bitmask +.rb +Sets path searching debugging flags according to the bitmask. See the +.I Kpathsea +manual for details. +.TP +.BI -mktex \ fmt +.rb +Enable +.RI mktex fmt , +where +.I fmt +must be either +.I tex +or +.IR tfm . +.TP +.B -mltex +.rb +Enable ML\*(TX extensions. Only effective in combination with +.BR -ini . +.TP +.BI -no-mktex \ fmt +.rb +Disable +.RI mktex fmt , +where +.I fmt +must be either +.I tex +or +.IR tfm . +.TP +.BI -output-comment \ string +.rb +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 +.rb 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 +.rb +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 pdfe\*(TX. +.TP +.B -parse-first-line +.rb +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 +.rb +Disable parsing of the first line of the main input file. +.TP +.BI -progname \ name +.rb +Pretend to be program +.IR name . +This affects both the format used and the search paths. +.TP +.B -recorder +.rb +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 +.rb +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 +.rb +Disable the +.BI \ewrite18{ command } +construct, even if it is enabled in the +.I texmf.cnf +file. +.TP +.B -src-specials +.rb +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 +.rb +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 +.rb +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 +.rb +Like +.B -translate-file +except that a +.I %& +line can overrule this setting. +.TP +.B -version +.rb +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 pdfe\*(TX formats, you cannot use ~ in a filename you +give directly to pdfe\*(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 +TEXMFOUTPUT +Normally, pdfe\*(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 pdfetex paper +and the current directory is not writable, if TEXMFOUTPUT has +the value +.IR /tmp , +pdfe\*(TX attempts to create +.I /tmp/paper.log +(and +.IR /tmp/paper.pdf , +if any output is produced.) +.TP +TEXINPUTS +Search path for +.I \einput +and +.I \eopenin +files. +This should 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/usr/tex:" to prepend the +current direcory and ``/home/user/tex'' to the standard search path. +.TP +TEXFORMATS +Search path for format files. +.TP +TEXPOOL +search path for +.B pdfetex +internal strings. +.TP +TEXEDIT +Command template for switching to editor. The default, usually +.BR vi , +is set when pdfe\*(TX is compiled. +.TP +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 pdfetex.pool +Text file containing pdfe\*(TX's internal strings. +.TP +.I pdftex.map +Filename mapping definitions. +.TP +.I *.tfm +Metric files for pdfe\*(TX's fonts. +.TP +.I *.fmt +Predigested pdfe\*(TX format (.\|fmt) files. +.br +.\"===================================================================== +.SH BUGS +This version of pdfe\*(TX implements a number of optional extensions. +In fact, many of these extensions conflict to a greater or lesser +extent with the definition of pdfe\*(TX. When such extensions are +enabled, the banner printed when pdfe\*(TX starts is changed to print +.B pdfeTeXk +instead of +.BR pdfeTeX . +.PP +This version of pdfe\*(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 +pdfe\*(TX is available for a large variety of machine architectures +and operation systems. +pdfe\*(TX is part of all major \*(TX distributions. +.P +Information on how to get pdfe\*(TX and related information +is available at the +.BI "http://tug.org" \ TUG +website. +The most recent version of pdfe\*(TX is available for anonymous +ftp at the +.B http://www.pdftex.de/tex/pdftex/ +.IR "pdfe\*(TX development site" . +.P +The following pdfe\*(TX related mailing list is available: +.BR pdftex@tug.org . +This is a majordomo list; +to subscribe send a message containing +.I subscribe pdftex +to +.BR majordomo@tug.org . +.\"===================================================================== +.SH "SEE ALSO" +.BR tex (1), +.BR mf (1), +.BR etex (1), +.BR pdftex (1). +.\"===================================================================== +.SH AUTHORS +The primary authors of pdf\*(TX are Han The Thanh, Petr Sojka, and +Jiri Zlatuska. +.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/doc/man/man1/cont-en.1 b/Master/texmf/doc/man/man1/cont-en.1 new file mode 100644 index 00000000000..e28b87d88e4 --- /dev/null +++ b/Master/texmf/doc/man/man1/cont-en.1 @@ -0,0 +1,458 @@ +.TH PDFETEX 1 "21 August 2004" "Web2C 7.5.3" +.\"===================================================================== +.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, pdfeinitex, pdfevirtex \- PDF output from e-TeX +.SH SYNOPSIS +.B pdfetex +.RI [ options ] +.RI [ commands ] +.\"===================================================================== +.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 +pdfe\*(TX is a version of e-\*(TX that can create +.I PDF +files as well as +.I DVI +files. +.PP +In +.I DVI +mode, pdfe\*(TX can be used as a complete replacement of the e-\*(TX +engine. +.PP +The typical use of pdfe\*(TX is with a pregenerated formats for which +PDF output has been enabled. The +.B pdfetex +command uses the equivalent of the plain e-\*(TX format, and the +.B pdfelatex +command uses the equivalent of the e-\*(LX format. +To generate formats, use the +.B -ini +switch. +.PP +The +.B pdfeinitex +and +.B pdfevirtex +commands are pdfe\*(TX's analogues to the +.B einitex +and +.B evirtex +commands. In this installation, they are symbolic links to the +.B pdfetex +executable. These symbolic links may not exist at all. +.PP +In +.I PDF +mode, pdfe\*(TX can natively handle the +.IR PDF , +.IR JPG , +and +.I PNG +graphics formats. +pdfe\*(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 pdfe\*(TX understands the following command line options. +.TP +.BI -fmt \ format +.rb +Use +.I format +as the name of the format to be used, instead of the name by which +pdfe\*(TX was called or a +.I %& +line. +.TP +.B -enc +.rb +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 +.rb +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 +.rb +Disable printing error messages in the +.I file:line:error +style. +.TP +.B -file-line-error-style +.rb +This is the old name of the +.B -file-line-error +option. +.TP +.B -halt-on-error +.rb +Exit with an error code when an error is encountered during processing. +.TP +.B -help +.rb +Print help message and exit. +.TP +.B -ini +.rb +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 +.rb +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 +.rb +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 +.rb +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 +.rb +Use +.I name +for the job name, instead of deriving it from the name of the input file. +.TP +.BI -kpathsea-debug \ bitmask +.rb +Sets path searching debugging flags according to the bitmask. See the +.I Kpathsea +manual for details. +.TP +.BI -mktex \ fmt +.rb +Enable +.RI mktex fmt , +where +.I fmt +must be either +.I tex +or +.IR tfm . +.TP +.B -mltex +.rb +Enable ML\*(TX extensions. Only effective in combination with +.BR -ini . +.TP +.BI -no-mktex \ fmt +.rb +Disable +.RI mktex fmt , +where +.I fmt +must be either +.I tex +or +.IR tfm . +.TP +.BI -output-comment \ string +.rb +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 +.rb 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 +.rb +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 pdfe\*(TX. +.TP +.B -parse-first-line +.rb +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 +.rb +Disable parsing of the first line of the main input file. +.TP +.BI -progname \ name +.rb +Pretend to be program +.IR name . +This affects both the format used and the search paths. +.TP +.B -recorder +.rb +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 +.rb +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 +.rb +Disable the +.BI \ewrite18{ command } +construct, even if it is enabled in the +.I texmf.cnf +file. +.TP +.B -src-specials +.rb +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 +.rb +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 +.rb +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 +.rb +Like +.B -translate-file +except that a +.I %& +line can overrule this setting. +.TP +.B -version +.rb +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 pdfe\*(TX formats, you cannot use ~ in a filename you +give directly to pdfe\*(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 +TEXMFOUTPUT +Normally, pdfe\*(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 pdfetex paper +and the current directory is not writable, if TEXMFOUTPUT has +the value +.IR /tmp , +pdfe\*(TX attempts to create +.I /tmp/paper.log +(and +.IR /tmp/paper.pdf , +if any output is produced.) +.TP +TEXINPUTS +Search path for +.I \einput +and +.I \eopenin +files. +This should 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/usr/tex:" to prepend the +current direcory and ``/home/user/tex'' to the standard search path. +.TP +TEXFORMATS +Search path for format files. +.TP +TEXPOOL +search path for +.B pdfetex +internal strings. +.TP +TEXEDIT +Command template for switching to editor. The default, usually +.BR vi , +is set when pdfe\*(TX is compiled. +.TP +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 pdfetex.pool +Text file containing pdfe\*(TX's internal strings. +.TP +.I pdftex.map +Filename mapping definitions. +.TP +.I *.tfm +Metric files for pdfe\*(TX's fonts. +.TP +.I *.fmt +Predigested pdfe\*(TX format (.\|fmt) files. +.br +.\"===================================================================== +.SH BUGS +This version of pdfe\*(TX implements a number of optional extensions. +In fact, many of these extensions conflict to a greater or lesser +extent with the definition of pdfe\*(TX. When such extensions are +enabled, the banner printed when pdfe\*(TX starts is changed to print +.B pdfeTeXk +instead of +.BR pdfeTeX . +.PP +This version of pdfe\*(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 +pdfe\*(TX is available for a large variety of machine architectures +and operation systems. +pdfe\*(TX is part of all major \*(TX distributions. +.P +Information on how to get pdfe\*(TX and related information +is available at the +.BI "http://tug.org" \ TUG +website. +The most recent version of pdfe\*(TX is available for anonymous +ftp at the +.B http://www.pdftex.de/tex/pdftex/ +.IR "pdfe\*(TX development site" . +.P +The following pdfe\*(TX related mailing list is available: +.BR pdftex@tug.org . +This is a majordomo list; +to subscribe send a message containing +.I subscribe pdftex +to +.BR majordomo@tug.org . +.\"===================================================================== +.SH "SEE ALSO" +.BR tex (1), +.BR mf (1), +.BR etex (1), +.BR pdftex (1). +.\"===================================================================== +.SH AUTHORS +The primary authors of pdf\*(TX are Han The Thanh, Petr Sojka, and +Jiri Zlatuska. +.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/doc/man/man1/cont-nl.1 b/Master/texmf/doc/man/man1/cont-nl.1 new file mode 100644 index 00000000000..e28b87d88e4 --- /dev/null +++ b/Master/texmf/doc/man/man1/cont-nl.1 @@ -0,0 +1,458 @@ +.TH PDFETEX 1 "21 August 2004" "Web2C 7.5.3" +.\"===================================================================== +.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, pdfeinitex, pdfevirtex \- PDF output from e-TeX +.SH SYNOPSIS +.B pdfetex +.RI [ options ] +.RI [ commands ] +.\"===================================================================== +.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 +pdfe\*(TX is a version of e-\*(TX that can create +.I PDF +files as well as +.I DVI +files. +.PP +In +.I DVI +mode, pdfe\*(TX can be used as a complete replacement of the e-\*(TX +engine. +.PP +The typical use of pdfe\*(TX is with a pregenerated formats for which +PDF output has been enabled. The +.B pdfetex +command uses the equivalent of the plain e-\*(TX format, and the +.B pdfelatex +command uses the equivalent of the e-\*(LX format. +To generate formats, use the +.B -ini +switch. +.PP +The +.B pdfeinitex +and +.B pdfevirtex +commands are pdfe\*(TX's analogues to the +.B einitex +and +.B evirtex +commands. In this installation, they are symbolic links to the +.B pdfetex +executable. These symbolic links may not exist at all. +.PP +In +.I PDF +mode, pdfe\*(TX can natively handle the +.IR PDF , +.IR JPG , +and +.I PNG +graphics formats. +pdfe\*(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 pdfe\*(TX understands the following command line options. +.TP +.BI -fmt \ format +.rb +Use +.I format +as the name of the format to be used, instead of the name by which +pdfe\*(TX was called or a +.I %& +line. +.TP +.B -enc +.rb +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 +.rb +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 +.rb +Disable printing error messages in the +.I file:line:error +style. +.TP +.B -file-line-error-style +.rb +This is the old name of the +.B -file-line-error +option. +.TP +.B -halt-on-error +.rb +Exit with an error code when an error is encountered during processing. +.TP +.B -help +.rb +Print help message and exit. +.TP +.B -ini +.rb +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 +.rb +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 +.rb +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 +.rb +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 +.rb +Use +.I name +for the job name, instead of deriving it from the name of the input file. +.TP +.BI -kpathsea-debug \ bitmask +.rb +Sets path searching debugging flags according to the bitmask. See the +.I Kpathsea +manual for details. +.TP +.BI -mktex \ fmt +.rb +Enable +.RI mktex fmt , +where +.I fmt +must be either +.I tex +or +.IR tfm . +.TP +.B -mltex +.rb +Enable ML\*(TX extensions. Only effective in combination with +.BR -ini . +.TP +.BI -no-mktex \ fmt +.rb +Disable +.RI mktex fmt , +where +.I fmt +must be either +.I tex +or +.IR tfm . +.TP +.BI -output-comment \ string +.rb +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 +.rb 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 +.rb +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 pdfe\*(TX. +.TP +.B -parse-first-line +.rb +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 +.rb +Disable parsing of the first line of the main input file. +.TP +.BI -progname \ name +.rb +Pretend to be program +.IR name . +This affects both the format used and the search paths. +.TP +.B -recorder +.rb +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 +.rb +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 +.rb +Disable the +.BI \ewrite18{ command } +construct, even if it is enabled in the +.I texmf.cnf +file. +.TP +.B -src-specials +.rb +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 +.rb +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 +.rb +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 +.rb +Like +.B -translate-file +except that a +.I %& +line can overrule this setting. +.TP +.B -version +.rb +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 pdfe\*(TX formats, you cannot use ~ in a filename you +give directly to pdfe\*(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 +TEXMFOUTPUT +Normally, pdfe\*(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 pdfetex paper +and the current directory is not writable, if TEXMFOUTPUT has +the value +.IR /tmp , +pdfe\*(TX attempts to create +.I /tmp/paper.log +(and +.IR /tmp/paper.pdf , +if any output is produced.) +.TP +TEXINPUTS +Search path for +.I \einput +and +.I \eopenin +files. +This should 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/usr/tex:" to prepend the +current direcory and ``/home/user/tex'' to the standard search path. +.TP +TEXFORMATS +Search path for format files. +.TP +TEXPOOL +search path for +.B pdfetex +internal strings. +.TP +TEXEDIT +Command template for switching to editor. The default, usually +.BR vi , +is set when pdfe\*(TX is compiled. +.TP +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 pdfetex.pool +Text file containing pdfe\*(TX's internal strings. +.TP +.I pdftex.map +Filename mapping definitions. +.TP +.I *.tfm +Metric files for pdfe\*(TX's fonts. +.TP +.I *.fmt +Predigested pdfe\*(TX format (.\|fmt) files. +.br +.\"===================================================================== +.SH BUGS +This version of pdfe\*(TX implements a number of optional extensions. +In fact, many of these extensions conflict to a greater or lesser +extent with the definition of pdfe\*(TX. When such extensions are +enabled, the banner printed when pdfe\*(TX starts is changed to print +.B pdfeTeXk +instead of +.BR pdfeTeX . +.PP +This version of pdfe\*(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 +pdfe\*(TX is available for a large variety of machine architectures +and operation systems. +pdfe\*(TX is part of all major \*(TX distributions. +.P +Information on how to get pdfe\*(TX and related information +is available at the +.BI "http://tug.org" \ TUG +website. +The most recent version of pdfe\*(TX is available for anonymous +ftp at the +.B http://www.pdftex.de/tex/pdftex/ +.IR "pdfe\*(TX development site" . +.P +The following pdfe\*(TX related mailing list is available: +.BR pdftex@tug.org . +This is a majordomo list; +to subscribe send a message containing +.I subscribe pdftex +to +.BR majordomo@tug.org . +.\"===================================================================== +.SH "SEE ALSO" +.BR tex (1), +.BR mf (1), +.BR etex (1), +.BR pdftex (1). +.\"===================================================================== +.SH AUTHORS +The primary authors of pdf\*(TX are Han The Thanh, Petr Sojka, and +Jiri Zlatuska. +.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/doc/man/man1/ctangle.1 b/Master/texmf/doc/man/man1/ctangle.1 new file mode 120000 index 00000000000..36112227c2d --- /dev/null +++ b/Master/texmf/doc/man/man1/ctangle.1 @@ -0,0 +1 @@ +cweb.1
\ No newline at end of file diff --git a/Master/texmf/doc/man/man1/ctie.1 b/Master/texmf/doc/man/man1/ctie.1 new file mode 100644 index 00000000000..8058d364e5a --- /dev/null +++ b/Master/texmf/doc/man/man1/ctie.1 @@ -0,0 +1,55 @@ +.TH CTIE 1 20/04/2003 +.SH NAME +ctie \- merge or apply CWEB change files +.SH SYNOPSIS +.B ctie +.B \-c|\-m +.I outputfile masterfile changefile... + +.SH DESCRIPTION +The +.I 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. +.I 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 +.I @i +command) are fully expanded during +.I CTIE +processing, which means that the change files are able to modify the +contents of any included files. Also, if this program has been +compiled using the +.I kpathsea +library, then files are searched for using the +.I CWEBINPUTS +environment variable, as described in the +.I kpathsea +documentation. +.SH OPTIONS +.TP +.B \-c +Create a single change file from the given +.IR changefiles . +.TP +.B \-m +Create a new master file by applying the given +.IR changefiles . +.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/doc/man/man1/cweave.1 b/Master/texmf/doc/man/man1/cweave.1 new file mode 120000 index 00000000000..36112227c2d --- /dev/null +++ b/Master/texmf/doc/man/man1/cweave.1 @@ -0,0 +1 @@ +cweb.1
\ No newline at end of file diff --git a/Master/texmf/doc/man/man1/cweb.1 b/Master/texmf/doc/man/man1/cweb.1 new file mode 100644 index 00000000000..617f92379b4 --- /dev/null +++ b/Master/texmf/doc/man/man1/cweb.1 @@ -0,0 +1,133 @@ +.TH CWEB 1 "19 December 2004" "Web2C 7.5.5" +. +.SH NAME +ctangle, cweave \- translate CWEB to C and/or TeX +. +.SH SYNOPSIS +.na +.B ctangle +[ +.B \-bhp +] [ +.B +s +] webfile[.w] [changefile[.ch]] [outputfile[.c]] +.br +.B cweave +[ +.B \-befhpx +] [ +.B +s +] webfile[.w] [changefile[.ch]] [outputfile[.tex]] +.ad +. +.SH DESCRIPTION +The +.I 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 +.I 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 .w is added if there is no +extension). +If that file cannot be opened, the extension .web is tried instead. +(But .w is recommended, since .web usually implies Pascal.) +If there is a second name, it is a change file (and .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 .c or .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 -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 +.I 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 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) +.TP +tex(1), 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/doc/man/man1/detex.1 b/Master/texmf/doc/man/man1/detex.1 new file mode 100644 index 00000000000..93e71005746 --- /dev/null +++ b/Master/texmf/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/doc/man/man1/dmp.1 b/Master/texmf/doc/man/man1/dmp.1 new file mode 100644 index 00000000000..69f54d4040b --- /dev/null +++ b/Master/texmf/doc/man/man1/dmp.1 @@ -0,0 +1,60 @@ +.TH DMP 1 "4 January 1998" "Web2C 7.5.5" +.\"===================================================================== +.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 +dmp \- translate Troff output to low-level MetaPost input +.SH SYNOPSIS +.B dmp +.RI [ option ] +.I ditrofffile +.RI [ mpxfile ] +.\"===================================================================== +.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 dmp +program generates \*(MP source code from the +.IR ditrofffile . +The generated code is written in +.I mpxfile +if it is specified, and to standard output otherwise. +.PP +.B dmp +is typically called from scripts like +.BR makempx , +not from the command line. +.\"===================================================================== +.SH OPTIONS +.B dmp +accepts the following options: +.TP +.B --help +.rb +Print help message and exit. +.TP +.B --version +.rb +Print version information and exit. +.\"===================================================================== +.SH "SEE ALSO" +.BR mpost (1), +.BR makempx (1). diff --git a/Master/texmf/doc/man/man1/dt2dv.1 b/Master/texmf/doc/man/man1/dt2dv.1 new file mode 100644 index 00000000000..d3b4726d2b7 --- /dev/null +++ b/Master/texmf/doc/man/man1/dt2dv.1 @@ -0,0 +1,156 @@ +.\" ==================================================================== +.\" @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/doc/man/man1/dv2dt.1 b/Master/texmf/doc/man/man1/dv2dt.1 new file mode 100644 index 00000000000..79f6368b80e --- /dev/null +++ b/Master/texmf/doc/man/man1/dv2dt.1 @@ -0,0 +1,715 @@ +.\" ==================================================================== +.\" @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/doc/man/man1/dvi2fax.1 b/Master/texmf/doc/man/man1/dvi2fax.1 new file mode 100644 index 00000000000..f7c436d6e33 --- /dev/null +++ b/Master/texmf/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/doc/man/man1/dvi2tty.1 b/Master/texmf/doc/man/man1/dvi2tty.1 new file mode 100644 index 00000000000..168a073373d --- /dev/null +++ b/Master/texmf/doc/man/man1/dvi2tty.1 @@ -0,0 +1,131 @@ +.TH DVI2TTY Local "7 June 1986" +.SH NAME +dvi2tty \- preview a 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 apprporiate for terminals +and lineprinters. 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 +usefull if you want to avoid walking to the +laserprinter (or whatever) for each iteration of your +document. +.br +Since +.I dvi2tty +produces output for terminals and lineprinters the +representation of documents is naturally quite primitive. +Fontchanges are totally ignored, which implies that +special symbols, such as mathematical symbols, get mapped into the +characters at the corresponding positions in the "standard" fonts. +.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. laserprinters). 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 commandline, 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 \-q +Don't pipe the output through a pager. +This may be the default on some systems +(depending on the whims of the SA installing the program). +.TP +.B \-f +Pipe through a pager, $PAGER if defined, or whatever your SA 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 overides 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 \-l +Mark pagebreaks with the two-character sequence ``^L''. The default is +to mark them with a formfeed character. +.TP +.B \-u +Don't make any attempts to find special Scandinavian characters. +If such characters are in the text they will map to ``a'' and ``o''. +This is probably the default outside of Scandinavia. (The SA made +the decision when the program was installed.) +.TP +.B \-s +Try to find the special Scandinavian characters that on most (?) +terminals in Scandinavia are mapped to ``{|}[\\]''. +This can be the default, and output from files not containing these +special characters will be identical regardless of this option. +.SH FILES +/usr/ucb/more \ \ \ \ +probably the default pager. +.SH ENVIRONMENT +PAGER \ \ \ \ \ \ \ \ \ \ \ \ +the pager to use. +.br +DVI2TTY \ \ \ \ \ \ \ \ \ \ \ +can be set to hold commandline options. +.SH "SEE ALSO" +TeX, dvi2ps +.SH AUTHOR +Svante Lindahl, Royal Institute of Technology, Stockholm +.br +Improved C version: Marcel Mol +.br +{seismo, mcvax}!enea!ttds!zap +.br +marcel@duteca.UUCP +.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 commandline. diff --git a/Master/texmf/doc/man/man1/dvibook.1 b/Master/texmf/doc/man/man1/dvibook.1 new file mode 100644 index 00000000000..dd0bce06108 --- /dev/null +++ b/Master/texmf/doc/man/man1/dvibook.1 @@ -0,0 +1,53 @@ +.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/doc/man/man1/dviconcat.1 b/Master/texmf/doc/man/man1/dviconcat.1 new file mode 100644 index 00000000000..9267446095a --- /dev/null +++ b/Master/texmf/doc/man/man1/dviconcat.1 @@ -0,0 +1,46 @@ +.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/doc/man/man1/dvicopy.1 b/Master/texmf/doc/man/man1/dvicopy.1 new file mode 100644 index 00000000000..cd62db37463 --- /dev/null +++ b/Master/texmf/doc/man/man1/dvicopy.1 @@ -0,0 +1,22 @@ +.TH DVICOPY 1 TeX "24 January 1999" "Web2C 7.5.5" +.SH NAME +dvicopy \- produce modified copy of DVI file +.SH SYNOPSIS +.B dvicopy +.RI [ options ] +.RI [ infile\ [ outfile ]] +.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 "SEE ALSO" +dviselect(1) diff --git a/Master/texmf/doc/man/man1/dvidvi.1 b/Master/texmf/doc/man/man1/dvidvi.1 new file mode 100644 index 00000000000..e9906a6e874 --- /dev/null +++ b/Master/texmf/doc/man/man1/dvidvi.1 @@ -0,0 +1,127 @@ +.TH DVIDVI L "March 1994" +.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 Copyright +dvidvi 1.0, Copyright (C) 1988-91, Radical Eye Software +.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. +.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/doc/man/man1/dvihp.1 b/Master/texmf/doc/man/man1/dvihp.1 new file mode 100644 index 00000000000..cd88772978a --- /dev/null +++ b/Master/texmf/doc/man/man1/dvihp.1 @@ -0,0 +1,49 @@ +.TH DVIHP 1 "October 30, 1999" +.\" 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@mail.tug.org. +.SH SEE ALSO +\fBdvicopy\fP(1), \fBdvilj4\fP(1). diff --git a/Master/texmf/doc/man/man1/dvilj.1 b/Master/texmf/doc/man/man1/dvilj.1 new file mode 100644 index 00000000000..40de4732e83 --- /dev/null +++ b/Master/texmf/doc/man/man1/dvilj.1 @@ -0,0 +1,275 @@ +.TH DVILJK 1 "10 June 1996" +.ad b +.SH NAME +dvilj4, dvilj4l, dvilj2p, dvilj \- convert a TeX DVI file to PCL, for HP LaserJet printers +.SH SYNOPSIS +\f3dvilj\f1 +[\f3\-\-D\f2number\f1] +[\f3\-c\f2copies\f1] +[\f3\-d\f2mode\f1] +[\f3\-D\f1] +[\f3\-E\f1] +[\f3\-e\f2outputfile\f1] +[\f3\-f\f2frompage\f1] +[\f3\-g\f1] +[\f3\-h\f2headerfile\f1] +[\f3\-l\f1] +[\f3\-M\f2flag\f1] +[\f3\-m\f2mag\f1] +[\f3\-p\f2pages\f1] +[\f3\-q\f1] +[\f3\-r\f1] +[\f3\-t\f2topage\f1] +[\f3\-s\f2pagesize\f1] +[\f3\-v\f1] +[\f3\-V\f2mode\f1] +[\f3\-w\f1] +[\f3\-x\f2xoff(mm)\f1] +[\f3\-y\f2yoff(mm)\f1] +[\f3\-X\f2xoff(dots)\f1] +[\f3\-Y\f2yoff(dots)\f1] +[\f3\-z\f1] +[\f3\-\f1] +[\f2filename\f1] +.SH DESCRIPTION +Dvilj and siblings convert TeX-output .dvi files into PCL (the +Hewlett-Packard Printer Control Language) commands suitable for printing +on a HP LaserJet+, HP LaserJet IIP (using dvilj2p), HP LaserJet 4 (using +dvilj4), and fully compatible printers. +.PP +Dvilj4 also provides support for the builtin Intellifont and TrueType +fonts; TFM and VF files are provided in the distribution. +Virtual fonts are not supported directly by Dvilj, so you must run +.BR dvicopy (1) +first, or otherwise expand the virtual fonts +.PP +All programs are generated from one source file dvi2xx.c. +They are usually called via a shell script or as a line printer +filter. One such script, dvihp, is included in the distribution. It +provides command-line options similar to those of dvips(1). +.SH OPTIONS +.TP \w'-Dnumber'u+2n +\f3--D\f2number\f1 +Debug according to the bits of \f2number\f1; see the Kpathsea manual for +values. Also turns on general verbosity. +.TP +\f3-c\f2number\f1 +print each page \f2number\f1 times (including original) +.TP +\f3-d\f2number\f1 +print in duplex mode. The option -d\f21\f1 means long edge binding, +-d\f22\f1 stands for short edge binding. This option is only +selectable from \fIdvilj2p\fP, and is known to work on the LaserJet IId, +LaserJet IIId, and LaserJet 4. +.TP +\f3-D\f1[-] +Double-sided printing - see below; -D\f21\f1 prints odd sides only, +-D\f22\f1 is for even pages, a trailing \f2-\f1 suppresses printing of +empty padding pages. +.TP +\f3-E\f1 +Switch printer into econo mode (dvilj4 only). +.TP +\f3-e\f2outfile\f1 +Send output to \f2outfile\f1 instead of the basename of dvi file +extended with `.lj'. +If \f2outfile\f1 is `-' (as in `-e-') the output is directed +to standard output and can be directly piped into a spooler. +.TP +\f3-f\f2pagenum\f1 +Print pages with TeX page numbers greater than or equal to \f2pagenum\f1. +.TP +\f3-g\f1 +``go'' mode: do not reset printer at start of job. +.TP +\f3-h\f2headerfile\f1 +Copy \f2headerfile\f1 to output before translation of the DVI file. +Used to send arbitrary commands to the laserprinter. +.TP +\f3-l\f1 +print output in landscape mode; supported +only by dvilj2p and dvilj4. +.TP +\f3-M\f2flag\f1 +Do (not) call mktexpk to generate fonts on demand. \f3-M\f21\f1 and +\f3-M\f1 are equivalent. \f3-M\f20\f1 enables invoking mktexpk. (This +is the same as dvips.) The default behavior (i.e., if no +\f3-M\f1 option is given) is chosen at compile-time; as distributed, +mktexpk is enabled. \f3-M\f1 is only valid if +dvi2xx was compiled with support for mktexpk. +.TP +\f3-m\f2magnification\f1 +Specify the magnification to use. The following are available: +.br +\f3-m#\f2usermag\f1 e.g., \f3#900\f1 +.br +\f3-m0\f1 equivalent to \f3-m#1000\f1 +.br +\f3-mh\f1 equivalent to \f3-m#1095\f1 +.br +\f3-m1\f1 equivalent to \f3-m#1200\f1 +.br +\f3-mq\f1 equivalent to \f3-m#1250\f1 +.br +\f3-m2\f1 equivalent to \f3-m#1440\f1 +.br +\f3-m3\f1 equivalent to \f3-m#1728\f1 +.br +\f3-m4\f1 equivalent to \f3-m#2074\f1 +.br +\f3-m5\f1 equivalent to \f3-m#2488\f1 +.TP +\f3-p\f2pagecount\f1 +print \f2pagecount\f1 pages after the starting page. +.TP +\f3-q\f1 +Quiet operation: omit final statistics, etc. +.TP +\f3-r\f1 +toggle page reversal; by default, pages are reversed. +.TP +\f3-s\f2pagesize \f1 +Specify the page size: +.br +\f3-s1\f1: executive (7.25in x 10.5in) +.br +\f3-s2\f1: letter (8.5in x 11in) +.br +\f3-s3\f1: legal (8.5in x 14in) +.br +\f3-s26\f1: A4 (210mm x 297mm) +.br +\f3-s80\f1: monarch (3.875in x 7.5in) +.br +\f3-s81\f1: commercial-10 (4.125in x 9.5in) +.br +\f3-s90\f1: international DL (110mm x 220mm) +.br +\f3-s91\f1: international C5 (162mm x 229mm) +.br +All values are from the LJ II technical reference manual. +If the -s commandline option is omitted, no clipping is performed +at the bottom of the page. +.TP +\f3-t\f2pagenum\f1 +Print pages with TeX page numbers less than or equal to \f2pagenum\f1. +.TP +\f3-v\f1 +Verbose mode: list fonts used, etc. +.TP +\f3-V\f2mode\f1 +compatibility mode. Use \f2K\f1 for Kyocera, \f2B\f1 for Brother, +\f26\f1 for LJ6 printers. +.TP +\f3-w\f1 +Omit warnings. +.TP +\f3-x\f2offset\f1 +global x-offset in mm on output page +relative to 1 inch/1 inch origin +.TP +\f3-y\f2offset\f1 +global y-offset in mm on output page +relative to 1 inch/1 inch origin +.TP +\f3-X\f2offset\f1 +global x-offset in dots on output page +(overrides 1 inch/1 inch origin) +.TP +\f3-Y\f2offset\f1 +global y-offset in dots on output page +(overrides 1 inch/1 inch origin) +.TP +\f3-z\f1 +print a test page with the page counter at end of job +.TP +\f3-\f1 +Take input from standard input (must be seekable), write to standard output. +.PP +If no arguments are specified a brief usage message is displayed. +.SH \especial COMMANDS +TeX `\especial' commands that are implemented: +.TP \w'\f3\especial{hpfile=<filename>}\f1'u+2n +\f3\especial{file=<filename>}\f1 +copy specified file to the printer; either vector- or bitmap-graphics PMP +commands +.TP +\f3\especial{hpfile=<filename>}\f1 +Same as `file'. +.TP 0 +others: +There are a few other special commands implented for the LJ-series, +which should only be used in connection with the distributed style +files (e.g., graybox.sty). They may change in forthcoming versions. +.PP +You can include Encapsulated PostScript (EPS) files in the PCL files output +by dvilj if you convert them to PCL first. The distribution includes a +script `epspcl' to do this (using Ghostscript, so your Ghostscript must +have the necessary LaserJet driver(s) compiled in). +.SH DOUBLE PAGE PRINTING +The command line option -D 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 -D is used to print both even and odd pages (-D is used +without the optional \f21\f1 or \f22\f1) +the following will happen after +half of the pages is printed: +\f3LJ:\f1 +the printer stops, shows message "FEED" 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 -D1 was specified only odd pages will be printed, -D2 can be used +for even pages. A trailing `-' (as in -D-, -D1- or -D2-) supresses +printing of empty pages which are generated for padding otherwise. +.PP +The driver allows the -D 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 LJ II 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 -pX can be used to abort printing +after the output of X pages (can lead to strange results together +with -D). I personally dislike this option. The secure way of +printing a part of a document is using -f (from) and -t (to). +.SH ENVIRONMENT +Dviljk 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 +DVILJFONTS, if set, overrides all other font paths. +.PP +DVILJMAKEPK, if set, overrides `mktexpk' as the name of the command to +execute to create a PK file if one isn't found. +.PP +The DVILJSIZES variable 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 ``pxl'' 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. \fIdvilj\fR +tries the actual size of the font before trying any of the given sizes. +.PP +KPATHSEA_DEBUG: Trace Kpathsea lookups; set to -1 for complete tracing. +.SH AUTHOR +Gustaf Neumann, Wirtschaftsuniversitaet Wien +.br +neumann@wu-wien.ac.at +.PP +dviljk changes by kb@mail.tug.org; email bug reports to tex\-k@mail.tug.org. diff --git a/Master/texmf/doc/man/man1/dvilj2p.1 b/Master/texmf/doc/man/man1/dvilj2p.1 new file mode 120000 index 00000000000..67bb7d80a78 --- /dev/null +++ b/Master/texmf/doc/man/man1/dvilj2p.1 @@ -0,0 +1 @@ +dvilj.1
\ No newline at end of file diff --git a/Master/texmf/doc/man/man1/dvilj4.1 b/Master/texmf/doc/man/man1/dvilj4.1 new file mode 120000 index 00000000000..67bb7d80a78 --- /dev/null +++ b/Master/texmf/doc/man/man1/dvilj4.1 @@ -0,0 +1 @@ +dvilj.1
\ No newline at end of file diff --git a/Master/texmf/doc/man/man1/dvilj4l.1 b/Master/texmf/doc/man/man1/dvilj4l.1 new file mode 120000 index 00000000000..67bb7d80a78 --- /dev/null +++ b/Master/texmf/doc/man/man1/dvilj4l.1 @@ -0,0 +1 @@ +dvilj.1
\ No newline at end of file diff --git a/Master/texmf/doc/man/man1/dvilj6.1 b/Master/texmf/doc/man/man1/dvilj6.1 new file mode 120000 index 00000000000..67bb7d80a78 --- /dev/null +++ b/Master/texmf/doc/man/man1/dvilj6.1 @@ -0,0 +1 @@ +dvilj.1
\ No newline at end of file diff --git a/Master/texmf/doc/man/man1/dvipdfm.1 b/Master/texmf/doc/man/man1/dvipdfm.1 new file mode 100644 index 00000000000..674a15790a0 --- /dev/null +++ b/Master/texmf/doc/man/man1/dvipdfm.1 @@ -0,0 +1,322 @@ +.de EX +.sp +.in +5 +.nf +.ft CW +.. +.de EE +.in -5 +.ft R +.sp +.fi +.. +.TH dvipdfm 1 5/28/2001 +.SH NAME +dvipdfm \- Produce PDF files directly from DVI files + +.SH SYNOPSIS +.B dvipdfm +.RI [ options ] +.IR file [.dvi] + +.SH DESCRIPTION +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 more details, consult the +.I "Dvipdfm User's Manual," +which is distributed with +.B dvipdfm. + +.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 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 tex "(1), " dvips "(1), " groff "(1), " grodvi "(1), " pic "(1), " +and the +.I "Kpathsea library" +info documentation. + +.SH AUTHOR +Mark A. Wicks <mwicks@kettering.edu> + diff --git a/Master/texmf/doc/man/man1/dvipdft.1 b/Master/texmf/doc/man/man1/dvipdft.1 new file mode 100644 index 00000000000..803db249e4e --- /dev/null +++ b/Master/texmf/doc/man/man1/dvipdft.1 @@ -0,0 +1,36 @@ +.TH "dvipdft" "1" "May 2004" "teTeX" "teTeX" +.PP +.SH "NAME" +dvipdft \- create thumbnail images for use with dvipdfm +.PP +.SH "SYNOPSIS" +.PP +\fBdvipdft\fP [ \fI DVIPDFM-OPTIONS\fP \&.\&.\&. ] \fI filename.dvi\fP +.PP +.SH "DESCRIPTION" +.PP +\fBdvipdft\fP 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ü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/doc/man/man1/dvipng.1 b/Master/texmf/doc/man/man1/dvipng.1 new file mode 100644 index 00000000000..a0862bd5abe --- /dev/null +++ b/Master/texmf/doc/man/man1/dvipng.1 @@ -0,0 +1,483 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" +.\" 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 "DVIPNG 1" +.TH DVIPNG 1 "2005-04-04" "dvipng 1.6" "User commands" +.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. On a +fairly low-end laptop, it takes less than a second to generate 150 +one-formula images. This makes dvipng 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 \-\-follow switch that makes dvipng wait at \s-1EOF\s0 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, color specials +and simple PostScript inclusion specials. +.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" +Set 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 \fB\s-1DEBUG\s0\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 \fBpreview.sty\fR from preview-latex is used. 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*" +Enable follow mode. 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 \s-1EOF\s0 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 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. 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 \fBpreview.sty\fR from preview-latex is used. 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 \-\-height and the \-\-depth. +.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" +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*" +Turns off automatic \s-1PK\s0 font generation (\fImktexpk\fR). This will have +no effect when using PostScript fonts, since no \s-1PK\s0 font generation will +be done anyway. +.IP "\fB\-\-noghostscript*\fR" 4 +.IX Item "--noghostscript*" +This switch prohibits the internal call to GhostScript for displaying +PostScript specials. \fB\-\-noghostscript0\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\-o\fR \fIname\fR" 4 +.IX Item "-o name" +Send output to the file \fIname\fR. A single occurrence of \fB%d\fR or +\&\fB%01d\fR, ..., \fB%09d\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%d.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\-\-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 \s-1PK\s0 and T1lib rendering to be \fInum\fR*\fInum\fR. The default +value is 4 which gives 16 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\-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. +This option overrides any papersize special in the \s-1DVI\s0 file. +.IP "\fB\-\-t1lib*\fR" 4 +.IX Item "--t1lib*" +Enable/disable 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*" +On systems with a fairly new \fBlibgd\fR, one can choose to generate +truecolor output. This will not be necessary in general unless you +include truecolor images via a PostScript special (i.e., the +\&\fBgraphics\fR or \fBgraphicx\fR package). It will lead to longer +execution time, mostly because more data is written to disk. +.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\-x\fR \fInum\fR" 4 +.IX Item "-x num" +Set the x magnification ratio to \fInum\fR/1000. 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 +``Currently, valid values range from 0 \- 9, corresponding directly to +the zlib compression levels 0 \- 9 (0 \- no compression, 9 \- \*(L"maximal\*(R" +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.'' +.SH "NOTES" +.IX Header "NOTES" +The full manual is accessible in the 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 General Public License, see the +\&\s-1COPYING\s0 file in the dvipng distribution or +<\fBhttp://www.gnu.org/licenses/gpl.html\fR>. +.PP +Copyright (c) 2002\-2005 Jan\-Ake Larsson diff --git a/Master/texmf/doc/man/man1/dvips.1 b/Master/texmf/doc/man/man1/dvips.1 new file mode 100644 index 00000000000..1ff6e3f0e64 --- /dev/null +++ b/Master/texmf/doc/man/man1/dvips.1 @@ -0,0 +1,517 @@ +.TH DVIPS 1 "27 May 2004" +.SH NAME +dvips \- convert a TeX DVI file to PostScript +.SH SYNOPSIS +.B dvips +[ +.I 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 +prep.ai.mit.edu:pub/gnu/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, normally sending the result directly to the +(laser)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. The number is taken as a set of +independent bits. The meaning of each bit follows. 1=specials; +2=paths; 4=fonts; 8=pages; 16=headers; 32=font compression; 64=files; +128=memory; 256=Kpathsea stat(2) calls; 512=Kpathsea hash table lookups; +1024=Kpathsea path element expansion; 2048=Kpathsea searches. To trace +everything having to do with file searching and opening, use 3650 (2048 ++ 1024 + 512 + 64 + 2). To track all classes, you can use `-1' (output +is extremely voluminous). +.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 +.B -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 extensions and interpreted as requests to +set 2-byte characters. The only drawback is that the virtual font array will +(at least temporarily) require 65536 positions instead of the default 256 +positions, i.e. the memory requirements of dvips 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). +.TP +.B -o name +The output will be sent to file +.I name +If no file name is given, 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 +Run in secure mode. This means that ``backtick'' commands from a +.I \especial{} +or +.I \epsffile{} +macro in the (La)TeX source like +.I \especial{psfile="`zcat foo.ps.Z"} +or +.I \epsffile[72 72 540 720]{"`zcat screendump.ps.gz"} +are not executed. +.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 . +.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 +kb@mail.tug.org. diff --git a/Master/texmf/doc/man/man1/dvired.1 b/Master/texmf/doc/man/man1/dvired.1 new file mode 100644 index 00000000000..f76e58087a3 --- /dev/null +++ b/Master/texmf/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/doc/man/man1/dviselect.1 b/Master/texmf/doc/man/man1/dviselect.1 new file mode 100644 index 00000000000..814f102308a --- /dev/null +++ b/Master/texmf/doc/man/man1/dviselect.1 @@ -0,0 +1,129 @@ +.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/doc/man/man1/dvitodvi.1 b/Master/texmf/doc/man/man1/dvitodvi.1 new file mode 100644 index 00000000000..549b5a5e8c7 --- /dev/null +++ b/Master/texmf/doc/man/man1/dvitodvi.1 @@ -0,0 +1,137 @@ +.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/doc/man/man1/dvitomp.1 b/Master/texmf/doc/man/man1/dvitomp.1 new file mode 100644 index 00000000000..a6b74030943 --- /dev/null +++ b/Master/texmf/doc/man/man1/dvitomp.1 @@ -0,0 +1,17 @@ +.TH DVITOMP 1 "October 30, 1999" +.\" 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 +\fBdvitomp\fP [\fIoptions\fP] \fIdvifile\fP[.dvi] [\fImpxfile\fP[.mpx]] +.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 ".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 tex-k@mail.tug.org. diff --git a/Master/texmf/doc/man/man1/dvitype.1 b/Master/texmf/doc/man/man1/dvitype.1 new file mode 100644 index 00000000000..a68e4f34ec3 --- /dev/null +++ b/Master/texmf/doc/man/man1/dvitype.1 @@ -0,0 +1,74 @@ +.TH DVITYPE 1 "19 December 1994" "Web2C 7.5.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 +.\"===================================================================== +.SH NAME +dvitype \- translate a dvi file for humans +.SH SYNOPSIS +.B dvitype +.I dvi_name[.dvi] +.\"===================================================================== +.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 +.I .dvi +extension is supplied if omitted from +.IR dvi_name . +The output goes to +.IR stdout . +.\"===================================================================== +.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 BUGS +The interactive dialog should be replaced by command-line options, as +with +.BR gftype . +.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/doc/man/man1/e2pall.1 b/Master/texmf/doc/man/man1/e2pall.1 new file mode 100644 index 00000000000..b102568b53a --- /dev/null +++ b/Master/texmf/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/doc/man/man1/ebb.1 b/Master/texmf/doc/man/man1/ebb.1 new file mode 100644 index 00000000000..1a44ed97e20 --- /dev/null +++ b/Master/texmf/doc/man/man1/ebb.1 @@ -0,0 +1,34 @@ +.TH "ebb" "1" "May 2004" "teTeX" "teTeX" +.PP +.SH "NAME" +ebb \- extract a bounding box from JPEG, PNG, and PDF files +.PP +.SH "SYNOPSIS" +.PP +\fBebb\fP [ \fI -v\fP | \fI-b\fP ] \fI graphic_file\fP +.PP +.SH "DESCRIPTION" +.PP +\fBebb\fP extracts the bounding box from JPEG, PNG, and PDF files +(with lower- or uppercase extensions) and writes it into a file with +the extension \fB.bb\fP, together with some header information. These +files can then be used by \fBdvipdfm\fP or other programs. +.PP +.SH "OPTIONS" +.HP +\fB\-v\fR : be verbose +.HP +\fB\-b\fR : Write .bb file in binary mode (has no effect on Linux and +other systems conforming to POSIX). +.HP +.PP +.SH "AUTHOR" +.PP +\fBebb\fP was written by Mark A. Wicks. +.PP +This manual page was written by Frank Küster <frank@kuesterei\&.ch>, +for the Debian GNU/Linux system\&. It may be used and modified 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/doc/man/man1/eplain.1 b/Master/texmf/doc/man/man1/eplain.1 new file mode 100644 index 00000000000..ec798867b6d --- /dev/null +++ b/Master/texmf/doc/man/man1/eplain.1 @@ -0,0 +1,103 @@ +.TH EPLAIN 1 "14 December 1993" "Web2C 7.5.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 \- extended plain TeX +.SH SYNOPSIS +.B eplain +[ 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 +.B eplain +is an extension of plain \*(TX 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 . +.PP +The complete +.I eplain +distribution is available via anonymous ftp to the Internet host +.I ftp.cs.umb.edu +from the file +.I pub/tex/eplain.tar.Z +which is linked to another file containing the most recent version of +the package. Major \*(TX archive sites should also have it. +.\"===================================================================== +.SH "SEE ALSO" +.BR emacs (1), +.BR info (1), +.BR initex (1), +.BR tex (1), +.BR xinfo (1). +.br +Karl Berry, +.IR eplain , +TUGboat 11(4), 571--572, 1990. +.br +Paul W. Abrahams with Karl Berry and Kathryn A. Hargreaves, +.IR "\*(OX for the Impatient" , +Addison-Wesley, 1990, ISBN 0-201-51375-7. diff --git a/Master/texmf/doc/man/man1/epsffit.1 b/Master/texmf/doc/man/man1/epsffit.1 new file mode 100644 index 00000000000..f708df244e3 --- /dev/null +++ b/Master/texmf/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" +psbook(1), psselect(1), pstops(1), epsffit(1), psnup(1), psresize(1), psmerge(1), fixscribeps(1), getafm(1), fixdlsrps(1), fixfmps(1), fixmacps(1), fixpsditps(1), fixpspps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), extractres(1), includeres(1) +.SH TRADEMARKS +.B PostScript +is a trademark of Adobe Systems Incorporated. diff --git a/Master/texmf/doc/man/man1/epstopdf.1 b/Master/texmf/doc/man/man1/epstopdf.1 new file mode 100644 index 00000000000..451e5a3ca1e --- /dev/null +++ b/Master/texmf/doc/man/man1/epstopdf.1 @@ -0,0 +1,54 @@ +.TH EPSTOPDF 1 "October 30, 1999" +.\" man page by Jim Van Zandt <jrv@vanzandt.mv.com> -*- nroff -*- +.SH NAME +epstopdf \- 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 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. The result is piped to +Ghostscript and a PDF version written. +.P +If the bounding box is not right, of course, you have problems... +.SH OPTIONS +.IP "\fB--outfile\fP=\fIfile\fP" +write result to \fIfile\fP instead of standard output. +.IP "\fB--\fP[\fBno\fP]\fBfilter\fP" +read standard input (default: --nofilter). +.IP "\fB--\fP[\fBno\fP]\fBgs\fP" +run ghostscript (default: --gs). +.IP "\fB--\fP[\fBno\fP]\fBcompress\fP" +use compression (default: --compress). +.IP "\fB--\fP[\fBno\fP]\fBhires\fP" +scan HiresBoundingBox (default: --nohires). +.IP "\fB--\fP[\fBno\fP]\fBexact\fP" +scan ExactBoundingBox (default: --noexact). +.IP "\fB--\fP[\fBno\fP]\fBdebug\fP" +debug informations (default: --nodebug). +.IP "\fB--help\fP +print usage +.SH EXAMPLE +Examples for producing "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 only thing I have not allowed for is the case of +"%%BoundingBox: (atend)", which is more complicated. +.SH SEE ALSO +\fBgs\fP(1). +.SH AUTHOR +Sebastian Rahtz, for Elsevier Science. +Now with extra tricks from Hans Hagen's texutil. diff --git a/Master/texmf/doc/man/man1/etex.1 b/Master/texmf/doc/man/man1/etex.1 new file mode 100644 index 00000000000..16277a606cc --- /dev/null +++ b/Master/texmf/doc/man/man1/etex.1 @@ -0,0 +1,429 @@ +.TH ETEX 1 "21 August 2004" "Web2C 7.5.5" +.\"===================================================================== +.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 +etex, einitex, evirtex \- extended TeX +.SH SYNOPSIS +.B etex +.RI [ options ] +[\fB&\fR \fIformat\fR ] +[ \fIfile\fR | \fB\e\fR \fIcommands\fR ] +.\"===================================================================== +.SH DESCRIPTION +Run the e-\*(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 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.fmt ; +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 (*). Such formats are +often prefixed with an `e', hence +.B etex +as the extended version of +.B tex +and +.B elatex +as the extended version of +.BR latex . +However, +.B eplain +is an exception to this rule. +.PP +The +.B einitex +and +.B evirtex +commands are e-\*(TX's analogues to the +.B initex +and +.B virtex +commands. In this installation, they are symbolic links to the +.B etex +executable. These symbolic links may not exist at all. +.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 +.rb +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 +.rb +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 +.rb +Enable the e-\*(TX extensions. This option is only effective in +combination with +.BR -ini . +.TP +.B -file-line-error +.rb +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 +.rb +Disable printing error messages in the +.I file:line:error +style. +.TP +.B -file-line-error-style +.rb +This is the old name of the +.B -file-line-error +option. +.TP +.B -halt-on-error +.rb +Exit with an error code when an error is encountered during processing. +.TP +.B -help +.rb +Print help message and exit. +.TP +.B -ini +.rb +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 +.rb +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 +.rb +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 +.rb +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 +.rb +Use +.I name +for the job name, instead of deriving it from the name of the input file. +.TP +.BI -kpathsea-debug \ bitmask +.rb +Sets path searching debugging flags according to the bitmask. See the +.I Kpathsea +manual for details. +.TP +.BI -mktex \ fmt +.rb +Enable +.RI mktex fmt , +where +.I fmt +must be either +.I tex +or +.IR tfm . +.TP +.B -mltex +.rb +Enable ML\*(TX extensions. Only effective in combination with +.BR -ini . +.TP +.BI -no-mktex \ fmt +.rb +Disable +.RI mktex fmt , +where +.I fmt +must be either +.I tex +or +.IR tfm . +.TP +.BI -output-comment \ string +.rb +Use +.I string +for the +.I DVI +file comment instead of the date. +.TP +.BI -output-directory \ directory +.rb 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 +.rb +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 +.rb +Disable parsing of the first line of the main input file. +.TP +.BI -progname \ name +.rb +Pretend to be program +.IR name . +This affects both the format used and the search paths. +.TP +.B -recorder +.rb +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 +.rb +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 +.rb +Disable the +.BI \ewrite18{ command } +construct, even if it is enabled in the +.I texmf.cnf +file. +.TP +.B -src-specials +.rb +Insert source specials into the +.I DVI +file. +.TP +.BI -src-specials \ where +.rb +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 +.rb +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 +.rb +Like +.B -translate-file +except that a +.I %& +line can overrule this setting. +.TP +.B -version +.rb +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 +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.) +.TP +TEXINPUTS +Search path for +.I \einput +and +.I \eopenin +files. +This should 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/usr/tex:" to prepend the +current direcory and ``/home/user/tex'' to the standard search path. +.TP +TEXFORMATS +Search path for format files. +.TP +TEXPOOL +search path for +.B etex +internal strings. +.TP +TEXEDIT +Command template for switching to editor. The default, usually +.BR vi , +is set when e-\*(TX is compiled. +.TP +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. +.br +.\"===================================================================== +.SH NOTES +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 tex (1), +.BR mf (1). +.\"===================================================================== +.SH AUTHORS +e-\*(TX was developed by Peter Breitenlohner (and the NTS 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/doc/man/man1/extconv.1 b/Master/texmf/doc/man/man1/extconv.1 new file mode 100644 index 00000000000..8bc5a66cc78 --- /dev/null +++ b/Master/texmf/doc/man/man1/extconv.1 @@ -0,0 +1,94 @@ +.\" man page for bg5conv +. +.TH EXTCONV 1 11-Aug-2005 "CJK Version 4.6.0" +. +.\" ==== +.\" ==== 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/doc/man/man1/extractres.1 b/Master/texmf/doc/man/man1/extractres.1 new file mode 100644 index 00000000000..86252b6b5b0 --- /dev/null +++ b/Master/texmf/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" +psbook(1), psselect(1), pstops(1), epsffit(1), psnup(1), psresize(1), psmerge(1), fixscribeps(1), getafm(1), fixdlsrps(1), fixfmps(1), fixmacps(1), fixpsditps(1), fixpspps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), extractres(1), includeres(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/doc/man/man1/fdf2tex.1 b/Master/texmf/doc/man/man1/fdf2tex.1 new file mode 100644 index 00000000000..d306652f34a --- /dev/null +++ b/Master/texmf/doc/man/man1/fdf2tex.1 @@ -0,0 +1,31 @@ +.TH FDF2TEX "1" "May 2004" "teTeX " "ConTeXt" +.SH NAME +fdf2tex \- Convert PDF formular data (FDF) into something (Con)TeX(t) can +handle +.PP +.SH "SYNOPSIS" +\fBfdf2tex\fP \fIinfile\fP [ \fIoutfile\fP ] +.PP +\fBfdf2tan\fP \fIinfile\fP +.PP +.SH DESCRIPTION +.PP +Converts PDF formular data (FDF) into something (Con)TeX(t) can +handle. These commands are usually called indirectly during ConTeXt +file processing. +.HP +.SH "BUGS" +.PP +Probably none - all errors are in this manpage +.PP +.SH "SEE ALSO" +.PP +\fBtexexec\fP(1)\&. +.PP +The TeXExec manual, \fImtexexec\&.pdf\fP\&. +.PP +.SH "AUTHOR" +.IP +This manual page was written by Frank Küster <frank@kuesterei\&.ch>, +for the Debian GNU/Linux system\&. It may be used and modified by +others without contacting the author\&. diff --git a/Master/texmf/doc/man/man1/fixdlsrps.1 b/Master/texmf/doc/man/man1/fixdlsrps.1 new file mode 100644 index 00000000000..35f0e0593c1 --- /dev/null +++ b/Master/texmf/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" +psbook(1), psselect(1), pstops(1), epsffit(1), psnup(1), psresize(1), psmerge(1), fixscribeps(1), getafm(1), fixdlsrps(1), fixfmps(1), fixmacps(1), fixpsditps(1), fixpspps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), extractres(1), includeres(1) +.SH TRADEMARKS +.B PostScript +is a trademark of Adobe Systems Incorporated. diff --git a/Master/texmf/doc/man/man1/fixfmps.1 b/Master/texmf/doc/man/man1/fixfmps.1 new file mode 100644 index 00000000000..0f031b2d763 --- /dev/null +++ b/Master/texmf/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" +psbook(1), psselect(1), pstops(1), epsffit(1), psnup(1), psresize(1), psmerge(1), fixscribeps(1), getafm(1), fixdlsrps(1), fixfmps(1), fixmacps(1), fixpsditps(1), fixpspps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), extractres(1), includeres(1) +.SH TRADEMARKS +.B PostScript +is a trademark of Adobe Systems Incorporated. diff --git a/Master/texmf/doc/man/man1/fixmacps.1 b/Master/texmf/doc/man/man1/fixmacps.1 new file mode 100644 index 00000000000..97efc859999 --- /dev/null +++ b/Master/texmf/doc/man/man1/fixmacps.1 @@ -0,0 +1,27 @@ +.TH FIXMACPS 1 "PSUtils Release 1 Patchlevel 17" +.SH NAME +fixmacps \- filter to fix Macintosh documents with saner version of md +.SH SYNOPSIS +.B fixmacps +< +.I Macintosh.ps +> +.I Fixed.ps +.SH DESCRIPTION +.I Fixmacps +is a +.I perl +filter which "fixes" PostScript generated from a Macintosh PC +that it works correctly with Angus Duggan's +.B psutils +package. +.SH FILES +md68_0.ps, md71_0.ps - sanitised versions of the md +prologue. +.SH AUTHOR +Copyright (C) Angus J. C. Duggan 1991-1995 +.SH "SEE ALSO" +psbook(1), psselect(1), pstops(1), epsffit(1), psnup(1), psresize(1), psmerge(1), fixscribeps(1), getafm(1), fixdlsrps(1), fixfmps(1), fixmacps(1), fixpsditps(1), fixpspps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), extractres(1), includeres(1) +.SH TRADEMARKS +.B PostScript +is a trademark of Adobe Systems Incorporated. diff --git a/Master/texmf/doc/man/man1/fixpsditps.1 b/Master/texmf/doc/man/man1/fixpsditps.1 new file mode 100644 index 00000000000..3945b7ad193 --- /dev/null +++ b/Master/texmf/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" +psbook(1), psselect(1), pstops(1), epsffit(1), psnup(1), psresize(1), psmerge(1), fixscribeps(1), getafm(1), fixdlsrps(1), fixfmps(1), fixmacps(1), fixpsditps(1), fixpspps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), extractres(1), includeres(1) +.SH TRADEMARKS +.B PostScript +is a trademark of Adobe Systems Incorporated. diff --git a/Master/texmf/doc/man/man1/fixpspps.1 b/Master/texmf/doc/man/man1/fixpspps.1 new file mode 100644 index 00000000000..ead4f0bcf14 --- /dev/null +++ b/Master/texmf/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" +psbook(1), psselect(1), pstops(1), epsffit(1), psnup(1), psresize(1), psmerge(1), fixscribeps(1), getafm(1), fixdlsrps(1), fixfmps(1), fixmacps(1), fixpsditps(1), fixpspps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), extractres(1), includeres(1) +.SH TRADEMARKS +.B PostScript +is a trademark of Adobe Systems Incorporated. diff --git a/Master/texmf/doc/man/man1/fixscribeps.1 b/Master/texmf/doc/man/man1/fixscribeps.1 new file mode 100644 index 00000000000..a3fcec62ae2 --- /dev/null +++ b/Master/texmf/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" +psbook(1), psselect(1), pstops(1), epsffit(1), psnup(1), psresize(1), psmerge(1), fixscribeps(1), getafm(1), fixdlsrps(1), fixfmps(1), fixmacps(1), fixpsditps(1), fixpspps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), extractres(1), includeres(1) +.SH TRADEMARKS +.B PostScript +is a trademark of Adobe Systems Incorporated. diff --git a/Master/texmf/doc/man/man1/fixtpps.1 b/Master/texmf/doc/man/man1/fixtpps.1 new file mode 100644 index 00000000000..c65bb070fba --- /dev/null +++ b/Master/texmf/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" +psbook(1), psselect(1), pstops(1), epsffit(1), psnup(1), psresize(1), psmerge(1), fixscribeps(1), getafm(1), fixdlsrps(1), fixfmps(1), fixmacps(1), fixpsditps(1), fixpspps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), extractres(1), includeres(1) +.SH TRADEMARKS +.B PostScript +is a trademark of Adobe Systems Incorporated. diff --git a/Master/texmf/doc/man/man1/fixwfwps.1 b/Master/texmf/doc/man/man1/fixwfwps.1 new file mode 100644 index 00000000000..31e71500cf4 --- /dev/null +++ b/Master/texmf/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" +psbook(1), psselect(1), pstops(1), epsffit(1), psnup(1), psresize(1), psmerge(1), fixscribeps(1), getafm(1), fixdlsrps(1), fixfmps(1), fixmacps(1), fixpsditps(1), fixpspps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), extractres(1), includeres(1) +.SH TRADEMARKS +.B PostScript +is a trademark of Adobe Systems Incorporated. diff --git a/Master/texmf/doc/man/man1/fixwpps.1 b/Master/texmf/doc/man/man1/fixwpps.1 new file mode 100644 index 00000000000..61052fc68f7 --- /dev/null +++ b/Master/texmf/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" +psbook(1), psselect(1), pstops(1), epsffit(1), psnup(1), psresize(1), psmerge(1), fixscribeps(1), getafm(1), fixdlsrps(1), fixfmps(1), fixmacps(1), fixpsditps(1), fixpspps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), extractres(1), includeres(1) +.SH TRADEMARKS +.B PostScript +is a trademark of Adobe Systems Incorporated. diff --git a/Master/texmf/doc/man/man1/fixwwps.1 b/Master/texmf/doc/man/man1/fixwwps.1 new file mode 100644 index 00000000000..ed58e11f94b --- /dev/null +++ b/Master/texmf/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" +psbook(1), psselect(1), pstops(1), epsffit(1), psnup(1), psresize(1), psmerge(1), fixscribeps(1), getafm(1), fixdlsrps(1), fixfmps(1), fixmacps(1), fixpsditps(1), fixpspps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), extractres(1), includeres(1) +.SH TRADEMARKS +.B PostScript +is a trademark of Adobe Systems Incorporated. diff --git a/Master/texmf/doc/man/man1/fmtutil-sys.1 b/Master/texmf/doc/man/man1/fmtutil-sys.1 new file mode 120000 index 00000000000..240dee18655 --- /dev/null +++ b/Master/texmf/doc/man/man1/fmtutil-sys.1 @@ -0,0 +1 @@ +fmtutil.1
\ No newline at end of file diff --git a/Master/texmf/doc/man/man1/fmtutil.1 b/Master/texmf/doc/man/man1/fmtutil.1 new file mode 100644 index 00000000000..dfb96086a74 --- /dev/null +++ b/Master/texmf/doc/man/man1/fmtutil.1 @@ -0,0 +1,80 @@ +.TH "fmtutil" "8" "February 2005" "teTeX" "teTeX" +.PP +.SH "NAME" +fmtutil \- utility for maintaining TeX format files +.PP +fmtutil-sys \- utility for maintaining TeX format files system\-wide +.PP +.SH "SYNOPSIS" +.PP +\fBfmtutil\fP [ \fIOPTION\fP\&.\&.\&. ] \fICOMMAND\fP +.PP +\fBfmtutil-sys\fP [ \fIOPTION\fP\&.\&.\&. ] \fICOMMAND\fP +.PP +.SH "DESCRIPTION" +.PP +\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 +.IP "\fB--all\fP" +recreate all format files +.IP "\fB--byfmt\fP \fIformatname\fP" +(re)create the format for +format \fIformatname\fP +.IP "\fB--byhyphen\fP \fIhyphenfile\fP" +(re)create formats that +depend on the hyphenation file +\fIhyphenfile\fP +.IP "\fB--help\fP" +print a summary of commands and options +.IP "\fB--missing\fP" +create any missing format files +.IP "\fB--showhyphen\fP \fIformatname\fP" +print the name of the +hyphenation file for the format +\fIformatname\fP +.PP +.SH "OPTIONS" +.PP +.IP "\fB--cnffile\fP \fIfile\fP" +specify the configuration +\fIfile\fP \fBfmtutil\fP should use +.IP "\fB--dolinks\fP" +(not implemented, just for compatibility) +.IP "\fB--fmtdir\fP \fIdirectory\fP" +set the destination +directory for format files generated by +\fBfmtutil\fP to \fIdirectory\fP +.IP "\fB--force\fP" +(not implemented, just for compatibility) +.IP "\fB--quiet\fP" +(not implemented, just for compatibility) +.IP "\fB--test\fP" +(not implemented, just for compatibility) +.PP +.SH "FILES" +.PP +.IP "\fIfmtutil\&.cnf\fP" +default configuration file +.PP +.SH "SEE ALSO" +.PP +\fBkpsewhich\fP(1) +.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 +\fBfmtutil\fP was written by Thomas Esser +<te@dbs\&.uni-hannover\&.de> and is Copyright 1998 Thomas +Esser\&. +.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/doc/man/man1/fontinst.1 b/Master/texmf/doc/man/man1/fontinst.1 new file mode 100644 index 00000000000..b907280d90d --- /dev/null +++ b/Master/texmf/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/doc/man/man1/getafm.1 b/Master/texmf/doc/man/man1/getafm.1 new file mode 100644 index 00000000000..33da5ca88ed --- /dev/null +++ b/Master/texmf/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" +psbook(1), psselect(1), pstops(1), epsffit(1), psnup(1), psresize(1), psmerge(1), fixscribeps(1), getafm(1), fixdlsrps(1), fixfmps(1), fixmacps(1), fixpsditps(1), fixpspps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), extractres(1), includeres(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/doc/man/man1/getnonfreefonts.1 b/Master/texmf/doc/man/man1/getnonfreefonts.1 new file mode 100644 index 00000000000..c7506d616d1 --- /dev/null +++ b/Master/texmf/doc/man/man1/getnonfreefonts.1 @@ -0,0 +1,182 @@ +.TH getnonfreefonts 1 "October 2005" "TeXLive" "TeXLive" +.SH NAME +getnonfreefonts \- download and install fonts which cannot be +distributed on a CD +.LP +getnonfreefonts-sys \- download and install fonts system\-wide which +cannot be distributed on a CD +.SH SYNOPSIS +.B getnonfreefonts +.RI +[options] [font] +.LP +.B getnonfreefonts-sys +.RI +[options] [font] +.SH DESCRIPTION +Some font suppliers provided fonts which can be used freely but they +disallow that money is charged for the distribution. Hence, for +distributions on CD or DVD it is usually impossible to include +these fonts. + +.BI getnonfreefonts +is a script which downloads and installs these fonts. Actually, it +first downloads the program +.BI getfont +from CTAN which is then executed. +.BI getfont +does the real work. It will be updated occasionally to support more +fonts. + +.BI getnonfreefonts +and +.BI getnonfreefonts-sys +are identical except that +.BI getnonfreefonts +installs files to +.RI $TEXMFHOME +while +.BI getnonfreefonts-sys +installs files to +.RI $TEXMFLOCAL +\. + +.BI getfont +will not be installed permanently on your system. It only +exists while +.BI getnonfreefonts +is running. +.BI getnonfreefonts +passes all arguments to +.BI getfont. + +If a font is specified, only this font will be installed, otherwise +all supported fonts will be installed. + +To get a list of supported fonts, run +.BI getnonfreefonts +.BI --lsfonts + +.SH OPTIONS +Only the options evaluated by +.BI getnonfreefonts +are described here. Run +.BI getnonfreefonts +.BI --help +to get a complete list. + +.TP +.B --ctan=<CTAN-node> +.rg +.B <CTAN-node> +can be either +.B +de +for ftp://ftp.dante.de (Hamburg, Germany), +.B +uk +for ftp://tex.ac.uk (Cambridge, UK), +or +.B us +for ftp://ctan.tug.org (Colchester, VT, US) + +The default is ftp://tex.ac.uk. + +.TP +.B --afm +.rg +Install AFM files as well. They are not installed by default. You do +not need them if you don't know what they are good for. + +.TP +.B -n, --noinstall +.rg +Do not install anything. Useful to check whether fonts are available +which are not installed yet. + + +.TP +.B --shell +.rg +Run +.BI getnonfreefonts +in a shell. +.BI getfont +can be called directly and will exist on your system until you leave +the shell. If your internet connection is very slow, you can save some time. +Run +.BI getfont --help +first. + + +.TP +.B -h, --help +.rg +Get a complete list of options. This list will be more complete and +more up-to-date than this manual page. + +.SH ENVIRONMENT +If the environt variable +.BI CTAN +is set to +.B ftp://<CTAN-node> +then this will be the default. The argument is an URL. + +.BI Example: +If your +.BI ~/.profile +contains the line +.BI CTAN=ftp://ftp.dante.de +then this will be the default. +If you are at a university which mirrors CTAN, you can set +.BI CTAN +to this mirror. It will work only if the mirror has the same +directory structure as CTAN, i.e if the directory +.BI tex-archive +is not omitted. + +.SH EXAMPLES +.TP +.B getnonfreefonts --help +.rg +Display all options and a list of supported fonts. Note that the +program +.B getfont +is installed temporarily and executed. You get more information than +this manual page can provide. + +.TP +.B getnonfreefonts +.rg +Install all supported fonts which are not installed yet. + +.TP +.B getnonfreefonts utopia +.rg +Install Adobe Utopia if it is not installed yet. + +.TP +.B getnonfreefonts --force --afm utopia +.rg +Install Adobe Utopia and the corresponding AFM files even if Utopia is +already installed. + +.TP +.B getnonfreefonts --noinstall +.rg +No fonts will be installed. Instead you are told which fonts are +available and which of them are already installed. + +.TP +.B getnonfreefonts --shell +.rg +No fonts are installed. You'll get an interactive shell where you can +invoke +.BI getfont +manually. Run +.B getfont --help +first. + + +.SH BUGS +Please send bug reports to Reinhard Kotucha <reinhard.kotucha@web.de>. diff --git a/Master/texmf/doc/man/man1/gftodvi.1 b/Master/texmf/doc/man/man1/gftodvi.1 new file mode 100644 index 00000000000..ae7f4c0e3b5 --- /dev/null +++ b/Master/texmf/doc/man/man1/gftodvi.1 @@ -0,0 +1,167 @@ +.TH GFTODVI 1 "14 December 1993" "Web2C 7.5.5" +.\"===================================================================== +.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 +[ +.BI \-overflow-label-offset =real +] +[ +.B \-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. (The program prompts +you for it if you don't give it.) 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 defaults to the same +root as the +.I gf +file, with the +.I 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/doc/man/man1/gftopk.1 b/Master/texmf/doc/man/man1/gftopk.1 new file mode 100644 index 00000000000..38b2d1084d1 --- /dev/null +++ b/Master/texmf/doc/man/man1/gftopk.1 @@ -0,0 +1,103 @@ +.TH GFTOPK 1 "14 December 1993" "Web2C 7.5.5" +.\"===================================================================== +.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 +[ +.B \-v +] +.I gf_file_name +[ +.I 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 +.I pk +suffix replacing +.IR 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/doc/man/man1/gftype.1 b/Master/texmf/doc/man/man1/gftype.1 new file mode 100644 index 00000000000..41a203badd1 --- /dev/null +++ b/Master/texmf/doc/man/man1/gftype.1 @@ -0,0 +1,97 @@ +.TH GFTYPE 1 "14 December 1993" "Web2C 7.5.5" +.\"===================================================================== +.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 +[ +.B \-i +] +[ +.B \-m +] +.I gf_file_name +[ +.I 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/doc/man/man1/gsftopk.1 b/Master/texmf/doc/man/man1/gsftopk.1 new file mode 100644 index 00000000000..cbbafa8e609 --- /dev/null +++ b/Master/texmf/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/doc/man/man1/gzip.1 b/Master/texmf/doc/man/man1/gzip.1 new file mode 100644 index 00000000000..6fa79862bfc --- /dev/null +++ b/Master/texmf/doc/man/man1/gzip.1 @@ -0,0 +1,478 @@ +.PU +.TH GZIP 1 local +.SH NAME +gzip, gunzip, zcat \- compress or expand files +.SH SYNOPSIS +.ll +8 +.B gzip +.RB [ " \-acdfhlLnNrtvV19 " ] +.RB [ \-S\ suffix ] +[ +.I "name \&..." +] +.ll -8 +.br +.B gunzip +.RB [ " \-acfhlLnNrtvV " ] +.RB [ \-S\ suffix ] +[ +.I "name \&..." +] +.br +.B zcat +.RB [ " \-fhLV " ] +[ +.I "name \&..." +] +.SH DESCRIPTION +.I Gzip +reduces the size of the named files using Lempel-Ziv coding (LZ77). +Whenever possible, +each file is replaced by one with the extension +.B "\&.gz," +while keeping the same ownership modes, access and modification times. +(The default extension is +.B "\-gz" +for VMS, +.B "z" +for MSDOS, OS/2 FAT, Windows NT FAT and Atari.) +If no files are specified, or if a file name is "-", the standard input is +compressed to the standard output. +.I Gzip +will only attempt to compress regular files. +In particular, it will ignore symbolic links. +.PP +If the compressed file name is too long for its file system, +.I gzip +truncates it. +.I Gzip +attempts to truncate only the parts of the file name longer than 3 characters. +(A part is delimited by dots.) If the name consists of small parts only, +the longest parts are truncated. For example, if file names are limited +to 14 characters, gzip.msdos.exe is compressed to gzi.msd.exe.gz. +Names are not truncated on systems which do not have a limit on file name +length. +.PP +By default, +.I gzip +keeps the original file name and timestamp in the compressed file. These +are used when decompressing the file with the +.B \-N +option. This is useful when the compressed file name was truncated or +when the time stamp was not preserved after a file transfer. +.PP +Compressed files can be restored to their original form using +.I gzip -d +or +.I gunzip +or +.I zcat. +If the original name saved in the compressed file is not suitable for its +file system, a new name is constructed from the original one to make it +legal. +.PP +.I gunzip +takes a list of files on its command line and replaces each +file whose name ends with .gz, -gz, .z, -z, _z or .Z +and which begins with the correct magic number with an uncompressed +file without the original extension. +.I gunzip +also recognizes the special extensions +.B "\&.tgz" +and +.B "\&.taz" +as shorthands for +.B "\&.tar.gz" +and +.B "\&.tar.Z" +respectively. +When compressing, +.I gzip +uses the +.B "\&.tgz" +extension if necessary instead of truncating a file with a +.B "\&.tar" +extension. +.PP +.I gunzip +can currently decompress files created by +.I gzip, zip, compress, compress -H +or +.I pack. +The detection of the input format is automatic. When using +the first two formats, +.I gunzip +checks a 32 bit CRC. For +.I pack, gunzip +checks the uncompressed length. The standard +.I compress +format was not designed to allow consistency checks. However +.I gunzip +is sometimes able to detect a bad .Z file. If you get an error +when uncompressing a .Z file, do not assume that the .Z file is +correct simply because the standard +.I uncompress +does not complain. This generally means that the standard +.I uncompress +does not check its input, and happily generates garbage output. +The SCO compress -H format (lzh compression method) does not include a CRC +but also allows some consistency checks. +.PP +Files created by +.I zip +can be uncompressed by gzip only if they have a single member compressed +with the 'deflation' method. This feature is only intended to help +conversion of tar.zip files to the tar.gz format. To extract zip files +with several members, use +.I unzip +instead of +.I gunzip. +.PP +.I zcat +is identical to +.I gunzip +.B \-c. +(On some systems, +.I zcat +may be installed as +.I gzcat +to preserve the original link to +.I compress.) +.I zcat +uncompresses either a list of files on the command line or its +standard input and writes the uncompressed data on standard output. +.I zcat +will uncompress files that have the correct magic number whether +they have a +.B "\&.gz" +suffix or not. +.PP +.I Gzip +uses the Lempel-Ziv algorithm used in +.I zip +and PKZIP. +The amount of compression obtained depends on the size of the +input and the distribution of common substrings. +Typically, text such as source code or English +is reduced by 60\-70%. +Compression is generally much better than that achieved by +LZW (as used in +.IR compress ), +Huffman coding (as used in +.IR pack ), +or adaptive Huffman coding +.RI ( compact ). +.PP +Compression is always performed, even if the compressed file is +slightly larger than the original. The worst case expansion is +a few bytes for the gzip file header, plus 5 bytes every 32K block, +or an expansion ratio of 0.015% for large files. Note that the actual +number of used disk blocks almost never increases. +.I gzip +preserves the mode, ownership and timestamps of files when compressing +or decompressing. + +.SH OPTIONS +.TP +.B \-a --ascii +Ascii text mode: convert end-of-lines using local conventions. This option +is supported only on some non-Unix systems. For MSDOS, CR LF is converted +to LF when compressing, and LF is converted to CR LF when decompressing. +.TP +.B \-c --stdout --to-stdout +Write output on standard output; keep original files unchanged. +If there are several input files, the output consists of a sequence of +independently compressed members. To obtain better compression, +concatenate all input files before compressing them. +.TP +.B \-d --decompress --uncompress +Decompress. +.TP +.B \-f --force +Force compression or decompression even if the file has multiple links +or the corresponding file already exists, or if the compressed data +is read from or written to a terminal. If the input data is not in +a format recognized by +.I gzip, +and if the option --stdout is also given, copy the input data without change +to the standard ouput: let +.I zcat +behave as +.I cat. +If +.B \-f +is not given, +and when not running in the background, +.I gzip +prompts to verify whether an existing file should be overwritten. +.TP +.B \-h --help +Display a help screen and quit. +.TP +.B \-l --list +For each compressed file, list the following fields: + + compressed size: size of the compressed file + uncompressed size: size of the uncompressed file + ratio: compression ratio (0.0% if unknown) + uncompressed_name: name of the uncompressed file + +The uncompressed size is given as -1 for files not in gzip format, +such as compressed .Z files. To get the uncompressed size for such a file, +you can use: + + zcat file.Z | wc -c + +In combination with the --verbose option, the following fields are also +displayed: + + method: compression method + crc: the 32-bit CRC of the uncompressed data + date & time: time stamp for the uncompressed file + +The compression methods currently supported are deflate, compress, lzh +(SCO compress -H) and pack. The crc is given as ffffffff for a file +not in gzip format. + +With --name, the uncompressed name, date and time are +those stored within the compress file if present. + +With --verbose, the size totals and compression ratio for all files +is also displayed, unless some sizes are unknown. With --quiet, +the title and totals lines are not displayed. +.TP +.B \-L --license +Display the +.I gzip +license and quit. +.TP +.B \-n --no-name +When compressing, do not save the original file name and time stamp by +default. (The original name is always saved if the name had to be +truncated.) When decompressing, do not restore the original file name +if present (remove only the +.I gzip +suffix from the compressed file name) and do not restore the original +time stamp if present (copy it from the compressed file). This option +is the default when decompressing. +.TP +.B \-N --name +When compressing, always save the original file name and time stamp; this +is the default. When decompressing, restore the original file name and +time stamp if present. This option is useful on systems which have +a limit on file name length or when the time stamp has been lost after +a file transfer. +.TP +.B \-q --quiet +Suppress all warnings. +.TP +.B \-r --recursive +Travel the directory structure recursively. If any of the file names +specified on the command line are directories, +.I gzip +will descend into the directory and compress all the files it finds there +(or decompress them in the case of +.I gunzip +). +.TP +.B \-S .suf --suffix .suf +Use suffix .suf instead of .gz. Any suffix can be given, but suffixes +other than .z and .gz should be avoided to avoid confusion when files +are transferred to other systems. A null suffix forces gunzip to try +decompression on all given files regardless of suffix, as in: + + gunzip -S "" * (*.* for MSDOS) + +Previous versions of gzip used +the .z suffix. This was changed to avoid a conflict with +.IR pack "(1)". +.TP +.B \-t --test +Test. Check the compressed file integrity. +.TP +.B \-v --verbose +Verbose. Display the name and percentage reduction for each file compressed +or decompressed. +.TP +.B \-V --version +Version. Display the version number and compilation options then quit. +.TP +.B \-# --fast --best +Regulate the speed of compression using the specified digit +.IR # , +where +.B \-1 +or +.B \-\-fast +indicates the fastest compression method (less compression) +and +.B \-9 +or +.B \-\-best +indicates the slowest compression method (best compression). +The default compression level is +.BR \-6 +(that is, biased towards high compression at expense of speed). +.SH "ADVANCED USAGE" +Multiple compressed files can be concatenated. In this case, +.I gunzip +will extract all members at once. For example: + + gzip -c file1 > foo.gz + gzip -c file2 >> foo.gz + +Then + gunzip -c foo + +is equivalent to + + cat file1 file2 + +In case of damage to one member of a .gz file, other members can +still be recovered (if the damaged member is removed). However, +you can get better compression by compressing all members at once: + + cat file1 file2 | gzip > foo.gz + +compresses better than + + gzip -c file1 file2 > foo.gz + +If you want to recompress concatenated files to get better compression, do: + + gzip -cd old.gz | gzip > new.gz + +If a compressed file consists of several members, the uncompressed +size and CRC reported by the --list option applies to the last member +only. If you need the uncompressed size for all members, you can use: + + gzip -cd file.gz | wc -c + +If you wish to create a single archive file with multiple members so +that members can later be extracted independently, use an archiver +such as tar or zip. GNU tar supports the -z option to invoke gzip +transparently. gzip is designed as a complement to tar, not as a +replacement. +.SH "ENVIRONMENT" +The environment variable +.B GZIP +can hold a set of default options for +.I gzip. +These options are interpreted first and can be overwritten by +explicit command line parameters. For example: + for sh: GZIP="-8v --name"; export GZIP + for csh: setenv GZIP "-8v --name" + for MSDOS: set GZIP=-8v --name + +On Vax/VMS, the name of the environment variable is GZIP_OPT, to +avoid a conflict with the symbol set for invocation of the program. +.SH "SEE ALSO" +znew(1), zcmp(1), zmore(1), zforce(1), gzexe(1), zip(1), unzip(1), compress(1), +pack(1), compact(1) +.SH "DIAGNOSTICS" +Exit status is normally 0; +if an error occurs, exit status is 1. If a warning occurs, exit status is 2. +.PP +Usage: gzip [-cdfhlLnNrtvV19] [-S suffix] [file ...] +.in +8 +Invalid options were specified on the command line. +.in -8 +.IR file : +not in gzip format +.in +8 +The file specified to +.I gunzip +has not been compressed. +.in -8 +.IR file: +Corrupt input. Use zcat to recover some data. +.in +8 +The compressed file has been damaged. The data up to the point of failure +can be recovered using +.in +8 +zcat file > recover +.in -16 +.IR file : +compressed with +.I xx +bits, can only handle +.I yy +bits +.in +8 +.I File +was compressed (using LZW) by a program that could deal with +more +.I bits +than the decompress code on this machine. +Recompress the file with gzip, which compresses better and uses +less memory. +.in -8 +.IR file : +already has .gz suffix -- no change +.in +8 +The file is assumed to be already compressed. +Rename the file and try again. +.in -8 +.I file +already exists; do you wish to overwrite (y or n)? +.in +8 +Respond "y" if you want the output file to be replaced; "n" if not. +.in -8 +gunzip: corrupt input +.in +8 +A SIGSEGV violation was detected which usually means that the input file has +been corrupted. +.in -8 +.I "xx.x%" +.in +8 +Percentage of the input saved by compression. +(Relevant only for +.BR \-v +and +.BR \-l \.) +.in -8 +-- not a regular file or directory: ignored +.in +8 +When the input file is not a regular file or directory, +(e.g. a symbolic link, socket, FIFO, device file), it is +left unaltered. +.in -8 +-- has +.I xx +other links: unchanged +.in +8 +The input file has links; it is left unchanged. See +.IR ln "(1)" +for more information. Use the +.B \-f +flag to force compression of multiply-linked files. +.in -8 +.SH CAVEATS +When writing compressed data to a tape, it is generally necessary to +pad the output with zeroes up to a block boundary. When the data is +read and the whole block is passed to +.I gunzip +for decompression, +.I gunzip +detects that there is extra trailing garbage after the compressed data +and emits a warning by default. You have to use the --quiet option to +suppress the warning. This option can be set in the +.B GZIP +environment variable as in: + for sh: GZIP="-q" tar -xfz --block-compress /dev/rst0 + for csh: (setenv GZIP -q; tar -xfz --block-compr /dev/rst0 + +In the above example, gzip is invoked implicitly by the -z option of +GNU tar. Make sure that the same block size (-b option of tar) is used +for reading and writing compressed data on tapes. (This example +assumes you are using the GNU version of tar.) +.SH BUGS +The --list option reports incorrect sizes if they exceed 2 gigabytes. +The --list option reports sizes as -1 and crc as ffffffff if the +compressed file is on a non seekable media. + +In some rare cases, the --best option gives worse compression than +the default compression level (-6). On some highly redundant files, +.I compress +compresses better than +.I gzip. diff --git a/Master/texmf/doc/man/man1/hbf2gf.1 b/Master/texmf/doc/man/man1/hbf2gf.1 new file mode 100644 index 00000000000..f36ae3c7cea --- /dev/null +++ b/Master/texmf/doc/man/man1/hbf2gf.1 @@ -0,0 +1,736 @@ +.\" man page for hbf2gf +. +.TH HBF2GF 1 11-Aug-2005 "CJK Version 4.6.0" +.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 `yes' 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 +`\c +.C \&.cfg '). +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 `\c +.C \&.gf ', +otherwise `\c +.C \&. <\c +.IR resolution >\c +.C gf '. +.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 `yes' and `no' 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 `\c +.C $ ', +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 `\c +.C $$ '. +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 `pk_directory' and `tfm_directory' +.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 `\c +.C 01 ' +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 `yes', 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 `no'. +.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 `yes', 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 `no'. +.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 `yes'. +.TP +.B tfm_files +Whether to create +.C TFM +files or not; default is `yes'. +.TP +.B ofm_file +Whether to create an +.C OPL +file or not; default is `no'. +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 `yes', +.C PK +files will include the resolution in the extension (e.g. +.C gsso1201.300pk ). +This affects the batch file only (default is `yes'). +.TP +.B rm_command +The shell command to remove files; default: `rm'. +.TP +.B cp_command +The shell command to copy files; default: `cp'. +.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 +Please note that older versions of +.B kpathsea +(<3.2) have no special means to seach for program related files. +Additionally, versions older than 3.3 have no default path for miscellaneous +fonts, thus we use the paths for PostScript related stuff if necessary for +fonts resp. configuration files. +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 +Version\ 3.3 and newer (this won't change again in the future!): +.PP +.in +4m +.ta 2i +.br +.C "\&.hbf MISCFONTS" +.br +.C "\&.cfg HBF2GFINPUTS" +.PP +Version\ 3.2: +.PP +.in +4m +.ta 2i +.br +.C "\&.hbf T1FONTS" +.br +.C "\&.cfg HBF2GFINPUTS" +.PP +And here the same for pre-3.2-versions of +.B kpathsea: +.PP +.in +4m +.ta 2i +.br +.C "\&.hbf T1FONTS" +.br +.C "\&.cfg TEXCONFIG" +.PP +Finally, the same for versions\ \(<=2.6: +.PP +.in +4m +.ta 2i +.br +.C "\&.hbf DVIPSHEADERS" +.br +.C "\&.cfg TEXCONFIG" +.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 -- 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 `\c +.C "kpsewhich --help" ' +on the command line prompt.] +This is exactly the 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 `\c +.C c:\\\\fonts!!\\\\hbf ' +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.dvi +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/doc/man/man1/includeres.1 b/Master/texmf/doc/man/man1/includeres.1 new file mode 100644 index 00000000000..eb1eb04f27a --- /dev/null +++ b/Master/texmf/doc/man/man1/includeres.1 @@ -0,0 +1,41 @@ +.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 FILES +.SH AUTHOR +Copyright (C) Angus J. C. Duggan 1991-1995 +.SH "SEE ALSO" +psbook(1), psselect(1), pstops(1), epsffit(1), psnup(1), psresize(1), psmerge(1), fixscribeps(1), getafm(1), fixdlsrps(1), fixfmps(1), fixmacps(1), fixpsditps(1), fixpspps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), extractres(1), includeres(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/doc/man/man1/info.1 b/Master/texmf/doc/man/man1/info.1 new file mode 100644 index 00000000000..39ca1d32ac3 --- /dev/null +++ b/Master/texmf/doc/man/man1/info.1 @@ -0,0 +1,89 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.34. +.TH INFO "1" "December 2004" "info 4.8" "User Commands" +.SH NAME +info \- read Info documents +.SH SYNOPSIS +.B info +[\fIOPTION\fR]... [\fIMENU-ITEM\fR...] +.SH DESCRIPTION +Read documentation in Info format. +.SH OPTIONS +.TP +\fB\-\-apropos\fR=\fISTRING\fR +look up STRING in all indices of all manuals. +.TP +\fB\-d\fR, \fB\-\-directory\fR=\fIDIR\fR +add DIR to INFOPATH. +.TP +\fB\-\-dribble\fR=\fIFILENAME\fR +remember user keystrokes in FILENAME. +.TP +\fB\-f\fR, \fB\-\-file\fR=\fIFILENAME\fR +specify Info file to visit. +.TP +\fB\-h\fR, \fB\-\-help\fR +display this help and exit. +.TP +\fB\-\-index\-search\fR=\fISTRING\fR +go to node pointed by index entry STRING. +.TP +\fB\-n\fR, \fB\-\-node\fR=\fINODENAME\fR +specify nodes in first visited Info file. +.TP +\fB\-o\fR, \fB\-\-output\fR=\fIFILENAME\fR +output selected nodes to FILENAME. +.TP +\fB\-R\fR, \fB\-\-raw\-escapes\fR +output "raw" ANSI escapes (default). +.TP +\fB\-\-no\-raw\-escapes\fR +output escapes as literal text. +.TP +\fB\-\-restore\fR=\fIFILENAME\fR +read initial keystrokes from FILENAME. +.TP +\fB\-O\fR, \fB\-\-show\-options\fR, \fB\-\-usage\fR +go to command\-line options node. +.TP +\fB\-\-subnodes\fR +recursively output menu items. +.TP +\fB\-w\fR, \fB\-\-where\fR, \fB\-\-location\fR +print physical location of Info file. +.TP +\fB\-\-vi\-keys\fR +use vi\-like and less\-like key bindings. +.TP +\fB\-\-version\fR +display version information and exit. +.PP +The first non\-option argument, if present, is the menu entry to start from; +it is searched for in all `dir' files along INFOPATH. +If it is not present, info merges all `dir' files and shows the result. +Any remaining arguments are treated as the names of menu +items relative to the initial node visited. +.SH EXAMPLES +.TP +info +show top\-level dir menu +.TP +info emacs +start at emacs node from top\-level dir +.TP +info emacs buffers +start at buffers node within emacs manual +.TP +info \fB\-\-show\-options\fR emacs +start at node with emacs' command line options +.TP +info \fB\-f\fR ./foo.info +show file ./foo.info, not searching dir +.SH "REPORTING BUGS" +Email bug reports to bug\-texinfo@gnu.org, +general questions and discussion to help\-texinfo@gnu.org. +Texinfo home page: http://www.gnu.org/software/texinfo/ +.SH COPYRIGHT +Copyright \(co 2004 Free Software Foundation, Inc. +There is NO warranty. You may redistribute this software +under the terms of the GNU General Public License. +For more information about these matters, see the files named COPYING. diff --git a/Master/texmf/doc/man/man1/infokey.1 b/Master/texmf/doc/man/man1/infokey.1 new file mode 100644 index 00000000000..fb8f4634f40 --- /dev/null +++ b/Master/texmf/doc/man/man1/infokey.1 @@ -0,0 +1,41 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.34. +.TH INFOKEY "1" "December 2004" "infokey 4.8" "User Commands" +.SH NAME +infokey \- compile customizations for Info +.SH SYNOPSIS +.B infokey +[\fIOPTION\fR]... [\fIINPUT-FILE\fR] +.SH DESCRIPTION +Compile infokey source file to infokey file. Reads INPUT\-FILE (default +$HOME/.infokey) and writes compiled key file to (by default) $HOME/.info. +.SH OPTIONS +.TP +\fB\-\-output\fR FILE +output to FILE instead of $HOME/.info +.TP +\fB\-\-help\fR +display this help and exit. +.TP +\fB\-\-version\fR +display version information and exit. +.SH "REPORTING BUGS" +Email bug reports to bug\-texinfo@gnu.org, +general questions and discussion to help\-texinfo@gnu.org. +Texinfo home page: http://www.gnu.org/software/texinfo/ +.SH COPYRIGHT +Copyright \(co 2003 Free Software Foundation, Inc. +There is NO warranty. You may redistribute this software +under the terms of the GNU General Public License. +For more information about these matters, see the files named COPYING. +.SH "SEE ALSO" +The full documentation for +.B infokey +is maintained as a Texinfo manual. If the +.B info +and +.B infokey +programs are properly installed at your site, the command +.IP +.B info infokey +.PP +should give you access to the complete manual. diff --git a/Master/texmf/doc/man/man1/install-info.1 b/Master/texmf/doc/man/man1/install-info.1 new file mode 100644 index 00000000000..004d5d0f97d --- /dev/null +++ b/Master/texmf/doc/man/man1/install-info.1 @@ -0,0 +1,78 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.34. +.TH INSTALL-INFO "1" "December 2004" "install-info 4.8" "User Commands" +.SH NAME +install-info \- update info/dir entries +.SH SYNOPSIS +.B install-info +[\fIOPTION\fR]... [\fIINFO-FILE \fR[\fIDIR-FILE\fR]] +.SH DESCRIPTION +Install or delete dir entries from INFO\-FILE in the Info directory file +DIR\-FILE. +.SH OPTIONS +.TP +\fB\-\-delete\fR +delete existing entries for INFO\-FILE from DIR\-FILE; +don't insert any new entries. +.TP +\fB\-\-dir\-file\fR=\fINAME\fR +specify file name of Info directory file. +This is equivalent to using the DIR\-FILE argument. +.TP +\fB\-\-entry\fR=\fITEXT\fR +insert TEXT as an Info directory entry. +TEXT should have the form of an Info menu item line +plus zero or more extra lines starting with whitespace. +If you specify more than one entry, they are all added. +If you don't specify any entries, they are determined +from information in the Info file itself. +.TP +\fB\-\-help\fR +display this help and exit. +.TP +\fB\-\-info\-file\fR=\fIFILE\fR +specify Info file to install in the directory. +This is equivalent to using the INFO\-FILE argument. +.TP +\fB\-\-info\-dir\fR=\fIDIR\fR +same as \fB\-\-dir\-file\fR=\fIDIR\fR/dir. +.TP +\fB\-\-item\fR=\fITEXT\fR +same as \fB\-\-entry\fR TEXT. +An Info directory entry is actually a menu item. +.TP +\fB\-\-quiet\fR +suppress warnings. +.TP +\fB\-\-remove\fR +same as \fB\-\-delete\fR. +.TP +\fB\-\-section\fR=\fISEC\fR +put this file's entries in section SEC of the directory. +If you specify more than one section, all the entries +are added in each of the sections. +If you don't specify any sections, they are determined +from information in the Info file itself. +.TP +\fB\-\-version\fR +display version information and exit. +.SH "REPORTING BUGS" +Email bug reports to bug\-texinfo@gnu.org, +general questions and discussion to help\-texinfo@gnu.org. +Texinfo home page: http://www.gnu.org/software/texinfo/ +.SH COPYRIGHT +Copyright \(co 2004 Free Software Foundation, Inc. +There is NO warranty. You may redistribute this software +under the terms of the GNU General Public License. +For more information about these matters, see the files named COPYING. +.SH "SEE ALSO" +The full documentation for +.B install-info +is maintained as a Texinfo manual. If the +.B info +and +.B install-info +programs are properly installed at your site, the command +.IP +.B info install-info +.PP +should give you access to the complete manual. diff --git a/Master/texmf/doc/man/man1/kpseaccess.1 b/Master/texmf/doc/man/man1/kpseaccess.1 new file mode 100644 index 00000000000..3ef9af6b2aa --- /dev/null +++ b/Master/texmf/doc/man/man1/kpseaccess.1 @@ -0,0 +1,63 @@ +.TH KPSEACCESS 1 "4 January 1998" "Kpathsea 3.5.5" +.\"===================================================================== +.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 [-rwx] +.I file +.\"===================================================================== +.SH DESCRIPTION +Exit successfully if +.I file +can be accessed with the specified mode. +The mode is one or more letters of +.IR rwx , +where +.I r +is for readable, +.I w +is for writable, and +.I 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 additional options: +.TP +.B --help +.rb +Print help message and exit. +.TP +.B --version +.rb +Print version information and exit. +.\"===================================================================== +.SH "SEE ALSO" +.BR access (2) diff --git a/Master/texmf/doc/man/man1/kpsepath.1 b/Master/texmf/doc/man/man1/kpsepath.1 new file mode 120000 index 00000000000..007e1178459 --- /dev/null +++ b/Master/texmf/doc/man/man1/kpsepath.1 @@ -0,0 +1 @@ +kpsetool.1
\ No newline at end of file diff --git a/Master/texmf/doc/man/man1/kpsereadlink.1 b/Master/texmf/doc/man/man1/kpsereadlink.1 new file mode 100644 index 00000000000..3a2e65ea0dc --- /dev/null +++ b/Master/texmf/doc/man/man1/kpsereadlink.1 @@ -0,0 +1,32 @@ +.TH KPSEREADLINK 1 "4 January 1998" "Kpathsea 3.5.5" +.\"===================================================================== +.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 additional options: +.TP +.B --help +.rb +Print help message and exit. +.TP +.B --version +.rb +Print version information and exit. +.\"===================================================================== +.SH "SEE ALSO" +.BR readlink (2) diff --git a/Master/texmf/doc/man/man1/kpsestat.1 b/Master/texmf/doc/man/man1/kpsestat.1 new file mode 100644 index 00000000000..5d4c7a2a54c --- /dev/null +++ b/Master/texmf/doc/man/man1/kpsestat.1 @@ -0,0 +1,53 @@ +.TH KPSESTAT 1 "4 January 1998" "Kpathsea 3.5.5" +.\"===================================================================== +.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 +.I = +as the mode to obtain the unchanged permissions. +.\"===================================================================== +.SH OPTIONS +.B kpsestat +accepts the following additional options: +.TP +.B --help +.rb +Print help message and exit. +.TP +.B --version +.rb +Print version information and exit. +.\"===================================================================== +.SH "SEE ALSO" +.BR chmod (1). diff --git a/Master/texmf/doc/man/man1/kpsetool.1 b/Master/texmf/doc/man/man1/kpsetool.1 new file mode 100644 index 00000000000..addd9b08344 --- /dev/null +++ b/Master/texmf/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/doc/man/man1/kpsewhere.1 b/Master/texmf/doc/man/man1/kpsewhere.1 new file mode 100644 index 00000000000..76700ed33fe --- /dev/null +++ b/Master/texmf/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/doc/man/man1/kpsewhich.1 b/Master/texmf/doc/man/man1/kpsewhich.1 new file mode 100644 index 00000000000..86ac0357676 --- /dev/null +++ b/Master/texmf/doc/man/man1/kpsewhich.1 @@ -0,0 +1,160 @@ +.TH KPSEWHICH 1 "4 January 1998" "Kpathsea 3.5.5" +.\"===================================================================== +.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 +.rb +Set debugging flags. +.TP +.BI -D \ num +.rb +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 +.rb +Set +.I $engine +in the environment, which is used in some search paths. +.TP +.BI -expand-braces \ string +.rb +Print variable and brace expansion of +.IR string . +.TP +.BI -expand-path \ string +.rb +Print complete path expansion of +.IR string . +.TP +.BI -expand-var \ string +.rb +Print variable expansion of +.IR string . +.TP +.BI -format \ name +.rb +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 +.rb +Print help message and exit. +.TP +.B -interactive +.rb +Ask for additional filenames to look up. +.TP +.BI -mktex \ fmt +.rb +enable +.RI mktex fmt +generation. +.RI ( fmt =pk/mf/tex/tfm) +.TP +.BI -mode \ string +.rb +Set device name for +.I $MAKETEX_MODE +to +.IR string ; +no default. +.TP +.B -must-exist +.rb +Search the disk as well as ls-R if necessary. +.TP +.BI -no-mktex \ fmt +.rb +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 +.rb +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 +.rb +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 +.rb +Print the expansion of +.IR variable . +.B -version +.rb +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/doc/man/man1/kpsexpand.1 b/Master/texmf/doc/man/man1/kpsexpand.1 new file mode 120000 index 00000000000..007e1178459 --- /dev/null +++ b/Master/texmf/doc/man/man1/kpsexpand.1 @@ -0,0 +1 @@ +kpsetool.1
\ No newline at end of file diff --git a/Master/texmf/doc/man/man1/lacheck.1 b/Master/texmf/doc/man/man1/lacheck.1 new file mode 100644 index 00000000000..9679e294e60 --- /dev/null +++ b/Master/texmf/doc/man/man1/lacheck.1 @@ -0,0 +1,113 @@ +.TH "LaCheck" "1" "10/26/05" "Release 1.26" +.SH NAME +lacheck - A consistency checker for LaTeX documents. +.SH SYNOPSIS +.B lacheck +.I filename +[ +.I .tex +] +.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/doc/man/man1/lambda.1 b/Master/texmf/doc/man/man1/lambda.1 new file mode 100644 index 00000000000..29d0bbb1c10 --- /dev/null +++ b/Master/texmf/doc/man/man1/lambda.1 @@ -0,0 +1,292 @@ +.TH OMEGA 1 "27 December 1997" "Web2C 7.5.5" +.\"===================================================================== +.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 +omega, iniomega, viromega \- extended unicode TeX +.SH SYNOPSIS +.B omega +.RI [ options ] +[\fB&\fR \fIformat\fR ] +[ \fIfile\fR | \fB\e\fR \fIcommands\fR ] +.\"===================================================================== +.SH DESCRIPTION +Run the Omega 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 Omega commands can be given, the first +of which must start with a backslash. +With a +.BI & format +argument Omega uses a different set of precompiled commands, +contained in +.IR format.fmt ; +it is usually better to use the +.B -fmt +.I format +option instead. +.PP +Omega 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 +The +.B iniomega +and +.B viromega +commands are Omega's analogues to the +.B initex +and +.B virtex +commands. In this installation, they are symlinks to the +.B omega +executable. +.PP +Omega's command line options are similar to those of \*(TX. +.PP +Omega is experimental software. +.\"===================================================================== +.SH OPTIONS +This version of Omega understands the following command line options. +.TP +.BI --oft \ format +.rb +Use +.I format +as the name of the format to be used, instead of the name by which +Omega was called or a +.I %& +line. +.TP +.B -halt-on-error +.rb +Exit with an error code when an error is encountered during processing. +.TP +.B --help +.rb +Print help message and exit. +.TP +.B --ini +.rb +Be +.BR iniomega , +for dumping formats; this is implicitly true if the program is called +as +.BR iniomega . +.TP +.BI --interaction \ mode +.rb +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 +.rb +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 +.rb +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 +.rb +Sets path searching debugging flags according to the bitmask. See the +.I Kpathsea +manual for details. +.TP +.BI --maketex \ fmt +.rb +Enable +.RI mktex fmt , +where +.I fmt +must be one of +.I tex +or +.IR tfm . +.TP +.BI --no-maketex \ fmt +.rb +Disable +.RI mktex fmt , +where +.I fmt +must be one of +.I tex +or +.IR tfm . +.TP +.BI --output-comment \ string +.rb +Use +.I string +for the DVI file comment instead of the date. +.TP +.BI -output-directory \ directory +.rb 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 +.rb +If the first line of the main input file begins with +.I %& +parse it to look for a dump name. +.TP +.BI --progname \ name +.rb +Pretend to be program +.IR name . +This affects both the format used and the search paths. +.TP +.B --recorder +.rb +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 +.rb +Enable the +.BI \ewrite18{ command } +construct. The +.I command +can be any Bourne shell command. This construct is normally +disallowed for security reasons. +.TP +.B --version +.rb +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 Omega formats, you cannot use ~ in a filename you +give directly to Omega, 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 +TEXMFOUTPUT +Normally, Omega 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 , +Omega attempts to create +.I /tmp/paper.log +(and +.IR /tmp/paper.dvi , +if any output is produced.) +.TP +TEXINPUTS +Search path for +.I \einput +and +.I \eopenin +files. +This should 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/usr/tex:" to prepend the +current direcory and ``/home/user/tex'' to the standard search path. +.TP +TEXEDIT +Command template for switching to editor. The default, usually +.BR vi , +is set when Omega is compiled. +.\"===================================================================== +.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 omega.pool +Encoded text of Omega's messages. +.TP +.I *.oft +Predigested Omega format (.\|oft) files. +.br +.\"===================================================================== +.SH NOTES +This manual page is not meant to be exhaustive. The complete +documentation for this version of Omega can be found in the info +manual +.IR "Web2C: A TeX implementation" . +.\"===================================================================== +.SH BUGS +This version of Omega implements a number of optional extensions. +In fact, many of these extensions conflict to a greater or lesser +extent with the definition of Omega. When such extensions are +enabled, the banner printed when Omega starts is changed to print +.B Omegak +instead of +.BR Omega . +.PP +This version of Omega 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. +.PP +The +.I DVI +files produced by Omega may use extensions which make them incompatible +with most software designed to handle +.I DVI +files. In order to print or preview them, you should use +.B odvips +to generate a PostScript file. +.PP +Omega is experimental software, and if you are an active user it is +strongly recommended that you subscribe to the Omega mailing list. +Visit the Omega website +.B http://omega.cse.unsw.edu.au +for information on how to subscribe. +.\"===================================================================== +.SH "SEE ALSO" +.BR tex (1), +.BR mf (1), +.RB odvips (1), +.\"===================================================================== +.SH AUTHORS +The primary authors of Omega are John Plaice and Yannis Haralambous. diff --git a/Master/texmf/doc/man/man1/latex.1 b/Master/texmf/doc/man/man1/latex.1 new file mode 100644 index 00000000000..89d63058631 --- /dev/null +++ b/Master/texmf/doc/man/man1/latex.1 @@ -0,0 +1,70 @@ +.TH LATEX 1 "29 March 1999" "Web2C 7.5.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 +.\"===================================================================== +.SH NAME +latex, elatex, lambda, pdflatex \- structured text formatting and typesetting +.SH SYNOPSIS +.B latex +[ 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 \*(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. +.\"===================================================================== +.SH "SEE ALSO" +.BR amslatex (1), +.BR amstex (1), +.BR tex (1), +.br +Leslie Lamport, +.IR "\*(LX \- A Document Preparation System" , +Addison-Wesley, 1985, ISBN 0-201-15790-X. diff --git a/Master/texmf/doc/man/man1/mag.1 b/Master/texmf/doc/man/man1/mag.1 new file mode 100644 index 00000000000..8d9f2d4a261 --- /dev/null +++ b/Master/texmf/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/doc/man/man1/makeindex.1 b/Master/texmf/doc/man/man1/makeindex.1 new file mode 100644 index 00000000000..1404df6cf74 --- /dev/null +++ b/Master/texmf/doc/man/man1/makeindex.1 @@ -0,0 +1,1203 @@ +.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 1L "10 December 1991" +.\"===================================================================== +.SH NAME +makeindex \- a general purpose, formatter-independent index processor +.SH SYNOPSIS +.B makeindex +.BR [ \-c ] +.BR [ \-g ] +.BR [ \-i ] +.BR [ \-l ] +.BR [ \-o +.IR ind ] +.BR [ \-p +.IR num ] +.BR [ \-q ] +.BR [ \-r ] +.BR [ \-s +.IR sfile ] +.BR [ \-t +.IR log ] +.BR [ \-L ] +.BR [ \-T ] +.BI [ 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 +.BR \-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 +.BR \-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 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 +Finally, 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. +.PP +From 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 <chen@renoir.berkeley.edu>. +.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/doc/man/man1/makeinfo.1 b/Master/texmf/doc/man/man1/makeinfo.1 new file mode 100644 index 00000000000..7b46491e0a6 --- /dev/null +++ b/Master/texmf/doc/man/man1/makeinfo.1 @@ -0,0 +1,205 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.34. +.TH MAKEINFO "1" "December 2004" "makeinfo 4.8" "User Commands" +.SH NAME +makeinfo \- translate Texinfo documents +.SH SYNOPSIS +.B makeinfo +[\fIOPTION\fR]... \fITEXINFO-FILE\fR... +.SH DESCRIPTION +Translate Texinfo source documentation to various other formats, by default +Info files suitable for reading online with Emacs or standalone GNU Info. +.SS "General options:" +.TP +\fB\-\-error\-limit\fR=\fINUM\fR +quit after NUM errors (default 100). +.TP +\fB\-\-force\fR +preserve output even if errors. +.TP +\fB\-\-help\fR +display this help and exit. +.TP +\fB\-\-no\-validate\fR +suppress node cross\-reference validation. +.TP +\fB\-\-no\-warn\fR +suppress warnings (but not errors). +.TP +\fB\-\-reference\-limit\fR=\fINUM\fR +warn about at most NUM references (default 1000). +.TP +\fB\-v\fR, \fB\-\-verbose\fR +explain what is being done. +.TP +\fB\-\-version\fR +display version information and exit. +.SS "Output format selection (default is to produce Info):" +.TP +\fB\-\-docbook\fR +output Docbook XML rather than Info. +.TP +\fB\-\-html\fR +output HTML rather than Info. +.TP +\fB\-\-xml\fR +output Texinfo XML rather than Info. +.TP +\fB\-\-plaintext\fR +output plain text rather than Info. +.SS "General output options:" +.TP +\fB\-E\fR, \fB\-\-macro\-expand\fR FILE +output macro\-expanded source to FILE. +ignoring any @setfilename. +.TP +\fB\-\-no\-headers\fR +suppress node separators, Node: lines, and menus +from Info output (thus producing plain text) +or from HTML (thus producing shorter output); +also, write to standard output by default. +.TP +\fB\-\-no\-split\fR +suppress splitting of Info or HTML output, +generate only one output file. +.TP +\fB\-\-number\-sections\fR +output chapter and sectioning numbers. +.TP +\fB\-o\fR, \fB\-\-output\fR=\fIFILE\fR +output to FILE (directory if split HTML), +.SS "Options for Info and plain text:" +.TP +\fB\-\-enable\-encoding\fR +output accented and special characters in +Info output based on @documentencoding. +.TP +\fB\-\-fill\-column\fR=\fINUM\fR +break Info lines at NUM characters (default 72). +.TP +\fB\-\-footnote\-style\fR=\fISTYLE\fR +output footnotes in Info according to STYLE: +`separate' to put them in their own node; +`end' to put them at the end of the node +.IP +in which they are defined (default). +.TP +\fB\-\-paragraph\-indent\fR=\fIVAL\fR +indent Info paragraphs by VAL spaces (default 3). +If VAL is `none', do not indent; if VAL is +`asis', preserve existing indentation. +.TP +\fB\-\-split\-size\fR=\fINUM\fR +split Info files at size NUM (default 300000). +.SS "Options for HTML:" +.TP +\fB\-\-css\-include\fR=\fIFILE\fR +include FILE in HTML <style> output; +read stdin if FILE is \-. +.SS "Options for XML and Docbook:" +.TP +\fB\-\-output\-indent\fR=\fIVAL\fR +indent XML elements by VAL spaces (default 2). +If VAL is 0, ignorable whitespace is dropped. +.SS "Input file options:" +.TP +\fB\-\-commands\-in\-node\-names\fR +allow @ commands in node names. +.TP +\fB\-D\fR VAR +define the variable VAR, as with @set. +.TP +\fB\-I\fR DIR +append DIR to the @include search path. +.TP +\fB\-P\fR DIR +prepend DIR to the @include search path. +.TP +\fB\-U\fR VAR +undefine the variable VAR, as with @clear. +.SS "Conditional processing in input:" +.TP +\fB\-\-ifdocbook\fR +process @ifdocbook and @docbook even if +not generating Docbook. +.TP +\fB\-\-ifhtml\fR +process @ifhtml and @html even if not generating HTML. +.TP +\fB\-\-ifinfo\fR +process @ifinfo even if not generating Info. +.TP +\fB\-\-ifplaintext\fR +process @ifplaintext even if not generating plain text. +.TP +\fB\-\-iftex\fR +process @iftex and @tex; implies \fB\-\-no\-split\fR. +.TP +\fB\-\-ifxml\fR +process @ifxml and @xml. +.TP +\fB\-\-no\-ifdocbook\fR +do not process @ifdocbook and @docbook text. +.TP +\fB\-\-no\-ifhtml\fR +do not process @ifhtml and @html text. +.TP +\fB\-\-no\-ifinfo\fR +do not process @ifinfo text. +.TP +\fB\-\-no\-ifplaintext\fR +do not process @ifplaintext text. +.TP +\fB\-\-no\-iftex\fR +do not process @iftex and @tex text. +.TP +\fB\-\-no\-ifxml\fR +do not process @ifxml and @xml text. +.IP +Also, for the \fB\-\-no\-ifFORMAT\fR options, do process @ifnotFORMAT text. +.IP +The defaults for the @if... conditionals depend on the output format: +if generating HTML, \fB\-\-ifhtml\fR is on and the others are off; +if generating Info, \fB\-\-ifinfo\fR is on and the others are off; +if generating plain text, \fB\-\-ifplaintext\fR is on and the others are off; +if generating XML, \fB\-\-ifxml\fR is on and the others are off. +.SH EXAMPLES +.TP +makeinfo foo.texi +write Info to foo's @setfilename +.TP +makeinfo \fB\-\-html\fR foo.texi +write HTML to @setfilename +.TP +makeinfo \fB\-\-xml\fR foo.texi +write Texinfo XML to @setfilename +.TP +makeinfo \fB\-\-docbook\fR foo.texi +write DocBook XML to @setfilename +.TP +makeinfo \fB\-\-no\-headers\fR foo.texi +write plain text to standard output +.IP +makeinfo \fB\-\-html\fR \fB\-\-no\-headers\fR foo.texi write html without node lines, menus +makeinfo \fB\-\-number\-sections\fR foo.texi write Info with numbered sections +makeinfo \fB\-\-no\-split\fR foo.texi write one Info file however big +.SH "REPORTING BUGS" +Email bug reports to bug\-texinfo@gnu.org, +general questions and discussion to help\-texinfo@gnu.org. +Texinfo home page: http://www.gnu.org/software/texinfo/ +.SH COPYRIGHT +Copyright \(co 2004 Free Software Foundation, Inc. +There is NO warranty. You may redistribute this software +under the terms of the GNU General Public License. +For more information about these matters, see the files named COPYING. +.SH "SEE ALSO" +The full documentation for +.B makeinfo +is maintained as a Texinfo manual. If the +.B info +and +.B makeinfo +programs are properly installed at your site, the command +.IP +.B info makeinfo +.PP +should give you access to the complete manual. diff --git a/Master/texmf/doc/man/man1/makempx.1 b/Master/texmf/doc/man/man1/makempx.1 new file mode 100644 index 00000000000..fe968665fb3 --- /dev/null +++ b/Master/texmf/doc/man/man1/makempx.1 @@ -0,0 +1,89 @@ +.TH MAKEMPX 1 "4 January 1998" "Web2C 7.5.5" +.\"===================================================================== +.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 +makempx \- typeset labels in MetaPost pictures with TeX or Troff +.SH SYNOPSIS +.B makempx +.RI [ --tex | --troff ] +.I mpfile mpxfile +.\"===================================================================== +.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 +If +.I mpxfile +is older than +.IR mpfile , +translate the labels from the \*(MP input file +.I mpfile +to low-level commands in +.IR MPXFILE , +by running +.BR "mpto -tex" , +.BR tex , +and +.B dvitomp +by default; or, if +.B -troff +is specified, +.BR "mpto -troff" , +.BR "eqn -d\e$\e$ | troff -Tpost" , +and +.BR dmp . +.PP +The current directory is used for writing temporary files. Errors are +left in +.IR mpxerr.{tex,log,dvi} . +.PP +If the file named in +.I $MPTEXPRE +(mptexpre.tex by default) exists, it is prepended to the output in tex +mode. +.PP +.B makempx +is typically called by +.BR mpost , +not from the command line. +.\"===================================================================== +.SH OPTIONS +.B makempx +accepts the following options: +.TP +.B --help +.rb +Print help message and exit. +.TP +.B --tex +.rb +Assume input file contains \*(TX commands. +.TP +.B --troff +.rb +Assume input file contains Troff commands. +.TP +.B --version +.rb +Print version information and exit. +.\"===================================================================== +.SH "SEE ALSO" +.BR mpost (1), +.BR mpto (1). diff --git a/Master/texmf/doc/man/man1/makempy.1 b/Master/texmf/doc/man/man1/makempy.1 new file mode 100644 index 00000000000..02cae248c54 --- /dev/null +++ b/Master/texmf/doc/man/man1/makempy.1 @@ -0,0 +1,60 @@ +.TH makempy "1" "May 2004" "teTeX " "ConTeXt" +.SH NAME +makempy \- Helper script for conversion of (PDF or PostScript) text to +\fBMetapost\fP graphics +.PP +.SH "SYNOPSIS" +\fBmakempy\fP \fIfilenam\fP +.PP +.SH DESCRIPTION +.PP +\fBmakempy\fP takes \fBMetapost\fP output files (*\&.mpo) and +translates them to *\&.mpy files. In order to include text as a +graphic into a file typeset with (Con)TeX(t), you extract the text +from Postscript of PDF files using \fBpdftops\fP and \fBpstoedit\fP, +creating a Metapost input file. +.PP +This file can then be processed by \fBmakempy\fP. The \fBmakempy\fP +script does its work without user intervention. When it deduces that +there are no changes, it will not run at all, otherwise it will report +its steps and/or encountered error. +.SH "OPTIONS" +.IP +.IP "\fB--help\fP" +returns some basic help information +.IP +.IP "\fB--silent\fP" +don t report status messages +.IP +.IP "\fB--force\fP" +always process the file (no checksum test) +.IP +.IP "\fB--noclean\fP" +don t remove temporary files when finished +.IP +.IP "\fB--acrobat\fP" +use ACROBAT for conversion (only unix) +.IP +.IP "\fB--pdftops\fP" +use PDFTOPS for conversion +.IP +.IP "\fB--ghostscript\fP" +use GHOSTSCRIPT for conversion +.IP +.SH "VARIABLES" +.PP +When set, the environment variables GS and GS_PROG will be used to +identify GHOSTSCRIPT. If needed, the names of the other programs that +are used can be set with PDFTOPS, ACROREAD and PSTOEDIT. +.HP +.SH "SEE ALSO" +.PP +\fBtexexec\fP(1)\&. +.PP +The makempy manual, \fImmakempy\&.pdf\fP\&. +.PP +.SH "AUTHOR" +.IP +This manual page was written by Frank Küster <frank@kuesterei\&.ch>, +for the Debian GNU/Linux system\&. It may be used and modified by +others without contacting the author\&. diff --git a/Master/texmf/doc/man/man1/mf-nowin.1 b/Master/texmf/doc/man/man1/mf-nowin.1 new file mode 120000 index 00000000000..48261aa3d6e --- /dev/null +++ b/Master/texmf/doc/man/man1/mf-nowin.1 @@ -0,0 +1 @@ +mf.1
\ No newline at end of file diff --git a/Master/texmf/doc/man/man1/mf.1 b/Master/texmf/doc/man/man1/mf.1 new file mode 100644 index 00000000000..9909f89db14 --- /dev/null +++ b/Master/texmf/doc/man/man1/mf.1 @@ -0,0 +1,501 @@ +.\" t +.TH MF 1 "10 November 2001" "Web2C 7.5.5" +.\"===================================================================== +.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 +.rb +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 +.rb +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 +.rb +Disable printing error messages in the +.I file:line:error +style. +.TP +.B -file-line-error-style +.rb +This is the old name of the +.B -file-line-error +option. +.TP +.B -halt-on-error +.rb +Exit with an error code when an error is encountered during processing. +.TP +.B -help +.rb +Print help message and exit. +.TP +.B -ini +.rb +Be +.BR inimf , +for dumping bases; this is implicitly true if the program is called +as +.BR inimf . +.TP +.BI -interaction \ mode +.rb +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 +.rb +Use +.I name +for the job name, instead of deriving it from the name of the input file. +.TP +.BI -kpathsea-debug \ bitmask +.rb +Sets path searching debugging flags according to the bitmask. See the +.I Kpathsea +manual for details. +.TP +.BI -maketex \ fmt +.rb +Enable +.RI mktex fmt , +where +.I fmt +must be +.IR mf . +.TP +.BI -no-maketex \ fmt +.rb +Disable +.RI mktex fmt , +where +.I fmt +must be +.IR mf . +.TP +.BI -output-directory \ directory +.rb 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 +.rb +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 +.rb +Disable parsing of the first line of the main input file. +.TP +.BI -progname \ name +.rb +Pretend to be program +.IR name . +This affects both the format used and the search paths. +.TP +.B -recorder +.rb +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 +.rb +Use the +.I tcxname +translation table. +.TP +.B -version +.rb +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 +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 +MFINPUTS +Search path for +.I input +and +.I openin +files. +.TP +MFEDIT +Command template for switching to editor. +.TP +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/doc/man/man1/mft.1 b/Master/texmf/doc/man/man1/mft.1 new file mode 100644 index 00000000000..db552fa1c4e --- /dev/null +++ b/Master/texmf/doc/man/man1/mft.1 @@ -0,0 +1,134 @@ +.TH MFT 1 "14 December 1993" "Web2C 7.5.5" +.\"===================================================================== +.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 code to TeX code for prettyprinting +.SH SYNOPSIS +.B mft +.I mf_file_name[.mf] +[ +[ +.B \-c +] +or +[ +.I change_file_name[.ch] +] +] +[ +[ +.B \-s +] +or +[ +.I style_file_name[.mft] +] +] +.\"===================================================================== +.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 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 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 command line has one required file name and two optional file names. +The required +one is a \*(MF source file; there is also an optional change file +(which works just as the change files to +.BR tangle (1) +and +.BR weave (1) +do) +and an optional style file (which is prepended to everything). +.PP +A file name that doesn't contain a dot is always given an extension, +either +.I .mf +(\*(MF) or +.I .ch +(change) or +.I .mft +(style). If no style file is specified, the style file +.I plain.mft +is automatically used. The +.I change_file_name +is not searched for using any paths. The +.I .mf +file is searched for using the MFINPUTS environment variable if you +have set it, or else the system default. The style file is searched +for using the TEXINPUTS environment variable. See +.BR tex (1) +for the details of the searching. +.PP +The output \*(TX file name is formed by using +.I .tex +in place of the extension of +.IR mf_file_name . +.\"===================================================================== +.SH OPTIONS +Specify command-line options +.B \-c +to suppress the reading of a change file, and +.B \-s +to suppress the reading of a style file. +.\"===================================================================== +.SH FILES +.TP +.I mftmac.tex +\*(TX macros used by +.B mft +output. +.TP +.I plain.mft +Default style file. +.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/doc/man/man1/mkindex.1 b/Master/texmf/doc/man/man1/mkindex.1 new file mode 100644 index 00000000000..503b70020fd --- /dev/null +++ b/Master/texmf/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/doc/man/man1/mkocp.1 b/Master/texmf/doc/man/man1/mkocp.1 new file mode 100644 index 00000000000..c35c967225e --- /dev/null +++ b/Master/texmf/doc/man/man1/mkocp.1 @@ -0,0 +1,50 @@ +.TH "mkocp" "1" "September 2000" "Omega" "Omega" +.PP +.SH "NAME" +mkocp \- frontend to \fBotp2ocp\fP(1) +.PP +.SH "SYNOPSIS" +.PP +\fBmkocp\fP \fIOTPFILE\fP +.PP +.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/doc/man/man1/mkofm.1 b/Master/texmf/doc/man/man1/mkofm.1 new file mode 100644 index 00000000000..9c38a4301a6 --- /dev/null +++ b/Master/texmf/doc/man/man1/mkofm.1 @@ -0,0 +1,33 @@ +.TH "mkofm" "1" "September 2000" "teTeX" "teTeX" +.PP +.SH "NAME" +mkofm \- front end to \fBmktextfm\fP(1) +.PP +.SH "SYNOPSIS" +.PP +\fBmkofm\fP \fIARGS\fP +.PP +.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/doc/man/man1/mktexfmt.1 b/Master/texmf/doc/man/man1/mktexfmt.1 new file mode 120000 index 00000000000..240dee18655 --- /dev/null +++ b/Master/texmf/doc/man/man1/mktexfmt.1 @@ -0,0 +1 @@ +fmtutil.1
\ No newline at end of file diff --git a/Master/texmf/doc/man/man1/mktexlsr.1 b/Master/texmf/doc/man/man1/mktexlsr.1 new file mode 100644 index 00000000000..ececa268140 --- /dev/null +++ b/Master/texmf/doc/man/man1/mktexlsr.1 @@ -0,0 +1,46 @@ +.TH MKTEXLSR 1 "4 January 1998" "Kpathsea 3.5.5" +.\"===================================================================== +.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 +.rb +Print help message and exit. +.TP +.B --version +.rb +Print version information and exit. diff --git a/Master/texmf/doc/man/man1/mktexmf.1 b/Master/texmf/doc/man/man1/mktexmf.1 new file mode 100644 index 00000000000..502a41ac325 --- /dev/null +++ b/Master/texmf/doc/man/man1/mktexmf.1 @@ -0,0 +1,59 @@ +.TH MKTEXMF 1 "4 January 1998" "Kpathsea 3.5.5" +.\"===================================================================== +.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 +.rb +Print help message and exit. +.TP +.B --version +.rb +Print version information and exit. +.\"===================================================================== +.SH "SEE ALSO" +.BR mktexpk (1), +.BR mktextfm (1). diff --git a/Master/texmf/doc/man/man1/mktexpk.1 b/Master/texmf/doc/man/man1/mktexpk.1 new file mode 100644 index 00000000000..99a5a71cd3a --- /dev/null +++ b/Master/texmf/doc/man/man1/mktexpk.1 @@ -0,0 +1,122 @@ +.TH MKTEXPK 1 "4 January 1998" "Kpathsea 3.5.5" +.\"===================================================================== +.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 +.I >&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. +.rb +.TP +.BI --dpi \ num +Generate the font at resolution +.IR num . +.rb +.TP +.B --help +.rb +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. +.rb +.TP +.BI --mfmode \ mode +The \*(MF mode to use. +.rb +.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. +.rb +.TP +.B --version +.rb +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/doc/man/man1/mktextfm.1 b/Master/texmf/doc/man/man1/mktextfm.1 new file mode 100644 index 00000000000..e8566899004 --- /dev/null +++ b/Master/texmf/doc/man/man1/mktextfm.1 @@ -0,0 +1,68 @@ +.TH MKTEXTFM 1 "4 January 1998" "Kpathsea 3.5.5" +.\"===================================================================== +.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 +.rb +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 +.rb +Print help message and exit. +.TP +.B --version +.rb +Print version information and exit. +.\"===================================================================== +.SH "SEE ALSO" +.BR mktexmf (1), +.BR mktexpk (1). diff --git a/Master/texmf/doc/man/man1/mmafm.1 b/Master/texmf/doc/man/man1/mmafm.1 new file mode 100644 index 00000000000..a837a4fa3c8 --- /dev/null +++ b/Master/texmf/doc/man/man1/mmafm.1 @@ -0,0 +1,183 @@ +.\" -*-nroff-*- +.ds V 2.34 +.de M +.BR "\\$1" "(\\$2)\\$3" +.. +.ds E " \-\- +.if t .ds E \(em +.de OP +.BR "\\$1" "\\$2" "\\$3" "\\$4" "\\$5" "\\$6" +.. +.de OA +.IR "\fB\\$1\& \|\fI\\$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, kohler@icir.org +.br +http://www.pdos.lcs.mit.edu/~eddietwo/ +.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 <oneill@cs.sfu.ca> for suggestions and patient +debugging. diff --git a/Master/texmf/doc/man/man1/mmpfb.1 b/Master/texmf/doc/man/man1/mmpfb.1 new file mode 100644 index 00000000000..23bac8dd967 --- /dev/null +++ b/Master/texmf/doc/man/man1/mmpfb.1 @@ -0,0 +1,211 @@ +.\" -*-nroff-*- +.ds V 2.34 +.de M +.BR "\\$1" "(\\$2)\\$3" +.. +.ds E " \-\- +.if t .ds E \(em +.de OP +.BR "\\$1" "\\$2" "\\$3" "\\$4" "\\$5" "\\$6" +.. +.de OA +.IR "\fB\\$1\& \|\fI\\$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, kohler@icir.org +.br +http://www.pdos.lcs.mit.edu/~eddietwo/ +.PP +The latest version is available from: +.br +http://www.lcdf.org/type/ +.PP +Thanks to Melissa O'Neill <oneill@cs.sfu.ca> for suggestions and patient +debugging. diff --git a/Master/texmf/doc/man/man1/mpost.1 b/Master/texmf/doc/man/man1/mpost.1 new file mode 100644 index 00000000000..b784a64df5a --- /dev/null +++ b/Master/texmf/doc/man/man1/mpost.1 @@ -0,0 +1,478 @@ +.TH MPOST 1 "10 November 2001" "Web2C 7.5.5" +.\"===================================================================== +.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, inimpost, virmpost \- MetaPost, a system for drawing pictures +.SH SYNOPSIS +.B mpost +.RI [ options ] +.RI [ commands ] +.\"===================================================================== +.SH DESCRIPTION +\*(MP interprets the \*(MP language and produces PostScript +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 +Like \*(TX and \*(MF, \*(MP is normally used with a large body of +precompiled macros. This version of \*(MP looks at its command line +to see what name it was called under. Both +.B inimpost +and +.B virmpost +are symlinks to the +.B mpost +executable. When called as +.BR inimpost +(or when the +.B -ini +option is given) it can be used to precompile macros into a +.I .mem +file. When called as +.B virmpost +it will use the +.I plain +mem. When called under any other name, \*(MP will use that name as +the name of the mem to use. For example, when called as +.B mpost +the +.I mpost +mem is used, which is identical to the +.I plain +mem. Other mems than +.I plain +are rarely used. +.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 first line should begin with a filename, a +.RI \e controlsequence , +or a +.IR &memname . +.PP +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 +There is normally one output file for each picture generated, +and the output files are named \fIjobname\fP\fB\^.\^\fP\fInnn\fP, +where \fInnn\fP +is a number passed to the +.I beginfig +macro. The output file name +can also be \fIjobname\fP\fB\^.\^\fP\fIps\fP +if this number is negative. +.PP +The output files can be used as figures in a \*(TX document by including +.ce +.BI "\especial{psfile=" jobname.nnn } +in the \*(TX document. Alternatively, one can +.B \einput epsf.tex +and then use the macro +.ce +.BI "\eepsfbox{" jobname.nnn } +to produce a box of the appropriate size containing the figure. +.TP +.BI btex " TeX commands " etex +This causes +.I mpost +to generate a \*(MP picture expression that corresponds to the +\*(TX commands. If the \*(TX commands generate +more than one line of text, it must be in a +.I \evbox +or a minipage environment. +.TP +.BI verbatimtex " TeX commands " etex +This is ignored by +.I mpost +except that the \*(TX commands are passed on to \*(TX. When using \*(LX +instead of \*(TX the input file must start with a +.I verbatimtex +block that gives the +.I \edocumentstyle +and +.I "\ebegin{document}" +commands. You can use the `%&' construct in the first verbatimtex +block to ensure that the correct \*(TX format is used to process the +commands. +.PP +Since most \*(TX fonts have to be downloaded as bitmaps, the +.I btex +feature works best when the output of +.I mpost +is to be included in a \*(TX document so that +.BR dvips (1) +can download the fonts. For self-contained PostScript output that can be +used directly or included in a +.I troff +document, start your \*(MP input file with the command +.I "prologues:=1" +and stick to standard PostScript fonts. \*(TX and \*(MP use the names in the +third column of the file +.IR trfonts.map , +which can be found in the directories with support files for \*(MP. +.PP +\*(MP output can be included in a +.I troff +document via the +.I "-m pictures" +macro package. In this case +.I mpost +should be invoked with the +.B -T +flag so that the commands between +.I btex +and +.I etex +or between +.I verbatimtex +and +.I etex +are interpreted as +.I troff +instead of \*(TX. (This automatically sets +.I "prologues:=1" +). +.\"===================================================================== +.SH OPTIONS +This version of \*(MP understands the following command line options. +.TP +.B -file-line-error +.rb +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 +.rb +Disable printing error messages in the +.I file:line:error +style. +.TP +.B -file-line-error-style +.rb +This is the old name of the +.B -file-line-error +option. +.TP +.B -halt-on-error +.rb +Exit with an error code when an error is encountered during processing. +.TP +.B -help +.rb +Print help message and exit. +.TP +.B -ini +.rb +Be +.BR inimpost , +for dumping bases; this is implicitly true if the program is called +as +.BR inimpost . +.TP +.BI -interaction \ mode +.rb +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 +.rb +Use +.I name +for the job name, instead of deriving it from the name of the input file. +.TP +.BI -kpathsea-debug \ bitmask +.rb +Sets path searching debugging flags according to the bitmask. See the +.I Kpathsea +manual for details. +.TP +.BI -mem \ mem +.rb +Use +.I mem +as the name of the mem to be used, instead of the name by which +\*(MP was called or a +.I %& +line. +.TP +.BI -output-directory \ directory +.rb 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 +.rb +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 +.rb +Disable parsing of the first line of the main input file. +.TP +.BI -progname \ name +.rb +Pretend to be program +.IR name . +This affects both the format used and the search paths. +.TP +.B -recorder +.rb +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 -T +.rb +Produce TROFF output. +.TP +.BI -translate-file \ tcxname +.rb +Use the +.I tcxname +translation table. +.TP +.B -troff +.rb +As +.BR -T . +.TP +.B -version +.rb +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 +TEXMFOUTPUT is set, \*(MP attempts to put its output +files in it, if they cannot be put in the current directory. +.PP +Here is a list of the environment variables affect the behavior of +.IR mpost : +.TP +.TP +MPINPUTS +Search path for +.I input +files. +.TP +MFINPUTS +Auxiliary search path for +.I input +files with +.I .mf +extensions. +.TP +MPSUPPORT +Directory for various tables for handling included +.I tex +and +.IR troff . +.TP +MPXCOMMAND +The name of a shell script that converts embedded typesetting commands +to a form that \*(MP understands. Defaults: +.I makempx +for +.I tex +and +.I troffmpx +for +.IR troff . +.TP +TEX +The version of \*(TX \- or \*(LX \- to use when processing +.I btex +and +.I verbatimtex +commands. Default +.IR tex . +This version of \*(MP allows you to use a `%&format' line instead. +.TP +TROFF +The +.I troff +pipeline for +.I btex +and +.I verbatimtex +commands. Default +.I eqn -d\e$\e$ | troff +.TP +MPEDIT +A command template for invoking an editor. +.PP +A +.I .mem +file is a binary file that permits fast loading of macro packages. +.I mpost +reads the default +.I plain.mem +unless another +.I .mem +file is specified at the start of the first line with an +.I & +just before it. There is also an +.I mfplain.mem +that simulates plain \*(MF so that +.I mpost +can read +.I .mf +fonts. (Plain \*(MF is described in +.IR "The \*(MF\^book" ). +.PP +Experts can create +.I .mem +files be invoking +.I inimpost +and giving macro definitions followed by a +.I dump +command. +.PP +The \*(MP language is similar to \*(MF, but the manual +.I A User's Manual for \*(MP +assumes no knowledge of \*(MF. \*(MP does not have bitmap +output commands or \*(MF's online display mechanism. +.\"===================================================================== +.SH FILES +.TP +.I mpost.pool +Encoded text of \*(MP's messages. +.TP +.I *.mem +Predigested \*(MP mem files. +.TP +.I plain.mp +The standard mem file. +.TP +.I mfplain.mp +The \*(MF-compatible mem file. This is loaded when +.I virmp +is invoked via a symbolic link as +.IR mfmp . +.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/examples.mp +The source file for a few sample figures +that are part of a \*(LX document +.I $TEXMFMAIN/doc/metapost/mpintro.tex +that describes the \*(MP system +in a little more detail. +.\"===================================================================== +.SH NOTES +This manual page is not meant to be exhaustive. The complete +documentation for this version of \*(MP can be found in the info manual +.IR "Web2C: A TeX implementation" . +.\"===================================================================== +.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 +John D. Hobby, +.IR "A User's Manual for \*(MP" , +CSTR 162, AT&T Bell Labs, +.br +John D. Hobby, +.IR "Drawing Graphs with \*(MP" , +CSTR 164, AT&T Bell Labs, +.br +.I TUGboat +(the journal of the \*(TX Users Group). +.\"===================================================================== +.SH "SEE ALSO" +.BR tex (1), +.BR mf (1), +.BR dvips (1). +.\"===================================================================== +.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. He also updated and extended this manual page. +.\"===================================================================== +.SH TRIVIA +Unlike \*(TX and \*(MF, \*(MP originally didn't use any fancy logo. +John Hobby says he prefers the spelling ``MetaPost'', yet Don Knuth +has updated the \*(MF +.I logo.mf +font to be able to typeset a proper \*(MP logo similar to the \*(MF +logo. Feel free to use whatever you think is more appropriate! diff --git a/Master/texmf/doc/man/man1/mpto.1 b/Master/texmf/doc/man/man1/mpto.1 new file mode 100644 index 00000000000..8c7e5fe58fa --- /dev/null +++ b/Master/texmf/doc/man/man1/mpto.1 @@ -0,0 +1,68 @@ +.TH MPTO 1 "4 January 1998" "Web2C 7.5.5" +.\"===================================================================== +.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 +mpto \- extract labels in MetaPost pictures for typesetting +.SH SYNOPSIS +.B mpto +.RI [ -tex | -troff ] +.I mpfile +.\"===================================================================== +.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 +Strip +.I btex..etex +and +.I verbatimtex...etex +parts from \*(MP input file +.IR mpfile , +converting to either \*(TX or Troff (\*(TX by default). The generated +code is dumped on standard output. +.PP +.B mpto +is typically called by +.BR makempx , +not from the command line. +.\"===================================================================== +.SH OPTIONS +.B mpto +accepts the following options: +.TP +.B --help +.rb +Print help message and exit. +.TP +.B -tex +.rb +Assume input file contains \*(TX commands. +.TP +.B -troff +.rb +Assume input file contains Troff commands. +.TP +.B --version +.rb +Print version information and exit. +.\"===================================================================== +.SH "SEE ALSO" +.BR mpost (1), +.BR makempx (1). diff --git a/Master/texmf/doc/man/man1/newer.1 b/Master/texmf/doc/man/man1/newer.1 new file mode 100644 index 00000000000..0a5b1c2f375 --- /dev/null +++ b/Master/texmf/doc/man/man1/newer.1 @@ -0,0 +1,41 @@ +.TH NEWER 1 "21 June 2005" "Web2C 7.5.5" +.\"===================================================================== +.SH NAME +newer \- compare file modification times +.SH SYNOPSIS +.B newer +.RI [ option ] +.I src1 +[ +.I src2 ... srcN +] +.I target +.\"===================================================================== +.SH DESCRIPTION +Exit successfully if files +.I src1 ... srcN +exist and at least one of them is not older than +.IR target . +Also exit successfully if +.I target +doesn't exist. +.\"===================================================================== +.SH OPTIONS +.B newer +accepts the following options: +.TP +.B --help +.rb +Print help message and exit. +.TP +.B --quiet, -q +.rb +Do not print any output, including error messages. +.TP +.B --version +.rb +Print version information and exit. +.TP +.B --verbose, -v +.rb +List missing source files. This is the default. diff --git a/Master/texmf/doc/man/man1/odvicopy.1 b/Master/texmf/doc/man/man1/odvicopy.1 new file mode 120000 index 00000000000..84bac04a557 --- /dev/null +++ b/Master/texmf/doc/man/man1/odvicopy.1 @@ -0,0 +1 @@ +dvicopy.1
\ No newline at end of file diff --git a/Master/texmf/doc/man/man1/odvips.1 b/Master/texmf/doc/man/man1/odvips.1 new file mode 120000 index 00000000000..bb895a1c4e5 --- /dev/null +++ b/Master/texmf/doc/man/man1/odvips.1 @@ -0,0 +1 @@ +dvips.1
\ No newline at end of file diff --git a/Master/texmf/doc/man/man1/odvitype.1 b/Master/texmf/doc/man/man1/odvitype.1 new file mode 120000 index 00000000000..d077e7784b4 --- /dev/null +++ b/Master/texmf/doc/man/man1/odvitype.1 @@ -0,0 +1 @@ +dvitype.1
\ No newline at end of file diff --git a/Master/texmf/doc/man/man1/ofm2opl.1 b/Master/texmf/doc/man/man1/ofm2opl.1 new file mode 100644 index 00000000000..adc4de3ec3c --- /dev/null +++ b/Master/texmf/doc/man/man1/ofm2opl.1 @@ -0,0 +1,91 @@ +.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 +\fBofm2opl\fP [ \fIOPTION\fP\&.\&.\&. ] \fIOFMNAME\fP[\&.ofm] [ +\fIOPLFILE\fP[\&.opl] ] +.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/doc/man/man1/omega.1 b/Master/texmf/doc/man/man1/omega.1 new file mode 100644 index 00000000000..29d0bbb1c10 --- /dev/null +++ b/Master/texmf/doc/man/man1/omega.1 @@ -0,0 +1,292 @@ +.TH OMEGA 1 "27 December 1997" "Web2C 7.5.5" +.\"===================================================================== +.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 +omega, iniomega, viromega \- extended unicode TeX +.SH SYNOPSIS +.B omega +.RI [ options ] +[\fB&\fR \fIformat\fR ] +[ \fIfile\fR | \fB\e\fR \fIcommands\fR ] +.\"===================================================================== +.SH DESCRIPTION +Run the Omega 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 Omega commands can be given, the first +of which must start with a backslash. +With a +.BI & format +argument Omega uses a different set of precompiled commands, +contained in +.IR format.fmt ; +it is usually better to use the +.B -fmt +.I format +option instead. +.PP +Omega 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 +The +.B iniomega +and +.B viromega +commands are Omega's analogues to the +.B initex +and +.B virtex +commands. In this installation, they are symlinks to the +.B omega +executable. +.PP +Omega's command line options are similar to those of \*(TX. +.PP +Omega is experimental software. +.\"===================================================================== +.SH OPTIONS +This version of Omega understands the following command line options. +.TP +.BI --oft \ format +.rb +Use +.I format +as the name of the format to be used, instead of the name by which +Omega was called or a +.I %& +line. +.TP +.B -halt-on-error +.rb +Exit with an error code when an error is encountered during processing. +.TP +.B --help +.rb +Print help message and exit. +.TP +.B --ini +.rb +Be +.BR iniomega , +for dumping formats; this is implicitly true if the program is called +as +.BR iniomega . +.TP +.BI --interaction \ mode +.rb +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 +.rb +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 +.rb +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 +.rb +Sets path searching debugging flags according to the bitmask. See the +.I Kpathsea +manual for details. +.TP +.BI --maketex \ fmt +.rb +Enable +.RI mktex fmt , +where +.I fmt +must be one of +.I tex +or +.IR tfm . +.TP +.BI --no-maketex \ fmt +.rb +Disable +.RI mktex fmt , +where +.I fmt +must be one of +.I tex +or +.IR tfm . +.TP +.BI --output-comment \ string +.rb +Use +.I string +for the DVI file comment instead of the date. +.TP +.BI -output-directory \ directory +.rb 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 +.rb +If the first line of the main input file begins with +.I %& +parse it to look for a dump name. +.TP +.BI --progname \ name +.rb +Pretend to be program +.IR name . +This affects both the format used and the search paths. +.TP +.B --recorder +.rb +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 +.rb +Enable the +.BI \ewrite18{ command } +construct. The +.I command +can be any Bourne shell command. This construct is normally +disallowed for security reasons. +.TP +.B --version +.rb +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 Omega formats, you cannot use ~ in a filename you +give directly to Omega, 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 +TEXMFOUTPUT +Normally, Omega 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 , +Omega attempts to create +.I /tmp/paper.log +(and +.IR /tmp/paper.dvi , +if any output is produced.) +.TP +TEXINPUTS +Search path for +.I \einput +and +.I \eopenin +files. +This should 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/usr/tex:" to prepend the +current direcory and ``/home/user/tex'' to the standard search path. +.TP +TEXEDIT +Command template for switching to editor. The default, usually +.BR vi , +is set when Omega is compiled. +.\"===================================================================== +.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 omega.pool +Encoded text of Omega's messages. +.TP +.I *.oft +Predigested Omega format (.\|oft) files. +.br +.\"===================================================================== +.SH NOTES +This manual page is not meant to be exhaustive. The complete +documentation for this version of Omega can be found in the info +manual +.IR "Web2C: A TeX implementation" . +.\"===================================================================== +.SH BUGS +This version of Omega implements a number of optional extensions. +In fact, many of these extensions conflict to a greater or lesser +extent with the definition of Omega. When such extensions are +enabled, the banner printed when Omega starts is changed to print +.B Omegak +instead of +.BR Omega . +.PP +This version of Omega 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. +.PP +The +.I DVI +files produced by Omega may use extensions which make them incompatible +with most software designed to handle +.I DVI +files. In order to print or preview them, you should use +.B odvips +to generate a PostScript file. +.PP +Omega is experimental software, and if you are an active user it is +strongly recommended that you subscribe to the Omega mailing list. +Visit the Omega website +.B http://omega.cse.unsw.edu.au +for information on how to subscribe. +.\"===================================================================== +.SH "SEE ALSO" +.BR tex (1), +.BR mf (1), +.RB odvips (1), +.\"===================================================================== +.SH AUTHORS +The primary authors of Omega are John Plaice and Yannis Haralambous. diff --git a/Master/texmf/doc/man/man1/opl2ofm.1 b/Master/texmf/doc/man/man1/opl2ofm.1 new file mode 100644 index 00000000000..425ff8e0adc --- /dev/null +++ b/Master/texmf/doc/man/man1/opl2ofm.1 @@ -0,0 +1,74 @@ +.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 +\fBopl2ofm\fP [ \fIOPTION\fP\&.\&.\&. ] \fIOPLFILE\fP[\&.opl] [ +\fIOFMFILE\fP[\&.ofm] ] +.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/doc/man/man1/otfinfo.1 b/Master/texmf/doc/man/man1/otfinfo.1 new file mode 100644 index 00000000000..e0bbcd10886 --- /dev/null +++ b/Master/texmf/doc/man/man1/otfinfo.1 @@ -0,0 +1,143 @@ +'\"t +.ds V 2.34 +.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-sfzpg\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 \-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. +' +.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 (kohler@icir.org) diff --git a/Master/texmf/doc/man/man1/otftotfm.1 b/Master/texmf/doc/man/man1/otftotfm.1 new file mode 100644 index 00000000000..a5450d3e290 --- /dev/null +++ b/Master/texmf/doc/man/man1/otftotfm.1 @@ -0,0 +1,1473 @@ +'\"t +.ds V 2.34 +.de M +.BR "\\$1" "(\\$2)\\$3" +.. +.de Sp +.if n .sp +.if t .sp 0.4 +.. +.de BUP +.IP \(bu 3n +.. +.TH OTFTOTFM 1 "LCDF Typetools" "Version \*V" +.SH NAME +otftotfm \- create TeX font metrics from PostScript OpenType fonts +.SH SYNOPSIS +.B otftotfm +\%[\fB\-a\fR] +\%[\fBoptions\fR] +\%\fIfontfile\fR.otf [\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" 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 only works on PostScript-flavored OpenType fonts. +.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.otf \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.otf". +' +.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 .) +You can then run "\fBotftotfm\fR +.B \-a +.IR file .otf +.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/ +PFB font TEXMF/fonts/type1/\fIvendor\fR/\fItypeface\fR/ \fIPStexname\fR.pfb +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, and \fIPStexname\fR is the PostScript name of the input +font. 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 +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 font T1DESTDIR \-\-type1\-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 is a good choice for many OpenType fonts; it +corresponds to the "texnansx.enc" encoding file, so we will supply +.B otftotfm +with the "\fB\-e\fR texnansx" option. +.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 CHARACTER 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. +.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 \-\-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 \-\-ligkern= command +Execute the specified LIGKERN +.IR command +in addition to any in 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 +Execute the specified POSITION +.IR command +in addition to any in 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 +Execute the specified UNICODING +.IR command +in addition to any in 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 +Set the font's TFM coding scheme to +.IR scheme , +which must be a string less than 40 characters long containing no +parentheses. The default is the encoding's PostScript name. Most tools +ignore the coding scheme, so you probably don't need to worry about this +command unless you are using fontinst. +' +.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. Use an alternate selector if you want to choose between different +versions of a character from within a TeX file. For instance, say that your +font provides three versions of "A". If you want to access them all, pick a +character to be your alternate selector -- say "*". Then give +.B otftotfm +the +.BR \-\-altselector\-char= '*' +option. In TeX, "A" will produce the normal version, "A*" will produce the +first alternate, and "A**" will produce the second alternate. Furthermore, +"s*t" will activate any discretionary "s_t" ligature in the font. The +default alternate-selector character is taken from the encoding. +.Sp +The +.B \-\-altselector\-char +mechanism uses the features specified by +.BR \-\-altselector\-feature +options. You don't need to turn on those features if you use +.BR \-\-altselector . +.Sp +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 CHARACTER 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 +.BR \-\-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 +' +.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\-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. +.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 +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 the Adobe glyph list, which helps translate glyph names to Unicode code +points. 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, if an input encoding +has "/dotlessi" at position 10, then +.B otftotfm +detects that the user wants to encode Unicode character U+0131 LATIN SMALL +LETTER DOTLESS I at position 10. The output encoding will use whatever +glyph the font suggests for that Unicode character, given the collection of +features you chose. +.PP +You can control this process with "UNICODING" comments in the input +encoding file. UNICODING comments have the following format: +.nf + % UNICODING \fIglyph\fR =: \fIchoice1\fR [\fIchoice2\fR ...] ; +.fi +\fIGlyph\fR and the +.IR choice s +are PostScript glyph names. This comment 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. For example, +.nf + % UNICODING pi1 =: uni03D6 ; +.fi +tells otftotfm that the character "/pi1" encodes as U+03D6 GREEK PI SYMBOL, +and +.nf + % UNICODING Delta =: uni0394 uni2206 ; +.fi +tells it that U+0394 GREEK CAPITAL LETTER DELTA should be preferred to +U+2206 INCREMENT as an encoding for "/Delta". You can also supply regular +glyph names: +.nf + % UNICODING Delta =: Deltagreek Delta ; +.fi +.B Otftotfm +uses Adobe's +.I glyphlist.txt +file to translate glyph names to Unicode; see +.IR http://partners.adobe.com/asn/developer/type/unicodegn.html . +.LP +You can map a glyph to nothing to remove that glyph from the input +encoding. This is useful to remove optional characters; for instance: +.nf + % UNICODING ff =: ; fi =: ; fl =: ; ffi =: ; ffl =: ; +.fi +The f-ligatures will be added back to the encoding, preferably at their +original locations, if some font feature requires them. +.LP +Map a glyph to 'emptyslot' if you don't want +.B otftotfm +to use the slot for a ligature character. For example, given this +UNICODING, +.nf + % UNICODING ff =: ff emptyslot ; +.fi +.B otftotfm +will leave the 'ff' encoding slot unused if the font has no 'ff' glyph. +(Note that most OpenType fonts provide a visible representation for unused +encoding slots, namely a box with an X inside.) +.LP +Each UNICODING line can contain multiple commands, separated by spaced +semicolons. +.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 +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 +Finally, the CODINGSCHEME command specifies a default +.B \-\-coding\-scheme +for the encoding; for example: +.nf + % CODINGSCHEME EXTENDED TEX FONT ENCODING +.fi +.PP +The +.BR \-\-unicoding , +.BR \-\-ligkern , +and +.B \-\-position +options let you add virtual UNICODING, LIGKERN/LIGKERNX, and POSITION +comments to an encoding. +.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 +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. Explicit +.B \-\-ligkern +and +.B \-\-unicoding +options 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 +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 +FFIsmall +Small-capital version of "FFL" +.PD +' +' +.SH "GLYPH PATTERNS" +.LP +The +.BR \-\-include\-subs +and +.BR \-\-include\-alternates +options, and their +.B \-\-exclude +variants, accept the following types of pattern. +.BUP +Glyph names. Example: "Aacute". 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. +.BUP +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". +.BUP +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. +.BUP +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. TeX can't support complex contextual swashes, or +alternate selection, but +.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 . +.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. +.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. +.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 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. +.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 . +' +.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. +' +.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 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). +' +.SH AUTHOR +Eddie Kohler (kohler@cs.ucla.edu) +.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/doc/man/man1/otp2ocp.1 b/Master/texmf/doc/man/man1/otp2ocp.1 new file mode 100644 index 00000000000..c111acc49d3 --- /dev/null +++ b/Master/texmf/doc/man/man1/otp2ocp.1 @@ -0,0 +1,41 @@ +.TH "otp2ocp" "1" "September 2000" "Omega" "Omega" +.PP +.SH "NAME" +otp2ocp \- convert Omega Translation Process files to Omega +Compiled Process files +.PP +.SH "SYNOPSIS" +.PP +\fBotp2ocp\fP \fIOTPFILE\fP[\&.otp] [ \fIOCPFILE\fP[\&.ocp] ] +.PP +.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/doc/man/man1/outocp.1 b/Master/texmf/doc/man/man1/outocp.1 new file mode 100644 index 00000000000..ee803d9be67 --- /dev/null +++ b/Master/texmf/doc/man/man1/outocp.1 @@ -0,0 +1,44 @@ +.TH "outocp" "1" "September 2000" "Omega" "Omega" +.PP +.SH "NAME" +outocp \- debug an OCP file +.PP +.SH "SYNOPSIS" +.PP +\fBoutocp\fP \fIOCPFILE\fP[\&.ocp] +.PP +.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/doc/man/man1/ovf2ovp.1 b/Master/texmf/doc/man/man1/ovf2ovp.1 new file mode 100644 index 00000000000..86fbbb56dd9 --- /dev/null +++ b/Master/texmf/doc/man/man1/ovf2ovp.1 @@ -0,0 +1,87 @@ +.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 +\fBovf2ovp\fP [ \fIOPTION\fP\&.\&.\&. ] \fIOVFNAME\fP[\&.ovf] [ [ +\fIOFMNAME\fP[\&.ofm] ] [ \fIOVPFILE\fP[\&.ovp] ] ] +.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/doc/man/man1/ovp2ovf.1 b/Master/texmf/doc/man/man1/ovp2ovf.1 new file mode 100644 index 00000000000..2793db27eda --- /dev/null +++ b/Master/texmf/doc/man/man1/ovp2ovf.1 @@ -0,0 +1,78 @@ +.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" +.PP +\fBovp2ovf\fP [ \fIOPTION\fP\&.\&.\&. ] \fIOVPFILE\fP[\&.ovp] [ [ +\fIOVFFILE\fP[\&.ovf] ] [ \fIOFMFILE\fP[\&.ofm] ] ] +.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/doc/man/man1/oxdvi.1 b/Master/texmf/doc/man/man1/oxdvi.1 new file mode 120000 index 00000000000..33de598c928 --- /dev/null +++ b/Master/texmf/doc/man/man1/oxdvi.1 @@ -0,0 +1 @@ +xdvi.1
\ No newline at end of file diff --git a/Master/texmf/doc/man/man1/patgen.1 b/Master/texmf/doc/man/man1/patgen.1 new file mode 100644 index 00000000000..ac33a0852e5 --- /dev/null +++ b/Master/texmf/doc/man/man1/patgen.1 @@ -0,0 +1,170 @@ +.TH PATGEN 1 "23 August 2004" "Web2C 7.5.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 +.\"===================================================================== +.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. 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 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, 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 +.B 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 hypenation level. +.PP +The patterns generated by +.B patgen +can be read by +.B initex +for use in hyphenating words. For a (very) long example of +.IR patgen 's +output, see +.IR $TEXMFMAIN/tex/generic/hyphen/hyphen.tex , +which contains the patterns \*(TX uses for English. +At some sites, patterns for several other languages may be available, +and the local +.B tex +programs may have them preloaded; consult your +.I Local Guide +or your system administrator for details. +.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 +.B 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 \w'@@'u+2n +.B Translate file +A translate file starts with a line containing the values of +.I left_hypen_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_hypen_min "=2, " right_hyphen_min "=3," +and the 26 lower case letters +.IR a ... z +with their upper case representations +.IR A ... Z +are assumed. +.TP \w'@@'u+2n +.B Terminal input +After reading the +.I translate_file +and any previously-generated patterns from +.IR pattern_file, +.B 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 hypenated word list. +.\"===================================================================== +.SH FILES +.TP \w'@@'u+2n +.I $TEXMFMAIN/tex/generic/hyphen/hyphen.tex +Patterns for English. +.\"===================================================================== +.SH "SEE ALSO" +Frank Liang, +.IR "Word hy-phen-a-tion by com-puter" , +STAN-CS-83-977, +Stanford University Ph.D. thesis, 1983. +.br +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, available from the \*(TX Users Group. Howard Trickey +originally ported it to Unix. diff --git a/Master/texmf/doc/man/man1/pdfetex.1 b/Master/texmf/doc/man/man1/pdfetex.1 new file mode 100644 index 00000000000..fb532c5e01e --- /dev/null +++ b/Master/texmf/doc/man/man1/pdfetex.1 @@ -0,0 +1,487 @@ +.TH PDFETEX 1 "21 August 2004" "Web2C 7.5.5" +.\"===================================================================== +.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, pdfeinitex, pdfevirtex \- PDF output from e-TeX +.SH SYNOPSIS +.B pdfetex +.RI [ options ] +[\fB&\fR \fIformat\fR ] +[ \fIfile\fR | \fB\e\fR \fIcommands\fR ] +.\"===================================================================== +.SH DESCRIPTION +Run the pdfe\*(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 pdfe\*(TX commands can be given, the first +of which must start with a backslash. +With a +.BI & format +argument pdfe\*(TX uses a different set of precompiled commands, +contained in +.IR format.fmt ; +it is usually better to use the +.B -fmt +.I format +option instead. +.PP +pdfe\*(TX is a version of e-\*(TX that can create +.I PDF +files as well as +.I DVI +files. +.PP +In +.I DVI +mode, pdfe\*(TX can be used as a complete replacement of the e-\*(TX +engine. +.PP +The typical use of pdfe\*(TX is with a pregenerated formats for which +PDF output has been enabled. The +.B pdfetex +command uses the equivalent of the plain e-\*(TX format, and the +.B pdfelatex +command uses the equivalent of the e-\*(LX format. +To generate formats, use the +.B -ini +switch. +.PP +The +.B pdfeinitex +and +.B pdfevirtex +commands are pdfe\*(TX's analogues to the +.B einitex +and +.B evirtex +commands. In this installation, they are symbolic links to the +.B pdfetex +executable. These symbolic links may not exist at all. +.PP +In +.I PDF +mode, pdfe\*(TX can natively handle the +.IR PDF , +.IR JPG , +and +.I PNG +graphics formats. +pdfe\*(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 pdfe\*(TX understands the following command line options. +.TP +.B -enc +.rb +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 +.rb +Enable the e-\*(TX extensions. This option is only effective in +combination with +.BR -ini . +.TP +.B -file-line-error +.rb +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 +.rb +Disable printing error messages in the +.I file:line:error +style. +.TP +.B -file-line-error-style +.rb +This is the old name of the +.B -file-line-error +option. +.TP +.BI -fmt \ format +.rb +Use +.I format +as the name of the format to be used, instead of the name by which +pdfe\*(TX was called or a +.I %& +line. +.TP +.B -halt-on-error +.rb +Exit with an error code when an error is encountered during processing. +.TP +.B -help +.rb +Print help message and exit. +.TP +.B -ini +.rb +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 +.rb +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 +.rb +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 +.rb +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 +.rb +Use +.I name +for the job name, instead of deriving it from the name of the input file. +.TP +.BI -kpathsea-debug \ bitmask +.rb +Sets path searching debugging flags according to the bitmask. See the +.I Kpathsea +manual for details. +.TP +.BI -mktex \ fmt +.rb +Enable +.RI mktex fmt , +where +.I fmt +must be either +.I tex +or +.IR tfm . +.TP +.B -mltex +.rb +Enable ML\*(TX extensions. Only effective in combination with +.BR -ini . +.TP +.BI -no-mktex \ fmt +.rb +Disable +.RI mktex fmt , +where +.I fmt +must be either +.I tex +or +.IR tfm . +.TP +.BI -output-comment \ string +.rb +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 +.rb 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 +.rb +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 pdfe\*(TX. +.TP +.B -parse-first-line +.rb +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 +.rb +Disable parsing of the first line of the main input file. +.TP +.BI -progname \ name +.rb +Pretend to be program +.IR name . +This affects both the format used and the search paths. +.TP +.B -recorder +.rb +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 +.rb +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 +.rb +Disable the +.BI \ewrite18{ command } +construct, even if it is enabled in the +.I texmf.cnf +file. +.TP +.B -src-specials +.rb +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 +.rb +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 +.rb +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 +.rb +Like +.B -translate-file +except that a +.I %& +line can overrule this setting. +.TP +.B -version +.rb +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 pdfe\*(TX formats, you cannot use ~ in a filename you +give directly to pdfe\*(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 +TEXMFOUTPUT +Normally, pdfe\*(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 pdfetex paper +and the current directory is not writable, if TEXMFOUTPUT has +the value +.IR /tmp , +pdfe\*(TX attempts to create +.I /tmp/paper.log +(and +.IR /tmp/paper.pdf , +if any output is produced.) +.TP +TEXINPUTS +Search path for +.I \einput +and +.I \eopenin +files. +This should 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/usr/tex:" to prepend the +current direcory and ``/home/user/tex'' to the standard search path. +.TP +TEXFORMATS +Search path for format files. +.TP +TEXPOOL +search path for +.B pdfetex +internal strings. +.TP +TEXEDIT +Command template for switching to editor. The default, usually +.BR vi , +is set when pdfe\*(TX is compiled. +.TP +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 pdfetex.pool +Text file containing pdfe\*(TX's internal strings. +.TP +.I pdftex.map +Filename mapping definitions. +.TP +.I *.tfm +Metric files for pdfe\*(TX's fonts. +.TP +.I *.fmt +Predigested pdfe\*(TX format (.\|fmt) files. +.br +.\"===================================================================== +.SH NOTES +This manual page is not meant to be exhaustive. The complete +documentation for this version of pdfe\*(TX can be found in the info +manual +.IR "Web2C: A TeX implementation" . +.\"===================================================================== +.SH BUGS +This version of pdfe\*(TX implements a number of optional extensions. +In fact, many of these extensions conflict to a greater or lesser +extent with the definition of pdfe\*(TX. When such extensions are +enabled, the banner printed when pdfe\*(TX starts is changed to print +.B pdfeTeXk +instead of +.BR pdfeTeX . +.PP +This version of pdfe\*(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 +pdfe\*(TX is available for a large variety of machine architectures +and operation systems. +pdfe\*(TX is part of all major \*(TX distributions. +.P +Information on how to get pdfe\*(TX and related information +is available at the +.BI "http://tug.org" \ TUG +website. +The most recent version of pdfe\*(TX is available for anonymous +ftp at the +.B http://www.pdftex.org/ +.IR "pdfe\*(TX development 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 . +More about the list can be found at the +.B "http://tug.org/mailman/listinfo/pdftex" +.I mailing list +website. +.\"===================================================================== +.SH "SEE ALSO" +.BR tex (1), +.BR mf (1), +.BR etex (1), +.BR pdftex (1). +.\"===================================================================== +.SH AUTHORS +The primary authors of pdf\*(TX are Han The Thanh, Petr Sojka, and +Jiri Zlatuska. +.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/doc/man/man1/pdflatex.1 b/Master/texmf/doc/man/man1/pdflatex.1 new file mode 120000 index 00000000000..8237fbd3a07 --- /dev/null +++ b/Master/texmf/doc/man/man1/pdflatex.1 @@ -0,0 +1 @@ +pdfetex.1
\ No newline at end of file diff --git a/Master/texmf/doc/man/man1/pdftex.1 b/Master/texmf/doc/man/man1/pdftex.1 new file mode 100644 index 00000000000..56ca5798215 --- /dev/null +++ b/Master/texmf/doc/man/man1/pdftex.1 @@ -0,0 +1,479 @@ +.TH PDFTEX 1 "25 March 2004" "Web2C 7.5.5" +.\"===================================================================== +.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 +pdftex, pdfinitex, pdfvirtex \- PDF output from TeX +.SH SYNOPSIS +.B pdftex +.RI [ options ] +[\fB&\fR \fIformat\fR ] +[ \fIfile\fR | \fB\e\fR \fIcommands\fR ] +.\"===================================================================== +.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.fmt ; +it is usually better to use the +.B -fmt +.I format +option instead. +.PP +pdf\*(TX is a version of \*(TX 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 of 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, they are symbolic links to the +.B pdftex +executable. These symbolic links may not exist at all. +.PP +In +.I PDF +mode, pdf\*(TX can natively handle the +.IR PDF , +.IR JPG , +and +.I PNG +graphics formats. +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 -enc +.rb +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 +.rb +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 +.rb +Disable printing error messages in the +.I file:line:error +style. +.TP +.B -file-line-error-style +.rb +This is the old name of the +.B -file-line-error +option. +.TP +.BI -fmt \ format +.rb +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 +.rb +Exit with an error code when an error is encountered during processing. +.TP +.B -help +.rb +Print help message and exit. +.TP +.B -ini +.rb +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 +.rb +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 +.rb +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 +.rb +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 +.rb +Use +.I name +for the job name, instead of deriving it from the name of the input file. +.TP +.BI -kpathsea-debug \ bitmask +.rb +Sets path searching debugging flags according to the bitmask. See the +.I Kpathsea +manual for details. +.TP +.BI -mktex \ fmt +.rb +Enable +.RI mktex fmt , +where +.I fmt +must be either +.I tex +or +.IR tfm . +.TP +.B -mltex +.rb +Enable ML\*(TX extensions. Only effective in combination with +.BR -ini . +.TP +.BI -no-mktex \ fmt +.rb +Disable +.RI mktex fmt , +where +.I fmt +must be either +.I tex +or +.IR tfm . +.TP +.BI -output-comment \ string +.rb +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 +.rb 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 +.rb +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 +.rb +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 +.rb +Disable parsing of the first line of the main input file. +.TP +.BI -progname \ name +.rb +Pretend to be program +.IR name . +This affects both the format used and the search paths. +.TP +.B -recorder +.rb +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 +.rb +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 +.rb +Disable the +.BI \ewrite18{ command } +construct, even if it is enabled in the +.I texmf.cnf +file. +.TP +.B -src-specials +.rb +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 +.rb +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 +.rb +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 +.rb +Like +.B -translate-file +except that a +.I %& +line can overrule this setting. +.TP +.B -version +.rb +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 +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, if 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.) +.TP +TEXINPUTS +Search path for +.I \einput +and +.I \eopenin +files. +This should 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/usr/tex:" to prepend the +current direcory and ``/home/user/tex'' to the standard search path. +.TP +TEXFORMATS +Search path for format files. +.TP +TEXPOOL +search path for +.B pdftex +internal strings. +.TP +TEXEDIT +Command template for switching to editor. The default, usually +.BR vi , +is set when pdf\*(TX is compiled. +.TP +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 +This manual page is not meant to be exhaustive. The complete +documentation for this version of pdf\*(TX can be found in 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 pdfe\*(TX and related information +is available at the +.BI "http://tug.org" \ TUG +website. +The most recent version of pdf\*(TX is available for anonymous +ftp at the +.B http://www.pdftex.org/ +.IR "pdf\*(TX development 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 . +More about the list can be found at the +.B "http://tug.org/mailman/listinfo/pdftex" +.I mailing list +website. +.\"===================================================================== +.SH "SEE ALSO" +.BR tex (1), +.BR mf (1). +.\"===================================================================== +.SH AUTHORS +The primary authors of pdf\*(TX are Han The Thanh, Petr Sojka, and +Jiri Zlatuska. +.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/doc/man/man1/pfb2pfa.1 b/Master/texmf/doc/man/man1/pfb2pfa.1 new file mode 100644 index 00000000000..f81abb8ed2f --- /dev/null +++ b/Master/texmf/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/doc/man/man1/pk2bm.1 b/Master/texmf/doc/man/man1/pk2bm.1 new file mode 100644 index 00000000000..5b9c6d599db --- /dev/null +++ b/Master/texmf/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/doc/man/man1/pktogf.1 b/Master/texmf/doc/man/man1/pktogf.1 new file mode 100644 index 00000000000..f341a3a2c8e --- /dev/null +++ b/Master/texmf/doc/man/man1/pktogf.1 @@ -0,0 +1,103 @@ +.TH PKTOGF 1 "14 December 1993" "Web2C 7.5.5" +.\"===================================================================== +.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 +[ +.B \-v +] +.I pk_file_name +[ +.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 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 +.I gf +suffix replacing +.IR 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/doc/man/man1/pktype.1 b/Master/texmf/doc/man/man1/pktype.1 new file mode 100644 index 00000000000..60bb34540aa --- /dev/null +++ b/Master/texmf/doc/man/man1/pktype.1 @@ -0,0 +1,85 @@ +.TH PKTYPE 1 "13 March 1996" "Web2C 7.5.5" +.\"===================================================================== +.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 +.I pk_file +[ +.I output_file +] +.\"===================================================================== +.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 +.I pk_file +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 +is specified, the plain text translation is 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 +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 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 adapted it for compilation with Web2c. diff --git a/Master/texmf/doc/man/man1/pltotf.1 b/Master/texmf/doc/man/man1/pltotf.1 new file mode 100644 index 00000000000..497f565770f --- /dev/null +++ b/Master/texmf/doc/man/man1/pltotf.1 @@ -0,0 +1,74 @@ +.TH PLTOTF 1 "27 December 1992" "Web2C 7.5.5" +.\"===================================================================== +.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 +[ +.B \-verbose +] +.I pl_file_name +.I tfm_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 pltotf +program translates a (human-oriented) \*(WB 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 +Both the +.I pl_file_name +and the +.I tfm_file_name +must be complete; no adding of default extensions or path searching is done. +.\"===================================================================== +.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/doc/man/man1/pooltype.1 b/Master/texmf/doc/man/man1/pooltype.1 new file mode 100644 index 00000000000..2f50fdbc582 --- /dev/null +++ b/Master/texmf/doc/man/man1/pooltype.1 @@ -0,0 +1,45 @@ +.TH POOLTYPE 1 "27 December 1992" "Web2C 7.5.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 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/doc/man/man1/ps2frag.1 b/Master/texmf/doc/man/man1/ps2frag.1 new file mode 100644 index 00000000000..b572c5733c1 --- /dev/null +++ b/Master/texmf/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/doc/man/man1/ps2pk.1 b/Master/texmf/doc/man/man1/ps2pk.1 new file mode 100644 index 00000000000..dbeed0cdbfc --- /dev/null +++ b/Master/texmf/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/doc/man/man1/psbook.1 b/Master/texmf/doc/man/man1/psbook.1 new file mode 100644 index 00000000000..97cf6229455 --- /dev/null +++ b/Master/texmf/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" +psbook(1), psselect(1), pstops(1), epsffit(1), psnup(1), psresize(1), psmerge(1), fixscribeps(1), getafm(1), fixdlsrps(1), fixfmps(1), fixmacps(1), fixpsditps(1), fixpspps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), extractres(1), includeres(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/doc/man/man1/pslatex.1 b/Master/texmf/doc/man/man1/pslatex.1 new file mode 100644 index 00000000000..c206596a6a0 --- /dev/null +++ b/Master/texmf/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/doc/man/man1/psmerge.1 b/Master/texmf/doc/man/man1/psmerge.1 new file mode 100644 index 00000000000..1f4b564930d --- /dev/null +++ b/Master/texmf/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" +psbook(1), psselect(1), pstops(1), epsffit(1), psnup(1), psresize(1), psmerge(1), fixscribeps(1), getafm(1), fixdlsrps(1), fixfmps(1), fixmacps(1), fixpsditps(1), fixpspps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), extractres(1), includeres(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/doc/man/man1/psnup.1 b/Master/texmf/doc/man/man1/psnup.1 new file mode 100644 index 00000000000..c90227c6070 --- /dev/null +++ b/Master/texmf/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" +psbook(1), psselect(1), pstops(1), epsffit(1), psnup(1), psresize(1), psmerge(1), fixscribeps(1), getafm(1), fixdlsrps(1), fixfmps(1), fixmacps(1), fixpsditps(1), fixpspps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), extractres(1), includeres(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/doc/man/man1/psresize.1 b/Master/texmf/doc/man/man1/psresize.1 new file mode 100644 index 00000000000..034ab27d54c --- /dev/null +++ b/Master/texmf/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" +psbook(1), psselect(1), pstops(1), epsffit(1), psnup(1), psresize(1), psmerge(1), fixscribeps(1), getafm(1), fixdlsrps(1), fixfmps(1), fixmacps(1), fixpsditps(1), fixpspps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), extractres(1), includeres(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/doc/man/man1/psselect.1 b/Master/texmf/doc/man/man1/psselect.1 new file mode 100644 index 00000000000..22a70bd6826 --- /dev/null +++ b/Master/texmf/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" +psbook(1), psselect(1), pstops(1), epsffit(1), psnup(1), psresize(1), psmerge(1), fixscribeps(1), getafm(1), fixdlsrps(1), fixfmps(1), fixmacps(1), fixpsditps(1), fixpspps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), extractres(1), includeres(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/doc/man/man1/pstops.1 b/Master/texmf/doc/man/man1/pstops.1 new file mode 100644 index 00000000000..2b3cbe2bf3f --- /dev/null +++ b/Master/texmf/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" +psbook(1), psselect(1), pstops(1), epsffit(1), psnup(1), psresize(1), psmerge(1), fixscribeps(1), getafm(1), fixdlsrps(1), fixfmps(1), fixmacps(1), fixpsditps(1), fixpspps(1), fixtpps(1), fixwfwps(1), fixwpps(1), fixwwps(1), extractres(1), includeres(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/doc/man/man1/rubibtex.1 b/Master/texmf/doc/man/man1/rubibtex.1 new file mode 100644 index 00000000000..0142072a769 --- /dev/null +++ b/Master/texmf/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/doc/man/man1/rumakeindex.1 b/Master/texmf/doc/man/man1/rumakeindex.1 new file mode 100644 index 00000000000..0fb271841d0 --- /dev/null +++ b/Master/texmf/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/doc/man/man1/sjisconv.1 b/Master/texmf/doc/man/man1/sjisconv.1 new file mode 100644 index 00000000000..99436936cd2 --- /dev/null +++ b/Master/texmf/doc/man/man1/sjisconv.1 @@ -0,0 +1,94 @@ +.\" man page for sjisconv +. +.TH SJISCONV 1 11-Aug-2005 "CJK Version 4.6.0" +. +.\" ==== +.\" ==== 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/doc/man/man1/t1ascii.1 b/Master/texmf/doc/man/man1/t1ascii.1 new file mode 100644 index 00000000000..0ae4d3eed57 --- /dev/null +++ b/Master/texmf/doc/man/man1/t1ascii.1 @@ -0,0 +1,51 @@ +.ds V 1.32 +.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 (kohler@icir.org) +.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/doc/man/man1/t1asm.1 b/Master/texmf/doc/man/man1/t1asm.1 new file mode 100644 index 00000000000..59d4db5e790 --- /dev/null +++ b/Master/texmf/doc/man/man1/t1asm.1 @@ -0,0 +1,96 @@ +.ds V 1.32 +.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 (kohler@icir.org) diff --git a/Master/texmf/doc/man/man1/t1binary.1 b/Master/texmf/doc/man/man1/t1binary.1 new file mode 100644 index 00000000000..fc41bcacc87 --- /dev/null +++ b/Master/texmf/doc/man/man1/t1binary.1 @@ -0,0 +1,42 @@ +.ds V 1.32 +.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 (kohler@icir.org) +.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/doc/man/man1/t1disasm.1 b/Master/texmf/doc/man/man1/t1disasm.1 new file mode 100644 index 00000000000..381bfb1b607 --- /dev/null +++ b/Master/texmf/doc/man/man1/t1disasm.1 @@ -0,0 +1,96 @@ +.ds V 1.32 +.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 (kohler@icir.org) diff --git a/Master/texmf/doc/man/man1/t1dotlessj.1 b/Master/texmf/doc/man/man1/t1dotlessj.1 new file mode 100644 index 00000000000..fd5778f88a3 --- /dev/null +++ b/Master/texmf/doc/man/man1/t1dotlessj.1 @@ -0,0 +1,96 @@ +.ds V 2.34 +.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 (kohler@icir.org) diff --git a/Master/texmf/doc/man/man1/t1lint.1 b/Master/texmf/doc/man/man1/t1lint.1 new file mode 100644 index 00000000000..54077ee6728 --- /dev/null +++ b/Master/texmf/doc/man/man1/t1lint.1 @@ -0,0 +1,48 @@ +.ds V 2.34 +.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 (kohler@icir.org) diff --git a/Master/texmf/doc/man/man1/t1mac.1 b/Master/texmf/doc/man/man1/t1mac.1 new file mode 100644 index 00000000000..63a196da720 --- /dev/null +++ b/Master/texmf/doc/man/man1/t1mac.1 @@ -0,0 +1,62 @@ +.ds V 1.32 +.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 (kohler@icir.org) diff --git a/Master/texmf/doc/man/man1/t1reencode.1 b/Master/texmf/doc/man/man1/t1reencode.1 new file mode 100644 index 00000000000..784a329a0e9 --- /dev/null +++ b/Master/texmf/doc/man/man1/t1reencode.1 @@ -0,0 +1,149 @@ +.ds V 2.34 +.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 "StandardEncoding", "ISOLatin1Encoding", "ExpertEncoding", +"ExpertSubsetEncoding", or "SymbolEncoding", in which case the +corresponding standard encoding is used. +' +.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 (kohler@cs.ucla.edu) diff --git a/Master/texmf/doc/man/man1/t1testpage.1 b/Master/texmf/doc/man/man1/t1testpage.1 new file mode 100644 index 00000000000..87816fe364f --- /dev/null +++ b/Master/texmf/doc/man/man1/t1testpage.1 @@ -0,0 +1,62 @@ +.ds V 2.34 +.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 it 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 (kohler@icir.org) diff --git a/Master/texmf/doc/man/man1/t1unmac.1 b/Master/texmf/doc/man/man1/t1unmac.1 new file mode 100644 index 00000000000..deb6f252136 --- /dev/null +++ b/Master/texmf/doc/man/man1/t1unmac.1 @@ -0,0 +1,71 @@ +.ds V 1.32 +.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 "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 (kohler@icir.org) +.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/doc/man/man1/tangle.1 b/Master/texmf/doc/man/man1/tangle.1 new file mode 100644 index 00000000000..43a5da6f3e8 --- /dev/null +++ b/Master/texmf/doc/man/man1/tangle.1 @@ -0,0 +1,180 @@ +.TH TANGLE 1 "20 October 2002" "Web2C 7.5.5" +.\"===================================================================== +.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 +] +.I webfile[.web] +[ +.I changefile[.ch] +] +.\"===================================================================== +.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 +.I .web +is added if there is no +extension). +If there is another name, it is a change file (and +.I .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 +.I .p +and +.I .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 +.rb +Print help message and exit. +.TP +.BI --length \ number +.rb +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 +.rb +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 +.rb +Convert all identifiers to lowercase. +.TP +.B --mixedcase +.rb +Retain the case of identifiers. This is the default. +.TP +.B --strict +.rb +When checking for collisions between identifiers, strip underlines and +convert all identifiers to uppercase first. +.TP +.B --underline +.rb +Retain underlines (also known as underscores) in identifiers. +.TP +.B --uppercase +.rb +Convert all identifiers to uppercase. This is the behaviour of the +original +.BR tangle . +.TP +.B --version +.rb +Print version information and exit. +.\"===================================================================== +.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/doc/man/man1/tcdialog.1 b/Master/texmf/doc/man/man1/tcdialog.1 new file mode 100644 index 00000000000..73931f1c4ca --- /dev/null +++ b/Master/texmf/doc/man/man1/tcdialog.1 @@ -0,0 +1,217 @@ +.TH DIALOG 1 "10 January 1994" +.SH NAME +dialog \- display dialog boxes from shell scripts +.SH SYNOPSIS +.B dialog --clear +.br +.BI "dialog --create-rc " file +.br +.B dialog +[ +.B \-\-title +.I title +] +[ +.B \-\-clear +] +.B box-options +.SH DESCRIPTION +.B Dialog +is a program that will let you to present a variety of questions or +display messages using dialog boxes from a shell script. Currently, +these types of dialog boxes are implemented: +.LP +.BR yes/no " box," " menu" " box," " input" " box," +.BR message " box," " text" " box," " info" " box, and" +.BR checklist " box." +.SH OPTIONS +.TP +.B \-\-clear +The screen will be cleared to the +.BR "screen attribute" " on exit." +.TP +.BI \-\-create-rc " file" +.RB "Since " dialog " supports run-time configuration," +this can be used to dump a sample configuration file to the file specified +by +.IR file "." +.TP +.BI \-\-title " title" +Specifies a +.I title +string to be displayed at the top of the dialog box. +.TP +.B Box Options +.TP +.BI \-\-yesno " text height width" +.RB A " yes/no" " dialog box of size" +.I height +rows by +.I width +columns will be displayed. The string specified by +.I text +is displayed inside the dialog box. If this string is too long to be fitted +in one line, it will be automatically divided into multiple lines at +appropriate places. The +.I text +string may also contain the sub-string +.I +"\en" +or newline characters +.I `\en\' +to control line breaking explicitly. This dialog box is useful for +asking questions that require the user to answer either yes or no. +.RB "The dialog box has a" " Yes" " button and a " No +button, in which the user can switch between by pressing the +.IR TAB " key." +.TP +.BI \-\-msgbox " text height width" +.RB A " message" " box is very similar to a" " yes/no" " box." +The only difference between a +.B message +box and a +.B yes/no +box is that a +.B message +box has only a single +.B OK +button. You can use this dialog box to display any message you like. +After reading the message, the user can press the +.I ENTER +key so that +.B dialog +will exit and the calling shell script can continue its operation. +.TP +.BI \-\-infobox " text height width" +.RB An " info" " box is basically a" " message" " box." +However, in this case, +.B dialog +will exit immediately after displaying the message to the user. The +screen is not cleared when +.B dialog +exits, so that the message will remain on the screen until the calling +shell script clears it later. This is useful when you want to inform +the user that some operations are carrying on that may require some +time to finish. +.TP +.BI \-\-inputbox " text height width" +.RB "An " input " box is useful when you want to ask questions that" +require the user to input a string as the answer. When inputing the +string, the +.I BACKSPACE +key can be used to correct typing errors. If the input string is longer than +can be fitted in the dialog box, the input field will be scrolled. On exit, +the input string will be printed on +.IR stderr "." +.TP +.BI \-\-textbox " file height width" +.RB A " text" " box lets you display the contents of a text file in a" +dialog box. It is like a simple text file viewer. The user can move +through the file by using the +.IR UP/DOWN ", " PGUP/PGDN +.RI and " HOME/END" " keys available on most keyboards." +If the lines are too long to be displayed in the box, the +.I LEFT/RIGHT +keys can be used to scroll the text region horizontally. For more +convenience, forward and backward searching functions are also provided. +.IP "\fB\-\-menu \fItext height width menu-height \fR[ \fItag item \fR] \fI..." +As its name suggests, a +.B menu +box is a dialog box that can be used to present a list of choices in +the form of a menu for the user to choose. Each menu entry consists of a +.IR tag " string and an " item " string. The" +.I tag +gives the entry a name to distinguish it from the other entries in the +menu. The +.I item +is a short description of the option that the entry represents. The +user can move between the menu entries by pressing the +.I UP/DOWN +keys, the first letter of the +.I tag +as a hot-key, or the number keys +.IR 1-9 ". There are" +.I menu-height +entries displayed in the menu at one time, but the menu will be +scrolled if there are more entries than that. When +.B dialog +exits, the +.I tag +of the chosen menu entry will be printed on +.IR stderr "." +.IP "\fB\-\-checklist \fItext height width list-height \fR[ \fItag item status \fR] \fI..." +.RB "A " checklist " box is similar to a " menu " box in that there are" +multiple entries presented in the form of a menu. Instead of choosing +one entry among the entries, each entry can be turned on or off by the +user. The initial on/off state of each entry is specified by +.IR status "." +On exit, a list of the +.I tag +strings of those entries that are turned on will be printed on +.IR stderr "." +.SH "RUN-TIME CONFIGURATION" +.TP 4 +1. +Create a sample configuration file by typing: +.LP +.in +1i +"dialog --create-rc <file>" +.TP 4 +2. +At start, +.B dialog +determines the settings to use as follows: +.RS +.TP 4 +a) +if environment variable +.B DIALOGRC +is set, it's value determines the name of the configuration file. +.TP 4 +b) +if the file in (a) can't be found, use the file +.I $HOME/.dialogrc +as the configuration file. +.TP 4 +c) +if the file in (b) can't be found, use compiled in defaults. +.RE +.TP 4 +3. +Edit the sample configuration file and copy it to some place that +.B dialog +can find, as stated in step 2 above. +.SH ENVIROMENT +.TP 15 +.B DIALOGRC +Define this variable if you want to specify the name of the configuration file +to use. +.SH FILES +.TP 20 +.I $HOME/.dialogrc +default configuration file +.SH DIAGNOSTICS +Exit status is 0 if +.BR dialog " is exited by pressing the " Yes " or " OK +button, and 1 if the +.BR No " or " Cancel +button is pressed. Otherwise, if errors occur inside +.B dialog +or +.B dialog +is exited by pressing the +.I ESC +key, the exit status is -1. +.SH BUGS +Text files containing +.I tab +characters may cause problems with +.B text +box. +.I Tab +characters in text files must first be expanded to spaces before being +.RB "displayed by " text " box." +.TP +Screen update is too slow. +.SH AUTHOR +Savio Lam <lam836@cs.cuhk.hk> diff --git a/Master/texmf/doc/man/man1/tex.1 b/Master/texmf/doc/man/man1/tex.1 new file mode 100644 index 00000000000..e13fecc48b3 --- /dev/null +++ b/Master/texmf/doc/man/man1/tex.1 @@ -0,0 +1,541 @@ +.TH TEX 1 "21 August 2004" "Web2C 7.5.5" +.\"===================================================================== +.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 ] +[\fB&\fR \fIformat\fR ] +[ \fIfile\fR | \fB\e\fR \fIcommands\fR ] +.\"===================================================================== +.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.fmt ; +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 transation 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 +.rb +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 +.rb +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 +.rb +Disable printing error messages in the +.I file:line:error +style. +.TP +.B -file-line-error-style +.rb +This is the old name of the +.B -file-line-error +option. +.TP +.BI -fmt \ format +.rb +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 +.rb +Exit with an error code when an error is encountered during processing. +.TP +.B -help +.rb +Print help message and exit. +.TP +.B -ini +.rb +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 +.rb +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 +.rb +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 +.rb +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 +.rb +Use +.I name +for the job name, instead of deriving it from the name of the input file. +.TP +.BI -kpathsea-debug \ bitmask +.rb +Sets path searching debugging flags according to the bitmask. See the +.I Kpathsea +manual for details. +.TP +.BI -mktex \ fmt +.rb +Enable +.RI mktex fmt , +where +.I fmt +must be either +.I tex +or +.IR tfm . +.TP +.B -mltex +.rb +Enable ML\*(TX extensions. Only effective in combination with +.BR -ini . +.TP +.BI -no-mktex \ fmt +.rb +Disable +.RI mktex fmt , +where +.I fmt +must be either +.I tex +or +.IR tfm . +.TP +.BI -output-comment \ string +.rb +Use +.I string +for the +.I DVI +file comment instead of the date. +.TP +.BI -output-directory \ directory +.rb 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 +.rb +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 +.rb +Disable parsing of the first line of the main input file. +.TP +.BI -progname \ name +.rb +Pretend to be program +.IR name . +This affects both the format used and the search paths. +.TP +.B -recorder +.rb +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 +.rb +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 +.rb +Disable the +.BI \ewrite18{ command } +construct, even if it is enabled in the +.I texmf.cnf +file. +.TP +.B -src-specials +.rb +Insert source specials into the +.I DVI +file. +.TP +.BI -src-specials \ where +.rb +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 +.rb +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 +.rb +Like +.B -translate-file +except that a +.I %& +line can overrule this setting. +.TP +.B -version +.rb +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 +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.) +.TP +TEXINPUTS +Search path for +.I \einput +and +.I \eopenin +files. +This should 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/usr/tex:" to prepend the +current direcory and ``/home/user/tex'' to the standard search path. +.TP +TEXFORMATS +Search path for format files. +.TP +TEXPOOL +search path for +.B tex +internal strings. +.TP +TEXEDIT +Command template for switching to editor. The default, usually +.BR vi , +is set when \*(TX is compiled. +.TP +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/doc/man/man1/texconfig-sys.1 b/Master/texmf/doc/man/man1/texconfig-sys.1 new file mode 120000 index 00000000000..5d3f79303b2 --- /dev/null +++ b/Master/texmf/doc/man/man1/texconfig-sys.1 @@ -0,0 +1 @@ +texconfig.1
\ No newline at end of file diff --git a/Master/texmf/doc/man/man1/texconfig.1 b/Master/texmf/doc/man/man1/texconfig.1 new file mode 100644 index 00000000000..30cb0ea7e90 --- /dev/null +++ b/Master/texmf/doc/man/man1/texconfig.1 @@ -0,0 +1,27 @@ +.TH texconfig 1 "February 2005" "teTeX" "teTeX" +.SH NAME +texconfig \- configures teTeX +.LP +texconfig-sys \- configures teTeX system\-wide +.SH SYNOPSIS +.B texconfig +.LP +.B texconfig-sys +.SH DESCRIPTION +.I texconfig +allows to configure and maintain +.I teTeX +in an easy and convenient manner. It uses the +.I dialog +program to draw nice input boxes. After answering the dialoges, the +appropriate files are changed automatically and all necessary +steps are involved to apply the new settings. +.SH "SEE ALSO" +.IR dialog (1), +.IR initex (1), +.IR mf (1), +.IR vi (1), +.IR EDITOR +environment-variable. +.SH AUTHOR +Thomas Esser <te@dbs.uni-hannover.de> diff --git a/Master/texmf/doc/man/man1/texdoc.1 b/Master/texmf/doc/man/man1/texdoc.1 new file mode 100644 index 00000000000..9d680c35b0d --- /dev/null +++ b/Master/texmf/doc/man/man1/texdoc.1 @@ -0,0 +1,94 @@ +.\" EX and EE are used for displays that are pure code +.de EX +.nf +.ft CW +.in +5 +.. +.de EE +.in -5 +.ft R +.fi +.. +.TH "texdoc" "1" "September 2000" "teTeX" "teTeX" +.PP +.SH "NAME" +texdoc \- Utility to look up TeX documentation +.PP +.SH "SYNOPSIS" +.PP +\fBtexdoc\fP [ \fIOPTION\fP \&.\&.\&. ] \fINAME\fP [ \&.\&.\&. ] +.PP +.SH "DESCRIPTION" +.PP +\fBtexdoc\fP seaches for \fINAME\fP in the TeX documentation and +starts an appropriate viewer\&. +.PP +\fINAME\fP should be the name of a command or package in the teTeX +distribution\&. +.PP +.SH "OPTIONS" +.PP +.IP "\fB--help\fP" +Display a brief summary of options\&. +.IP +.IP "\fB-l\fP" +List matching files\&. Does not start a viewer\&. +.IP "\fB-v\fP" +Sets verbose mode\&. Shows the command being used to +display the documentation\&. +.PP +.SH "ENVIRONMENT" +.PP +.IP "\fB$TEXDOCVIEW_dvi\fP" +DVI viewer\&. Defaults to \fBxdvi\fP(1)\&. +.IP "\fB$TEXDOCVIEW_pdf\fP" +PDF viewer\&. Defaults to \fBacroread\fP(1)\&. +.IP "\fB$TEXDOCVIEW_ps\fP" +PostScript viewer\&. Defaults to +\fBghostview\fP(1)\&. +.IP "\fB$TEXDOCVIEW_html\fP" +HTML viewer\&. Defaults to \fBnetscape\fP(1)\&. +.IP "\fB$TEXDOCVIEW_txt\fP" +Text viewer\&. Defaults to \fB$PAGER-more\fP\&. +.PP +The environment variables should be set with a ``%s\&'\&' as a placeholder +for the name of the file\&. For example, +.PP +.EX +hostname% setenv TEXDOCVIEW_pdf "gv %s" +.EE +.PP +or +.PP +.EX +hostname$ TEXDOCVIEW_html="mozilla %s" + +hostname$ export TEXDOCVIEW_html +.EE +.PP +.SH "SEE ALSO" +.PP +\fBacroread\fP(1), \fBgv\fP(1), \fBkpsewhich\fP(1), +\fBless\fP(1), \fBmore\fP(1), \fBxdvi\fP(1) +.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 +\fBtexdoc\fP was written by Thomas Esser +<te@dbs\&.uni-hannover\&.de>, David Aspinall +<da@dcs\&.ed\&.ac\&.uk>, and +Simon Wilkinson +<sxw@dcs\&.ed\&.ac\&.uk> during 1998 and 1999\&. \fBtexdoc\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/doc/man/man1/texdoctk.1 b/Master/texmf/doc/man/man1/texdoctk.1 new file mode 100644 index 00000000000..03bb298c7a4 --- /dev/null +++ b/Master/texmf/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 derivates (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 concfiguration 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 programm 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 writeable 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/doc/man/man1/texexec.1 b/Master/texmf/doc/man/man1/texexec.1 new file mode 100644 index 00000000000..2d8593b674c --- /dev/null +++ b/Master/texmf/doc/man/man1/texexec.1 @@ -0,0 +1,574 @@ +.de EX +.sp +.in +5 +.nf +.ft CW +.. +.de EE +.in -5 +.ft R +.sp +.fi +.. +.TH "texexec" "1" "October 2000" "ConTeXt" "ConTeXt" +.PP +.SH "NAME" +texexec \- ConTeXt and PDF auxiliary program and batch processor +.PP +.SH "SYNOPSIS" +\fBtexexec\fP [ \fIOPTION\fP \&.\&.\&. ] \fIFILE\fP [ \&.\&.\&. ] +.PP +.SH "DESCRIPTION" +.PP +\fBtexexec\fP is a Perl script that provides several functions: +.IP o +Process a TeX file\&. This includes performing as many runs as +necessary of \fBtex\fP(1), \fBtexutil\fP(1), and +\fBmetapost\fP(1)\&. Options allow you to select the output +format, the pages to process, paper size, and so forth\&. +.IP o +Create new ConTeXt formats (with \fB--format\fP)\&. +.IP o +Post-process existing PDF files, including merging multiple +files, and extracting and rearranging pages within a file +(similar to the functions provided by \fBpsnup\fP(1) and +\fBpdfmerge\fP(1))\&. +.IP o +Extract or strip documentation from com{ConTeXt} source files +(using \fBtexutil\fP(1))\&. +.IP o +Run METAPOST (\fBmpost\fP(1)) to generate figures from METAPOST +source\&. +.IP o +Produce ``proof sheets\'\' of figures used in a \fBConTeXt\fP source +file\&. +.IP +.PP +.SH "OPTIONS" +.PP +All switches are specified in full, but can be abbreviated to the +shortest unique string\&. Thus, \fB--ver\fP works the same as +\fB--verbose\fP\&. +.PP +.SH "General Options" +.PP +.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 (which can +be handy when tracing installation problems)\&. +.IP "\fB--environment=\fP\fIENVIRONMENT\fP" +Specify a ConTeXt +\fIENVIRONMENT\fP to use when processing the file\&. +This option can be useful when converting from +non-ConTeXt file formats where no environment or layout +settings are present in the file\&. +.IP "\fB--help\fP [ \fISWITCH\fP ]" +Produce a summary of switches +and arguments\&. Many switches have additional +information that can be seen by typing ``\f(CWtexexec +--help optvar(SWITCH)\fP\'\'\&. +.IP "\fB--interface=\fP\fILANGUAGE\fP" +Specify the language +\fBConTeXt\fP 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--once\fP" +Process a file once and only 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--output=\fP\fIDRIVER\fP" +Specify the output \fIDRIVER\fP +for use with \f(CW\especial\fP primitives\&. Defaults to the setting in +the local \fIcont-sys\&.tex\fP file, but can be set to one of +.IP +.RS +.IP "\fBpdftex\fP" +Native \fBpdftex\fP(1) code +.IP "\fBdvips\fP" +For \fBdvips\fP(1) (the default) +.IP "\fBdvipsone\fP" +For \fBdvipsone\fP +.IP "\fBdviwindo\fP" +For \fBdviwindo\fP, the oldest +\fBConTeXt\fP drivers +.IP "\fBdviview\fP" +For \fBdviview\fP (experimental) +.IP +.RE +.IP +There may be other supported drivers -- check the most +recent \fBConTeXt\fP documentation\&. +.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; one or more pages separated by commas +(\f(CWx,y\fP); or a page range in the form \f(CW:z\fP\&. +.IP "\fB--passon=\fP\fISTRING\fP" +Pass additional command-line +switches and arguments to the \fBtex\fP(1) process +run by \fBtexexec\fP\&. +.IP +For example, the \fBMikTeX\fP TeX system (for +DOS/Windows) can embed information in the DVI file that +will allow you to find the line in a source code file +corresponding to the line in the typeset output\&. It +uses a switch called ``--src\'\' to activate this +functionality, and can be used from \fBtexexec\fP as +.IP +.EX +\f(CWtexexec --passon="--src" somefile\fP +.EE +.IP +The double quotes (\f(CW"\fP) are required to prevent +\fBtexexec\fP from using the switch itself\&. +.IP "\fB--program\fP" +The name of the TeX program to use +(\fBtex\fP(1), by default)\&. +.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--silent\fP" +Suppress diagnostic and progress messages\&. +.IP "\fB--suffix=\fP\fISUFFIX\fP" +Specify the suffix of the output file\&. +.IP "\fB--tex=\fP\fIPROGRAMNAME\fP" +Allows you specify the program +to use instead of \fBtex\fP(1)\&. Useful for trying +different versions of \fBtex\fP(1) installed on the +same machine\&. +.IP "\fB--texutil\fP" +Force a run of \fBtexutil\fP(1)\&. +.IP "\fB--verbose\fP" +Output diagnostic information, including the +contents of \fItexexec\&.ini\fP\&. +.IP +.PP +.SH "Processing \fBConTeXt\fP Source Files" +.PP +Including specifying paper sizes, formats, and so forth\&. +.PP +.IP "\fB--arrange\fP" +Don\'t perform page rearrangements (e\&.g\&., for +producing a booklet) until the last run\&. +.IP "\fB--batch\fP" +Process the file in batch mode -- continue to +typeset the document after finding errors\&. More +imformation about batch mode can be found in Donald +E\&. Knuth\'s \fITeXbook\fP\&. +.IP "\fB--bodyfont\fP" +The name of a font to preload for use in +setting the body of the text\&. +.IP "\fB--centerpage\fP" +Center the document image 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--dvi\fP" +Shortcut for \fB--output=dvi\fP\&. +.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" +Allows you to change the mode +(page size and resolution) of the output file\&. +.IP +.EX +\f(CWtexexec --pdf --mode=A4 --result=pdftex-a pdftex-t\fP +\f(CWtexexec --pdf --mode=letter --result=pdftex-l pdftex-t\fP +\f(CWtexexec --pdf --mode=screen --result=pdftex-s pdftex-t\fP +.EE +.IP +Here the mode switch tells \fBConTeXt\fP to obey +the mode directives in the layout specifications\&. The +\fB--result\fP flag allows you to +rename the output file\&. +.IP "\fB--noarrange\fP" +Ignore arrangement commands in the source +file\&. +.IP "\fB--paper=\fP\fIKEY\fP" +For typesetting multiple pages on a +single piece of paper\&. \fIKEY\fP can be \fBa4a3\fP +(for printing A4 pages on A3 paper) or \fBa5a4\fP +(for printing A5 pages on A4 paper)\&. The actual layout +of the pages is specified with the +\fB--print\fP switch\&. +.IP "\fB--pdf\fP" +Shorthand for \fB--output=pdftex\fP\&. +.IP "\fB--print=\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 +--paper switch to specify the original page +and sheet size\&. +.IP +.PP +.SH "Creating \fBConTeXt\fP Format Files" +.PP +.IP "\fB--format=\fP\fIFORMATFILE\fP" +Specify a \fIFORMATFILE\fP +to use when typesetting\&. \fBtexexec\fP will prepend the +string \f(CWcont- \fP to the name you give, so you can +type \f(CWplain\fP instead of \f(CWcont-plain\fP, as in +.IP +.EX +\f(CWtexexec --format=plain --program=pdftex somefile\fP +.EE +.IP "\fB--make\fP" +Generate a \fBConTeXt\fP format file\&. +.PP +.SH "Postprocess PDF Files" +.PP +.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\&. +.IP +.EX +\f(CWtexexec --pdfarrange --paper=a5a4 --print=up foo\&.pdf\fP +.EE +.IP +This command creates an A5 booklet from a PDF file +\fIfoo\&.pdf\fP\&. \fB--pdfarrange\fP is used in +conjunction with the following switches: +.IP "\fB--paperoffset\fP" +Adjust the space between the +edge of the pages and the beginning of the text block\&. +.IP "\fB--backspace\fP" +Adjust the inside (``gutter\'\') +margins\&. +.IP "\fB--topspace\fP" +Adjust 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 \fBConTeXt\fP to adjust +the page layout for double-sided output, producing much +more attractive results\&. +.IP +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\&. +.IP +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 you to +specify the +\fB--combination\fP +switch\&. +.IP "\fB--pdfselect\fP" +Extract pages from a file\&. Use in combination with +the \fB--selection\fP switch, as +in +.IP +.RS +\f(CWtexexec --pdfselect --paper=S6 +--selection=1,9,14 file-1\fP +.RE +.IP +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)\&. +.IP +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\&. +.PP +.SH "Extract or Strip Out Documentation" +.PP +.IP "\fB--listing\fP" +Produce a typeset version of the source code in +\fIFILE\fP\&. You can specify the form of the output +file, as in +.RS +\f(CWtexexec --listing --pdf readme\&.now\fP +.RE +.IP +which will produce a PDF file called +\fItexexec\&.pdf\fP\&. Without the +\fB--pdf\fP flag, \fBtexexec\fP will +produce a DVI file\&. +.IP +See also \fB--backspace\fP and +\fB--topspace\fP\&. +.IP "\fB--module\fP" +Create documentation for \fBConTeXt\fP, +\fBMetaPost\fP (see \fBmpost\fP(1)), and Perl modules\&. +Converts the documentation to \fBConTeXt\fP format and +then typesets that documentation\&. See +\fBtexutil\fP(1) for more information about the +format of the documentation strings\&. +.PP +.SH "Process METAPOST Figures" +.PP +.IP "\fB--mpformat\fP" +The name of a \fBMetaPost\fP format file\&. +.IP "\fB--mptex\fP" +Strips out and typesets TeX code embedded in a +\fBMetaPost\fP file\&. +.IP "\fB--nomp\fP" +Do not run \fBMetaPost\fP, even if needed\&. +.IP "\fB--nomprun\fP" +Do not run \fBmpost\fP(1) on embedded +\fBMetaPost\fP code\&. +.PP +.SH "Producing Proof Sheets of Figures" +.PP +.IP "\fB--figures=\fP\fIALTERNATIVE\fP" +Specify one of three +options to produce a document containing the images +used in the source file: +.IP +.RS +.IP "\fBa\fP" +A proof sheet with additional +information provided for each figure +.IP "\fBb\fP" +A proof sheet with the graphics only +.IP "\fBc\fP" +One figure per page, with the page +clipped to the bounding box of the +figure +.IP +See also \fB--paperoffset\fP, +which allows you to specify an offset to be added to +the page, as in +.IP +.EX +\f(CWtexexec --figures=c --paperoffset=\&.5cm *\&.pdf +*\&.png *\&.jpg\fP +.EE +.IP +.RE +.IP +\fBtexexec\fP uses \fBtexutil\fP(1) to obtain the list +of figures to process\&. +.PP +.SH "USAGE" +.PP +.IP o +Each \fBConTeXt\fP 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: +.IP +.EX +\f(CWtexexec --make en nl\fP +.EE +.IP +By default, the language used for typesetting matches the +user-interface language (set with +\fB--interface\fP\&. It\'s possible to use one +language for typesetting and another for messages by changing the +relevant settings in \fIcont-usr\&.tex\fP, but these languages can +also be changed on the command line with a command such as +.IP +.RS +\f(CWtexexec --make --language=pl,cz,sk --bodyfont=plr en\fP +.RE +.IP +That command generates a \fBConTeXt\fP format file with an English user +interface, and the main language set to Polish (\fBpl\fP)\&. The +default body font is the Polish version of Computer Modern Roman +(\fBplr\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 +.IP +.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=pdfetex 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 DVI file\&. The +\fB--pdf\fP flag tells \fBtexexec\fP to produce a PDF +file, instead (by running \fBpdftex\fP(1))\&. You can also be more +specific about what drivers \fBtexexec\fP should use, by specifying a +command line such as +.IP +.EX +\f(CWtexexec --output=dvips,acrobat test\fP +.EE +.IP +which specifies the use of the \fBdvips\fP driver (which is the +default), combined with the use of Acrobat-specific PDF instructions\&. +.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 "INITIALIZATION" +.IP +When starting, \fBtexexec\fP first looks for the file +\fItexexec\&.ini\fP, which specifies the location of various +programs and configuration files, and specifies the programs to use\&. +The \fB--verbose\fP flag causes \fBtexexec\fP to print +the information in \fItexexec\&.ini\fP to the terminal and the log +file\&. +.IP +\fBtexexec\fP requires Perl\&. On Unix and Unix-like systems, no special +steps have to be taken to get \fBtexexec\fP to work beyond installing +Perl and having the \fBperl\fP(1) binary in your path\&. On Windows +systems, however, you may need to run Perl by typing commands such as +``\f(CWperl texexec\&.pl optvar(ARGS)\fP\'\'\&. +.IP +The \fBfpTeX\fP distribution comes with a program called +\fBrunperl\&.exe\fP that can be copied and renamed to \fBtexexec\&.exe\fP\&. +You will also have to rename a copy to \fBtexutil\&.exe\fP (see +\fBtexutil\fP(1))\&. The \fBteTeX\fP and \fBfpTeX\fP distributions, at +least, should perform the necessary steps as part of their +installation sequence -- if you have problems, however, you may need +to follow the advice given here\&. +.IP +The file \fItexexec\&.rme\fP contains default configuration +information\&. If no file \fItexexec\&.ini\fP exists (in +\fITEXMF/context/config/\fP, you should copy \fItexexec\&.rme\fP +to that directory and rename it to \fItexexec\&.ini\fP\&. Make any +necessary changes to this file to reflect the layout of programs and +directories on your system\&. +.SH "ENCODINGS" +.IP +Some languages require specific character encodings to represent their +alphabets (beyond the basic ASCII encoding)\&. Although you can use TeX +commands to represent these characters, such as ``\f(CW\e\&.z\fP\'\', it\'s +easier to use a text editor that includes direct support for these +characters and let \fBConTeXt\fP translate them to the necessary TeX +commands\&. For some languages, this approach can also improve the +performance of TeX\'s hyphenation algorithms\&. +.IP +\fBConTeXt\fP supports several of the most commonly used encodings\&. +Check the files beginning with \fIenco-\fP, \fIlang-\fP, and +\fIfont-\fP in the \fBConTeXt\fP distribution for more information\&. +.IP +\fBweb2c\fP distributions (such as \fBteTeX\fP) support a mechanism to +map document encodings to \fBConTeXt\fP\'s internal encoding, font +encodings, and hyphenation patterns\&. \fBtexexec\fP provides a document +option and a command-line flag to pass the necessary information to +\fBtex\fP(1) or \fBpdftex\fP(1)\&. You can add lines such as +.IP +.EX +\f(CW%& --translate-file=cp1250pl\fP +.EE +or +.IP +.EX +\f(CW% --translate=cp1250pl\fP +.EE +.IP +to the beginning of your document, or specify the \fB--translate\fP +flag on the command line, as +.IP +.EX +\f(CWtexexec --translate=il2pl somefile\fP +.EE +.IP +Note that using language-specific encodings will make your file less +portable than using ASCII\&. It may not be possible for other people to +typeset your documents on their systems\&. +.SH "FILES" +.IP +.IP "\fITEXMF/context/config/texexec\&.ini\fP" +TeXExec configuration file +.IP "\fITEXMF/context/config/texexec\&.rme\fP" +TeXExec configuration file defaults +.IP +.SH "SEE ALSO" +.IP +\fBbibtex\fP(1), \fBdvips\fP(1), \fBfmtutil\fP(1), +\fBmakeindex\fP(1), \fBmetapost\fP(1), \fBmpost\fP(1), +\fBpdfetex\fP(1), \fBpdfmerge\fP(1), \fBpdftex\fP(1), +\fBperl\fP(1), \fBpsnup\fP(1), \fBtex\fP(1), \fBtexshow\fP(1), +\fBtexutil\fP(1)\&. +.IP +The TeXExec manual, \fImtexexec\&.pdf\fP\&. +.IP +The TeXExec configuration README files: +.IP o +\fITEXMF/context/config/texexec\&.rme\fP +.IP o +\fITEXMF/context/perltk/texexec\&.rme\fP +.IP +Donald E\&. Knuth\'s \fIThe TeXbook\fP\&. +.SH "AUTHOR" +.IP +This manpage was written by Tobias Burnus +<burnus@gmx\&.de> and C\&.M\&. Connelly +<c@eskimo\&.com>\&. It is based on +the \fBTeXExec\fP manual written by Hans Hagen +<pragma@wxs\&.nl>\&. +.IP +The PDF manual and \fBtexexec\fP itself can be obtained from +<http://www\&.pragma-ade\&.com/pragma-ade/texexec\&.htm> diff --git a/Master/texmf/doc/man/man1/texfind.1 b/Master/texmf/doc/man/man1/texfind.1 new file mode 100644 index 00000000000..d9e88940cdf --- /dev/null +++ b/Master/texmf/doc/man/man1/texfind.1 @@ -0,0 +1,72 @@ +.TH "texfind" "1" "April 2004" "ConTeXt" "teTeX" +.PP +.SH "NAME" +texfind \- graphical tool to search for text in TeX input files +.PP +.SH "SYNOPSIS" +.PP +\fBtexfind\fP [ \fIOPTION\fP \&.\&.\&. ] +.PP +.SH "DESCRIPTION" +.PP +\fBtexfind\fP is a graphical, interactive tool that helps you +searching through TeX input files, including subdirectories, and +allows you to do search/replace tasks using Perl regular +expressions. It opens two windows: One displays the directory +hierarchy and allows to select different search directories. The +second window is used to enter the query and display the results. +.PP +.SH "SEARCHING" +.PP +Enter a search string in the input box at the top, choose the file +extension (*tex by default) and hit ENTER to start the search. The +results will be displayed below. +.PP +The search string is actually a perl regular expression. This gives +you lots of flexibility. The search-and-replace function also uses +Perl regex syntax, but you can also just use simple strings. Currently +there is no way to save changed files. +.PP +.SH "MENU" +.PP +Use the right mouse button to open a menu. +.HP +\fBFile\fP : Currently only used to exit the program +.HP +\fBEdit\fP : Copy selections, select or unselect all +.HP +\fBSearch\fP : Open a \fBFind\fP dialog that allows further searching +through the displayed results. The \fBReplace\fP option can be used to +replace single or all occurrences of a string, but currently it is not +possible to change the file. +.PP +\fBView\fP : Select specific lines, and adjust word or character +wrapping. +.PP +.SH "OPTIONS" +.HP +\fB\-\-font\fR : specify the font used for the menu. Default is +courier. +.HP +Other options probably exist - I appreciate input by the program +authors, experienced users or perl geeks. +.HP +.SH "SEE ALSO" +.IP +\fBperlre\fP(1) +.PP +.SH "BUGS" +.PP +None known\&. Well - the replace function isn't the most useful one. +.PP +.SH "AUTHOR" +.PP +\fBtexfind\fP was written for the ConTeXt package by Hans Hagen and +Ton Otten, PRAGMA\&. +.PP +This manual page was written by Frank Küster <frank@kuesterei\&.ch>, +for the Debian GNU/Linux system\&. It may be used and modified 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/doc/man/man1/texfont.1 b/Master/texmf/doc/man/man1/texfont.1 new file mode 100644 index 00000000000..692d5bcf3d9 --- /dev/null +++ b/Master/texmf/doc/man/man1/texfont.1 @@ -0,0 +1,84 @@ +.TH TEXFONT "1" "May 2004" "teTeX " "texfont.pdf" +.SH NAME +texfont \- font installation tool for ConTeXt +.PP +.SH "SYNOPSIS" +\fBtexfont\fP [ \fIOPTION\fP \&.\&.\&. ] +.PP +.SH DESCRIPTION +.PP +TeXFont is a perl script that helps to set up and install TeX fonts. +It was designed for use with ConTeXt, but may also be helpful for +users of other formats, like plain TeX or LaTeX. Its use is described +in detail in the files mtexfont.pdf and mfont.pdf. +.PP +.SH "OPTIONS" +.PP +.HP +\fB\-\-fontroot\fR=\fIpath\fR : texmf font root (automatically determined) +.HP +\fB\-\-sourcepath\fR=\fIpath\fR : when installing, copy from this path (default: .) +.HP +\fB\-\-sourcepath\fR=\fIauto\fR : locate and use vendor/collection +.HP +\fB\-\-vendor\fR=\fIname\fR : vendor name (first level directory) +.HP +\fB\-\-collection\fR=\fIname\fR : font collection (second level +directory) +.HP +\fB\-\-encoding\fR=\fIname\fR : encoding vector (default: texnansi) +.HP +\fB\-\-slant\fR=\fIs\fR : slant glyphs in font by factor (0.0 - 1.5) +.HP +\fB\-\-extend\fR=\fIs\fR : extend glyphs in font by factor (0.0 - 1.5) +.HP +\fB\-\-caps\fR=\fIs\fR : capitalize lowercase chars by factor (0.5 - 1.0) +.HP +\fB\-\-noligs\fR : remove ligatures +.HP +\fB\-\-install\fR : copy files from source to font tree +.HP +\fB\-\-listing\fR : list files on auto sourcepath +.HP +\fB\-\-remove\fR : remove files on auto sourcepath +.HP +\fB\-\-makepath\fR : when needed, create the paths +.HP +\fB\-\-test\fR : use test paths for vendor/collection +.HP +\fB\-\-show\fR : run tex on texfont.tex +.HP +\fB\-\-batch\fR : process given batch file +.HP +\fB\-\-weight\fR : multiple master weight +.HP +\fB\-\-width\fR : multiple master width +.HP +\fB\-\-expert\fR : also handle expert fonts +.HP +\fB\-\-help\fR : show some more info +.HP +.SH "SEE ALSO" +.PP +\fBtexexec\fP(1), \fBfontinst\fP(1), \fBtexshow\fP(1), +\fBtexutil\fP(1)\&. +.PP +The TeXFont manual, \fImtexfont\&.pdf\fP\& +.PP +The ConTeXt Font manual, \fImfonts\&.pdf\fP\& +.PP +The TeXExec manual, \fImtexexec\&.pdf\fP\&. +.PP +Donald E\&. Knuth\'s \fIThe TeXbook\fP\&. +.PP +.SH "AUTHOR" +.IP +This manual page was written by Frank Küster <frank@kuesterei\&.ch>, +for the Debian GNU/Linux system\&. It may be used and modified 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)\&. +.IP +The PDF manual and \fBtexfont\fP itself can be obtained from +<http://www\&.pragma-ade\&.com> diff --git a/Master/texmf/doc/man/man1/texhash.1 b/Master/texmf/doc/man/man1/texhash.1 new file mode 120000 index 00000000000..ac860c268d1 --- /dev/null +++ b/Master/texmf/doc/man/man1/texhash.1 @@ -0,0 +1 @@ +mktexlsr.1
\ No newline at end of file diff --git a/Master/texmf/doc/man/man1/texi2dvi.1 b/Master/texmf/doc/man/man1/texi2dvi.1 new file mode 100644 index 00000000000..41fae2f7d5e --- /dev/null +++ b/Master/texmf/doc/man/man1/texi2dvi.1 @@ -0,0 +1,95 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.33. +.TH TEXI2DVI "1" "February 2005" "texi2dvi 1.39" "User Commands" +.SH NAME +texi2dvi \- print Texinfo documents +.SH SYNOPSIS +.B texi2dvi +[\fIOPTION\fR]... \fIFILE\fR... +.SH DESCRIPTION +Run each Texinfo or LaTeX FILE through TeX in turn until all +cross-references are resolved, building all indices. The directory +containing each FILE is searched for included files. The suffix of FILE +is used to determine its language (LaTeX or Texinfo). +.PP +Makeinfo is used to perform Texinfo macro expansion before running TeX +when needed. +.SS "Operation modes:" +.TP +\fB\-b\fR, \fB\-\-batch\fR +no interaction +.TP +\fB\-c\fR, \fB\-\-clean\fR +remove all auxiliary files +.TP +\fB\-D\fR, \fB\-\-debug\fR +turn on shell debugging (set \fB\-x\fR) +.TP +\fB\-h\fR, \fB\-\-help\fR +display this help and exit successfully +.TP +\fB\-o\fR, \fB\-\-output\fR=\fIOFILE\fR +leave output in OFILE (implies \fB\-\-clean\fR); +Only one input FILE may be specified in this case +.TP +\fB\-q\fR, \fB\-\-quiet\fR +no output unless errors (implies \fB\-\-batch\fR) +.TP +\fB\-s\fR, \fB\-\-silent\fR +same as \fB\-\-quiet\fR +.TP +\fB\-v\fR, \fB\-\-version\fR +display version information and exit successfully +.TP +\fB\-V\fR, \fB\-\-verbose\fR +report on what is done +.SS "TeX tuning:" +.TP +-@ +use @input instead of \einput; for preloaded Texinfo +.TP +\fB\-e\fR, \fB\-E\fR, \fB\-\-expand\fR +force macro expansion using makeinfo +.TP +\fB\-I\fR DIR +search DIR for Texinfo files +.TP +\fB\-l\fR, \fB\-\-language\fR=\fILANG\fR +specify the LANG of FILE (LaTeX or Texinfo) +.TP +\fB\-p\fR, \fB\-\-pdf\fR +use pdftex or pdflatex for processing +.TP +\fB\-r\fR, \fB\-\-recode\fR +call recode before TeX to translate input characters +.TP +\fB\-t\fR, \fB\-\-command\fR=\fICMD\fR +insert CMD in copy of input file +.TP +or \fB\-\-texinfo\fR=\fICMD\fR +multiple values accumulate +.PP +The values of the BIBTEX, LATEX (or PDFLATEX), MAKEINDEX, MAKEINFO, +TEX (or PDFTEX), TEXINDEX, and THUMBPDF environment variables are used +to run those commands, if they are set. Any CMD strings are added +after @setfilename for Texinfo input, in the first line for LaTeX input. +.SH "REPORTING BUGS" +Email bug reports to <bug-texinfo@gnu.org>, +general questions and discussion to <help-texinfo@gnu.org>. +Texinfo home page: http://www.gnu.org/software/texinfo/ +.SH COPYRIGHT +Copyright \(co 2005 Free Software Foundation, Inc. +There is NO warranty. You may redistribute this software +under the terms of the GNU General Public License. +For more information about these matters, see the files named COPYING. +.SH "SEE ALSO" +The full documentation for +.B texi2dvi +is maintained as a Texinfo manual. If the +.B info +and +.B texi2dvi +programs are properly installed at your site, the command +.IP +.B info texi2dvi +.PP +should give you access to the complete manual. diff --git a/Master/texmf/doc/man/man1/texi2html.1 b/Master/texmf/doc/man/man1/texi2html.1 new file mode 100644 index 00000000000..d5f080f0301 --- /dev/null +++ b/Master/texmf/doc/man/man1/texi2html.1 @@ -0,0 +1,164 @@ +.TH TEXI2HTML 1 "4 February 2005" +.AT 3 +.SH NAME +texi2html \- a Texinfo to HTML converter +.SH SYNOPSIS +.B texi2html [options] file +.SH DESCRIPTION +.I Texi2html +converts the given Texinfo file to a set of HTML files. It tries to handle +most of the Texinfo commands. It creates hypertext links for cross-references, +footnotes... +.PP +.I Texi2html +may furthermore use latex2html to generate HTML (code and/or images) for @math +and @iftex tags (see the +.B \-\-l2h +option). +.PP +.I Texi2html +creates several files depending on the contents of the Texinfo file and on +the chosen options (see FILES). +.PP +The HTML files created by +.I texi2html +are closer to TeX than to Info. +.SH OPTIONS +Options may be abbreviated to th shortests unique prefix. The +following is only an incomplete list of the available options: +.TP 12 +.B \-\-help [1|2] +Print usage instructions and list the most important, all relevant, +or all recognised (including obsolete) command-line options, and exit. +.TP +.B \-\-ifinfo \-\-iftex \-\-ifxml \-\-ifplaintext \-\-ifhtml +Expand @ifinfo, @iftex and @tex, @ifxml and @xml, @ifplaintext, +@ifhtml and @html regions, and don't expand @ifnot +corresponding regions (default: ifhtml). +.TP +.B \-\-no\-ifinfo \-\-no\-iftex \-\-no\-ifxml \-\-no\-ifplaintext \-\-no\-html +Don't expand @ifinfo, @iftex, @ifxml, @ifplaintext regions and expand +@ifnot corresponding regions. +.TP +.B \-I \fIdir\fP +Append \fIdir\fP to the directory list searched for included files. +.TP +.B \-P \fIdir\fP +Prepend \fIdir\fP to the directory list searched for included files. +.TP +.B \-\-no\-menu +Don't show the Texinfo menus; by default they are shown. +.TP +.B \-\-no\-number +Don't number the sections. +.TP +.B \-\-split chapter|section|node +Split the output into several HTML files (one per main chapter/section or node). +.TP +.B \-\-l2h +Use latex2html for content of @math and @tex tags. Content must be such that +both, latex and tex, can translate it correctly. I.e., no tex-only constructs +must be used. +.TP +.B \-\-l2h\-l2h \fIprog\fP +Use \fIprog\fP as latex2html program (default \fIlatex2html\fP). +Program must be executable. +.TP +.B \-\-l2h\-init \fIfile\fP +Use \fIfile\fP as latex2html init file. \fIfile\fP should be used to specify in which way latex2html handles mathematical expressions and formulas. + +Note that latex2html locates +(and uses) init-files in the following order (provided they exist): +(1) global init file (usually in latex2html source dir) +(2) $HOME/.latex2html_init +(3) ./.latex2html_init +(4) init file given on command line. +.TP +.B \-\-l2h\-tmp \fIdir\fP +Use \fIdir\fP as tmp dir for latex2html. This directory (resp. its path) +must not contain a dot (i.e., a "."). +.TP +.B \-\-l2h\-clean +remove all intermediate files generated by latex2html (prevents caching!) +.TP +.B \-\-l2h\-skip +Do not really run latex2html. Use (kept) files of previous runs, instead. +.TP +.B \-\-Verbose +Give a verbose output. +.TP +.B \-\-version +Print version and exit. +.PP +.SH FILES +Initialisation options are read first from ${prefix}/etc/texi2html/Config +(the exact location being changeable with the +.RI --sysconfdir= dir +option to the configure script), then from $HOME/.texi2html/Config, +then any command-line options including \-\-init\-file options; +with later settings overriding earlier ones. +.P +By default +.I texi2html +my creates the following files (foo being the name of the Texinfo file): +.TP 16 +.B foo_toc.html +The table of contents (if @contents is present). +.TP +.B foo.html +The document's contents or the Top element. +.TP +.B foo_fot.html +The footnotes (if any). +.TP +.B foo_abt.html +An help section. +.TP +.B foo_l2h_img* +Images generated by latex2html (if any). +.PP +When used with the +.B \-\-split +option, it creates several files (one per chapter or node), named +.B foo_n.html +(n being the index of the chapter or node), and the +.B foo.html +file contains the Top element. +.PP +Otherwise it creates only one file: +.B foo.html +.SH VERSION +This is \fItexi2html\fP version 1.76, 4 February 2005. +.SH AUTHOR +Texi2html was originally written by is Lionel Cons, CERN IT/DIS/OSE, +Lionel.Cons@cern.ch. Over time, many other people around the net +contributed to this program. Its current maintainer is Olaf Bachmann, +obachman@mathematik.uni-kl.de. +.SH AVAILABILITY +The latest version of this program, as well as support in the form of mailing +lists with archives, bug tracking, documentation, and other tools can be found +at: + http://texi2html.cvshome.org/ +.SH COPYRIGHT +Copyright \(co 1999, 2000, 2003 Free Software Foundation, Inc. +There is NO warranty. You may redistribute this software +under the terms of the GNU General Public License. +For more information about these matters, see the file named COPYING. +.SH "SEE ALSO" +GNU Texinfo Documentation Format +.br +http://texinfo.org/ +.br +World Wide Web (WWW), +HyperText Markup Language (HTML) +.br +http://www.w3.org +.br +LaTeX2HTML +.br +http://www-dsed.llnl.gov/files/programs/unix/latex2html +.SH BUGS +This man-page is not up-to-date and there exists no up-to-date documentation, yet. +Until it exists, see the beginning of the texi2html.init file for remarks about +command-line options and configurations. +.ex diff --git a/Master/texmf/doc/man/man1/texi2pdf.1 b/Master/texmf/doc/man/man1/texi2pdf.1 new file mode 120000 index 00000000000..24af14aff5d --- /dev/null +++ b/Master/texmf/doc/man/man1/texi2pdf.1 @@ -0,0 +1 @@ +texi2dvi.1
\ No newline at end of file diff --git a/Master/texmf/doc/man/man1/texindex.1 b/Master/texmf/doc/man/man1/texindex.1 new file mode 100644 index 00000000000..732e12b8874 --- /dev/null +++ b/Master/texmf/doc/man/man1/texindex.1 @@ -0,0 +1,47 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.34. +.TH TEXINDEX "1" "December 2004" "texindex 4.8" "User Commands" +.SH NAME +texindex \- sort Texinfo index files +.SH SYNOPSIS +.B texindex +[\fIOPTION\fR]... \fIFILE\fR... +.SH DESCRIPTION +Generate a sorted index for each TeX output FILE. +Usually FILE... is specified as `foo.??' for a document `foo.texi'. +.SH OPTIONS +.TP +\fB\-h\fR, \fB\-\-help\fR +display this help and exit +.TP +\fB\-k\fR, \fB\-\-keep\fR +keep temporary files around after processing +.TP +\fB\-\-no\-keep\fR +do not keep temporary files around after processing (default) +.TP +\fB\-o\fR, \fB\-\-output\fR FILE +send output to FILE +.TP +\fB\-\-version\fR +display version information and exit +.SH "REPORTING BUGS" +Email bug reports to bug\-texinfo@gnu.org, +general questions and discussion to help\-texinfo@gnu.org. +Texinfo home page: http://www.gnu.org/software/texinfo/ +.SH COPYRIGHT +Copyright \(co 2004 Free Software Foundation, Inc. +There is NO warranty. You may redistribute this software +under the terms of the GNU General Public License. +For more information about these matters, see the files named COPYING. +.SH "SEE ALSO" +The full documentation for +.B texindex +is maintained as a Texinfo manual. If the +.B info +and +.B texindex +programs are properly installed at your site, the command +.IP +.B info texindex +.PP +should give you access to the complete manual. diff --git a/Master/texmf/doc/man/man1/texlinks.1 b/Master/texmf/doc/man/man1/texlinks.1 new file mode 100644 index 00000000000..d195b2c888e --- /dev/null +++ b/Master/texmf/doc/man/man1/texlinks.1 @@ -0,0 +1,65 @@ +.TH "texlinks" "8" "September 2000" "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--help\fP or \fB-h\fP" +show some help text +.IP "\fB--cnffile\fP \fIFILE\fP or \fB-f\fP \fIFILE\fP" +use +file as configuration file (default: +\fIfmtutil\&.cnf\fP) +.IP "\fB--verbose\fP or \fB-v\fP" +set verbose mode on (default: off) +.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 +.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 <tetex@dbs\&.uni-hannover\&.de> (mailing list)\&. +.PP +.SH "AUTHOR" +.PP +\fBtexlinks\fP was written by Thomas Esser +<te@dbs\&.uni-hannover\&.de> and is Copyright © 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/doc/man/man1/texshow.1 b/Master/texmf/doc/man/man1/texshow.1 new file mode 100644 index 00000000000..1fda1f952c8 --- /dev/null +++ b/Master/texmf/doc/man/man1/texshow.1 @@ -0,0 +1,69 @@ +.TH "texshow" "1" "Oct 2000" "ConTeXt" "CONTEXT" +.PP +.SH "NAME" +texshow \- ConTeXt command and parameter reference +.PP +.SH "SYNOPSIS" +\fBtexshow\fP [ \fIOPTION\fP ] [ \fICOMMAND\fP ] +[ \fILANGUAGE\fP ] +.PP +.SH "DESCRIPTION" +.PP +\fBtexshow\fP uses \fBperl\fP(1) and PerlTk (see \fBTk\fP(3pm)) to +show a overview of the commands and parameters of those\&. In the Tk +window you can search for a command and by switching the interface, +you can see the equivalent in another interface language\&. +.PP +\fICOMMAND\fP is a \fBConTeXt\fP command to search for in the +database\&. Note that Plain TeX commands are not (yet) in this database +although they can be used in \fBConTeXt\fP source files\&. +.PP +\fILANGUAGE\fP can be one of \fBcz\fP (Czech), \fBde\fP +(German), \fBen\fP (US-English) or \fBnl\fP (Dutch)\&. The default +language is Dutch\&. +.PP +You can also set the interface language with the +\fB--interface\fP switch\&. +.PP +.SH "OPTIONS" +.PP +.IP "\fB--help\fP" +Print a brief syntax summary +.IP "\fB--interface=\fP\fILANGUAGE\fP" +Primary interface language\&. +See DESCRIPTION for \fILANGUAGE\fP options\&. +.PP +.SH "FILES" +.PP +.IP "\fITEXMF/context/perltk/cont_mis\&.pm\fP" +Perl module for +formatting data +.IP "\fITEXMF/context/perltk/cont_set\&.pm\fP" +Perl module for +defining and constructing Tk interface +.IP "\fITEXMF/context/data/cont-\fIXX\fP\&.tws\fP" +The database +file\&. At this writing, \fIXX\fP can be one of \fBcz\fP (Czech), +\fBde\fP (German), \fBen\fP (English), \fBit\fP (Italian), or +\fBnl\fP (Dutch)\&. Which file is used is determined by the +\fILANGUAGE\fP specified on the command line\&. +.PP +.SH "SEE ALSO" +.PP +\fBtexexec\fP(1), \fBtexutil\fP(1), \fBpdfetex\fP(1), +\fBpdftex\fP(1)\&. +.PP +Web page: <http://www\&.pragma-ade\&.com/> +.PP +.SH "AUTHOR" +.PP +\fBtexshow\fP was written by Hans Hagen +<pragma@wxs\&.nl>\&. +.PP +This manpage was written by Tobias Burnus +<burnus@gmx\&.de> and C\&.M\&. Connelly +<c@eskimo\&.com>\&. +.PP +\fBtexshow\fP is part of \fBTeXWork\fP and \fBConTeXt\fP and is available +from <http://www\&.pragma-ade\&.com/pragma-ade/>\&. +.PP diff --git a/Master/texmf/doc/man/man1/texutil.1 b/Master/texmf/doc/man/man1/texutil.1 new file mode 100644 index 00000000000..5a6ea8d365e --- /dev/null +++ b/Master/texmf/doc/man/man1/texutil.1 @@ -0,0 +1,266 @@ +.TH TEXUTIL 1 UMFT +.de EX +.sp +.in +5 +.nf +.ft CW +.. +.de EE +.in -5 +.ft R +.sp +.fi +.. +.TH "texutil" "1" "October 2000" "ConTeXt" "CONTEXT" +.PP +.SH "NAME" +texutil \- ConTeXt auxiliary program +.PP +.SH "SYNOPSIS" +\fBtexutil\fP [ \fIOPTION\fP\&.\&.\&. ] \fIFILENAME\fP[\&.\&.\&.] +.PP +.SH "DESCRIPTION" +.PP +When processing a source file, \fBConTeXt\fP (via \fBtexexec\fP(1)) +saves information (including table of contents, tables of figures and +tables, index entries, cross-references) in a ``utility file\'\' called +\fIFILENAME\fP\fI\&.tui\fP\&. After each successful run, this +utility file is postprocessed by \fBtexutil\fP to organize the +information for the next run\&. +.PP +\fBtexutil\fP performs a number of useful functions: +.PP +.IP o +Postprocessing references, including sorting index and list +entries (with \fB--references\fP) +.IP o +Extracting documentation and other types of information from +\fBConTeXt\fP source files (with +\fB--documents\fP) +.IP o +Logfile analysis (with \fB--logfile\fP) +.IP o +Collecting information about graphic files to help with +typesetting (with \fB--figures\fP) +.IP o +Converting EPS files to a PDF format suitable for inclusion in +PDF files generated with \fBpdftex\fP(1) (with +--\fB--epspage\fP and +\fB--epstopdf\fP) +.PP +.SH "OPTIONS" +.PP +All switches are specified here in full, but can be abbreviated to the +shortest unique string\&. Thus, \fB--ver\fP works the same as +\fB--verbose\fP provided that there is no other flag beginning with +``\f(CWver\fP\'\'\&. +.PP +.SH "General Options" +.PP +.IP "\fB--help\fP" +Print a usage summary to stdout\&. +.IP "\fB--interface=\fP\fILANGUAGECODE\fP" +Specify the language for +messages\&. One of \fBen\fP (English), \fBde\fP (German), or +\fBnl\fP (Dutch)\&. The default language is English\&. +.IP "\fB--outputfile=\fP\fIFILENAME\fP" +Specify the name of the +output file\&. +.IP "\fB--purge\fP [ \fIBASENAME\fP ]" +Delete temporary files\&. +Specifying an optional \fIBASENAME\fP will only +affect the temporary files that begin with that +\fIBASENAME\fP\&. +.IP "\fB--silent\fP" +Redirects stdout to the \fIlog\fP file +(\fItexutil\&.log\fP, by default)\&. When used with +\fB--verbose\fP, a summary is printed to stdout, while +any other output is written to the \fIlog\fP file\&. +.IP +For example, +.IP +.EX +\f(CWtexutil --figures --silent --verbose somefile\&.png\fP +.EE +.IP +will output something like +.IP +.EX +\f(CWn=somefile\&.png t=png x=0bp y=0bp w=443bp h=591bp\fP +.EE +.IP +to stdout, placing other output into +\fItexutil\&.log\fP\&. This information can be piped +into another program for further processing\&. +.IP "\fB--type=\fP\fISUFFIX\fP" +Specify the \fISUFFIX\fP of the +file you want \fBtexutil\fP to process\&. +.IP "\fB--verbose\fP" +Print diagnostic messages to the screen\&. +.PP +.SH "Postprocessing References" +.PP +The \fB--references\fP flag instructs \fBtexutil\fP to process +information about cross-references, index entries, and other data +requiring more than one pass to process in the \fBConTeXt\fP utility +file\&. +.PP +Index and sorted list entries are sorted before being written out; +redundant index entries are removed\&. +.PP +\fBtexutil\fP is called automatically by \fBtexexec\fP(1) during its +processing runs unless you specify otherwise\&. \fBtexutil\fP can also +be run by hand, using the form +.PP +.EX +\f(CWtexutil --references\fP \fIFILENAME\fP +.EE +.PP +This command would cause \fBtexutil\fP to load the utility file +\fIFILENAME\fP\fI\&.tui\fP, sort and convert the contents of that +file, and write the results to \fIFILENAME\fP\fI\&.tuo\fP\&. +.PP +Options specific to this mode are: +.IP "\fB--ij\fP" +Sort ``\f(CWIJ\fP\'\' as ``\f(CWY\fP\'\'\&. Often used when +processing files written in Dutch\&. +.IP "\fB--high\fP" +Convert ``high\'\' ASCII values into equivalent TeX +commands\&. This switch is provided for backward +compatibility\&. +.IP "\fB--quotes\fP" +Take \fBtex\fP(1) accent commands into +consideration when sorting\&. (Otherwise, quotes are +considered to be boundary characters for strings\&.) +.IP "\fB--tcxpath=\fP\fIPATH\fP" +Specify path to \fItcx\fP +filter files for translating +between encodings\&. +.PP +.SH "Extracting Information from ConTeXt Source Files" +.PP +\fBConTeXt\fP source files often contain documentation (see +USAGE for more information about the format) or other +information that can be extracted by \fBtexutil\fP when called with the +\fB--documents\fP flag: +.PP +.EX +\f(CWtexutil --documents\fP \fIFILENAME\fP +.EE +.PP +This command produces a file called \fIFILENAME\fP\fI\&.ted\fP +from a ConTeXt file called \fIFILENAME\fP\fI\&.tex\fP\&. +.PP +The \fB--sources\fP flag does the opposite: Documentation lines are +stripped out of the output, which is written to a file called +\fIFILENAME\fP\fI\&.tes\fP\&. +.PP +Historically, \fBConTeXt\fP source files included other forms of +information -- such as syntax definitions, macro definitions, and +editor templates -- that can be extracted with the following flags: +.PP +.IP "\fB--infos\fP" +Extract TeXEdit macro information +(\fItex\fP->\fItud\fP -- see +USAGE) +.IP "\fB--setups\fP" +Extract \fBConTeXt\fP syntax definitions +(\fItex\fP->\fItexutil\&.tus\fP) +.IP "\fB--templates\fP" +Extract TeXEdit editor templates +(\fItex\fP->\fItud\fP) +.PP +.SH "Analyzing Log Files" +.PP +Calling \fBtexutil\fP with the \fB--logfile\fP option allows you to +extract information about problems with your \fBConTeXt\fP source file +from the log file produced during a \fBtexexec\fP(1) run\&. +.PP +You can specify what information \fBtexutil\fP should report with the +following options: +.IP "\fB--box\fP" +Extract information about overfull boxes\&. By +default, this flag will cause \fBtexedit\fP to report both +horizontal and vertical overfull boxes\&. If you\'re only +interested in one kind, you can specify \fB--hbox\fP or +\fB--vbox\fP instead\&. +.IP "\fB--criterium=\fP\fISIZE\fP" +Exclude reports about boxes that +are less than \fISIZE\fP points too large\&. +.IP "\fB--unknown\fP" +Extract messages about missing references or +figures\&. +.PP +.SH "Gathering Information about Figures" +.PP +The \fB--figures\fP flag tells \fBtexutil\fP to generate information +about one or more (non-EPS) graphics files for use in typesetting\&. +Called as, for example, +.PP +.EX +\f(CWtexutil --figures *\&.png *\&.tif\fP +.EE +.PP +\fBtexutil\fP will scan the current directory for PNG and TIFF files +and extract some useful information about their sizes and types\&. By +default, this information is stored in a file called +\fItexutil\&.tuf\fP, which is consulted by \fBConTeXt\fP when +typesetting a page with a non-EPS image file -- see the example given +for the \fB--silent\fP flag for an alternative\&. +.PP +This flag is especially useful when you plan to typeset a file of +previews of graphic files -- see the discussion of the +\fB--figures\fP flag in the \fBtexexec\fP(1) manpage\&. +.PP +.SH "Converting EPS Files for PDF Inclusion" +.PP +\fBtexutil\fP can also convert EPS files to PDF format for inclusion in +PDF files generated with \fBpdftex\fP(1) or \fBpdfetex\fP(1)\&. +.PP +.IP "\fB--epspage\fP" +Adjust the bounding box of an EPS file to the +dimensions of the output page\&. This option also removes some +redundant information and marks files as converted so that they +will not be affected by subsequent runs\&. +.IP "\fB--epstopdf\fP" +Calls \fBgs\fP(1) to convert the specified +EPS graphic files into PDF format\&. +.PP +.SH "USAGE" +.PP +.SH "Embedded Documentation Format" +.PP +Documentation lines included in \fBConTeXt\fP source files can be +specified by beginning lines with the following strings: +.IP "\f(CW%C\fP" +Copyright information +.IP "\f(CW%D\fP" +Documentation lines +.IP "\f(CW%I\fP" +TeXEdit information lines (mostly in Dutch) +.IP "\f(CW%M\fP" +Macro code needed to processs the documentation +.IP "\f(CW%S\fP" +``Suppressed\'\' lines +.PP +The same forms can be used for Perl scripts, except that the +``\f(CW%\fP\'\' characters are replaced by ``\f(CW#\fP\'\' characters\&. See +the source for \fBtexutil\fP for an example\&. +.PP +.SH "SEE ALSO" +.PP +\fBgs\fP(1), \fBpdfetex\fP(1), \fBpdftex\fP(1), +\fBtexexec\fP(1), \fBtexshow\fP(1)\&. +.PP +Web page: <http://www\&.pragma-ade\&.com/> +.PP +.SH "AUTHOR" +.PP +This manpage was written by C\&.M\&. Connelly +<c@eskimo\&.com> and Tobias Burnus +<burnus@gmx\&.de>\&. It is based on +the \fBtexutil\fP manual written by Hans Hagen +<pragma@wxs\&.nl>\&. +.PP +The PDF manual and \fBtexutil\fP itself can be obtained at +<http://www\&.pragma-ade\&.com/pragma-ade/texutil\&.htm>\&. diff --git a/Master/texmf/doc/man/man1/tftopl.1 b/Master/texmf/doc/man/man1/tftopl.1 new file mode 100644 index 00000000000..8f66a461e1b --- /dev/null +++ b/Master/texmf/doc/man/man1/tftopl.1 @@ -0,0 +1,117 @@ +.TH TFTOPL 1 "17 December 1994" "Web2C 7.5.5" +.\"===================================================================== +.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 +[ +.BI \-charcode-format =format +] +[ +.B \-verbose +] +.I tfm_name[.tfm] +[ +.I pl_name[.pl] +] +.\"===================================================================== +.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 +.I .pl +if it lacks a suffix. +If +.I pl_name +is not given, standard output is used. Likewise, +.I tfm_name +is extended with +.I .tfm +if it lacks a suffix. Also, path searching is done for the +.I .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 +The argument +.I format +to +.B \-charcode-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 +Without the +.B \-verbose +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/doc/man/man1/thumbpdf.1 b/Master/texmf/doc/man/man1/thumbpdf.1 new file mode 100644 index 00000000000..d1d7e358f9a --- /dev/null +++ b/Master/texmf/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/doc/man/man1/tie.1 b/Master/texmf/doc/man/man1/tie.1 new file mode 100644 index 00000000000..13d132d8ed6 --- /dev/null +++ b/Master/texmf/doc/man/man1/tie.1 @@ -0,0 +1,39 @@ +.TH TIE 1L 9/24/92 +.SH NAME +tie \- merge or apply WEB change files +.SH SYNOPSIS +.B tie +.B \-c|\-m +.I outputfile masterfile changefile... + +.SH DESCRIPTION +The +.I 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). +.I Tie +can be used to either merge up to nine 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 +.I outputfile. +.SS OPTIONS +.TP +.B \-c +Create a single change file from the given +.I changefiles. +.TP +.B \-m +Create a new master file by applying the given +.I changefiles. +.SH "SEE ALSO" +.br +web(1), cweb(1l). +.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/doc/man/man1/ttf2afm.1 b/Master/texmf/doc/man/man1/ttf2afm.1 new file mode 100644 index 00000000000..7cf15df3ab0 --- /dev/null +++ b/Master/texmf/doc/man/man1/ttf2afm.1 @@ -0,0 +1,74 @@ +.TH "ttf2afm" "1" "September 2000" "pdfTeX" "pdfTeX" +.PP +.SH "NAME" +ttf2afm \- utility to generate AFM files for TrueType fonts +.PP +.SH "SYNOPSIS" +.PP +\fBttf2afm\fP [ \fIOPTION\fP\&.\&.\&. ] \fIFONTFILE\fP +.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/doc/man/man1/ttf2pk.1 b/Master/texmf/doc/man/man1/ttf2pk.1 new file mode 100644 index 00000000000..516a3081223 --- /dev/null +++ b/Master/texmf/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/doc/man/man1/ttf2pt1.1 b/Master/texmf/doc/man/man1/ttf2pt1.1 new file mode 100644 index 00000000000..86a36074b8c --- /dev/null +++ b/Master/texmf/doc/man/man1/ttf2pt1.1 @@ -0,0 +1,619 @@ +.rm #[ #] #H #V #F C +.SH "NAME" +TTF2PT1 \- A True Type to PostScript Type 1 Font Converter +.SH "SYNOPSIS" +\f(CWttf2pt1 \fI[-options] ttffont.ttf [Fontname]\fR\fR +.PP +or +.PP +\f(CWttf2pt1 \fI[-options] ttffont.ttf -\fR\fR +.SH "DESCRIPTION" +Ttf2pt1 is a font converter from the True Type format (and some other formats +supported by the FreeType library as well) to the Adobe Type1 format. +.PP +The versions 3.0 and later got rather extensive post-processing algorithm that +brings the converted fonts to the requirements of the Type1 standard, tries to +correct the rounding errors introduced during conversions and some simple +kinds of bugs that are typical for the public domain TTF fonts. It +also generates the hints that enable much better rendering of fonts in +small sizes that are typical for the computer displays. But everything +has its price, and some of the optimizations may not work well for certain +fonts. That's why the options were added to the converter, to control +the performed optimizations. +.SH "OPTIONS" +The first variant creates the file \f(CWFontname.pfa\fR (or \f(CWFontname.pfb\fR if the +option \*(L'\fB\-b\fR\*(R' was used) with the converted font and \f(CWFontname.afm\fR with the +font metrics, the second one prints the font or another file (if the option +\&\*(R'\fB\-G\fR\*(R' was used) on the standard output from where it can be immediately +piped through some filter. If no \f(CWFontname\fR is specified for the first +variant, the name is generated from \f(CWttffont\fR by replacing the \f(CW.ttf\fR +filename suffix. +.PP +Most of the time no options are neccessary (with a possible exception +of \*(L'\fB\-e\fR'). But if there are some troubles with the resulting font, they +may be used to control the conversion. +The \fBoptions\fR are: +.Ip "\(bu" 2 +\f(CW\fB-a\fR\fR \- Include all the glyphs from the source file into the converted +file. If this option is not specified then only the glyphs that have +been assigned some encoding are included, because the rest of glyphs +would be inaccessible anyway and would only consume the disk space. +But some applications are clever enough to change the encoding on +the fly and thus use the other glyphs, in this case they could +benefit from using this option. But there is a catch: the X11 library +has rather low limit for the font size. Including more glyphs increases +the file size and thus increases the chance of hitting this limit. +See \f(CWapp/X11/README\fR for the description of a +patch to X11 which fixes this problem. +.Ip "\(bu" 2 +\f(CW\fB-b\fR\fR \- Encode the resulting font to produce a ready \f(CW.pfb\fR file. +.Ip "\(bu" 2 +\f(CW\fB-d \fIsuboptions\fR\fR\fR \- Debugging options. The suboptions are: +.Sp +\f(CW\fBa\fR\fR \- Print out the absolute coordinates of dots in outlines. Such +a font can not be used by any program (that's why this option is +incompatible with \*(L'\fB\-e\fR') but it has proven to be a valuable debuging +information. +.Sp +\f(CW\fBr\fR\fR \- Do not reverse the direction of outlines. The \s-1TTF\s0 fonts have +the standard direction of outlines opposite to the Type1 fonts. So +they should be reversed during proper conversion. This option +may be used for debugging or to handle a \s-1TTF\s0 font with wrong +direction of outlines (possibly, converted in a broken way from +a Type1 font). The first signs of the wrong direction are the +letters like \*(L"P\*(R" or \*(L"B\*(R" without the unpainted \*(L"holes\*(R" inside. +.Ip "\(bu" 2 +\f(CW\fB-e\fR\fR \- Assemble the resulting font to produce a ready \f(CW.pfa\fR file. +.Sp +[ S.B.: Personally I don't think that this option is particularly useful. +The same result may be achieved by piping the unassembled data +through t1asm, the Type 1 assembler. And, anyways, it's good to +have the t1utils package handy. But Mark and many users think that +this functionality is good and it took not much time to add this option. ] +.Ip "\(bu" 2 +\f(CW\fB-F\fR\fR \- Force the Unicode encoding: any type of \s-1MS\s0 encoding specified +in the font is ignored and the font is treated like it has Unicode +encoding. \fB\s-1WARNING\s0:\fR this option is intended for buggy fonts +which actually are in Unicode but are marked as something else. The +effect on the other fonts is unpredictable. +.Ip "\(bu" 2 +\f(CW\fB-G \fIsuboptions\fR\fR\fR \- File generation options. The suboptions may be lowercase +or uppercase, the lowercase ones disable the generation of particular +files, the corresponding uppercase suboptions enable the generation of the +same kind of files. If the result of ttf2pt1 is requested to be printed on +the standard output, the last enabling suboption of \fB\-G\fR determines +which file will be written to the standard output and the rest of files +will be discarded. For example, \fB\-G A\fR will request the \s-1AFM\s0 file. +The suboptions to disable/enable the generation of the files are: +.Sp +\f(CW\fBf/F\fR\fR \- The font file. Depending on the other options this file +will have one of the suffixes \f(CW.t1a\fR, \f(CW.pfa\fR or \f(CW.pfb\fR. If the conversion result +is requested on the standard output ('\f(CW-\fR\*(R' is used as the output file name) +then the font file will also be written there by default, if not overwritten +by another suboption of \fB\-G\fR. +\fBDefault: enabled\fR +.Sp +\f(CW\fBa/A\fR\fR \- The Adobe font metrics file (\f(CW.afm\fR). +\fBDefault: enabled\fR +.Sp +\f(CW\fBe/E\fR\fR \- The dvips encoding file (\f(CW.enc\fR). +\fBDefault: disabled\fR +.Ip "\(bu" 2 +\f(CW\fB-l \fIlanguage\fR[+\fIargument\fR]\fR\fR \- Extract the fonts for the specified language from a +multi-language Unicode font. If this option is not used the converter +tries to guess the language by the values of the shell variable \s-1LANG\s0. +If it is not able to guess the language by \s-1LANG\s0 it tries all the +languages in the order they are listed. +.Sp +After the plus sign an optional argument for the language extractor +may be specified. The format of the argument is absolutely up to +the particular language converter. The primary purpose of the +argument is to support selection of planes for the multi-plane +Eastern encodings but it can also be used in any other way. The +language extractor may decide to add the plane name in some form +to the name of the resulting font. None of the currently supported +languages make any use of the argument yet. +.Sp +As of now the following languages are supported: +.Sp +\ \ \f(CWlatin1\fR \- for all the languages using the Latin-1 encoding +.Sp +\ \ \f(CWlatin2\fR \- for the Central European languages +.Sp +\ \ \f(CWlatin4\fR \- for the Baltic languages +.Sp +\ \ \f(CWlatin5\fR \- for the Turkish language +.Sp +\ \ \f(CWcyrillic\fR \- for the languages with Cyrillic alphabet +.Sp +\ \ \f(CWrussian\fR \- historic synonym for cyrillic +.Sp +\ \ \f(CWbulgarian\fR \- historic synonym for cyrillic +.Sp +\ \ \f(CWadobestd\fR \- for the AdobeStandard encoding used by TeX +.Sp +\ \ \f(CWplane+\fIargument\fR\fR \- to select one plane from a multi-byte encoding +.Sp +The argument of the \*(L"\f(CWplane\fR\*(R" language may be in one of three forms: +.Sp +\ \ \f(CWplane+\fBpid=\fR\fI<pid>\fR\fB,eid=\fR\fI<eid>\fR\fR +.Sp +\ \ \f(CWplane+\fBpid=\fR\fI<pid>\fR\fB,eid=\fR\fI<eid>\fR\fB,\fR\fI<plane_number>\fR\fR +.Sp +\ \ \f(CWplane+\fI<plane_number>\fR\fR +.Sp +Pid (\s-1TTF\s0 platform id) and eid (\s-1TTF\s0 encoding id) select a particular +\s-1TTF\s0 encoding table in the original font. They are specified as decimal +numbers. If this particular encoding table is not present in the font +file then the conversion fails. The native ("ttf") front-end parser supports +only pid=3 (Windows platform), the FreeType-based ("ft") front-end supports +any platform. If pid/eid is not specified then the \s-1TTF\s0 encoding table is +determined as usual: Unicode encoding if it's first or an 8-bit encoding +if not (and for an 8-bit encoding the plane number is silently ignored). +To prevent the converter from falling back to an 8-bit encoding, specify +the Unicode pid/eid value explicitly. +.Sp +Plane_number is a hexadecimal (if starts with \*(L"\fB0x\fR") or decimal number. +It gives the values of upper bytes for which 256 characters will be +selected. If not specified, defaults to 0. It is also used as a font +name suffix (the leading \*(L"0x\*(R" is not included into the suffix). +.Sp +\fB\s-1NOTE\s0:\fR +You may notice that the language names are not uniform: some are the +names of particular languages and some are names of encodings. This +is because of the different approaches. The original idea was to +implement a conversion from Unicode to the appropriate Windows +encoding for a given language. And then use the translation tables +to generate the fonts in whatever final encodings are needed. This +would allow to pile together the Unicode fonts and the non-Unicode +Windows fonts for that language and let the program to sort them out +automatically. And then generate fonts in all the possible encodings +for that language. An example of this approach is the Russian language +support. But if there is no multiplicity of encodings used for some +languages and if the non-Unicode fonts are not considered important +by the users, another way would be simpler to implement: just provide +only one table for extraction of the target encoding from Unicode +and don't bother with the translation tables. The latin* \*(L"languages\*(R" +are examples of this approach. If somebody feels that he needs the +Type1 fonts both in Latin-* and Windows encodings he or she is absolutely +welcome to submit the code to implement it. +.Sp +\fB\s-1WARNING\s0:\fR +Some of the glyphs included into the AdobeStandard encoding are not +included into the Unicode standard. The most typical examples of such +glyphs are ligatures like \*(L'fi\*(R', \*(L'fl\*(R' etc. Because of this the font +designers may place them at various places. The converter tries to +do its best, if the glyphs have honest Adobe names and/or are +placed at the same codes as in the Microsoft fonts they will be +picked up. Otherwise a possible solution is to use the option \*(L'\fB\-L\fR\*(R' +with an external map. +.Ip "\(bu" 2 +\f(CW\fB-L \fIfile\fR[+[pid=\fI<pid>\fR,eid=\fI<eid>\fR,][\fIplane\fR]]\fR\fR \- Extract the fonts for the specified +language from a multi-language font using the map from this file. This is +rather like the option \*(L'\fB\-l\fR\*(R' but the encoding map is not +compiled into the program, it's taken from that file, so it's +easy to edit. Examples of such files are provided in +\f(CWmaps/adobe-standard-encoding.map\fR, \f(CWCP1250.map\fR. (\fB\s-1NOTE\s0:\fR +the \*(L'standard encoding\*(R' map does not include all the glyphs of the +AdobeStandard encoding, it's provided only as an example.) The +description of the supported map formats is in the file +\f(CWmaps/unicode-sample.map\fR. +.Sp +Likewise to \*(L'\fB\-l\fR\*(R', an argument may be specified after the map file +name. But in this case the argument has fixed meaning: it selects the +original \s-1TTF\s0 encoding table (the syntax is the same as in \*(L'\fB\-l plane\fR') +and/or a plane of the map file. The plane name also gets added after dash +to the font name. The plane is a concept used in the Eastern fonts with big +number of glyphs: one \s-1TTF\s0 font gets divided into multiple Type1 fonts, +each containing one plane of up to 256 glyphs. But with a little +creativity this concept may be used for other purposes of combining +multiple translation maps into one file. To extract multiple planes +from a \s-1TTF\s0 font \f(CWttf2pt1\fR must be run multiple times, each time with +a different plane name specified. +.Sp +The default original \s-1TTF\s0 encoding table used for the option \*(L'\fB\-L\fR\*(R' is +Unicode. The map files may include directives to specify different original +\s-1TTF\s0 encodings. However if the pid/eid pair is specified with +it overrides any original encoding specified in the map file. +.Ip "\(bu" 2 +\f(CW\fB-m \fItype\fR=\fIvalue\fR\fR\fR \- Set maximal or minimal limits of resources. +These limits control the the font generation by limiting the resources +that the font is permitted to require from the PostScript interpreter. +The currently supported types of limits are: +.Sp +\f(CW\fBh\fR\fR \- the maximal hint stack depth for the substituted hints. +The default value is 128, according to the limitation in X11. This seems to +be the lowest (and thus the safest) widespread value. To display the +hint stack depth required by each glyph in a \f(CW.t1a\fR file use the script +\f(CWscripts/cntstems.pl\fR. +.Ip "\(bu" 2 +\f(CW\fB-O \fIsuboptions\fR\fR\fR \- Outline processing options. The suboptions +may be lowercase or uppercase, the lowercase ones disable the features, +the corresponding uppercase suboptions enable the same features. +The suboptions to disable/enable features are: +.Sp +\f(CW\fBb/B\fR\fR \- Guessing of the ForceBold parameter. This parameter helps +the Type1 engine to rasterize the bold fonts properly at small sizes. +But the algorithm used to guess the proper value of this flag makes +that guess based solely on the font name. In rare cases that may cause +errors, in these cases you may want to disable this guessing. +\fBDefault: enabled\fR +.Sp +\f(CW\fBh/H\fR\fR \- Autogeneration of hints. The really complex outlines +may confuse the algorithm, so theoretically it may be useful +sometimes to disable them. Although up to now it seems that +even bad hints are better than no hints at all. +\fBDefault: enabled\fR +.Sp +\f(CW\fBu/U\fR\fR \- Hint substitution. Hint substitution is a technique +permitting generation of more detailed hints for the rasterizer. It allows +to use different sets of hints for different parts of a glyph and change +these sets as neccessary during rasterization (that's why \*(L"substituted"). +So it should improve the quality of the fonts rendered at small sizes. +But there are two catches: First, the X11 library has rather low limit for +the font size. More detailed hints increase the file size and thus increase +the chance of hitting this limit (that does not mean that you shall hit it +but you may if your fonts are particularly big). This is especially +probable for Unicode fonts converted with option \*(L'\fB\-a\fR\*(R', so you may want to +use \*(L'\fB\-a\fR\*(R' together with \*(L'\fB\-Ou\fR\*(R'. See \f(CWapp/X11/README\fR for the description of +a patch to X11 which fixes this problem. Second, some rasterizers (again, +X11 is the typical example) have a limitation for total number of hints +used when drawing a glyph (also known as the hint stack depth). If that +stack overflows the glyph is ignored. Starting from version 3.22 \f(CWttf2pt1\fR +uses algorithms to minimizing this depth, with the trade-off of slightly +bigger font files. The glyphs which still exceed the limit set by option +\&\*(R'\fB\-mh\fR\*(R' have all the substituted hints removed and only base hints left. +The algorithms seem to have been refined far enough to make the fonts with +substituted hints look better than the fonts without them or at least the +same. Still if the original fonts are not well-designed the detailed +hinting may emphasize the defects of the design, such as non-even thickness +of lines. So provided that you are not afraid of the X11 bug the best idea +would be to generate a font with this feature and without it, then compare +the results using the program \f(CWother/cmpf\fR (see the description +in \f(CWother/README\fR) and decide which one looks better. +\fBDefault: enabled\fR +.Sp +\f(CW\fBo/O\fR\fR \- Space optimization of the outlines\*(R' code. This kind of optimization +never hurts, and the only reason to disable this feature is for comparison +of the generated fonts with the fonts generated by the previous versions of +converter. Well, it _almost_ never hurts. As it turned out there exist +some brain-damaged printers which don't understand it. Actually this +feature does not change the outlines at all. The Type 1 font manual +provides a set of redundant operators that make font description shorter, +such as \*(L'10 hlineto\*(R' instead of \*(L'0 10 rlineto\*(R' to describe a horizontal +line. This feature enables use of these operators. +\fBDefault: enabled\fR +.Sp +\f(CW\fBs/S\fR\fR \- Smoothing of outlines. If the font is broken in some +way (even the ones that are not easily noticeable), such smoothing +may break it further. So disabling this feature is the first thing to be +tried if some font looks odd. But with smoothing off the hint generation +algorithms may not work properly too. +\fBDefault: enabled\fR +.Sp +\f(CW\fBt/T\fR\fR \- Auto-scaling to the 1000x1000 Type1 standard matrix. The +\s-1TTF\s0 fonts are described in terms of an arbitrary matrix up to +4000x4000. The converted fonts must be scaled to conform to +the Type1 standard. But the scaling introduces additional rounding +errors, so it may be curious sometimes to look at the font in its +original scale. +\fBDefault: enabled\fR +.Sp +\f(CW\fBw/W\fR\fR \- Glyphs\*(R' width corection. This option is designed to be +used on broken fonts which specify too narrow widths for the +letters. You can tell that a font can benefit from this option +if you see that the characters are smashed together without +any whitespace between them. This option causes the converter +to set the character widths to the actual width of this character +plus the width of a typical vertical stem. But on the other hand +the well-designed fonts may have characters that look better if +their widths are set slightly narrower. Such well-designed fonts +will benefit from disabling this feature. You may want to convert +a font with and without this feature, compare the results and +select the better one. This feature may be used only on proportional +fonts, it has no effect on the fixed-width fonts. +\fBDefault: disabled\fR +.Ip "\(bu" 2 +\f(CW\fB-p \fIparser_name\fR\fR\fR \- Use the specified front-end parser to read the font file. +If this option is not used, ttf2pt1 selects the parser automatically based +on the suffix of the font file name, it uses the first parser in its +list that supports this font type. Now two parsers are supported: +.Sp +\ \ \f(CWttf\fR \- built-in parser for the ttf files (suffix \f(CW.ttf\fR) +.Sp +\ \ \f(CWbdf\fR \- built-in parser for the \s-1BDF\s0 files (suffix \f(CW.bdf\fR) +.Sp +\ \ \f(CWft\fR \- parser based on the FreeType-2 library (suffixes \f(CW.ttf\fR, +\&\f(CW.otf\fR, \f(CW.pfa\fR, \f(CW.pfb\fR) +.Sp +The parser \f(CWft\fR is \fB\s-1NOT\s0\fR linked in by default. See \f(CWMakefile\fR +for instructions how to enable it. We do no support this parser on +Windows: probably it will work but nobody tried and nobody knows how +to build it. +.Sp +The conversion of the bitmap fonts (such as \s-1BDF\s0) is simplistic yet, +producing jagged outlines. When converting such fonts, it might be +a good idea to turn off the hint substitution (using option \fB\-Ou\fR) +because the hints produced will be huge but not adding much to the +quality of the fonts. +.Ip "\(bu" 2 +\f(CW\fB-u \fInumber\fR\fR\fR \- Mark the font with this value as its +UniqueID. The UniqueID is used by the printers with the hard disks +to cache the rasterized characters and thus significantly +speed-up the printing. Some of those printers just can't +store the fonts without UniqueID on their disk.The problem +is that the \s-1ID\s0 is supposed to be unique, as it name says. And +there is no easy way to create a guaranteed unique \s-1ID\s0. Adobe specifies +the range 4000000-4999999 for private IDs but still it's difficult +to guarantee the uniqueness within it. So if you don't really need the +UniqueID don't use it, it's optional. Luckily there are a few millions of +possible IDs, so the chances of collision are rather low. +If instead of the number a special value \*(L'\f(CW\fBA\fR\fR\*(R' is given +then the converter generates the value of UniqueID automatically, +as a hash of the font name. (\fB\s-1NOTE\s0:\fR in the version 3.22 the +algorithm for autogeneration of UniqueID was changed to fit the values +into the Adobe-spacified range. This means that if UniqueIDs were used +then the printer's cache may need to be flushed before replacing the +fonts converted by an old version with fonts converted by a newer version). +A simple way to find if any of the fonts in a given directory have +duplicated UniqueIDs is to use the command: +.Sp +\f(CW\ \ cat *.pf[ab] | grep UniqueID | sort | uniq -c | grep -v ' 1 '\fR +.Sp +Or if you use \f(CWscripts/convert\fR it will do that for you automatically +plus it will also give the exact list of files with duplicate UIDs. +.Ip "\(bu" 2 +\f(CW\fB-v \fIsize\fR\fR\fR \- Re-scale the font to get the size of a typical uppercase +letter somewhere around the specified size. Actually, it re-scales +the whole font to get the size of one language-dependent letter to be +at least of the specified size. Now this letter is \*(L"A\*(R" in all the +supported languages. The size is specified in the points of the +Type 1 coordinate grids, the maximal value is 1000. This is an +experimental option and should be used with caution. It tries to +increase the visible font size for a given point size and thus make +the font more readable. But if overused it may cause the fonts to +look out of scale. As of now the interesting values of size for +this option seem to be located mostly between 600 and 850. This +re-scaling may be quite useful but needs more experience to +understand the balance of its effects. +.Ip "\(bu" 2 +\f(CW\fB-W \fIlevel\fR\fR\fR \- Select the verbosity level of the warnings. +Currently the levels from 0 to 4 are supported. Level 0 means no warnings +at all, level 4 means all the possible warnings. The default level is 3. +Other levels may be added in the future, so using the level number 99 is +recommended to get all the possible warnings. Going below level 2 is +not generally recommended because you may miss valuable information about +the problems with the fonts being converted. +.Ip "\(bu" 2 +\fBObsolete option:\fR +\f(CW\fB-A\fR\fR \- Print the font metrics (.afm file) instead of the font on \s-1STDOUT\s0. +Use \fB\-\s-1GA\s0\fR instead. +.Ip "\(bu" 2 +\fBVery obsolete option:\fR +.Sp +The algorithm that implemented the forced fixed width had major +flaws, so it was disabled. The code is still in the program and +some day it will be refined and returned back. Meanwhile the +option name \*(L'\fB\-f\fR\*(R' was reused for another option. The old version was: +.Sp +\f(CW\fB-f\fR\fR \- Don't try to force the fixed width of font. Normally the converter +considers the fonts in which the glyph width deviates by not more +than 5% as buggy fixed width fonts and forces them to have really +fixed width. If this is undesirable, it can be disabled by this option. +.PP +The \f(CW.pfa\fR font format supposes that the description of the characters +is binary encoded and encrypted. This converter does not encode or +encrypt the data by default, you have to specify the option \*(L'\fB\-e\fR\*(R' +or use the \f(CWt1asm\fR program to assemble (that means, encode and +encrypt) the font program. The \f(CWt1asm\fR program that is included with +the converter is actually a part of the \f(CWt1utils\fR package, rather old +version of which may be obtained from +.PP +http://ttf2pt1.sourceforge.net/t1utils.tar.gz +.PP +Note that \f(CWt1asm\fR from the old version of that package won't work properly +with the files generated by \f(CWttf2pt1\fR version 3.20 and later. Please use +\f(CWt1asm\fR packaged with \f(CWttf2pt1\fR or from the new version \f(CWt1utils\fR +instead. For a newer version of \f(CWt1utils\fR please look at +.PP +http://www.lcdf.org/~eddietwo/type/ +.SH "EXAMPLES" +So, the following command lines: +.PP +\f(CWttf2pt1 -e ttffont.ttf t1font\fR +.PP +\f(CWttf2pt1 ttffont.ttf - | t1asm >t1font.pfa\fR +.PP +represent two ways to get a working font. The benefit of the second form +is that other filters may be applied to the font between the converter +and assembler. +.SH "FILES" +.Ip "\(bu" 2 +\s-1TTF2PT1_LIBXDIR/\s0t1asm +.Ip "\(bu" 2 +\s-1TTF2PT1_SHAREDIR\s0/* +.Ip "\(bu" 2 +\s-1TTF2PT1_SHAREDIR/\s0scripts/* +.Ip "\(bu" 2 +\s-1TTF2PT1_SHAREDIR/\s0other/* +.Ip "\(bu" 2 +\s-1TTF2PT1_SHAREDIR/README\s0 +.Ip "\(bu" 2 +\s-1TTF2PT1_SHAREDIR/FONTS\s0 +.SH "SEE ALSO" +.Ip "\(bu" 4 +the \fIttf2pt1_convert(1)\fR manpage +.Ip "\(bu" 4 +the \fIttf2pt1_x2gs(1)\fR manpage +.Ip "\(bu" 4 +the \fIt1asm(1)\fR manpage +.Ip "\(bu" 4 +ttf2pt1-announce@lists.sourceforge.net +.Sp +The mailing list with announcements about ttf2pt1. It is a moderated mailing +with extremely low traffic. Everyone is encouraged to subscribe to keep in +touch with the current status of project. To subscribe use the Web interface +at http://lists.sourceforge.net/mailman/listinfo/ttf2pt1-announce. +If you have only e-mail access to the Net then send a subscribe request to +the development mailing list ttf2pt1-devel@lists.sourceforge.net and somebody +will help you with subscription. +.Ip "\(bu" 4 +ttf2pt1-devel@lists.sourceforge.net +.Sp +ttf2pt1-users@lists.sourceforge.net +.Sp +The ttf2pt1 mailing lists for development and users issues. They have not +that much traffic either. To subscribe use the Web interface at +http://lists.sourceforge.net/mailman/listinfo/ttf2pt1-devel +and http://lists.sourceforge.net/mailman/listinfo/ttf2pt1-users. +If you have only e-mail access to the Net then send a subscribe request to +the development mailing list ttf2pt1-devel@lists.sourceforge.net and somebody +will help you with subscription. +.Ip "\(bu" 4 +http://ttf2pt1.sourceforge.net +.Sp +http://www.netspace.net.au/~mheath/ttf2pt1/ +.Sp +The primary copies of the main page of the project. +.SH "BUGS" +It seems that many Eastern fonts use features of the TTF format that are +not supported by the ttf2pt1's built-in front-end parser. Because of +this for now we recommend using the FreeType-based parser (option +\&\*(R'\fB\-p ft\fR') with the \*(L"\f(CWplane\fR\*(R" language. +.Sh "Troubleshooting and bug reports" +Have problems with conversion of some font ? The converter dumps core ? Or your +printer refuses to understand the converted fonts ? Or some characters are +missing ? Or some characters look strange ? +.PP +Send the bug reports to the ttf2pt1 development mailing list at +ttf2pt1-devel@lists.sourceforge.net. +.PP +Try to collect more information about the problem and include it into +the bug report. (Of course, even better if you would provide a ready +fix, but just a detailed bug report is also good). Provide detailed +information about your problem, this will speed up the response greatly. +Don't just write \*(L"this font looks strange after conversion\*(R" but describe +what's exactly wrong with it: for example, what characters look wrong +and what exactly is wrong about their look. Providing a link to the +original font file would be also a good idea. Try to do a little +troublehooting and report its result. This not only would help with +the fix but may also give you a temporary work-around for the bug. +.PP +First, enable full warnings with option \*(L'\fB\-W99\fR\*(R', save them to +a file and read carefully. Sometimes the prolem is with a not implemented +feature which is reported in the warnings. Still, reporting about such +problems may be a good idea: some features were missed to cut corners, +in hope that no real font is using them. So a report about a font using +such a feature may motivate someone to implement it. Of course, you +may be the most motivated person: after all, you are the one wishing +to convert that font. ;\-) Seriously, the philosophy \*(L"scrath your own itch\*(R" +seems to be the strongest moving force behind the Open Source software. +.PP +The next step is playing with the options. This serves a dual purpose: +on one hand, it helps to localize the bug, on the other hand you may be +able to get a working version of the font for the meantime while the +bug is being fixed. The typical options to try out are: first \*(L'\fB\-Ou\fR\*(R', if +it does not help then \*(L'\fB\-Os\fR\*(R', then \*(L'\fB\-Oh\fR\*(R', then \*(L'\fB\-Oo\fR\*(R'. +They are described in a bit more detail above. Try them one by one +and in combinations. See if with them the resulting fonts look better. +.PP +On some fonts ttf2pt1 just crashes. Commonly that happens because the +font being converted is highly defective (although sometimes the bug +is in ttf2pt1 itself). In any case it should not crash, so the reports +about such cases will help to handle these defects properly in future. +.PP +We try to respond to the bug reports in a timely fashion but alas, this +may not always be possible, especially if the problem is complex. +This is a volunteer project and its resources are limited. Because +of this we would appreciate bug reports as detailed as possible, +and we would appreciate the ready fixes and contributions even more. +.SH "HISTORY" +Based on ttf2pfa by Andrew Weeks, and help from Frank Siegert. +.PP +Modification by Mark Heath. +.PP +Further modification by Sergey Babkin. +.PP +The Type1 assembler by I. Lee Hetherington with modifications by +Kai-Uwe Herbing. + +.rn }` '' +.IX Title "TTF2PT1 1" +.IX Name "TTF2PT1 - A True Type to PostScript Type 1 Font Converter" + +.IX Header "NAME" + +.IX Header "SYNOPSIS" + +.IX Header "DESCRIPTION" + +.IX Header "OPTIONS" + +.IX Item "\(bu" + +.IX Item "\(bu" + +.IX Item "\(bu" + +.IX Item "\(bu" + +.IX Item "\(bu" + +.IX Item "\(bu" + +.IX Item "\(bu" + +.IX Item "\(bu" + +.IX Item "\(bu" + +.IX Item "\(bu" + +.IX Item "\(bu" + +.IX Item "\(bu" + +.IX Item "\(bu" + +.IX Item "\(bu" + +.IX Item "\(bu" + +.IX Item "\(bu" + +.IX Header "EXAMPLES" + +.IX Header "FILES" + +.IX Item "\(bu" + +.IX Item "\(bu" + +.IX Item "\(bu" + +.IX Item "\(bu" + +.IX Item "\(bu" + +.IX Item "\(bu" + +.IX Header "SEE ALSO" + +.IX Item "\(bu" + +.IX Item "\(bu" + +.IX Item "\(bu" + +.IX Item "\(bu" + +.IX Item "\(bu" + +.IX Item "\(bu" + +.IX Header "BUGS" + +.IX Subsection "Troubleshooting and bug reports" + +.IX Header "HISTORY" + diff --git a/Master/texmf/doc/man/man1/ttf2tfm.1 b/Master/texmf/doc/man/man1/ttf2tfm.1 new file mode 100644 index 00000000000..a1edc31eaae --- /dev/null +++ b/Master/texmf/doc/man/man1/ttf2tfm.1 @@ -0,0 +1,1182 @@ +.\" 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 , \ \-N , \ \-p , +.BR \-r , \ \-R , \ \-t , +.BR \-T , \ \-u , \ \-v , \ \-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/doc/man/man1/ttfdump.1 b/Master/texmf/doc/man/man1/ttfdump.1 new file mode 100644 index 00000000000..e3916ecb211 --- /dev/null +++ b/Master/texmf/doc/man/man1/ttfdump.1 @@ -0,0 +1,124 @@ +.TH TTFDUMP 1 "18 Feb 1997" "ILX Project" +.SH NAME +ttfdump \- Dumping the contents of a TrueType Font file +.SH SYNOPSIS +\fBttfdump\fR [-h] [-t \fItablename\fP] [-g \fIglyphnumber\fP] [-c \fIcollection\fP] [-i] \fIttfile\fR [-o \fIdumpfile\fR] +.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 and 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 glhph 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 +.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-i\fI ttfile\fR +TrueType font file to be dumped. +.TP +\fB-o\fI dumpfile\fR +Output of the dump. If this option is not specified, dump to stdout. +.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 AOTHOR +Li-Da Lho, ollie@ms1.hinet.net diff --git a/Master/texmf/doc/man/man1/updmap-sys.1 b/Master/texmf/doc/man/man1/updmap-sys.1 new file mode 120000 index 00000000000..60ebe4f8025 --- /dev/null +++ b/Master/texmf/doc/man/man1/updmap-sys.1 @@ -0,0 +1 @@ +updmap.1
\ No newline at end of file diff --git a/Master/texmf/doc/man/man1/updmap.1 b/Master/texmf/doc/man/man1/updmap.1 new file mode 100644 index 00000000000..7ee7cbdf77f --- /dev/null +++ b/Master/texmf/doc/man/man1/updmap.1 @@ -0,0 +1,260 @@ +.TH "updmap" "1" "February 2005" "teTeX" "teTeX" +.PP +.SH "NAME" +updmap \- Update font map files for TeX output drivers\&. +.PP +updmap-sys \- Update font map files for TeX output drivers system\-wide\&. +.PP +.SH "SYNOPSIS" +.PP +\fBupdmap\fP [ \fIOPTION\fP \&.\&.\&. ] [ +\fICOMMAND\fP \&.\&.\&. ] +.PP +\fBupdmap-sys\fP [ \fIOPTION\fP \&.\&.\&. ] [ +\fICOMMAND\fP \&.\&.\&. ] +.PP +.SH "DESCRIPTION" +.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), \fBdvipdfm\fP(1) and (soon) \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 a single +source, allowing you to easily keep all the different configuration +files in sync\&. +.PP +\fBupdmap\fP reads a configuration file, \fBupdmap\&.cfg\fP(5) and, +depending on the options specified in that file and on the command +line, \fBupdmap\fP will write generated map files to a directory of +your choosing (via one of the \fB--*outputdir\fP options), or automatically +determine where to place the files\&. In the latter case, it tries to +use the tree where the variable TEXMFVAR points to. +When used with the options \fB--edit\fP, \fB--setoption\fP, +\fB--enable\fP, \fB--disable\fP, or \fB--syncwithtrees\fP, \fBupdmap\fP will first write +\fBupdmap\&.cfg\fP(5) and regenerate the map files only if this file +has been changed\&. +.PP +.SH "OPTIONS" +.PP +The following command-line options are available: +.IP +.IP "\fB--cnffile\fP \fIfile\fP" +Specify a configuration \fIfile\fP\&. +.IP +.IP "\fB--dvipsoutputdir\fP \fIdirectory\fP" +Specify the output +\fIdirectory\fP for map files generated with dvips syntax\&. +.IP +.IP "\fB--pdftexoutputdir\fP \fIdirectory\fP" +Specify the output +\fIdirectory\fP for map files generated with pdftex syntax\&. +.IP +.IP "\fB--dvipdfmoutputdir\fP \fIdirectory\fP" +Specify the output +\fIdirectory\fP for map files generated with dvipdfm syntax\&. +.IP +.IP "\fB--outputdir\fP \fIdirectory\fP" +Specify the output +\fIdirectory\fP for all generated map files\&. +.IP +.IP "\fB--nohash\fP" +Do not run \fBtexhash\fP(1)\&. +.IP +.IP "\fB--nomkmap\fP" +Do not recreate existing map files\&. +.IP +.IP "\fB--quiet\fP" +Reduce verbosity\&. +.IP +.PP +The following commands can be substituted for \fICOMMAND\fP: +.IP +.IP "\fB--edit\fP" +Edit the \fIupdmap\&.cfg\fP file\&. +.IP +.IP "\fB--help\fP" +Show a command and option summary\&. +.IP +.IP "\fB--showoptions\fP \fIitem\fP" +Show alternatives for option +\fIitem\fP\&. +.IP +.IP "\fB--setoption\fP \fIoption\fP \fIvalue\fP" +Set +\fIoption\fP to \fIvalue\fP, where \fIoption\fP is one of: +.IP "" +\fBdvipsPreferOutline\fP +.IP "" +\fBLW35\fP +.IP "" +\fBdvipsDownloadBase35\fP +.IP "" +\fBpdftexDownloadBase14\fP +.IP "" +\fBdvipdfmDownloadBase14\fP +.IP +.IP "\fB--enable\fP \fImaptype\fP \fImapfile\fP" +Add or enable a \fBMap\fP or \fBMixedMap\fP for \fImapfile\fP\&. +.IP +.IP "\fB--enable Map=\fImapfile\fP" +Add or enable a Map for \fImapfile\fP\&. +.IP +.IP "\fB--enable MixedMap=\fP\fImapfile\fP" +Add or enable a MixedMap for \fImapfile\fP\&. +.IP +.IP "\fB--disable\fP \fImapfile\fP" +Disable Map or MixedMap for \fImapfile\fP\&. +.IP +.IP "\fB--syncwithtrees\fP" +Disable entries in the config file that refer to map files which are +unavailable\&. +.IP +.IP "\fB--listmaps\fP" +List all active and inactive maps\&. +.IP +.IP "\fB--listavailablemaps\fP" +List all active and inactive maps, but restrict output to map files +that are available in one of the texmf trees\&. +.PP +.SH "FILES" +.PP +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\&. +.IP +.IP "\fIdvips35\&.map\fP" +Map file for standard 35 PostScript fonts for +use with \fBdvips\fP(1)\&. +.IP +.IP "\fIpdftex35\&.map\fP" +Map file for standard 35 PostScript fonts for +use with \fBpdftex\fP(1)\&. +.IP +.IP "\fIdvipdfm35\&.map\fP" +Map file for standard 35 PostScript fonts for +use with \fBdvipdfm\fP(1)\&. +.IP +.IP "\fIps2pk35\&.map\fP" +Map file for standard 35 PostScript fonts for +use with \fBps2pk\fP(1)\&. +.IP +.PP +Output files: +.IP +.IP "\fIpsfonts\&.map\fP" +For \fBdvips\fP(1)\&. +Soft link +against \fIpsfonts_t1\&.map\fP if option \fBdvipsPreferOutline\fP active, +else against \fIpsfonts_pk\&.map\fP. +.IP +.IP "\fIpsfonts_pk\&.map\fP" +For \fBdvips\fP(1)\&. +Without information from MixedMap files\&. +(Setting of \fBdvipsPreferOutline\fP ignored\&.) +.IP +.IP "\fIpsfonts_t1\&.map\fP" +For \fBdvips\fP(1)\&. +With information from MixedMap files\&. +(Setting of \fBdvipsPreferOutline\fP ignored\&.) +.IP +.IP "\fIdownload35\&.map\fP" +For \fBdvips\fP(1)\&. +Always downloads the standard 35 fonts\&. +(Setting of \fBdvipsDownloadBase35\fP ignored\&.) +.IP +.IP "\fIbuiltin35\&.map\fP" +For \fBdvips\fP(1)\&. +Never downloads the standard 35 fonts\&. +(Setting of \fBdvipsDownloadBase35\fP ignored\&.) +.IP +.IP "\fIpdftex\&.map\fP" +For \fBpdftex\fP(1)\&. +Soft link +against \fIpdftex_dl14\&.map\fP if option \fBpdftexDownloadBase14\fP active, +else against \fIpdftex_ndl14\&.map\fP. +.IP +.IP "\fIpdftex_dl14\&.map\fP" +For \fBpdftex\fP(1)\&. +Always downloads the standard 14 fonts\&. +.IP +.IP "\fIpdftex_ndl14\&.map\fP" +For \fBpdftex\fP(1)\&. +Never downloads the standard 14 fonts\&. +.IP +.IP "\fIdvipdfm\&.map\fP" +For \fBdvipdfm\fP(1)\&. +Soft link +against \fIdvipdfm_dl14\&.map\fP if option \fBdvipdfmDownloadBase14\fP active, +else against \fIdvipdfm_ndl14\&.map\fP. +.IP "\fIdvipdfm_dl14\&.map\fP" +For \fBdvipdfm\fP(1)\&. +Always downloads the standard 14 fonts\&. +.IP +.IP "\fIdvipdfm_ndl14\&.map\fP" +For \fBdvipdfm\fP(1)\&. +Never downloads the standard 14 fonts\&. +.IP +.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)\&. +.IP +.PP +teTeX configuration files for \fBdvips\fP(1) tuned for use with \fBupdmap\fP: +.IP +.IP "\fIconfig\&.builtin35\fP" +Loads \fIbuildin35\&.map\fP instead +of \fIpsfonts\&.map\fP\&. +.IP +.IP "\fIconfig\&.download35\fP" +Loads \fIdownload35\&.map\fP instead +of \fIpsfonts\&.map\fP\&. +.IP +.IP "\fIconfig\&.outline\fP" +Loads \fIpsfonts_t1\&.map\fP instead +of \fIpsfonts\&.map\fP\&. +.IP +.IP "\fIconfig\&.pdf\fP" +Loads \fIpsfonts_t1\&.map\fP instead +of \fIpsfonts\&.map\fP and has additional optimizations for PDF generation\&. +.IP +.IP "\fIconfig\&.pk\fP" +Loads \fIpsfonts_pk\&.map\fP instead +of \fIpsfonts\&.map\fP\&. +.IP +.IP "\fIconfig\&.www\fP" +Loads \fIpsfonts_t1\&.map\fP instead +of \fIpsfonts\&.map\fP\&. +(For compatibility with previous versions of teTeX\&.) +.IP +.IP "\fIconfig\&.gstopk\fP" +Loads \fIpsfonts_t1\&.map\fP instead +of \fIpsfonts\&.map\fP\&. +.IP +.PP +.SH "SEE ALSO" +.PP +\fBupdmap\&.cfg\fP(5), \fBdvipdfm\fP(1), \fBdvips\fP(1), +\fBgsftopk\fP(1), \fBpdftex\fP(1), \fBps2pk\fP(1), +\fBtexhash\fP(1), \fBxdvi\fP(1)\&. +.PP +Web page: \fI<http://tug\&.org/teTeX/>\fP +.PP +.SH "BUGS" +.PP +None known, but report any bugs found to <tetex@dbs\&.uni-hannover\&.de> (mailing list)\&. +.PP +.SH "AUTHOR" +.PP +\fBupdmap\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 +<cmc@debian\&.org>, for +the Debian GNU/Linux system and later slightly adapted for teTeX 3\&. diff --git a/Master/texmf/doc/man/man1/vftovp.1 b/Master/texmf/doc/man/man1/vftovp.1 new file mode 100644 index 00000000000..3306e1d8c66 --- /dev/null +++ b/Master/texmf/doc/man/man1/vftovp.1 @@ -0,0 +1,100 @@ +.TH VFTOVP 1 "19 December 1994" "Web2C 7.5.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 +.\"===================================================================== +.SH NAME +vftovp \- convert virtual font (vf) files to virtual property lists (vpl) +.SH SYNOPSIS +.B vftovp +[ +.BI \-charcode-format =format +] +[ +.B \-verbose +] +.I vf_name[.vf] +.I tfm_name[.tfm] +[ +.I vpl_name[.vpl] +] +.\"===================================================================== +.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 +The argument +.I format +to +.B \-charcode-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 +Without the +.B \-verbose +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/doc/man/man1/vlna.1 b/Master/texmf/doc/man/man1/vlna.1 new file mode 100644 index 00000000000..4bbe9f70ffc --- /dev/null +++ b/Master/texmf/doc/man/man1/vlna.1 @@ -0,0 +1,130 @@ +.\" $Id$ +.TH VLNA 1 "4. unora 1998" +.nh +.SH NAZEV +vlna \- pridani vlnek za neslabicne predlozky v TeXu +.SH POUZITI +.B vlna +[\fIvolby\fP] +[\fIsoubory\fP] +.SH POPIS +Program +.B vlna +pridava vlnky (misto puvodnich mezer) za neslabicne predlozky +ve vstupnich souborech pro TeX, coz zabrani zlomu radku v nezadoucich mistech. +.PP +Veskere aktivity programu je mozne vypnout sekvenci \fB%~-\fP a zapnout +sekvenci \fB%~+\fP (mezi uvedenymi znaky muze byt libovolne mnozstvi mezer). +.PP +Pred predlozkou se muze nachazet libovolne mnozstvi oteviracich zavorek, +pred kterymi se musi nachazet mezera nebo zacatek radku. Pred +oteviraci svorkou muze byt take misto mezery TeXova +\(lq\\sekvence\(rq (od verze 1.2). +Napr. za \(lq([{(V\(rq na pocatku radku bude vlnka pridana. +Stejne tak se text \(lq\\uv{V lese}\(rq promeni na +\(lq\\uv{V~lese}\(rq. +.PP +Program kontroluje konzistenci matematickych prostredi (neni-li uveden +parametr \fB\-m\fP). +Vstup do \fIdisplay\fP rezimu (\fB$$\fP) uvnitr \fItext\fP rezimu (\fB$\fP) +(napr. \fB$\fP...\fB$$\fP...\fB$\fP) znamena varovani a prechod do +\fIdisplay\fP. +Podobne prazdny radek uvnitr \fItext\fP nebo \fIdisplay\fP rezimu znamena +vypis varovani a prechod do nematematickeho (standardniho) rezimu. +Uvnitr rezimu \fIdisplay\fP se ignoruji vyskyty samostatneho znaku \fB$\fP, +jelikoz byva vetsinou soucasti konstrukce \fB\\hbox\fP. +.PP +Program kontroluje konzistenci verbatim rezimu na konci souboru. +Nebyl-li ukoncen, vypise se varovani. +Kontrola se neprovadi, pokud je pouzita volba \fB\-n\fP nebo \fB\-w\fP. +.PP +Program nedoplnuje vlnky za samostatna pismena, ktera jako predlozky vypadaji, +ale nasleduji bezprostredne za sekvencemi \fB\\TeX\fP nebo \fB\\LaTeX\fP. +Napr. do textu \(lq\fBVlastnosti \\TeX u jsou\fP\(rq nebude zadna vlnka +doplnena. +.SH VOLBY +Volby jsou nepovinne a mohou byt uvedeny v libovolnem poradi, ale nemohou +byt spojovany. +.TP +.B \-f +Filtr. Jmena souboru jsou interpretovana takto: +.RS +.TP 4 +.B vlna \-f \fIsoubor1 soubor2\fP +Vstup je \fIsoubor1\fP, vystup \fIsoubor2\fP. +.TP 4 +.B vlna \-f \fIsoubor1\fP +Vstup je \fIsoubor1\fP, vystup \fIstdout\fP. +.TP 4 +.B vlna \-f +Vstup je \fIstdin\fP, vystup \fIstdout\fP. +.TP 4 +\fBvlna\fP \fIsoubor1\fP [\fIsoubor2\fP [\fIsoubor3\fP ...]] +Neni-li uveden parametr \fB\-f\fP, kazdy soubor je zpracovavan samostatne. +.RE +.TP +.B \-s +Tichy rezim. Program potlaci vypis uvodni zpravy, varovnych zprav a +statistik o zmenach v souborech +(bez uvedeni parametru jsou zpravy vypisovany na \fIstderr\fP). +V tichem rezimu se vypise jen chyba, ktera predcasne ukonci +cinnost programu. +.TP +.B \-r +Nevytvaret (mazat) zalohy. +Parametr \fB\-r\fP nema vliv, pokud je uveden spolu s \fB\-f\fP. +V opacnem pripade se ke kazdemu souboru vytvari zaloha s vlnkou na konci jmena +a parametr \fB\-r\fP zpusobi, ze na konci zpracovani jsou tyto zalohy mazany. +.TP +.B \-v \fIznaky\fP +Znaky povazovane za neslabicne predlozky, za ktere ma byt pridavana +vlnka. Implicitni hodnota je \fB\-v\ KkSsVvZzOoUuAI\fP. (Mezi +\fB\-v\fP a skupinou znaku musi byt mezera.) +.TP +.B \-m +Ignorovani prechodu do matematickych prostredi +(\fB$\fP...\fB$\fP a \fB$$\fP...\fB$$\fP). +Parametr \fB\-m\fP zpusobi vlnkovani i v matematickych prostredich, ktera +se implicitne vynechavaji. +.TP +.B \-n +Ignorovani verbatim rezimu (\fB\\verb\fP\fI<znak>\fP...\fI<znak>\fP, +\fB\\begtt\fP...\fB\\endtt\fP). +Parametr \fB\-n\fP zpusobi vlnkovani i ve verbatim rezimu, ktery se +implicitne vynechava. +.TP +.B \-l +LaTeX. Pro rozpoznani matematickeho rezimu jsou pridana prostredi +\fB\\begin{display}\fP...\fB\\end{display}\fP a +\fB\\begin{equation}\fP...\fB\\end{equation}\fP. +Pro rozpoznani verbatim rezimu je pridano LaTeXove prostredi +\fB\\begin{verbatim}\fP...\fB\\end{verbatim}\fP. +.TP +.B \-w +Web. Pro rozpoznani verbatim rezimu jsou pridany sekvence +\fB@<\fP, \fB@d\fP...\fB@*\fP, \fB@\fP\fImezera\fP nebo \fB@>|\fP. +Ve zdrojovem kodu se tedy nevlnkuje program, ale jen komentare. +.SH PRIKLADY +.TP +.B vlna \-m \-n \-s \-r \fIsoubor\fP +Volani priblizne odpovida volani puvodniho programu \fBvlna\fP. +(Navic se neprovadi vlnkovani za sekvencemi \fB\\TeX\fP a \fB\\LaTeX\fP.) +.TP +.B vlna *.tex +Vlnkovani vsech souboru s priponou \fBtex\fP. +(Pouze na UNIXu.) +.TP +.B vlna \-f soubor > /dev/null +Test konzistence matematickeho a verbatim rezimu bez provedeni zmen. +(Pouze na UNIXu.) +.SH SOUBORY +.PD 0 +.TP +.I c:Program FilesTeXLivebinwin32/vlna +spustitelny program +.TP +.I c:Program FilesTeXLivetexmfdocman/vlna.1 +manualova stranka +.PD +.SH AUTOR +Petr Olsak <olsak@math.feld.cvut.cz>. Manualovou stranku a Makefile vytvoril Rulolf Cejka diff --git a/Master/texmf/doc/man/man1/vptovf.1 b/Master/texmf/doc/man/man1/vptovf.1 new file mode 100644 index 00000000000..3d85680e9ba --- /dev/null +++ b/Master/texmf/doc/man/man1/vptovf.1 @@ -0,0 +1,68 @@ +.TH VPTOVF 1 "16 December 1994" "Web2C 7.5.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 +.\"===================================================================== +.SH NAME +vptovf \- convert virtual property lists to virtual font metrics +.SH SYNOPSIS +.B vptovf +[ +.B \-verbose +] +.I vpl_name[.vpl] +.I vfm_name[.vf] +.I tfm_name[.tfm] +.\"===================================================================== +.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, +.I vpl_name, +.I vf_name, +and +.I 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/doc/man/man1/weave.1 b/Master/texmf/doc/man/man1/weave.1 new file mode 100644 index 00000000000..5837755e54d --- /dev/null +++ b/Master/texmf/doc/man/man1/weave.1 @@ -0,0 +1,77 @@ +.TH WEAVE 1 "4 May 1993" "Web2C 7.5.5" +.\"===================================================================== +.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 +[ +.B \-x +] +.I webfile[.web] +[ +.I changefile[.ch] +] +.\"===================================================================== +.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 +.I .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 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/doc/man/man1/xdvi.1 b/Master/texmf/doc/man/man1/xdvi.1 new file mode 100644 index 00000000000..8922ee1febe --- /dev/null +++ b/Master/texmf/doc/man/man1/xdvi.1 @@ -0,0 +1,4101 @@ +.\" 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 "2005/04/28" "Xdvik 22.84.10" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.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\-base\fP \fIbase URL\fP] +.\" [\fB\-bd\fP \fIcolor\fP] +[\fB\-bg\fP \fIcolor\fP] +[\fB\-browser\fP \fIWWWbrowser\fP] +[\fB\-bw\fP \fIwidth\fP] +[\fB\-bw\fP \fIwidth\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\-expertmode\fP \fIflag\fP] +[\fB\-fg\fP \fIcolor\fP] +[\fB\-findstring\fP \fIstring\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\-href\fP \fIanchor\fP] +[\fB\-hush\fP] +[\fB\-hushchars\fP] +[\fB\-hushchecksums\fP] +[\fB\-hushspecials\fP] +[\fB\-hushstdout\fP] +[\fB\-icongeometry\fP \fIgeometry\fP] +[\fB\-iconic\fP] +[\fB\-install\fP] +[\fB\-interpreter\fP \fIpath\fP] +[\fB\-keep\fP] +[\fB\-l\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 +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 \-bd " color" +.\" .RB ( .borderColor ) +.\" Determines the color of the window border. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-bg " color" +.RB ( .background ) +Determines the color of the background. +.\" .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\" .TP +.\" .BI \-bordercolor " color" +.\" Same as +.\" .BR -bd . +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-borderwidth " width" +.RB ( .borderWidth ) +Specifies the width of the border of the window. Same as +.BR -bw . +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.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: +.SB netscape -raise -remote "openURL(%s,new-window)":xterm -e lynx %s:xterm -e wget %s +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.BI \-bw " width" +.RB ( .borderWidth ) +Specifies the width of the border of the window. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.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 preferrable 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 +.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 \-href " 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 \-hushspecials +.RB ( .hushSpecials ) +Causes +.B xdvi +to suppress warnings about +.B \especial +strings that it cannot process. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.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 +.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 only honoured by the +.B up() +and +.B down() +actions, not by +.B up-or-previous() +and +.BR down-or-next() . +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B \-l +.RB ( .listFonts ) +List the names of all fonts used. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.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 mentined 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 unneccessary. +.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 encosed 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 occurences 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 +.RI ( 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 lables 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 issue warnings about +.B \especial +strings that it cannot process. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.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 or down. If set to zero, the wheel mouse functionality is 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 Delete " key" +.RB [ up-or-previous() ] +Moves down two-thirds of a window-full, or to the top of the previous page +if already at the bottom of the page. With a float argument, moves down the +corresponding fraction of a window-full. By default, the +.I Space +key is bound to the action +.B unpause-or-next() +which does a similar thing; see there. +.br +The `keep' flag is ignored by these actions. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.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 currenlty 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. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.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 ' +and +.BR Ctrl-h . +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.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 [ 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 the 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 ' +and +.BR Ctrl-h . +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.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 +.I 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 +.TP +.B Mouse-1 +.RB [ do-href()magnifier(*1) ] +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B Mouse-2 +.RB [ do-href-newwindow()magnifier(*2) ] +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, +.I 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 Mouse-3 +.RB [ magnifier(*3) ] +The actions +.B magnifier(n) +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 +In \fB`Ruler Mode'\fR, the first button moves or sets a ruler cross instead; +see the section +.BR MODES , +below, for details. +.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 Shift-Mouse-1 +.RB [ drag(+) ] +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B Shift-Mouse-2 +.RB [ drag(|) ] +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B Shift-Mouse-3 +.RB [ drag(-) ] +Drags the page with the mouse. Shift-Mouse 1 allows dragging in all directions, +Shift-Mouse 2 allows vertical dragging only, and Shift-Mouse 3 allows +horizontal dragging only. To access these actions via customization, use the +.B drag +action. This action should have one parameter, the character +.RB `` | '', +.RB `` - '', +or +.RB `` + '', +indicating vertical dragging, horizontal dragging, or dragging in both +directions. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.TP +.B Ctrl-Mouse-1 +.RB [ source-special() ] +Holding down the +.I Ctrl +key and clicking mouse button 1 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. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.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 +Ctrl<Btn1Down>: magnifier(*3)\en\e +Shift<Btn1Down>: magnifier(*2)\en\e +<Btn1Down>: magnifier(*1)\en +.sp 1n +.ft +.fi +.RE +.PP +Note: The additional `Modes' for Mouse-1 (Ruler Mode, Text Mode - see +the section +.BR MODES ) +only work if Mouse-1 has the magnifier() action bound to it. +.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 +Support of wheel mice is controlled by the +.B wheelTranslations +resource. Generally the only action routine called by this resource should be +.BR wheel . +The default value is +``\fB<Btn4Down>:wheel(-1.)\en<Btn5Down>:wheel(1.)\fR''. +Because this resource is implemented differently from the others, it should +not begin with +.RB ``#override ''; +when specifying a value for this resource, all wheel actions should be +included. +.\" #ifxaw +.\" NOTE: following is different with Motif, and will change for Xaw too ... +.\" removed for the time being. +.\" +.\" .PP +.\" The menu entries and actions may also be customized, in a similar manner. +.\" In this case the resource +.\" .B menuTranslations +.\" should consist of a string describing the pulldown menu names, submenu entries +.\" and the associated actions. Currently, only one level of submenus is provided for. +.\" The description consists of lines (substrings separated by the newline character +.\" `\fB\\n\fP'), +.\" where each line describes one menu entry. Each line consists of a colon-separated +.\" list containing the following elements: +.\" .RS 2 +.\" .TP 2 +.\" - +.\" the name of the menu; +.\" .TP +.\" - +.\" the name of the submenu; +.\" .TP +.\" - +.\" an accelerator for the action (the accelerator is currently not displayed in the menu, but it might be in future versions); +.\" .TP +.\" - +.\" one of the actions mentioned in the sections on KEYSTROKES above. +.\" .RE +.\" .PP +.\" Instead of a submenu and an action, an entry may also contain the string +.\" .RB `` SEP '' ; +.\" in this case, a separator line is inserted after the preceding menu entry. +.\" .PP +.\" The default value of this resource is as follows: +.\" .RS 5 +.\" .nf +.\" .ft 3 +.\" .sp 1n +.\" xdvi.menuTranslations: \e +.\" File:Open ...:Ctrl-o:select-dvi-file()\en\e +.\" File:Find ...:Ctrl-f:find()\en\e +.\" File:Reload:R:reread-dvi-file()\en\e +.\" File:Print ...:Ctrl-p:print()\en\e +.\" File:Save as ...::save()\en\e +.\" File:Quit:q:quit()\en\e +.\" Navigate:First:1 g:goto-page(1)\en\e +.\" Navigate:Page-10:10 p:back-page(10)\en\e +.\" Navigate:Page-5:5 p:back-page(10)\en\e +.\" Navigate:Prev:p:back-page(1)\en\e +.\" Navigate:SEP:\en\e +.\" Navigate:Next:n:forward-page(1)\en\e +.\" Navigate:Page+5:5 n:forward-page(5)\en\e +.\" Navigate:Page+10:10 n:forward-page(10)\en\e +.\" Navigate:Last:g:goto-page()\en\e +.\" Navigate:SEP:\en\e +.\" Navigate:Back Hyperlink:B:htex-back()\en\e +.\" Mark:Mark all:-1 m:toggle-mark(-1)\en\e +.\" Mark:Unmark all:0 m:toggle-mark(0)\en\e +.\" Mark:SEP:\en\e +.\" Mark:Toggle odd:1 m:toggle-mark(1)\en\e +.\" Mark:Toggle even:2 m:toggle-mark(2)\en\e +.\" Mark:Toggle current:m:toggle-mark()\en\e +.\" Zoom:Zoom in:Ctrl-+:set-shrink-factor(+)\en\e +.\" Zoom:Zoom out:Ctrl--:set-shrink-factor(-)\en\e +.\" Zoom:SEP:\en\e +.\" Zoom:Fit in window:s:set-shrink-factor(a)\en\e +.\" Zoom:SEP:\en\e +.\" Zoom:$#:1 s:set-shrink-factor(1)\en\e +.\" Zoom:$#:2 s:set-shrink-factor(2)\en\e +.\" Zoom:$#:3 s:set-shrink-factor(3)\en\e +.\" Zoom:$#:4 s:set-shrink-factor(4)\en\e +.\" Zoom:$#:5 s:set-shrink-factor(5)\en\e +.\" Zoom:$#:6 s:set-shrink-factor(6)\en\e +.\" Zoom:$#:7 s:set-shrink-factor(7)\en\e +.\" Zoom:$#:8 s:set-shrink-factor(8)\en\e +.\" Zoom:$#:9 s:set-shrink-factor(9)\en\e +.\" Options:View PS:1 v:set-ps(1)\en\e +.\" Options:View PS + bbox:2 v:set-ps(2)\en\e +.\" Options:No PS, bbox only:0 v:set-ps(0)\en\e +.\" Options:SEP:\en\e +.\" Options:Keep position:k:set-keep-flag(toggle)\en\e +.\" Options:SEP:\en\e +.\" Options:Fonts darker:Alt-Ctrl-+:change-density(25)\en\e +.\" Options:Fonts lighter:Alt-Ctrl--:change-density(-25)\en\e +.\" Help:About ...::help(helpGeneral)\en\e +.\" Help:Page Motion ...::help(helpPagemotion)\en\e +.\" Help:Other Commands ...::help(helpOthercommands)\en\e +.\" Help:Mouse Buttons ...::help(helpMousebuttons)\en\e +.\" Help:HyperTeX commands ...::help(helpHypertex)\en\e +.\" Help:Source specials ...::help(helpSourcespecials)\en +.\" .sp 1n +.\" .ft +.\" .fi +.\" .RE +.\" .PP +.\" The label string may contain a colon if it is escaped by a backslash +.\" (`\fB\\\fP'). (Note: Since the internal handling of menus requires +.\" every menu label to be unique, xdvi's special strings for customizing +.\" shrink factors in the buttons -- +.\" .RB ` $# ', +.\" .RB ` $% ' +.\" and +.\" .RB ' $_ ' +.\" -- are not supported by xdvik). +.\" endif +.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). +.PP +Wheel mice are supported: motion of the wheel on such a mouse moves the +image up or down by the number of pixels indicated by the +.B \-wheelunit +option. To access this option via customization, use the +.B wheel +action. This 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. +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +.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 +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 +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 resouce +.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, turing 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 segmeted 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). +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 `?'. +If you think that xdvi should recognize a character but doesn't, +please send a feature request to the address given in +.B AUTHORS +below. Likewise, if you observe spurious spaces or unwanted linebreaks in +the output, please report this as a bug. +.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 bindings for +.BR Mouse-1 , +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 continously 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). +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 \ecolorbox and \efcolorbox macros don't work +with xdvi. See the section LIMITATIONS below for more information on these +restrictions. +Xdvi supports the same list of named colors as with +.BR dvips , +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/mimetypes +.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 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/doc/man/man1/xdvizilla.1 b/Master/texmf/doc/man/man1/xdvizilla.1 new file mode 100644 index 00000000000..62b0d91c2de --- /dev/null +++ b/Master/texmf/doc/man/man1/xdvizilla.1 @@ -0,0 +1,115 @@ +.\" Copyright (c) 2002-2004 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. +.\" +.TH XDVIZILLA 1 "11 October 2002" "X Version 11" +.SH NAME +xdvizilla \- Helper application for running xdvi +.SH SYNOPSIS +.B xdvizilla +[\fB\-no\-rm\fP] +.I file +.SH DESCRIPTION +Presently (October 2002), Mozilla has some bugs with helper applications: +it passes gzipped +.RB ( .gz ) +files directly to the helper application without uncompressing, and it +passes compressed +.RB ( .Z ) +files as empty files. +.PP +To work around these problems, +.B xdvizilla +was written to look at files and decompress them correctly (depending on +their file types). +.PP +In addition, some sites produced tarred +.I dvi +files (including the +.I dvi +file as well as some included figures), and +.B xdvizilla +correctly handles those files as well. +.SH OPTIONS +Only one option is supported: +.TP +.B \-no\-rm +Normally +.B xdvizilla +will remove +.I file +before finishing. This option inhibits this behavior. +.SH INSTALLATION +In addition to installing +.B xdvizilla +in a directory on the default search path, it is necessary to set it up +as a helper application within the browser. +.PP +For +.BR "Netscape 4.x" , +add the following lines to the +.B mailcap +file: +.RS 5 +.nf +.ft 3 +.sp 1n +application/x-dvi; xdvi -safer %s +application/x-dvi-tar; xdvizilla -no-rm %s +.sp 1n +.ft +.fi +.RE +.PP +For +.BR "Netscape 6.x" , +.BR "Netscape 7.x" , +or +.BR "Mozilla 1.x" , +add the following lines to the +.B mailcap +file: +.RS 5 +.nf +.ft 3 +.sp 1n +application/x-dvi; xdvizilla %s +application/x-dvi-tar; xdvizilla %s +.sp 1n +.ft +.fi +.RE +.PP +In addition, it would be useful to check that the following line is included +in the +.B mime.types +file: +.RS 5 +.nf +.ft 3 +.sp 1n +type=application/x-dvi exts="dvi" desc="TeX dvi file" +.sp 1n +.ft +.fi +.RE +.SH SEE ALSO +.BR X (1), +.BR xdvi (1). +.SH AUTHOR +Paul Vojta, U.C. Berkeley. diff --git a/Master/texmf/doc/man/man3/zlib.3 b/Master/texmf/doc/man/man3/zlib.3 new file mode 100644 index 00000000000..890098449dd --- /dev/null +++ b/Master/texmf/doc/man/man3/zlib.3 @@ -0,0 +1,159 @@ +.TH ZLIB 3 "17 November 2003" +.SH NAME +zlib \- compression/decompression library +.SH SYNOPSIS +[see +.I zlib.h +for full description] +.SH DESCRIPTION +The +.I zlib +library is a general purpose data compression library. +The code is thread safe. +It provides in-memory compression and decompression functions, +including integrity checks of the uncompressed data. +This version of the library supports only one compression method (deflation) +but other algorithms will be added later +and will have the same stream interface. +.LP +Compression can be done in a single step if the buffers are large enough +(for example if an input file is mmap'ed), +or can be done by repeated calls of the compression function. +In the latter case, +the application must provide more input and/or consume the output +(providing more output space) before each call. +.LP +The library also supports reading and writing files in +.IR gzip (1) +(.gz) format +with an interface similar to that of stdio. +.LP +The library does not install any signal handler. +The decoder checks the consistency of the compressed data, +so the library should never crash even in case of corrupted input. +.LP +All functions of the compression library are documented in the file +.IR zlib.h . +The distribution source includes examples of use of the library +in the files +.I example.c +and +.IR minigzip.c . +.LP +Changes to this version are documented in the file +.I ChangeLog +that accompanies the source, +and are concerned primarily with bug fixes and portability enhancements. +.LP +A Java implementation of +.I zlib +is available in the Java Development Kit 1.1: +.IP +http://www.javasoft.com/products/JDK/1.1/docs/api/Package-java.util.zip.html +.LP +A Perl interface to +.IR zlib , +written by Paul Marquess (pmqs@cpan.org), +is available at CPAN (Comprehensive Perl Archive Network) sites, +including: +.IP +http://www.cpan.org/modules/by-module/Compress/ +.LP +A Python interface to +.IR zlib , +written by A.M. Kuchling (amk@magnet.com), +is available in Python 1.5 and later versions: +.IP +http://www.python.org/doc/lib/module-zlib.html +.LP +A +.I zlib +binding for +.IR tcl (1), +written by Andreas Kupries (a.kupries@westend.com), +is availlable at: +.IP +http://www.westend.com/~kupries/doc/trf/man/man.html +.LP +An experimental package to read and write files in .zip format, +written on top of +.I zlib +by Gilles Vollant (info@winimage.com), +is available at: +.IP +http://www.winimage.com/zLibDll/unzip.html +and also in the +.I contrib/minizip +directory of the main +.I zlib +web site. +.SH "SEE ALSO" +The +.I zlib +web site can be found at either of these locations: +.IP +http://www.zlib.org +.br +http://www.gzip.org/zlib/ +.LP +The data format used by the zlib library is described by RFC +(Request for Comments) 1950 to 1952 in the files: +.IP +http://www.ietf.org/rfc/rfc1950.txt (concerning zlib format) +.br +http://www.ietf.org/rfc/rfc1951.txt (concerning deflate format) +.br +http://www.ietf.org/rfc/rfc1952.txt (concerning gzip format) +.LP +These documents are also available in other formats from: +.IP +ftp://ftp.uu.net/graphics/png/documents/zlib/zdoc-index.html +.LP +Mark Nelson (markn@ieee.org) wrote an article about +.I zlib +for the Jan. 1997 issue of Dr. Dobb's Journal; +a copy of the article is available at: +.IP +http://dogma.net/markn/articles/zlibtool/zlibtool.htm +.SH "REPORTING PROBLEMS" +Before reporting a problem, +please check the +.I zlib +web site to verify that you have the latest version of +.IR zlib ; +otherwise, +obtain the latest version and see if the problem still exists. +Please read the +.I zlib +FAQ at: +.IP +http://www.gzip.org/zlib/zlib_faq.html +.LP +before asking for help. +Send questions and/or comments to zlib@gzip.org, +or (for the Windows DLL version) to Gilles Vollant (info@winimage.com). +.SH AUTHORS +Version 1.2.1 +Copyright (C) 1995-2003 Jean-loup Gailly (jloup@gzip.org) +and Mark Adler (madler@alumni.caltech.edu). +.LP +This software is provided "as-is," +without any express or implied warranty. +In no event will the authors be held liable for any damages +arising from the use of this software. +See the distribution directory with respect to requirements +governing redistribution. +The deflate format used by +.I zlib +was defined by Phil Katz. +The deflate and +.I zlib +specifications were written by L. Peter Deutsch. +Thanks to all the people who reported problems and suggested various +improvements in +.IR zlib ; +who are too numerous to cite here. +.LP +UNIX manual page by R. P. C. Rodgers, +U.S. National Library of Medicine (rodgers@nlm.nih.gov). +.\" end of man page diff --git a/Master/texmf/doc/man/man5/fmtutil.cnf.5 b/Master/texmf/doc/man/man5/fmtutil.cnf.5 new file mode 100644 index 00000000000..7c5aeb905d2 --- /dev/null +++ b/Master/texmf/doc/man/man5/fmtutil.cnf.5 @@ -0,0 +1,75 @@ +.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 file 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 +.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/doc/man/man5/info.5 b/Master/texmf/doc/man/man5/info.5 new file mode 100644 index 00000000000..08fd289908f --- /dev/null +++ b/Master/texmf/doc/man/man5/info.5 @@ -0,0 +1,72 @@ +.\" info(5) +.\" $Id: info.5,v 1.2 2004/04/11 17:56:45 karl Exp $ +.\" +.\" Copyright (C) 1998 Free Software Foundation, Inc. +.\" +.\" Permission is granted to make and distribute verbatim copies of this +.\" manual provided the copyright notice and this permission notice are +.\" preserved on all copies. +.\" +.\" Permission is granted to copy and distribute modified versions of +.\" this manual under the conditions for verbatim copying, provided that +.\" the entire resulting derived work is distributed under the terms of a +.\" permission notice identical to this one. +.\" +.\" Permission is granted to copy and distribute translations of this +.\" manual into another language, under the above conditions for modified +.\" versions, except that this permission notice may be stated in a +.\" translation approved by the Foundation. +.\" +.de EX +.nf +.ft CW +.in +5 +.. +.de EE +.in -5 +.ft R +.fi +.. +.TH INFO 5 "GNU Info" "FSF" +.SH NAME +info \- readable online documentation +.SH DESCRIPTION +The Info file format is an easily-parsable representation for online +documents. It can be read by +.I emacs(1) +and +.I info(1) +among other programs. +.PP +Info files are usually created from +.I texinfo(5) +sources by +.IR makeinfo(1) , +but can be created from scratch if so desired. +.PP +For a full description of the Texinfo language and associated tools, +please see the Texinfo manual (written in Texinfo itself). Most likely, +running this command from your shell: +.EX +info texinfo +.EE +or this key sequence from inside Emacs: +.EX +M-x info RET m texinfo RET +.EE +will get you there. +.SH AVAILABILITY +ftp://ftp.gnu.org/pub/gnu/texinfo-<version>.tar.gz +.br +or any GNU mirror site. +.SH "REPORTING BUGS" +Please send bug reports to bug-texinfo@gnu.org, +general questions and discussion to help-texinfo@gnu.org. +.SH "SEE ALSO" +info(1), install-info(1), makeinfo(1), texi2dvi(1), +.br +texindex(1). +.br +emacs(1), tex(1). +.br +texinfo(5). diff --git a/Master/texmf/doc/man/man5/texinfo.5 b/Master/texmf/doc/man/man5/texinfo.5 new file mode 100644 index 00000000000..0ca35cac0d5 --- /dev/null +++ b/Master/texmf/doc/man/man5/texinfo.5 @@ -0,0 +1,61 @@ +.\" texinfo(5) +.\" $Id: texinfo.5,v 1.2 2004/04/11 17:56:45 karl Exp $ +.\" +.\" Copyright (C) 1998, 1999, 2002 Free Software Foundation, Inc. +.\" +.\" Permission is granted to make and distribute verbatim copies of this +.\" manual provided the copyright notice and this permission notice are +.\" preserved on all copies. +.\" +.\" Permission is granted to copy and distribute modified versions of +.\" this manual under the conditions for verbatim copying, provided that +.\" the entire resulting derived work is distributed under the terms of a +.\" permission notice identical to this one. +.\" +.\" Permission is granted to copy and distribute translations of this +.\" manual into another language, under the above conditions for modified +.\" versions, except that this permission notice may be stated in a +.\" translation approved by the Foundation. +.\" +.de EX +.nf +.ft CW +.in +5 +.. +.de EE +.in -5 +.ft R +.fi +.. +.TH TEXINFO 5 "GNU Texinfo" "FSF" +.SH NAME +texinfo \- software documentation system +.SH DESCRIPTION +Texinfo is a documentation system that uses a single source file to +produce both online information and printed output. It is primarily +designed for writing software manuals. +.PP +For a full description of the Texinfo language and associated tools, +please see the Texinfo manual (written in Texinfo itself). Most likely, +running this command from your shell: +.EX +info texinfo +.EE +or this key sequence from inside Emacs: +.EX +M-x info RET m texinfo RET +.EE +will get you there. +.SH AVAILABILITY +ftp://ftp.gnu.org/gnu/texinfo/ +.br +or any GNU mirror site. +.SH "REPORTING BUGS" +Please send bug reports to bug-texinfo@gnu.org, +general questions and discussion to help-texinfo@gnu.org. +.SH "SEE ALSO" +info(1), install-info(1), makeinfo(1), texi2dvi(1), texindex(1). +.br +emacs(1), tex(1). +.br +info(5). diff --git a/Master/texmf/doc/man/man5/updmap.cfg.5 b/Master/texmf/doc/man/man5/updmap.cfg.5 new file mode 100644 index 00000000000..67d6412fcc1 --- /dev/null +++ b/Master/texmf/doc/man/man5/updmap.cfg.5 @@ -0,0 +1,137 @@ +.\" Hey, Emacs! This is an -*- nroff -*- source file. +.\" +.\" Copyright (C) 2004 Hilmar Preusse <hille42@web.de> +.\" +.\" 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 with +.\" your Debian GNU/Linux system, in /usr/share/common-licenses/GPL, or with +.\" the dpkg source package as the file COPYING. If not, write to the Free +.\" Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. +.\" +.TH "UPDMAP.CFG" "5" "AUGUST 2005" "Debian/GNU Linux" "" +.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), \fBdvipdfm\fP(1) and (soon) \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 a single source, +\fBupdmap.cfg\fR, allowing you to easily keep all the different +configuration files in sync\&. +.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 +\fBdvipsDownloadBase\fR +.br +Configures if \fBdvips\fR (by default) should download the standard 35 LaserWriter +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 either 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 base 14 pdf fonts? Since some configurations +(ps / pdf tools / printers) use bad default fonts, it is safer to download +the fonts. The pdf files will get bigger, though. +.br +Valid settings are \fItrue\fR (download the fonts) or \fIfalse\fR (don't +download the fonts). Adobe recomments to embed all fonts. +.P +\fBdvipdfmDownloadBase14\fR +.br +Should \fBdvipdfm\fR download the base 14 pdf fonts? Since some configurations +(ps / pdf tools / printers) use bad default fonts, it is safer to download +the fonts. The pdf files will get bigger, though. +.br +Valid settings are \fItrue\fR (download the fonts) or \fIfalse\fR (don't +download the fonts). +.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 +section 6.4, "'psfonts.map': PostScript font catalog" in the manual of +\fBdvips\fP(1), available as info and pdf file. +.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 +The sign \fB#\fR precedes a comment. +.P +Not used Map files should be commented out using the string \fB#!\fR at the +beginning of the line. These entries can be (de-)activaed using \fBupdmap\fR +with the options \fI--enable\fR and \fI--disable\fR. +.SH "SPECIAL TO DEBIAN" +In Debian the file \fBupdmap.cfg\fR is a generated file sitting in /var. It is +generated by concatenating the *.cfg files from /etc/texmf/updmap.d/. These +files follow the syntax of updmap.cfg, but contain only parts of it. +.SH "AUTHOR" +This manual page was written by Hilmar Preusse <hille42@web.de>, 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 my fault; inquiries about or corrections to this manual +page should be directed to me (and not to the primary author). +.SH "SEE ALSO" +updmap(1), info page of dvips(1) +.SH "THANKS TO" +Frank Kuester, +Thomas Esser. |