xsuperlock/xsuperlock.1.in

.TH @PACKAGE_NAME@ 1 2015-11-02 "@PACKAGE_VERSION@" "@PACKAGE_NAME@"

.SH NAME

.B @PACKAGE_NAME@
\- A screen locker.

.SH SYNOPSIS

.B xsuperlock
[options]

.SH DESCRIPTION

.P
XSuperLock is a program that locks the screen by preventing keyboard and mouse
input from getting to other X clients until the correct password has been
entered. Unlike most minimalistic screen lockers, XSuperLock also displays a
password entry dialog, and optionally, runs an xscreensaver-compatible (see
.BR XScreenSaver (1))
screensaver. Every single detail of XSuperLock's operation is configurable using
X resources.
XSuperLock does not automatically lock the screen after any period of inactivity.
That's
.BR xautolock (1)'s
job.

.SH OPTIONS

.TP
.B \-d, --display
The X server display to use.
.TP
.B \-s, --screensaver
The name of the screensaver executable to run.
.TP
.B \--screensaver-dir
The directory that contains screensavers (@DEFAULT_SCREENSAVER_DIR@ by default)
.TP
.B \-o, --screensaver-opts
Parameters to pass to the screensaver. Remember to enclose them in quotes.
.TP
.B \-f, --fade
Fade before locking.
.TP
.B \-h, --help
Print a help message and exit.
.TP
.B \-V, --version
Print version information.

.SH RESOURCES

.P
The following options can be set using X resources:
.TP
.B screensaverName
The name of the screensaver executable to run.
This option can be overriden on the command line using -s or --screensaver.
Default value: none.
.TP
.B screensaverDir
A path to the directory that contains screensaver executables. This option can
be overriden on the command line using --screensaver-dir.
Default value: "@DEFAULT_SCREENSAVER_DIR@".
.TP
.B screensaverOpts
Parameters to pass to the screensaver.
This option can be overriden on the command line using -o or --screensaver-opts.
Default value: none.
.TP
.B password
The password to use for unlocking the screen.
If it is not specified, @PACKAGE_NAME@ will attempt to use your system account's
password. For that to work, @PACKAGE_NAME@ must be able to access the shadowed
passwords file (see
.BR shadow (5)).
Default value: none.
.TP
.B errorTimeout
The amount of seconds during which @PACKAGE_NAME@ ignores all input after an
incorrect password is entered in the prompt.
Default value: 3.
.TP
.B idleTimeout
The amount of time without user activity, in seconds, after which the dialog
will automatically close and resume the screensaver.
Default value: 30.
.TP
.B fadeTimeout
The duration of the initial fade effect, in milliseconds.
Default value: 2000.
.TP
.B dialogWidth
The width of the password entry dialog, in pixels.
Default value: 400.
.TP
.B dialogHeight
The height of the password entry dialog, in pixels.
Default value: 300.
.TP
.B dialogBgColor
The background color of the password entry dialog.
Default value: EEEE/EEEE/EEEE.
.TP
.B timeFormat
The format of the current time that should be displayed (see
.BR strftime (3)).
Default value: "%I:%M:%S %p".
.TP
.B timeLabelFont
The font that @PACKAGE_NAME@ should try to use to display the current time on
the password entry dialog.
Default value: "sans-18:bold".
.TP
.B timeLabelX
The X coordinate of the label that shows the current time.
Default value: 0.
.TP
.B timeLabelY
The Y coordinate of the label that shows the current time.
Default value: 20.
.TP
.B timeLabelColor
The color of the label that shows the current time.
Default value: 0000/0000/0000.
.TP
.B dateFormat
The format of the current date that should be displayed (see
.BR strftime (3)).
Default value: "%Y/%m/%d".
.TP
.B dateLabelFont
The font that should be used to display the current date on the password entry
dialog.
Default value: "sans-12".
.TP
.B dateLabelX
The X coordinate of the label that shows the current date.
Default value: 0.
.TP
.B dateLabelY
The Y coordinate of the label that shows the current time.
Default value: 45.
.TP
.B dateLabelColor
The color of the label that shows the current date.
Default value: 0000/0000/0000.
.TP
.B fullnameLabel
A string that describes what should be displayed on the label that shows the
current user's full name, as explained above.
Default value: "%F".
.TP
.B fullnameLabelFont
The font that should be used to display the current user's full name on the
password entry dialog.
Default value: "sans-18".
.TP
.B fullnameLabelX
The X coordinate of the label that shows the current user's full name.
Default value: 0.
.TP
.B fullnameLabelY
The Y coordinate of the label that shows the current user's full name.
Default value: 100.
.TP
.B fullnameLabelColor
The color of the label that shows the current user's full name.
Default value: 0000/0000/0000.
.TP
.B usernameLabel
A string that describes what should be displayed on the label that shows the
current user's account name, as explained above.
Default value: "%n on %H".
.TP
.B usernameLabelFont
The font that should be used to display the current user's account name on the
password entry dialog.
Default value: "sans-10".
.TP
.B usernameLabelX
The X coordinate of the label that shows the current user's account name.
Default value: 0.
.TP
.B usernameLabelY
The Y coordinate of the label that shows the current user's account name.
Default value: 130.
.TP
.B usernameLabelColor
The color of the label that shows the current user's account name.
Default value: 0000/0000/0000.
.TP
.B passwordLabel
The text on the label that is, by default, to the left of the password field.
Default value: "Password:".
.TP
.B passwordLabelFont
The font that should be used to display the password entry field's label.
Default value: "sans-10".
.TP
.B passwordLabelX
The X coordinate of the password entry field's label.
Default value: 30.
.TP
.B passwordLabelY
The Y coordinate of the password entry field's label.
Default value: 200.
.TP
.B passwordLabelColor
The color of the password entry field's label.
Default value: 0000/0000/0000.
.TP
.B passwordDotSize
The diameter of the dots that are shown in the password field instead of
characters.
.TP
.B passwordFieldWidth
The width of the password entry field, in pixels.
Default value: 250.
.TP
.B passwordFieldHeight
The height of the password entry field, in pixels.
Default value: 20.
.TP
.B passwordFieldBorderWidth
The width of the border that surrounds the password entry field, in pixels.
Default value: 2.
.TP
.B passwordFieldX
The X coordinate of the password entry field.
Default value: -30.
.TP
.B passwordFieldY
The Y coordinate of the password entry field.
Default value: 195.
.TP
.B passwordFieldBorderColor
The color of the password entry field's border.
Default value: 0000/0000/0000.
.TP
.B passwordFieldBgColor
The background color of the password entry field.
Default value: FFFF/FFFF/FFFF.
.TP
.B passwordFieldDotColor
The color of the dots displayed instead of characters in the password entry
field.
Default value: 0000/0000/0000.
.TP
.B incorrectLabel
The text to display when an incorrect password has been entered.
Default value: "Incorrect password!".
.TP
.B incorrectLabelFont
The font of the label that is displayed when an incorrect password has been
entered.
Default value: "sans-10:bold".
.TP
.B incorrectLabelX
The X coordinate of the label that is displayed when an incorrect password has
been entered.
Default value: 0.
.TP
.B incorrectLabelY
The Y coordinate of the label that is displayed when an incorrect password has
been entered.
Default value: 225.
.TP
.B incorrectLabelColor
The color of the label that is displayed when an incorrect password has been
entered.
Default value: FFFF/0000/0000.
.TP
.B buttonWidth
The width, in pixels, of all the buttons on the password entry dialog.
Default value: 95.
.TP
.B buttonHeight
The height, in pixels, of all the buttons on the password entry dialog.
Default value: 25.
.TP
.B buttonBorderWidth
The width of the border for all buttons on the password entry dialog.
Default value: 2.
.TP
.B buttonLabelFont
The font used for button labels.
Default value: "sans-10".
.TP
.B unlockButtonLabel
The label on the button used for confirming the password to unlock the screen.
Default value: "Unlock".
.TP
.B unlockButtonX
The X coordinate of the "unlock" button.
Default value: 100.
.TP
.B unlockButtonY
The Y coordinate of the "unlock" button.
Default value: 260.
.TP
.B unlockButtonBgColor
The background color of the "unlock" button.
Default value: FFFF/FFFF/FFFF.
.TP
.B unlockButtonBorderColor
The border color of the "unlock" button.
Default value: 0000/0000/0000.
.TP
.B unlockButtonLabelColor
The label color of the "unlock" button.
Default value: 0000/0000/0000.
.TP
.B cancelButtonLabel
The label on the button used for closing the dialog while keeping the screen
locked.
Default value: "Cancel".
.TP
.B cancelButtonX
The X coordinate of the "cancel" button.
Default value: 205.
.TP
.B cancelButtonY
The Y coordinate of the "cancel" button.
Default value: 260.
.TP
.B cancelButtonBgColor
The background color of the "cancel" button.
Default value: FFFF/FFFF/FFFF.
.TP
.B cancelButtonBorderColor
The border color of the "cancel" button.
Default value: 0000/0000/0000.
.TP
.B cancelButtonLabelColor
The label color of the "cancel" button.
Default value: 0000/0000/0000.

