From e4f98cbf00732a79944b0a9a7ad18d8bf2d5f154 Mon Sep 17 00:00:00 2001
From: Tyson Whitehead <twhitehead@gmail.com>
Date: Tue, 19 Aug 2025 16:30:34 -0400
Subject: [PATCH] Document OOD_SHELL_TERM

Tagged need doc in https://github.com/OSC/ondemand/pull/4504
---
 source/customizations.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/source/customizations.rst b/source/customizations.rst
index c6d093c1..960182de 100644
--- a/source/customizations.rst
+++ b/source/customizations.rst
@@ -599,6 +599,11 @@ connection alive is not factored into this.
 of activity (in milliseconds). After this duration, the connection will be closed
 regardless of activity. Its default is 3600000 milliseconds (1 hour).
 
+``OOD_SHELL_TERM`` allows the default ``TERM=xterm-16color`` to be overriden. Should only
+be set to ones whose escape codes are fully supported by the underlying
+`hterm library <https://chromium.googlesource.com/apps/libapps/+/HEAD/hterm/docs/ControlSequences.md>`__.
+Some other common ones that are include ``xterm``, ``xterm-256color``, and ``xterm-direct``.
+
 .. code:: shell
 
   # /etc/ood/config/apps/shell/env