Imported from util-linux-2.7.1 tarball.

1 files changed, 25 insertions, 34 deletions

diff --git a/sys-utils/readprofile.1 b/sys-utils/readprofile.1
index fd5d7196d..a72113c85 100644
--- a/sys-utils/readprofile.1
+++ b/sys-utils/readprofile.1
@@ -1,4 +1,4 @@
-.TH READPROFILE 1 "January 1995"
+.TH READPROFILE 1 "May 1996"
 .UC 4
 .SH NAME
 readprofile - a tool to read kernel profiling information
@@ -9,7 +9,7 @@ readprofile - a tool to read kernel profiling information
 ]
 
 .SH VERSION
-This manpage documents version 1.1 of the program.
+This manpage documents version 2.0 of the program.
 
 .SH DESCRIPTION
 
@@ -33,12 +33,6 @@ Available command line options are the following:
 .RB -m " mapfile"
 Specify a mapfile, which by default is
 .B /usr/src/linux/System.map.
-To ease use of
-.B readprofile
-with kernels in the 1.1.7x series, if the default file can't be opened,
-the alternate file
-.B /usr/src/linux/zSystem.map
-is tried.
 You should specify the map file on cmdline if your current kernel isn't the
 last one you compiled. If the name of the map file ends with `.gz' it
 is decompressed on the fly.
@@ -50,10 +44,10 @@ Specify a different profiling buffer, which by default is
 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'. If the name of the pro-file
-ends by `.gz' it is decompressed on the fly. The pro-file is such that
-.B gzip
-shrinks it by 50-100 times.
+file can be copied using `cat' or `cp'. There is no more support for
+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
@@ -61,7 +55,8 @@ 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').
+is chosen during kernel configuration (through `make config'),
+or in the kernel's command line.
 If the 
 .B -t
 (terse) switch is used together with
@@ -77,13 +72,10 @@ ticks are not printed.
 .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.
-
-.TP
-.B -t
-Terse. This causes the output to be unfilled. It is the format used in the
-first release of 
-.B readprofile.
+is readable by everybody but writable only by the superuser. However,
+you can make 
+.B readprofile
+setuid 0, in order to reset the buffer without gaining privileges.
 
 .TP
 .B -v
@@ -119,9 +111,9 @@ Look at all the kernel information, with ram addresses"
    readprofile -av | less
 
 .fi
-Browse a gzipped `freezed' profile buffer for a non current kernel:
+Browse a `freezed' profile buffer for a non current kernel:
 .nf
-   readprofile -p ~/profile.freeze.gz -m /zImage.map
+   readprofile -p ~/profile.freeze -m /zImage.map.gz
 
 .fi
 
@@ -129,31 +121,30 @@ Browse a gzipped `freezed' profile buffer for a non current kernel:
 
 .LP
 .B readprofile
-needs a kernel version 1.1.73 or newer, because
+only works with an 1.3.x or newer kernel,
+because 
 .B /proc/profile
-is absent
-in older versions.
+changed in the step from 1.2 to 1.3
 
 .LP
-To enable profiling, the kernel must be reconfigured, recompiled, and
-rebooted. No profiling module is available, and it wouldn't be easy to
-build. So this can be construed as a feature.
+This program only works with ELF kernels. The change for a.out kernels
+is trivial, and left as an exercise to the a.out user.
+
+.LP
+To enable profiling, the kernel must be rebooted, because no profiling module
+is available, and it wouldn't be easy to build. To enable profiling,
+you can specify "profile=2" (or another number) on the kernel commandline.
+The number you specify is the two-exponent used as profiling step.
 
 .LP
 Profiling is disabled when interrupts are inhibited. This means that many
 profiling ticks happen when interrupts are re-enabled. Watch out for
 misleading information.
 
-.SH AUTHOR
-
-Readprofile and /proc/profile are by Alessandro Rubini (rubini@ipvvis.unipv.it)
-
 .SH FILES
 .nf
 /proc/profile              A binary snapshot of the profiling buffer.
 /usr/src/linux/System.map  The symbol table for the kernel.
-/usr/src/linux/zSystem.map Old name for the symbol table. 
-
 /usr/src/linux/*           The program being profiled :-)
 .fi