.SH NOTES

.P
In the above list of resource options, the way in which certain configuration
values are interpreted is not trivial. The following list explains how
@PACKAGE_NAME@ interprets certain types of configuration values:
.TP
.B Colors
Colors are specified as three 4-digit hexadecimal numbers separated by slashes.
The numbers determine the amounts of red, green and blue, respectively.
.TP
.B Fonts
Fonts are specified by their Xft font names. See 
.BR Xft (3).
.TP
.B X coordinates
If the amount of pixels is positive, the object will be left-aligned and
indented by the specified amount of pixels; if it is zero, the object will be
horizontally centered; and if it is negative, the object will be right-aligned
and indented by the absolute value of the specified amount of pixels.
.TP
.B Y coordinates
If the amount of pixels is positive, the object will be top-aligned and
indented by the specified amount of pixels; if it is zero, the object will be
vertically centered; and if it is negative, the object will be bottom-aligned
and indented by the absolute value of the specified amount of pixels.

.P
In the text of the labels that are, by default, used to display the full name
and the account name of the current user, the following character sequences
are replaced by the value they specify:
.TP
.B %n
The account name of the current user.
.TP
.B %u
The UID (user ID) of the current user.
.TP
.B %g
The GID (group ID) of the current user's default group.
.TP
.B %h
The path to the current user's home directory.
.TP
.B %H
The hostname of the local machine.
.TP
.B %s
The default shell of the current user.
.TP
.B %F
The full name of the current user.

.SH BUGS

None that I know of.