git.sur5r.net Git - i3/i3/blob - man/i3-nagbar.man

   1 i3-nagbar(1)
   2 ============
   3 Michael Stapelberg <michael+i3@stapelberg.de>
   4 v4.0, July 2011
   5
   6 == NAME
   7
   8 i3-nagbar - displays an error bar on top of your screen
   9
  10 == SYNOPSIS
  11
  12 i3-nagbar [-m <message>] [-b <button> <terminal-action>] [-B <button> <shell-action>] [-t warning|error] [-f <font>] [-v]
  13
  14 == OPTIONS
  15
  16 *-v, --version*::
  17 Display version number and exit.
  18
  19 *-h, --help*::
  20 Display a short help-message and exit.
  21
  22 *-t, --type* 'type'::
  23 Display either a warning or error message. This only changes the color scheme
  24 for the i3-nagbar. Default: error.
  25
  26 *-m, --message* 'message'::
  27 Display 'message' as text on the left of the i3-nagbar.
  28
  29 *-f, --font* 'font'::
  30 Select font that is being used.
  31
  32 *-b, --button* 'button' 'terminal-action'::
  33 Adds a button labelled 'button' to the bar. When pressed, the command given
  34 in 'terminal-action' is executed inside a terminal emulator, via i3-sensible-terminal(1).
  35 Multiple buttons can be defined.
  36
  37 *-B, --button-sh* 'button' 'shell-action'::
  38 Same as *--button*, except that the command given in 'shell-action' is executed directly by the shell.
  39
  40 == DESCRIPTION
  41
  42 i3-nagbar is used by i3 to tell you about errors in your configuration file
  43 (for example). While these errors are logged to the logfile (if any), the past
  44 has proven that users are either not aware of their logfile or do not check it
  45 after modifying the configuration file.
  46
  47 == EXAMPLE
  48
  49 ------------------------------------------------
  50 i3-nagbar -m 'You have an error in your i3 config file!' \
  51 -b 'edit config' 'i3-sensible-editor ~/.config/i3/config'
  52 ------------------------------------------------
  53
  54 == SEE ALSO
  55
  56 i3(1), i3-sensible-terminal(1)
  57
  58 == AUTHOR
  59
  60 Michael Stapelberg and contributors