diff --git a/AUTHORS.md b/AUTHORS.md deleted file mode 100644 index 99bde41e..00000000 --- a/AUTHORS.md +++ /dev/null @@ -1,20 +0,0 @@ -# Digital Voice Modem Host - -- Bryan Biedenkapp (https://github.com/gatekeep) -- Natalie Moore (https://github.com/jelimoore) -- Patrick McDonnell (https://github.com/W3AXL) - -- Build Chain and Helper Tools - - K4YT3X (https://github.com/k4yt3x) - -- Documentation Team - - Charles Bricker (https://github.com/ceb515) - - Connor Lovell (https://github.com/DevRanger) - -- Community Support Team - - Steven Jennison (https://github.com/sjennison) - - Charles Bricker (https://github.com/ceb515) - -## Special thanks to - -- Jonathan Naylor G4KLX (https://github.com/g4klx) and the MMDVM authors. diff --git a/README.md b/README.md index 3787bba0..84db4414 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,12 @@ # Digital Voice Modem Host -The DVM Host (dvmhost) software suite, provides the primary host computer implementation of a mixed-mode DMR, P25 and/or NXDN or dedicated-mode DMR, P25 or NXDN repeater system that talks to the actual modem hardware, and the networking core (dvmfne) that provides a centralized network service that interconnects DVM Host (dvmhost) and other endpoint applications allowing networked communications. +The DVM Host (dvmhost) software suite, provides the a set of applications that, act as a primary host computer implementation of a mixed-mode DMR, P25 and/or NXDN or dedicated-mode DMR, P25 or NXDN repeater system that talks to the actual modem hardware, a TIA/V.24 standard interface (dvmdfsi) allowing communications to commercial P25 hardware, and the networking core (dvmfne) that provides a centralized network service that interconnects various DVM endpoint applications allowing networked communications. Please feel free to reach out to us for help, comments or otherwise, on our Discord: https://discord.gg/3pBe8xgrEz This project generates a few executables: -- `dvmhost` the main executable, this is the host software that connects to the DVM modems (both repeater and hotspot) and is the primary data processing application for digital modes. [See configuration](#dvmhost-configuration) to configure and calibrate. +- `dvmhost` host software that connects to the DVM modems (both repeater and hotspot) and is the primary data processing application for digital modes. [See configuration](#dvmhost-configuration) to configure and calibrate. +- `dvmdfsi` TIA/V.24 standard interface application that connects to a V.24 interface board or UDP to allow for P25 DFSI communications with commercial P25 hardware. - `dvmfne` a network "core", this provides a central server for `dvmhost` instances to connect to and be networked with, allowing relay of traffic and other data between `dvmhost` instances and other `dvmfne` instances. [See configuration](#dvmfne-configuration) to configure. - `dvmcmd` a simple command-line utility to send remote control commands to a `dvmhost` or `dvmfne` instance with REST API configured. - `dvmmon` a TUI utility that allows semi-realtime console-based monitoring of `dvmhost` instances (this tool is only available when project wide TUI support is enabled!). @@ -155,13 +156,16 @@ There is no other real configuration for a `dvmfne` instance other then setting ### dvmhost Command Line Parameters ``` -usage: ./dvmhost [-vhf] [--setup] [-c ] [--remote [-a
] [-p ]] +usage: ./dvmhost [-vhdf][--syslog][--setup][-c ][--remote [-a
] [-p ]] -v show version information -h show this screen + -d force modem debug -f foreground mode - --setup setup mode + --syslog force logging to syslog + + --setup setup and calibration mode -c specifies the configuration file to use @@ -172,15 +176,32 @@ usage: ./dvmhost [-vhf] [--setup] [-c ] [--remote [-a ] + + -v show version information + -h show this screen + -f foreground mode + + --syslog force logging to syslog + + -c specifies the configuration file to use + + -- stop handling options +``` + ### dvmfne Command Line Parameters ``` -usage: ./dvmfne [-vhf][-c ] +usage: ./dvmfne [-vhf][--syslog][-c ] -v show version information -h show this screen -f foreground mode + --syslog force logging to syslog + -c specifies the configuration file to use -- stop handling options @@ -189,7 +210,7 @@ usage: ./dvmfne [-vhf][-c ] ### dvmcmd Command Line Parameters ``` -usage: ./dvmcmd [-dvh][-a
][-p ][-P ] +usage: ./dvmcmd [-dvhs][-a
][-p ][-P ] -d enable debug -v show version information @@ -199,6 +220,8 @@ usage: ./dvmcmd [-dvh][-a
][-p ][-P ]