summaryrefslogtreecommitdiff
path: root/audio/lsmi/man/lsmi-joystick.1
diff options
context:
space:
mode:
Diffstat (limited to 'audio/lsmi/man/lsmi-joystick.1')
-rw-r--r--audio/lsmi/man/lsmi-joystick.183
1 files changed, 83 insertions, 0 deletions
diff --git a/audio/lsmi/man/lsmi-joystick.1 b/audio/lsmi/man/lsmi-joystick.1
new file mode 100644
index 0000000000..72bb02ab80
--- /dev/null
+++ b/audio/lsmi/man/lsmi-joystick.1
@@ -0,0 +1,83 @@
+.\" 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 LSMI-JOYSTICK 1 "May 15, 2012"
+.\" 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
+
+lsmi-joystick \- Linux Pseudo MIDI Input -- Joystick
+.SH SYNOPSIS
+.B lsmi-joystick
+.RI [ options ] " files" ...
+.SH DESCRIPTION
+
+This driver allows any joystick supported by the Linux joydev interface to
+be used as a MIDI pitch/modulation controller. Of course, some joysticks are
+more suitable than others. I use an old analog flight stick. Holding down
+button 1 causes the vertical axis to send pitchbend messages, while button 2
+causes the vertical axis to send modulation messages. Holding down both
+buttons causes the vertical axis to send pitchbend messages and the
+horizontal axis to send modulation messages.
+
+.SH USAGE
+
+Distribution specific init scripts are not included. The drivers may be
+started from init, your .bashrc, by qjackctl, etc. In order to be run by a
+non-root user the drivers must have access to the device files in /dev/input.
+This may be accomplished by adding a group 'input', adding desired users to
+this group, and configuring udev to assign the appropriate ownership to files
+in /dev/input. It should be perfectly safe to run the drivers as root,
+however.
+
+For realtime scheduling (the \-R option), either use set_rlimits, or set the
+appropriate POSIX capabilities on the executable:
+.P
+/sbin/setcap cap_ipc_lock,cap_sys_nice=ep /usr/bin/lsmi-joystick
+.P
+The lsmi.SlackBuild script already includes RT scheduling support.
+
+.SH OPTIONS
+.TP
+.B \-h, \-\-help
+Show summary of options.
+.TP
+.B \-d, \-\-device specialfile
+Event device to use (instead of js0).
+.TP
+.B \-R, \-\-realtime rtprio
+Use realtime priority 'rtprio' (requires privs).
+.TP
+.B \-v, \-\-verbose
+Be verbose (show note events).
+.TP
+.B \-p, \-\-port client:port
+Connect to ALSA Sequencer client on startup.
+.TP
+.B \-n, \-\-no-hold
+Send controller data even when no joystick button is held.
+.TP
+.B \-z, \-\-daemon
+Fork and don't print anything to stdout.
+.SH SEE ALSO
+.BR lsmi-keyhack (1),
+.BR lsmi-monterey (1),
+.BR lsmi-mouse (1).
+.br
+.SH AUTHOR
+lsmi was written by Jonathan Moore Liles.
+.PP
+This manual page was written by Ariel Errera <ariel@musix.org.ar>,
+for the Debian project (but may be used by others). It was then modified
+by B. Watson for the SlackBuilds.org project.