From a018954444adab7c33016ce804ea49ec54b8b4b2 Mon Sep 17 00:00:00 2001 From: Peter Breitenlohner Date: Mon, 17 May 2010 07:58:30 +0000 Subject: manpage formatting, also adapt to facts git-svn-id: svn://tug.org/texlive/trunk@18297 c570f23f-e606-0410-a88d-b1316a301751 --- Build/source/texk/kpathsea/man/Makefile.in | 1 + Build/source/texk/kpathsea/man/kpseaccess.man | 13 +++++++--- Build/source/texk/web2c/man/ChangeLog | 9 +++++++ Build/source/texk/web2c/man/aleph.man | 30 ++++++++++++++-------- Build/source/texk/web2c/man/amstex.man | 4 +-- Build/source/texk/web2c/man/eplain.man | 4 +-- Build/source/texk/web2c/man/etex.man | 23 +++++++++-------- Build/source/texk/web2c/man/latex.man | 4 +-- Build/source/texk/web2c/man/luatex.man | 37 +++++++++++++++++---------- Build/source/texk/web2c/man/mf.man | 14 +++++----- Build/source/texk/web2c/man/mpost.man | 15 ++++++----- Build/source/texk/web2c/man/pdfetex.man | 6 ++--- Build/source/texk/web2c/man/pdftex.man | 23 +++++++++-------- Build/source/texk/web2c/man/tex.man | 20 +++++++-------- 14 files changed, 122 insertions(+), 81 deletions(-) diff --git a/Build/source/texk/kpathsea/man/Makefile.in b/Build/source/texk/kpathsea/man/Makefile.in index 11dd1f8c399..ecc1d6e98b7 100644 --- a/Build/source/texk/kpathsea/man/Makefile.in +++ b/Build/source/texk/kpathsea/man/Makefile.in @@ -122,6 +122,7 @@ LIBTOOL = @LIBTOOL@ LIPO = @LIPO@ LN_S = @LN_S@ LTLIBOBJS = @LTLIBOBJS@ +LT_OBJDIR = @LT_OBJDIR@ MAINT = @MAINT@ MAKEINFO = @MAKEINFO@ MKDIR_P = @MKDIR_P@ diff --git a/Build/source/texk/kpathsea/man/kpseaccess.man b/Build/source/texk/kpathsea/man/kpseaccess.man index 91af3e85c1b..836cc6077b8 100644 --- a/Build/source/texk/kpathsea/man/kpseaccess.man +++ b/Build/source/texk/kpathsea/man/kpseaccess.man @@ -1,4 +1,4 @@ -.TH KPSEACCESS 1 "7 April 2010" "Kpathsea @VERSION@" +.TH KPSEACCESS 1 "16 May 2010" "Kpathsea @VERSION@" .\"===================================================================== .if n .ds MP MetaPost .if t .ds MP MetaPost @@ -20,14 +20,19 @@ kpseaccess \- determine whether a file can be accessed .SH SYNOPSIS .B kpseaccess -.RB [ \-rwx ] +.I mode .I file .\"===================================================================== .SH DESCRIPTION Exit successfully if .I file -can be accessed with the specified mode. -The mode is one or more letters of +can be accessed with the specified +.IR mode . +The +.I mode +is an optional dash +.RB (` \- ') +followed by zero or more letters of .BR rwx , where .B r diff --git a/Build/source/texk/web2c/man/ChangeLog b/Build/source/texk/web2c/man/ChangeLog index 8d4601b868b..6fc417373b1 100644 --- a/Build/source/texk/web2c/man/ChangeLog +++ b/Build/source/texk/web2c/man/ChangeLog @@ -1,3 +1,12 @@ +2010-05-14 Peter Breitenlohner + + * aleph.man, amstex.man, eplain.man, etex.man, latex.man, + luatex.man, mf.man, mpost.man, pdfetex.man, pdftex.man, tex.man: + Uniform manpage formatting: bold for literals, italic for + variable items, roman for meta items. Adapt to facts. + + * mpost.man: FIXME: need to define the macro URL. + 2010-04-10 Peter Breitenlohner * ctie.man (new): Instead of ../ctiedir/ctie.1. diff --git a/Build/source/texk/web2c/man/aleph.man b/Build/source/texk/web2c/man/aleph.man index 1345102956a..afdd8a46edc 100644 --- a/Build/source/texk/web2c/man/aleph.man +++ b/Build/source/texk/web2c/man/aleph.man @@ -1,4 +1,4 @@ -.TH ALEPH 1 "1 February 2010" "Web2C @VERSION@" +.TH ALEPH 1 "14 May 2010" "Web2C @VERSION@" .\"===================================================================== .if n .ds MF Metafont .if t .ds MF M\s-2ETAFONT\s0 @@ -23,8 +23,8 @@ aleph \- extended Unicode TeX .SH SYNOPSIS .B aleph .RI [ options ] -[\fB&\fR \fIformat\fR ] -[ \fIfile\fR | \fB\e\fR \fIcommands\fR ] +.RI [ \fB&\fPformat ] +.RI [ file | \fB\e\fPcommands ] .\"===================================================================== .SH DESCRIPTION Run the Aleph typesetter on @@ -38,7 +38,7 @@ With a .BI & format argument Aleph uses a different set of precompiled commands, contained in -.IR format.fmt ; +.IR format\fB.fmt\fP ; it is usually better to use the .B -fmt .I format @@ -57,7 +57,16 @@ activity. Run aleph --help to see the complete list of options; this is not exhaustive. .TP -.B -halt-on-error +.BI --fmt \ format +.rb +Use +.I format +as the name of the format to be used, instead of the name by which +Aleph was called or a +.I %& +line. +.TP +.B --halt-on-error .rb Exit with an error code when an error is encountered during processing. .TP @@ -128,8 +137,9 @@ Use .I string for the DVI file comment instead of the date. .TP -.BI -output-directory \ directory -.rb Write output files in +.BI --output-directory \ directory +.rb +Write output files in .I directory instead of the current directory. Look up input files in .I directory @@ -180,7 +190,7 @@ expanded, not taken as part of the filename. Other programs, such as \*(MF, do not have this problem. .PP .TP -TEXMFOUTPUT +.B TEXMFOUTPUT Normally, Aleph puts its output files in the current directory. If any output file cannot be opened there, it tries to open it in the directory specified in the environment variable TEXMFOUTPUT. @@ -198,7 +208,7 @@ files, as \*(TX often generates files that need to be subsequently read; for input, no suffixes (such as ``.tex'') are added by default, the input name is simply checked as given. .TP -TEXINPUTS +.B TEXINPUTS Search path for .I \einput and @@ -211,7 +221,7 @@ component will be replaced with the paths defined in the file. For example, set TEXINPUTS to ".:/home/user/tex:" to prepend the current direcory and ``/home/user/tex'' to the standard search path. .TP -TEXEDIT +.B TEXEDIT Command template for switching to editor. The default, usually .BR vi , is set when Aleph is compiled. diff --git a/Build/source/texk/web2c/man/amstex.man b/Build/source/texk/web2c/man/amstex.man index a6263bb3d6e..47f6b0f8867 100644 --- a/Build/source/texk/web2c/man/amstex.man +++ b/Build/source/texk/web2c/man/amstex.man @@ -1,4 +1,4 @@ -.TH AMSTEX 1 "12 August 2008" "Web2C @VERSION@" +.TH AMSTEX 1 "14 May 2010" "Web2C @VERSION@" .\"===================================================================== .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 @@ -20,7 +20,7 @@ amstex \- structured text formatting and typesetting .SH SYNOPSIS .B amstex -[ first line ] +.RI [ first-line ] .\"===================================================================== .SH DESCRIPTION This manual page is not meant to be exhaustive. The complete diff --git a/Build/source/texk/web2c/man/eplain.man b/Build/source/texk/web2c/man/eplain.man index e9a1805e022..69d8593518a 100644 --- a/Build/source/texk/web2c/man/eplain.man +++ b/Build/source/texk/web2c/man/eplain.man @@ -1,4 +1,4 @@ -.TH EPLAIN 1 "14 December 1993" "Web2C @VERSION@" +.TH EPLAIN 1 "14 May 2010" "Web2C @VERSION@" .\"===================================================================== .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 @@ -20,7 +20,7 @@ eplain \- extended plain TeX .SH SYNOPSIS .B eplain -[ first-line ] +.RI [ first-line ] .\"===================================================================== .SH DESCRIPTION This manual page is not meant to be exhaustive. The complete diff --git a/Build/source/texk/web2c/man/etex.man b/Build/source/texk/web2c/man/etex.man index 651b2567e4b..57e763b463e 100644 --- a/Build/source/texk/web2c/man/etex.man +++ b/Build/source/texk/web2c/man/etex.man @@ -1,4 +1,4 @@ -.TH ETEX 1 "1 February 2010" "pdftex 1.40" "Web2C @VERSION@" +.TH ETEX 1 "14 May 2010" "pdftex 1.40" "Web2C @VERSION@" .\"===================================================================== .if n .ds MF Metafont .if t .ds MF M\s-2ETAFONT\s0 @@ -27,8 +27,8 @@ etex \- extended (plain) TeX .SH SYNOPSIS .B etex .RI [ options ] -[\fB&\fR \fIformat\fR ] -[ \fIfile\fR | \fB\e\fR \fIcommands\fR ] +.RI [ \fB&\fPformat ] +.RI [ file | \fB\e\fPcommands ] .\"===================================================================== .SH DESCRIPTION Run the e-\*(TX typesetter on @@ -42,7 +42,7 @@ With a .BI & format argument e-\*(TX uses a different set of precompiled commands, contained in -.IR format.fmt ; +.IR format\fB.fmt\fP ; it is usually better to use the .B -fmt .I format @@ -202,7 +202,8 @@ for the file comment instead of the date. .TP .BI -output-directory \ directory -.rb Write output files in +.rb +Write output files in .I directory instead of the current directory. Look up input files in .I directory @@ -303,7 +304,7 @@ expanded, not taken as part of the filename. Other programs, such as \*(MF, do not have this problem. .PP .TP -TEXMFOUTPUT +.B TEXMFOUTPUT Normally, e-\*(TX puts its output files in the current directory. If any output file cannot be opened there, it tries to open it in the directory specified in the environment variable TEXMFOUTPUT. @@ -321,7 +322,7 @@ files, as \*(TX often generates files that need to be subsequently read; for input, no suffixes (such as ``.tex'') are added by default, the input name is simply checked as given. .TP -TEXINPUTS +.B TEXINPUTS Search path for .I \einput and @@ -334,20 +335,20 @@ component will be replaced with the paths defined in the file. For example, set TEXINPUTS to ".:/home/user/tex:" to prepend the current direcory and ``/home/user/tex'' to the standard search path. .TP -TEXFORMATS +.B TEXFORMATS Search path for format files. .TP -TEXPOOL +.B TEXPOOL search path for .B etex internal strings. .TP -TEXEDIT +.B TEXEDIT Command template for switching to editor. The default, usually .BR vi , is set when e-\*(TX is compiled. .TP -TFMFONTS +.B TFMFONTS Search path for font metric .RI ( .tfm ) files. diff --git a/Build/source/texk/web2c/man/latex.man b/Build/source/texk/web2c/man/latex.man index 0637c4f0c41..45abb53145b 100644 --- a/Build/source/texk/web2c/man/latex.man +++ b/Build/source/texk/web2c/man/latex.man @@ -1,4 +1,4 @@ -.TH LATEX 1 "7 January 2007" "Web2C @VERSION@" +.TH LATEX 1 "14 May 2010" "Web2C @VERSION@" .\"===================================================================== .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 @@ -16,7 +16,7 @@ latex, elatex, lambda, pdflatex \- structured text formatting and typesetting .SH SYNOPSIS .B latex -[ first line ] +.RI [ first-line ] .\"===================================================================== .SH DESCRIPTION .PP diff --git a/Build/source/texk/web2c/man/luatex.man b/Build/source/texk/web2c/man/luatex.man index 553cbc518c1..1879f7233b3 100644 --- a/Build/source/texk/web2c/man/luatex.man +++ b/Build/source/texk/web2c/man/luatex.man @@ -1,4 +1,4 @@ -.TH LUATEX 1 "2009.04.22" "luatex 0.40" "Web2C @VERSION@" +.TH LUATEX 1 "14 May 2010" "luatex 0.40" "Web2C @VERSION@" .\"===================================================================== .if n .ds MF Metafont .if t .ds MF M\s-2ETAFONT\s0 @@ -13,18 +13,31 @@ an embedded scripting language .\"===================================================================== .SH SYNOPSIS .B luatex -[\-\-lua=\fIFILE\fR] [\fIOPTION\fR]... [\fITEXNAME\fR[.tex]] [\fICOMMANDS\fR] - +.RB [ \-\-lua=\fIFILE\fP ] +.RI [ OPTION ].\|.\|. +.RI [ TEXNAME [ \fB.tex\fP ]] +.RI [ COMMANDS ] +.br .B luatex -[\-\-lua=\fIFILE\fR] [\fIOPTION\fR]... \fI\eFIRST\-LINE\fR - +.RB [ \-\-lua=\fIFILE\fP ] +.RI [ OPTION ].\|.\|. +.BI \e FIRST\-LINE +.br .B luatex -[\-\-lua=\fIFILE\fR] [\fIOPTION\fR]... \fB&\fIFMT ARGS\fR +.RB [ \-\-lua=\fIFILE\fP ] +.RI [ OPTION ].\|.\|. +.BI & FMT +.RI [ ARGS ] .\"===================================================================== .SH DESCRIPTION -Run the lua\*(TX typesetter on \fITEXNAME\fR, usually creating -TEXNAME.pdf. Any -remaining \fICOMMANDS\fR are processed as lua\*(TX input, after TEXNAME +Run the lua\*(TX typesetter on +.IR TEXNAME , +usually creating +.IR TEXNAME\fB.pdf\fP . +Any remaining +.I COMMANDS +are processed as lua\*(TX input, after +.I TEXNAME is read. Alternatively, if the first non\-option argument begins with a backslash, @@ -234,13 +247,11 @@ Print credits and version details. .TP The following options are ignored: .TP -.BR "\-\-8bit" ,\ "\-\-etex" ,\ "\-\-parse\-first\-line" ,\ -"\-\-no\-parse\-first\-line" +.BR \-\-8bit ,\ \-\-etex ,\ \-\-parse\-first\-line ,\ \-\-no\-parse\-first\-line .rb These are always on. .TP -.BI "\-\-default\-translate\-file=" TCXNAME , \ "\-\-translate\-file=" -TCXNAME +.BR \-\-default\-translate\-file=\fITCXNAME\fP ,\ \-\-translate\-file=\fITCXNAME\fP .rb These are always off. diff --git a/Build/source/texk/web2c/man/mf.man b/Build/source/texk/web2c/man/mf.man index f535a37252c..a6d2a5196bd 100644 --- a/Build/source/texk/web2c/man/mf.man +++ b/Build/source/texk/web2c/man/mf.man @@ -1,5 +1,5 @@ .\" t -.TH MF 1 "10 November 2001" "Web2C @VERSION@" +.TH MF 1 "14 May 2010" "Web2C @VERSION@" .\"===================================================================== .if n .ds MF Metafont .if t .ds MF M\s-2ETAFONT\s0 @@ -331,7 +331,8 @@ must be .IR mf . .TP .BI -output-directory \ directory -.rb Write output files in +.rb +Write output files in .I directory instead of the current directory. Look up input files in .I directory @@ -379,21 +380,22 @@ searching. The 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 +.B TEXMFOUTPUT +is set, \*(MF attempts to put its output files in it, if they cannot be put in the current directory. Again, see .BR tex (1). .TP -MFINPUTS +.B MFINPUTS Search path for .I input and .I openin files. .TP -MFEDIT +.B MFEDIT Command template for switching to editor. .TP -MFTERM +.B MFTERM Determines the online graphics display. If MFTERM is not set, and DISPLAY is set, the Metafont window support for X is used. (DISPLAY must be set to a valid X server specification, as usual.) diff --git a/Build/source/texk/web2c/man/mpost.man b/Build/source/texk/web2c/man/mpost.man index 59df395d0dd..380436f1aea 100644 --- a/Build/source/texk/web2c/man/mpost.man +++ b/Build/source/texk/web2c/man/mpost.man @@ -1,4 +1,4 @@ -.TH MPOST 1 "27 May 2009" "MetaPost 1.201" +.TH MPOST 1 "14 May 2010" "MetaPost 1.201" .\"===================================================================== .if n .ds MP MetaPost .if t .ds MP MetaPost @@ -27,8 +27,8 @@ mpost \- MetaPost, a system for creating graphics .PP .B mpost .B --dvitomp -.IR dvifile [.dvi] -.RI [ mpxfile [.mpx]] +.IR dvifile [\fB.dvi\fP] +.RI [ mpxfile [\fB.mpx\fP]] .\"===================================================================== .SH DESCRIPTION @@ -140,10 +140,11 @@ Addison-Wesley, 1986, ISBN 0-201-13445-4. .BR mf (1), .BR mptopdf (1), .BR tex (1), -.PP -.URL "http://foundry.supelec.fr/gf/project/metapost/" "MetaPost source code" . -.BR -.URL "http://tug.org/metapost/" "MetaPost home page" . +.\" FIXME: need to define the macro URL! +.\" .PP +.\" .URL "http://foundry.supelec.fr/gf/project/metapost/" "MetaPost source code" . +.\" .BR +.\" .URL "http://tug.org/metapost/" "MetaPost home page" . .\"===================================================================== .SH AUTHORS \*(MP was designed by John D. Hobby, incorporating algorithms from diff --git a/Build/source/texk/web2c/man/pdfetex.man b/Build/source/texk/web2c/man/pdfetex.man index 7aea1034fdf..e0ad1257cfe 100644 --- a/Build/source/texk/web2c/man/pdfetex.man +++ b/Build/source/texk/web2c/man/pdfetex.man @@ -1,4 +1,4 @@ -.TH PDFETEX 1 "1 February 2010" "pdftex 1.40" "Web2C @VERSION@" +.TH PDFETEX 1 "14 May 2010" "pdftex 1.40" "Web2C @VERSION@" .\"===================================================================== .if n .ds MF Metafont .if t .ds MF M\s-2ETAFONT\s0 @@ -25,8 +25,8 @@ pdfetex \- PDF output from e-TeX .SH SYNOPSIS .B pdfetex .RI [ options ] -[\fB&\fR \fIformat\fR ] -[ \fIfile\fR | \fB\e\fR \fIcommands\fR ] +.RI [ \fB&\fPformat ] +.RI [ file | \fB\e\fPcommands ] .\"===================================================================== .SH DESCRIPTION pdfe\*(TX is another name for pdf\*(TX; they behave identically. diff --git a/Build/source/texk/web2c/man/pdftex.man b/Build/source/texk/web2c/man/pdftex.man index f291eb58f06..bad15ed0265 100644 --- a/Build/source/texk/web2c/man/pdftex.man +++ b/Build/source/texk/web2c/man/pdftex.man @@ -1,4 +1,4 @@ -.TH PDFTEX 1 "1 February 2010" "pdftex 1.40" "Web2C @VERSION@" +.TH PDFTEX 1 "14 May 2010" "pdftex 1.40" "Web2C @VERSION@" .\"===================================================================== .if n .ds MF Metafont .if t .ds MF M\s-2ETAFONT\s0 @@ -27,8 +27,8 @@ pdftex, pdfinitex, pdfvirtex \- PDF output from TeX .SH SYNOPSIS .B pdftex .RI [ options ] -[\fB&\fR \fIformat\fR ] -[ \fIfile\fR | \fB\e\fR \fIcommands\fR ] +.RI [ \fB&\fPformat ] +.RI [ file | \fB\e\fPcommands ] .\"===================================================================== .SH DESCRIPTION Run the pdf\*(TX typesetter on @@ -42,7 +42,7 @@ With a .BI & format argument pdf\*(TX uses a different set of precompiled commands, contained in -.IR format.fmt ; +.IR format\fB.fmt\fP ; it is usually better to use the .B -fmt .I format @@ -242,7 +242,8 @@ in mode. .TP .BI -output-directory \ directory -.rb Write output files in +.rb +Write output files in .I directory instead of the current directory. Look up input files in .I directory @@ -364,7 +365,7 @@ expanded, not taken as part of the filename. Other programs, such as \*(MF, do not have this problem. .PP .TP -TEXMFOUTPUT +.B TEXMFOUTPUT Normally, pdf\*(TX puts its output files in the current directory. If any output file cannot be opened there, it tries to open it in the directory specified in the environment variable TEXMFOUTPUT. @@ -382,7 +383,7 @@ files, as \*(TX often generates files that need to be subsequently read; for input, no suffixes (such as ``.tex'') are added by default, the input name is simply checked as given. .TP -TEXINPUTS +.B TEXINPUTS Search path for .I \einput and @@ -395,20 +396,20 @@ component will be replaced with the paths defined in the file. For example, set TEXINPUTS to ".:/home/user/tex:" to prepend the current directory and ``/home/user/tex'' to the standard search path. .TP -TEXFORMATS +.B TEXFORMATS Search path for format files. .TP -TEXPOOL +.B TEXPOOL search path for .B pdftex internal strings. .TP -TEXEDIT +.B TEXEDIT Command template for switching to editor. The default, usually .BR vi , is set when pdf\*(TX is compiled. .TP -TFMFONTS +.B TFMFONTS Search path for font metric .RI ( .tfm ) files. diff --git a/Build/source/texk/web2c/man/tex.man b/Build/source/texk/web2c/man/tex.man index c7e2776fff3..fcec2347109 100644 --- a/Build/source/texk/web2c/man/tex.man +++ b/Build/source/texk/web2c/man/tex.man @@ -1,4 +1,4 @@ -.TH TEX 1 "1 February 2010" "Web2C @VERSION@" +.TH TEX 1 "14 May 2010" "Web2C @VERSION@" .\"===================================================================== .if n .ds MF Metafont .if t .ds MF M\s-2ETAFONT\s0 @@ -32,8 +32,8 @@ tex, virtex, initex \- text formatting and typesetting .SH SYNOPSIS .B tex .RI [ options ] -[\fB&\fR \fIformat\fR ] -[ \fIfile\fR | \fB\e\fR \fIcommands\fR ] +.RI [ \fB&\fPformat ] +.RI [ file | \fB\e\fPcommands ] .\"===================================================================== .SH DESCRIPTION Run the \*(TX typesetter on @@ -47,7 +47,7 @@ With a .BI & format argument \*(TX uses a different set of precompiled commands, contained in -.IR format.fmt ; +.IR format\fB.fmt\fP ; it is usually better to use the .B -fmt .I format @@ -411,7 +411,7 @@ expanded, not taken as part of the filename. Other programs, such as \*(MF, do not have this problem. .PP .TP -TEXMFOUTPUT +.B TEXMFOUTPUT Normally, \*(TX puts its output files in the current directory. If any output file cannot be opened there, it tries to open it in the directory specified in the environment variable TEXMFOUTPUT. @@ -429,7 +429,7 @@ files, as \*(TX often generates files that need to be subsequently read; for input, no suffixes (such as ``.tex'') are added by default, the input name is simply checked as given. .TP -TEXINPUTS +.B TEXINPUTS Search path for .I \einput and @@ -442,20 +442,20 @@ component will be replaced with the paths defined in the file. For example, set TEXINPUTS to ".:/home/user/tex:" to prepend the current directory and ``/home/user/tex'' to the standard search path. .TP -TEXFORMATS +.B TEXFORMATS Search path for format files. .TP -TEXPOOL +.B TEXPOOL search path for .B tex internal strings. .TP -TEXEDIT +.B TEXEDIT Command template for switching to editor. The default, usually .BR vi , is set when \*(TX is compiled. .TP -TFMFONTS +.B TFMFONTS Search path for font metric .RI ( .tfm ) files. -- cgit v1.2.3