From 392fd78a730dc3115344549a3831989932f110fd Mon Sep 17 00:00:00 2001 From: "B. Watson" Date: Fri, 15 May 2015 18:47:18 -0400 Subject: audio/guitarix: Updated for version 0.32.3. --- audio/guitarix/guitarix.1 | 242 +++++++++++++++++++++++++++++++++------------- 1 file changed, 175 insertions(+), 67 deletions(-) (limited to 'audio/guitarix/guitarix.1') diff --git a/audio/guitarix/guitarix.1 b/audio/guitarix/guitarix.1 index b6bff28280..09b48a509c 100644 --- a/audio/guitarix/guitarix.1 +++ b/audio/guitarix/guitarix.1 @@ -1,22 +1,64 @@ -.TH GUITARIX "1" "October 2012" "SlackBuilds.org" "User Commands" +.\" Man page generated from reStructuredText. +. +.TH GUITARIX 1 "2015-05-14" "0.32.3" "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 -.B guitarix -.RI [ options ] +.sp +guitarix [\fI\-options\fP] .SH DESCRIPTION -.B 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. -.PP +.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 'pressure', you +used when distortion is disabled. To modify the sound \(aqpressure\(aq, you can use the feedback and feedforward sliders. -.PP +.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 @@ -25,119 +67,185 @@ 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: -.IP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C guitarix -.br -guitarix \fB\-r\fR gx4\-black \fB\-i\fR system:capture_3 -.br -guitarix \fB\-c\fR \fB\-o\fR system:playback_1 \fB\-o\fR system:playback_2 -.SS "Help Options" -.TP -\fB\-h\fR, \fB\-\-help\fR +guitarix \-r gx4\-black \-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 -\fB\-\-help\-all\fR +.B \-\-help\-all Show all help options .TP -\fB\-\-help\-style\fR +.B \-\-help\-style GTK style configuration options .TP -\fB\-\-help\-jack\fR +.B \-\-help\-jack JACK configuration options .TP -\fB\-\-help\-file\fR +.B \-\-help\-overload +Switch to bypass mode on overload condition +.TP +.B \-\-help\-file File options .TP -\fB\-\-help\-debug\fR +.B \-\-help\-debug Debug options .TP -\fB\-\-help\-gtk\fR +.B \-\-help\-gtk Show GTK+ Options -.SS -GTK style configuration options +.UNINDENT .TP -\fB\-c\fR, \fB\-\-clear\fR -Use 'default' GTK style +.B GTK style configuration options +.INDENT 7.0 .TP -\fB\-r\fR, \fB\-\-rcset\fR=\fISTYLE\fR -Style to use, 'gx1\-alloy', 'gx2\-emerald', 'gx3\-dezert', 'gx4\-black', 'gx5\-gree' -.SS "JACK Configuration Options" +.B \-c\fP,\fB \-\-clear +Use \(aqdefault\(aq GTK style .TP -\fB\-i\fR, \fB\-\-jack\-input\fR=\fIPORT\fR +.BI \-r\fP,\fB \-\-rcset\fB= STYLE +Style to use, \(aqgx1\-alloy\(aq, \(aqgx2\-emerald\(aq, \(aqgx3\-dezert\(aq, \(aqgx4\-black\(aq, \(aqgx5\-gree\(aq, \(aqgx6\-blue\(aq, \(aqgx7\-blues\(aq, \(aqgx8\-dark\(aq, \(aqgx9\-flat\(aq, \(aqgx9\-grass\(aq +.UNINDENT +.TP +.B JACK configuration options +.INDENT 7.0 +.TP +.BI \-i\fP,\fB \-\-jack\-input\fB= PORT Guitarix JACK input .TP -\fB\-o\fR, \fB\-\-jack\-output\fR=\fIPORT\fR +.BI \-o\fP,\fB \-\-jack\-output\fB= PORT Guitarix JACK outputs .TP -\fB\-m\fR, \fB\-\-jack\-midi\fR=\fIPORT\fR -Guitarix JACK MIDI control +.BI \-m\fP,\fB \-\-jack\-midi\fB= PORT +Guitarix JACK midi control .TP -\fB\-J\fR, \fB\-\-jack\-no\-conect\fR +.B \-J\fP,\fB \-\-jack\-no\-conect dissable self\-connect JACK ports .TP -\fB\-n\fR, \fB\-\-name\fR=\fINAME\fR +.BI \-n\fP,\fB \-\-name\fB= NAME instance name (default gx_head) .TP -\fB\-U\fR, \fB\-\-jack\-uuid\fR +.BI \-U\fP,\fB \-\-jack\-uuid\fB= UUID JackSession ID .TP -\fB\-A\fR, \fB\-\-jack\-uuid2\fR +.BI \-A\fP,\fB \-\-jack\-uuid2\fB= UUID2 JackSession ID .TP -\fB\-s\fR, \fB\-\-server\-name\fR=\fINAME\fR +.BI \-s\fP,\fB \-\-server\-name\fB= NAME JACK server name to connect to -.SS "File Options" +.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 -\fB\-f\fR, \fB\-\-load\-file\fR=\fIFILE\fR +.BI \-f\fP,\fB \-\-load\-file\fB= FILE load state file on startup .TP -\fB\-P\fR, \fB\-\-plugin\-dir\fR=\fIDIR\fR +.BI \-P\fP,\fB \-\-plugin\-dir\fB= DIR directory with guitarix plugins (.so files) .TP -\fB\-K\fR, \fB\-\-dissable\-auto\-save\fR -dissable auto save to state file when quit -.SS "Debug Options" +.B \-K\fP,\fB \-\-disable\-save\-on\-exit +disable auto save to state file when quit .TP -\fB\-B\fR, \fB\-\-builder\-dir\fR=\fIDIR\fR +.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 -\fB\-S\fR, \fB\-\-style\-dir\fR=\fIDIR\fR +.BI \-\-style\-dir\fB= DIR directory with skin style definitions (.rc files) .TP -\fB\-t\fR, \fB\-\-log\-terminal\fR +.B \-t\fP,\fB \-\-log\-terminal print log on terminal .TP -\fB\-d\fR, \fB\-\-dump\-parameter\fR -dump parameter table in JSON format -.SS "GTK+ Options" +.B \-d\fP,\fB \-\-dump\-parameter +dump parameter table in json format +.UNINDENT +.TP +.B GTK+ Options +.INDENT 7.0 .TP -\fB\-\-class\fR=\fICLASS\fR +.BI \-\-class\fB= CLASS Program class as used by the window manager .TP -\fB\-\-gtk\-name\fR=\fINAME\fR +.BI \-\-gtk\-name\fB= NAME Program name as used by the window manager .TP -\fB\-\-screen\fR=\fISCREEN\fR +.BI \-\-screen\fB= SCREEN X screen to use .TP -\fB\-\-sync\fR +.B \-\-sync Make X calls synchronous .TP -\fB\-\-gtk\-module\fR=\fIMODULES\fR +.BI \-\-gtk\-module\fB= MODULES Load additional GTK+ modules .TP -\fB\-\-g\-fatal\-warnings\fR +.B \-\-g\-fatal\-warnings Make all warnings fatal -.SS "Application Options" +.UNINDENT .TP -\fB\-v\fR, \fB\-\-version\fR +.B Application Options: +.INDENT 7.0 +.TP +.B \-v\fP,\fB \-\-version Print version string and exit .TP -\fB\-\-display\fR=\fIDISPLAY\fR +.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 \-\-display\fB= DISPLAY X display to use -.SH AUTHORS -Guitarix is Copyright (c) 2010 Hermman Meyer \- James Warden \- Andreas Degert -.PP -This man page was created for the SlackBuilds.org project by B. Watson, but it can -be used by anyone. +.UNINDENT +.UNINDENT +.\" Generated by docutils manpage writer. +. -- cgit v1.2.3