From 83cb0b0e8cc1e97efdbf53c4e0a14121aef08b42 Mon Sep 17 00:00:00 2001 From: Martin Willi Date: Fri, 28 Apr 2006 09:07:55 +0000 Subject: --- doc/manpage.d/ipsec_networkof.3.html | 238 ----------------------------------- 1 file changed, 238 deletions(-) delete mode 100644 doc/manpage.d/ipsec_networkof.3.html (limited to 'doc/manpage.d/ipsec_networkof.3.html') diff --git a/doc/manpage.d/ipsec_networkof.3.html b/doc/manpage.d/ipsec_networkof.3.html deleted file mode 100644 index ea0f83f82..000000000 --- a/doc/manpage.d/ipsec_networkof.3.html +++ /dev/null @@ -1,238 +0,0 @@ -Content-type: text/html - -Manpage of IPSEC_INITSUBNET - -

IPSEC_INITSUBNET

-Section: C Library Functions (3)
Updated: 12 March 2002
Index -Return to Main Contents

- - - -

NAME

- -ipsec initsubnet - initialize an ip_subnet -
- -ipsec addrtosubnet - initialize a singleton ip_subnet -
- -ipsec subnettypeof - get address type of an ip_subnet -
- -ipsec masktocount - convert subnet mask to bit count -
- -ipsec networkof - get base address of an ip_subnet -
- -ipsec maskof - get subnet mask of an ip_subnet - -

SYNOPSIS

- -#include <freeswan.h> - -

-const char *initsubnet(const ip_address *addr, - -
- -int maskbits, int clash, ip_subnet *dst); - -
- -const char *addrtosubnet(const ip_address *addr, - -
- -ip_subnet *dst); - -

-int subnettypeof(const ip_subnet *src); - -
- -int masktocount(const ip_address *src); - -
- -void networkof(const ip_subnet *src, ip_address *dst); - -
- -void maskof(const ip_subnet *src, ip_address *dst); - - -

DESCRIPTION

- -The -<freeswan.h> - -library uses an internal type -ip_subnet - -to contain a description of an IP subnet -(base address plus mask). -These functions provide basic tools for creating and examining this type. -

- -Initsubnet - -initializes a variable -*dst - -of type -ip_subnet - -from a base address and -a count of mask bits. -The -clash - -parameter specifies what to do if the base address includes -1 - -bits outside the prefix specified by the mask -(that is, in the ``host number'' part of the address): -

'0': -zero out host-number bits -
'x': -non-zero host-number bits are an error -

- -

- -Initsubnet - -returns -NULL - -for success and -a pointer to a string-literal error message for failure; -see DIAGNOSTICS. -

- -Addrtosubnet - -initializes an -ip_subnet - -variable -*dst - -to a ``singleton subnet'' containing the single address -*addr. - -It returns -NULL - -for success and -a pointer to a string-literal error message for failure. -

- -Subnettypeof - -returns the address type of a subnet, -normally -AF_INET - -or -AF_INET6. - -(The -<freeswan.h> - -header file arranges to include the necessary headers for these -names to be known.) -

- -Masktocount - -converts a subnet mask, expressed as an address, to a bit count -suitable for use with -initsubnet. - -It returns --1 - -for error; see DIAGNOSTICS. -

- -Networkof - -fills in -*dst - -with the base address of subnet -src. - -

- -Maskof - -fills in -*dst - -with the subnet mask of subnet -src, - -expressed as an address. - -

DIAGNOSTICS

- -Fatal errors in -initsubnet - -are: -unknown address family; -unknown -clash - -value; -impossible mask bit count; -non-zero host-number bits and -clash - -is -'x'. - -Fatal errors in -addrtosubnet - -are: -unknown address family. -Fatal errors in -masktocount - -are: -unknown address family; -mask bits not contiguous. - -

HISTORY

- -Written for the FreeS/WAN project by Henry Spencer. -

- -

-This document was created by -man2html, -using the manual pages.
-Time: 21:40:18 GMT, November 11, 2003 - - -- cgit v1.2.3