From 4b0faa32f3ce02d731ddabf42759402fbee055e9 Mon Sep 17 00:00:00 2001 From: Preston Brown Date: Mon, 30 Apr 2001 20:56:25 +0000 Subject: documentation for ipcalc added. --- src/doc/html/doxygen.css | 20 +++ src/doc/html/doxygen.gif | Bin 0 -> 2378 bytes src/doc/html/files.html | 18 +++ src/doc/html/globals.html | 27 ++++ src/doc/html/index.html | 18 +++ src/doc/html/ipcalc_c.html | 381 ++++++++++++++++++++++++++++++++++++++++++++ src/doc/man/man3/ipcalc_c.3 | 197 +++++++++++++++++++++++ 7 files changed, 661 insertions(+) create mode 100644 src/doc/html/doxygen.css create mode 100644 src/doc/html/doxygen.gif create mode 100644 src/doc/html/files.html create mode 100644 src/doc/html/globals.html create mode 100644 src/doc/html/index.html create mode 100644 src/doc/html/ipcalc_c.html create mode 100644 src/doc/man/man3/ipcalc_c.3 (limited to 'src/doc') diff --git a/src/doc/html/doxygen.css b/src/doc/html/doxygen.css new file mode 100644 index 00000000..7f8e5b88 --- /dev/null +++ b/src/doc/html/doxygen.css @@ -0,0 +1,20 @@ +H1 { text-align: center; } +A.qindex {} +A.qindexRef {} +A.el { text-decoration: none; font-weight: bold } +A.elRef { font-weight: bold } +A.code { text-decoration: none; font-weight: normal; color: #4444ee } +A.codeRef { font-weight: normal; color: #4444ee } +DL.el { margin-left: -1cm } +DIV.fragment { width: 100%; border: none; background-color: #eeeeee } +DIV.ah { background-color: black; margin-bottom: 3; margin-top: 3 } +TD.md { background-color: #f2f2ff } +DIV.groupHeader { margin-left: 16; margin-top: 12; margin-bottom: 6; font-weight: bold } +DIV.groupText { margin-left: 16; font-style: italic; font-size: smaller } +FONT.keyword { color: #008000 } +FONT.keywordtype { color: #604020 } +FONT.keywordflow { color: #e08000 } +FONT.comment { color: #800000 } +FONT.preprocessor { color: #806020 } +FONT.stringliteral { color: #002080 } +FONT.charliteral { color: #008080 } diff --git a/src/doc/html/doxygen.gif b/src/doc/html/doxygen.gif new file mode 100644 index 00000000..192c83ce Binary files /dev/null and b/src/doc/html/doxygen.gif differ diff --git a/src/doc/html/files.html b/src/doc/html/files.html new file mode 100644 index 00000000..22c982f1 --- /dev/null +++ b/src/doc/html/files.html @@ -0,0 +1,18 @@ + + + +File Index + + + +
+Main Page   File List   Globals  
+

initscripts File List

Here is a list of all documented files with brief descriptions: +
Generated at Mon Apr 30 16:39:02 2001 for initscripts by + +doxygen1.2.6 written by Dimitri van Heesch, + © 1997-2001
+ + diff --git a/src/doc/html/globals.html b/src/doc/html/globals.html new file mode 100644 index 00000000..d1bb857b --- /dev/null +++ b/src/doc/html/globals.html @@ -0,0 +1,27 @@ + + + +File Member Index + + + +
+Main Page   File List   Globals  
+

initscripts Globals

Here is a list of all documented functions, variables, defines, enums, and typedefs with links to the documentation: +
Generated at Mon Apr 30 16:39:02 2001 for initscripts by + +doxygen1.2.6 written by Dimitri van Heesch, + © 1997-2001
+ + diff --git a/src/doc/html/index.html b/src/doc/html/index.html new file mode 100644 index 00000000..ef0fe17f --- /dev/null +++ b/src/doc/html/index.html @@ -0,0 +1,18 @@ + + + +Main Page + + + +
+Main Page   File List   Globals  
+

initscripts Documentation

+

+

$id$

Generated at Mon Apr 30 16:39:02 2001 for initscripts by + +doxygen1.2.6 written by Dimitri van Heesch, + © 1997-2001
+ + diff --git a/src/doc/html/ipcalc_c.html b/src/doc/html/ipcalc_c.html new file mode 100644 index 00000000..b1a67d24 --- /dev/null +++ b/src/doc/html/ipcalc_c.html @@ -0,0 +1,381 @@ + + + +ipcalc.c File Reference + + + +
+Main Page   File List   Globals  
+

ipcalc.c File Reference

provides utilities for manipulating IP addresses. +More... +

+#include <ctype.h>
+#include <popt.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <sys/socket.h>
+#include <netinet/in.h>
+#include <arpa/inet.h>
+#include <netdb.h>
+ + + + + + + + + + + + + + + + + + + + + +

Defines

+#define IPBITS   (sizeof(unsigned long int) * 8)
 the number of bits in an IP address.

+#define IPBYTES   (sizeof(unsigned long int))
 the number of bytes in an IP address.


Functions

unsigned long int prefix2mask (int prefix)
 creates a netmask from a specified number of bits. More...

int mask2prefix (unsigned long int mask)
 calculates the number of bits masked off by a netmask. More...

unsigned long int default_netmask (unsigned long int addr)
 returns the default (canonical) netmask associated with specified IP address. More...

unsigned long int calc_broadcast (unsigned long int addr, int prefix)
 calculate broadcast address given an IP address and a prefix length. More...

unsigned long int calc_network (unsigned long int addr, int prefix)
 calculates the network address for a specified address and prefix. More...

const char* get_hostname (unsigned long int addr)
 returns the hostname associated with the specified IP address. More...

int main (int argc, const char **argv)
 wrapper program for ipcalc functions. More...

+

Detailed Description

+provides utilities for manipulating IP addresses. +

+ +

+ +

+ ipcalc provides utilities and a front-end command line interface for manipulating IP addresses, and calculating various aspects of an ip address/netmask/network address/prefix/etc. +

+Functionality can be accessed from other languages from the library interface, documented here. To use ipcalc from the shell, read the ipcalc(1) manual page. +

+When passing parameters to the various functions, take note of whether they take host byte order or network byte order. Most take host byte order, and return host byte order, but there are some exceptions. +

+

Function Documentation

+

+ + + + +
+ + + + + + + + + + +
+unsigned long int calc_broadcast ( + +unsigned long int addr, +
+int prefix ) +
+
+ + + + + +
+   + + +

+calculate broadcast address given an IP address and a prefix length. +

+ +

+

+Parameters:
+ + + +
addr +  +an IP address in network byte order.
prefix +  +a prefix length. +

+

+
+Returns:
+the calculated broadcast address for the network, in network byte order.
+

+ + + + +
+ + + + + + + + + + +
+unsigned long int calc_network ( + +unsigned long int addr, +
+int prefix ) +
+
+ + + + + +
+   + + +

+calculates the network address for a specified address and prefix. +

+ +

+

+Parameters:
+ + + +
addr +  +an IP address, in network byte order
prefix +  +the network prefix
+
+Returns:
+the base address of the network that addr is associated with, in network byte order.
+

+ + + + +
+ + + + + + +
+unsigned long int default_netmask ( + +unsigned long int addr ) +
+
+ + + + + +
+   + + +

+returns the default (canonical) netmask associated with specified IP address. +

+ +

+ When the Internet was originally set up, various ranges of IP addresses were segmented into three network classes: A, B, and C. This function will return a netmask that is associated with the IP address specified defining where it falls in the predefined classes.

+Parameters:
+ + +
addr +  +an IP address in network byte order.
+
+Returns:
+a netmask in network byte order.
+

+ + + + +
+ + + + + + +
+const char * get_hostname ( + +unsigned long int addr ) +
+
+ + + + + +
+   + + +

+returns the hostname associated with the specified IP address. +

+ +

+

+Parameters:
+ + +
addr +  +an IP address to find a hostname for, in network byte order +

+

+
+Returns:
+a hostname, or NULL if one cannot be determined. Hostname is stored in a static buffer that may disappear at any time, the caller should copy the data if it needs permanent storage.
+

+ + + + +
+ + + + + + + + + + +
+main ( + +int argc, +
+const char ** argv ) +
+
+ + + + + +
+   + + +

+wrapper program for ipcalc functions. +

+ +

+ This is a wrapper program for the functions that the ipcalc library provides. It can be used from shell scripts or directly from the command line. +

+For more information, please see the ipcalc(1) man page.

+

+ + + + +
+ + + + + + +
+int mask2prefix ( + +unsigned long int mask ) +
+
+ + + + + +
+   + + +

+calculates the number of bits masked off by a netmask. +

+ +

+ This function calculates the significant bits in an IP address as specified by a netmask. See also prefix2mask.

+Parameters:
+ + +
mask +  +is the netmask, specified as an unsigned long integer in network byte order.
+
+Returns:
+the number of significant bits.
+

+ + + + +
+ + + + + + +
+unsigned long int prefix2mask ( + +int bits ) +
+
+ + + + + +
+   + + +

+creates a netmask from a specified number of bits. +

+ +

+ This function converts a prefix length to a netmask. As CIDR (classless internet domain internet domain routing) has taken off, more an more IP addresses are being specified in the format address/prefix (i.e. 192.168.2.3/24, with a corresponding netmask 255.255.255.0). If you need to see what netmask corresponds to the prefix part of the address, this is the function. See also mask2prefix.

+Parameters:
+ + +
prefix +  +is the number of bits to create a mask for.
+
+Returns:
+a network mask, in network byte order.
+

Generated at Mon Apr 30 16:39:02 2001 for initscripts by + +doxygen1.2.6 written by Dimitri van Heesch, + © 1997-2001
+ + diff --git a/src/doc/man/man3/ipcalc_c.3 b/src/doc/man/man3/ipcalc_c.3 new file mode 100644 index 00000000..04b0ac97 --- /dev/null +++ b/src/doc/man/man3/ipcalc_c.3 @@ -0,0 +1,197 @@ +.TH "ipcalc.c" 3 "30 Apr 2001" "initscripts" \" -*- nroff -*- +.ad l +.nh +.SH NAME +ipcalc.c \- provides utilities for manipulating IP addresses. +.SH SYNOPSIS +.br +.PP +\fC#include \fR +.br +\fC#include \fR +.br +\fC#include \fR +.br +\fC#include \fR +.br +\fC#include \fR +.br +\fC#include \fR +.br +\fC#include \fR +.br +\fC#include \fR +.br +\fC#include \fR +.br + +.SS Defines + +.in +1c +.ti -1c +.RI "#define \fBIPBITS\fR (sizeof(unsigned long int) * 8)" +.br +.RI "\fIthe number of bits in an IP address.\fR" +.ti -1c +.RI "#define \fBIPBYTES\fR (sizeof(unsigned long int))" +.br +.RI "\fIthe number of bytes in an IP address.\fR" +.in -1c +.SS Functions + +.in +1c +.ti -1c +.RI "unsigned long int \fBprefix2mask\fR (int prefix)" +.br +.RI "\fIcreates a netmask from a specified number of bits.\fR" +.ti -1c +.RI "int \fBmask2prefix\fR (unsigned long int mask)" +.br +.RI "\fIcalculates the number of bits masked off by a netmask.\fR" +.ti -1c +.RI "unsigned long int \fBdefault_netmask\fR (unsigned long int addr)" +.br +.RI "\fIreturns the default (canonical) netmask associated with specified IP address.\fR" +.ti -1c +.RI "unsigned long int \fBcalc_broadcast\fR (unsigned long int addr, int prefix)" +.br +.RI "\fIcalculate broadcast address given an IP address and a prefix length.\fR" +.ti -1c +.RI "unsigned long int \fBcalc_network\fR (unsigned long int addr, int prefix)" +.br +.RI "\fIcalculates the network address for a specified address and prefix.\fR" +.ti -1c +.RI "const char* \fBget_hostname\fR (unsigned long int addr)" +.br +.RI "\fIreturns the hostname associated with the specified IP address.\fR" +.ti -1c +.RI "int \fBmain\fR (int argc, const char **argv)" +.br +.RI "\fIwrapper program for ipcalc functions.\fR" +.in -1c +.SH DETAILED DESCRIPTION +.PP +provides utilities for manipulating IP addresses. +.PP +.PP + ipcalc provides utilities and a front-end command line interface for manipulating IP addresses, and calculating various aspects of an ip address/netmask/network address/prefix/etc. +.PP +Functionality can be accessed from other languages from the library interface, documented here. To use ipcalc from the shell, read the ipcalc(1) manual page. +.PP +When passing parameters to the various functions, take note of whether they take host byte order or network byte order. Most take host byte order, and return host byte order, but there are some exceptions. +.PP +.SH FUNCTION DOCUMENTATION +.PP +.SS unsigned long int calc_broadcast (unsigned long int addr, int prefix) +.PP +calculate broadcast address given an IP address and a prefix length. +.PP +.PP + +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIaddr\fR\fR +an IP address in network byte order. +.TP +\fB\fIprefix\fR\fR +a prefix length. +.PP +\fBReturns: \fR +.in +1c +the calculated broadcast address for the network, in network byte order. +.SS unsigned long int calc_network (unsigned long int addr, int prefix) +.PP +calculates the network address for a specified address and prefix. +.PP +.PP + +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIaddr\fR\fR +an IP address, in network byte order +.TP +\fB\fIprefix\fR\fR +the network prefix +.PP +\fBReturns: \fR +.in +1c +the base address of the network that addr is associated with, in network byte order. +.SS unsigned long int default_netmask (unsigned long int addr) +.PP +returns the default (canonical) netmask associated with specified IP address. +.PP +.PP + When the Internet was originally set up, various ranges of IP addresses were segmented into three network classes: A, B, and C. This function will return a netmask that is associated with the IP address specified defining where it falls in the predefined classes. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIaddr\fR\fR +an IP address in network byte order. +.PP +\fBReturns: \fR +.in +1c +a netmask in network byte order. +.SS const char * get_hostname (unsigned long int addr) +.PP +returns the hostname associated with the specified IP address. +.PP +.PP + +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIaddr\fR\fR +an IP address to find a hostname for, in network byte order +.PP +\fBReturns: \fR +.in +1c +a hostname, or NULL if one cannot be determined. Hostname is stored in a static buffer that may disappear at any time, the caller should copy the data if it needs permanent storage. +.SS main (int argc, const char ** argv) +.PP +wrapper program for ipcalc functions. +.PP +.PP + This is a wrapper program for the functions that the ipcalc library provides. It can be used from shell scripts or directly from the command line. +.PP +For more information, please see the ipcalc(1) man page. +.SS int mask2prefix (unsigned long int mask) +.PP +calculates the number of bits masked off by a netmask. +.PP +.PP + This function calculates the significant bits in an IP address as specified by a netmask. See also \fBprefix2mask\fR. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fImask\fR\fR +is the netmask, specified as an unsigned long integer in network byte order. +.PP +\fBReturns: \fR +.in +1c +the number of significant bits. +.SS unsigned long int prefix2mask (int bits) +.PP +creates a netmask from a specified number of bits. +.PP +.PP + This function converts a prefix length to a netmask. As CIDR (classless internet domain internet domain routing) has taken off, more an more IP addresses are being specified in the format address/prefix (i.e. 192.168.2.3/24, with a corresponding netmask 255.255.255.0). If you need to see what netmask corresponds to the prefix part of the address, this is the function. See also \fBmask2prefix\fR. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIprefix\fR\fR +is the number of bits to create a mask for. +.PP +\fBReturns: \fR +.in +1c +a network mask, in network byte order. +.SH AUTHOR +.PP +Generated automatically by Doxygen for initscripts from the source code. \ No newline at end of file -- cgit v1.2.1