fish-shell/sphinx_doc_src/cmds/ulimit.rst

.. _cmd-ulimit:

ulimit - set or get resource usage limits
=========================================

Synopsis
--------

::

    ulimit [OPTIONS] [LIMIT]


Description
-----------

``ulimit`` builtin sets or outputs the resource usage limits of the shell and any processes spawned by it. If a new limit value is omitted, the current value of the limit of the resource is printed; otherwise, the specified limit is set to the new value.

Use one of the following switches to specify which resource limit to set or report:

- ``-c`` or ``--core-size``: the maximum size of core files created. By setting this limit to zero, core dumps can be disabled.

- ``-d`` or ``--data-size``: the maximum size of a process' data segment.

- ``-f`` or ``--file-size``: the maximum size of files created by the shell.

- ``-l`` or ``--lock-size``: the maximum size that may be locked into memory.

- ``-m`` or ``--resident-set-size``: the maximum resident set size.

- ``-n`` or ``--file-descriptor-count``: the maximum number of open file descriptors (most systems do not allow this value to be set).

- ``-s`` or ``--stack-size``: the maximum stack size.

- ``-t`` or ``--cpu-time``: the maximum amount of CPU time in seconds.

- ``-u`` or ``--process-count``: the maximum number of processes available to a single user.

- ``-v`` or ``--virtual-memory-size`` The maximum amount of virtual memory available to the shell.

Note that not all these limits are available in all operating systems.

The value of limit can be a number in the unit specified for the resource or one of the special values ``hard``, ``soft``, or ``unlimited``, which stand for the current hard limit, the current soft limit, and no limit, respectively.

If limit is given, it is the new value of the specified resource. If no option is given, then ``-f`` is assumed. Values are in kilobytes, except for ``-t``, which is in seconds and ``-n`` and ``-u``, which are unscaled values. The exit status is 0 unless an invalid option or argument is supplied, or an error occurs while setting a new limit.

``ulimit`` also accepts the following switches that determine what type of limit to set:

- ``-H`` or ``--hard`` sets hard resource limit

- ``-S`` or ``--soft`` sets soft resource limit

A hard limit can only be decreased. Once it is set it cannot be increased; a soft limit may be increased up to the value of the hard limit. If neither ``-H`` nor ``-S`` is specified, both the soft and hard limits are updated when assigning a new limit value, and the soft limit is used when reporting the current value.

The following additional options are also understood by ``ulimit``:

- ``-a`` or ``--all`` prints all current limits

The ``fish`` implementation of ``ulimit`` should behave identically to the implementation in bash, except for these differences:

- Fish ``ulimit`` supports GNU-style long options for all switches

- Fish ``ulimit`` does not support the ``-p`` option for getting the pipe size. The bash implementation consists of a compile-time check that empirically guesses this number by writing to a pipe and waiting for SIGPIPE. Fish does not do this because it this method of determining pipe size is unreliable. Depending on bash version, there may also be further additional limits to set in bash that do not exist in fish.

- Fish ``ulimit`` does not support getting or setting multiple limits in one command, except reporting all values using the ``-a`` switch


Example
-------

``ulimit -Hs 64`` sets the hard stack size limit to 64 kB.
docs: Add labels to all commands This allows us to use :ref: references, which don't require hardcoding it as html [ci skip] 2019-03-31 17:05:09 +08:00			`.. _cmd-ulimit:`

