TERM_CLIENTS(1)

NAME
trsh, tupload, tdownload, tredir, tudpredir, txconn, tmon, tshutdown, trdate, trdated - clients to term

SYNOPSIS
trsh [options] [command]

tupload [options] file ... [remote_directory]

tdownload [options] file ... [local_directory]

tredir [options] {local_port [remotehost:]remote_port} ...

tudpredir [options] {local_port [remotehost:]remote_port} ...

txconn [options]

tmon

tshutdown

trdate [options]

trdated [options]

DESCRIPTION
These clients connect to a local term(1) daemon and initiate a communication link with the remote daemon and remote processes. Trsh runs an interactive shell or commands on the remote system, tupload transfers files from the local system to the remote, and tdownload does the reverse. tredir and tupdredir redirect connections from ports on the local system to ports on a remote system (TCP or UDP respectively), txconn redirects X server connections from the local system to the remote, and tmon prints summary information about a term link.

As far as the clients are concerned, the link established by term(1) is completely symmetric; the clients don't know which system is your physically local system (the system you're typing at) and which is physically remote. From a client's point of view, the local system is the one on which the client is executing. The remote system is the other system, the one on which the client is not executing.

USAGE

trsh
    With no arguments, trsh is similar to rlogin(1). An interactive shell is started on the remote system. Terminal features such as character echoing, line editing, and window resizing are handled by a tty on the remote system. If a command is given, it executes on the remote system instead of the default shell. Specifying command without the -s option is primarily useful for starting a non-default shell remotely.

There is a single
    trsh specific option:

    -s  Use a simple connection. This makes trsh behave more like rsh(1). The specified command is executed by a shell on the remote system. Like rsh(1), quoted shell metacharacters are interpreted remotely, so filename redirection, multiple commands, or pipes can be used remotely. If no command is given, the -s option is ignored.

    The -s option should almost always be used when a command is provided. In particular, it should be used if trsh is part of a pipeline. The only exception to this rule is when remote terminal features are needed.

Trsh
    differs from rlogin(1) and rsh(1) in a couple of significant ways. First, the stdout and stderr of the remote shell or command are both directed to the local stdout. Second, the connection is broken as soon as a local end-of-file occurs. This means that any output generated by the remote system after EOF is lost. For example,

trsh -s wc < /etc/passwd

runs the remote
    wc(1) command on the contents of the local /etc/passwd, but will not produce any output.

tredir
    Tredir accept pairs of port numbers, the first of each being the local port number to redirect, and the second the remote port to redirect into. They will also accept a hostname with each of the second port numbers. For example,

tredir 119 my.nntp.host:119

can be run on the non-internet side of the link.
    Then, any local program that connects to port 119 (like an NNTP newsreader), will be connected to port 119 on my.nntp.host. Tredir becomes a background daemon once it has successfully established the local port. More than one port can be redirected at once with a single tredir. For example,

tredir 119 my.nntp.host:119 4000 remote.home:23

would redirect ports 119 and 4000, 119 to the nntp port on
    my.nntp.host, and port 4000 to the login port on remote.host. Tredir handles redirecting TCP ports.

tudpredir
    Tudpredir works similarly to tredir except a UDP port is redirected instead of a TCP port. One important difference is tudpredir commands must be placed in the background manually.

tupload
    Tupload takes a list of local file names to upload. If there is more than one name, then the last name is checked to see if it matches a remote directory. If it does match a remote directory, the files are uploaded to this directory. If a remote file exists, and is smaller than the local file, tupload will assume that it was a previous upload that got aborted, and will attempt to resume the upload. Tupload specific options are:

    -f  Tells upload to not do any possible resumptions. Always overwrite the remote file.

    -u  Unlink the local file after a successful upload.

    -v  Verbose mode. Will write out the number of bytes transferred, the name of the remote file, and the CPS rate. Two 'v's will produce more output; note, however, that the "current CPS" values shown will be less accurate at the beginning and end of the upload, since tupload has no direct knowledge about how fast term is sending data.

    -q  Quiet mode. Tupload will not write out any messages.

    -as <remote_file>
        Any of the local file names may be followed by the -as <remote_file> option to specify a new name for the remote copy of the file. By default the remote file will have the same name as the local file.

tdownload
    Tdownload takes the same arguments as tupload, but uses them to transfer the file(s) in the opposite direction. If the last name is a local directory, it is used to put all the files in. One or more local files may be specified "-as -" and the file's data will be sent to stdout.

txconn
    Txconn establishes an X screen port on the system it is run on. Connections to that screen will be redirected to the X server on the other system. If your DISPLAY environment variable is set, txconn will try to use the screen number given by DISPLAY. Txconn prints the number of the screen it actually establishes in a format suitable for re-setting your DISPLAY variable. The recommended method of starting txconn and setting your DISPLAY variable at the same time is to run

