[src/trunk]: src/usr.bin/tpfmt man page

[yamt <yamt%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/be3f23c5b9eb
branches:  trunk
changeset: 771624:be3f23c5b9eb
user:      yamt <yamt%NetBSD.org@localhost>
date:      Sat Nov 26 16:15:09 2011 +0000

description:
man page

diffstat:

 usr.bin/tpfmt/Makefile |   3 +-
 usr.bin/tpfmt/tpfmt.1  |  95 ++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 96 insertions(+), 2 deletions(-)

diffs (111 lines):

diff -r 1db77da55612 -r be3f23c5b9eb usr.bin/tpfmt/Makefile
--- a/usr.bin/tpfmt/Makefile    Sat Nov 26 15:59:34 2011 +0000
+++ b/usr.bin/tpfmt/Makefile    Sat Nov 26 16:15:09 2011 +0000
@@ -1,7 +1,6 @@
-#      $NetBSD: Makefile,v 1.3 2011/04/14 16:25:58 yamt Exp $
+#      $NetBSD: Makefile,v 1.4 2011/11/26 16:15:09 yamt Exp $
 
 PROG=  tpfmt
-NOMAN= 
 
 CPPFLAGS+= -I${NETBSDSRCDIR}/sys/
 SRCS=  tpfmt.c sym.c
diff -r 1db77da55612 -r be3f23c5b9eb usr.bin/tpfmt/tpfmt.1
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/usr.bin/tpfmt/tpfmt.1     Sat Nov 26 16:15:09 2011 +0000
@@ -0,0 +1,95 @@
+.\"    $NetBSD: tpfmt.1,v 1.1 2011/11/26 16:15:09 yamt Exp $
+.\"
+.\" Copyright (c)2011 YAMAMOTO Takashi,
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" ------------------------------------------------------------
+.Dd November 27, 2011
+.Dt TPFMT 8
+.Os
+.\" ------------------------------------------------------------
+.Sh NAME
+.Nm tpfmt
+.Nd format tprof samples
+.Dt LS 1
+.\" ------------------------------------------------------------
+.Sh SYNOPSIS
+.Nm
+.Op Fl CkLPs
+.Op Fl p Ar pid
+.\" ------------------------------------------------------------
+.Sh DESCRIPTION
+The
+.Nm
+utility creates and outputs a plain text representation
+for a given profiling result recorded by
+.Xr tprof 8 .
+.\" XXX should explain the output.
+.Pp
+The
+.Nm
+utility accepts the following options.
+.Bl -tag -width hogehoge
+.It Fl C
+Don't distinguish CPUs.
+All samples are treated as its CPU number is 0.
+.It Fl k
+Kernel only.
+Ignore samples for userland code.
+.It Fl L
+Don't distinguish LWPs.
+All samples are treated as its LWP ID is 0.
+.It Fl P
+Don't distinguish processes.
+All samples are treated as its PID is 0.
+.It Fl p Ar pid
+Process only samples for the process with PID
+.Ar pid
+and ignore the rest.
+.It Fl s
+Per symbol.
+Try to aggregate samples by functions rather than instructions.
+It's currently useful only for in-kernel samples.
+.El
+.\" ------------------------------------------------------------
+.Sh EXAMPLES
+See
+.Xr tprof 8
+for an example.
+.\" ------------------------------------------------------------
+.\.Sh HISTORY
+.\The
+.\.Nm
+.\utility first appeared in
+.\.Nx XXX .
+.\" ------------------------------------------------------------
+.Sh AUTHORS
+The
+.Nm
+utility is written by
+.An YAMAMOTO Takashi .
+.\" ------------------------------------------------------------
+.Sh SEE ALSO
+.Xr tprof 4 ,
+.Xr tprof 8