Switch command docs from \section to reStructuredText 2018-12-17 09:39:33 +08:00			`ulimit - set or get resource usage limits`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`=========================================`
Switch command docs from \section to reStructuredText 2018-12-17 09:39:33 +08:00
Migrate the 'synopsis' sections to .rst format 2018-12-18 09:58:24 +08:00			`Synopsis`
			`--------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
docs: update all command synopsis formatting Adds synopses for those commands missing them. Moves all synopsis sections to code blocks. This improves the appearance, although highlighting as fish code may not be the ideal appearance. 2019-09-17 17:59:04 +08:00			`::`

			`ulimit [OPTIONS] [LIMIT]`
Migrate the 'synopsis' sections to .rst format 2018-12-18 09:58:24 +08:00
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Convert \\subsection sections into rst format 2018-12-19 10:44:30 +08:00			`Description`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`-----------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			``ulimit`` builtin sets or outputs the resource usage limits of the shell and any processes spawned by it. If a new limit value is omitted, the current value of the limit of the resource is printed; otherwise, the specified limit is set to the new value.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
			`Use one of the following switches to specify which resource limit to set or report:`

Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			- ``-c`` or ``--core-size``: the maximum size of core files created. By setting this limit to zero, core dumps can be disabled.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			- ``-d`` or ``--data-size``: the maximum size of a process' data segment.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			- ``-f`` or ``--file-size``: the maximum size of files created by the shell.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			- ``-l`` or ``--lock-size``: the maximum size that may be locked into memory.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			- ``-m`` or ``--resident-set-size``: the maximum resident set size.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			- ``-n`` or ``--file-descriptor-count``: the maximum number of open file descriptors (most systems do not allow this value to be set).
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			- ``-s`` or ``--stack-size``: the maximum stack size.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			- ``-t`` or ``--cpu-time``: the maximum amount of CPU time in seconds.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			- ``-u`` or ``--process-count``: the maximum number of processes available to a single user.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			- ``-v`` or ``--virtual-memory-size`` The maximum amount of virtual memory available to the shell.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
			`Note that not all these limits are available in all operating systems.`

Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			The value of limit can be a number in the unit specified for the resource or one of the special values ``hard``, ``soft``, or ``unlimited``, which stand for the current hard limit, the current soft limit, and no limit, respectively.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
docs: standardise on exit status terminology Exit status is used in the POSIX specification and is preferred over return code/return status/exit code. [ci skip] 2019-09-17 16:31:39 +08:00			If limit is given, it is the new value of the specified resource. If no option is given, then ``-f`` is assumed. Values are in kilobytes, except for ``-t``, which is in seconds and ``-n`` and ``-u``, which are unscaled values. The exit status is 0 unless an invalid option or argument is supplied, or an error occurs while setting a new limit.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			``ulimit`` also accepts the following switches that determine what type of limit to set:
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			- ``-H`` or ``--hard`` sets hard resource limit
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			- ``-S`` or ``--soft`` sets soft resource limit
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
doc(ulimit): add missing backquotes around -H, -S and -a options (cherry picked from commit a53405a7be09d4325106383395a7afc782641e83) 2020-02-25 14:34:54 +08:00			A hard limit can only be decreased. Once it is set it cannot be increased; a soft limit may be increased up to the value of the hard limit. If neither ``-H`` nor ``-S`` is specified, both the soft and hard limits are updated when assigning a new limit value, and the soft limit is used when reporting the current value.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			The following additional options are also understood by ``ulimit``:
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			- ``-a`` or ``--all`` prints all current limits
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			The ``fish`` implementation of ``ulimit`` should behave identically to the implementation in bash, except for these differences:
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			- Fish ``ulimit`` supports GNU-style long options for all switches
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			- Fish ``ulimit`` does not support the ``-p`` option for getting the pipe size. The bash implementation consists of a compile-time check that empirically guesses this number by writing to a pipe and waiting for SIGPIPE. Fish does not do this because it this method of determining pipe size is unreliable. Depending on bash version, there may also be further additional limits to set in bash that do not exist in fish.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
doc(ulimit): add missing backquotes around -H, -S and -a options (cherry picked from commit a53405a7be09d4325106383395a7afc782641e83) 2020-02-25 14:34:54 +08:00			- Fish ``ulimit`` does not support getting or setting multiple limits in one command, except reporting all values using the ``-a`` switch
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00

Convert \\subsection sections into rst format 2018-12-19 10:44:30 +08:00			`Example`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`-------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			``ulimit -Hs 64`` sets the hard stack size limit to 64 kB.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00