aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'doc/rst/usage.rst')
-rw-r--r--doc/rst/usage.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/rst/usage.rst b/doc/rst/usage.rst
index c341d42..15aa3c1 100644
--- a/doc/rst/usage.rst
+++ b/doc/rst/usage.rst
@@ -2337,6 +2337,11 @@ the config file. An empty string sets the policy to *deny all*.
+----------------+-------------------+-----------------------------------------+
| HOME | os.environ | |
+----------------+-------------------+-----------------------------------------+
+ | LANG | os.environ | |
+ +----------------+-------------------+-----------------------------------------+
+ | *LC_\** | os.environ | all environment variables starting |
+ | | | with LC\_ |
+ +----------------+-------------------+-----------------------------------------+
| ROVERLAY_PHASE | event | event that caused the script to run |
+----------------+-------------------+-----------------------------------------+
| HAS_CHANGES | *internal* | a shbool (``y`` or ``n``) that |
@@ -2390,6 +2395,9 @@ the config file. An empty string sets the policy to *deny all*.
| | *$ROVERLAY\ | executable (which creates the overlay) |
| | _HELPER_EXE* | |
+----------------+-------------------+-----------------------------------------+
+ | ROVERLAY\ | config | hook config file (`EVENT_HOOK_RC`_, |
+ | _HOOKRC | | optional) |
+ +----------------+-------------------+-----------------------------------------+
| STATS_DB | config | stats database file |
| | | (optional, only set if configured) |
+----------------+-------------------+-----------------------------------------+
@@ -3101,6 +3109,13 @@ EVENT_HOOK
Defaults to <libexec dir>/hooks/mux.sh if roverlay has been installed
and ADDITIONS_DIR_/hooks/mux.sh otherwise.
+.. _EVENT_HOOK_RC:
+
+EVENT_HOOK_RC
+ Config file for hook scripts (in shell script syntax).
+
+ Defaults to <not set>.
+
.. _EVENT_HOOK_RESTRICT:
EVENT_HOOK_RESTRICT
@@ -3128,6 +3143,11 @@ FILTER_SHELL_ENV
HOOK
Alias to EVENT_HOOK_.
+.. _HOOK_RC:
+
+HOOK_RC
+ Alias to EVENT_HOOK_RC_.
+
.. _HOOK_RESTRICT:
HOOK_RESTRICT