    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"
    sbatch submits a batch script to Slurm.  The batch script may be given to
    sbatch through a file name on the command line, or if no file name is specified,
    sbatch will read in a script from standard input. The batch script may contain
    options preceded with "#SBATCH" before any executable commands in the script.
    sbatch will stop processing further #SBATCH directives once the first
    non\-comment non\-whitespace line has been reached in the script.

    sbatch exits immediately after the script is successfully transferred to the
    Slurm controller and assigned a Slurm job ID.  The batch script is not
    necessarily granted resources immediately, it may sit in the queue of pending
    jobs for some time before its required resources become available.

    By default both standard output and standard error are directed to a file of
    the name "slurm\-%j.out", where the "%j" is replaced with the job allocation
    number. The file will be generated on the first node of the job allocation.
    Other than the batch script itself, Slurm does no movement of user files.

    When the job allocation is finally granted for the batch script, Slurm
    runs a single copy of the batch script on the first node in the set of
    allocated nodes.

    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

    .SH "RETURN VALUE"
    sbatch will return 0 on success or error code on failure.

    .SH "SCRIPT PATH RESOLUTION"

    The batch script is resolved in the following order:
    .br

    1. If script starts with ".", then path is constructed as:
    current working directory / script
    .br
    2. If script starts with a "/", then path is considered absolute.
    .br
    3. If script is in current working directory.
    .br
    4. If script can be resolved through PATH. See \fBpath_resolution\fR(7).
    .br
    .P
    Current working directory is the calling process working directory unless the
    .TP
    \fB\-\-acctg\-freq\fR=<\fIdatatype\fR>=<\fIinterval\fR>[,<\fIdatatype\fR>=<\fIinterval\fR>...]
    Define the job accounting and profiling sampling intervals in seconds.
    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:
    .IP
    .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
    running tasks from this job array to 4.
    The minimum index value is 0.
    the maximum value is one less than the configuration parameter MaxArraySize.
    \fBNOTE\fR: Currently, federated job arrays only run on the local cluster.
    .IP

    .TP
    \fB\-\-batch\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 batch
    script using this options.
    For example a job's allocation may include both Intel Haswell and KNL nodes
    with features "haswell" and "knl" respectively.
    On such a configuration the batch script would normally benefit by executing
    on a faster Haswell node.
    This would be specified using the option "\-\-batch=haswell".
    The specification can include AND and OR operators using the ampersand and
    vertical bar separators. For example:
    "\-\-batch=haswell|broadwell" or "\-\-batch=haswell|big_memory".
    The \-\-batch argument must be a subset of the job's
    \fB\-\-constraint\fR=<\fIlist\fR> argument (i.e. the job can not request only
    KNL nodes, but require the script to execute on a Haswell node).
    If the request can not be satisfied from the resources allocated to the job,
    the batch script will execute on the first node of the job allocation.
    .IP

    .TP
    \fB\-\-bb\fR=<\fIspec\fR>
    Burst buffer specification. The form of the specification is system dependent.
    Also see \fB\-\-bbf\fR.
    When the \fB\-\-bb\fR option is used, Slurm parses this option and creates a
    temporary burst buffer script file that is used internally by the burst buffer
    plugins. See Slurm's burst buffer guide for more information and examples:
    .br
    https://slurm.schedmd.com/burst_buffer.html
    .IP

    .TP
    \fB\-\-bbf\fR=<\fIfile_name\fR>
    Path of file containing burst buffer specification.
    The form of the specification is system dependent.
    These burst buffer directives will be inserted into the submitted batch script.
    See Slurm's burst buffer guide for more information and examples:
    .br
    https://slurm.schedmd.com/burst_buffer.html
    .IP

    .TP
    \fB\-b\fR, \fB\-\-begin\fR=<\fItime\fR>
    Submit the batch script to the Slurm controller immediately, like normal, but
    tell the controller to defer the allocation of the job until the specified time.

    job tomorrow with the keyword \fItomorrow\fR.
    The value may be changed after job submission using the
    \fBscontrol\fR command.
    For example:
    .IP
    .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
    .IP

    .TP
    \fB\-D\fR, \fB\-\-chdir\fR=<\fIdirectory\fR>
    Set the working directory of the batch script to \fIdirectory\fR before
    it is executed. The path can be specified as full path or relative path
    to the directory where the command is executed.
    .IP

    .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. If the "!" option is included, Slurm
    will attempt to submit a sibling job to a cluster that has none 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 the
    \fB\-\-export\fR option to control environment variables exported
    between clusters.
    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
    must have square brackets surrounding it.

    \fBNOTE\fR: This option is not supported by the helpers NodeFeatures plugin.
    Heterogeneous jobs can be used instead.
    .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
    .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,
    \fB\-\-constraint="[(rack1|rack2)*1&(rack3)*2]"\fR will get you one node with
    either the "rack1" or "rack2" features and two nodes with the "rack3" feature.
    If requesting more than one feature and using node counts, the request
    must have square brackets surrounding it.

    \fBNOTE\fR: Brackets are only reserved for \fBMultiple Counts\fR and
    \fBMatching OR\fR syntax.
    AND operators require a count for each feature inside square brackets
    (i.e. "[quad*2&hemi*1]"). Slurm will only allow a single set of bracketed
    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.
    .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.

    \fBNOTE\fR: Explicitly setting a job's specialized core value implicitly sets
    the --exclusive option.
    .IP

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

    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:
    .IP
    .RS
    .TP 14
    \fB####\fR
    frequency in kilohertz
    .IP

    .TP
    \fBLow\fR
    the lowest available frequency
    .IP

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

    .TP
    \fBHighM1\fR
    (high minus one) will select the next highest available frequency
    .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

    .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
    configured, this parameter is ignored.

    \fBNOTE\fR: When the step completes, the frequency and governor of each
    selected CPU is reset to the previous values.

    \fBNOTE\fR: When submitting jobs with  the \fB\-\-cpu\-freq\fR option
    with linuxproc as the ProctrackType can cause jobs to run too quickly before
    Accounting is able to poll for job information. As a result not all of
    accounting information will be present.
    .RE
    .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 the Slurm controller that ensuing job steps will require \fIncpus\fR
    number of processors per task.  Without this option, the controller will
    just try to allocate one processor per task.

    For instance,
    consider an application that has 4 tasks, each requiring 3 processors.  If our

    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

    .TP
    \fB\-d\fR, \fB\-\-dependency\fR=<\fIdependency_list\fR>
    Defer the start of this job until the specified dependencies have been
    satisfied.
    <\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
    .IP
    means that the job can run only after a 0 return code of jobs 20 and 21
    AND the 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,
    \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
    \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.
    .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.
    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
    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
    .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
    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).
    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
    .IP

    .TP
    \fB\-e\fR, \fB\-\-error\fR=<\fIfilename_pattern\fR>
    Instruct Slurm to connect the batch script's standard error directly to the
    file name specified in the "\fIfilename pattern\fR".
    By default both standard output and standard error are directed to the same file.
    For job arrays, the default file name is "slurm\-%A_%a.out", "%A" is replaced
    by the job ID and "%a" with the array index.
    For other jobs, the default file name is "slurm\-%j.out", where the "%j" is
    replaced by the job ID.
    See the \fBfilename pattern\fR section below for filename specification options.
    .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}]
    The job allocation can not share nodes with other running jobs (or just other
    users with the "=user" option or with the "=mcs" option).
    If user/mcs 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
    Identify which environment variables from the submission environment are
    propagated to the launched application. Note that SLURM_* variables are
    always propagated.
    .IP
    .RS
    .TP 10
    \fB\-\-export\fR=ALL
    Default mode if \fB\-\-export\fR is not specified. All of the user's environment
    will be loaded (either from the caller's environment or from a clean environment
    if \fI\-\-get\-user\-env\fR is specified).
    .IP

    .TP
    \fB\-\-export\fR=NIL
    Only SLURM_* and SPANK option variables from the user environment will be
    defined. User must use absolute path to the binary to be executed that will
    define the environment.
    User can not specify explicit environment variables with "NIL".

    Unlike NONE, NIL will not automatically create a user's environment using the
    \fI\-\-get\-user\-env\fR mechanism.
    .IP

    .TP
    \fB\-\-export\fR=NONE
    Only SLURM_* and SPANK option variables from the user environment will be
    defined. User must use absolute path to the binary to be executed that will
    define the environment.
    User can not specify explicit environment variables with "NONE".
    However, Slurm will then implicitly attempt to load the user's environment on
    the node where the script is being executed, as if \fI\-\-get\-user\-env\fR was
    specified.

    This option is particularly important for jobs that are submitted on one cluster
    and execute on a different cluster (e.g. with different paths).
    To avoid steps inheriting environment export settings (e.g. "NONE") from
    sbatch command, the environment variable SLURM_EXPORT_ENV should be set to
    "ALL" in the job script.
    .IP

    .TP
    \fB\-\-export\fR=[\fIALL\fR,]<\fIenvironment_variables\fR>
    Exports all SLURM_* and SPANK option environment variables along with explicitly
    defined variables. Multiple environment variable names should be comma
    separated.
    Environment variable names may be specified to propagate the current
    value (e.g. "\-\-export=EDITOR") or specific values may be exported
    (e.g. "\-\-export=EDITOR=/bin/emacs"). If "ALL" is specified, then all user
    environment variables will be loaded and will take precedence over any
    explicitly given environment variables.
    .IP
    .RS 5
    .RE
    .RE
    .IP

    .TP
    \fB\-\-export\-file\fR={<\fIfilename\fR>|<\fIfd\fR>}
    If a number between 3 and OPEN_MAX is specified as the argument to
    this option, a readable file descriptor will be assumed (STDIN and
    STDOUT are not supported as valid arguments).  Otherwise a filename is
    assumed.  Export environment variables defined in <\fIfilename\fR> or
    read from <\fIfd\fR> to the job's execution environment. The
    content is one or more environment variable definitions of the form
    NAME=value, each separated by a null character.  This allows the use
    of special characters in environment definitions.
    .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,
    login environment. Clear any environment variables before calling sbatch
    that you do not want propagated to the spawned program.
    The optional \fItimeout\fR value is in seconds. Default value is 8 seconds.
    The optional \fImode\fR value control the "su" options.
    With a \fImode\fR value of "S", "su" is executed without the "\-" option.
    With a \fImode\fR value of "L", "su" is executed with the "\-" option,
    replicating the login environment.
    If \fImode\fR not specified, the mode established at Slurm build time
    is used.
    Example of use include "\-\-get\-user\-env", "\-\-get\-user\-env=10"
    "\-\-get\-user\-env=10L", and "\-\-get\-user\-env=S".
    .IP

    .TP
    \fB\-\-gid\fR=<\fIgroup\fR>
    If \fBsbatch\fR is run as root, and the \fB\-\-gid\fR option is used,
    submit the job with \fIgroup\fR's group access permissions.  \fIgroup\fR
    may be the group name or the numerical group ID.
    .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
    .RE
    .IP

    .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
    "g" or "G" (multiple of 1024 x 1024 x 1024),
    "t" or "T" (multiple of 1024 x 1024 x 1024 x 1024),
    "p" or "P" (multiple of 1024 x 1024 x 1024 x 1024 x 1024).
    The specified resources will be allocated to the job on each node.
    The available generic consumable resources is configurable by the system
    administrator.
    A list of available generic consumable resources will be printed and the
    command will exit if the option argument is "help".
    Examples of use include "\-\-gres=gpu:2", "\-\-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
    .IP

    .TP
    \fB\-\-hint\fR=<\fItype\fR>
    Bind tasks according to application hints.
    .br
    \fBNOTE\fR: This option cannot be used in conjunction with
    \fB\-\-ntasks\-per\-core\fR, \fB\-\-threads\-per\-core\fR or \fB\-B\fR.
    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\-\-ignore\-pbs\fR
    Ignore all "#PBS" and "#BSUB" options specified in the batch script.
    .IP

    .TP
    \fB\-i\fR, \fB\-\-input\fR=<\fIfilename_pattern\fR>
    read on sbatch's standard input.
    .IP

    .TP
    \fB\-\-kill\-on\-invalid\-dep\fR=<yes|no>
    If a job has an invalid dependency and it can never run this parameter tells
    Slurm to terminate it or not. A terminated job state will be JOB_CANCELLED.
    If this option is not specified the system wide behavior applies.
    By default the job stays pending with reason DependencyNeverSatisfied or if the
    kill_invalid_depend is specified in slurm.conf the job is terminated.
    .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").
    To submit jobs using remote licenses, those served by the slurmdbd, specify
    the name of the server providing the licenses.
    For example "\-\-license=nastran@slurmdb:12".

    \fBNOTE\fR: When submitting heterogeneous jobs, license requests
    may only be made on the first component job.
    For example "sbatch \-L ansys:2 : script.sh".
    .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), TIME_LIMIT_50 (reached 50
    percent of time limit) and ARRAY_TASKS (send emails for each array task).
    Multiple \fItype\fR values may be specified in a comma separated list.
    The user to be notified is indicated with \fB\-\-mail\-user\fR.
    Unless the ARRAY_TASKS option is specified, mail notifications on job BEGIN,
    END, FAIL and REQUEUE apply to a job array as a whole rather than generating
    individual email messages for each task in the job array.
    .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

    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: 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:
    .IP
    .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
     #!/bin/sh
    > srun hostname |sort
    > EOF
    sbatch: Submitted batch job 65541

    $ cat slurm\-65541.out
    host1
    host2
    host3
    host4
    .fi

    .TP
    To create a heterogeneous job with 3 components, each allocating a unique set \
    of nodes:
    .IP
    .nf
    $ sbatch \-w node[2\-3] : \-w node4 : \-w node[5\-7] work.bash
    Submitted batch job 34987
    .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