From f679f5b7a264150399cef925fb2d5d0e5f6384c0 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Mon, 10 Apr 2023 14:31:49 +0200 Subject: Add man page: LIBAXL_REQUEST_BELL.3 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- man3/LIBAXL_REQUEST_BELL.3 | 53 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 man3/LIBAXL_REQUEST_BELL.3 diff --git a/man3/LIBAXL_REQUEST_BELL.3 b/man3/LIBAXL_REQUEST_BELL.3 new file mode 100644 index 0000000..f3c974c --- /dev/null +++ b/man3/LIBAXL_REQUEST_BELL.3 @@ -0,0 +1,53 @@ +.TH LIBAXL_REQUEST_BELL 3 libaxl +.SH NAME +LIBAXL_REQUEST_BELL - Ring the keyboard bell +.SH SYNOPSIS +.nf +#include + +#define LIBAXL_REQUEST_BELL 49 +struct libaxl_request_bell { + uint8_t \fIopcode\fP; + uint8_t \fIpercent\fP; + uint16_t \fI_request_length\fP; +}; +.fi +.SH DESCRIPTION +The display server shall ring the bell +on the keyboard, at a volume relative to +the base volume for the keyboard, if possible. +.PP +The value of the +.I percent +field shall be set to a value within [-100, 100], +where -100 maps to a volume of 0, 0 maps to the +base volume, and 100 maps to 100%. Other values +are interpreted via piece-wise linear interpolation. +.PP +Other fields are filled in automatically by the +.BR libaxl_send_request (3) +function. +.SH EXTENDED DESCRIPTION +The volume at which the bell is rung is +.I (base - (base * percent) / 100 + percent) +when +.I percent +is nonnegative and +.I (base + (base * percent) / 100) +when +.I percent +is negative; +where +.I base +is the base volume for the keyboard. +.SH ERRORS +.TP +.B LIBAXL_ERROR_VALUE (3) +.I percent +is less than -100 or greater than 100. +.SH REPLIES +None. +.SH SEE ALSO +.BR libaxl_send_request (3), +.BR LIBAXL_REQUEST_CHANGE_KEYBOARD_CONTROL (3), +.BR LIBAXL_REQUEST_GET_KEYBOARD_CONTROL (3) -- cgit v1.2.3-70-g09d2