2
0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-05-21 19:22:05 +00:00

Fix usage and example for replaycons command

This commit is contained in:
Mark Gurevich 2020-08-06 11:07:56 -04:00
parent fa1b49799a
commit f575439489
3 changed files with 11 additions and 11 deletions

View File

@ -19,7 +19,7 @@ SYNOPSIS
********
\ **replaycons**\ [\ *node*\ ] [\ *bps*\ ] [\ *tail_amount*\ ]
\ **replaycons**\ \ *node log file*\ [\ *bps*\ ] [\ *tail_amount*\ ]
\ **replaycons**\ [\ **-h**\ | \ **-**\ **-help**\ | \ **-v**\ | \ **-**\ **-version**\ ]
@ -31,9 +31,9 @@ DESCRIPTION
The \ **replaycons**\ command reads the console log stored by conserver for this node, and displays it
in a way that simulates the original output of the console. Using the \ *bps*\ value, it will throttle
the speed of the output play back. (The conserver logs are stored in /var/log/consoles.)
the speed of the output play back. (The logs are stored in /var/log/consoles.)
For now, replaycons must be run locally on the system on which the console log is stored. This is normally
\ **replaycons**\ must be run locally on the system on which the console log is stored. This is normally
that management node, but in a hierarchical cluster will usually be the service node.
@ -51,7 +51,7 @@ OPTIONS
\ *tail_amount*\
The place in the console log file to start play back, specified as the # of lines from the end.
The place in the console log file to start play back, specified as the number of lines from the end.
@ -96,7 +96,7 @@ EXAMPLES
.. code-block:: perl
replaycons 19200 2000
replaycons node1.log 19200 2000

View File

@ -5,7 +5,7 @@ B<replaycons> - replay the console output for a node
=head1 SYNOPSIS
B<replaycons> [I<node>] [I<bps>] [I<tail_amount>]
B<replaycons> I<node log file> [I<bps>] [I<tail_amount>]
B<replaycons> [B<-h> | B<--help> | B<-v> | B<--version>]
@ -14,9 +14,9 @@ B<replaycons> [B<-h> | B<--help> | B<-v> | B<--version>]
The B<replaycons> command reads the console log stored by conserver for this node, and displays it
in a way that simulates the original output of the console. Using the I<bps> value, it will throttle
the speed of the output play back. (The conserver logs are stored in /var/log/consoles.)
the speed of the output play back. (The logs are stored in /var/log/consoles.)
For now, replaycons must be run locally on the system on which the console log is stored. This is normally
B<replaycons> must be run locally on the system on which the console log is stored. This is normally
that management node, but in a hierarchical cluster will usually be the service node.
@ -30,7 +30,7 @@ The display rate to use to play back the console output. Default is 19200.
=item I<tail_amount>
The place in the console log file to start play back, specified as the # of lines from the end.
The place in the console log file to start play back, specified as the number of lines from the end.
=item B<-v|--version>
@ -64,7 +64,7 @@ An error has occurred.
To replay the console for node1 at the default rate, starting 2000 lines from the end:
replaycons 19200 2000
replaycons node1.log 19200 2000
=back

View File

@ -17,7 +17,7 @@ use Getopt::Long;
my $usage_string =
"Usage:
replaycons node [bps] [tail]
replaycons node_log [bps] [tail]
replaycons -h|--help
replaycons -v|--version
bps Specifies the display rate.