summaryrefslogtreecommitdiffstats
path: root/lib/libipsec
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
parent5a2f1bee2159f0334a4c05979cebccb2e391f029 (diff)
downloadFreeBSD-src-bd156625a79c13ea8f7dac5369d3ccef7f591c95.zip
FreeBSD-src-bd156625a79c13ea8f7dac5369d3ccef7f591c95.tar.gz
The .Fn function. Spelling.
Diffstat (limited to 'lib/libipsec')
-rw-r--r--lib/libipsec/ipsec_set_policy.319
-rw-r--r--lib/libipsec/ipsec_strerror.312
2 files changed, 21 insertions, 10 deletions
diff --git a/lib/libipsec/ipsec_set_policy.3 b/lib/libipsec/ipsec_set_policy.3
index 3d2f25c..00c3a6d 100644
--- a/lib/libipsec/ipsec_set_policy.3
+++ b/lib/libipsec/ipsec_set_policy.3
@@ -48,8 +48,9 @@
.Ft "char *"
.Fn ipsec_dump_policy "char *buf" "char *delim"
.Sh DESCRIPTION
+The
.Fn ipsec_set_policy
-generates IPsec policy specification structure, namely
+function generates IPsec policy specification structure, namely
.Li struct sadb_x_policy
and/or
.Li struct sadb_x_ipsecrequest
@@ -60,18 +61,21 @@ and length
.Fa len
of
.Fa policy .
+The
.Fn ipsec_set_policy
-will return the buffer of IPsec policy specification structure.
+function will return the buffer of IPsec policy specification structure.
The buffer is dynamically allocated, and must be freed by the caller by calling
.Xr free 3 .
.Pp
You may want the length of the generated buffer such when calling
.Xr setsockopt 2 .
+The
.Fn ipsec_get_policylen
-will return the length.
+function will return the length.
.Pp
+The
.Fn ipsec_dump_policy
-converts IPsec policy structure into readable form.
+function converts IPsec policy structure into readable form.
Therefore,
.Fn ipsec_dump_policy
can be regarded as inverse conversion of
@@ -86,8 +90,9 @@ If you set
to
.Dv NULL ,
single whitespace is assumed.
+The
.Fn ipsec_dump_policy
-returns pointer to dynamically allocated string.
+function returns a pointer to dynamically allocated string.
It is caller's responsibility to reclaim the region, by using
.Xr free 3 .
.Pp
@@ -253,8 +258,10 @@ in ipsec ipcomp/transport//use
esp/transport//use
.Ed
.Sh RETURN VALUES
+The
.Fn ipsec_set_policy
-returns a pointer to the allocated buffer of policy specification if successful; otherwise a NULL pointer is returned.
+function returns a pointer to the allocated buffer of policy specification if
+successful; otherwise a NULL pointer is returned.
.Fn ipsec_get_policylen
returns with positive value
(meaning the buffer size)
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