autogenerate the manpage

why did i manually write a manpage if it can be autogenerated?

diff --git a/debian/control b/debian/control
index 0ef5a0fee4318d72e3bf1f7ca98fc18916b42492..0c928e45d716453174c034f49183861e1d8e2bb3 100644 (file)
--- a/debian/control
+++ b/debian/control
@@ -9,6 +9,7 @@ Build-Depends: debhelper (>= 7.0.1),
  cdbs (>= 0.4.69~),
  devscripts (>= 2.10.7~),
  doxygen,
+ help2man,
  libqt4-dev,
  qt4-qmake,
  libjack-dev

diff --git a/debian/control.in b/debian/control.in
index a1ec19e2de9c7cdf15b687656597554c19d61542..057a4cde6e7d9306f143e332a293e95b4c950a2b 100644 (file)
--- a/debian/control.in
+++ b/debian/control.in
@@ -6,6 +6,7 @@ Uploaders: IOhannes m zmoelnig (gpg-key at iem) <zmoelnig@iem.at>,
  Jonas Smedegaard <dr@jones.dk>
 Build-Depends: @cdbs@,
  doxygen,
+ help2man,
  libqt4-dev,
  qt4-qmake,
  libjack-dev

diff --git a/debian/jacktrip.1 b/debian/jacktrip.1
deleted file mode 100644 (file)
index 3320db7..0000000
--- a/debian/jacktrip.1
+++ /dev/null
@@ -1,80 +0,0 @@
-.\"                                      Hey, EMACS: -*- nroff -*-
-.\" First parameter, NAME, should be all caps
-.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
-.\" other parameters are allowed: see man(7), man(1)
-.TH JACKTRIP 1 "November 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
-jacktrip \- A System for High-Quality Audio Network Performance over the Internet.
-.SH SYNOPSIS
-.B jacktrip
-.RI [ options ]
-.SH DESCRIPTION
-This manual page documents briefly the
-.B jacktrip
-command.
-.PP
-.\" TeX users may be more comfortable with the \fB<whatever>\fP and
-.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
-.\" respectively.
-\fBjacktrip\fP is a program that allows to establish a high-quality, low latency multi-channel audio connection over the internet
-.SH OPTIONS
-This program follows the usual GNU command line syntax, with long
-options starting with two dashes (`-').
-A summary of options is included below.
-.TP
-.B  \-s, \-\-server
-Run in Server Mode
-.TP
-.B  \-c, \-\-client <peer_host_IP_number>
-Run in Client Mode
-.TP
-.B  \-n, \-\-numchannels \fIn\fR
-Number of Input and Output Channels (default 2)
-.TP
-.B  \-q, \-\-queue \fIq\fR
-Queue Buffer Length, in Packet Size, can be 1 or more (default 4)
-.TP
-.B  \-r, \-\-redundancy \fIr\fR 
-Packet Redundancy to avoid glitches with packet losses, can be 1 or more (default 1)
-.TP
-.B  \-o, \-\-portoffset \fIo\fR
-Receiving port offset from base port \fB4464\fP (default 0)
-.TP
-.B  \-b, \-\-bitres \fIb\fR
-Audio Bit Rate Resolutions, can be one of [8, 16, 24, 32] (default 16)
-.TP
-.B  \-z, \-\-zerounderrun
-Set buffer to zeros when underrun occurs (defaults to wavetable)
-.TP
-.B  \-l, \-\-loopback
-Run in Loop\-Back Mode
-.TP
-.B  \-j, \-\-jamlink
-Run in JamLink Mode (Connect to a JamLink Box)
-.TP
-.B \-\-clientname
-Change default client name (default is JackTrip)
-.TP
-.B  \-v, \-\-version
-Prints Version Number
-.TP
-.B  \-h, \-\-help
-Print  a brief usage message describing the main jacktrip options
-
-.SH AUTHOR
-jacktrip was written by Juan-Pablo Caceres & Chris Chafe (SoundWIRE group at CCRMA, Stanford University)
-.PP
-This manual page was written by IOhannes m zmoelnig (gpg-key at iem) <zmoelnig@iem.at>,
-for the Debian project (and may be used by others).

diff --git a/debian/jacktrip.manpages b/debian/jacktrip.manpages
index ed09ef4d3d1421baa0c2271269ed5328f571cc6c..6550933d281756d3fec19195909c51437b06fc9e 100644 (file)
--- a/debian/jacktrip.manpages
+++ b/debian/jacktrip.manpages
@@ -1 +1 @@
-debian/jacktrip.1
+jacktrip.1

diff --git a/debian/rules b/debian/rules
index d7fa617278d3e9a8e1874455e9e794e51f341c43..50b1b40f5f97d89ee1871a146ed7a10ce579dca1 100755 (executable)
--- a/debian/rules
+++ b/debian/rules
@@ -41,6 +41,8 @@ DEB_COPYRIGHT_CHECK_IGNORE_REGEX = ^\./(documentation/img/.*|debian/(changelog|c
 
 build/jacktrip::
        doxygen jacktrip_doxygen
+       help2man -N src/jacktrip > jacktrip.1
 
 clean::
        rm -rf WWW
+       rm -f jacktrip.1