path: root/audio/guitarix/guitarix.1

.\" Man page generated from reStructuredText.
.
.TH GUITARIX 1 "2016-08-06" "0.35.1" "SlackBuilds.org"
.SH NAME
guitarix \- guitar amp simulator and effects processor
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" RST source for guitarix(1) man page. Convert with:
.
.\" rst2man.py guitarix.rst > guitarix.1
.
.\" rst2man.py comes from the SBo development/docutils package.
.
.\" converting from pod:
.
.\" s/B<\([^>]*\)>/**\1**/g
.
.\" s/I<\([^>]*\)>/*\1*/g
.
.SH SYNOPSIS
.sp
guitarix [\fI\-options\fP]
.SH DESCRIPTION
.sp
Guitarix is a rock guitar amplifier for Jack (Jack Audio Connection
Kit) with one input and two outputs. It is designed to get nice
trash/metal/rock guitar sounds.  Guitarix comes with a GTK+ graphical
user interface and a set of LADSPA plugins. This manual page describes
the GTK+ interface.
.sp
Guitarix provides one JACK input port and two JACK output ports.
Controls for bass, treble, gain, compressor, preamp, balance, distortion,
freeverb, crybaby (wah) and echo are available. A fixed resonator is
used when distortion is disabled. To modify the sound \(aqpressure\(aq, you
can use the feedback and feedforward sliders.
.sp
Guitarix includes an experimental tuner and a JACK MIDI output port
with 3 channels. They are fed by a mix from a pitch tracker and a
beat detector. You can pitch the octave (2 octaves up or down), choose the
MIDI channel, the MIDI program, the velocity and the sensitiviy, which
translates into how fast the note will read after the beat detector
emits a signal. Values for the beat detector can be set for all
channels.
.SH OPTIONS
.sp
All parameters are optional. Examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
guitarix
guitarix \-r Guitarix_Oak \-i system:capture_3
guitarix \-c \-o system:playback_1 \-o system:playback_2
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B Help Options:
.INDENT 7.0
.TP
.B \-h\fP,\fB  \-\-help
Show help options
.TP
.B \-\-help\-all
Show all help options
.TP
.B \-\-help\-style
GTK style configuration options
.TP
.B \-\-help\-jack
JACK configuration options
.TP
.B \-\-help\-overload
Switch to bypass mode on overload condition
.TP
.B \-\-help\-file
File options
.TP
.B \-\-help\-debug
Debug options
.TP
.B \-\-help\-gtk
Show GTK+ Options
.UNINDENT
.TP
.B GTK style configuration options
.INDENT 7.0
.TP
.B \-c\fP,\fB  \-\-clear
Use \(aqdefault\(aq GTK style
.TP
.BI \-r\fP,\fB  \-\-rcset\fB= <STYLE>
Style to use, case\-sensitive, one of: \(aqBurl\(aq, \(aqCamouflage\(aq, \(aqCopper\(aq, \(aqDark\(aq, \(aqGrandma\(aq, \(aqGrungy_Sun\(aq, \(aqGrungy_Sun_Dark\(aq, \(aqGuitarix\(aq, \(aqGuitarix_Oak\(aq, \(aqHippie\(aq, \(aqLavender\(aq, \(aqNebula\(aq, \(aqOak\(aq, \(aqOlive\(aq, \(aqOrange\(aq, \(aqPlain_Dark\(aq, \(aqPsycedelic\(aq, \(aqSky\(aq, \(aqWhite_Oak\(aq
.UNINDENT
.TP
.B JACK configuration options
.INDENT 7.0
.TP
.BI \-i\fP,\fB  \-\-jack\-input\fB= <PORT>
Guitarix JACK input
.TP
.BI \-o\fP,\fB  \-\-jack\-output\fB= <PORT>
Guitarix JACK outputs
.TP
.BI \-m\fP,\fB  \-\-jack\-midi\fB= <PORT>
Guitarix JACK midi control
.TP
.B \-J\fP,\fB  \-\-jack\-no\-conect
disable self\-connect JACK ports
.TP
.BI \-n\fP,\fB  \-\-name\fB= <NAME>
instance name (default gx_head)
.TP
.BI \-U\fP,\fB  \-\-jack\-uuid\fB= <UUID>
JackSession ID
.TP
.BI \-A\fP,\fB  \-\-jack\-uuid2\fB= <UUID2>
JackSession ID
.TP
.BI \-s\fP,\fB  \-\-server\-name\fB= <NAME>
JACK server name to connect to
.UNINDENT
.TP
.B Switch to bypass mode on overload condition
.INDENT 7.0
.TP
.BI \-I\fP,\fB  \-\-idle\-timeout\fB= <SECONDS>
starved idle thread probe (default: disabled)
.TP
.B \-C\fP,\fB  \-\-no\-convolver\-overload
disable overload on convolver missed deadline
.TP
.B \-X\fP,\fB  \-\-xrun\-overload
JACK xrun (default: false)
.TP
.BI \-S\fP,\fB  \-\-sporadic\fB= <SECONDS>
allow single overload events per interval (default: disabled)
.UNINDENT
.TP
.B File options
.INDENT 7.0
.TP
.BI \-f\fP,\fB  \-\-load\-file\fB= <FILE>
load state file on startup
.TP
.BI \-P\fP,\fB  \-\-plugin\-dir\fB= <DIR>
directory with guitarix plugins (.so files)
.TP
.B \-K\fP,\fB  \-\-disable\-save\-on\-exit
disable auto save to state file when quit
.TP
.B \-a\fP,\fB  \-\-auto\-save
enable auto save (only in server mode)
.UNINDENT
.TP
.B Debug options
.INDENT 7.0
.TP
.BI \-B\fP,\fB  \-\-builder\-dir\fB= <DIR>
directory from which .glade files are loaded
.TP
.BI \-\-style\-dir\fB= <DIR>
directory with skin style definitions (.rc files)
.TP
.B \-t\fP,\fB  \-\-log\-terminal
print log on terminal
.TP
.B \-d\fP,\fB  \-\-dump\-parameter
dump parameter table in json format
.UNINDENT
.TP
.B GTK+ Options
.INDENT 7.0
.TP
.BI \-\-class\fB= <CLASS>
Program class as used by the window manager
.TP
.BI \-\-gtk\-name\fB= <NAME>
Program name as used by the window manager
.TP
.BI \-\-screen\fB= <SCREEN>
X screen to use
.TP
.B \-\-sync
Make X calls synchronous
.TP
.BI \-\-gtk\-module\fB= <MODULES>
Load additional GTK+ modules
.TP
.B \-\-g\-fatal\-warnings
Make all warnings fatal
.UNINDENT
.TP
.B Application Options:
.INDENT 7.0
.TP
.B \-v\fP,\fB  \-\-version
Print version string and exit
.TP
.B \-N\fP,\fB  \-\-nogui
start without GUI
.TP
.BI \-p\fP,\fB  \-\-rpcport\fB= <PORT>
start a JSON\-RPC server listening on port PORT
.TP
.BI \-H\fP,\fB  \-\-rpchost\fB= <HOSTNAME>
set hostname to connect to
.TP
.B \-G\fP,\fB  \-\-onlygui
start only GUI
.TP
.B \-L\fP,\fB  \-\-liveplaygui
start with Live Play GUI
.TP
.B \-M\fP,\fB  \-\-mute
start with engine muted
.TP
.BI \-b\fP,\fB  \-\-bank\fB= <BANK:PRESET>
set bank and preset to load at startup (A:0\-Z:9)
.TP
.BI \-t\fP,\fB  \-\-tuner_tet\fB= <TEMP>
set tuner temperament at startup (12, 19, 24, 31, 53)
.TP
.BI \-F\fP,\fB  \-\-reference_pitch\fB= <HZ>
set tuner reference pitch at startup (225 \- 453)
.TP
.BI \-\-display\fB= <DISPLAY>
X display to use
.UNINDENT
.UNINDENT
.\" Generated by docutils manpage writer.
.