diff --git a/README.md b/README.md index 9d9f4ae..30cbd63 100644 --- a/README.md +++ b/README.md @@ -2,33 +2,34 @@ Scan a IPv4 range for a certain port. ## Usage -Write: `$ wwmap --help` for help. +`$ wwmap --help` for help. - USAGE: - wwmap [OPTIONS] --port - OPTIONS: - -f, --from - From IPv4 - [default: 0] + USAGE: + wwmap [OPTIONS] [CIDR] - -h, --help - Print help information + ARGS: + Which port to scan for. + IPv4 subnet range (CIDR). Leave empty for the whole internet. [default: 0.0.0.0/0] - -i, --ignore-ip-list - A file containing ignored IPv4 addresses (seperated by linebreaks). [default: - ignore-ips-list.txt] + OPTIONS: + -h, --help + Print help information - -n, --threads - Amount of threads that will be used when scanning for the specified port. [default: 1] + -i, --ignore-ip-list + A file containing ignored IPv4 addresses (seperated by linebreaks). [default: + ignore-ips-list.txt] - -p, --port - Which port to scan for. + -n, --threads + Amount of threads that will be used when scanning for the specified port. [default: 1] - -t, --to - To IPv4 - [default: 4294967295] + -v, --verbose + Enable verbose (debug) output - -v, --verbose - Enable verbose (debug) output + -V, --version + Print version information - -V, --version - Print version information +### Examples +You can scan the whole internet for a HTTP server using this command: `$ wwmap 80 0.0.0.0/0`. + +It is recommended to use a large amount threads for large IPv4 ranges (like the whole internet).