update bcfg2-admin man pages

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

1 files changed, 93 insertions, 17 deletions

diff --git a/man/bcfg2-admin.8 b/man/bcfg2-admin.8
index c25c14e1c..d657f6dbf 100644
--- a/man/bcfg2-admin.8
+++ b/man/bcfg2-admin.8
@@ -1,45 +1,46 @@
-.TH "bcfg2-admin" 8
+		.TH "bcfg2-admin" 8
 .SH NAME
 bcfg2-admin \- Perform repository administration tasks
 .SH SYNOPSIS
 .B bcfg2-admin
-.I init
-.I client <action> <client>
-.I query [g=group] [p=profile] [-f output-file] [-n] [-c]
-.I compare <old> <new>
-.I minestruct <client> [-g groups] [-f output-file]
-.I pull <client> <entry type> <entry name>
-.I tidy
-.I viz [-h] [-b] [-k] [-o output.png] [-r]
-
+.I [-C config-file]
+.I <mode>
+.I <mode args>
+.I <mode options>
 .SH DESCRIPTION
 .PP
 .B bcfg2-admin
 Perform bcfg2 repository administration
+.SH OPTIONS
+.PP
+.B -C <config-file>
+.RS
+Specify the location of the configuration file (if it is not in /etc/bcfg2.conf)
+.RE
 .SH MODES
 .PP 
 .B init
 .RS
 Initialize a new repository (interactive)
 .RE
-.B client
+.B client <action> <client> [attribute=value]
 .RS
 Add or remove clients from metadata
 .RE
-.B query
+.B query [g=group] [p=profile] [-f output-file] [-n] [-c]
 .RS
 Search for clients based on group or profile
 .RE
-.B compare
+.B compare <old> <new>
 .RS
 Compare two client configurations. Can be used to verify consistent
 behavior between releases
 .RE
-.B minestruct
+.B minestruct <client> [-f xml-file] [-g groups]
 .RS
 Build structure entries based on client statistics extra entries
 .RE
-.B pull
+.B pull <client> <entry-type> <entry-name>
 .RS
 Install configuration information into repo based on client bad
 entries
@@ -48,10 +49,84 @@ entries
 .RS
 Remove unused files from repository
 .RE
-.B viz
+.B viz [-h] [-b] [-k] [-o png-file] [-r]
 .RS
 Create a graphviz diagram of client, group and bundle information
 .RE
+.SH CLIENT OPTIONS
+.PP
+.B \mode
+.RS
+Add a client 'add' or delete a client 'del'
+.RE
+.B \client
+.RS
+Specify the client's name
+.RE
+.B \attribute=value
+.RS
+Set attribute values when adding a new client
+.RE
+.SH QUERY OPTIONS
+.PP
+.B \g=group
+.RS
+Specify a group to search within
+.RE
+.B \p=profile
+.RS
+Specify a profile to search within
+.RE
+.B \-f <output-file>
+.RS
+Write the results of the query to a file
+.RE
+.B \-n
+.RS
+Print the results, one on each line
+.RE
+.B \-c
+.RS
+Print the results, separated by commas
+.RE
+.SH COMPARE OPTIONS
+.PP
+.B \old
+.RS
+Specify the location of the old configuration file
+.RE
+.B \new
+.RS
+Specify the location of the new configuration file
+.RE
+.SH MINESTRUCT OPTIONS
+.PP
+.B \client
+.RS
+Client whose metadata is to be searched for extra entries
+.RE
+.B \-g <groups>
+.RS
+Hierarchy of groups in which to place the extra entries in
+.RE
+.B \-f <xml-output-file>
+.RS
+Specify the xml file in which to write the extra entries
+.RE
+.SH PULL OPTIONS
+.PP
+.B \client
+.RS
+Specify the name of the client to search for
+.RE
+.B \entry-type
+.RS
+Specify the type of the entry to pull
+.RE
+.B \entry-name
+.RS
+Specify the name of the entry to pull
+.RE
 .SH VIZ OPTIONS
 .PP
 .B \-h
@@ -62,7 +137,7 @@ Include hosts in diagram
 .RS
 Include bundles in diagram
 .RE
-.B "-o <output file>"
+.B \-o <output file>
 .RS
 Write to outfile file instead of stdout
 .RE
@@ -74,3 +149,4 @@ Produce raw graphviz output
 .RS
 Add a shape/color key
 .RE
+