From: Pierre Ossman <ossman@cendio.se>
Date: Wed, 17 Sep 2014 14:16:10 +0000 (+0200)
Subject: Update the vncviewer man page with current list of options
X-Git-Tag: v1.3.90~31^2~7
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=3e156d6c96d5762abe9c2747ad44ef3a402d3902;p=tigervnc.git

Update the vncviewer man page with current list of options
---

diff --git a/vncviewer/vncviewer.man b/vncviewer/vncviewer.man
index 4fec9ebf..6c6a0fb4 100644
--- a/vncviewer/vncviewer.man
+++ b/vncviewer/vncviewer.man
@@ -81,9 +81,6 @@ to a remote screen which is the same size as your local one. If the remote
 screen is bigger, you can scroll by bumping the mouse against the edge of the
 screen.
 
-Unfortunately this mode doesn't work completely with all window managers, since
-it breaks the X window management conventions.
-
 .SH OPTIONS (PARAMETERS)
 You can get a list of parameters by giving \fB\-h\fP as a command-line option
 to vncviewer.  Parameters can be turned on with -\fIparam\fP or off with
@@ -113,7 +110,15 @@ Xvnc supports reverse connections with a helper program called
 .B vncconfig.
 
 .TP
-.B \-passwd \fIpassword-file\fP
+.B \-SecurityTypes \fIsec-types\fP
+Specify which security schemes to attempt to use when authenticating with
+the server.  Valid values are a comma separated list of \fBNone\fP,
+\fBVncAuth\fP, \fBPlain\fP, \fBTLSNone\fP, \fBTLSVnc\fP, \fBTLSPlain\fP,
+\fBX509None\fP, \fBX509Vnc\fP and \fBX509Plain\fP. Default is to attempt
+every supported scheme. 
+
+.TP
+.B \-passwd, \-PasswordFile \fIpassword-file\fP
 If you are on a filesystem which gives you access to the password file used by
 the server, you can specify it here to avoid typing it in.  It will usually be
 "~/.vnc/passwd".
@@ -131,6 +136,19 @@ Useful if you want to view a desktop without interfering; often needs to be
 combined with
 .B \-Shared.
 
+.TP
+.B \-AcceptClipboard
+Accept clipboard changes from the server. Default is on.
+
+.TP
+.B \-SendClipboard
+Send clipboard changes to the server. Default is on.
+
+.TP
+.B \-SendPrimary
+Send the primary selection and cut buffer to the server as well as the
+clipboard selection. Default is on.
+
 .TP
 .B \-Maximize
 Maximize viewer window. 
@@ -139,12 +157,27 @@ Maximize viewer window.
 .B \-FullScreen
 Start in full-screen mode.
 
+.TP
+.B \-FullScreenAllMonitors
+Use all local monitors and not just the current one when switching to
+full-screen mode.
+
+.TP
+.B \-FullscreenSystemKeys
+Pass special keys (like Alt+Tab) directly to the server when in full-screen
+mode.
+
 .TP
 .B \-DesktopSize \fIwidth\fPx\fIheight\fP
 Instead of keeping the existing remote screen size, the client will attempt to
 switch to the specified since when connecting. If the server does not support
 the SetDesktopSize message then the screen will retain the original size.
 
+.TP
+.B \-RemoteResize
+Dynamically resize the remote desktop size as the size of the local client
+window changes. Note that this may not work with all VNC servers.
+
 .TP
 .B \-AutoSelect
 Use automatic selection of encoding and pixel format (default is on).  Normally
@@ -170,18 +203,33 @@ This option specifies the preferred encoding to use from one of "Tight", "ZRLE",
 "hextile" or "raw".
 
 .TP
-.B -UseLocalCursor
-Render the mouse cursor locally if the server supports it (default is on).
-This can make the interactive performance feel much better over slow links.
+.B \-NoJpeg
+Disable lossy JPEG compression in Tight encoding. Default is off.
+
+.TP
+.B \-QualityLevel \fIlevel\fP
+JPEG quality level. 0 = Low, 9 = High. May be adjusted automatically if
+\fB-AutoSelect\fP is turned on. Default is 8.
+
+.TP
+.B \-CompressLevel \fIlevel\fP
+Use specified lossless compression level. 0 = Low, 6 = High. Default is 2.
+
+.TP
+.B \-CustomCompressLevel
+Use custom compression level. Default if \fBCompressLevel\fP is specified.
+
+.TP
+.B \-DotWhenNoCursor
+Show the dot cursor when the server sends an invisible cursor. Default is off.
 
 .TP
-.B \-WMDecorationWidth \fIw\fP, \-WMDecorationHeight \fIh\fP
-The total width and height taken up by window manager decorations.  This is
-used to calculate the maximum size of the VNC viewer window.  Default is
-width 6, height 24.
+.B \-PointerEventInterval \fItime\fP
+Time in milliseconds to rate-limit successive pointer events. Default is
+to send events immediately.
 
 .TP
-.B \-log \fIlogname\fP:\fIdest\fP:\fIlevel\fP
+.B \-Log \fIlogname\fP:\fIdest\fP:\fIlevel\fP
 Configures the debug log settings.  \fIdest\fP can currently be \fBstderr\fP or
 \fBstdout\fP, and \fIlevel\fP is between 0 and 100, 100 meaning most verbose
 output.  \fIlogname\fP is usually \fB*\fP meaning all, but you can target a
@@ -190,10 +238,8 @@ specific source file if you know the name of its "LogWriter".  Default is
 
 .TP
 .B \-MenuKey \fIkeysym-name\fP
-This option specifies the key which brings up the popup menu.  The key is
-specified as an X11 keysym name (these can be obtained by removing the XK_
-prefix from the entries in "/usr/include/X11/keysymdef.h" - the currently 
-implemented list is: F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, Pause, 
+This option specifies the key which brings up the popup menu. The currently
+supported list is: F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, Pause,
 Print, Scroll_Lock, Escape, Insert, Delete, Home, Page_Up, Page_Down).
 Default is F8.