From 57bfbe4a09a898f11da686646164d3fdf3875123 Mon Sep 17 00:00:00 2001
From: Mattias Andrée <maandree@kth.se>
Date: Sat, 13 Apr 2019 20:41:54 +0200
Subject: And man pages for the function, and add print function to user
 specifiec error details
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Mattias Andrée <maandree@kth.se>
---
 liberror_print_error.3 | 90 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 90 insertions(+)
 create mode 100644 liberror_print_error.3

(limited to 'liberror_print_error.3')

diff --git a/liberror_print_error.3 b/liberror_print_error.3
new file mode 100644
index 0000000..a069835
--- /dev/null
+++ b/liberror_print_error.3
@@ -0,0 +1,90 @@
+.TH LIBERROR_PRINT_ERROR 3 2019-04-13 liberror
+.SH NAME
+liberror_print_error \- print an error
+.SH SYNOPSIS
+.nf
+#include <liberror.h>
+
+int liberror_print_error(struct liberror_error *\fIerror\fP, FILE *\fIfp\fP, int \fIreset\fP, const char *\fIprefix\fP);
+.fi
+.PP
+Link with
+.IR \-lerror .
+.SH DESCRIPTION
+The
+.BR liberror_print_error ()
+function prints the error, including available details, backtrace,
+and cause recursively, specified in the
+.I error
+parameter, or the error currently assigned to the thread if
+.I error
+is
+.IR NULL ,
+to
+.IR fp ,
+or to the standard error if
+.I fp
+is
+.IR NULL .
+Unless
+.I prefix
+is
+.I NULL
+or the empty string, each printed line will becoming with with
+.I prefix
+followed by a space and a colon. Under normal usage,
+.I prefix
+shall be
+.I argv[0]
+from the
+.BR main ()
+function.
+.PP
+If
+.I reset
+is non-zero,
+.I error
+will be deallocated with the
+.BR liberror_free_error (3)
+function, or if
+.I error
+is
+.IR NULL ,
+with the
+.BR liberror_reset_error (3)
+function, which marks that the thread does not have any error
+assigned to it. Thus, if
+.I error
+is
+.I NULL
+and
+.I reset
+is non-zero, there is no need to call the
+.BR liberror_reset_error (3)
+function.
+.SH RETURN VALUE
+None.
+.SH ERRORS
+.I errno
+will never be changed.
+.SH EXAMPLES
+None.
+.SH APPLICATION USAGE
+None.
+.SH RATIONALE
+None.
+.SH FUTURE DIRECTIONS
+None.
+.SH NOTES
+None.
+.SH SEE ALSO
+.BR liberror (7),
+.BR liberror.h (0),
+.BR liberror_copy_error (3),
+.BR liberror_free_error (3),
+.BR liberror_get_error (3),
+.BR liberror_print_bactrace (3),
+.BR liberror_reset_error (3),
+.BR liberror_save_backtrace (3),
+.BR liberror_set_error (3),
+.BR liberror_set_error_errno (3)
-- 
cgit v1.2.3-70-g09d2