    \fBsalloc\fR [\fIOPTIONS(0)\fR...] \fR[ : \fR[\fIOPTIONS(N)\fR...]\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 the value of
    \fBSallocDefaultCommand\fR in slurm.conf is used. If
    \fBSallocDefaultCommand\fR is not set, 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"

    .nr step 1 1
    If provided, the command is resolved in the following order:
    .br
    .IP \n[step]. 3
    If command starts with ".", then path is constructed as:
    current working directory / command
    .IP \n+[step].
    If command starts with a "/", then path is considered absolute.
    .IP \n+[step].
    If command can be resolved through PATH. See \fBpath_resolution\fR(7).
    .IP \n+[step].
    If command is in current working directory.
    .P
    Current working directory is the calling process working directory unless the
    \fB\-\-acctg\-freq\fR
    Define the job accounting and profiling sampling intervals.
    This can be used to override the \fIJobAcctGatherFrequency\fR parameter in Slurm's
    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_infiniband
    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.
        \fB\-\-cores\-per\-socket\fR=<\fIcores\fR>
        \fB\-\-threads\-per\-core\fR=<\fIthreads\fR>
    .fi
    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.

    .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 it's allocated compute nodes. See the
    description of SallocDefaultCommand in the slurm.conf man page for more
    information about how to spawn a remote shell.

    .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 it's allocated compute nodes. See the
    description of SallocDefaultCommand in the slurm.conf man page for more
    information about how to spawn a remote shell.

    .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.
    second.  The job will be eligible to start on the next poll
    following the specified time. The exact poll interval depends on the
    Slurm scheduler (e.g., 60 seconds with the default sched/builtin).
     \- If no time (HH:MM:SS) is specified, the default is (00:00:00).
     \- If a date is specified without a year (e.g., MM/DD) then the current
    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.
    .TP
    \fBMultiple Counts\fR
    Specific counts of multiple resources may be specified by using the AND
    operator and enclosing the options within square brackets.
    For example: "\fB\-\-constraint=[rack1*2&rack2*4]"\fR might
    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
    \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.
    Not 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
    in the list set by the slurm.conf option CpuFreqGovernors.

    When \fBp2\fR is present, p1 will be the minimum scaling frequency and
    p2 will be the maximum scaling frequency.
    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: This parameter is treated as a request, not a requirement.
    If the job step's node does not support setting the CPU frequency, or
    the requested value is outside the bounds of the legal frequencies, an
    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.
    Requires the \fB\-\-gpus\fR option.
    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]]]

    .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).

    .TP
    \fB\-d\fR, \fB\-\-dependency\fR=<\fIdependency_list\fR>
    Defer the start of this job until the specified dependencies have been
    satisfied completed.
    \fBafter:job_id[:jobid...]\fR
    This job can begin execution after the specified jobs have begun
    execution.
    .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.
    .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.
    .RE

    .TP
    \fB\-D\fR, \fB\-\-chdir\fR=<\fIpath\fR>
    Change directory to \fIpath\fR before beginning execution. The path
    can be specified as full path or relative path to the directory where
    the command is executed.

    .TP
    \fB\-\-exclusive[=user|mcs]\fR
    The job allocation can not share nodes with other running jobs (or just other
    users with the "=user" option or with the "=mcs" option).
    The default shared/exclusive behavior depends on system configuration and the
    partition's \fBOverSubscribe\fR option takes precedence over the job's option.

    .TP
    \fB\-F\fR, \fB\-\-nodefile\fR=<\fInode file\fR>
    Much like \-\-nodelist, but the list is contained in a file of name
    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".
    This option was originally created for use by Moab.

    .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=<\fItype\fR>
    Bind tasks to specific GPUs.
    By default every spawned task can access every GPU allocated to the job.

    Supported \fItype\fR options:
    .RS
    .TP 10
    \fBclosest\fR
    Bind each task to the GPU(s) which are closest.
    In a NUMA environment, each task may be bound to more than one GPU (i.e.
    all GPUs in that NUMA environment).
    .TP
    \fBmap_gpu:<list>\fR
    Bind by setting GPU masks on tasks (or ranks) as specified where <list> is
    <gpu_id_for_task_0>,<gpu_id_for_task_1>,... GPU 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_gpu:0*4,1*4".

    .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".

    Supported \fIvalue\fR definitions:
    .RS
    .TP 10
    \fBlow\fR
    the lowest available frequency.
    .TP
    \fBmedium\fR
    attempts to set a frequency in the middle of the available range.
    .TP
    \fBhigh\fR
    the highest available frequency.
    .TP
    \fBhighm1\fR
    (high minus one) will select the next highest available frequency.
    .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.
    Multiple options can be requested in a comma separated list, for example:
    "\-\-gpus\-per\-task=volta:3,kepler:1".
    Requires job to specify a task count (\-\-nodes).
    See also the \fB\-\-gpus\fR, \fB\-\-gpus\-per\-socket\fR and
    \fB\-\-gpus\-per\-node\fR options.

    .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).
    The specified resources will be allocated to the job on each node.
    The available generic consumable resources is configurable by the system
    administrator.
    A list of available generic consumable resources will be printed and the
    command will exit if the option argument is "help".
    Examples of use include "\-\-gres=gpu:2,mic:1", "\-\-gres=gpu:kepler:2", and
    "\-\-gres=help".

    .TP
    \fB\-\-gres\-flags\fR=<\fItype\fR>
    Specify generic resource task binding options.
    .RS
    .TP
    .B disable\-binding
    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.
    .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.
    .RE

    .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
    [don't] use extra threads with in-core multi-threading
    which can benefit communication intensive applications.
    Only supported with the task/affinity plugin.
    .TP
    .B help
    show this help message
    .RE

    .TP
    \fB\-I\fR, \fB\-\-immediate\fR[=<\fIseconds\fR>]
    exit if resources are not available within the
    time period specified.
    If no argument is given (seconds defaults to 1), resources must be available
    immediately for the request to succeed. If \fBdefer\fR is configured in
    \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".
    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.
    "\-\-licenses=foo:4,bar").

    .TP
    \fB\-M\fR, \fB\-\-clusters\fR=<\fIstring\fR>
    Clusters to issue commands to.  Multiple cluster names may be comma separated.
    The job will be submitted to the one cluster providing the earliest expected
    job initiation time. The default value is the current cluster. A value of
    \(aq\fIall\fR' will query to run on all clusters.
    Note that the SlurmDBD must be up for this option to work properly.

    .TP
    \fB\-m\fR, \fB\-\-distribution\fR=
    \fIarbitrary\fR|<\fIblock\fR|\fIcyclic\fR|\fIplane=<options>\fR[:\fIblock\fR|\fIcyclic\fR|\fIfcyclic\fR]>

    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
    include a number representing the size of the task block.  This is
    followed by an optional specification of the task distribution scheme
    within a block of tasks and between the blocks of tasks.  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. For more
    details (including examples and diagrams), please see
    .br
    https://slurm.schedmd.com/mc_support.html
    .br
    and
    .br
    https://slurm.schedmd.com/dist_plane.html
    .TP
    .B arbitrary
    The arbitrary method of distribution will allocate processes in\-order
    as listed in file designated by the environment variable
    SLURM_HOSTFILE.  If this variable is listed it will over ride any
    other method specified.  If not set the method will default to block.
    Inside the hostfile must contain at minimum the number of hosts
    requested and be one per line or comma separated.  If specifying a
    task count (\fB\-n\fR, \fB\-\-ntasks\fR=<\fInumber\fR>), your tasks
    will be laid out on the nodes in the order of the file.
    .br
    \fBNOTE:\fR The arbitrary distribution option on a job allocation only
    controls the nodes to be allocated to the job and not the allocation of
    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>

    .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.
    Default units are megabytes unless the SchedulerParameters configuration
    parameter includes the "default_gbytes" option for gigabytes.
    Different units can be specified using the suffix [K|M|G|T].
    Default value is \fBDefMemPerNode\fR and the maximum value is
    \fBMaxMemPerNode\fR. If configured, both of parameters can be
    seen using the \fBscontrol show config\fR command.
    This parameter would generally be used if whole nodes
    are allocated to jobs (\fBSelectType=select/linear\fR).
    Also see \fB\-\-mem\-per\-cpu\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. If \fB\-\-mem\fR, \fB\-\-mem\-per\-cpu\fR or
    \fB\-\-mem\-per\-gpu\fR are specified as command line arguments, then they will
    take precedence over the environment.

    NOTE: A memory size specification of zero is treated as a special case and
    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 unless the SchedulerParameters configuration
    parameter includes the "default_gbytes" option for gigabytes.
    Different units can be specified using the suffix [K|M|G|T].
    Default value is \fBDefMemPerCPU\fR and the maximum value is \fBMaxMemPerCPU\fR
    (see exception below). If configured, both of 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.
    .TP
    \fB\-\-mem\-per\-gpu\fR=<\fIsize[units]\fR>
    Minimum memory required per allocated GPU.
    Default units are megabytes unless the SchedulerParameters configuration
    parameter includes the "default_gbytes" option for gigabytes.
    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.
    Also see \fB\-\-mem\fR.
    The \fB\-\-mem\fR, \fB\-\-mem\-per\-cpu\fR and \fB\-\-mem\-per\-gpu\fR
    options are mutually exclusive.

    .TP
    \fB\-\-mem\-bind\fR=[{\fIquiet,verbose\fR},]\fItype\fR
    Bind tasks to memory. Used only when the task/affinity plugin is enabled
    and the NUMA memory functions are available.
    \fBNote that the resolution of CPU and memory binding
    may differ on some architectures.\fR For example, CPU binding may be performed
    at the level of the cores within a processor while memory binding will
    be performed at the level of nodes, where the definition of "nodes"
    may differ from system to system.
    By default no memory binding is performed; any task using any CPU can use
    any memory. This option is typically used to ensure that each task is bound to
    the memory closest to it's assigned CPU. \fBThe use of any type other than
    "none" or "local" is not recommended.\fR
    If you want greater control, try running a simple test code with the
    options "\-\-cpu\-bind=verbose,none \-\-mem\-bind=verbose,none" to determine
    the specific configuration.

    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
    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".
    Not supported unless the entire node is 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
    tasks on every node (i.e. the lowest task ID on each node is mapped to the
    first mask specified in the list, etc.).
    NUMA masks are \fBalways\fR interpreted as hexadecimal values.
    Note that masks must be preceded with a '0x' if they don't begin
    with [0-9] so they are seen as numerical 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 mask with an
    asterisk and repetition count
    For example "mask_mem:0*4,1*4".
    Not supported unless the entire node is allocated to the job.
    .TP
    .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.
    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
    executed some command. This option advises the Slurm controller that job
    steps run within this allocation will launch a maximum of \fInumber\fR
    tasks and sufficient resources are allocated to accomplish this.
    The default is one task per node, but note
    that the \fB\-\-cpus\-per\-task\fR option will change this default.

    .TP
    \fB\-\-network\fR=<\fItype\fR>
    Specify information pertaining to the switch or network.
    The interpretation of \fItype\fR is system dependent.
    This option is supported when running Slurm on a Cray natively.  It is
    used to request using Network Performance Counters.
    Only one value per request is valid.
    All options are case in\-sensitive.
    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,
    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.
    Default value is zero.
    Independent CAU will be allocated for each programming interface (MPI, LAPI, etc.)
    .TP
    \fBDEVNAME\fR=<\fIname\fR>
    Specify the device name to use for communications (e.g. "eth0" or "mlx4_0").
    .TP
    \fBDEVTYPE\fR=<\fItype\fR>
    Specify the device type to use for communications.
    The supported values of \fItype\fR are:
    "IB" (InfiniBand), "HFI" (P7 Host Fabric Interface),
    "IPONLY" (IP-Only interfaces), "HPCE" (HPC Ethernet), and
    "KMUX" (Kernel Emulation of HPCE).
    The devices allocated to a job must all be of the same type.
    The default value depends upon depends upon what hardware is available and in
    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.
    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
    network for each task.
    .TP
    \fBIPV4,LAPI,SN_Single\fR
    Create a IP version 4 connection for LAPI communications on one switch network
    for each task.
    .TP
    \fBInstances=2,US,LAPI,MPI\fR
    Create two user space connections each for LAPI and MPI communications on every
    switch network for each task. Note that SN_ALL is the default option so every
    switch network is used. Also note that Instances=2 specifies that two
    connections are established for each protocol (LAPI and MPI) and each task.
    If there are two networks and four tasks on the node then a total
    of 32 connections are established (2 instances x 2 protocols x 2 networks x
    4 tasks).
    .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.
    NOTE: This option is not supported unless \fISelectType=cons_res\fR is
    configured (either directly or indirectly on Cray systems)
    along with the node's core count.

    .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,
    Related to \fB\-\-ntasks\-per\-node\fR except at the socket level
    instead of the node level.
    NOTE: This option is not supported unless \fISelectType=cons_res\fR is
    configured (either directly or indirectly on Cray systems)
    along with the node's socket count.

    .TP
    \fB\-\-no\-bell\fR
    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\-\-profile\fR=<all|none|[energy[,|task[,|lustre[,|network]]]]>
    enables detailed data collection by the acct_gather_profile plugin.
    Detailed data are typically time-series that are stored in an HDF5 file for
    the job or an InfluxDB database depending on the configured plugin.

    .RS
    .TP 10
    \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 it's 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.

    .TP

    .TP
    \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=<\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.
    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.  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 it's \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 unless the SchedulerParameters configuration
    parameter includes the "default_gbytes" option for gigabytes.
    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.

    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_GPUS\fR
    Same as \fB\-G, \-\-gpus\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_PER_NODE\fR
    Same as \fB\-\-gpus\-per\-node\fR
    .TP
    \fBSALLOC_GPUS_PER_TASK\fR
    Same as \fB\-\-gpus\-per\-task\fR
    \fBSALLOC_GRES\fR
    Same as \-\-gres\fR
    .TP
    \fBSALLOC_GRES_FLAGS\fR
    Same as \-\-gres\-flags\fR
    .TP
    \fBSALLOC_HINT\fR or \fBSLURM_HINT\fR
    Same as \fB\-\-hint\fR
    .TP
    \fBSALLOC_IMMEDIATE\fR
    Same as \fB\-I, \-\-immediate\fR
    .TP
    .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
    .TP
    \fBSALLOC_THREAD_SPEC\fR
    Same as \fB\-\-thread\-spec\fR
    .TP
    \fBSALLOC_TIMELIMIT\fR
    Same as \fB\-t, \-\-time\fR
    .TP
    \fBSALLOC_USE_MIN_NODES\fR
    Same as \fB\-\-use\-min\-nodes\fR
    .TP
    \fBSALLOC_WAIT_ALL_NODES\fR
    Same as \fB\-\-wait\-all\-nodes\fR
    .TP
    \fBSALLOC_WCKEY\fR
    Same as \fB\-\-wckey\fR
    .TP
    \fBSALLOC_WAIT4SWITCH\fR
    Max time waiting for requested switches. See \fB\-\-switches\fR
    .TP
    \fBSLURM_CONF\fR
    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_*_PACK_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_DISTRIBUTION\fR
    Only set if the \fB\-m, \-\-distribution\fR option is specified.
    .TP
    \fBSLURM_GPUS\fR
    Number of GPUs requested.
    Only set if the \fB\-G, \-\-gpus\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.
    .TP
    \fBSLURM_GPU_FREQ\fR
    Requested GPU frequency.
    Only set if the \fB\-\-gpu\-freq\fR option is specified.
    .TP
    \fBSLURM_GPUS_PER_NODE\fR
    Requested GPU count per allocated node.
    Only set if the \fB\-\-gpus\-per\-node\fR option is specified.
    .TP
    \fBSLURM_GPUS_PER_SOCKET\fR
    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_JOB_ACCOUNT\fR
    Account name associated of the job allocation.
    .TP
    \fBSLURM_JOB_NUM_NODES\fR (and \fBSLURM_NNODES\fR for backwards compatibility)
    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_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_BIND_PREFER\fR
    Set to "prefer" if the \-\-mem\-bind\fR option includes the prefer option.
    .TP
    \fBSLURM_MEM_BIND_SORT\fR
    Sort free cache pages (run zonesort on Intel KNL nodes)
    .TP
    \fBSLURM_MEM_BIND_TYPE\fR
    Set to the memory binding type specified with the \-\-mem\-bind\fR option.
    Possible values are "none", "rank", "map_map", "mask_mem" and "local".
    .TP
    \fBSLURM_MEM_BIND_VERBOSE\fR
    Set to "verbose" if the \-\-mem\-bind\fR option includes the verbose option.
    Set to "quiet" otherwise.
    .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_PACK_SIZE\fR
    Set to count of components in heterogeneous job.
    .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.
    .TP
    .TP
    \fBSLURM_NTASKS_PER_SOCKET\fR
    Set to value of the \-\-ntasks\-per\-socket\fR option, if specified.
    .TP
    \fBSLURM_PROFILE\fR
    Same as \fB\-\-profile\fR
    .TP
    \fBSLURM_TASKS_PER_NODE\fR
    Number of tasks to be initiated on each node. Values are
    comma separated and in the same order as SLURM_JOB_NODELIST.
    If two or more consecutive nodes are to have the same task
    count, that count is followed by "(x#)" where "#" is the
    repetition count. For example, "SLURM_TASKS_PER_NODE=2(x3),1"
    indicates that the first three nodes will each execute three
    tasks and the fourth node will execute one task.

    .SH "SIGNALS"
    .LP
    While salloc is waiting for a PENDING job allocation, most signals will cause
    salloc to revoke the allocation request and exit.

    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"
    .LP
    To get an allocation, and open a new xterm in which srun commands may be typed
    interactively:
    .IP
    $ salloc \-N16 xterm
    .br
    salloc: Granted job allocation 65537
    .br
    (at this point the xterm appears, and salloc waits for xterm to exit)
    .br
    salloc: Relinquishing job allocation 65537
    .LP
    To grab an allocation of nodes and launch a parallel application on one command
    line (See the \fBsalloc\fR man page for more examples):
    .IP
    salloc \-N5 srun \-n10 myprogram
    .LP
    +To create a heterogeneous job with 3 components, each allocating a unique set of nodes:
    .IP
    salloc -w node[2-3] : -w node4 : -w node[5-7] bash
    .br
    salloc: job 32294 queued and waiting for resources
    .br
    .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
    Software Foundation; either version 2 of the License, or (at your option)
    any later version.
    .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"
    .LP
    \fBsinfo\<B>fR(1), \fBsattach\fR(1), \fBsbatch\fR(1), \fBsqueue\fR(1), \fBscancel\fR(1), \fBscontrol\fR(1),
    \fBslurm.conf\fR(5), \fBsched_setaffinity\fR (2), \fBnuma\fR (3)