summaryrefslogtreecommitdiffstats
path: root/sys-utils/readprofile.1
diff options
context:
space:
mode:
authorPeter Breitenlohner2009-07-22 11:29:04 +0200
committerKarel Zak2009-08-17 12:11:06 +0200
commitfd22da56a63dde7f316975ffb06818c5cc81245b (patch)
tree55882bb7969afda7d28b80e209993c43c1be09ee /sys-utils/readprofile.1
parentrdev.8: formatting (diff)
downloadkernel-qcow2-util-linux-fd22da56a63dde7f316975ffb06818c5cc81245b.tar.gz
kernel-qcow2-util-linux-fd22da56a63dde7f316975ffb06818c5cc81245b.tar.xz
kernel-qcow2-util-linux-fd22da56a63dde7f316975ffb06818c5cc81245b.zip
readprofile.1: formatting
Signed-off-by: Peter Breitenlohner <peb@mppmu.mpg.de>
Diffstat (limited to 'sys-utils/readprofile.1')
-rw-r--r--sys-utils/readprofile.138
1 files changed, 18 insertions, 20 deletions
diff --git a/sys-utils/readprofile.1 b/sys-utils/readprofile.1
index 57f35b910..dc65053f0 100644
--- a/sys-utils/readprofile.1
+++ b/sys-utils/readprofile.1
@@ -4,9 +4,7 @@
readprofile - a tool to read kernel profiling information
.SH SYNOPSIS
.B readprofile
-[
-.I options
-]
+.RI [ options ]
.SH VERSION
This manpage documents version 2.0 of the program.
@@ -16,7 +14,7 @@ This manpage documents version 2.0 of the program.
.LP
The
.B readprofile
-command uses the
+command uses the
.B /proc/profile
information to print ascii data on standard output.
The output is
@@ -30,7 +28,7 @@ the procedure. The output is filled with blanks to ease readability.
Available command line options are the following:
.TP
-.RB -m " mapfile"
+.BI \-m " mapfile"
Specify a mapfile, which by default is
.B /usr/src/linux/System.map.
You should specify the map file on cmdline if your current kernel isn't the
@@ -38,51 +36,51 @@ last one you compiled, or if you keep System.map elsewhere. If the name of
the map file ends with `.gz' it is decompressed on the fly.
.TP
-.RB -p " pro-file"
+.BI \-p " pro-file"
Specify a different profiling buffer, which by default is
.B /proc/profile.
Using a different pro-file is useful if you want to `freeze' the
kernel profiling at some time and read it later. The
.B /proc/profile
file can be copied using `cat' or `cp'. There is no more support for
-compressed profile buffers, like in
+compressed profile buffers, like in
.B readprofile-1.1,
because the program needs to know the size of the buffer in advance.
.TP
-.B -i
-Info. This makes
+.B \-i
+Info. This makes
.B readprofile
only print the profiling step used by the kernel.
The profiling step is the resolution of the profiling buffer, and
is chosen during kernel configuration (through `make config'),
or in the kernel's command line.
-If the
-.B -t
+If the
+.B \-t
(terse) switch is used together with
-.B -i
+.B \-i
only the decimal number is printed.
.TP
-.B -a
+.B \-a
Print all symbols in the mapfile. By default the procedures with 0 reported
ticks are not printed.
.TP
-.B -b
+.B \-b
Print individual histogram-bin counts.
.TP
-.B -r
+.B \-r
Reset the profiling buffer. This can only be invoked by root, because
.B /proc/profile
is readable by everybody but writable only by the superuser. However,
-you can make
+you can make
.B readprofile
setuid 0, in order to reset the buffer without gaining privileges.
.TP
-.RB -M " multiplier"
+.BI \-M " multiplier"
On some architectures it is possible to alter the frequency at which
the kernel delivers profiling interrupts to each CPU. This option allows you to
set the frequency, as a multiplier of the system clock frequency, HZ.
@@ -91,14 +89,14 @@ and sparc64-SMP (2.4 kernel). This option also resets the profiling buffer,
and requires superuser privileges.
.TP
-.B -v
+.B \-v
Verbose. The output is organized in four columns and filled with blanks.
The first column is the RAM address of a kernel function, the second is
the name of the function, the third is the number of clock ticks and the
last is the normalized load.
.TP
-.B -V
+.B \-V
Version. This makes
.B readprofile
print its version number and exit.
@@ -140,7 +138,7 @@ Request profiling at 2kHz per CPU, and reset the profiling buffer
.LP
.B readprofile
only works with an 1.3.x or newer kernel,
-because
+because
.B /proc/profile
changed in the step from 1.2 to 1.3