.SH NAME
shairport-sync \- Synchronised Audio Player for iTunes / AirPlay
.SH SYNOPSIS
-\fBshairport-sync [-djvw]\fB [-a \fB\fIname\fB]\fB [-A \fB\fIlatency\fB]\fB [-B \fB\fIcommand\fB]\fB [-c \fB\fIconfigurationfile\fB]\fB [-E \fB\fIcommand\fB]\fB [--get-cover-art]\fB [--logOutputLevel=]\fB [-L \fB\fIlatency\fB]\fB [-m \fB\fIbackend\fB]\fB [--meta-dir=\fB\fIdirectory\fB]\fB [-o \fB\fIbackend\fB]\fB [--password=\fB\fIsecret\fB]\fB [-r \fB\fIthreshold\fB]\fB [--statistics]\fB [-S \fB\fImode\fB]\fB [-t \fB\fItimeout\fB]\fB [--tolerance=\fB\fIframes\fB]\fB [-- \fB\fIaudio_backend_options\fB]\fB
+\fBshairport-sync [-djvw]\fB [-a \fB\fIname\fB]\fB [-A \fB\fIlatency\fB]\fB [-B \fB\fIcommand\fB]\fB [-c \fB\fIconfigurationfile\fB]\fB [-E \fB\fIcommand\fB]\fB [--get-cover-art]\fB [--logOutputLevel]\fB [-L \fB\fIlatency\fB]\fB [-m \fB\fIbackend\fB]\fB [--meta-dir=\fB\fIdirectory\fB]\fB [-o \fB\fIbackend\fB]\fB [--password=\fB\fIsecret\fB]\fB [-r \fB\fIthreshold\fB]\fB [--statistics]\fB [-S \fB\fImode\fB]\fB [-t \fB\fItimeout\fB]\fB [--tolerance=\fB\fIframes\fB]\fB [-- \fB\fIaudio_backend_options\fB]\fB
shairport-sync -D\fB
(Note: Shairport Sync may have been compiled to use a different configuration directory. You can determine which by performing the command \fI$ shairport-sync -V\f1. One of the items in the output string is the value of the \fBsysconfdir\f1, i.e. the System Configuration Directory.)
-Settings are organised into groups, for example, there is a "general" group of standard settings, and there is an "alsa" group with settings that pertain to the ALSA back end. Here is an example of a typical configuration file:
+Within the configuraton file, settings are organised into groups, for example, there is a "general" group of standard settings, and there is an "alsa" group with settings that pertain to the ALSA back end. Here is an example of a typical configuration file:
\fBgeneral = {\f1
\fBpassword = "secret";\f1
+\fBoutput_backend = "alsa";\f1
+
\fB};\f1
\fB\f1
\fBoutput_device=\f1\fI"output_device"\f1\fB;\f1
Use the output device called \fIoutput_device\f1. The default is the device called \fI"default"\f1.
.TP
-.TP
\fBmixer_control_name=\f1\fI"name"\f1\fB;\f1
Specify the \fIname\f1 of the mixer control to be used by shairport-sync to control the volume. The mixer control must be on the mixer device, which by default is the output device. If you do not specify a mixer control name, shairport-sync will adjust the volume in software.
-\fBmixer_type=\f1\fI"mixer_type"\f1\fB;\f1
-This setting is deprecated and is ignored. For your information, its functionality has been automatically incorporated in the \fBmixer_control_name\f1 setting -- if you specify a mixer name with the \fBmixer_control_name\f1 setting, it is assumed that the mixer is implemented in hardware.
.TP
\fBmixer_device=\f1\fI"mixer_device"\f1\fB;\f1
By default, the mixer is assumed to be output_device. Use this setting to specify a device other than the output device.
These settings are for the SNDIO back end, used to communicate with audio output devices in the SNDIO system.
.TP
\fBdevice=\f1\fI"snd/0"\f1\fB;\f1
-Use this optional setting to specify the name of the output device, e.g. \fI"snd/0"\f1.
+Use this optional setting to specify the name of the output device, e.g. \fI"snd/0"\f1. The default is to use the SNDIO system's default.
.TP
\fBrate=\f1\fI44100\f1\fB;\f1
-Use this optional setting to specify the output rate in frames per second. Valid rates are 44100, 88200, 176400 or 352800. The output device must have the capability to accept data at the specified rate. Default is 44100.
+Use this optional setting to specify the output rate in frames per second. Valid rates are 44100, 88200, 176400 or 352800. The output device must have the capability to accept data at the specified rate. The default is 44100.
.TP
\fBformat=\f1\fI"S16"\f1\fB;\f1
Use this optional setting to specify the output format. Allowable values are "U8", "S8", "S16", "S24", "S24_3LE", "S24_3BE" or "S32". The device must have the capability to accept the format you specify.
These settings are for the new PulseAudio backend.
.TP
\fBapplication_name=\f1\fI"Shairport Sync"\f1\fB;\f1
-Use this to set the name to appear in the Sounds "Applications" tab when Shairport Sync is active Default is "Shairport Sync".
+Use this to set the name to appear in the Sounds "Applications" tab when Shairport Sync is active. The default is the name "Shairport Sync".
.TP
\fB"PIPE" SETTINGS\f1
These settings are for the PIPE backend, used to route audio to a named unix pipe. The audio is in raw CD audio format: PCM 16 bit little endian, 44,100 samples per second, interleaved stereo.
These command-line options are used by shairport-sync itself.
.TP
\fB-a \f1\fIservice name\f1\fB | --name=\f1\fIservice name\f1
-Use this \fIservice name\f1 to identify this player in iTunes, etc. The following substitutions are allowed: \fB%h\f1 for the computer's hostname, \fB%H\f1 for the computer's hostname with the first letter capitalised (ASCII only), \fB%v\f1 for the shairport-sync version number, e.g. "3.0.1" and \fB%V\f1 for the shairport-sync version string, e.g. "3.0.1-OpenSSL-Avahi-ALSA-soxr-metadata-sysconfdir:/etc".
+Use this \fIservice name\f1 to identify this player in iTunes, etc.
+
+The following substitutions are allowed: \fB%h\f1 for the computer's hostname, \fB%H\f1 for the computer's hostname with the first letter capitalised (ASCII only), \fB%v\f1 for the shairport-sync version number, e.g. "3.0.1" and \fB%V\f1 for the shairport-sync version string, e.g. "3.0.1-OpenSSL-Avahi-ALSA-soxr-metadata-sysconfdir:/etc".
The default is "%H", which is replaced by the hostname with the first letter capitalised.
.TP
Force the use of the specified mDNS backend to advertise the player on the network. The default is to try all mDNS backends until one works.
.TP
\fB-o \f1\fIoutputbackend\f1\fB | --output=\f1\fIoutputbackend\f1
-Force the use of the specified output backend to play the audio. The default is to try the first one. (This is not used at present.)
+Force the use of the specified output backend to play the audio. The default is to try the first one.
.TP
\fB-p \f1\fIport\f1\fB | --port=\f1\fIport\f1
Listen for play requests on \fIport\f1. The default is to use port 5000.
<opt>[-c </opt><arg>configurationfile</arg><opt>]</opt>
<opt>[-E </opt><arg>command</arg><opt>]</opt>
<opt>[--get-cover-art]</opt>
- <opt>[--logOutputLevel=]</opt>
+ <opt>[--logOutputLevel]</opt>
<opt>[-L </opt><arg>latency</arg><opt>]</opt>
<opt>[-m </opt><arg>backend</arg><opt>]</opt>
<opt>[--meta-dir=</opt><arg>directory</arg><opt>]</opt>
i.e. the System Configuration Directory.)</p>
- <p>Settings are organised into <i>groups</i>, for example, there is a "general" group of
+ <p>Within the configuraton file, settings are organised into <i>groups</i>, for example, there is a "general" group of
standard settings, and there is an "alsa" group with settings that pertain to the ALSA
back end. Here is an example of a typical configuration file:</p>
<p><p><opt>name = "Mike's Boombox";</opt></p></p>
<p><p><opt>interpolation = "soxr";</opt></p></p>
<p><p><opt>password = "secret";</opt></p></p>
+ <p><p><opt>output_backend = "alsa";</opt></p></p>
<p><opt>};</opt></p>
<p><opt></opt></p>
<p><opt>alsa = {</opt></p>
<optdesc><p>Use the output device called <arg>output_device</arg>. The default is the device called <arg>"default"</arg>.</p></optdesc>
</option>
<option>
- <option>
<p><opt>mixer_control_name=</opt><arg>"name"</arg><opt>;</opt></p>
<optdesc><p>Specify the <arg>name</arg> of the mixer control to be used by shairport-sync to control the volume.
The mixer control must be on the mixer device, which by default is the output device.
If you do not specify a mixer control name, shairport-sync will adjust the volume in software.</p></optdesc>
- </option>
- <p><opt>mixer_type=</opt><arg>"mixer_type"</arg><opt>;</opt></p>
- <optdesc><p>This setting is deprecated and is ignored. For your information, its functionality has been automatically incorporated in the <opt>mixer_control_name</opt> setting
- -- if you specify a mixer name with the <opt>mixer_control_name</opt> setting, it is assumed that the mixer is implemented in hardware.</p></optdesc>
</option>
<option>
<p><opt>mixer_device=</opt><arg>"mixer_device"</arg><opt>;</opt></p>
</option>
<option>
<p><opt>use_mmap_if_available=</opt><arg>"yes"</arg><opt>;</opt></p>
- <optdesc><p> Use this optional advanced setting to control whether MMAP-based output is used to communicate
with the DAC. Default is <arg>"yes"</arg>.</p></optdesc>
+ <optdesc><p> Use this optional advanced setting to control whether MMAP-based output is used to communicate with the DAC. Default is <arg>"yes"</arg>.</p></optdesc>
</option>
<p>These settings are for the SNDIO back end, used to communicate with audio output devices in the SNDIO system.</p>
<option>
<p><opt>device=</opt><arg>"snd/0"</arg><opt>;</opt></p>
- <optdesc><p>Use this optional setting to specify the name of the output device, e.g. <arg>"snd/0"</arg>.</p></optdesc>
+ <optdesc><p>Use this optional setting to specify the name of the output device, e.g. <arg>"snd/0"</arg>. The default is to use the SNDIO system's default.</p></optdesc>
</option>
<option>
<p><opt>rate=</opt><arg>44100</arg><opt>;</opt></p>
<optdesc><p>Use this optional setting to specify the output rate in frames per second. Valid rates are 44100, 88200, 176400 or 352800.
- The output device must have the capability to accept data at the specified rate. Default is 44100.</p></optdesc>
+ The output device must have the capability to accept data at the specified rate. The default is 44100.</p></optdesc>
</option>
<option>
<p><opt>format=</opt><arg>"S16"</arg><opt>;</opt></p>
<p>These settings are for the new PulseAudio backend.</p>
<option>
<p><opt>application_name=</opt><arg>"Shairport Sync"</arg><opt>;</opt></p>
- <optdesc><p>Use this to set the name to appear in the Sounds "Applications" tab when Shairport Sync is active Default is "Shairport Sync".</p></optdesc>
+ <optdesc><p>Use this to set the name to appear in the Sounds "Applications" tab when Shairport Sync is active. The default is the name "Shairport Sync".</p></optdesc>
</option>
<option><p><opt>"PIPE" SETTINGS</opt></p></option>
<option>
<p><opt>-a </opt><arg>service name</arg><opt> | --name=</opt><arg>service name</arg></p>
<optdesc><p>
- Use this <arg>service name</arg> to identify this player in iTunes, etc.
+ Use this <arg>service name</arg> to identify this player in iTunes, etc.</p>
<p>The following substitutions are allowed:
<opt>%h</opt> for the computer's hostname,
<opt>%v</opt> for the shairport-sync version number, e.g. "3.0.1" and
<opt>%V</opt> for the shairport-sync version string, e.g. "3.0.1-OpenSSL-Avahi-ALSA-soxr-metadata-sysconfdir:/etc".</p>
<p>The default is "%H", which is replaced by the hostname with the first letter capitalised.</p>
- </p></optdesc>
+ </optdesc>
</option>
<option>
<p><opt>-o </opt><arg>outputbackend</arg><opt> | --output=</opt><arg>outputbackend</arg></p>
<optdesc><p>
Force the use of the specified output backend to play the audio.
- The default is to try the first one. (This is not used at
- present.)
+ The default is to try the first one.
</p></optdesc>
</option>
<b>[-c </b><em>configurationfile</em><b>]</b>
<b>[-E </b><em>command</em><b>]</b>
<b>[--get-cover-art]</b>
- <b>[--logOutputLevel=]</b>
+ <b>[--logOutputLevel]</b>
<b>[-L </b><em>latency</em><b>]</b>
<b>[-m </b><em>backend</em><b>]</b>
<b>[--meta-dir=</b><em>directory</em><b>]</b>
i.e. the System Configuration Directory.)</p>
- <p>Settings are organised into groups, for example, there is a "general" group of
+ <p>Within the configuraton file, settings are organised into groups, for example, there is a "general" group of
standard settings, and there is an "alsa" group with settings that pertain to the ALSA
back end. Here is an example of a typical configuration file:</p>
<p><p><b>name = "Mike's Boombox";</b></p></p>
<p><p><b>interpolation = "soxr";</b></p></p>
<p><p><b>password = "secret";</b></p></p>
+ <p><p><b>output_backend = "alsa";</b></p></p>
<p><b>};</b></p>
<p><b></b></p>
<p><b>alsa = {</b></p>
<p>Use the output device called <em>output_device</em>. The default is the device called <em>"default"</em>.</p>
-
<p><b>mixer_control_name=</b><em>"name"</em><b>;</b></p>
<p>Specify the <em>name</em> of the mixer control to be used by shairport-sync to control the volume.
The mixer control must be on the mixer device, which by default is the output device.
If you do not specify a mixer control name, shairport-sync will adjust the volume in software.</p>
- <p><b>mixer_type=</b><em>"mixer_type"</em><b>;</b></p>
- <p>This setting is deprecated and is ignored. For your information, its functionality has been automatically incorporated in the <b>mixer_control_name</b> setting
- -- if you specify a mixer name with the <b>mixer_control_name</b> setting, it is assumed that the mixer is implemented in hardware.</p>
-
<p><b>mixer_device=</b><em>"mixer_device"</em><b>;</b></p>
<p>By default, the mixer is assumed to be output_device. Use this setting to specify a device other than the output device.</p>
<p><b>use_mmap_if_available=</b><em>"yes"</em><b>;</b></p>
- <p> Use this optional advanced setting to control whether MMAP-based output is used to communicate with the DAC. Default is <em>"yes"</em>.</p>
+ <p> Use this optional advanced setting to control whether MMAP-based output is used to communicate with the DAC. Default is <em>"yes"</em>.</p>
<p>These settings are for the SNDIO back end, used to communicate with audio output devices in the SNDIO system.</p>
<p><b>device=</b><em>"snd/0"</em><b>;</b></p>
- <p>Use this optional setting to specify the name of the output device, e.g. <em>"snd/0"</em>.</p>
+ <p>Use this optional setting to specify the name of the output device, e.g. <em>"snd/0"</em>. The default is to use the SNDIO system's default.</p>
<p><b>rate=</b><em>44100</em><b>;</b></p>
<p>Use this optional setting to specify the output rate in frames per second. Valid rates are 44100, 88200, 176400 or 352800.
- The output device must have the capability to accept data at the specified rate. Default is 44100.</p>
+ The output device must have the capability to accept data at the specified rate. The default is 44100.</p>
<p><b>format=</b><em>"S16"</em><b>;</b></p>
<p>These settings are for the new PulseAudio backend.</p>
<p><b>application_name=</b><em>"Shairport Sync"</em><b>;</b></p>
- <p>Use this to set the name to appear in the Sounds "Applications" tab when Shairport Sync is active Default is "Shairport Sync".</p>
+ <p>Use this to set the name to appear in the Sounds "Applications" tab when Shairport Sync is active. The default is the name "Shairport Sync".</p>
<p><b>"PIPE" SETTINGS</b></p>
<p><b>-a </b><em>service name</em><b> | --name=</b><em>service name</em></p>
<p>
- Use this <em>service name</em> to identify this player in iTunes, etc.
+ Use this <em>service name</em> to identify this player in iTunes, etc.</p>
<p>The following substitutions are allowed:
<b>%h</b> for the computer's hostname,
<b>%v</b> for the shairport-sync version number, e.g. "3.0.1" and
<b>%V</b> for the shairport-sync version string, e.g. "3.0.1-OpenSSL-Avahi-ALSA-soxr-metadata-sysconfdir:/etc".</p>
<p>The default is "%H", which is replaced by the hostname with the first letter capitalised.</p>
- </p>
+
<p><b>-o </b><em>outputbackend</em><b> | --output=</b><em>outputbackend</em></p>
<p>
Force the use of the specified output backend to play the audio.
- The default is to try the first one. (This is not used at
- present.)
+ The default is to try the first one.
</p>
projects / thirdparty / shairport-sync.git / commitdiff
