diff options
author | Clark Williams <williams@redhat.com> | 2010-02-23 10:27:08 -0600 |
---|---|---|
committer | Clark Williams <williams@redhat.com> | 2010-02-23 10:27:08 -0600 |
commit | 2359346741c39f97b98f36cd4bfe0e4f01635edf (patch) | |
tree | de1b8689a8ffe7c3d3e2129cf85f103b3dc1e6f5 | |
parent | 98a082ca9f0349aab53dce4a4808c31e8f8dd4b0 (diff) | |
download | rt-tests-2359346741c39f97b98f36cd4bfe0e4f01635edf.tar.gz |
added hackbench.8 manpage framework
Signed-off-by: Clark Williams <williams@redhat.com>
-rw-r--r-- | src/hackbench/hackbench.8 | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/src/hackbench/hackbench.8 b/src/hackbench/hackbench.8 new file mode 100644 index 0000000..438db26 --- /dev/null +++ b/src/hackbench/hackbench.8 @@ -0,0 +1,70 @@ +.\" Hey, EMACS: -*- nroff -*- +.TH HACKBENCH 8 "febrary 23, 2010" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +hackbench \- scheduler benchmark/stress test +.SH SYNOPSIS +.B hackbench +.RI "[ -p|--pipe ] [ -s|--datasize " <bytes> " ] [ -l|--loops " <num loops> " ] " \ +" [ -g|--groups " <num groups " ] [ -f|--fds " <num fds> " ] " \ +" [ -T|--threads ] [ -P|--process ] [ --help "] + +.\" .SH DESCRIPTION +.\" This manual page documents briefly the +.\" .B hackbench commands. +.\" .PP +.\" \fI<whatever>\fP escape sequences to invode bold face and italics, respectively. +.\" \fBhackbench\fP is a program that... +.SH DESCRIPTION +Hackbench is both a benchmark and a stress test for the Linux kernel +scheduler. It's main job is to create a specified number of pairs of +schedulable entities (either threads or traditional processes) which +communicate via either sockets or pipes and time how long it takes for +each pair to send data back and forth. + +.SH OPTIONS +These programs follow the usual GNU command line syntax, with long +options starting with two dashes ('\-\-'). +.br +A summary of options is included below. +.TP +.B \-p, \-\-pipe +.TP +.B \-s, \-\-datasize=<size in bytes> +.TP +.B \-l, \-\-loops=<number of loops> +.TP +.B \-g, \-\-groups=<number of groups> +.TP +.B \-f, \-\-fds=<number of file descriptors> +.TP +.B \-T, \-\-threads +.TP +.B \-P, \-\-process +.TP +.B \-\-help +.TP + +.\" .SH SEE ALSO +.\" .BR bar (1), +.\" .BR baz (1). +.\" .br +.\" The programs are documented fully by +.\" .IR "The Rise and Fall of a Fooish Bar" , +.\" available via the Info system. +.SH AUTHOR +hackbench was written by Thomas Gleixner <tglx@linuxtronix.de>. +.PP +This manual page was written by Alessio Igor Bogani <abogani@texware.it>, +for the Debian project (but may be used by others). |