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> <action>] [-B <button> <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' 'action'::
  33 Create a button with text 'button'. The 'action' are the shell commands that
  34 will be executed by this button. Multiple buttons can be defined.
  35 Will launch the shell commands inside a terminal emulator, using
  36 i3-sensible-terminal.
  37
  38 *-B, --button-no-terminal* 'button' 'action'::
  39 Same as above, but will execute the shell commands directly, without launching a
  40 terminal emulator.
  41
  42 == DESCRIPTION
  43
  44 i3-nagbar is used by i3 to tell you about errors in your configuration file
  45 (for example). While these errors are logged to the logfile (if any), the past
  46 has proven that users are either not aware of their logfile or do not check it
  47 after modifying the configuration file.
  48
  49 == EXAMPLE
  50
  51 ------------------------------------------------
  52 i3-nagbar -m 'You have an error in your i3 config file!' \
  53 -b 'edit config' 'i3-sensible-editor ~/.config/i3/config'
  54 ------------------------------------------------
  55
  56 == SEE ALSO
  57
  58 i3(1)
  59
  60 == AUTHOR
  61
  62 Michael Stapelberg and contributors