aboutsummaryrefslogtreecommitdiffstats
path: root/libj2_kfs_j2u.3
diff options
context:
space:
mode:
authorMattias Andrée <m@maandree.se>2025-12-27 20:44:22 +0100
committerMattias Andrée <m@maandree.se>2025-12-27 20:44:22 +0100
commit56b19a09fda414876e310d086636c8e618871219 (patch)
treed1858ddf3712e2dcd4a0bf3aae8a4669e598ea11 /libj2_kfs_j2u.3
parentTesting (diff)
downloadlibj2-56b19a09fda414876e310d086636c8e618871219.tar.gz
libj2-56b19a09fda414876e310d086636c8e618871219.tar.bz2
libj2-56b19a09fda414876e310d086636c8e618871219.tar.xz
Add some man pagesHEADmaster
Signed-off-by: Mattias Andrée <m@maandree.se>
Diffstat (limited to 'libj2_kfs_j2u.3')
-rw-r--r--libj2_kfs_j2u.352
1 files changed, 52 insertions, 0 deletions
diff --git a/libj2_kfs_j2u.3 b/libj2_kfs_j2u.3
new file mode 100644
index 0000000..de3841a
--- /dev/null
+++ b/libj2_kfs_j2u.3
@@ -0,0 +1,52 @@
+.TH LIBJ2_KFS_J2U 3 LIBJ2
+.SH NAME
+libj2_kfs_j2u \- Keep first set bit, clear the rest
+
+.SH SYNOPSIS
+.nf
+#include <libj2.h>
+
+void \fBlibj2_kfs_j2u\fP(struct libj2_j2u *\fIa\fP);
+void \fBlibj2_kfs_j2u_to_j2u\fP(const struct libj2_j2u *\fIa\fP, struct libj2_j2u *\fIr\fP);
+.fi
+.PP
+Link with
+.IR -lj2 .
+
+.SH DESCRIPTION
+The
+.BR libj2_kfs_j2u ()
+function clears all bits in
+.I a
+except the first (least significant)
+set bit (no modification if all bits
+are cleared).
+.PP
+The
+.BR libj2_kfs_j2u_to_j2u ()
+function performs the same action as
+.BR libj2_kfs_j2u ()
+but instead of modifying
+.IR a ,
+the result is stored in
+.IR r .
+.PP
+The arguments are assumed to be
+.RI non- NULL .
+
+.SH RETURN VALUE
+None.
+
+.SH ERRORS
+The
+.BR libj2_kfs_j2u ()
+and
+.BR libj2_kfs_j2u_to_j2u ()
+functions cannot fail.
+
+.SH SEE ALSO
+.BR libj2 (7),
+.BR libj2_kls_j2u (3),
+.BR libj2_ffs_j2u (3),
+.BR libj2_cfs_j2u (3),
+.BR libj2_sfc_j2u (3)