summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Bisballe Jensen <larsbisballe@gmail.com>2015-02-16 12:41:46 +0100
committerLars Bisballe Jensen <larsbisballe@gmail.com>2015-02-16 12:41:46 +0100
commit2214806138113feb91a76d640f89773c1088b705 (patch)
treefc98937d48bb6dfe9413dbb4147c149a8cde3c6e
parent6188081a19dc60209add5e4f2e1c57d64520f914 (diff)
man page is now correctly formatted
-rw-r--r--man/drumgizmo.1138
1 files changed, 78 insertions, 60 deletions
diff --git a/man/drumgizmo.1 b/man/drumgizmo.1
index 3472ddc..ad9b1f2 100644
--- a/man/drumgizmo.1
+++ b/man/drumgizmo.1
@@ -4,7 +4,7 @@
drumgizmo \- drum application
.SH SYNOPSIS
-\fBdrumgizmo\fR [OPTIONS] \fIdrumkitfile
+\fBdrumgizmo\fR [OPTIONS] drumkitfile
.SH "DESCRIPTION"
.PP
@@ -13,86 +13,104 @@ drumgizmo \- drum application
DrumGizmo uses an open drumkit file format, allowing the community to create their own drumkits. It has multichannel output, making it possible to mix it just the way you would a real drumkit. The optional built-in humanizer analyzes the midi notes, adjusting velocities on-the-fly. This client can be a stand-alone midi renderer, generating .wav files, 1 for each channel. Or use DrumGizmo as a software sampler for an electronic drumkit. There are also plugin versions available.
.SH "OPTIONS"
-.TP
-\fB-p, --preload
-Load entire kit audio files into memory (uses A LOT of memory).
-.TP
+.PD 0
+.RE
+.RS 7
\fB-i, --inputengine \fR{dummy|test|jackmidi|midifile}
+.RS 7
Use said event input engine.
-.TP
-\fB-I, --inputparms parmlist
+
+.RE
+\fB-I, --inputparms parmlist\fR
+.RS 7
Set input engine parameters.
-.TP
-.SS
-\fBjackmidi:
+
+\fBjackmidi:\fR
+.P
midimap=<midimapfile>
-.TP
-.SS
-\fBmidifile:
-file=<midifile>, speed=<tempo> (default 1.0)
-.br
+
+\fBmidifile:\fR
+.P
+file=<midifile>
+.P
+speed=<tempo> (default 1.0)
+.P
track=<miditrack> (default -1, all tracks)
-.br
-midimap=<midimapfile>, loop=<true|false>
-.TP
-.SS
-\fBtest:
+.P
+midimap=<midimapfile>
+.P
+loop=<true|false>
+
+\fBtest:\fR
+.P
p=<hit_propability> (default 0.1)
-.br
+.P
instr=<instrument> (default -1, random instrument)
-.br
+.P
len=<seconds> (default -1, forever)
-.TP
-.SS
-\fBdummy:
-.TP
+
+\fBdummy:\fR
+
+.RE
\fB-o, --outputengine \fR{dummy|alsa|jackaudio|wavfile}
+.RS 7
Use said audio output engine.
-.TP
-\fB-O, --outputparms parmlist
+
+.RE
+\fB-O, --outputparms parmlist\fR
+.RS 7
Set output engine parameters.
-.TP
-.SS
-\fBalsa:
+
+\fBalsa:\fR
+.P
dev=<device> (default 'default')
-.br
+.P
frames=<frames> (default 32)
-.br
+.P
srate=<samplerate> (default 441000)
-.TP
-.SS
-\fBwavfile:
+
+\fBwavfile:\fR
+.P
file=<filename> (default 'output')
-.br
+.P
srate=<samplerate> (default 44100)
-.TP
-.SS
-\fBjackaudio:
-.TP
-.SS
-\fBdummy:
-.TP
-\fB-e, --endpos
+
+\fBjackaudio:\fR
+
+\fBdummy:\fR
+
+.RE
+\fB-e, --endpos\fR
+.RS 7
Number of samples to process, -1: infinite.
-.TP
-\fB-v, --version
+
+.RE
+\fB-v, --version\fR
+.RS 7
Print drumgizmo version and exit.
-.TP
-\fB-h, --help
+
+.RE
+\fB-h, --help\fR
+.RS 7
Print command line help and exit.
-.TP
-\fB\fIdrumkitfile
+
+.RE
+\fBdrumkitfile\fR
+.RS 7
Load the drumkitfile.
-.El
-.Sh "EXAMPLES"
-Render midifile to wav files:
-.Bb -literal -offset indent -compact
-drumgizmo -p -i midifile -I file=file.mid,midimap=midimap.xml -o wavfile -O file=file.wav drumkit.xml
-.Ed
-Recieve midi from Jack and send audio output to speakers:
-drumgizmo -p -i jackmidi -I midimap=midimap.xml -o jackaudio drumkit.xml
+
+.RE
+.SH "EXAMPLES"
+\fBRender midifile to wav files:\fR
+.RS 7
+drumgizmo -i midifile -I file=file.mid,midimap=midimap.xml -o wavfile -O file=file.wav drumkit.xml
+.RE
+\fBRecieve midi from Jack and send audio output to speakers:\fR
+.RS 7
+drumgizmo -i jackmidi -I midimap=midimap.xml -o jackaudio drumkit.xml
+.RE
.SH "BUGS"
Report bugs to http://www.drumgizmo.org/wiki/doku.php?id=bugs.
.SH "ADDITIONAL INFORMATION"
-For further information, visit the website http://www.drumgizmo.org/.
+For further information, visit the website http://www.drumgizmo.org.