aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README48
1 files changed, 48 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..95bf2d7
--- /dev/null
+++ b/README
@@ -0,0 +1,48 @@
+NAME
+ libabort - String functions that abort when getting out of bounds
+
+SYNOPSIS
+ #include <libabort.h>
+
+ Link with -labort.
+
+DESCRIPTION
+ libabort provides string functions that call abort(3) rather than
+ silently truncating or read or write out of bounds.
+
+ Each function is namespaced with the prefix libabort_, and shorthand
+ names are available without this prefix, however defining
+ LIBABORT_NO_SHORTHANDS before including <libabort.h> will cause these
+ shorthands not to be defined.
+
+ The following functions are provided:
+
+ libabort_stracpy(3)
+ Copy a NUL terminated string into a fixed-size buffer.
+ Returns the written string.
+
+ libabort_stpacpy(3)
+ Copy a NUL terminated string into a fixed-size buffer.
+ Returns the end of the written string.
+
+ libabort_stracat(3)
+ Append a NUL terminated string to a NUL terminated string within
+ a fixed-size buffer. Returns the augmented string.
+
+ libabort_stpacat(3)
+ Append a NUL terminated string to a NUL terminated string within
+ a fixed-size buffer. Returns the end of the augmented string.
+
+ libabort_stralen(3)
+ Compute the length of string that is expected to be NUL
+ terminated.
+
+ libabort_saprintf(3)
+ Format a string into a fixed-size buffer.
+
+ libabort_vsaprintf(3)
+ Format a string into a fixed-size buffer using a va_list
+ argument list.
+
+SEE ALSO
+ None.