COQDOC(1)

📦
version 9.3.0 · 3 versions
, in alpine 3.24, arch rolling, fedora 44, nixos 26.05, nixpkgs unstable, ubuntu stonking

💖 COQDOC(1) — the coqdoc manual, but make it slay 💖

okay bestie, pull up a chair, because this is the documentation tool for the Coq proof assistant and she is iconic. it's from the General Commands Manual section of the manual pages, and by the end of this you're gonna be writing docs like a main character. 🎀

✨ NAME ✨

coqdoc — the documentation tool for the Coq proof assistant. periodt.

🌸 SYNOPSIS 🌸

coqdoc [ options ] files

🦋 DESCRIPTION 🦋

so coqdoc is a documentation tool for the Coq proof assistant, and what she does is create LaTeX or HTML documents from a set of Coq files. that's the whole vibe. 🫶

and listen — for actual documentation, the manual is like "see the Coq reference manual (url below)." so yeah, that's where the deep lore lives, url below, iykyk.

👑 OPTIONS 👑

💅 Overall options

  • -h — help. this one gives you the complete list of options accepted by coqdoc. the full menu, no gatekeeping.
  • --html — select a HTML output. ✨
  • --latex — select a LaTeX output. 🎀
  • --dvi — select a DVI output.
  • --ps — select a PostScript output.
  • --texmacs — select a TeXmacs output.
  • --stdout — redirect the output to stdout. straight to your terminal, no files, no drama.
  • -o file, --output file — redirect the output into the file file.
  • -d dir, --directory dir — output files into directory dir instead of the current directory. ⚠️ heads up: option -d does not change the filename specified with option -o, if any.
  • -s, --short — do not insert titles for the files. the default behavior is to insert a title like Library Foo for each file, so this is the "no name tags at the party" option.
  • -t string, --title string — set the document title.
  • --body-only — suppress the header and trailer of the final document. so you can insert the resulting document into a larger one, like a little sticker in a scrapbook. 🌈
  • -p string, --preamble string — insert some material in the LaTeX preamble, right before \begin{document} (meaningless with -html). 💀 yeah, meaningless with -html, don't try it.
  • --vernac-file file, --tex-file file — considers the file file respectively as a .v (or .g) file or a .tex file.
  • --files-from file — read file names to process in file file as if they were given on the command line. useful for program sources split in several directories. 🗂️
  • -q, --quiet — be quiet. do not print anything except errors. the "don't text me unless it's an emergency" setting.
  • -h, --help — give a short summary of the options and exit.
  • -v, --version — print the version and exit.

🔥 Index options

default behavior is to build an index, for the HTML output only, into index.html.

  • --no-index — do not output the index. bye bestie 👋
  • --multi-index — generate one page for each category and each letter in the index, together with a top page index.html.

🎀 Table of contents option

  • -toc, --table-of-contents — insert a table of contents. for a LaTeX output, it inserts a \tableofcontents at the beginning of the document. for a HTML output, it builds a table of contents into toc.html. ✨
  • --glob-from file — make references using Coq globalizations from file file. (such globalizations are obtained with Coq option -dump-glob.)
  • --no-externals — do not insert links to the Coq standard library.
  • --external url libroot — set base URL for the external library whose root prefix is libroot.
  • --coqlib_url url — set base URL for the Coq standard library (default is http://coq.inria.fr/library/).
  • --coqlib dir — set the base path where the Coq files are installed, especially style files coqdoc.sty and coqdoc.css. 🎨
  • -R dir coqdir — map physical directory dir to Coq logical directory coqdir (similarly to Coq option -R). 📌 note: option -R only has effect on the files following it on the command line, so you will probably need to put this option first.

⭐ Contents options

  • -g, --gallina — do not print proofs.
  • -l, --light — light mode. suppress proofs (as with -g) and the following commands:
    • [Recursive] Tactic Definition
    • Hint / Hints
    • Require
    • Transparent / Opaque
    • Implicit Argument / Implicits
    • Section / Variable / Hypothesis / End

the behavior of options -g and -l can be locally overridden using the (* begin show *) ... (* end show *) environment (see above). 💖

🌈 Language options

default behavior is to assume ASCII 7 bits input files.

  • -latin1, --latin1 — select ISO-8859-1 input files. it is equivalent to --inputenc latin1 --charset iso-8859-1.
  • -utf8, --utf8 — select UTF-8 (Unicode) input files. it is equivalent to --inputenc utf8 --charset utf-8. LaTeX UTF-8 support can be found at http://www.ctan.org/tex-archive/macros/latex/contrib/supported/unicode/. 🌍
  • --inputenc string — give a LaTeX input encoding, as an option to LaTeX package inputenc.
  • --charset string — specify the HTML character set, to be inserted in the HTML header.

💜 SEE ALSO 💜

and that's the whole page, bestie — no cap. this manual page came to you from the General Commands Manual family, it's the COQDOC(1) page, and if you ever forget it, just know it lives at the very bottom of itself with the same name it started with. slay. 💅✨🦋🌸

ok that's literally it, go document something gorgeous 🎀
📦 where this page comes from