diff options
author | gnn <gnn@FreeBSD.org> | 2006-02-14 13:02:00 +0000 |
---|---|---|
committer | gnn <gnn@FreeBSD.org> | 2006-02-14 13:02:00 +0000 |
commit | a3483ac2d7eb6c19372be10483ab7c4303909e84 (patch) | |
tree | 00a1e2b6da9875a2dcb443971b63f0bdee40ebf3 /lib/libipsec/ipsec_strerror.3 | |
parent | f6f0b57cbaf4d31fcc661b3e9d25c3cb1a394bef (diff) | |
download | FreeBSD-src-a3483ac2d7eb6c19372be10483ab7c4303909e84.zip FreeBSD-src-a3483ac2d7eb6c19372be10483ab7c4303909e84.tar.gz |
Clean up some descriptions and remove ambiguities in the language.
Add explanations to the examples.
MFC after: 1 week
Diffstat (limited to 'lib/libipsec/ipsec_strerror.3')
-rw-r--r-- | lib/libipsec/ipsec_strerror.3 | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/lib/libipsec/ipsec_strerror.3 b/lib/libipsec/ipsec_strerror.3 index 982d195..d162fa6 100644 --- a/lib/libipsec/ipsec_strerror.3 +++ b/lib/libipsec/ipsec_strerror.3 @@ -29,13 +29,13 @@ .\" .\" $FreeBSD$ .\" -.Dd May 6, 1998 +.Dd February 14, 2006 .Dt IPSEC_STRERROR 3 .Os .\" .Sh NAME .Nm ipsec_strerror -.Nd error message for IPsec policy manipulation library +.Nd error messages for the IPsec policy manipulation library .\" .Sh SYNOPSIS .In netinet6/ipsec.h @@ -49,7 +49,7 @@ declares .Dl extern int ipsec_errcode; .Pp which is used to pass an error code from IPsec policy manipulation library -to an user program. +to a user program. The .Fn ipsec_strerror function can be used to obtain the error message string for the error code. @@ -59,19 +59,19 @@ Since .Fn ipsec_strerror uses .Xr strerror 3 -as underlying function, calling +as an underlying function, calling .Xr strerror 3 after .Fn ipsec_strerror -would make the return value from +would overwrite the the return value from .Fn ipsec_strerror -invalid, or overwritten. +and make it invalid. .\" .Sh RETURN VALUES The .Fn ipsec_strerror function always returns a pointer to C string. -The C string must not be overwritten by user programs. +The C string must not be overwritten by the caller. .\" .Sh SEE ALSO .Xr ipsec_set_policy 3 |