aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/audit/docs/auparse_reset.3
diff options
context:
space:
mode:
Diffstat (limited to 'framework/src/audit/docs/auparse_reset.3')
-rw-r--r--framework/src/audit/docs/auparse_reset.323
1 files changed, 23 insertions, 0 deletions
diff --git a/framework/src/audit/docs/auparse_reset.3 b/framework/src/audit/docs/auparse_reset.3
new file mode 100644
index 00000000..943fb962
--- /dev/null
+++ b/framework/src/audit/docs/auparse_reset.3
@@ -0,0 +1,23 @@
+.TH "AUPARSE_RESET" "3" "Sep 2014" "Red Hat" "Linux Audit API"
+.SH NAME
+auparse_reset \- reset audit parser instance
+.SH "SYNOPSIS"
+.B #include <auparse.h>
+.sp
+int auparse_reset(auparse_state_t *au);
+
+.SH "DESCRIPTION"
+
+auparse_reset resets all internal cursors to the beginning. It closes files, descriptors, and frees memory buffers.
+
+.SH "RETURN VALUE"
+
+Returns \-1 if an error occurs; otherwise, 0 for success.
+
+.SH "SEE ALSO"
+
+.BR auparse_init (3),
+.BR auparse_destroy (3).
+
+.SH AUTHOR
+Steve Grubb