From c372860ddb4a768f7f6c50cd26d60119370d5cd5 Mon Sep 17 00:00:00 2001 From: Benno Schulenberg Date: Sun, 20 Jul 2014 23:15:47 +0200 Subject: docs: bring eight more man pages closer to standard formatting Also, for chcpu, the options -c, -d, -e and -g are mutually exclusive, and for the mode argument the option -p is not optional. For ldattach, use the standard options separator ", " instead of the unusual " | ". And add the missing --version to several of the pages. Besides, improve the wording and the consistency of the spacing. Signed-off-by: Benno Schulenberg --- sys-utils/chcpu.8 | 58 ++++++++++++++++++++++++++----------------------------- 1 file changed, 27 insertions(+), 31 deletions(-) (limited to 'sys-utils/chcpu.8') diff --git a/sys-utils/chcpu.8 b/sys-utils/chcpu.8 index c3ce86c3c..9bed8ea2c 100644 --- a/sys-utils/chcpu.8 +++ b/sys-utils/chcpu.8 @@ -1,18 +1,16 @@ -.TH CHCPU "8" "June 2012" Linux "User Manuals" +.TH CHCPU 8 "July 2014" "util-linux" "System Administration" .SH NAME chcpu \- configure CPUs .SH SYNOPSIS -chcpu -[\-e] [\-d] [\-c] [\-g] -cpu-list -.br -chcpu [\-p] mode -.br -chcpu -\-r +.B chcpu +.BR \-c | \-d | \-e | \-g +.I cpu-list .br -chcpu [\-h] [\-V] +.B chcpu \-p +.I mode .br +.B chcpu +.BR \-r | \-h | \-V .SH DESCRIPTION .B chcpu can modify the state of CPUs. It can enable or disable CPUs, scan for new @@ -31,21 +29,24 @@ makes the command applicable to the CPUs with the addresses 0, 5, 7, 9, 10, and 11. .SH OPTIONS .TP -.BR \-r , " \-\-rescan" -Trigger a rescan of CPUs. Use this option on systems that do not -automatically detect newly attached CPUs. The Linux kernel then recognizes -the new CPUs. -.TP .BR \-c , " \-\-configure " \fIcpu-list\fP -Configure all specified CPUs. Configuring a CPU means that the hypervisor +Configure the specified CPUs. Configuring a CPU means that the hypervisor takes a CPU from the CPU pool and assigns it to the virtual hardware on which your kernel runs. .TP +.BR \-d , " \-\-disable " \fIcpu-list\fP +Disable the specified CPUs. Disabling a CPU means that the kernel sets it +offline. +.TP .BR \-e , " \-\-enable " \fIcpu-list\fP -Enable all specified CPUs. Enabling a CPU means that the kernel sets it -online. A CPU must be configured, see -.BR -c , -before it can be enabled. +Enable the specified CPUs. Enabling a CPU means that the kernel sets it +online. A CPU must be configured, see \fB\-c\fR, before it can be enabled. +.TP +.BR \-g , " \-\-deconfigure " \fIcpu-list\fP +Deconfigure the specified CPUs. Deconfiguring a CPU means that the +hypervisor removes the CPU from the virtual hardware on which the Linux +instance runs and returns it to the CPU pool. A CPU must be offline, see +\fB\-d\fR, before it can be deconfigured. .TP .BR \-p , " \-\-dispatch " \fImode\fP Set the CPU dispatching @@ -65,21 +66,16 @@ The workload is concentrated on few CPUs. .RE .PD 1 .TP -.BR \-d , " \-\-disable " \fIcpu-list\fP -Disable all specified CPUs. Disabling a CPU means that the kernel sets it -offline. +.BR \-r , " \-\-rescan" +Trigger a rescan of CPUs. After a rescan, the Linux kernel recognizes +the new CPUs. Use this option on systems that do not +automatically detect newly attached CPUs. .TP -.BR \-g , " \-\-deconfigure " \fIcpu-list\fP -Deconfigure all specified CPUs. Deconfiguring a CPU means that the -hypervisor removes the CPU from the virtual hardware on which the Linux -instance runs and returns it to the CPU pool. A CPU must be offline, see -\-d, before it can be deconfigured. +.BR \-V , " \-\-version" +Display version information and exit. .TP .BR \-h , " \-\-help" Display help text and exit. -.TP -.BR \-V , " \-\-version" -Display version information and exit. .SH RETURN CODES .B chcpu -- cgit v1.2.3-55-g7522