dtstyle: Coverity 89011
[oweals/cde.git] / cde / util / scripts / xon.man
1 .\" $XConsortium: xon.man /main/2 1995/07/17 10:49:49 drk $
2 .TH XON 1 "Release 5" "X Version 11"
3 .SH NAME
4 xon \- start an X program on a remote machine
5 .SH SYNOPSIS
6 .B xon
7 remote-host [-access] [-debug] [-name window-name] [-nols] [-screen screen-no]
8 [-user user-name] [command ...]
9 .SH DESCRIPTION
10 .I Xon
11 runs the specified command (default xterm -ls) on the remote machine using
12 rsh.  Xon passes the DISPLAY, XAUTHORITY and XUSERFILESEARCHPATH environment
13 variables to the remote command.
14 .PP
15 When no command is specified, xon runs 'xterm -ls'.  It additionally
16 specifies the application name to be 'xterm-\fIremote-host\fP' and the
17 window title to be '-fIremote-host\fP'.
18 .PP
19 Xon can only work when the remote host will allow you to use rsh, by having
20 an entry in the .rhosts file permitting access.
21 .SH OPTIONS
22 .PP
23 Note that the options follow the remote host name (as they do with rlogin).
24 .sp
25 .IP "\fB-access\fP"
26 Runs xhost locally to add the remote host to the host access list in the X
27 server.  This won't work unless xhost is given permission to modify the
28 access list.
29 .IP "\fB-debug\fP"
30 Normally, xon disconnects the remote process from stdin, stdout and stderr
31 to eliminate the daemon processes which usually connect them across the
32 network.  Specifying the \fB-debug\fP option leaves them connected so that
33 error messages from the remote execution are sent back to the originating
34 host.
35 .IP "\fB-name window-name\fP"
36 This specifies a different application name and window title for the default
37 command (xterm).
38 .IP "\fB-nols\fP"
39 Normally xon passes the -ls option to the remote xterm; this option
40 suspends that behaviour.
41 .IP "\fB-screen screen-no\fP"
42 This changes the screen number of the DISPLAY variable passed to the remote
43 command.
44 .IP "\fB-user user-name\fP"
45 By default, xon simply uses rsh to connect to the remote machine using the
46 same user name as on the local machine.  This option cause xon to specify an
47 alternative user name.  This will not work unless you have authorization to
48 access the remote account via rsh by placing an appropriate entry in the
49 remote users .rhosts file.
50 .SH BUGS
51 Xon can get easily confused when the remote-host, user-name or various
52 environment variable values contain white space.
53 .PP
54 Xon has no way to send the appropriate X authorization information to the
55 remote host.