usr.bin/limits/limits.1

   1 .\" Copyright (c) 1996 David Nugent <davidn@blaze.net.au>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, is permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice immediately at the beginning of the file, without modification,
   9 .\"    this list of conditions, and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. This work was done expressly for inclusion into FreeBSD.  Other use
  14 .\"    is permitted provided this notation is included.
  15 .\" 4. Absolutely no warranty of function or purpose is made by the author
  16 .\"    David Nugent.
  17 .\" 5. Modifications may be freely made to this file providing the above
  18 .\"    conditions are met.
  19 .\"
  20 .\" $FreeBSD: src/usr.bin/limits/limits.1,v 1.14.2.10 2003/02/25 20:31:18 trhodes Exp $
  21 .\"
  22 .Dd March 1, 2019
  23 .Dt LIMITS 1
  24 .Os
  25 .Sh NAME
  26 .Nm limits
  27 .Nd set or display process resource limits
  28 .Sh SYNOPSIS
  29 .Nm
  30 .Op Fl C Ar class
  31 .Op Fl SHB
  32 .Op Fl ea
  33 .Op Fl cdfklmnstuv Op val
  34 .Nm
  35 .Op Fl C Ar class
  36 .Op Fl SHB
  37 .Op Fl cdfklmnstuv Op val
  38 .Op Fl E
  39 .Op Ar name Ns = Ns Ar value ...
  40 .Op Ar command
  41 .Nm
  42 .Op Fl U Ar user
  43 .Op Fl SHB
  44 .Op Fl ea
  45 .Op Fl cdflmnstuv Op val
  46 .Nm
  47 .Op Fl U Ar user
  48 .Op Fl SHB
  49 .Op Fl cdflmnstuv Op val
  50 .Op Fl E
  51 .Op Ar name Ns = Ns Ar value ...
  52 .Op Ar command
  53 .Sh DESCRIPTION
  54 The
  55 .Nm
  56 utility either prints or sets kernel resource limits, and may optionally set
  57 environment variables like
  58 .Xr env 1
  59 and run a program with the selected resources.
  60 Three uses of the
  61 .Nm
  62 command are possible:
  63 .Bl -tag -width indent
  64 .It Xo
  65 .Nm
  66 .Op Ar limitflags
  67 .Op Ar name Ns = Ns Ar value
  68 .Ar command
  69 .Xc
  70 This usage sets limits according to
  71 .Ar limitflags ,
  72 optionally sets environment variables given as
  73 .Ar name Ns = Ns Ar value
  74 pairs, and then runs the specified command.
  75 .It Xo
  76 .Nm
  77 .Op Ar limitflags
  78 .Xc
  79 This usage determines values of resource settings according to
  80 .Ar limitflags ,
  81 does not attempt to set them and outputs these values to
  82 standard output.
  83 By default, this will output the current kernel resource settings
  84 active for the calling process.
  85 Using the
  86 .Fl C Ar class
  87 or
  88 .Fl U Ar user
  89 flags, you may also display the current resource settings modified
  90 by the appropriate login class resource limit entries from
  91 the
  92 .Xr login.conf 5
  93 login capabilities database.
  94 .It Xo
  95 .Nm
  96 .Fl e Op Ar limitflags
  97 .Xc
  98 This usage determines values of resource settings according to
  99 .Ar limitflags ,
 100 but does not set them itself.
 101 Like the previous usage it outputs these values to standard
 102 output, except that it will emit them in
 103 .Em eval
 104 format, suitable for the calling shell.
 105 The calling shell is determined by examining the entries in the
 106 .Pa /proc
 107 filesystem for the parent process.
 108 If the shell is known (i.e. it is one of sh, csh, bash, tcsh, ksh,
 109 pdksh or rc),
 110 .Nm
 111 emits 'limit' or 'ulimit' commands in the format understood by
 112 that shell.
 113 If the name of the shell cannot be determined, then the 'ulimit'
 114 format used by
 115 .Xr sh 1
 116 is used.
 117 .Pp
 118 This is very useful for setting limits used by scripts, or prior
 119 launching of daemons and other background tasks with specific
 120 resource limit settings, and provides the benefit of allowing
 121 global configuration of maximum resource usage by maintaining a
 122 central database of settings in the login class database.
 123 .Pp
 124 Within a shell script,
 125 .Nm
 126 will normally be used with eval within backticks as follows:
 127 .Pp
 128 .Dl eval `limits -e -C daemon`
 129 .Pp
 130 which causes the output of
 131 .Nm
 132 to be evaluated and set by the current shell.
 133 .El
 134 .Pp
 135 The value of
 136 .Ar limitflags
 137 specified in the above contains one or more of the following options:
 138 .Bl -tag -width "-d [limit]"
 139 .It Fl C Ar class
 140 Use current resource values, modified by the resource entries applicable
 141 for the login class "class".
 142 .It Fl U Ar user
 143 Use current resource values, modified by the resource entries applicable
 144 to the login class which "user" belongs to.
 145 If the user does not belong to a class, then the resource capabilities
 146 for the "default" class are used, if it exists, or the "root" class if
 147 the user is a superuser account.
 148 .It Fl S
 149 Select display or setting of "soft" (or current) resource limits.
 150 If specific limits settings follow this switch, only soft limits are
 151 affected unless overridden later with either the
 152 .Fl H
 153 or
 154 .Fl B
 155 flags.
 156 .It Fl H
 157 Select display or setting of "hard" (or maximum) resource limits.
 158 If specific limits settings follow this switch, only hard limits are
 159 affected until overridden later with either the
 160 .Fl S
 161 or
 162 .Fl B
 163 flags.
 164 .It Fl B
 165 Select display or setting of both "soft" (current) or "hard" (maximum)
 166 resource limits.
 167 If specific limits settings follow this switch, both soft and hard
 168 limits are affected until overridden later with either the
 169 .Fl S
 170 or
 171 .Fl H
 172 flags.
 173 .Fl e
 174 Select "eval mode" formatting for output.
 175 This is valid only on display mode and cannot be used when running a
 176 command.
 177 The exact syntax used for output depends upon the type of shell from
 178 which
 179 .Nm
 180 is invoked.
 181 .It Fl b Op Ar limit
 182 Selects or sets the
 183 .Em sbsize
 184 resource limit.
 185 .It Fl c Op Ar limit
 186 Select or set (if 'limit' is specified) the
 187 .Em coredumpsize
 188 resource limit.
 189 A value of 0 disables core dumps.
 190 .It Fl d Op Ar limit
 191 Select or set (if 'limit' is specified) the
 192 .Em datasize
 193 resource limit.
 194 .It Fl f Op Ar limit
 195 Select or set the
 196 .Em filesize
 197 resource limit.
 198 .It Fl k Op Ar limit
 199 Select or set the
 200 .Em posixlocks
 201 resource limit.
 202 .It Fl l Op Ar limit
 203 Select or set the
 204 .Em memorylocked
 205 resource limit.
 206 .It Fl m Op Ar limit
 207 Select or set the
 208 .Em memoryuse
 209 size limit.
 210 .It Fl n Op Ar limit
 211 Select or set the
 212 .Em openfiles
 213 resource limit.  The system-wide limit on the maximum number of
 214 open files per process can be viewed using the 'sysctl kern.maxfilesperproc'
 215 command.  The total number of simultaneously open files in the entire
 216 system is limited to the value displayed by the 'sysctl kern.maxfiles'
 217 command.
 218 .It Fl s Op Ar limit
 219 Select or set the
 220 .Em stacksize
 221 resource limit.
 222 .It Fl t Op Ar limit
 223 Select or set the
 224 .Em cputime
 225 resource limit.
 226 .It Fl u Op Ar limit
 227 Select or set the
 228 .Em maxproc
 229 resource limit.  The system-wide limit on the maximum number of processes
 230 allowed per UID can be viewed using the 'sysctl kern.maxprocperuid' command.
 231 The maximum number of processes that can be running simultaneously
 232 in the entire system is limited to the value given by
 233 the 'sysctl kern.maxproc' command.
 234 .It Fl v Op Ar limit
 235 Select or set the
 236 .Em virtualmem
 237 resource limit.
 238 This limit encompasses the entire VM space for the user process
 239 and is inclusive of text, data, bss, stack,
 240 .Xr sbrk 2
 241 and
 242 .Xr mmap 2 Ns 'd
 243 space.
 244 .El
 245 .Pp
 246 Valid values for
 247 .Ar val
 248 in the above set of options consist of either the
 249 string
 250 .Dq Li infinity ,
 251 .Dq Li inf ,
 252 .Dq Li unlimited
 253 or
 254 .Dq Li unlimit
 255 for an infinite (or kernel-defined maximum)
 256 limit, or a numeric value optionally followed by a suffix.
 257 Values which relate to size default to a value in bytes, or one of the
 258 following suffixes may be used as a multiplier:
 259 .Pp
 260 .Bl -tag -offset indent -width 4n -compact
 261 .It Li b
 262 512 byte blocks.
 263 .It Li k
 264 kilobytes (1024 bytes).
 265 .It Li m
 266 megabytes (1024*1024 bytes).
 267 .It Li g
 268 gigabytes.
 269 .It Li t
 270 terabytes.
 271 .El
 272 .Pp
 273 The
 274 .Va cputime
 275 resource defaults to a number of seconds, but a multiplier may be
 276 used, and as with size values, multiple values separated by a valid
 277 suffix are added together:
 278 .Pp
 279 .Bl -tag -offset indent -width 4n -compact
 280 .It Li s
 281 seconds.
 282 .It Li m
 283 minutes.
 284 .It Li h
 285 hours.
 286 .It Li d
 287 days.
 288 .It Li w
 289 weeks.
 290 .It Li y
 291 365 day years.
 292 .El
 293 .Bl -tag -width ".Fl C Ar class"
 294 .It Fl E
 295 Cause
 296 .Nm
 297 to completely ignore the environment it inherits.
 298 .It Fl a
 299 Force all resource settings to be displayed even if
 300 other specific resource settings have been specified.
 301 For example, if you wish to disable core dumps when starting up
 302 the Usenet News system, but wish to set all other resource settings
 303 as well that apply to the
 304 .Dq Li news
 305 account, you might use:
 306 .Pp
 307 .Dl "eval `limits -U news -aBec 0`"
 308 .Pp
 309 As with the
 310 .Xr setrlimit 2
 311 call, only the superuser may raise process
 312 .Dq hard
 313 resource limits.
 314 Non-root users may, however, lower them or change
 315 .Dq soft
 316 resource limits
 317 within to any value below the hard limit.
 318 When invoked to execute a program, the failure of
 319 .Nm
 320 to raise a hard limit is considered a fatal error.
 321 .El
 322 .Sh EXIT STATUS
 323 The
 324 .Nm
 325 utility
 326 exits with EXIT_FAILURE if usage is incorrect in any way; i.e. an invalid
 327 option, or set/display options are selected in the same invocation,
 328 .Fl e
 329 is used when running a program, etc.
 330 When run in display or eval mode,
 331 .Nm
 332 exits with a status of EXIT_SUCCESS.
 333 When run in command mode and execution of the command succeeds, the exit status
 334 will be whatever the executed program returns.
 335 .Sh SEE ALSO
 336 .Xr builtin 1 ,
 337 .Xr csh 1 ,
 338 .Xr env 1 ,
 339 .Xr limit 1 ,
 340 .Xr sh 1 ,
 341 .Xr getrlimit 2 ,
 342 .Xr setrlimit 2 ,
 343 .Xr login_cap 3 ,
 344 .Xr login.conf 5 ,
 345 .Xr sysctl 8
 346 .Sh BUGS
 347 The
 348 .Nm
 349 utility does not handle commands with equal (``='') signs in their
 350 names, for obvious reasons.
 351 .Pp
 352 When eval output is selected, the
 353 .Pa /proc
 354 filesystem must be installed
 355 and mounted for the shell to be correctly determined, and therefore
 356 output syntax correct for the running shell.
 357 The default output is valid for
 358 .Xr sh 1 ,
 359 so this means that any
 360 usage of
 361 .Nm
 362 in eval mode prior mounting
 363 .Pa /proc
 364 may only occur in standard bourne
 365 shell scripts.
 366 .Pp
 367 The
 368 .Nm
 369 utility makes no effort to ensure that resource settings emitted or displayed
 370 are valid and settable by the current user.
 371 Only a superuser account may raise hard limits, and when doing so
 372 the
 373 .Dx
 374 kernel will silently lower limits to values less than
 375 specified if the values given are too high.