diff options
Diffstat (limited to 'Master/texmf-dist/doc/man/man1/ctwill.1')
-rw-r--r-- | Master/texmf-dist/doc/man/man1/ctwill.1 | 47 |
1 files changed, 33 insertions, 14 deletions
diff --git a/Master/texmf-dist/doc/man/man1/ctwill.1 b/Master/texmf-dist/doc/man/man1/ctwill.1 index cfac2030f35..069733e6c8b 100644 --- a/Master/texmf-dist/doc/man/man1/ctwill.1 +++ b/Master/texmf-dist/doc/man/man1/ctwill.1 @@ -1,6 +1,20 @@ -.\" Automatically generated by Pandoc 2.11.4 +.\" Automatically generated by Pandoc .\" -.TH "CTWILL" "1" "February 6, 2021" "Web2c 2021" "General Commands Manual" +.\" Define V font for inline verbatim, using C font in formats +.\" that render this, and otherwise B font. +.ie "\f[CB]x\f[]"x" \{\ +. ftr V B +. ftr VI BI +. ftr VB B +. ftr VBI BI +.\} +.el \{\ +. ftr V CR +. ftr VI CI +. ftr VB CB +. ftr VBI CBI +.\} +.TH "CTWILL" "1" "February 5, 2022" "Web2c 2022" "General Commands Manual" .hy .SH NAME .PP @@ -16,8 +30,8 @@ ctwill, ctwill-refsort, ctwill-twinx - translate CWEB to TeX with mini-indexes .PD 0 .P .PD -\f[B]ctwill-twinx\f[R] \f[I]outfile\f[R].tex [\f[I]outfile\f[R].tex \&...] > -index.tex +\f[B]ctwill-twinx\f[R] \f[I]outfile\f[R].tex [\f[I]outfile\f[R].tex \&...] +> index.tex .SH DESCRIPTION .PP The \f[B]ctwill\f[R] program converts a CWEB source document into a @@ -48,7 +62,7 @@ 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. .PP \f[B]ctwill\f[R] is exactly like \f[B]cweave\f[R] except that it -produces much better documentation, for which you must work harder. +produces much better documentation, for which you must work much harder. You should run \f[B]ctwill\f[R] twice, once to prime the pump and once to get decent answers. Moreover, you must run the output twice through TeX. @@ -60,9 +74,14 @@ Say \f[B]ctwill-refsort < foo.ref > foo.sref\f[R] and then another \f[B]tex foo\f[R] will produce alphabetized output. .PP The \f[B]ctwill-twinx\f[R] program compiles a master index for a set of related -programs that have been processed by \f[B]ctwill\f[R]. +programs that have been processed by \f[B]ctwill\f[R] (\f[I]not\f[R] by +\f[B]cweave\f[R], mind you!). The individual programs should define their names with a line of the form \f[B]\[rs]def\[rs]title{NAME}\f[R]. +For your convenience, \f[B]ctwill-twinx\f[R] grabs the first \[lq]word\[rq] in +\f[B]\[rs]title\f[R] and turns it into uppercase form. +You should adapt file \f[B]twinx-startup.tex\f[R] for the first page of +the master index. .PP The mini-indexes list identifiers that are used but not defined on each two-page spread. @@ -106,13 +125,13 @@ 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 (4.2). +This version is based on the most recent version of CWEB (4.7). .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], \f[B]-t\f[R], +\f[B]--version\f[R], and flags \f[B]+c\f[R], \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 @@ -153,6 +172,8 @@ leave out the \f[B]happy message\f[R] (\f[B]-h\f[R]). \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]+c\f[R]: check temporary output for changes +.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 @@ -162,8 +183,6 @@ output .IP \[bu] 2 \f[B]-o\f[R]: suppress separation of declarations and statements .IP \[bu] 2 -\f[B]-t\f[R]: ignore temporary output irrespective of changes -.IP \[bu] 2 \f[B]-x\f[R]: omit indices, section names, table of contents .IP \[bu] 2 \f[B]+P\f[R]: \f[B]\[rs]input ctproofmac.tex\f[R] instead of @@ -174,6 +193,9 @@ output .IP \[bu] 2 \f[B]+s\f[R]: print usage statistics .IP \[bu] 2 +\f[B]+t\f[R]: treat \f[B]typename\f[R] in a template like +\f[B]typedef\f[R] +.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 @@ -246,7 +268,4 @@ Levy and Knuth. .PD 0 .P .PD -\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 CWEBbin extension that serves as the -basis for CWEB in TeX\ Live; see the project -page (https://github.com/ascherer/cwebbin). +Contemporary development on https://github.com/ascherer/cwebbin. |