summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/man/man5
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/man/man5')
-rw-r--r--Master/texmf-dist/doc/man/man5/Makefile17
-rw-r--r--Master/texmf-dist/doc/man/man5/fmtutil.cnf.577
-rw-r--r--Master/texmf-dist/doc/man/man5/fmtutil.cnf.man5.pdfbin0 -> 6397 bytes
-rw-r--r--Master/texmf-dist/doc/man/man5/synctex.5319
-rw-r--r--Master/texmf-dist/doc/man/man5/synctex.man5.pdfbin0 -> 8938 bytes
-rw-r--r--Master/texmf-dist/doc/man/man5/updmap.cfg.5155
-rw-r--r--Master/texmf-dist/doc/man/man5/updmap.cfg.man5.pdfbin0 -> 8664 bytes
7 files changed, 568 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/man/man5/Makefile b/Master/texmf-dist/doc/man/man5/Makefile
new file mode 100644
index 00000000000..c0afb8965a5
--- /dev/null
+++ b/Master/texmf-dist/doc/man/man5/Makefile
@@ -0,0 +1,17 @@
+# Public domain. Originally written by Manuel Pegourie-Gonnard, 2008.
+
+SRC = $(wildcard man5/*.5)
+PDF = $(patsubst %.5, %.man5.pdf, $(SRC))
+
+MKPDF = $(GROFF) $(PDFOPTS) $< | $(PSPDF) - $@.tmp && mv $@.tmp $@ || rm $@.tmp
+
+all: pdf
+pdf: $(PDF)
+
+clean:
+ @echo 'Removing pdf files.'
+ @rm -f -- $(PDF)
+
+%.man5.pdf: %.5
+ $(MKPDF)
+
diff --git a/Master/texmf-dist/doc/man/man5/fmtutil.cnf.5 b/Master/texmf-dist/doc/man/man5/fmtutil.cnf.5
new file mode 100644
index 00000000000..4efedcf590c
--- /dev/null
+++ b/Master/texmf-dist/doc/man/man5/fmtutil.cnf.5
@@ -0,0 +1,77 @@
+.TH "fmtutil\&.cnf" "5" "October 2000" "teTeX" "teTeX"
+.PP
+.SH "NAME"
+fmtutil\&.cnf \- configuration file for fmtutil
+.PP
+.SH "DESCRIPTION"
+.PP
+The \fIfmtutil\&.cnf\fP file contains the configuration information
+for \fBfmtutil\fP(8)\&. Each line contains the name of the format
+(e\&.g\&., ``tex\'\', ``latex\'\', ``omega\'\'), the name of the engine that
+is used by that format (e\&.g\&., ``tex\'\', ``etex\'\', ``omega\'\'), the pattern
+file (e\&.g\&., \fIlanguage\&.dat\fP, \fIlanguage\&.def\fP), and any
+arguments (name of an \fI\&.ini\fP file)\&.
+.PP
+Fields are separated by whitespace\& and complete lines can be commented
+out with ``#\'\'\&. The ``pattern file\'\' field cannot be used to
+define a file that is used while building the format\&.
+It tells \fBfmtutil\fP which files (separated by commas) the
+format creation procedure reads\& and it has an effect to the options
+\fI--showhyphen\fP and \fI--byhyphen\fP\&.
+If the format has no way to
+customize hyphenation, a ``-\'\' can be used to indicate this\&.
+.PP
+.SH "NOTES"
+.PP
+The \fBtex\fP(1) and \fBamstex\fP(1) formats always load
+\fIhyphen\&.tex\fP\&. No customization by a pattern file is available
+for these formats\&. Therefore, the pattern-file field for the
+\fBtex\fP and \fBamstex\fP is usually indicated to be empty (``-\'\')\&.
+.PP
+You can, however, build customized formats on top of plain
+\fBtex\fP(1) or \fBamstex\fP(1) by using \fIbplain\&.tex\fP instead of
+\fIplain\&.tex\fP (b for the \fIBabel\fP system). See, for example,
+the \fIbplain\&.ini\fP file for the bplain format)\&.
+.PP
+\fBetex\fP(1) loads \fIlanguage\&.def\fP, not
+\fIlanguage\&.dat\fP\&.
+.PP
+Symbolic links to the correct engines (e\&.g\&., bplain -> tex)
+are generated by the \fBtexlinks\fP(8) script\&. Remember to run
+\fBtexlinks\fP(8) if you run \fBfmtutil\fP(8) yourself, rather
+than using the FORMATS option in \fBtexconfig\fP(8)\&.
+.PP
+.SH "FILES"
+.PP
+.IP "\fIfmtutil\&.cnf\fP"
+default configuration file
+.IP "\fIlanguage\&.dat\fP"
+hyphenation pattern file
+.IP "\fIlanguage\&.def\fP"
+hyphenation pattern file
+.IP "\fIlanguage\&.dat.lua\fP"
+hyphenation pattern file
+.PP
+.SH "SEE ALSO"
+.PP
+\fBamstex\fP(1), \fBetex\fP(1), \fBfmtutil\fP(8),
+\fBtex\fP(1), \fBtexconfig\fP(8), \fBtexlinks\fP(8)\&.
+.PP
+Web page: <http://tug\&.org/teTeX/>
+.PP
+.SH "BUGS"
+.PP
+None known, but report any bugs found to <tetex@dbs\&.uni-hannover\&.de> (mailing list)\&.
+.PP
+.SH "AUTHOR"
+.PP
+\fIfmtutil\&.cnf\fP was written by Thomas Esser
+<te@dbs\&.uni-hannover\&.de>, and is Copyright 1998,
+1999 but released into the public domain\&.
+.PP
+This manual page was written by C\&.M\&. Connelly
+<c@eskimo\&.com>, for
+the Debian GNU/Linux system\&. It may be used by other distributions
+without contacting the author\&. Any mistakes or omissions in the
+manual page are my fault; inquiries about or corrections to this
+manual page should be directed to me (and not to the primary author)\&.
diff --git a/Master/texmf-dist/doc/man/man5/fmtutil.cnf.man5.pdf b/Master/texmf-dist/doc/man/man5/fmtutil.cnf.man5.pdf
new file mode 100644
index 00000000000..0409ae0ec49
--- /dev/null
+++ b/Master/texmf-dist/doc/man/man5/fmtutil.cnf.man5.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/man/man5/synctex.5 b/Master/texmf-dist/doc/man/man5/synctex.5
new file mode 100644
index 00000000000..3b331efe0bd
--- /dev/null
+++ b/Master/texmf-dist/doc/man/man5/synctex.5
@@ -0,0 +1,319 @@
+.Dd Mar 13, 2012
+.Dt SYNCTEX 5
+.Os "Independant"
+.\"
+.\"
+.Sh NAME
+.Nm synctex
+.Nd Synchronize TeXnology help file
+.\"
+.\"
+.Sh DESCRIPTION
+Synchronize TeXnology help file
+.Pq synctexs
+are text files that help input/output synchronization during document preparation with the TeX typesetting system.
+.Sh BASICS
+The structure of this file should not be considered public, in the sense that no one should need to parse its contents, except the synctex command line utility, and the synctex_parser library.
+Unless it is absolutely not avoidable, access to the contents of the synctex file should only be made through requests made to the synctex command line utility.
+.\"
+.Sh STRUCTURE
+The element structure of a synctex file is a list of text line records as follows.
+.Sq \&* ,
+.Sq \&+ ,
+and
+.Sq \&?
+have their usual EBNF meanings:
+.Sq \&*
+means zero or more,
+.Sq \&+
+means one or more, and
+.Sq \&?
+means zero or one
+.Pq i.e., optional .
+.Pp
+.Bl -item -offset indent
+.\"
+.It
+.Li <SyncTeX> ::=
+.Pq The whole contents in 4 sections
+.Bl -item -offset indent
+.It
+.Li <Preamble>
+.It
+.Li <Content>
+.It
+.Li <Postamble>
+.It
+.Li <Post Scriptum>
+.El
+.\"
+.El
+.Pp
+Each section starts with the first occurrence of a sectioning line, and ends with the next section, if any.
+In the following definitions, we do not mention the section ending condition.
+.Sh The preamble
+.Bl -item -offset indent
+.\"
+.It
+.Li <Preamble> ::=
+.Bl -item -offset indent
+.It
+.Qq SyncTeX Version:
+<Version Number> <EOL>
+.It
+.Li <Input Line>*
+.It
+.Qq Magnification:
+<TeX magnification> <EOL>
+.It
+.Qq Unit:
+<unit in scaled point> <EOL>
+.It
+.Qq X Offset:
+<horizontal offset in scaled point> <EOL>
+.It
+.Qq Y Offset:
+<vertical offset in scaled point> <EOL>
+.El
+.It
+.Li <Input Line> ::=
+.Qq Input:
+<tag>
+.Qq \&:
+<File Name> <EOL>
+.\"
+.El
+.Sh The content
+.Bl -item -offset indent
+.It
+.Li <Content> ::=
+.Bl -item -offset indent
+.It
+.Li <byte offset record>
+.It
+.Qq Content:
+<EOL>
+.It
+.Li <sheet(1)>
+.It
+.Li <Input Line>*
+.It
+.Li <sheet(2)>
+.It
+.Li <Input Line>*
+.It
+.Li ...
+.It
+.Li <sheet(N)>
+.It
+.Li <Input Line>*
+.El
+.It
+.Li <byte offset record> ::=
+.Qq \&!
+<byte offset> <end of record>
+.Pp
+.El
+.Pp
+.Bl -item -offset indent
+.It
+.Li <sheet(n)> ::=
+.Bl -item -offset indent
+.It
+.Li <byte offset record>
+.It
+.Qq \&{
+<the integer n> <end of record>/
+.It
+.Li <box content>*
+.It
+.Li <byte offset record>
+.It
+.Qq \&}
+<the integer n> <end of record>
+.El
+.El
+.Pp
+The <box content> describes what is inside a box.
+It is either a vertical or horizontal box,
+with some records related to glue, kern or math nodes.
+.Bl -item -offset indent
+.It
+.Li <box content> ::=
+.Bl -item -offset indent
+.It
+.Li <vbox section>|<hbox section>
+.It
+.Li |<void vbox record>|<void hbox record>
+.It
+.Li |<current record>|<glue record>|<kern record>|<math record>
+.El
+.It
+.Li <vbox section> ::=
+.Bl -item -offset indent
+.It
+.Qq \&[
+<link>
+.Qq \&:
+<point>
+.Qq \&:
+<size> <end of record>
+.It
+.Li <box content>*
+.It
+.Qq \&]
+<end of record>
+.El
+.It
+.Li <hbox section> ::=
+.Bl -item -offset indent
+.It
+.Li \&(
+<link>
+.Qq \&:
+<point>
+.Qq \&:
+<size> <end of record>
+.It
+.Li <box content>*
+.It
+.Qq \&)
+<end of record>
+.El
+.El
+.Pp
+Void boxes:
+.Bl -item -offset indent
+.It
+.Li <void vbox record> ::=
+.Qq v
+<link>
+.Qq \&:
+<point>
+.Qq \&:
+<size> <end of record>
+.It
+.Li <void hbox record> ::=
+.Qq h
+<link>
+.Qq \&:
+<point>
+.Qq \&:
+<size> <end of record>
+.It
+.Li <size> ::= <Width>
+.Qq \&,
+<Height>
+.Qq \&,
+<Depth>
+.It
+.Li <Width> ::= <integer>
+.It
+.Li <Height> ::= <integer>
+.It
+.Li <Depth> ::= <integer>
+.It
+.Li <link> ::= <tag>
+.Qq \&,
+<line>(
+.Qq \&,
+<column>)?
+.It
+.Li <line> ::= <integer>
+.It
+.Li <column> ::= <integer>
+.El
+.Pp
+The forthcoming records are basic one liners.
+.Bl -item -offset indent
+.It
+.Li <current record> ::=
+.Qq x
+<link>
+.Qq \&:
+<point> <end of record>
+.It
+.Li <kern record> ::=
+.Qq k
+<link>
+.Qq \&:
+<point>
+.Qq \&:
+<Width> <end of record>
+.It
+.Li <glue record> ::=
+.Qq g
+<link>
+.Qq \&:
+<point> <end of record>
+.It
+.Li <math record> ::=
+.Qq $
+<link>
+.Qq \&:
+<point> <end of record>
+.El
+.Pp
+.\" .Sx underline, .Dq double quotes, .Pq enclosed in parenthesis
+.Sh The postamble
+The postamble closes the file
+If there is no postamble, it means that the typesetting process did not end correctly.
+.Bl -item -offset indent
+.\"
+.It
+.Li <Postamble>::=
+.Bl -item -offset indent
+.It
+.Li <byte offset record>
+.It
+.Qq Count:
+<Number of records> <EOL>
+.El
+.El
+.Sh The post scriptum
+The post scriptum contains material possibly added by 3rd parties.
+It allows to append some transformation (shift and magnify).
+Typically, one applies a dvi to pdf filter with offset options and magnification,
+then he appends the same options to the synctex file, for example
+.Bd -literal -offset indent
+ synctex update -o foo.pdf -m 0.486 -x 9472573sp -y 13.3dd source.dvi
+.Ed
+.Bl -item -offset indent
+.\"
+.It
+.Li <Post Scriptum>::=
+.\"
+.Bl -item -offset indent
+.It
+.Li <byte offset record>
+.It
+.Qq Post Scriptum:
+<EOL>
+.It
+.Qq Magnification:
+<number> <EOL>
+.Pq Set additional magnification
+.It
+.Qq X Offset:
+<dimension> <EOL>
+.Pq Set horizontal offset
+.It
+.Qq Y Offset:
+<dimension> <EOL>
+.Pq Set vertical offset
+.El
+.El
+This second information will override the offset and magnification previously available in the preamble section.
+All the numbers are encoded using the decimal representation with "C" locale.
+.Sh USAGE
+.Pp
+The <current record> is used to compute the visible size of hbox's.
+The byte offset is an implicit anchor to navigate the synctex file from sheet to sheet.
+.\" nroff -man synctex.5 | less
+.\"groff -man -Tascii synctex.5 | less
+.\"To convert a man page to plain pre-formatted text (e.g for spell checking) use:
+.\"nroff -man synctex.5 | col -b > synctex.5.txt
+.\"To convert it to Postscript (for printing or further conversion to pdf) use:
+.\"groff -man -Tps synctex.5 > synctex.5.ps
+.\"To convert the man page to html use:
+.\"man2html synctex.5
diff --git a/Master/texmf-dist/doc/man/man5/synctex.man5.pdf b/Master/texmf-dist/doc/man/man5/synctex.man5.pdf
new file mode 100644
index 00000000000..e1c12badd77
--- /dev/null
+++ b/Master/texmf-dist/doc/man/man5/synctex.man5.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/man/man5/updmap.cfg.5 b/Master/texmf-dist/doc/man/man5/updmap.cfg.5
new file mode 100644
index 00000000000..43a7cc2d23f
--- /dev/null
+++ b/Master/texmf-dist/doc/man/man5/updmap.cfg.5
@@ -0,0 +1,155 @@
+.\" Hey, Emacs! This is an -*- nroff -*- source file.
+.\"
+.\" Copyright (C) 2004, 2012 Hilmar Preusse <hille42@web.de>
+.\" Copyright (C) 2012 Norbert Preining <preining@logic.at>
+.\"
+.\" This is free software; you can redistribute it and/or modify it under
+.\" the terms of the GNU General Public License as published by the Free
+.\" Software Foundation; either version 2, or (at your option) any later
+.\" version.
+.\"
+.\" This is distributed in the hope that it will be useful, but WITHOUT
+.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+.\" for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License
+.\" along with this program. if not, see <http://www.gnu.org/licenses/>.
+.\"
+.TH "UPDMAP.CFG" "20" "November 2012" "TeX Live" "TeX Live"
+.SH "NAME"
+\fBupdmap.cfg\fR \- configuration of font mapping/inclusion for dvips and
+friends.
+.SH "DESCRIPTION"
+The file \fBupdmap.cfg\fR is the central font configuration file of a
+teTeX system and is read by \fBupdmap\fP(1). It describes if and how
+fonts should be included (or not included) into PS-/PDF-files. This
+works for Outline (Postscript Type1) and Bitmap Fonts (Postscript
+Type3) mostly coming from MetaFont.
+.PP
+\fBupdmap\fP is a utility that creates font configuration files for
+\fBdvips\fP(1), \fBpdftex\fP(1), \fBxdvi\fP(1), \fBps2pk\fP(1),
+\fBgsftopk\fP(1), and \fBdvipdfmx\fP(1)\&. In
+an ideal world, updmap would be unnecessary -- each of these programs
+would read the same configuration file to learn what fonts are
+available and how they should be treated\&. As things stand, however,
+each of these tools has subtly different requirements and thereby
+needs its own font configuration file\&. \fBupdmap\fP creates font
+configuration files for all of these programs from several sources,
+namely all \fBupdmap.cfg\fR, allowing you to easily keep all the different
+configuration files in sync\&.
+.P
+Running "updmap --help" will output the main documentation for using
+\fBupdmap\fR.
+.P
+\fBdvipsPreferOutline\fR
+.br
+Configures if \fBdvips\fR (by default) should prefer bitmap fonts or outline fonts
+if both are available? Independent of this setting, outlines can be forced
+by putting "p psfonts_t1.map" into a config file that dvips reads. Bitmaps
+can be forced by putting "p psfonts_pk.map" into a config file. We provide
+such config files which can be enabled via
+\fBdvips\fR \fI-Poutline\fR (resp. \fBdvips\fR \fI-Ppk\fR).
+.br
+Valid settings for dvipsPreferOutline are \fItrue\fR / \fIfalse\fR.
+.P
+\fBLW35\fR
+.br
+Which fonts of the "Basic 35 Laserwriter Fonts" do you want to use and
+how are the filenames chosen? Valid settings:
+.br
+URW: URW fonts with "vendor" filenames (e.g. n019064l.pfb)
+.br
+URWkb: URW fonts with "berry" filenames (e.g. uhvbo8ac.pfb)
+.br
+ADOBE: Adobe fonts with "vendor" filenames (e.g. hvnbo___.pfb)
+.br
+ADOBEkb: Adobe fonts with "berry" filenames (e.g. phvbo8an.pfb)
+.P
+\fBdvipsDownloadBase35\fR
+.br
+Configures if \fBdvips\fR (by default) should download the 35 base
+PostScript fonts into the document (set \fItrue\fR) or should these
+fonts be used from the ps interpreter / printer (set \fIfalse\fR).
+.br
+The user can override the default by specifying \fBdvips\fR \fI-Pdownload35\fR
+(resp. \fBdvips\fR \fI-Pbuiltin35\fR) to download the LW35 fonts
+(resp. use the built-in fonts).
+.br
+Valid settings are \fItrue\fR / \fIfalse\fR.
+.P
+\fBpdftexDownloadBase14\fR
+.br
+Should \fBpdftex\fR download the 14 base PDF fonts? Since some configurations
+(ps / pdf tools / printers) use bad default fonts, it is safer to download
+the fonts. The pdf files get bigger, but that is the cost.
+.br
+Valid settings are \fItrue\fR (download the fonts) or \fIfalse\fR (don't
+download the fonts). Adobe recommends embedding all fonts.
+.P
+\fBpxdviUse\fR
+.br
+Should special map files for pxdvi be created? pxdvi is an adaption of xdvi
+with support for reading and displaying files generated by the ptex family
+of engines.
+.br
+Valid settings are \fItrue\fR (generate configuration) or \fIfalse\fR. See
+http://www.tug.org/texlive/updmap-kanji.html for detailed discussion.
+.P
+\fBkanjiEmbed\fR
+.br
+\fBkanjiVariant\fR
+.br
+The options \fBkanjiEmbed\fR and \fBkanjiVariant\fR specify special
+replacements in the map lines. In a map, the string "@kanjiEmbed@"
+will be replaced by the value of that option; similarly for
+\fBkanjiVariant\fR. In this way, users of Japanese TeX can select
+different fonts to be included in the final output.
+.P
+\fBMap\fR
+.br
+Points to a map file, which describes a mapping from a font (called in the TeX
+document) to the pfb file containing the Postscript code.
+.br
+Usage: \fBMap\fR filename.map
+.P
+The syntax of map files is the same as \fBdvips\fP(1) uses, see the
+section "psfonts.map" in the manual of \fBdvips\fP(1).
+.P
+\fBMixedMap\fR
+.br
+Similar to \fBMap\fR. It should be used when there is Type1 and a bitmap
+implementation of the font (the latter mostly coming from MetaFont). These
+entries will not be used in the default map of \fBdvips\fR if
+\fBdvipsPreferOutline\fR is set to \fIfalse\fR.
+.br
+Usage: \fBMixedMap\fR filename.map
+.P
+\fBKanjiMap\fR
+.br
+Similar to \fBMap\fR. This should be used for kanji fonts.
+.br
+Usage: \fBKanjiMap\fR filename.map
+.P
+The sign \fB#\fR precedes a comment.
+.P
+Map files not to be used should be commented out using the string
+\fB#!\fR at the beginning of the line. Such entries can be
+(de-)activated using \fBupdmap\fR with the options \fI--enable\fR and
+\fI--disable\fR, respectively.
+
+.SH "AUTHOR"
+This manual page was written by Hilmar Preusse <hille42@web.de> and
+extended by Norbert Preining <preining@logic.at>, for
+the Debian GNU/Linux system by simply copying the comments from
+\fBupdmap.cfg\fR and rewriting some of them. It may be used by other
+distributions without contacting the author. Any mistakes or omissions in
+the manual page are our fault; inquiries about or corrections to this manual
+page should be directed to tex-live@tug.org.
+
+.SH "SEE ALSO"
+updmap(1), dvips(1)
+
+.SH "THANKS TO"
+Frank Kuester,
+Thomas Esser.
diff --git a/Master/texmf-dist/doc/man/man5/updmap.cfg.man5.pdf b/Master/texmf-dist/doc/man/man5/updmap.cfg.man5.pdf
new file mode 100644
index 00000000000..3fff19ac64c
--- /dev/null
+++ b/Master/texmf-dist/doc/man/man5/updmap.cfg.man5.pdf
Binary files differ