From b55ce38b5bcb408bc2dd8147eb265b9d32a4ac61 Mon Sep 17 00:00:00 2001 From: Sascha Kruse Date: Thu, 15 Sep 2011 20:42:06 +0200 Subject: [PATCH] updated documentation also changed README to README.1 since github should support this. --- README | 76 ---------------------------------------- README.1 | 104 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ dunst.1 | 85 +-------------------------------------------- dunst.c | 2 +- 4 files changed, 106 insertions(+), 161 deletions(-) delete mode 100644 README create mode 100644 README.1 mode change 100644 => 120000 dunst.1 diff --git a/README b/README deleted file mode 100644 index 621a423..0000000 --- a/README +++ /dev/null @@ -1,76 +0,0 @@ -DNOTIFY(1) DNOTIFY(1) - - - -NAME - dunst - dmenu-ish universal notification system - -SYNOPSIS - dunst [-geometry geom] [-fn font] [-nb color] [-nf color] [-to secs] [-key key] [-mod modifier] [-mon n] - -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 argu‐ - ment in a fashion similar to dmenu and additionally prints them to stdout. Notifications can be closed via mouseclick. - -OPTIONS - -h/--help - display help message. - - -fn/ font - defines the font or font set used. - - -nb/-bg color - 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. - - -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. - - -mon n show the notification on monitor n. - - -mon [[]x][+/-+/-] - 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. - - -EXAMPLES - dunst -geometry x2 Displays a maximum of two lines across the top of the screen. - - dunst -geometry x3+0-0 - Displays a maximum of three the lines across the bottom of the screen. - - dunst -geometry 0x3-30+20 - Displays a maximum of three lines 30 pixels away from the right border and 20 pixels away from the top with adaptive size. - - dunst -geometry 100x3-30+20 - Displays a maximum of three lines 30 pixels away from the right border and 20 pixels away from the top with a width of 100 pixels. - -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. - - 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. - -SEE also - dwm(1), dmenu(1), twmn(1), notify-send(1) - - - - DNOTIFY(1) diff --git a/README.1 b/README.1 new file mode 100644 index 0000000..5ef80e0 --- /dev/null +++ b/README.1 @@ -0,0 +1,104 @@ +.TH DNOTIFY 1 +.SH NAME +dunst \- dmenu\-ish universal notification system +.SH SYNOPSIS +.B dunst +.RB [ \-geometry +.IR geom ] +.RB [ \-fn +.IR font ] +.RB [ \-nf +.IR color ] +.RB [ \-nb +.IR color ] +.RB [ \-lf +.IR color ] +.RB [ \-lb +.IR color ] +.RB [ \-cf +.IR color ] +.RB [ \-cb +.IR color ] +.RB [ \-to +.IR secs ] +.RB [ \-key +.IR key ] +.RB [ \-mod +.IR modifier ] +.RB [ \-mon +.IR n ] +.P +.SH DESCRIPTION +.B 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. +.SH OPTIONS +.TP +.B \-h/\-\-help +display help message. +.TP +.BI \-fn " font" +defines the font or font set used. +.TP +.BI \-nb " color" +defines the background color for normal messages. #RGB, #RRGGBB and X color names are supported. +.TP +.BI \-nf " color" +defines the foreground color for normal messages. +.TP +.BI \-lb " color" +defines the background color for low urgency messages. +.TP +.BI \-lf " color" +defines the forground color for low urgency messages. +.TP +.BI \-cb " color" +defines the background color for critical messages. +.TP +.BI \-cf " color" +defines the forground color for critical messages. +.TP +.BI \-msg " msg" +display msg instead of listening to notifications. This option can be used multiple times. +.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. +.TP +.BI \-mon " n" +show the notification on monitor n. +.TP +.BI \-geometry " [[]x][+/-+/-]" +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. + +.SH EXAMPLES +.BI "dunst " \-geometry " x2" +Displays a maximum of two lines across the top of the screen. +.TP +.BI "dunst " \-geometry " x3+0-0" +Displays a maximum of three the lines across the bottom of the screen. +.TP +.BI "dunst " \-geometry " 0x3-30+20" +Displays a maximum of three lines 30 pixels away from the right border and 20 pixels away from the top with adaptive size. +.TP +.BI "dunst " \-geometry " 100x3-30+20" +Displays a maximum of three lines 30 pixels away from the right border and 20 pixels away from the top with a width of 100 pixels. +.SH AUTHOR +written by Sascha Kruse +.SH 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. +.TP +Some snippets in dunst_dbus.c are taken from twmn. See http://github.com/sboli/twmn. +.TP +If you feel that copyrights are violated, please send me an e-mail to knopwob@googlemail.com. +.SH SEE also +.IR dwm (1), +.IR dmenu (1), +.IR twmn (1), +.IR notify-send (1) diff --git a/dunst.1 b/dunst.1 deleted file mode 100644 index 5c097bd..0000000 --- a/dunst.1 +++ /dev/null @@ -1,84 +0,0 @@ -.TH DNOTIFY 1 -.SH NAME -dunst \- dmenu\-ish universal notification system -.SH SYNOPSIS -.B dunst -.RB [ \-geometry -.IR geom ] -.RB [ \-fn -.IR font ] -.RB [ \-nb -.IR color ] -.RB [ \-nf -.IR color ] -.RB [ \-to -.IR secs ] -.RB [ \-key -.IR key ] -.RB [ \-mod -.IR modifier ] -.RB [ \-mon -.IR n ] -.P -.SH DESCRIPTION -.B 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. -.SH OPTIONS -.TP -.B \-h/\-\-help -display help message. -.TP -.BI \-fn/ " font" -defines the font or font set used. -.TP -.BI \-nb/\-bg " color" -defines the background color. #RGB, #RRGGBB and X color names are supported. -.TP -.BI \-nf/\-fg " color" -defines the background color. -.TP -.BI \-msg " msg" -display msg instead of listening to notifications. This option can be used multiple times. -.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. -.TP -.BI \-mon " n" -show the notification on monitor n. -.TP -.BI \-mon " [[]x][+/-+/-]" -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. - -.SH EXAMPLES -.BI "dunst " \-geometry " x2" -Displays a maximum of two lines across the top of the screen. -.TP -.BI "dunst " \-geometry " x3+0-0" -Displays a maximum of three the lines across the bottom of the screen. -.TP -.BI "dunst " \-geometry " 0x3-30+20" -Displays a maximum of three lines 30 pixels away from the right border and 20 pixels away from the top with adaptive size. -.TP -.BI "dunst " \-geometry " 100x3-30+20" -Displays a maximum of three lines 30 pixels away from the right border and 20 pixels away from the top with a width of 100 pixels. -.SH AUTHOR -written by Sascha Kruse -.SH 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. -.TP -Some snippets in dunst_dbus.c are taken from twmn. See http://github.com/sboli/twmn. -.TP -If you feel that copyrights are violated, please send me an e-mail to knopwob@googlemail.com. -.SH SEE also -.IR dwm (1), -.IR dmenu (1), -.IR twmn (1), -.IR notify-send (1) diff --git a/dunst.1 b/dunst.1 new file mode 120000 index 0000000..c74f87f --- /dev/null +++ b/dunst.1 @@ -0,0 +1 @@ +README.1 \ No newline at end of file diff --git a/dunst.c b/dunst.c index 29c1eef..147e4fb 100644 --- a/dunst.c +++ b/dunst.c @@ -588,6 +588,6 @@ main(int argc, char *argv[]) { void usage(int exit_status) { - fputs("usage: dunst [-h/--help] [-geometry geom] [-fn font]\n[-nb/-bg color] [-nf/-fg color] [-to secs] [-key key] [-mod modifier] [-mon n] [-msg msg]\n", stderr); + fputs("usage: dunst [-h/--help] [-geometry geom] [-fn font]\n[-nb color] [-nf color] [-lb color] [-lf color] [-cb color] [ -cf color]\n[-to secs] [-key key] [-mod modifier] [-mon n] [-msg msg]\n", stderr); exit(exit_status); }