usage-txt.h revision 181834
1223013Sdim/*   -*- buffer-read-only: t -*- vi: set ro:
2223013Sdim *
3223013Sdim *  DO NOT EDIT THIS FILE   (usage-txt.h)
4223013Sdim *
5223013Sdim *  It has been AutoGen-ed  Saturday May  5, 2007 at 12:02:33 PM PDT
6223013Sdim *  From the definitions    usage-txt.def
7223013Sdim *  and the template file   usage-txt.tpl
8223013Sdim *
9223013Sdim *  This file handles all the bookkeeping required for tracking all the little
10223013Sdim *  tiny strings used by the AutoOpts library.  There are 113
11249423Sdim *  of them.  This is not versioned because it is entirely internal to the
12223013Sdim *  library and accessed by client code only in a very well-controlled way:
13249423Sdim *  they may substitute translated strings using a procedure that steps through
14226633Sdim *  all the string pointers.
15249423Sdim *
16249423Sdim *  AutoOpts is free software; you can redistribute it and/or
17223013Sdim *  modify it under the terms of the GNU Lesser General Public
18223013Sdim *  License as published by the Free Software Foundation; either
19223013Sdim *  version 2.1 of the License, or (at your option) any later version.
20223013Sdim *
21223013Sdim *  AutoOpts is distributed in the hope that it will be useful,
22223013Sdim *  but WITHOUT ANY WARRANTY; without even the implied warranty of
23223013Sdim *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
24223013Sdim *  Lesser General Public License for more details.
25223013Sdim *
26223013Sdim *  You should have received a copy of the GNU Lesser General Public
27223013Sdim *  License along with AutoOpts.  If not, write to:
28223013Sdim *  	The Free Software Foundation, Inc.,
29223013Sdim *  	51 Franklin Street, Fifth Floor
30223013Sdim *  	Boston, MA  02110-1301, USA.
31223013Sdim */
32223013Sdim#ifndef AUTOOPTS_USAGE_TXT_H_GUARD
33223013Sdim#define AUTOOPTS_USAGE_TXT_H_GUARD
34223013Sdim
35223013Sdim#undef  cch_t
36223013Sdim#define cch_t char const
37223013Sdim
38223013Sdim/*
39223013Sdim *  One structure to hold all the pointers to all the stringlets.
40223013Sdim */
41223013Sdimtypedef struct {
42223013Sdim  int       field_ct;
43223013Sdim  char*     utpz_GnuBoolArg;
44223013Sdim  char*     utpz_GnuKeyArg;
45223013Sdim  char*     utpz_GnuKeyLArg;
46223013Sdim  char*     utpz_GnuNumArg;
47223013Sdim  char*     utpz_GnuStrArg;
48223013Sdim  cch_t*    apz_str[ 108 ];
49223013Sdim} usage_text_t;
50223013Sdim
51223013Sdim/*
52223013Sdim *  Declare the global structure with all the pointers to translated
53223013Sdim *  strings.  This is then used by the usage generation procedure.
54223013Sdim */
55223013Sdimextern usage_text_t option_usage_text;
56223013Sdim
57223013Sdim#if defined(AUTOOPTS_INTERNAL) /* DEFINE ALL THE STRINGS = = = = = */
58223013Sdim/*
59223013Sdim *  Provide a mapping from a short name to fields in this structure.
60223013Sdim */
61223013Sdim#define zAO_Bad               (option_usage_text.apz_str[  0])
62223013Sdim#define zAO_Big               (option_usage_text.apz_str[  1])
63223013Sdim#define zAO_Err               (option_usage_text.apz_str[  2])
64223013Sdim#define zAO_Sml               (option_usage_text.apz_str[  3])
65223013Sdim#define zAll                  (option_usage_text.apz_str[  4])
66223013Sdim#define zAlt                  (option_usage_text.apz_str[  5])
67263508Sdim#define zAmbigKey             (option_usage_text.apz_str[  6])
68223013Sdim#define zAmbiguous            (option_usage_text.apz_str[  7])
69223013Sdim#define zArgsMust             (option_usage_text.apz_str[  8])
70223013Sdim#define zAtMost               (option_usage_text.apz_str[  9])
71223013Sdim#define zAuto                 (option_usage_text.apz_str[ 10])
72223013Sdim#define zBadPipe              (option_usage_text.apz_str[ 11])
73223013Sdim#define zBadVerArg            (option_usage_text.apz_str[ 12])
74223013Sdim#define zCantFmt              (option_usage_text.apz_str[ 13])
75223013Sdim#define zCantSave             (option_usage_text.apz_str[ 14])
76223013Sdim#define zDefaultOpt           (option_usage_text.apz_str[ 15])
77223013Sdim#define zDis                  (option_usage_text.apz_str[ 16])
78223013Sdim#define zEnab                 (option_usage_text.apz_str[ 17])
79223013Sdim#define zEquiv                (option_usage_text.apz_str[ 18])
80223013Sdim#define zErrOnly              (option_usage_text.apz_str[ 19])
81223013Sdim#define zExamineFmt           (option_usage_text.apz_str[ 20])
82223013Sdim#define zFiveSpaces           (option_usage_text.apz_str[ 21])
83223013Sdim#define zFlagOkay             (option_usage_text.apz_str[ 22])
84223013Sdim#define zFmtFmt               (option_usage_text.apz_str[ 23])
85223013Sdim#define zForkFail             (option_usage_text.apz_str[ 24])
86223013Sdim#define zFSErrOptLoad         (option_usage_text.apz_str[ 25])
87223013Sdim#define zFSErrReadFile        (option_usage_text.apz_str[ 26])
88223013Sdim#define zGenshell             (option_usage_text.apz_str[ 27])
89223013Sdim#define zGnuBoolArg           (option_usage_text.utpz_GnuBoolArg)
90223013Sdim#define zGnuBreak             (option_usage_text.apz_str[ 28])
91223013Sdim#define zGnuKeyArg            (option_usage_text.utpz_GnuKeyArg)
92223013Sdim#define zGnuKeyLArg           (option_usage_text.utpz_GnuKeyLArg)
93223013Sdim#define zGnuNestArg           (option_usage_text.apz_str[ 29])
94223013Sdim#define zGnuNumArg            (option_usage_text.utpz_GnuNumArg)
95223013Sdim#define zGnuOptArg            (option_usage_text.apz_str[ 30])
96263508Sdim#define zGnuOptFmt            (option_usage_text.apz_str[ 31])
97223013Sdim#define zGnuStrArg            (option_usage_text.utpz_GnuStrArg)
98223013Sdim#define zIllOptChr            (option_usage_text.apz_str[ 32])
99223013Sdim#define zIllOptStr            (option_usage_text.apz_str[ 33])
100223013Sdim#define zIllegal              (option_usage_text.apz_str[ 34])
101223013Sdim#define zInvalOptDesc         (option_usage_text.apz_str[ 35])
102223013Sdim#define zKeyWords             (option_usage_text.apz_str[ 36])
103223013Sdim#define zLoadCooked           (option_usage_text.apz_str[ 37])
104223013Sdim#define zLoadKeep             (option_usage_text.apz_str[ 38])
105223013Sdim#define zLoadType             (option_usage_text.apz_str[ 39])
106223013Sdim#define zLoadUncooked         (option_usage_text.apz_str[ 40])
107223013Sdim#define zLtypeInteger         (option_usage_text.apz_str[ 41])
108223013Sdim#define zLtypeNest            (option_usage_text.apz_str[ 42])
109223013Sdim#define zLtypeString          (option_usage_text.apz_str[ 43])
110223013Sdim#define zLtypeBool            (option_usage_text.apz_str[ 44])
111223013Sdim#define zLtypeKeyword         (option_usage_text.apz_str[ 45])
112223013Sdim#define zLtypeSetMembership   (option_usage_text.apz_str[ 46])
113223013Sdim#define zMembers              (option_usage_text.apz_str[ 47])
114223013Sdim#define zMisArg               (option_usage_text.apz_str[ 48])
115223013Sdim#define zMultiEquiv           (option_usage_text.apz_str[ 49])
116223013Sdim#define zMust                 (option_usage_text.apz_str[ 50])
117223013Sdim#define zNeedOne              (option_usage_text.apz_str[ 51])
118223013Sdim#define zNoArg                (option_usage_text.apz_str[ 52])
119223013Sdim#define zNoArgs               (option_usage_text.apz_str[ 53])
120223013Sdim#define zNoCreat              (option_usage_text.apz_str[ 54])
121223013Sdim#define zNoFlags              (option_usage_text.apz_str[ 55])
122223013Sdim#define zNoKey                (option_usage_text.apz_str[ 56])
123223013Sdim#define zNoLim                (option_usage_text.apz_str[ 57])
124223013Sdim#define zNoPreset             (option_usage_text.apz_str[ 58])
125223013Sdim#define zNoRq_NoShrtTtl       (option_usage_text.apz_str[ 59])
126223013Sdim#define zNoRq_ShrtTtl         (option_usage_text.apz_str[ 60])
127223013Sdim#define zNoStat               (option_usage_text.apz_str[ 61])
128223013Sdim#define zNoState              (option_usage_text.apz_str[ 62])
129223013Sdim#define zNone                 (option_usage_text.apz_str[ 63])
130223013Sdim#define zNotDef               (option_usage_text.apz_str[ 64])
131263508Sdim#define zNotEnough            (option_usage_text.apz_str[ 65])
132263508Sdim#define zNotFile              (option_usage_text.apz_str[ 66])
133263508Sdim#define zNotNumber            (option_usage_text.apz_str[ 67])
134263508Sdim#define zNrmOptFmt            (option_usage_text.apz_str[ 68])
135263508Sdim#define zNumberOpt            (option_usage_text.apz_str[ 69])
136263508Sdim#define zOneSpace             (option_usage_text.apz_str[ 70])
137263508Sdim#define zOnlyOne              (option_usage_text.apz_str[ 71])
138263508Sdim#define zOptsOnly             (option_usage_text.apz_str[ 72])
139263508Sdim#define zPathFmt              (option_usage_text.apz_str[ 73])
140263508Sdim#define zPlsSendBugs          (option_usage_text.apz_str[ 74])
141263508Sdim#define zPreset               (option_usage_text.apz_str[ 75])
142263508Sdim#define zPresetFile           (option_usage_text.apz_str[ 76])
143263508Sdim#define zPresetIntro          (option_usage_text.apz_str[ 77])
144223013Sdim#define zProg                 (option_usage_text.apz_str[ 78])
145223013Sdim#define zProhib               (option_usage_text.apz_str[ 79])
146223013Sdim#define zReorder              (option_usage_text.apz_str[ 80])
147223013Sdim#define zReqFmt               (option_usage_text.apz_str[ 81])
148223013Sdim#define zReqOptFmt            (option_usage_text.apz_str[ 82])
149263508Sdim#define zReqThese             (option_usage_text.apz_str[ 83])
150263508Sdim#define zReq_NoShrtTtl        (option_usage_text.apz_str[ 84])
151263508Sdim#define zReq_ShrtTtl          (option_usage_text.apz_str[ 85])
152263508Sdim#define zSepChars             (option_usage_text.apz_str[ 86])
153263508Sdim#define zSetMembers           (option_usage_text.apz_str[ 87])
154223013Sdim#define zSetMemberSettings    (option_usage_text.apz_str[ 88])
155223013Sdim#define zShrtGnuOptFmt        (option_usage_text.apz_str[ 89])
156223013Sdim#define zSixSpaces            (option_usage_text.apz_str[ 90])
157223013Sdim#define zStdBoolArg           (option_usage_text.apz_str[ 91])
158223013Sdim#define zStdBreak             (option_usage_text.apz_str[ 92])
159223013Sdim#define zStdKeyArg            (option_usage_text.apz_str[ 93])
160223013Sdim#define zStdKeyLArg           (option_usage_text.apz_str[ 94])
161223013Sdim#define zStdNestArg           (option_usage_text.apz_str[ 95])
162223013Sdim#define zStdNoArg             (option_usage_text.apz_str[ 96])
163223013Sdim#define zStdNumArg            (option_usage_text.apz_str[ 97])
164223013Sdim#define zStdOptArg            (option_usage_text.apz_str[ 98])
165263508Sdim#define zStdReqArg            (option_usage_text.apz_str[ 99])
166263508Sdim#define zStdStrArg            (option_usage_text.apz_str[100])
167223013Sdim#define zTabHyp               (option_usage_text.apz_str[101])
168223013Sdim#define zTabHypAnd            (option_usage_text.apz_str[102])
169223013Sdim#define zTabout               (option_usage_text.apz_str[103])
170223013Sdim#define zThreeSpaces          (option_usage_text.apz_str[104])
171223013Sdim#define zTwoSpaces            (option_usage_text.apz_str[105])
172223013Sdim#define zUpTo                 (option_usage_text.apz_str[106])
173223013Sdim#define zValidKeys            (option_usage_text.apz_str[107])
174223013Sdim
175223013Sdim  /*
176223013Sdim   *  First, set up the strings.  Some of these are writable.  These are all in
177223013Sdim   *  English.  This gets compiled into libopts and is distributed here so that
178223013Sdim   *  xgettext (or equivalents) can extract these strings for translation.
179223013Sdim   */
180223013Sdim
181223013Sdim  static char    eng_zGnuBoolArg[] = "=T/F";
182223013Sdim  static char    eng_zGnuKeyArg[] = "=KWd";
183223013Sdim  static char    eng_zGnuKeyLArg[] = "=Mbr";
184223013Sdim  static char    eng_zGnuNumArg[] = "=num";
185223013Sdim  static char    eng_zGnuStrArg[] = "=str";
186223013Sdimstatic char const usage_txt[3208] =
187223013Sdim    "AutoOpts function called without option descriptor\n\0"
188223013Sdim    "\tThis exceeds the compiled library version:  \0"
189223013Sdim    "Automated Options Processing Error!\n"
190223013Sdim    "\t%s called AutoOpts function with structure version %d:%d:%d.\n\0"
191223013Sdim    "\tThis is less than the minimum library version:  \0"
192223013Sdim    "all\0"
193223013Sdim    "\t\t\t\t- an alternate for %s\n\0"
194223013Sdim    "%s error:  the keyword `%s' is ambiguous for %s\n\0"
195223013Sdim    "ambiguous\0"
196223013Sdim    "%s: Command line arguments required\n\0"
197223013Sdim    "%d %s%s options allowed\n\0"
198223013Sdim    "version and help options:\0"
199223013Sdim    "Error %d (%s) from the pipe(2) syscall\n\0"
200223013Sdim    "ERROR: version option argument '%c' invalid.  Use:\n"
201223013Sdim    "\t'v' - version only\n"
202263508Sdim    "\t'c' - version and copyright\n"
203263508Sdim    "\t'n' - version and copyright notice\n\0"
204263508Sdim    "ERROR:  %s option conflicts with the %s option\n\0"
205263508Sdim    "%s(optionSaveState): error: cannot allocate %d bytes\n\0"
206263508Sdim    "\t\t\t\t- default option for unnamed options\n\0"
207263508Sdim    "\t\t\t\t- disabled as --%s\n\0"
208263508Sdim    "\t\t\t\t- enabled by default\n\0"
209263508Sdim    "-equivalence\0"
210223013Sdim    "ERROR:  only \0"
211223013Sdim    " - examining environment variables named %s_*\n\0"
212223013Sdim    "     \0"
213223013Sdim    "Options are specified by doubled hyphens and their name\n"
214263508Sdim    "or by a single hyphen and the flag character.\n\0"
215263508Sdim    "%%-%ds %%s\n\0"
216263508Sdim    "fs error %d (%s) on fork - cannot obtain %s usage\n\0"
217263508Sdim    "File error %d (%s) opening %s for loading options\n\0"
218223013Sdim    "fs error %d (%s) reading file %s\n\0"
219223013Sdim    "\n"
220223013Sdim    "= = = = = = = =\n\n"
221263508Sdim    "This incarnation of genshell will produce\n"
222223013Sdim    "a shell script to parse the options for %s:\n\n\0"
223223013Sdim    "\n"
224223013Sdim    "%s\n\n\0"
225223013Sdim    "=Cplx\0"
226223013Sdim    "[=arg]\0"
227223013Sdim    "--%2$s%1$s\0"
228223013Sdim    "%s: illegal option -- %c\n\0"
229223013Sdim    "%s: %s option -- %s\n\0"
230223013Sdim    "illegal\0"
231223013Sdim    "AutoOpts ERROR:  invalid option descriptor for %s\n\0"
232223013Sdim    "words=\0"
233223013Sdim    "cooked\0"
234223013Sdim    "keep\0"
235223013Sdim    "type=\0"
236223013Sdim    "uncooked\0"
237223013Sdim    "integer\0"
238223013Sdim    "nested\0"
239223013Sdim    "string\0"
240223013Sdim    "bool\0"
241223013Sdim    "keyword\0"
242223013Sdim    "set\0"
243223013Sdim    "\t\t\t\t- is a set membership option\n\0"
244226633Sdim    "%s: option `%s' requires an argument\n\0"
245226633Sdim    "Equivalenced option '%s' was equivalenced to both\n"
246226633Sdim    "\t'%s' and '%s'\0"
247226633Sdim    "\t\t\t\t- must appear between %d and %d times\n\0"
248226633Sdim    "ERROR:  The %s option is required\n\0"
249226633Sdim    "%s: option `%s' cannot have an argument\n\0"
250226633Sdim    "%s: Command line arguments not allowed\n\0"
251239462Sdim    "error %d (%s) creating %s\n\0"
252226633Sdim    "Options are specified by single or double hyphens and their name.\n\0"
253226633Sdim    "%s error:  `%s' does not match any %s keywords\n\0"
254226633Sdim    "\t\t\t\t- may appear multiple times\n\0"
255226633Sdim    "\t\t\t\t- may not be preset\n\0"
256226633Sdim    "   Arg Option-Name    Description\n\0"
257226633Sdim    "  Flg Arg Option-Name    Description\n\0"
258226633Sdim    "error %d (%s) stat-ing %s\n\0"
259226633Sdim    "%s(optionRestore): error: no saved option state\n\0"
260226633Sdim    "none\0"
261239462Sdim    "'%s' not defined\n\0"
262226633Sdim    "ERROR:  The %s option must appear %d times\n\0"
263226633Sdim    "error:  cannot load options from non-regular file %s\n\0"
264226633Sdim    "%s error:  `%s' is not a recognizable number\n\0"
265223013Sdim    " %3s %s\0"
266223013Sdim    "The '-#<number>' option may omit the hash char\n\0"
267223013Sdim    " \0"
268223013Sdim    "one %s%s option allowed\n\0"
269223013Sdim    "All arguments are named options.\n\0"
270223013Sdim    " - reading file %s\0"
271226633Sdim    "\n"
272223013Sdim    "please send bug reports to:  %s\n\0"
273223013Sdim    "\t\t\t\t- may NOT appear - preset only\n\0"
274223013Sdim    "#  preset/initialization file\n"
275223013Sdim    "#  %s#\n\0"
276223013Sdim    "\n"
277223013Sdim    "The following option preset mechanisms are supported:\n\0"
278223013Sdim    "program\0"
279223013Sdim    "prohibits these options:\n\0"
280223013Sdim    "Operands and options may be intermixed.  They will be reordered.\n\0"
281223013Sdim    "ERROR:  %s option requires the %s option\n\0"
282223013Sdim    " %3s %-14s %s\0"
283226633Sdim    "requires these options:\n\0"
284223013Sdim    "   Arg Option-Name   Req?  Description\n\0"
285223013Sdim    "  Flg Arg Option-Name   Req?  Description\n\0"
286223013Sdim    "-_^\0"
287223013Sdim    "members=\0"
288223013Sdim    "or you may use a numeric representation.  Preceding these with a '!' will\n"
289223013Sdim    "clear the bits, specifying 'none' will clear all bits, and 'all' will set them\n"
290223013Sdim    "all.  Multiple entries may be passed as an option argument list.\n\0"
291226633Sdim    "%s\0"
292223013Sdim    "      \0"
293223013Sdim    "T/F\0"
294223013Sdim    "\n"
295223013Sdim    "%s\n\n"
296223013Sdim    "%s\0"
297223013Sdim    "KWd\0"
298223013Sdim    "Mbr\0"
299    "Cpx\0"
300    "no \0"
301    "Num\0"
302    "opt\0"
303    "YES\0"
304    "Str\0"
305    "\t\t\t\t- \0"
306    "\t\t\t\t-- and \0"
307    "\t\t\t\t%s\n\0"
308    "   \0"
309    "  \0"
310    "\t\t\t\t- may appear up to %d times\n\0"
311    "The valid \"%s\" option keywords are:\n\0";
312
313
314  /*
315   *  Now, define (and initialize) the structure that contains
316   *  the pointers to all these strings.
317   *  Aren't you glad you don't maintain this by hand?
318   */
319  usage_text_t option_usage_text = {
320    113,
321    eng_zGnuBoolArg, eng_zGnuKeyArg,  eng_zGnuKeyLArg, eng_zGnuNumArg,
322    eng_zGnuStrArg,
323    {
324      usage_txt +   0, usage_txt +  52, usage_txt +  98, usage_txt + 197,
325      usage_txt + 247, usage_txt + 251, usage_txt + 278, usage_txt + 327,
326      usage_txt + 337, usage_txt + 374, usage_txt + 399, usage_txt + 425,
327      usage_txt + 465, usage_txt + 602, usage_txt + 650, usage_txt + 704,
328      usage_txt + 746, usage_txt + 770, usage_txt + 796, usage_txt + 809,
329      usage_txt + 823, usage_txt + 870, usage_txt + 876, usage_txt + 979,
330      usage_txt + 991, usage_txt +1042, usage_txt +1093, usage_txt +1127,
331      usage_txt +1233, usage_txt +1239, usage_txt +1245, usage_txt +1252,
332      usage_txt +1263, usage_txt +1289, usage_txt +1310, usage_txt +1318,
333      usage_txt +1369, usage_txt +1376, usage_txt +1383, usage_txt +1388,
334      usage_txt +1394, usage_txt +1403, usage_txt +1411, usage_txt +1418,
335      usage_txt +1425, usage_txt +1430, usage_txt +1438, usage_txt +1442,
336      usage_txt +1476, usage_txt +1514, usage_txt +1579, usage_txt +1622,
337      usage_txt +1657, usage_txt +1698, usage_txt +1738, usage_txt +1765,
338      usage_txt +1832, usage_txt +1880, usage_txt +1913, usage_txt +1938,
339      usage_txt +1973, usage_txt +2011, usage_txt +2038, usage_txt +2087,
340      usage_txt +2092, usage_txt +2110, usage_txt +2154, usage_txt +2208,
341      usage_txt +2254, usage_txt +2262, usage_txt +2310, usage_txt +2312,
342      usage_txt +2337, usage_txt +2371, usage_txt +2390, usage_txt +2424,
343      usage_txt +2460, usage_txt +2498, usage_txt +2554, usage_txt +2562,
344      usage_txt +2588, usage_txt +2654, usage_txt +2696, usage_txt +2710,
345      usage_txt +2735, usage_txt +2775, usage_txt +2818, usage_txt +2822,
346      usage_txt +2831, usage_txt +3050, usage_txt +3053, usage_txt +3060,
347      usage_txt +3064, usage_txt +3072, usage_txt +3076, usage_txt +3080,
348      usage_txt +3084, usage_txt +3088, usage_txt +3092, usage_txt +3096,
349      usage_txt +3100, usage_txt +3104, usage_txt +3111, usage_txt +3123,
350      usage_txt +3131, usage_txt +3135, usage_txt +3138, usage_txt +3171
351    }
352  };
353
354#endif /* DO_TRANSLATIONS */
355#endif /* AUTOOPTS_USAGE_TXT_H_GUARD */
356