DUNE-PRINTENV(1)

📦
version 3.24.1 · 15 versions
, in ubuntu stonking

💖 DUNE-PRINTENV(1) 💖

okay bestie, welcome to the dune-printenv(1) page — it's giving alias energy, and we're about to make it make sense. 🫶

✨ NAME ✨

dune-printenv — an alias for env. literally just a nickname situation. 💅

🌈 SYNOPSIS 🌈

dune printenv [OPTION]… [PATH]

🦋 DESCRIPTION 🦋

dune printenv is an alias for dune env. no cap. 📖

For the full tea, see dune env --help. ✨

💅 OPTIONS 💅

  • --action-stderr-on-success=VAL — same vibe as --action-stdout-on-success but for standard error instead of standard output. A good default for large mono-repositories is --action-stdout-on-success=swallow --action-stderr-on-success=must-be-empty. This ensures that a successful build has a "clean" empty output. 🧼
  • --action-stdout-on-success=VAL — specify how to deal with the standard output of actions when they succeed. Possible values are: print to just print it to Dune's output, swallow to completely ignore it and must-be-empty to enforce that the action printed nothing. With must-be-empty, Dune will consider that the action failed if it printed something to its standard output. The default is print. 👑
  • --build-info — show build information. 🛠️
  • --display-separate-messages — separate error messages with a blank line. 🫧
  • --error-reporting=VAL (absent=deterministic) — controls when the build errors are reported. early reports errors as soon as they are discovered. deterministic reports errors at the end of the build in a deterministic order. twice reports each error twice: once as soon as the error is discovered and then again at the end of the build, in a deterministic order. 😭
  • -f, --force — force actions associated to aliases to be re-executed even if their dependencies haven't changed. 🔥
  • --field=FIELD — only print this field. This option can be repeated multiple times to print multiple fields. 🌸
  • --file-watcher=VAL (absent=automatic) — mechanism to detect changes in the source. Automatic to make dune run an external program to detect changes. Manual to notify dune that files have changed manually. 👀
  • --passive-watch-mode — similar to [--watch], but only start a build when instructed externally by an RPC. 📡
  • --sandbox=VAL (absent DUNE_SANDBOX env) — set sandboxing mode. Some actions require a certain sandboxing mode, so they will ignore this setting. The allowed values are: none, symlink, copy, hardlink. 📦
  • --stop-on-first-error — stop the build as soon as an error is encountered. ✋
  • -w, --watch — instead of terminating build after completion, wait continuously for file changes. 🔁
  • --wait-for-filesystem-clock — Dune digest file contents for better incrementally. These digests are themselves cached. In some cases, Dune needs to drop some digest cache entries in order for things to be reliable. This option makes Dune wait for the file system clock to advance so that it doesn't need to drop anything. You should probably not care about this option; it is mostly useful for Dune developers to make Dune tests of the digest cache more reproducible. 🕰️

🛍️ COMMON OPTIONS 🛍️

