CONVERTGLS2BIB(1)

📦 version 2026.0, in alpine 3.24

🦋 CONVERTGLS2BIB(1) 🦋

okay bestie so this is the convertgls2bib manual page and honestly it's giving "tiny tool, huge slay" 💅 stick with me and we'll get through it together.

✨ SYNOPSIS ✨

convertgls2bib [option]+ texfile bibfile

like, one or more [option]s, then your texfile, then your bibfile. that's the whole vibe check.

💖 DESCRIPTION 💖

So what does this icon actually do? It converts a .tex file that's full of glossary definitions — you know, the ones using commands like \newglossaryentry and \newacronym — into a .bib file in the format that bib2gls needs. Glow-up for your glossary, no cap ✨

And it's distributed with bib2gls, so it ships with the family. 🫶

🎀 OPTIONS 🎀

🌸 GENERAL OPTIONS 🌸

  • --help or -h — shows you the help message and then dips out. exit stage left. 🚪
  • --version or -v — prints version info and bounces.
  • --silent or --quiet or -q — suppresses all the messages except errors. literally the "don't talk to me unless something's on fire" mode. 🔥
  • --verbose — turns verbose mode ON. chatty era.
  • --no-verbose — turns verbose mode OFF.
  • --debug [n] — shows debugging messages. [n] is optional, iykyk.
  • --debug-mode setting — use this instead of --debug when the level number is hard to remember (real). The value is the same as for bib2gls's --debug-mode option.
  • --no-debug — switches debugging mode off. Equivalent to --debug 0.
  • --log-file filename — logs messages to the given file. It's intended primarily for debugging messages, so turning on debug mode will automatically create a transcript file — but otherwise a file won't be created unless you use this option. no option, no file, periodt.

🧚 ENCOSING AND LOCALISATION OPTIONS 🧚

(yes the heading says "encosing", we're keeping it, it's iconic, don't @ me 💀)

  • --texenc name — sets the character encoding to name for the input .tex files.
  • --bibenc name — sets the character encoding to name for the output .bib files.
  • --locale lang tag — uses the language resource files associated with the given language tag lang tag. And if there isn't an appropriate file? The en (English) file gets used instead. backup plan secured. 🇬🇧

💜 FILTERING OPTIONS 💜

  • --preamble-only or -p — only parses the document preamble. So it stops parsing when \begin{document} is encountered. bye bestie 👋
  • --no-preamble-only — parses the entire document. this is the default.
  • --ignore-fields list or -f list — ignores all the fields in the comma-separated list. And listen: if the list includes sort, type or category, it will automatically implement the corresponding --ignore-sort, --ignore-type or --ignore-category option. Each item in the list should identify the field by its original case-sensitive key.
    • This option is cumulative. (stack it up, queen 👑)
  • --no-ignore-fields — cancels the effect of --ignore-fields.
  • --ignore-category — omits the category field. Default if --split-on-category.
  • --no-ignore-category — doesn't omit the category field. Default unless --split-on-category.
  • --ignore-type — omits the type field. Default if --split-on-type.
  • --no-ignore-type — doesn't omit the type field. Default unless --split-on-type.
  • --ignore-sort — ignores the sort field (default).
  • --no-ignore-sort — doesn't ignore the sort field.

🌈 OUTPUT FILE OPTIONS 🌈

  • --overwrite — overwrites existing .bib files. Default unless --split-on-type is used.
  • --no-overwrite — doesn't overwrite existing .bib files. Default if --split-on-type is used.
  • --split-on-type or -t — splits the entries into separate files according to the type field. This option automatically implements --ignore-type and --no-overwrite. two-for-one, we love efficiency 💅
  • --no-split-on-type — doesn't split the entries into separate files according to the type field (default).
  • --split-on-category or -c — splits the entries into separate files according to the category field. This option automatically implements --ignore-category and --no-overwrite.
  • --no-split-on-category — doesn't split the entries into separate files according to the category field (default).

⭐ ADJUSTMENT OPTIONS ⭐

  • --absorb-see — absorbs \glssee and \glsxtrindexseealso into the data (default).
  • --no-absorb-see — doesn't absorb \glssee and \glsxtrindexseealso into the data.
  • --index-conversion or -i — any entries that would normally be converted to @entry that don't have a description, or that just have the description set to \nopostdesc or \glsxtrnopostpunc, will be converted to @index and the description field will be omitted. 🎀
  • --no-index-conversion — doesn't use @index instead of @entry if the description is empty or just \nopostdesc or \glsxtrnopostpunc (default).
  • --space-sub value or -s value — substitutes spaces in labels with value.
  • --field-map mappings or -m mappings — adds source key to destination field label mapping. The argument should be a comma-separated list of src-field=dest-field pairs. This option is cumulative.
    • The deprecated --key-map is a synonym of --field-map.
  • --no-field-map — cancels all mappings applied with --field-map.
    • The deprecated --no-key-map is a synonym of --field-map.
  • --internal-field-map mappings — adds the given mappings to the default set of internal field to key mappings. For example, desc is the internal field label of the description key. This option is cumulative.
    • This option is only needed if the internal field label is supplied in the argument of a command such as \glssetnoexpandfield.

🍓 REQUIRES 🍓

Java 8 and a TeX distribution. both. no skipping. 🙈

💀 LICENSE 💀

License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>

This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.

(read that warranty bit again, bestie — there is NO WARRANTY, and we mean it 😭)

The bib2gls manual:

texdoc bib2gls

The glossaries-extra manual:

texdoc glossaries-extra

The glossaries manual:

texdoc glossaries

three manuals, one texdoc, go read them, they ate. 📚

🫶 AUTHOR 🫶

Nicola L. C. Talbot, <https://www.dickimaw-books.com/>

and that's the whole page, bestie — brought to you by perl v5.40.0, dated 2024-12-21. mwah 💋✨

📦 where this page comes from