summaryrefslogtreecommitdiffstats
path: root/schedutils
diff options
context:
space:
mode:
authorBenno Schulenberg2011-08-03 11:17:11 +0200
committerKarel Zak2011-08-08 11:58:48 +0200
commit397a511458ddf57548c08fcd39e7e8c4ddc7f80f (patch)
treee316691b6ce6d17248a7d342cf112814d2598a48 /schedutils
parentwipefs: change option -v to -V for --version; add it to man page (diff)
downloadkernel-qcow2-util-linux-397a511458ddf57548c08fcd39e7e8c4ddc7f80f.tar.gz
kernel-qcow2-util-linux-397a511458ddf57548c08fcd39e7e8c4ddc7f80f.tar.xz
kernel-qcow2-util-linux-397a511458ddf57548c08fcd39e7e8c4ddc7f80f.zip
chrt: adjust style of man page, alphabetize option -p
Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
Diffstat (limited to 'schedutils')
-rw-r--r--schedutils/chrt.160
1 files changed, 32 insertions, 28 deletions
diff --git a/schedutils/chrt.1 b/schedutils/chrt.1
index 79750c75d..e7f2c3e4d 100644
--- a/schedutils/chrt.1
+++ b/schedutils/chrt.1
@@ -39,9 +39,9 @@ chrt \- manipulate real-time attributes of a process
.RI [ prio ]\ pid
.SH DESCRIPTION
.PP
-.BR chrt (1)
-sets or retrieves the real-time scheduling attributes of an existing PID, or
-runs COMMAND with the given attributes. Both policy (one of
+.BR chrt
+sets or retrieves the real-time scheduling attributes of an existing \fIpid\fR,
+or runs \fIcommand\fR with the given attributes. Both policy (one of
.BR SCHED_OTHER ,
.BR SCHED_FIFO ,
.BR SCHED_RR ,
@@ -52,7 +52,7 @@ and priority can be set and retrieved.
.PP
The
.BR SCHED_BATCH
-policy is supported since Linux 2.6.16. The
+policy is supported since Linux 2.6.16. The
.BR SCHED_IDLE
policy is supported since Linux 2.6.23.
.PP
@@ -62,66 +62,70 @@ flag for policies SCHED_RR and SCHED_FIFO is supported
since Linux 2.6.31.
.SH OPTIONS
.TP
-.B -p, --pid
-operate on an existing PID and do not launch a new task
-.TP
.B -a, --all-tasks
-set or retrieve the scheduling attributes of all the tasks (threads) for a
+Set or retrieve the scheduling attributes of all the tasks (threads) for a
given PID.
.TP
.B -b, --batch
-set scheduling policy to
+Set scheduling policy to
.BR SCHED_BATCH
-(Linux specific)
+(Linux specific).
.TP
.B -f, --fifo
-set scheduling policy to
-.BR SCHED_FIFO
+Set scheduling policy to
+.BR SCHED_FIFO .
.TP
.B -i, --idle
-set scheduling policy to
+Set scheduling policy to
.BR SCHED_IDLE
-(Linux specific)
+(Linux specific).
.TP
.B -m, --max
-show minimum and maximum valid priorities, then exit
+Show minimum and maximum valid priorities, then exit.
.TP
.B -o, --other
-set policy scheduling policy to
-.BR SCHED_OTHER
+Set policy scheduling policy to
+.BR SCHED_OTHER .
+.TP
+.B -p, --pid
+Operate on an existing PID and do not launch a new task.
.TP
.B -r, --rr
-set scheduling policy to
+Set scheduling policy to
.BR SCHED_RR
-(the default)
+(the default).
.TP
.B -R, --reset-on-fork
-add
+Add
.B SCHED_RESET_ON_FORK
flag to the
.B SCHED_FIFO
or
.B SCHED_RR
-scheduling policy (Linux specific)
+scheduling policy (Linux specific).
.TP
.B -v, --verbose
-show status information
+Show status information.
.TP
.B -h, --help
-display usage information and exit
+Display usage information and exit.
.TP
.B -V, --version
-display version information and exit
+Display version information and exit.
.SH USAGE
.TP
-The default behavior is to run a new command::
-chrt prio command [arguments]
+The default behavior is to run a new command:
+.B chrt
+.I prio
+.IR command\ [ arguments ]
.TP
You can also retrieve the real-time attributes of an existing task:
-chrt -p pid
+.B chrt \-p
+.I pid
.TP
Or set them:
-chrt -p prio pid
+.B chrt \-p
+.I prio pid
.SH PERMISSIONS
A user must possess
.BR CAP_SYS_NICE