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

Basic manpage for message_aggregator

Browse Source 
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5538 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
This commit is contained in:
Bill Somerville 2015-06-05 13:44:52 +00:00
parent 8734a4639b
commit 7f5b86fd36
2 changed files with 55 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
manpages/CMakeLists.txt
View File

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

54
manpages/man1/message_aggregator.1.txt Normal file
View File

@ -0,0 +1,54 @@
:doctype: manpage
:man source: AsciiDoc
:man version: {VERSION}
:man manual: WSJT-X Manual
= wsjtx(1)
== NAME
message_aggregator - Reference example UDP server
== SYNOPSIS
*message_aggregator*
== DESCRIPTION
*message_aggregator* does not serve any useful purpose other than to
demonstrate the UDP message features of *WSJT-X*. It is a small GUI
application that interacts with any running *WSJT-X* instances.
Developers writing add on applications may find the source code of
message_aggregator 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 MessageAggregator.cpp should cover all the required
areas. All these files can be found at:
https://sourceforge.net/p/wsjt/wsjt/HEAD/tree/branches/wsjtx/
*message_aggregator* may also be used as a multi-cast UDP server which
allows multiple instances of *message_aggregator* to be run
concurrently, to do this simply use a suitable multi-cast group
address in *message_aggregator* 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.
== AUTHOR
Bill Somerville, G4WJS.
== COPYING
*message_aggregator* is Copyright (C) 2015 by William Somerville, G4WJS,
with contributions from additional authors. *message_aggregator* 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.