nagbalae/dunst
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update a few man page descriptions

Browse Source
This commit is contained in:
fwsmit 2020-12-25 20:04:35 +01:00
parent d0dfaf0488
commit 63103f991d
2 changed files with 20 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/dunst.1.pod
View File

@ -31,10 +31,10 @@ Print version information.
Print notifications to stdout. This might be useful for logging, setting up Print notifications to stdout. This might be useful for logging, setting up
rules or using the output in other scripts. rules or using the output in other scripts.
=item B<-*setting* [value]> =item B<->F<SETTING> B<[value]>
Where *setting* can be any setting that's available in the global section of Where F<SETTING> can be any setting that's available in the global section of
the configuration file. See B<dunst(5)> for possible settings. the configuration file. See dunst(5) for possible settings.
Each configuration option in the global section can be overridden from the Each configuration option in the global section can be overridden from the
command line by adding a single dash in front of it's name. command line by adding a single dash in front of it's name.
@ -57,7 +57,7 @@ will be changed in the future.
An example configuration file is included (usually /etc/dunst/dunstrc). Note: An example configuration file is included (usually /etc/dunst/dunstrc). Note:
this was previously /usr/share/dunst/dunstrc. this was previously /usr/share/dunst/dunstrc.
Before using dunst, copy this file to ~/.config/dunst/dunstrc and edit Before using dunst, copy this file to ~/.config/dunst/dunstrc and edit
it accordingly. it accordingly. See dunst(5) for all possible settings.
=head2 NOTIFY-SEND =head2 NOTIFY-SEND
@ -89,12 +89,16 @@ notifications HAVE actions.
The "context" keybinding is used to interact with these actions, by showing a The "context" keybinding is used to interact with these actions, by showing a
menu of possible actions. This feature requires "dmenu" or a dmenu drop-in menu of possible actions. This feature requires "dmenu" or a dmenu drop-in
replacement present. replacement present. It is preferred to set this keybinding with your window
manager or desktop envirorment and let it execute C<dunsctl context>. Another
option is to set this keybinding in your dunstrc, but this is soon to be deprecated
(and doesn't work on Wayland).
Alternatively, you can invoke an action with a middle click on the notification. Alternatively, you can invoke an action with a middle click on the notification.
If there is exactly one associated action, or one is marked as default, that one If there is exactly one associated action, or one is marked as default, that one
is invoked. If there are multiple, the context menu is shown. The same applies is invoked. If there are multiple, the context menu is shown. The same applies
to URLs when there are no actions. to URLs when there are no actions. You can change the mouse button to right click
by setting C<mouse_right_click = close_all> in your dunstrc.
=head1 MISCELLANEOUS =head1 MISCELLANEOUS

19
docs/dunst.5.pod
View File

@ -10,9 +10,11 @@ To change the configuration, copy this file to ~/.config/dunst/dunstrc and edit
it accordingly. it accordingly.
The configuration is divided into sections in an ini-like format. The 'global' The configuration is divided into sections in an ini-like format. The 'global'
section contains most general settings while the 'shortcuts' sections contains section contains most general settings while the setions 'urgency_low',
all keyboard configuration and the 'experimental' section all the features that 'urgency_normal' and 'urgency_critical' are for low, normal and critical urgency
have not yet been tested thoroughly. notifications respectively. The 'shortcuts' section (deprecated) contains all
keyboard configuration and the 'experimental' section all the features that have
not yet been tested thoroughly.
Any section that is not one of the above is assumed to be a rule, see RULES for Any section that is not one of the above is assumed to be a rule, see RULES for
more details. more details.
@ -640,16 +642,15 @@ See TIME FORMAT for valid times.
Dunst now contains a command line control command that can be used to interact Dunst now contains a command line control command that can be used to interact
with it. It supports all functions previously done only via keyboard shortcuts with it. It supports all functions previously done only via keyboard shortcuts
but also has a lot of extra functionality. So see more see the dunstctl man but also has a lot of extra functionality. So see more see dunstctl(1).
page.
=head1 HISTORY =head1 HISTORY
Dunst saves a number of notifications (specified by B<history_length>) in memory. Dunst saves a number of notifications (specified by B<history_length>) in memory.
These notifications can be recalled (i.e. redisplayed) by pressing the These notifications can be recalled (i.e. redisplayed) by calling
B<history_key> (see the shortcuts section), whether these notifications will B<dunstctl history> (see dunstctl(1)). Whether these notifications will time out
time out like if they have been just send depends on the value of the like if they have been just send depends on the value of the B<sticky_history>
B<sticky_history> setting. setting.
Past notifications are redisplayed in a first-in-last-out order, meaning that Past notifications are redisplayed in a first-in-last-out order, meaning that
pressing the history key once will bring up the most recent notification that pressing the history key once will bring up the most recent notification that