Skip to content

Commit 87d656d

Browse files
authored
Merge pull request #1476 from bynect/update-docs2
Update docs
2 parents 669c586 + d1335ad commit 87d656d

File tree

3 files changed

+51
-23
lines changed

3 files changed

+51
-23
lines changed

docs/dunst.5.pod

Lines changed: 48 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ filters: it applies to all notifications.
2020

2121
See RULES for more details.
2222

23-
All experimental settings are marked with I<Experimental>.
23+
The "experimental" section contains experimental and unstable settings.
24+
These options can change in breaking ways between releases.
25+
If you find a problem with these new features, make sure to report it.
2426

2527
=head2 Global section
2628

@@ -31,7 +33,7 @@ All experimental settings are marked with I<Experimental>.
3133
Specifies on which monitor the notifications should be displayed in, either by
3234
name or by number, starting from 0. See the B<follow> setting.
3335

34-
=item B<follow> (values: [none/mouse/keyboard] default: none)
36+
=item B<follow> (values: [none/mouse/keyboard], default: none)
3537

3638
Defines where the notifications should be placed in a multi-monitor setup. All
3739
values except I<none> override the B<monitor> setting.
@@ -148,7 +150,7 @@ Origin can be one of:
148150
center
149151
right-center
150152

151-
=item B<offset> format: (horizontal, vertical)
153+
=item B<offset> (format: (horizontal, vertical), default: (10, 50))
152154

153155
Respectively the horizontal and vertical offset in pixels from the corner
154156
of the screen specified by B<origin>. A negative offset will lead to the
@@ -164,7 +166,7 @@ For backwards compatibility this syntax is also accepted.
164166

165167
offset = 10x300
166168

167-
=item B<scale> (default: 0, X11 only)
169+
=item B<scale> (default: 0) (X11 only)
168170

169171
Specifies a scale factor for dimensions to adapt notifications to
170172
HiDPI screens. This scales the notification geometry and it's
@@ -304,7 +306,7 @@ of size B<frame_width> will be drawn around each notification instead.
304306
This setting requires a compositor and any applications displayed between the
305307
gaps are not currently clickable.
306308

