update manpages and readme
This commit is contained in:
Pandora
parent
dbea946a29
commit
2c41db03ca
80
README.md
80
README.md
|
|
@ -3,7 +3,7 @@ i3lock - improved screen locker
|
|||
|
||||
_This is just a re-patched version of i3lock with the commits from [i3lock-color](https://github.com/eBrnd/i3lock-color); all the credit for the color functionality goes to [eBrnd](https://github.com/eBrnd/) !_
|
||||
|
||||
|
||||
|
||||
|
||||
i3lock is a simple screen locker like slock. After starting it, you will
|
||||
see a white screen (you can configure the color/an image). You can return
|
||||
|
|
@ -15,58 +15,32 @@ Many little improvements have been made to i3lock over time:
|
|||
(run "i3lock && echo mem > /sys/power/state" to get a locked screen
|
||||
after waking up your computer from suspend to RAM)
|
||||
|
||||
- You can specify either a background color or a PNG image which will be
|
||||
- You can specify either a background color or an image (JPG or PNG), which will be
|
||||
displayed while your screen is locked.
|
||||
|
||||
- You can also specify additional color options with the following command-line options:
|
||||
- `--insidevercolor=rrggbbaa` -- Inside of the circle while the password is being verified
|
||||
- `--insidewrongcolor=rrggbbaa` -- Inside of the circle when a wrong password was entered
|
||||
- `--insidecolor=rrggbbaa` -- Inside of the circle while typing/idle
|
||||
- `--ringvercolor=rrggbbaa` -- Outer ring while the password is being verified
|
||||
- `--ringwrongcolor=rrggbbaa` -- Outer ring when a wrong password was entered
|
||||
- `--ringcolor=rrggbbaa` -- Outer ring while typing/idle
|
||||
- `--linecolor=rrggbbaa` -- Line separating outer ring from inside of the circle
|
||||
- `--separatorcolor=rrggbbaa` -- Lines delimiting the highlight segments
|
||||
- `--textcolor=rrggbbaa` -- Text ("verifying", "wrong!")
|
||||
- `--keyhlcolor=rrggbbaa` -- Keypress highlight segments
|
||||
- `--bshlcolor=rrggbbaa` -- Backspace highlight segments
|
||||
- `--line-uses-ring`, `-r` -- the line between the inside and outer ring uses the ring color for its color
|
||||
- `--line-uses-inside`, `-s` -- the line between the inside and outer ring uses the inside color for its color
|
||||
- The following additional options have been added:
|
||||
- `-S, --screen` -- specifies which display to draw the unlock indicator on
|
||||
- `-k, --clock` -- enables the clock display.
|
||||
- `--indicator` -- forces the indicator to always show, even if there's no activity.
|
||||
- `--composite` -- enables checking for compositors and trying to grab the compositor window, since that causes issues with some compositors.
|
||||
- **NOTE**: This can potentially allow sensitive information to display over the screen locker, so take care when you use this option.
|
||||
- `-B=sigma, --blur` -- enables Gaussian blur. Sigma is the blur radius.
|
||||
- Note: You can still composite images over the blur (but still under the indicator) with -i.
|
||||
- Eventually there might be an `imagepos` arg, similar to `time` and `datepos`.
|
||||
- `--indpos="x+(w/2):y+(h/2)"` -- position of the unlock indicator. Expressions using the variables x (current screen's x value), y (current screen's y value), w (screen width), h (screen height), and r (indicator radius) can be used.
|
||||
- `--timestr="%H:%M:%S"` -- allows custom overriding of the time format string. Accepts `strftime` formatting. Default is `"%H:%M:%S"`.
|
||||
- `--timepos="ix:iy-20"` -- position of the time. All the variables in `indpos` can be used here, as well as the additional values ix (indicator x position), iy (indicator y position), cw (clock width), and ch (clock height).
|
||||
- `--timecolor=rrggbbaa` -- color of the time string
|
||||
- `--timefont="sans-serif"` -- font used for the time display
|
||||
- `--timesize=32` -- font size for the time display
|
||||
- `--datestr="%A, %m %Y"` -- allows custom overriding of the date format string. Accepts `strftime` formatting. Default is `"%A, %m %Y"`.
|
||||
- `--datepos="ix:iy-20"` -- position of the date. All the variables in `indpos` and `timepos` can be used here, as well as the additional values tx (time x) and ty (time y).
|
||||
- `--datecolor=rrggbbaa` -- color of the date string
|
||||
- `--datefont="sans-serif"` -- font used for the date display
|
||||
- `--datesize=14` -- font size for the date display
|
||||
- `--veriftext="verifying…"` -- text to be shown while verifying
|
||||
- `--wrongtext="wrong!"` -- text to be shown upon an incorrect password being entered
|
||||
- `--statusfont="sans-serif"` -- font used for the status text
|
||||
- `--textsize=28` -- font size for the status text
|
||||
- `--modsize=14` -- font size for the modifier keys listing
|
||||
- `--radius=90` -- the radius of the circle indicator
|
||||
- `--ring-width=7` -- the width of the indicator ring
|
||||
|
||||
- The readme's list of options might be a bit out of date - please check the manpage, or look at the list of options in i3lock.c.
|
||||
|
||||
- You can specify whether i3lock should bell upon a wrong password.
|
||||
|
||||
- i3lock uses PAM and therefore is compatible with LDAP etc.
|
||||
On OpenBSD i3lock uses the bsd\_auth(3) framework.
|
||||
|
||||
## Additional features in this fork
|
||||
- You can also specify additional options, as detailed in the manpage. This includes, but is not limited to, the following:
|
||||
- Color options for the following:
|
||||
- verification ring
|
||||
- interior ring color
|
||||
- ring interior line color
|
||||
- key highlight color
|
||||
- backspace highlight color
|
||||
- text colors for most/all strings
|
||||
- Changing all of the above depending on PAM's authentication status
|
||||
- Blurring the current screen and using that as the lock background
|
||||
- Showing a clock in the indicator
|
||||
- refreshing on a timer, instead of on each keypress
|
||||
- Positioning the various UI elements
|
||||
- Changing the ring radius and thickness, as well as text size
|
||||
- A new bar indicator, which replaces the ring indicator with its own set of options
|
||||
- An experimental thread for driving the redraw ticks, so that things like the bar/clock still update when PAM is blocking
|
||||
|
||||
## Building
|
||||
|
||||
Before you build - check and see if there's a packaged version available for your distro (there usually is, either in a community repo/PPA).
|
||||
|
|
@ -81,25 +55,17 @@ i3lock now uses GNU autotools for building; you'll need to do something like `au
|
|||
- libxcb-util
|
||||
- libpam-dev
|
||||
- libcairo-dev
|
||||
- libfontconfig-dev
|
||||
- libxcb-composite0
|
||||
- libxcb-composite0-dev
|
||||
- libxcb-xinerama
|
||||
- libxcb-randr
|
||||
- libev
|
||||
- libx11-dev
|
||||
- libx11-xcb-dev
|
||||
- libxkbcommon >= 0.5.0
|
||||
- libxkbcommon-x11 >= 0.5.0
|
||||
- libjpeg-turbo >= 1.4.90
|
||||
|
||||
(On centos/RHEL/etc, the packages tend to look like `cairo-devel` instead of `libcairo-dev`. Use `yum provides \*/<header.h>` to figure out what packages you need.)
|
||||
|
||||
##### Ubuntu
|
||||
|
||||
sudo apt-get install pkg-config libxcb1 libpam-dev libcairo-dev libxcb-composite0 libxcb-composite0-dev libxcb-xinerama0-dev libev-dev libx11-dev libx11-xcb-dev libxkbcommon0 libxkbcommon-x11-0 libxcb-dpms0-dev libxcb-image0-dev libxcb-util0-dev libxcb-xkb-dev libxkbcommon-x11-dev libxkbcommon-dev
|
||||
|
||||
For JPEG lock image support, you'll also need `libjpeg-turbo8` version 1.4.90 or newer (Ubuntu 17.04 or later)
|
||||
|
||||
##### Aur Package
|
||||
[Stable](https://aur.archlinux.org/packages/i3lock-color/)
|
||||
|
||||
|
|
@ -110,11 +76,11 @@ Running i3lock
|
|||
Simply invoke the 'i3lock' command. To get out of it, enter your password and
|
||||
press enter.
|
||||
|
||||
A [sample script](https://github.com/chrjguill/i3lock-color/blob/master/lock.sh) is included in this repository. [Here](https://streamable.com/fpl46) is a short clip of that script in action!
|
||||
A [sample script](https://github.com/PandorasFox/i3lock-color/blob/master/lock.sh) is included in this repository. [Here](https://streamable.com/fpl46) is a short clip of that script in action!
|
||||
|
||||
On OpenBSD the `i3lock` binary needs to be setgid `auth` to call the
|
||||
authentication helpers, e.g. `/usr/libexec/auth/login_passwd`.
|
||||
|
||||
Upstream
|
||||
--------
|
||||
Please submit pull requests for i3lock things to https://github.com/i3/i3lock and pull requests for color things to me at https://github.com/chrjguill/i3lock-color.
|
||||
Please submit pull requests for i3lock things to https://github.com/i3/i3lock and pull requests for features to me here at https://github.com/PandorasFox/i3lock-color.
|
||||
|
|
|
|||
52
i3lock.1
52
i3lock.1
|
|
@ -296,8 +296,8 @@ ty - the computed y value of the timestring, for the current display.
|
|||
.RE
|
||||
|
||||
.TP
|
||||
.B \-\-refresh\-rate=seconds
|
||||
The refresh rate of the indicator, given in seconds. This should automatically align itself, but is somewhat buggy currently.
|
||||
.B \-\-refresh\-rate=seconds-as-double
|
||||
The refresh rate of the indicator, given in seconds. This should automatically align itself, but is somewhat buggy currently. Values less than one will work, but may result in poor system performance.
|
||||
|
||||
.TP
|
||||
.B \-\-veriftext="text"
|
||||
|
|
@ -319,6 +319,52 @@ The fontsize of the text listing all the active modifiers (caps lock, num lock,
|
|||
.B \-\-radius
|
||||
The radius of the circle. Defaults to 90.
|
||||
|
||||
.TP
|
||||
.B \-\-bar\-indicator
|
||||
Replaces the usual ring indicator with a bar indicator, with a variety of options.
|
||||
|
||||
.TP
|
||||
.B \-\-redraw\-thread
|
||||
Starts a separate thread for redrawing the screen. Potentially worse for security, but makes the bar indicator still do its usual periodic redraws when PAM is authenticating.
|
||||
|
||||
.TP
|
||||
.B \-\-bar\-direction={0, 1, 2}
|
||||
Sets the direction the bars grow in. 0 is the default (downwards, or rightwards, depending on the bar orientation). 1 is the reverse, and 2 is both.
|
||||
|
||||
.TP
|
||||
.B \-\-bar\-width=15
|
||||
Sets the width of the minibars in the bar.
|
||||
|
||||
.TP
|
||||
.B \-\-bar\-orientation={vertical,horizontal}
|
||||
Sets whether the bar is vertically or horizontally oriented. Defaults to horizontal.
|
||||
|
||||
.TP
|
||||
.B \-\-bar\-step
|
||||
Sets the step that each bar decreases by when a key is pressed. A random bar is set to its max height, and then each neighbor is set to (height - step*distance).
|
||||
|
||||
.TP
|
||||
.B \-\-bar\-max\-height
|
||||
The maximum height a bar can get to. When a key is pressed, a random bar is set to this value, and then its neighbors are set to its height, minus the step value.
|
||||
|
||||
.TP
|
||||
.B \-\-bar\-base\-width
|
||||
The thickness of the "base" bar that all the bars originate from. This bar also takes on the ring verif and wrong colors to give authentication feedback.
|
||||
|
||||
.TP
|
||||
.B \-\-bar\-color
|
||||
Sets the default color of the bar base.
|
||||
|
||||
.TP
|
||||
.B \-\-bar\-periodic\-step
|
||||
The value by which the bars decrease each time the screen is redrawn.
|
||||
|
||||
.TP
|
||||
.B \-\-bar\-position
|
||||
Works similarly to the time/date/indicator expressions. If the bar is horizontal, this sets the vertical offset from the top edge. If it's vertically oriented, this sets the horizontal offset from the left edge.
|
||||
|
||||
|
||||
|
||||
.SH DPMS
|
||||
|
||||
The \-d (\-\-dpms) option was removed from i3lock in version 2.8. There were
|
||||
|
|
@ -350,3 +396,5 @@ The \-I (-\-inactivity-timeout=seconds) was removed because it only makes sense
|
|||
Michael Stapelberg <michael+i3lock at stapelberg dot de>
|
||||
|
||||
Jan-Erik Rediger <badboy at archlinux.us>
|
||||
|
||||
Pandora <pandora at techfo dot xyz>
|
||||
|
|
|
|||
Loading…
Reference in New Issue