Add man pages for bitwise connectives

Signed-off-by: Mattias Andrée <m@maandree.se>

1 files changed, 82 insertions, 0 deletions

diff --git a/libj2_j2u_nif_j2u.3 b/libj2_j2u_nif_j2u.3
new file mode 100644
index 0000000..cab990a
--- /dev/null
+++ b/libj2_j2u_nif_j2u.3
@@ -0,0 +1,82 @@
+.TH LIBJ2_J2U_NIF_J2U 3 LIBJ2
+.SH NAME
+libj2_j2u_nif_j2u \- Calculate bitwise NIF
+
+.SH SYNOPSIS
+.nf
+#include <libj2.h>
+
+void \fBlibj2_j2u_nif_j2u\fP(struct libj2_j2u *\fIa\fP, const struct libj2_j2u *\fIb\fP);
+void \fBlibj2_j2u_nif_j2u_to_j2u\fP(const struct libj2_j2u *\fIa\fP, const struct libj2_j2u *\fIb\fP, struct libj2_j2u *\fIr\fP);
+void \fBlibj2_j2u_nif_ju\fP(struct libj2_j2u *\fIa\fP, uintmax_t \fIb\fP);
+void \fBlibj2_j2u_nif_ju_to_j2u\fP(const struct libj2_j2u *\fIa\fP, uintmax_t \fIb\fP, struct libj2_j2u *\fIr\fP);
+void \fBlibj2_ju_nif_j2u_to_j2u\fP(uintmax_t \fIa\fP, const struct libj2_j2u *\fIb\fP, struct libj2_j2u *\fIr\fP);
+void \fBlibj2_j2u_nif_bit\fP(struct libj2_j2u *\fIa\fP, unsigned \fIb\fP);\fP
+void \fBlibj2_j2u_nif_bit_to_j2u\fP(const struct libj2_j2u *\fIa, unsigned \fIb, struct libj2_j2u *\fIr\fP);\fP
+.fi
+.PP
+Link with
+.IR -lj2 .
+
+.SH DESCRIPTION
+The above listed functions
+calculate the bitwise NIF of
+.I a
+and
+.IR b ;
+for the functions where one of the
+parameter uses a narrower, that
+argument is extended with cleared
+bits above it's most significant
+bit; except that for the functions
+.BR libj2_j2u_nif_bit ()
+and
+.BR libj2_j2u_nif_bit_to_j2u ()
+the argument
+.I b
+is replaced with an argument with
+all bits cleared, except the
+.IR b th
+bit (counting from 0 at the least
+significant bit) which is set.
+The result is written to
+.IR r ,
+or if the function doesn't not the
+.I r
+parameter, to
+.IR a .
+.PP
+The arguments are assumed to be
+.RI non- NULL .
+
+.SH RETURN VALUE
+None.
+
+.SH ERRORS
+The above listed functions cannot fail.
+
+.SH HISTORY
+The
+.BR libj2_j2u_nif_j2u (),
+.BR libj2_j2u_nif_j2u_to_j2u (),
+.BR libj2_j2u_nif_ju (),
+.BR libj2_j2u_nif_ju_to_j2u (),
+.BR libj2_ju_nif_j2u_to_j2u (),
+.BR libj2_j2u_nif_bit (),
+and
+.BR libj2_j2u_nif_bit_to_j2u ()
+functions were added in version 1.0 of
+.BR libj2 .
+
+.SH SEE ALSO
+.BR libj2 (7),
+.BR libj2_j2u_and_j2u (3),
+.BR libj2_j2u_or_j2u (3),
+.BR libj2_j2u_xor_j2u (3),
+.BR libj2_j2u_if_j2u (3),
+.BR libj2_j2u_imply_j2u (3),
+.BR libj2_j2u_nand_j2u (3),
+.BR libj2_j2u_nor_j2u (3),
+.BR libj2_j2u_xnor_j2u (3),
+.BR libj2_j2u_nimply_j2u (3),
+.BR libj2_not_j2u (3)