diff options
| author | ajax <ajax@980ebf18-57e1-0310-9a29-db15c13687c0> | 2006-09-25 19:00:24 +0000 |
|---|---|---|
| committer | ajax <ajax@980ebf18-57e1-0310-9a29-db15c13687c0> | 2006-09-25 19:00:24 +0000 |
| commit | b4970a9b989a79a96deaa391a5d5b359e2818491 (patch) | |
| tree | 0847725abaad7f3b2d38f73dbd4778bccf3a097e | |
| parent | cc08e2f6999d23edaa839367767d60855a246bcd (diff) | |
| download | puppet-b4970a9b989a79a96deaa391a5d5b359e2818491.tar.gz puppet-b4970a9b989a79a96deaa391a5d5b359e2818491.tar.xz puppet-b4970a9b989a79a96deaa391a5d5b359e2818491.zip | |
Expanded documentation of command-line arguments for the puppet executables. (Tweak)
git-svn-id: https://reductivelabs.com/svn/puppet/trunk@1688 980ebf18-57e1-0310-9a29-db15c13687c0
| -rwxr-xr-x | bin/puppetdoc | 22 | ||||
| -rw-r--r-- | documentation/documentation/configref.page | 2 | ||||
| -rw-r--r-- | documentation/documentation/typedocs.page | 2 |
3 files changed, 12 insertions, 14 deletions
diff --git a/bin/puppetdoc b/bin/puppetdoc index 2c7b1879b..2dc170911 100755 --- a/bin/puppetdoc +++ b/bin/puppetdoc @@ -155,14 +155,14 @@ arugments or in the configuration file for the appropriate executable. For instance, the command-line invocation below would set the configuration directory to /private/puppet - $ puppetd --confdir=/private/puppet + $ puppetd --confdir=/private/puppet Note that boolean options are turned on and off with a slightly different syntax on the command line: - $ puppetd --storeconfigs - - $ puppetd --no-storeconfigs + $ puppetd --storeconfigs + + $ puppetd --no-storeconfigs The invocations above will enable and disable, respectively, the storage of the client configuration. @@ -176,9 +176,9 @@ The file, which follows INI-style formatting, should contain a bracketed heading named for the executable, followed by pairs of parameters with their values. Here is an example of a very simple `puppetd.conf` file: - [puppetd] - confdir = /private/puppet - storeconfigs = true + [puppetd] + confdir = /private/puppet + storeconfigs = true Note that boolean parameters must be explicitly specified as `true` or `false` as seen above. @@ -189,7 +189,7 @@ the executable in question with the `--genconfig` command. The executable will print a template configuration to standard output, which can be redirected to a file like so: - $ puppetd --genconfig > /etc/puppet/puppetd.conf + $ puppetd --genconfig > /etc/puppet/puppetd.conf Note that this invocation will "clobber" (throw away) the contents of any pre-existing `puppetd.conf` file, so make a backup of your present config @@ -200,15 +200,13 @@ argument, which will generate a manifest that can be used to manage all of Puppet's directories and files and prints it to standard output. This can likewise be redirected to a file: - $ puppetd --genmanifest > /etc/puppet/manifests/site.pp + $ puppetd --genmanifest > /etc/puppet/manifests/site.pp Puppet can also create user and group accounts for itself (one `puppet` group and one `puppet` user) if it is invoked as `root` with the `--mkusers` argument: - $ puppetd --mkusers + $ puppetd --mkusers - - Any default values are in ``block type`` at the end of the description. } diff --git a/documentation/documentation/configref.page b/documentation/documentation/configref.page index c3e2aba8c..b3c36f33c 100644 --- a/documentation/documentation/configref.page +++ b/documentation/documentation/configref.page @@ -506,4 +506,4 @@ Where Puppet stores dynamic and growing data. ``/var/puppet`` ---------------- -*This page autogenerated on Mon Sep 25 14:48:11 EDT 2006* +*This page autogenerated on Mon Sep 25 14:59:45 EDT 2006* diff --git a/documentation/documentation/typedocs.page b/documentation/documentation/typedocs.page index 83cdaefd0..cddbd5c7a 100644 --- a/documentation/documentation/typedocs.page +++ b/documentation/documentation/typedocs.page @@ -1717,4 +1717,4 @@ so Puppet only checks for it at that time. ---------------- -*This page autogenerated on Mon Sep 25 14:48:14 EDT 2006* +*This page autogenerated on Mon Sep 25 14:59:47 EDT 2006* |