diff --git a/docs/source/guides/admin-guides/references/index.rst b/docs/source/guides/admin-guides/references/index.rst index 4299d1549..2218a340a 100644 --- a/docs/source/guides/admin-guides/references/index.rst +++ b/docs/source/guides/admin-guides/references/index.rst @@ -26,7 +26,7 @@ The following tools are shipped with xCAT and have been contributed by various x .. toctree:: - :maxdepth:1 + :maxdepth: 1 tools/detect_dhcpd.rst tools/mac2linklocal.rst diff --git a/docs/source/guides/admin-guides/references/man1/switchdiscover.1.rst b/docs/source/guides/admin-guides/references/man1/switchdiscover.1.rst index 7c6d616eb..de604d36a 100644 --- a/docs/source/guides/admin-guides/references/man1/switchdiscover.1.rst +++ b/docs/source/guides/admin-guides/references/man1/switchdiscover.1.rst @@ -168,9 +168,8 @@ FILES /opt/xcat/bin/switchdiscover -********* +******** SEE ALSO - -********* +******** diff --git a/docs/source/guides/admin-guides/references/man1/xdsh.1.rst b/docs/source/guides/admin-guides/references/man1/xdsh.1.rst index 817dc0c04..6ef3f6915 100644 --- a/docs/source/guides/admin-guides/references/man1/xdsh.1.rst +++ b/docs/source/guides/admin-guides/references/man1/xdsh.1.rst @@ -111,13 +111,7 @@ DSH_PATH=$PATH The \ **-E**\ flag exports a local environment definition file to each remote target. Environment variables specified in this file are defined in the remote shell environment before the \ *command_list*\ is executed. -The definition file should contain entries like the following and be executable. One environment variable per line. - - -.. code-block:: perl - - export NEWENVVARIABLE="yes" - export ANOTHERENVVARIABLE="yes" +The file should be executable and contain one environment variable per line. \ **COMMAND**\ \ **EXECUTION**\ : @@ -206,7 +200,8 @@ running commands, are terminated (SIGTERM). This flag will have xdsh remove all files from the subdirectories of the the directory on the servicenodes, where xdcp stages the copy to the compute nodes as defined in the site table SNsyncfiledir and nodesyncfiledir - attribute, when the target is a service node. + attribute, when the target is a service node. + It can also be used to remove the nodesyncfiledir directory on the compute nodes, which keeps the backup copies of files for the xdcp APPEND function support, if a compute node is the target. @@ -283,6 +278,7 @@ running commands, are terminated (SIGTERM). Set up the SSH keys for the user running the command to the specified node list. The userid must have the same uid, gid and password as the userid on the node where the keys will be setup. + If the current user is root, roots public ssh keys will be put in the authorized_keys\* files under roots .ssh directory on the node(s). If the current user is non-root, the user must be in the policy table and have credential to run the xdsh command. diff --git a/docs/source/guides/admin-guides/references/man8/xcatdebug.8.rst b/docs/source/guides/admin-guides/references/man8/xcatdebug.8.rst index b964fd672..9b786f0be 100644 --- a/docs/source/guides/admin-guides/references/man8/xcatdebug.8.rst +++ b/docs/source/guides/admin-guides/references/man8/xcatdebug.8.rst @@ -14,12 +14,13 @@ NAME \ **xcatdebug**\ - Enable or disable the trace facilities for xCAT. (Only supports Linux Operating System) -**************************************************************************************************************************************************************************** +******** SYNOPSIS -\ **xcatdebug**\ { [\ **-f enable**\ | \ **disable**\ [\ **-c**\ {\ *configuration file*\ | \ *subroutine list*\ }]] | [ \ **-d enable**\ | \ **disable**\ ]} -**************************************************************************************************************************************************************************** +******** +\ **xcatdebug**\ { [\ **-f enable**\ | \ **disable**\ [\ **-c**\ {\ *configuration file*\ | \ *subroutine list*\ }]] | [ \ **-d enable**\ | \ **disable**\ ]} + *********** DESCRIPTION diff --git a/xCAT-client/pods/man1/switchdiscover.1.pod b/xCAT-client/pods/man1/switchdiscover.1.pod index 673b8ff69..ffca87876 100755 --- a/xCAT-client/pods/man1/switchdiscover.1.pod +++ b/xCAT-client/pods/man1/switchdiscover.1.pod @@ -116,5 +116,5 @@ To use lldp method to discover the switches: /opt/xcat/bin/switchdiscover - =head1 SEE ALSO + diff --git a/xCAT-client/pods/man1/xdsh.1.pod b/xCAT-client/pods/man1/xdsh.1.pod index 88c3a61dd..6693e4795 100644 --- a/xCAT-client/pods/man1/xdsh.1.pod +++ b/xCAT-client/pods/man1/xdsh.1.pod @@ -94,10 +94,7 @@ DSH_PATH=$PATH The B<-E> flag exports a local environment definition file to each remote target. Environment variables specified in this file are defined in the remote shell environment before the I is executed. -The definition file should contain entries like the following and be executable. One environment variable per line. - - export NEWENVVARIABLE="yes" - export ANOTHERENVVARIABLE="yes" +The file should be executable and contain one environment variable per line. B B: @@ -181,6 +178,7 @@ This flag will have xdsh remove all files from the subdirectories of the the directory on the servicenodes, where xdcp stages the copy to the compute nodes as defined in the site table SNsyncfiledir and nodesyncfiledir attribute, when the target is a service node. + It can also be used to remove the nodesyncfiledir directory on the compute nodes, which keeps the backup copies of files for the xdcp APPEND function support, if a compute node is the target. @@ -242,6 +240,7 @@ normally the Management Node. The command you run must not prompt for input, the Set up the SSH keys for the user running the command to the specified node list. The userid must have the same uid, gid and password as the userid on the node where the keys will be setup. + If the current user is root, roots public ssh keys will be put in the authorized_keys* files under roots .ssh directory on the node(s). If the current user is non-root, the user must be in the policy table and have credential to run the xdsh command. diff --git a/xCAT-client/pods/man8/xcatdebug.8.pod b/xCAT-client/pods/man8/xcatdebug.8.pod index 0fcdfaf0f..18452555e 100644 --- a/xCAT-client/pods/man8/xcatdebug.8.pod +++ b/xCAT-client/pods/man8/xcatdebug.8.pod @@ -3,6 +3,7 @@ B - Enable or disable the trace facilities for xCAT. (Only supports Linux Operating System) =head1 SYNOPSIS + B { [B<-f enable> | B [B<-c> {I | I}]] | [ B<-d enable> | B]} =head1 DESCRIPTION