Merge pull request #2766 from MachFour/nagbar-shell-exec

[i3/i3] / man / i3-nagbar.man

diff --git a/man/i3-nagbar.man b/man/i3-nagbar.man
index 3dd37bb706c97866700a1f72a967fcb241b8f456..7dd3a238130e66ea09719d37aaa2365cfc4980f1 100644 (file)
--- a/man/i3-nagbar.man
+++ b/man/i3-nagbar.man
@@ -9,7 +9,33 @@ i3-nagbar - displays an error bar on top of your screen
 
 == SYNOPSIS
 
-i3-nagbar -m 'message' -b 'label' 'action'
+i3-nagbar [-m <message>] [-b <button> <terminal-action>] [-B <button> <shell-action>] [-t warning|error] [-f <font>] [-v]
+
+== OPTIONS
+
+*-v, --version*::
+Display version number and exit.
+
+*-h, --help*::
+Display a short help-message and exit.
+
+*-t, --type* 'type'::
+Display either a warning or error message. This only changes the color scheme
+for the i3-nagbar. Default: error.
+
+*-m, --message* 'message'::
+Display 'message' as text on the left of the i3-nagbar.
+
+*-f, --font* 'font'::
+Select font that is being used.
+
+*-b, --button* 'button' 'terminal-action'::
+Adds a button labelled 'button' to the bar. When pressed, the command given
+in 'terminal-action' is executed inside a terminal emulator, via i3-sensible-terminal(1).
+Multiple buttons can be defined.
+
+*-B, --button-sh* 'button' 'shell-action'::
+Same as *--button*, except that the command given in 'shell-action' is executed directly by the shell.
 
 == DESCRIPTION
 
@@ -22,12 +48,12 @@ after modifying the configuration file.
 
 ------------------------------------------------
 i3-nagbar -m 'You have an error in your i3 config file!' \
--b 'edit config' 'xterm $EDITOR ~/.i3/config'
+-b 'edit config' 'i3-sensible-editor ~/.config/i3/config'
 ------------------------------------------------
 
 == SEE ALSO
 
-i3(1)
+i3(1), i3-sensible-terminal(1)
 
 == AUTHOR