From 2b8374f5446466a291118c18d6a0355e55d01645 Mon Sep 17 00:00:00 2001 From: Dmitry Maksyoma Date: Sat, 13 Mar 2021 20:07:06 +1300 Subject: [PATCH] Update vncpasswd manual page --- unix/vncpasswd/vncpasswd.man | 74 ++++++++++++++++++++++++++++-------- 1 file changed, 58 insertions(+), 16 deletions(-) diff --git a/unix/vncpasswd/vncpasswd.man b/unix/vncpasswd/vncpasswd.man index ecf2bc9..9894c78 100644 --- a/unix/vncpasswd/vncpasswd.man +++ b/unix/vncpasswd/vncpasswd.man @@ -2,18 +2,15 @@ .SH NAME vncpasswd \- change the VNC password .SH SYNOPSIS -\fBvncpasswd\fR [\fIpasswd-file\fR] -.br -\fBvncpasswd\fR \-f +\fBvncpasswd\fR -u [\fIusername\fR] [\fI-wnod\fR] [\fIpasswd-file\fR] .SH DESCRIPTION .B vncpasswd allows you to set the password used to access VNC desktops. Its default behavior is to prompt for a VNC password and then store an obfuscated version -of this password to \fIpasswd-file\fR (or to $HOME/.vnc/passwd if no password -file is specified.) The \fBvncserver\fP script runs \fBvncpasswd\fP the first -time you start a VNC desktop, and it invokes \fBXvnc\fP with the appropriate -\fB\-rfbauth\fP option. \fBvncviewer\fP can also be given a password file to -use via the \fB\-passwd\fP option. +of this password to \fIpasswd-file\fR (or to $HOME/.kasmpasswd if no password +file is specified.) The \fBvncserver\fP script will ask you to add a user +the first time you start a VNC desktop. HTTP Basic Authentication will be used +to ask for username and password, when you connect. The password must be at least six characters long (unless the \fB\-f\fR command-line option is used-- see below), and only the first eight @@ -27,22 +24,67 @@ crack the password simply by snooping on the network. .SH OPTIONS .TP -.B \-f -Filter mode. Read a plain-text password from stdin and write an encrypted -version to stdout. Note that in filter mode, short or even empty passwords -will be silently accepted. +.B \-u \fIname\fR -A view-only password must be separated from the normal password by a newline -character. +Specify user name. There can be multiple users. +.TP +.B \-w + +Write permission. Enable user to use mouse and keyboard. The default mode is to +view only. + +.TP +.B \-o + +Owner permission. Allow the user to add/delete users and change their +permissions. + +.TP +.B \-d + +Delete user specified with \fI-u\fR. You need the owner permission for that. + +.TP +.B \-n + +Don't update their password, while updating permissions. .SH FILES .TP -$HOME/.vnc/passwd +$HOME/.kasmpasswd Default location of the VNC password file. +.SH EXAMPLES +.TP +Create a new user foo that can to use mouse and keyboard: +$ vncpasswd -u foo -w + +.TP +Create a new user foo that can view, but can't use mouse and keyboard: +$ vncpasswd -u foo + +.TP +Create a new user foo that can add new users AND use mouse and keyboard: +$ vncpasswd -u foo -ow + +.TP +Delete user foo +$ vncpasswd -u foo -d + +.TP +Strip all permissions from user foo, making it view only. Don't touch password. +$ vncpasswd -u foo -n + +.TP +Strip all permissions from user foo, making it view only. Change password. +$ vncpasswd -u foo + +.TP +Add write permission for user foo. Don't touch password. +$ vncpasswd -u foo -w -n + .SH SEE ALSO -.BR vncviewer (1), .BR vncserver (1), .BR Xvnc (1) .BR vncconfig (1),