summaryrefslogtreecommitdiffstats
path: root/lib/libipsec/ipsec_strerror.3
diff options
context:
space:
mode:
authorcharnier <charnier@FreeBSD.org>2003-02-06 11:29:40 +0000
committercharnier <charnier@FreeBSD.org>2003-02-06 11:29:40 +0000
commitbd156625a79c13ea8f7dac5369d3ccef7f591c95 (patch)
tree41c3c390bd58458bde88d4491635d91351fc960d /lib/libipsec/ipsec_strerror.3
parent5a2f1bee2159f0334a4c05979cebccb2e391f029 (diff)
downloadFreeBSD-src-bd156625a79c13ea8f7dac5369d3ccef7f591c95.zip
FreeBSD-src-bd156625a79c13ea8f7dac5369d3ccef7f591c95.tar.gz
The .Fn function. Spelling.
Diffstat (limited to 'lib/libipsec/ipsec_strerror.3')
-rw-r--r--lib/libipsec/ipsec_strerror.312
1 files changed, 8 insertions, 4 deletions
diff --git a/lib/libipsec/ipsec_strerror.3 b/lib/libipsec/ipsec_strerror.3
index 77f228f..bdddbd5 100644
--- a/lib/libipsec/ipsec_strerror.3
+++ b/lib/libipsec/ipsec_strerror.3
@@ -49,8 +49,9 @@ declares
.Pp
which is used to pass an error code from IPsec policy manipulation library
to an user program.
+The
.Fn ipsec_strerror
-can be used to obtain the error message string for the error code.
+function can be used to obtain the error message string for the error code.
.Pp
The array pointed to is not to be modified by the program.
Since
@@ -66,20 +67,23 @@ would make the return value from
invalid, or overwritten.
.\"
.Sh RETURN VALUES
+The
.Fn ipsec_strerror
-always return a pointer to C string.
+function always returns a pointer to C string.
The C string must not be overwritten by user programs.
.\"
.Sh SEE ALSO
.Xr ipsec_set_policy 3
.\"
.Sh HISTORY
+The
.Fn ipsec_strerror
-first appeared in WIDE/KAME IPv6 protocol stack kit.
+function first appeared in WIDE/KAME IPv6 protocol stack kit.
.\"
.Sh BUGS
+The
.Fn ipsec_strerror
-will return its result which may be overwritten by subsequent calls.
+function will return its result which may be overwritten by subsequent calls.
.Pp
.Va ipsec_errcode
is not thread safe.
OpenPOWER on IntegriCloud