nils/shairport-sync
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix a few typos in the man page, bump the version number.

Browse Source
This commit is contained in:
Mike Brady
2014-11-21 11:00:47 +00:00
parent 3b5cc99f4c
commit dcb091abb0
4 changed files with 30 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files
configure.ac
+1 -1
View File
@@ -2,7 +2,7 @@
# Process this file with autoconf to produce a configure script.
AC_PREREQ([2.50])
AC_INIT([shairport-sync], [2.1.11], [mikebrady@eircom.net])
AC_INIT([shairport-sync], [2.1.12], [mikebrady@eircom.net])
AM_INIT_AUTOMAKE
AC_CONFIG_SRCDIR([shairport.c])
AC_CONFIG_HEADERS([config.h])
man/shairport-sync.7
+7 -7
View File
@@ -2,7 +2,7 @@
.SH NAME
shairport-sync \- Synchronised Audio Player for iTunes / AirPlay
.SH SYNOPSIS
\fBshairport-sync [-dvw]\fB [-A \fB\fIname\fB]\fB [-a \fB\fIlatency\fB]\fB [-B \fB\fIcommand\fB]\fB [-E \fB\fIcommand\fB]\fB [-i \fB\fIlatency\fB]\fB [-m \fB\fIbackend\fB]\fB [-o \fB\fIbackend\fB]\fB [-r \fB\fIthreshold\fB]\fB [-S \fB\fImode\fB]\fB [-t \fB\fItimeout\fB]\fB [-- \fB\fIaudio_backend_options\fB]\fB
\fBshairport-sync [-dvw]\fB [-a \fB\fIname\fB]\fB [-A \fB\fIlatency\fB]\fB [-B \fB\fIcommand\fB]\fB [-E \fB\fIcommand\fB]\fB [-i \fB\fIlatency\fB]\fB [-m \fB\fIbackend\fB]\fB [-o \fB\fIbackend\fB]\fB [-r \fB\fIthreshold\fB]\fB [-S \fB\fImode\fB]\fB [-t \fB\fItimeout\fB]\fB [-- \fB\fIaudio_backend_options\fB]\fB
shairport-sync -D\fB
@@ -17,7 +17,7 @@ shairport-sync -R\fB
shairport-sync -V\fB
\f1
.SH DESCRIPTION
shairport-sync plays audio streamed from iTunes or from an AirPlay device to an audio device connected via an audio back end. (At present, only an ALSA audio back end has been implemented.)
shairport-sync plays audio streamed from iTunes or from an AirPlay device to an audio device connected via an audio back end. At present, the only fully-implemented back end is for ALSA.
A feature of shairport-sync is that the audio is played synchronously. This means that if many devices are playing the same stream at the same time, all the outputs will stay in step with one another. This allows multiple devices play the same source without getting out of phase with one another, enabling, for example, simultaneous multi-room operation.
.SH OPTIONS
@@ -28,10 +28,10 @@ The command line for shairport-sync can take two kinds of options: regular progr
These options are used by shairport-sync itself.
.TP
\fB-A | --AirPlayLatency=\f1\fIlatency\f1
Use this latency, in frames, for audio streamed from an AirPlay device. The default is 88,200 frames, where there are 44,100 frames to the second.
Use this \fIlatency\f1, in frames, for audio streamed from an AirPlay device. The default is 88,200 frames, where there are 44,100 frames to the second.
.TP
\fB-a \f1\fIservice name\f1\fB | --name=\f1\fIservice name\f1
Use this service name to identify this player in iTunes, etc. The default name is "Shairport Sync on <hostname>".
Use this \fIservice name\f1 to identify this player in iTunes, etc. The default name is "Shairport Sync on <hostname>".
.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.
@@ -42,7 +42,7 @@ If you want shairport-sync to wait until the command has completed before starti
Disconnect the shairport-sync daemon from the output device and exit. (Requires that the daemon has written its PID to an agreed file -- see the \fB-d\f1 option).
.TP
\fB-d | --daemon\f1
Instruct shairport-sync to demonise itself. It will write its Process ID (PID) to a file, usually at /var/run/shairport-sync.pid, which is used by the \fB-k\f1, \fB-D\f1 and \fB-R\f1 options to locate the daemon at a later time.
Instruct shairport-sync to demonise itself. It will write its Process ID (PID) to a file, usually at \fI/var/run/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.
.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.
@@ -53,13 +53,13 @@ If you want shairport-sync to wait until the command has completed before contin
Print brief help message and exit.
.TP
\fB-i | --iTunesLatency=\f1\fIlatency\f1
Use this latency, in frames, for audio streamed from an iTunes source. The default is 99,400 frames, where there are 44,100 frames to the second.
Use this \fIlatency\f1, in frames, for audio streamed from an iTunes source. The default is 99,400 frames, where there are 44,100 frames to the second.
.TP
\fB-k | --kill\f1
Kill the shairport-sync daemon and exit. (Requires that the daemon has written its PID to an agreed file -- see the \fB-d\f1 option).
.TP
\fB-m \f1\fImdnsbackend\f1\fB | --mdns=\f1\fImdnsbackend\f1
Force the use of the specified mDNS backend to advertise the player on the network. The default is to try them all until one works.
Force the use of the specified mDNS backend to advertise the player on the network. The default is to try all mDNS backends all 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.)
man/shairport-sync.7.xml
+11 -10
View File
@@ -35,8 +35,8 @@
<cmd>shairport-sync <opt>-D</opt> <arg>interface</arg></cmd>
-->
<cmd>shairport-sync <opt>[-dvw]</opt>
<opt>[-A </opt><arg>name</arg><opt>]</opt>
<opt>[-a </opt><arg>latency</arg><opt>]</opt>
<opt>[-a </opt><arg>name</arg><opt>]</opt>
<opt>[-A </opt><arg>latency</arg><opt>]</opt>
<opt>[-B </opt><arg>command</arg><opt>]</opt>
<opt>[-E </opt><arg>command</arg><opt>]</opt>
<opt>[-i </opt><arg>latency</arg><opt>]</opt>
@@ -57,8 +57,8 @@
<description>
<p>shairport-sync plays audio streamed from iTunes or from an AirPlay
device to an audio device connected via an audio back end. (At present,
only an ALSA audio back end has been implemented.)</p>
device to an audio device connected via an audio back end. At present,
the only fully-implemented back end is for ALSA.</p>
<p> A feature of shairport-sync is that the audio is played synchronously.
This means that if many devices are playing the same stream at the same
@@ -75,7 +75,8 @@
ignore most of them. See the EXAMPLES section for typical usages.</p>
<p>The command line for shairport-sync can take two kinds of options:
regular program options and audio backend options. Program options are
regular <b>program options</b> and <b>audio backend options</b>.
Program options are
always listed first, followed by any audio backend options separated by
a <b>--</b> symbol.</p>
@@ -86,7 +87,7 @@
<option>
<p><opt>-A | --AirPlayLatency=</opt><arg>latency</arg></p>
<optdesc><p>
Use this latency, in frames, for audio streamed from an AirPlay
Use this <arg>latency</arg>, in frames, for audio streamed from an AirPlay
device. The default is 88,200 frames, where there are 44,100
frames to the second.
</p></optdesc>
@@ -95,7 +96,7 @@
<option>
<p><opt>-a </opt><arg>service name</arg><opt> | --name=</opt><arg>service name</arg></p>
<optdesc><p>
Use this service name to identify this player in iTunes, etc.
Use this <arg>service name</arg> to identify this player in iTunes, etc.
The default name is "Shairport Sync on &lt;hostname&gt;".
</p></optdesc>
</option>
@@ -127,7 +128,7 @@
<optdesc><p>
Instruct shairport-sync to demonise itself. It will write its
Process ID (PID) to a file, usually at
/var/run/shairport-sync.pid, which is used by the
<file>/var/run/shairport-sync.pid</file>, which is used by the
<opt>-k</opt>, <opt>-D</opt> and <opt>-R</opt> options to locate
the daemon at a later time.
</p></optdesc>
@@ -155,7 +156,7 @@
<option>
<p><opt>-i | --iTunesLatency=</opt><arg>latency</arg></p>
<optdesc><p>
Use this latency, in frames, for audio streamed from an iTunes
Use this <arg>latency</arg>, in frames, for audio streamed from an iTunes
source. The default is 99,400 frames, where there are 44,100
frames to the second.
</p></optdesc>
@@ -173,7 +174,7 @@
<p><opt>-m </opt><arg>mdnsbackend</arg><opt> | --mdns=</opt><arg>mdnsbackend</arg></p>
<optdesc><p>
Force the use of the specified mDNS backend to advertise the
player on the network. The default is to try them all until one
player on the network. The default is to try all mDNS backends all until one
works.
</p></optdesc>
</option>
man/shairport-sync.html
+11 -10
View File
@@ -7,8 +7,8 @@
<b>
shairport-sync <b>[-dvw]</b>
<b>[-A </b><em>name</em><b>]</b>
<b>[-a </b><em>latency</em><b>]</b>
<b>[-a </b><em>name</em><b>]</b>
<b>[-A </b><em>latency</em><b>]</b>
<b>[-B </b><em>command</em><b>]</b>
<b>[-E </b><em>command</em><b>]</b>
<b>[-i </b><em>latency</em><b>]</b>
@@ -38,8 +38,8 @@
<h2>Description</h2>
<p>shairport-sync plays audio streamed from iTunes or from an AirPlay
device to an audio device connected via an audio back end. (At present,
only an ALSA audio back end has been implemented.)</p>
device to an audio device connected via an audio back end. At present,
the only fully-implemented back end is for ALSA.</p>
<p> A feature of shairport-sync is that the audio is played synchronously.
This means that if many devices are playing the same stream at the same
@@ -58,7 +58,8 @@
ignore most of them. See the EXAMPLES section for typical usages.</p>
<p>The command line for shairport-sync can take two kinds of options:
regular program options and audio backend options. Program options are
regular program options and audio backend options.
Program options are
always listed first, followed by any audio backend options separated by
a -- symbol.</p>
@@ -71,7 +72,7 @@
<p><b>-A | --AirPlayLatency=</b><em>latency</em></p>
<p>
Use this latency, in frames, for audio streamed from an AirPlay
Use this <em>latency</em>, in frames, for audio streamed from an AirPlay
device. The default is 88,200 frames, where there are 44,100
frames to the second.
</p>
@@ -80,7 +81,7 @@
<p><b>-a </b><em>service name</em><b> | --name=</b><em>service name</em></p>
<p>
Use this service name to identify this player in iTunes, etc.
Use this <em>service name</em> to identify this player in iTunes, etc.
The default name is &quot;Shairport Sync on &lt;hostname&gt;&quot;.
</p>
@@ -112,7 +113,7 @@
<p>
Instruct shairport-sync to demonise itself. It will write its
Process ID (PID) to a file, usually at
/var/run/shairport-sync.pid, which is used by the
<em>/var/run/shairport-sync.pid</em>, which is used by the
<b>-k</b>, <b>-D</b> and <b>-R</b> options to locate
the daemon at a later time.
</p>
@@ -140,7 +141,7 @@
<p><b>-i | --iTunesLatency=</b><em>latency</em></p>
<p>
Use this latency, in frames, for audio streamed from an iTunes
Use this <em>latency</em>, in frames, for audio streamed from an iTunes
source. The default is 99,400 frames, where there are 44,100
frames to the second.
</p>
@@ -158,7 +159,7 @@
<p><b>-m </b><em>mdnsbackend</em><b> | --mdns=</b><em>mdnsbackend</em></p>
<p>
Force the use of the specified mDNS backend to advertise the
player on the network. The default is to try them all until one
player on the network. The default is to try all mDNS backends all until one
works.
</p>