CHKLREF(1)

πŸ’– chklref β€” bestie edition πŸ’–

okay so this is the manual page for chklref version 3.1.2, and honestly? it's giving "tiny script, huge service". it lives in the User Commands section of your manual, and it's here to save you from yourself. let's get into it 🫢


✨ NAME ✨

chklref β€” manual page for chklref 3.1.2


🌸 SYNOPSIS 🌸

chklref [options] texfile

πŸ¦‹ DESCRIPTION πŸ¦‹

bestie. it checks for unused labels and bibitems in a LaTeX file. that's it, that's the whole vibe. no more ghost \labels haunting your document, no more bibitems sitting in your .bib file collecting dust while never getting cited. iconic behavior, honestly πŸ’…


πŸŽ€ OPTIONS πŸŽ€

  • --tex <compiler>, -t β€” tell it which TeX compiler to use, babe. the default is pdflatex.
  • --tex-options β€” the list of options you want passed to the TeX compiler. it needs to be a quoted string of white-space-delimited options, so wrap it in quotes or it'll get messy. heads up: chklref always adds -interaction nonstopmode on top of whatever you give it, so that one's non-negotiable, no cap.
  • --debug, -d β€” run in debug mode. it will not clean the generated .chk file, so you can go snoop on it.
  • --quiet, -q β€” run in quiet mode. it will not print the output of the TeX compiler. peace and quiet, finally πŸ™ˆ
  • --parse-only β€” do not run the LaTeX compiler at all; just use the .chk file that already exists. and lowkey important: when you pass this option, these other options become meaningless: --tex, --tex-options, --quiet, --debug. like, they're still there, they just do nothing. it's giving decorative.
  • --version, -v β€” print the version of this script.
  • --help,h β€” print this help.

πŸ’œ AUTHOR πŸ’œ

written by Jerome Lelong <jerome.lelong@gmail.com> ✨


🌈 REPORTING BUGS 🌈

report bugs to https://github.com/jlelong/chklref.

⚠️ real talk: chklref is known not to work with cleveref. that's a documented thing, not a skill issue on your part.

and if you wanna contribute to chklref, feel free to open a PR on https://github.com/jlelong/chklref. go off, king πŸ‘‘


copyright 2005-2019 Jerome Lelong <jerome.lelong@gmail.com>.

this program comes with ABSOLUTELY NO WARRANTY. like, none. zero. nada.

this is free software, and you are welcome to redistribute it under GPLv3. slay πŸ’…


⭐ SEE ALSO ⭐

the full documentation for chklref is maintained as a Texinfo manual. if the info and chklref programs are properly installed at your site, the command

info chklref

should give you access to the complete manual. iykyk 🧚


and that's the whole page, bestie!! this was chklref version 3.1.2, from November 2019, living its best life in the User Commands section of the manual. go check those unused labels, you've got this πŸ’–βœ¨πŸŽ€