Initial commit. Actual dyndns request is not implemented yet

[oss/dyngo.git] / dyngo.md

diff --git a/dyngo.md b/dyngo.md
new file mode 100644 (file)
index 0000000..d7ed659
--- /dev/null
+++ b/dyngo.md
@@ -0,0 +1,45 @@
+% dingo(8)
+% Victor Wagner <vitus@wagner.pp.ru>
+% September 2019
+
+NAME
+====
+
+dingo - multi-network dynamic DNS client
+
+SYNOPSIS
+========
+
+**dyngo** [ **-f** *configuration-file* ]
+
+DESCRIPTION
+===========
+
+**dyngo** is dynamic DNS client which periodically tries to check if
+some of IP addresses of the current machine change and report to
+appropriate dynamic DNS server if so.
+
+It is primarily intended to let machine be visible in the local DNS 
+of office or home local networks, VPNs and so on. So it expects that
+there could be private dynamic dns servers. Couple of dynamic DNS
+scripts is included into distribution to make it easier to set up
+dynamic dns.
+
+But nothing prevent user from defining some of networks as global
+ones and put URL of public dyndns server into it.
+
+If network is defined as global, i.e have netmask /0, private ip ranges
+wouldn't be reported to corresponding DNS server.
+
+CONFIGURATION FILE
+==================
+
+Configuration file **dyngo.conf** is ini-style file. It contains section
+**dyngo** with global service parameters and section per dyndns server.
+
+Names of server-description sections are arbitrary, but should be
+unique, because they are used as keys into persistent database.
+
+
+
+