    \fBsmap\fR [\fIOPTIONS\fR...]
    .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 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.

    .SH "OPTIONS"
    .TP
    \fB\-c\fR, \fB\-\-commandline\fR
    Print output to the commandline, no curses.

    .TP
    \fB\-D <option>\fR, \fB\-\-display=<option>\fR
    sets the display mode for smap, showing relevant 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.
    .RS
    .TP
    .I "j"
    Displays information about jobs running on system.
    .TP
    .I "r"
    Display information about advanced reservations.
    While all current and future reservations will be listed,
    only currently active reservations will appear on the node map.
    .TP
    .I "s"
    Displays information about slurm partitions on the system
    .RE

    .TP
    \fB\-h\fR, \fB\-\-noheader\fR
    Do not print a header on the output.

    .TP
    \fB\-H\fR, \fB\-\-show_hidden\fR
    Display hidden partitions and their jobs.

    .TP
    \fB\-\-help\fR,
    Print a message describing all \fBsmap\fR options.

    .TP
    \fB\-i <seconds>\fR , \fB\-\-iterate=<seconds>\fR
    Print the state on a periodic basis.
    Sleep for the indicated number of seconds between reports.
    \fB\-Q\fR, \fB\-\-quiet\fR
    Avoid printing error messages.

    .TP
    \fB\-\-usage\fR
    Print a brief message listing the \fBsmap\fR options.

    .TP
    \fB\-V\fR , \fB\-\-version\fR
    Print version information and exit.

    .SH "INTERACTIVE OPTIONS"
    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.

    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
    \fBACCESS_CONTROL\fR
    Identifies the users or bank accounts which can use this advanced reservation.
    A prefix of "A:" indicates that the following account names may use this reservation.
    A prefix of "U:" indicates that the following user names may use this reservation.
    .TP
    \fBAVAIL\fR
    Partition state: \fBup\fR or \fBdown\fR.
    .TP
    \fBEND_TIME\fR
    The time when an advanced reservation ended.
    .TP
    \fBID\fR
    Key to identify the nodes associated with this entity in the node chart.
    .TP
    \fBNAME\fR
    Name of the job or advanced reservation.
    .TP
    \fBNODELIST\fR
    Names of nodes associated with this configuration, partition or reservation.
    .TP
    \fBNODES\fR
    Count of nodes with this particular configuration.
    .TP
    \fBPARTITION\fR
    Name of a partition.  Note that the suffix "*" identifies the
    default partition.
    .TP
    their abbreviated forms: alloc, comp, down, drain, drng,
    fail, failg, idle, and unk respectively.
    Note that the suffix "*" identifies nodes that are presently
    not responding.
    See \fBNODE STATE CODES\fR section below for more information.
    .TP
    \fBTIMELIMIT\fR
    Maximum time limit for any user job in
    days\-hours:minutes:seconds.  \fBinfinite\fR is used to identify
    jobs or partitions without a job time limit.
    .TP

    .SH "TOPOGRAPHY INFORMATION"
    .PP
    The node chart is designed to indicate relative locations of
    the nodes.
    On most Linux clusters this will represent a one\-dimensional
    array of nodes. Larger clusters will utilize multiple as needed
    with right side of one line being logically followed by the
    left side of the next line.

    .SH "NODE STATE CODES"
    .PP
    Node state codes are shortened as required for the field size.
    These node states may be followed by a special character to identify
    state flags associated with the node.
    The following node sufficies and states are used:
    .TP 4
    \fB*\fR
    The node is presently not responding and will not be allocated
    any new work.  If the node remains non\-responsive, it will
    be placed in the \fBDOWN\fR state (except in the case of
    \fBCOMPLETING\fR, \fBDRAINED\fR, \fBDRAINING\fR,
    \fBFAIL\fR, \fBFAILING\fR nodes).
    .TP
    \fB~\fR
    The node is presently in a power saving mode (typically
    running at reduced frequency).
    .TP
    \fB#\fR
    The node is presently being powered up or configured.
    .TP
    \fB$\fR
    The node is currently in a reservation with a flag value of "maintenance".
    .TP
    \fB@\fR
    The node is pending reboot.
    .TP 12
    \fBALLOCATED\fR
    The node has been allocated to one or more jobs.
    .TP
    \fBALLOCATED+\fR
    administrators may also explicitly place nodes in this state. If
    a node resumes normal operation, Slurm can automatically
    return it to service. See the \fBReturnToService\fR
    and \fBSlurmdTimeout\fR parameter descriptions in the
    \fBslurm.conf\fR(5) man page for more information.
    .TP
    \fBDRAINED\fR
    The node is unavailable for use per system administrator
    request.  See the \fBupdate node\fR command in the
    \fBscontrol\fR(1) man page or the \fBslurm.conf\fR(5) man page
    for more information.
    .TP
    \fBDRAINING\fR
    The node is currently executing a job, but will not be allocated
    to additional jobs. The node state will be changed to state
    \fBDRAINED\fR when the last job on it completes. Nodes enter
    this state per system administrator request. See the \fBupdate
    node\fR command in the \fBscontrol\fR(1) man page or the
    \fBslurm.conf\fR(5) man page for more information.
    .TP
    \fBFAIL\fR
    The node is expected to fail soon and is unavailable for
    use per system administrator request.
    See the \fBupdate node\fR command in the \fBscontrol\fR(1)
    man page or the \fBslurm.conf\fR(5) man page for more information.
    .TP
    \fBFAILING\fR
    The node is currently executing a job, but is expected to fail
    soon and is unavailable for use per system administrator request.
    See the \fBupdate node\fR command in the \fBscontrol\fR(1)
    man page or the \fBslurm.conf\fR(5) man page for more information.
    .TP
    \fBIDLE\fR
    The node is not allocated to any jobs and is available for use.
    .TP
    \fBMAINT\fR
    The node is currently in a reservation with a flag value of "maintainence".
    .TP
    \fBREBOOT\fR
    The node is currently scheduled to be rebooted.
    .TP
    \fBUNKNOWN\fR
    The Slurm controller has just started and the node's state
    has not yet been determined.

    .SH "JOB STATE CODES"
    Jobs typically pass through several states in the course of their
    execution.
    The typical states are \fBPENDING\fR, \fBRUNNING\fR, \fBSUSPENDED\fR,
    \fBCOMPLETING\fR, and \fBCOMPLETED\fR.
    An explanation of each state follows.
    .TP 20
    \fBCF  CONFIGURING\fR
    Job has been allocated resources, but are waiting for them to become ready for use
    (e.g. booting).
    .TP
    \fBF   FAILED\fR
    Job terminated with non\-zero exit code or other failure condition.
    .TP
    \fBNF  NODE_FAIL\fR
    Job terminated due to failure of one or more allocated nodes.
    .TP
    \fBPD  PENDING\fR
    Sibling job (in federation) revoked.
    .TP
    \fBPR  PREEMPTED\fR
    Job terminated due to preemption.
    .TP
    \fBRV  REVOKED\fR
    Job currently has an allocation.
    .TP
    \fBR   RUNNING\fR
    Job currently has an allocation.
    .TP
    \fBSI  SIGNALING\fR
    Signal of job currently in progress.
    .TP
    \fBSO  STAGE_OUT\fR
    Staging out data after job completion.
    .TP
    \fBSE  SPECIAL_EXIT\fR
    The job was requeued in a special state. This state can be set by
    users, typically in EpilogSlurmctld, if the job has terminated with
    a particular exit value.
    .TP
    \fBST  STOPPED\fR
    Job has an allocation, but execution has been stopped with SIGSTOP signal.
    CPUS have been retained by this job.
    .TP
    \fBS   SUSPENDED\fR
    Job has an allocation, but execution has been suspended and CPUs have been
    released for other jobs.
    .TP
    \fBTO  TIMEOUT\fR
    Job terminated upon reaching its time limit.

    .SH "ENVIRONMENT VARIABLES"
    The following environment variables can be used to override settings
    compiled into smap.
    .TP 20
    \fBSLURM_CONF\fR
    The location of the Slurm configuration file.

    .SH "COPYING"
    .LP
    Slurm is distributed in the hope that it will be useful, but WITHOUT ANY
    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
    details.

    .SH "SEE ALSO"
    \fBscontrol\fR(1), \fBsinfo\fR(1), \fBsqueue\fR(1),
    \fBslurm_load_ctl_conf\fR (3), \fBslurm_load_jobs\fR (3),
    \fBslurm_load_node\fR (3),
    \fBslurm_load_partitions\fR (3),
    \fBslurm_reconfigure\fR (3), \fBslurm_shutdown\fR (3),
    \fBslurm_update_job\fR (3), \fBslurm_update_node\fR (3),
    \fBslurm_update_partition\fR (3),
    \fBslurm.conf\fR(5)