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

Add a note in the README about mDNS backends

Browse Source
This commit is contained in:
Paul Lietar
2013-10-22 10:44:00 +11:00
committed by James Laird
parent ce77feecef
commit 2a515a9b23
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+11
View File
@@ -24,6 +24,8 @@ Debian/Raspbian users can get the basics with
Runtime Requirements
--------------------
You must be running an mDNS (Bonjour) daemon. On a Mac, this will be running already. Otherwise, you must be running avahi-daemon or Howl.
As an alternative, you may use the tinysvcmdns backend, which embeds a lightweight mDNS daemon. It is, however, way less robust than bonjour or avahi.
Check the [mDNS Backends] section for more information.
How to get started
-------------
@@ -44,6 +46,15 @@ Note that options are supplied to backends at the end of the commandline, separa
shairport -o ao -- -d mydriver -o setting=thing
```
mDNS Backends
-------------
Shairport uses mDNS to advertize the service. Multiple backends are available to perform the task.
For a list of available backends, run `shairport -h`.
The backends prefixed by 'external' rely on external programs that should be present in your path.
By default, shairport will try all backends, in the order they are listed by `shairport -h`, until one works.
You can force the use of a specific backend using `shairport -m tinysvcmdns` for example.
Thanks
------
Big thanks to David Hammerton for releasing an ALAC decoder, which is reproduced here in full.