aboutsummaryrefslogtreecommitdiffstats
path: root/man/libsimple_enstrdup.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2018-11-07 22:18:04 +0100
committerMattias Andrée <maandree@kth.se>2018-11-07 22:18:04 +0100
commit9fc2b129167e1f2a16d942369f057f618a00d81c (patch)
treec15d15d8afc525a423ce0d43d95f676e6e5a2541 /man/libsimple_enstrdup.3
parentAdd arrayalloc man page (diff)
downloadlibsimple-9fc2b129167e1f2a16d942369f057f618a00d81c.tar.gz
libsimple-9fc2b129167e1f2a16d942369f057f618a00d81c.tar.bz2
libsimple-9fc2b129167e1f2a16d942369f057f618a00d81c.tar.xz
Move section 3 man pages to man3/ and add libsimple.h.0
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'man/libsimple_enstrdup.3')
-rw-r--r--man/libsimple_enstrdup.3120
1 files changed, 0 insertions, 120 deletions
diff --git a/man/libsimple_enstrdup.3 b/man/libsimple_enstrdup.3
deleted file mode 100644
index 4a2aa4f..0000000
--- a/man/libsimple_enstrdup.3
+++ /dev/null
@@ -1,120 +0,0 @@
-.TH LIBSIMPLE_ENSTRDUP 3 2018-10-27 libsimple
-.SH NAME
-libsimple_enstrdup, libsimple_strdupa \- duplicate a string
-.SH SYNOPSIS
-.nf
-#include <libsimple.h>
-
-char *libsimple_strdupa(const char *\fIs\fP);
-char *libsimple_enstrdup(int \fIstatus\fP, const char *\fIs\fP);
-static inline char *libsimple_estrdup(const char *\fIs\fP);
-
-#ifndef strdupa
-# define strdupa libsimple_strdupa
-#endif
-#ifndef enstrdup
-# define enstrdup libsimple_enstrdup
-#endif
-#ifndef estrdup
-# define estrdup libsimple_estrdup
-#endif
-.fi
-.PP
-Link with
-.IR \-lsimple .
-.SH DESCRIPTION
-The
-.BR libsimple_enstrdup ()
-and
-.BR libsimple_estrdup ()
-functions are versions of the
-.BR strdup (3)
-function that call the
-.BR libsimple_enprintf (3)
-function on failure, causing the process to print
-an error message and exit. See
-.BR libsimple_enprintf (3)
-for more information.
-.PP
-The
-.BR libsimple_strdupa ()
-function is implemented as a macro and is a version
-of the
-.BR strdup (3)
-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_strdupa (),
-.BR libsimple_enstrdup (),
-and
-.BR libsimple_estrdup ()
-functions return a non-null pointer, on failure the
-.BR libsimple_enstrdup (),
-and
-.BR libsimple_estrdup ()
-functions exit the process. The
-.BR libsimple_strdupa ()
-function cannot fail, however the kernel
-can kill the thread, and possibly the process, with a
-.B SIGSEGV
-signal if the memory cannot be allocated.
-.PP
-The returned pointer should be deallocated when it
-is no longer needed, except for the pointer returned
-by the
-.BR libsimple_strdupa ()
-function, it is automatically deallocated when the
-calling function returns.
-.SH ERRORS
-None.
-.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_strdupa (),
-.br
-.BR libsimple_enstrdup (),
-.br
-.BR libsimple_estrdup (),
-T} Thread safety MT-Safe
-T{
-.BR libsimple_strdupa (),
-.br
-.BR libsimple_enstrdup (),
-.br
-.BR libsimple_estrdup (),
-T} Async-signal safety AS-Safe
-T{
-.BR libsimple_strdupa (),
-.br
-.BR libsimple_enstrdup (),
-.br
-.BR libsimple_estrdup (),
-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_enstrndup (3),
-.BR libsimple_memdup (3),
-.BR libsimple_aligned_memdup (3),
-.BR strndup (3),
-.BR strdup (3)