From 8bd66592a1ea3ce13b79f68c1637df8166c9de7c Mon Sep 17 00:00:00 2001
From: Eric Wasylishen <ewasylishen@gmail.com>
Date: Sat, 15 Apr 2023 17:45:35 -0600
Subject: [PATCH] docs: document -aliasdef

---
 docs/qbsp.rst | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)

diff --git a/docs/qbsp.rst b/docs/qbsp.rst
index c69173a1..b149992e 100644
--- a/docs/qbsp.rst
+++ b/docs/qbsp.rst
@@ -197,6 +197,55 @@ Options
    Set number of threads to use. By default, qbsp will attempt to
    use all available hardware threads.
 
+.. option:: -aliasdef <aliases.def> [...]
+
+   Adds alias definition files, which can transform entities in the .map into other entities.
+
+   For example, given this alias definition file:
+
+   .. code-block:: none
+      :caption: aliases.def
+
+      misc_torch1 // source classname
+      {
+      "classname" "misc_model" // classname to transform into
+      "model" "torch1.mdl"
+      }
+
+      misc_torch2
+      {
+      "classname" "misc_model"
+      "model" "torch2.mdl"
+      }
+
+   and an input map file:
+
+   .. code-block:: none
+
+      {
+      "classname" "misc_torch1"
+      "model" "override.mdl"
+      }
+
+      {
+      "classname" "misc_torch2"
+      }
+
+   the following will be output in the .bsp's entity lump:
+
+   .. code-block:: none
+
+      {
+      "classname" "misc_model"
+      "model" "override.mdl" // key/value from map takes precedence
+      }
+
+      {
+      "classname" "misc_model"
+      "model" "torch2.mdl" // key/value from alias file
+      }
+
+
 Game Path Specification
 -----------------------