From d86989c9b579568fbb8b3d360489b9b05750d979 Mon Sep 17 00:00:00 2001 From: Mark Gurevich Date: Wed, 3 Feb 2016 16:45:58 -0500 Subject: [PATCH] man page changes to remove xcatconfig without any flags and fix EXAMPLES formatting --- .../admin-guides/references/man1/chdef.1.rst | 2 +- .../references/man8/xcatconfig.8.rst | 42 +++++++++++++------ xCAT-client/pods/man8/xcatconfig.8.pod | 22 +++++----- 3 files changed, 41 insertions(+), 25 deletions(-) diff --git a/docs/source/guides/admin-guides/references/man1/chdef.1.rst b/docs/source/guides/admin-guides/references/man1/chdef.1.rst index 2a9d0666e..295cc5d66 100644 --- a/docs/source/guides/admin-guides/references/man1/chdef.1.rst +++ b/docs/source/guides/admin-guides/references/man1/chdef.1.rst @@ -72,7 +72,7 @@ OPTIONS \ **-n**\ \ *new-name*\ Change the current object name to the new-name which is specified by the -n option. - Objects of type site and monitoring cannot be renamed with the -n option. + Objects of type site, group and monitoring cannot be renamed with the -n option. Note: For the \ **-n**\ option, only one node can be specified. For some special nodes such as fsp, bpa, frame, cec etc., their name is referenced in their own hcp attribute, or the hcp attribute of other nodes. If you use \ **-n**\ option, you must manually change all hcp attributes that refer to this name. diff --git a/docs/source/guides/admin-guides/references/man8/xcatconfig.8.rst b/docs/source/guides/admin-guides/references/man8/xcatconfig.8.rst index 131b44c00..906b5544e 100644 --- a/docs/source/guides/admin-guides/references/man8/xcatconfig.8.rst +++ b/docs/source/guides/admin-guides/references/man8/xcatconfig.8.rst @@ -19,8 +19,6 @@ SYNOPSIS ******** -\ **xcatconfig**\ - \ **xcatconfig**\ {\ **-h**\ |\ **--help**\ } \ **xcatconfig**\ {\ **-v**\ |\ **--version**\ } @@ -131,43 +129,63 @@ EXAMPLES -\* +1. To force regeneration of keys and credentials and reinitialize the site table: - \ **xcatconfig**\ \ *-f*\ + + .. code-block:: perl + + xcatconfig -f + -\* +2. To regenerate root's ssh keys: - \ **xcatconfig**\ \ *-k*\ + + .. code-block:: perl + + xcatconfig -k + -\* +3. To regenerate node host ssh keys: - \ **xcatconfig**\ \ *-s*\ + + .. code-block:: perl + + xcatconfig -s + -\* +4. To regenerate node host ssh keys and credentials: - \ **xcatconfig**\ \ *-s*\ \ *-c*\ + + .. code-block:: perl + + xcatconfig -s -c + -\* +5. To add the Management Node to the DB: - \ **xcatconfig**\ \ *-m*\ + + .. code-block:: perl + + xcatconfig -m + diff --git a/xCAT-client/pods/man8/xcatconfig.8.pod b/xCAT-client/pods/man8/xcatconfig.8.pod index fe8b07110..a2f52d67a 100644 --- a/xCAT-client/pods/man8/xcatconfig.8.pod +++ b/xCAT-client/pods/man8/xcatconfig.8.pod @@ -4,8 +4,6 @@ B - Sets up the Management Node during the xCAT install. =head1 SYNOPSIS -B - B {B<-h>|B<--help>} B {B<-v>|B<--version>} @@ -84,34 +82,34 @@ This option will set tunable parameters on the Management and Service nodes reco =over 2 -=item * +=item 1. To force regeneration of keys and credentials and reinitialize the site table: -B I<-f> + xcatconfig -f -=item * +=item 2. To regenerate root's ssh keys: -B I<-k> + xcatconfig -k -=item * +=item 3. To regenerate node host ssh keys: -B I<-s> + xcatconfig -s -=item * +=item 4. To regenerate node host ssh keys and credentials: -B I<-s> I<-c> + xcatconfig -s -c -=item * +=item 5. To add the Management Node to the DB: -B I<-m> + xcatconfig -m =back