    \fBsalloc\fR [\fIOPTIONS(0)\fR...] [ : [\fIOPTIONS(N)\fR...]] [\fIcommand(0)\fR [\fIargs(0)\fR...]]

    Option(s) define multiple jobs in a co-scheduled heterogeneous job.
    For more details about heterogeneous jobs see the document
    .br
    https://slurm.schedmd.com/heterogeneous_jobs.html

    .SH "DESCRIPTION"
    salloc is used to allocate a Slurm job allocation, which is a set of resources
    (nodes), possibly with some set of constraints (e.g. number of processors per
    node).  When salloc successfully obtains the requested allocation, it then runs
    the command specified by the user.  Finally, when the user specified command is
    complete, salloc relinquishes the job allocation.

    The command may be any program the user wishes.  Some typical commands are
    xterm, a shell script containing srun commands, and srun (see the EXAMPLES
    section). If no command is specified, then \fBsalloc\fR runs the user's default
    shell.

    The following document describes the influence of various options on the
    allocation of cpus to jobs and tasks.
    .br
    https://slurm.schedmd.com/cpu_management.html

    NOTE: The salloc logic includes support to save and restore the terminal line
    settings and is designed to be executed in the foreground. If you need to
    execute salloc in the background, set its standard input to some file, for
    example: "salloc \-n16 a.out </dev/null &"

    .SH "RETURN VALUE"
    If salloc is unable to execute the user command, it will
    return 1 and print errors to stderr. Else if success or if killed by signals
    HUP, INT, KILL, or QUIT: it will return 0.

    .SH "COMMAND PATH RESOLUTION"

    If provided, the command is resolved in the following order:
    .br

    1. If command starts with ".", then path is constructed as:
    current working directory / command
    .br
    2. If command starts with a "/", then path is considered absolute.
    .br
    3. If command can be resolved through PATH. See \fBpath_resolution\fR(7).
    .br
    4. If command is in current working directory.
    .P
    Current working directory is the calling process working directory unless the
    \fB\-\-chdir\fR argument is passed, which will override the current working
    directory.

    configuration file, \fIslurm.conf\fR.
    The supported format is as follows:
    .RS
    .TP 12
    \fB\-\-acctg\-freq=\fR\fI<datatype>\fR\fB=\fR\fI<interval>\fR
    where \fI<datatype>\fR=\fI<interval>\fR specifies the task sampling
    interval for the jobacct_gather plugin or a
    sampling interval for a profiling type by the
    acct_gather_profile plugin. Multiple,
    comma-separated \fI<datatype>\fR=\fI<interval>\fR intervals
    may be specified. Supported datatypes are as follows:
    .RS
    .TP
    \fBtask=\fI<interval>\fR
    where \fI<interval>\fR is the task sampling interval in seconds
    for the jobacct_gather plugins and for task
    profiling by the acct_gather_profile plugin.
    NOTE: This frequency is used to monitor memory usage. If memory limits
    are enforced the highest frequency a user can request is what is configured in
    the slurm.conf file.  They can not turn it off (=0) either.
    .TP
    \fBenergy=\fI<interval>\fR
    where \fI<interval>\fR is the sampling interval in seconds
    for energy profiling using the acct_gather_energy plugin
    .TP
    \fBnetwork=\fI<interval>\fR
    where \fI<interval>\fR is the sampling interval in seconds
    for infiniband profiling using the acct_gather_interconnect
    plugin.
    .TP
    \fBfilesystem=\fI<interval>\fR
    where \fI<interval>\fR is the sampling interval in seconds
    for filesystem profiling using the acct_gather_filesystem
    plugin.
    .TP
    .RE
    .RE
    .br
    The default value for the task sampling interval
    is 30. The default value for all other intervals is 0.
    An interval of 0 disables sampling of the specified type.
    If the task sampling interval is 0, accounting
    information is collected only at job termination (reducing Slurm
    interference with the job).
    .br
    .br
    Smaller (non\-zero) values have a greater impact upon job performance,
    but a value of 30 seconds is not likely to be noticeable for
    applications having less than 10,000 tasks.
    .RE

    .TP
    If task/affinity plugin is enabled, then specifying an allocation in this
    manner also results in subsequently launched tasks being bound to threads
    if the \fB\-B\fR option specifies a thread count, otherwise an option of
    \fIcores\fR if a core count is specified, otherwise an option of \fIsockets\fR.
    If SelectType is configured to select/cons_res, it must have a parameter of
    CR_Core, CR_Core_Memory, CR_Socket, or CR_Socket_Memory for this option
    to be honored.
    If not specified, the scontrol show job will display 'ReqS:C:T=*:*:*'. This
    option applies to job allocations.
    \fBNOTE:\fR This option is mutually exclusive with \fB\-\-hint\fR,
    \fB\-\-threads\-per\-core\fR and \fB\-\-ntasks\-per\-core\fR.

    .TP
    \fB\-\-bb\fR=<\fIspec\fR>
    Burst buffer specification. The form of the specification is system dependent.
    Note the burst buffer may not be accessible from a login node, but require
    that salloc spawn a shell on one of its allocated compute nodes.

    .TP
    \fB\-\-bbf\fR=<\fIfile_name\fR>
    Path of file containing burst buffer specification.
    The form of the specification is system dependent.
    Also see \fB\-\-bb\fR.
    Note the burst buffer may not be accessible from a login node, but require
    that salloc spawn a shell on one of its allocated compute nodes.

    .TP
    \fB\-\-begin\fR=<\fItime\fR>
    Defer eligibility of this job allocation until the specified time.

    Time may be of the form \fIHH:MM:SS\fR to run a job at
    a specific time of day (seconds are optional).
    (If that time is already past, the next day is assumed.)
    You may also specify \fImidnight\fR, \fInoon\fR, \fIfika\fR (3 PM) or
    \fIteatime\fR (4 PM) and you can have a time\-of\-day suffixed
    with \fIAM\fR or \fIPM\fR for running in the morning or the evening.
    You can also say what day the job will be run, by specifying
    a date of the form \fIMMDDYY\fR or \fIMM/DD/YY\fR
    \fIYYYY\-MM\-DD\fR. Combine date and time using the following
    format \fIYYYY\-MM\-DD[THH:MM[:SS]]\fR. You can also
    give times like \fInow + count time\-units\fR, where the time\-units
    can be \fIseconds\fR (default), \fIminutes\fR, \fIhours\fR,
    \fIdays\fR, or \fIweeks\fR and you can tell Slurm to run
    the job today with the keyword \fItoday\fR and to run the
    job tomorrow with the keyword \fItomorrow\fR.
    The value may be changed after job submission using the
    \fBscontrol\fR command.
    For example:
    .nf
       \-\-begin=16:00
       \-\-begin=now+1hour
       \-\-begin=now+60           (seconds by default)

    year is assumed, unless the combination of MM/DD and HH:MM:SS has
    already passed for that year, in which case the next year is used.
    .RE

    .TP
    \fB\-\-bell\fR
    Force salloc to ring the terminal bell when the job allocation is granted
    (and only if stdout is a tty).  By default, salloc only rings the bell
    if the allocation is pending for more than ten seconds (and only if stdout
    is a tty). Also see the option \fB\-\-no\-bell\fR.

    .TP
    \fB\-\-cluster\-constraint\fR=<\fIlist\fR>
    Specifies features that a federated cluster must have to have a sibling job
    submitted to it. Slurm will attempt to submit a sibling job to a cluster if it
    has at least one of the specified features.

    .TP
    \fB\-\-comment\fR=<\fIstring\fR>
    An arbitrary comment.

    .TP
    \fB\-C\fR, \fB\-\-constraint\fR=<\fIlist\fR>
    Nodes can have \fBfeatures\fR assigned to them by the Slurm administrator.
    Users can specify which of these \fBfeatures\fR are required by their job
    using the constraint option.
    Only nodes having features matching the job constraints will be used to
    satisfy the request.
    Multiple constraints may be specified with AND, OR, matching OR,
    resource counts, etc. (some operators are not supported on all system types).
    Supported \fbconstraint\fR options include:
    .PD 1
    .RS
    .TP
    \fBSingle Name\fR
    Only nodes which have the specified feature will be used.
    For example, \fB\-\-constraint="intel"\fR
    .TP
    \fBNode Count\fR
    A request can specify the number of nodes needed with some feature
    by appending an asterisk and count after the feature name.
    For example, \fB\-\-nodes=16 \-\-constraint="graphics*4 ..."\fR
    indicates that the job requires 16 nodes and that at least four of those
    nodes must have the feature "graphics."
    .TP
    \fBAND\fR
    If only nodes with all of specified features will be used.
    The ampersand is used for an AND operator.
    For example, \fB\-\-constraint="intel&gpu"\fR
    .TP
    \fBOR\fR
    If only nodes with at least one of specified features will be used.
    be used to specify that two nodes must be allocated from nodes with the feature
    of "rack1" and four nodes must be allocated from nodes with the feature
    "rack2".

    \fBNOTE:\fR This construct does not support multiple Intel KNL NUMA or MCDRAM
    modes. For example, while \fB\-\-constraint="[(knl&quad)*2&(knl&hemi)*4]"\fR is
    not supported, \fB\-\-constraint="[haswell*2&(knl&hemi)*4]"\fR is supported.
    Specification of multiple KNL modes requires the use of a heterogeneous job.
    .TP
    \fBBrackets\fR
    Brackets can be used to indicate that you are looking for a set of nodes with
    the different requirements contained within the brackets. For example,
    \fB--constraint="[(rack1|rack2)*1&(rack3)*2]"\fR will get you one node with
    either the "rack1" or "rack2" features and two nodes with the "rack3" feature.
    The same request without the brackets will try to find a single node that
    meets those requirements.
    .TP
    \fBParenthesis\fR
    Parenthesis can be used to group like node features together. For example,
    \fB\-\-constraint="[(knl&snc4&flat)*4&haswell*1]"\fR might be used to specify
    that four nodes with the features "knl", "snc4" and "flat" plus one node with
    the feature "haswell" are required. All options within parenthesis should be
    grouped with AND (e.g. "&") operands.
    .RE

    .TP
    \fB\-\-contiguous\fR
    If set, then the allocated nodes must form a contiguous set.

    \fBNOTE\fR: If SelectPlugin=cons_res this option won't be honored
    with the \fBtopology/tree\fR or \fBtopology/3d_torus\fR
    plugins, both of which can modify the node ordering.

    .TP
    \fB\-\-cores\-per\-socket\fR=<\fIcores\fR>
    Restrict node selection to nodes with at least the specified number of
    cores per socket.  See additional information under \fB\-B\fR option
    above when task/affinity plugin is enabled.

    .TP
    \fB\-\-cpu\-freq\fR =<\fIp1\fR[\-\fIp2\fR[:\fIp3\fR]]>

    Request that job steps initiated by srun commands inside this allocation
    be run at some requested frequency if possible, on the CPUs selected
    for the step on the compute node(s).

    \fBp1\fR can be  [#### | low | medium | high | highm1] which will set the
    frequency scaling_speed to the corresponding value, and set the frequency
    scaling_governor to UserSpace. See below for definition of the values.

    \fBp1\fR can be [Conservative | OnDemand | Performance | PowerSave] which
    will set the scaling_governor to the corresponding value. The governor has to be

    If the current frequency is < min, it will be set to min. Likewise,
    if the current frequency is > max, it will be set to max.

    Acceptable values at present include:
    .RS
    .TP 14
    \fB####\fR
    frequency in kilohertz
    .TP
    \fBLow\fR
    the lowest available frequency
    .TP
    \fBHigh\fR
    the highest available frequency
    .TP
    \fBHighM1\fR
    (high minus one) will select the next highest available frequency
    .TP
    \fBMedium\fR
    attempts to set a frequency in the middle of the available range
    .TP
    \fBConservative\fR
    attempts to use the Conservative CPU governor
    .TP
    \fBOnDemand\fR
    attempts to use the OnDemand CPU governor (the default value)
    .TP
    \fBPerformance\fR
    attempts to use the Performance CPU governor
    .TP
    \fBPowerSave\fR
    attempts to use the PowerSave CPU governor
    .TP
    \fBUserSpace\fR
    attempts to use the UserSpace CPU governor
    .TP
    .RE

    The following informational environment variable is set in the job
    step when \fB\-\-cpu\-freq\fR option is requested.
    .nf
            SLURM_CPU_FREQ_REQ
    .fi

    This environment variable can also be used to supply the value for the
    CPU frequency request if it is set when the 'srun' command is issued.
    The \fB\-\-cpu\-freq\fR on the command line will override the
    environment variable value.  The form on the environment variable is
    the same as the command line.
    See the \fBENVIRONMENT VARIABLES\fR
    section for a description of the SLURM_CPU_FREQ_REQ variable.

    \fBNOTE\fR: When submitting jobs with  the \fB\-\-cpu\-freq\fR option
    with linuxproc as the ProctrackType can cause jobs to run too quickly before
    Accounting is able to poll for job information. As a result not all of
    accounting information will be present.
    .RE

    .TP
    \fB\-\-cpus\-per\-gpu\fR=<\fIncpus\fR>
    Advise Slurm that ensuing job steps will require \fIncpus\fR processors per
    allocated GPU.
    Not compatible with the \fB\-\-cpus\-per\-task\fR option.

    .TP
    \fB\-c\fR, \fB\-\-cpus\-per\-task\fR=<\fIncpus\fR>
    Advise Slurm that ensuing job steps will require \fIncpus\fR processors per
    task. By default Slurm will allocate one processor per task.

    For instance,
    consider an application that has 4 tasks, each requiring 3 processors.  If our
    cluster is comprised of quad\-processors nodes and we simply ask for
    12 processors, the controller might give us only 3 nodes.  However, by using
    the \-\-cpus\-per\-task=3 options, the controller knows that each task requires
    3 processors on the same node, and the controller will grant an allocation
    of 4 nodes, one for each of the 4 tasks.

    .TP
    \fB\-\-deadline\fR=<\fIOPT\fR>
    remove the job if no ending is possible before
    this deadline (start > (deadline \- time[\-min])).
    Default is no deadline.  Valid time formats are:
    .br
    HH:MM[:SS] [AM|PM]
    .br
    MMDD[YY] or MM/DD[/YY] or MM.DD[.YY]
    .br
    MM/DD[/YY]\-HH:MM[:SS]
    .br
    YYYY\-MM\-DD[THH:MM[:SS]]]
    .br
    now[+\fIcount\fR[seconds(default)|minutes|hours|days|weeks]]

    .TP
    \fB\-\-delay\-boot\fR=<\fIminutes\fR>
    Do not reboot nodes in order to satisfied this job's feature specification if
    the job has been eligible to run for less than this time period.
    If the job has waited for less than the specified period, it will use only
    nodes which already have the specified features.
    The argument is in units of minutes.
    A default value may be set by a system administrator using the \fBdelay_boot\fR
    option of the \fBSchedulerParameters\fR configuration parameter in the
    slurm.conf file, otherwise the default value is zero (no delay).
    Dependencies on remote jobs are allowed in a federation.
    Once a job dependency fails due to the termination state of a preceding job,
    the dependent job will never be run, even if the preceding job is requeued and
    has a different termination state in a subsequent execution.
    .PD
    .RS
    .TP
    \fBafter:job_id[[+time][:jobid[+time]...]]\fR
    After the specified jobs start or are cancelled and 'time' in minutes from job
    start or cancellation happens, this
    job can begin execution. If no 'time' is given then there is no delay after
    start or cancellation.
    .TP
    \fBafterany:job_id[:jobid...]\fR
    This job can begin execution after the specified jobs have terminated.
    .TP
    \fBafterburstbuffer:job_id[:jobid...]\fR
    This job can begin execution after the specified jobs have terminated and
    any associated burst buffer stage out operations have completed.
    .TP
    \fBaftercorr:job_id[:jobid...]\fR
    A task of this job array can begin execution after the corresponding task ID
    in the specified job has completed successfully (ran to completion with an
    exit code of zero).
    .TP
    \fBafternotok:job_id[:jobid...]\fR
    This job can begin execution after the specified jobs have terminated
    in some failed state (non-zero exit code, node failure, timed out, etc).
    .TP
    \fBafterok:job_id[:jobid...]\fR
    This job can begin execution after the specified jobs have successfully
    executed (ran to completion with an exit code of zero).
    .TP
    \fBexpand:job_id\fR
    Resources allocated to this job should be used to expand the specified job.
    The job to expand must share the same QOS (Quality of Service) and partition.
    Gang scheduling of resources in the partition is also not supported.
    "expand" is not allowed for jobs that didn't originate on the same cluster
    as the submitted job.
    .TP
    \fBsingleton\fR
    This job can begin execution after any previously launched jobs
    sharing the same job name and user have terminated.
    In other words, only one job by that name and owned by that user can be running
    or suspended at any point in time.
    In a federation, a singleton dependency must be fulfilled on all clusters
    unless DependencyParameters=disable_remote_singleton is used in slurm.conf.
    .RE

    .TP
    \fB\-D\fR, \fB\-\-chdir\fR=<\fIpath\fR>
    Change directory to \fIpath\fR before beginning execution. The path
    in the file.    Duplicate node names in the file will be ignored.
    The order of the node names in the list is not important; the node names
    will be sorted by Slurm.

    .TP
    \fB\-\-get\-user\-env\fR[=\fItimeout\fR][\fImode\fR]
    This option will load login environment variables for the user specified
    in the \fB\-\-uid\fR option.
    The environment variables are retrieved by running something of this sort
    "su \- <username> \-c /usr/bin/env" and parsing the output.
    Be aware that any environment variables already set in salloc's environment
    will take precedence over any environment variables in the user's
    login environment.
    The optional \fItimeout\fR value is in seconds. Default value is 3 seconds.
    The optional \fImode\fR value control the "su" options.
    With a \fImode\fR value of "S", "su" is executed without the "\-" option.
    With a \fImode\fR value of "L", "su" is executed with the "\-" option,
    replicating the login environment.
    If \fImode\fR not specified, the mode established at Slurm build time
    is used.
    Example of use include "\-\-get\-user\-env", "\-\-get\-user\-env=10"
    "\-\-get\-user\-env=10L", and "\-\-get\-user\-env=S".
    NOTE: This option only works if the caller has an
    effective uid of "root".

    .TP
    \fB\-\-gid\fR=<\fIgroup\fR>
    Submit the job with the specified \fIgroup\fR's group access permissions.
    \fIgroup\fR may be the group name or the numerical group ID.
    In the default Slurm configuration, this option is only valid when used
    by the user root.

    .TP
    \fB\-G\fR, \fB\-\-gpus\fR=[<\fitype\fR>:]<\fInumber\fR>
    Specify the total number of GPUs required for the job.
    An optional GPU type specification can be supplied.
    For example "\-\-gpus=volta:3".
    Multiple options can be requested in a comma separated list, for example:
    "\-\-gpus=volta:3,kepler:1".
    See also the \fB\-\-gpus\-per\-node\fR, \fB\-\-gpus\-per\-socket\fR and
    \fB\-\-gpus\-per\-task\fR options.

    .TP
    \fB\-\-gpu\-bind\fR=[verbose,]<\fItype\fR>
    Bind tasks to specific GPUs.
    By default every spawned task can access every GPU allocated to the step.
    If "verbose," is specified before <\fItype\fR>, then print out GPU binding
    debug information to the stderr of the tasks. GPU binding is ignored if there is
    only one task.

    Supported \fItype\fR options:
    .RS
    For example "map_gpu:0*4,1*4".
    If the task/cgroup plugin is used and ConstrainDevices is set in cgroup.conf,
    then the GPU IDs are zero-based indexes relative to the GPUs allocated to the
    job (e.g. the first GPU is 0, even if the global ID is 3). Otherwise, the GPU
    IDs are global IDs, and all GPUs on each node in the job should be allocated for
    predictable binding results.
    .TP
    \fBmask_gpu:<list>\fR
    Bind by setting GPU masks on tasks (or ranks) as specified where <list> is
    <gpu_mask_for_task_0>,<gpu_mask_for_task_1>,... The mapping is specified for
    a node and identical mapping is applied to the tasks on every node (i.e. the
    lowest task ID on each node is mapped to the first mask specified in the list,
    etc.). GPU masks are always interpreted as hexadecimal values but can be
    preceded with an optional '0x'. To simplify support for large task counts, the
    lists may follow a map with an asterisk and repetition count.
    For example "mask_gpu:0x0f*4,0xf0*4".
    If the task/cgroup plugin is used and ConstrainDevices is set in cgroup.conf,
    then the GPU IDs are zero-based indexes relative to the GPUs allocated to the
    job (e.g. the first GPU is 0, even if the global ID is 3). Otherwise, the GPU
    IDs are global IDs, and all GPUs on each node in the job should be allocated for
    predictable binding results.
    .TP
    \fBsingle:<tasks_per_gpu>\fR
    Like \fI--gpu-bind=closest\fR, except that each task can only be bound to a
    single GPU, even when it can be bound to multiple GPUs that are equally close.
    The GPU to bind to is determined by \fI<tasks_per_gpu>\fR, where the
    first \fI<tasks_per_gpu>\fR tasks are bound to the first GPU available, the
    second \fI<tasks_per_gpu>\fR tasks are bound to the second GPU available, etc.
    This is basically a block distribution of tasks onto available GPUs, where the
    available GPUs are determined by the socket affinity of the task and the socket
    affinity of the GPUs as specified in gres.conf's \fICores\fR parameter.
    .RE

    .TP
    \fB\-\-gpu\-freq\fR=[<\fItype\fR]=\fIvalue\fR>[,<\fItype\fR=\fIvalue\fR>][,verbose]
    Request that GPUs allocated to the job are configured with specific frequency
    values.
    This option can be used to independently configure the GPU and its memory
    frequencies.
    After the job is completed, the frequencies of all affected GPUs will be reset
    to the highest possible values.
    In some cases, system power caps may override the requested values.
    The field \fItype\fR can be "memory".
    If \fItype\fR is not specified, the GPU frequency is implied.
    The \fIvalue\fR field can either be "low", "medium", "high", "highm1" or
    a numeric value in megahertz (MHz).
    If the specified numeric value is not possible, a value as close as
    possible will be used. See below for definition of the values.
    The \fIverbose\fR option causes current GPU frequency information to be logged.
    Examples of use include "\-\-gpu\-freq=medium,memory=high" and
    "\-\-gpu\-freq=450".

    .RE

    .TP
    \fB\-\-gpus\-per\-node\fR=[<\fitype\fR>:]<\fInumber\fR>
    Specify the number of GPUs required for the job on each node included in
    the job's resource allocation.
    An optional GPU type specification can be supplied.
    For example "\-\-gpus\-per\-node=volta:3".
    Multiple options can be requested in a comma separated list, for example:
    "\-\-gpus\-per\-node=volta:3,kepler:1".
    See also the \fB\-\-gpus\fR, \fB\-\-gpus\-per\-socket\fR and
    \fB\-\-gpus\-per\-task\fR options.

    .TP
    \fB\-\-gpus\-per\-socket\fR=[<\fitype\fR>:]<\fInumber\fR>
    Specify the number of GPUs required for the job on each socket included in
    the job's resource allocation.
    An optional GPU type specification can be supplied.
    For example "\-\-gpus\-per\-socket=volta:3".
    Multiple options can be requested in a comma separated list, for example:
    "\-\-gpus\-per\-socket=volta:3,kepler:1".
    Requires job to specify a sockets per node count ( \-\-sockets\-per\-node).
    See also the \fB\-\-gpus\fR, \fB\-\-gpus\-per\-node\fR and
    \fB\-\-gpus\-per\-task\fR options.

    .TP
    \fB\-\-gpus\-per\-task\fR=[<\fitype\fR>:]<\fInumber\fR>
    Specify the number of GPUs required for the job on each task to be spawned
    in the job's resource allocation.
    An optional GPU type specification can be supplied.
    For example "\-\-gpus\-per\-task=volta:1". Multiple options can be
    requested in a comma separated list, for example:
    "\-\-gpus\-per\-task=volta:3,kepler:1". See also the \fB\-\-gpus\fR,
    \fB\-\-gpus\-per\-socket\fR and \fB\-\-gpus\-per\-node\fR options.
    This option requires an explicit task count, e.g. -n, --ntasks or "--gpus=X
    --gpus-per-task=Y" rather than an ambiguous range of nodes with -N, --nodes.
    .br
    NOTE: This option will not have any impact on GPU binding, specifically
    it won't limit the number of devices set for CUDA_VISIBLE_DEVICES.

    .TP
    \fB\-\-gres\fR=<\fIlist\fR>
    Specifies a comma delimited list of generic consumable resources.
    The format of each entry on the list is "name[[:type]:count]".
    The name is that of the consumable resource.
    The count is the number of those resources with a default value of 1.
    The count can have a suffix of
    "k" or "K" (multiple of 1024),
    "m" or "M" (multiple of 1024 x 1024),
    "g" or "G" (multiple of 1024 x 1024 x 1024),
    "t" or "T" (multiple of 1024 x 1024 x 1024 x 1024),
    "p" or "P" (multiple of 1024 x 1024 x 1024 x 1024 x 1024).
    Disable filtering of CPUs with respect to generic resource locality.
    This option is currently required to use more CPUs than are bound to a GRES
    (i.e. if a GPU is bound to the CPUs on one socket, but resources on more than
    one socket are required to run the job).
    This option may permit a job to be allocated resources sooner than otherwise
    possible, but may result in lower job performance.
    .br
    \fBNOTE\fR: This option is specific to \fBSelectType=cons_res\fR.
    .TP
    .B enforce\-binding
    The only CPUs available to the job will be those bound to the selected
    GRES (i.e. the CPUs identified in the gres.conf file will be strictly
    enforced). This option may result in delayed initiation of a job.
    For example a job requiring two GPUs and one CPU will be delayed until both
    GPUs on a single socket are available rather than using GPUs bound to separate
    sockets, however, the application performance may be improved due to improved
    communication speed.
    Requires the node to be configured with more than one socket and resource
    filtering will be performed on a per\-socket basis.
    .br
    \fBNOTE\fR: This option is specific to \fBSelectType=cons_tres\fR.
    .RE

    .TP
    \fB\-H, \-\-hold\fR
    Specify the job is to be submitted in a held state (priority of zero).
    A held job can now be released using scontrol to reset its priority
    (e.g. "\fIscontrol release <job_id>\fR").

    .TP
    \fB\-h\fR, \fB\-\-help\fR
    Display help information and exit.

    .TP
    \fB\-\-hint\fR=<\fItype\fR>
    Bind tasks according to application hints.
    .br
    \fBNOTE\fR: This option cannot be used in conjunction with
    \fB\-\-ntasks\-per\-core\fR, \fB\-\-threads\-per\-core\fR or \fB\-B\fR. If
    \fB\-\-hint\fR is specified as a command line argument, it will take
    precedence over the environment.
    .RS
    .TP
    .B compute_bound
    Select settings for compute bound applications:
    use all cores in each socket, one thread per core.
    .TP
    .B memory_bound
    Select settings for memory bound applications:
    use only one core in each socket, one thread per core.
    .TP
    .B [no]multithread
    \fBSchedulerParameters\fR and seconds=1 the allocation request will fail
    immediately; \fBdefer\fR conflicts and takes precedence over this option.
    By default, \fB\-\-immediate\fR is off, and the command
    will block until resources become available. Since this option's
    argument is optional, for proper parsing the single letter option must
    be followed immediately with the value and not include a space between
    them. For example "\-I60" and not "\-I 60".

    .TP
    \fB\-J\fR, \fB\-\-job\-name\fR=<\fIjobname\fR>
    Specify a name for the job allocation. The specified name will appear along with
    the job id number when querying running jobs on the system.  The default job
    name is the name of the "command" specified on the command line.

    .TP
    \fB\-K\fR, \fB\-\-kill\-command\fR[=\fIsignal\fR]
    salloc always runs a user\-specified command once the allocation is
    granted.  salloc will wait indefinitely for that command to exit.
    If you specify the \-\-kill\-command option salloc will send a signal to
    your command any time that the Slurm controller tells salloc that its job
    allocation has been revoked. The job allocation can be revoked for a
    couple of reasons: someone used \fBscancel\fR to revoke the allocation,
    or the allocation reached its time limit.  If you do not specify a signal
    name or number and Slurm is configured to signal the spawned command at job
    termination, the default signal is SIGHUP for interactive and SIGTERM for
    non\-interactive sessions. Since this option's argument is optional,
    for proper parsing the single letter option must be followed
    immediately with the value and not include a space between them. For
    example "\-K1" and not "\-K 1".

    .TP
    \fB\-k\fR, \fB\-\-no\-kill\fR [=off]
    Do not automatically terminate a job if one of the nodes it has been
    allocated fails.  The user will assume the responsibilities for fault\-tolerance
    should a node fail.  When there is a node failure, any active job steps (usually
    MPI jobs) on that node will almost certainly suffer a fatal error, but with
    \-\-no\-kill, the job allocation will not be revoked so the user may launch
    new job steps on the remaining nodes in their allocation.

    Specify an optional argument of "off" disable the effect of the
    \fBSALLOC_NO_KILL\fR environment variable.

    By default Slurm terminates the entire job allocation if any node fails in its
    range of allocated nodes.

    .TP
    \fB\-L\fR, \fB\-\-licenses\fR=<\fBlicense\fR>
    Specification of licenses (or other resources available on all
    nodes of the cluster) which must be allocated to this job.
    License names can be followed by a colon and count
    (the default count is one).
    Multiple license names should be comma separated (e.g.
    Specify alternate distribution methods for remote processes.
    In salloc, this only sets environment variables that will be used by
    subsequent srun requests.
    This option controls the assignment of tasks to the nodes on which
    resources have been allocated, and the distribution of those resources
    to tasks for binding (task affinity). The first distribution
    method (before the ":") controls the distribution of resources across
    nodes. The optional second distribution method (after the ":")
    controls the distribution of resources across sockets within a node.
    Note that with select/cons_res, the number of cpus allocated on each
    socket and node may be different. Refer to
    https://slurm.schedmd.com/mc_support.html
    for more information on resource allocation, assignment of tasks to
    nodes, and binding of tasks to CPUs.
    .RS

    First distribution method:
    .TP
    .B block
    The block distribution method will distribute tasks to a node such
    that consecutive tasks share a node. For example, consider an
    allocation of three nodes each with two cpus. A four\-task block
    distribution request will distribute those tasks to the nodes with
    tasks one and two on the first node, task three on the second node,
    and task four on the third node.  Block distribution is the default
    behavior if the number of tasks exceeds the number of allocated nodes.
    .TP
    .B cyclic
    The cyclic distribution method will distribute tasks to a node such
    that consecutive tasks are distributed over consecutive nodes (in a
    round\-robin fashion). For example, consider an allocation of three
    nodes each with two cpus. A four\-task cyclic distribution request
    will distribute those tasks to the nodes with tasks one and four on
    the first node, task two on the second node, and task three on the
    third node.
    Note that when SelectType is select/cons_res, the same number of CPUs
    may not be allocated on each node. Task distribution will be
    round\-robin among all the nodes with CPUs yet to be assigned to tasks.
    Cyclic distribution is the default behavior if the number
    of tasks is no larger than the number of allocated nodes.
    .TP
    .B plane
    The tasks are distributed in blocks of a specified size. The number of tasks
    distributed to each node is the same as for cyclic distribution, but the
    taskids assigned to each node depend on the plane size. Additional distribution
    specifications cannot be combined with this option.
    For more details (including examples and diagrams), please see
    .br
    https://slurm.schedmd.com/mc_support.html
    .br
    and
    .br
    CPUs on those nodes. This option is meant primarily to control a job step's
    task layout in an existing job allocation for the srun command.

    .TP
    Second distribution method:
    .TP
    .B block
    The block distribution method will distribute tasks to sockets such
    that consecutive tasks share a socket.
    .TP
    .B cyclic
    The cyclic distribution method will distribute tasks to sockets such
    that consecutive tasks are distributed over consecutive sockets (in a
    round\-robin fashion).
    Tasks requiring more than one CPU will have all of those CPUs allocated on a
    single socket if possible.
    .TP
    .B fcyclic
    The fcyclic distribution method will distribute tasks to sockets such
    that consecutive tasks are distributed over consecutive sockets (in a
    round\-robin fashion).
    Tasks requiring more than one CPU will have each CPUs allocated in a cyclic
    fashion across sockets.
    .RE

    .TP
    \fB\-\-mail\-type\fR=<\fItype\fR>
    Notify user by email when certain event types occur.
    Valid \fItype\fR values are NONE, BEGIN, END, FAIL, REQUEUE, ALL (equivalent to
    BEGIN, END, FAIL, INVALID_DEPEND, REQUEUE, and STAGE_OUT), INVALID_DEPEND
    (dependency never satisfied), STAGE_OUT (burst buffer stage out and teardown
    completed), TIME_LIMIT, TIME_LIMIT_90 (reached 90 percent of time limit),
    TIME_LIMIT_80 (reached 80 percent of time limit), and TIME_LIMIT_50 (reached 50
    percent of time limit).
    Multiple \fItype\fR values may be specified in a comma separated list.
    The user to be notified is indicated with \fB\-\-mail\-user\fR.

    .TP
    \fB\-\-mail\-user\fR=<\fIuser\fR>
    User to receive email notification of state changes as defined by
    \fB\-\-mail\-type\fR.
    The default value is the submitting user.

    .TP
    \fB\-\-mcs\-label\fR=<\fImcs\fR>
    Used only when the mcs/group plugin is enabled.
    This parameter is a group among the groups of the user.
    Default value is calculated by the Plugin mcs if it's enabled.

    .TP
    \fB\-\-mem\fR=<\fIsize[units]\fR>
    Specify the real memory required per node.
    grants the job access to all of the memory on each node.
    If the job is allocated multiple nodes in a heterogeneous cluster, the memory
    limit on each node will be that of the node in the allocation with the smallest
    memory size (same limit will apply to every node in the job's allocation).

    NOTE: Enforcement of memory limits currently relies upon the task/cgroup plugin
    or enabling of accounting, which samples memory use on a periodic basis (data
    need not be stored, just collected). In both cases memory use is based upon
    the job's Resident Set Size (RSS). A task may exceed the memory limit until
    the next periodic accounting sample.

    .TP
    \fB\-\-mem\-per\-cpu\fR=<\fIsize[units]\fR>
    Minimum memory required per allocated CPU.
    Default units are megabytes.
    Different units can be specified using the suffix [K|M|G|T].
    The default value is \fBDefMemPerCPU\fR and the maximum value is
    \fBMaxMemPerCPU\fR (see exception below). If configured, both parameters can be
    seen using the \fBscontrol show config\fR command.
    Note that if the job's \fB\-\-mem\-per\-cpu\fR value exceeds the configured
    \fBMaxMemPerCPU\fR, then the user's limit will be treated as a memory limit
    per task; \fB\-\-mem\-per\-cpu\fR will be reduced to a value no larger than
    \fBMaxMemPerCPU\fR; \fB\-\-cpus\-per\-task\fR will be set and the value of
    \fB\-\-cpus\-per\-task\fR multiplied by the new \fB\-\-mem\-per\-cpu\fR
    value will equal the original \fB\-\-mem\-per\-cpu\fR value specified by
    the user.
    This parameter would generally be used if individual processors
    are allocated to jobs (\fBSelectType=select/cons_res\fR).
    If resources are allocated by core, socket, or whole nodes, then the number
    of CPUs allocated to a job may be higher than the task count and the value
    of \fB\-\-mem\-per\-cpu\fR should be adjusted accordingly.
    Also see \fB\-\-mem\fR and \fB\-\-mem\-per\-gpu\fR.
    The \fB\-\-mem\fR, \fB\-\-mem\-per\-cpu\fR and \fB\-\-mem\-per\-gpu\fR
    options are mutually exclusive.

    NOTE: If the final amount of memory requested by a job
    can't be satisfied by any of the nodes configured in the
    partition, the job will be rejected.
    This could happen if \fB\-\-mem\-per\-cpu\fR is used with the
    \fB\-\-exclusive\fR option for a job allocation and \fB\-\-mem\-per\-cpu\fR
    times the number of CPUs on a node is greater than the total memory of that
    node.

    .TP
    \fB\-\-mem\-per\-gpu\fR=<\fIsize[units]\fR>
    Minimum memory required per allocated GPU.
    Default units are megabytes.
    Different units can be specified using the suffix [K|M|G|T].
    Default value is \fBDefMemPerGPU\fR and is available on both a global and
    per partition basis.
    If configured, the parameters can be seen using the \fBscontrol show config\fR
    and \fBscontrol show partition\fR commands.
    any memory. This option is typically used to ensure that each task is bound to
    the memory closest to its assigned CPU. \fBThe use of any type other than
    "none" or "local" is not recommended.\fR

    NOTE: To have Slurm always report on the selected memory binding for
    all commands executed in a shell, you can enable verbose mode by
    setting the SLURM_MEM_BIND environment variable value to "verbose".

    The following informational environment variables are set when
    \fB\-\-mem\-bind\fR is in use:

    .nf
    	SLURM_MEM_BIND_LIST
    	SLURM_MEM_BIND_PREFER
    	SLURM_MEM_BIND_SORT
    	SLURM_MEM_BIND_TYPE
    	SLURM_MEM_BIND_VERBOSE
    .fi

    See the \fBENVIRONMENT VARIABLES\fR section for a more detailed description
    of the individual SLURM_MEM_BIND* variables.

    Supported options include:
    .RS
    .TP
    .B help
    show this help message
    .TP
    .B local
    Use memory local to the processor in use
    .TP
    .B map_mem:<list>
    Bind by setting memory masks on tasks (or ranks) as specified where <list> is
    <numa_id_for_task_0>,<numa_id_for_task_1>,...
    The mapping is specified for a node and identical mapping is applied to the
    tasks on every node (i.e. the lowest task ID on each node is mapped to the
    first ID specified in the list, etc.).
    NUMA IDs are interpreted as decimal values unless they are preceded
    with '0x' in which case they interpreted as hexadecimal values.
    If the number of tasks (or ranks) exceeds the number of elements in this list,
    elements in the list will be reused as needed starting from the beginning of
    the list.
    To simplify support for large task counts, the lists may follow a map with an
    asterisk and repetition count.
    For example "map_mem:0x0f*4,0xf0*4".
    For predictable binding results, all CPUs for each node in the job should be
    allocated to the job.
    .TP
    .B mask_mem:<list>
    Bind by setting memory masks on tasks (or ranks) as specified where <list> is
    <numa_mask_for_task_0>,<numa_mask_for_task_1>,...
    The mapping is specified for a node and identical mapping is applied to the
    .B no[ne]
    don't bind tasks to memory (default)
    .TP
    .B p[refer]
    Prefer use of first specified NUMA node, but permit
     use of other available NUMA nodes.
    .TP
    .B q[uiet]
    quietly bind before task runs (default)
    .TP
    .B rank
    bind by task rank (not recommended)
    .TP
    .B sort
    sort free cache pages (run zonesort on Intel KNL nodes)
    .TP
    .B v[erbose]
    verbosely report binding before task runs
    .RE

    .TP
    \fB\-\-mincpus\fR=<\fIn\fR>
    Specify a minimum number of logical cpus/processors per node.

    .TP
    \fB\-N\fR, \fB\-\-nodes\fR=<\fIminnodes\fR[\-\fImaxnodes\fR]>
    Request that a minimum of \fIminnodes\fR nodes be allocated to this job.
    A maximum node count may also be specified with \fImaxnodes\fR.
    If only one number is specified, this is used as both the minimum and
    maximum node count.
    The partition's node limits supersede those of the job.
    If a job's node limits are outside of the range permitted for its
    associated partition, the job will be left in a PENDING state.
    This permits possible execution at a later time, when the partition
    limit is changed.
    If a job node limit exceeds the number of nodes configured in the
    partition, the job will be rejected.
    Note that the environment
    variable \fBSLURM_JOB_NUM_NODES\fR will be set to the count of nodes actually
    allocated to the job. See the \fBENVIRONMENT VARIABLES \fR section
    for more information.  If \fB\-N\fR is not specified, the default
    behavior is to allocate enough nodes to satisfy the requirements of
    the \fB\-n\fR and \fB\-c\fR options.
    The job will be allocated as many nodes as possible within the range specified
    and without delaying the initiation of the job.
    The node count specification may include a numeric value followed by a suffix
    of "k" (multiplies numeric value by 1,024) or "m" (multiplies numeric value by
    1,048,576).

    .TP
    \fB\-n\fR, \fB\-\-ntasks\fR=<\fInumber\fR>
    salloc does not launch tasks, it requests an allocation of resources and
    In this configuration supported values include:
    .RS
    .TP 6
    \fBsystem\fR
    Use the system\-wide network performance counters. Only nodes requested
    will be marked in use for the job allocation.  If the job does not
    fill up the entire system the rest of the nodes are not
    able to be used by other jobs using NPC, if idle their state will appear as
    PerfCnts.  These nodes are still available for other jobs not using NPC.
    .TP
    \fBblade\fR
    Use the blade network performance counters. Only nodes requested
    will be marked in use for the job allocation.  If the job does not
    fill up the entire blade(s) allocated to the job those blade(s) are not
    able to be used by other jobs using NPC, if idle their state will appear as
    PerfCnts.  These nodes are still available for other jobs not using NPC.
    .TP
    .RE

    .br
    .br
    In all cases the job allocation request \fBmust specify the
    \-\-exclusive option\fR.  Otherwise the request will be denied.

    .br
    .br
    Also with any of these options steps are not allowed to share blades,
    so resources would remain idle inside an allocation if the step
    running on a blade does not take up all the nodes on the blade.

    .br
    .br
    The \fBnetwork\fR option is also supported on systems with IBM's Parallel Environment (PE).
    See IBM's LoadLeveler job command keyword documentation about the keyword
    "network" for more information.
    Multiple values may be specified in a comma separated list.
    All options are case in\-sensitive.
    Supported values include:
    .RS
    .TP 12
    \fBBULK_XFER\fR[=<\fIresources\fR>]
    Enable bulk transfer of data using Remote Direct-Memory Access (RDMA).
    The optional \fIresources\fR specification is a numeric value which can have
    a suffix of "k", "K", "m", "M", "g" or "G" for kilobytes, megabytes or
    gigabytes.
    NOTE: The \fIresources\fR specification is not supported by the underlying
    IBM infrastructure as of Parallel Environment version 2.2 and no value should
    be specified at this time.
    .TP
    \fBCAU\fR=<\fIcount\fR>
    Number of Collectve Acceleration Units (CAU) required.
    Applies only to IBM Power7-IH processors.
    order of preferences is IPONLY (which is not considered in User Space mode),
    HFI, IB, HPCE, and KMUX.
    .TP
    \fBIMMED\fR =<\fIcount\fR>
    Number of immediate send slots per window required.
    Applies only to IBM Power7-IH processors.
    Default value is zero.
    .TP
    \fBINSTANCES\fR =<\fIcount\fR>
    Specify number of network connections for each task on each network connection.
    The default instance count is 1.
    .TP
    \fBIPV4\fR
    Use Internet Protocol (IP) version 4 communications (default).
    .TP
    \fBIPV6\fR
    Use Internet Protocol (IP) version 6 communications.
    .TP
    \fBLAPI\fR
    Use the LAPI programming interface.
    .TP
    \fBMPI\fR
    Use the MPI programming interface.
    MPI is the default interface.
    .TP
    \fBPAMI\fR
    Use the PAMI programming interface.
    .TP
    \fBSHMEM\fR
    Use the OpenSHMEM programming interface.
    .TP
    \fBSN_ALL\fR
    Use all available switch networks (default).
    .TP
    \fBSN_SINGLE\fR
    Use one available switch network.
    .TP
    \fBUPC\fR
    Use the UPC programming interface.
    .TP
    \fBUS\fR
    Use User Space communications.
    .TP

    Some examples of network specifications:
    .TP
    \fBInstances=2,US,MPI,SN_ALL\fR
    Create two user space connections for MPI communications on every switch
    network for each task.
    .TP
    \fBUS,MPI,Instances=3,Devtype=IB\fR
    Create three user space connections for MPI communications on every InfiniBand
    .RE

    .TP
    \fB\-\-nice\fR[=\fIadjustment\fR]
    Run the job with an adjusted scheduling priority within Slurm. With no
    adjustment value the scheduling priority is decreased by 100. A negative nice
    value increases the priority, otherwise decreases it. The adjustment range is
    +/\- 2147483645. Only privileged users can specify a negative adjustment.

    .TP
    \fB\-\-ntasks\-per\-core\fR=<\fIntasks\fR>
    Request the maximum \fIntasks\fR be invoked on each core.
    Meant to be used with the \fB\-\-ntasks\fR option.
    Related to \fB\-\-ntasks\-per\-node\fR except at the core level
    instead of the node level.
    \fBNOTE\fR: This option is not supported when using
    \fISelectType=select/linear\fR.

    .TP
    \fB\-\-ntasks\-per\-gpu\fR=<\fIntasks\fR>
    Request that there are \fIntasks\fR tasks invoked for every GPU.
    This option can work in two ways: 1) either specify \fB\-\-ntasks\fR in
    addition, in which case a type-less GPU specification will be automatically
    determined to satisfy \fB\-\-ntasks\-per\-gpu\fR, or 2) specify the GPUs wanted
    (e.g. via \fB\-\-gpus\fR or \fB\-\-gres\fR) without specifying \fB\-\-ntasks\fR,
    and the total task count will be automatically determined.
    The number of CPUs needed will be automatically increased if necessary to allow
    for any calculated task count.
    This option will implicitly set \fB\-\-gpu-bind=single:<ntasks>\fR, but that
    can be overridden with an explicit \fB\-\-gpu-bind\fR specification.
    This option is not compatible with a node range
    (i.e. \-N<\fIminnodes\fR\-\fImaxnodes\fR>).
    This option is not compatible with \fB\-\-gpus-per-task\fR,
    \fB\-\-gpus-per-socket\fR, or \fB\-\-ntasks-per-node\fR.
    This option is not supported unless \fISelectType=cons_tres\fR is
    configured (either directly or indirectly on Cray systems).

    .TP
    \fB\-\-ntasks\-per\-node\fR=<\fIntasks\fR>
    Request that \fIntasks\fR be invoked on each node.
    If used with the \fB\-\-ntasks\fR option, the \fB\-\-ntasks\fR option will take
    precedence and the \fB\-\-ntasks\-per\-node\fR will be treated as a
    \fImaximum\fR count of tasks per node.
    Meant to be used with the \fB\-\-nodes\fR option.
    This is related to \fB\-\-cpus\-per\-task\fR=\fIncpus\fR,
    but does not require knowledge of the actual number of cpus on
    each node.  In some cases, it is more convenient to be able to
    request that no more than a specific number of tasks be invoked
    on each node.  Examples of this include submitting
    a hybrid MPI/OpenMP app where only one MPI "task/rank" should be
    assigned to each node while allowing the OpenMP portion to utilize
    all of the parallelism present in the node, or submitting a single
    Silence salloc's use of the terminal bell. Also see the option \fB\-\-bell\fR.

    .TP
    \fB\-\-no\-shell\fR
    immediately exit after allocating resources, without running a
    command. However, the Slurm job will still be created and will remain
    active and will own the allocated resources as long as it is active.
    You will have a Slurm job id with no associated processes or
    tasks. You can submit \fBsrun\fR commands against this resource allocation,
    if you specify the \fB\-\-jobid=\fR option with the job id of this Slurm job.
    Or, this can be used to temporarily reserve a set of resources so that
    other jobs cannot use them for some period of time.  (Note that the
    Slurm job is subject to the normal constraints on jobs, including time
    limits, so that eventually the job will terminate and the resources
    will be freed, or you can terminate the job manually using the
    \fBscancel\fR command.)

    .TP
    \fB\-O\fR, \fB\-\-overcommit\fR
    Overcommit resources.
    When applied to job allocation, only one CPU is allocated to the job per node
    and options used to specify the number of tasks per node, socket, core, etc.
    are ignored.
    When applied to job step allocations (the \fBsrun\fR command when executed
    within an existing job allocation), this option can be used to launch more than
    one task per CPU.
    Normally, \fBsrun\fR will not allocate more than one process per CPU.
    By specifying \fB\-\-overcommit\fR you are explicitly allowing more than one
    process per CPU. However no more than \fBMAX_TASKS_PER_NODE\fR tasks are
    permitted to execute per node.  NOTE: \fBMAX_TASKS_PER_NODE\fR is
    defined in the file \fIslurm.h\fR and is not a variable, it is set at
    Slurm build time.

    .TP
    \fB\-p\fR, \fB\-\-partition\fR=<\fIpartition_names\fR>
    Request a specific partition for the resource allocation.  If not specified,
    the default behavior is to allow the slurm controller to select the default
    partition as designated by the system administrator. If the job can use more
    than one partition, specify their names in a comma separate list and the one
    offering earliest initiation will be used with no regard given to the partition
    name ordering (although higher priority partitions will be considered first).
    When the job is initiated, the name of the partition used will be placed first
    in the job record partition string.

    .TP
    \fB\-\-power\fR=<\fIflags\fR>
    Comma separated list of power management plugin options.
    Currently available flags include:
    level (all nodes allocated to the job should have identical power caps,
    may be disabled by the Slurm configuration option PowerParameters=job_no_level).

    .TP
    \fBAll\fR
    All data types are collected. (Cannot be combined with other values.)

    .TP
    \fBNone\fR
    No data types are collected. This is the default.
     (Cannot be combined with other values.)

    .TP
    \fBEnergy\fR
    Energy data is collected.

    .TP
    \fBTask\fR
    Task (I/O, Memory, ...) data is collected.

    .TP
    \fBLustre\fR
    Lustre data is collected.

    .TP
    \fBNetwork\fR
    Network (InfiniBand) data is collected.
    .RE

    .TP
    \fB\-q\fR, \fB\-\-qos\fR=<\fIqos\fR>
    Request a quality of service for the job.  QOS values can be defined
    for each user/cluster/account association in the Slurm database.
    Users will be limited to their association's defined set of qos's when
    the Slurm configuration parameter, AccountingStorageEnforce, includes
    "qos" in its definition.

    .TP
    \fB\-Q\fR, \fB\-\-quiet\fR
    Suppress informational messages from salloc. Errors will still be displayed.

    .TP
    \fB\-\-reboot\fR
    Force the allocated nodes to reboot before starting the job.
    This is only supported with some system configurations and will otherwise be
    silently ignored. Only root, \fISlurmUser\fR or admins can reboot nodes.

    .TP
    \fB\-\-reservation\fR=<\fIreservation_names\fR>
    Allocate resources for the job from the named reservation. If the job can use
    more than one reservation, specify their names in a comma separate list and the
    one offering earliest initiation. Each reservation will be considered in the
    order it was requested.
    All reservations will be listed in scontrol/squeue through the life of the job.
    In accounting the first reservation will be seen and after the job starts the
    reservation used will replace it.
    \fB\-S\fR, \fB\-\-core\-spec\fR=<\fInum\fR>
    Count of specialized cores per node reserved by the job for system operations
    and not used by the application. The application will not use these cores,
    but will be charged for their allocation.
    Default value is dependent upon the node's configured CoreSpecCount value.
    If a value of zero is designated and the Slurm configuration option
    AllowSpecResourcesUsage is enabled, the job will be allowed to override
    CoreSpecCount and use the specialized resources on nodes it is allocated.
    This option can not be used with the \fB\-\-thread\-spec\fR option.

    .TP
    \fB\-\-signal\fR=[R:]<\fIsig_num\fR>[@<\fIsig_time\fR>]
    When a job is within \fIsig_time\fR seconds of its end time,
    send it the signal \fIsig_num\fR.
    Due to the resolution of event handling by Slurm, the signal may
    be sent up to 60 seconds earlier than specified.
    \fIsig_num\fR may either be a signal number or name (e.g. "10" or "USR1").
    \fIsig_time\fR must have an integer value between 0 and 65535.
    By default, no signal is sent before the job's end time.
    If a \fIsig_num\fR is specified without any \fIsig_time\fR,
    the default time will be 60 seconds.
    Use the "R:" option to allow this job to overlap with a reservation with
    MaxStartDelay set.
    To have the signal sent at preemption time see the
    \fBpreempt_send_user_signal\fR \fBSlurmctldParameter\fR.

    .TP
    \fB\-\-sockets\-per\-node\fR=<\fIsockets\fR>
    Restrict node selection to nodes with at least the specified number of
    sockets.  See additional information under \fB\-B\fR option above when
    task/affinity plugin is enabled.

    .TP
    \fB\-\-spread\-job\fR
    Spread the job allocation over as many nodes as possible and attempt to
    evenly distribute tasks across the allocated nodes.
    This option disables the topology/tree plugin.

    .TP
    \fB\-\-switches\fR=<\fIcount\fR>[@<\fImax\-time\fR>]
    When a tree topology is used, this defines the maximum count of switches
    desired for the job allocation and optionally the maximum time to wait
    for that number of switches. If Slurm finds an allocation containing more
    switches than the count specified, the job remains pending until it either finds
    an allocation with desired switch count or the time limit expires.
    It there is no switch count limit, there is no delay in starting the job.
    Acceptable time formats include "minutes", "minutes:seconds",
    "hours:minutes:seconds", "days\-hours", "days\-hours:minutes" and
    "days\-hours:minutes:seconds".
    The job's maximum time delay may be limited by the system administrator using
    the \fBSchedulerParameters\fR configuration parameter with the
    \fBmax_switch_wait\fR parameter option.
    permit the job to run longer than scheduled.  Time resolution is one minute
    and second values are rounded up to the next minute.

    A time limit of zero requests that no time limit be imposed.  Acceptable time
    formats include "minutes", "minutes:seconds", "hours:minutes:seconds",
    "days\-hours", "days\-hours:minutes" and "days\-hours:minutes:seconds".

    .TP
    \fB\-\-thread\-spec\fR=<\fInum\fR>
    Count of specialized threads per node reserved by the job for system operations
    and not used by the application. The application will not use these threads,
    but will be charged for their allocation.
    This option can not be used with the \fB\-\-core\-spec\fR option.

    .TP
    \fB\-\-threads\-per\-core\fR=<\fIthreads\fR>
    Restrict node selection to nodes with at least the specified number of
    threads per core. In task layout, use the specified maximum number of threads
    per core. NOTE: "Threads" refers to the number of processing units on
    each core rather than the number of application tasks to be launched per core.
    See additional information under \fB\-B\fR option above when task/affinity
    plugin is enabled.

    .TP
    \fB\-\-time\-min\fR=<\fItime\fR>
    Set a minimum time limit on the job allocation.
    If specified, the job may have its \fB\-\-time\fR limit lowered to a value
    no lower than \fB\-\-time\-min\fR if doing so permits the job to begin
    execution earlier than otherwise possible.
    The job's time limit will not be changed after the job is allocated resources.
    This is performed by a backfill scheduling algorithm to allocate resources
    otherwise reserved for higher priority jobs.
    Acceptable time formats include "minutes", "minutes:seconds",
    "hours:minutes:seconds", "days\-hours", "days\-hours:minutes" and
    "days\-hours:minutes:seconds".

    .TP
    \fB\-\-tmp\fR=<\fIsize[units]\fR>
    Specify a minimum amount of temporary disk space per node.
    Default units are megabytes.
    Different units can be specified using the suffix [K|M|G|T].

    .TP
    \fB\-\-usage\fR
    Display brief help message and exit.

    .TP
    \fB\-\-uid\fR=<\fIuser\fR>
    Attempt to submit and/or run a job as \fIuser\fR instead of the
    invoking user id. The invoking user's credentials will be used
    to check access permissions for the target partition. This option
    is only valid for user root. This option may be used by user root
    \fB\-v\fR, \fB\-\-verbose\fR
    Increase the verbosity of salloc's informational messages.  Multiple
    \fB\-v\fR's will further increase salloc's verbosity.  By default only
    errors will be displayed.

    .TP
    \fB\-w\fR, \fB\-\-nodelist\fR=<\fInode name list\fR>
    Request a specific list of hosts.
    The job will contain \fIall\fR of these hosts and possibly additional hosts
    as needed to satisfy resource requirements.
    The list may be specified as a comma\-separated list of hosts, a range of hosts
    (host[1\-5,7,...] for example), or a filename.
    The host list will be assumed to be a filename if it contains a "/" character.
    If you specify a minimum node or processor count larger than can be satisfied
    by the supplied host list, additional resources will be allocated on other
    nodes as needed.
    Duplicate node names in the list will be ignored.
    The order of the node names in the list is not important; the node names
    will be sorted by Slurm.

    .TP
    \fB\-\-wait\-all\-nodes\fR=<\fIvalue\fR>
    Controls when the execution of the command begins with respect to when nodes
    are ready for use (i.e. booted).
    By default, the salloc command will return as soon as the allocation is made.
    This default can be altered using the \fBsalloc_wait_nodes\fR option to the
    \fBSchedulerParameters\fR parameter in the slurm.conf file.
    .RS
    .TP 5
    0
    Begin execution as soon as allocation can be made.
    Do not wait for all nodes to be ready for use (i.e. booted).
    .TP
    1
    Do not begin execution until all nodes are ready for use.
    .RE

    .TP
    \fB\-\-wckey\fR=<\fIwckey\fR>
    Specify wckey to be used with job.  If TrackWCKey=no (default) in the
    slurm.conf this value is ignored.

    .TP
    \fB\-x\fR, \fB\-\-exclude\fR=<\fInode name list\fR>
    Explicitly exclude certain nodes from the resources granted to the job.

    .TP
    \fB\-\-x11\fR[=<\fIall\fR|\fIfirst\fR|\fIlast\fR>]
    Sets up X11 forwarding on all, first or last node(s) of the allocation. This
    option is only enabled if Slurm was compiled with X11 support and
    PrologFlags=x11 is defined in the slurm.conf. Default is \fIall\fR.

    .PP
    Upon startup, salloc will read and handle the options set in the following
    environment variables.  Note: Command line options always override environment
    variables settings.

    .TP 22
    \fBSALLOC_ACCOUNT\fR
    Same as \fB\-A, \-\-account\fR
    .TP
    \fBSALLOC_ACCTG_FREQ\fR
    Same as \fB\-\-acctg\-freq\fR
    .TP
    \fBSALLOC_BELL\fR
    Same as \fB\-\-bell\fR
    .TP
    \fBSALLOC_BURST_BUFFER\fR
    Same as \fB\-\-bb\fR
    .TP
    \fBSALLOC_CLUSTERS\fR or \fBSLURM_CLUSTERS\fR
    Same as \fB\-\-clusters\fR
    .TP
    \fBSALLOC_CONSTRAINT\fR
    Same as \fB\-C\fR, \fB\-\-constraint\fR
    .TP
    \fBSALLOC_CORE_SPEC\fR
    Same as \fB\-\-core\-spec\fR
    .TP
    \fBSALLOC_CPUS_PER_GPU\fR
    Same as \fB\-\-cpus\-per\-gpu\fR
    .TP
    \fBSALLOC_DEBUG\fR
    Same as \fB\-v, \-\-verbose\fR
    .TP
    \fBSALLOC_DELAY_BOOT\fR
    Same as \fB\-\-delay\-boot\fR
    .TP
    \fBSALLOC_EXCLUSIVE\fR
    Same as \fB\-\-exclusive\fR
    .TP
    \fBSALLOC_GPU_BIND\fR
    Same as \fB\-\-gpu\-bind\fR
    .TP
    \fBSALLOC_GPU_FREQ\fR
    Same as \fB\-\-gpu\-freq\fR
    .TP
    \fBSALLOC_GPUS\fR
    Same as \fB\-G, \-\-gpus\fR
    .TP
    \fBSALLOC_GPUS_PER_NODE\fR
    Same as \fB\-\-gpus\-per\-node\fR
    .TP
    \fBSALLOC_GPUS_PER_TASK\fR
    \fBSALLOC_KILL_CMD\fR
    Same as \fB\-K\fR, \fB\-\-kill\-command\fR
    .TP
    \fBSALLOC_MEM_BIND\fR
    Same as \fB\-\-mem\-bind\fR
    .TP
    \fBSALLOC_MEM_PER_CPU\fR
    Same as \fB\-\-mem\-per\-cpu\fR
    .TP
    \fBSALLOC_MEM_PER_GPU\fR
    Same as \fB\-\-mem\-per\-gpu\fR
    .TP
    \fBSALLOC_MEM_PER_NODE\fR
    Same as \fB\-\-mem\fR
    .TP
    \fBSALLOC_NETWORK\fR
    Same as \fB\-\-network\fR
    .TP
    \fBSALLOC_NO_BELL\fR
    Same as \fB\-\-no\-bell\fR
    .TP
    \fBSALLOC_NO_KILL\fR
    Same as \fB\-k\fR, \fB\-\-no\-kill\fR
    .TP
    \fBSALLOC_OVERCOMMIT\fR
    Same as \fB\-O, \-\-overcommit\fR
    .TP
    \fBSALLOC_PARTITION\fR
    Same as \fB\-p, \-\-partition\fR
    .TP
    \fBSALLOC_POWER\fR
    Same as \fB\-\-power\fR
    .TP
    \fBSALLOC_PROFILE\fR
    Same as \fB\-\-profile\fR
    .TP
    \fBSALLOC_QOS\fR
    Same as \fB\-\-qos\fR
    .TP
    \fBSALLOC_REQ_SWITCH\fR
    When a tree topology is used, this defines the maximum count of switches
    desired for the job allocation and optionally the maximum time to wait
    for that number of switches. See \fB\-\-switches\fR.
    .TP
    \fBSALLOC_RESERVATION\fR
    Same as \fB\-\-reservation\fR
    .TP
    \fBSALLOC_SIGNAL\fR
    Same as \fB\-\-signal\fR
    .TP
    \fBSALLOC_SPREAD_JOB\fR
    Same as \fB\-\-spread\-job\fR
    Max time waiting for requested switches. See \fB\-\-switches\fR
    .TP
    \fBSALLOC_WCKEY\fR
    Same as \fB\-\-wckey\fR
    .TP
    \fBSLURM_CONF\fR
    The location of the Slurm configuration file.
    .TP
    \fBSLURM_EXIT_ERROR\fR
    Specifies the exit code generated when a Slurm error occurs
    (e.g. invalid options).
    This can be used by a script to distinguish application exit codes from
    various Slurm error conditions.
    Also see \fBSLURM_EXIT_IMMEDIATE\fR.
    .TP
    \fBSLURM_EXIT_IMMEDIATE\fR
    Specifies the exit code generated when the \fB\-\-immediate\fR option
    is used and resources are not currently available.
    This can be used by a script to distinguish application exit codes from
    various Slurm error conditions.
    Also see \fBSLURM_EXIT_ERROR\fR.

    .SH "OUTPUT ENVIRONMENT VARIABLES"
    .PP
    salloc will set the following environment variables in the environment of
    the executed program:
    .TP
    \fBSLURM_*_HET_GROUP_#\fR
    For a heterogeneous job allocation, the environment variables are set separately
    for each component.
    .TP
    \fBSLURM_CLUSTER_NAME\fR
    Name of the cluster on which the job is executing.
    .TP
    \fBSLURM_CPUS_PER_GPU\fR
    Number of CPUs requested per allocated GPU.
    Only set if the \fB\-\-cpus\-per\-gpu\fR option is specified.
    .TP
    \fBSLURM_CPUS_PER_TASK\fR
    Number of CPUs requested per task.
    Only set if the \fB\-\-cpus\-per\-task\fR option is specified.
    .TP
    \fBSLURM_DIST_PLANESIZE\fR
    Plane distribution size. Only set for plane distributions.
    See \fB\-m, \-\-distribution\fR.
    .TP
    \fBSLURM_DISTRIBUTION\fR
    Only set if the \fB\-m, \-\-distribution\fR option is specified.
    .TP
    \fBSLURM_GPU_BIND\fR
    Requested binding of tasks to GPU.
    Only set if the \fB\-\-gpu\-bind\fR option is specified.
    Requested GPU count per allocated socket.
    Only set if the \fB\-\-gpus\-per\-socket\fR option is specified.
    .TP
    \fBSLURM_GPUS_PER_TASK\fR
    Requested GPU count per allocated task.
    Only set if the \fB\-\-gpus\-per\-task\fR option is specified.
    .TP
    \fBSLURM_HET_SIZE\fR
    Set to count of components in heterogeneous job.
    .TP
    \fBSLURM_JOB_ACCOUNT\fR
    Account name associated of the job allocation.
    .TP
    \fBSLURM_JOB_ID\fR
    The ID of the job allocation.
    .TP
    \fBSLURM_JOB_CPUS_PER_NODE\fR
    Count of CPUs available to the job on the nodes in the allocation, using the
    format \fICPU_count\fR[(x\fInumber_of_nodes\fR)][,\fICPU_count\fR
    [(x\fInumber_of_nodes\fR)] ...].
    For example: SLURM_JOB_CPUS_PER_NODE='72(x2),36' indicates that on the
    first and second nodes (as listed by SLURM_JOB_NODELIST) the allocation
    has 72 CPUs, while the third node has 36 CPUs.
    \fBNOTE\fR: The \fBselect/linear\fR plugin allocates entire nodes to jobs, so
    the value indicates the total count of CPUs on allocated nodes. The
    \fBselect/cons_res\fR and \fBselect/cons_tres\fR plugins allocate individual
    CPUs to jobs, so this number indicates the number of CPUs allocated to the job.
    .TP
    \fBSLURM_JOB_NODELIST\fR
    List of nodes allocated to the job.
    .TP
    \fBSLURM_JOB_NUM_NODES\fR
    Total number of nodes in the job allocation.
    .TP
    \fBSLURM_JOB_PARTITION\fR
    Name of the partition in which the job is running.
    .TP
    \fBSLURM_JOB_QOS\fR
    Quality Of Service (QOS) of the job allocation.
    .TP
    \fBSLURM_JOB_RESERVATION\fR
    Advanced reservation containing the job allocation, if any.
    .TP
    \fBSLURM_JOBID\fR
    The ID of the job allocation. See \fBSLURM_JOB_ID\fR. Included for backwards
    compatibility.
    .TP
    \fBSLURM_MEM_BIND\fR
    Set to value of the \-\-mem\-bind\fR option.
    .TP
    \fBSLURM_MEM_BIND_LIST\fR
    Set to bit mask used for memory binding.
    .TP
    \fBSLURM_MEM_PER_CPU\fR
    Same as \fB\-\-mem\-per\-cpu\fR
    .TP
    \fBSLURM_MEM_PER_GPU\fR
    Requested memory per allocated GPU.
    Only set if the \fB\-\-mem\-per\-gpu\fR option is specified.
    .TP
    \fBSLURM_MEM_PER_NODE\fR
    Same as \fB\-\-mem\fR
    .TP
    \fBSLURM_NNODES\fR
    Total number of nodes in the job allocation. See \fBSLURM_JOB_NUM_NODES\fR.
    Included for backwards compatibility.
    .TP
    \fBSLURM_NODELIST\fR
    List of nodes allocated to the job. See \fBSLURM_JOB_NODELIST\fR. Included
    for backwards compabitility.
    .TP
    \fBSLURM_NODE_ALIASES\fR
    Sets of node name, communication address and hostname for nodes allocated to
    the job from the cloud. Each element in the set if colon separated and each
    set is comma separated. For example:
    SLURM_NODE_ALIASES=ec0:1.2.3.4:foo,ec1:1.2.3.5:bar
    .TP
    \fBSLURM_NTASKS\fR
    Same as \fB\-n, \-\-ntasks\fR
    .TP
    \fBSLURM_NTASKS_PER_CORE\fR
    Set to value of the \-\-ntasks\-per\-core\fR option, if specified.
    .TP
    \fBSLURM_NTASKS_PER_GPU\fR
    Set to value of the \-\-ntasks\-per\-gpu\fR option, if specified.
    .TP
    \fBSLURM_NTASKS_PER_NODE\fR
    Set to value of the \-\-ntasks\-per\-node\fR option, if specified.
    .TP
    \fBSLURM_NTASKS_PER_SOCKET\fR
    Set to value of the \-\-ntasks\-per\-socket\fR option, if specified.
    .TP
    \fBSLURM_OVERCOMMIT\fR
    Set to \fB1\fR if \fB\-\-overcommit\fR was specified.
    .TP
    \fBSLURM_PROFILE\fR
    Same as \fB\-\-profile\fR
    .TP
    \fBSLURM_SUBMIT_DIR\fR
    The directory from which \fBsalloc\fR was invoked or, if applicable, the
    directory specified by the \fB\-D, \-\-chdir\fR option.
    .TP
    \fBSLURM_SUBMIT_HOST\fR
    The hostname of the computer from which \fBsalloc\fR was invoked.

    However if the allocation has been granted and salloc has already started the
    specified command, then salloc will ignore most signals.
    salloc will not exit or release the allocation until the command exits.
    One notable exception is SIGHUP. A SIGHUP signal will cause salloc to
    release the allocation and exit without waiting for the command to finish.
    Another exception is SIGTERM, which will be forwarded to the spawned process.

    .SH "EXAMPLES"
    .TP
    To get an allocation, and open a new xterm in which srun commands may be typed \
    interactively:

    .nf
    $ salloc \-N16 xterm
    salloc: Granted job allocation 65537
    # (at this point the xterm appears, and salloc waits for xterm to exit)
    salloc: Relinquishing job allocation 65537
    .fi

    .TP
    To grab an allocation of nodes and launch a parallel application on one \
    command line:

    .nf
    $ salloc \-N5 srun \-n10 myprogram
    .fi

    .TP
    To create a heterogeneous job with 3 components, each allocating a unique set \
    of nodes:

    .nf
    $ salloc -w node[2-3] : -w node4 : -w node[5-7] bash
    salloc: job 32294 queued and waiting for resources
    salloc: job 32294 has been allocated resources
    salloc: Granted job allocation 32294
    .fi

    .SH "COPYING"
    Copyright (C) 2006\-2007 The Regents of the University of California.
    Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
    .br
    Copyright (C) 2008\-2010 Lawrence Livermore National Security.
    .br
    Copyright (C) 2010\-2018 SchedMD LLC.
    .LP
    This file is part of Slurm, a resource management program.
    For details, see <https://slurm.schedmd.com/>.
    .LP
    Slurm is free software; you can redistribute it and/or modify it under
    the terms of the GNU General Public License as published by the Free
    </PRE>