git.sur5r.net Git - i3/i3/blob - i3bar/doc/i3bar.man

   1 i3bar(1)
   2 ========
   3 Axel Wagner <mail+i3bar@merovius.de>
   4 v0.7, July 2011
   5
   6 == NAME
   7
   8 i3bar - xcb-based status- and workspace-bar
   9
  10 == SYNOPSIS
  11
  12 *i3bar* [*-s* 'sock_path'] [*-c* 'command'] [*-m*|*-d*['pos']] [*-f* 'font'] [*-V*] [*-h*]
  13
  14 == OPTIONS
  15
  16 *-s, --socket* 'sock_path'::
  17 Specifies the 'socketpath', via which *i3bar* connects to *i3*(1). If *i3bar* can not connect to *i3*, it will exit. Defaults to '/tmp/i3-ipc.sock'
  18
  19 *-c, --command* 'command'::
  20 Execute '<command>' to get 'stdin'. You can also simply pipe into 'stdin', but starting the coomand for itself, *i3bar* is able to send 'SIGCONT' and 'SIGSTOP', when combined with *-m*
  21
  22 *-m, --hide*::
  23 Hide the bar, when 'mod4' is not pressed. With this, dockmode will not be set, and the bar is out of the way most of the time so you have more room.
  24 If *-c* is specified, the childprocess is sent a 'SIGSTOP' on hiding and a 'SIGCONT' on unhiding of the bars.
  25 This is the default behavior of i3bar.
  26
  27 *-d*['pos']*, --dock*[*=*'pos']::
  28 Put i3bar in dockmode. This will reserve some space for it, so it does not overlap other clients.
  29 You can specify either *bottom* (default) or *top* as 'pos'.
  30
  31 *-f, --font* 'font'::
  32 Specifies a 'X-core-font' to use. You can choose one with *xfontsel*(1). Defaults to '-misc-fixed-medium-r-semicondensed--12-110-75-75-c-60-iso10646-1'.
  33
  34 *-V, --verbose*::
  35 Be (very) verbose with the debug-output. If not set, only errors are reported to 'stderr'
  36
  37 *-h, --help*::
  38 Display a short help-message and exit
  39
  40 == DESCRIPTION
  41
  42 *i3bar* is an xcb- and libev-based status- and ws-bar. It is best thought of as an replacement for the *i3-wsbar*(1) + *dzen2*(1)-combination. It creates a workspace-bar for every active output ("screen") and displays a piped in statusline rightaligned on every bar.
  43
  44 It does not sample any status-information itself, so you still need a program like *i3status*(1) or *conky*(1) for that.
  45
  46 i3bar does not support any color or other markups, so stdin should be plain utf8, one line at a time. If you use *i3status*(1), you therefore should specify 'output_format = none' in the general section of its config file.
  47
  48 Also, you should disable the internal workspace bar of *i3*(1), when using *i3bar* by specifying 'workspace_bar no' in your *i3*-configfile.
  49
  50 == COLORS
  51
  52 *i3bar* does not yet support formatting in the displayed statusline. However it does support setting colors for the bar, the workspace-buttons and the statusline.
  53
  54 For now this happens with the following command-line-options:
  55
  56 *--color-bar-fg, --color-bar-bg, --color-active-ws-fg, --color-active-ws-bg, --color-inactive-ws-fg,  --color-inactive-ws-bg, --color-urgent-ws-bg, --color-urgent-ws-fg, --color-focus-ws-fg, --color-focus-ws-bg*
  57
  58 For each specified option you need to give a HEX-colorcode.
  59
  60 Be advised that this command-line-options are only temporary and are very likely to be removed, when we finally have a config-file.
  61
  62 == ENVIRONMENT
  63
  64 === I3SOCK
  65
  66 If no ipc-socket is specified on the commandline, this variable is used
  67 to determine the path, at wich the unix domain socket is expected, on which
  68 to connect to i3.
  69
  70 == EXAMPLES
  71
  72 To get a docked bar with some statusinformation, you use
  73
  74 *i3status | i3bar --dock*
  75
  76 If you rather have it displayed at the top of the screen, you use
  77
  78 *i3status | i3bar --dock=top*
  79
  80 If you want it to hide when not needed, you should instead simply use
  81
  82 *i3bar -c i3status*
  83
  84 == SEE ALSO
  85
  86 +i3(1)+, +i3-wsbar(1)+, +dzen2(1)+, +i3status(1)+
  87
  88 == AUTHORS
  89
  90 Axel Wagner and contributors