summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/man/man1/cweb.1
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2024-02-20 18:33:28 +0000
committerKarl Berry <karl@freefriends.org>2024-02-20 18:33:28 +0000
commit12a220e80344b5c02b56a57d4a994ccb854bc22c (patch)
tree09be80dc6f1fb1aa93c4c60ec8e20bcbd36e6f8d /Master/texmf-dist/doc/man/man1/cweb.1
parent3575aa305fd619edaa92f3bc49368cfe9d2f76bc (diff)
2024 man page, news, manual updates
git-svn-id: svn://tug.org/texlive/trunk@70015 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/man/man1/cweb.1')
-rw-r--r--Master/texmf-dist/doc/man/man1/cweb.191
1 files changed, 36 insertions, 55 deletions
diff --git a/Master/texmf-dist/doc/man/man1/cweb.1 b/Master/texmf-dist/doc/man/man1/cweb.1
index 6f322dfdf91..ddb38a63376 100644
--- a/Master/texmf-dist/doc/man/man1/cweb.1
+++ b/Master/texmf-dist/doc/man/man1/cweb.1
@@ -1,35 +1,17 @@
.\" Automatically generated by Pandoc
.\"
-.\" 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 "CWEB" "1" "August 20, 2022" "Web2c 2023" "General Commands Manual"
-.hy
+.TH "CWEB" "1" "August 20, 2022" "Web2c 2024" "General Commands Manual"
.SH NAME
-.PP
-ctangle, cweave - translate CWEB to C/C++ and/or TeX
+ctangle, cweave \- translate CWEB to C/C++ and/or TeX
.SH SYNOPSIS
-.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]]]
+[{\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]]]
+[{\f[I]changefile\f[R][.ch]|\-} [\f[I]outfile\f[R][.tex]]]
.SH DESCRIPTION
-.PP
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
@@ -39,16 +21,15 @@ 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
+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
+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
there is no extension).
@@ -60,39 +41,38 @@ 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.
+change file to apply, you can use `\f[B]\-\f[R]' as the second argument.
.SH DIFFERENCES TO ORIGINAL CWEB
-.PP
-CWEBbin tries hard to be a drop-in replacement for CWEB, so in general
+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]+c\f[R], \f[B]-i\f[R], \f[B]-o\f[R],
-\f[B]+u\f[R], and \f[B]+lX\f[R] are new in CWEBbin and TeX\ Live.
+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]+c\f[R], \f[B]\-i\f[R],
+\f[B]\-o\f[R], \f[B]+u\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.
+\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; see ENVIRONMENT below.
+permit several, colon\-separated, paths; see ENVIRONMENT below.
.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
-Options on the command line may be either turned off with `\f[B]-\f[R]'
+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]
+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]).
+leave out the \f[B]happy message\f[R] (\f[B]\-h\f[R]).
.PP
The first batch of options are common to both \f[B]ctangle\f[R] and
\f[B]cweave\f[R]:
@@ -103,46 +83,46 @@ The first batch of options are common to both \f[B]ctangle\f[R] and
.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)
+\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]
+\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]+s\f[R]: print usage statistics
.IP \[bu] 2
-\f[B]--help\f[R]: display help message and exit
+\f[B]\-\-help\f[R]: display help message and exit
.IP \[bu] 2
-\f[B]--version\f[R]: output version information and exit
+\f[B]\-\-version\f[R]: output version information and exit
.PP
There is one other option applicable to \f[B]ctangle\f[R] only:
.IP \[bu] 2
\f[B]+k\f[R]: keep separators in numeric literals in the output
.IP \[bu] 2
-\f[B]+u\f[R]: transliterate UTF-8 charcters in C code
+\f[B]+u\f[R]: transliterate UTF\-8 charcters in C code
.PP
There are seven 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]
+\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
+\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
+\f[B]\-i\f[R]: suppress indentation of parameter declarations
.IP \[bu] 2
-\f[B]-o\f[R]: suppress separation of declarations and statements
+\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
+\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[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]
.IP \[bu] 2
\f[B]+t\f[R]: treat \f[B]typename\f[R] in a template like
\f[B]typedef\f[R]
.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.
@@ -158,15 +138,17 @@ translation catalogs.
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]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).
+\f[B]cwebman.tex\f[R]: The CWEB user manual, available in PDF from \c
+.UR https://ctan.org/pkg/cweb
+CTAN
+.UE \c
+\&.
.SH SEE ALSO
.IP \[bu] 2
The CWEB System of Structured Documentation: by Donald E.\ Knuth and
@@ -180,7 +162,6 @@ Weaving a Program: by Wayne Sewell.
.PP
cweb(1), tex(1), cc(1)
.SH AUTHORS
-.PP
Don Knuth wrote WEB for TeX and Pascal.
.PD 0
.P