]> git.ipfire.org Git - thirdparty/shairport-sync.git/commitdiff
Update FREEBSD.md
authorMike Brady <mikebrady@eircom.net>
Sun, 16 Apr 2017 17:00:25 +0000 (18:00 +0100)
committerGitHub <noreply@github.com>
Sun, 16 Apr 2017 17:00:25 +0000 (18:00 +0100)
FREEBSD.md

index 286cad089260165cf0ed78acbe47eb8ba75de8a0..037f804ed345347f998b30017d3e4c91fde46c41 100644 (file)
@@ -1,7 +1,13 @@
-This is a very quick initial note about installing Shairport Sync on FreeBSD. Some manual installation is required. Please see important notes at the end about using the `sndio` back end.
+Introduction
+----
+This is a very quick initial note about installing Shairport Sync on FreeBSD. Some manual installation is required.
+
+Please see important notes at the end about using the `sndio` back end -- some workarounds are needed for the present.
 
 The build instrctions here install back ends of `sndio` (native to OpenBSD) and ALSA. ALSA is, or course, the Advanced Linux Sound Architecture, so it is not "native" to FreeBSD. It has, however, been ported, so it should work pretty well.
 
+General
+----
 This build was done on a default build of `FreeBSD 11.0-RELEASE-p9`.
 
 First, update everything:
@@ -16,6 +22,8 @@ Next, install the `pkg` package manager and update its lists:
 # pkg update
 ```
 
+Subsystems
+----
 Now, install the ALSA and Avahi subsystems. Note: `avahi-app` is chosen because it doesn’t require X11 and `nss_mdns` allows FreeBSD
 to resolve mDNS-originated addresses. Thanks to [reidransom](https://gist.github.com/reidransom/6033227) for this:
 
@@ -33,6 +41,9 @@ hosts: files dns mdns
 ```
 Reboot for these changes to take effect.
 
+Building
+----
+
 Next, install the packages that are needed for Shairport Sync to be downloaded and build successfully:
 ```
 # pkg install git autotools pkgconf popt libconfig openssl sndio
@@ -52,19 +63,16 @@ $ CPPFLAGS="-I/usr/local/include" ./configure  --with-alsa --with-avahi --with-s
 $ make
 ```
 
+What's Next
+----
 After this, you're on your own – the `$ sudo make install` step does not work for FreeBSD. Maybe some day...
 
 To continue, you should create a configuration file at `/usr/local/etc/shairport-sync.conf`. Please see the sample configuration file for more details.
 
-Note, the `mixer` command is useful for setting the output device's overall volume settings. With the default settings for the `sndio` back end, the `pcm` mixer controls its maximum output:
-
-```
-$ mixer vol 100 # sets overall volume
-$ mixer pcm 100 # sets maximum volume level for the default sndio device used by Shairport Sync
-```
+Using the `sndio` backend
+----
 
-Using the `sndio` back end.
-The `sndio` back end does synchronisation, using informatin supplied by the `sndio` subsystem. The format of the information is not the same as that coming from the ALSA subsystem, so Shairport Sync cannot yet use it properly. As a workaround, use the following settings:
+The `sndio` back end does synchronisation, using information from the `sndio` subsystem. The format of the information is not the same as that coming from the ALSA subsystem, so Shairport Sync cannot yet use it properly. As a workaround, please use the following settings:
 
 In the `general` stanza, make the following settings:
 ```
@@ -73,3 +81,11 @@ resync_threshold_in_seconds = 0.0; // ignore a large error in the initial estima
 ```
 Note that there are workarounds -- it is hoped that they won't be necessary for too long.
 
+Setting Overall  Volume
+----
+Note, the `mixer` command is useful for setting the output device's overall volume settings. With the default settings for the `sndio` back end, the `pcm` mixer controls its maximum output:
+
+```
+$ mixer vol 100 # sets overall volume
+$ mixer pcm 100 # sets maximum volume level for the default sndio device used by Shairport Sync
+```