From c2196a6aa9a9cd15795baf7c4537a0b585daee06 Mon Sep 17 00:00:00 2001
From: Sol Jerome <solj@ices.utexas.edu>
Date: Tue, 4 May 2010 16:40:35 +0000
Subject: man: Add bcfg2-info updates from Fabian Affolter (Resolves Ticket
 #610)

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

git-svn-id: https://svn.mcs.anl.gov/repos/bcfg/trunk/bcfg2@5854 ce84e21b-d406-0410-9b95-82705330c041
---
 man/bcfg2-info.8 | 105 ++++++++++++++++++++++++++++++++++++++++++++++++++++---
 man/bcfg2.1      |   7 ++--
 2 files changed, 104 insertions(+), 8 deletions(-)

(limited to 'man')

diff --git a/man/bcfg2-info.8 b/man/bcfg2-info.8
index dd14a908b..8fbba12e2 100644
--- a/man/bcfg2-info.8
+++ b/man/bcfg2-info.8
@@ -3,7 +3,11 @@
 bcfg2-info \- Creates a local version of the bcfg2 server core for
 state observation
 .SH SYNOPSIS
-.B bcfg2-info [-C <config file>] [-h]
+.B bcfg2-info
+.I [\-C <config file>] [\-E <encoding>] [\-Q <repository path>] [\-h] [\-p] [\-x <password>]
+.I <mode>
+.I <mode args>
+.I <mode options>
 .SH DESCRIPTION
 .PP
 .B bcfg2-info
@@ -13,14 +17,107 @@ debugging purposes.
 .PP
 .B "\-C <config file>"
 .RS
-Specify an alternative location for bcfg2.conf. (Default
-/etc/bcfg2.conf)
+Specify the location of the configuration file (if it is not in /etc/bcfg2.conf).
+.RE
+.B "\-E <encoding>"
+.RS
+Specify the encoding of cfg files.
+.RE
+.B "\-Q <repository path>
+.RS
+Specify the server repository path.
+.RE
+.B "\-d"
+.RS
+Run in debug mode.
 .RE
-.B "\-h
+.B "\-h"
 .RS
 Give a bit of help about the command line arguments and
 options. After this bcfg2-info exits.
 .RE
+.B "\-p"
+.RS
+Specify a profile.
+.RE
+.B "\-x <password>"
+.RS
+Set the communication password.
+.RE
+.SH MODES
+.PP
+.B build <hostname> <filename>
+.RS
+Build config for hostname, writing to filename
+.RE
+.B builddir <hostname> <dirname>
+.RS
+Build config for hostname, writing separate files to dirname
+.RE
+.B buildall <directory>
+.RS
+Build configs for all clients in directory
+.RE
+.B buildfile <filename> <hostname>
+.RS
+Build config file for hostname (not written to disk)
+.RE
+.B bundles
+.RS
+Print out group/bundle information
+.RE
+.B clients
+.RS
+Print out client/profile information
+.RE
+.B debug
+.RS
+Shell out to native python interpreter
+.RE
+.B event_debug
+.RS
+Display filesystem events as they are processed
+.RE
+.B generators
+.RS
+List current versions of generators
+.RE
+.B groups
+.RS
+List groups
+.RE
+.B help
+.RS
+Print the list of available commands
+.RE
+.B mappings <type*> <name*>
+.RS
+Print generator mappings for optional type and name
+.RE
+.B profile <command> <args>
+.RS
+Profile a single bcfg2-info command
+.RE
+.B quit
+.RS
+Exit bcfg2-info command line
+.RE
+.B showentries <hostname> <type>
+.RS
+Show abstract configuration entries for a given host
+.RE
+.B showclient <client1> <client2>
+.RS
+Show metadata for given hosts.
+.RE
+.B update
+.RS
+Process pending file events
+.RE
+.B version
+.RS
+Print version of this tool
+.RE
 .SH "SEE ALSO"
 .BR bcfg2(1),
 .BR bcfg2-server(8)
diff --git a/man/bcfg2.1 b/man/bcfg2.1
index 174f4d5a6..e49e6d415 100644
--- a/man/bcfg2.1
+++ b/man/bcfg2.1
@@ -3,8 +3,7 @@
 bcfg2 \- reconfigure machine based on settings in BCFG2
 .SH SYNOPSIS
 .B bcfg2
-.I [\-d] [\-v] [\-p] [\-c cache file] [\-e] [\-f config file] [\-I] [\-q] [\-b bundle]
-[\-r removal mode]
+.I [\-d] [\-v] [\-p] [\-c cache file] [\-e] [\-f config file] [\-I] [\-q] [\-b bundle] [\-r removal mode]
 .SH DESCRIPTION
 .TP
 .BR bcfg2
@@ -80,7 +79,7 @@ Daemonize the agent.
 .TP 
 .BR "\-k" 
 Run in bulletproof mode. This currently only affects behavior in the
-debian toolset; it calls apt-get update and clean and dpkg \-\-configure \-\-pending.
+debian toolset; it calls apt\-get update and clean and dpkg \-\-configure \-\-pending.
 .TP
 .BR "\-l <whitelist|blacklist>"
 Run the client in the server decision list mode. This approach is needed
@@ -92,7 +91,7 @@ management, these issues typically crop up in environments with several
 administrators and much configuration variety.
 .TP
 .BR "\-n"
-Run bcfg2 in dry-run mode. No changes will be made to the
+Run bcfg2 in dry\-run mode. No changes will be made to the
 system. 
 .TP
 .BR "\-o <LogFile Path>"
-- 
cgit v1.2.3-1-g7c22