Util-Linux package development
 help / color / mirror / Atom feed
From: Benno Schulenberg <bensberg@telfort.nl>
To: util-linux@vger.kernel.org
Cc: David Anes <david.anes@suse.com>
Subject: [PATCH 07/10] renice: (man) reword several things, to be clearer, and improve some markup
Date: Thu, 17 Apr 2025 11:48:21 +0200	[thread overview]
Message-ID: <20250417094825.20870-7-bensberg@telfort.nl> (raw)
In-Reply-To: <20250417094825.20870-1-bensberg@telfort.nl>

Also, remove a reference to ulimit(1p) that doesn't make sense.

CC: David Anes <david.anes@suse.com>
Signed-off-by: Benno Schulenberg <bensberg@telfort.nl>
---
 sys-utils/renice.1.adoc | 37 ++++++++++++++++++++++++++-----------
 1 file changed, 26 insertions(+), 11 deletions(-)

diff --git a/sys-utils/renice.1.adoc b/sys-utils/renice.1.adoc
index e50e1e918..5f2e2a98d 100644
--- a/sys-utils/renice.1.adoc
+++ b/sys-utils/renice.1.adoc
@@ -46,24 +46,30 @@ renice - alter priority of running processes
 
 == SYNOPSIS
 
-*renice* [*--priority|--relative*] _priority_ [*-g*|*-p*|*-u*] _identifier_...
+*renice* [*-n*|*--priority*|*--relative*] _priority_ [*-g*|*-p*|*-u*] _identifier_...
 
 == DESCRIPTION
 
 *renice* alters the scheduling priority of one or more running processes. The first argument is the _priority_ value to be used. The other arguments are interpreted as process IDs (by default), process group IDs, user IDs, or user names. *renice*'ing a process group causes all processes in the process group to have their scheduling priority altered. *renice*'ing a user causes all processes owned by the user to have their scheduling priority altered.
 
-If no *-n*, *--priority* or *--relative* option is used, then the priority is set as *absolute*.
+By default, _priority_ is understood as an absolute value. But when option *--relative* is given,
+or when option *-n* is given and the environment variable POSIXLY_CORRECT is set, then _priority_
+is understood as a relative value.
 
 == OPTIONS
 
-*-n* _priority_::
-Specify the *absolute* or *relative* (depending on environment variable POSIXLY_CORRECT) scheduling _priority_ to be used for the process, process group, or user. Use of the option *-n* is optional, but when used, it must be the first argument. See *NOTES* for more information.
+*-n* _priority_|__delta__::
+Specify the absolute scheduling priority (when POSIXLY_CORRECT is not set) or a relative
+priority (when POSIXLY_CORRECT *is* set).  See *NOTES* below for more details.
+Using option *-n* is optional, but when used, it must be the first argument.
 
 *--priority* _priority_::
-Specify an *absolute* scheduling _priority_. _Priority_ is set to the given value. This is the default, when no option is specified.
+Specify the absolute scheduling _priority_ to be used.
+This is the default, when no option is specified.
 
-*--relative* _priority_::
-Specify a *relative* scheduling _priority_. Same as the standard POSIX *-n* option. _Priority_ gets _incremented/decremented_ by the given value.
+*--relative* _delta_::
+Specify a relative priority. The actual scheduling priority gets incremented/decremented
+by the given _delta_. (This is the same as the *-n* option when POSIXLY_CORRECT is set.)
 
 *-g*, *--pgrp*::
 Interpret the succeeding arguments as process group IDs.
@@ -83,21 +89,30 @@ to map user names to user IDs
 
 == NOTES
 
-Users other than the superuser may only alter the priority of processes they own. Furthermore, an unprivileged user can only _increase_ the "nice value" (i.e., choose a lower priority) and such changes are irreversible unless (since Linux 2.6.12) the user has a suitable "nice" resource limit (see *ulimit*(1p) and *getrlimit*(2)).
+Users other than the superuser may alter the priority only of processes they own.
+Furthermore, an unprivileged user can only _increase_ the "nice value" (that is:
+lower the urgency), and such changes are irreversible unless (since Linux 2.6.12)
+the user has a suitable "nice" resource limit (see *getrlimit*(2)).
 
 The superuser may alter the priority of any process and set the priority to any value in the range -20 to 19. Useful priorities are: 19 (the affected processes will run only when nothing else in the system wants to), 0 (the "base" scheduling priority), anything negative (to make things go very fast).
 
-For historical reasons in this implementation, the *-n* option did not follow the POSIX specification. Therefore, instead of setting a *relative* priority, it sets an *absolute* priority by default. As this may not be desirable, this behavior can be controlled by setting the environment variable POSIXLY_CORRECT to be fully POSIX compliant. See the *-n* option for details. See *--relative* and *--priority* for options that do not change behavior depending on environment variables.
+For historical reasons, the *-n* option in this implementation does not follow the POSIX
+specification: instead of setting a *relative* priority, it sets an *absolute* priority
+by default. As this may not be desirable, this behavior can be changed by setting the
+environment variable POSIXLY_CORRECT, to be fully POSIX compliant. See *--relative* and
+*--priority* for options that do not change behavior depending on environment variables.
 
 == HISTORY
 
 The *renice* command appeared in 4.0BSD.
 
-== EXAMPLES
+== EXAMPLE
 
-The following command would change the priority of the processes with PIDs 987 and 32, plus all processes owned by the users daemon and root:
+The following command changes the priority of the processes with PIDs 987 and 32, plus all processes owned by the users daemon and root:
 
+____
 *renice +1 987 -u daemon root -p 32*
+____
 
 == SEE ALSO
 
-- 
2.48.1


  parent reply	other threads:[~2025-04-17  9:49 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-04-17  9:48 [PATCH 01/10] bits: (man) normalize the markup and improve some layout Benno Schulenberg
2025-04-17  9:48 ` [PATCH 02/10] last: (man) correct the descriptions of --present and --since Benno Schulenberg
2025-04-17  9:48 ` [PATCH 03/10] last: (man) reduce an inflated table to sane proportions Benno Schulenberg
2025-04-17  9:48 ` [PATCH 04/10] rtcwake: " Benno Schulenberg
2025-04-17  9:48 ` [PATCH 05/10] terminal-colors.d: (man) reduce two tables to succinct lists Benno Schulenberg
2025-04-17  9:48 ` [PATCH 06/10] renice: in usage text, condense the oververbose description of option -n Benno Schulenberg
2025-04-17  9:48 ` Benno Schulenberg [this message]
2025-04-17  9:48 ` [PATCH 08/10] lscpu: (man) don't refer to a missing section, and improve some wordings Benno Schulenberg
2025-04-17  9:48 ` [PATCH 09/10] docs: correct misspellings of "may be" and mistaken uses of "overwritten" Benno Schulenberg
2025-04-17  9:48 ` [PATCH 10/10] docs: correct mistaken uses of "overwrite" to say "override" instead Benno Schulenberg
2025-04-17  9:58 ` [PATCH 01/10] bits: (man) normalize the markup and improve some layout Robin Jarry
2025-04-24  9:57 ` Karel Zak

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250417094825.20870-7-bensberg@telfort.nl \
    --to=bensberg@telfort.nl \
    --cc=david.anes@suse.com \
    --cc=util-linux@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox