From d9527bd9490df1e540dc0f957aa31652cd87cb64 Mon Sep 17 00:00:00 2001 From: Sascha Kruse Date: Fri, 9 Sep 2011 00:28:21 +0200 Subject: [PATCH] updated documentation --- README | 40 +++++++++++++++++++++++++++++----------- dunst.1 | 10 ++++++++++ dunst.c | 2 +- 3 files changed, 40 insertions(+), 12 deletions(-) diff --git a/README b/README index 1da3215..0abff12 100644 --- a/README +++ b/README @@ -2,12 +2,15 @@ NAME dunst - dmenu-ish universal notification system SYNOPSIS - dunst [-b] [-ne l/r] [-fn font] [-nb color] [-nf color] [-to secs] + dunst [-b] [-ne l/r] [-fn font] [-nb color] [-nf color] [-to secs] + [-key key] [-mod modifier] DESCRIPTION - dunst is a lightweight notification-daemon for the libnotify. It can also be used as a standalone notification - system. Dnotify displays messages received via dbus or as commandline argument in a fashion similar to dmenu - and additionally prints them to stdout. Notifications can be closed via mouseclick. + dunst is a lightweight notification-daemon for the libnotify. It can + also be used as a standalone notification system. Dnotify displays mes‐ + sages received via dbus or as commandline argument in a fashion similar + to dmenu and additionally prints them to stdout. Notifications can be + closed via mouseclick. OPTIONS -h/--help @@ -16,33 +19,48 @@ OPTIONS -b dunst appears at the bottom of the screen. -ne l/r - Don't expand popup across the screen and put it in the [l]eft or [r]ight edge + Don't expand popup across the screen and put it in the [l]eft or + [r]ight edge -fn/ font defines the font or font set used. -nb/-bg color - defines the background color. #RGB, #RRGGBB and X color names are supported. + defines the background color. #RGB, #RRGGBB and X color names + are supported. -nf/-fg color defines the background color. -msg msg - display msg instead of listening to notifications. This option can be used multiple times. + display msg instead of listening to notifications. This option + can be used multiple times. -to secs display each message for secs seconds. + -key key + close window by pressing key [a,b,space,Return etc.] (should be + used in combination with -mod). + + -mod modifier + defines the modifier for the key. Available modifiers are: + ctrl,shift,mod1 (usually the alt-key),mod2,mod3,mod4 (usually + windows key). This option can be used multiple times to combine + modifiers. + AUTHOR written by Sascha Kruse COPYRIGHT - Parts of the code are taken from dmenu (especially draw.c and draw.h). Read LICENCE.dmenu and look at - http://tools.suckless.org/dmenu. + Parts of the code are taken from dmenu (especially draw.c and draw.h). + Read LICENCE.dmenu and look at http://tools.suckless.org/dmenu. - Some snippets in dunst_dbus.c are taken from twmn. See http://github.com/sboli/twmn. + Some snippets in dunst_dbus.c are taken from twmn. See + http://github.com/sboli/twmn. - If you feel that copyrights are violated, please send me an e-mail to knopwob@googlemail.com. + If you feel that copyrights are violated, please send me an e-mail to + knopwob@googlemail.com. SEE also dwm(1), dmenu(1), twmn(1), notify-send(1) diff --git a/dunst.1 b/dunst.1 index e3263eb..210991b 100644 --- a/dunst.1 +++ b/dunst.1 @@ -14,6 +14,10 @@ dunst \- dmenu\-ish universal notification system .IR color ] .RB [ \-to .IR secs ] +.RB [ \- key +.IR key ] +.RB [ \- mod +.IR modifier ] .P .SH DESCRIPTION .B dunst @@ -43,6 +47,12 @@ display msg instead of listening to notifications. This option can be used multi .TP .BI \-to " secs" display each message for secs seconds. +.TP +.BI \-key " key" +close window by pressing key [a,b,space,Return etc.] (should be used in combination with -mod). +.TP +.BI \-mod " modifier" +defines the modifier for the key. Available modifiers are: ctrl,shift,mod1 (usually the alt-key),mod2,mod3,mod4 (usually windows key). This option can be used multiple times to combine modifiers. .SH AUTHOR written by Sascha Kruse .SH COPYRIGHT diff --git a/dunst.c b/dunst.c index af5afc7..3a09b03 100644 --- a/dunst.c +++ b/dunst.c @@ -378,6 +378,6 @@ main(int argc, char *argv[]) { void usage(int exit_status) { - fputs("usage: dunst [-h/--help] [-b] [-ne l/r] [-fn font]\n[-nb/-bg color] [-nf/-fg color] [-to secs] [-msg msg]\n", stderr); + fputs("usage: dunst [-h/--help] [-b] [-ne l/r] [-fn font]\n[-nb/-bg color] [-nf/-fg color] [-to secs] [-key key] [-mod modifier] [-msg msg]\n", stderr); exit(exit_status); }