doc: Use asciidoc for manpage

6 files changed, 189 insertions, 62 deletions

diff --git a/configure.ac b/configure.ac
index 8d0aa7e..7164905 100644
--- a/configure.ac
+++ b/configure.ac
@@ -319,10 +319,15 @@ AC_SUBST(ADDITIONAL_OBJECTS)
 AC_SUBST(TINYPROXY_CONFIG_DIR)
 AC_SUBST(TINYPROXY_CONFIG_FILE)
 
+# Check for asciidoc
+AC_PATH_PROG(A2X, a2x, no)
+AM_CONDITIONAL(HAVE_A2X, test "x$A2X" != "xno")
+
 AC_CONFIG_FILES([
 Makefile
 src/Makefile
 doc/Makefile
+doc/man8/Makefile
 packaging/Makefile
 packaging/fedora/tinyproxy.spec
 packaging/fedora/Makefile
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 76a4418..687cabf 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,8 +1,10 @@
+SUBDIRS = \
+	man8
+
 # HTML Variable Substitution Files
 HTML_VAR_SUBST = HTML_VARIABLES debug.html default.html stats.html
-man_MANS = tinyproxy.8
 
-EXTRA_DIST = $(man_MANS) tinyproxy.conf \
+EXTRA_DIST = tinyproxy.conf \
 	HTTP_ERROR_CODES RFC_INFO \
 	filter-howto.txt \
 	$(HTML_VAR_SUBST)
diff --git a/doc/man8/Makefile.am b/doc/man8/Makefile.am
new file mode 100644
index 0000000..3dc9dea
--- /dev/null
+++ b/doc/man8/Makefile.am
@@ -0,0 +1,23 @@
+MAN8_FILES  = \
+	tinyproxy.txt
+
+A2X_ARGS = \
+	-d manpage \
+	-f manpage
+
+man_MANS = \
+	$(MAN8_FILES:.txt=.8)
+
+.txt.8:
+if HAVE_A2X
+	a2x $(A2X_ARGS) $<
+else
+	@echo "*** a2x (asciidoc) is required to regenerate $(@) ***"; exit 1;
+endif
+
+EXTRA_DIST = \
+        $(MAN8_FILES) \
+        $(man_MANS)
+
+clean-local:
+	rm -f $(MAN8_FILES:.txt=.8) $(MAN1_FILES:.txt=.xml)
diff --git a/doc/man8/tinyproxy.8 b/doc/man8/tinyproxy.8
new file mode 100644
index 0000000..1ae95b9
--- /dev/null
+++ b/doc/man8/tinyproxy.8
@@ -0,0 +1,75 @@
+'\" t
+.\"     Title: tinyproxy
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
+.\"      Date: 09/13/2009
+.\"    Manual: [FIXME: manual]
+.\"    Source: [FIXME: source]
+.\"  Language: English
+.\"
+.TH "TINYPROXY" "8" "09/13/2009" "[FIXME: source]" "[FIXME: manual]"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+tinyproxy \- A light\-weight HTTP proxy daemon
+.SH "SYNOPSIS"
+.sp
+\fBtinyproxy\fR [\-vldch]
+.SH "DESCRIPTION"
+.sp
+\fBtinyproxy\fR is a light\-weight HTTP proxy daemon designed to consume a minimum amount of system resources\&. It listens on a given TCP port and handles HTTP proxy requests\&. Designed from the ground up to be fast and yet small, it is an ideal solution for use cases such as embedded deployments where a full featured HTTP proxy is required, but the system resources for a larger proxy are unavailable\&.
+.SH "OPTIONS"
+.sp
+\fBtinyproxy\fR accepts the following options:
+.PP
+\fB\-c <config\-file>\fR
+.RS 4
+Use an alternate configuration file\&.
+.RE
+.PP
+\fB\-d\fR
+.RS 4
+Don\'t daemonize and stay in the foreground\&. Useful for debugging purposes\&.
+.RE
+.PP
+\fB\-h\fR
+.RS 4
+Display a short help screen of command line arguments and exit\&.
+.RE
+.PP
+\fB\-l\fR
+.RS 4
+Display the licensing agreement\&.
+.RE
+.PP
+\fB\-v\fR
+.RS 4
+Display version information and exit\&.
+.RE
+.SH "SIGNALS"
+.sp
+In addition to command\-line options, there are also several signals that can be sent to \fBtinyproxy\fR while it is running to generate debugging information and to force certain events\&.
+.PP
+\fBSIGHUP\fR
+.RS 4
+Force Tinyproxy to do a garbage collection on the current connections linked list\&. This is usually done automatically after a certain number of connections have been handled\&.
+.RE
+.SH "FILES"
+.sp
+/etc/tinyproxy/tinyproxy\&.conf, /var/run/tinyproxy\&.pid, /var/log/tinyproxy\&.log
+.SH "BUGS"
+.sp
+To report bugs in Tinyproxy, please visit <https://www\&.banu\&.com/tinyproxy/support/>\&.
+.SH "COPYRIGHT"
+.sp
+Copyright (c) 1998\-2000 Steven Young; Copyright (c) 2000\-2001 Robert James Kaes; Copyright (c) 2009 Mukund Sivaraman\&.
+.sp
+This program is distributed under the terms of the GNU General Public License version 2 or above\&. See the COPYING file for additional information\&.
diff --git a/doc/man8/tinyproxy.txt b/doc/man8/tinyproxy.txt
new file mode 100644
index 0000000..9aac609
--- /dev/null
+++ b/doc/man8/tinyproxy.txt
@@ -0,0 +1,82 @@
+TINYPROXY(8)
+============
+
+NAME
+----
+
+tinyproxy - A light-weight HTTP proxy daemon
+
+
+SYNOPSIS
+--------
+
+*tinyproxy* [-vldch]
+
+
+DESCRIPTION
+-----------
+
+*tinyproxy* is a light-weight HTTP proxy daemon designed to consume a
+minimum amount of system resources. It listens on a given TCP port and
+handles HTTP proxy requests. Designed from the ground up to be fast and
+yet small, it is an ideal solution for use cases such as embedded
+deployments where a full featured HTTP proxy is required, but the system
+resources for a larger proxy are unavailable.
+
+
+OPTIONS
+-------
+
+*tinyproxy* accepts the following options:
+
+*-c <config-file>*::
+    Use an alternate configuration file.
+
+*-d*::
+    Don't daemonize and stay in the foreground. Useful for debugging purposes.
+
+*-h*::
+    Display a short help screen of command line arguments and exit.
+
+*-l*::
+    Display the licensing agreement.
+
+*-v*::
+    Display version information and exit.
+
+
+SIGNALS
+-------
+
+In addition to command-line options, there are also several signals that
+can be sent to *tinyproxy* while it is running to generate debugging
+information and to force certain events.
+
+*SIGHUP*::
+    Force Tinyproxy to do a garbage collection on the current
+    connections linked list. This is usually done automatically after a
+    certain number of connections have been handled.
+
+
+FILES
+-----
+
+`/etc/tinyproxy/tinyproxy.conf`, `/var/run/tinyproxy.pid`, `/var/log/tinyproxy.log`
+
+BUGS
+----
+
+To report bugs in Tinyproxy, please visit
+<https://www.banu.com/tinyproxy/support/[https://www.banu.com/tinyproxy/support/]>.
+
+
+COPYRIGHT
+---------
+
+Copyright (c) 1998-2000 Steven Young; 
+Copyright (c) 2000-2001 Robert James Kaes;
+Copyright (c) 2009 Mukund Sivaraman.
+
+This program is distributed under the terms of the GNU General Public
+License version 2 or above. See the COPYING file for additional
+information.
diff --git a/doc/tinyproxy.8 b/doc/tinyproxy.8
deleted file mode 100644
index 3187460..0000000
--- a/doc/tinyproxy.8
+++ /dev/null
@@ -1,60 +0,0 @@
-.\" -*- nroff -*-
-.\"
-.\" tinyproxy.8
-.\"
-.\" Copyright (c) 1998-2000  Steven Young
-.\" Copyright (c) 2000-2001  Robert James Kaes
-.\"
-.\" This program is distributed under the terms of the GNU General Public
-.\" License. See COPYING for additional information.
-.\"
-.TH tinyproxy 8 .\" "tinyproxy Manual" "January 27, 2003"
-.SH NAME
-tinyproxy -- A small HTTP proxy server
-.SH SYNTAX
-\fBtinyproxy\fR [ \fB-vldch\fR ]
-.SH VERSION
-This man page documents the usage of the tinyproxy command.
-.SH DESCRIPTION
-\fBtinyproxy\fR is a lightweight HTTP proxy server designed to consume a minimum amount of system resources. It listens on a given TCP port and handles HTTP proxy requests.
-.SH OPTIONS
-.IP "-c <config_file>"
-Use an alternate configuration file.
-.IP -d
-Don't daemonize; stay in the foreground. Useful for debugging purposes.
-.IP -h
-Display a short help screen of command line arguments and exit.
-.IP -l
-Display the licensing agreement.
-.IP -v
-Display version information and exit.
-.SH SIGNALS
-In addition to these command line options, there are also several signals
-that can be sent to tinyproxy while it is running to generate debugging
-information and to force certain events.
-.TP 5
-.B SIGHUP
-Force \fBtinyproxy\fR to do a garbage collection on the current connections
-linked list.  This is usually done automatically after a certain number of
-connections have been handled.
-.SH FILES
-.nf
-/etc/tinyproxy/tinyproxy.conf
-/var/run/tinyproxy.pid
-/var/log/tinyproxy.log
-.fi
-.SH AUTHORS
-.nf
-Robert James Kaes (rjkaes@flarenet.com)
-Steven Young (sdyoung@users.sourceforge.net)
-.fi
-.SH COPYRIGHT
-\fBtinyproxy\fR is distributed under the GNU Public License (GPL).  For more
-information on the GPL, please see the file COPYING which should have been
-included in the archive with \fBtinyproxy\fR.  Failing that,
-http://www.fsf.org/ will doubtless have a copy up for you to peruse.  Please
-don't use this software if you don't agree to the terms specified therein.
-.SH AVAILABILITY
-The latest version of \fBtinyproxy\fR can be acquired from: http://tinyproxy.sourceforge.net/
-.SH BUGS
-Please report any bugs, problems or security issues with tinyproxy via the Bug Tracking system hosted by SourceForge at the following URL: \fBhttp://sourceforge.net/tracker/?group_id=2632\fR