Dynamic Routing Guide
Man Pages for UM Router

Help for the UM Router command line can be obtained by entering "tnwgd -h". Brief help for the UM Router configuration file can be obtained by entering "tnwgd -d", which prints the DTD contents. (FYI: "tnwgd" stands for "Twenty Nine West Gateway Daemon", a historical name for the UM Router.)

There are two executables for the UM Router, each with it's own man page:


Tnwgd Man Page  <-

The tnwgd executable can be run interactively from a command prompt or from a script/batch file. For use as a Windows Service, see Tnwgds Man Page.

Purpose: UM Gateway daemon
Usage: tnwgd [options] configfile
Available options:
-d, --dump-dtd dump the configuration DTD to stdout
-h, --help display this help and exit
-v, --validate validate config-file then exit
-f, --detach detach from terminal
Description
UM Router services are provided by tnwgd. (FYI: "tnwgd" stands for "Twenty Nine West Gateway Daemon", a historical name for the UM Router.) A UM Router configuration file is required. The contents and format of the configuration file are documented separately.
The DTD used to validate a configuration file is dumped to standard output with -d or --dump-dtd. After dumping the DTD, tnwgd exits instead of providing UM Router services as usual. See UM Router Configuration DTD for the DTD with comments removed.
To validate the configuration file, use either the -v or --validate options. After attempting validation, tnwgd exits instead of providing UM Router services as usual. The exit status will be 0 for a configuration file successfully validated by the DTD, and non-zero otherwise.
Command line help is available with -h or --help.
Unix Only
Tnwgd normally remains attached to the controlling terminal and runs until interrupted. If the -f or --detach option is given on Unix, tnwgd instead forks and detaches the child process from the controlling terminal, and the parent exits immediately.
Exit Status
The exit status from tnwgd is 0 for success and some non-zero value for failure.


Tnwgds Man Page  <-

The tnwgds executable is for use as a Windows Service. The service can be installed as a service by the Windows package installer.

Alternatively, the tnwgds executable can be run interactively from a command prompt to install the service or to change certain configuration elements. See UM Daemons as Windows Services for more details.

Purpose: UM Gateway daemon
Usage: tnwgds [options] [configfile]
Available options:
-d, --dump-dtd dump the configuration DTD to stdout
-h, --help display this help and exit
-v, --validate validate config-file then exit
-s, --service=install install the service passing configfile
-s, --service=remove delete/remove the service
-s, --service=config update configfile info to use configfile passed
-e, --event-log-level Update/set service logging level. This is the minimum logging
level to send to the Windows event log. Valid values are:
NONE - Send no events
INFO
WARN - default
ERROR
Description
UM Router services are provided by tnwgds Windows Service. (FYI: "tnwgds" stands for "Twenty Nine West Gateway Daemon Service", a historical name for the UM Router.) A UM Router configuration file is required. The contents and format of the configuration file are documented separately.
The configfile parameter is used interactively to configure the UM Router's XML configuration file.
The DTD used to validate a configuration file is dumped to standard output with -d or --dump-dtd. After dumping the DTD, tnwgd exits instead of providing UM Router services as usual. See UM Router Configuration DTD for the DTD with comments removed.
To validate the configuration file, use either the -v or --validate options. After attempting validation, tnwgd exits instead of providing UM Router services as usual. The exit status will be 0 for a configuration file successfully validated by the DTD, and non-zero otherwise.
The -s is used interactively to control the installation of the Windows service. The -e is used interactively to configure the logging threshold for writing to the Windows Event Log. See UM Daemons as Windows Services for more details.
Command line help is available with -h or --help.
Exit Status
The exit status from tnwgd is 0 for success and some non-zero value for failure.