Add and fix man pages

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

1 files changed, 186 insertions, 0 deletions

diff --git a/man/libsimple_aligned_allocz.3 b/man/libsimple_aligned_allocz.3
new file mode 100644
index 0000000..dc3bc44
--- /dev/null
+++ b/man/libsimple_aligned_allocz.3
@@ -0,0 +1,186 @@
+.TH LIBSIMPLE_ALIGNED_ALLOCZ 3 2018-11-03 libsimple
+.SH NAME
+libsimple_aligned_allocz \- allocate optionally initialised memory with custom alignment
+.SH SYNOPSIS
+.nf
+#include <libsimple.h>
+
+static inline void *libsimple_aligned_allocz(int \fIclear\fP, size_t \fIalignment\fP, size_t \fIn\fP);
+void *libsimple_enaligned_allocz(int \fIstatus\fP, int \fIclear\fP, size_t \fIalignment\fP, size_t \fIn\fP);
+static inline void *libsimple_ealigned_allocz(int \fIclear\fP, size_t \fIalignment\fP, size_t \fIn\fP);
+
+#ifndef aligned_allocz
+# define aligned_allocz libsimple_aligned_allocz
+#endif
+#ifndef enaligned_allocz
+# define enaligned_allocz libsimple_enaligned_allocz
+#endif
+#ifndef ealigned_allocz
+# define ealigned_allocz libsimple_ealigned_allocz
+#endif
+.fi
+.PP
+Link with
+.IR \-lsimple .
+.SH DESCRIPTION
+The
+.BR libsimple_aligned_allocz (),
+.BR libsimple_enaligned_allocz (),
+and
+.BR libsimple_ealigned_allocz ()
+functions allocate
+.I n
+bytes to the heap and return a pointer with an
+alignment of
+.I alignment
+bytes to the allocated memory. The memory will be
+initialised with zeroes if
+.I clear
+is a non-zero value. The function
+.BR free (3)
+shall be called with the returned pointer as
+input when the allocated memory is no longer needed.
+.PP
+The
+.BR libsimple_enaligned_allocz ()
+and
+.BR libsimple_ealigned_allocz ()
+functions will terminate the process if the memory
+cannot be allocated of if the user tries to allocate
+0 bytes, by calling the
+.BR libsimple_enprintf ()
+and
+.BR libsimple_eprintf ()
+functions, respectively.
+On failure, the process's exit value will be
+.I status
+if the
+.BR libsimple_enaligned_allocz ()
+function is used or
+.IR libsimple_default_failure_exit (3)
+if the
+.BR libsimple_ealigned_allocz ()
+function is used.
+.PP
+The
+.BR libsimple_enaligned_allocz ()
+and
+.BR libsimple_ealigned_allocz ()
+functions behaviour is unspecified if
+.I n
+is 0.
+.SH RETURN VALUE
+The
+.BR libsimple_aligned_allocz (),
+.BR libsimple_enaligned_allocz (),
+and
+.BR libsimple_ealigned_allocz ()
+functions return a pointer to the allocated memory
+upon success completion; otherwise the
+.BR libsimple_aligned_allocz ()
+function return
+.B NULL
+and set
+.I errno
+it indicate the error, and the
+.BR libsimple_enaligned_allocz ()
+and
+.BR libsimple_ealigned_allocz ()
+functions terminated the process.
+.SH ERRORS
+The
+.BR libsimple_aligned_allocz ()
+function will fail if:
+.TP
+.B EINVAL
+.I n
+is 0.
+.TP
+.B EINVAL
+.I n
+is not a multiple of
+.IR alignment .
+.TP
+.B EINVAL
+.I alignment
+is not a power of two.
+.TP
+.B ENOMEM
+Enough memory could not be allocated.
+.PP
+The
+.BR libsimple_enaligned_allocz ()
+and
+.BR libsimple_ealigned_allocz ()
+functions will terminate the process on failure.
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lb lb lb
+l l l.
+Interface	Attribute	Value
+T{
+.BR libsimple_aligned_allocz (),
+.br
+.BR libsimple_enaligned_allocz (),
+.br
+.BR libsimple_ealigned_allocz ()
+T}	Thread safety	MT-Safe
+T{
+.BR libsimple_aligned_allocz (),
+.br
+.BR libsimple_enaligned_allocz (),
+.br
+.BR libsimple_ealigned_allocz ()
+T}	Async-signal safety	AS-Safe
+T{
+.BR libsimple_aligned_allocz (),
+.br
+.BR libsimple_enaligned_allocz (),
+.br
+.BR libsimple_ealigned_allocz ()
+T}	Async-cancel safety	AC-Safe
+.TE
+.SH EXAMPLES
+None.
+.SH APPLICATION USAGE
+None.
+.SH RATIONALE
+None.
+.SH FUTURE DIRECTIONS
+None.
+.SH NOTES
+None.
+.SH BUGS
+None.
+.SH SEE ALSO
+.BR libsimple_enmalloc (3),
+.BR libsimple_mallocz (3),
+.BR libsimple_vmallocn (3),
+.BR libsimple_vmalloczn (3),
+.BR libsimple_encalloc (3),
+.BR libsimple_vcallocn (3),
+.BR libsimple_enrealloc (3),
+.BR libsimple_vreallocn (3),
+.BR libsimple_memalign (3),
+.BR libsimple_memalignz (3),
+.BR libsimple_vmemalignn (3),
+.BR libsimple_vmemalignzn (3),
+.BR libsimple_enposix_memalign (3),
+.BR libsimple_posix_memalignz (3),
+.BR libsimple_vposix_memalignn (3),
+.BR libsimple_vposix_memalignzn (3),
+.BR libsimple_enaligned_alloc (3),
+.BR libsimple_valigned_allocn (3),
+.BR libsimple_valigned_alloczn (3),
+.BR libsimple_pvalloc (3),
+.BR libsimple_pvallocz (3),
+.BR libsimple_vpvallocn (3),
+.BR libsimple_vpvalloczn (3),
+.BR libsimple_valloc (3),
+.BR libsimple_vallocz (3),
+.BR libsimple_vvallocn (3),
+.BR libsimple_vvalloczn (3),
+.BR aligned_alloc (3)