From e6bc5141b885d256457be80628b9d2ad11f3ad27 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 12 Sep 2021 11:09:28 +0200 Subject: Adding ddns-client manpage. Signed-off-by: Daniel Baumann --- ddns-client/share/man/Makefile | 59 ++++++++++++++++++++++ ddns-client/share/man/ddns-client.1.rst | 86 +++++++++++++++++++++++++++++++++ ddns-client/share/man/man.in | 19 ++++++++ 3 files changed, 164 insertions(+) create mode 100644 ddns-client/share/man/Makefile create mode 100644 ddns-client/share/man/ddns-client.1.rst create mode 100644 ddns-client/share/man/man.in diff --git a/ddns-client/share/man/Makefile b/ddns-client/share/man/Makefile new file mode 100644 index 0000000..61a9eb9 --- /dev/null +++ b/ddns-client/share/man/Makefile @@ -0,0 +1,59 @@ +# Open Infrastructure: network-tools + +# Copyright (C) 2014-2021 Daniel Baumann +# +# SPDX-License-Identifier: GPL-3.0+ +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +# Depends: python3-docutils + +RST2MAN = rst2man \ + --no-datestamp \ + --no-generator \ + --strict \ + --strip-comments \ + --tab-width=4 \ + --verbose + +VERSION := $(shell cat ../../../VERSION.txt) + +SHELL := sh -e + +all: build + +build: man + +rebuild: clean build + +man: man.in *.rst + @echo -n "Creating manpages... " + + @for FILE in *.rst; \ + do \ + cp man.in $$(basename $${FILE} .rst); \ + $(RST2MAN) $${FILE} | \ + sed -e '/^.\\" Man page generated/d' \ + -e '/^.\\" Generated by/d' \ + -e "s|^\(.TH .*\) \(\"\" \"\"\) |\1 $${VERSION} service-tools |" \ + >> $$(basename $${FILE} .rst); \ + echo -n "."; \ + done + + @echo " done." + +clean: + rm -f *.[0-9] + +.PHONY: all clean build rebuild man diff --git a/ddns-client/share/man/ddns-client.1.rst b/ddns-client/share/man/ddns-client.1.rst new file mode 100644 index 0000000..07a0360 --- /dev/null +++ b/ddns-client/share/man/ddns-client.1.rst @@ -0,0 +1,86 @@ +.. Open Infrastructure: network-tools + +.. Copyright (C) 2014-2021 Daniel Baumann +.. +.. SPDX-License-Identifier: GPL-3.0+ +.. +.. This program is free software: you can redistribute it and/or modify +.. it under the terms of the GNU General Public License as published by +.. the Free Software Foundation, either version 3 of the License, or +.. (at your option) any later version. +.. +.. This program is distributed in the hope that it will be useful, +.. but WITHOUT ANY WARRANTY; without even the implied warranty of +.. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.. GNU General Public License for more details. +.. +.. You should have received a copy of the GNU General Public License +.. along with this program. If not, see . + +=========== +ddns-client +=========== + +------------------ +Dynamic DNS client +------------------ + +:manual section: 1 +:manual group: Open Infrastructure + +Synopsis +======== + +| **ddns-client** {update|remove|list} + +Description +=========== + +**ddns-client** is a dynamic DNS client to update records in a nameserver zone. + +Features +======== + +**ddns-client** has the following features: + +| **works with IPv4 and IPv6** +| **ddns-client** by default updates IPv4 and IPv6 addresses, if available. + +Files +===== + +The following files are used: + +/etc/network-tools/tsig.key: + default location for the TSIG key to be used. + +/etc/network-tools/config/ddns-client.conf: + configuration file. + +See also +======== + +| knsupdate(1), +| kdig(1). + +Homepage +======== + +More information about network-tools and the Open Infrastructure project can be +found on the homepage (https://open-infrastructure.net). + +Contact +======= + +Bug reports, feature requests, help, patches, support and everything else are +welcome on the Open Infrastructure Software Mailing List +. + +Debian specific bugs can also be reported in the Debian Bug Tracking System +(https://bugs.debian.org). + +Authors +======= + +network-tools were written by Daniel Baumann + and others. diff --git a/ddns-client/share/man/man.in b/ddns-client/share/man/man.in new file mode 100644 index 0000000..5a55f8c --- /dev/null +++ b/ddns-client/share/man/man.in @@ -0,0 +1,19 @@ +.\" Open Infrastructure: network-tools +.\" +.\" Copyright (C) 2014-2021 Daniel Baumann +.\" +.\" SPDX-License-Identifier: GPL-3.0+ +.\" +.\" This program is free software: you can redistribute it and/or modify +.\" it under the terms of the GNU General Public License as published by +.\" the Free Software Foundation, either version 3 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public License +.\" along with this program. If not, see . +.\" -- cgit v1.2.3