CONVERTGLS2BIB(1)

📦
version 76845 · 5 versions
, in fedora 44

💖 CONVERTGLS2BIB(1) 💖

okay bestie, pull up a chair, because we're talking about convertgls2bib — a lil command-line icon that ships with bib2gls and honestly? she's the moment. 💅

✨ SYNOPSIS ✨

convertgls2bib [option]+ texfile bibfile

🌸 DESCRIPTION 🌸

So here's the tea: convertgls2bib takes a .tex file that's got glossary definitions in it — you know, the ones written with commands like \newglossaryentry and \newacronym — and turns it into a .bib file in the format that bib2gls needs. That's it. That's the whole job. And she comes distributed with bib2gls, so if you already have that, you already have her. 🎀

🦋 OPTIONS 🦋

🌈 GENERAL OPTIONS 🌈

  • --help, -h — shows you the help message and then dips. bye! 👋
  • --version, -v — shows off her version info and exits.
  • --silent, --quiet, -q — mutes everything except errors. she's giving "I'm not reading all that" energy. 💀
  • --verbose — turns verbose mode ON.
  • --no-verbose — turns verbose mode OFF.
  • --debug [n] — spills the debugging messages.
  • --debug-mode setting — same vibe as --debug, but you use it when the level number is hard to remember. The value is the same as for bib2gls's --debug-mode option.
  • --no-debug — switches debugging mode off. Equivalent to --debug 0. periodt.
  • --log-file filename — logs messages to the file you name. Mainly intended for debugging messages, so turning debug mode on will automatically create a transcript file — but otherwise, no file gets created unless you actually use this option. no option, no file, that's the rule. 🫶

🔤 ENCOSING AND LOCALISATION OPTIONS 🔤

bestie, yes, "ENCOSING" — that's literally how the original spells it and we are NOT fixing her, she's perfect. 😭
  • --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 for the given language tag lang tag. And if there's no matching file? She falls back to the en (English) one. no cap. ✨

🎀 FILTERING OPTIONS 🎀

  • --preamble-only, -p — only parses the document preamble, meaning she stops parsing the second she hits \begin{document}.
  • --no-preamble-only — parses the ENTIRE document (this is the default).
  • --ignore-fields list, -f list — ignores every field in the comma-separated list. If the list includes sort, type or category, she automatically implements the matching --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. (she stacks, she doesn't replace 💅)

  • --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 — does NOT overwrite existing .bib files. Default if --split-on-type is used.
  • --split-on-type, -t — splits the entries into separate files according to the type field. This option automatically implements --ignore-type and --no-overwrite. she does a lil extra, she's helpful like that 🧚
  • --no-split-on-type — doesn't split entries into separate files by the type field (default).
  • --split-on-category, -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 entries into separate files by 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, -i — any entries that would normally get converted to @entry but that don't have a description, or that have a description set to just \nopostdesc or \glsxtrnopostpunc, will be converted to @index instead, and the description field gets omitted.
  • --no-index-conversion — doesn't use @index instead of @entry when the description is empty or is just \nopostdesc or \glsxtrnopostpunc (default).
  • --space-sub value, -s value — substitutes spaces in labels with value.
  • --field-map mappings, -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.
heads up bestie: the deprecated --key-map is a synonym of --field-map.
  • --no-field-map — cancels ALL the mappings you applied with --field-map.
and 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. (Like, for example, desc is the internal field label of the description key.) This option is cumulative.

You only need this option if the internal field label is supplied in the argument of a command such as \glssetnoexpandfield.

👑 REQUIRES 👑

  • Java 8
  • a TeX distribution

like, both of them. she's not picky, but she does need both. 🫶

📜 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. 🫡 (that's the dramatic part — no warranty, bestie, not even a lil one)

okay so if you wanna go deeper (and you should, she's fascinating), hit up these:

The bib2gls manual:

texdoc bib2gls

The glossaries-extra manual:

texdoc glossaries-extra

The glossaries manual:

texdoc glossaries

go read, bestie, it's giving study session and honestly I'm obsessed. ✨

🎀 AUTHOR 🎀

Nicola L. C. Talbot, <https://www.dickimaw-books.com/> — actual legend, we stan. 👑

and that's the whole page!! 💖 she's running on perl v5.40.0 and dated 2024-12-08 — so yeah, this was convertgls2bib(1), thanks for coming to my ted talk, ily, go convert some glossaries. 🦋✨💅

📦 where this page comes from