Merge from vendor branch FILE:
[dragonfly.git] / crypto / heimdal-0.6.3 / appl / kx / kx.1
1 .\" Copyright (c) 1996 - 1997 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: kx.1,v 1.9 2003/04/11 12:44:57 lha Exp $
33 .\"
34 .Dd September 27, 1996
35 .Dt KX 1
36 .Os KTH-KRB
37 .Sh NAME
38 .Nm kx
39 .Nd
40 securely forward X conections
41 .Sh SYNOPSIS
42 .Ar kx
43 .Op Fl l Ar username
44 .Op Fl k
45 .Op Fl d
46 .Op Fl t
47 .Op Fl p Ar port
48 .Op Fl P
49 .Ar host
50 .Sh DESCRIPTION
51 The
52 .Nm
53 program forwards an X connection from a remote client to a local screen
54 through an authenticated and encrypted stream.  Options supported by
55 .Nm kx :
56 .Bl -tag -width Ds
57 .It Fl l
58 Log in on the remote the host as user
59 .Ar username .
60 .It Fl k
61 Do not enable keep-alives on the TCP connections.
62 .It Fl d
63 Do not fork. This is mainly useful for debugging.
64 .It Fl t
65 Listen not only on a UNIX-domain socket but on a TCP socket as well.
66 .It Fl p
67 Use the port
68 .Ar port .
69 .It Fl P
70 Force passive mode.
71 .El
72 .Pp
73 This program is used by
74 .Nm rxtelnet
75 and
76 .Nm rxterm
77 and you should not need to run it directly.
78 .Pp
79 It connects to a
80 .Nm kxd
81 on the host
82 .Ar host
83 and then will relay the traffic from the remote X clients to the local
84 server.  When started, it prints the display and Xauthority-file to be
85 used on host
86 .Ar host
87 and then goes to the background, waiting for connections from the
88 remote
89 .Nm kxd .
90 .Sh SEE ALSO
91 .Xr rxtelnet 1 ,
92 .Xr rxterm 1 ,
93 .Xr kxd 8