lukas/DynuIPRefresher
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

added usage info to readme

Browse Source
This commit is contained in:
lukas 2020-05-21 11:38:39 +02:00
parent 8c0c888472
commit ea648d5946
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -15,6 +15,22 @@ Furthermore, you can optionally specify a Telegram API key and a Chat ID if you
To enable and start the service: To enable and start the service:
`systemctl enable iprefresher.service` and `systemctl start iprefresher.service` `systemctl enable iprefresher.service` and `systemctl start iprefresher.service`
## Usage
First of all configure the right keys in the `/etc/iprefresher.cfg` or `%appdata%\DynuIpRefresher\iprefresher.cfg` config file.
Afterwards use the following options:
```
help page:
[-h] [--help] print this help page
[-v] [--version] print the software version
[-f] [--force] force refresh of ip
[-l] [--loop] infinite loop to refresh ip every five minutes
[-c] [--checkconfig] validate configuration
[-ip] [--currentip] get current global ip
[no argument] normal ip check and refresh
```
## Build ## Build
## Basic Build ## Basic Build