| 1 | .\" roarpluginrunner.1: |
|---|
| 2 | |
|---|
| 3 | .TH "roarpluginrunner" "1" "FIXME(DATE)" "RoarAudio" "System User's Manual: roarpluginrunner" |
|---|
| 4 | |
|---|
| 5 | .SH NAME |
|---|
| 6 | |
|---|
| 7 | roarpluginrunner \- Run RoarAudio plugins |
|---|
| 8 | |
|---|
| 9 | .SH SYNOPSIS |
|---|
| 10 | |
|---|
| 11 | roarpluginrunner [OPTIONS]... PLUGIN |
|---|
| 12 | |
|---|
| 13 | .SH DESCRIPTION |
|---|
| 14 | |
|---|
| 15 | This tool can be used to run RoarAudio plugins or report information about the plugin. |
|---|
| 16 | roarpluginrunner loads the plugins in a plugin container with the given parameters passed. |
|---|
| 17 | This allows you to run all universal plugins as well as some other plugins out side |
|---|
| 18 | a specific host. It can also be used for Testing the plugins. |
|---|
| 19 | |
|---|
| 20 | There are three modes of operation: Running, Running as application and Explaining. |
|---|
| 21 | The first mode (Running) is what most host applications will do. |
|---|
| 22 | Running as application is different in the way that all parameters left on the command line |
|---|
| 23 | after the plugin name are parsed and passed to the plugin as plugin arguments. |
|---|
| 24 | |
|---|
| 25 | In this mode parameters passed after the plugin name are splitted into key-value-pairs. |
|---|
| 26 | An option (beginning with two dashes) are passed as pair with the option name (the dashes) removed as key |
|---|
| 27 | and no value. If it contains a equality sign the part after it is passed as value. |
|---|
| 28 | Options with a single dash are splitted each letter into an own key-value-pair with only the key set. |
|---|
| 29 | Non-option arguments (with no dashes) are passed as value-only pairs. |
|---|
| 30 | After a pure double dash all parameters are passed as non-options with the double dash completely removed |
|---|
| 31 | from the key-value-array. |
|---|
| 32 | |
|---|
| 33 | In the explain mode the plugin is loaded but not run. The meta information about the plugin are reported. |
|---|
| 34 | This includes true meta data like the name, authors and copyright but also technical meta data |
|---|
| 35 | like the host application's name the plugin is written for. |
|---|
| 36 | |
|---|
| 37 | When the plugin uses symbols from the host directly the plugin may not be loaded into roarpluginrunner |
|---|
| 38 | because of the system's library loader limits. On GNU/Linux (and other POSIX like implementations) |
|---|
| 39 | this is only true if the plugin uses global variables of the host. Plugins using functions of the host |
|---|
| 40 | can still be loaded in this mode. |
|---|
| 41 | |
|---|
| 42 | .SH "OPTIONS" |
|---|
| 43 | |
|---|
| 44 | .TP |
|---|
| 45 | \fB-h \-\-help\fR |
|---|
| 46 | Prints a help message. |
|---|
| 47 | |
|---|
| 48 | .TP |
|---|
| 49 | \fB-v \-\-verbose\fR |
|---|
| 50 | Be verbose. Can be used multiple times. |
|---|
| 51 | |
|---|
| 52 | .TP |
|---|
| 53 | \fB--server SERVER\fR |
|---|
| 54 | Set default server to SERVER. |
|---|
| 55 | |
|---|
| 56 | .TP |
|---|
| 57 | \fB--run\fR |
|---|
| 58 | Run plugin. |
|---|
| 59 | |
|---|
| 60 | .TP |
|---|
| 61 | \fB--run-as-application\fR |
|---|
| 62 | Same as \-\-run except all tailing arguments are passed to the plugin. |
|---|
| 63 | This is also used by \fBroarpluginapplication\fR(1). |
|---|
| 64 | |
|---|
| 65 | .TP |
|---|
| 66 | \fB--explain\fR |
|---|
| 67 | Explain plugin. This lists all details about the plugin without actually running it. |
|---|
| 68 | |
|---|
| 69 | .TP |
|---|
| 70 | \fB--appname NAME\fR |
|---|
| 71 | Sets the appname. |
|---|
| 72 | |
|---|
| 73 | .TP |
|---|
| 74 | \fB--abiversion ABI\fR |
|---|
| 75 | Set the ABI version. |
|---|
| 76 | |
|---|
| 77 | .TP |
|---|
| 78 | \fB--args ARGS\fR |
|---|
| 79 | Set plugin arguments. |
|---|
| 80 | |
|---|
| 81 | .SH "SEE ALSO" |
|---|
| 82 | \fBroarpluginapplication\fR(1), |
|---|
| 83 | \fBroartips\fR(7), |
|---|
| 84 | \fBlibroar\fR(7), |
|---|
| 85 | \fBRoarAudio\fR(7). |
|---|
| 86 | |
|---|
| 87 | .SH "HISTORY" |
|---|
| 88 | |
|---|
| 89 | For history information see \fBRoarAudio\fR(7). |
|---|
| 90 | |
|---|
| 91 | .\" ll |
|---|
