diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-06-12 17:45:09 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-06-12 17:45:09 +0000 |
| commit | da1a8f12d7a38f67f3f464aaaffa851f929ae4ea (patch) | |
| tree | 677688f3aeab7f324f266d106770165708522c2c /docs/source/reference.rst | |
| parent | Initial commit. (diff) | |
| download | python-netaddr-da1a8f12d7a38f67f3f464aaaffa851f929ae4ea.tar.xz python-netaddr-da1a8f12d7a38f67f3f464aaaffa851f929ae4ea.zip | |
Adding upstream version 0.10.1.upstream/0.10.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
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 |