File: ulimit.html

package info (click to toggle)
fish 4.2.1-3.1
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 35,980 kB
  • sloc: python: 6,972; javascript: 1,407; sh: 1,009; xml: 411; ansic: 230; objc: 78; makefile: 20
file content (297 lines) | stat: -rw-r--r-- 16,330 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
<!DOCTYPE html>

<html lang="en" data-content_root="../">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

    <title>ulimit - set or get resource usage limits &#8212; fish-shell 4.2.1 documentation</title>
    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=4da8bbd6" />
    <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=f89b4716" />
    <script src="../_static/documentation_options.js?v=6fb65176"></script>
    <script src="../_static/doctools.js?v=9bcbadda"></script>
    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="umask - set or get the file creation mode mask" href="umask.html" />
    <link rel="prev" title="type - locate a command and describe its type" href="type.html" />
    <link rel="shortcut icon" type="image/png" href="../_static/fish.png" />
     

  </head><body><div id="fmain">  
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
    <li><img src="../_static/fish.png" alt=""
             style="width: 80px; height: 80px; vertical-align: middle; margin-top: -1px"/></li>
    <li><a href="https://fishshell.com/">fish-shell</a> &#187;</li>
    
    <a href="../index.html">fish-shell 4.2.1 documentation</a> &#187;
    

          <li class="nav-item nav-item-1"><a href="../commands.html" accesskey="U">Commands</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">ulimit - set or get resource usage limits</a></li>
    <li class="right">
        

    <div class="inline-search" role="search">
        <form class="inline-search" action="../search.html" method="get">
          <input placeholder="Quick search" type="text" name="q" />
          <input type="submit" value="Go" />
          <input type="hidden" name="check_keywords" value="yes" />
          <input type="hidden" name="area" value="default" />
        </form>
    </div>
    </li>
    
    <div id="old-docs-notice" style="display: none">
        This documents an old version of fish.
        <a href="../../current/">See the latest release.</a>
    </div>

      </ul>
    </div>    

    <div class="document">
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
<div>
<h3><a href="../index.html">Documents</a></h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../faq.html">Frequently asked questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../interactive.html">Interactive use</a></li>
<li class="toctree-l1"><a class="reference internal" href="../language.html">The fish language</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../commands.html">Commands</a></li>
<li class="toctree-l1"><a class="reference internal" href="../fish_for_bash_users.html">Fish for bash users</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../completions.html">Writing your own completions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../prompt.html">Writing your own prompt</a></li>
<li class="toctree-l1"><a class="reference internal" href="../design.html">Design</a></li>
<li class="toctree-l1"><a class="reference internal" href="../relnotes.html">Release notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../terminal-compatibility.html">Terminal Compatibility</a></li>
<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing To Fish</a></li>
<li class="toctree-l1"><a class="reference internal" href="../license.html">License</a></li>
</ul>

</div>
<search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div>
<h4><a href="../index.html">Sections</a></h4>
<ul>
<li><a class="reference internal" href="#">ulimit - set or get resource usage limits</a><ul>
<li><a class="reference internal" href="#synopsis">Synopsis</a></li>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#example">Example</a></li>
</ul>
</li>
</ul>

