aboutsummaryrefslogtreecommitdiff
path: root/doc/data.rst
diff options
context:
space:
mode:
authorSean Whitton <spwhitton@spwhitton.name>2021-02-21 15:14:54 -0700
committerSean Whitton <spwhitton@spwhitton.name>2021-02-21 15:18:51 -0700
commit01ce41d093ce6e1120ee91e36ced7ed4d557632d (patch)
tree06a04194cdf48da5f036847b5acd05dafc83b99f /doc/data.rst
parentee839dcc62d30970f1d9850162e4479df8374c2e (diff)
downloadconsfigurator-01ce41d093ce6e1120ee91e36ced7ed4d557632d.tar.gz
start figuring out :SUDO connection type
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
Diffstat (limited to 'doc/data.rst')
-rw-r--r--doc/data.rst12
1 files changed, 10 insertions, 2 deletions
diff --git a/doc/data.rst b/doc/data.rst
index d30eab8..be2d98c 100644
--- a/doc/data.rst
+++ b/doc/data.rst
@@ -23,8 +23,16 @@ other purposes.
- ``(HOSTNAME . PATH)`` means the data that should be uploaded to ``PATH`` on
``HOSTNAME`` (and nowhere else)
-- ``("lisp-system" . SYSTEM)`` means the data is Lisp code which, when loaded,
- defines the packages and symbols contained in the ASDF system ``SYSTEM``.
+- ``("--lisp-system" . SYSTEM)`` means the data is Lisp code which, when
+ loaded, defines the packages and symbols contained in the ASDF system
+ ``SYSTEM``
+
+- ``("--user-passwd--HOSTNAME" . USER)`` means the data is the password for
+ user ``USER`` on ``HOSTNAME``.
+
+(Proposed convention: Except for the first item above, these reserved names
+should start with ``--`` and use ``--`` to separate parameter values within
+the string. Hostnames cannot start with a hyphen.)
Mechanics
---------