MAKEGLOSSARIES(1)

📦
version 78288 · 7 versions
, in fedora 44

💖 MAKEGLOSSARIES 💖

okay so this is the makeglossaries page from section 1 of the manual, it's a Perl script, and bestie, if you're writing LaTeX with the glossaries package, this little icon is literally your new bestie. no cap. 🎀

✨ NAME ✨

makeglossaries — calls makeindex/xindy for LaTeX documents using the glossaries package 🦋

🌸 SYNOPSIS 🌸

makeglossaries [-o file] [-q] [-Q] [-k] [-n] [-s file] [-t file] [-L
language] [-c] [-g] [-l] [-p num] [-r] [-d aux dir] [-m file] [-x file]
[-e] [--version] [--help] filename

💅 DESCRIPTION 💅

so makeglossaries is designed for use with LaTeX documents that use the glossaries package. that's the whole vibe. 👑

the mandatory argument filename should be the name of the aux file. the .aux extension may be omitted, but bestie, it's best included where the filename includes additional dots in its name — that way there's no ambiguity. literally just do it. 🌟

alternatively, filename may be the name of a specific glossary file if only one glossary should be processed (for example, when you're working on a draft document, we've all been there 🫶). in this case, the aux file is still expected to exist and is inferred from the basename of filename.

makeglossaries will read the auxiliary file to determine whether makeindex or xindy should be called. all the information required to be passed to the relevant indexing application should also be contained in the auxiliary file — but it may be overridden by the option arguments to makeglossaries. so like, the aux file is the main character, but you can step in. 💁♀️

🔥 OPTIONS 🔥

  • -e — Don't attempt to repair multiple encaps or illegal page number (makeindex only). like, we're not fixing that for you, sorry bestie 😭
  • -c — Compress intermediate blanks (makeindex only). squeeze it, slay. ✨
  • -d aux dir — Specify the directory the .aux, .glo etc files are located. Defaults to the parent directory of the base file filename. 🗂️
  • -g — Employ German word ordering (makeindex only).
  • -k — Don't try forking with piped redirection. (Lessens the effect of -q) 🍴
  • -l — Letter ordering.
  • -L language — This option only has an effect if xindy is called. Sets the language. See xindy documentation for further details. 🗣️
  • -m file — Specify the full path name for makeindex to file in the event that makeindex isn't on the operating system's path. lost? we'll find it. 🔍
  • -n — Print the commands that would normally be executed but don't run them. a lil preview, a lil window shopping, no commitment. 👀
  • -o file — Use file as the output file. (Only suitable for documents containing a single glossary, otherwise each glossary will be overridden.) ⚠️
  • -p num — Sets the starting page number to be num (makeindex only).
  • -q — Quiet mode. Reduces chatter to standard output. 🤫
  • -Q — Silences warning about being unable to fork. shhh, we don't need to talk about it. 🙈
  • -r
  • -s file — Use file as the style file. Note that if you use this option, you need to know whether makeindex or xindy will be called, as they have different style files. like, know your girlies. 💅
  • -t file — Use file as the transcript file.

Disable implicit page range formation (makeindex only).

  • -x file — Specify the full path name for xindy to file in the event that xindy isn't on the operating system's path. same energy as -m but for the other one. 🦋
  • --version — Prints version number and exits. ✌️
  • --help — Prints help message and exits. 🆘

🌈 REQUIRES 🌈

Perl, Getopt::Std, and makeindex or xindy (depending on glossaries package options). that's the squad, no substitutions. 👑

🎀 LICENSE 🎀

This is free software distributed under the LaTeX Project Public License. There is NO WARRANTY. See <http://www.latex-project.org/lppl.txt> for details.

no warranty bestie, i'm just a perl script 😭 but fr, read the link.

💜 AUTHOR 💜

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

The glossaries manual:

texdoc glossaries

like, go read it, it's giving educational. 📚

and that's a wrap, bestie 🫶 this was perl v5.40.2, dated 2025-05-14, for the MAKEGLOSSARIES(1) manual page — go forth and index those glossaries, periodt. 💖✨

📦 where this page comes from