Fix errors in the formatting of the man pages causing problems

with the conversion to rst

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

docs/source/guides/admin-guides/references/man1/switchdiscover.1.rst

@@ -168,9 +168,8 @@ FILES
 /opt/xcat/bin/switchdiscover
 
 
-*********
+********
 SEE ALSO
-
-*********
+********
 
 

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.

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

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
+

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<command_list> 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<COMMAND> B<EXECUTION>:
 
@@ -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.

xCAT-client/pods/man8/xcatdebug.8.pod

@@ -3,6 +3,7 @@
 B<xcatdebug> - Enable or disable the trace facilities for xCAT. (Only supports Linux Operating System)
 
 =head1 SYNOPSIS
+
 B<xcatdebug> { [B<-f enable> | B<disable> [B<-c> {I<configuration file> | I<subroutine list>}]] | [ B<-d enable> | B<disable>]}
 
 =head1 DESCRIPTION