make the readme prettier; add To-do
This commit is contained in:
Chris Guillott
parent
34c2d5e1a3
commit
1beed9bc16
72
README.md
72
README.md
|
|
@ -1,24 +1,60 @@
|
||||||
i3lock-color
|
i3lock-color - improved screen locker
|
||||||
============
|
===============================
|
||||||
|
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
|
||||||
|
to your screen by entering your password.
|
||||||
|
|
||||||
*making i3lock's typing indicator color scheme configurable*
|
Many little improvements have been made to i3lock over time:
|
||||||
|
|
||||||
I added the following command line options:
|
- i3lock forks, so you can combine it with an alias to suspend to RAM
|
||||||
* `--insidevercolor=rrggbbaa` -- Inside of the circle while the password is being verified
|
(run "i3lock && echo mem > /sys/power/state" to get a locked screen
|
||||||
* `--insidewrongcolor=rrggbbaa` -- Inside of the circle when a wrong password was entered
|
after waking up your computer from suspend to RAM)
|
||||||
* `--insidecolor=rrggbbaa` -- Inside of the circle while typing/idle
|
|
||||||
* `--ringvercolor=rrggbbaa` -- Outer ring while the password is being
|
|
||||||
* `--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 and delimiting the highlight segments
|
|
||||||
* `--textcolor=rrggbbaa` -- Text ("verifying", "wrong!")
|
|
||||||
* `--keyhlcolor=rrggbbaa` -- Keypress highlight segments
|
|
||||||
* `--bshlcolor=rrggbbaa` -- Backspace highlight segments
|
|
||||||
|
|
||||||
All the colors have an alpha channel now. Please keep in mind that this was not intended when the program was originally written, so making thing transparent that weren't before can make it look strange.
|
- You can specify either a background color or a PNG image which will be
|
||||||
|
displayed while your screen is locked.
|
||||||
|
|
||||||
### Examples:
|
- 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
|
||||||
|
- `--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 and delimiting the highlight segments
|
||||||
|
- `--textcolor=rrggbbaa` -- Text ("verifying", "wrong!")
|
||||||
|
- `--keyhlcolor=rrggbbaa` -- Keypress highlight segments
|
||||||
|
- `--bshlcolor=rrggbbaa` -- Backspace highlight segments
|
||||||
|
- All the colors have an alpha channel now. Please keep in mind that this was not intended when the program was originally written, so making things transparent that weren't before can make it look strange.
|
||||||
|
|
||||||
i3lock --insidevercolor=0000a0bf --insidewrongcolor=ff8000bf --insidecolor=ffffffbf --ringvercolor=0020ffff --ringwrongcolor=4040ffff --ringcolor=404090ff --textcolor=ffffffff --linecolor=aaaaaaff --keyhlcolor=30ccccff --bshlcolor=ff8000ff
|
- You can specify whether i3lock should bell upon a wrong password.
|
||||||
|
|
||||||
Refer to the original README file for general information and libraries you need.
|
- i3lock uses PAM and therefore is compatible with LDAP etc.
|
||||||
|
|
||||||
|
Requirements
|
||||||
|
------------
|
||||||
|
- pkg-config
|
||||||
|
- libxcb
|
||||||
|
- libxcb-util
|
||||||
|
- libpam-dev
|
||||||
|
- libcairo-dev
|
||||||
|
- libxcb-xinerama
|
||||||
|
- libev
|
||||||
|
- libx11-dev
|
||||||
|
- libx11-xcb-dev
|
||||||
|
- libxkbcommon >= 0.5.0
|
||||||
|
- libxkbcommon-x11 >= 0.5.0
|
||||||
|
|
||||||
|
Running i3lock
|
||||||
|
-------------
|
||||||
|
Simply invoke the 'i3lock' command. To get out of it, enter your password and
|
||||||
|
press enter.
|
||||||
|
|
||||||
|
Example usage for colors:
|
||||||
|
|
||||||
|
i3lock --insidevercolor=0000a0bf --insidewrongcolor=ff8000bf --insidecolor=ffffffbf --ringvercolor=0020ffff --ringwrongcolor=4040ffff --ringcolor=404090ff --textcolor=ffffffff
|
||||||
|
--linecolor=aaaaaaff --keyhlcolor=30ccccff --bshlcolor=ff8000ff
|
||||||
|
|
||||||
|
|
||||||
|
Upstream
|
||||||
|
--------
|
||||||
|
Please submit pull requests to https://github.com/i3/i3lock
|
||||||
|
|
|
||||||
|
|
@ -1,41 +0,0 @@
|
||||||
i3lock - improved screen locker
|
|
||||||
===============================
|
|
||||||
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
|
|
||||||
to your screen by entering your password.
|
|
||||||
|
|
||||||
Many little improvements have been made to i3lock over time:
|
|
||||||
|
|
||||||
- i3lock forks, so you can combine it with an alias to suspend to RAM
|
|
||||||
(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
|
|
||||||
displayed while your screen is locked.
|
|
||||||
|
|
||||||
- You can specify whether i3lock should bell upon a wrong password.
|
|
||||||
|
|
||||||
- i3lock uses PAM and therefore is compatible with LDAP etc.
|
|
||||||
|
|
||||||
Requirements
|
|
||||||
------------
|
|
||||||
- pkg-config
|
|
||||||
- libxcb
|
|
||||||
- libxcb-util
|
|
||||||
- libpam-dev
|
|
||||||
- libcairo-dev
|
|
||||||
- libxcb-xinerama
|
|
||||||
- libev
|
|
||||||
- libx11-dev
|
|
||||||
- libx11-xcb-dev
|
|
||||||
- libxkbcommon >= 0.5.0
|
|
||||||
- libxkbcommon-x11 >= 0.5.0
|
|
||||||
|
|
||||||
Running i3lock
|
|
||||||
-------------
|
|
||||||
Simply invoke the 'i3lock' command. To get out of it, enter your password and
|
|
||||||
press enter.
|
|
||||||
|
|
||||||
Upstream
|
|
||||||
--------
|
|
||||||
Please submit pull requests to https://github.com/i3/i3lock
|
|
||||||
|
|
@ -0,0 +1,6 @@
|
||||||
|
st for i3lock with colors
|
||||||
|
===============================
|
||||||
|
* Make alpha a bit less hacky / play better with other colors
|
||||||
|
* Make the arguments less chunky / more concise
|
||||||
|
* Let the user specify 3 colors and have it generate shades based off them
|
||||||
|
* Rainbow mode / random color mode?
|
||||||
Loading…
Reference in New Issue