From 2db187feac70feee3b355b418931d3df74e1e200 Mon Sep 17 00:00:00 2001 From: =?utf8?q?IOhannes=20m=20zm=C3=B6lnig?= Date: Thu, 25 Nov 2010 19:26:40 +0100 Subject: [PATCH] autogenerate the manpage why did i manually write a manpage if it can be autogenerated? --- debian/control | 1 + debian/control.in | 1 + debian/jacktrip.1 | 80 ---------------------------------------- debian/jacktrip.manpages | 2 +- debian/rules | 2 + 5 files changed, 5 insertions(+), 81 deletions(-) delete mode 100644 debian/jacktrip.1 diff --git a/debian/control b/debian/control index 0ef5a0f..0c928e4 100644 --- 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 a1ec19e..057a4cd 100644 --- a/debian/control.in +++ b/debian/control.in @@ -6,6 +6,7 @@ Uploaders: IOhannes m zmoelnig (gpg-key at iem) , Jonas Smedegaard 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 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 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\fP and -.\" \fI\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 -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) , -for the Debian project (and may be used by others). diff --git a/debian/jacktrip.manpages b/debian/jacktrip.manpages index ed09ef4..6550933 100644 --- a/debian/jacktrip.manpages +++ b/debian/jacktrip.manpages @@ -1 +1 @@ -debian/jacktrip.1 +jacktrip.1 diff --git a/debian/rules b/debian/rules index d7fa617..50b1b40 100755 --- 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 -- 2.30.2