aboutsummaryrefslogtreecommitdiffstats
path: root/man3/libsimple_aligned_strdup.3
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--man3/libsimple_aligned_strdup.314
1 files changed, 13 insertions, 1 deletions
diff --git a/man3/libsimple_aligned_strdup.3 b/man3/libsimple_aligned_strdup.3
index d6c99fb..1570e68 100644
--- a/man3/libsimple_aligned_strdup.3
+++ b/man3/libsimple_aligned_strdup.3
@@ -1,6 +1,7 @@
-.TH LIBSIMPLE_ALIGNED_STRDUP 3 2018-11-27 libsimple
+.TH LIBSIMPLE_ALIGNED_STRDUP 3 libsimple
.SH NAME
libsimple_aligned_strdup, libsimple_aligned_strdupa \- duplicate a string
+
.SH SYNOPSIS
.nf
#include <libsimple.h>
@@ -26,6 +27,7 @@ static inline char *libsimple_ealigned_strdup(const char *\fIs\fP, size_t \fIn\f
.PP
Link with
.IR \-lsimple .
+
.SH DESCRIPTION
The
.BR libsimple_aligned_strdup ()
@@ -58,6 +60,7 @@ function that uses allocates the memory on the stack
rather than on the heap, causing the return pointer
to become invalid when the calling function returns.
It is only available when compling with GCC or Clang.
+
.SH RETURN VALUE
Upon successful completion, the
.BR libsimple_aligned_strdupa (),
@@ -88,12 +91,14 @@ by the
.BR libsimple_aligned_strdupa ()
function, it is automatically deallocated when the
calling function returns.
+
.SH ERRORS
The
.BR libsimple_aligned_strdup ()
function may fail for any reason specified for the
.BR aligned_alloc (3)
function.
+
.SH ATTRIBUTES
For an explanation of the terms used in this section, see
.BR attributes (7).
@@ -130,18 +135,25 @@ T{
.BR libsimple_ealigned_strdup (),
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_aligned_strndup (3),
.BR libsimple_aligned_memdup (3),