pybtex(1)

πŸ“¦
version 0.25.1 Β· 3 versions
, in ubuntu resolute, ubuntu stonking

✨ pybtex β€” ok bestie, let's talk bibliographies πŸ’–

So you've got a LaTeX .aux file and a dream, and you want a bibliography out of it. Hi, you've come to the right girl. This is the manual for pybtex β€” it lives in the pybtex(1) section of the manual, and it is literally a whole BibTeX-compatible bibliography processor written in Python. πŸ‘‘


πŸŽ€ NAME πŸŽ€

pybtex β€” a BibTeX-compatible bibliography processor in Python. No cap, that's the whole name section, we keep it cute and we keep it moving. πŸ’…


πŸ¦‹ SYNOPSIS πŸ¦‹

pybtex [ options ] auxfile.aux

That's it. That's the whole summoning ritual. ✨


🌸 DESCRIPTION 🌸

Ok so here's the tea. Pybtex reads citation information from a LaTeX .aux file and produces a formatted bibliography. That's the main character arc. πŸ“š

And it understands BibTeX .bib and .bst style files, which means you can use it as a drop-in replacement for BibTeX. Yes, drop-in. Just swap it in, nobody will even notice, iconic behaviour honestly. 🫢

Besides BibTeX .bib files, BibTeXML and YAML bibliography files are supported too. Options, we love options. 🌈

And the flex doesn't stop there: it is also possible to define bibliography formatting styles in Python. You can write your own styles. In Python. Your fave language. It's giving versatility. 🐍


⭐ GENERAL OPTONS ⭐

(yes, that's how it's spelled in the original, and we respect her for it πŸ’œ)

  • --version β€” show the program's version number and exit. Quick lil identity check. πŸͺͺ
  • -h, --help β€” show this help message and exit. Hi bestie, need directions? πŸ’¬
  • --strict β€” turn warnings into errors. Dramatic? Yes. But that's the point β€” a warning is now a full stop, no more "eh it's probably fine". 😭
  • --terse β€” ignored, for compatibility with BibTeX. It does nothing, it's just there so your BibTeX command line doesn't get its feelings hurt. A little decorative flag. πŸŽ€
  • --min-crossrefs=NUMBER β€” include item after NUMBER crossrefs; default 2. So the threshold is 2 unless you say otherwise. πŸ”’
  • -f FORMAT, --bibliography-format=FORMAT β€” bibliograpy format. The options are bibtex, bibtexml, yaml. (Yes, "bibliograpy" β€” typo's in the original, we're keeping the receipts. πŸ’€)
  • -b BACKEND, --output-backend=BACKEND β€” output backend. The options are html, latex, markdown, plaintext. Pick your vibe, she'll dress for the occasion. 🎨
  • -s STYLE, --style=STYLE β€” bibliography formatting style. 🎩
  • -l LANGUAGE, --style-language=LANGUAGE β€” the style definition language to use: bibtex or python. Old school or new school, your call. 🐍 vs πŸ“œ

πŸ’œ PYTHONIC STYLE OPTIONS πŸ’œ

This is the Python-flavoured corner of the menu, and honestly? It eats. πŸ”₯

  • --label-style=STYLE β€” label formatting style. Options: alpha, number. πŸ”€πŸ”’
  • --name-style=STYLE β€” name formatting style. Options: lastfirst, plain. πŸ§‘β€πŸŽ“
  • --sorting-style=STYLE β€” sorting style. Options: author_year_title, none. Order it or don't, both valid. πŸ“‘
  • --abbreviate-names β€” use the abbreviated name formatting style. Short names, quick read, slay. βœ‚οΈ

πŸ“ ENCODING OPTIONS πŸ“

Get your encodings right or cry about it later, bestie, we've all been there. 😭

  • -e ENCODING, --encoding=ENCODING β€” the default encoding. 🌐
  • --bibtex-encoding=ENCODING β€” (no description in the original, she just stands there looking mysterious πŸ™ˆ)
  • --bst-encoding=ENCODING β€” (same deal, the manpage gives her no one-liner, so I'm not gonna make one up πŸ’…)
  • --output-encoding=ENCODING β€” (also no description, but the flag is real and it is here 🫢)

🌈 SEE ALSO 🌈

Nothing here yet. Empty. Void. A blank space where the cross-references would be. It's giving "we'll finish this later" and honestly, relatable. πŸ’€βœ¨


That's the whole page, babes. And for the sign-off: this came from the Pybtex manual page β€” that's the source and the version, right there in the footer β€” dated the way the original footer is dated (which is to say, the page itself just says Pybtex and calls it a day, and we love a low-effort footer). πŸ’–

Now go format some bibliographies. Main character energy only. Periodt. πŸ‘‘πŸŽ€πŸ¦‹

πŸ“¦ where this page comes from