[prev in list] [next in list] [prev in thread] [next in thread] 

List:       oprofile-list
Subject:    [PATCH 5/7] Add a short man page for op-check-perfevents.
From:       William Cohen <wcohen () redhat ! com>
Date:       2013-07-05 16:08:21
Message-ID: 1373040503-16422-6-git-send-email-wcohen () redhat ! com
[Download RAW message or body]


Signed-off-by: William Cohen <wcohen@redhat.com>
---
 configure.ac                 |  1 +
 doc/Makefile.am              |  1 +
 doc/op-check-perfevents.1.in | 36 ++++++++++++++++++++++++++++++++++++
 3 files changed, 38 insertions(+)
 create mode 100644 doc/op-check-perfevents.1.in

diff --git a/configure.ac b/configure.ac
index a985d1d..39b8af9 100644
--- a/configure.ac
+++ b/configure.ac
@@ -426,6 +426,7 @@ AC_OUTPUT(Makefile \
 	doc/oprofile.1 \
 	doc/opcontrol.1 \
 	doc/ophelp.1 \
+	doc/op-check-perfevents.1 \
 	doc/opreport.1 \
 	doc/opannotate.1 \
 	doc/opgprof.1 \
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 68d472b..a78943b 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -15,6 +15,7 @@ man_MANS = \
 	opannotate.1 \
 	opgprof.1 \
 	ophelp.1 \
+	op-check-perfevents.1 \
 	oparchive.1 \
 	opimport.1
 
diff --git a/doc/op-check-perfevents.1.in b/doc/op-check-perfevents.1.in
new file mode 100644
index 0000000..79c8e01
--- /dev/null
+++ b/doc/op-check-perfevents.1.in
@@ -0,0 +1,36 @@
+.TH OP-CHECK-PERFEVENTS 1 "@DATE@" "oprofile @VERSION@"
+.UC 4
+.SH NAME
+op-check-perfevents \- checks for kernel perf pmu support
+.SH SYNOPSIS
+.br
+.B op-check-perfevents
+[
+.I options
+]
+.SH DESCRIPTION
+
+The small helper program 
+.B op-check-perfevents
+determines whether the kernel supports the perf interface
+and returns a zero exit status if the perf pmu support is available. 
+.SH OPTIONS
+.TP
+.BI "--help / -h"
+Show usage help message.
+.br
+.TP
+.BI "--verbose / -v"
+Print string describing the error number of perf_event_open syscall
+.br
+
+.SH ENVIRONMENT
+No special environment variables are recognised by op-check-perfevents.
+
+.SH VERSION
+.TP
+This man page is current for @PACKAGE@-@VERSION@.
+
+.SH SEE ALSO
+.BR @OP_DOCDIR@,
+.BR oprofile(1)
-- 
1.8.1.4


------------------------------------------------------------------------------
This SF.net email is sponsored by Windows:

Build for Windows Store.

http://p.sf.net/sfu/windows-dev2dev
_______________________________________________
oprofile-list mailing list
oprofile-list@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/oprofile-list
[prev in list] [next in list] [prev in thread] [next in thread]