Skip to content

Commit

Permalink
add: usage param
Browse files Browse the repository at this point in the history
  • Loading branch information
kekeho committed Aug 24, 2019
1 parent 45c62e1 commit 50fdb50
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,45 @@
NNST: Network Scan Tools

## Status

Master: [![Build Status](https://travis-ci.org/kekeho/nnst.svg?branch=master)](https://travis-ci.org/kekeho/nnst)

## Features

### Port scan

Scan unix port (parallel), and check port is open.

## Usage

```sh
_ ___ ____________
/ |/ / |/ / __/_ __/
/ / /\ \ / /
/_/|_/_/|_/___/ /_/

NNST: Network Scan Tools

Usage:
nnst portscan [-t=<timeout>] <address> <ports>...
nnst portscan [-t=<timeout>] <address> -r <start_port> <end_port>

Command:
portscan: Check port(s) open


Options:
address Target address (hostname, domain or IP)
ports Target port list
-t --timeout=<timeout> Set timeout [ms] (default=2500)

-r --range Range mode
<start_port>, <end_port> Set scan range

-h --help Show this help
-v --version Show version info
```

## Build

### Dependencies to build
Expand Down

0 comments on commit 50fdb50

Please sign in to comment.