Add support for user preferences

[mudpy.git] / doc / source / configuration.rst

diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst
index bca9161..d0f8093 100644 (file)
--- a/doc/source/configuration.rst
+++ b/doc/source/configuration.rst
@@ -2,7 +2,7 @@
  configuration
 ===============
 
  configuration
 ===============
 

-.. Copyright (c) 2004-2018 mudpy authors. Permission to use, copy,
+.. Copyright (c) 2004-2019 mudpy authors. Permission to use, copy,

    modify, and distribute this software is granted under terms
    provided in the LICENSE file distributed with this software.
 
    modify, and distribute this software is granted under terms
    provided in the LICENSE file distributed with this software.
 


@@ -422,3 +422,36 @@ written.
 Example::
 
   .mudpy.timing.status: 6000
 Example::
 
   .mudpy.timing.status: 6000

+
+.mudpy.user
+-----------
+
+.mudpy.user.pref_admin
+~~~~~~~~~~~~~~~~~~~~~~
+
+list, optional
+
+This can be used to list facets an administrative user is allowed to
+set or override on their own ``account`` element, in addition to any
+in the `.mudpy.user.pref_allow`_ list. Note that this is merely a
+convenience, as an administrator is already able to call the ``set``
+command to set values for facets of any element.
+
+Example::
+
+  .mudpy.user.pref_admin:
+      - loglevel
+
+.mudpy.user.pref_allow
+~~~~~~~~~~~~~~~~~~~~~~
+
+list, optional
+
+This can be used to list facets any user is allowed to set or
+override on their own ``account`` element with the ``preference``
+command.
+
+Example::
+
+  .mudpy.user.pref_allow:
+      - prompt