diff options
Diffstat (limited to 'docs/source/reference.rst')
| -rw-r--r-- | docs/source/reference.rst | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/source/reference.rst b/docs/source/reference.rst new file mode 100644 index 0000000..b8107e7 --- /dev/null +++ b/docs/source/reference.rst @@ -0,0 +1,33 @@ +Reference +========= + +The pages in this section contain technical description of various parts of netaddr machinery. + +netaddr provides support for: + +Layer 3 addresses + +- IPv4 and IPv6 addresses, subnets, masks, prefixes +- iterating, slicing, sorting, summarizing and classifying IP networks +- dealing with various ranges formats (CIDR, arbitrary ranges and globs, nmap) +- set based operations (unions, intersections etc) over IP addresses and subnets +- parsing a large variety of different formats and notations +- looking up IANA IP block information +- generating DNS reverse lookups +- supernetting and subnetting + +Layer 2 addresses + +- representation and manipulation MAC addresses and EUI-64 identifiers +- looking up IEEE organisational information (OUI, IAB) +- generating derived IPv6 addresses + +.. toctree:: + :maxdepth: 1 + + reference/compatibility + api + changes + references + copyright + license |