The default is "%H", which is replaced by the hostname with the first letter capitalised.
.TP
\fB-B \f1\fIprogram\f1\fB | --on-start=\f1\fIprogram\f1
-Execute \fIprogram\f1 when playback is about to begin. Specify the full path to the program, e.g. \fI/usr/bin/logger\f1. Executable scripts can be used, but they must have the appropriate Shebang (\fI#!/bin/sh\f1) in the headline.
+Execute \fIprogram\f1 when playback is about to begin. Specify the full path to the program, e.g. \fI/usr/bin/logger\f1. Executable scripts can be used, but they must have the appropriate shebang (\fI#!/bin/sh\f1) in the headline.
If you want shairport-sync to wait until the command has completed before starting to play, select the \fB-w\f1 option as well.
.TP
Instruct shairport-sync to demonise itself. It will write its Process ID (PID) to a file, usually at \fI/var/run/shairport-sync/shairport-sync.pid\f1, which is used by the \fB-k\f1, \fB-D\f1 and \fB-R\f1 options to locate the daemon at a later time. See also the \fB-j\f1 option.
.TP
\fB-E \f1\fIprogram\f1\fB | --on-stop=\f1\fIprogram\f1
-Execute \fIprogram\f1 when playback has ended. Specify the full path to the program, e.g. \fI/usr/bin/logger\f1. Executable scripts can be used, but they must have the appropriate Shebang (\fI#!/bin/sh\f1) in the headline.
+Execute \fIprogram\f1 when playback has ended. Specify the full path to the program, e.g. \fI/usr/bin/logger\f1. Executable scripts can be used, but they must have the appropriate shebang (\fI#!/bin/sh\f1) in the headline.
If you want shairport-sync to wait until the command has completed before continuing, select the \fB-w\f1 option as well.
.TP
<option>
<p><opt>run_this_when_volume_is_set=</opt><arg>"/full/path/to/application/and/args"</arg><opt>;</opt></p>
<optdesc><p>Here you can specify a program and its arguments that will be run when the volume is set or changed. Be careful to include the full path to the application.
- The application must be marked as executable and, if it is a script, its first line must begin with the standard Shebang <file>#!/bin/...</file> as appropriate.</p>
+ The application must be marked as executable and, if it is a script, its first line must begin with the standard shebang <file>#!/bin/...</file> as appropriate.</p>
<p>The desired AirPlay volume is appended to the end of the command line - leave a space if you want it treated as an extra argument.
AirPlay volume goes from 0.0 to -30.0 and -144.0 means "mute".</p></optdesc>
</option>
<option>
<p><opt>run_this_before_play_begins=</opt><arg>"/path/to/application and args"</arg><opt>;</opt></p>
<optdesc><p>Here you can specify a program and its arguments that will be run just before a play session begins. Be careful to include the full path to the application.
- The application must be marked as executable and, if it is a script, its first line must begin with the standard Shebang <file>#!/bin/...</file> as appropriate.</p></optdesc>
+ The application must be marked as executable and, if it is a script, its first line must begin with the standard shebang <file>#!/bin/...</file> as appropriate.</p></optdesc>
</option>
<option>
<p><opt>run_this_after_play_ends=</opt><arg>"/path/to/application and args"</arg><opt>;</opt></p>
<optdesc><p>Here you can specify a program and its arguments that will be run just after a play session ends. Be careful to include the full path to the application.
- The application must be marked as executable and, if it is a script, its first line must begin with the standard Shebang <file>#!/bin/...</file> as appropriate.</p></optdesc>
+ The application must be marked as executable and, if it is a script, its first line must begin with the standard shebang <file>#!/bin/...</file> as appropriate.</p></optdesc>
</option>
<option>
<p><opt>wait_for_completion=</opt><arg>"choice"</arg><opt>;</opt></p>
<optdesc><p>
Execute <arg>program</arg> when playback is about to begin. Specify the
full path to the program, e.g. <file>/usr/bin/logger</file>.
- Executable scripts can be used, but they must have the appropriate Shebang
+ Executable scripts can be used, but they must have the appropriate shebang
(<file>#!/bin/sh</file> in the headline.</p>
<p>If you want shairport-sync to wait until the command has
<optdesc><p>
Execute <arg>program</arg> when playback has ended. Specify the
full path to the program, e.g. <file>/usr/bin/logger</file>.
- Executable scripts can be used, but they must have the appropriate Shebang
+ Executable scripts can be used, but they must have the appropriate shebang
(<file>#!/bin/sh</file> in the headline.</p>
<p>If you want shairport-sync to wait until the command has
completed before continuing, select the <opt>-w</opt> option as well.
<p>
Execute <em>program</em> when playback is about to begin. Specify the
full path to the program, e.g. <em>/usr/bin/logger</em>.
- Executable scripts can be used, but they must have the appropriate Shebang
+ Executable scripts can be used, but they must have the appropriate shebang
<em>#!/bin/sh</em> in the headline.</p>
<p>If you want shairport-sync to wait until the command has
<p>
Execute <em>program</em> when playback has ended. Specify the
full path to the program, e.g. <em>/usr/bin/logger</em>.
- Executable scripts can be used, but they must have the appropriate Shebang
+ Executable scripts can be used, but they must have the appropriate shebang
<em>#!/bin/sh</em> in the headline.</p>
<p>If you want shairport-sync to wait until the command has
completed before continuing, select the <b>-w</b> option as well.
projects / thirdparty / shairport-sync.git / commitdiff
