From 79ef1ac677d7df1633b5654b5310317ee9c6aede Mon Sep 17 00:00:00 2001
From: Sol Jerome <solj@ices.utexas.edu>
Date: Mon, 22 Mar 2010 20:02:57 +0000
Subject: doc: Add new service mode information

Signed-off-by: Sol Jerome <solj@ices.utexas.edu>

git-svn-id: https://svn.mcs.anl.gov/repos/bcfg/trunk/bcfg2@5785 ce84e21b-d406-0410-9b95-82705330c041
---
 doc/client/index.txt                    | 21 +++++++++++
 doc/client/paranoid.txt                 |  4 +--
 doc/server/plugins/generators/rules.txt | 63 ++++++++++++++++++++++++---------
 3 files changed, 69 insertions(+), 19 deletions(-)

diff --git a/doc/client/index.txt b/doc/client/index.txt
index d0e7bd9a6..e13d97ea8 100644
--- a/doc/client/index.txt
+++ b/doc/client/index.txt
@@ -22,6 +22,27 @@ architecture, as opposed to one with a smarter client, for a few reasons:
   deployment engine that can be driven by anything that writes a
   compatible configuration description.
 
+Overall client service mode
+---------------------------
+
+`New in version 1.0.0`
+
+Overall client service mode. Specified on the client using ``-s <service
+mode``.
+
+* default
+
+  * perform all service manipulations
+
+* disabled
+
+  * perform no service manipulations
+
+* build
+
+  * attempt to stop all services started
+  * deprecates/replaces -B
+
 .. toctree::
    :maxdepth: 2
 
diff --git a/doc/client/paranoid.txt b/doc/client/paranoid.txt
index 0dba89fd1..8f50c550d 100644
--- a/doc/client/paranoid.txt
+++ b/doc/client/paranoid.txt
@@ -26,7 +26,7 @@ How do I use it?
 
 This will save a copy of the replaced file in ``/var/cache/bcfg2``,
 but it'll be named as the path to the file with /'s replaced
-by _'s. For example, the old `/etc/hosts` will be named
+by _'s. For example, the old ``/etc/hosts`` will be named
 ``/var/cache/bcfg2/etc_hosts``.
 
 Extra configuration
@@ -39,5 +39,5 @@ in 1.0. For the following section in bcfg2.conf::
     path = /my/custom/backup/path
     max_copies = 5
 
-You will have the file backups store in /my/custom/backup/path. This
+You will have the file backups store in ``/my/custom/backup/path``. This
 will also keep the five most recent backups of files.
diff --git a/doc/server/plugins/generators/rules.txt b/doc/server/plugins/generators/rules.txt
index ca40eae70..3c546dac0 100644
--- a/doc/server/plugins/generators/rules.txt
+++ b/doc/server/plugins/generators/rules.txt
@@ -116,23 +116,52 @@ See [wiki:Plugins/Actions Actions]
 Service Tag
 -----------
 
-+----------+-----------------------------+-------------------------------+
-| Name     | Description                 | Values                        |
-+==========+=============================+===============================+
-| name     | Service Name                | String                        |
-+----------+-----------------------------+-------------------------------+
-| status   | Should the service be on or | (on|off)                      |
-|          | off.                        |                               |
-+----------+-----------------------------+-------------------------------+
-| restart  | Service command for restart | String                        |
-|          | (default:restart)           |                               |
-+----------+-----------------------------+-------------------------------+
-| type     | Driver to use on the client | (chkconfig|deb|rc-update|smf) |
-|          | to manage this service.     |                               |
-+----------+-----------------------------+-------------------------------+
-| sequence | Order for service startup   | integer                       |
-|          | (debian services only)      |                               |
-+----------+-----------------------------+-------------------------------+
++----------+--------------------------+---------------------------------------+
+| Name     | Description              | Values                                |
++==========+==========================+=======================================+
+| mode     | Per Service Mode (New in | (manual|default|supervised|custom)    |
+|          | 1.0)                     |                                       |
++----------+--------------------------+---------------------------------------+
+| name     | Service Name             | String                                |
++----------+--------------------------+---------------------------------------+
+| status   | Should the service be    | (on|off)                              |
+|          | on or off.               |                                       |
+|          | off.                     |                                       |
++----------+--------------------------+---------------------------------------+
+| restart  | Service command for      | String                                |
+|          | restart                  |                                       |
+|          | (default:restart)        |                                       |
++----------+--------------------------+---------------------------------------+
+| type     | Driver to use on the     | (chkconfig|deb|rc-update|smf|upstart) |
+|          | client to manage this    |                                       |
+|          | service.                 |                                       |
++----------+--------------------------+---------------------------------------+
+| sequence | Order for service        | integer                               |
+|          | startup (debian services |                                       |
+|          | only)                    |                                       |
++----------+--------------------------+---------------------------------------+
+
+Service mode descriptions
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+`New in version 1.0.0`
+
+* manual
+
+  * do not start/stop/restart this service
+
+* default
+
+  * perform appropriate service ops
+
+* supervised
+
+  * default + ensure service is running when verification is performed
+  * deprecates supervised='true'
+
+* custom
+
+  * set non-default restart target in conjunction with target attribute
 
 Client Tag
 ----------
-- 
cgit v1.2.3-1-g7c22