| Constantin Kaplinsky | b30ae7f | 2006-05-25 05:04:46 +0000 | [diff] [blame] | 1 | .TH vncserver 1 "17 Apr 2006" "TightVNC" "Virtual Network Computing" |
| 2 | .SH NAME |
| 3 | vncserver \- start or stop a VNC server |
| 4 | .SH SYNOPSIS |
| 5 | .B vncserver |
| 6 | .RI [: display# ] |
| 7 | .RB [ \-name |
| 8 | .IR desktop-name ] |
| 9 | .RB [ \-geometry |
| 10 | .IR width x height ] |
| 11 | .RB [ \-depth |
| 12 | .IR depth ] |
| 13 | .RB [ \-pixelformat |
| 14 | .IR format ] |
| 15 | .RI [ Xvnc-options... ] |
| 16 | .br |
| 17 | .BI "vncserver \-kill :" display# |
| 18 | .SH DESCRIPTION |
| 19 | .B vncserver |
| 20 | is used to start a VNC (Virtual Network Computing) desktop. |
| 21 | .B vncserver |
| 22 | is a Perl script which simplifies the process of starting an Xvnc server. It |
| 23 | runs Xvnc with appropriate options and starts some X applications to be |
| 24 | displayed in the VNC desktop. |
| 25 | |
| 26 | .B vncserver |
| 27 | can be run with no options at all. In this case it will choose the first |
| 28 | available display number (usually :1), start Xvnc as that display, and run a |
| 29 | couple of basic applications to get you started. You can also specify the |
| 30 | display number, in which case it will use that number if it is available and |
| 31 | exit if not, eg: |
| 32 | |
| 33 | .RS |
| 34 | vncserver :13 |
| 35 | .RE |
| 36 | |
| 37 | Editing the file $HOME/.vnc/xstartup allows you to change the applications run |
| 38 | at startup (but note that this will not affect an existing desktop). |
| 39 | |
| 40 | .SH OPTIONS |
| 41 | You can get a list of options by giving \fB\-h\fP as an option to vncserver. |
| 42 | In addition to the options listed below, any unrecognised options will be |
| 43 | passed to Xvnc - see the Xvnc man page, or "Xvnc \-help" for details. |
| 44 | |
| 45 | .TP |
| 46 | .B \-name \fIdesktop-name\fP |
| 47 | Each desktop has a name which may be displayed by the viewer. It defaults to |
| 48 | "\fIhost\fP:\fIdisplay#\fP (\fIusername\fP)" but you can change it with this |
| 49 | option. It is passed in to the xstartup script via the $VNCDESKTOP environment |
| 50 | variable, allowing you to run a different set of applications according to the |
| 51 | name of the desktop. |
| 52 | |
| 53 | .TP |
| 54 | .B \-geometry \fIwidth\fPx\fIheight\fP |
| 55 | Specify the size of the desktop to be created. Default is 1024x768. |
| 56 | |
| 57 | .TP |
| 58 | .B \-depth \fIdepth\fP |
| 59 | Specify the pixel depth in bits of the desktop to be created. Default is 16, |
| 60 | other possible values are 8, 15 and 24 - anything else is likely to cause |
| 61 | strange behaviour by applications. |
| 62 | |
| 63 | .TP |
| 64 | .B \-pixelformat \fIformat\fP |
| 65 | Specify pixel format for server to use (BGRnnn or RGBnnn). The default for |
| 66 | depth 8 is BGR233 (meaning the most significant two bits represent blue, the |
| 67 | next three green, and the least significant three represent red), the default |
| 68 | for depth 16 is RGB565 and for depth 24 is RGB888. |
| 69 | |
| 70 | .TP |
| 71 | .B \-cc 3 |
| 72 | As an alternative to the default TrueColor visual, this allows you to run an |
| 73 | Xvnc server with a PseudoColor visual (i.e. one which uses a color map or |
| 74 | palette), which can be useful for running some old X applications which only |
| 75 | work on such a display. Values other than 3 (PseudoColor) and 4 (TrueColor) |
| 76 | for the \-cc option may result in strange behaviour, and PseudoColor desktops |
| 77 | must be 8 bits deep. |
| 78 | |
| 79 | .TP |
| 80 | .B \-kill :\fIdisplay#\fP |
| 81 | This kills a VNC desktop previously started with vncserver. It does this by |
| 82 | killing the Xvnc process, whose process ID is stored in the file |
| 83 | "$HOME/.vnc/\fIhost\fP:\fIdisplay#\fP.pid". It actually ignores anything |
| 84 | preceding a ":" in its argument. This can be useful so you can write |
| 85 | "vncserver \-kill $DISPLAY", for example at the end of your xstartup file after |
| 86 | a particular application exits. |
| 87 | |
| 88 | .SH FILES |
| 89 | Several VNC-related files are found in the directory $HOME/.vnc: |
| 90 | .TP |
| 91 | $HOME/.vnc/xstartup |
| 92 | A shell script specifying X applications to be run when a VNC desktop is |
| 93 | started. If it doesn't exist, vncserver will create a new one which runs a |
| 94 | couple of basic applications. |
| 95 | .TP |
| 96 | $HOME/.vnc/passwd |
| 97 | The VNC password file. |
| 98 | .TP |
| 99 | $HOME/.vnc/\fIhost\fP:\fIdisplay#\fP.log |
| 100 | The log file for Xvnc and applications started in xstartup. |
| 101 | .TP |
| 102 | $HOME/.vnc/\fIhost\fP:\fIdisplay#\fP.pid |
| 103 | Identifies the Xvnc process ID, used by the |
| 104 | .B \-kill |
| 105 | option. |
| 106 | |
| 107 | .SH SEE ALSO |
| 108 | .BR vncviewer (1), |
| 109 | .BR vncpasswd (1), |
| 110 | .BR vncconfig (1), |
| 111 | .BR Xvnc (1) |
| 112 | .br |
| 113 | http://www.tightvnc.com |
| 114 | |
| 115 | .SH AUTHOR |
| 116 | Tristan Richardson, RealVNC Ltd. |
| 117 | |
| 118 | VNC was originally developed by the RealVNC team while at Olivetti |
| Constantin Kaplinsky | be1bda8 | 2006-06-02 04:43:52 +0000 | [diff] [blame^] | 119 | Research Ltd / AT&T Laboratories Cambridge. TightVNC additions were |
| Constantin Kaplinsky | b30ae7f | 2006-05-25 05:04:46 +0000 | [diff] [blame] | 120 | implemented by Constantin Kaplinsky. Many other people participated in |
| 121 | development, testing and support. |