1 files changed, 298 insertions, 0 deletions
diff --git a/i3lock-extended.1 b/i3lock-extended.1
new file mode 100644
index 0000000..b0f51a7
--- /dev/null
+++ b/i3lock-extended.1
@@ -0,0 +1,298 @@
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.TH i3lock\-extended 1 "MARCH 2020" Linux "User Manuals"
+.SH NAME
+i3lock\-extended \- improved screen locker
+.SH SYNOPSIS
+.B i3lock\-extended
+.RB [\|\-B
+.IR color \|]
+.RB [\|\-b\|]
+.RB [\|\-c
+.IR color \|]
+.RB [\|\-D\|]
+.RB [\|\-E\|]
+.RB [\|\-e\|]
+.RB [\|\-F
+.IR color \|]
+.RB [\|\-f\|]
+.RB [\|\-G
+.IR color \|]
+.RB [\|\-i
+.IR image.png \|]
+.RB [\|\-J
+.IR text \|]
+.RB [\|\-L\|]
+.RB [\|\-n\|]
+.RB [\|\-O
+.IR color \|]
+.RB [\|\-p
+.IR pointer\|]
+.RB [\|\-R
+.IR color \|]
+.RB [\|\-r
+.IR refresh rate \|]
+.RB [\|\-S
+.IR size \|]
+.RB [\|\-T
+.IR template \|]
+.RB [\|\-t\|]
+.RB [\|\-u\|]
+.RB [\|\-v\|]
+.RB [\|\-W
+.IR halign \|]
+.RB [\|\-X
+.IR halign \|]
+.RB [\|\-x
+.IR halign \|]
+.RB [\|\-Y
+.IR valign \|]
+.RB [\|\-y
+.IR valign \|]
+.RB [\|\-Z
+.IR valign \|]
+.SH DESCRIPTION
+.B i3lock-extended
+is a fork of i3lock which is a simple screen locker like slock.
+i3lock-extended has all the i3lock features and some additional ones. 
+Hence this manual will refer to i3lock-extended only when describing these
+additional features. 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.
+.SH IMPROVEMENTS
+.IP \[bu] 2
+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)
+.IP \[bu]
+You can specify either a background color or a PNG image which will be displayed while your screen is locked.
+.IP \[bu]
+You can specify whether i3lock should bell upon a wrong password.
+.IP \[bu]
+i3lock uses PAM and therefore is compatible with LDAP, etc.
+.SH EXTENDED FUNCTIONALITY
+.B i3lock\-extended
+provides the following additional functionality:
+.IP \[bu] 2
+LED-clock
+.IP \[bu]
+Digital clock
+.IP \[bu]
+Elapsed time since activation
+.IP \[bu]
+Display-text
+.SH OPTIONS
+.TP
+.BI \-B\  rrggbb \fR,\ \fB\-\-led\-border\-color= rrggbb
+The border color of the LED clock.
+format: rrggbb (i.e. ff0000 is red). Default: 000000 (black).
+.TP
+.B \-b, \-\-beep
+Enable beeping. Be sure to not do this when you are about to annoy other people,
+like when opening your laptop in a boring lecture.
+.TP
+.BI \-c\  rrggbb \fR,\ \fB\-\-color= rrggbb
+Turn the screen into the given color instead of white.
+Color must be given in 3-byte. Default: ffffff (white).
+.TP
+.B \-D, \-\-digital\-clock
+Display digital clock.
+.TP
+.B \-\-debug
+Enables debug logging.
+Note, that this will log the password used for authentication to stdout.
+.TP
+.B \-E, \-\-elapsed\-time
+Display the elapsed time since i3lock-extended was activated.
+.TP
+.B \-e, \-\-ignore-empty-password
+When an empty password is provided by the user, do not validate
+it. Without this option, the empty password will be provided to PAM
+and, if invalid, the user will have to wait a few seconds before
+another try. This can be useful if the XF86ScreenSaver key is used to
+put a laptop to sleep and bounce on resume or if you happen to wake up
+your computer with the enter key.
+.TP
+.BI \-F\  rrggbb \fR,\ \fB\-\-led\-off\-color= rrggbb
+The color of the off-LED in the LED-clock. Default: 7f7f7f.
+.TP
+.B \-f, \-\-show-failed-attempts
+Show the number of failed attempts, if any.
+.TP
+.BI \-G\  rrggbb \fR,\ \fB\-\-digital\-clock\-color= rrggbb
+The color of the digital-clock (text). Default: 000000 (black).
+.TP
+.BI \-i\  path \fR,\ \fB\-\-image= path
+Display the given PNG image instead of a blank screen.
+.TP
+.BI \-J\  text \fR,\ \fB\-\-display\-text= text
+Display text instead of elapsed time, using the same color and alignment.
+.TP
+.B \-L, \-\-led\-clock
+Display LED-clock.
+.TP
+.B \-n, \-\-nofork
+Don't fork after starting.
+.TP
+.BI \-O\  rrggbb \fR,\ \fB\-\-led\-on\-color= rrggbb
+The color of the on-LED in the LED-clock. Default: ffff00 (yellow).
+.TP
+.BI \-p\  win|default \fR,\ \fB\-\-pointer= win|default
+If you specify "default",
+.B i3lock
+does not hide your mouse pointer. If you specify "win",
+.B i3lock
+displays a hardcoded Windows-Pointer (thus enabling you to mess with your
+friends by using a screenshot of a Windows desktop as a locking-screen).
+.TP
+.BI \-R\  rrggbb \fR,\ \fB\-\-elapsed\-time\-color= rrggbb
+The color of the elapsed time (text). Default: 000000 (black).
+.TP
+.BI \-r\  rate \fR,\ \fB\-\-refresh\-rate= rate
+Rate is the amount of times per second we refresh the screen. Default: 2.
+.TP
+.BI \fB\-\-raw= format
+Read the image given by \-\-image as a raw image instead of PNG. The argument is the image's format
+as <width>x<height>:<pixfmt>. The supported pixel formats are:
+\'native', 'rgb', 'xrgb', 'rgbx', 'bgr', 'xbgr', and 'bgrx'.
+The "native" pixel format expects a pixel as a 32-bit (4-byte) integer in
+the machine's native endianness, with the upper 8 bits unused. Red, green and blue are stored in
+the remaining bits, in that order.
+.BR Example:
+.Vb 6
+\&      --raw=1920x1080:rgb
+.Ve
+.BR
+You can use ImageMagick’s
+.IR convert(1)
+program to feed raw images into i3lock:
+.BR
+.Vb 6
+\&      convert wallpaper.jpg RGB:- | i3lock --raw 3840x2160:rgb --image /dev/stdin
+.Ve
+This allows you to load a variety of image formats without i3lock having to
+support each one explicitly.
+.TP
+.BI \-S\  size \fR,\ \fB\-\-text\-size= size
+The text size for elapsed time, digital clock and display-text. Default: 28.
+.TP
+.BI \-T\  template \fR,\ \fB\-\-digital\-clock\-template= template
+The date(time) template for the digital clock. Default: %H:%M:%S.
+.TP
+.B \-t, \-\-tiling
+If an image is specified (via \-i) it will display the image tiled all over the screen
+(if it is a multi-monitor setup, the image is visible on all screens).
+.TP
+.B \-u, \-\-no-unlock-indicator
+Disable the unlock indicator. i3lock will by default show an unlock indicator
+after pressing keys. This will give feedback for every keypress and it will
+show you the current PAM state (whether your password is currently being
+verified or whether it is wrong).
+.TP
+.B \-v, \-\-version
+Display the version of your
+.B i3lock
+.TP
+.BI \-W\  halign \fR,\ \fB\-\-elapsed\-time\-halign= halign
+The horizontal alignment for elapsed time and display-text.
+Valid halign values: left, center, right. Default: right
+.TP
+.BI \-X\  halign \fR,\ \fB\-\-led\-clock\-halign= halign
+The horizontal alignment for the LED-clock. Default: center
+.TP
+.BI \-x\  halign \fR,\ \fB\-\-digital\-clock\-halign= halign
+The horizontal alignment for the digital clock. Default: left
+.TP
+.BI \-Y\  valign \fR,\ \fB\-\-led\-clock\-valign= valign
+The vertical alignment for the LED-clock.
+Valid valign values: top, middle, bottom. Default: bottom
+.TP
+.BI \-y\  valign \fR,\ \fB\-\-digital\-clock\-valign= valign
+The vertical alignment for the digital clock. Default: top
+.TP
+.BI \-Z\  valign \fR,\ \fB\-\-elapsed\-time\-valign= valign
+The vertical alignment for elapsed time and display-text. Default: bottom
+.SH DPMS
+The \-d (\-\-dpms) option was removed from i3lock in version 2.8. There were
+plenty of use-cases that were not properly addressed, and plenty of bugs
+surrounding that feature. While features are not normally removed from i3 and
+its tools, we felt the need to make an exception in this case.
+Users who wish to explicitly enable DPMS only when their screen is locked can
+use a wrapper script around i3lock like the following:
+.Vb 6
+\&      #!/bin/sh
+\&      revert() {
+\&        xset dpms 0 0 0
+\&      }
+\&      trap revert HUP INT TERM
+\&      xset +dpms dpms 5 5 5
+\&      i3lock -n
+\&      revert
+.Ve
+The \-I (-\-inactivity-timeout=seconds) was removed because it only makes sense with DPMS.
+.SH SEE ALSO
+.IR xautolock(1)
+\- use i3lock as your screen saver
+.IR convert(1)
+\- feed a wide variety of image formats to i3lock
+.SH AUTHOR
+Michael Stapelberg <michael+i3lock at stapelberg dot de>
+Jan-Erik Rediger <badboy at archlinux.us>
+Simeon Simeonov <sgs (AT) pichove (DOT) org>

diff --git a/i3lock-extended.1 b/i3lock-extended.1 new file mode 100644 index 0000000..b0f51a7 --- /dev/null +++ b/i3lock-extended.1
@@ -0,0 +1,298 @@
	1	.de Vb \" Begin verbatim text
	2	.ft CW
	3	.nf
	4	.ne \\$1
	5	..
	6	.de Ve \" End verbatim text
	7	.ft R
	8	.fi
	9	..
	10
	11	.TH i3lock\-extended 1 "MARCH 2020" Linux "User Manuals"
	12
	13	.SH NAME
	14	i3lock\-extended \- improved screen locker
	15
	16	.SH SYNOPSIS
	17	.B i3lock\-extended
	18	.RB [\\|\-B
	19	.IR color \\|]
	20	.RB [\\|\-b\\|]
	21	.RB [\\|\-c
	22	.IR color \\|]
	23	.RB [\\|\-D\\|]
	24	.RB [\\|\-E\\|]
	25	.RB [\\|\-e\\|]
	26	.RB [\\|\-F
	27	.IR color \\|]
	28	.RB [\\|\-f\\|]
	29	.RB [\\|\-G
	30	.IR color \\|]
	31	.RB [\\|\-i
	32	.IR image.png \\|]
	33	.RB [\\|\-J
	34	.IR text \\|]
	35	.RB [\\|\-L\\|]
	36	.RB [\\|\-n\\|]
	37	.RB [\\|\-O
	38	.IR color \\|]
	39	.RB [\\|\-p
	40	.IR pointer\\|]
	41	.RB [\\|\-R
	42	.IR color \\|]
	43	.RB [\\|\-r
	44	.IR refresh rate \\|]
	45	.RB [\\|\-S
	46	.IR size \\|]
	47	.RB [\\|\-T
	48	.IR template \\|]
	49	.RB [\\|\-t\\|]
	50	.RB [\\|\-u\\|]
	51	.RB [\\|\-v\\|]
	52	.RB [\\|\-W
	53	.IR halign \\|]
	54	.RB [\\|\-X
	55	.IR halign \\|]
	56	.RB [\\|\-x
	57	.IR halign \\|]
	58	.RB [\\|\-Y
	59	.IR valign \\|]
	60	.RB [\\|\-y
	61	.IR valign \\|]
	62	.RB [\\|\-Z
	63	.IR valign \\|]
	64
	65	.SH DESCRIPTION
	66	.B i3lock-extended
	67	is a fork of i3lock which is a simple screen locker like slock.
	68	i3lock-extended has all the i3lock features and some additional ones.
	69	Hence this manual will refer to i3lock-extended only when describing these
	70	additional features. After starting it, you will see a white screen
	71	(you can configure the color/an image). You can return to your screen by
	72	entering your password.
	73
	74	.SH IMPROVEMENTS
	75
	76	.IP \[bu] 2
	77	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)
	78	.IP \[bu]
	79	You can specify either a background color or a PNG image which will be displayed while your screen is locked.
	80	.IP \[bu]
	81	You can specify whether i3lock should bell upon a wrong password.
	82	.IP \[bu]
	83	i3lock uses PAM and therefore is compatible with LDAP, etc.
	84
	85	.SH EXTENDED FUNCTIONALITY
	86	.B i3lock\-extended
	87	provides the following additional functionality:
	88
	89	.IP \[bu] 2
	90	LED-clock
	91	.IP \[bu]
	92	Digital clock
	93	.IP \[bu]
	94	Elapsed time since activation
	95	.IP \[bu]
	96	Display-text
	97
	98	.SH OPTIONS
	99	.TP
	100	.BI \-B\ rrggbb \fR,\ \fB\-\-led\-border\-color= rrggbb
	101	The border color of the LED clock.
	102	format: rrggbb (i.e. ff0000 is red). Default: 000000 (black).
	103
	104	.TP
	105	.B \-b, \-\-beep
	106	Enable beeping. Be sure to not do this when you are about to annoy other people,
	107	like when opening your laptop in a boring lecture.
	108
	109	.TP
	110	.BI \-c\ rrggbb \fR,\ \fB\-\-color= rrggbb
	111	Turn the screen into the given color instead of white.
	112	Color must be given in 3-byte. Default: ffffff (white).
	113
	114	.TP
	115	.B \-D, \-\-digital\-clock
	116	Display digital clock.
	117
	118	.TP
	119	.B \-\-debug
	120	Enables debug logging.
	121	Note, that this will log the password used for authentication to stdout.
	122
	123	.TP
	124	.B \-E, \-\-elapsed\-time
	125	Display the elapsed time since i3lock-extended was activated.
	126
	127	.TP
	128	.B \-e, \-\-ignore-empty-password
	129	When an empty password is provided by the user, do not validate
	130	it. Without this option, the empty password will be provided to PAM
	131	and, if invalid, the user will have to wait a few seconds before
	132	another try. This can be useful if the XF86ScreenSaver key is used to
	133	put a laptop to sleep and bounce on resume or if you happen to wake up
	134	your computer with the enter key.
	135
	136	.TP
	137	.BI \-F\ rrggbb \fR,\ \fB\-\-led\-off\-color= rrggbb
	138	The color of the off-LED in the LED-clock. Default: 7f7f7f.
	139
	140	.TP
	141	.B \-f, \-\-show-failed-attempts
	142	Show the number of failed attempts, if any.
	143
	144	.TP
	145	.BI \-G\ rrggbb \fR,\ \fB\-\-digital\-clock\-color= rrggbb
	146	The color of the digital-clock (text). Default: 000000 (black).
	147
	148	.TP
	149	.BI \-i\ path \fR,\ \fB\-\-image= path
	150	Display the given PNG image instead of a blank screen.
	151
	152	.TP
	153	.BI \-J\ text \fR,\ \fB\-\-display\-text= text
	154	Display text instead of elapsed time, using the same color and alignment.
	155
	156	.TP
	157	.B \-L, \-\-led\-clock
	158	Display LED-clock.
	159
	160	.TP
	161	.B \-n, \-\-nofork
	162	Don't fork after starting.
	163
	164	.TP
	165	.BI \-O\ rrggbb \fR,\ \fB\-\-led\-on\-color= rrggbb
	166	The color of the on-LED in the LED-clock. Default: ffff00 (yellow).
	167
	168	.TP
	169	.BI \-p\ win\|default \fR,\ \fB\-\-pointer= win\|default
	170	If you specify "default",
	171	.B i3lock
	172	does not hide your mouse pointer. If you specify "win",
	173	.B i3lock
	174	displays a hardcoded Windows-Pointer (thus enabling you to mess with your
	175	friends by using a screenshot of a Windows desktop as a locking-screen).
	176
	177	.TP
	178	.BI \-R\ rrggbb \fR,\ \fB\-\-elapsed\-time\-color= rrggbb
	179	The color of the elapsed time (text). Default: 000000 (black).
	180
	181	.TP
	182	.BI \-r\ rate \fR,\ \fB\-\-refresh\-rate= rate
	183	Rate is the amount of times per second we refresh the screen. Default: 2.
	184
	185	.TP
	186	.BI \fB\-\-raw= format
	187	Read the image given by \-\-image as a raw image instead of PNG. The argument is the image's format
	188	as <width>x<height>:<pixfmt>. The supported pixel formats are:
	189	\'native', 'rgb', 'xrgb', 'rgbx', 'bgr', 'xbgr', and 'bgrx'.
	190	The "native" pixel format expects a pixel as a 32-bit (4-byte) integer in
	191	the machine's native endianness, with the upper 8 bits unused. Red, green and blue are stored in
	192	the remaining bits, in that order.
	193
	194	.BR Example:
	195	.Vb 6
	196	\& --raw=1920x1080:rgb
	197	.Ve
	198
	199	.BR
	200	You can use ImageMagick’s
	201	.IR convert(1)
	202	program to feed raw images into i3lock:
	203
	204	.BR
	205	.Vb 6
	206	\& convert wallpaper.jpg RGB:- \| i3lock --raw 3840x2160:rgb --image /dev/stdin
	207	.Ve
	208
	209	This allows you to load a variety of image formats without i3lock having to
	210	support each one explicitly.
	211
	212	.TP
	213	.BI \-S\ size \fR,\ \fB\-\-text\-size= size
	214	The text size for elapsed time, digital clock and display-text. Default: 28.
	215
	216	.TP
	217	.BI \-T\ template \fR,\ \fB\-\-digital\-clock\-template= template
	218	The date(time) template for the digital clock. Default: %H:%M:%S.
	219
	220	.TP
	221	.B \-t, \-\-tiling
	222	If an image is specified (via \-i) it will display the image tiled all over the screen
	223	(if it is a multi-monitor setup, the image is visible on all screens).
	224
	225	.TP
	226	.B \-u, \-\-no-unlock-indicator
	227	Disable the unlock indicator. i3lock will by default show an unlock indicator
	228	after pressing keys. This will give feedback for every keypress and it will
	229	show you the current PAM state (whether your password is currently being
	230	verified or whether it is wrong).
	231
	232	.TP
	233	.B \-v, \-\-version
	234	Display the version of your
	235	.B i3lock
	236
	237	.TP
	238	.BI \-W\ halign \fR,\ \fB\-\-elapsed\-time\-halign= halign
	239	The horizontal alignment for elapsed time and display-text.
	240	Valid halign values: left, center, right. Default: right
	241
	242	.TP
	243	.BI \-X\ halign \fR,\ \fB\-\-led\-clock\-halign= halign
	244	The horizontal alignment for the LED-clock. Default: center
	245
	246	.TP
	247	.BI \-x\ halign \fR,\ \fB\-\-digital\-clock\-halign= halign
	248	The horizontal alignment for the digital clock. Default: left
	249
	250	.TP
	251	.BI \-Y\ valign \fR,\ \fB\-\-led\-clock\-valign= valign
	252	The vertical alignment for the LED-clock.
	253	Valid valign values: top, middle, bottom. Default: bottom
	254
	255	.TP
	256	.BI \-y\ valign \fR,\ \fB\-\-digital\-clock\-valign= valign
	257	The vertical alignment for the digital clock. Default: top
	258
	259	.TP
	260	.BI \-Z\ valign \fR,\ \fB\-\-elapsed\-time\-valign= valign
	261	The vertical alignment for elapsed time and display-text. Default: bottom
	262
	263	.SH DPMS
	264
	265	The \-d (\-\-dpms) option was removed from i3lock in version 2.8. There were
	266	plenty of use-cases that were not properly addressed, and plenty of bugs
	267	surrounding that feature. While features are not normally removed from i3 and
	268	its tools, we felt the need to make an exception in this case.
	269
	270	Users who wish to explicitly enable DPMS only when their screen is locked can
	271	use a wrapper script around i3lock like the following:
	272
	273	.Vb 6
	274	\& #!/bin/sh
	275	\& revert() {
	276	\& xset dpms 0 0 0
	277	\& }
	278	\& trap revert HUP INT TERM
	279	\& xset +dpms dpms 5 5 5
	280	\& i3lock -n
	281	\& revert
	282	.Ve
	283
	284	The \-I (-\-inactivity-timeout=seconds) was removed because it only makes sense with DPMS.
	285
	286	.SH SEE ALSO
	287	.IR xautolock(1)
	288	\- use i3lock as your screen saver
	289
	290	.IR convert(1)
	291	\- feed a wide variety of image formats to i3lock
	292
	293	.SH AUTHOR
	294	Michael Stapelberg <michael+i3lock at stapelberg dot de>
	295
	296	Jan-Erik Rediger <badboy at archlinux.us>
	297
	298	Simeon Simeonov <sgs (AT) pichove (DOT) org>