add a man page

Sigrid Solveig Haflínudóttir committed 5 years ago

Commit e2f298b1 parent a5aaf3c2 files · +58 −0Browse files

Unified · Split

2 files

@@ -0,0 +1,52 @@
	1	+.TH BAR 1
	2	+.SH NAME
	3	+bar \- display a bar
	4	+.SH SYNOPSIS
	5	+.B bar
	6	+[
	7	+.I -s separator
	8	+]
	9	+[
	10	+.I -p position
	11	+]
	12	+[
	13	+.I -b
	14	+]
	15	+.SH DESCRIPTION
	16	+.I bar
	17	+displays a small window with current battery charge, date and time.
	18	+Additional data may be displayed by writing lines of text to its
	19	+standard input.
	20	+.PP
	21	+.I Bar
	22	+Reacts to mouse clicks by writing the "clicked" portion of the text
	23	+(enclosed by the separator) to standard output. This can be used to
	24	+perform additional actions by a custom script.
	25	+.PP
	26	+By default,
	27	+.I bar
	28	+is placed at the bottom right corner of the screen. This can be
	29	+changed by speicifying option
	30	+.I -p
	31	+with first letters of the required placement:
	32	+.I l
	33	+for "left",
	34	+.I r
	35	+for "right",
	36	+.I t
	37	+for "top" and
	38	+.I b
	39	+for "bottom". If neither left nor right is chosen, the window will be
	40	+placed in either top or bottom center.
	41	+.PP
	42	+Separator can be changed with
	43	+.I -s
	44	+option.
	45	+.PP
	46	+.I Bar
	47	+keeps itself as a top window. To make it stay at the bottom, use
	48	+.I -b .
	49	+.SH SOURCE
	50	+https://git.sr.ht/~ft/bar
	51	+.SH BUGS
	52	+Impossible.

Keyboard shortcuts