~arivigo/sline

528b7e9ce349319669a1f05b825b4aa7de43bbf8 — Ariadna Vigo 6 months ago 3a198dc
man/: fixing formatting
6 files changed, 13 insertions(+), 0 deletions(-)

M man/sline.3
M man/sline_end.3
M man/sline_errmsg.3
M man/sline_set_prompt.3
M man/sline_setup.3
M man/sline_version.3
M man/sline.3 => man/sline.3 +3 -0
@@ 63,6 63,7 @@ At exit, it is highly advisable to call
to restore the terminal state 
and free all used memory. 
.SH RETURN VALUE
.PP
.BR sline ()
returns 0 if no error occurred. 
If an error did occur, 


@@ 86,8 87,10 @@ An unreadable character or escape sequence was found during I/O.
.BR sline_errmsg (3)
may be used to retrieve an error message string to be presented to the user.
.SH SEE ALSO
.PP
.BR sline_errmsg (3), 
.BR sline_end (3), 
.BR sline_history_get (3),
.BR sline_setup (3), 
.BR sline_set_prompt (3),
.BR sline_version (3)

M man/sline_end.3 => man/sline_end.3 +2 -0
@@ 25,9 25,11 @@ making it possible to call
.BR sline_end ()
even when the program exists unexpectedly. 
.SH RETURN VALUE
.PP
.BR sline_end ()
does not return any value.
.SH SEE ALSO
.PP
.BR atexit (3), 
.BR sline (3), 
.BR sline_setup (3)

M man/sline_errmsg.3 => man/sline_errmsg.3 +2 -0
@@ 24,8 24,10 @@ Using
without having checked whether an error has occured 
leads to undefined behavior.
.SH RETURN VALUE
.PP
.BR sline_errmsg ()
always returns a statically allocated constant string. 
.SH SEE ALSO
.PP
.BR sline (3), 
.BR sline_setup (3)

M man/sline_set_prompt.3 => man/sline_set_prompt.3 +2 -0
@@ 22,8 22,10 @@ format string as the
parameter,
followed by the necessary positional arguments.
.SH RETURN VALUE
.PP
.BR sline_set_prompt ()
does not return any values.
.SH SEE ALSO
.PP
.BR printf (3), 
.BR sline (3)

M man/sline_setup.3 => man/sline_setup.3 +2 -0
@@ 36,6 36,7 @@ When command history is disabled,
.BR sline (3) 
will ignore any presses to the Up/Down arrow keys.
.SH RETURN VALUE
.PP
.BR sline_setup ()
returns 0 if no error occurred.
If an error did occur, a value less than 0 is returned 


@@ 62,6 63,7 @@ Terminal attributes could not be set.
.BR sline_errmsg (3)
may be used to retrieve an error message string to be presented to the user.
.SH SEE ALSO
.PP
.BR sline (3), 
.BR sline_errmsg (3), 
.BR sline_end (3)

M man/sline_version.3 => man/sline_version.3 +2 -0
@@ 13,7 13,9 @@ sline_version \- Report version of sline
reports the version of sline as a string,
as defined at compile-time.
.SH RETURN VALUE
.PP
.BR sline_version ()
always returns a statically allocated constant string. 
.SH SEE ALSO
.PP
.BR sline (3)