summaryrefslogtreecommitdiffstats
path: root/sys-utils/lscpu.1
diff options
context:
space:
mode:
authorBenno Schulenberg2013-01-22 11:13:07 +0100
committerKarel Zak2013-01-30 15:23:56 +0100
commit7ff986d328657c91c64b98a560eefc8abff7640e (patch)
treecfec8b27f57ae94e8a33b9b3c4482ee512119f42 /sys-utils/lscpu.1
parentlscpu: correct the description of --sysroot in help text (diff)
downloadkernel-qcow2-util-linux-7ff986d328657c91c64b98a560eefc8abff7640e.tar.gz
kernel-qcow2-util-linux-7ff986d328657c91c64b98a560eefc8abff7640e.tar.xz
kernel-qcow2-util-linux-7ff986d328657c91c64b98a560eefc8abff7640e.zip
doc: remove incorrect spaces from lscpu synopsis in manpage
Also normalize text spacing and add some formatting. Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
Diffstat (limited to 'sys-utils/lscpu.1')
-rw-r--r--sys-utils/lscpu.159
1 files changed, 29 insertions, 30 deletions
diff --git a/sys-utils/lscpu.1 b/sys-utils/lscpu.1
index f7e34b95d..f747a35b7 100644
--- a/sys-utils/lscpu.1
+++ b/sys-utils/lscpu.1
@@ -1,32 +1,31 @@
.\" Process this file with
.\" groff -man -Tascii lscpu.1
.\"
-.TH LSCPU 1 "February 2011" "util-linux" "User Commands"
+.TH LSCPU 1 "January 2013" "util-linux" "User Commands"
.SH NAME
lscpu \- display information about the CPU architecture
.SH SYNOPSIS
.B lscpu
-.RB [ \-a | \-b | \-c "] [" \-x "] [" \-s " \fIdirectory\fP] [" \-e " [\fI=list\fP]|" \-p " [\fI=list\fP]]"
+.RB [ \-a | \-b | \-c "] [" \-x "] [" \-s " \fIdirectory\fP] [" \-e [=\fIlist\fP]| \-p [=\fIlist\fP]]
.br
.B lscpu
.BR \-h | \-V
.SH DESCRIPTION
.B lscpu
-gathers CPU architecture information from sysfs and /proc/cpuinfo. The
+gathers CPU architecture information from sysfs and /proc/cpuinfo. The
command output can be optimized for parsing or for easy readability by humans.
-.br
The information includes, for example, the number of CPUs, threads, cores,
-sockets, and Non-Uniform Memory Access (NUMA) nodes. There is also information
+sockets, and Non-Uniform Memory Access (NUMA) nodes. There is also information
about the CPU caches and cache sharing, family, model, bogoMIPS, byte order,
and stepping.
-Options that result in an output table have a \fIlist\fP argument. Use this
-argument to customize the command output. Specify a comma-separated list of
+Options that result in an output table have a \fIlist\fP argument. Use this
+argument to customize the command output. Specify a comma-separated list of
column labels to limit the output table to only the specified columns, arranged
-in the specified order. See \fBCOLUMNS\fP for a list of valid column labels. The
+in the specified order. See \fBCOLUMNS\fP for a list of valid column labels. The
column labels are not case sensitive.
-Not all columns are supported on all architectures. If an unsupported column is
+Not all columns are supported on all architectures. If an unsupported column is
specified, \fBlscpu\fP prints the column but does not provide any data for it.
.SS COLUMNS
@@ -35,16 +34,16 @@ specified, \fBlscpu\fP prints the column but does not provide any data for it.
The logical CPU number of a CPU as used by the Linux kernel.
.TP
.B CORE
-The logical core number. A core can contain several CPUs.
+The logical core number. A core can contain several CPUs.
.TP
.B SOCKET
-The logical socket number. A socket can contain several cores.
+The logical socket number. A socket can contain several cores.
.TP
.B BOOK
-The logical book number. A book can contain several sockets.
+The logical book number. A book can contain several sockets.
.TP
.B NODE
-The logical NUMA node number. A node may contain several books.
+The logical NUMA node number. A node may contain several books.
.TP
.B CACHE
Information about how caches are shared between CPUs.
@@ -57,14 +56,14 @@ Indicator that shows whether the Linux instance currently makes use of the CPU.
.TP
.B CONFIGURED
Indicator that shows if the hypervisor has allocated the CPU to the virtual
-hardware on which the Linux instance runs. CPUs that are configured can be set
+hardware on which the Linux instance runs. CPUs that are configured can be set
online by the Linux instance.
This column contains data only if your hardware system and hypervisor support
dynamic CPU resource allocation.
.TP
.B POLARIZATION
This column contains data for Linux instances that run on virtual hardware with
-a hypervisor that can switch the CPU dispatching mode (polarization). The
+a hypervisor that can switch the CPU dispatching mode (polarization). The
polarization can be:
.RS
.TP 12
@@ -75,52 +74,52 @@ The workload is spread across all available CPUs.
The workload is concentrated on few CPUs.
.P
For vertical polarization, the column also shows the degree of concentration,
-high, medium, or low. This column contains data only if your hardware system
+high, medium, or low. This column contains data only if your hardware system
and hypervisor support CPU polarization.
.RE
.SH OPTIONS
.TP
.BR \-a , " \-\-all"
-Include lines for online and offline CPUs in the output (default for -e). This
-option may only specified together with option -e or -p.
+Include lines for online and offline CPUs in the output (default for \fB-e\fR).
+This option may only be specified together with option \fB-e\fR or \fB-p\fR.
.TP
.BR \-b , " \-\-online"
-Limit the output to online CPUs (default for -p). This option may only
-be specified together with option -e or -p.
+Limit the output to online CPUs (default for \fB-p\fR).
+This option may only be specified together with option \fB-e\fR or \fB-p\fR.
.TP
.BR \-c , " \-\-offline"
-Limit the output to offline CPUs. This option may only be specified together
-with option -e or -p.
+Limit the output to offline CPUs.
+This option may only be specified together with option \fB-e\fR or \fB-p\fR.
.TP
-.BR \-e , " \-\-extended " \fI[=list]\fP
+.BR \-e , " \-\-extended" [=\fIlist\fP]
Display the CPU information in human readable format.
If the \fIlist\fP argument is omitted, all columns for which data is available
are included in the command output.
When specifying the \fIlist\fP argument, the string of option, equal sign (=), and
-\fIlist\fP must not contain any blanks or other white space.
+\fIlist\fP must not contain any blanks or other whitespace.
Examples: '\fB-e=cpu,node\fP' or '\fB--extended=cpu,node\fP'.
.TP
.BR \-h , " \-\-help"
Display help information and exit.
.TP
-.BR \-p , " \-\-parse " \fI[=list]\fP
+.BR \-p , " \-\-parse" [=\fIlist\fP]
Optimize the command output for easy parsing.
If the \fIlist\fP argument is omitted, the command output is compatible with earlier
-versions of \fBlscpu\fP. In this compatible format, two commas are used to separate
-CPU cache columns. If no CPU caches are identified the cache column is omitted.
+versions of \fBlscpu\fP. In this compatible format, two commas are used to separate
+CPU cache columns. If no CPU caches are identified the cache column is omitted.
.br
If the \fIlist\fP argument is used, cache columns are separated with a colon (:).
When specifying the \fIlist\fP argument, the string of option, equal sign (=), and
-\fIlist\fP must not contain any blanks or other white space.
+\fIlist\fP must not contain any blanks or other whitespace.
Examples: '\fB-p=cpu,node\fP' or '\fB--parse=cpu,node\fP'.
.TP
.BR \-s , " \-\-sysroot " \fIdirectory\fP
Gather CPU data for a Linux instance other than the instance from which the
-\fBlscpu\fP command is issued. The specified \fIdirectory\fP is the system root
+\fBlscpu\fP command is issued. The specified \fIdirectory\fP is the system root
of the Linux instance to be inspected.
.TP
.BR \-x , " \-\-hex"
@@ -130,7 +129,7 @@ the sets in list format (for example 0,1).
.BR \-V , " \-\-version"
Display version information and exit.
.SH BUGS
-The basic overview about CPU family, model, etc. is always based on the first
+The basic overview of CPU family, model, etc. is always based on the first
CPU only.
Sometimes in Xen Dom0 the kernel reports wrong data.