File: README.pod

package info (click to toggle)
dunst 1.1.0-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 484 kB
  • ctags: 519
  • sloc: ansic: 3,699; sh: 170; makefile: 76
file content (196 lines) | stat: -rw-r--r-- 4,773 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
=head1 NAME

dunst - A customizable and lightweight notification-daemon

=head1 SYNOPSIS

dunst [-geometry geom] [-shrink shrink] [-fn font] [-nf/nb/lf/lb/cf/cb color]
[-to/nto/lto/cto secs] [-format fmt] [-key key] [-mod mod] [-mon n]
[-t/title title] [-c/class class] [-v]

=head1 DESCRIPTION

Dunst is a highly configurable and lightweight notification daemon.

=head1 OPTIONS

=over 4

=item B<-h/--help>

display help message.

=item B<-fn font>

defines the font or font set used.

=item B<-lb/nb/cb color>

defines the background color of low/normal/critical messages.

=item B<-lf/nf/cf color>

defines the foreground color of low/normal/critical messages.

=item B<-to secs>

defines the default timeout. Can be (partially) overridden by
the following options.

=item B<-lto/nto/cto secs>

timeouts for low/normal/critical messages.

=item B<-key key>

remove notification by pressing key.

=item B<-all_key key>

remove all notifications by pressing key.

=item B<-history_key key>

redisplay last notification by pressing key.

=item B<-format fmt>

defines the format of the message. See FORMAT.

=item B<-mon n>

show the notification on monitor n.

=item B<-follow mode>

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.

=item B<-s>

sort messages by urgency.

=item B<-ns>

don't sort messages by urgency.

=item B<-geometry [{width}]x{height}][+/-{x}+/-{y}]>

The geometry of the message window. The height is measured
in lines everything else in pixels. If the width is omitted
but the height is given ("-geometry x2"), the message window
expands over  the  whole  screen (dmenu-like).
If  width  is  0,  the  window  expands  to  the longest
message displayed. A positive x is measured from the left,
a negative from the right side of the screen.
Y is measured from the top and down respectevly.
see also EXAMPLES show the notification on monitor n.

=item B<-t/-title title>

Define the title of notification windows spawned by dunst.

=item B<-t/-class class>

Define the class of notification windows spawned by dunst.

=item B<-shrink>

Shrink window if it's smaller than the width. Will be ignored if width is 0.

=item B<-lh/-line_height> height

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.

=item B<-print>

Print notifications to stdout. This might be useful for logging, setting up rules or using the output in other scripts.

=item B<-v/--version>

print version information.


=item B<-config file>

use alternative config file.

=back

=head1 FORMAT

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:

=over 4

=item B<%a>  appname

=item B<%s>  summary

=item B<%b>  body

=item B<%i>  iconname (including its path)

=item B<%I>  iconname (without its path)

=item B<%p>  progress value ([  0%] to [100%])

=back

=head1 COLORS

Every option that needs a color as argument accepts #RGB, #RRGGBB and
X color names.


=head1 NOTIFY-SEND

dunst is able to get different colors for a message via notify-send.
In order to do that you have to add a hint via the -h option.
The progress value can be set with a hint, too.

=over 4

=item notify-send -h string:fgcolor:#ff4444

=item notify-send -h string:bgcolor:#4444ff -h string:fgcolor:#ff4444

=item notify-send -h int:value:42 "Working ..."

=back

=head1 MISCELLANEOUS

Dunst can be paused by sending a notification with a summary of "DUNST_COMMAND_PAUSE"
and resumed with a summary of "DUNST_COMMAND_RESUME". Alternatively you can send SIGUSR1 and SIGUSR2 to pause and unpause respectivly. For Example:

=over 4

=item killall -SIGUSR1 dunst # pause

=item killall -SIGUSR2 dunst # resume

=back

When paused dunst will not display any notifications but keep all notifications in a queue.
This can for example be wrapped around a screen locker (i3lock, slock) to prevent flickering
of notifications through the lock and to read all missed notifications after returning to the computer.

=head1 CONFIGURATION

An example configuration file is included (usually /usr/share/doc/dunst/dunstrc.example.gz).
To change the configuration, copy this file to ~/.config/dunst/dunstrc and edit
it accordingly.

=head1 AUTHOR

written by Sascha Kruse <knopwob@googlemail.com>

=head1 COPYRIGHT

copyright 2013 Sascha Kruse and contributors (see LICENSE for licensing information)

If you feel that copyrights are violated, please send me an email.

=head1 SEE ALSO

dwm(1), dmenu(1), twmn(1), notify-send(1)