2023-08-14 02:12:13 +02:00
|
|
|
.TH WAYNEKO 1 2023-08-14 "git.sr.ht/~leon_plickat/wayneko" "General Commands Manual"
|
|
|
|
|
.
|
|
|
|
|
.SH NAME
|
|
|
|
|
.P
|
|
|
|
|
wayneko \- Neko on Wayland
|
|
|
|
|
.
|
|
|
|
|
.
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.SY wayneko
|
|
|
|
|
.OP \-h
|
|
|
|
|
.OP \-\-help
|
|
|
|
|
.OP \-?
|
|
|
|
|
.YS
|
|
|
|
|
.
|
|
|
|
|
.SY wayneko
|
|
|
|
|
.OP \-\-background\-colour 0xRRGGBB[AA]
|
|
|
|
|
.OP \-\-outline\-colour 0xRRGGBB[AA]
|
2023-10-19 06:45:19 +02:00
|
|
|
.OP \-\-type neko|inu|random
|
2023-10-20 02:51:29 +02:00
|
|
|
.OP \-\-follow\-pointer true|false
|
2023-08-14 02:12:13 +02:00
|
|
|
.YS
|
|
|
|
|
.
|
|
|
|
|
.
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
.P
|
|
|
|
|
Display an animated neko cat on the bottom of an output.
|
2023-10-10 19:48:54 +02:00
|
|
|
Responds to the pointer being near the bottom edge of that output.
|
2023-10-11 03:09:49 +02:00
|
|
|
While most cats are usually active at night, wayneko likes to mostly sleep when
|
|
|
|
|
it's late, only occasionally waking.
|
2023-08-14 02:12:13 +02:00
|
|
|
.P
|
|
|
|
|
Requires the Wayland server to implement \fBzwlr-layer-shell-unstable-v1\fR.
|
|
|
|
|
.
|
|
|
|
|
.
|
|
|
|
|
.SH OPTIONS
|
|
|
|
|
.P
|
|
|
|
|
\fB\-h\fR, \fB\-\-help\fR, \fB\-?\fR
|
|
|
|
|
.RS
|
|
|
|
|
Print help text and exit.
|
|
|
|
|
.RE
|
|
|
|
|
.
|
|
|
|
|
.P
|
|
|
|
|
\fB\-\-background\-colour\fR \fI0xRRGGBB[AA]\fR
|
|
|
|
|
.RS
|
|
|
|
|
Set the background fill colour using a hexadecimal colour code prefixed by '0x'.
|
|
|
|
|
Alpha value is optional.
|
|
|
|
|
.RE
|
|
|
|
|
.
|
|
|
|
|
.P
|
|
|
|
|
\fB\-\-outline\-colour\fR \fI0xRRGGBB[AA]\fR
|
|
|
|
|
.RS
|
|
|
|
|
Set the outline colour using a hexadecimal colour code prefixed by '0x'.
|
|
|
|
|
Alpha value is optional.
|
|
|
|
|
.RE
|
|
|
|
|
.
|
2023-10-19 06:45:19 +02:00
|
|
|
.P
|
|
|
|
|
\fB\-\-type\fR \fBneko\fR|\fBinu\fR|\fBrandom\fR
|
|
|
|
|
.RS
|
|
|
|
|
This option lets you choose between neko and her friend inu.
|
|
|
|
|
.RE
|
|
|
|
|
.
|
2023-10-20 02:51:29 +02:00
|
|
|
.P
|
|
|
|
|
\fB\-\-follow\-pointer\fR \fBtrue\fR|\fBfalse\fR
|
|
|
|
|
.RS
|
|
|
|
|
Set whether neko follows the pointer when it approaches the bottom of the output
|
|
|
|
|
.RE
|
|
|
|
|
.
|
2023-08-14 02:12:13 +02:00
|
|
|
.
|
|
|
|
|
.SH AUTHOR
|
|
|
|
|
.P
|
|
|
|
|
Code by
|
|
|
|
|
.MT leonhenrik.plickat@stud.uni-goettingen.de
|
|
|
|
|
Leon Henrik Plickat
|
|
|
|
|
.ME .
|
|
|
|
|
.
|
|
|
|
|
.P
|
|
|
|
|
Neko bitmaps taken from public domain.
|
