aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSina Ghaderi <32870524+Sina-Ghaderi@users.noreply.github.com>2020-08-12 03:20:18 +0430
committerGitHub <noreply@github.com>2020-08-12 03:20:18 +0430
commita68094d8f974d019a01daf4024e7c1bbb47ae353 (patch)
treeed55f8bc622527ed17ad6609992bbe3c25ad3432
parent9b77d5ca3284cf84a7ca25afb09f506d1f19f895 (diff)
More Options Added in ReadMe.md
-rw-r--r--Readme.md27
1 files changed, 17 insertions, 10 deletions
diff --git a/Readme.md b/Readme.md
index e89ed22..ffa4481 100644
--- a/Readme.md
+++ b/Readme.md
@@ -9,7 +9,7 @@ Runing on Windows, Linux and Unix based systems
### Installation
Prerequisites: [Golang](https://golang.org) + [Git](https://git-scm.com)
Installing for windows - linux - freebsd and macos. (linux is recommended)
-Clone the code form Github or [Snix](https://slc.snix.ir/snix/go-ipfm) servers.
+Clone the code form [Github](https://github.com/sina-ghaderi/go-ipfm) or [Snix](https://slc.snix.ir) servers.
```
# git clone https://slc.snix.ir/snix/go-ipfm.git # Snix
# git clone https://github.com/Sina-Ghaderi/go-ipfm.git # Github
@@ -24,16 +24,22 @@ starting go-ipfm on eth0 interface, network 10.10.10.0/24, database database.db
```
#./go-ipfm -h
Usage of ./go-ipfm:
+ -hbm string
+ show (in txt file) data usage in <KB|MB|GB|TB> (default "MB")
-inf string
- network interface to capture on <interface_name> (default "lo")
+ network interface to capture on <interface_name> (default "lo")
-net string
- network to capture on <ipv4/cidr> (default "192.168.1.0/24")
+ network to capture on <ipv4/cidr> (default "192.168.1.0/24")
+ -srf string
+ sort data in txt file based on <descending|ascending> (default "descending")
+ -srt string
+ sort data in txt file based on <TX|RX> (default "RX")
-svd string
- database to save data <database_name> (default "ipfm.db")
+ database to save data <database_name> (default "ipfm.db")
-ttf string
- time in second to flush data into the database <integer> (default "3")
+ time in second to flush data into the database <integer> (default "3")
-txt string
- also save data to file <filename|false> (default "false")
+ also save data to file <filename|false> (default "false")
```
### Examples
So im runing go-ipfm on KVM host to measure vm's bandwidth usage
@@ -46,10 +52,11 @@ Open data.txt file by using `watch` and `cat` command in linux:
```
# watch cat data.txt
-SrcIP Address RX TX
-192.168.122.110 16624 18304
-192.168.122.1 0 4176
-192.168.122.104 3612311 113727
+Go-IPFM 0.34 - Capturing Data On virbr0 - Time: 2020-08-12 03:04:32
+Source-IPV4-Add RX(MB) TX(MB)
+192.168.122.110 30.844 86.812
+192.168.122.104 1.891 1.939
+192.168.122.1 0.000 22.320
```

Snix LLC Git Repository Holder Copyright(C) 2022 All Rights Reserved Email To Snix.IR