texlive[49673] Build/source/texk/web2c/man/ctwill.man: another

[commits+karl at tug.org]

Revision: 49673
          http://tug.org/svn/texlive?view=revision&revision=49673
Author:   karl
Date:     2019-01-11 23:52:18 +0100 (Fri, 11 Jan 2019)
Log Message:
-----------
another ctwill.man update, now via pandoc

Modified Paths:
--------------
    trunk/Build/source/texk/web2c/man/ctwill.man

Modified: trunk/Build/source/texk/web2c/man/ctwill.man
===================================================================
--- trunk/Build/source/texk/web2c/man/ctwill.man	2019-01-11 22:30:04 UTC (rev 49672)
+++ trunk/Build/source/texk/web2c/man/ctwill.man	2019-01-11 22:52:18 UTC (rev 49673)
@@ -1,158 +1,198 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
-.
-.TH "CTWILL" "1" "2019-01-10" "Web2C @VERSION@" "General Commands Manual"
-.
-.SH "NAME"
-\fBctwill\fR \- translate CWEB to TeX with mini\-indexes
-.
-.SH "SYNOPSIS"
-\fBctwill\fR [\fIoptions\fR] \fIwebfile\fR[\.w] [{\fIchangefile\fR[\.ch]|\-} [\fIoutfile\fR[\.tex]]]
-.
-.SH "DESCRIPTION"
-The \fBctwill\fR 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, \fIitalics\fR, \fBboldface\fR, etc\., and it supplies extensive cross\-index information that it gathers automatically\.
-.
+.\" Automatically generated by Pandoc 2.5
+.\"
+.TH "CTWILL" "1" "January 11, 2019" "Web2c @VERSION@" "General Commands Manual"
+.hy
+.SH NAME
+.PP
+ctwill, ctwill-refsort, ctwill-twinx \[en] translate CWEB to TeX
+.PD 0
 .P
-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\.
-.
+.PD
+with mini\-indexes per spread or per section
+.SH SYNOPSIS
+.PP
+\f[B]ctwill\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]]]
+.PD 0
 .P
