diff options
author | James Turnbull <james@lovedthanlost.net> | 2010-04-12 07:31:40 +1000 |
---|---|---|
committer | test branch <puppet-dev@googlegroups.com> | 2010-02-17 06:50:53 -0800 |
commit | b49c60bd35aa216197c330934ccb0cc69982bad9 (patch) | |
tree | 7ff9f83a98aa2adbd3d62cf7a7d86288b45a3bf0 | |
parent | 115f37d88d36d5b3006b7c56b53b6644fabfd537 (diff) | |
download | puppet-b49c60bd35aa216197c330934ccb0cc69982bad9.tar.gz puppet-b49c60bd35aa216197c330934ccb0cc69982bad9.tar.xz puppet-b49c60bd35aa216197c330934ccb0cc69982bad9.zip |
Update man pages and partial doc fix to #3491
-rwxr-xr-x | install.rb | 12 | ||||
-rw-r--r-- | man/man5/puppet.conf.5 | 26 | ||||
-rw-r--r-- | man/man8/puppetca.8 | 85 | ||||
-rw-r--r-- | man/man8/puppetd.8 | 108 | ||||
-rw-r--r-- | man/man8/puppetmasterd.8 | 52 | ||||
-rw-r--r-- | man/man8/puppetqd.8 | 45 | ||||
-rw-r--r-- | man/man8/puppetrun.8 | 100 | ||||
-rwxr-xr-x | sbin/puppetd | 5 |
8 files changed, 199 insertions, 234 deletions
diff --git a/install.rb b/install.rb index 4da92d98c..3f48940a6 100755 --- a/install.rb +++ b/install.rb @@ -349,7 +349,7 @@ def build_ri(files) end end -def build_man(bins) +def build_man(bins, sbins) return unless $haveman begin # Locate rst2man @@ -361,13 +361,15 @@ def build_man(bins) File.unlink("./puppet.conf.rst") # Create binary man pages - bins.each do |bin| - b = bin.gsub( "bin/", "") + binary = bins + sbins + binary.each do |bin| + b = bin.gsub( /(bin|sbin)\//, "") %x{#{bin} --help > ./#{b}.rst} %x{#{rst2man} ./#{b}.rst ./man/man8/#{b}.8} File.unlink("./#{b}.rst") end - rescue SystemCallError + +rescue SystemCallError $stderr.puts "Couldn't build man pages: " + $! $stderr.puts "Continuing with install..." end @@ -470,7 +472,7 @@ prepare_installation #run_tests(tests) if InstallOptions.tests #build_rdoc(rdoc) if InstallOptions.rdoc #build_ri(ri) if InstallOptions.ri -#build_man(bins) if InstallOptions.man +#build_man(bins, sbins) if InstallOptions.man do_bins(sbins, InstallOptions.sbin_dir) do_bins(bins, InstallOptions.bin_dir) do_libs(libs) diff --git a/man/man5/puppet.conf.5 b/man/man5/puppet.conf.5 index b762e40a3..2a5b1b192 100644 --- a/man/man5/puppet.conf.5 +++ b/man/man5/puppet.conf.5 @@ -4,7 +4,7 @@ Configuration Reference \- .\" Man page generated from reStructeredText. . .sp -\fBThis page is autogenerated; any changes will get overwritten\fP \fI(last generated on Mon Feb 08 23:57:07 +1100 2010)\fP +\fBThis page is autogenerated; any changes will get overwritten\fP \fI(last generated on Sun Apr 11 17:57:48 \-0400 2010)\fP .SS Contents .INDENT 0.0 .IP \(bu 2 @@ -294,6 +294,14 @@ Whether matching in case statements and selectors should be case\-sensitive. Ca .SS catalog_format .sp (Deprecated for \(aqpreferred_serialization_format\(aq) What format to use to dump the catalog. Only supports \(aqmarshal\(aq and \(aqyaml\(aq. Only matters on the client, since it asks the server for a specific format. +.SS catalog_terminus +.sp +Where to get node catalogs. This is useful to change if, for instance, you\(aqd like to pre\-compile catalogs and store them in memcached or some other easily\-accessed store. +.INDENT 0.0 +.IP \(bu 2 +. +\fBDefault\fP: compiler +.UNINDENT .SS cert_inventory .sp A Complete listing of all certificates @@ -319,7 +327,7 @@ The name to use when handling certificates. Defaults to the fully qualified dom .INDENT 0.0 .IP \(bu 2 . -\fBDefault\fP: absinthe.lovedthanlost.net +\fBDefault\fP: pelin.lovedthanlost.net .UNINDENT .SS classfile .sp @@ -1159,7 +1167,7 @@ The \(aqfrom\(aq email address for the reports. .INDENT 0.0 .IP \(bu 2 . -\fBDefault\fP: \fI\%report@absinthe.lovedthanlost.net\fP +\fBDefault\fP: \fI\%report@pelin.lovedthanlost.net\fP .UNINDENT .SS reports .sp @@ -1420,6 +1428,14 @@ Whether to validate types during parsing. . \fBDefault\fP: true .UNINDENT +.SS use_cached_catalog +.sp +Whether to only use the cached catalog rather than compiling a new catalog on every run. Puppet can be run with this enabled by default and then selectively disabled when a recompile is desired. +.INDENT 0.0 +.IP \(bu 2 +. +\fBDefault\fP: false +.UNINDENT .SS usecacheonfailure .sp Whether to use the cached configuration when the remote configuration will not compile. This option is useful for testing new configurations, where you want to fix the broken configuration rather than reverting to a known\-good one. @@ -1442,7 +1458,7 @@ Where Puppet stores dynamic and growing data. The default for this parameter is .INDENT 0.0 .IP \(bu 2 . -\fBDefault\fP: /var/puppet +\fBDefault\fP: /var/lib/puppet .UNINDENT .SS yamldir .sp @@ -1468,7 +1484,7 @@ Boolean; whether to use the zlib library .ce 0 .sp .sp -\fIThis page autogenerated on Mon Feb 08 23:57:07 +1100 2010\fP +\fIThis page autogenerated on Sun Apr 11 17:57:48 \-0400 2010\fP .\" Generated by docutils manpage writer. .\" . diff --git a/man/man8/puppetca.8 b/man/man8/puppetca.8 index f219e9cce..92e9de1b1 100644 --- a/man/man8/puppetca.8 +++ b/man/man8/puppetca.8 @@ -2,127 +2,114 @@ .SH NAME \- .\" Man page generated from reStructeredText. - +. .SH SYNOPSIS +.sp Stand\-alone certificate authority. Capable of generating certificates but mostly meant for signing certificate requests from puppet clients. - - .SH USAGE .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 - .TP .B puppetca [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] +. [\-g|\-\-generate] [\-l|\-\-list] [\-s|\-\-sign] [\-r|\-\-revoke] [\-p|\-\-print] [\-c|\-\-clean] [\-\-verify] [host] - .UNINDENT .UNINDENT .UNINDENT - .SH DESCRIPTION +.sp Because the puppetmasterd daemon defaults to not signing client certificate requests, this script is available for signing outstanding requests. It can be used to list outstanding requests and then either sign them individually or sign all of them. - - .SH OPTIONS -Note that any configuration parameter that\'s valid in the configuration -file is also a valid long argument. For example, \'ssldir\' is a valid -configuration parameter, so you can specify \'\-\-ssldir <directory>\' as an +.sp +Note that any configuration parameter that\(aqs valid in the configuration +file is also a valid long argument. For example, \(aqssldir\(aq is a valid +configuration parameter, so you can specify \(aq\-\-ssldir <directory>\(aq as an argument. - +.sp See the configuration file documentation at \fI\%http://reductivelabs.com/projects/puppet/reference/configref.html\fP for the full list of acceptable parameters. A commented list of all configuration options can also be generated by running puppetca with -\'\-\-genconfig\'. - +\(aq\-\-genconfig\(aq. .INDENT 0.0 - .TP .B all: Operate on all items. Currently only makes sense with -\'\-\-sign\', \'\-\-clean\', or \'\-\-list\'. - - +. +\(aq\-\-sign\(aq, \(aq\-\-clean\(aq, or \(aq\-\-list\(aq. .TP -.B clean: Remove all files related to a host from puppetca\'s storage. +.B clean: Remove all files related to a host from puppetca\(aqs storage. +. This is useful when rebuilding hosts, since new certificate signing requests will only be honored if puppetca does not have a copy of a signed certificate for that host. The -certificate of the host remains valid. If \'\-\-all\' is specified +certificate of the host remains valid. If \(aq\-\-all\(aq is specified then all host certificates, both signed and unsigned, will be removed. - .UNINDENT +.sp debug: Enable full debugging. - .INDENT 0.0 - .TP .B generate: Generate a certificate for a named client. A +. certificate/keypair will be generated for each client named on the command line. - .UNINDENT +.sp help: Print this help message - .INDENT 0.0 - .TP -.B list: List outstanding certificate requests. If \'\-\-all\' is +.B list: List outstanding certificate requests. If \(aq\-\-all\(aq is +. specified, signed certificates are also listed, prefixed by -\'+\', and revoked or invalid certificates are prefixed by \'\-\' +\(aq+\(aq, and revoked or invalid certificates are prefixed by \(aq\-\(aq (the verification outcome is printed in parenthesis). - .UNINDENT -print: Print the full\-text version of a host\'s certificate. - +.sp +print: Print the full\-text version of a host\(aqs certificate. .INDENT 0.0 - .TP .B revoke: Revoke the certificate of a client. The certificate can be +. specified either by its serial number, given as a decimal -number or a hexadecimal number prefixed by \'0x\', or by its +number or a hexadecimal number prefixed by \(aq0x\(aq, or by its hostname. The certificate is revoked by adding it to the -Certificate Revocation List given by the \'cacrl\' config +Certificate Revocation List given by the \(aqcacrl\(aq config parameter. Note that the puppetmasterd needs to be restarted after revoking certificates. - - .TP -.B sign: Sign an outstanding certificate request. Unless \'\-\-all\' is +.B sign: Sign an outstanding certificate request. Unless \(aq\-\-all\(aq is +. specified, hosts must be listed after all flags. - .UNINDENT +.sp verbose: Enable verbosity. - +.sp version: Print the puppet version number and exit. - +.sp verify: Verify the named certificate against the local CA certificate. - - .SH EXAMPLE .INDENT 0.0 .INDENT 3.5 +.sp $ puppetca \-l culain.madstop.com $ puppetca \-s culain.madstop.com - .UNINDENT .UNINDENT - .SH AUTHOR +.sp Luke Kanies - - .SH COPYRIGHT +.sp Copyright (c) 2005 Reductive Labs, LLC Licensed under the GNU Public License - - -.\" Generated by docutils manpage writer on 2009-12-30 19:31. +.\" Generated by docutils manpage writer. .\" +. diff --git a/man/man8/puppetd.8 b/man/man8/puppetd.8 index fc151be93..c2d5cb530 100644 --- a/man/man8/puppetd.8 +++ b/man/man8/puppetd.8 @@ -1,55 +1,53 @@ -.TH Synopsis "" "" "" +.TH SYNOPSIS "" "" "" .SH NAME Synopsis \- .\" Man page generated from reStructeredText. +. +.sp Retrieve the client configuration from the central puppet server and apply it to the local host. - +.sp Currently must be run out periodically, using cron or something similar. - - .SH USAGE .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 - .TP .B puppetd [\-D|\-\-daemonize|\-\-no\-daemonize] [\-d|\-\-debug] [\-\-disable] [\-\-enable] +. [\-h|\-\-help] [\-\-fqdn <host name>] [\-l|\-\-logdest syslog|<file>|console] [\-o|\-\-onetime] [\-\-serve <handler>] [\-t|\-\-test] [\-\-noop] [\-V|\-\-version] [\-v|\-\-verbose] [\-w|\-\-waitforcert <seconds>] - .UNINDENT .UNINDENT .UNINDENT - .SH DESCRIPTION +.sp This is the main puppet client. Its job is to retrieve the local -machine\'s configuration from a remote server and apply it. In order to +machine\(aqs configuration from a remote server and apply it. In order to successfully communicate with the remote server, the client must have a certificate signed by a certificate authority that the server trusts; the recommended method for this, at the moment, is to run a certificate authority as part of the puppet server (which is the default). The client will connect and request a signed certificate, and will continue connecting until it receives one. - +.sp Once the client has a signed certificate, it will retrieve its configuration and apply it. - - .SH USAGE NOTES +.sp +puppetd+ does its best to find a compromise between interactive use and daemon use. Run with no arguments and no configuration, it will go into the backgroun, attempt to get a signed certificate, and retrieve and apply its configuration every 30 minutes. - +.sp Some flags are meant specifically for interactive use \-\- in particular, +test+ and +tags+ are useful. +test+ enables verbose logging, causes the -daemon to stay in the foreground, exits if the server\'s configuration is -invalid (this happens if, for instance, you\'ve left a syntax error on +daemon to stay in the foreground, exits if the server\(aqs configuration is +invalid (this happens if, for instance, you\(aqve left a syntax error on the server), and exits after running the configuration once (rather than hanging around as a long\-running process). - +.sp +tags+ allows you to specify what portions of a configuration you want to apply. Puppet elements are tagged with all of the class or definition names that contain them, and you can use the +tags+ flag to specify one @@ -60,87 +58,80 @@ manage +ntpd+, you would put all of the new elements into an +ntpd+ class, and call puppet with +\-\-tags ntpd+, which would only apply that small portion of the configuration during your testing, rather than applying the whole thing. - - .SH OPTIONS -Note that any configuration parameter that\'s valid in the configuration -file is also a valid long argument. For example, \'server\' is a valid -configuration parameter, so you can specify \'\-\-server <servername>\' as +.sp +Note that any configuration parameter that\(aqs valid in the configuration +file is also a valid long argument. For example, \(aqserver\(aq is a valid +configuration parameter, so you can specify \(aq\-\-server <servername>\(aq as an argument. - +.sp See the configuration file documentation at \fI\%http://reductivelabs.com/trac/puppet/wiki/ConfigurationReference\fP for the full list of acceptable parameters. A commented list of all configuration options can also be generated by running puppetd with -\'\-\-genconfig\'. - +\(aq\-\-genconfig\(aq. +.sp daemonize: Send the process into the background. This is the default. - +.sp no\-daemonize: Do not send the process into the background. - +.sp debug: Enable full debugging. - .INDENT 0.0 - .TP .B disable: Disable working on the local system. This puts a lock file +. in place, causing +puppetd+ not to work on the system until the lock file is removed. This is useful if you are testing a configuration and do not want the central configuration to override the local state until everything is tested and committed. - .UNINDENT +.sp +puppetd+ uses the same lock file while it is running, so no more than one +puppetd+ process is working at a time. - +.sp +puppetd+ exits after executing this. - .INDENT 0.0 - .TP .B enable: Enable working on the local system. This removes any lock +. file, causing +puppetd+ to start managing the local system again (although it will continue to use its normal scheduling, so it might not start for another half hour). - .UNINDENT +.sp +puppetd+ exits after executing this. - .INDENT 0.0 - .TP .B fqdn: Set the fully\-qualified domain name of the client. This is +. only used for certificate purposes, but can be used to override the discovered hostname. If you need to use this flag, it is generally an indication of a setup problem. - .UNINDENT +.sp help: Print this help message - .INDENT 0.0 - .TP .B logdest: Where to send messages. Choose between syslog, the +. console, and a log file. Defaults to sending messages to syslog, or the console if debugging or verbosity is enabled. - - .TP .B no\-client: Do not create a config client. This will cause the daemon +. to run without ever checking for its configuration automatically, and only makes sense when used in conjunction with \-\-listen. - - .TP -.B onetime: Run the configuration once, rather than as a long\-running -daemon. This is useful for interactively running puppetd. - - +.B onetime: Run the configuration once. Runs a single daemonized +. +Puppet run. Useful for interactively running puppetd and +hence used in conjunction with the \-\-no\-daemonize option. .TP .B serve: Start another type of server. By default, +puppetd+ will +. start a service handler that allows authenticated and authorized remote nodes to trigger the configuration to be pulled down and applied. You can specify any handler here @@ -149,53 +140,46 @@ or resource. The handlers are in +lib/puppet/network/handler+, and the names must match exactly, both in the call to +serve+ and in +namespaceauth.conf+. - - .TP .B test: Enable the most common options used for testing. These are +. +onetime+, +verbose+, +ignorecache, +no\-daemonize+, and +no\-usecacheonfailure+. - - .TP .B noop: Use +noop+ mode where the daemon runs in a no\-op or +. dry\-run mode. This is useful for seeing what changes Puppet will make without actually executing the changes. - .UNINDENT +.sp verbose: Turn on verbose reporting. - +.sp version: Print the puppet version number and exit. - .INDENT 0.0 - .TP .B waitforcert: This option only matters for daemons that do not yet have +. certificates and it is enabled by default, with a value of 120 (seconds). This causes +puppetd+ to connect to the server every 2 minutes and ask it to sign a certificate request. This is useful for the initial setup of a puppet client. You can turn off waiting for certificates by specifying a time of 0. - .UNINDENT - .SH EXAMPLE .INDENT 0.0 .INDENT 3.5 +.sp puppetd \-\-server puppet.domain.com - .UNINDENT .UNINDENT - .SH AUTHOR +.sp Luke Kanies - - .SH COPYRIGHT +.sp Copyright (c) 2005, 2006 Reductive Labs, LLC Licensed under the GNU Public License - - -.\" Generated by docutils manpage writer on 2009-12-30 19:31. +.\" Generated by docutils manpage writer. .\" +. diff --git a/man/man8/puppetmasterd.8 b/man/man8/puppetmasterd.8 index cf1355192..5bfea2ef2 100644 --- a/man/man8/puppetmasterd.8 +++ b/man/man8/puppetmasterd.8 @@ -2,79 +2,71 @@ .SH NAME \- .\" Man page generated from reStructeredText. - +. .SH SYNOPSIS +.sp The central puppet server. Functions as a certificate authority by default. - - .SH USAGE .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 - .TP .B puppetmasterd [\-D|\-\-daemonize|\-\-no\-daemonize] [\-d|\-\-debug] [\-h|\-\-help] +. [\-l|\-\-logdest <file>|console|syslog] [\-v|\-\-verbose] [\-V|\-\-version] - .UNINDENT .UNINDENT .UNINDENT - .SH DESCRIPTION +.sp This is the puppet central daemon. - - .SH OPTIONS -Note that any configuration parameter that\'s valid in the configuration -file is also a valid long argument. For example, \'ssldir\' is a valid -configuration parameter, so you can specify \'\-\-ssldir <directory>\' as an +.sp +Note that any configuration parameter that\(aqs valid in the configuration +file is also a valid long argument. For example, \(aqssldir\(aq is a valid +configuration parameter, so you can specify \(aq\-\-ssldir <directory>\(aq as an argument. - +.sp See the configuration file documentation at \fI\%http://reductivelabs.com/trac/puppet/wiki/ConfigurationReference\fP for the full list of acceptable parameters. A commented list of all configuration options can also be generated by running puppetmasterdd -with \'\-\-genconfig\'. - +with \(aq\-\-genconfig\(aq. +.sp daemonize: Send the process into the background. This is the default. - +.sp no\-daemonize: Do not send the process into the background. - +.sp debug: Enable full debugging. - +.sp help: Print this help message. - .INDENT 0.0 - .TP .B logdest: Where to send messages. Choose between syslog, the +. console, and a log file. Defaults to sending messages to syslog, or the console if debugging or verbosity is enabled. - .UNINDENT +.sp verbose: Enable verbosity. - +.sp version: Print the puppet version number and exit. - - .SH EXAMPLE .INDENT 0.0 .INDENT 3.5 +.sp puppetmasterd - .UNINDENT .UNINDENT - .SH AUTHOR +.sp Luke Kanies - - .SH COPYRIGHT +.sp Copyright (c) 2005 Reductive Labs, LLC Licensed under the GNU Public License - - -.\" Generated by docutils manpage writer on 2009-12-30 19:31. +.\" Generated by docutils manpage writer. .\" +. diff --git a/man/man8/puppetqd.8 b/man/man8/puppetqd.8 index 2b096cf15..bf08f2bb2 100644 --- a/man/man8/puppetqd.8 +++ b/man/man8/puppetqd.8 @@ -1,60 +1,55 @@ -.TH Synopsis "" "" "" +.TH SYNOPSIS "" "" "" .SH NAME Synopsis \- .\" Man page generated from reStructeredText. +. +.sp Retrieve serialized records from a queue and process them in order. - - .SH USAGE .INDENT 0.0 .INDENT 3.5 +.sp puppetqd [\-d|\-\-debug] [\-v|\-\-verbose] - .UNINDENT .UNINDENT - .SH DESCRIPTION +.sp This is a simple application that just processes entities in a queue as they are recieved. - - .SH OPTIONS -Note that any configuration parameter that\'s valid in the configuration -file is also a valid long argument. For example, \'server\' is a valid -configuration parameter, so you can specify \'\-\-server <servername>\' as +.sp +Note that any configuration parameter that\(aqs valid in the configuration +file is also a valid long argument. For example, \(aqserver\(aq is a valid +configuration parameter, so you can specify \(aq\-\-server <servername>\(aq as an argument. - +.sp See the configuration file documentation at \fI\%http://reductivelabs.com/trac/puppet/wiki/ConfigurationReference\fP for the full list of acceptable parameters. A commented list of all configuration options can also be generated by running puppetd with -\'\-\-genconfig\'. - +\(aq\-\-genconfig\(aq. +.sp debug: Enable full debugging. - +.sp help: Print this help message - +.sp verbose: Turn on verbose reporting. - +.sp version: Print the puppet version number and exit. - - .SH EXAMPLE .INDENT 0.0 .INDENT 3.5 +.sp puppetqd - .UNINDENT .UNINDENT - .SH AUTHOR +.sp Luke Kanies - - .SH COPYRIGHT +.sp Copyright (c) 2009 Reductive Labs, LLC Licensed under the GNU Public License - - -.\" Generated by docutils manpage writer on 2009-12-30 19:32. +.\" Generated by docutils manpage writer. .\" +. diff --git a/man/man8/puppetrun.8 b/man/man8/puppetrun.8 index 90707f2e7..73a4ba3f2 100644 --- a/man/man8/puppetrun.8 +++ b/man/man8/puppetrun.8 @@ -2,58 +2,55 @@ .SH NAME \- .\" Man page generated from reStructeredText. - +. .SH SYNOPSIS +.sp Trigger a puppetd run on a set of hosts. - - .SH USAGE .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 - .TP .B puppetrun [\-a|\-\-all] [\-c|\-\-class <class>] [\-d|\-\-debug] [\-f|\-\-foreground] +. [\-h|\-\-help] [\-\-host <host>] [\-\-no\-fqdn] [\-\-ignoreschedules] [\-t|\-\-tag <tag>] [\-\-test] [\-p|\-\-ping] - .UNINDENT .UNINDENT .UNINDENT - .SH DESCRIPTION +.sp This script can be used to connect to a set of machines running +puppetd+ and trigger them to run their configurations. The most common usage would be to specify a class of hosts and a set of tags, and +puppetrun+ would look up in LDAP all of the hosts matching that class, then connect to each host and trigger a run of all of the objects with the specified tags. - +.sp If you are not storing your host configurations in LDAP, you can specify hosts manually. - +.sp You will most likely have to run +puppetrun+ as root to get access to the SSL certificates. - -+puppetrun+ reads +puppetmaster+\'s configuration file, so that it can +.sp ++puppetrun+ reads +puppetmaster+\(aqs configuration file, so that it can copy things like LDAP settings. - - .SH USAGE NOTES +.sp +puppetrun+ is useless unless +puppetd+ is listening. See its documentation for more information, but the gist is that you must enable +listen+ on the +puppetd+ daemon, either using +\-\-listen+ on the command -line or adding \'listen: true\' in its config file. In addition, you need +line or adding \(aqlisten: true\(aq in its config file. In addition, you need to set the daemons up to specifically allow connections by creating the -+namespaceauth+ file, normally at \'/etc/puppet/namespaceauth.conf\'. This ++namespaceauth+ file, normally at \(aq/etc/puppet/namespaceauth.conf\(aq. This file specifies who has access to each namespace; if you create the file you must add every namespace you want any Puppet daemon to allow \-\- it is currently global to all Puppet daemons. - +.sp An example file looks like this: - - +.sp .nf +.ft C [fileserver] allow *.madstop.com @@ -62,103 +59,94 @@ An example file looks like this: [puppetrunner] allow culain.madstop.com +.ft P .fi +.sp This is what you would install on your Puppet master; non\-master hosts -could leave off the \'fileserver\' and \'puppetmaster\' namespaces. - +could leave off the \(aqfileserver\(aq and \(aqpuppetmaster\(aq namespaces. +.sp Expect more documentation on this eventually. - - .SH OPTIONS -Note that any configuration parameter that\'s valid in the configuration -file is also a valid long argument. For example, \'ssldir\' is a valid -configuration parameter, so you can specify \'\-\-ssldir <directory>\' as an +.sp +Note that any configuration parameter that\(aqs valid in the configuration +file is also a valid long argument. For example, \(aqssldir\(aq is a valid +configuration parameter, so you can specify \(aq\-\-ssldir <directory>\(aq as an argument. - +.sp See the configuration file documentation at \fI\%http://reductivelabs.com/projects/puppet/reference/configref.html\fP for the full list of acceptable parameters. A commented list of all configuration options can also be generated by running puppetmasterdd -with \'\-\-genconfig\'. - +with \(aq\-\-genconfig\(aq. .INDENT 0.0 - .TP .B all: Connect to all available hosts. Requires LDAP support +. at this point. - - .TP .B class: Specify a class of machines to which to connect. This +. only works if you have LDAP configured, at the moment. - .UNINDENT +.sp debug: Enable full debugging. - .INDENT 0.0 - .TP .B foreground: Run each configuration in the foreground; that is, when +. connecting to a host, do not return until the host has finished its run. The default is false. - .UNINDENT +.sp help: Print this help message - .INDENT 0.0 - .TP .B host: A specific host to which to connect. This flag can be +. specified more than once. - - .TP .B ignoreschedules: Whether the client should ignore schedules when running +. its configuration. This can be used to force the client to perform work it would not normally perform so soon. The default is false. - - .TP .B parallel: How parallel to make the connections. Parallelization +. is provided by forking for each client to which to connect. The default is 1, meaning serial execution. - - .TP .B tag: Specify a tag for selecting the objects to apply. Does +. not work with the \-\-test option. - - .TP .B test: Print the hosts you would connect to but do not +. actually connect. This option requires LDAP support at this point. - .UNINDENT +.sp ping: - - +.sp .nf -Do a ICMP echo against the target host. Skip hosts that don\'t respond to ping. +.ft C +Do a ICMP echo against the target host. Skip hosts that don\(aqt respond to ping. +.ft P .fi - .SH EXAMPLE .INDENT 0.0 .INDENT 3.5 +.sp sudo puppetrun \-p 10 \-\-host host1 \-\-host host2 \-t remotefile \-t webserver - .UNINDENT .UNINDENT - .SH AUTHOR +.sp Luke Kanies - - .SH COPYRIGHT +.sp Copyright (c) 2005 Reductive Labs, LLC Licensed under the GNU Public License - - -.\" Generated by docutils manpage writer on 2009-12-30 19:31. +.\" Generated by docutils manpage writer. .\" +. diff --git a/sbin/puppetd b/sbin/puppetd index 5886100b8..f88e0fefe 100755 --- a/sbin/puppetd +++ b/sbin/puppetd @@ -131,8 +131,9 @@ # makes sense when used in conjunction with --listen. # # onetime:: -# Run the configuration once, rather than as a long-running daemon. This is -# useful for interactively running puppetd. +# Run the configuration once. Runs a single daemonized Puppet run. Useful for +# interactively running puppetd and hence used in conjunction with the --no-daemonize +# option. # # fingerprint:: # Display the current certificate or certificate signing request fingerprint |