1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
|
User Commands BIBCLEAN(1)
NAME
bibclean - prettyprint and syntax check BibTeX and Scribe
bibliography data base files
SYNOPSIS
bibclean [ -author ] [ -error-log filename ] [ -help ]
[ '-?' ] [ -init-file filename ] [ -max-width nnn ]
[ -[no-]align-equals ] [ -[no-]check-values ]
[ -[no-]delete-empty-values ]
[ -[no-]file-position ] [ -[no-]fix-font-changes ]
[ -[no-]fix-initials ] [ -[no-]fix-names ]
[ -[no-]German-style ] [ -[no-]keep-linebreaks ]
[ -[no-]keep-parbreaks ]
[ -[no-]keep-preamble-spaces ]
[ -[no-]keep-spaces ] [ -[no-]keep-string-spaces ]
[ -[no-]parbreaks ] [ -[no-]prettyprint ]
[ -[no-]print-patterns ] [ -[no-]read-init-files ]
[ -[no-]remove-OPT-prefixes ] [ -[no-]scribe ]
[ -[no-]trace-file-opening ] [ -[no-]warnings ]
[ -version ]
<infile or bibfile1 bibfile2 bibfile3 ...
>outfile
All options can be abbreviated to a unique leading prefix.
An explicit file name of ``-'' represents standard input; it
is assumed if no input files are specified.
On VAX VMS and IBM PC DOS, the leading ``-'' on option names
may be replaced by a slash, ``/''; however, the ``-'' option
prefix is always recognized.
DESCRIPTION
bibclean prettyprints input BibTeX files to stdout, and
checks the brace balance and bibliography entry syntax as
well. It can be used to detect problems in BibTeX files
that sometimes confuse even BibTeX itself, and importantly,
can be used to normalize the appearance of collections of
BibTeX files.
Here is a summary of the formatting actions:
o BibTeX items are formatted into a consistent structure
with one field = "value" pair per line, and the initial @
and trailing right brace in column 1.
o Tabs are expanded into blank strings; their use is
discouraged because they inhibit portability, and can
suffer corruption in electronic mail.
o Long string values are split at a blank and continued
onto the next line with leading indentation.
Version 2.11.4 Last change: 09 May 1998 1
User Commands BIBCLEAN(1)
o A single blank line separates adjacent bibliography
entries.
o Text outside BibTeX entries is passed through verbatim.
o Outer parentheses around entries are converted to braces.
o Personal names in author and editor field values are nor-
malized to the form ``P. D. Q. Bach'', from ``P.D.Q.
Bach'' and ``Bach, P.D.Q.''.
o Hyphen sequences in page numbers are converted to en-
dashes.
o Month values are converted to standard BibTeX string
abbreviations.
o In titles, sequences of upper-case characters at brace
level zero are braced to protect them from being con-
verted to lower-case letters by some bibliography styles.
o CODEN, ISBN (International Standard Book Number) and ISSN
(International Standard Serial Number) entry values are
examined to verify the checksums of each listed number,
and correct ISBN hyphenation is automatically supplied.
The standardized format of the output of bibclean facili-
tates the later application of simple filters, such as bib-
check(1), bibdup(1), bibextract(1), bibindex(1), bibjoin(1),
biblabel(1), biblook(1), biborder(1), bibsort(1),
citefind(1), and citetags(1), to process the text, and also
is the one expected by the GNU Emacs BibTeX support func-
tions.
OPTIONS
Command-line switches may be abbreviated to a unique leading
prefix, and letter case is not significant. All options are
parsed before any input bibliography files are read, no
matter what their order on the command line. Options that
correspond to a yes/no setting of a flag have a form with a
prefix "no-" to set the flag to no. For such options, the
last setting determines the flag value used. This is signi-
ficant when options are also specified in initialization
files (see the INITIALIZATION FILES manual section).
The leading hyphen that distinguishes an option from a
filename may be doubled, for compatibility with GNU and
POSIX conventions. Thus, -author and --author are
equivalent.
To avoid confusion with options, if a filename begins with a
hyphen, it must be disguised by a leading absolute or
Version 2.11.4 Last change: 09 May 1998 2
User Commands BIBCLEAN(1)
relative directory path, e.g., /tmp/-foo.bib or ./-foo.bib.
-author Display an author credit on the
standard error unit, stderr, and
then exit with a success return
code. Sometimes an executable
program is separated from its
documentation and source code;
this option provides a way to
recover from that.
-error-log filename Redirect stderr to the indicated
file, which will then contain
all of the error and warning
messages. This option is pro-
vided for those systems that
have difficulty redirecting
stderr.
-help or -? Display a help message on
stderr, giving a usage descrip-
tion, similar to this section of
the manual pages, and then exit
with a success return code.
-init-file filename Provide an explicit value pat-
tern initialization file. It
will be processed after any
system-wide and job-wide ini-
tialization files found on the
PATH (for VAX VMS, SYS$SYSTEM)
and BIBINPUTS search paths,
respectively, and may override
them. It in turn may be over-
ridden by a subsequent file-
specific initialization file.
The initialization file name can
be changed at compile time, or
at run time through a setting of
the environment variable BIB-
CLEANINI, but defaults to .bib-
cleanrc on UNIX, and to
bibclean.ini elsewhere. For
further details, see the INI-
TIALIZATION FILES manual sec-
tion.
-max-width nnn bibclean normally limits output
line widths to 72 characters,
and in the interests of con-
sistency, that value should not
be changed. Occasionally,
Version 2.11.4 Last change: 09 May 1998 3
User Commands BIBCLEAN(1)
special-purpose applications may
require different maximum line
widths, so this option provides
that capability. The number
following the option name can be
specified in decimal, octal
(starting with 0), or hexade-
cimal (starting with 0x). A
zero or negative value is inter-
preted to mean unlimited, so
-max-width 0 can be used to
ensure that each field/value
pair appears on a single line.
When -no-prettyprint requests
bibclean to act as a lexical
analyzer, the default line width
is unlimited, unless overridden
by this option.
When bibclean is prettyprinting,
line wrapping will be done only
at a space. Consequently, a long
non-blank character sequence may
result in the output exceeding
the requested line width.
When bibclean is lexing, line
wrapping is done by inserting a
backslash-newline pair when the
specified maximum is reached, so
no line length will ever exceed
the maximum.
-[no-]align-equals With the positive form, align
the equals sign in key/value
assignments at the same column,
separated by a single space from
the value string. Otherwise,
the equals sign follows the key,
separated by a single space.
Default: no.
-[no-]check-values With the positive form, apply
heuristic pattern matching to
field values in order to detect
possible errors (e.g., ``year =
"192"'' instead of ``year =
"1992"''), and issue warnings
when unexpected patterns are
found.
Version 2.11.4 Last change: 09 May 1998 4
User Commands BIBCLEAN(1)
This checking is usually benefi-
cial, but if it produces too
many bogus warnings for a par-
ticular bibliography file, you
can disable it with the negative
form of this option. Default:
yes.
-[no-]delete-empty-values With the positive form, remove
all field/value pairs for which
the value is an empty string.
This is helpful in cleaning up
bibliographies generated from
text editor templates. Compare
this option with -[no-]remove-
OPT-prefixes described below.
Default: no.
-[no-]file-position With the positive form, give
detailed file position informa-
tion in warning and error mes-
sages. Default: no.
-[no-]fix-font-changes With the positive form, supply
an additional brace level around
font changes in titles to pro-
tect against downcasing by some
BibTeX styles. Font changes
that already have more than one
level of braces are not modi-
fied.
For example, if a title contains
the Latin phrase {\em Dictyos-
telium Discoideum} or {\em
{D}ictyostelium {D}iscoideum},
then downcasing will incorrectly
convert the phrase to lower-case
letters. Most BibTeX users are
surprised that bracing the ini-
tial letters does not prevent
the downcase action. The
correct coding is {{\em Dictyos-
telium Discoideum}}. However,
there are also legitimate cases
where an extra level of bracing
wrongly protects from downcas-
ing. Consequently, bibclean
will normally not supply an
extra level of braces, but if
you have a bibliography where
the extra braces are routinely
Version 2.11.4 Last change: 09 May 1998 5
User Commands BIBCLEAN(1)
missing, you can use this option
to supply them.
If you think that you need this
option, it is strongly recom-
mended that you apply bibclean
to your bibliography file with
and without -fix-font-changes,
then compare the two output
files to ensure that extra
braces are not being supplied in
titles where they should not be
present. You will have to
decide which of the two output
files is the better choice, then
repair the incorrect title brac-
ing by hand.
Since font changes in titles are
uncommon, except for cases of
the type which this option is
designed to correct, it should
do more good than harm.
Default: no.
-[no-]fix-initials With the positive form, insert a
space after a period following
author initials. Default: yes.
-[no-]fix-names With the positive form, reorder
author and editor name lists to
remove commas at brace level
zero, placing first names or
initials before last names.
Default: yes.
-[no-]German-style With the positive form, inter-
pret quote characters ["] inside
braced value strings at brace
level 1 according to the conven-
tions of the TeX style file
german.sty, which overloads
quote to simplify input and
representation of German umlaut
accents, sharp-s (es-zet), liga-
ture separators, invisible
hyphens, raised/lowered quotes,
French guillemets, and discre-
tionary hyphens. Recognized
character combinations will be
braced to prevent BibTeX from
interpreting the quote as a
Version 2.11.4 Last change: 09 May 1998 6
User Commands BIBCLEAN(1)
string delimiter.
Quoted strings receive no spe-
cial handling from this option,
and since German nouns in titles
must anyway be protected from
the downcasing operation of most
BibTeX bibliography styles, Ger-
man value strings that use the
overloaded quote character can
always be entered in the form
"{...}", without the need to
specify this option at all.
Default: no.
-[no-]keep-linebreaks Normally, line breaks inside
value strings are collapsed into
a single space, so that long
value strings can later be bro-
ken to provide lines of reason-
able length.
With the positive form, line-
breaks are preserved in value
strings. If -max-width is set
to zero, this preserves the ori-
ginal line breaks. Spacing out-
side value strings remains under
bibclean's control, and is not
affected by this option.
Default: no.
-[no-]keep-parbreaks With the positive form, preserve
paragraph breaks (either
formfeeds, or lines containing
only spaces) in value strings.
Normally, paragraph breaks are
collapsed into a single space.
Spacing outside value strings
remains under bibclean's con-
trol, and is not affected by
this option. Default: no.
-[no-]keep-preamble-spaces With the positive form, preserve
all whitespace in @Preamble{...}
entries. Default: no.
-[no-]keep-spaces With the positive form, preserve
all spaces in value strings.
Normally, multiple spaces are
Version 2.11.4 Last change: 09 May 1998 7
User Commands BIBCLEAN(1)
collapsed into a single space.
This option can be used together
with -keep-linebreaks, -keep-
parbreaks, and -max-width 0 to
preserve the form of value
strings while still providing
syntax and value checking.
Spacing outside value strings
remains under bibclean's con-
trol, and is not affected by
this option. Default: no.
-[no-]keep-string-spaces With the positive form, preserve
all whitespace in @String{...}
entries. Default: no.
-[no-]parbreaks With the negative form, a para-
graph break (either a formfeed,
or a line containing only
spaces) is not permitted in
value strings, or between
field/value pairs. This may be
useful to quickly trap runaway
strings arising from mismatched
delimiters. Default: yes.
-[no-]prettyprint Normally, bibclean functions as
a prettyprinter. However, with
the negative form of this
option, it acts as a lexical
analyzer instead, producing a
stream of lexical tokens. See
the LEXICAL ANALYSIS manual sec-
tion for further details.
Default: yes.
-[no-]print-patterns With the positive form, print
the value patterns read from
initialization files as they are
added to internal tables. Use
this option to check newly-added
patterns, or to see what pat-
terns are being used.
When bibclean is compiled with
native pattern-matching code
(the default), these patterns
are the ones that will be used
in checking value strings for
valid syntax, and all of them
are specified in initialization
files, rather than hard-coded
Version 2.11.4 Last change: 09 May 1998 8
User Commands BIBCLEAN(1)
into the program. For further
details, see the INITIALIZATION
FILES manual section. Default:
no.
-[no-]read-init-files With the negative form, suppress
loading of system-, user-, and
file-specific initialization
files. Initializations will
come only from those files
explicitly given by -init-file
filename options. Default: yes.
-[no-]remove-OPT-prefixes With the positive form, remove
the ``OPT'' prefix from each
field name where the correspond-
ing value is not an empty
string. The prefix ``OPT'' must
be entirely in upper-case to be
recognized.
This option is for bibliogra-
phies generated with the help of
the GNU Emacs BibTeX editing
support, which generates tem-
plates with optional fields
identified by the ``OPT'' pre-
fix. Although the function M-x
bibtex-remove-OPT normally bound
to the keystrokes C-c C-o does
the job, users often forget,
with the result that BibTeX does
not recognize the field name,
and ignores the value string.
Compare this option with -[no-
]delete-empty-values described
above. Default: no.
-[no-]scribe With the positive form, accept
input syntax conforming to the
Scribe document system. The
output will be converted to con-
form to BibTeX syntax. See the
SCRIBE BIBLIOGRAPHY FORMAT
manual section for further
details. Default: no.
-[no-]trace-file-opening With the positive form, record
in the error log file the names
of all files which bibclean
attempts to open. Use this
option to identify where
Version 2.11.4 Last change: 09 May 1998 9
User Commands BIBCLEAN(1)
initialization files are
located. Default: no.
-[no-]warnings With the positive form, allow
all warning messages. The nega-
tive form is not recommended
since it may mask problems that
should be repaired. Default:
yes.
-version Display the program version
number on stderr, and then exit
with a success return code.
This will also include an indi-
cation of who compiled the pro-
gram, the host name on which it
was compiled, the time of compi-
lation, and the type of string-
value matching code selected,
when that information is avail-
able to the compiler.
ERROR RECOVERY AND WARNINGS
When bibclean detects an error, it issues an error message
to both stderr and stdout. That way, the user is clearly
notified, and the output bibliography also contains the mes-
sage at the point of error.
Error messages begin with a distinctive pair of queries, ??,
beginning in column 1, followed by the input file name and
line number. If the -file-position option was specified,
they also contain the input and output positions of the
current file, entry, and value. Each position includes the
file byte number, the line number, and the column number.
In the event of a runaway string argument, the entry and
value positions should precisely pinpoint the erroneous
bibliography entry, and the file positions will indicate
where it was detected, which may be rather later in the
files.
Warning messages identify possible problems, and are there-
fore sent only to stderr, and not to stdout, so they never
appear in the output file. They are identified by a dis-
tinctive pair of percents, %%, beginning in column 1, and as
with error messages, may be followed by file position mes-
sages if the -file-position option was specified.
For convenience, the first line of each error and warning
message sent to stderr is formatted according to the expec-
tations of the GNU Emacs next-error command. You can invoke
bibclean with the Emacs M-x compile<RET>bibclean
filename.bib >filename.new command, then use the next-error
Version 2.11.4 Last change: 09 May 1998 10
User Commands BIBCLEAN(1)
command, normally bound to C-x ` (that's a grave, or back,
accent), to move to the location of the error in the input
file.
If error messages are ignored, and left in the output
bibliography file, they will precipitate an error when the
bibliography is next processed with BibTeX.
After issuing an error message, bibclean then resynchronizes
its input by copying it verbatim to stdout until a new
bibliography entry is recognized on a line in which the
first non-blank character is an at-sign (@). This ensures
that nothing is lost from the input file(s), allowing
corrections to be made in either the input or the output
files. However, if bibclean detects an internal error in
its data structures, it will terminate abruptly without
further input or output processing; this kind of error
should never happen, and if it does, it should be reported
immediately to the author of the program. Errors in ini-
tialization files, and running out of dynamic memory, will
also immediately terminate bibclean.
INITIALIZATION FILES
bibclean can be compiled with one of three different types
of pattern matching; the choice is made by the installer at
compile time:
o The original version uses explicit hand-coded tests
of value-string syntax.
o The second version uses regular-expression pattern-
matching host library routines together with
regular-expression patterns that come entirely from
initialization files.
o The third version uses special patterns that come
entirely from initialization files.
The second and third versions are the ones of most interest
here, because they allow the user to control what values are
considered acceptable. However, command-line options can
also be specified in initialization files, no matter which
pattern matching choice was selected.
When bibclean starts, it searches for initialization files,
finding the first one in the system executable program
search path (on UNIX and IBM PC DOS, PATH) and the first one
in the BIBINPUTS search path, and processes them in turn.
Then, when command-line arguments are processed, any addi-
tional files specified by -init-filefilename options are
also processed. Finally, immediately before each named
bibliography file is processed, an attempt is made to
Version 2.11.4 Last change: 09 May 1998 11
User Commands BIBCLEAN(1)
process an initialization file with the same name, but with
the extension changed to .ini. The default extension can be
changed by a setting of the environment variable BIB-
CLEANEXT. This scheme permits system-wide, user-wide,
session-wide, and file-specific initialization files to be
supported.
When input is taken from stdin, there is no file-specific
initialization.
For precise control, the -no-read-init-files option
suppresses all initialization files except those explicitly
named by -init-filefilename options, either on the command
line, or in requested initialization files.
Recursive execution of initialization files with nested
-init-file options is permitted; if the recursion is circu-
lar, bibclean will finally get a non-fatal initialization
file open failure after opening too many files. This ter-
minates further initialization file processing. As the
recursion unwinds, the files are all closed, then execution
proceeds normally.
An initialization file may contain empty lines, comments
from percent to end of line (just like TeX), option
switches, and field/pattern or field/pattern/message assign-
ments. Leading and trailing spaces are ignored. This is
best illustrated by a short example:
% This is a small bibclean initialization file
-init-file /u/math/bib/.bibcleanrc %% departmental patterns
chapter = "\"D\"" %% 23
pages = "\"D--D\"" %% 23--27
volume = "\"D \\an\\d D\"" %% 11 and 12
year = \
"\"dddd, dddd, dddd\"" \
"Multiple years specified." %% 1989, 1990, 1991
-no-fix-names %% do not modify author/editor lists
Long logical lines can be split into multiple physical lines
by breaking at a backslash-newline pair; the backslash-
newline pair is discarded. This processing happens while
characters are being read, before any further interpretation
of the input stream.
Version 2.11.4 Last change: 09 May 1998 12
User Commands BIBCLEAN(1)
Each logical line must contain a complete option (and its
value, if any), or a complete field/pattern pair, or a
field/pattern/message triple.
Comments are stripped during the parsing of the field, pat-
tern, and message values. The comment start symbol is not
recognized inside quoted strings, so it can be freely used
in such strings.
Comments on logical lines that were input as multiple physi-
cal lines via the backslash-newline convention must appear
on the last physical line; otherwise, the remaining physical
lines will become part of the comment.
Pattern strings must be enclosed in quotation marks; within
such strings, a backslash starts an escape mechanism that is
commonly used in UNIX software. The recognized escape
sequences are:
\a alarm bell (octal 007)
\b backspace (octal 010)
\f formfeed (octal 014)
\n newline (octal 012)
\r carriage return (octal 015)
\t horizontal tab (octal 011)
\v vertical tab (octal 013)
\ooo character number octal ooo (e.g \012 is linefeed).
Up to 3 octal digits may be used.
\0xhh
character number hexadecimal hh (e.g., \0x0a is
linefeed). xhh may be in either letter case. Any
number of hexadecimal digits may be used.
Backslash followed by any other character produces just that
character. Thus, \% gets a literal percent into a string
(preventing its interpretation as a comment), \" produces a
quotation mark, and \\ produces a single backslash.
An ASCII NUL (\0) in a string will terminate it; this is a
feature of the C programming language in which bibclean is
implemented.
Field/pattern pairs can be separated by arbitrary space, and
optionally, either an equals sign or colon functioning as an
Version 2.11.4 Last change: 09 May 1998 13
User Commands BIBCLEAN(1)
assignment operator. Thus, the following are equivalent:
pages="\"D--D\""
pages:"\"D--D\""
pages "\"D--D\""
pages = "\"D--D\""
pages : "\"D--D\""
pages "\"D--D\""
Each field name can have an arbitrary number of patterns
associated with it; however, they must be specified in
separate field/pattern assignments.
An empty pattern string causes previously-loaded patterns
for that field name to be forgotten. This feature permits
an initialization file to completely discard patterns from
earlier initialization files.
Patterns for value strings are represented in a tiny
special-purpose language that is both convenient and suit-
able for bibliography value-string syntax checking. While
not as powerful as the language of regular-expression pat-
terns, its parsing can be portably implemented in less than
3% of the code in a widely-used regular-expression parser
(the GNU regexp package).
The patterns are represented by the following special char-
acters:
<space> one or more spaces
a exactly one letter
A one or more letters
d exactly one digit
D one or more digits
r exactly one Roman numeral
R one or more Roman numerals (i.e. a Roman
number)
w exactly one word (one or more letters and
digits)
W one or more space-separated words, beginning
and ending with a word
. one `special' character, one of the characters
<space>!#()*+,-./:;?[]~, a subset of
Version 2.11.4 Last change: 09 May 1998 14
User Commands BIBCLEAN(1)
punctuation characters that are typically used
in string values
: one or more `special' characters
X one or more `special'-separated words, begin-
ning and ending with a word
\x exactly one x (x is any character), possibly
with an escape sequence interpretation given
earlier
x exactly the character x (x is anything but one
of these pattern characters:
aAdDrRwW.:<space>\)
The X pattern character is very powerful, but generally
inadvisable, since it will match almost anything likely to
be found in a BibTeX value string. The reason for providing
pattern matching on the value strings is to uncover possible
errors, not mask them.
There is no provision for specifying ranges or repetitions
of characters, but this can usually be done with separate
patterns. It is a good idea to accompany the pattern with a
comment showing the kind of thing it is expected to match.
Here is a portion of an initialization file giving a few of
the patterns used to match number value strings:
number = "\"D\"" %% 23
number = "\"A AD\"" %% PN LPS5001
number = "\"A D(D)\"" %% RJ 34(49)
number = "\"A D\"" %% XNSS 288811
number = "\"A D\\.D\"" %% Version 3.20
number = "\"A-A-D-D\"" %% UMIAC-TR-89-11
number = "\"A-A-D\"" %% CS-TR-2189
number = "\"A-A-D\\.D\"" %% CS-TR-21.7
For a bibliography that contains only article entries, this
list should probably be reduced to just the first pattern,
so that anything other than a digit string fails the
pattern-match test. This is easily done by keeping
bibliography-specific patterns in a corresponding file with
extension .ini, since that file is read automatically.
You should be sure to use empty pattern strings in this pat-
tern file to discard patterns from earlier initialization
files.
The value strings passed to the pattern matcher contain sur-
rounding quotes, so the patterns should also. However, you
could use a pattern specification like "\"D" to match an
Version 2.11.4 Last change: 09 May 1998 15
User Commands BIBCLEAN(1)
initial digit string followed by anything else; the omission
of the final quotation mark \" in the pattern allows the
match to succeed without checking that the next character in
the value string is a quotation mark.
Because the value strings are intended to be processed by
TeX, the pattern matching ignores braces, and TeX control
sequences, together with any space following those control
sequences. Spaces around braces are preserved. This con-
vention allows the pattern fragment A-AD-D to match the
value string TN-K\slash 27-70, because the value is impli-
citly collapsed to TN-K27-70 during the matching operation.
bibclean's normal action when a string value fails to match
any of the corresponding patterns is to issue a warning mes-
sage something like this: "Unexpected value in ``year =
"192"''. In most cases, that is sufficient to alert the
user to a problem. In some cases, however, it may be desir-
able to associate a different message with a particular pat-
tern. This can be done by supplying a message string fol-
lowing the pattern string. Format items %% (single per-
cent), %e (entry name), %f (field name), %k (citation key),
and %v (string value) are available to get current values
expanded in the messages. Here is an example:
chapter = "\"D:D\"" "Colon found in ``%f = %v''" %% 23:2
To be consistent with other messages output by bibclean, the
message string should not end with punctuation.
If you wish to make the message an error, rather than just a
warning, begin it with a query (?), like this:
chapter = "\"D:D\"" "?Colon found in ``%f = %v''" %% 23:2
The query will not be included in the output message.
Escape sequences are supported in message strings, just as
they are in pattern strings. You can use this to advantage
for fancy things, such as terminal display mode control. If
you rewrite the previous example as
chapter = "\"D:D\"" \
"?\033[7mColon found in ``%f = %v''\033[0m" %% 23:2
the error message will appear in inverse video on display
screens that support ANSI terminal control sequences. Such
practice is not normally recommended, since it may have
undesirable effects on some output devices. Nevertheless,
you may find it useful for restricted applications.
Version 2.11.4 Last change: 09 May 1998 16
User Commands BIBCLEAN(1)
For some types of bibliography fields, bibclean contains
special-purpose code to supplement or replace the pattern
matching:
o CODEN, ISBN and ISSN field values are handled this
way because their validation requires evaluation of
checksums that cannot be expressed by simple pat-
terns; no patterns are even used in these three
cases.
o When bibclean is compiled with pattern-matching code
support, chapter, number, pages, and volume values
are checked only by pattern matching.
o month values are first checked against the standard
BibTeX month abbreviations, and only if no match is
found are patterns then used.
o year values are first checked against patterns, then
if no match is found, the year numbers are found and
converted to integer values for testing against rea-
sonable bounds.
Values for other fields are checked only against patterns.
You can provide patterns for any field you like, even ones
bibclean does not already know about. New ones are simply
added to an internal table that is searched for each string
to be validated.
The special field, key, represents the bibliographic cita-
tion key. It can be given patterns, like any other field.
Here is an initialization file pattern assignment that will
match an author name, a colon, an alphabetic string, and a
two-digit year:
key = "A:Add" %% Knuth:TB86
Notice that no quotation marks are included in the pattern,
because the citation keys are not quoted. You can use such
patterns to help enforce uniform naming conventions for
citation keys, which is increasingly important as your
bibliography data base grows.
LEXICAL ANALYSIS
When -no-prettyprint is specified, bibclean acts as a lexi-
cal analyzer instead of a prettyprinter, producing output in
lines of the form
<token-number><tab><token-name><tab>"<token-value>"
Each output line contains a single complete token, identi-
fied by a small integer number for use by a computer
Version 2.11.4 Last change: 09 May 1998 17
User Commands BIBCLEAN(1)
program, a token type name for human readers, and a string
value in quotes.
Special characters in the token value string are represented
with ANSI/ISO Standard C escape sequences, so all characters
other than NUL are representable, and multi-line values can
be represented in a single line.
Here are the token numbers and token type names that can
appear in the output when -prettyprint is specified:
0 UNKNOWN
1 ABBREV
2 AT
3 COMMA
4 COMMENT
5 ENTRY
6 EQUALS
7 FIELD
8 INCLUDE
9 INLINE
10 KEY
11 LBRACE
12 LITERAL
13 NEWLINE
14 PREAMBLE
15 RBRACE
16 SHARP
17 SPACE
18 STRING
19 VALUE
Programs that parse such output should also be prepared for
lines beginning with the warning prefix, %%, or the error
prefix, ??, and for ANSI/ISO Standard C line number direc-
tives of the form
# line 273 "texbook1.bib"
which record the line number and file name of the current
input file.
If a -max-width nnn command-line option was specified, long
output lines will be wrapped at a backslash-newline pair,
and consequently, software that processes the lexical token
stream should be prepared to collapse such wrapped lines
back into single lines.
As an example of the use of -no-prettyprint, the UNIX com-
mand pipeline
bibclean -no-prettyprint mylib.bib | \
awk '$2 == "KEY" {print $3}' | \
sed -e 's/"//g' | \
sort
Version 2.11.4 Last change: 09 May 1998 18
User Commands BIBCLEAN(1)
will extract a sorted list of all citation keys in the file
mylib.bib.
A certain amount of processing will have been done on the
tokens. In particular, delimiters equivalent to braces will
have been replaced by braces, and braced strings will have
become quoted strings.
The LITERAL token type is used for arbitrary text that bib-
clean does not examine further, such as the contents of a
@Preamble{...} or a @Comment{...}.
The UNKNOWN token type should never appear in the output
stream. It is used internally to initialize token type
variables.
SCRIBE BIBLIOGRAPHY FORMAT
bibclean's support for the Scribe bibliography format is
based on the syntax description in the Scribe Introductory
User's Manual, 3rd Edition, May 1980. Scribe was originally
developed by Brian Reid at Carnegie-Mellon University, and
is now marketed by Unilogic, Ltd.
The BibTeX bibliography format was strongly influenced by
Scribe, and indeed, with care, it is possible to share
bibliography files between the two systems. Nevertheless,
there are some differences, so here is a summary of features
of the Scribe bibliography file format:
(1) Letter case is not significant in field names and
entry names, but case is preserved in value strings.
(2) In field/value pairs, the field and value may be
separated by one of three characters: =, /, or space.
Space may optionally surround these separators.
(3) Value delimiters are any of these seven pairs: { } [
] ( ) < > ' ' " " ` `
(4) Value delimiters may not be nested, even though with
the first four delimiter pairs, nested balanced delim-
iters would be unambiguous.
(5) Delimiters can be omitted around values that contain
only letters, digits, sharp (#), ampersand (&), period
(.), and percent (%).
(6) Outside of delimited values, a literal at-sign (@) is
represented by doubled at-signs (@@).
(7) Bibliography entries begin with @name, as for BibTeX,
but any of the seven Scribe value delimiter pairs may
Version 2.11.4 Last change: 09 May 1998 19
User Commands BIBCLEAN(1)
be used to surround the values in field/value pairs.
As in (4), nested delimiters are forbidden.
(8) Arbitrary space may separate entry names from the fol-
lowing delimiters.
(9) @Comment is a special command whose delimited value is
discarded. As in (4), nested delimiters are forbid-
den.
(10) The special form
@Begin{comment}
...
@End{comment}
permits encapsulating arbitrary text containing any
characters or delimiters, other than
``@End{comment}''. Any of the seven delimiter pairs
may be used around the word ``comment'' following the
``@Begin'' or ``@End''; the delimiters in the two
cases need not be the same, and consequently,
``@Begin{comment}''/``@End{comment}'' pairs may not be
nested.
(11) The key field is required in each bibliography entry.
(12) A backslashed quote in a string will be assumed to be
a TeX accent, and braced appropriately. While such
accents do not conform to Scribe syntax, Scribe-format
bibliographies have been found that appear to be
intended for TeX processing.
Because of this loose syntax, bibclean's normal error detec-
tion heuristics are less effective, and consequently, Scribe
mode input is not the default; it must be explicitly
requested.
ENVIRONMENT VARIABLES
BIBCLEANEXT File extension of bibliography-specific ini-
tialization files. Default: .ini.
BIBCLEANINI Name of bibclean initialization files.
Default: .bibcleanrc (UNIX), bibclean.ini
(non-UNIX).
BIBINPUTS Search path for bibclean and BibTeX input
files. On UNIX, this is a colon-separated list
of directories that are searched in order from
first to last. It is not an error for a speci-
fied directory to not exist.
Version 2.11.4 Last change: 09 May 1998 20
User Commands BIBCLEAN(1)
On other operating systems, the directory names
should be separated by whatever character is
used in system search path specifications, such
as a semicolon on IBM PC DOS.
PATH On Atari TOS, IBM PC DOS, IBM PC OS/2, Micro-
soft NT, and UNIX, search path for system exe-
cutable files. The system-wide bibclean ini-
tialization file is searched for in this path.
SYS$SYSTEM On VAX VMS, search path for system executable
files and the system-wide bibclean initializa-
tion file.
FILES
*.bib BibTeX and Scribe bibliography data base
files.
*.ini File-specific initialization files.
.bibcleanrc UNIX system-wide and user-specific initiali-
zation files.
bibclean.ini Non-UNIX system-wide and user-specific ini-
tialization files.
SEE ALSO
bibcheck(1), bibdup(1), bibextract(1), bibindex(1), bib-
join(1), biblabel(1), biblex(1), biblook(1), biborder(1),
bibparse(1), bibsort(1), bibtex(1), bibunlex(1),
citefind(1), citesub(1), citetags(1), latex(1), scribe(1),
tex(1).
AUTHOR
Nelson H. F. Beebe
Center for Scientific Computing
University of Utah
Department of Mathematics, 322 INSCC
155 S 1400 E RM 233
Salt Lake City, UT 84112-0090
USA
Tel: +1 801 581 5254
FAX: +1 801 585 1640, +1 801 581 4148
Email: beebe@math.utah.edu, beebe@acm.org, beebe@ieee.org (Internet)
URL: http://www.math.utah.edu/~beebe
Version 2.11.4 Last change: 09 May 1998 21
|
