aboutsummaryrefslogtreecommitdiffstats
path: root/vncviewer/vncviewer.man
diff options
context:
space:
mode:
authorMathias Jonsson <math.jonsson@gmail.com>2018-04-22 19:10:30 +0200
committerMathias Jonsson <math.jonsson@gmail.com>2018-05-22 22:48:41 +0200
commit50439d78fae2828356bfde789ec5c4fd0911ae09 (patch)
tree5b7828255715e8073b259cb39e110fb59dfceb4a /vncviewer/vncviewer.man
parent105177fc07d07521eafdcf373c1825a59b9c554d (diff)
downloadtigervnc-50439d78fae2828356bfde789ec5c4fd0911ae09.tar.gz
tigervnc-50439d78fae2828356bfde789ec5c4fd0911ae09.zip
Accept a cfg as an argument as an alt way to start the viewer
The user can specify a tigervnc configuration file as an argument to the viewer. Previously the viewer assumed this to be a server, but now we will first check if there is any file matching the given argument. If so, try to load the content of that file, like we normally do. Fixes issue #38.
Diffstat (limited to 'vncviewer/vncviewer.man')
-rw-r--r--vncviewer/vncviewer.man16
1 files changed, 16 insertions, 0 deletions
diff --git a/vncviewer/vncviewer.man b/vncviewer/vncviewer.man
index 22b46cd5..729c01d6 100644
--- a/vncviewer/vncviewer.man
+++ b/vncviewer/vncviewer.man
@@ -14,6 +14,10 @@ vncviewer \- VNC viewer for X
.RI [ options ]
.B \-listen
.RI [ port ]
+.br
+.B vncviewer
+.RI [ options ]
+.RI [ .tigervnc file ]
.SH DESCRIPTION
.B vncviewer
is a viewer (client) for Virtual Network Computing. This manual page documents
@@ -31,6 +35,18 @@ VNC server on that machine. Either the machine name or display number can be
omitted. So for example ":1" means display number 1 on the same machine, and
"snoopy" means "snoopy:0" i.e. display 0 on machine "snoopy".
+As another quick way to start a connection to a VNC server, specify a .tigervnc
+configuration file as an argument to the viewer, e.g.:
+
+.RS
+vncviewer ./some.tigervnc
+.RE
+
+where './some.tigervnc' is an existing and valid TigerVNC configuration file.
+The file name needs to include a path separator. Additional options may be
+given too, but the given configuration file will overwrite any conflicting
+parameters.
+
If the VNC server is successfully contacted, you will be prompted for a
password to authenticate you. If the password is correct, a window will appear
showing the desktop of the VNC server.