From 9791c72a6e81ed7d5304afea10cf7f35614b872c Mon Sep 17 00:00:00 2001 From: Micke Nordin Date: Mon, 24 Oct 2022 17:55:33 +0200 Subject: [PATCH] Update readme --- README.md | 105 +++++++++++++++++++++++++++++------------------------- 1 file changed, 57 insertions(+), 48 deletions(-) diff --git a/README.md b/README.md index 0da9da0..b5f5041 100644 --- a/README.md +++ b/README.md @@ -5,60 +5,69 @@ This is a commandline tool for knotapi https://gitlab.nic.cz/knot/knot-dns-rest ## Usage +``` +usage: knotctl [-h] [--json | --no-json] {add,config,delete,list,update} ... +positional arguments: + {add,config,delete,list,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 -t TTL -z ZONE + +options: + -h, --help show this help message and exit + -d DATA, --data DATA + -n NAME, --name NAME + -r RTYPE, --rtype RTYPE + -t TTL, --ttl TTL + -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 -``` -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 -``` -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 + +options: + -h, --help show this help message and exit + -b BASEURL, --baseurl BASEURL + -p PASSWORD, --password PASSWORD + -u USERNAME, --username USERNAME ``` -### Update +### DELETE ``` -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 delete [-h] [-d DATA] [-n NAME] [-r RTYPE] -z ZONE + +options: + -h, --help show this help message and exit + -d DATA, --data DATA + -n NAME, --name NAME + -r RTYPE, --rtype RTYPE + -z ZONE, --zone ZONE +``` +### 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 + -n NAME, --name NAME + -r RTYPE, --rtype RTYPE + -z ZONE, --zone ZONE +``` +### UPDATE +``` +usage: knotctl update [-h] -d DATA -n NAME -r RTYPE -t TTL -z ZONE + +options: + -h, --help show this help message and exit + -d DATA, --data DATA + -n NAME, --name NAME + -r RTYPE, --rtype RTYPE + -t TTL, --ttl TTL + -z ZONE, --zone ZONE ```