RUBBER-INFO(1)

πŸ“¦
version 1.6.7 Β· 3 versions
, in arch rolling, debian trixie, opensuse-leap 16.0, ubuntu questing, ubuntu resolute, ubuntu stonking

✨ NAME ✨

rubber-info β€” the lil bestie that extracts information from LaTeX documents πŸ’…


🌸 SYNOPSIS 🌸

rubber-info [options] [action] source

πŸ¦‹ DESCRIPTION πŸ¦‹

Okay so rubber-info is a utility that pulls all kinds of information out of a LaTeX document. It's giving detective energy πŸ”. You can grab info straight from the source (like when it's calculating dependencies, iykyk) or from the compilation log files (which is where you dig out the errors and warnings).

Think of it as the little sibling / complement to the compilation system rubber(1). They're a package deal, fr fr 🫢

The command-line options? Those are literally the same ones rubber(1) uses, plus one of the actions listed below. That's the whole vibe.


πŸ‘‘ ACTIONS πŸ‘‘

You must specify one of these command-line options, because that's how the program knows which info you actually want. No action = no clue, bestie 😭

Heads up though: for any action that reads a log file, you gotta have done a compilation beforehand. The log doesn't manifest itself out of thin air, no cap.

And if you specify none of these actions at all? Then --check is assumed. It's the default main character ✨

  • --boxes β€” digs through the log file and pulls out the places in the source where bad boxes showed up (yes, the famous overfull and underfull \hbox and \vbox β€” iconic behavior honestly πŸ’€)
  • --check β€” reports errors if there are any; otherwise reports undefined references if there are any; otherwise lists warnings and bad boxes. This is the default action, so if you're indecisive, it's got you πŸŽ€
  • --deps β€” analyses the source files and spits out a space-separated list of every file the document depends on and that Rubber cannot rebuild.
  • --errors β€” extracts from the log file the list of errors that happened during the last compilation. The receipts πŸ“‹
  • -h, --help β€” displays the list of all available options and exits nicely. So polite. So demure. 🫢
  • --refs β€” reports the list of undefined or multiply defined references (aka the \ref's that are not defined by one \label). Broken links, exposed πŸ”₯
  • --rules β€” analyses the source files and produces a list of dependency rules. One rule gets made for each intermediate target that would be made when running rubber. The rules are formatted in the style of Makefiles, so yes it ate πŸ’…
  • --version β€” prints the version number and exits nicely. Same energy as --help, equally well-mannered ✨
  • --warnings β€” "stupidly" enumerates all LaTeX warnings, i.e. all the lines in the log file that contain the string "Warning". It's not subtle, it's not smart, it just goes 😭

πŸ’€ BUGS πŸ’€

There are surely a some... πŸ‘€ (we don't talk about it)

This page documents Rubber version 1.6.7. The program and this man-page are maintained by Florian Schmaus <flo@geekplace.eu>. The homepage for Rubber can be found at https://gitlab.com/latex-rubber/rubber. Go say hi 🌈


πŸŽ€ SEE ALSO πŸŽ€

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

info rubber

should give you access to the complete manual. That's your backstage pass, bestie 🎟️


And that's the whole page, periodt πŸ’– β€” this was RUBBER-INFO(1), documenting Rubber version 1.6.7, maintained with love by Florian Schmaus. Go read the Texinfo manual next, mwah 🫢✨