OCP-BROWSER(1)

📦 version 1.4.1, in nixos 26.05, nixpkgs unstable

🦋 OCP-BROWSER(1) 🦋

okay bestie, welcome to ocp-browser, from the Ocp-browser Manual (yes that's the manual's actual name, we love a self-titled moment 💅). This is the page where you learn the whole vibe. Strap in. 🎀

✨ NAME ✨

ocp-browser — interactively completes and prints documentation. That's it, that's the whole job. It completes stuff, it prints docs, it does it interactively. Slay. 👑

✨ SYNOPSIS ✨

ocp-browser [OPTION]…

literally just the command and then a bunch of options, no positional args to worry about, breathe 🫶

✨ DESCRIPTION ✨

So here's the entire description the page gives us:

See alt+h for help.

no cap, that's the whole thing 😭 so like — press alt+h once you're inside and it'll explain itself to you. iykyk, the tool explains the tool. iconic honestly.

✨ OPTIONS ✨

okay here's the full menu, every single one, no gatekeeping 💖

  • --build=DIR — sets the current project build dir (default: it tries to guess). it's giving "i'll figure it out myself" energy, but you can hand it the answer if you want.
  • -c WHEN, --color=WHEN — colorizes the output. WHEN is either always, never or auto. pick your aesthetic 🌈
  • --context=FILEPOS — analyses the context at the given FILE[:LINE[,COL]] so it can give you appropriate answers w.r.t. open modules, etc. and yes, you can read from stdin: specify just : for that, or alternatively FILENAME:- if you still wanna specify a filename — which gets used to detect e.g. the owning library scope. sneaky but useful 🧚
  • -F MODULES, --full-open=MODULES — like --open, but if the .cmt is available, it loads even the elements that would be restricted by the interface. useful for the current file. it's --open's unhinged main character sister 💀
  • -h LIST, --hide=LIST — kinds of elements not to show in answers; LIST is a comma-separated list of element kinds (see --show). ⚠️ careful, bestie: here -h is hide, not help. the help is alt+h. do not get got by this.
  • -I DIRS — OCaml directories to (recursively) load the libraries from. yes, recursively. it goes deep 🕳️
  • --no-build — don't include the build directory of the current project in lookups. boundaries! 🚧
  • --no-opamlib — don't include the OPAM library directory (opam var lib) in lookups.
  • --no-stdlib — don't include the OCaml standard library directory (ocamlc -where) in lookups.
  • -O MODULES, --open=MODULES — considers the given (comma-separated list of) modules as opened for lookup. yes bestie, opened, we're letting them in 🔓
  • --root=DIR — sets the current project root (default: try to guess). same guessing situation as --build, it's a whole theme.
  • -s LIST, --show=LIST — kinds of elements to show in answers; LIST is a comma-separated list of types, values and methods, exceptions, constructs (record fields and sum type constructors), modules and classes, sigs (module and class types), keywords. the default is t,v,e,c,m,s,k — screenshot that, you'll need it ✨

🌸 COMMON OPTIONS 🌸

the shared ones, every CLI has them, but ours are cute:

  • --help[=FMT] (default=auto) — shows this help in format FMT. the value FMT must be one of auto, pager, groff or plain. with auto, the format is pager or plain whenever the TERM env var is dumb or undefined.
  • --version — shows version information. little identity check 🪪

💜 EXIT STATUS 💜

ocp-browser exits with:

  1. 0 — on success. we love a clean win 🎉
  2. 123 — on indiscriminate errors reported on standard error. vague, chaotic, no further notes 💀
  3. 124 — on command line parsing errors. you typed something weird, it's judging you gently
  4. 125 — on unexpected internal errors (bugs). not you, it's them 😭

and that's the whole page, bestie — you are now officially ocp-browser literate, go forth and complete things 🌈🦋⭐

Ocp-browser 1.4.0 — that's the version, and this is the end of the OCP-BROWSER(1) manual page. mwah, bye 🫶💖

📦 where this page comes from