summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJoey Hess2014-11-25 11:46:36 -0400
committerJoey Hess2014-11-25 11:46:36 -0400
commit1f40af51e1355bd14f457d3e63dbad19eafcf4d8 (patch)
tree1d93d33d4bdea27a3079461f59438e6a1dae3cda /doc
parentedcfd24251d41ba2f6912b28a2027ee8a1d1b5da (diff)
parente0d2761e00b76f6857fbd57ff846dbcfe1530465 (diff)
Merge branch 'joeyconfig'
Diffstat (limited to 'doc')
-rw-r--r--doc/usage.mdwn20
1 files changed, 14 insertions, 6 deletions
diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index e83e8def..093ec34e 100644
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -11,14 +11,22 @@ propellor [options]
`propellor` is a property-based host configuration management program written
and configured in haskell.
-The first time you run `propellor`, without any options,
-it will set up a `~/.propellor/` repository.
-Edit `~/.propellor/config.hs` to configure it.
+# MODES OF OPERATION
-Once propellor is configured, running it without any options will take
-action as needed to satisfy the configured properties of the local host.
+* The first time you run `propellor`, without any options,
+ it will set up a `~/.propellor/` repository.
+ Edit `~/.propellor/config.hs` to configure it.
-# OPTIONS
+* Once propellor is configured, running it without any options will take
+ action as needed to satisfy the configured properties of the local host.
+
+ If there's a central git repository, it will first fetch from the
+ repository, check the gpg signature and merge, and rebuild propellor,
+ so that any configuration changes will immediately take effect.
+
+ If propellor is run by a non-root user without any options, this is
+ the same as running propellor --spin with the hostname of the local
+ host.
* --spin targethost [targethost ...] [--via relayhost]