add doxygen support and json export document support
[heimdal.git] / appl / kx / rxterm.1
bloba7e848c6e6c15580c701807ca91681309584612d
1 .\" Copyright (c) 1996 - 1997, 2001 - 2003 Kungliga Tekniska Högskolan
2 .\" (Royal Institute of Technology, Stockholm, Sweden).
3 .\" All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\"
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\"
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\"
16 .\" 3. Neither the name of the Institute nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\" $Id$
33 .\"
34 .Dd April 11, 2003
35 .Dt RXTERM 1
36 .Os KTH_KRB
37 .Sh NAME
38 .Nm rxterm
39 .Nd start a secure remote xterm
40 .Sh SYNOPSIS
41 .Nm rxterm
42 .Op Fl l Ar username
43 .Op Fl k
44 .Op Fl r Ar rsh_args
45 .Op Fl x Ar xterm_args
46 .Op Fl K Ar kx_args
47 .Op Fl w Ar term_emulator
48 .Op Fl b Ar rsh_program
49 .Ar host
50 .Op Ar port
51 .Sh DESCRIPTION
52 The
53 .Nm
54 program starts an
55 .Nm xterm
56 window on host
57 .Ar host .
58 From this window you will also be able to run X clients that will be
59 able to connect securely to your X server. If
60 .Ar port
61 is given, that port will be used instead of the default.
62 .Pp
63 The supported options are:
64 .Bl -tag -width Ds
65 .It Fl l
66 Log in on the remote host as user
67 .Ar username .
68 .It Fl k
69 Disable keep-alives.
70 .It Fl r
71 Send
72 .Ar rsh_args
73 as arguments to
74 .Nm rsh .
75 .It Fl x
76 Send
77 .Ar xterm_args
78 as arguments to
79 .Nm xterm .
80 .It Fl X
81 Send
82 .Ar kx_args
83 as arguments to
84 .Nm kx .
85 .It Fl w
86 Use
87 .Ar term_emulator
88 instead of xterm.
89 .It Fl b
90 Use
91 .Ar rsh_program
92 instead of rsh.
93 .It Fl v
94 Be verbose.
95 .El
96 .Sh EXAMPLE
97 To login from host
98 .Va foo
99 (where your display is)
100 to host
101 .Va bar ,
102 you might do the following.
103 .Bl -enum
105 On foo:
107 .Va bar
109 You will get a new window running an
110 .Nm xterm
111 on host
112 .Va bar .
113 In this window you will be able to start X clients.
115 .Sh SEE ALSO
116 .Xr kx 1 ,
117 .Xr rsh 1 ,
118 .Xr rxtelnet 1 ,
119 .Xr tenletxr 1 ,
120 .Xr kxd 8