Debian Codegraph @

texmf-dist/doc/man/man1/bibtexu.1

raw
1 .TH BIBTEXU "1" "30 August 2022" "bibtexu 4.00" "User Commands"
2 .SH NAME
3 bibtexu \- UTF-8 Big BibTeX
4 .SH SYNOPSIS
5 .B bibtexu
6 [\fIoptions\fR] \fIaux-file\fR
7 .SH DESCRIPTION
8 .PP
9 .B BibTeXu
10 is the Unicode-compliant version of BibTeX.
11 It is largely based on Niel Kempson's BibTeX8, and it provides
12 a better support for UTF-8 by integrating ICU library. Therefore,
13 .B BibTeXu
14 no longer requires the Codepage and Sort order ("CS") file; instead,
15 the method of sorting and case-changing can be controlled via
16 command-line options.
17 .SH OPTIONS
18 .TP
19 \fB\-?\fR \fB\-\-help\fR
20 display some brief help text.
21 .TP
22 \fB\-d\fR \fB\-\-debug\fR TYPE
23 report debugging information. TYPE is one
24 or more of all, csf, io, mem, misc, search.
25 .TP
26 \fB\-s\fR \fB\-\-statistics\fR
27 report internal statistics.
28 .TP
29 \fB\-t\fR \fB\-\-trace\fR
30 report execution tracing.
31 .TP
32 \fB\-v\fR \fB\-\-version\fR
33 report BibTeX version.
34 .TP
35 \fB\-l\fR \fB\-\-language\fR LANG
36 use language LANG to convert strings to low case.
37 This argument is passed to ICU library.
38 .TP
39 \fB\-o\fR \fB\-\-location\fR LANG
40 use language LANG for sorting.
41 This argument is passed to ICU library.
42 .TP
43 \fB\-B\fR \fB\-\-big\fR
44 set large BibTeX capacity.
45 .TP
46 \fB\-H\fR \fB\-\-huge\fR
47 set huge BibTeX capacity.
48 .TP
49 \fB\-W\fR \fB\-\-wolfgang\fR
50 set really huge BibTeX capacity for Wolfgang.
51 .TP
52 \fB\-M\fR \fB\-\-min_crossrefs\fR ##
53 set min_crossrefs to ##.
54 .TP
55 \fB\-\-mstrings\fR ##
56 allow ## unique strings.
57 .SH UNICODE SUPPORT
58 .PP
59 .B BibTeXu
60 supports extended features to handle Unicode characters.
61 Several built-in functions in bibliography styles are enhanced as follows.
62 .TP
63 \fB&\fR
64 Pops the top two (integer) literals and pushes their bitwise AND.
65 .TP
66 \fB|\fR
67 Pops the top two (integer) literals and pushes their bitwise OR.
68 .TP
69 \fBadd.period$\fR
70 Pops the top (string) literal, adds a `.' to it if the last non`}'
71 character isn't a `.', `?', `!' or a Unicode punctuation mark and pushes this resulting string.
72 The mark may be U+203C, U+203D, U+2047, U+2048, U+2049, U+3002, U+FF01, U+FF0E or U+FF1F.
73 .TP
74 \fBchr.to.int$\fR
75 Pops the top (string) literal, makes sure it's a multibyte string of a single Unicode code point,
76 converts it to the corresponding Unicode scalar value (integer), and pushes this integer.
77 .TP
78 \fBint.to.chr$\fR
79 Pops the top (integer) literal, interpreted as the Unicode scalar value of a single code point,
80 converts it to the corresponding single character multibyte string, and pushes this string.
81 .TP
82 \fBnum.names$\fR, \fBformat.name$\fR
83 The function is the same as original BibTeX but
84 an Ideographic/Fullwidth Comma (U+3001, U+FF0C) in addition to an " and " string is
85 accepted as a separator between persons and
86 Ideographic Space (U+3000) in addition to a space " " is accepted as a separator between a family name and a given name.
87 .TP
88 \fBsubstring$\fR, \fBtext.length$\fR, \fBtext.prefix$\fR
89 The function is the same as original BibTeX but the unit of operand numbers is Unicode code point.
90 .TP
91 \fBchange.case$\fR
92 The function is the same as original BibTeX but letters of
93 non-english Latin, Greek and Cyrillic are supported.
94 .TP
95 \fBwidth$\fR
96 The function is the same as original BibTeX but letters of Latin-1 and Latin Extended-A
97 and CJK characters are supported.
98 .TP
99 \fBis.cjk.str$\fR
100 Pops the top (string) literal, set flag bits to an integer if CJK characters are found in the string,
101 and pushes the resulting integer, otherwise pushes 0.
102 Flags 0x001, 0x002, 0x004, 0x008 and 0x800 are corresponding to Hanzi (Kanji, Hanja), Kana, Hangul,
103 Bopomofo and other CJK characters, respectively.
104 For example, an integer 0x003 will be pushed if Hanzi and Kana characters are found in a poped string literal.
105 .TP
106 \fBis.kanji.str$\fR
107 Same as \fBis.cjk.str$\fR for compatibility with (u)pBibTeX.
108 .SH SEE ALSO
109 More detailed description of
110 .B BibTeXu
111 is available at $TEXMFDIST/doc/bibtexu/README.
112 .SH AUTHORS
113 .B BibTeXu
114 was written by Yannis Haralambous and his students.
115 It is maintained as part of TeX Live.
116 .PP
117 This manpage was written for TeX Live.