Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 202 lines (110 sloc) 5.007 kB
eb58f13 @knopwob README -> README.pod
authored
1 =head1 NAME
2
dfb48b0 @knopwob change description texts
authored
3 dunst - A customizable and lightweight notification-daemon
eb58f13 @knopwob README -> README.pod
authored
4
5 =head1 SYNOPSIS
6
a25954f @gs93 added shrink option
gs93 authored
7 dunst [-geometry geom] [-shrink shrink] [-fn font] [-nf/nb/lf/lb/cf/cb color]
d2245c7 @badosu Set wm class and name with -name
badosu authored
8 [-to/nto/lto/cto secs] [-format fmt] [-key key] [-mod mod] [-mon n]
9 [-t/title title] [-c/class class] [-v]
eb58f13 @knopwob README -> README.pod
authored
10
11 =head1 DESCRIPTION
12
1af715c @knopwob Remove dash in "notification daemon"
authored
13 Dunst is a highly configurable and lightweight notification daemon.
eb58f13 @knopwob README -> README.pod
authored
14
15 =head1 OPTIONS
16
17 =over 4
18
0e0f1fe @knopwob update README
authored
19 =item B<-h/--help>
eb58f13 @knopwob README -> README.pod
authored
20
21 display help message.
22
23 =item B<-fn font>
24
2751c67 @akseli0x61 Add instructions to set font size and multiple font options
akseli0x61 authored
25 Defines the font or font set used. Optionally set the size as a decimal number after the font name and space.
26 Multiple font options can be separated with commas.
eb58f13 @knopwob README -> README.pod
authored
27
aceec39 @knopwob fixed typo in README/manpage
authored
28 =item B<-lb/nb/cb color>
eb58f13 @knopwob README -> README.pod
authored
29
30 defines the background color of low/normal/critical messages.
31
32 =item B<-lf/nf/cf color>
33
34 defines the foreground color of low/normal/critical messages.
35
36 =item B<-to secs>
37
38 defines the default timeout. Can be (partially) overridden by
39 the following options.
40
41 =item B<-lto/nto/cto secs>
42
43 timeouts for low/normal/critical messages.
44
45 =item B<-key key>
46
4380af7 @knopwob rewrite keyboard shortcut handling
authored
47 remove notification by pressing key.
eb58f13 @knopwob README -> README.pod
authored
48
4380af7 @knopwob rewrite keyboard shortcut handling
authored
49 =item B<-all_key key>
eb58f13 @knopwob README -> README.pod
authored
50
4380af7 @knopwob rewrite keyboard shortcut handling
authored
51 remove all notifications by pressing key.
52
53 =item B<-history_key key>
54
55 redisplay last notification by pressing key.
eb58f13 @knopwob README -> README.pod
authored
56
57 =item B<-format fmt>
58
59 defines the format of the message. See FORMAT.
60
61 =item B<-mon n>
62
63 show the notification on monitor n.
64
e98492d @knopwob follow focus
authored
65 =item B<-follow mode>
66
67 display notifications on focused monitor. Possible options are "mouse" to follow the mouse cursor, "keyboard" to follow the window with the keyboard focus and "none" to disable focus following. "mouse" and "keyboard" overwrite the -mon option.
68
5915cbd @knopwob new option to sort messages by order
authored
69 =item B<-s>
70
71 sort messages by urgency.
72
73 =item B<-ns>
74
75 don't sort messages by urgency.
76
eb58f13 @knopwob README -> README.pod
authored
77 =item B<-geometry [{width}]x{height}][+/-{x}+/-{y}]>
78
79 The geometry of the message window. The height is measured
80 in lines everything else in pixels. If the width is omitted
81 but the height is given ("-geometry x2"), the message window
82 expands over the whole screen (dmenu-like).
83 If width is 0, the window expands to the longest
84 message displayed. A positive x is measured from the left,
85 a negative from the right side of the screen.
86 Y is measured from the top and down respectevly.
87 see also EXAMPLES show the notification on monitor n.
88
d2245c7 @badosu Set wm class and name with -name
badosu authored
89 =item B<-t/-title title>
90
91 Define the title of notification windows spawned by dunst.
92
93 =item B<-t/-class class>
94
95 Define the class of notification windows spawned by dunst.
96
a25954f @gs93 added shrink option
gs93 authored
97 =item B<-shrink>
98
e92e36a @gs93 added documentation
gs93 authored
99 Shrink window if it's smaller than the width. Will be ignored if width is 0.
a25954f @gs93 added shrink option
gs93 authored
100
788ed74 @knopwob new option for line height
authored
101 =item B<-lh/-line_height> height
102
103 The height of a single line in pixel. If the height is smaller than the font height, it will get raised to the font height.
104
1a4deea @knopwob Update to verbose mode
authored
105 =item B<-print>
106
107 Print notifications to stdout. This might be useful for logging, setting up rules or using the output in other scripts.
108
bdf1561 @knopwob add -v/--version option.
authored
109 =item B<-v/--version>
eb58f13 @knopwob README -> README.pod
authored
110
bdf1561 @knopwob add -v/--version option.
authored
111 print version information.
eb58f13 @knopwob README -> README.pod
authored
112
113
c18be50 @knopwob config parsing
authored
114 =item B<-config file>
115
116 use alternative config file.
117
504477e @springworm add option to run scripts for suppressed notifications - fix #212
springworm authored
118 =item B<-always_run_script>
119
120 Always run rule-defined scripts, even if the notification is suppressed with format = "".
121
0e0f1fe @knopwob update README
authored
122 =back
123
eb58f13 @knopwob README -> README.pod
authored
124 =head1 FORMAT
125
126 fmt is a string containing placeholders. The placeholders will be replaced with the corresponding text, or if the text is not present, nothing. Possible placeholders are:
127
128 =over 4
129
130 =item B<%a> appname
131
132 =item B<%s> summary
133
134 =item B<%b> body
135
136 =item B<%i> iconname (including its path)
137
138 =item B<%I> iconname (without its path)
139
75cb6da @progandy simplified documentation
progandy authored
140 =item B<%p> progress value ([ 0%] to [100%])
bcd3a79 @progandy document new placeholder
progandy authored
141
eb58f13 @knopwob README -> README.pod
authored
142 =back
143
144 =head1 COLORS
145
146 Every option that needs a color as argument accepts #RGB, #RRGGBB and
147 X color names.
148
149
150 =head1 NOTIFY-SEND
151
152 dunst is able to get different colors for a message via notify-send.
153 In order to do that you have to add a hint via the -h option.
bcd3a79 @progandy document new placeholder
progandy authored
154 The progress value can be set with a hint, too.
eb58f13 @knopwob README -> README.pod
authored
155
156 =over 4
157
158 =item notify-send -h string:fgcolor:#ff4444
159
160 =item notify-send -h string:bgcolor:#4444ff -h string:fgcolor:#ff4444
161
bcd3a79 @progandy document new placeholder
progandy authored
162 =item notify-send -h int:value:42 "Working ..."
163
eb58f13 @knopwob README -> README.pod
authored
164 =back
165
62ecd76 @knopwob add pause/resume info to manpage
authored
166 =head1 MISCELLANEOUS
167
168 Dunst can be paused by sending a notification with a summary of "DUNST_COMMAND_PAUSE"
a378aa9 @knopwob pause/unpause via SIGUSR1/SIGUSR2
authored
169 and resumed with a summary of "DUNST_COMMAND_RESUME". Alternatively you can send SIGUSR1 and SIGUSR2 to pause and unpause respectivly. For Example:
170
3175b04 @knopwob fix error in README.pod
authored
171 =over 4
172
a378aa9 @knopwob pause/unpause via SIGUSR1/SIGUSR2
authored
173 =item killall -SIGUSR1 dunst # pause
174
175 =item killall -SIGUSR2 dunst # resume
176
177 =back
178
62ecd76 @knopwob add pause/resume info to manpage
authored
179 When paused dunst will not display any notifications but keep all notifications in a queue.
180 This can for example be wrapped around a screen locker (i3lock, slock) to prevent flickering
181 of notifications through the lock and to read all missed notifications after returning to the computer.
182
0e0f1fe @knopwob update README
authored
183 =head1 CONFIGURATION
184
185 An example configuration file is included (usually /usr/share/dunst/dunstrc).
78b6e2b @stapelberg use libxdg-basedir to properly handle the xdg spec
stapelberg authored
186 To change the configuration, copy this file to ~/.config/dunst/dunstrc and edit
187 it accordingly.
0e0f1fe @knopwob update README
authored
188
eb58f13 @knopwob README -> README.pod
authored
189 =head1 AUTHOR
190
191 written by Sascha Kruse <knopwob@googlemail.com>
192
193 =head1 COPYRIGHT
194
1b90d82 @knopwob update copyright year
authored
195 copyright 2013 Sascha Kruse and contributors (see LICENSE for licensing information)
eb58f13 @knopwob README -> README.pod
authored
196
197 If you feel that copyrights are violated, please send me an email.
198
199 =head1 SEE ALSO
200
201 dwm(1), dmenu(1), twmn(1), notify-send(1)
Something went wrong with that request. Please try again.