Dynamic Routing Guide

Man Pages for DRO

UM Message Routing services are provided by the DRO daemon (DRO).

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

- Tnwgd Man Page - Unix and Windows command-line interface.
- Tnwgds Man Page - Windows service interface.

(Note: "tnwg" stands for "Twenty Nine West Gateway", an older name for the DRO.)

# Tnwgd Man Page <-

Unix and Windows command-line interface.

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
-u, --use-utc Use UTC time format for log messages
-f, --detach detach from terminal

Description
  The `tnwgd` command runs the DRO. It can be run interactively from a shell or command prompt, or from a script or batch file. (For use as a Windows Service, see Tnwgds Man Page.)

  The "configfile" parameter is required and specifies the file path for the DRO's XML configuration file. See DRO Configuration Reference for configuration details.

  The "-f" option directs a Unix-based `tnwgd` to fork a child process which detaches from the controlling terminal. The `tnwgd` command normally remains attached to the controlling terminal and runs until interrupted. With "-f", the `tnwgd` command exits back to the shell, and the forked child continues running in the background.

  The "-d" option dumps (prints) the DRO's XML DTD to standard output. After dumping the DTD, `tnwgd` exits. See DRO Configuration DTD for the DTD with comments removed.

  The "-u" option tells the DRO to format its log file timestamps as UTC.

  The "-v" option validates the XML structure of the given configuration file against the DRO's XML DTD. After validating the configuration file's XML structure, `tnwgd` exits with status 0 for no errors, or non-zero if errors were found. For example:
  tnwgd -v /um/dro_cfg.xml

  Note that valid XML structure does not guarantee that the configuration file is completely correct. It must be tested on a running DRO.

  The "-h" option prints the man page and exits.

Exit Status
  The exit status from `tnwgd` is 0 for success and some non-zero value for failure.

# Tnwgds Man Page <-

Windows service interface.

See UM Daemons as Windows Services for general information about UM daemons as Windows Services.

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
-u, --use-utc Use UTC time format for log messages
-E, --env_var_file update/set the environment Variable File
-U, --unset-env-var-file unset the environment variable file
-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
  The `tnwgds` command has two functions:
  - First, it lets the user supply Windows Service operating parameters, which the command saves into the Windows registry. Those operating parameters are subsequently used by the DRO Service. For details on setting Windows Service operating parameters, see Configure the Windows Service.
  - Second, it provides Windows with the DRO executable to run as a Service.

  The "configfile" parameter provides the file path for the DRO's XML configuration file. It is supplied in conjunction with the "-v" option or the "-s config" option (see below). See DRO Configuration Reference for configuration details.

  Note that valid XML structure does not guarantee that the configuration file is completely correct. It must be tested on a running DRO.

  For "-s install" see Install the Windows Service.

  For "-s remove" see Remove the Windows Service.

  For "-s config", "-e", "-E", and "-U", see Configure the Windows Service.

  The "-d" option dumps (prints) the DRO's XML DTD to standard output. After dumping the DTD, `tnwgds` exits.

  The "-v" option validates the XML structure of the given configuration file against the DRO's XML DTD. After validating the configuration file's XML structure, `tnwgd` exits with status 0 for no errors, or non-zero if errors were found. For example:
  tnwgds -v c:\um\dro_cfg.xml

  Note that valid XML structure does not guarantee that the configuration file is completely correct. It must be tested on a running DRO.

  The "-h" option prints the man page and exits.

Exit Status
  The exit status from `tnwgd` is 0 for success and some non-zero value for failure.

Attention
  Do not use the task manager or the "kill" command to stop a UM daemon running as a Windows service. Use the Windows service control panel to stop the service.