summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKevin Lyda <kevin@ie.suberic.net>2019-04-08 09:00:09 +0100
committerKevin Lyda <kevin@ie.suberic.net>2019-04-08 09:00:09 +0100
commit2c0ba1ba92fdf393f30ffab0667cf507ecae09b0 (patch)
tree89472b0e98a855d73ad6800a4ce44c43da5399ff
parentf253c28fccbd395f5f5063d60bd81179dda76d4f (diff)
Clarify how volume works
It was noted in https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=62763 that the man page doesn't really clarify how the volume flag/xresource works. This is an attempt to address this situation and let this long standing bug finally go silent.
-rw-r--r--man/xbiff.man8
1 files changed, 7 insertions, 1 deletions
diff --git a/man/xbiff.man b/man/xbiff.man
index 446a47f..739b362 100644
--- a/man/xbiff.man
+++ b/man/xbiff.man
@@ -68,7 +68,11 @@ is your login name). If the MAIL environment variable is set,
the file specified by it will be monitored.
.TP 8
.B \-volume \fIpercentage\fP
-This option specifies how loud the bell should be rung when new mail comes in.
+This option specifies how loud the bell should be rung when new mail
+comes in. The percentage is relative to the current volume in \fIxset\fP.
+So 0 is normal volume, negative percentages are towards minimum (-100
+is silent), and positive percentages are towards maximum volume (100
+is loudest).
.TP 8
.B \-shape
This option indicates that the mailbox window should be shaped if masks for
@@ -145,6 +149,8 @@ The default is 30.
.TP 8
.B volume (\fPclass\fB Volume)
Specifies how loud the bell should be rung. The default is 33 percent.
+Note that this is a percentage of the current \fIxset\fP volume.
+To reduce the volume, specify a negative percentage.
.TP 8
.B foreground (\fPclass\fB Foreground)
Specifies the color for the foreground.