mirror/freebsd
1
0
Fork 0
mirror of https://git.FreeBSD.org/src.git synced 2025-01-04 12:52:15 +00:00
Code Issues Releases Activity

The .Fn function. Spelling.

Browse Source
This commit is contained in:
Philippe Charnier 2003-02-06 11:29:40 +00:00
parent 50f0640536
commit bd99773b0c
Notes: svn2git 2020-12-20 02:59:44 +00:00 
svn path=/head/; revision=110444
2 changed files with 21 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
lib/libipsec/ipsec_set_policy.3
View File

@ -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)

12
lib/libipsec/ipsec_strerror.3
View File

@ -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.