From dcb091abb0fdd830d0823d8b68d68e311ab2eee4 Mon Sep 17 00:00:00 2001 From: Mike Brady Date: Fri, 21 Nov 2014 11:00:47 +0000 Subject: [PATCH] Fix a few typos in the man page, bump the version number. --- configure.ac | 2 +- man/shairport-sync.7 | 14 +++++++------- man/shairport-sync.7.xml | 21 +++++++++++---------- man/shairport-sync.html | 21 +++++++++++---------- 4 files changed, 30 insertions(+), 28 deletions(-) diff --git a/configure.ac b/configure.ac index 8cef9b39..43a39d0d 100644 --- a/configure.ac +++ b/configure.ac @@ -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]) diff --git a/man/shairport-sync.7 b/man/shairport-sync.7 index d9669ee0..c0a2cb47 100644 --- a/man/shairport-sync.7 +++ b/man/shairport-sync.7 @@ -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 ". +Use this \fIservice name\f1 to identify this player in iTunes, etc. The default name is "Shairport Sync on ". .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.) diff --git a/man/shairport-sync.7.xml b/man/shairport-sync.7.xml index 93e4f82a..6d1da88f 100644 --- a/man/shairport-sync.7.xml +++ b/man/shairport-sync.7.xml @@ -35,8 +35,8 @@ shairport-sync -D interface --> shairport-sync [-dvw] - [-A name] - [-a latency] + [-a name] + [-A latency] [-B command] [-E command] [-i latency] @@ -57,8 +57,8 @@

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.)

+ 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 @@ -75,7 +75,8 @@ ignore most of them. See the EXAMPLES section for typical usages.

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.

@@ -86,7 +87,7 @@ @@ -127,7 +128,7 @@

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 + /var/run/shairport-sync.pid, which is used by the -k, -D and -R options to locate the daemon at a later time.

@@ -155,7 +156,7 @@ diff --git a/man/shairport-sync.html b/man/shairport-sync.html index 2405f7a4..34f4ea0d 100644 --- a/man/shairport-sync.html +++ b/man/shairport-sync.html @@ -7,8 +7,8 @@ shairport-sync [-dvw] - [-A name] - [-a latency] + [-a name] + [-A latency] [-B command] [-E command] [-i latency] @@ -38,8 +38,8 @@

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.)

+ 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 @@ -58,7 +58,8 @@ ignore most of them. See the EXAMPLES section for typical usages.

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.

@@ -71,7 +72,7 @@

-A | --AirPlayLatency=latency

- Use this latency, in frames, for audio streamed from an AirPlay + 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.

@@ -80,7 +81,7 @@

-a service name | --name=service name

- Use this service name to identify this player in iTunes, etc. + Use this service name to identify this player in iTunes, etc. The default name is "Shairport Sync on <hostname>".

@@ -112,7 +113,7 @@

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 + /var/run/shairport-sync.pid, which is used by the -k, -D and -R options to locate the daemon at a later time.

@@ -140,7 +141,7 @@

-i | --iTunesLatency=latency

- Use this latency, in frames, for audio streamed from an iTunes + 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.

@@ -158,7 +159,7 @@

-m mdnsbackend | --mdns=mdnsbackend

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.