summaryrefslogtreecommitdiff
path: root/doc/usage.mdwn
diff options
context:
space:
mode:
authorJoey Hess2014-12-26 15:35:17 -0400
committerJoey Hess2014-12-26 15:35:17 -0400
commit28596064c234333d11a33e619c72547b3a0a8367 (patch)
tree4d3039599eef7441b8ba4aeec03ba40d2fd6a656 /doc/usage.mdwn
parentc7aac0b35e0a8b18dd46d6533c2fbc348f0de461 (diff)
layout
Diffstat (limited to 'doc/usage.mdwn')
-rw-r--r--doc/usage.mdwn26
1 files changed, 14 insertions, 12 deletions
diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index 6ef2e965..45015131 100644
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -13,11 +13,13 @@ and configured in haskell.
# MODES OF OPERATION
-* The first time you run `propellor`, without any options,
- it will set up a `~/.propellor/` repository.
- Edit `~/.propellor/config.hs` to configure it.
+* propellor
-* Once propellor is configured, running it without any options will take
+ The first time you run `propellor`, without any options,
+ it will set up a `~/.propellor/` repository. Edit `~/.propellor/config.hs`
+ to configure it.
+
+ 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
@@ -28,7 +30,7 @@ and configured in haskell.
the same as running propellor --spin with the hostname of the local
host.
-* --spin targethost [targethost ...] [--via relayhost]
+* propellor --spin targethost [targethost ...] [--via relayhost]
Causes propellor to automatically install itself on the specified target
host, or if it's already installed there, push any updates. Propellor is
@@ -47,7 +49,7 @@ and configured in haskell.
uses ssh agent forwarding to make this work, and the relay host
sees any privdata belonging to the target host.
-* --add-key keyid
+* propellor --add-key keyid
Adds a gpg key, which is used to encrypt the privdata.
@@ -55,25 +57,25 @@ and configured in haskell.
using this key. Propellor requires signed commits when pulling from
a central git repository.
-* --list-fields
+* propellor --list-fields
Lists all privdata fields that are used by your propellor configuration.
The first 2 columns are the field name and context, and are followed by
a list of the hosts that use that privdata value.
-* --set field context
+* propellor --set field context
Sets a field of privdata. The content is read in from stdin.
-* --dump field context
+* propellor --dump field context
Outputs the privdata value to stdout.
-* --edit field context
+* propellor --edit field context
Opens $EDITOR on the privdata value.
-* --merge
+* propellor --merge
Combine multiple --spin commits into a single, more useful commit.
@@ -89,7 +91,7 @@ and configured in haskell.
(This will result in a trapezoid pattern in gitk.)
-* hostname
+* propellor hostname
When run with a hostname and no other options, propellor will
provision the local host with the configuration of that hostname.