Skip to content
Snippets Groups Projects
Commit 55ddf605 authored by Don Lipari's avatar Don Lipari Committed by Morris Jette
Browse files

smap man page: clarify use of interactive mode and other minor mods

parent e3d2b258
No related branches found
No related tags found
No related merge requests found
......@@ -9,7 +9,7 @@ configurations parameters.
.SH "DESCRIPTION"
\fBsmap\fR is used to graphically view job, partition and node information
for a system running SLURM.
Note that information about nodes and partitions to which a user lacks
Note that information about nodes and partitions to which you lack
access will always be displayed to avoid obvious gaps in the output.
This is equivalent to the \fB\-\-all\fR option of the \fBsinfo\fR and
\fBsqueue\fR commands.
......@@ -21,20 +21,21 @@ Print output to the commandline, no curses.
.TP
\fB\-D <option>\fR, \fB\-\-display=<option>\fR
sets the display mode for smap. Showing revelant information about specific
views and displaying a corresponding node chart. While in any
display a user can switch by typing a different view letter. This is true in
all modes except for 'configure mode' user can type 'quit' to exit just
configure mode. Typing 'exit' will end the configuration mode and exit smap.
Note that unallocated nodes are indicated by a '.' and nodes in the
DOWN, DRAINED or FAIL state by a '#'.
sets the display mode for smap, showing revelant information about the
selected view and displaying a corresponding node chart. Note that
unallocated nodes are indicated by a '.' and nodes in the DOWN,
DRAINED or FAIL state by a '#'. When the \fB\-\-iterate=<seconds>\fR
option is also selected, you can switch displays by typing a different
letter from the list below (except 'c').
.RS
.TP 15
.I "b"
Displays information about BlueGene partitions on the system
.TP
.I "c"
Displays current BlueGene node states and allows users to configure the system.
Displays current BlueGene node states and allows users to configure
the system. Type 'quit' to end the configure mode. Type 'exit' to
end the configuration mode and exit smap.
.TP
.I "j"
Displays information about jobs running on system.
......@@ -107,16 +108,16 @@ Print a brief message listing the \fBsmap\fR options.
Print version information and exit.
.SH "INTERACTIVE OPTIONS"
When using smap in curses mode you can scroll through the different windows
When using smap in curses mode and when the \fB\-\-iterate=<seconds>\fR
option is also selected, you can scroll through the different windows
using the arrow keys. The \fBup\fR and \fBdown\fR arrow keys scroll
the window containing the grid, and the \fBleft\fR and \fBright\fR arrow keys
scroll the window containing the text information.
To change screens when an iterate is set you can use any of the
options available to the \fB\-D\fR option listed above.
You can also hide or make visible hidden partitions by pressing
\fBh\fR at any moment when an iterate is set.
With the iterate option selected, you can use any of the options
available to the \fB\-D\fR option listed above (except 'c') to change
screens. You can also hide or make visible hidden partitions by
pressing 'h' at any moment.
.SH "OUTPUT FIELD DESCRIPTIONS"
.TP
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment