1SXHKD(1)                         Sxhkd Manual                         SXHKD(1)
2
3
4

NAME

6       sxhkd - Simple X hotkey daemon
7

SYNOPSIS

9       sxhkd [OPTIONS] [EXTRA_CONFIG ...]
10

DESCRIPTION

12       sxhkd is a simple X hotkey daemon with a powerful and compact
13       configuration syntax.
14

OPTIONS

16       -h
17           Print the synopsis to standard output and exit.
18
19       -v
20           Print the version information to standard output and exit.
21
22       -m COUNT
23           Handle the first COUNT mapping notify events.
24
25       -t TIMEOUT
26           Timeout in seconds for the recording of chord chains.
27
28       -c CONFIG_FILE
29           Read the main configuration from the given file.
30
31       -r REDIR_FILE
32           Redirect the commands output to the given file.
33
34       -s STATUS_FIFO
35           Output status information to the given FIFO.
36

BEHAVIOR

38       sxhkd is a daemon that listens to keyboard events and execute commands.
39
40       It reads its configuration file from $XDG_CONFIG_HOME/sxhkd/sxhkdrc by
41       default, or from the given file if the -c option is used.
42
43       Additional configuration files can be passed as arguments.
44
45       If sxhkd receives a SIGUSR1 (resp. SIGUSR2) signal, it will reload its
46       configuration file (resp. toggle the grabbing state of all its
47       bindings).
48
49       The commands are executed via SHELL -c COMMAND (hence you can use
50       environment variables).
51
52       SHELL will be the content of the first defined environment variable in
53       the following list: SXHKD_SHELL, SHELL.
54
55       If you have a non-QWERTY keyboard or a non-standard layout
56       configuration, you should provide a COUNT of 1 to the -m option or -1
57       (interpreted as infinity) if you constantly switch from one layout to
58       the other (sxhkd ignores all mapping notify events by default because
59       the majority of those events are pointless).
60

CONFIGURATION

62       Each line of the configuration file is interpreted as so:
63
64       ·   If it is empty or starts with #, it is ignored.
65
66       ·   If it starts with a space, it is read as a command.
67
68       ·   Otherwise, it is read as a hotkey.
69
70       General syntax:
71
72           HOTKEY
73               [;]COMMAND
74
75           HOTKEY      := CHORD_1 ; CHORD_2 ; ... ; CHORD_n
76           CHORD_i     := [MODIFIERS_i +] [~][@]KEYSYM_i
77           MODIFIERS_i := MODIFIER_i1 + MODIFIER_i2 + ... + MODIFIER_ik
78
79       The valid modifier names are: super, hyper, meta, alt, control, ctrl,
80       shift, mode_switch, lock, mod1, mod2, mod3, mod4, mod5 and any.
81
82       The keysym names are given by the output of xev.
83
84       Hotkeys and commands can be spread across multiple lines by ending each
85       partial line with a backslash character.
86
87       When multiple chords are separated by semicolons, the hotkey is a chord
88       chain: the command will only be executed after receiving each chord of
89       the chain in consecutive order.
90
91       The colon character can be used instead of the semicolon to indicate
92       that the chord chain shall not be aborted when the chain tail is
93       reached.
94
95       If a command starts with a semicolon, it will be executed
96       synchronously, otherwise asynchronously.
97
98       The Escape key can be used to abort a chord chain.
99
100       If @ is added at the beginning of the keysym, the command will be run
101       on key release events, otherwise on key press events.
102
103       If ~ is added at the beginning of the keysym, the captured event will
104       be replayed for the other clients.
105
106       Pointer hotkeys can be defined by using one of the following special
107       keysym names: button1, button2, button3, ..., button24.
108
109       The hotkey and the command may contain sequences of the form
110       {STRING_1,...,STRING_N}.
111
112       In addition, the sequences can contain ranges of the form A-Z where A
113       and Z are alphanumeric characters.
114
115       The underscore character represents an empty sequence element.
116

AUTHOR

118       Bastien Dejean <nihilhill at gmail.com>
119

MAILING LIST

121       sxhkd at librelist.com
122
123
124
125Sxhkd 0.5.8                       07/14/2017                          SXHKD(1)