From 6f64e71fc628cf059d0bbd0af5462161e339c393 Mon Sep 17 00:00:00 2001 From: Narayan Desai Date: Fri, 10 Feb 2006 22:48:40 +0000 Subject: Man page updates git-svn-id: https://svn.mcs.anl.gov/repos/bcfg/trunk/bcfg2@1729 ce84e21b-d406-0410-9b95-82705330c041 --- man/bcfg2-info.8 | 9 +++++- man/bcfg2-repo-validate.8 | 2 +- man/bcfg2-server.8 | 25 +++++++++++------ man/bcfg2.1 | 71 ++++++++++++++++++++++++++--------------------- 4 files changed, 65 insertions(+), 42 deletions(-) diff --git a/man/bcfg2-info.8 b/man/bcfg2-info.8 index a71bc21a4..f500bfa00 100644 --- a/man/bcfg2-info.8 +++ b/man/bcfg2-info.8 @@ -3,12 +3,19 @@ bcfg2-info \- Creates a local version of the bcfg2 server core for state observation .SH SYNOPSIS -.B bcfg2-info +.B bcfg2-info [-c ] .SH DESCRIPTION .PP .B bcfg2-info Instantiate an instance of the Bcfg2 core for data examination and debugging purposes. +.SH OPTIONS +.PP +.B "\-c " +.RS +Specify an alternative location for bcfg2.conf. (Default +/etc/bcfg2.conf) +.RE .SH "SEE ALSO" .BR bcfg2(1), .BR bcfg2-server(8) diff --git a/man/bcfg2-repo-validate.8 b/man/bcfg2-repo-validate.8 index cebcbd301..7d61b0cde 100644 --- a/man/bcfg2-repo-validate.8 +++ b/man/bcfg2-repo-validate.8 @@ -3,7 +3,7 @@ bcfg2-repo-validate \- Check Bcfg2 repository data against data schemas .SH SYNOPSIS .B bcfg2-repo-validate -.I [ Repository Location ] [ Schema Location ] +.I [-v] [ Repository Location ] [ Schema Location ] .SH DESCRIPTION .PP .B bcfg2-repo-validate diff --git a/man/bcfg2-server.8 b/man/bcfg2-server.8 index 3274638c6..4e545cf30 100644 --- a/man/bcfg2-server.8 +++ b/man/bcfg2-server.8 @@ -10,15 +10,24 @@ bcfg2-server \- Server for client configuration specifications This daemon serves configurations to clients based on the data in its repository. .SH OPTIONS -.TP -.B \-d run bcfg2 in debug mode. -.TP -.B \-v run bcfg2 in verbose mode. -.TP -.B \-C Statically set client. Useful for debugging problems with +.PP +.B \-d +.RS +Run bcfg2 in debug mode. +.RE +.B \-v +.RS +Run bcfg2 in verbose mode. +.RE +.B "\-C " +.RS +Statically set client. Useful for debugging problems with particular client's configs. -.TP -.B \-D Daemonize, placing the program pid in the specified pidfile +.RE +.B \-D +.RS +Daemonize, placing the program pid in the specified pidfile. +.RE .SH "SEE ALSO" .BR bcfg2(1), .BR bcfg2-repo-validate(8) diff --git a/man/bcfg2.1 b/man/bcfg2.1 index 0df0e7e65..c065c3afa 100644 --- a/man/bcfg2.1 +++ b/man/bcfg2.1 @@ -15,42 +15,49 @@ client state, attempting to install the desired configuration, and finally uploading statistics about the bcfg2 execution and client state. .SH OPTIONS -.TP -.B \-d run bcfg2 in debug mode. -.TP -.B \-v run bcfg2 in verbose mode. -.TP -.B \-P run bcfg2 in paranoid mode. Diffs will be logged for +.PP +.B "\-d" +.RS +Run bcfg2 in debug mode. +.RE +.B "\-v" +.RS +Run bcfg2 in verbose mode. +.RE +.B "\-b " +.RS +Run bcfg2 against only one bundle in the configuration. +.RE +.B "\-P" +.RS +Run bcfg2 in paranoid mode. Diffs will be logged for configuration files marked as paranoid by the Bcfg2 server. -.TP -.B \-q run bcfg2 in quick mode. Package checksum verification won't be +.RE +.B "\-q" +.RS +Run bcfg2 in quick mode. Package checksum verification won't be performed. This mode relaxes the constraints of correctness, and thus should only be used in safe conditions. -.TP -.B \-n run bcfg2 in dry-run mode. No changes will be made to the +.RE +.B "\-n" +.RS +Run bcfg2 in dry-run mode. No changes will be made to the system. -.TP -.B \-B run bcfg2 in build mode. Services aren't started, as the system +.RE +.B "\-B" +.RS +Run bcfg2 in build mode. Services aren't started, as the system may still be in miniroot. -.TP -.B \-r make bcfg2 remove extra configuration elements it -detects. Mode is one of all, svcs, or pkgs. All removes all -entries. Likewise, services and packages remove only the extra -configuration elements of the respective type. -.TP -.B \-i image specify image for client -.TP -.B \-p profile specify profile for client -.TP -Remove extra configuration located by two way verification. Removal -mode is one of all, packages, or services. (Services are currently -unimplemented under Debian. Nothing is currently supported under redhat) -.B \-p assert profile for client. -.TP -.B \-i assert image for client. +.RE +.B "\-r " +.RS +Cause bcfg2 to remove extra configuration elements it detects. Mode is one of all, svcs, or pkgs. All removes all entries. Likewise, services and packages remove only the extra configuration elements of the respective type. +.RE +.B "\-p " +.RS +Assert a profile for the current client. +.RE .SH "SEE ALSO" -.BR Bcfg2Server(8), -.BR Bcfg2Ctl(8) +.BR bcfg2-server(8), +.BR bcfg2-info(8) .SH "BUGS" -Two way removal mode is only implemented for packages under -Debian. All other types are not yet implemented. \ No newline at end of file -- cgit v1.2.3-1-g7c22