From 1b5ccb12d52a3ded8f8c76606ba4315739bae8c3 Mon Sep 17 00:00:00 2001
From: ridiculousfish <corydoras@ridiculousfish.com>
Date: Fri, 19 Oct 2018 17:53:03 -0700
Subject: [PATCH] Document PATH variables

---
 doc_src/index.hdr.in | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/doc_src/index.hdr.in b/doc_src/index.hdr.in
index 75a9e0801..75ee86f85 100644
--- a/doc_src/index.hdr.in
+++ b/doc_src/index.hdr.in
@@ -861,6 +861,24 @@ env | grep smurf
 
 `fish` automatically creates arrays from all environment variables whose name ends in PATH, by splitting them on colons. Other variables are not automatically split.
 
+\subsection variables-path PATH variables
+
+Path variables are a special kind of variable used to support colon-delimited path lists including PATH, CDPATH, MANPATH, PYTHONPATH, etc. All variables that end in `PATH` (case-sensitive) become PATH variables.
+
+PATH variables act as normal arrays, except they are are implicitly joined and split on colons.
+\fish
+set MYPATH 1 2 3
+echo "$MYPATH"
+<outp># 1:2:3</outp>
+set MYPATH "$MYPATH:4:5"
+echo $MYPATH
+# 1 2 3 4 5
+echo "$MYPATH"
+<outp># 1:2:3:4:5</outp>
+\endfish
+
+Variables can be marked or unmarked as PATH variables via the `--path` and `--unpath` options to `set`.
+
 \subsection variables-special Special variables
 
 The user can change the settings of `fish` by changing the values of certain variables.