Update bcfg2.conf manpage for 1.0

git-svn-id: https://svn.mcs.anl.gov/repos/bcfg/trunk/bcfg2@5123 ce84e21b-d406-0410-9b95-82705330c041

1 files changed, 63 insertions, 31 deletions

diff --git a/man/bcfg2.conf.5 b/man/bcfg2.conf.5
index d41e62eb6..385cd9595 100644
--- a/man/bcfg2.conf.5
+++ b/man/bcfg2.conf.5
@@ -5,39 +5,38 @@ bcfg2.conf - configuration parameters for bcfg2
 
 .SH DESCRIPTION
 .TP
-bcfg2.conf includes configuration parameters for the bcfg2 server and client. 
+bcfg2.conf includes configuration parameters for the bcfg2 server and client.
 
 .SH FILE FORMAT
-The file is INI-style and consists of sections and options. A section begins with the name of the sections in square brackets and continues until the next section begins. 
+The file is INI-style and consists of sections and options. A section
+begins with the name of the sections in square brackets and continues
+until the next section begins.
 
 Options are specified in the form 'name = value'.
 
-The file is line-based each newline-terminated line represents either a comment, a section name or an option.
+The file is line-based each newline-terminated line represents either a
+comment, a section name or an option.
+
+Any line beginning with a hash (#) is ignored, as are lines containing
+only whitespace.
 
-Any line beginning with a hash (#) is ignored, as are lines containing only whitespace.
 
 .SH SERVER OPTIONS
-These options are only necessary on the Bcfg2 server. They are specified in the [server] section of the configuration file.
+These options are only necessary on the Bcfg2 server. They are specified
+in the [server] section of the configuration file.
 
 .TP
 .B repository
-Specifies the path to the Bcfg2 repository containing all of the configuration specifications. The repository should be created using the bcfg2-init command.
-
-.TP
-.B svn
-Set this to yes if the repository is SVN managed.
-
-.TP
-.B structures
-A comma-delimited list of all the enabled structures plugins. Currently available plugins are Base, Bundler, and SGenshi. Defaults to Bundler and Base.
-
-.TP
-.B generators
-A comma-delimited list of all enabled generator plugins. Currently available plugins are Actions, Cfg, Deps, Hostbase, Pkgmgr, Rules, SSHbase, TCheetah, and TGenshi. Defaults to SSHbase, Cfg, Pkgmgr, and Rules.
+Specifies the path to the Bcfg2 repository containing all of the
+configuration specifications. The repository should be created using the
+bcfg2-init command.
 
 .TP
 .B plugins
-A comma-delimited list of enabled server plugins. Currently available plugins are DBStats.
+A comma-delimited list of enabled server plugins. Currently available
+plugins are Actions, Base, Bundler, Cfg, DBStats, Deps, Git, Hostbase,
+Packages, Pkgmgr, Rules, SGenshi, Snapshots, SSHbase, Svn, TCheetah, and
+TGenshi.
 
 .TP
 .B bundles
@@ -45,26 +44,34 @@ A list of enabled bundles
 
 .TP
 .B filemonitor
-The file monitor used to watch for changes in the repository. Values of 'gamin', 'fam', or 'pseudo' are valid.
+The file monitor used to watch for changes in the repository.
+Values of 'gamin', 'fam', or 'pseudo' are valid.
+
 
 .SH CLIENT OPTIONS
-These options only affect client functionality, specified in the [client] section.
+These options only affect client functionality, specified in the
+[client] section.
 
 .TP
 .B drivers
 Specify tool driver set to use. This option can be used to explicitly
 specify the client tool drivers you want to use when the client is run.
 
+
 .SH STATISTICS OPTIONS
-Server-only, specified in the [statistics] section. These options control the statistics collection functionality of the server.
+Server-only, specified in the [statistics] section. These options
+control the statistics collection functionality of the server.
 
 .TP
 .B database_engine
-The database engine used by the statistics module. One of either 'postgresql', 'mysql', 'sqlite3', or 'ado_mssql'.
+The database engine used by the statistics module. One of
+either 'postgresql', 'mysql', 'sqlite3', or 'ado_mssql'.
 
 .TP
 .B database_name
-The name of the database to use for statistics data. If 'database_engine' is set to 'sqlite3' this is a file path to sqlite file and defaults to $REPOSITORY_DIR/etc/brpt.sqlite
+The name of the database to use for statistics data. If 'database_engine'
+is set to 'sqlite3' this is a file path to sqlite file and defaults to
+$REPOSITORY_DIR/etc/brpt.sqlite
 
 .TP
 .B database_user
@@ -82,16 +89,21 @@ Host for database connections. Not used for sqlite3.
 .B database_port
 Port for database connections. Not used for sqlite3.
 
+
 .SH COMMUNICATION OPTIONS
-Specified in the [communication] section. These options define settings used for client-server communication.
+Specified in the [communication] section. These options define settings
+used for client-server communication.
 
 .TP
 .B password
-Required on both the server and clients. On the server, sets the password clients need to use to communicate. On a client, sets the password to use to connect to the server.
+Required on both the server and clients. On the server, sets the
+password clients need to use to communicate. On a client, sets the
+password to use to connect to the server.
 
 .TP
 .B key
-A server-only option. The file system path to the server's SSL key. Required if using xmlrpc/ssl for communication.
+A server-only option. The file system path to the server's SSL key.
+Required if using xmlrpc/ssl for communication.
 
 .TP
 .B protocol
@@ -111,25 +123,45 @@ A client-only option. The UUID of the client.
 
 .TP
 .B fingerprint
-A client-only option. The fingerprint of the server's SSL certificate. Obtainable by running 'bcfg2-admin fingerprint'.
+A client-only option. The fingerprint of the server's SSL certificate.
+Obtainable by running 'bcfg2-admin fingerprint'.
+
 
 .SH COMPONENT OPTIONS
 Specified in the [components] section.
 
 .TP
 .B bcfg2
-URL of the server. On the server this specifies which interface and port the server listens on. On the client, this specifies where the client will attempt to contact the server. eg: bcfg2 = https://10.3.1.6:6789 
+URL of the server. On the server this specifies which interface and
+port the server listens on. On the client, this specifies where the
+client will attempt to contact the server. eg:
+bcfg2 = https://10.3.1.6:6789
 
 .TP
 .B encoding
-Text encoding of configuration files. Defaults to the system default encoding.
+Text encoding of configuration files. Defaults to the system default
+encoding.
+
 
 .SH LOGGING OPTIONS
-Specified in the [logging] section. These options control the server logging functionality.
+Specified in the [logging] section. These options control the server
+logging functionality.
 
 .B path
 Server log file path.
 
+
+.SH SNAPSHOTS OPTIONS
+Specified in the [snapshots] section. These options control the server
+snapshots functionality.
+
+.B driver
+sqlite
+
+.B database
+The name of the database to use for statistics data. eg:
+$REPOSITORY_DIR/etc/bcfg2.sqlite
+
 .SH SEE ALSO
 .BR bcfg2(1),
 .BR bcfg2-server(8)