updated documentation
This commit is contained in:
		
							parent
							
								
									3e5bf33b59
								
							
						
					
					
						commit
						d9527bd949
					
				
							
								
								
									
										40
									
								
								README
									
									
									
									
									
								
							
							
						
						
									
										40
									
								
								README
									
									
									
									
									
								
							| @ -2,12 +2,15 @@ NAME | |||||||
|        dunst - dmenu-ish universal notification system |        dunst - dmenu-ish universal notification system | ||||||
| 
 | 
 | ||||||
| SYNOPSIS | 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 | DESCRIPTION | ||||||
|        dunst  is a lightweight notification-daemon for the libnotify. It can also be used as a standalone notification |        dunst is a lightweight notification-daemon for the  libnotify.  It  can | ||||||
|        system. Dnotify displays messages received via dbus or as commandline argument in a fashion  similar  to  dmenu |        also be used as a standalone notification system. Dnotify displays mes‐ | ||||||
|        and additionally prints them to stdout. Notifications can be closed via mouseclick. |        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 | OPTIONS | ||||||
|        -h/--help |        -h/--help | ||||||
| @ -16,33 +19,48 @@ OPTIONS | |||||||
|        -b     dunst appears at the bottom of the screen. |        -b     dunst appears at the bottom of the screen. | ||||||
| 
 | 
 | ||||||
|        -ne l/r |        -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 |        -fn/ font | ||||||
|               defines the font or font set used. |               defines the font or font set used. | ||||||
| 
 | 
 | ||||||
|        -nb/-bg color |        -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 |        -nf/-fg color | ||||||
|               defines the background color. |               defines the background color. | ||||||
| 
 | 
 | ||||||
|        -msg msg |        -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 |        -to secs | ||||||
|               display each message for secs seconds. |               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 | AUTHOR | ||||||
|        written by Sascha Kruse <knopwob@googlemail.com> |        written by Sascha Kruse <knopwob@googlemail.com> | ||||||
| 
 | 
 | ||||||
| COPYRIGHT | COPYRIGHT | ||||||
|        Parts  of  the  code  are  taken  from  dmenu  (especially  draw.c and draw.h).  Read LICENCE.dmenu and look at |        Parts  of the code are taken from dmenu (especially draw.c and draw.h). | ||||||
|        http://tools.suckless.org/dmenu. |        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 | SEE also | ||||||
|        dwm(1), dmenu(1), twmn(1), notify-send(1) |        dwm(1), dmenu(1), twmn(1), notify-send(1) | ||||||
|  | |||||||
							
								
								
									
										10
									
								
								dunst.1
									
									
									
									
									
								
							
							
						
						
									
										10
									
								
								dunst.1
									
									
									
									
									
								
							| @ -14,6 +14,10 @@ dunst \- dmenu\-ish universal notification system | |||||||
| .IR color ] | .IR color ] | ||||||
| .RB [ \-to | .RB [ \-to | ||||||
| .IR secs ] | .IR secs ] | ||||||
|  | .RB [ \- key | ||||||
|  | .IR key ] | ||||||
|  | .RB [ \- mod | ||||||
|  | .IR modifier ] | ||||||
| .P | .P | ||||||
| .SH DESCRIPTION | .SH DESCRIPTION | ||||||
| .B dunst  | .B dunst  | ||||||
| @ -43,6 +47,12 @@ display msg instead of listening to notifications. This option can be used multi | |||||||
| .TP | .TP | ||||||
| .BI \-to " secs" | .BI \-to " secs" | ||||||
| display each message for secs seconds. | 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 | .SH AUTHOR | ||||||
| written by Sascha Kruse <knopwob@googlemail.com> | written by Sascha Kruse <knopwob@googlemail.com> | ||||||
| .SH COPYRIGHT | .SH COPYRIGHT | ||||||
|  | |||||||
							
								
								
									
										2
									
								
								dunst.c
									
									
									
									
									
								
							
							
						
						
									
										2
									
								
								dunst.c
									
									
									
									
									
								
							| @ -378,6 +378,6 @@ main(int argc, char *argv[]) { | |||||||
| 
 | 
 | ||||||
| void | void | ||||||
| usage(int exit_status) { | 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); |     exit(exit_status); | ||||||
| } | } | ||||||
|  | |||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user
	 Sascha Kruse
						Sascha Kruse