Merge pull request #39 from eribertomota/eriberto-idleconn-manpage

Add idleconn manpage

contrib/idleconn-manpage/genallman.sh

@@ -0,0 +1,30 @@
+#!/bin/bash
+
+# Generate several manpages at the same time.
+# Copyright (C) 2014-2015 Joao Eriberto Mota Filho <eriberto@debian.org>
+# v0.3, available at https://github.com/eribertomota/genallman
+#
+# You can use this code in the same terms of the BSD-3-clause license or,
+# optionally, in the same terms of the license used in debian/ directory
+# when packaging for Debian or similar.
+#
+# This script uses txt2man. You need 2 files: program_name.txt and
+# program_name.header.
+#
+# The program_name.header must be use this structure:
+#
+# .TH <program_name> "<manpage_level>" "<date>" "<program_name_upper_case> <program_version>" "<program_description>"
+#
+# Example:
+#
+# .TH mac-robber "1" "May 2013" "MAC-ROBBER 1.02" "collects data about allocated files in mounted filesystems"
+
+[ -f /usr/bin/txt2man ] || { echo "ERROR: txt2man not found."; exit; }
+
+for NAME in $(ls | grep header | cut -d'.' -f1)
+do
+    LEVEL=$(cat $NAME.header | cut -d" " -f3 | tr -d '"')
+    cat $NAME.header > $NAME.$LEVEL
+    txt2man $NAME.txt | grep -v '^.TH ' >> $NAME.$LEVEL
+    echo "Generated $NAME.$LEVEL."
+done

contrib/idleconn-manpage/idleconn.header

@@ -0,0 +1 @@
+.TH idleconn "1" "Mar 2016" "IDLECONN 0.9.0" "tool for opening any number of idle connections"

contrib/idleconn-manpage/idleconn.txt

@@ -0,0 +1,37 @@
+NAME
+ idleconn - tool for opening any number of idle connections
+
+SYNOPSIS
+ idleconn <server> <port> <numidle>
+
+DESCRIPTION
+ idleconn is part of httperf suite and is useful to simulate a large number
+ of concurrent and idle connections. It can establish a set of persistent
+ connections, each of which generated periodic requests to the server. The
+ effect is that at all times, some of the connections were active while the
+ rest were idle, and these active and idle connection sets kept changing with
+ time. (This paragraph was extracted and adapted from the article "Scalability
+ of Linux Event-Dispatch Mechanisms" (HPL-2000-174), written by Abhishek
+ Chandra and David Mosberger).
+
+OPTIONS
+ server   IP of the server to connect.
+ port     Port used by server.
+ numidle  Number of idle process to be generated.
+
+EXAMPLE
+ This is a simple example how to use idleconn:
+
+    $ ./idleconn 192.168.1.1 80 100
+
+ It would open and maintain 100 idle connections to a web server, listening on
+ port 80, using the IP address 192.168.1.1.
+
+SEE ALSO
+ httperf(1)
+
+AUTHOR
+  The httperf was written by David Mosberger-Tang, Hewlett-Packard Company and Contributors.
+
+  This manual page was written by Joao Eriberto Mota Filho <eriberto@debian.org>
+  for the Debian project (but may be used by others).

man/Makefile.am

@@ -1,2 +1,2 @@
-man_MANS = httperf.1
+man_MANS = httperf.1 idleconn.1
 EXTRA_DIST = $(man_MANS)

man/idleconn.1

@@ -0,0 +1,54 @@
+.TH idleconn "1" "Mar 2016" "IDLECONN 0.9.0" "tool for opening any number of idle connections"
+.\" Text automatically generated by txt2man
+.SH NAME
+\fBidleconn \fP- tool for opening any number of idle connections
+\fB
+.SH SYNOPSIS
+.nf
+.fam C
+ \fBidleconn\fP <server> <port> <numidle>
+
+.fam T
+.fi
+.fam T
+.fi
+.SH DESCRIPTION
+\fBidleconn\fP is part of httperf suite and is useful to simulate a large number
+of concurrent and idle connections. It can establish a set of persistent
+connections, each of which generated periodic requests to the server. The
+effect is that at all times, some of the connections were active while the
+rest were idle, and these active and idle connection sets kept changing with
+time. (This paragraph was extracted and adapted from the article "Scalability
+of Linux Event-Dispatch Mechanisms" (HPL-2000-174), written by Abhishek
+Chandra and David Mosberger).
+.SH OPTIONS
+.TP
+.B
+server
+IP of the server to connect.
+.TP
+.B
+port
+Port used by server.
+.TP
+.B
+numidle
+Number of idle process to be generated.
+.SH EXAMPLE
+This is a simple example how to use \fBidleconn\fP:
+.PP
+.nf
+.fam C
+    $ ./idleconn 192.168.1.1 80 100
+
+.fam T
+.fi
+It would open and maintain 100 idle connections to a web server, listening on
+port 80, using the IP address 192.168.1.1.
+.SH SEE ALSO
+\fBhttperf\fP(1)
+.SH AUTHOR
+The httperf was written by David Mosberger-Tang, Hewlett-Packard Company and Contributors.
+.PP
+This manual page was written by Joao Eriberto Mota Filho <eriberto@debian.org>
+for the Debian project (but may be used by others).