From 9e17e9cce1f070313c143fa1d507269f661e6810 Mon Sep 17 00:00:00 2001
From: "kim (grufwub)" <grufwub@gmail.com>
Date: Thu, 16 Jul 2020 17:16:00 +0100
Subject: [PATCH] add user directories to documentation

Signed-off-by: kim (grufwub) <grufwub@gmail.com>
---
 README.md     |  2 ++
 docs/USAGE.md | 22 +++++++++++++++++++++-
 2 files changed, 23 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 1d49698..50a03ea 100644
--- a/README.md
+++ b/README.md
@@ -32,6 +32,8 @@ WARNING: the (currently non-extant) development branch is filled with lava,
 
 - Request remapping with regex (see [usage](docs/USAGE.md))
 
+- User server spaces (see [usage](docs/USAGE.md))
+
 - Separate system and access logging
 
 # Further Docs
diff --git a/docs/USAGE.md b/docs/USAGE.md
index 5db4b69..4605c4f 100644
--- a/docs/USAGE.md
+++ b/docs/USAGE.md
@@ -90,4 +90,24 @@ e.g. scripts within cgi-bin to the root directory:
 `/(?P<uri>[^/]+) -> /cgi-bin/$uri`
 
 Entries are parsed, compiled, and so matched-against in order. They are matched against
-relative paths so please bear this in mind if you have user directories enabled.
\ No newline at end of file
+relative paths so please bear this in mind if you have user directories enabled.
+
+# User server spaces
+
+When user server spaces are enabled, they are accessed via the following gopher URL:
+
+`gopher://server.host:70/1/~user`
+
+Where the username supplied will then look for a user folder under:
+
+`/home/$user/$user_folder`
+
+For example:
+
+User directory = `public_gopher`
+
+`gopher://server.host:70/1/~grufwub`
+
+Will fetch from the filesystem:
+
+`/home/grufwub/public_gopher`
\ No newline at end of file