summaryrefslogtreecommitdiffstats
path: root/lib/libc/string/strerror.3
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2001-12-12 15:02:32 +0000
committerru <ru@FreeBSD.org>2001-12-12 15:02:32 +0000
commit1af36d20819d289e5321d94eeb0016ca230c2925 (patch)
treee90e5a60730548156a91452450fe2dc71accb439 /lib/libc/string/strerror.3
parent84f883bb74a6a6773a9f49f3ed8100c8bd215223 (diff)
downloadFreeBSD-src-1af36d20819d289e5321d94eeb0016ca230c2925.zip
FreeBSD-src-1af36d20819d289e5321d94eeb0016ca230c2925.tar.gz
mdoc(7) police: minor markup nits.
Diffstat (limited to 'lib/libc/string/strerror.3')
-rw-r--r--lib/libc/string/strerror.340
1 files changed, 20 insertions, 20 deletions
diff --git a/lib/libc/string/strerror.3 b/lib/libc/string/strerror.3
index 2ed92d6..3e75cb1 100644
--- a/lib/libc/string/strerror.3
+++ b/lib/libc/string/strerror.3
@@ -36,7 +36,7 @@
.\" @(#)strerror.3 8.1 (Berkeley) 6/9/93
.\" $FreeBSD$
.\"
-.Dd Nov 26, 2001
+.Dd November 26, 2001
.Dt STRERROR 3
.Os
.Sh NAME
@@ -55,14 +55,14 @@
.Vt extern const char * const sys_errlist[] ;
.Vt extern const int sys_nerr ;
.In string.h
-.Ft char *
+.Ft "char *"
.Fn strerror "int errnum"
.Ft int
-.Fn strerror_r "int errnum" "char * strerrbuf" "size_t buflen"
+.Fn strerror_r "int errnum" "char *strerrbuf" "size_t buflen"
.Sh DESCRIPTION
The
.Fn strerror ,
-.Fn strerror_r
+.Fn strerror_r
and
.Fn perror
functions look up the error message string corresponding to an
@@ -79,7 +79,7 @@ The
.Fn strerror_r
function renders the same result into
.Fa strerrbuf
-for a maximum of
+for a maximum of
.Fa buflen
characters and returns 0 upon success.
.Pp
@@ -99,7 +99,7 @@ and does not point to the null character,
this string is prepended to the message
string and separated from it by
a colon and space
-.Pq Ql \&:\ \& ;
+.Pq Dq Li ":\ " ;
otherwise, only the error message string is printed.
.Pp
If
@@ -108,30 +108,31 @@ is not a recognized error number,
.Fn strerror
returns an error message string containing
.Dq Li "Unknown error:\ "
-followed by the error number in decimal, while
+followed by the error number in decimal, while
.Fn strerror_r
leaves
.Fa strerrbuf
-unchanged and returns
+unchanged and returns
.Er EINVAL .
Error numbers recognized by this implementation fall in
-the range 0 <=
+the range 0 \(<=
.Fa errnum
<
.Fa sys_nerr .
.Pp
If insufficient storage is provided in
-.Fa strerrbuf
-(as specified in
+.Fa strerrbuf
+(as specified in
.Fa buflen )
-to contain the error string,
+to contain the error string,
.Fn strerror_r
returns
-.Er ERANGE
-and
+.Er ERANGE
+and
.Fa strerrbuf
-will contain an error message that has been truncated and nul
-terminated to fit the length specified by
+will contain an error message that has been truncated and
+.Dv NUL
+terminated to fit the length specified by
.Fa buflen .
.Pp
The message strings can be accessed directly using the external
@@ -156,13 +157,12 @@ and
.Fn perror
functions first appeared in
.Bx 4.4 .
-The
+The
.Fn strerror_r
function was implemented in
.Fx 4.4
-by
-.An Wes Peters
-.Aq wes@freebsd.org .
+by
+.An Wes Peters Aq wes@FreeBSD.org .
.Sh BUGS
For unknown error numbers, the
.Fn strerror
OpenPOWER on IntegriCloud