diff options
author | Rene Mayrhofer <rene@mayrhofer.eu.org> | 2007-04-12 20:41:31 +0000 |
---|---|---|
committer | Rene Mayrhofer <rene@mayrhofer.eu.org> | 2007-04-12 20:41:31 +0000 |
commit | 774a362e87feab25f1be16fbca08269ddc7121a4 (patch) | |
tree | cf71f4e7466468ac3edc2127125f333224a9acfb /src/libfreeswan/anyaddr.3 | |
parent | c54a140a445bfe7aa66721f68bb0781f26add91c (diff) | |
download | vyos-strongswan-774a362e87feab25f1be16fbca08269ddc7121a4.tar.gz vyos-strongswan-774a362e87feab25f1be16fbca08269ddc7121a4.zip |
Major new upstream release, just ran svn-upgrade for now (and wrote some
debian/changelong entries).
Diffstat (limited to 'src/libfreeswan/anyaddr.3')
-rw-r--r-- | src/libfreeswan/anyaddr.3 | 87 |
1 files changed, 87 insertions, 0 deletions
diff --git a/src/libfreeswan/anyaddr.3 b/src/libfreeswan/anyaddr.3 new file mode 100644 index 000000000..4594a9ff9 --- /dev/null +++ b/src/libfreeswan/anyaddr.3 @@ -0,0 +1,87 @@ +.TH IPSEC_ANYADDR 3 "8 Sept 2000" +.\" RCSID $Id: anyaddr.3,v 1.1 2004/03/15 20:35:25 as Exp $ +.SH NAME +ipsec anyaddr \- get "any" address +.br +ipsec isanyaddr \- test address for equality to "any" address +.br +ipsec unspecaddr \- get "unspecified" address +.br +ipsec isunspecaddr \- test address for equality to "unspecified" address +.br +ipsec loopbackaddr \- get loopback address +.br +ipsec isloopbackaddr \- test address for equality to loopback address +.SH SYNOPSIS +.B "#include <freeswan.h> +.sp +.B "const char *anyaddr(int af, ip_address *dst);" +.br +.B "int isanyaddr(const ip_address *src);" +.br +.B "const char *unspecaddr(int af, ip_address *dst);" +.br +.B "int isunspecaddr(const ip_address *src);" +.br +.B "const char *loopbackaddr(int af, ip_address *dst);" +.br +.B "int isloopbackaddr(const ip_address *src);" +.SH DESCRIPTION +These functions fill in, and test for, special values of the +.I ip_address +type. +.PP +.I Anyaddr +fills in the destination +.I *dst +with the ``any'' address of address family +.IR af +(normally +.B AF_INET +or +.BR AF_INET6 ). +The IPv4 ``any'' address is the one embodied in the old +.B INADDR_ANY +macro. +.PP +.I Isanyaddr +returns +.B 1 +if the +.I src +address equals the ``any'' address, +and +.B 0 +otherwise. +.PP +Similarly, +.I unspecaddr +supplies, and +.I isunspecaddr +tests for, +the ``unspecified'' address, +which may be the same as the ``any'' address. +.PP +Similarly, +.I loopbackaddr +supplies, and +.I islookbackaddr +tests for, +the loopback address. +.PP +.IR Anyaddr , +.IR unspecaddr , +and +.I loopbackaddr +return +.B NULL +for success and +a pointer to a string-literal error message for failure; +see DIAGNOSTICS. +.SH SEE ALSO +inet(3), ipsec_addrtot(3), ipsec_sameaddr(3) +.SH DIAGNOSTICS +Fatal errors in the address-supplying functions are: +unknown address family. +.SH HISTORY +Written for the FreeS/WAN project by Henry Spencer. |