</div>
        </div>
      </div>
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <section id="ulimit-set-or-get-resource-usage-limits">
<h1>ulimit - set or get resource usage limits<a class="headerlink" href="#ulimit-set-or-get-resource-usage-limits" title="Link to this heading">¶</a></h1>
<section id="synopsis">
<h2>Synopsis<a class="headerlink" href="#synopsis" title="Link to this heading">¶</a></h2>
<div class="highlight-fish-synopsis notranslate"><div class="highlight"><pre><span></span><span class="nf">ulimit</span><span class="w"> </span><span class="g g-Other">[</span><span class="no">OPTIONS</span><span class="g g-Other">]</span><span class="w"> </span><span class="g g-Other">[</span><span class="no">LIMIT</span><span class="g g-Other">]</span>
</pre></div>
</div>
</section>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Link to this heading">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">ulimit</span></code> 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.</p>
<p>Use one of the following switches to specify which resource limit to set or report:</p>
<dl class="simple">
<dt><strong>-b</strong> or <strong>--socket-buffers</strong></dt><dd><p>The maximum size of socket buffers.</p>
</dd>
<dt><strong>-c</strong> or <strong>--core-size</strong></dt><dd><p>The maximum size of core files created. By setting this limit to zero, core dumps can be disabled.</p>
</dd>
<dt><strong>-d</strong> or <strong>--data-size</strong></dt><dd><p>The maximum size of a process’ data segment.</p>
</dd>
<dt><strong>-e</strong> or <strong>--nice</strong></dt><dd><p>Controls the maximum nice value; on Linux, this value is subtracted from 20 to give the effective value.</p>
</dd>
<dt><strong>-f</strong> or <strong>--file-size</strong></dt><dd><p>The maximum size of files created by a process.</p>
</dd>
<dt><strong>-i</strong> or <strong>--pending-signals</strong></dt><dd><p>The maximum number of signals that may be queued.</p>
</dd>
<dt><strong>-l</strong> or <strong>--lock-size</strong></dt><dd><p>The maximum size that may be locked into memory.</p>
</dd>
<dt><strong>-m</strong> or <strong>--resident-set-size</strong></dt><dd><p>The maximum resident set size.</p>
</dd>
<dt><strong>-n</strong> or <strong>--file-descriptor-count</strong></dt><dd><p>The maximum number of open file descriptors.</p>
</dd>
<dt><strong>-q</strong> or <strong>--queue-size</strong></dt><dd><p>The maximum size of data in POSIX message queues.</p>
</dd>
<dt><strong>-r</strong> or <strong>--realtime-priority</strong></dt><dd><p>The maximum realtime scheduling priority.</p>
</dd>
<dt><strong>-s</strong> or <strong>--stack-size</strong></dt><dd><p>The maximum stack size.</p>
</dd>
<dt><strong>-t</strong> or <strong>--cpu-time</strong></dt><dd><p>The maximum amount of CPU time in seconds.</p>
</dd>
<dt><strong>-u</strong> or <strong>--process-count</strong></dt><dd><p>The maximum number of processes available to the current user.</p>
</dd>
<dt><strong>-w</strong> or <strong>--swap-size</strong></dt><dd><p>The maximum swap space available to the current user.</p>
</dd>
<dt><strong>-v</strong> or <strong>--virtual-memory-size</strong></dt><dd><p>The maximum amount of virtual memory available to the shell.</p>
</dd>
<dt><strong>-y</strong> or <strong>--realtime-maxtime</strong></dt><dd><p>The maximum contiguous realtime CPU time in microseconds.</p>
</dd>
<dt><strong>-K</strong> or <strong>--kernel-queues</strong></dt><dd><p>The maximum number of kqueues (kernel queues) for the current user.</p>
</dd>
<dt><strong>-P</strong> or <strong>--ptys</strong></dt><dd><p>The maximum number of pseudo-terminals for the current user.</p>
</dd>
<dt><strong>-T</strong> or <strong>--threads</strong></dt><dd><p>The maximum number of simultaneous threads for the current user.</p>
</dd>
</dl>
<p>Note that not all these limits are available in all operating systems; consult the documentation for <code class="docutils literal notranslate"><span class="pre">setrlimit</span></code> in your operating system.</p>
<p>The value of limit can be a number in the unit specified for the resource or one of the special values <code class="docutils literal notranslate"><span class="pre">hard</span></code>, <code class="docutils literal notranslate"><span class="pre">soft</span></code>, or <code class="docutils literal notranslate"><span class="pre">unlimited</span></code>, which stand for the current hard limit, the current soft limit, and no limit, respectively.</p>
<p>If limit is given, it is the new value of the specified resource. If no option is given, then <strong>-f</strong> is assumed. Values are in kilobytes, except for <strong>-t</strong>, which is in seconds and <strong>-n</strong> and <strong>-u</strong>, 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.</p>
<p><code class="docutils literal notranslate"><span class="pre">ulimit</span></code> also accepts the following options that determine what type of limit to set:</p>
<dl class="simple">
<dt><strong>-H</strong> or <strong>--hard</strong></dt><dd><p>Sets hard resource limit.</p>
</dd>
<dt><strong>-S</strong> or <strong>--soft</strong></dt><dd><p>Sets soft resource limit.</p>
</dd>
</dl>
<p>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 <strong>-H</strong> nor <strong>-S</strong> 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.</p>
<p>The following additional options are also understood by <code class="docutils literal notranslate"><span class="pre">ulimit</span></code>:</p>
<dl class="simple">
<dt><strong>-a</strong> or <strong>--all</strong></dt><dd><p>Prints all current limits.</p>
</dd>
<dt><strong>-h</strong> or <strong>--help</strong></dt><dd><p>Displays help about using this command.</p>
</dd>
</dl>
<p>The <code class="docutils literal notranslate"><span class="pre">fish</span></code> implementation of <code class="docutils literal notranslate"><span class="pre">ulimit</span></code> should behave identically to the implementation in bash, except for these differences:</p>
<ul class="simple">
<li><p>Fish <code class="docutils literal notranslate"><span class="pre">ulimit</span></code> supports GNU-style long options for all switches.</p></li>
<li><p>Fish <code class="docutils literal notranslate"><span class="pre">ulimit</span></code> does not support the <strong>-p</strong> 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 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.</p></li>
<li><p>Fish <code class="docutils literal notranslate"><span class="pre">ulimit</span></code> does not support getting or setting multiple limits in one command, except reporting all values using the <strong>-a</strong> switch.</p></li>
</ul>
</section>
<section id="example">
<h2>Example<a class="headerlink" href="#example" title="Link to this heading">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">ulimit</span> <span class="pre">-Hs</span> <span class="pre">64</span></code> sets the hard stack size limit to 64 kB.</p>
</section>
</section>


            <div class="clearer"></div>
          </div>
        </div>
      </div> 
      <div class="clearer"></div>
    </div>  
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
    <li><img src="../_static/fish.png" alt=""
             style="width: 80px; height: 80px; vertical-align: middle; margin-top: -1px"/></li>
    <li><a href="https://fishshell.com/">fish-shell</a> &#187;</li>
    
    <a href="../index.html">fish-shell 4.2.1 documentation</a> &#187;
    

          <li class="nav-item nav-item-1"><a href="../commands.html" >Commands</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">ulimit - set or get resource usage limits</a></li>
    <li class="right">
        

    <div class="inline-search" role="search">
        <form class="inline-search" action="../search.html" method="get">
          <input placeholder="Quick search" type="text" name="q" />
          <input type="submit" value="Go" />
          <input type="hidden" name="check_keywords" value="yes" />
          <input type="hidden" name="area" value="default" />
        </form>
    </div>
    </li>
    
    <div id="old-docs-notice" style="display: none">
        This documents an old version of fish.
        <a href="../../current/">See the latest release.</a>
    </div>

      </ul>
    </div>  
    <div class="footer">
    &copy; Copyright fish-shell developers.
    <br />
    <a href="https://github.com/fish-shell/fish-shell/issues">Found a bug</a>?
    <br />

    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
    </div>
