From 7310cf3449ad823773f66d1eb0d79770504efa17 Mon Sep 17 00:00:00 2001 From: Bill Somerville Date: Thu, 26 Nov 2015 18:53:24 +0000 Subject: [PATCH] Added manpage for udp_daemon reference example git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@6190 ab8295b8-cf94-4d9e-aec4-7959e3be5d79 --- manpages/CMakeLists.txt | 1 + manpages/man1/udp_daemon.1.txt | 67 ++++++++++++++++++++++++++++++++++ 2 files changed, 68 insertions(+) create mode 100644 manpages/man1/udp_daemon.1.txt diff --git a/manpages/CMakeLists.txt b/manpages/CMakeLists.txt index 780536782..7b2a3ed93 100644 --- a/manpages/CMakeLists.txt +++ b/manpages/CMakeLists.txt @@ -5,6 +5,7 @@ set (ASCIIDOC_MANS man1/rigctl-wsjtx.1.txt man1/rigctld-wsjtx.1.txt man1/message_aggregator.1.txt + man1/udp_daemon.1.txt ) find_program (A2X_EXECUTABLE NAMES a2x a2x.py) diff --git a/manpages/man1/udp_daemon.1.txt b/manpages/man1/udp_daemon.1.txt new file mode 100644 index 000000000..e1182e8f1 --- /dev/null +++ b/manpages/man1/udp_daemon.1.txt @@ -0,0 +1,67 @@ +:doctype: manpage +:man source: AsciiDoc +:man version: {VERSION} +:man manual: WSJT-X Manual += wsjtx(1) + +== NAME + +udp_daemon - Reference example UDP server + +== SYNOPSIS + +*udp_daemon* ['OPTIONS'] + +== DESCRIPTION + +*udp_daemon* does not serve any useful purpose other than to + demonstrate the UDP message features of *WSJT-X*. It is a small + command line application that interacts with any running *WSJT-X* + instances. + +Developers writing add on applications may find the source code of +*udp_daemon* contained in the *WSJT-X* code repository useful. The +files NetworkMessage.hpp, MessageServer.hpp, MessageClient.hpp and +their associated implementations along with the application source +UDPDaemon.cpp should cover all the required areas. All these files can +be found at: + +https://sourceforge.net/p/wsjt/wsjt/HEAD/tree/branches/wsjtx/ + +*udp_daemon* may also be used as a multi-cast UDP server which allows +multiple instances of *udp_daemon* to be run concurrently, to do this +simply pass a suitable multi-cast group address using the command line +option and in *WSJT-X* in the "*Settings->Reporting->UDP Server*" pane +e.g. 239.255.0.1 or ff03::1 for a local scope group. + +Note that on some systems it may be necessary to add a static +multi-cast route to the routing table before multi-cast traffic can be +routed to sockets on the same host as the sender. + +== OPTIONS +*-p* PORT, *--port*=PORT:: + +Optional service port number to listen on (default 2237). + +*-g* MULTICAST-GROUP, *--group*=MULTICAST-GROUP:: + +Optional multicast group address to join (Default unicast server). + +*-v, --version*:: Display the application version. + +*-h,--help*:: Display usage information. + +== AUTHOR + +Bill Somerville, G4WJS. + +== COPYING + +*udp_daemon* is Copyright (C) 2015 by William Somerville, G4WJS, +with contributions from additional authors. *udp_daemon* is Open Source +software, licensed under the GNU General Public License (GPLv3). + +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.