From 746aa4907f24b9e34c2bd385bb99a3048134e598 Mon Sep 17 00:00:00 2001 From: Bryan Biedenkapp Date: Thu, 4 Jan 2024 23:31:04 -0500 Subject: [PATCH] document command line parameters for dvmcmd, dvmfne, and dvmmon; --- README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) diff --git a/README.md b/README.md index d7e27fd6..29b17e75 100644 --- a/README.md +++ b/README.md @@ -148,6 +148,8 @@ The following setups assume the host is compiled with the setup TUI mode (if ava ## Command Line Parameters +### dvmhost Command Line Parameters + ``` usage: ./dvmhost [-vhf] [--setup] [-c ] [--remote [-a
] [-p ]] @@ -166,6 +168,54 @@ usage: ./dvmhost [-vhf] [--setup] [-c ] [--remote [-a ][-p ][-P ] + + -d enable debug + -v show version information + -h show this screen + + -a remote modem command address + -p remote modem command port + -P remote modem authentication password + + -- stop handling options +``` + +NOTE: See `dvmcmd -h` for full help for commands and arguments. + +### dvmfne Command Line Parameters + +``` +usage: ./dvmfne [-vhf][-c ] + + -v show version information + -h show this screen + -f foreground mode + + -c specifies the configuration file to use + + -- stop handling options +``` + +### dvmmon Command Line Parameters + +``` +usage: ./dvmmon [-dvh][--hide-log][-c ] + + -d enable debug + -v show version information + -h show this screen + + --hide-log hide interactive logging window on startup + + -c specifies the monitor configuration file to use + + -- stop handling options +``` + ## Conference Bridge FNE The DVMHost project will also build `dvmfne` which is a simple conference bridge style FNE. This FNE uses its own configuration file (see `fne-config.example.yml`).