Debian Codegraph @

test/okay/testoptj.err

raw
1
2 Usage: ../bibclean [ -author ] [ -copyleft ] [ -copyright ]
3 [ -error-log filename ] [ -help ] [ '-?' ]
4 [ -init-file filename ] [ -ISBN-file filename ]
5 [ -keyword-file filename ] [ -max-width nnn ]
6 [ -[no-]align-equals ] [ -[no-]brace-protect ]
7 [ -[no-]check-values ] [ -[no-]debug-match-failures ]
8 [ -[no-]delete-empty-values ] [ -[no-]file-position ]
9 [ -[no-]fix-accents ] [ -[no-]fix-braces ] [ -[no-]fix-degrees ]
10 [ -[no-]fix-font-changes ] [ -[no-]fix-initials ]
11 [ -[no-]fix-math ] [ -[no-]fix-names ] [ -[no-]German-style ]
12 [ -[no-]keep-linebreaks ] [ -[no-]keep-parbreaks ]
13 [ -[no-]keep-preamble-spaces ] [ -[no-]keep-spaces ]
14 [ -[no-]keep-string-spaces ] [ -[no-]parbreaks ]
15 [ -[no-]prettyprint ] [ -[no-]print-ISBN-table ]
16 [ -[no-]print-keyword-table ] [ -[no-]print-patterns ]
17 [ -[no-]quiet ] [ -[no-]read-init-files ]
18 [ -[no-]remove-OPT-prefixes ] [ -[no-]scribe ]
19 [ -[no-]trace-file-opening ] [ -[no-]warnings ]
20 [ -output-file filename ] [ -version ]
21 [ <infile or bibfile1 bibfile2 bibfile3 ...] >outfile
22
23 Command-line switches may be abbreviated to a unique leading prefix,
24 and letter case is not significant. All options are parsed before any
25 input bibliography files are read, no matter what their order on the
26 command line. Options that correspond to a yes/no setting of a flag
27 have a form with a prefix "no-" to set the flag to no. For such
28 options, the last setting determines the flag value used. That is
29 significant when options are also specified in initialization files
30 (see the INITIALIZATION FILES manual section).
31
32 The leading hyphen that distinguishes an option from a filename may be
33 doubled, for compatibility with GNU and POSIX conventions. Thus,
34 -author and --author are equivalent.
35
36 To avoid confusion with options, if a filename begins with a hyphen, it
37 must be disguised by a leading absolute or relative directory path,
38 e.g., /tmp/-foo.bib or ./-foo.bib.
39
40 -author Display an author credit on the standard error unit, stderr,
41 and then terminate with a success return code. Sometimes an
42 executable program is separated from its documentation and
43 source code; this option provides a way to recover from that.
44
45 -copyleft Display copyright information on the standard error unit,
46 stderr, and then terminate with a success return code.
47
48 -copyright
49 Display copyright information on the standard error unit,
50 stderr, and then terminate with a success return code.
51
52 -error-log filename
53 Redirect stderr to the indicated file, which then contains
54 all of the error and warning messages. This option is
55 provided for those systems that have difficulty redirecting
56 stderr.
57
58 -help or -?
59 Display a help message on stderr, giving a usage description,
60 similar to this section of the manual pages, and then
61 terminate with a success return code.
62
63 -ISBN-file filename
64 Provide an explicit ISBN-range initialization file. It is
65 processed after any system-wide and job-wide ISBN
66 initialization files found on the PATH (for VAX VMS,
67 SYS$SYSTEM) and BIBINPUTS search paths, respectively, and may
68 override them. The ISBN initialization file name can be
69 changed at compile time, or at run time through a setting of
70 the environment variable BIBCLEANISBN, but defaults to
71 .bibclean.isbn on UNIX, and bibclean.isb elsewhere. For
72 further details, see the ISBN INITIALIZATION FILES manual
73 section.
74
75 -init-file filename
76 Provide an explicit value pattern initialization file. It is
77 processed after any system-wide and job-wide initialization
78 files found on the PATH (for VAX VMS, SYS$SYSTEM) and
79 BIBINPUTS search paths, respectively, and may override them.
80 It in turn may be overridden by a subsequent file-specific
81 initialization file. The initialization file name can be
82 changed at compile time, or at run time through a setting of
83 the environment variable BIBCLEANINI, but defaults to
84 .bibcleanrc on UNIX, and to bibclean.ini elsewhere. For
85 further details, see the INITIALIZATION FILES manual section.
86
87 -keyword-file filename
88 Provide an explicit keyword initialization file. It is
89 processed after any system-wide and job-wide keyword
90 initialization files found on the PATH (for VAX VMS,
91 SYS$SYSTEM) and BIBINPUTS search paths, respectively, and may
92 override them. The keyword initialization file name can be
93 changed at compile time, or at run time through a setting of
94 the environment variable BIBCLEANKEY, but defaults to
95 .bibclean.key on UNIX, and bibclean.key elsewhere. For
96 further details, see the KEYWORD INITIALIZATION FILES manual
97 section.
98
99 -max-width nnn
100 bibclean normally limits output line widths to 72 characters,
101 and in the interests of consistency, that value should not be
102 changed. Occasionally, special-purpose applications may
103 require different maximum line widths, so this option
104 provides that capability. The number following the option
105 name can be specified in decimal, octal (starting with 0), or
106 hexadecimal (starting with 0x). A zero or negative value is
107 interpreted to mean unlimited, so -max-width 0 can be used to
108 ensure that each field/value pair appears on a single line.
109
110 When -no-prettyprint requests bibclean to act as a lexical
111 analyzer, the default line width is unlimited, unless
112 overridden by this option.
113
114 When bibclean is prettyprinting, line wrapping is done only
115 at a space. Consequently, a long non-blank character sequence
116 may result in the output exceeding the requested line width.
117
118 When bibclean is lexing, line wrapping is done by inserting a
119 backslash-newline pair when the specified maximum is reached,
120 so no line length ever exceeds the maximum.
121
122 -[no-]align-equals
123 With the positive form, align the equals sign in key/value
124 assignments at the same column, separated by a single space
125 from the value string. Otherwise, the equals sign follows
126 the key, separated by a single space. Default: no.
127
128 -[no-]brace-protect
129 Protect uppercase and mixedcase words at brace-level zero
130 with braces to prevent downcasing by some BibTeX styles.
131 Default: yes.
132
133 -[no-]check-values
134 With the positive form, apply heuristic pattern matching to
135 field values in order to detect possible errors (e.g., ``year
136 = "192"'' instead of ``year = "1992"''), and issue warnings
137 when unexpected patterns are found.
138
139 That checking is usually beneficial, but if it produces too
140 many bogus warnings for a particular bibliography file, you
141 can disable it with the negative form of this option.
142 Default: yes.
143
144 -[no-]debug-match-failures
145 With the positive form, print out a warning when a value
146 pattern fails to match a value string.
147
148 That is helpful in debugging new patterns, but because the
149 output can be voluminous, you should use this option only
150 with small test files, and initialization files that
151 eliminate all patterns apart from the ones that you are
152 testing. Default: no.
153
154 -[no-]delete-empty-values
155 With the positive form, remove all field/value pairs for
156 which the value is an empty string. That is helpful in
157 cleaning up bibliographies generated from text editor
158 templates. Compare this option with -[no-]remove-OPT-prefixes
159 described below. Default: no.
160
161 -[no-]file-position
162 With the positive form, give detailed file position
163 information in warning and error messages. Default: no.
164
165 -[no-]fix-accents
166 With the positive form, normalize TeX accents in annotes,
167 authors, booktitles, editors, notes, remarks, and titles.
168 Default: no.
169
170 -[no-]fix-braces
171 With the positive form, normalize bracing in annotes,
172 authors, booktitles, editors, notes, remarks, and titles, by
173 removing unnecessary levels of braces. Default: no.
174
175 -[no-]fix-degrees
176 With the positive form, remove spaces in author/editor fields
177 inside braces after letter-ending periods. That makes
178 reductions from J. J. {Thomson, M. A., F. R. S.}, Frederick
179 {Soddy, B. A. (Oxon.)}, and John A. {Cable, M. A., M. Ed.,
180 Dipl. Deutsch (Marburg), A. L. C. M.} to J. J. {Thomson,
181 M.A., F.R.S.}, Frederick {Soddy, B.A. (Oxon.)}, and John A.
182 {Cable, M.A., M.Ed., Dipl.Deutsch (Marburg), A.L.C.M.},
183 respectively.
184
185 In journals in the humanities and history of science, as well
186 as in some scientific journals until well into the 20th
187 Century, academic, honorary, and professional titles and
188 degrees are commonly attached to personal names. Even though
189 modern publishing practice avoids such decorations, for
190 accuracy, bibliography entries should preferably retain them.
191 Journal typographical practice generally follows the
192 reductions described here.
193
194 -[no-]fix-font-changes
195 With the positive form, supply an additional brace level
196 around font changes in titles to protect against downcasing
197 by some BibTeX styles. Font changes that already have more
198 than one level of braces are not modified.
199
200 For example, if a title contains the Latin phrase {\em
201 Dictyostelium discoideum} or {\em {D}ictyostelium
202 discoideum}, then downcasing incorrectly converts the phrase
203 to lower-case letters. Most BibTeX users are surprised that
204 bracing the initial letters does not prevent the downcase
205 action. The correct coding is {{\em Dictyostelium
206 discoideum}}. However, there are also legitimate cases where
207 an extra level of bracing wrongly protects from downcasing.
208 Consequently, bibclean normally does not supply an extra
209 level of braces, but if you have a bibliography where the
210 extra braces are routinely missing, you can use this option
211 to supply them.
212
213 If you think that you need this option, it is strongly
214 recommended that you apply bibclean to your bibliography file
215 with and without -fix-font-changes, then compare the two
216 output files to ensure that extra braces are not being
217 supplied in titles where they should not be present. You
218 must decide which of the two output files is the better
219 choice, then repair the incorrect title bracing by hand.
220
221 Because font changes in titles are uncommon, except for cases
222 of the type that this option is designed to correct, it
223 should do more good than harm. Default: no.
224
225 -[no-]fix-initials
226 With the positive form, insert a space after a period
227 following author initials. Default: yes.
228
229 -[no-]fix-math
230 With the positive form, improve readability of math mode in
231 titles by inserting spaces around operators, deleting other
232 unnecessary space, and removing braces around single-
233 character subscripts and superscripts. Default: no.
234
235 -[no-]fix-names
236 With the positive form, reorder author and editor name lists
237 to remove commas at brace level zero, placing first names or
238 initials before last names. Default: yes.
239
240 -[no-]German-style
241 With the positive form, interpret quote characters ["] inside
242 braced value strings at brace level 1 according to the
243 conventions of the TeX style file german.sty, which overloads
244 quote to simplify input and representation of German umlaut
245 accents, sharp-s (es-zet), ligature separators, invisible
246 hyphens, raised/lowered quotes, French guillemets, and
247 discretionary hyphens. Recognized character combinations are
248 braced to prevent BibTeX from interpreting the quote as a
249 string delimiter.
250
251 Quoted strings receive no special handling from this option,
252 and because German nouns in titles must anyway be protected
253 from the downcasing operation of most BibTeX bibliography
254 styles, German value strings that use the overloaded quote
255 character can always be entered in the form "{...}", without
256 the need to specify this option at all.
257
258 Default: no.
259
260 -[no-]keep-linebreaks
261 Normally, line breaks inside value strings are collapsed into
262 a single space, so that long value strings can later be
263 broken to provide lines of reasonable length.
264
265 With the positive form, linebreaks are preserved in value
266 strings. If -max-width is set to zero, this preserves the
267 original line breaks. Spacing outside value strings remains
268 under bibclean's control, and is not affected by this option.
269
270 Default: no.
271
272 -[no-]keep-parbreaks
273 With the positive form, preserve paragraph breaks (either
274 formfeeds, or lines containing only spaces) in value strings.
275 Normally, paragraph breaks are collapsed into a single space.
276 Spacing outside value strings remains under bibclean's
277 control, and is not affected by this option. Default: no.
278
279 -[no-]keep-preamble-spaces
280 With the positive form, preserve all whitespace in
281 @Preamble{...} entries. Default: no.
282
283 -[no-]keep-spaces
284 With the positive form, preserve all spaces in value strings.
285 Normally, multiple spaces are collapsed into a single space.
286 This option can be used together with -keep-linebreaks,
287 -keep-parbreaks, and -max-width 0 to preserve the form of
288 value strings while still providing syntax and value
289 checking. Spacing outside value strings remains under
290 bibclean's control, and is not affected by this option.
291 Default: no.
292
293 -[no-]keep-string-spaces
294 With the positive form, preserve all whitespace in
295 @String{...} entries. Default: no.
296
297 -[no-]parbreaks
298 With the negative form, a paragraph break (either a formfeed,
299 or a line containing only spaces) is not permitted in value
300 strings, or between field/value pairs. That may be useful to
301 quickly trap runaway strings arising from mismatched
302 delimiters. Default: yes.
303
304 -[no-]prettyprint
305 Normally, bibclean functions as a prettyprinter. However,
306 with the negative form of this option, it acts as a lexical
307 analyzer instead, producing a stream of lexical tokens. See
308 the LEXICAL ANALYSIS manual section for further details.
309 Default: yes.
310
311 -[no-]print-ISBN-table
312 With the positive form, print the ISBN-range table on stderr,
313 then terminate with a success return code.
314
315 That action is taken after all command-line options are
316 processed, and before any input files are read (other than
317 those that are values of command-line options).
318
319 The format of the output ISBN-range table is acceptable for
320 input as an ISBN initialization file (see the ISBN
321 INITIALIZATION FILES manual section). Default: no.
322
323 -[no-]print-keyword-table
324 With the positive form, print the keyword initialization
325 table on stderr, then terminate with a success return code.
326
327 That action is taken after all command-line options are
328 processed, and before any input files are read (other than
329 those that are values of command-line options).
330
331 The format of the output table is acceptable for input as a
332 keyword initialization file (see the KEYWORD INITIALIZATION
333 FILES manual section). Default: no.
334
335 -[no-]print-patterns
336 With the positive form, print the value patterns read from
337 initialization files as they are added to internal tables.
338 Use this option to check newly-added patterns, or to see what
339 patterns are being used.
340
341 When bibclean is compiled with native pattern-matching code
342 (the default), those patterns are the ones that are used in
343 checking value strings for valid syntax, and all of them are
344 specified in initialization files, rather than hard-coded
345 into the program. For further details, see the
346 INITIALIZATION FILES manual section. Default: no.
347
348 -[no-]quiet
349 This option is the opposite of -[no-]warning; it exists for
350 user convenience, and for compatibility with other programs
351 that use -q for quiet operation, without warning messages.
352
353 -[no-]read-init-files
354 With the negative form, suppress loading of system-, user-,
355 and file-specific initialization files. Initializations then
356 come only from those files explicitly given by -init-file
357 filename options. Default: yes.
358
359 -[no-]remove-OPT-prefixes
360 With the positive form, remove the ``OPT'' prefix from each
361 field name where the corresponding value is not an empty
362 string. The prefix ``OPT'' must be entirely in upper-case to
363 be recognized.
364
365 This option is for bibliographies generated with the help of
366 the GNU Emacs BibTeX editing support, which generates
367 templates with optional fields identified by the ``OPT''
368 prefix. Although the function M-x bibtex-remove-OPT normally
369 bound to the keystrokes C-c C-o does the job, users often
370 forget, with the result that BibTeX does not recognize the
371 field name, and ignores the value string. Compare this
372 option with -[no-]delete-empty-values described above.
373 Default: no.
374
375 -[no-]scribe
376 With the positive form, accept input syntax conforming to the
377 Scribe document system. The output is converted to conform
378 to BibTeX syntax. See the SCRIBE BIBLIOGRAPHY FORMAT manual
379 section for further details. Default: no.
380
381 -[no-]trace-file-opening
382 With the positive form, record in the error log file the
383 names of all files that bibclean attempts to open. Use this
384 option to identify where initialization files are located.
385 Default: no.
386
387 -[no-]warnings
388 With the positive form, allow all warning messages. The
389 negative form is not recommended because it may mask problems
390 that should be repaired. Default: yes.
391
392 -output-file filename
393 Supply an alternate output file to replace stdout. If the
394 filename cannot be opened for output, execution terminates
395 immediately with a nonzero exit code.
396
397 -version Display the program version number on stderr, and then
398 terminate with a success return code. That includes an
399 indication of who compiled the program, the host name on
400 which it was compiled, the time of compilation, and the type
401 of string-value matching code selected, when that information
402 is available to the compiler.
403