307-
=item B<separator_color> (values: [auto/foreground/frame/#RRGGBB] default: frame)
309+
=item B<separator_color> (values: [auto/foreground/frame/#RRGGBB], default: frame)
308310

309311
Sets the color of the separator line between two notifications.
310312

@@ -422,7 +424,7 @@ For a complete markup reference, see
422424

423425
=item B<%n> progress value without any extra characters
424426

425-
=item B<%%> Literal %
427+
=item B<%%> literal %
426428

427429
=back
428430

@@ -489,7 +491,7 @@ https://specifications.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.ht
489491

490492
If the theme inherits from other themes, they will be used as a backup.
491493

492-
This setting is experimental and not enabled by default. See
494+
This setting is not enabled by default. See
493495
B<enable_recursive_icon_lookup> for how to enable it.
494496

495497
=item B<enable_recursive_icon_lookup> (default: false)
@@ -691,6 +693,17 @@ See the example configuration file for examples.
691693
Old version of dunst allowed changing the colors of different urgencies through
692694
command line options. This has been long removed in favour of RULES, see issue #328.
693695

696+
=head2 Experimental section
697+
698+
=over 4
699+
700+
=item B<per_monitor_dpi> (default: false)
701+
702+
Use different DPI for each monitor.
703+
This setting is currently implemented only for X11.
704+
705+
=back
706+
694707
=head1 DUNSTCTL
695708

696709
Dunst now contains a command line control command that can be used to interact
@@ -796,7 +809,7 @@ The allowed attributes are listed below.
796809

797810
=over 4
798811

799-
=item C<appname> (discouraged, see desktop_entry)
812+
=item C<appname> (see also desktop_entry)
800813

801814
The name of the application as reported by the client. Be aware that the name
802815
can often differ depending on the locale used.
@@ -1139,56 +1152,71 @@ See RULES for more detailed explanations for some options.
11391152

11401153
=over 4
11411154

1142-
=item B<fgcolor>
1155+
=item B<fgcolor> (type: string)
11431156

11441157
Foreground color.
11451158

1146-
=item B<bgcolor>
1159+
=item B<bgcolor> (type: string)
11471160

11481161
Background color.
11491162

1150-
=item B<frcolor>
1163+
=item B<frcolor> (type: string)
11511164

11521165
Frame color.
11531166

1154-
=item B<hlcolor>
1167+
=item B<hlcolor> (type: string or string array)
11551168

11561169
Highlight color.
11571170

1158-
=item B<value>
1171+
=item B<value> (type: int or uint)
11591172

11601173
Progress value.
11611174

1162-
=item B<image-path>
1175+
=item B<image-path> (type: string)
11631176

11641177
Icon name. This may be a path or just the icon name.
11651178

1166-
=item B<image-data>
1179+
The alias B<image_path> is also supported.
1180+
1181+
=item B<image-data> (type: variant)
11671182

11681183
A stream of raw image data.
11691184

1170-
=item B<category>
1185+
The aliases B<image_data> and B<icon_data> are also supported.
1186+
1187+
=item B<category> (type: string)
11711188

11721189
The category.
11731190

1174-
=item B<desktop-entry>
1191+
=item B<desktop-entry> (type: string)
11751192

11761193
The desktop entry.
11771194

1178-
=item B<transient>
1195+
=item B<transient> (type: int or boolean)
11791196

11801197
The transient value.
11811198

1199+
=item B<x-dunst-stack-tag> (type: string)
1200+
1201+
The stack tag of the notification.
1202+
A tagged notification will replace an earlier notification with the same tag.
1203+
1204+
=item B<x-canonical-private-synchronous> (type: string)
1205+
1206+
Alias for B<x-dunst-stack-tag>.
1207+
11821208
=back
11831209

11841210
Some examples:
11851211

1186-
notify-send -h string:fgcolor:#ff4444
1212+
notify-send -h string:fgcolor:#ff4444 "hello"
11871213

1188-
notify-send -h string:bgcolor:#4444ff -h string:fgcolor:#ff4444 -h string:frcolor:#44ff44
1214+
notify-send -h string:bgcolor:#4444ff -h string:fgcolor:#ff4444 -h string:frcolor:#44ff44 ":)"
11891215

11901216
notify-send -h int:value:42 "Working ..."
11911217

1218+
notify-send -h string:x-canonical-private-synchronous:volume "Muted"
1219+
11921220
=head1 ACTIONS
11931221

11941222
Dunst allows notifiers (i.e.: programs that send the notifications) to specify

src/dbus.c

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -896,7 +896,6 @@ static struct notification *dbus_message_to_notification(const gchar *sender, GV
896896
}
897897
}
898898

899-
900899
gradient_pattern(grad);
901900

902901
notification_keep_original(n);

src/settings.c

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,16 +146,17 @@ FILE *fopen_conf(char * const path)
146146
}
147147

148148
void check_and_correct_settings(struct settings *s) {
149+
bool on_wayland = is_running_wayland();
149150

150151
#ifndef ENABLE_WAYLAND
151-
if (is_running_wayland()) {
152+
if (on_wayland) {
152153
/* We are using xwayland now. Setting force_xwayland to make sure
153154
* the idle workaround below is activated */
154155
settings.force_xwayland = true;
155156
}
156157
#endif
157158

158-
if (settings.force_xwayland && is_running_wayland()) {
159+
if (settings.force_xwayland && on_wayland) {
159160
if (settings.idle_threshold > 0)
160161
LOG_W("Using xwayland. Disabling idle.");
161162
/* There is no way to detect if the user is idle

0 commit comments

Comments
 (0)