README -> README.pod
Make use of githubs markup capabilities for READMEs.
This commit is contained in:
Sascha Kruse
parent
822e5d2f8c
commit
eb58f1338e
5
Makefile
5
Makefile
@ -32,6 +32,11 @@ clean:
|
|||||||
@echo cleaning
|
@echo cleaning
|
||||||
@rm -f ${OBJ}
|
@rm -f ${OBJ}
|
||||||
@rm -f dunst
|
@rm -f dunst
|
||||||
|
@rm -f dunst.1
|
||||||
|
|
||||||
|
doc: dunst.1
|
||||||
|
dunst.1: README.pod
|
||||||
|
pod2man $< > $@
|
||||||
|
|
||||||
install: all
|
install: all
|
||||||
@echo installing executables to ${DESTDIR}${PREFIX}/bin
|
@echo installing executables to ${DESTDIR}${PREFIX}/bin
|
||||||
|
|||||||
120
README
120
README
@ -1,120 +0,0 @@
|
|||||||
DNOTIFY(1) DNOTIFY(1)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
dunst - dmenu-ish universal notification system
|
|
||||||
|
|
||||||
SYNOPSIS
|
|
||||||
dunst [-geometry geom] [-fn font] [-nf color] [-nb color] [-lf color] [-lb color] [-cf color] [-cb color] [-to secs] [-nto secs] [-lto secs] [-cto secs] [-format fmt] [-key key] [-mod modifier] [-mon n] [-v]
|
|
||||||
|
|
||||||
DESCRIPTION
|
|
||||||
dunst is a lightweight notification-daemon for the libnotify. 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.
|
|
||||||
|
|
||||||
OPTIONS
|
|
||||||
-h/--help
|
|
||||||
display help message.
|
|
||||||
|
|
||||||
-fn font
|
|
||||||
defines the font or font set used.
|
|
||||||
|
|
||||||
-nb color
|
|
||||||
defines the background color for normal messages. #RGB, #RRGGBB and X color names are supported.
|
|
||||||
|
|
||||||
-nf color
|
|
||||||
defines the foreground color for normal messages.
|
|
||||||
|
|
||||||
-lb color
|
|
||||||
defines the background color for low urgency messages.
|
|
||||||
|
|
||||||
-lf color
|
|
||||||
defines the forground color for low urgency messages.
|
|
||||||
|
|
||||||
-cb color
|
|
||||||
defines the background color for critical messages.
|
|
||||||
|
|
||||||
-cf color
|
|
||||||
defines the forground color for critical messages.
|
|
||||||
|
|
||||||
-to secs
|
|
||||||
timeout for messages with low and normal urgency. Messages with a timeout of 0 will not dissappear automaticly (defaults to 10)
|
|
||||||
|
|
||||||
-nto secs
|
|
||||||
timeout for messages with normal urgency (defaults to 10)
|
|
||||||
|
|
||||||
-lto secs
|
|
||||||
timeout for messages with low urgency (defaults to 10)
|
|
||||||
|
|
||||||
-cto secs
|
|
||||||
timeout for messages with critical urgency (defaults to 0)
|
|
||||||
|
|
||||||
-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.
|
|
||||||
|
|
||||||
-format fmt
|
|
||||||
defines the format of the messages. See FORMAT.
|
|
||||||
|
|
||||||
-mon n show the notification on monitor n.
|
|
||||||
|
|
||||||
-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.
|
|
||||||
|
|
||||||
-v Activate verbose mode.
|
|
||||||
|
|
||||||
|
|
||||||
NOTIFY-SEND
|
|
||||||
dunst is able to get different colors for a message via notify-send. For that, you have to add a hint via the -h option.
|
|
||||||
|
|
||||||
notify-send -h string:fgcolor:#ff4444
|
|
||||||
|
|
||||||
notify-send -h string:bgcolor:#4444ff
|
|
||||||
|
|
||||||
notify-send -h string:bgcolor:#4444ff -h string:fgcolor:#ff4444
|
|
||||||
|
|
||||||
FORMAT
|
|
||||||
fmt is a string containing placeholders. The placeholders will be replaced with the corresponding text, or if the text is not present, nothing. Possible placeholders are:
|
|
||||||
|
|
||||||
%a appname
|
|
||||||
|
|
||||||
%s summary
|
|
||||||
|
|
||||||
%b body
|
|
||||||
|
|
||||||
%i iconname (including its path)
|
|
||||||
|
|
||||||
%I iconname (without its path)
|
|
||||||
|
|
||||||
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)
|
|
||||||
135
README.pod
Normal file
135
README.pod
Normal file
@ -0,0 +1,135 @@
|
|||||||
|
=head1 NAME
|
||||||
|
|
||||||
|
dunst - dmenu-ish universal notification system
|
||||||
|
|
||||||
|
=head1 SYNOPSIS
|
||||||
|
|
||||||
|
dunst [-geometry geom] [-fn font] [-nf/nb/lf/lb/cf/cb color]
|
||||||
|
[-to/nto/lto/cto secs] [-format fmt] [-key key] [-mod mod] [-mon n] [-v]
|
||||||
|
|
||||||
|
=head1 DESCRIPTION
|
||||||
|
|
||||||
|
dunst is a lightweight notification-daemon for the libnotify. dunst
|
||||||
|
displays messages received via dbus or as commandline argument in a
|
||||||
|
fashion similar to dmenu.
|
||||||
|
|
||||||
|
=head1 OPTIONS
|
||||||
|
|
||||||
|
=over 4
|
||||||
|
|
||||||
|
=item B<-h/--help>
|
||||||
|
|
||||||
|
display help message.
|
||||||
|
|
||||||
|
=item B<-fn font>
|
||||||
|
|
||||||
|
defines the font or font set used.
|
||||||
|
|
||||||
|
=item B<-lb/nb/cg color>
|
||||||
|
|
||||||
|
defines the background color of low/normal/critical messages.
|
||||||
|
|
||||||
|
=item B<-lf/nf/cf color>
|
||||||
|
|
||||||
|
defines the foreground color of low/normal/critical messages.
|
||||||
|
|
||||||
|
=item B<-to secs>
|
||||||
|
|
||||||
|
defines the default timeout. Can be (partially) overridden by
|
||||||
|
the following options.
|
||||||
|
|
||||||
|
=item B<-lto/nto/cto secs>
|
||||||
|
|
||||||
|
timeouts for low/normal/critical messages.
|
||||||
|
|
||||||
|
=item B<-key key>
|
||||||
|
|
||||||
|
close window by pressing key. See also -mod.
|
||||||
|
|
||||||
|
=item B<-mod modifier>
|
||||||
|
|
||||||
|
defines the modifier used in conjunction with -key. Available
|
||||||
|
modifiers are: ctrl, shift, mod1-mod4. This option can be used
|
||||||
|
multiple times to combine modifiers.
|
||||||
|
|
||||||
|
=item B<-format fmt>
|
||||||
|
|
||||||
|
defines the format of the message. See FORMAT.
|
||||||
|
|
||||||
|
=item B<-mon n>
|
||||||
|
|
||||||
|
show the notification on monitor n.
|
||||||
|
|
||||||
|
=item B<-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.
|
||||||
|
|
||||||
|
=item B<-v>
|
||||||
|
|
||||||
|
Increase verbosity. Can be used multiple times.
|
||||||
|
|
||||||
|
=back
|
||||||
|
|
||||||
|
=head1 FORMAT
|
||||||
|
|
||||||
|
fmt is a string containing placeholders. The placeholders will be replaced with the corresponding text, or if the text is not present, nothing. Possible placeholders are:
|
||||||
|
|
||||||
|
=over 4
|
||||||
|
|
||||||
|
=item B<%a> appname
|
||||||
|
|
||||||
|
=item B<%s> summary
|
||||||
|
|
||||||
|
=item B<%b> body
|
||||||
|
|
||||||
|
=item B<%i> iconname (including its path)
|
||||||
|
|
||||||
|
=item B<%I> iconname (without its path)
|
||||||
|
|
||||||
|
=back
|
||||||
|
|
||||||
|
=head1 COLORS
|
||||||
|
|
||||||
|
Every option that needs a color as argument accepts #RGB, #RRGGBB and
|
||||||
|
X color names.
|
||||||
|
|
||||||
|
|
||||||
|
=head1 NOTIFY-SEND
|
||||||
|
|
||||||
|
dunst is able to get different colors for a message via notify-send.
|
||||||
|
In order to do that you have to add a hint via the -h option.
|
||||||
|
|
||||||
|
=over 4
|
||||||
|
|
||||||
|
=item notify-send -h string:fgcolor:#ff4444
|
||||||
|
|
||||||
|
=item notify-send -h string:bgcolor:#4444ff -h string:fgcolor:#ff4444
|
||||||
|
|
||||||
|
=back
|
||||||
|
|
||||||
|
=head1 AUTHOR
|
||||||
|
|
||||||
|
written by Sascha Kruse <knopwob@googlemail.com>
|
||||||
|
|
||||||
|
=head1 COPYRIGHT
|
||||||
|
|
||||||
|
Parts of the code are taken from dmenu. Especially draw.c and draw.h.
|
||||||
|
See LICENSE.dmenu and http://tools.suckless.org/dmenu .
|
||||||
|
Some snippets in dunst_dbus.c are taken from twm.
|
||||||
|
See http://github.com/sboli/twmn.
|
||||||
|
|
||||||
|
Everything else can be considered beerware.
|
||||||
|
|
||||||
|
If you feel that copyrights are violated, please send me an email.
|
||||||
|
|
||||||
|
=head1 SEE ALSO
|
||||||
|
|
||||||
|
dwm(1), dmenu(1), twmn(1), notify-send(1)
|
||||||
151
dunst.1
151
dunst.1
@ -1,151 +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 [ \-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 [ \-nto
|
|
||||||
.IR secs ]
|
|
||||||
.RB [ \-lto
|
|
||||||
.IR secs ]
|
|
||||||
.RB [ \-cto
|
|
||||||
.IR secs ]
|
|
||||||
.RB [ \-format
|
|
||||||
.IR fmt ]
|
|
||||||
.RB [ \-key
|
|
||||||
.IR key ]
|
|
||||||
.RB [ \-mod
|
|
||||||
.IR modifier ]
|
|
||||||
.RB [ \-mon
|
|
||||||
.IR n ]
|
|
||||||
.RB [ \-v ]
|
|
||||||
.P
|
|
||||||
.SH DESCRIPTION
|
|
||||||
.B dunst
|
|
||||||
is a lightweight notification\-daemon for the libnotify. 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 \-to " secs"
|
|
||||||
timeout for messages with low and normal urgency. Messages with a timeout of 0 will not dissappear automaticly (defaults to 10)
|
|
||||||
.TP
|
|
||||||
.BI \-nto " secs"
|
|
||||||
timeout for messages with normal urgency (defaults to 10)
|
|
||||||
.TP
|
|
||||||
.BI \-lto " secs"
|
|
||||||
timeout for messages with low urgency (defaults to 10)
|
|
||||||
.TP
|
|
||||||
.BI \-cto " secs"
|
|
||||||
timeout for messages with critical urgency (defaults to 0)
|
|
||||||
.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 \-format " fmt"
|
|
||||||
defines the format of the messages. See FORMAT.
|
|
||||||
.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.
|
|
||||||
.TP
|
|
||||||
.BI \-v
|
|
||||||
Activate verbose mode.
|
|
||||||
|
|
||||||
.SH NOTIFY-SEND
|
|
||||||
dunst is able to get different colors for a message via notify-send. For that, you have to add a hint via the -h option.
|
|
||||||
.TP
|
|
||||||
.BI "notify-send -h string:fgcolor:#ff4444"
|
|
||||||
.TP
|
|
||||||
.BI "notify-send -h string:bgcolor:#4444ff"
|
|
||||||
.TP
|
|
||||||
.BI "notify-send -h string:bgcolor:#4444ff -h string:fgcolor:#ff4444"
|
|
||||||
.SH FORMAT
|
|
||||||
fmt is a string containing placeholders. The placeholders will be replaced with the corresponding text, or if the text is not present, nothing.
|
|
||||||
Possible placeholders are:
|
|
||||||
.TP
|
|
||||||
%a appname
|
|
||||||
.TP
|
|
||||||
%s summary
|
|
||||||
.TP
|
|
||||||
%b body
|
|
||||||
.TP
|
|
||||||
%i iconname (including its path)
|
|
||||||
.TP
|
|
||||||
%I iconname (without its path)
|
|
||||||
.SH MOUSE
|
|
||||||
.BI leftclick
|
|
||||||
to Delete oldest messages and
|
|
||||||
.BI rightclick
|
|
||||||
Delete all messages.
|
|
||||||
.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)
|
|
||||||
Loading…
x
Reference in New Issue
Block a user