summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorNiklas Janz <niklas@janz.online>2018-02-04 18:04:43 +0100
committerNiklas Janz <niklas@janz.online>2018-02-04 18:04:43 +0100
commit2273ac267eda79a10cb05023851b9f579d3ab36c (patch)
tree8c5efd863f2e31a7f969f4533a015678c4486a79 /man
parent79c41ec0f8f459619f8d9170175a69223e270ea1 (diff)
Referenced the shebang ordeal in the man pages.
Diffstat (limited to 'man')
-rw-r--r--man/shairport-sync.710
-rw-r--r--man/shairport-sync.7.xml14
-rw-r--r--man/shairport-sync.html14
3 files changed, 19 insertions, 19 deletions
diff --git a/man/shairport-sync.7 b/man/shairport-sync.7
index 35fa5a5..e96088a 100644
--- a/man/shairport-sync.7
+++ b/man/shairport-sync.7
@@ -151,7 +151,7 @@ The purpose of this silent lead-in is to give the backend sufficient time to pre
If the value chosen is too short for synchronised backends such as the ALSA, sndio or PA backends, then audio will not be synchronised correctly at the start of play. The default is to have a silent lead-in of approximately the same time as the latency set by the client.
.TP
\fBrun_this_when_volume_is_set=\f1\fI"/full/path/to/application/and/args"\f1\fB;\f1
-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 \fI#!/bin/...\f1 as appropriate.
+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 appropriate shebang \fI#!/bin/...\f1.
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".
.TP
@@ -267,10 +267,10 @@ The maximum packet size for any UDP metadata. This must be between 500 or 65000.
shairport-sync can run programs just before it starts to play an audio stream and just after it finishes. You specify them using the sessioncontrol group settings run_this_before_play_begins and run_this_after_play_ends.
.TP
\fBrun_this_before_play_begins=\f1\fI"/path/to/application and args"\f1\fB;\f1
-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 \fI#!/bin/...\f1 as appropriate.
+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 appropriate shebang \fI#!/bin/...\f1.
.TP
\fBrun_this_after_play_ends=\f1\fI"/path/to/application and args"\f1\fB;\f1
-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 \fI#!/bin/...\f1 as appropriate.
+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 appropriate shebang \fI#!/bin/...\f1.
.TP
\fBwait_for_completion=\f1\fI"choice"\f1\fB;\f1
Set \fIchoice\f1 to "yes" to make shairport-sync wait until the programs specified in the \fBrun_this_before_play_begins\f1, \fBrun_this_after_play_ends\f1 and \fBrun_this_when_volume_is_set\f1 have completed execution before continuing. The default is "no".
@@ -299,7 +299,7 @@ The following substitutions are allowed: \fB%h\f1 for the computer's hostname, \
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 \fI#!/bin/sh\f1 (or whatever is appropriate) 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
@@ -315,7 +315,7 @@ Please note that this feature is deprecated and will be removed in a future vers
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 \fI#!/bin/sh\f1 (or whatever is appropriate) 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
diff --git a/man/shairport-sync.7.xml b/man/shairport-sync.7.xml
index 6d79a7f..4235e9c 100644
--- a/man/shairport-sync.7.xml
+++ b/man/shairport-sync.7.xml
@@ -275,7 +275,7 @@
<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 <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>
@@ -446,12 +446,12 @@
<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 <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 <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>
@@ -511,8 +511,8 @@
<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 <file>#!/bin/sh</file> (or
- whatever is appropriate) in the headline.</p>
+ 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 starting to play, select the <opt>-w</opt> option as well.
@@ -554,8 +554,8 @@
<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 <file>#!/bin/sh</file> (or
- whatever is appropriate) in the headline.</p>
+ Executable scripts can be used, but they must have the appropriate Shebang
+ (<file>#!/bin/sh</file> in the headline.</p></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></optdesc>
diff --git a/man/shairport-sync.html b/man/shairport-sync.html
index 4b821e1..b063e1a 100644
--- a/man/shairport-sync.html
+++ b/man/shairport-sync.html
@@ -256,7 +256,7 @@
<p><b>run_this_when_volume_is_set=</b><em>&quot;/full/path/to/application/and/args&quot;</em><b>;</b></p>
<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 <em>#!/bin/...</em> as appropriate.</p>
+ The application must be marked as executable and, if it is a script, its first line must begin with the appropriate shebang <em>#!/bin/...</em>.</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 &quot;mute&quot;.</p>
@@ -427,12 +427,12 @@
<p><b>run_this_before_play_begins=</b><em>&quot;/path/to/application and args&quot;</em><b>;</b></p>
<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 <em>#!/bin/...</em> as appropriate.</p>
+ The application must be marked as executable and, if it is a script, its first line must begin with the appropriate shebang <em>#!/bin/...</em>.</p>
<p><b>run_this_after_play_ends=</b><em>&quot;/path/to/application and args&quot;</em><b>;</b></p>
<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 <em>#!/bin/...</em> as appropriate.</p>
+ The application must be marked as executable and, if it is a script, its first line must begin with the appropriate shebang <em>#!/bin/...</em>.</p>
<p><b>wait_for_completion=</b><em>&quot;choice&quot;</em><b>;</b></p>
@@ -496,8 +496,8 @@
<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 <em>#!/bin/sh</em> (or
- whatever is appropriate) in the headline.</p>
+ 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 starting to play, select the <b>-w</b> option as well.
@@ -539,8 +539,8 @@
<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 <em>#!/bin/sh</em> (or
- whatever is appropriate) in the headline.</p>
+ 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.
</p>