From 8d1ac961e6af367e1aefaaddbcbfd37457ffe9a9 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Thu, 16 Jun 2011 20:42:20 +0000 Subject: make man page with help2man; update live updmap git-svn-id: svn://tug.org/texlive/trunk@23019 c570f23f-e606-0410-a88d-b1316a301751 --- Build/source/texk/tetex/ChangeLog | 1 + Build/source/texk/tetex/updmap.man | 362 +++++++++++++++++-------------------- 2 files changed, 171 insertions(+), 192 deletions(-) (limited to 'Build') diff --git a/Build/source/texk/tetex/ChangeLog b/Build/source/texk/tetex/ChangeLog index 32fb254ee40..eccade77090 100644 --- a/Build/source/texk/tetex/ChangeLog +++ b/Build/source/texk/tetex/ChangeLog @@ -1,6 +1,7 @@ 2011-06-16 Karl Berry * updmap.pl (help): add more info and modify to work with help2man. + * updmap.man: generate with help2man. * updmap.pl (progname): eliminate fn in favor of $0 or hardwired "updmap" as appropriate. diff --git a/Build/source/texk/tetex/updmap.man b/Build/source/texk/tetex/updmap.man index b9487c9a0c1..a4d08594617 100644 --- a/Build/source/texk/tetex/updmap.man +++ b/Build/source/texk/tetex/updmap.man @@ -1,260 +1,238 @@ -.TH "updmap" "1" "August 2009" "TeX Live" "TeX Live" -.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 +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.3. +.TH UPDMAP "1" "June 2011" "TeX Live" "User Commands" +.SH NAME +updmap \- manage TeX font maps, per-user +.br +updmap-sys \- manage TeX font maps, system-wide +.SH SYNOPSIS +.B updmap +[\fIOPTION\fR] ... [\fICOMMAND\fR] +.br +.B updmap-sys +[\fIOPTION\fR] ... [\fICOMMAND\fR] +.SH DESCRIPTION +updmap (TeX Live) version $Id: updmap.pl 23018 2011\-06\-16 20:35:36Z karl $ +.PP +Update the default font map files used by pdftex, dvips, and dvipdfm(x), +as determined by the configuration file updmap.cfg (the one returned by +running "kpsewhich updmap.cfg"). +.PP +Among other things, these map files are used to determine which fonts +should be used as bitmaps and which as outlines, and to determine which +fonts are included in the output. +.PP +By default, the TeX filename database (ls\-R) is also updated. +.SH OPTIONS +.TP +\fB\-\-cnffile\fR FILE +read FILE for the updmap configuration +.TP +\fB\-\-dvipsoutputdir\fR DIR +specify output directory (dvips syntax) +.TP +\fB\-\-pdftexoutputdir\fR DIR +specify output directory (pdftex syntax) +.TP +\fB\-\-outputdir\fR DIR +specify output directory (for all files) +.TP +\fB\-\-copy\fR +cp generic files rather than using symlinks +.TP +\fB\-\-force\fR +recreate files even if config hasn't changed +.TP +\fB\-\-nomkmap\fR +do not recreate map files +.TP +\fB\-\-nohash\fR +do not run texhash +.TP +\fB\-n\fR, \fB\-\-dry\-run\fR +only show the configuration, no output +.TP +\fB\-\-quiet\fR, \fB\-\-silent\fR +reduce verbosity +.SS "Commands:" +.TP +\fB\-\-help\fR +show this message and exit +.TP +\fB\-\-version\fR +show version information and exit +.TP +\fB\-\-showoptions\fR ITEM +show alternatives for options +.TP +\fB\-\-setoption\fR OPTION VALUE +set option, where OPTION is one of: +LW35, dvipsPreferOutline, dvipsDownloadBase35, +or pdftexDownloadBase14 +.TP +\fB\-\-setoption\fR OPTION=VALUE +as above, just different syntax +.TP +\fB\-\-enable\fR MAPTYPE MAPFILE +add "MAPTYPE MAPFILE" to updmap.cfg, +where MAPTYPE is either Map or MixedMap +.TP +\fB\-\-enable\fR Map=MAPFILE +add "Map MAPFILE" to updmap.cfg +.HP +\fB\-\-enable\fR MixedMap=MAPFILE add "MixedMap MAPFILE" to updmap.cfg +.TP +\fB\-\-disable\fR MAPFILE +disable MAPFILE, whether Map or MixedMap +.TP +\fB\-\-listmaps\fR +list all active and inactive maps +.TP +\fB\-\-listavailablemaps\fR +same as \fB\-\-listmaps\fR, but without +unavailable map files +.TP +\fB\-\-syncwithtrees\fR +disable unavailable map files in updmap.cfg +.PP +Explanation of the map types: the (only) difference between Map and +MixedMap is that MixedMap entries are not added to psfonts_pk.map. +The purpose is to help users with printers that render Type 1 outline +fonts worse than mode\-tuned Type 1 bitmap fonts. So, MixedMap is used +for fonts that are available as both Type 1 and Metafont. +.PP +Explanation of the \fB\-\-setoption\fR possibilities: +.TP +dvipsPreferOutline +true|false (default true) +.IP +Whether dvips uses bitmaps or outlines, when both are available. +.TP +dvipsDownloadBase35 +true|false (default false) +.IP +Whether dvips includes the standard 35 PostScript fonts in its output. +.TP +pdftexDownloadBase14 +true|false (default true) +.IP +Whether pdftex includes the standard 14 PDF fonts in its output. +.TP +LW35 +URWkb|URW|ADOBEkb|ADOBE (default URWkb) +.IP +Adapt the font and file names of the standard 35 PostScript fonts. +URWkb URW fonts with "berry" filenames (e.g. uhvbo8ac.pfb) +URW URW fonts with "vendor" filenames (e.g. n019064l.pfb) +ADOBEkb Adobe fonts with "berry" filenames (e.g. phvbo8an.pfb) +ADOBE Adobe fonts with "vendor" filenames (e.g. hvnbo___.pfb) +.IP +These options are only read and acted on by updmap; dvips, pdftex, etc., +do not know anything about them. They work by changing the default map +file which the programs read, so they can be overridden by specifying +command\-line options or configuration files to the programs, as +explained at the beginning of updmap.cfg. +.SH ENVIRONMENT +.PP +Explanation of trees and files normally used: +.IP +updmap both reads and writes TEXMFCONFIG/web2c/updmap.cfg, according to +the actions specified. +.IP +updmap writes the map files for dvips (psfonts.map) and pdftex +(pdftex.map) to the TEXMFVAR/fonts/map/updmap/{dvips,pdftex}/ +directories. +.IP +The log file is written to TEXMFVAR/web2c/updmap.log. +.IP +When updmap\-sys is run, TEXMFSYSCONFIG and TEXMFSYSVAR are used +instead. This is the only difference between updmap\-sys and updmap. +.IP +Other locations can be used if overridden on the command line, or these +trees don't exist, or you are not using the original TeX Live. +.IP +To see the precise locations of the various files that +will be read and written, give the \fB\-n\fR option (or read the man page). +.SH EXAMPLES +.PP +For step\-by\-step instructions on making new fonts known to TeX, read +http://tug.org/fonts/fontinstall.html. For even more terse +instructions, read the beginning of updmap.cfg. +.SH FILES Configuration and input files: .IP "\fIupdmap\&.cfg\fP" Main configuration file\&. In \fItexmf/web2c\fP by default, but may be located elsewhere depending on your distribution\&. -.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 +Same as \fIpsfonts_t1\&.map\fP if option \fBdvipsPreferOutline\fP active, +else as \fIpsfonts_pk\&.map\fP. .IP "\fIpsfonts_pk\&.map\fP" For \fBdvips\fP(1)\&. Without information from MixedMap files\&. (Setting of \fBdvipsPreferOutline\fP ignored\&.) -.IP .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 +Same as \fIpdftex_dl14\&.map\fP if option \fBpdftexDownloadBase14\fP active, +else as \fIpdftex_ndl14\&.map\fP. .IP "\fIpdftex_dl14\&.map\fP" For \fBpdftex\fP(1)\&. Always downloads the standard 14 fonts\&. -.IP .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 +Configuration files for \fBdvips\fP(1): .IP "\fIconfig\&.builtin35\fP" Loads \fIbuiltin35\&.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 +(For compatibility with old versions\&.) .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\fP -.PP -.SH "BUGS" -.PP -None known, but report any bugs found to (mailing list)\&. -.PP -.SH "AUTHOR" -.PP -\fBupdmap\fP was written by Thomas Esser - and is in the public domain\&. -.PP -This manual page was written by C\&.M\&. Connelly -, for -the Debian GNU/Linux system and later slightly adapted for teTeX 3\&. +.SH "REPORTING BUGS" +Report bugs to: tex\-k@tug.org +.br +TeX Live home page: -- cgit v1.2.3