From: Sami Kerola Date: Sat, 2 Jun 2012 19:00:19 +0000 (+0200) Subject: docs: clean up chcpu.8 manual X-Git-Tag: v2.22-rc1~315^2~2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a6210872c5e76a3b5f86953db025eb7cb8a38c9f;p=thirdparty%2Futil-linux.git docs: clean up chcpu.8 manual * Add lightness to synopsis. * Use argument and parameter highlights consistently. * Indent dispatch modes. * Add spaces after dots (English spacing). * Add line break macros. * Use URL and email macros where appropriate. Signed-off-by: Sami Kerola --- diff --git a/sys-utils/chcpu.8 b/sys-utils/chcpu.8 index 8bafd0d6c6..d016b86f26 100644 --- a/sys-utils/chcpu.8 +++ b/sys-utils/chcpu.8 @@ -1,70 +1,79 @@ -.TH CHCPU 8 "August 2011" Linux "User Manuals" +.TH CHCPU "8" "June 2012" Linux "User Manuals" .SH NAME chcpu \- configure CPUs .SH SYNOPSIS -.B chcpu -.BR \-e | \-d | \-c | \-g " \fIcpu-list\fP" +chcpu +[\-e] [\-d] [\-c] [\-g] +cpu-list .br -.B chcpu -.BR \-p " \fImode\fP" +chcpu [\-p] mode .br -.B chcpu -.BR \-r +chcpu +\-r .br -.B chcpu -.BR \-h | \-V +chcpu [\-h] [\-V] .br .SH DESCRIPTION .B chcpu -can modify the state of CPUs. It can enable or disable CPUs, scan -for new CPUs, change the CPU dispatching mode of the underlying hypervisor, -and request CPUs from the hypervisor (configure) or return CPUs to the -hypervisor (deconfigure). - -Some options have a \fIcpu-list\fP argument. Use this argument to specify a -comma-separated list of CPUs. The list can contain individual CPU addresses or -ranges of addresses. -For example, -.BR 0,5,7,9-11 -makes the command applicable to the CPUs with the addresses 0, 5, 7, 9, 10, and -11. - +can modify the state of CPUs. It can enable or disable CPUs, scan for new +CPUs, change the CPU dispatching +.I mode +of the underlying hypervisor, and request CPUs from the hypervisor +(configure) or return CPUs to the hypervisor (deconfigure). +.PP +Some options have a +.I cpu-list +argument. Use this argument to specify a comma-separated list of CPUs. The +list can contain individual CPU addresses or ranges of addresses. For +example, +.B 0,5,7,9-11 +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. +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 takes -a CPU from the CPU pool and assigns it to the virtual hardware on which your -kernel runs. +Configure all 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 \-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 -c, before it can be enabled. +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. .TP .BR \-p , " \-\-dispatch " \fImode\fP -Set the CPU dispatching mode (polarization). This option has an effect only if -your hardware architecture and hypervisor support CPU polarization. There are -two modes: -.RS +Set the CPU dispatching +.I mode +(polarization). This option has an effect only if your hardware architecture +and hypervisor support CPU polarization. Available +.I modes +are: +.RS 14 .TP 12 +.PD 0 .B horizontal The workload is spread across all available CPUs. .TP 12 .B vertical 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. +Disable all specified CPUs. Disabling a CPU means that the kernel sets it +offline. .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. +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. .TP .BR \-h , " \-\-help" Display help information and exit. @@ -72,9 +81,9 @@ Display help information and exit. .BR \-V , " \-\-version" Display version information and exit. .SH AUTHOR -.nf -Heiko Carstens -.fi +.MT heiko.carstens@de.ibm.com +Heiko Carstens +.ME .SH COPYRIGHT Copyright IBM Corp. 2011 .br @@ -82,4 +91,6 @@ Copyright IBM Corp. 2011 .BR lscpu (1) .SH AVAILABILITY The chcpu command is part of the util-linux package and is available from -ftp://ftp.kernel.org/pub/linux/utils/util-linux/. +.UR ftp://\:ftp.kernel.org\:/pub\:/linux\:/utils\:/util-linux/ +Linux Kernel Archive +.UE .