diff options
author | Jesse Wolfe <jes5199@gmail.com> | 2010-05-12 18:22:27 -0700 |
---|---|---|
committer | test branch <puppet-dev@googlegroups.com> | 2010-02-17 06:50:53 -0800 |
commit | 5665e3984f73c70b90f65dd8bf4445b5adda5121 (patch) | |
tree | 551c3bd04ff10b3c3670d362e7bcb3998963541c /lib/puppet/reference | |
parent | fc2904955ca6e77bda8719671df200e0811c38cd (diff) | |
download | puppet-5665e3984f73c70b90f65dd8bf4445b5adda5121.tar.gz puppet-5665e3984f73c70b90f65dd8bf4445b5adda5121.tar.xz puppet-5665e3984f73c70b90f65dd8bf4445b5adda5121.zip |
Feature #2276 Single Executable: Update docstrings
Update documentation strings everywhere to use single-executable
notation rather than the old executable names.
Signed-off-by: Jesse Wolfe <jes5199@gmail.com>
Diffstat (limited to 'lib/puppet/reference')
-rw-r--r-- | lib/puppet/reference/configuration.rb | 27 | ||||
-rw-r--r-- | lib/puppet/reference/indirection.rb | 2 | ||||
-rw-r--r-- | lib/puppet/reference/network.rb | 4 |
3 files changed, 15 insertions, 18 deletions
diff --git a/lib/puppet/reference/configuration.rb b/lib/puppet/reference/configuration.rb index 477b9a7ab..352116cd5 100644 --- a/lib/puppet/reference/configuration.rb +++ b/lib/puppet/reference/configuration.rb @@ -57,14 +57,14 @@ These parameters can be supplied to the executables either as command-line options or in the configuration file. For instance, the command-line invocation below would set the configuration directory to ``/private/puppet``:: - $ puppetd --confdir=/private/puppet + $ puppet agent --confdir=/private/puppet Note that boolean options are turned on and off with a slightly different syntax on the command line:: - $ puppetd --storeconfigs + $ puppet agent --storeconfigs - $ puppetd --no-storeconfigs + $ puppet agent --no-storeconfigs The invocations above will enable and disable, respectively, the storage of the client configuration. @@ -81,11 +81,8 @@ executables look for ``puppet.conf`` in their configuration directory ``~user/.puppet/puppet.conf`` as a regular user by default. All executables will set any parameters set within the ``main`` section, -while each executable will also look for a section named for the executable -and load those parameters. For example, ``puppetd`` will look for a -section named ``puppetd``, and ``puppetmasterd`` looks for a section -named ``puppetmasterd``. This allows you to use a single configuration file -to customize the settings for all of your executables. +and each executable will also use one of the ``master``, ``agent``, or +``user`` sections. File Format ''''''''''' @@ -111,7 +108,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/puppet.conf + $ puppet agent --genconfig > /etc/puppet/puppet.conf Note that this invocation will replace the contents of any pre-existing `puppet.conf` file, so make a backup of your present config if it contains @@ -122,23 +119,23 @@ 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 + $ puppet agent --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 + $ puppet agent --mkusers Signals ------- -The ``puppetd`` and ``puppetmasterd`` executables catch some signals for special +The ``puppet agent`` and ``puppet master`` executables catch some signals for special handling. Both daemons catch (``SIGHUP``), which forces the server to restart tself. Predictably, interrupt and terminate (``SIGINT`` and ``SIGTERM``) will shut -down the server, whether it be an instance of ``puppetd`` or ``puppetmasterd``. +down the server, whether it be an instance of ``puppet agent`` or ``puppet master``. -Sending the ``SIGUSR1`` signal to an instance of ``puppetd`` will cause it to +Sending the ``SIGUSR1`` signal to an instance of ``puppet agent`` will cause it to immediately begin a new configuration transaction with the server. This -signal has no effect on ``puppetmasterd``. +signal has no effect on ``puppet master``. Configuration Parameter Reference --------------------------------- diff --git a/lib/puppet/reference/indirection.rb b/lib/puppet/reference/indirection.rb index 074398120..13c014ed4 100644 --- a/lib/puppet/reference/indirection.rb +++ b/lib/puppet/reference/indirection.rb @@ -26,7 +26,7 @@ end reference.header = "This is the list of all indirections, their associated terminus classes, and how you select between them. -In general, the appropriate terminus class is selected by the application for you (e.g., ``puppetd`` would always use the ``rest`` +In general, the appropriate terminus class is selected by the application for you (e.g., ``puppet agent`` would always use the ``rest`` terminus for most of its indirected classes), but some classes are tunable via normal settings. These will have ``terminus setting`` documentation listed with them. diff --git a/lib/puppet/reference/network.rb b/lib/puppet/reference/network.rb index 1b635fdf2..14b26dd70 100644 --- a/lib/puppet/reference/network.rb +++ b/lib/puppet/reference/network.rb @@ -27,8 +27,8 @@ on the server, and the client knows how to call the handler's methods appropriately. Most handlers are meant to be started on the server, usually within -``puppetmasterd``, and the clients are mostly started on the client, -usually within ``puppetd``. +``puppet master``, and the clients are mostly started on the client, +usually within ``puppet agent``. You can find the server-side handler for each interface at ``puppet/network/handler/<name>.rb`` and the client class at |