    \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, \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 SlurmDBD must be up for this option to work properly.
    .IP

    .TP
    \fB\-\-comment\fR=<\fIstring\fR>
    An arbitrary comment.
    .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
    \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."
    If requesting more than one feature and using node counts, the request
    \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 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.

    \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

    .TP
    \fBBrackets\fR
    Brackets can be used to indicate that you are looking for a set of nodes with
    the different requirements contained within the brackets. For example,
    .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: If the SelectType is cons_tres this option won't be honored
    with the \fBtopology/tree\fR or \fBtopology/3d_torus\fR
    plugins, both of which can modify the node ordering.
    .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.
    The job will get an implicit \fB--exclusive\fR allocation for the rest of
    the Cores on the nodes, resulting in the job's processes being able to use (and
    being charged for) all the Cores on the nodes except for the overridden
    Specialized Cores.
    This option can not be used with the \fB\-\-thread\-spec\fR option.

    .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
    \fBLow\fR
    the lowest available frequency
    .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.

    \fBNOTE\fR: Setting the frequency for just the CPUs of the job step
    implies that the tasks are confined to those CPUs.  If task
    confinement (i.e. the task/affinity TaskPlugin is enabled, or the task/cgroup
    TaskPlugin is enabled with "ConstrainCores=yes" set in cgroup.conf) is not
    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]]
    .IP

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

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

    .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).
    This job must be submitted while the specified job is still active or within
    \fBMinJobAge\fR seconds after the specified job has ended.
    .IP

    .TP
    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
    .B *
    Use the default method for distributing tasks to nodes (block).
    .IP

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

    .TP
    .B cyclic
    The cyclic distribution method will distribute tasks to a node such
    that consecutive tasks are distributed over consecutive nodes (in a
    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
    Second distribution method (distribution of CPUs across sockets for binding):

    .TP
    .B *
    Use the default method for distributing CPUs across sockets (cyclic).
    .IP

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

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

    .LP
    Optional control for task distribution over nodes:

    .TP
    .B Pack
    Rather than evenly distributing a job step's tasks evenly across its allocated
    nodes, pack them as tightly as possible on the nodes.
    This only applies when the "block" task distribution method is used.
    .IP

    .TP
    .B NoPack
    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
    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
        \fB\-\-sockets\-per\-node\fR=<\fIsockets\fR>
        \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_tres, 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.
    .br
    \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
    replicating the login environment.
    If \fImode\fR is not specified, the mode established at Slurm build time
    is used.
    Examples of use include "\-\-get\-user\-env", "\-\-get\-user\-env=10"
    "\-\-get\-user\-env=10L", and "\-\-get\-user\-env=S".
    \fBNOTE\fR: This option only works if the caller has an
    effective uid of "root".
    .IP

    .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.
    .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
    .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".
    See also the \fB\-\-gpus\-per\-node\fR, \fB\-\-gpus\-per\-socket\fR and
    \fB\-\-gpus\-per\-task\fR options.
    .br
    \fBNOTE\fR: The allocation has to contain at least one GPU per node.
    .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>,
    but that can be overridden with an explicit \-\-tres\-bind=gres/gpu
    specification.
    .br
    .IP
    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", "\-\-gres=gpu:kepler:2", and
    "\-\-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.
    .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
    \fB\-\-hint\fR=<\fItype\fR>
    Bind tasks according to application hints.
    .br
    \fBNOTE\fR: This option cannot be used in conjunction with
    \fB\-\-ntasks\-per\-core\fR, \fB\-\-threads\-per\-core\fR or \fB\-B\fR.
    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 [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.
    .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.
    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
    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 license names should be comma separated (e.g.
    "\-\-licenses=foo:4,bar").

    \fBNOTE\fR: When submitting heterogeneous jobs, license requests
    may only be made on the first component job.
    For example "salloc \-L ansys:2 :".
    .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
    BEGIN, END, FAIL, INVALID_DEPEND, REQUEUE, and STAGE_OUT), INVALID_DEPEND
    (dependency never satisfied), STAGE_OUT (burst buffer stage out and teardown
    completed), TIME_LIMIT, TIME_LIMIT_90 (reached 90 percent of time limit),
    TIME_LIMIT_80 (reached 80 percent of time limit), and TIME_LIMIT_50 (reached 50
    percent of time limit).
    Multiple \fItype\fR values may be specified in a comma separated list.
    The user to be notified is indicated with \fB\-\-mail\-user\fR.
    .IP

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

    .TP
    \fB\-\-mcs\-label\fR=<\fImcs\fR>
    Used only when the mcs/group plugin is enabled.
    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: 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.
    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 its assigned CPU. \fBThe use of any type other than
    "none" or "local" is not recommended.\fR

    \fBNOTE\fR: 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:
    .IP
    .RS
    .TP
    .B help
    first ID specified in the list, etc.).
    NUMA IDs are interpreted as decimal values unless they are preceded
    with '0x' in which case they interpreted as hexadecimal values.
    If the number of tasks (or ranks) exceeds the number of elements in this list,
    elements in the list will be reused as needed starting from the beginning of
    the list.
    To simplify support for large task counts, the lists may follow a map with an
    asterisk and repetition count.
    For example "map_mem:0x0f*4,0xf0*4".
    For predictable binding results, all CPUs for each node in the job should be
    allocated to the job.
    .IP

    .TP
    .B mask_mem:<list>
    Bind by setting memory masks on tasks (or ranks) as specified where <list> is