micke
/
knotctl
1
0
Fork 0
Code Issues 4 Pull Requests Packages Projects Releases 6 Wiki Activity

Format readme

Browse Source
main
Micke Nordin 2 years ago
parent 0db9475256
commit 04e2350749
Signed by: micke
GPG Key ID: 0DA0A7A5708FE257
1 changed files with 39 additions and 6 deletions
Show Stats Download Patch File Download Diff File

45
README.md
Unescape View File

@ -7,25 +7,58 @@ https://gitlab.nic.cz/knot/knot-dns-rest
## Usage ## Usage
``` ```
usage: knotctl [-h] [--json | --no-json] {add,delete,list,config,update} ... positional arguments: {add,delete,list,config,update} options: -h, --help show this help message and exit --json, --no-json usage: knotctl [-h] [--json | --no-json] {add,delete,list,config,update} ...
positional arguments: {add,delete,list,config,update}
options:
-h, --help show this help message and exit
--json, --no-json
``` ```
### Add ### Add
``` ```
usage: knotctl add [-h] [-d [DATA ...]] [-n NAME] [-r RTYPE] -z ZONE options: -h, --help show this help message and exit -d [DATA ...], --data [DATA ...] Specify any number of key - value pairs: name=dns1.example.com. -n NAME, --name NAME -r RTYPE, --rtype RTYPE -z ZONE, --zone ZONE usage: knotctl add [-h] [-d [DATA ...]] [-n NAME] [-r RTYPE] -z ZONE
options:
-h, --help show this help message and exit
-d [DATA ...], --data [DATA ...] Specify any number of key - value pairs: name=dns1.example.com.
-n NAME, --name NAME
-r RTYPE, --rtype RTYPE
-z ZONE, --zone ZONE
``` ```
### Delete ### Delete
``` ```
usage: knotctl delete [-h] [-d [DATA ...]] [-n NAME] [-r RTYPE] -z ZONE options: -h, --help show this help message and exit -d [DATA ...], --data [DATA ...] Specify any number of key - value pairs: name=dns1.example.com. -n NAME, --name NAME -r RTYPE, --rtype RTYPE -z ZONE, --zone ZONE usage: knotctl delete [-h] [-d [DATA ...]] [-n NAME] [-r RTYPE] -z ZONE
options:
-h, --help show this help message and exit
-d [DATA ...], --data [DATA ...] Specify any number of key - value pairs: name=dns1.example.com.
-n NAME, --name NAME
-r RTYPE, --rtype RTYPE
-z ZONE, --zone ZONE
``` ```
### List ### List
``` ```
usage: knotctl list [-h] [-d [DATA ...]] [-n NAME] [-r RTYPE] [-z ZONE] options: -h, --help show this help message and exit -d [DATA ...], --data [DATA ...] Specify any number of key - value pairs: name=dns1.example.com. -n NAME, --name NAME -r RTYPE, --rtype RTYPE -z ZONE, --zone ZONE usage: knotctl list [-h] [-d [DATA ...]] [-n NAME] [-r RTYPE] [-z ZONE]
options:
-h, --help show this help message and exit
-d [DATA ...], --data [DATA ...] Specify any number of key - value pairs: name=dns1.example.com.
-n NAME, --name NAME
-r RTYPE, --rtype RTYPE
-z ZONE, --zone ZONE
``` ```
### Config ### Config
``` ```
usage: knotctl config [-h] [-b BASEURL] [-p PASSWORD] [-u USERNAME] options: -h, --help show this help message and exit -b BASEURL, --baseurl BASEURL -p PASSWORD, --password PASSWORD -u USERNAME, --username USERNAME usage: knotctl config [-h] [-b BASEURL] [-p PASSWORD] [-u USERNAME]
options:
-h, --help show this help message and exit
-b BASEURL, --baseurl BASEURL
-p PASSWORD, --password PASSWORD
-u USERNAME, --username USERNAME
``` ```
### Update ### Update
``` ```
usage: knotctl update [-h] -d [DATA ...] -n NAME -r RTYPE -z ZONE options: -h, --help show this help message and exit -d [DATA ...], --data [DATA ...] Specify any number of key - value pairs: name=dns1.example.com. -n NAME, --name NAME -r RTYPE, --rtype RTYPE -z ZONE, --zone ZONE usage: knotctl update [-h] -d [DATA ...] -n NAME -r RTYPE -z ZONE
options:
-h, --help show this help message and exit
-d [DATA ...], --data [DATA ...] Specify any number of key - value pairs: name=dns1.example.com.
-n NAME, --name NAME
-r RTYPE, --rtype RTYPE
-z ZONE, --zone ZONE
``` ```

Write Preview
Loading…
Cancel
Save