You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
158 lines
2.6 KiB
158 lines
2.6 KiB
.\" Generated by scdoc 1.11.2
|
|
.\" Complete documentation for this program is not available as a GNU info page
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.nh
|
|
.ad l
|
|
.\" Begin generated content:
|
|
.TH "swhkd" "1" "2022-08-14" "github.com/shinyzenith/swhkd" "General Commands Manual"
|
|
.P
|
|
.SH NAME
|
|
.P
|
|
swhkd - Hotkey daemon inspired by sxhkd written in rust
|
|
.P
|
|
.SH SYNOPSIS
|
|
.P
|
|
\fBpkexec swhkd\fR [\fIflags\fR]
|
|
.P
|
|
.SH CONFIG FILE
|
|
.P
|
|
The config file goes in \fB/etc/swhkd/swhkdrc\fR.\& Since swhkd is written with a pkexec privilege escalation model in mind, we can'\&t detect
|
|
\fB$XDG_CONFIG_HOME\fR.\&
|
|
.P
|
|
This can be avoided as such:
|
|
.RS 4
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.IP \(bu 4
|
|
.\}
|
|
Using the \fBinclude\fR statement in your config file.\&
|
|
.RE
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.IP \(bu 4
|
|
.\}
|
|
Using the \fB-c\fR flag to mention a custom config file at runtime.\&
|
|
.RE
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.IP \(bu 4
|
|
.\}
|
|
Symlinking the config file from \fB~/.\&config/swhkd/swhkdrc\fR or any other directory of choice to \fB/etc/swhkd/swhkdrc\fR.\&
|
|
|
|
.RE
|
|
.P
|
|
.RE
|
|
More about the config file syntax in `swhkd(5)`
|
|
.P
|
|
.SH OPTIONS
|
|
.P
|
|
\fB-h\fR, \fB--help\fR
|
|
.RS 4
|
|
Print help message and quit.\&
|
|
.P
|
|
.RE
|
|
\fB-V\fR, \fB--version\fR
|
|
.RS 4
|
|
Print version information.\&
|
|
.P
|
|
.RE
|
|
\fB-c\fR, \fB--config\fR <CONFIG_FILE_PATH>
|
|
.RS 4
|
|
Set a custom config file path.\&
|
|
.P
|
|
.RE
|
|
\fB-C\fR, \fB--cooldown\fR <COOLDOWN_IN_MS>
|
|
.RS 4
|
|
Set a custom repeat cooldown duration.\& Default is 250ms.\& Most wayland
|
|
compositors handle this server side however, either way works.\&
|
|
.P
|
|
.RE
|
|
\fB-d\fR, \fB--debug\fR
|
|
.RS 4
|
|
Enable debug mode.\&
|
|
.P
|
|
.RE
|
|
\fB-D, --device\fR <DEVICE_NAME>
|
|
.RS 4
|
|
Manually set the keyboard devices to use.\& Can occur multiple times.\&
|
|
.P
|
|
.RE
|
|
.SH SIGNALS
|
|
.P
|
|
.RS 4
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.IP \(bu 4
|
|
.\}
|
|
Reload config file: `sudo pkill -HUP swhkd`
|
|
.RE
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.IP \(bu 4
|
|
.\}
|
|
Pause Hotkey checking: `sudo pkill -USR1 swhkd`
|
|
.RE
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.IP \(bu 4
|
|
.\}
|
|
Resume key checking: `sudo pkill -USR2 swhkd`
|
|
|
|
.RE
|
|
.P
|
|
.RE
|
|
.SH AUTHORS
|
|
.P
|
|
Maintained by Shinyzenith <aakashsensharma@gmail.\&com>, EdenQwQ <lsahlm1eden@gmail.\&com>, and Angelo Fallaria <ba.\&fallaria@gmail.\&com>.\&
|
|
For more information about development, see <https://github.\&com/waycrate/swhkd>.\&
|
|
.P
|
|
.SH SEE ALSO
|
|
.P
|
|
.RS 4
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.IP \(bu 4
|
|
.\}
|
|
\fBswhkd(5)\fR
|
|
.RE
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.IP \(bu 4
|
|
.\}
|
|
\fBswhkd-keys(5)\fR
|
|
.RE
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.IP \(bu 4
|
|
.\}
|
|
\fBswhks(1)\fR
|
|
.RE
|