Back to index

tetex-bin  3.0
help.h
Go to the documentation of this file.
00001 /* help.h: help messages for web2c programs.
00002 
00003    This is included by everyone, from cpascal.h.  This is better than
00004    putting the help messages directly in the change files because (1)
00005    multiline strings aren't supported by tangle, and it would be a pain
00006    to make up a new syntax for them in web2c, and (2) when a help msg
00007    changes, we need only recompile, not retangle or reconvert.  The
00008    downside is that everything gets recompiled when any msg changes, but
00009    that's better than having umpteen separate tiny files.  (For one
00010    thing, the messages have a lot in common, so it's nice to have them
00011    in one place.)
00012 
00013 Copyright (C) 1995, 96 Karl Berry, 2001, 03, 04 Olaf Weber.
00014 
00015 This program is free software; you can redistribute it and/or modify
00016 it under the terms of the GNU General Public License as published by
00017 the Free Software Foundation; either version 2, or (at your option)
00018 any later version.
00019 
00020 This program is distributed in the hope that it will be useful,
00021 but WITHOUT ANY WARRANTY; without even the implied warranty of
00022 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00023 GNU General Public License for more details.
00024 
00025 You should have received a copy of the GNU General Public License
00026 along with this program; if not, write to the Free Software
00027 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
00028 
00029 /* Note: Help messages for TeX & MF family moved to texmfmp-help.h, to
00030    prevent multiple-definition errors. */
00031 
00032 #ifndef HELP_H
00033 #define HELP_H
00034 
00035 #ifdef BIBTEX
00036 const_string BIBTEXHELP[] = {
00037     "Usage: bibtex [OPTION]... AUXFILE[.aux]",
00038     "  Write bibliography for entries in AUXFILE to AUXFILE.bbl.",
00039     "",
00040     "-min-crossrefs=NUMBER  include item after NUMBER cross-refs; default 2",
00041     "-terse                 do not print progress reports",
00042     "-help                  display this help and exit",
00043     "-version               output version information and exit",
00044     NULL
00045 };    
00046 #endif /* BIBTEX */
00047 
00048 #ifdef CWEB
00049 const_string CWEAVEHELP[] = {
00050     "Usage: cweave [OPTIONS] WEBFILE[.w] [{CHANGEFILE[.ch]|-}] [OUTFILE[.tex]]",
00051     "  Weave WEBFILE with CHANGEFILE into a TeX document.",
00052     "  Default CHANGEFILE is /dev/null;",
00053     "  TeX output goes to the basename of WEBFILE extended with `.tex'",
00054     "  unless otherwise specified by OUTFILE; in this case, '-' specifies",
00055     "  a null CHANGEFILE.",
00056     "",
00057     "-b          suppress banner line on terminal",
00058     "-f          do not force a newline after every C statement in output",
00059     "-h          suppress success message on completion",
00060     "-p          suppress progress report messages",
00061     "-x          omit indices and table of contents",
00062     "+e          enclose C material in \\PB{...}",
00063     "+s          print usage statistics",
00064     "--help      display this help and exit",
00065     "--version   output version information and exit",
00066     NULL
00067 };
00068 
00069 const_string CTANGLEHELP[] = {
00070     "Usage: ctangle [OPTIONS] WEBFILE[.w] [{CHANGEFILE[.ch]|-}] [OUTFILE[.c]]",
00071     "  Tangle WEBFILE with CHANGEFILE into a C/C++ program.",
00072     "  Default CHANGEFILE is /dev/null;",
00073     "  C output goes to the basename of WEBFILE extended with `.c'",
00074     "  unless otherwise specified by OUTFILE; in this case, '-' specifies",
00075     "  a null CHANGEFILE.",
00076     "",
00077     "-b          suppress banner line on terminal",
00078     "-h          suppress success message on completion",
00079     "-p          suppress progress report messages",
00080     "+s          print usage statistics",
00081     "--help      display this help and exit",
00082     "--version   output version information and exit",
00083     NULL
00084 };
00085 #endif /* CWEB */
00086 
00087 #ifdef DVICOPY
00088 const_string DVICOPYHELP[] = {
00089     "Usage: dvicopy [OPTION]... [INDVI[.dvi] [OUTDVI[.dvi]]]",
00090     "  Expand virtual font references in INDVI to OUTDVI.",
00091     "  Defaults are standard input and standard output, respectively.",
00092     "",
00093     "-magnification=NUMBER  override existing magnification with NUMBER",
00094     "-max-pages=NUMBER      process NUMBER pages; default one million",
00095     "-page-start=PAGE-SPEC  start at PAGE-SPEC, for example `2' or `5.*.-2'",
00096     "-help                  display this help and exit",
00097     "-version               output version information and exit",
00098     NULL
00099 };
00100 #endif /* DVICOPY */
00101 
00102 #ifdef DVITOMP
00103 const_string DVITOMPHELP[] = {
00104     "Usage: dvitomp [OPTION]... DVIFILE[.dvi] [MPXFILE[.mpx]]",
00105     "  Translate DVIFILE to the MetaPost MPXFILE.",
00106     "  Default MPXFILE is basename of DVIFILE extended with `.mpx'.",
00107     "",
00108     "-help                  display this help and exit",
00109     "-version               output version information and exit",
00110     NULL
00111 };
00112 #endif /* DVITOMP */
00113 
00114 #ifdef DVITYPE
00115 const_string DVITYPEHELP[] = {
00116     "Usage: dvitype [OPTION]... DVIFILE[.dvi]",
00117     "  Verify and translate DVIFILE to human-readable form,",
00118     "  written to standard output.",
00119     "",
00120     "-dpi=REAL              set resolution to REAL pixels per inch; default 300.0",
00121     "-magnification=NUMBER  override existing magnification with NUMBER",
00122     "-max-pages=NUMBER      process NUMBER pages; default one million",
00123     "-output-level=NUMBER   verbosity level, from 0 to 4; default 4",
00124     "-page-start=PAGE-SPEC  start at PAGE-SPEC, for example `2' or `5.*.-2'",
00125     "-show-opcodes          show numeric opcodes (in decimal)",
00126     "-help                  display this help and exit",
00127     "-version               output version information and exit",
00128     NULL
00129 };
00130 #endif /* DVITYPE */
00131 
00132 #ifdef GFTODVI
00133 const_string GFTODVIHELP[] = {
00134     "Usage: gftodvi [OPTION]... GFNAME",
00135     "  Translate each character in GFNAME to a page in a DVI file,",
00136     "  which is named with the basename of GFNAME extended with `.dvi'.",
00137     "",
00138     "-overflow-label-offset=REAL  override 2.1in offset for overflow labels",
00139     "-help                        display this help and exit",
00140     "-verbose                     display progress reports",
00141     "-version                     output version information and exit",
00142     NULL
00143 };
00144 #endif /* GFTODVI */
00145 
00146 #ifdef GFTOPK
00147 const_string GFTOPKHELP[] = {
00148     "Usage: gftopk [OPTION]... GFNAME [PKFILE]",
00149     "  Translate the bitmap font GFNAME to PKFILE.",
00150     "  Default PKFILE is basename of GFNAME extended with `pk'.",
00151     "",
00152     "-help       display this help and exit",
00153     "-verbose    display progress reports",
00154     "-version    output version information and exit",
00155     NULL
00156 };
00157 #endif /* GFTOPK */
00158 
00159 #ifdef GFTYPE
00160 const_string GFTYPEHELP[] = {
00161     "Usage: gftype [OPTION]... GFNAME",
00162     "  Verify and translate the bitmap font GFNAME to human-readable form,",
00163     "  written to standard output.",
00164     "",
00165     "-images       show characters as pixels",
00166     "-mnemonics    translate all GF commands",
00167     "-help         display this help and exit",
00168     "-version      output version information and exit",
00169     NULL
00170 };
00171 #endif /* GFTYPE */
00172 
00173 #ifdef MFT
00174 const_string MFTHELP[] = {
00175     "Usage: mft [OPTION]... NAME[.mf|.mp]",
00176     "  Translate MFNAME to TeX for printing, using the mftmac.tex (or",
00177     "  mptmac.tex) macros.  Output goes to basename of NAME extended",
00178     "  with `.tex'.",
00179     "",
00180     "-change=CHFILE  apply the change file CHFILE as with tangle and weave",
00181     "-metapost       assume NAME is a METAPOST source file",
00182     "-style=MFTNAME  use MFTNAME instead of plain.mft (or mplain.mft)",
00183     "                 (this option can be given more than once)",
00184     "-help           display this help and exit",
00185     "-version        output version information and exit",
00186     NULL
00187 };
00188 #endif /* MFT */
00189 
00190 #ifdef ODVICOPY
00191 const_string ODVICOPYHELP[] = {
00192     "Usage: odvicopy [OPTION]... [INDVI[.dvi] [OUTDVI[.dvi]]]",
00193     "  Expand virtual font references in INDVI to OUTDVI.",
00194     "  Defaults are standard input and standard output, respectively.",
00195     "",
00196     "-magnification=NUMBER  override existing magnification with NUMBER",
00197     "-max-pages=NUMBER      process NUMBER pages; default one million",
00198     "-page-start=PAGE-SPEC  start at PAGE-SPEC, for example `2' or `5.*.-2'",
00199     "-help                  display this help and exit",
00200     "-version               output version information and exit",
00201     NULL
00202 };
00203 #endif /* ODVICOPY */
00204 
00205 #ifdef ODVITYPE
00206 const_string ODVITYPEHELP[] = {
00207     "Usage: odvitype [OPTION]... DVIFILE[.dvi]",
00208     "  Verify and translate DVIFILE to human-readable form,",
00209     "  written to standard output.",
00210     "",
00211     "-dpi=REAL              set resolution to REAL pixels per inch; default 300.0",
00212     "-magnification=NUMBER  override existing magnification with NUMBER",
00213     "-max-pages=NUMBER      process NUMBER pages; default one million",
00214     "-output-level=NUMBER   verbosity level, from 0 to 4; default 4",
00215     "-page-start=PAGE-SPEC  start at PAGE-SPEC, for example `2' or `5.*.-2'",
00216     "-show-opcodes          show numeric opcodes (in decimal)",
00217     "-help                  display this help and exit",
00218     "-version               output version information and exit",
00219     NULL
00220 };
00221 #endif /* ODVITYPE */
00222 
00223 #ifdef OFM2OPL
00224 const_string OFM2OPLHELP[] = {
00225     "Usage: ofm2opl [OPTION]... OFMNAME[.ofm] [OPLFILE[.opl]]",
00226     "  Translate the font metrics OFMNAME to human-readable property list file",
00227     "  OPLFILE or standard output.",
00228     "",
00229     "-charcode-format=TYPE  output character codes according to TYPE,",
00230     "                        either `hex' or `ascii'; default is hex,",
00231     "                        ascii = ascii letters and digits, hex for all else",
00232     "-help                  display this help and exit",
00233     "-verbose               display progress reports",
00234     "-version               output version information and exit",
00235     NULL
00236 };
00237 #endif /* OFM2OPL */
00238 
00239 #ifdef OPL2OFM
00240 const_string OPL2OFMHELP[] = {
00241     "Usage: opl2ofm [OPTION]... OPLFILE[.opl] [OFMFILE[.ofm]]",
00242     "  Translate the property list OPLFILE to OFMFILE.",
00243     "  Default OFMFILE is basename of OPLFILE extended with `.ofm'.",
00244     "",
00245     "-help       display this help and exit",
00246     "-verbose    display progress reports",
00247     "-version    output version information and exit",
00248     NULL
00249 };
00250 #endif /* OPL2OFM */
00251 
00252 #if defined (OTANGLE) || defined (OTANGLEBOOT)
00253 const_string OTANGLEHELP[] = {
00254     "Usage: otangle [OPTION]... WEBFILE[.web] [CHANGEFILE[.ch]]",
00255     "  Tangle WEBFILE with CHANGEFILE into a Pascal program.",
00256     "  Default CHANGEFILE is /dev/null;",
00257     "  Pascal output goes to the basename of WEBFILE extended with `.p',",
00258     "  and a string pool file, if necessary, to the same extended with `.pool'.",
00259     "",
00260     "-help       display this help and exit",
00261     "-version    output version information and exit",
00262     NULL
00263 };
00264 #endif /* OTANGLE */
00265 
00266 #ifdef OVF2OVP
00267 const_string OVF2OVPHELP[] = {
00268     "Usage: ovf2ovp [OPTION]... OVFNAME[.ovf] [OFMNAME[.ofm] [OVPFILE[.ovp]]]",
00269     "  Translate OVFNAME and companion OFMNAME to human-readable",
00270     "  virtual property list file OVPFILE or standard output.",
00271     "  If OFMNAME is not specified, OVFNAME (with `.ovf' removed) is used.",
00272     "",
00273     "-charcode-format=TYPE  output character codes according to TYPE,",
00274     "                        either `hex' or `ascii'; default is hex,",
00275     "                        ascii = ascii letters and digits, hex for all else",
00276     "-help                  display this help and exit",
00277     "-verbose               display progress reports",
00278     "-version               output version information and exit",
00279     NULL
00280 };
00281 #endif /* OVF2OVP */
00282 
00283 #ifdef OVP2OVF
00284 const_string OVP2OVFHELP[] = {
00285     "Usage: ovp2ovf [OPTION]... OVPFILE[.ovp] [OVFFILE[.ovf] [OFMFILE[.ofm]]]",
00286     "  Translate OVPFILE to OVFFILE and companion OFMFILE.",
00287     "  Default OVFFILE is basename of OVPFILE extended with `.ovf'.",
00288     "  Default OFMFILE is OVFFILE extended with `.ofm'.",
00289     "",
00290     "-help                  display this help and exit",
00291     "-verbose               display progress reports",
00292     "-version               output version information and exit",
00293     NULL
00294 };
00295 #endif /* OVP2OVF */
00296 
00297 #ifdef PATGEN
00298 const_string PATGENHELP[] = {
00299     "Usage: patgen [OPTION]... DICTIONARY PATTERNS OUTPUT TRANSLATE",
00300     "  Generate the OUTPUT hyphenation file for use with TeX",
00301     "  from the DICTIONARY, PATTERNS, and TRANSLATE files.",
00302     "",
00303     "-help           display this help and exit",
00304     "-version        output version information and exit",
00305     NULL
00306 };
00307 #endif /* PATGEN */
00308 
00309 #ifdef PKTOGF
00310 const_string PKTOGFHELP[] = {
00311     "Usage: pktogf [OPTION]... PKNAME [GFFILE]",
00312     "  Translate the bitmap font PKNAME to GFFILE.",
00313     "  Default GFFILE is basename of PKNAME extended with `gf'.",
00314     "",
00315     "-help       display this help and exit",
00316     "-verbose    display progress reports",
00317     "-version    output version information and exit",
00318     NULL
00319 };
00320 #endif /* PKTOGF */
00321 
00322 #ifdef PKTYPE
00323 const_string PKTYPEHELP[] = {
00324     "Usage: pktype [OPTION]... PKNAME",
00325     "  Verify and translate the bitmap font PKNAME to human-readable form,",
00326     "  written to standard output.",
00327     "",
00328     "-help       display this help and exit",
00329     "-version    output version information and exit",
00330     NULL
00331 };
00332 #endif /* PKTYPE */
00333 
00334 #ifdef PLTOTF
00335 const_string PLTOTFHELP[] = {
00336     "Usage: pltotf [OPTION]... PLFILE[.pl] [TFMFILE[.tfm]]",
00337     "  Translate the property list PLFILE to TFMFILE.",
00338     "  Default TFMFILE is basename of PLFILE extended with `.tfm'.",
00339     "",
00340     "-help       display this help and exit",
00341     "-verbose    display progress reports",
00342     "-version    output version information and exit",
00343     NULL
00344 };
00345 #endif /* PLTOTF */
00346 
00347 #ifdef POOLTYPE
00348 const_string POOLTYPEHELP[] = {
00349     "Usage: pooltype [OPTION]... POOLFILE[.pool]",
00350     "  Display the string number of each string in POOLFILE.",
00351     "",
00352     "-help       display this help and exit",
00353     "-version    output version information and exit",
00354     NULL
00355 };
00356 #endif /* POOLTYPE */
00357 
00358 #if defined (TANGLE) || defined (TANGLEBOOT)
00359 const_string TANGLEHELP[] = {
00360     "Usage: tangle [OPTION]... WEBFILE[.web] [CHANGEFILE[.ch]]",
00361     "  Tangle WEBFILE with CHANGEFILE into a Pascal program.",
00362     "  Default CHANGEFILE is /dev/null;",
00363     "  Pascal output goes to the basename of WEBFILE extended with `.p',",
00364     "  and a string pool file, if necessary, to the same extended with `.pool'.",
00365     "",
00366     "-help          display this help and exit",
00367     "-length=NUMBER the first NUMBER characters of an identifier have to be",
00368     "                unique (default 32)",
00369     "-loose         honor the upper/lower/mixedcase and underline options when",
00370     "                comparing identifiers (default)",
00371     "-lowercase     make all identifiers lowercase",
00372     "-mixedcase     retain the case of identifiers unchanged (default)",
00373     "-strict        always smash case and remove underlines when comparing",
00374     "                identifiers",
00375     "-underline     do not remove underline characters from indentifiers",
00376     "-uppercase     make all identifiers uppercase",
00377     "-version       output version information and exit",
00378     NULL
00379 };
00380 #endif /* TANGLE */
00381 
00382 #ifdef TFTOPL
00383 const_string TFTOPLHELP[] = {
00384     "Usage: tftopl [OPTION]... TFMNAME[.tfm] [PLFILE[.pl]]",
00385     "  Translate the font metrics TFMNAME to human-readable property list file",
00386     "  PLFILE or standard output.",
00387     "",
00388     "-charcode-format=TYPE  output character codes according to TYPE,",
00389     "                        either `octal' or `ascii'; default is ascii for",
00390     "                        letters and digits, octal for all else",
00391     "-help                  display this help and exit",
00392     "-verbose               display progress reports",
00393     "-version               output version information and exit",
00394     NULL
00395 };
00396 #endif /* TFTOPL */
00397 
00398 #ifdef VFTOVP
00399 const_string VFTOVPHELP[] = {
00400     "Usage: vftovp [OPTION]... VFNAME[.vf] [TFMNAME[.tfm] [VPLFILE[.vpl]]]",
00401     "  Translate VFNAME and companion TFMNAME to human-readable",
00402     "  virtual property list file VPLFILE or standard output.",
00403     "  If TFMNAME is not specified, VFNAME (with `.vf' removed) is used.",
00404     "",
00405     "-charcode-format=TYPE  output character codes according to TYPE,",
00406     "                       either `octal' or `ascii'; default is ascii for",
00407     "                        letters and digits, octal for all else",
00408     "-help                   display this help and exit",
00409     "-verbose               display progress reports",
00410     "-version               output version information and exit",
00411     NULL
00412 };
00413 #endif /* VFTOVP */
00414 
00415 #ifdef VPTOVF
00416 const_string VPTOVFHELP[] = {
00417     "Usage: vptovf [OPTION]... VPLFILE[.vpl] [VFFILE[.vf] [TFMFILE[.tfm]]]",
00418     "  Translate VPLFILE to VFFILE and companion TFMFILE.",
00419     "  Default VFFILE is basename of VPLFILE extended with `.vf'.",
00420     "  Default TFMFILE is VFFILE extended with `.tfm'.",
00421     "",
00422     "-help                  display this help and exit",
00423     "-verbose               display progress reports",
00424     "-version               output version information and exit",
00425     NULL
00426 };
00427 #endif /* VPTOVF */
00428 
00429 #ifdef WEAVE
00430 const_string WEAVEHELP[] = {
00431     "Usage: weave [OPTION]... WEBFILE[.web] [CHANGEFILE[.ch]]",
00432     "  Weave WEBFILE with CHANGEFILE into a TeX document.",
00433     "  Default CHANGEFILE is /dev/null;",
00434     "  TeX output goes to the basename of WEBFILE extended with `.tex'.",
00435     "",
00436     "-x          omit cross-reference information",
00437     "-help       display this help and exit",
00438     "-version    output version information and exit",
00439     NULL
00440 };
00441 #endif /* WEAVE */
00442 
00443 #endif /* not HELP_H */