2015-05-16 00:47:18 +02:00
|
|
|
.\" Man page generated from reStructuredText.
|
|
|
|
.
|
2016-08-06 23:25:48 +02:00
|
|
|
.TH GUITARIX 1 "2016-08-06" "0.35.1" "SlackBuilds.org"
|
2012-12-16 21:27:30 +01:00
|
|
|
.SH NAME
|
|
|
|
guitarix \- guitar amp simulator and effects processor
|
2015-05-16 00:47:18 +02:00
|
|
|
.
|
|
|
|
.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
|
|
|
|
.
|
2012-12-16 21:27:30 +01:00
|
|
|
.SH SYNOPSIS
|
2015-05-16 00:47:18 +02:00
|
|
|
.sp
|
|
|
|
guitarix [\fI\-options\fP]
|
2012-12-16 21:27:30 +01:00
|
|
|
.SH DESCRIPTION
|
2015-05-16 00:47:18 +02:00
|
|
|
.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
|
2012-12-16 21:27:30 +01:00
|
|
|
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
|
2015-05-16 00:47:18 +02:00
|
|
|
used when distortion is disabled. To modify the sound \(aqpressure\(aq, you
|
2012-12-16 21:27:30 +01:00
|
|
|
can use the feedback and feedforward sliders.
|
2015-05-16 00:47:18 +02:00
|
|
|
.sp
|
2012-12-16 21:27:30 +01:00
|
|
|
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
|
2015-05-16 00:47:18 +02:00
|
|
|
.sp
|
2012-12-16 21:27:30 +01:00
|
|
|
All parameters are optional. Examples:
|
2015-05-16 00:47:18 +02:00
|
|
|
.INDENT 0.0
|
|
|
|
.INDENT 3.5
|
|
|
|
.sp
|
|
|
|
.nf
|
|
|
|
.ft C
|
2012-12-16 21:27:30 +01:00
|
|
|
guitarix
|
2016-08-06 23:25:48 +02:00
|
|
|
guitarix \-r Guitarix_Oak \-i system:capture_3
|
2015-05-16 00:47:18 +02:00
|
|
|
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
|
2012-12-16 21:27:30 +01:00
|
|
|
Show help options
|
|
|
|
.TP
|
2015-05-16 00:47:18 +02:00
|
|
|
.B \-\-help\-all
|
2012-12-16 21:27:30 +01:00
|
|
|
Show all help options
|
|
|
|
.TP
|
2015-05-16 00:47:18 +02:00
|
|
|
.B \-\-help\-style
|
2012-12-16 21:27:30 +01:00
|
|
|
GTK style configuration options
|
|
|
|
.TP
|
2015-05-16 00:47:18 +02:00
|
|
|
.B \-\-help\-jack
|
2012-12-16 21:27:30 +01:00
|
|
|
JACK configuration options
|
|
|
|
.TP
|
2015-05-16 00:47:18 +02:00
|
|
|
.B \-\-help\-overload
|
|
|
|
Switch to bypass mode on overload condition
|
|
|
|
.TP
|
|
|
|
.B \-\-help\-file
|
2012-12-16 21:27:30 +01:00
|
|
|
File options
|
|
|
|
.TP
|
2015-05-16 00:47:18 +02:00
|
|
|
.B \-\-help\-debug
|
2012-12-16 21:27:30 +01:00
|
|
|
Debug options
|
|
|
|
.TP
|
2015-05-16 00:47:18 +02:00
|
|
|
.B \-\-help\-gtk
|
2012-12-16 21:27:30 +01:00
|
|
|
Show GTK+ Options
|
2015-05-16 00:47:18 +02:00
|
|
|
.UNINDENT
|
2012-12-16 21:27:30 +01:00
|
|
|
.TP
|
2015-05-16 00:47:18 +02:00
|
|
|
.B GTK style configuration options
|
|
|
|
.INDENT 7.0
|
2012-12-16 21:27:30 +01:00
|
|
|
.TP
|
2015-05-16 00:47:18 +02:00
|
|
|
.B \-c\fP,\fB \-\-clear
|
|
|
|
Use \(aqdefault\(aq GTK style
|
2012-12-16 21:27:30 +01:00
|
|
|
.TP
|
2016-08-06 23:25:48 +02:00
|
|
|
.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
|
2015-05-16 00:47:18 +02:00
|
|
|
.UNINDENT
|
|
|
|
.TP
|
|
|
|
.B JACK configuration options
|
|
|
|
.INDENT 7.0
|
|
|
|
.TP
|
2016-08-06 23:25:48 +02:00
|
|
|
.BI \-i\fP,\fB \-\-jack\-input\fB= <PORT>
|
2012-12-16 21:27:30 +01:00
|
|
|
Guitarix JACK input
|
|
|
|
.TP
|
2016-08-06 23:25:48 +02:00
|
|
|
.BI \-o\fP,\fB \-\-jack\-output\fB= <PORT>
|
2012-12-16 21:27:30 +01:00
|
|
|
Guitarix JACK outputs
|
|
|
|
.TP
|
2016-08-06 23:25:48 +02:00
|
|
|
.BI \-m\fP,\fB \-\-jack\-midi\fB= <PORT>
|
2015-05-16 00:47:18 +02:00
|
|
|
Guitarix JACK midi control
|
2012-12-16 21:27:30 +01:00
|
|
|
.TP
|
2015-05-16 00:47:18 +02:00
|
|
|
.B \-J\fP,\fB \-\-jack\-no\-conect
|
2016-08-06 23:25:48 +02:00
|
|
|
disable self\-connect JACK ports
|
2012-12-16 21:27:30 +01:00
|
|
|
.TP
|
2016-08-06 23:25:48 +02:00
|
|
|
.BI \-n\fP,\fB \-\-name\fB= <NAME>
|
2012-12-16 21:27:30 +01:00
|
|
|
instance name (default gx_head)
|
|
|
|
.TP
|
2016-08-06 23:25:48 +02:00
|
|
|
.BI \-U\fP,\fB \-\-jack\-uuid\fB= <UUID>
|
2012-12-16 21:27:30 +01:00
|
|
|
JackSession ID
|
|
|
|
.TP
|
2016-08-06 23:25:48 +02:00
|
|
|
.BI \-A\fP,\fB \-\-jack\-uuid2\fB= <UUID2>
|
2012-12-16 21:27:30 +01:00
|
|
|
JackSession ID
|
|
|
|
.TP
|
2016-08-06 23:25:48 +02:00
|
|
|
.BI \-s\fP,\fB \-\-server\-name\fB= <NAME>
|
2012-12-16 21:27:30 +01:00
|
|
|
JACK server name to connect to
|
2015-05-16 00:47:18 +02:00
|
|
|
.UNINDENT
|
|
|
|
.TP
|
|
|
|
.B Switch to bypass mode on overload condition
|
|
|
|
.INDENT 7.0
|
|
|
|
.TP
|
2016-08-06 23:25:48 +02:00
|
|
|
.BI \-I\fP,\fB \-\-idle\-timeout\fB= <SECONDS>
|
2015-05-16 00:47:18 +02:00
|
|
|
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
|
2016-08-06 23:25:48 +02:00
|
|
|
.BI \-S\fP,\fB \-\-sporadic\fB= <SECONDS>
|
2015-05-16 00:47:18 +02:00
|
|
|
allow single overload events per interval (default: disabled)
|
|
|
|
.UNINDENT
|
|
|
|
.TP
|
|
|
|
.B File options
|
|
|
|
.INDENT 7.0
|
2012-12-16 21:27:30 +01:00
|
|
|
.TP
|
2016-08-06 23:25:48 +02:00
|
|
|
.BI \-f\fP,\fB \-\-load\-file\fB= <FILE>
|
2012-12-16 21:27:30 +01:00
|
|
|
load state file on startup
|
|
|
|
.TP
|
2016-08-06 23:25:48 +02:00
|
|
|
.BI \-P\fP,\fB \-\-plugin\-dir\fB= <DIR>
|
2012-12-16 21:27:30 +01:00
|
|
|
directory with guitarix plugins (.so files)
|
|
|
|
.TP
|
2015-05-16 00:47:18 +02:00
|
|
|
.B \-K\fP,\fB \-\-disable\-save\-on\-exit
|
|
|
|
disable auto save to state file when quit
|
2012-12-16 21:27:30 +01:00
|
|
|
.TP
|
2015-05-16 00:47:18 +02:00
|
|
|
.B \-a\fP,\fB \-\-auto\-save
|
|
|
|
enable auto save (only in server mode)
|
|
|
|
.UNINDENT
|
|
|
|
.TP
|
|
|
|
.B Debug options
|
|
|
|
.INDENT 7.0
|
|
|
|
.TP
|
2016-08-06 23:25:48 +02:00
|
|
|
.BI \-B\fP,\fB \-\-builder\-dir\fB= <DIR>
|
2012-12-16 21:27:30 +01:00
|
|
|
directory from which .glade files are loaded
|
|
|
|
.TP
|
2016-08-06 23:25:48 +02:00
|
|
|
.BI \-\-style\-dir\fB= <DIR>
|
2012-12-16 21:27:30 +01:00
|
|
|
directory with skin style definitions (.rc files)
|
|
|
|
.TP
|
2015-05-16 00:47:18 +02:00
|
|
|
.B \-t\fP,\fB \-\-log\-terminal
|
2012-12-16 21:27:30 +01:00
|
|
|
print log on terminal
|
|
|
|
.TP
|
2015-05-16 00:47:18 +02:00
|
|
|
.B \-d\fP,\fB \-\-dump\-parameter
|
|
|
|
dump parameter table in json format
|
|
|
|
.UNINDENT
|
|
|
|
.TP
|
|
|
|
.B GTK+ Options
|
|
|
|
.INDENT 7.0
|
2012-12-16 21:27:30 +01:00
|
|
|
.TP
|
2016-08-06 23:25:48 +02:00
|
|
|
.BI \-\-class\fB= <CLASS>
|
2012-12-16 21:27:30 +01:00
|
|
|
Program class as used by the window manager
|
|
|
|
.TP
|
2016-08-06 23:25:48 +02:00
|
|
|
.BI \-\-gtk\-name\fB= <NAME>
|
2012-12-16 21:27:30 +01:00
|
|
|
Program name as used by the window manager
|
|
|
|
.TP
|
2016-08-06 23:25:48 +02:00
|
|
|
.BI \-\-screen\fB= <SCREEN>
|
2012-12-16 21:27:30 +01:00
|
|
|
X screen to use
|
|
|
|
.TP
|
2015-05-16 00:47:18 +02:00
|
|
|
.B \-\-sync
|
2012-12-16 21:27:30 +01:00
|
|
|
Make X calls synchronous
|
|
|
|
.TP
|
2016-08-06 23:25:48 +02:00
|
|
|
.BI \-\-gtk\-module\fB= <MODULES>
|
2012-12-16 21:27:30 +01:00
|
|
|
Load additional GTK+ modules
|
|
|
|
.TP
|
2015-05-16 00:47:18 +02:00
|
|
|
.B \-\-g\-fatal\-warnings
|
2012-12-16 21:27:30 +01:00
|
|
|
Make all warnings fatal
|
2015-05-16 00:47:18 +02:00
|
|
|
.UNINDENT
|
2012-12-16 21:27:30 +01:00
|
|
|
.TP
|
2015-05-16 00:47:18 +02:00
|
|
|
.B Application Options:
|
|
|
|
.INDENT 7.0
|
|
|
|
.TP
|
|
|
|
.B \-v\fP,\fB \-\-version
|
2012-12-16 21:27:30 +01:00
|
|
|
Print version string and exit
|
|
|
|
.TP
|
2015-05-16 00:47:18 +02:00
|
|
|
.B \-N\fP,\fB \-\-nogui
|
|
|
|
start without GUI
|
|
|
|
.TP
|
2016-08-06 23:25:48 +02:00
|
|
|
.BI \-p\fP,\fB \-\-rpcport\fB= <PORT>
|
2015-05-16 00:47:18 +02:00
|
|
|
start a JSON\-RPC server listening on port PORT
|
|
|
|
.TP
|
2016-08-06 23:25:48 +02:00
|
|
|
.BI \-H\fP,\fB \-\-rpchost\fB= <HOSTNAME>
|
2015-05-16 00:47:18 +02:00
|
|
|
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
|
2016-08-06 23:25:48 +02:00
|
|
|
.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>
|
2012-12-16 21:27:30 +01:00
|
|
|
X display to use
|
2015-05-16 00:47:18 +02:00
|
|
|
.UNINDENT
|
|
|
|
.UNINDENT
|
|
|
|
.\" Generated by docutils manpage writer.
|
|
|
|
.
|