Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_tigervnc / refs/heads/android-16 / . / unix / vncpasswd / vncpasswd.man
blob: 9e681815b98abdd84578178db172d489ecaada3f [file] [log] [blame]
Pierre Ossmanf256a1a2014-09-17 14:09:58 +0200[diff] [blame]1.TH vncpasswd 1 "" "TigerVNC" "Virtual Network Computing"
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000[diff] [blame]2.SH NAME
DRC7f9ea272010-07-09 19:37:14 +0000[diff] [blame]3vncpasswd \- change the VNC password
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000[diff] [blame]4.SH SYNOPSIS
DRC7f9ea272010-07-09 19:37:14 +0000[diff] [blame]5\fBvncpasswd\fR [\fIpasswd-file\fR]
6.br
7\fBvncpasswd\fR \-f
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000[diff] [blame]8.SH DESCRIPTION
9.B vncpasswd
DRC7f9ea272010-07-09 19:37:14 +0000[diff] [blame]10allows you to set the password used to access VNC desktops. Its default
11behavior is to prompt for a VNC password and then store an obfuscated version
12of this password to \fIpasswd-file\fR (or to $HOME/.vnc/passwd if no password
13file is specified.) The \fBvncserver\fP script runs \fBvncpasswd\fP the first
14time you start a VNC desktop, and it invokes \fBXvnc\fP with the appropriate
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000[diff] [blame]15\fB\-rfbauth\fP option. \fBvncviewer\fP can also be given a password file to
16use via the \fB\-passwd\fP option.
17
DRC7f9ea272010-07-09 19:37:14 +0000[diff] [blame]18The password must be at least six characters long (unless the \fB\-f\fR
19command-line option is used-- see below), and only the first eight
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000[diff] [blame]20characters are significant. Note that the stored password is \fBnot\fP
21encrypted securely - anyone who has access to this file can trivially find out
DRC7f9ea272010-07-09 19:37:14 +0000[diff] [blame]22the plain-text password, so \fBvncpasswd\fP always sets appropriate permissions
23(read and write only by the owner.) However, when accessing a VNC desktop, a
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000[diff] [blame]24challenge-response mechanism is used over the wire making it hard for anyone to
25crack the password simply by snooping on the network.
26
DRC7f9ea272010-07-09 19:37:14 +0000[diff] [blame]27.SH OPTIONS
28
29.TP
30.B \-f
31Filter mode. Read a plain-text password from stdin and write an encrypted
32version to stdout. Note that in filter mode, short or even empty passwords
33will be silently accepted.
34
Pierre Ossmane58fcb92018-05-07 16:03:45 +0200[diff] [blame]35A view-only password must be separated from the normal password by a newline
36character.
37
DRC7f9ea272010-07-09 19:37:14 +0000[diff] [blame]38
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000[diff] [blame]39.SH FILES
40.TP
41$HOME/.vnc/passwd
42Default location of the VNC password file.
43
44.SH SEE ALSO
45.BR vncviewer (1),
46.BR vncserver (1),
47.BR Xvnc (1)
48.BR vncconfig (1),
49.br
Pierre Ossman32b96ff2018-10-19 14:56:53 +0200[diff] [blame]50https://www.tigervnc.org
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000[diff] [blame]51
DRC7f9ea272010-07-09 19:37:14 +0000[diff] [blame]52.SH AUTHORS
Pierre Ossmane37a1442014-09-17 14:08:16 +0200[diff] [blame]53Tristan Richardson, RealVNC Ltd., Antoine Martin, D. R. Commander and others.
Constantin Kaplinskyb30ae7f2006-05-25 05:04:46 +0000[diff] [blame]54
55VNC was originally developed by the RealVNC team while at Olivetti
Constantin Kaplinskybe1bda82006-06-02 04:43:52 +0000[diff] [blame]56Research Ltd / AT&T Laboratories Cambridge. TightVNC additions were
Pierre Ossmane37a1442014-09-17 14:08:16 +0200[diff] [blame]57implemented by Constantin Kaplinsky. Many other people have since
58participated in development, testing and support. This manual is part
59of the TigerVNC software suite.