diff --git a/docs/advanced/environment-vars.qmd b/docs/advanced/environment-vars.qmd index c10262dc49..b1b8c2d0d8 100644 --- a/docs/advanced/environment-vars.qmd +++ b/docs/advanced/environment-vars.qmd @@ -15,25 +15,29 @@ quarto render You can read about other ways to set environment variables in Quarto Projects in [Environment Variables](/docs/projects/environment.qmd). -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Variable | Description | -+==============================+==================================================================================================================================================================================================+ -| `QUARTO_R` | Explicit path to the version of `Rscript` to be used by the `knitr` engine and `quarto run *.R` command. | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| `QUARTO_PYTHON` | Explicit path to the version of `python` to be used by the `jupyter` engine and `quarto run *.py` command. | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| `QUARTO_JULIA` | Explicit path to the version of `julia` to be used by the `julia` engine. | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| `QUARTO_VERSION_REQUIREMENT` | A [`semver`](https://semver.org/) string describing the Quarto version requested by the environment. If this check fails, Quarto will not run. | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| `QUARTO_KNITR_RSCRIPT_ARGS` | Comma separated list of command line argument to pass to `Rscript` started by Quarto when rendering with `knitr` engine, e.g. | -| | | -| | ``` | -| | QUARTO_KNITR_RSCRIPT_ARGS="--no-init-file,--max-connections=258" | -| | ``` | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| `QUARTO_TEXLIVE_BINPATH` | Explicit path to the TeX Live binaries to be passed to `tlmgr option sys_bin` used when setting `tlmgr` and related to `PATH` using `tlmgr add path` . By default, Quarto looks in known places. | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Variable | Description | ++=================================+=============================================================================================================================================================================================================================================================================================================================================================================================================================================================+ +| `QUARTO_R` | Explicit path to the version of `Rscript` to be used by the `knitr` engine and `quarto run *.R` command. | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| `QUARTO_PYTHON` | Explicit path to the version of `python` to be used by the `jupyter` engine and `quarto run *.py` command. | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| `QUARTO_JULIA` | Explicit path to the version of `julia` to be used by the `julia` engine. | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| `QUARTO_VERSION_REQUIREMENT` | A [`semver`](https://semver.org/) string describing the Quarto version requested by the environment. If this check fails, Quarto will not run. | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| `QUARTO_KNITR_RSCRIPT_ARGS` | Comma separated list of command line argument to pass to `Rscript` started by Quarto when rendering with `knitr` engine, e.g. | +| | | +| | ``` | +| | QUARTO_KNITR_RSCRIPT_ARGS="--no-init-file,--max-connections=258" | +| | ``` | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| `QUARTO_TEXLIVE_BINPATH` | Explicit path to the TeX Live binaries to be passed to `tlmgr option sys_bin` used when setting `tlmgr` and related to `PATH` using `tlmgr add path` . By default, Quarto looks in known places. | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| `QUARTO_CHROMIUM` | Explicit path to binary to use for chrome headless. Quarto uses [Chrome Devtools Protocol](https://chromedevtools.github.io/devtools-protocol/) to do screenshot of HTML diagrams for PDF insertion. The binary must be compatible with this protocol. (e.g. Chrome, Chromium, Chrome Headless Shell, Edge, ...) | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| `QUARTO_CHROMIUM_HEADLESS_MODE` | Used for adaption of the `--headless` mode used with `QUARTO_CHROMIUM` binary. Set to `"none"` for `--headless` , or to `"old"` or `"new"` to pass as argument, e.g. `--headless=` . Quarto 1.6 sets `"old"` as default, which works from Chrome 112 to 131. Starting Quarto 1.7.13, `"none"` is the default as [Chrome 132 removed old headless mode](https://developer.chrome.com/blog/removing-headless-old-from-chrome). | ++---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ## Variables Quarto sets @@ -60,17 +64,16 @@ ENV["QUARTO_DOCUMENT_PATH"] ``` ::: -+--------------------------------------------+----------------------------------------------------------------------------------------------------------+ -| Variable | Description | -+============================================+==========================================================================================================+ -| `QUARTO_PROJECT_ROOT` | Root of the project, or the directory of the file if not in project mode | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------+ -| `QUARTO_DOCUMENT_PATH` | Directory of the document being rendered | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------+ -| `QUARTO_PROFILE` | Profile used, e.g `QUARTO_PROFILE=advanced,production` for `quarto render --profile advanced,production` | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------+ -| `QUARTO_FIG_WIDTH` and `QUARTO_FIG_HEIGHT` | Values for `fig-width` and `fig-height` as set in the document metadata | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------+ -| `QUARTO_RUN_NO_NETWORK` | When `true`, Quarto project scripts written in TypeScript won't be allowed to use the network to | -| | download sources. In this setting, those scripts will not have access to the standard library. | -+--------------------------------------------+----------------------------------------------------------------------------------------------------------+ ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Variable | Description | ++============================================+=================================================================================================================================================================================================+ +| `QUARTO_PROJECT_ROOT` | Root of the project, or the directory of the file if not in project mode | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| `QUARTO_DOCUMENT_PATH` | Directory of the document being rendered | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| `QUARTO_PROFILE` | Profile used, e.g `QUARTO_PROFILE=advanced,production` for `quarto render --profile advanced,production` | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| `QUARTO_FIG_WIDTH` and `QUARTO_FIG_HEIGHT` | Values for `fig-width` and `fig-height` as set in the document metadata | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| `QUARTO_RUN_NO_NETWORK` | When `true`, Quarto project scripts written in TypeScript won't be allowed to use the network to download sources. In this setting, those scripts will not have access to the standard library. | ++--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ \ No newline at end of file