sys/man/1/vnc

   1 .TH VNC 1
   2 .SH NAME
   3 vncs, vncv \- remote frame buffer server and viewer for Virtual Network Computing (VNC)
   4 .SH SYNOPSIS
   5 .B vncs
   6 [
   7 .B -v
   8 ]
   9 [
  10 .B -c
  11 .I cert
  12 ]
  13 [
  14 .B -d
  15 .BI : display
  16 ]
  17 [
  18 .B -g
  19 .IB width x height
  20 ]
  21 [
  22 .B -p
  23 .I pixfmt
  24 ]
  25 [
  26 .B -x
  27 .I net
  28 ]
  29 [
  30 .I cmd
  31 [
  32 .I args
  33 ...
  34 ]
  35 ]
  36 .PP
  37 .B vncs
  38 .B -k
  39 .BI : display
  40 [
  41 .B -x
  42 .I net
  43 ]
  44 .PP
  45 .B vncv
  46 [
  47 .B -cstv
  48 ]
  49 [
  50 .B -e
  51 .I encodings
  52 ]
  53 [
  54 .B -l
  55 .I charset
  56 ]
  57 [
  58 .B -k
  59 .I keypattern
  60 ]
  61 .IR host [\fL: n ]
  62 .SH DESCRIPTION
  63 VNC is a lightweight protocol
  64 for accessing graphical applications
  65 remotely.  The protocol allows one or more
  66 clients to connect to a server.
  67 While connected, clients display the frame buffer
  68 presented by the server and can send mouse events,
  69 keyboard events, and exchange snarf buffers.
  70 The server persists across viewer sessions, so that
  71 the virtual application can be accessed from various locations
  72 as its owner moves around.
  73 .PP
  74 VNC displays have names of the form
  75 .IB host : n \fR,
  76 where
  77 .I host
  78 is the machine's network name and
  79 .I n
  80 is a small integer identifier; display
  81 .I n
  82 is served on TCP port
  83 .RI 5900+ n .
  84 .PP
  85 .I Vncs
  86 starts a new virtual frame buffer in memory, simulating
  87 a Plan 9 terminal running
  88 .I cmd
  89 .IR args ,
  90 by default an interactive shell.
  91 As viewers connect, each is authenticated using a
  92 (rather breakable) challenge-response protocol using
  93 the user's Inferno/POP password.
  94 .PP
  95 The options are:
  96 .TF "\fL-p \fIpixfmt"
  97 .PD
  98 .TP
  99 .B -c \fIcert
 100 start TLS on each viewer connection using the certificate
 101 in the file
 102 .IR cert .
 103 The corresponding private key must be loaded into
 104 the server's
 105 .IR factotum (4).
 106 When serving TLS connections, the base port is
 107 35729 rather than 5900.
 108 .TP
 109 .B -d :\fIn
 110 run on display
 111 .I n ;
 112 without this option, the server searches
 113 for an unused display.
 114 .TP
 115 .B -g \fIwidth\fBx\fIheight\fR
 116 set the virtual frame buffer to be
 117 .IB width x height
 118 (default
 119 1024x768)
 120 pixels.
 121 .TP
 122 .B -p \fIpixfmt
 123 set the virtual frame buffer's internal pixel format to
 124 .I pixfmt
 125 (default
 126 .BR r5g6b5 ).
 127 .TP
 128 .B -v
 129 print verbose output to standard error.
 130 .TP
 131 .B -x \fInet
 132 announce on an alternate network interface.
 133 .TP
 134 .B -A
 135 turn off authentication.
 136 .PD
 137 .PP
 138 The command
 139 .B vncs
 140 .B -k
 141 .BI : n
 142 kills the VNC server running on display
 143 .IR n .
 144 .PP
 145 .I Vncv
 146 provides access to remote display
 147 .IB host : n \fR.
 148 It resizes its window to be the smaller of the
 149 remote frame buffer size and the local screen.
 150 .PP
 151 The options are:
 152 .TP
 153 .B -c
 154 when connecting to 8-bit displays, request
 155 .B r4g4b4
 156 pixels rather than
 157 .B r3g3b2
 158 pixels.
 159 This takes up more bandwidth but usually gives
 160 significantly better matching to the Plan 9 color map.
 161 .TP
 162 .B -e \fIencodings
 163 set the ordered list of allowed frame buffer update encodings.
 164 The default (and full) set is
 165 .B copyrect
 166 .B corre
 167 .B hextile
 168 .B rre
 169 .BR raw .
 170 The encodings should be given as a single space-separated argument
 171 (quoted when using the shell).
 172 .TP
 173 .B -l \fIcharset
 174 sets the character set (see
 175 .IR tcs (1))
 176 used by the server to encode clipboard text. The default is
 177 .B utf-8.
 178 .TP
 179 .B -k \fIkeypattern
 180 add
 181 .I keypattern
 182 to the pattern used to select a key from
 183 .IR factotum (4).
 184 .TP
 185 .B -s
 186 share the display with extant viewers;
 187 by default extant viewers are closed
 188 when a new viewer connects.
 189 .TP
 190 .B -t
 191 start TLS on the connection.
 192 .TP
 193 .B -v
 194 print verbose output to standard error.
 195 .PD
 196 .SH SOURCE
 197 .B /sys/src/cmd/vnc
 198 .SH "SEE ALSO
 199 .B http://www.uk.research.att.com/vnc
 200 .SH BUGS
 201 If the remote frame buffer is larger than the local screen,
 202 only the upper left corner can be accessed.
 203 .PP
 204 .I Vncv
 205 does no verification of the TLS certificate presented
 206 by the server.
 207 .PP
 208 .I Vncv
 209 supports only version 3.3 of the RFB protocol.