2
0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-05-29 09:13:08 +00:00

man page changes to remove xcatconfig without any flags and fix EXAMPLES formatting

This commit is contained in:
Mark Gurevich 2016-02-03 16:45:58 -05:00
parent e7bac264a1
commit d86989c9b5
3 changed files with 41 additions and 25 deletions

View File

@ -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.

View File

@ -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

View File

@ -4,8 +4,6 @@ B<xcatconfig> - Sets up the Management Node during the xCAT install.
=head1 SYNOPSIS
B<xcatconfig>
B<xcatconfig> {B<-h>|B<--help>}
B<xcatconfig> {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<xcatconfig> I<-f>
xcatconfig -f
=item *
=item 2.
To regenerate root's ssh keys:
B<xcatconfig> I<-k>
xcatconfig -k
=item *
=item 3.
To regenerate node host ssh keys:
B<xcatconfig> I<-s>
xcatconfig -s
=item *
=item 4.
To regenerate node host ssh keys and credentials:
B<xcatconfig> I<-s> I<-c>
xcatconfig -s -c
=item *
=item 5.
To add the Management Node to the DB:
B<xcatconfig> I<-m>
xcatconfig -m
=back