aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2023-04-10 13:53:04 +0200
committerMattias Andrée <maandree@kth.se>2023-04-10 13:53:04 +0200
commit383113f073e3efe37916daa81e73ebc99bf0de59 (patch)
treefc30e408c5e06a5f24dcf48e9890549c89763ac8
parentAdd doc links (diff)
downloadlibaxl-383113f073e3efe37916daa81e73ebc99bf0de59.tar.gz
libaxl-383113f073e3efe37916daa81e73ebc99bf0de59.tar.bz2
libaxl-383113f073e3efe37916daa81e73ebc99bf0de59.tar.xz
Add man page: LIBAXL_REQUEST_NO_OPERATION.3
Signed-off-by: Mattias Andrée <maandree@kth.se>
-rw-r--r--man3/LIBAXL_REQUEST_NO_OPERATION.346
1 files changed, 46 insertions, 0 deletions
diff --git a/man3/LIBAXL_REQUEST_NO_OPERATION.3 b/man3/LIBAXL_REQUEST_NO_OPERATION.3
new file mode 100644
index 0000000..4896859
--- /dev/null
+++ b/man3/LIBAXL_REQUEST_NO_OPERATION.3
@@ -0,0 +1,46 @@
+.TH LIBAXL_REQUEST_NO_OPERATION 3 libaxl
+.SH NAME
+LIBAXL_REQUEST_NO_OPERATION - Do nothing
+.SH SYNOPSIS
+.nf
+#include <libaxl.h>
+
+#define LIBAXL_REQUEST_NO_OPERATION 127
+struct libaxl_request_no_operation {
+ uint8_t \fIopcode\fP;
+ uint8_t \fI__pad\fP;
+ uint16_t \fIrequest_length\fP;
+};
+.fi
+.SH DESCRIPTION
+The display server shall consume but ignore the
+request. The display server shall not generate
+any request or any response or take any action.
+.PP
+This request is not generally useful.
+.PP
+The value of the
+.I opcode
+field shall be
+.I LIBAXL_REQUEST_NO_OPERATION
+to signify that the request is of the request
+described in this document.
+.PP
+The value of the
+.I request_length
+field shall be set to any positive value. The
+sent message will be this number times 4 bytes
+in size. The minimum value of this field is
+useful where the client finds it convient to
+add padding to force requests to begin on
+64-bit boundaries.
+.PP
+Other fields are filled in automatically by the
+.BR libaxl_send_request (3)
+function.
+.SH ERRORS
+None.
+.SH REPLIES
+None.
+.SH SEE ALSO
+.BR libaxl_send_request (3)