</div>

<script type="text/javascript">
 FISH_DOCS_VERSION = "4.2";

 function copy_to_clipboard(it) {
     // Find the pre tag we're interested in.
     var pre = it.target;
     while (pre.tagName != "PRE") pre = pre.parentNode;
     var txt = "";
     // Cheesy: If we have a prompt,
     // we only copy prompted lines,
     // by splitting and matching and stuff
     if (pre.querySelector('span.gp')) {
         var texts= [];
         for (var line of pre.innerText.split('\n')) {
             if (line.match(/^>_?.*/)) {
                 texts.push(line.replace(/^>_?/, ""));
             }
         }
         txt = texts.join("\n");
     } else {
         // Even cheesier: If we don't have a prompt, we remove the button text from the end.
         var txt = pre.innerText.substring(0, pre.innerText.length - it.target.innerText.length).trim();
     }

     navigator.clipboard.writeText(txt).then(function() {
         // Success - set the text to indicate it,
         // then set it back after 2 seconds.
         var span = pre.querySelector("button span");
         if (span) {
             var oldText = span.innerText;
             span.innerText = "COPIED!";
             setTimeout(function() {
                 span.innerText = oldText;
             }, 2000);
         }
     }, function() {
     });
 }

  (function () {
      // Add copy buttons to all the codeblocks.
      var codeblocks = document.querySelectorAll('div > pre');

      var button = document.createElement('button');
      var span = document.createElement('span');
      span.innerText = "COPY";
      button.appendChild(span);

      for (var i of codeblocks) {
          var newButton = button.cloneNode(true);
          newButton.addEventListener('click', copy_to_clipboard);
          i.appendChild(newButton);
      }
  })();
</script>

  </body>
</html>