diff --git a/README.md b/README.md index a7673fb..b9f6fa1 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,28 @@ # conn -__the script is actively being rewritten on this branch and might not be on a usable state right now__ - quick and dirty server availability check

basically just a way too complex wrapper for nmap and fping
### features: -- multi-input detection -- ipv4 input detection -- ipv6 input detection +- ~~multi-input detection~~ (not needed anymore since the rewrite) +- ~~ipv4 input detection~~ (not needed anymore since the rewrite) +- ~~ipv6 input detection~~ (not needed anymore since the rewrite) - waiting for availability - send notification on availability - updater built in # usage -Usage: conn (options) [ip]
+Usage: conn [IP(s)/hostname(s)]
Options:
- -m/--multi -- test multiple ips / disable portscan
- -h/--help -- show help
- -6/--force-ipv6 -- force ipv6 portscanning (also forces portscanning)
- -4/--force-ipv4 -- force ipv4 portscanning (also forces portscanning)
- -y/--yes -- portscan without asking
- -n/--no -- dont portscan
- -p/--portscan -- same as -y
- -w/--wait -- wait for active connection
- -u/--update -- update the script
- -f/ --fast -- disable os check
- -s/ --simple -- same as -f
+ -h / --help show help page (this)
+ -6 / --force-ipv6 force ipv6 portscanning (also forces portscanning)
+ -4 / --force-ipv4 force ipv4 portscanning (also forces portscanning)
+ -y / --yes portscan without asking
+ -n / --no dont portscan
+ -w / --wait wait for active connection
+ -u / --update update the script
+ -f / --fast disable os check
+ -s / --simple simplify output
# installation 1. download the script:
@@ -46,28 +42,33 @@ chmod +x conn.sh && ./conn.sh # sample output ```bash -checking connection status for localhost +./conn.sh nils.lol +checking connection status for nils.lol -------------------Availability---------------------- -localhost is alive (545 ms) +nils.lol is alive (35.5 ms) note: this seems to be a linux machine ----------------------------------------------------- +portscan? (y/n) (default: y) + -------------------Portscan--------------------- -Starting Nmap 7.91 ( https://nmap.org ) at 2021-02-15 15:07 CET -Nmap scan report for localhost (127.0.0.1) -Host is up, received user-set (0.047s latency). -Other addresses for localhost (not scanned): ::1 -Not shown: 998 closed ports -Reason: 998 conn-refused -PORT STATE SERVICE REASON -22/tcp open ssh syn-ack -631/tcp open ipp syn-ack -Nmap done: 1 IP address (1 host up) scanned in 3.23 seconds +Starting Nmap 7.92 ( https://nmap.org ) at 2021-12-05 13:42 CET +Nmap scan report for nils.lol (168.119.185.158) +Host is up, received user-set (0.048s latency). +Not shown: 995 filtered tcp ports (no-response) +PORT STATE SERVICE REASON +21/tcp open ftp syn-ack +22/tcp open ssh syn-ack +80/tcp open http syn-ack +81/tcp closed hosts2-ns conn-refused +443/tcp open https syn-ack -localhost : [0], 64 bytes, 0.185 ms (0.185 avg, 0% loss) -localhost : [1], 64 bytes, 0.058 ms (0.122 avg, 0% loss) -localhost : [2], 64 bytes, 0.060 ms (0.101 avg, 0% loss) -localhost : [3], 64 bytes, 0.081 ms (0.096 avg, 0% loss) +Nmap done: 1 IP address (1 host up) scanned in 5.54 seconds -localhost : xmt/rcv/%loss = 4/4/0%, min/avg/max = 0.058/0.096/0.185 +nils.lol : [0], 64 bytes, 36.5 ms (36.5 avg, 0% loss) +nils.lol : [1], 64 bytes, 35.7 ms (36.1 avg, 0% loss) +nils.lol : [2], 64 bytes, 34.7 ms (35.6 avg, 0% loss) +nils.lol : [3], 64 bytes, 33.5 ms (35.1 avg, 0% loss) + +nils.lol : xmt/rcv/%loss = 4/4/0%, min/avg/max = 33.5/35.1/36.5 ------------------------------------------------ ```