IPRANGE(1)

📦
version 1.0.4 · 2 versions
, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble

🌸 NAME 🌸

iprange — bestie, it manages IP ranges. That's it, that's the job. 💅

✨ SYNOPSIS ✨

iprange [options] file1 file2 file3 ...

💖 DESCRIPTION 💖

iprange manages IP ranges. Iconic. No cap. 🎀

👑 OPTIONS 👑

heads up babes: multiple options are aliases, so a bunch of these are just the same thing wearing different outfits. 🫶

🌈 CIDR output modes:

  • --optimize, --combine, --merge, --union, -J — all of these are the MERGE mode (which is the default). Returns every single IP found across all the files, and the resulting set is sorted. ✨
  • --common, --intersect — this is COMMON mode. It intersects all the files to find their common IPs. Resulting set is sorted. 💖
  • --except, --exclude-next — EXCEPT mode, and here's how it works, stay with me: (1) merge all files before this parameter (that's ipset A); (2) remove all IPs found in the files after this parameter, from ipset A, and print whatever's left. Resulting set is sorted. 🦋
  • --diff, --diff-next — DIFF mode! The way it works: (1) merge all files before this parameter (ipset A); (2) merge all files after this parameter (ipset B); (3) print all the differences between A and B, i.e. IPs found in either A or B, but not both. Resulting set is sorted. And listen: when there are differences between A and B, iprange exits with 1, and 0 otherwise. periodt.
  • --ipset-reduce PERCENT, --reduce-factor PERCENT — IPSET REDUCE mode. Merge all files and print the merged set, but try to reduce the number of prefixes (subnets) found, while allowing some increase in entries. The PERCENT is how much percent to allow increase on the number of entries in order to reduce the prefixes (subnets) — the internal default PERCENT is 20. Use -v to see exactly what it does. The resulting set is sorted. 🔥
  • --ipset-reduce-entries ENTRIES, --reduce-entries ENTRIES — also IPSET REDUCE mode. Allow increasing the entries above PERCENT, if they are below ENTRIES (the internal default ENTRIES is 16384).

🍓 CSV output modes:

  • --compare — COMPARE ALL mode. Compares all files with all other files. Add --header to get the CSV header too. 💜
  • --compare-first — COMPARE FIRST mode. Compares the first file with all other files. Add --header to get the CSV header too.
  • --compare-next — COMPARE NEXT mode. Compares all the files that appear before this parameter to all files that appear after this parameter. Add --header to get the CSV header too.
  • --count-unique, -C — COUNT UNIQUE mode. Merge all files and print its counts. Add --header to get the CSV header too. ✨
  • --count-unique-all — COUNT UNIQUE ALL mode. Print counts for each file. Add --header to get the CSV header too.

🧚 Controlling input:

  • --dont-fix-network — by default, the network address of all CIDRs is used (like, 1.1.1.17/24 gets read as 1.1.1.0/24). This option disables that feature, so 1.1.1.17/24 gets read as 1.1.1.17-1.1.1.255. 🙈
  • --default-prefix PREFIX, -p PREFIX — sets the default prefix for all IPs without a mask. The default is 32.

💅 Controlling CIDR output:

  • --min-prefix N — do not generate prefixes larger than N. So if N is 24, then /24 to /32 entries will be generated (a /16 network will get generated using multiple /24 networks). This is useful for optimizing netfilter/iptables ipsets, where each different prefix increases the lookup time for each packet, whereas the number of entries in the ipset does not affect its performance. With this setting, more entries will be produced to accomplish the same match. > WARNING: misuse of this parameter can create a large number of entries in the generated set. 😭
  • --prefixes N,N,N, ... — enable only the given prefixes to express all CIDRs; prefix 32 is always enabled. > WARNING: misuse of this parameter can create a large number of entries in the generated set. 💀
  • --print-ranges, -j — print IP ranges (A.A.A.A-B.B.B.B). The default is to print CIDRs (A.A.A.A/B). It only applies when the output is not CSV. 🌈
  • --print-single-ips, -1 — print single IPs; this can produce large output. The default is to print CIDRs (A.A.A.A/B). It only applies when the output is not CSV.
  • --print-binary — print binary data: this is the fastest way to print a large ipset. The result can be read by iprange on the same architecture (no conversion of endianness). 🔥
  • --print-prefix STRING — print STRING before each IP, range or CIDR. This sets both --print-prefix-ips and --print-prefix-nets.
  • --print-prefix-ips STRING — print STRING before each single IP: useful for entering single IPs to a different ipset than the networks. 🎀
  • --print-prefix-nets STRING — print STRING before each range or CIDR: useful for entering subnets to a different ipset than single IPs.
  • --print-suffix STRING — print STRING after each IP, range or CIDR. This sets both --print-suffix-ips and --print-suffix-nets.
  • --print-suffix-ips STRING — print STRING after each single IP: useful for giving single IPs different ipset options. ✨
  • --print-suffix-nets STRING — print STRING after each range or CIDR: useful for giving subnets different ipset options.
  • --quiet — do not print the actual ipset. Can only be used in DIFF mode. 🫶

⭐ Controlling CSV output:

  • --header — when the output is CSV, print the header line (the default is to not print the header line).

🦋 Controlling DNS resolution:

  • --dns-threads NUMBER — the number of parallel DNS queries to execute when the input files contain hostnames. The default is 5. 💜
  • --dns-silent — do not print DNS resolution errors (the default is to print all DNS related errors).
  • --dns-progress — print DNS resolution progress bar. 🌈

🎀 Other options:

  • --has-compare, --has-reduce — exits with 0; other versions of iprange will exit with 1. Use this option in scripts to find out if this version of iprange is present in a system. iykyk 👑
  • -v — be verbose on stderr.

💖 Getting help:

  • --version — print version and exit.
  • --help, -h — print this message and exit. bestie behaviour fr fr 🫶

🌸 FILES 🌸

Input files:

  • fileN — a filename or - for stdin. Each filename can be followed by [as NAME] to change its name in the CSV output. If no filename is given, stdin is assumed. 💅

Files may contain any or all of the following:

  1. comments starting with hashes (#) or semicolons (;);
  2. one IP per line (without mask);
  3. a CIDR per line (A.A.A.A/B);
  4. an IP range per line (A.A.A.A - B.B.B.B);
  5. a CIDR range per line (A.A.A.A/B - C.C.C.C/D); the range is calculated as the network address of A.A.A.A/B to the broadcast address of C.C.C.C/D (this is affected by --dont-fix-network);
  6. CIDRs can be given in either prefix or netmask format in all cases (including ranges);
  7. one hostname per line, to be resolved with DNS (if the IP resolves to multiple IPs, all of them will be added to the ipset) — hostnames cannot be given as ranges;
  8. spaces and empty lines are ignored.

Any number of files can be given. ✨

Copyright © 2015-2017 Costa Tsaousis for FireHOL (Refactored and extended)

Copyright © 2004 Paul Townsend (Adapted)

Copyright © 2003 Gabriel L. Somlo (Original)

License: GPLv2+: GNU GPL version 2 or later <http://gnu.org/licenses/gpl2.html>. This program comes with ABSOLUTELY NO WARRANTY; This is free software, and you are welcome to redistribute it under certain conditions; See COPYING distributed in the source for details.

okay that's the whole thing, you're literally a iprange girlie now 💅✨ — this was iprange 1.0.4, from December 2018, and yes the manual page itself is IPRANGE(1). mwah, go slay some ipsets 🎀🦋💖

📦 where this page comes from