Remote Transactional File Server


rdm-tfs [OPTIONS]... [input_file [arg]... ]


The Transactional File Server (TFS) utility instantiates a TFS that can be accessed by one or more remote clients using either TCP/IP protocol or shared-memory protocol. If both are enabled, they can be used simultaneously by different client sessions. rdm-tfs may run on the same computer as a runtime, or on a different computer, provided the different computer's domain name is visible to the runtime through TCP/IP.

rdm-tfs may be installed as a Windows service, or started as a daemon process. To determine if rdm-tfs is already running, use the --query option (the --query option will work whether rdm-tfs has been started in the foreground or background).

On Windows, you may install rdm-tfs as a service that will run automatically by using the --install option. The PATH must list the fully qualified path to the rdm-tfs utility, or to the directory in which it resides. All required DLLs must reside either in the same directory as rdm-tfs. This option requires administrative privilege. To stop/start the rdm-tfs service, use the Windows service control manager.

When this utility is run as a foreground process, it may be cleanly terminated by issuing SIGINT (normally Ctrl-C from the keyboard). SIGTERM has the same effect. If the utility does not terminate immediately it will be terminated immediately (cleanly or not) upon the third signal.

Option Description
-h, --help Display this usage information
--version Display the version information
-q, --quiet Quiet mode. No information will be displayed
--docroot=path The location of the docroot directory. (See Document Root (DOCROOT))
--trans=trans_list Specifies a comma separated list of transports to listen on. Options are tcp and shm (default is shm, tcp). (See tcp or sharedmem)
-n, --name=name Specifies the server port (TCP/IP) or name (non-TCP-IP) for connections. The default port is 21553 and the default name is 21553. If a number is specified it will be used for the TCP/IP port and the server name. If a string or invalid port number is specified it will be used as the server name and the TCP/IP transport will not be initialized. (See name)
-v, --verbose Verbose output. (See opt_verbose)
--start Start the server (run as a daemon on Unix)
--stop Stop the server
--query Query the execution status of the server


Option Description
--install=exepath Install the server as a service at the specified path.
--uninstall Uninstall the server as a service.
--serviceuser=username User account to install service as (only valid with --install option)
--servicepw=password User account password to install service as (only valid with --install option and required with --serviceuser option)

See Also

Introduction to the TFS