Skip to content

Add table of environment variables #1248

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dpiparo merged 1 commit into from
Oct 9, 2026
Merged

Add table of environment variables #1248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions _data/navigation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ manual:
url: manual/object_ownership
- title: Multi-threading
url: manual/multi_threading
- title: Useful Parameters
url: manual/useful_parameters
- title: ROOT Manual - Functional parts
url: manual/functional_parts
children:
Expand Down
33 changes: 33 additions & 0 deletions manual/useful_parameters/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: Useful Parameters
layout: single
sidebar:
nav: "manual"
toc: true
toc_sticky: true
---

## Evnironment Variables
The behaviour of ROOT can be steered with the usage of environment variables. The table below, summarises their names, types and purpose.

| **Name** | **Type or Value** | **Description** |
|-------------------------------------------|------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| JSROOTSYS | path | Location of JSROOT. Used for notebooks integration, RWebDisplayHandle and THttpServer. |
| ROOT_BATCH | - | If defined, enable ROOT's batch mode |
| ROOT_DISABLE_TCLASS_GET_CLASS_AUTOPARSING | - | if defined, disable auto-parsing |
| ROOT_EXPERIMENTAL_EXPORT_RNTUPLE_METRICS | path | Location of RNTuple's exported metrics |
| ROOT_HIST | string | Of the form "N1:N2", N1 and N2 are integers. N1: maximum number of lines to be kept in the .roothist file; N2 (optional): once the lines saved are N1, the last N2 lines will be removed |
| ROOT_LISTENER_SOCKET | path | Location of the unix socket for remote connections |
| ROOT_MAX_THREADS | unsigned int | Cap the size of the implicit multi threading thread pool |
| ROOT_OBJECT_AUTO_REGISTRATION | bool | Set ROOT7 mode for object auto registration |
| ROOT_RNTUPLE_CLUSTERBUNCHSIZE | int | Set the number of clusters the reader should prefetch or queue up at once |
| ROOT_TTREECACHE_PREFILL | bool | Set ttree cache filling by reading all branch baskets at entry 0 |
| ROOT_WEBDISPLAY | off/batch/native/chromechromium/firefox/edge/server/qt6... | Set backend for web-graphics windows' handling. At the command line that would be specified with the switch `--web=XYZ` |
| ROOT_WEBGUI_SOCKET | url or path | Set socket, e.g. TCP or Linux, for the internal web-graphics server |
| ROOTDEBUG | 1,2,3,4 | Set verbosity level, the higher the more verbose |
| ROOTENV_NO_HOME | - | If defined, ignore .rootrc file in the home directory |
| ROOTENV_USER_PATH | path | If defined, location of .rootrc instead of the one in the home directory |
| ROOTIGNOREPREFIX | bool | If true, force ROOT to use the $ROOTSYS path instead of a hardcoded, system-wide installation prefix |
| ROOTSYS | path | Location of ROOT’s build or install directory (being abandoned) |
| ROOTUI5SYS | path | If defined, location of ui5 |

Loading