summaryrefslogtreecommitdiff
path: root/Master/texmf/doc/man/man5
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2006-01-03 00:00:18 +0000
committerKarl Berry <karl@freefriends.org>2006-01-03 00:00:18 +0000
commita540e256be85df29c60ac323d4460c6cde1d9350 (patch)
treed83a3a57112a9ec6966691569ecc2dfe78d82b81 /Master/texmf/doc/man/man5
parent84a45ba83a3095eb4908d4325981b11fc1b31b05 (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/man5')
-rw-r--r--Master/texmf/doc/man/man5/fmtutil.cnf.575
-rw-r--r--Master/texmf/doc/man/man5/info.572
-rw-r--r--Master/texmf/doc/man/man5/texinfo.561
-rw-r--r--Master/texmf/doc/man/man5/updmap.cfg.5137
4 files changed, 345 insertions, 0 deletions
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.