✨ add completion

✨ add man page

man/dynb.1

@@ -0,0 +1,109 @@
+.\" Man page generated from reStructuredText.
+.
+.TH MAN 1 "2021-04-03" "" ""
+.SH NAME
+man \- DynB - dynamic DNS update script for bash
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.SH SYNOPSIS
+.sp
+\fBman  [\-\-version] [\-\-link] [\-\-reset] [\-\-debug] [\-\-update\-method UPDATE\-METHOD] [\-\-ip\-mode IP\-MODE] [\-\-domain DOMAIN] [\-\-service\-provider SERVICE\-PROVIDER] [\-\-username USERNAME] [\-\-password PASSWORD] [\-\-token TOKEN] [\-\-help]\fP
+.SH DESCRIPTION
+.sp
+IPv4 (A) and IPv6 (AAAA) record updates are supported.
+.SH ARGUMENTS
+.INDENT 0.0
+.TP
+.B \-v\fP,\fB  \-\-version
+outputs the client version.
+[Default: off]
+.sp
+
+.TP
+.B \-l\fP,\fB  \-\-link
+links to your script at ~/.local/bin/dynb.
+[Default: off]
+.sp
+
+.TP
+.B \-r\fP,\fB  \-\-reset
+deletes the client blocking status file.
+[Default: off]
+.sp
+
+.TP
+.B \-\-debug
+enables debug mode.
+[Default: off]
+.sp
+
+.TP
+.BI \-m \ UPDATE\-METHOD\fR,\fB \ \-\-update\-method \ UPDATE\-METHOD
+choose if you want to use DynDNS2 or the DomRobot RPC\-API.
+.sp
+dyndns | domrobot
+.TP
+.BI \-i \ IP\-MODE\fR,\fB \ \-\-ip\-mode \ IP\-MODE
+updates type A (IPv4) and AAAA (IPv6) records.
+.sp
+4 | 6 | dual
+.TP
+.BI \-d \ DOMAIN\fR,\fB \ \-\-domain \ DOMAIN
+set the domain you want to update.
+.sp
+dyndns.example.com
+.TP
+.BI \-s \ SERVICE\-PROVIDER\fR,\fB \ \-\-service\-provider \ SERVICE\-PROVIDER
+set your provider in case you are using DynDNS2.
+.sp
+inwx | dynv6
+.TP
+.BI \-u \ USERNAME\fR,\fB \ \-\-username \ USERNAME
+depends on your selected update method and your provider.
+.sp
+e.g. user42
+.TP
+.BI \-p \ PASSWORD\fR,\fB \ \-\-password \ PASSWORD
+depends on your selected update method and your provider.
+.sp
+e.g. SuperSecretPassword
+.TP
+.BI \-t \ TOKEN\fR,\fB \ \-\-token \ TOKEN
+depends on your selected update method and your provider.
+.sp
+YourProviderGivenToken
+.TP
+.B \-h\fP,\fB  \-\-help
+Prints help.
+.sp
+
+.UNINDENT
+.SH AUTHOR
+Eduard Veit
+.\" Generated by docutils manpage writer.
+.