[SCM] mididings/master: Add livedings manpage.
alessio at users.alioth.debian.org
alessio at users.alioth.debian.org
Tue Nov 2 08:15:11 UTC 2010
The following commit has been merged in the master branch:
commit 96edbc499e2ab0cf8cb7a5d0a187767f600fbd51
Author: Alessio Treglia <alessio at debian.org>
Date: Tue Nov 2 09:15:02 2010 +0100
Add livedings manpage.
diff --git a/debian/livedings.1 b/debian/livedings.1
new file mode 100644
index 0000000..f5c5371
--- /dev/null
+++ b/debian/livedings.1
@@ -0,0 +1,72 @@
+.TH LIVEDINGS "1" "November 2010" "" "User Commands"
+.SH NAME
+livedings \- manual page for livedings
+.SH SYNOPSIS
+.B livedings
+\fI-p control_port -l listen_port \fR[\fIoptions\fR]
+.SH DESCRIPTION
+.B livedings
+is a graphical frontend for mididings that allows users to monitor and trigger
+scene changes. It runs as a separate application that uses OSC to communicate
+with mididings. To use it, enable the OSCInterface hook in a mididings script,
+specifying two unused UDP ports:
+.PP
+.nf
+ from mididings.extra.osc import OSCInterface
+.sp
+ hook(OSCInterface(56418, 56419))
+ ...
+.sp
+.fi
+Then run livedings with the same port numbers:
+.PP
+.nf
+ $ livedings -p 56418 -l 56419
+.fi
+.PP
+The first port is used by mididings to listen for commands, the second one is used to notify livedings of scene changes.
+.SH OPTIONS
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+show this help message and exit
+.TP
+\fB\-p\fR CONTROL_PORT
+OSC port mididings is listening on
+.TP
+\fB\-l\fR LISTEN_PORT
+OSC port for notifications from mididings
+.TP
+\fB\-T\fR
+enable custom theme and larger fonts
+.TP
+\fB\-x\fR WIDTH
+width of window in pixels (640)
+.TP
+\fB\-y\fR HEIGHT
+height of window in pixels (400)
+.TP
+\fB\-w\fR LIST_WIDTH
+width of scene list in pixels (240)
+.TP
+\fB\-F\fR FONT
+display font (Sans 14 bold)
+.TP
+\fB\-f\fR LIST_FONT
+scene list font (Sans 10)
+.TP
+\fB\-c\fR COLOR
+text color (gray50)
+.TP
+\fB\-C\fR COLOR_HIGHLIGHT
+highlight text color (black)
+.TP
+\fB\-b\fR COLOR_BACKGROUND
+background color
+.PP
+.SH "SEE ALSO"
+\fBmididings\fR(1)
+.SH "AUTHOR"
+livedings was written by Dominic Sacré <dominic.sacre at gmx.de>.
+.PP
+This manual page was written by Alessio Treglia <alessio at debian.org>,
+for the Debian project (and may be used by others).
diff --git a/debian/mididings.manpages b/debian/mididings.manpages
new file mode 100644
index 0000000..1193344
--- /dev/null
+++ b/debian/mididings.manpages
@@ -0,0 +1 @@
+debian/livedings.1
--
mididings packaging
More information about the pkg-multimedia-commits
mailing list