summaryrefslogtreecommitdiff
path: root/Build/source/texk/web2c/man/ctwill.man
diff options
context:
space:
mode:
Diffstat (limited to 'Build/source/texk/web2c/man/ctwill.man')
-rw-r--r--Build/source/texk/web2c/man/ctwill.man87
1 files changed, 64 insertions, 23 deletions
diff --git a/Build/source/texk/web2c/man/ctwill.man b/Build/source/texk/web2c/man/ctwill.man
index e92a6e0b684..78820df93bd 100644
--- a/Build/source/texk/web2c/man/ctwill.man
+++ b/Build/source/texk/web2c/man/ctwill.man
@@ -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,18 +24,19 @@ with mini\-indexes per spread or per section
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
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 @@ Like the \f[B].aux\f[R] files, \f[B].bux\f[R] files should contain only
.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,13 +101,40 @@ you can check that your specifications are correct.
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]'
(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 @@ leave out the \f[B]happy message\f[R] (\f[B]\-h\f[R]).
\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 @@ leave out the \f[B]happy message\f[R] (\f[B]\-h\f[R]).
.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 @@ dctproofmac.tex\f[R].
\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 @@ Literate Programming: by D.\ E.\ Knuth.
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.