setenv  DISPLAY  `hostname`:0

setenv  DISPLAY  `txconn`

from csh and related shells, or

export  DISPLAY  `hostname`:0

export  DISPLAY=`txconn`

from sh and related shells.  Later trsh calls will have this preset.
    Txconn becomes a background daemon once it has successfully established the port.

tmon
    Tmon periodically queries the term daemon for information about the number of clients and the data flow-rate of the channels. It updates its output on the terminal it is running in.

tshutdown
    Tshutdown closes all term clients and stops both the local and remote term servers. Sometimes a crashed client will keep this from working. In that case you can blast the term servers by typing Control-C to kill the local server, then echoing 00000 to your modem device multiple times to kill the remote server.

trdate/trdated
    Trdate is a time setting utility. It will read the time on the remote system and set the local clock to the remote time. It attempts to take into account the delay in getting the data across the link by adding half the time taken to get the info onto the time it receives.

When run with a 'd' as the last character of the name, trdated will set the
    time every 5 minutes. It can thus be started in rc.local and run as a daemon. If it does not find a term connection it will ignore the error silently so it can run when there is no term connection.

trdate/trdated
    may only be used by root.

    -v  Verbose mode. Tmon will output details as it goes.

    -d delay
        Change delay. Only valid in daemon mode. Sets the delay between time queries to delay seconds. Default is 300 seconds (5 minutes).

GLOBAL OPTIONS
The following options are accepted by all term clients

-t <server>
    Specifies which term daemon socket to connect to (~/.term/socket<server>). This is useful if you have specific socket names for connections to specific remote hosts, or if you have multiple terms using different serial connections.

-S on
    Specifies to connection is to a shared server. (Default if set user or group id.)

-S off
    Specifies to connection is to a private server.

-r  Specifies a raw link (no compression).

-c  Specifies a compressing link. All clients but tupload/tdownload use compression by default.

-p <number>
    Specifies priority for this link. A client with higher priority will be able to send its data faster than lower priority clients. This may be changed in future releases. The priority of trsh defaults to 10 and tupload/tdownload default to -5. All other clients default to zero. Valid numbers are between -20 and 20.

EXAMPLES
Some simple, contrived examples:

trsh

This establishes an interactive shell on the remote machine. The connection is maintained until you exit the remote shell.

trsh -s who

prints out a list of current users of the remote machine.

ls -li | awk '{print $1, $5}' | trsh -s plot

will generate a scatter plot of file size vs inode. Most likely this would be run on the physically remote system to produce local graphical output about the files on the remote system.

tupload -vv -r lin-0.99.3.tar.Z -as lin993.tar.Z /new

This will upload the local file 'lin-0.99.3.tar.Z' to the remote system with the name '/new/lin993.tar.Z'. It will resume an upload if there is an existing /new/lin993.tar.Z, and will write out the CPS and bytes transferred every so often. It will not do compression on the way.

tredir 6667 munagin.ee.mu.oz.au:6500 9017 17

This will map any connections to port 6667 on your local host to port 6500 on munagin.ee.mu.oz.au and any connections on your local host to port 9017 to port 17 on the remote machine. So if you do 'telnet 0 6667' locally, you will be connected to port 6500 on munagin, and if you do 'telnet 0 9017', you will be connected to port 17 on the remote machine.

Let's say the physically remote machine, earlobe.mit.edu, is on the internet. You can establish a port on earlobe which will allow anyone on the internet to telnet to your physically local, non-internet machine. On the local machine you could type

trsh -s tredir 4000 23

Alternatively, if you already have an interactive shell on the remote machine you could just run the tredir command from that shell. In either case, once the tredir daemon is running, users typing

telnet earlobe.mit.edu 4000

from any internet host will get a login prompt from your physically local machine.

ENVIRONMENT VARIABLES

SHELL
    Default shell for trsh.

DISPLAY
    Used by txconn to determine which X server port to use.

TERMDIR
    Where to find the .term directory in private mode. This directory will contain the socket used by all term clients. The default is HOME.

TERMSHARE
    Where term runs from in shared mode. The default is /usr/local/lib/term.

TERMMODE
    What mode term will attempt to use. 0 == private, 1 == system shared, 2 == user shared.

TERMSERVER
    This should specify the <server> name, if you used one.

BUGS
If the remote command for 'trsh -s <command>' doesn't consume its input fast enough, the channel can lose data. Trsh breaks the channel as soon as the local EOF is received, thus losing any final output from the remote process. Tmon gives bogus output on some machines (e.g. NeXT).

SEE ALSO
term(1), term_setup(1).