aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorSean Whitton <spwhitton@spwhitton.name>2021-02-24 10:59:53 -0700
committerSean Whitton <spwhitton@spwhitton.name>2021-02-24 10:59:53 -0700
commit9c798ef725c51023d9b0447d7902d830385df727 (patch)
treebc61d8bcd81d28e03300a025abfb34b6ca9a5790 /README.rst
parent4d799dadf2a67dc59210834f7d0ea8a8487865cb (diff)
downloadconsfigurator-9c798ef725c51023d9b0447d7902d830385df727.tar.gz
README: update DEPLOY form
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index 8a34462..b8a4a66 100644
--- a/README.rst
+++ b/README.rst
@@ -19,7 +19,9 @@ execute your configuration on hosts with different ways of connecting to them.
Connections can be arbitrarily nested. For example, to combine SSHing to a
Debian machine as an unprivileged user, using sudo to become root, and then
starting up a Lisp image to execute your deployment code, you would just
-evaluate ``(deploy (:ssh (:sudo :user "root") :debian-sbcl) foo.example.com)``.
+evaluate::
+
+ (deploy (:ssh (:sudo :as "spwhitton@foo.example.com") :debian-sbcl) foo.example.com)
Declarative configuration management systems like Consfigurator and Propellor_
share a number of goals with projects like the `GNU Guix System`_ and