commit 6dccc5c610637532dfbc806855be3f6f84eced05
parent 73f02eea6e5f55e5ca85cdffbd6feced50f85e99
Author: James Wescott <james@wescottdesign.com>
Date: Sat, 8 Jul 2017 12:44:29 -0700
Added indicator position to documentation
Diffstat:
2 files changed, 24 insertions(+), 12 deletions(-)
diff --git a/README.md b/README.md
@@ -41,13 +41,14 @@ Many little improvements have been made to i3lock over time:
- `-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. Expressions using the variables x (current screen's x value), y (current screen's y value), w (screen width), h (screen height), ix (indicator x position), iy (indicator y position) cw (clock width), and ch (clock height) can be used..
+ - `--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 `timepos` can be used here, as well as the additional values tx (time x) and ty (time 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
diff --git a/i3lock.1 b/i3lock.1
@@ -182,6 +182,25 @@ Sets the color of the 'separtor', which is at both ends of the ring highlights.
Sets the color of the status text ("verifying...", "wrong!", etc).
.TP
+.B \-\-indpos="x position:y position"
+Sets the position for the unlock indicator. Valid variables include:
+
+.RS
+.RS
+x - x position of the current display. Corresponds to the leftmost row of pixels on that display.
+
+y - y position of the current display. Corresponds to the topmost row of pixels on that display.
+
+w - width of the current display.
+
+h - height of the current display.
+
+r - the unlock indicator radius.
+
+.RE
+.RE
+
+.TP
.B \-\-timecolor=rrggbbaa
Sets the color of the time in the clock.
@@ -199,18 +218,10 @@ Sets the font size for rendering the time string. Defaults to 32.
.TP
.B \-\-timepos="x position:y position"
-Sets the position for the time string. Valid variables include:
+Sets the position for the time string. All the variables from \-\-indpos may be used, in addition to:
.RS
.RS
-x - x position of the current display. Corresponds to the leftmost row of pixels on that display.
-
-y - y position of the current display. Corresponds to the topmost row of pixels on that display.
-
-w - width of the current display.
-
-h - height of the current display.
-
ix - the x value of the indicator on the current display.
iy - the y value of the indicator on the current display.
@@ -239,7 +250,7 @@ Sets the font size for rendering the date string. Defaults to 14.
.TP
.B \-\-datepos="x position:y position"
-Sets the position for the date string. All the variables from \-\-timepos may be used, in addition to:
+Sets the position for the date string. All the variables from \-\-indpos and \-\-timepos may be used, in addition to:
.RS
.RS
