From ee3d7b3b46d628c46f31fa28c2be1d04347f8c31 Mon Sep 17 00:00:00 2001 From: Michael Kerrisk Date: Fri, 16 Dec 2016 12:18:57 +0100 Subject: [PATCH] getrlimit.2: Various minor wording fixes Mainly: use complete sentence to introduce each limit. Signed-off-by: Michael Kerrisk --- man2/getrlimit.2 | 40 ++++++++++++++++++++++------------------ 1 file changed, 22 insertions(+), 18 deletions(-) diff --git a/man2/getrlimit.2 b/man2/getrlimit.2 index 4071616dc..fe9c812db 100644 --- a/man2/getrlimit.2 +++ b/man2/getrlimit.2 @@ -125,7 +125,8 @@ The argument must be one of: .TP .B RLIMIT_AS -The maximum size of the process's virtual memory (address space) in bytes. +This is the maximum size of the process's virtual memory +(address space) in bytes. .\" since 2.0.27 / 2.1.12 This limit affects calls to .BR brk (2), @@ -145,15 +146,17 @@ Since the value is a \fIlong\fP, on machines with a 32-bit \fIlong\fP either this limit is at most 2 GiB, or this resource is unlimited. .TP .B RLIMIT_CORE -Maximum size of a +This is the maximum size of a .I core file (see -.BR core (5)). +.BR core (5)) +that the process may dump. When 0 no core dump files are created. When nonzero, larger dumps are truncated to this size. .TP .B RLIMIT_CPU -CPU time limit in seconds. +This is a limit, in seconds, +on the amount of CPU time that the process can consume. When the process reaches the soft limit, it is sent a .B SIGXCPU signal. @@ -173,7 +176,7 @@ perform an orderly termination upon first receipt of .BR SIGXCPU .) .TP .B RLIMIT_DATA -The maximum size of the process's data segment (initialized data, +This is the maximum size of the process's data segment (initialized data, uninitialized data, and heap). This limit affects calls to .BR brk (2) @@ -184,7 +187,7 @@ which fail with the error upon encountering the soft limit of this resource. .TP .B RLIMIT_FSIZE -The maximum size of files that the process may create. +This is the maximum size of files that the process may create. Attempts to extend a file beyond this limit result in delivery of a .B SIGXFSZ signal. @@ -197,16 +200,16 @@ fails with the error .TP .BR RLIMIT_LOCKS " (Early Linux 2.4 only)" .\" to be precise: Linux 2.4.0-test9; no longer in 2.4.25 / 2.5.65 -A limit on the combined number of +This is a limit on the combined number of .BR flock (2) locks and .BR fcntl (2) leases that this process may establish. .TP .B RLIMIT_MEMLOCK -The maximum number of bytes of memory that may be locked +This is the maximum number of bytes of memory that may be locked into RAM. -In effect this limit is rounded down to the nearest multiple +This limit is in effect rounded down to the nearest multiple of the system page size. This limit affects .BR mlock (2) @@ -243,7 +246,7 @@ that a privileged process may lock, and this limit instead governs the amount of memory that an unprivileged process may lock. .TP .BR RLIMIT_MSGQUEUE " (since Linux 2.6.8)" -Specifies the limit on the number of bytes that can be allocated +This is a limit on the number of bytes that can be allocated for POSIX message queues for the real user ID of the calling process. This limit is enforced for .BR mq_open (3). @@ -287,7 +290,7 @@ create an unlimited number of zero-length messages (such messages nevertheless each consume some system memory for bookkeeping overhead). .TP .BR RLIMIT_NICE " (since Linux 2.6.12, but see BUGS below)" -Specifies a ceiling to which the process's nice value can be raised using +This specifies a ceiling to which the process's nice value can be raised using .BR setpriority (2) or .BR nice (2). @@ -306,7 +309,7 @@ For more detail on the nice value, see .BR sched (7). .TP .B RLIMIT_NOFILE -Specifies a value one greater than the maximum file descriptor number +This specifies a value one greater than the maximum file descriptor number that can be opened by this process. Attempts .RB ( open (2), @@ -320,7 +323,8 @@ to exceed this limit yield the error on BSD.) .TP .B RLIMIT_NPROC -The maximum number of processes (or, more precisely on Linux, threads) +This is the maximum number of processes +(or, more precisely on Linux, threads) that can be created for the real user ID of the calling process. Upon encountering this limit, .BR fork (2) @@ -333,7 +337,7 @@ or the capability. .TP .B RLIMIT_RSS -Specifies the limit (in bytes) of the process's resident set +This is a limit (in bytes) on the process's resident set (the number of virtual pages resident in RAM). This limit has effect only in Linux 2.4.x, x < 30, and there affects only calls to @@ -345,7 +349,7 @@ specifying .\" -- MTK, Jul 05 .TP .BR RLIMIT_RTPRIO " (since Linux 2.6.12, but see BUGS)" -Specifies a ceiling on the real-time priority that may be set for +This specifies a ceiling on the real-time priority that may be set for this process using .BR sched_setscheduler (2) and @@ -355,7 +359,7 @@ For further details on real-time scheduling policies, see .BR sched (7) .TP .BR RLIMIT_RTTIME " (since Linux 2.6.25)" -Specifies a limit (in microseconds) +This is a limit (in microseconds) on the amount of CPU time that a process scheduled under a real-time scheduling policy may consume without making a blocking system call. @@ -384,7 +388,7 @@ For further details on real-time scheduling policies, see .BR sched (7) .TP .BR RLIMIT_SIGPENDING " (since Linux 2.6.8)" -Specifies the limit on the number of signals +This is a limit on the number of signals that may be queued for the real user ID of the calling process. Both standard and real-time signals are counted for the purpose of checking this limit. @@ -398,7 +402,7 @@ queued to the process. .\" that was present in kernels <= 2.6.7. MTK Dec 04 .TP .B RLIMIT_STACK -The maximum size of the process stack, in bytes. +This is the maximum size of the process stack, in bytes. Upon reaching this limit, a .B SIGSEGV signal is generated.