]> git.ipfire.org Git - thirdparty/shairport-sync.git/commitdiff
Add information about --logOutputLevel
authorMike Brady <mikebrady@eircom.net>
Fri, 7 Apr 2017 19:31:12 +0000 (20:31 +0100)
committerMike Brady <mikebrady@eircom.net>
Fri, 7 Apr 2017 19:31:12 +0000 (20:31 +0100)
man/shairport-sync.7
man/shairport-sync.7.xml
man/shairport-sync.html

index c616ed6830b6352c64dd3580d0d3b9543dffcd2b..1b460331275233947ccb5671fd9312f314723e59 100644 (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 [-c \fB\fIconfigurationfile\fB]\fB [-E \fB\fIcommand\fB]\fB [--get-cover-art]\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 [-dvw]\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
 
@@ -301,6 +301,9 @@ Print brief help message and exit.
 \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--logOutputLevel\f1
+Use this to log the volume level when the volume is changed. It may be useful if you are trying to determine a suitable value for the maximum volume level. Not available as a configuration file setting. 
+.TP
 \fB-L | --latency=\f1\fIlatency\f1
 Use this to set the \fIdefault latency\f1, in frames, for audio coming from an unidentified source or from an iTunes Version 9 or earlier source. The standard value for the \fIdefault latency\f1 is 88,200 frames, where there are 44,100 frames to the second. 
 
index ef7bbebc05db2dfd4000c50fd7a5bbf0c5a90dc8..89cfcfbcc0177da0f3b9232fed3475594bec550e 100644 (file)
@@ -42,6 +42,7 @@
       <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>[-L </opt><arg>latency</arg><opt>]</opt>
       <opt>[-m </opt><arg>backend</arg><opt>]</opt>
       <opt>[--meta-dir=</opt><arg>directory</arg><opt>]</opt>
     
     <option>
     <p><opt>volume_max_db=</opt><arg>dBvalue</arg><opt>;</opt></p>
-    <optdesc><p>Specify the maximum output level to be used with the hardware mixer, if used. If no hardware mixed is used, this setting specifies the maximum setting permissible in the software mixer, which has an attenuation of from 0.0 dB down to -96.3 dB.</p>
+    <optdesc><p>Specify the maximum output level to be used with the hardware mixer, if used. If no hardware mixed is used, this setting speciies the maximum setting permissible in the software mixer, which has an attenuation of from 0.0 dB down to -96.3 dB.</p>
     </optdesc>
     </option>
     
     
     <option>
     <p><opt>interface=</opt><arg>"name"</arg><opt>;</opt></p>
-    <optdesc>Use this advanced setting if you want to confine Shairport Sync to the named interface. Leave it commented out to get the default behaviour.</optdesc>
+    <optdesc>Use this advanced setting if you want to confine Shairport Sync to the named interface. Leave it commented out to get the default bahaviour.</optdesc>
     </option>
     
     <option>
 
     <option>
     <p><opt>output_format=</opt><arg>"format"</arg><opt>;</opt></p>
-    <optdesc>Use this setting to specify the format that should be used to send data to the ALSA device. 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. "S" means signed; "U" means unsigned; BE means big-endian and LE means little-endian. Except where stated (using *LE or *BE), endianness matches that of the processor. The default is "S16". If you are using a hardware mixer, the best setting is S16, as audio will pass through Shairport Sync unmodified except for interpolation. If you are using the software mixer, use 32- or 24-bit, if your device is capable of it, to get the lowest possible levels of dither.
+    <optdesc>Use this setting to specify the format that should be used to send data to the ALSA device. 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. "S" means signed; "U" means unsigned; BE means big-endian and LE means little-endian. Except where stated (using *LE or *BE), endianness matches that of the processor. The default is "S16". If you are using a hardware mixer, the best setting is S16, as audio will pass through Shairport Sync unmodifed except for interpolation. If you are using the software mixer, use 32- or 24-bit, if your device is capable of it, to get the lowest possible levels of dither.
     </optdesc>
     </option>
 
                </p></optdesc>
          </option>
 
+         <option>
+               <p><opt>--logOutputLevel</opt></p>
+               <optdesc><p>
+               Use this to log the volume level when the volume is changed. It may be useful if you are trying to
+               determine a suitable value for the maximum volume level. Not available as a configuration file setting.
+    </p>
+    </optdesc>
+         </option>
+
          <option>
                <p><opt>-L | --latency=</opt><arg>latency</arg></p>
                <optdesc><p>
index 5c1455f71c1740615da9e349b3c40d4368d763a8..b1c543fb0320cfed298daaa38c370090d8a0335d 100644 (file)
@@ -13,6 +13,7 @@
       <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>[-L </b><em>latency</em><b>]</b>
       <b>[-m </b><em>backend</em><b>]</b>
       <b>[--meta-dir=</b><em>directory</em><b>]</b>
          
 
          
+               <p><b>--logOutputLevel</b></p>
+               <p>
+               Use this to log the volume level when the volume is changed. It may be useful if you are trying to
+               determine a suitable value for the maximum volume level. Not available as a configuration file setting.
+    </p>
+    
+         
+
+         
                <p><b>-L | --latency=</b><em>latency</em></p>
                <p>
                Use this to set the <em>default latency</em>, in frames, for audio coming from an unidentified source or from an iTunes Version 9 or earlier source. The standard value for the <em>default latency</em> is 88,200 frames, where there are 44,100