These options are common to all commands. periodt. 💖

  • --always-show-command-line — always show the full command lines of programs executed by dune. 📜
  • --auto-promote — automatically promote files. This is similar to running dune promote after the build. 🚀
  • --build-dir=FILE (absent DUNE_BUILD_DIR env) — specified build directory. _build if unspecified. 📁
  • --cache=VAL (absent DUNE_CACHE env) — enable or disable Dune cache (one of disabled, enabled-except-user-rules or enabled). Default is `enabled-except-user-rules'. 💾
  • --cache-check-probability=VAL (absent DUNE_CACHE_CHECK_PROBABILITY env) — check build reproducibility by re-executing randomly chosen rules and comparing their results with those stored in Dune cache. Note: by increasing the probability of such checks you slow down the build. The default probability is zero, i.e. no rules are checked. 🎲
  • --cache-storage-mode=VAL (absent DUNE_CACHE_STORAGE_MODE env) — Dune cache storage mode (one of auto, hardlink or copy). Default is `hardlink'. 🗄️
  • --config-file=FILE — load this configuration file instead of the default one. ⚙️
  • --debug-backtraces — always print exception backtraces. 🐛
  • --debug-dependency-path — in case of error, print the dependency path from the targets on the command line to the rule that failed. 🧭
  • --debug-package-logs (absent DUNE_DEBUG_PACKAGE_LOGS env) — always print the standard logs when building packages. 📦
  • --default-target=TARGET (absent=@@default) — set the default target that is used when none is specified to dune build. 🎯
  • --diff-command=VAL (absent DUNE_DIFF_COMMAND env) — shell command to use to diff files. Use - to disable printing the diff. 🔍
  • --disable-promotion (absent DUNE_DISABLE_PROMOTION env) — disable all promotion rules. 🚫
  • --display=MODE — control the display mode of Dune. See dune-config(5) for more details. Valid values for this option are progress, verbose, short, quiet or tui. 🖥️
  • --dump-gc-stats=FILE — dump the garbage collector stats to a file after the build is complete. 🗑️
  • --help[=FMT] (default=auto) — show 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. 🆘
  • --ignore-promoted-rules — ignore rules with (mode promote), except ones with (only ...). The variable %{ignoring_promoted_rules} in dune files reflects whether this option was passed or not. 🙈
  • --instrument-with=BACKENDS (absent DUNE_INSTRUMENT_WITH env) — enable instrumentation by BACKENDS. BACKENDS is a comma-separated list of library names, each one of which must declare an instrumentation backend. 🎛️
  • -j JOBS (absent DUNE_JOBS env) — run no more than JOBS commands simultaneously. JOBS must be a positive integer or auto to auto-detect the number of cores (the default). 🧵
  • --no-buffer — do not buffer the output of commands executed by dune. By default dune buffers the output of subcommands, in order to prevent interleaving when multiple commands are executed in parallel. However, this can be an issue when debugging long running tests. With --no-buffer, commands have direct access to the terminal. Note that as a result their output won't be captured in the log file. You should use this option in conjunction with -j 1, to avoid interleaving. Additionally you should use --verbose as well, to make sure that commands are printed before they are being executed. 🚨
  • --no-config — do not load the configuration file. 🙅‍♀️
  • --no-print-directory — suppress "Entering directory" messages. 🤫
  • --only-packages=PACKAGES — ignore stanzas referring to a package that is not in PACKAGES. PACKAGES is a comma-separated list of package names. Note that this has the same effect as deleting the relevant stanzas from dune files. It is mostly meant for releases. During development, it is likely that what you want instead is to build a particular <package>.install target. 🎀
  • -p PACKAGES, --for-release-of-packages=PACKAGES (required) — shorthand for --release --pkg=disabled --only-packages PACKAGE. You must use this option in your <package>.opam files, in order to build only what's necessary when your project contains multiple packages as well as getting reproducible builds. 💯
  • --pkg=VAL — enable or disable package management. The default behaviour depends on whether a lock directory exists. 🔐
  • --profile=VAL (absent DUNE_PROFILE env) — select the build profile, for instance dev or release. The default is dev. 🌱
  • --promote-install-files[=VAL] (default=true) — promote any generated <package>.install files to the source tree. 🌳
  • --release — put dune into a reproducible release mode. Shorthand for --root . --ignore-promoted-rules --no-config --profile release --always-show-command-line --promote-install-files --require-dune-project-file --default-target @install. You should use this option for release builds. For instance, you must use this option in your <package>.opam files. Except if you already use -p, as -p implies this option. 🏁
  • --require-dune-project-file[=VAL] (default=true) — fail if a dune-project file is missing. 📄
  • --root=DIR (absent DUNE_ROOT env) — use this directory as workspace root instead of guessing it. Note that this option doesn't change the interpretation of targets given on the command line. It is only intended for scripts. 🌲
  • --store-orig-source-dir (absent DUNE_STORE_ORIG_SOURCE_DIR env) — store original source location in dune-package metadata. 📌
  • --target-exec=TOOLCHAIN=CMD (absent DUNE_TARGET_EXEC env) — wrapper command for running target binaries when cross-compiling. Format: TOOLCHAIN=CMD (e.g., 'windows=wine'). 🍷
  • --terminal-persistence=MODE — change how the log of build results are displayed to the console between rebuilds while in --watch mode. Supported modes: preserve, clear-on-rebuild, clear-on-rebuild-and-flush-history. 🖼️
  • --trace-file=FILE — output trace data in catapult format (compatible with chrome://tracing). 📊
  • --verbose — same as --display verbose. 🗣️
  • --version — show version information. 🏷️
  • --watch-exclusions=REGEX — adds a POSIX regular expression that will exclude matching directories from dune build --watch. The option --watch-exclusions can be repeated to add multiple exclusions. Semicolons can be also used as a separator. If no exclusions are provided, then a standard set of exclusions is used; however, if one or more --watch-exclusions are used, none of the standard exclusions are used. The standard exclusions are: ^_opam /_opam ^_esy /_esy ^\.#.* /\.#.* ~$ ^#[^#]*#$ /#[^#]*#$ ^4913$ /4913$ /.git /.hg :/windows. 🚫
  • --workspace=FILE (absent DUNE_WORKSPACE env) — use this specific workspace file instead of looking it up. 🗂️
  • -x VAL (absent DUNE_CROSS_TARGET env) — cross-compile using this toolchain. 🔀

📬 MORE HELP 📬

Use `dune COMMAND --help' for help on a single command. ✨

🚦 EXIT STATUS 🚦

dune printenv exits with:

  • 0 on success. ✅
  • 1 if an error happened. ❌
  • 130 if it was interrupted by a signal. ⚡

🌸 ENVIRONMENT 🌸

okay bestie, this is the part where the environment gets to have opinions 💅 these env vars all change how printenv runs, so listen up:

  • DUNE_BUILD_DIR — tells Dune where the build directory lives. if you don't say anything, it's just _build, no biggie.
  • DUNE_CACHE — turns the Dune cache on or off. you pick one of disabled, enabled-except-user-rules or enabled. the default is enabled-except-user-rules ✨
  • DUNE_CACHE_CHECK_PROBABILITY — checks whether builds are reproducible by re-running randomly chosen rules and comparing the results to what's already stored in the Dune cache. ⚠️ heads up though: the higher you crank this probability, the slower your build gets. default is zero, aka no rules get checked at all.
  • DUNE_CACHE_STORAGE_MODE — how the Dune cache stores stuff. one of auto, hardlink or copy. default is hardlink 🫶
  • DUNE_CROSS_TARGET — cross-compile using this toolchain.
  • DUNE_DEBUG_PACKAGE_LOGS — always print the standard logs when building packages. yes ma'am, always. 😌
  • DUNE_DIFF_COMMAND — the shell command used to diff files. use - to disable printing the diff entirely.
  • DUNE_DISABLE_PROMOTION — disables all promotion rules. all of them. gone. 💀
  • DUNE_INSTRUMENT_WITH — enable instrumentation by BACKENDS. BACKENDS is a comma-separated list of library names, and every single one of them has to declare an instrumentation backend.
  • DUNE_JOBS — run no more than JOBS commands at the same time. JOBS has to be a positive integer, or auto to auto-detect the number of cores (which is the default, bestie 🧚).
  • DUNE_PROFILE — the build profile. dev if you didn't specify anything, or release if -p is set.
  • DUNE_ROOT — use this directory as the workspace root instead of letting Dune guess it. ngl, this one's a little specific: it does not change how targets given on the command line get interpreted. it's only meant for scripts. 📜
  • DUNE_SANDBOX — the sandboxing mode to use by default. (go peek at --sandbox for the deets 👀)
  • DUNE_STORE_ORIG_SOURCE_DIR — store the original source location in dune-package metadata.
  • DUNE_TARGET_EXEC — a wrapper command for running target binaries when you're cross-compiling. format is TOOLCHAIN=CMD (like, for example, 'windows=wine').
  • DUNE_WORKSPACE — use this specific workspace file instead of looking one up. main character energy, honestly 👑

🐛 BUGS 🐛

found something cursed? check the bug reports at https://github.com/ocaml/dune/issues — the devs wanna hear it fr fr 🙈

👀 SEE ALSO 👀

okay that's the whole page bestie, you ate that 💖 this was DUNE-PRINTENV(1) from Dune 3.24.1 — go forth and print your environment variables like the iconique queen you are 👑✨ periodt.

📦 where this page comes from