Slurm Workload Manager -

    \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

    \fBNOTE\fR: 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.

    This can be used to override the \fIJobAcctGatherFrequency\fR parameter in
    the slurm.conf file. <\fIdatatype\fR>=<\fIinterval\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 <\fIdatatype\fR>=<\fIinterval\fR> pairs
    may be specified. Supported \fIdatatype\fR values are:
    .RS
    .TP 12
    \fBtask\fR
    Sampling interval for the jobacct_gather plugins and for task
    profiling by the acct_gather_profile plugin.
    .br
    \fBNOTE\fR: 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. It can not be disabled.
    .IP

    .TP
    \fBenergy\fR
    Sampling interval for energy profiling using the
    acct_gather_energy plugin.
    .IP

    .TP
    \fBnetwork\fR
    Sampling interval for infiniband profiling using the
    acct_gather_interconnect plugin.
    .IP

    .TP
    \fBfilesystem\fR
    Sampling interval for filesystem profiling using the
    acct_gather_filesystem plugin.
    .IP

    .LP
    The default value for the task sampling interval is 30 seconds.
    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
    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
    \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.
    See Slurm's burst buffer guide for more information and examples:
    .br
    https://slurm.schedmd.com/burst_buffer.html
    .IP

    .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, \fIelevenses\fR (11 AM),
    \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)
       \-\-begin=2010\-01\-20T12:34:00
    .fi

    .RS
    .PP
    Notes on date/time specifications:
     \- Although the 'seconds' field of the HH:MM:SS time specification is
    allowed by the code, note that the poll time of the Slurm scheduler
    is not precise enough to guarantee dispatch of the job on the exact
    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
    .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.
    .IP

    .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 \fBslurmdbd\fR must be up for this option to work properly, unless
    running in a federation with \fBFederationParameters=fed_display\fR configured.
    .IP

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

    .TP
    \fB\-\-consolidate\-segments\fR
    Ensure that all segments from the allocation will be consolidated
    into one higher-level aggregated block.

    This option applies to job allocations.
    \fBNOTE\fR: This option will only work with the \fBtopology/block\fR plugin.
    .IP

    .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. If you are looking for 'soft' constraints please
    see \fB\-\-prefer\fR for more information.
    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).

    \fBNOTE\fR: Changeable features are features defined by a NodeFeatures plugin.

    Supported \fB\-\-constraint\fR options include:
    .IP
    .PD 1
    .RS
    .TP
    \fBSingle Name\fR
    Only nodes which have the specified feature will be used.
    For example, \fB\-\-constraint="intel"\fR
    .IP

    .TP
    \fBAND\fR
    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
    .IP

    .TP
    \fBOR\fR
    Only nodes with at least one of specified features will be used.
    The vertical bar is used for an OR operator. If changeable features are not
    requested, nodes in the allocation can have different features. For example,
    \fBsalloc -N2 \-\-constraint="intel|amd"\fR can result in a job allocation
    where one node has the intel feature and the other node has the amd feature.
    However, if the expression contains a changeable feature, then all OR operators
    are automatically treated as Matching OR so that all nodes in the job
    allocation have the same set of features. For example,
    \fBsalloc -N2 \-\-constraint="foo|bar&baz"\fR
    The job is allocated two nodes where both nodes have foo, or bar and baz (one
    or both nodes could have foo, bar, and baz). The helpers NodeFeatures plugin
    will find the first set of node features that matches all nodes in the job
    allocation; these features are set as active features on the node and passed to
    RebootProgram (see \fBslurm.conf\fR(5)) and the helper script (see
    \fBhelpers.conf\fR(5)). In this case, the helpers plugin uses the first of
    "foo" or "bar,baz" that match the two nodes in the job allocation.
    .IP

    .TP
    \fBMatching OR\fR
    If only one of a set of possible options should be used for all allocated
    nodes, then use the OR operator and enclose the options within square brackets.
    For example, \fB\-\-constraint="[rack1|rack2|rack3|rack4]"\fR might
    be used to specify that all nodes must be allocated on a single rack of
    the cluster, but any of those four racks can be used.
    .IP

    .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 option is not supported by the helpers NodeFeatures plugin.

    \fBNOTE\fR: Multiple Counts can cause jobs to be allocated with a non-optimal
    network layout.
    .IP
    constraints per job.

    \fBNOTE\fR: Square brackets are not supported by the helpers NodeFeatures
    plugin. Matching OR can be requested without square brackets by using the
    vertical bar character with at least one changeable feature.
    .IP

    .TP
    \fBParentheses\fR
    Parentheses 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.
    Parentheses can also be used to group operations. Without parentheses, node
    features are parsed strictly from left to right.
    For example,
    \fB\-\-constraint="foo&bar|baz"\fR requests nodes with foo and bar, or baz.
    \fB\-\-constraint="foo|bar&baz"\fR requests nodes with foo and baz, or bar and
    baz (note how baz was AND'd with everything).
    \fB\-\-constraint="foo&(bar|baz)"\fR requests nodes with foo and at least
    one of bar or baz.
    \fBNOTE\fR: OR within parentheses should not be used with a KNL
    NodeFeatures plugin but is supported by the helpers NodeFeatures plugin.
    .RE
    .IP

    .TP
    \fB\-\-container\fR=<\fIpath_to_container\fR>
    Absolute path to OCI container bundle.
    .IP

    .TP
    \fB\-\-container-id\fR=<\fIcontainer_id\fR>
    Unique name for OCI container.
    .IP

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

    \fBNOTE\fR: This option will only work with the \fBtopology/flat\fR plugin.
    Other topology plugins modify the node ordering and prevent this option from
    taking effect.
    .IP

    .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.
    If AllowSpecResourcesUsage is enabled a job can override the CoreSpecCount of
    all its allocated nodes with this option.
    The overridden Specialized Cores will still be reserved for system processes.
    above when task/affinity plugin is enabled.
    .br
    \fBNOTE\fR: This option may implicitly set the number of tasks (if \fB\-n\fR
    was not specified) as one task per requested thread.
    .IP

    .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, \fBp1\fR will be the minimum scaling frequency and
    \fBp2\fR will be the maximum scaling frequency. In that case the governor
    \fBp3\fR or CpuFreqDef cannot be UserSpace since it doesn't support a range.

    \fBp2\fR can be [#### | medium | high | highm1]. p2 must be greater than p1 and
    is incompatible with UserSpace governor.

    \fBp3\fR can be [Conservative | OnDemand | Performance | PowerSave | SchedUtil |
    UserSpace]
    which will set the governor to the corresponding value.

    If \fBp3\fR is UserSpace, the frequency scaling_speed, scaling_max_freq and
    scaling_min_freq will be statically set to the value defined by \fBp1\fR.

    Any requested frequency below the minimum available frequency will be rounded
    to the minimum available frequency. In the same way, any requested frequency
    above the maximum available frequency will be rounded to the maximum available
    frequency.

    The \fBCpuFreqDef\fR parameter in slurm.conf will be used to set the governor
    in absence of \fBp3\fR. If there's no \fBCpuFreqDef\fR, the default governor
    will be to use the system current governor set in each cpu. Specifying a
    range without \fBCpuFreqDef\fR or a specific governor is therefore not allowed.

    Acceptable values at present include:
    .RS
    .TP 14
    \fB####\fR
    frequency in kilohertz
    .IP

    .TP
    \fBMedium\fR
    attempts to set a frequency in the middle of the available range
    .IP

    .TP
    \fBConservative\fR
    attempts to use the Conservative CPU governor
    .IP

    .TP
    \fBOnDemand\fR
    attempts to use the OnDemand CPU governor (the default value)
    .IP

    .TP
    \fBPerformance\fR
    attempts to use the Performance CPU governor
    .IP

    .TP
    \fBPowerSave\fR
    attempts to use the PowerSave CPU governor
    .IP

    .TP
    \fBUserSpace\fR
    attempts to use the UserSpace CPU governor
    .IP

    .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
    error is logged, but the job step is allowed to continue.
    .RE
    .IP

    .TP
    \fB\-\-cpus\-per\-gpu\fR=<\fIncpus\fR>
    Request that \fIncpus\fR processors be allocated per allocated GPU.
    Steps inheriting this value will imply \-\-exact.
    Not compatible with the \fB\-\-cpus\-per\-task\fR option.
    .IP

    .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. Note that if neither \fBDefaultTime\fR nor
    \fBMaxTime\fR are configured on the partition the job is in, the job will
    need to specify some form of time limit (\-\-time[\-min]) if a deadline
    is to be used.

    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]]
    .br
    midnight, elevenses (11 AM), noon, fika (3 PM), teatime (4 PM), or tomorrow

    One or more time strings may be specified (e.g., 'tomorrow18:00'). If there is
    a conflict between them, the last one will silently take precedence.
    .IP

    .TP
    \fB\-\-delay\-boot\fR=<\fIminutes\fR>
    <\fIdependency_list\fR> is of the form
    <\fItype:job_id[:job_id][,type:job_id[:job_id]]\fR> or
    <\fItype:job_id[:job_id][?type:job_id[:job_id]]\fR>.
    All dependencies must be satisfied if the "," separator is used.
    Any dependency may be satisfied if the "?" separator is used.
    Only one separator may be used. For instance:
    .nf
    -d afterok:20:21,afterany:23
    .fi
    means that the job can run only after a 0 return code of jobs 20 and 21
    AND completion of job 23. However:
    .nf
    -d afterok:20:21?afterany:23
    .fi
    means that any of the conditions (afterok:20 OR afterok:21 OR afterany:23)
    will be enough to release the job.
    Many jobs can share the same dependency and these jobs may even belong to
    different users. The value may be changed after job submission using the
    scontrol command.
    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.
    .IP
    .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.
    .IP

    .TP
    \fBafterany:job_id[:jobid...]\fR
    This job can begin execution after the specified jobs have terminated.
    This is the default dependency type.
    .IP

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

    .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). If the specified job is not an array, this is treated the
    same as afterok.
    .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).
    This job must be submitted while the specified job is still active or within
    \fBMinJobAge\fR seconds after the specified job has ended.
    If the dependent job id is not found and is on the same cluster as the job
    submission, the job is rejected. If the dependent job id is not found and is on
    a different cluster from the job submission, the dependency is marked as
    failed.
    .IP

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

    .TP
    \fB\-m\fR, \fB\-\-distribution\fR={*|block|cyclic|arbitrary|plane=<\fIsize\fR>}[:{*|block|cyclic|fcyclic}[:{*|block|cyclic|fcyclic}]][,{Pack|NoPack}]

    Specify alternate distribution methods for remote processes.
    For job allocation, this sets environment variables that will be used by
    subsequent srun requests and also affects which cores will be selected for
    job allocation.

    This option controls the distribution 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 first ":") controls the distribution of tasks to nodes.
    The second distribution method (after the first ":")
    controls the distribution of allocated CPUs across sockets for binding
    to tasks. The third distribution method (after the second ":") controls
    the distribution of allocated CPUs across cores for binding to tasks.
    The second and third distributions apply only if task affinity is enabled.
    The third distribution is supported only if the task/cgroup plugin is
    configured. The default value for each distribution type is specified by *.

    Note that with select/cons_tres, the number of CPUs
    allocated to each socket and node may be different. Refer to
    https://slurm.schedmd.com/mc_support.html
    for more information on resource allocation, distribution of tasks to
    nodes, and binding of tasks to CPUs.
    .RS
    First distribution method (distribution of tasks across nodes):

    .TP

    .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_tres, 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.
    .IP

    .TP
    .B plane
    The tasks are distributed in blocks of size <\fIsize\fR>. The size must be given
    or SLURM_DIST_PLANESIZE must be set. 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
    https://slurm.schedmd.com/mc_support.html and
    https://slurm.schedmd.com/dist_plane.html
    .IP

    .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 override 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.
    .br
    \fBNOTE\fR: If the number of tasks is given and a list of requested nodes is
    also given, the number of nodes used from that list will be reduced to match
    that of the number of tasks if the number of nodes in the list is greater than
    the number of tasks.
    .IP

    .LP
    .TP
    .B cyclic
    The cyclic distribution method will distribute allocated CPUs for
    binding to a given task consecutively from the same socket, and
    from the next consecutive socket for the next task, in a
    round\-robin fashion across sockets.
    Tasks requiring more than one CPU will have all of those CPUs allocated on a
    single socket if possible.
    .br
    \fBNOTE\fR: In nodes with hyper-threading enabled, a task not requesting full
    cores may be distributed across sockets. This can be avoided by specifying
    \fB\-\-ntasks\-per\-core=1\fR, which forces tasks to allocate full cores.
    .IP

    .TP
    .B fcyclic
    The fcyclic distribution method will distribute allocated CPUs
    for binding to tasks from consecutive sockets in a
    round\-robin fashion across the sockets.
    Tasks requiring more than one CPU will have each CPUs allocated in a cyclic
    fashion across sockets.
    .IP

    .LP
    Third distribution method (distribution of CPUs across cores for binding):

    .TP
    .B *
    Use the default method for distributing CPUs across cores
    (inherited from second distribution method).
    .IP

    .TP
    .B block
    The block distribution method will distribute allocated CPUs
    consecutively from the same core for binding to tasks, before using
    the next consecutive core.
    .IP

    .TP
    .B cyclic
    The cyclic distribution method will distribute allocated CPUs for
    binding to a given task consecutively from the same core, and
    from the next consecutive core for the next task, in a
    round\-robin fashion across cores.
    .IP

    .TP
    .B fcyclic
    The fcyclic distribution method will distribute allocated CPUs
    for binding to tasks from consecutive cores in a
    round\-robin fashion across the cores.
    Rather than packing a job step's tasks as tightly as possible on the nodes,
    distribute them evenly.
    This user option will supersede the SelectTypeParameters CR_Pack_Nodes
    configuration parameter.
    .RE
    .IP

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

    .TP
    \fB\-\-exclusive\fR[={user|mcs|topo}]
    The job allocation can not share nodes (or topology segment  with the "=topo")
    with other running jobs (or just other users with the "=user" option or
    with the "=mcs" option).
    If user/mcsi/topo are not specified (i.e. the job allocation can not share nodes with
    other running jobs), the job is allocated all CPUs and GRES on all nodes in the
    allocation, but is only allocated as much memory as it requested. This is by
    design to support gang scheduling, because suspended jobs still reside in
    memory. To request all the memory on a node, use \fB\-\-mem=0\fR.
    The default shared/exclusive behavior depends on system configuration and the
    partition's \fBOverSubscribe\fR option takes precedence over the job's option.
    \fBNOTE\fR: Since shared GRES (MPS) cannot be allocated at the same time as a
    sharing GRES (GPU) this option only allocates all sharing GRES and no underlying
    shared GRES.

    \fBNOTE\fR: This option is mutually exclusive with \fB\-\-oversubscribe\fR.
    .IP

    .TP
    \fB\-\-extra\fR=<\fIstring\fR>
    An arbitrary string enclosed in single or double quotes if using spaces or some
    special characters.

    If \fBSchedulerParameters=extra_constraints\fR is enabled, this string is used
    for node filtering based on the \fIExtra\fR field in each node.
    .IP

    .TP
    \fB\-B\fR, \fB\-\-extra\-node\-info\fR=<\fIsockets\fR>[:\fIcores\fR[:\fIthreads\fR]]
    Restrict node selection to nodes with at least the specified number of
    sockets, cores per socket and/or threads per core.
    .br
    \fBNOTE\fR: These options do not specify the resource allocation size.
    Each value specified is considered a minimum.
    An asterisk (*) can be used as a placeholder indicating that all available
    resources of that type are to be utilized. Values can also be specified as
    min\-max. The individual levels can also be specified in separate options if
    desired:
    .nf
    \fBNOTE\fR: This option is mutually exclusive with \fB\-\-hint\fR,
    \fB\-\-threads\-per\-core\fR and \fB\-\-ntasks\-per\-core\fR.
    .br
    \fBNOTE\fR: This option may implicitly set the number of tasks (if \fB\-n\fR
    was not specified) as one task per requested thread.
    .IP

    .TP
    \fB\-\-gpu\-bind\fR=[verbose,]<\fItype\fR>
    Equivalent to \-\-tres\-bind=gres/gpu:[verbose,]<\fItype\fR>
    See \fB\-\-tres\-bind\fR for all options and documentation.
    .IP

    .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:
    .IP
    .RS
    .TP 10
    \fBlow\fR
    the lowest available frequency.
    .IP

    .TP
    \fBmedium\fR
    attempts to set a frequency in the middle of the available range.
    .IP

    .TP
    \fBhigh\fR
    the highest available frequency.
    .IP

    .TP
    \fBhighm1\fR
    nodes need different GPU types.
    .IP

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

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

    .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.
    This option will implicitly set \-\-tres\-bind=gres/gpu:per_task:<gpus_per_task>,
    or if multiple gpu types are specified
    \-\-tres\-bind=gres/gpu:per_task:<gpus_per_task_type_sum>. However, that can be
    overridden with an explicit \-\-tres\-bind=gres/gpu specification.
    .br
    .IP

    .TP
    \fB\-\-gres\fR=<\fIlist\fR>
    Specifies a comma\-delimited list of generic consumable resources requested per
    node.
    The format for each entry in the list is "name[[:type]:count]".
    The \fIname\fR is the type of consumable resource (e.g. gpu).
    "\-\-gres=help".
    .IP

    .TP
    \fB\-\-gres\-flags\fR=<\fItype\fR>
    Specify generic resource task binding options.
    .IP
    .RS

    .TP
    .B multiple\-tasks\-per\-sharing
    Negate \fBone\-task\-per\-sharing\fR. This is useful if it is set by default in
    \fBSelectTypeParameters\fR.
    .IP

    .TP
    .B disable\-binding
    Negate \fBenforce\-binding\fR. This is useful if it is set by default in
    \fBSelectTypeParameters\fR.
    .IP

    .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 can be set by default in \fBSelectTypeParameters\fR.
    .br
    \fBNOTE\fR: This option is specific to \fBSelectType=cons_tres\fR.
    .br
    \fBNOTE\fR: This option can give undefined results if attempting to enforce
    binding on multiple gres on multiple sockets.
    .IP

    .TP
    .B one\-task\-per\-sharing
    Do not allow different tasks in to be allocated shared gres from the same
    sharing gres.
    .br
    \fBNOTE\fR: This flag is only enforced if shared gres are requested with
    \-\-tres\-per\-task.
    .br
    \fBNOTE\fR: This option can be set by default with
    \fBSelectTypeParameters=ONE_TASK_PER_SHARING_GRES\fR.
    .br
    \fBNOTE\fR: This option implies specific values for certain related options,
    which prevents its use with any user\-specified values for
    \fB\-\-ntasks\-per\-core\fR, \fB\-\-cores\-per\-socket\fR,
    \fB\-\-sockets\-per\-node\fR, \fB\-\-threads\-per\-core\fR or \fB\-B\fR.
    These conflicting options will override \fB\-\-hint\fR when specified as
    command line arguments. If a conflicting option is specified as an environment
    variable, \-\-hint as a command line argument will take precedence.
    .IP
    .RS
    .TP
    .B compute_bound
    Select settings for compute bound applications:
    use all cores in each socket, one thread per core.
    .IP

    .TP
    .B memory_bound
    Select settings for memory bound applications:
    use only one core in each socket, one thread per core.
    .IP

    .TP
    .B multithread
    Use extra threads with in\-core multi\-threading
    which can benefit communication intensive applications.
    Only supported with the task/affinity plugin.
    .IP

    .TP
    .B nomultithread
    Don't use extra threads with in\-core multi\-threading;
    restricts tasks to one thread per core.
    Only supported with the task/affinity plugin.
    .IP

    .TP
    .B help
    show this help message
    .RE
    .IP

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

    .TP
    \fB\-I\fR, \fB\-\-immediate\fR[=<\fIseconds\fR>]
    exit if resources are not available within the
    time period specified.
    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.
    .IP

    .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 \fB\-\-kill\-command\fR 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".
    .IP

    .TP
    \fB\-L\fR, \fB\-\-licenses\fR=<\fIlicense\fR>[@\fIdb\fR][:\fIcount\fR][,\fIlicense\fR[@\fIdb\fR][:\fIcount\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 licenses can be requested. If they are separated by a comma (','
    meaning AND), then all requested licenses are required for the job. For example,
    "\-\-licenses=foo:4,bar". If they are separated by a pipe ('|' meaning OR),
    then only one of the license requests are required for the job. For example,
    "\-\-licenses=foo:4|bar". AND and OR cannot both be used.

    \fBNOTE\fR: When submitting heterogeneous jobs, license requests
    may only be made on the first component job.
    For example "salloc \-L ansys:2 :".

    \fBNOTE\fR: If licenses are tracked in AccountingStorageTres and OR is used,
    ReqTRES will display all requested tres separated by commas. AllocTRES will
    display only the license that was allocated to the job.

    \fBNOTE\fR: When a job requests OR'd licenses, Slurm will attempt to allocate
    the licenses in the order in which they are requested. This specified order
    will take precedence even if the rest of requested licenses could be satisfied
    on a requested reservation. This also applies to backfill planning when
    \fBSchedulerParameters=bf_licenses\fR is configured.
    .IP

    .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
    \fB\-\-mail\-type\fR. This may be a full email address or a username. If a
    username is specified, the value from \fBMailDomain\fR in slurm.conf will be
    appended to create an email address.
    The default value is the submitting user.
    .IP

    .TP
    \fB\-\-mcs\-label\fR=<\fImcs\fR>
    Used only when a compatible \fBMCSPlugin\fR is enabled. This parameter is a
    group that the user belongs to (\fBmcs/group\fR) or an arbitrary label string
    (\fBmcs/label\fR). In both cases, no label will be assigned by default. Refer to
    the MCS documentation for more details: <https://slurm.schedmd.com/mcs.html>
    .IP

    .TP
    \fB\-\-mem\fR=<\fIsize\fR>[\fIunits\fR]
    Specify the real memory required per node.
    Default units are megabytes.
    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.

    \fBNOTE\fR: 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.

    \fBNOTE\fR: The memory used by each slurmstepd process is included in the job's
    total memory usage. It typically consumes between 20MiB and 200MiB, though this
    can vary depending on system configuration and any loaded plugins.

    \fBNOTE\fR: Memory requests will not be strictly enforced unless Slurm is
    configured to use an enforcement mechanism. See \fBConstrainRAMSpace\fR in
    the \fBcgroup.conf\fR(5) man page and \fBOverMemoryKill\fR in the
    \fBslurm.conf\fR(5) man page for more details.
    .IP

    .TP
    \fB\-\-mem\-bind\fR=[{quiet|verbose},]<\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.
    	SLURM_MEM_BIND_PREFER
    	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:
    .IP
    .RS
    .TP
    .B help
    show this help message
    .IP

    .TP
    .B local
    Use memory local to the processor in use
    .IP

    .TP
    .B map_mem:<list>
    Bind by setting memory masks on tasks (or ranks) as specified where <list> is
    fR(5) man page for a full list of flags. The environment
    variable takes precedence over the setting in the slurm.conf.
    .IP

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

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

    .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
    .TP
    \fBSLURM_CONTAINER_ID\fR
    OCI id for job.
    Only set if \fB\-\-container-id\fR is specified.
    .IP

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

    .TP
    \fBSLURM_CPUS_PER_TASK\fR
    Number of CPUs requested per task.
    Only set if either the \fB\-\-cpus\-per\-task\fR option or the
    \fB\-\-tres\-per\-task=cpu=#\fR option is specified.
    .IP

    .TP
    \fBSLURM_DIST_PLANESIZE\fR
    Plane distribution size. Only set for plane distributions.
    See \fB\-m, \-\-distribution\fR.
    .IP

    .TP
    \fBSLURM_DISTRIBUTION\fR
    Only set if the \fB\-m, \-\-distribution\fR option is specified.
    .IP

    .TP
    \fBSLURM_GPU_BIND\fR
    Requested binding of tasks to GPU.
    Only set if the \fB\-\-gpu\-bind\fR option is specified.
    .IP

    .TP
    \fBSLURM_GPU_FREQ\fR
    Requested GPU frequency.
    Only set if the \fB\-\-gpu\-freq\fR option is specified.
    .IP

    .TP
    \fBSLURM_GPUS\fR
    Number of GPUs requested.
    Only set if the \fB\-G, \-\-gpus\fR option is specified.
    .IP

    .TP
    \fBSLURM_GPUS_PER_NODE\fR
    Requested GPU count per allocated node.
    Only set if the \fB\-\-gpus\-per\-node\fR option is specified.
    \fBSLURM_JOB_ACCOUNT\fR
    Account name associated of the job allocation.
    .IP

    .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_tres\fR plugin allocates individual
    CPUs to jobs, so this number indicates the number of CPUs allocated to the job.
    .IP

    .TP
    \fBSLURM_JOB_END_TIME\fR
    The UNIX timestamp for a job's projected end time.
    .IP

    .TP
    \fBSLURM_JOB_GPUS\fR
    The global GPU IDs of the GPUs allocated to this job. The GPU IDs are not
    relative to any device cgroup, even if devices are constrained with task/cgroup.
    Only set in batch and interactive jobs.
    .IP

    .TP
    \fBSLURM_JOB_ID\fR
    The ID of the job allocation.
    .IP

    .TP
    \fBSLURM_JOB_LICENSES\fR
    Name and count of any license(s) requested.
    .IP

    .TP
    \fBSLURM_JOB_NODELIST\fR
    List of nodes allocated to the job.
    .IP

    .TP
    \fBSLURM_JOB_NUM_NODES\fR
    Total number of nodes in the job allocation.
    .IP

    .TP
    \fBSLURM_JOB_PARTITION\fR
    \fBSLURM_JOB_SEGMENT_SIZE\fR
    The size of the segments that was used to create the job allocation.
    Only set if \-\-segment\fR is specified.
    .IP

    .TP
    \fBSLURM_JOB_START_TIME\fR
    UNIX timestamp for a job's start time.
    .IP

    .TP
    \fBSLURM_JOBID\fR
    The ID of the job allocation. See \fBSLURM_JOB_ID\fR. Included for backwards
    compatibility.
    .IP

    .TP
    \fBSLURM_MEM_BIND\fR
    Set to value of the \fB\-\-mem\-bind\fR option.
    .IP

    .TP
    \fBSLURM_MEM_BIND_LIST\fR
    Set to bit mask used for memory binding.
    .IP

    .TP
    \fBSLURM_MEM_BIND_PREFER\fR
    Set to "prefer" if the \fB\-\-mem\-bind\fR option includes the prefer option.
    .IP

    .TP
    \fBSLURM_MEM_BIND_TYPE\fR
    Set to the memory binding type specified with the \fB\-\-mem\-bind\fR option.
    Possible values are "none", "rank", "map_mem:", "mask_mem:" and "local".
    .IP

    .TP
    \fBSLURM_MEM_BIND_VERBOSE\fR
    Set to "verbose" if the \fB\-\-mem\-bind\fR option includes the verbose option.
    Set to "quiet" otherwise.
    .IP

    .TP
    \fBSLURM_MEM_PER_CPU\fR
    Same as \fB\-\-mem\-per\-cpu\fR
    .IP

    .TP
    \fBSLURM_MEM_PER_GPU\fR
    Requested memory per allocated GPU.
    Only set if the \fB\-\-mem\-per\-gpu\fR option is specified.
    Total number of nodes in the job allocation. See \fBSLURM_JOB_NUM_NODES\fR.
    Included for backwards compatibility.
    .IP

    .TP
    \fBSLURM_NODELIST\fR
    List of nodes allocated to the job. See \fBSLURM_JOB_NODELIST\fR. Included
    for backwards compatibility.
    .IP

    .TP
    \fBSLURM_NPROCS\fR
    Same as \fBSLURM_NTASKS\fR. Included for backwards compatibility.
    .IP

    .TP
    \fBSLURM_NTASKS\fR
    Set to value of the \fB\-\-ntasks\fR option, if specified. Or, if any of the
    \fB\-\-ntasks\-per\-*\fR options are specified, set to the number of tasks in
    the job.

    \fBNOTE\fR: This is also an input variable for srun, so if set it will
    effectively set the \fB\-\-ntasks\fR option for srun when called from the
    salloc shell.
    .IP

    .TP
    \fBSLURM_NTASKS_PER_CORE\fR
    Set to value of the \fB\-\-ntasks\-per\-core\fR option, if specified.
    .IP

    .TP
    \fBSLURM_NTASKS_PER_GPU\fR
    Set to value of the \fB\-\-ntasks\-per\-gpu\fR option, if specified.
    .IP

    .TP
    \fBSLURM_NTASKS_PER_NODE\fR
    Set to value of the \fB\-\-ntasks\-per\-node\fR option, if specified.
    .IP

    .TP
    \fBSLURM_NTASKS_PER_SOCKET\fR
    Set to value of the \fB\-\-ntasks\-per\-socket\fR option, if specified.
    .IP

    .TP
    \fBSLURM_OOMKILLSTEP\fR
    Same as \fB\-\-oom\-kill\-step\fR
    .IP

    .TP
    .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.
    .IP

    .TP
    \fBSLURM_SUBMIT_HOST\fR
    The hostname of the computer from which \fBsalloc\fR was invoked.
    .IP

    .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 two
    tasks and the fourth node will execute one task.
    .IP

    .TP
    \fBSLURM_THREADS_PER_CORE\fR
    This is only set if \fB\-\-threads\-per\-core\fR or
    \fBSALLOC_THREADS_PER_CORE\fR were specified. The value will be set to the
    value specified by \fB\-\-threads\-per\-core\fR or
    \fBSALLOC_THREADS_PER_CORE\fR. This is used by subsequent srun calls within the
    job allocation.
    .IP

    .TP
    \fBSLURM_TRES_PER_TASK\fR
    Set to the value of \fB\-\-tres\-per\-task\fR. If \fB\-\-cpus\-per\-task\fR or
    \fB\-\-gpus\-per\-task\fR is specified, it is also set in
    \fBSLURM_TRES_PER_TASK\fR as if it were specified in \fB\-\-tres\-per\-task\fR.
    .IP

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

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

    .TP
    To create a heterogeneous job with 3 components, each allocating a unique set \
    of nodes:
    .IP
    .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\-2022 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
    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\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)