From 1f94a78ce8962fbc9cacd0eb7be220dc0a8e3201 Mon Sep 17 00:00:00 2001 From: Benno Schulenberg Date: Mon, 14 Jul 2014 11:02:58 +0200 Subject: docs: improve formatting and wording of a few man pages Signed-off-by: Benno Schulenberg --- sys-utils/prlimit.1 | 108 ++++++++++++++++++++++++++-------------------------- 1 file changed, 53 insertions(+), 55 deletions(-) (limited to 'sys-utils/prlimit.1') diff --git a/sys-utils/prlimit.1 b/sys-utils/prlimit.1 index 95bc87607..164f472ea 100644 --- a/sys-utils/prlimit.1 +++ b/sys-utils/prlimit.1 @@ -2,20 +2,18 @@ .\" Copyright 2011 Davidlohr Bueso .\" May be distributed under the GNU General Public License -.TH PRLIMIT 1 "October 2011" "util-linux" "User Commands" +.TH PRLIMIT 1 "July 2014" "util-linux" "User Commands" .SH NAME prlimit \- -get and set a process resource limits. +get and set process resource limits .SH SYNOPSIS -.B prlimit -.RB [options] -.RB [ \-\-{resource_name}[=limits] -.RB [ \-\-pid\ PID] +.BR prlimit " [options]" +.RB [ \-\-\fIresource\fR [ =\fIlimits\fR] +.RB [ \-\-pid\ \fIPID\fR] -.B prlimit -.RB [options] -.RB [ \-\-{resource_name}[=limits]] -.RB "command " [ argument ...] +.BR prlimit " [options]" +.RB [ \-\-\fIresource\fR [ =\fIlimits\fR] +.IR "command " [ argument ...] .SH DESCRIPTION Given a process id and one or more resources, \fBprlimit\fP tries to retrieve @@ -25,70 +23,71 @@ When \fIcommand\fR is given, .B prlimit will run this command with the given arguments. -The \fIlimits\fP format is composed by a soft and a hard (ceiling) value, separated -by a semicolon (:), in order to modify the existing value(s). If no limits are -used, \fBprlimit\fP will only display the current values. If one of the values -is not used, then the existing one will be used. To specify the unlimited or +The \fIlimits\fP parameter is composed of a soft and a hard value, separated +by a colon (:), in order to modify the existing values. If no \fIlimits\fR are +given, \fBprlimit\fP will display the current values. If one of the values +is not given, then the existing one will be used. To specify the unlimited or infinity limit (RLIM_INFINITY), the -1 or 'unlimited' string can be passed. -Because of the nature of limits, the soft value must be lower or equal to the -high limit. To see all the available resource limits, refer to the RESOURCE -OPTIONS section. +Because of the nature of limits, the soft limit must be lower or equal to the +high limit (also called the ceiling). To see all available resource limits, +refer to the RESOURCE OPTIONS section. -.IP "\fB:\fP Specify both limits" -.IP "\fB:\fP Specify only the soft limit" -.IP "\fB:\fP Specify only the hard limit" -.IP "\fB\fP Specify both soft and hard limits to the same value" +.IP "\fIsoft\fP:\fIhard\fP Specify both limits." +.IP "\fIsoft\fP: Specify only the soft limit." +.IP ":\fIhard\fP Specify only the hard limit." +.IP "\fIvalue\fP Specify both both limits to the same value." .SH GENERAL OPTIONS -.IP "\fB\-p, \-\-pid\fP" -Specify the process id, if none is given, it will use the running process. +.IP "\fB\-h, \-\-help\fP" +Display help text and exit. +.IP "\fB\-\-noheadings\fP" +Do not print a header line. .IP "\fB\-o, \-\-output \fIlist\fP" -Define the output columns to use. If no output arrangement is specified, then a default set is used. -Use \fB\-\-help\fP to get list of all supported columns. -.IP "\fB\-V, \-\-version\fP" -Display version information and exit. -.IP "\fB\-\-verbose\fP" -Verbose mode. +Define the output columns to use. If no output arrangement is specified, +then a default set is used. +Use \fB\-\-help\fP to get a list of all supported columns. +.IP "\fB\-p, \-\-pid\fP" +Specify the process id; if none is given, the running process will be used. .IP "\fB\-\-raw\fP" Use the raw output format. -.IP "\fB\-\-noheadings\fP" -Do not print a header line. -.IP "\fB\-h, \-\-help\fP" -Display help text and exit. +.IP "\fB\-\-verbose\fP" +Verbose mode. +.IP "\fB\-V, \-\-version\fP" +Display version information and exit. .SH RESOURCE OPTIONS -.IP "\fB\-c, \-\-core\fP[=limits]" +.IP "\fB\-c, \-\-core\fP[=\fIlimits\fR]" Maximum size of a core file. -.IP "\fB\-d, \-\-data\fP[=limits]" +.IP "\fB\-d, \-\-data\fP[=\fIlimits\fR]" Maximum data size. -.IP "\fB\-e, \-\-nice\fP[=limits]" +.IP "\fB\-e, \-\-nice\fP[=\fIlimits\fR]" Maximum nice priority allowed to raise. -.IP "\fB\-f, \-\-fsize\fP[=limits]" +.IP "\fB\-f, \-\-fsize\fP[=\fIlimits\fR]" Maximum file size. -.IP "\fB\-i, \-\-sigpending\fP[=limits]" +.IP "\fB\-i, \-\-sigpending\fP[=\fIlimits\fR]" Maximum number of pending signals. -.IP "\fB\-l, \-\-memlock\fP[=limits]" +.IP "\fB\-l, \-\-memlock\fP[=\fIlimits\fR]" Maximum locked-in-memory address space. -.IP "\fB\-m, \-\-rss\fP[=limits]" +.IP "\fB\-m, \-\-rss\fP[=\fIlimits\fR]" Maximum Resident Set Size (RSS). -.IP "\fB\-n, \-\-nofile\fP[=limits]" +.IP "\fB\-n, \-\-nofile\fP[=\fIlimits\fR]" Maximum number of open files. -.IP "\fB\-q, \-\-msgqueue\fP[=limits]" +.IP "\fB\-q, \-\-msgqueue\fP[=\fIlimits\fR]" Maximum number of bytes in POSIX message queues. -.IP "\fB\-r, \-\-rtprio\fP[=limits]" +.IP "\fB\-r, \-\-rtprio\fP[=\fIlimits\fR]" Maximum real-time priority. -.IP "\fB\-s, \-\-stack\fP[=limits]" +.IP "\fB\-s, \-\-stack\fP[=\fIlimits\fR]" Maximum size of the stack. -.IP "\fB\-t, \-\-cpu\fP[=limits]" +.IP "\fB\-t, \-\-cpu\fP[=\fIlimits\fR]" CPU time, in seconds. -.IP "\fB\-u, \-\-nproc\fP[=limits]" +.IP "\fB\-u, \-\-nproc\fP[=\fIlimits\fR]" Maximum number of processes. -.IP "\fB\-v, \-\-as\fP[=limits]" +.IP "\fB\-v, \-\-as\fP[=\fIlimits\fR]" Address space limit. -.IP "\fB\-x, \-\-locks\fP[=limits]" +.IP "\fB\-x, \-\-locks\fP[=\fIlimits\fR]" Maximum number of file locks held. -.IP "\fB\-y, \-\-rttime\fP[=limits]" +.IP "\fB\-y, \-\-rttime\fP[=\fIlimits\fR]" Timeout for real-time tasks. .RE @@ -96,24 +95,23 @@ Timeout for real-time tasks. .IP "\fBprlimit \-\-pid 13134\fP" Display limit values for all current resources. .IP "\fBprlimit \-\-pid 13134 \--rss --nofile=1024:4095\fP" -Display the limits of the RSS and set the soft and hard limits for the number +Display the limits of the RSS, and set the soft and hard limits for the number of open files to 1024 and 4095, respectively. .IP "\fBprlimit \-\-pid 13134 --nproc=512:\fP" Modify only the soft limit for the number of processes. .IP "\fBprlimit \-\-pid $$ --nproc=unlimited\fP" -Set the number of processes for both soft and ceiling values to unlimited. +Set for the current process both the soft and ceiling values for the number of +processes to umlimited. .IP "\fBprlimit --cpu=10 sort -u hugefile\fP" -Set the soft and hard CPU time limit and run 'sort'. +Set both the soft and hard CPU time limit to ten seconds and and run 'sort'. .SH "SEE ALSO" .BR prlimit (2), .BR ulimit (1) .SH NOTES -.nf -The prlimit system call is supported since Linux 2.6.36, previous kernels will +The prlimit system call is supported since Linux 2.6.36, older kernels will break this program. -.fi .SH AUTHORS .nf -- cgit v1.2.3-55-g7522