w4kek/WSJT-X
1
0
Fork 0
mirror of https://github.com/saitohirga/WSJT-X.git synced 2024-11-25 05:38:46 -05:00
Code Issues Packages Projects Releases Wiki Activity

Added manpage for udp_daemon reference example

Browse Source 
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@6190 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
This commit is contained in:
Bill Somerville 2015-11-26 18:53:24 +00:00
parent 3cd2ce650c
commit 7310cf3449
2 changed files with 68 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
manpages/CMakeLists.txt
View File

@ -5,6 +5,7 @@ set (ASCIIDOC_MANS
man1/rigctl-wsjtx.1.txt man1/rigctl-wsjtx.1.txt
man1/rigctld-wsjtx.1.txt man1/rigctld-wsjtx.1.txt
man1/message_aggregator.1.txt man1/message_aggregator.1.txt
man1/udp_daemon.1.txt
) )
find_program (A2X_EXECUTABLE NAMES a2x a2x.py) find_program (A2X_EXECUTABLE NAMES a2x a2x.py)

67
manpages/man1/udp_daemon.1.txt Normal file
View File

@ -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.