1 /* help.h: help messages for web2c programs.
3 This is included by everyone, from cpascal.h. This is better than
4 putting the help messages directly in the change files because (1)
5 multiline strings aren't supported by tangle, and it would be a pain
6 to make up a new syntax for them in web2c, and (2) when a help msg
7 changes, we need only recompile, not retangle or reconvert. The
8 downside is that everything gets recompiled when any msg changes, but
9 that's better than having umpteen separate tiny files. (For one
10 thing, the messages have a lot in common, so it's nice to have them
13 Copyright 1995, 1996, 2009, 2011, 2012 Karl Berry.
14 Copyright 2008 Taco Hoekwater.
15 Copyright 2001, 2003, 2004 Olaf Weber.
17 This program is free software; you can redistribute it and/or modify
18 it under the terms of the GNU General Public License as published by
19 the Free Software Foundation; either version 2, or (at your option)
22 This program is distributed in the hope that it will be useful,
23 but WITHOUT ANY WARRANTY; without even the implied warranty of
24 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 GNU General Public License for more details.
27 You should have received a copy of the GNU General Public License
28 along with this program; if not, see <http://www.gnu.org/licenses/>. */
30 /* Help messages for TeX & MF family are in texmfmp-help.h, to
31 prevent multiple-definition errors. */
37 const_string BIBTEXHELP
[] = {
38 "Usage: bibtex [OPTION]... AUXFILE[.aux]",
39 " Write bibliography for entries in AUXFILE to AUXFILE.bbl,",
40 " along with a log file AUXFILE.blg."
42 "-min-crossrefs=NUMBER include item after NUMBER cross-refs; default 2",
43 "-terse do not print progress reports",
44 "-help display this help and exit",
45 "-version output version information and exit",
51 const_string CTANGLEHELP
[] = {
52 "Usage: ctangle [OPTIONS] WEBFILE[.w] [{CHANGEFILE[.ch]|-} [OUTFILE[.c]]]",
53 " Tangle WEBFILE with CHANGEFILE into a C/C++ program.",
54 " Default CHANGEFILE is " DEV_NULL
";",
55 " C output goes to the basename of WEBFILE extended with `.c'",
56 " unless otherwise specified by OUTFILE; in this case, '-' specifies",
57 " a null CHANGEFILE.",
59 "-b suppress banner line on terminal",
60 "-h suppress success message on completion",
61 "-p suppress progress report messages",
62 "+s print usage statistics",
63 "--help display this help and exit",
64 "--version output version information and exit",
68 const_string CWEAVEHELP
[] = {
69 "Usage: cweave [OPTIONS] WEBFILE[.w] [{CHANGEFILE[.ch]|-} [OUTFILE[.tex]]]",
70 " Weave WEBFILE with CHANGEFILE into a TeX document.",
71 " Default CHANGEFILE is " DEV_NULL
";",
72 " TeX output goes to the basename of WEBFILE extended with `.tex'",
73 " unless otherwise specified by OUTFILE; in this case, '-' specifies",
74 " a null CHANGEFILE.",
76 "-b suppress banner line on terminal",
77 "-f do not force a newline after every C statement in output",
78 "-h suppress success message on completion",
79 "-p suppress progress report messages",
80 "-x omit indices and table of contents",
81 "+e enclose C material in \\PB{...}",
82 "+s print usage statistics",
83 "--help display this help and exit",
84 "--version output version information and exit",
90 const_string DVICOPYHELP
[] = {
91 "Usage: dvicopy [OPTION]... [INDVI[.dvi] [OUTDVI[.dvi]]]",
92 " Expand virtual font references in INDVI to OUTDVI.",
93 " Defaults are standard input and standard output, respectively.",
95 "-magnification=NUMBER override existing magnification with NUMBER",
96 "-max-pages=NUMBER process NUMBER pages; default one million",
97 "-page-start=PAGE-SPEC start at PAGE-SPEC, for example `2' or `5.*.-2'",
98 "-help display this help and exit",
99 "-version output version information and exit",
105 const_string DVITYPEHELP
[] = {
106 "Usage: dvitype [OPTION]... DVIFILE[.dvi]",
107 " Verify and translate DVIFILE to human-readable form,",
108 " written to standard output.",
110 "-dpi=REAL set resolution to REAL pixels per inch; default 300.0",
111 "-magnification=NUMBER override existing magnification with NUMBER",
112 "-max-pages=NUMBER process NUMBER pages; default one million",
113 "-output-level=NUMBER verbosity level, from 0 to 4; default 4",
114 "-page-start=PAGE-SPEC start at PAGE-SPEC, for example `2' or `5.*.-2'",
115 "-show-opcodes show numeric opcodes (in decimal)",
116 "-help display this help and exit",
117 "-version output version information and exit",
123 const_string GFTODVIHELP
[] = {
124 "Usage: gftodvi [OPTION]... GFNAME",
125 " Translate each character in GFNAME to a page in a DVI file,",
126 " which is named with the basename of GFNAME extended with `.dvi'.",
128 "-overflow-label-offset=REAL override 2.1in offset for overflow labels",
129 "-help display this help and exit",
130 "-verbose display progress reports",
131 "-version output version information and exit",
137 const_string GFTOPKHELP
[] = {
138 "Usage: gftopk [OPTION]... GFNAME [PKFILE]",
139 " Translate the bitmap font GFNAME to PKFILE.",
140 " Default PKFILE is basename of GFNAME extended with `pk'.",
142 "-help display this help and exit",
143 "-verbose display progress reports",
144 "-version output version information and exit",
150 const_string GFTYPEHELP
[] = {
151 "Usage: gftype [OPTION]... GFNAME",
152 " Verify and translate the bitmap font GFNAME to human-readable form,",
153 " written to standard output.",
155 "-images show characters as pixels",
156 "-mnemonics translate all GF commands",
157 "-help display this help and exit",
158 "-version output version information and exit",
164 const_string MFTHELP
[] = {
165 "Usage: mft [OPTION]... NAME[.mf|.mp]",
166 " Translate MFNAME to TeX for printing, using the mftmac.tex (or",
167 " mptmac.tex) macros. Output goes to basename of NAME extended",
170 "-change=CHFILE apply the change file CHFILE as with tangle and weave",
171 "-metapost assume NAME is a METAPOST source file",
172 "-style=MFTNAME use MFTNAME instead of plain.mft (or mplain.mft)",
173 " (this option can be given more than once)",
174 "-help display this help and exit",
175 "-version output version information and exit",
181 const_string ODVICOPYHELP
[] = {
182 "Usage: odvicopy [OPTION]... [INDVI[.dvi] [OUTDVI[.dvi]]]",
183 " Expand virtual font references in INDVI to OUTDVI.",
184 " Defaults are standard input and standard output, respectively.",
186 "-magnification=NUMBER override existing magnification with NUMBER",
187 "-max-pages=NUMBER process NUMBER pages; default one million",
188 "-page-start=PAGE-SPEC start at PAGE-SPEC, for example `2' or `5.*.-2'",
189 "-help display this help and exit",
190 "-version output version information and exit",
193 #endif /* ODVICOPY */
196 const_string ODVITYPEHELP
[] = {
197 "Usage: odvitype [OPTION]... DVIFILE[.dvi]",
198 " Verify and translate DVIFILE to human-readable form,",
199 " written to standard output.",
201 "-dpi=REAL set resolution to REAL pixels per inch; default 300.0",
202 "-magnification=NUMBER override existing magnification with NUMBER",
203 "-max-pages=NUMBER process NUMBER pages; default one million",
204 "-output-level=NUMBER verbosity level, from 0 to 4; default 4",
205 "-page-start=PAGE-SPEC start at PAGE-SPEC, for example `2' or `5.*.-2'",
206 "-show-opcodes show numeric opcodes (in decimal)",
207 "-help display this help and exit",
208 "-version output version information and exit",
211 #endif /* ODVITYPE */
214 const_string OFM2OPLHELP
[] = {
215 "Usage: ofm2opl [OPTION]... OFMNAME[.ofm] [OPLFILE[.opl]]",
216 " Translate the font metrics OFMNAME to human-readable property list file",
217 " OPLFILE or standard output.",
220 "-char-format=TYPE output character codes according to TYPE,",
221 " either `num' or `ascii'; default is num,",
222 " ascii = ascii letters and digits, num for all else",
223 "-num-format=TYPE output numbers according to TYPE,",
224 " either `hex' or `octal'; default is hex",
225 "-text-format=TYPE output coding scheme and family according to TYPE,",
226 " either `mixed' or `upper' case; default is mixed",
228 "-charcode-format=TYPE output character codes according to TYPE,",
229 " either `hex' or `ascii'; default is hex,",
230 " ascii = ascii letters and digits, hex for all else",
232 "-help display this help and exit",
233 "-verbose display progress reports",
234 "-version output version information and exit",
240 const_string OPL2OFMHELP
[] = {
241 "Usage: opl2ofm [OPTION]... OPLFILE[.opl] [OFMFILE[.ofm]]",
242 " Translate the property list OPLFILE to OFMFILE.",
243 " Default OFMFILE is basename of OPLFILE extended with `.ofm'.",
245 "-help display this help and exit",
246 "-verbose display progress reports",
247 "-version output version information and exit",
252 #if defined (OTANGLE) || defined (OTANGLEBOOT)
253 const_string OTANGLEHELP
[] = {
254 "Usage: otangle [OPTION]... WEBFILE[.web] [CHANGEFILE[.ch]]",
255 " Tangle WEBFILE with CHANGEFILE into a Pascal program.",
256 " Default CHANGEFILE is " DEV_NULL
";",
257 " Pascal output goes to the basename of WEBFILE extended with `.p',",
258 " and a string pool file, if necessary, to the same extended with `.pool'.",
260 "-help display this help and exit",
261 "-version output version information and exit",
267 const_string OVF2OVPHELP
[] = {
268 "Usage: ovf2ovp [OPTION]... OVFNAME[.ovf] [OFMNAME[.ofm] [OVPFILE[.ovp]]]",
269 " Translate OVFNAME and companion OFMNAME to human-readable",
270 " virtual property list file OVPFILE or standard output.",
271 " If OFMNAME is not specified, OVFNAME (with `.ovf' removed) is used.",
274 "-char-format=TYPE output character codes according to TYPE,",
275 " either `num' or `ascii'; default is num,",
276 " ascii = ascii letters and digits, num for all else",
277 "-num-format=TYPE output numbers according to TYPE,",
278 " either `hex' or `octal'; default is hex",
279 "-text-format=TYPE output coding scheme and family according to TYPE,",
280 " either `mixed' or `upper' case; default is mixed",
282 "-charcode-format=TYPE output character codes according to TYPE,",
283 " either `hex' or `ascii'; default is hex,",
284 " ascii = ascii letters and digits, hex for all else",
286 "-help display this help and exit",
287 "-verbose display progress reports",
288 "-version output version information and exit",
294 const_string OVP2OVFHELP
[] = {
295 "Usage: ovp2ovf [OPTION]... OVPFILE[.ovp] [OVFFILE[.ovf] [OFMFILE[.ofm]]]",
296 " Translate OVPFILE to OVFFILE and companion OFMFILE.",
297 " Default OVFFILE is basename of OVPFILE extended with `.ovf'.",
298 " Default OFMFILE is basename of OVFFILE extended with `.ofm'.",
300 "-help display this help and exit",
301 "-verbose display progress reports",
302 "-version output version information and exit",
308 const_string PATGENHELP
[] = {
309 "Usage: patgen [OPTION]... DICTIONARY PATTERNS OUTPUT TRANSLATE",
310 " Generate the OUTPUT hyphenation file for use with TeX",
311 " from the DICTIONARY, PATTERNS, and TRANSLATE files.",
313 "-help display this help and exit",
314 "-version output version information and exit",
320 const_string based_prog_name
= "BibTeX";
321 const_string PBIBTEXHELP
[] = {
322 "Usage: pbibtex [OPTION]... AUXFILE[.aux]",
323 " Write bibliography for entries in AUXFILE to AUXFILE.bbl,",
324 " along with a log file AUXFILE.blg."
326 "-kanji=STRING set Japanese encoding (STRING=euc|jis|sjis|utf8)",
327 "-min-crossrefs=NUMBER include item after NUMBER cross-refs; default 2",
329 "-sjis-terminal always output to stdout and stderr by CP932",
331 "-terse do not print progress reports",
332 "-help display this help and exit",
333 "-version output version information and exit",
339 const_string based_prog_name
= "DVItype";
340 const_string PDVITYPEHELP
[] = {
341 "Usage: pdvitype [OPTION]... DVIFILE[.dvi]",
342 " Verify and translate DVIFILE to human-readable form,",
343 " written to standard output.",
345 "-dpi=REAL set resolution to REAL pixels per inch; default 300.0",
346 "-kanji=STRING set Japanese encoding (STRING=euc|jis|sjis|utf8)",
347 "-magnification=NUMBER override existing magnification with NUMBER",
348 "-max-pages=NUMBER process NUMBER pages; default one million",
349 "-output-level=NUMBER verbosity level, from 0 to 4; default 4",
350 "-page-start=PAGE-SPEC start at PAGE-SPEC, for example `2' or `5.*.-2'",
351 "-show-opcodes show numeric opcodes (in decimal)",
353 "-sjis-terminal always output to stdout and stderr by CP932",
355 "-help display this help and exit",
356 "-version output version information and exit",
359 #endif /* PDVITYPE */
362 const_string PKTOGFHELP
[] = {
363 "Usage: pktogf [OPTION]... PKNAME [GFFILE]",
364 " Translate the bitmap font PKNAME to GFFILE.",
365 " Default GFFILE is basename of PKNAME extended with `gf'.",
367 "-help display this help and exit",
368 "-verbose display progress reports",
369 "-version output version information and exit",
375 const_string PKTYPEHELP
[] = {
376 "Usage: pktype [OPTION]... PKNAME",
377 " Verify and translate the bitmap font PKNAME to human-readable form,",
378 " written to standard output.",
380 "-help display this help and exit",
381 "-version output version information and exit",
387 const_string PLTOTFHELP
[] = {
388 "Usage: pltotf [OPTION]... PLFILE[.pl] [TFMFILE[.tfm]]",
389 " Translate the property list PLFILE to TFMFILE.",
390 " Default TFMFILE is basename of PLFILE extended with `.tfm'.",
392 "-help display this help and exit",
393 "-verbose display progress reports",
394 "-version output version information and exit",
400 const_string POOLTYPEHELP
[] = {
401 "Usage: pooltype [OPTION]... POOLFILE[.pool]",
402 " Display the string number of each string in POOLFILE.",
404 "-help display this help and exit",
405 "-version output version information and exit",
408 #endif /* POOLTYPE */
411 const_string based_prog_name
= "PLtoTF";
412 const_string PPLTOTFHELP
[] = {
413 "Usage: ppltotf [OPTION]... PLFILE[.pl] [TFMFILE[.tfm]]",
414 " Translate the property list PLFILE to TFMFILE.",
415 " Default TFMFILE is basename of PLFILE extended with `.tfm'.",
417 "-kanji=STRING set Japanese encoding (STRING=euc|jis|sjis|utf8)",
419 "-sjis-terminal always output to stdout and stderr by CP932",
421 "-help print this message and exit.",
422 "-verbose output progress reports.",
423 "-version print version information and exit.",
429 const_string based_prog_name
= "TFtoPL";
430 const_string PTFTOPLHELP
[] = {
431 "Usage: ptftopl [OPTION]... TFMNAME[.tfm] [PLFILE[.pl]]",
432 " Translate the font metrics TFMNAME to human-readable property list file",
433 " PLFILE or standard output.",
435 "-charcode-format=TYPE output character codes according to TYPE,",
436 " either `octal' or `ascii'; default is ascii for",
437 " letters and digits, octal for all else",
438 "-kanji=STRING set Japanese encoding (STRING=euc|jis|sjis|utf8)",
440 "-sjis-terminal always output to stdout and stderr by CP932",
442 "-help display this help and exit",
443 "-verbose display progress reports",
444 "-version output version information and exit",
449 #if defined (TANGLE) || defined (TANGLEBOOT)
450 const_string TANGLEHELP
[] = {
451 "Usage: tangle [OPTION]... WEBFILE[.web] [CHANGEFILE[.ch]]",
452 " Tangle WEBFILE with CHANGEFILE into a Pascal program.",
453 " Default CHANGEFILE is " DEV_NULL
";",
454 " Pascal output goes to the basename of WEBFILE extended with `.p',",
455 " and a string pool file, if necessary, to the same extended with `.pool'.",
457 "-length=NUMBER the first NUMBER characters of an identifier have to be",
458 " unique (default 32)",
459 "-loose honor the upper/lower/mixedcase and underline options when",
460 " comparing identifiers (default)",
461 "-lowercase make all identifiers lowercase",
462 "-mixedcase retain the case of identifiers unchanged (default)",
463 "-strict always smash case and remove underlines when comparing",
465 "-underline do not remove underline characters from indentifiers",
466 "-uppercase make all identifiers uppercase",
467 "-help display this help and exit",
468 "-version output version information and exit",
474 const_string TFTOPLHELP
[] = {
475 "Usage: tftopl [OPTION]... TFMNAME[.tfm] [PLFILE[.pl]]",
476 " Translate the font metrics TFMNAME to human-readable property list file",
477 " PLFILE or standard output.",
479 "-charcode-format=TYPE output character codes according to TYPE,",
480 " either `octal' or `ascii'; default is ascii for",
481 " letters and digits, octal for all else",
482 "-help display this help and exit",
483 "-verbose display progress reports",
484 "-version output version information and exit",
490 const_string based_prog_name
= "BibTeX";
491 const_string UPBIBTEXHELP
[] = {
492 "Usage: upbibtex [OPTION]... AUXFILE[.aux]",
493 " Write bibliography for entries in AUXFILE to AUXFILE.bbl,",
494 " along with a log file AUXFILE.blg."
496 "-kanji=STRING set Japanese encoding (STRING=euc|jis|sjis|utf8|uptex)",
497 "-kanji-internal=STRING set Japanese internal encoding (STRING=euc|uptex)",
498 "-min-crossrefs=NUMBER include item after NUMBER cross-refs; default 2",
500 "-sjis-terminal always output to stdout and stderr by CP932",
502 "-terse do not print progress reports",
503 "-help display this help and exit",
504 "-version output version information and exit",
507 #endif /* UPBIBTEX */
510 const_string based_prog_name
= "DVItype";
511 const_string UPDVITYPEHELP
[] = {
512 "Usage: updvitype [OPTION]... DVIFILE[.dvi]",
513 " Verify and translate DVIFILE to human-readable form,",
514 " written to standard output.",
516 "-dpi=REAL set resolution to REAL pixels per inch; default 300.0",
517 "-kanji=STRING set Japanese encoding (STRING=euc|jis|sjis|utf8|uptex)",
518 "-magnification=NUMBER override existing magnification with NUMBER",
519 "-max-pages=NUMBER process NUMBER pages; default one million",
520 "-output-level=NUMBER verbosity level, from 0 to 4; default 4",
521 "-page-start=PAGE-SPEC start at PAGE-SPEC, for example `2' or `5.*.-2'",
522 "-show-opcodes show numeric opcodes (in decimal)",
524 "-sjis-terminal always output to stdout and stderr by CP932",
526 "-help display this help and exit",
527 "-version output version information and exit",
530 #endif /* UPDVITYPE */
533 const_string based_prog_name
= "PLtoTF";
534 const_string UPPLTOTFHELP
[] = {
535 "Usage: uppltotf [OPTION]... PLFILE[.pl] [TFMFILE[.tfm]]",
536 " Translate the property list PLFILE to TFMFILE.",
537 " Default TFMFILE is basename of PLFILE extended with `.tfm'.",
539 "-kanji=STRING set Japanese encoding (STRING=euc|jis|sjis|utf8|uptex)",
541 "-sjis-terminal always output to stdout and stderr by CP932",
543 "-help print this message and exit.",
544 "-verbose output progress reports.",
545 "-version print version information and exit.",
548 #endif /* UPPLTOTF */
551 const_string based_prog_name
= "TFtoPL";
552 const_string UPTFTOPLHELP
[] = {
553 "Usage: uptftopl [OPTION]... TFMNAME[.tfm] [PLFILE[.pl]]",
554 " Translate the font metrics TFMNAME to human-readable property list file",
555 " PLFILE or standard output.",
557 "-charcode-format=TYPE output character codes according to TYPE,",
558 " either `octal' or `ascii'; default is ascii for",
559 " letters and digits, octal for all else",
560 "-kanji=STRING set Japanese encoding (STRING=euc|jis|sjis|utf8|uptex)",
562 "-sjis-terminal always output to stdout and stderr by CP932",
564 "-help display this help and exit",
565 "-verbose display progress reports",
566 "-version output version information and exit",
569 #endif /* UPTFTOPL */
572 const_string VFTOVPHELP
[] = {
573 "Usage: vftovp [OPTION]... VFNAME[.vf] [TFMNAME[.tfm] [VPLFILE[.vpl]]]",
574 " Translate VFNAME and companion TFMNAME to human-readable",
575 " virtual property list file VPLFILE or standard output.",
576 " If TFMNAME is not specified, VFNAME (with `.vf' removed) is used.",
578 "-charcode-format=TYPE output character codes according to TYPE,",
579 " either `octal' or `ascii'; default is ascii for",
580 " letters and digits, octal for all else",
581 "-help display this help and exit",
582 "-verbose display progress reports",
583 "-version output version information and exit",
589 const_string VPTOVFHELP
[] = {
590 "Usage: vptovf [OPTION]... VPLFILE[.vpl] [VFFILE[.vf] [TFMFILE[.tfm]]]",
591 " Translate VPLFILE to VFFILE and companion TFMFILE.",
592 " Default VFFILE is basename of VPLFILE extended with `.vf'.",
593 " Default TFMFILE is basename of VFFILE extended with `.tfm'.",
595 "-help display this help and exit",
596 "-verbose display progress reports",
597 "-version output version information and exit",
603 const_string WEAVEHELP
[] = {
604 "Usage: weave [OPTION]... WEBFILE[.web] [CHANGEFILE[.ch]]",
605 " Weave WEBFILE with CHANGEFILE into a TeX document.",
606 " Default CHANGEFILE is " DEV_NULL
";",
607 " TeX output goes to the basename of WEBFILE extended with `.tex'.",
609 "-x omit cross-reference information",
610 "-help display this help and exit",
611 "-version output version information and exit",
616 #endif /* not HELP_H */