diff --git a/docs/source/guides/admin-guides/references/man1/psh.1.rst b/docs/source/guides/admin-guides/references/man1/psh.1.rst index e264a9e75..dc847a489 100644 --- a/docs/source/guides/admin-guides/references/man1/psh.1.rst +++ b/docs/source/guides/admin-guides/references/man1/psh.1.rst @@ -15,17 +15,17 @@ psh - parallel remote shell **************** -\ **Synopsis**\ +\ **Synopsis**\ **************** -\ **psh**\ [\ **-i**\ \ *interface*\ ] [\ **-f**\ \ *fanout*\ ] [\ **-l**\ \ *user*\ ] \ *noderange*\ \ *command*\ +\ **psh**\ [\ **-i**\ \ *interface*\ ] [\ **-f**\ \ *fanout*\ ] [\ **-l**\ \ *user*\ ] \ *noderange*\ \ *command*\ \ **psh**\ {\ **-h | -**\ **-help | -v | -**\ **-version**\ } ******************* -\ **Description**\ +\ **Description**\ ******************* @@ -44,129 +44,129 @@ management node to the compute node via a service node. *************** -\ **Options**\ +\ **Options**\ *************** -\ **-i**\ \ *interface*\ - +\ **-i**\ \ *interface*\ + The NIC on the node that psh should communicate with. For example, if \ *interface*\ is \ **eth1**\ , then psh will concatenate \ **-eth1**\ to the end of every node name before ssh'ing to it. This assumes those host names have been set up to resolve to the IP address of each of the eth1 NICs. - -\ **-f**\ \ *fanout*\ - + +\ **-f**\ \ *fanout*\ + Specifies a fanout value for the maximum number of concur- rently executing remote shell processes. - -\ **-l**\ \ *user*\ - + +\ **-l**\ \ *user*\ + Log into the nodes as the specified username. The default is to use the same username as you are running the psh command as. - -\ **-n|-**\ **-nonodecheck**\ - + +\ **-n|-**\ **-nonodecheck**\ + Do not send the noderange to xcatd to expand it into a list of nodes. Instead, use the noderange exactly as it is specified. In this case, the noderange must be a simple list of comma-separated hostnames of the nodes. This allows you to run \ **psh**\ even when xcatd is not running. - -\ *noderange*\ - + +\ *noderange*\ + See noderange(3)|noderange.3. - -\ *command*\ - - Command to be run in parallel. If no command is give then \ **psh**\ + +\ *command*\ + + Command to be run in parallel. If no command is give then \ **psh**\ enters interactive mode. In interactive mode a ">" prompt is displayed. Any command entered is executed in parallel to the nodes in the noderange. Use "exit" or "Ctrl-D" to end the interactive session. - -\ **-h | -**\ **-help**\ - + +\ **-h | -**\ **-help**\ + Print help. - + ************************************* -\ **Environment**\ \ **Variables**\ +\ **Environment**\ \ **Variables**\ ************************************* -\ **XCATPSHFANOUT**\ - +\ **XCATPSHFANOUT**\ + Specifies the fanout value. This variable is overridden by the \ **-f**\ flag. Default is 64. - + **************** -\ **Examples**\ +\ **Examples**\ **************** 1. Run uptime on 3 nodes: - - + + .. code-block:: perl - + psh node4-node6 uptime - - + + Output is similar to: - - + + .. code-block:: perl - + node4: Sun Aug 5 17:42:06 MDT 2001 node5: Sun Aug 5 17:42:06 MDT 2001 node6: Sun Aug 5 17:42:06 MDT 2001 - - + + 2. Run a command on some BladeCenter management modules: - - + + .. code-block:: perl - + psh amm1-amm5 'info -T mm[1]' - - + + 3. Remove the tmp files on the nodes in the 1st frame: - - + + .. code-block:: perl - + psh rack01 'rm -f /tmp/*' - - + + Notice the use of '' to forward shell expansion. This is not necessary in interactive mode. - + ************************ -\ **See**\ \ **Also**\ +\ **See**\ \ **Also**\ ************************