texlive[49845] Build/source/texk/web2c/man: Update CWEB manpages.
commits+ascherer at tug.org
commits+ascherer at tug.org
Mon Jan 28 07:33:20 CET 2019
Revision: 49845
http://tug.org/svn/texlive?view=revision&revision=49845
Author: ascherer
Date: 2019-01-28 07:33:20 +0100 (Mon, 28 Jan 2019)
Log Message:
-----------
Update CWEB manpages.
Modified Paths:
--------------
trunk/Build/source/texk/web2c/man/ChangeLog
trunk/Build/source/texk/web2c/man/ctwill.man
trunk/Build/source/texk/web2c/man/cweb.man
Modified: trunk/Build/source/texk/web2c/man/ChangeLog
===================================================================
--- trunk/Build/source/texk/web2c/man/ChangeLog 2019-01-28 02:26:31 UTC (rev 49844)
+++ trunk/Build/source/texk/web2c/man/ChangeLog 2019-01-28 06:33:20 UTC (rev 49845)
@@ -1,3 +1,8 @@
+2019-01-28 Andreas Scherer <https://ascherer.github.io>
+
+ * ctwill.man,
+ * cweb.man: Updated manpages; describe differences to original CWEB.
+
2019-01-10 Andreas Scherer <https://ascherer.github.io>
* ctwill.man: New manpage for CTWILL and its tools.
Modified: trunk/Build/source/texk/web2c/man/ctwill.man
===================================================================
--- trunk/Build/source/texk/web2c/man/ctwill.man 2019-01-28 02:26:31 UTC (rev 49844)
+++ trunk/Build/source/texk/web2c/man/ctwill.man 2019-01-28 06:33:20 UTC (rev 49845)
@@ -1,6 +1,6 @@
.\" Automatically generated by Pandoc 2.5
.\"
-.TH "CTWILL" "1" "January 11, 2019" "Web2c @VERSION@" "General Commands Manual"
+.TH "CTWILL" "1" "January 27, 2019" "Web2c @VERSION@" "General Commands Manual"
.hy
.SH NAME
.PP
@@ -24,8 +24,8 @@
index.tex
.SH DESCRIPTION
.PP
-The \f[B]ctwill\f[R] program converts a CWEB source document into a TeX
-file that may be formatted and printed in the usual way.
+The \f[B]ctwill\f[R] program converts a CWEB source document 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, \f[I]italics\f[R], \f[B]boldface\f[R], etc., and
it supplies extensive cross\-index information that it gathers
@@ -32,10 +32,11 @@
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.
+information that is needed both to produce a compilable C/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/C++.
+.SH USAGE
.PP
The command line should have one, two, or three names on it.
The first is taken as the CWEB input file (and \f[B].w\f[R] is added if
@@ -89,7 +90,7 @@
.PP
The meaning specified by \f[B]\[at]$\&...\[at]>\f[R] generally has four
components: an identifier (followed by space), a program name (enclosed
-in braces), a section number (followed by space), and a TeX part.
+in braces), a section number (followed by space), and a TeX\ part.
.PP
A special \f[I]proofmode\f[R] is provided so that you can check
\f[B]ctwill\f[R]\[cq]s conclusions about cross\-references.
@@ -100,6 +101,33 @@
More details how to use \f[B]ctwill\f[R] can be found in the first
sections of its source code, respectively the change file
\f[B]cweav\-twill.ch\f[R] applicable to the \f[B]cweave.w\f[R] source.
+.SH DIFFERENCES TO ORIGINAL CTWILL
+.PP
+The present incarnation of \f[B]ctwill\f[R] and its utilities tries hard
+to be a drop\-in replacement for the original package.
+There are, however, a few differences worth noting:
+.IP \[bu] 2
+This version is based on the most recent version of CWEB (3.64c).
+.IP \[bu] 2
+In TeX\ Live the utility programs are prefixed with \f[B]ctwill\-\f[R]
+and the macro files with \f[B]ct\f[R] for technical reasons.
+.IP \[bu] 2
+Options \f[B]\-\-help\f[R], \f[B]\-\-quiet\f[R], \f[B]\-\-verbose\f[R],
+\f[B]\-\-version\f[R], and flags \f[B]\-i\f[R], \f[B]\-o\f[R], and
+\f[B]+lX\f[R] are new in CWEBbin and TeX\ Live.
+.IP \[bu] 2
+Option \f[B]+lX\f[R] is accompanied by example wrapper files for
+\f[B]ctwimac.tex\f[R] and \f[B]ctproofmac.tex\f[R] with translated
+captions for German (\f[B]+ld\f[R]).
+.IP \[bu] 2
+\f[B]ctwill\f[R] in TeX\ Live operates silently by default; use the
+\f[B]\-\-verbose\f[R] option to get the original behavior.
+.IP \[bu] 2
+File lookup with the environment variable CWEBINPUTS is extended to
+permit several, colon\-separated, paths.
+.IP \[bu] 2
+If properly configured, the main program \f[B]ctwill\f[R] is localized
+with the \[lq]GNU gettext utilities\[rq].
.SH OPTIONS
.PP
Options on the command line may be either turned off with `\f[B]\-\f[R]'
@@ -106,7 +134,7 @@
(if they are on by default) or turned on with `\f[B]+\f[R]' (if they are
off by default).
In fact, the options are processed from left to right, so a sequence
-like \f[B]\[en]verbose \-h\f[R] will only show the \f[B]banner line\f[R]
+like \f[B]\-\-verbose \-h\f[R] will only show the \f[B]banner line\f[R]
(\f[B]+b\f[R]) and the \f[B]progress report\f[R] (\f[B]+p\f[R]), but
leave out the \f[B]happy message\f[R] (\f[B]\-h\f[R]).
.IP \[bu] 2
@@ -117,14 +145,15 @@
\f[B]+p\f[R]: print progress report messages
.IP \[bu] 2
\f[B]+q\f[R]/\f[B]\-q\f[R]: shortcut for \f[B]\-bhp\f[R]; also
-\f[B]\[en]quiet\f[R] (default)
+\f[B]\-\-quiet\f[R] (default)
.IP \[bu] 2
\f[B]+v\f[R]/\f[B]\-v\f[R]: shortcut for \f[B]+bhp\f[R]; also
-\f[B]\[en]verbose\f[R]
+\f[B]\-\-verbose\f[R]
.IP \[bu] 2
-\f[B]\-e\f[R]: do not enclose C material in \f[B]\f[R]
+\f[B]\-e\f[R]: do not enclose C/C++\ material in \f[B]\f[R]
.IP \[bu] 2
-\f[B]\-f\f[R]: do not force a newline after every C statement in output
+\f[B]\-f\f[R]: do not force a newline after every C/C++\ statement in
+output
.IP \[bu] 2
\f[B]\-i\f[R]: suppress indentation of parameter declarations
.IP \[bu] 2
@@ -140,20 +169,28 @@
.IP \[bu] 2
\f[B]+s\f[R]: print usage statistics
.IP \[bu] 2
-\f[B]\[en]help\f[R]: display help message and exit
+\f[B]\-\-help\f[R]: display help message and exit
.IP \[bu] 2
-\f[B]\[en]version\f[R]: output version information and exit
+\f[B]\-\-version\f[R]: output version information and exit
.SH ENVIRONMENT
.PP
The environment variable CWEBINPUTS is used to search for the input
files, or the system default if CWEBINPUTS is not set.
See tex(1) for the details of the searching.
+.PP
+If prepared for NLS support, \f[B]ctwill\f[R] like \f[B]ctangle\f[R] and
+\f[B]cweave\f[R] uses the environment variable TEXMFLOCALEDIR to
+configure the parent directory where the \[lq]GNU gettext utilities\[rq]
+search for translation catalogs.
+.PP
+These variables are preconfigured in TeX\ Live\[cq]s
+\f[B]texmf.cnf\f[R].
.SH FILES
.PP
The location of the files mentioned below varies from system to system.
Use the \f[B]kpsewhich\f[R] utility to find their locations.
.IP \[bu] 2
-\f[B]ctwimac.tex\f[R]: The default TeX macros \f[B]\[rs]input\f[R] in
+\f[B]ctwimac.tex\f[R]: The default TeX\ macros \f[B]\[rs]input\f[R] in
the first line of the output file.
.IP \[bu] 2
\f[B]ctproofmac.tex\f[R]: If \f[B]ctwill\f[R] is invoked with the
@@ -168,14 +205,15 @@
\f[I]webfile\f[R]\f[B].bux\f[R]: Reference definitions to resolve from
other modules.
.IP \[bu] 2
-\f[B]system.bux\f[R]: Reference definitions to resolve from C standard
-library header files like \f[B]<stdio.h>\f[R].
+\f[B]system.bux\f[R]: Reference definitions to resolve from
+C/C++\ standard library header files like \f[B]<stdio.h>\f[R].
.PP
Other \f[B]aux\f[R]iliary files with references are created
automatically by \f[B]ctwill\f[R] and the actual index files are created
by TeX.
.IP \[bu] 2
-\f[B]cwebman.tex\f[R]: The CWEB user manual.
+\f[B]cwebman.tex\f[R]: The CWEB user manual, available in PDF from
+CTAN (https://ctan.org/pkg/cweb).
.SH SEE ALSO
.IP \[bu] 2
The CWEB System of Structured Documentation: by Donald E.\ Knuth and
@@ -188,11 +226,14 @@
Weaving a Program: by Wayne Sewell.
.PP
cweb(1), tex(1), cc(1)
+.SH AUTHORS
.PP
+Don Knuth wrote \f[B]ctwill\f[R] based on \f[B]cweave\f[R] by Silvio
+Levy and Knuth.
+.PD 0
+.P
+.PD
As of 2019, \f[B]ctwill\f[R] and its utilities \f[B]ctwill-refsort\f[R] and
\f[B]ctwill-twinx\f[R] have been fully integrated with the extended CWEBbin
-system that serves as the basis for CWEB in TeX Live; see the project
+system that serves as the basis for CWEB in TeX\ Live; see the project
page (https://github.com/ascherer/cwebbin).
-.SH AUTHORS
-Don Knuth wrote \f[B]ctwill\f[R] based on \f[B]cweave\f[R] by Silvio
-Levy and Knuth.
Modified: trunk/Build/source/texk/web2c/man/cweb.man
===================================================================
--- trunk/Build/source/texk/web2c/man/cweb.man 2019-01-28 02:26:31 UTC (rev 49844)
+++ trunk/Build/source/texk/web2c/man/cweb.man 2019-01-28 06:33:20 UTC (rev 49845)
@@ -1,162 +1,171 @@
-.TH CWEB 1 "10 January 2018" "Web2C @VERSION@"
-.\"=====================================================================
+.\" Automatically generated by Pandoc 2.5
+.\"
+.TH "CWEB" "1" "January 27, 2019" "Web2c @VERSION@" "General Commands Manual"
+.hy
.SH NAME
-ctangle, cweave \- translate CWEB to C and/or TeX
-.\"=====================================================================
+.PP
+ctangle, cweave \[en] translate CWEB to TeX
.SH SYNOPSIS
-.B ctangle
-.RB [ +bhps ]
-.IR webfile [ \fB.w\fP ]
-.RI [{ changefile [ \fB.ch\fP ]| \fB\-\fP }
-.RI [ outfile [ \fB.c\fP ]]]
-.br
-.B cweave
-.RB [ +bhps ]
-.RB [ \-efiox ]
-.RB [ \-lX | +lX ]
-.IR webfile [ \fB.w\fP ]
-.RI [{ changefile [ \fB.ch\fP ]| \fB\-\fP }
-.RI [ outfile [ \fB.tex\fP ]]]
-.\"=====================================================================
+.PP
+\f[B]ctangle\f[R] [\f[I]options\f[R]] \f[I]webfile\f[R][.w]
+[{\f[I]changefile\f[R][.ch]|\-} [\f[I]outfile\f[R][.c]]]
+.PD 0
+.P
+.PD
+\f[B]cweave\f[R] [\f[I]options\f[R]] \f[I]webfile\f[R][.w]
+[{\f[I]changefile\f[R][.ch]|\-} [\f[I]outfile\f[R][.tex]]]
.SH DESCRIPTION
-The
-.B 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
-.B 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.
+The \f[B]ctangle\f[R] program converts a CWEB source document into a
+C/C++\ program that may be compiled in the usual way.
+The output file includes \f[B]#line\f[R] specifications so that
+debugging can be done in terms of the CWEB source file.
.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.
+The \f[B]cweave\f[R] 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, \f[I]italics\f[R], \f[B]boldface\f[R], 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/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/C++.
+.SH USAGE
+.PP
The command line should have one, two, or three names on it.
-The first is taken as the CWEB file (and
-.B .w
-is added if there is no extension).
-If that file cannot be opened, the extension
-.B .web
-is tried instead. (But
-.B .w
-is recommended, since
-.B .web
-usually implies Pascal.)
-If there is a second name, it is a change file (and
-.B .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
-.B .c
-or
-.BR .tex .
+The first is taken as the CWEB input file (and \f[B].w\f[R] is added if
+there is no extension).
+If there is a second name, it is a change file (and \f[B].ch\f[R] is
+added if there is no extension).
+The change file overrides parts of the CWEB 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 \f[B].tex\f[R].
+If you just want to change the output file name, but don\[cq]t have a
+change file to apply, you can use `\f[B]\-\f[R]' as the second argument.
+.SH DIFFERENCES TO ORIGINAL CWEB
.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).
+CWEBbin tries hard to be a drop\-in replacement for CWEB, so in general
+you should not notice any differences in invoking the programs nor in
+the resulting output.
+There are, however, a few differences worth noting:
+.IP \[bu] 2
+Options \f[B]\-\-help\f[R], \f[B]\-\-quiet\f[R], \f[B]\-\-verbose\f[R],
+\f[B]\-\-version\f[R], and flags \f[B]\-i\f[R], \f[B]\-o\f[R], and
+\f[B]+lX\f[R] are new in CWEBbin and TeX\ Live.
+.IP \[bu] 2
+Option \f[B]+lX\f[R] is accompanied by several wrapper files for
+\f[B]cwebmac.tex\f[R] with translated captions for German
+(\f[B]+ld\f[R]), French (\f[B]+lf\f[R]), and Italian (\f[B]+li\f[R]).
+.IP \[bu] 2
+CWEB in TeX\ Live operates silently by default (as of 2019); use the
+\f[B]\-\-verbose\f[R] option to get the original behavior.
+.IP \[bu] 2
+File lookup with the environment variable CWEBINPUTS is extended to
+permit several, colon\-separated, paths.
+.IP \[bu] 2
+If properly configured, the main programs \f[B]ctangle\f[R] and
+\f[B]cweave\f[R] are localized with the \[lq]GNU gettext utilities\[rq].
+.SH OPTIONS
.PP
-Both programs operate silently by default (as of 2019).
+Options on the command line may be either turned off with `\f[B]\-\f[R]'
+(if they are on by default) or turned on with `\f[B]+\f[R]' (if they are
+off by default).
+In fact, the options are processed from left to right, so a sequence
+like \f[B]\-\-verbose \-h\f[R] will only show the \f[B]banner line\f[R]
+(\f[B]+b\f[R]) and the \f[B]progress report\f[R] (\f[B]+p\f[R]), but
+leave out the \f[B]happy message\f[R] (\f[B]\-h\f[R]).
.PP
-The
-.B +b
-option prints the banner line on your terminal
-when ctangle or cweave begins.
-The
-.B +h
-option prints the happy message if the processing
-was successful.
-The
-.B +p
-option prints progress reports (starred module numbers) as the processing
-takes place.
+The first batch of options are common to both \f[B]ctangle\f[R] and
+\f[B]cweave\f[R]:
+.IP \[bu] 2
+\f[B]+b\f[R]: print banner line on terminal
+.IP \[bu] 2
+\f[B]+h\f[R]: print success message on completion
+.IP \[bu] 2
+\f[B]+p\f[R]: print progress report messages
+.IP \[bu] 2
+\f[B]+q\f[R]/\f[B]\-q\f[R]: shortcut for \f[B]\-bhp\f[R]; also
+\f[B]\-\-quiet\f[R] (default)
+.IP \[bu] 2
+\f[B]+v\f[R]/\f[B]\-v\f[R]: shortcut for \f[B]+bhp\f[R]; also
+\f[B]\-\-verbose\f[R]
+.IP \[bu] 2
+\f[B]+s\f[R]: print usage statistics
+.IP \[bu] 2
+\f[B]\-\-help\f[R]: display help message and exit
+.IP \[bu] 2
+\f[B]\-\-version\f[R]: output version information and exit
.PP
-The
-.B +s
-option prints statistics about memory usage at the end of a run.
+There are six other options applicable to \f[B]cweave\f[R] only:
+.IP \[bu] 2
+\f[B]\-e\f[R]: do not enclose C/C++\ material in
+\f[B]\[rs]PB{\&...}\f[R]
+.IP \[bu] 2
+\f[B]\-f\f[R]: do not force a newline after every C/C++\ statement in
+output
+.IP \[bu] 2
+\f[B]\-i\f[R]: suppress indentation of parameter declarations
+.IP \[bu] 2
+\f[B]\-o\f[R]: suppress separation of declarations and statements
+.IP \[bu] 2
+\f[B]\-x\f[R]: omit indices, section names, table of contents
+.IP \[bu] 2
+\f[B]+lX\f[R]/\f[B]\-lX\f[R]: use macros for language \f[I]X\f[R] as of
+\f[I]X\f[R]\f[B]cwebmac.tex\f[R]
+.SH ENVIRONMENT
.PP
-There are six other options applicable to
-.B cweave
-only:
-.B \-e
-inhibits the enclosure of C\ material formatted by
-.B cweave
-in
-\ePB{.\|.\|.}
-brackets.
-Such brackets are normally inserted so that special hooks
-can be used by
-.I cweb-latex
-and similar programs.
-By default,
-\ePB{.\|.\|.}.
-is defined as a no-op.
-.B \-f
-means do not force a newline after every statement in the formatted output.
-.B \-i
-suppresses the indentation of parameter declarations.
-.B \-lX
-(or +lX) uses macros for language X\ from Xcwebmac.tex.
-.B \-o
-suppresses the visual separation of declarations and statements.
-.B \-x
-means omit the index and table of contents.
-.\"=====================================================================
-.SH ENVIRONMENT
-The environment variable CWEBINPUTS is used to search for the input files,
-or the system default if CWEBINPUTS is not set. See
-.BR tex (1)
-for the details of the searching.
-.\"=====================================================================
+The environment variable CWEBINPUTS is used to search for the input
+files, or the system default if CWEBINPUTS is not set.
+See tex(1) for the details of the searching.
+.PP
+If prepared for NLS support, \f[B]ctangle\f[R] and \f[B]cweave\f[R] use
+the environment variable TEXMFLOCALEDIR to configure the parent
+directory where the \[lq]GNU gettext utilities\[rq] search for
+translation catalogs.
+.PP
+These variables are preconfigured in TeX\ Live\[cq]s
+\f[B]texmf.cnf\f[R].
.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).
.PP
-.BR tex (1),
-.BR cc (1).
-.\"=====================================================================
+The location of the files mentioned below varies from system to system.
+Use the \f[B]kpsewhich\f[R] utility to find their locations.
+.IP \[bu] 2
+\f[B]cwebmac.tex\f[R]: The default TeX\ macros \f[B]\[rs]input\f[R] in
+the first line of the \f[B]cweave\f[R] output file.
+.IP \[bu] 2
+\f[B]cwebman.tex\f[R]: The CWEB user manual, available in PDF from
+CTAN (https://ctan.org/pkg/cweb).
+.SH SEE ALSO
+.IP \[bu] 2
+The CWEB System of Structured Documentation: by Donald E.\ Knuth and
+Silvio Levy (hardcopy version of \f[B]cwebman.tex\f[R] and the source
+code listings of \f[B]common.w\f[R], \f[B]ctangle.w\f[R], and
+\f[B]cweave.w\f[R]).
+.IP \[bu] 2
+Literate Programming: by D.\ E.\ Knuth.
+.IP \[bu] 2
+Weaving a Program: by Wayne Sewell.
+.PP
+cweb(1), tex(1), cc(1)
.SH AUTHORS
+.PP
Don Knuth wrote WEB for TeX and Pascal.
-.br
-Silvio Levy designed and developed CWEB
-by adapting the WEB conventions to\ C and by recoding everything in CWEB.
+.PD 0
+.P
+.PD
+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.
-.br
-As of 2019, the CWEB system in TeX Live is based on the CWEBbin extension
-that collects ideas and improvements from numerous contributors;
-see https://github.com/ascherer/cwebbin.
+.PD 0
+.P
+.PD
+As of 2019, the CWEB system in TeX\ Live is based on the CWEBbin
+extension that collects ideas and improvements from numerous
+contributors; see the project
+page (https://github.com/ascherer/cwebbin).
More information about the tex-live-commits
mailing list