-The command line should have one, two, or three names on it\. The first is taken as the CWEB input file (and \fB\.w\fR is added if there is no extension)\. If there is a second name, it is a change file (and \fB\.ch\fR 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 \fB\.tex\fR\. If you just want to change the output file name, but don\'t have a change file to apply, you can use \'\fB\-\fR\' as the second argument\.
-.
+.PD
+\f[B]ctwill-refsort\f[R] < \f[I]indexfile\f[R].ref > \f[I]indexfile\f[R].sref
+.PD 0
 .P
-\fBctwill\fR is exactly like \fBcweave\fR except that it produces much better documentation, for which you must work harder\. You should run \fBctwill\fR twice, once to prime the pump and once to get decent answers\. Moreover, you must run the output twice through TeX\.
-.
-.P
-After \fBtex foo\fR you will have output that looks like final pages except that the entries of mini\-indexes won\'t be alphabetized\. The first run produces a weird file called \fBfoo\.ref\fR\. Say \fBrefsort < foo\.ref > foo\.sref\fR and then another \fBtex foo\fR will produce alphabetized output\.
-.
-.P
-The mini\-indexes list identifiers that are used but not defined on each two\-page spread\. At the end of each section, \fBctwill\fR gives TeX a list of identifiers used in that section and information about where they are defined\.
-.
-.P
-The current meaning of every identifier is initially \fB\euninitialized\fR\. Then \fBctwill\fR reads the \fB\.aux\fR file for your job, if any\.
-.
-.P
-Before reading the \fB\.aux\fR file, \fBctwill\fR actually looks for a file called \fBsystem\.bux\fR, which will be read if present\. And after \fBfoo\.aux\fR, a third possibility is \fBfoo\.bux\fR\. The general convention is to put definitions of system procedures such as \fIprintf\fR into \fBsystem\.bux\fR, and to put definitions found in specifically foo\-ish header files into \fBfoo\.bux\fR\. Like the \fB\.aux\fR files, \fB\.bux\fR files should contain only \fB@$\fR specifications\.
-.
-.P
-The meaning specified by \fB@$\.\.\.@>\fR 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\.
-.
-.P
-A special \fIproofmode\fR is provided so that you can check \fBctwill\fR\'s conclusions about cross\-references\. Run \fBctwill\fR with the flag \fB+P\fR, and TeX will produce a specially formatted document (\fIwithout\fR mini\-indexes) in which you can check that your specifications are correct\.
-.
-.P
-More details how to use \fBctwill\fR can be found in the first sections of its source code, respectively the change file \fBcweav\-twill\.ch\fR applicable to the \fBcweave\.w\fR source\.
-.
-.SH "OPTIONS"
-Options on the command line may be either turned off with \'\fB\-\fR\' (if they are on by default) or turned on with \'\fB+\fR\' (if they are off by default)\. In fact, the options are processed from left to right, so a sequence like \fB\-\-verbose \-h\fR will only show the \fBbanner line\fR (\fB+b\fR) and the \fBprogress report\fR (\fB+p\fR), but leave out the \fBhappy message\fR (\fB\-h\fR)\.
-.
-.TP
-\fB+b\fR
-print banner line on terminal
-.
-.TP
-\fB+h\fR
-print success message on completion
-.
-.TP
-\fB+p\fR
-print progress report messages
-.
-.TP
-\fB+q\fR/\fB\-q\fR
-shortcut for \fB\-bhp\fR; also \fB\-\-quiet\fR (default)
-.
-.TP
-\fB+v\fR/\fB\-v\fR
-shortcut for \fB+bhp\fR; also \fB\-\-verbose\fR
-.
-.TP
-\fB\-e\fR
-do not enclose C material in \fB\ePB{\.\.\.}\fR
-.
-.TP
-\fB\-f\fR
-do not force a newline after every C statement in output
-.
-.TP
-\fB\-i\fR
-suppress indentation of parameter declarations
-.
-.TP
-\fB\-o\fR
-suppress separation of declarations and statements
-.
-.TP
-\fB\-x\fR
-omit indices, section names, table of contents
-.
-.TP
-\fB+P\fR
-\fB\einput proofmac\.tex\fR instead of \fBctwimac\.tex\fR
-.
-.TP
-\fB+l\fR\fIX\fR/\fB\-l\fR\fIX\fR
-use macros for language \fIX\fR as of \fIX\fR\fBct\fR{\fBwi\fR|\fBproof\fR}\fBmac\.tex\fR
-.
-.TP
-\fB+s\fR
-print usage statistics
-.
-.TP
-\fB\-\-help\fR
-display help message and exit
-.
-.TP
-\fB\-\-version\fR
-output version information and exit
-.
-.SH "ENVIRONMENT"
-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\.
-.
-.SH "FILES"
-The location of the files mentioned below varies from system to system\. Use the \fBkpsewhich\fR utility to find their locations\.
-.
-.TP
-\fBctwimac\.tex\fR
-The default TeX macros \fB\einput\fR in the first line of the output file\.
-.
-.TP
-\fBctproofmac\.tex\fR
-If \fBctwill\fR is invoked with the \fB+P\fR option, it will change the first line of the output file to \fB\einput ctproofmac\.tex\fR\.
-.
-.P
-In both cases you can request some prefix \fIX\fR with the \fB+l\fR\fIX\fR option, e\.g\., \fB+ld\fR will \fB\einput dctwimac\.tex\fR and \fB+Pld\fR will \fB\einput dctproofmac\.tex\fR\.
-.
-.TP
-\fIwebfile\fR\fB\.bux\fR
-Reference definitions to resolve from other modules\.
-.
-.TP
-\fBsystem\.bux\fR
-Reference definitions to resolve from C standard library header files like \fB<stdio\.h>\fR\.
-.
-.P
-Other \fBaux\fRiliary files with references are created automatically by \fBctwill\fR and the actual index files are created by TeX\.
-.
-.TP
-\fBcwebman\.tex\fR
-The CWEB user manual\.
-.
-.SH "SEE ALSO"
-.
-.TP
-The CWEB System of Structured Documentation
-by Donald E\. Knuth and Silvio Levy (hardcopy version of \fBcwebman\.tex\fR and the source code listings of \fBcommon\.w\fR, \fBctangle\.w\fR, and \fBcweave\.w\fR)\.
-.
-.TP
-Literate Programming
-by D\. E\. Knuth\.
-.
-.TP
-Weaving a Program
-by Wayne Sewell\.
-.
-.P
+.PD
+\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 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.
+.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
+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.
+.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.
+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.
+.PP
+After \f[B]tex foo\f[R] you will have output that looks like final pages
+except that the entries of mini\-indexes won\[cq]t be alphabetized.
+The first run produces a weird file called \f[B]foo.ref\f[R].
+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].
+The individual programs should define their names with a line of the
+form \f[B]\[rs]def\[rs]title{NAME}\f[R].
+.PP
+The mini\-indexes list identifiers that are used but not defined on each
+two\-page spread.
+At the end of each section, \f[B]ctwill\f[R] gives TeX a list of
+identifiers used in that section and information about where they are
+defined.
+.PP
+The current meaning of every identifier is initially
+\f[B]\[rs]uninitialized\f[R].
+Then \f[B]ctwill\f[R] reads the \f[B].aux\f[R] file for your job, if
+any.
+.PP
+Before reading the \f[B].aux\f[R] file, \f[B]ctwill\f[R] actually looks
+for a file called \f[B]system.bux\f[R], which will be read if present.
+And after \f[B]foo.aux\f[R], a third possibility is \f[B]foo.bux\f[R].
+The general convention is to put definitions of system procedures such
+as \f[I]printf\f[R] into \f[B]system.bux\f[R], and to put definitions
+found in specifically foo\-ish header files into \f[B]foo.bux\f[R].
+Like the \f[B].aux\f[R] files, \f[B].bux\f[R] files should contain only
+\f[B]\[at]$\f[R] specifications.
+.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.
+.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.
+Run \f[B]ctwill\f[R] with the flag \f[B]+P\f[R], and TeX will produce a
+specially formatted document (\f[I]without\f[R] mini\-indexes) in which
+you can check that your specifications are correct.
+.PP
+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 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]
+(\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
+\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]\[en]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]
+.IP \[bu] 2
+\f[B]\-e\f[R]: do not enclose 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
+.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]+P\f[R]: \f[B]\[rs]input proofmac.tex\f[R] instead of
+\f[B]ctwimac.tex\f[R]
+.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]ct\f[R]{\f[B]wi\f[R]|\f[B]proof\f[R]}\f[B]mac.tex\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
+.IP \[bu] 2
+\f[B]\[en]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.
+.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
+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
+\f[B]+P\f[R] option, it will change the first line of the output file to
+\f[B]\[rs]input ctproofmac.tex\f[R].
+.PP
+In both cases you can request some prefix \f[I]X\f[R] with the
+\f[B]+lX\f[R] option, e.g., \f[B]+ld\f[R] will \f[B]\[rs]input
+dctwimac.tex\f[R] and \f[B]+Pld\f[R] will \f[B]\[rs]input
+dctproofmac.tex\f[R].
+.IP \[bu] 2
+\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].
+.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.
+.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 "AUTHOR"
-Don Knuth wrote \fBctwill\fR based on \fBcweave\fR by Silvio Levy and Knuth\. As of 2019, \fBctwill\fR and its utilities \fBrefsort\fR and \fBtwinx\fR have been fully integrated with the extended CWEBbin system that serves as the basis for CWEB in TeX Live; see project page \fIhttps://github\.com/ascherer/cwebbin\fR\.
+.PP
+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
+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.