Add more documentation about the amplification value.

[paraslash.git] / afs.cmd

diff --git a/afs.cmd b/afs.cmd
index 3f44873e444d7036f7b12b42fe4127420786cd71..5c9f1ecb5c78cd01a8dbcf86b7adc5cd4e6449d5 100644 (file)
--- a/afs.cmd
+++ b/afs.cmd
@@ -180,7 +180,7 @@ H:  a slash (see fnmatch(3)).
 N: touch
 P: AFS_READ | AFS_WRITE
 D: Manipulate the afs data for all audio files matching a pattern.
 N: touch
 P: AFS_READ | AFS_WRITE
 D: Manipulate the afs data for all audio files matching a pattern.

-U: touch [-n numplayed] [-l lastplayed] [-y lyrics_id] [-i image_id] [-v] [-p] pattern
+U: touch [-n numplayed] [-l lastplayed] [-y lyrics_id] [-i image_id] [-a amp] [-v] [-p] pattern

 H: If no option is given, lastplayed is set to the current time
 H: and numplayed is increased by one. Otherwise, only the given
 H: options are taken into account.
 H: If no option is given, lastplayed is set to the current time
 H: and numplayed is increased by one. Otherwise, only the given
 H: options are taken into account.


@@ -202,6 +202,14 @@ H:         this audio file.
 H:
 H: -i  Set the image id. Same as -y, but sets the image.
 H:
 H:
 H: -i  Set the image id. Same as -y, but sets the image.
 H:

+H: -a  Set the amplification value (0-255). This determines a scaling
+H:     factor by which the amplitude should be multiplied in order to
+H:     normalize the volume of the audio file.  A value of zero means
+H:     no amplification, 64 means the amplitude should be multiplied
+H:     by a factor of two, 128 by three and so on.
+H:
+H:     This value is used by the compress filter.
+H:

 H: -v  Verbose mode. Explain what is being done.
 H:
 H: -p  Pathname match. Match a slash in the path only with a slash
 H: -v  Verbose mode. Explain what is being done.
 H:
 H: -p  Pathname match. Match a slash in the path only with a slash