diff options
author | charnier <charnier@FreeBSD.org> | 2003-02-06 11:29:40 +0000 |
---|---|---|
committer | charnier <charnier@FreeBSD.org> | 2003-02-06 11:29:40 +0000 |
commit | bd156625a79c13ea8f7dac5369d3ccef7f591c95 (patch) | |
tree | 41c3c390bd58458bde88d4491635d91351fc960d /lib/libipsec/ipsec_set_policy.3 | |
parent | 5a2f1bee2159f0334a4c05979cebccb2e391f029 (diff) | |
download | FreeBSD-src-bd156625a79c13ea8f7dac5369d3ccef7f591c95.zip FreeBSD-src-bd156625a79c13ea8f7dac5369d3ccef7f591c95.tar.gz |
The .Fn function. Spelling.
Diffstat (limited to 'lib/libipsec/ipsec_set_policy.3')
-rw-r--r-- | lib/libipsec/ipsec_set_policy.3 | 19 |
1 files changed, 13 insertions, 6 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) |