Skip to content

Commit 952d7be

Browse files
jblomerdpiparo
authored andcommitted
[NFC][core] add ROOTENV_USER_PATH to TEnv class doc
(cherry picked from commit 8aa4000)
1 parent 326b5a7 commit 952d7be

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

core/base/src/TEnv.cxx

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,15 @@ The TEnv class reads config files, by default named `.rootrc`.
1616
Three types of config files are read: global, user and local files. The
1717
global file is `$ROOTSYS/etc/system<name>` (or `ROOTETCDIR/system<name>`)
1818
the user file is `$HOME/<name>` and the local file is `./<name>`.
19+
1920
By setting the shell variable `ROOTENV_NO_HOME=1` the reading of
2021
the `$HOME/<name>` resource file will be skipped. This might be useful
2122
in case the home directory resides on an auto-mounted remote file
2223
system and one wants to avoid this file system from being mounted.
2324
25+
By setting ROOTENV_USER_PATH=<path>, the user-level configuration can
26+
be read from a custom path instead of from $HOME.
27+
2428
The format of the `.rootrc` file is similar to the `.Xdefaults` format:
2529
~~~ {.cpp}
2630
[+]<SystemName>.<RootName|ProgName>.<name>[(type)]: <value>
@@ -388,18 +392,18 @@ TString TEnvRec::ExpandValue(const char *value)
388392

389393
////////////////////////////////////////////////////////////////////////////////
390394
/// Create a resource table and read the (possibly) three resource files,
391-
/// i.e.\ `$ROOTSYS/etc/system<name>` or `ROOTETCDIR/system<name>`
395+
/// i.e.\ `$ROOTSYS/etc/system<name>` or `ROOTETCDIR/system<name>`
392396
/// (kEnvGlobal), `$HOME/<name>` or (kEnvUser), and `$PWD/<name>` (kEnvLocal).
393397
/// ROOT always reads ".rootrc" (in TROOT::InitSystem()). You can
394398
/// read additional user defined resource files by creating additional TEnv
395399
/// objects. By setting the shell variable ROOTENV_NO_HOME=1 the reading of
396400
/// the `$HOME/<name>` resource file will be skipped. This might be useful in
397401
/// case the home directory resides on an auto-mounted remote file system
398402
/// and one wants to avoid the file system from being mounted.
399-
/// In case the environment variable ROOTENV_USER_PATH is specified,
400-
/// and ROOTENV_NO_HOME is not set, then `$ROOTENV_USER_PATH/<name>`
403+
/// In case the environment variable ROOTENV_USER_PATH is specified,
404+
/// and ROOTENV_NO_HOME is not set, then `$ROOTENV_USER_PATH/<name>`
401405
/// is considered instead of `$HOME/<name>`.
402-
/// If environment variables have to be avoided, a `rootlogon.C` script
406+
/// If environment variables have to be avoided, a `rootlogon.C` script
403407
/// can be created where where the environment can be set through an
404408
/// invocation of TEnv::ReadFile.
405409

0 commit comments

Comments
 (0)