updated documentation
also changed README to README.1 since github should support this.
This commit is contained in:
Sascha Kruse
parent
0d84f1c720
commit
b55ce38b5b
76
README
76
README
@ -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 [[<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.
|
||||
|
||||
|
||||
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 <knopwob@googlemail.com>
|
||||
|
||||
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)
|
||||
104
README.1
Normal file
104
README.1
Normal file
@ -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 " [[<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.
|
||||
|
||||
.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 <knopwob@googlemail.com>
|
||||
.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)
|
||||
84
dunst.1
84
dunst.1
@ -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 " [[<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.
|
||||
|
||||
.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 <knopwob@googlemail.com>
|
||||
.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)
|
||||
2
dunst.c
2
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);
|
||||
}
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user