]> git.sur5r.net Git - i3/i3/blob - man/i3bar.man
Merge branch 'master' into next
[i3/i3] / man / i3bar.man
1 i3bar(1)
2 ========
3 Axel Wagner <mail+i3bar@merovius.de>
4 v4.1, October 2011
5
6 == NAME
7
8 i3bar - xcb-based status- and workspace-bar
9
10 == SYNOPSIS
11
12 *i3bar* [*-s* 'sock_path'] [*-b* 'bar_id'] [*-v*] [*-h*]
13
14 == WARNING
15
16 i3bar will automatically be invoked by i3 for every 'bar' configuration block.
17
18 Starting it manually is usually not what you want to do.
19
20 You have been warned!
21
22 == OPTIONS
23
24 *-s, --socket* 'sock_path'::
25 Overwrites the path to the i3 IPC socket.
26
27 *-b, --bar_id* 'bar_id'::
28 Specifies the bar ID for which to get the configuration from i3.
29
30 *-v, --version*::
31 Display version number and exit.
32
33 *-h, --help*::
34 Display a short help-message and exit
35
36 == DESCRIPTION
37
38 *i3bar* displays a bar at the bottom (or top) of your monitor(s) containing
39 workspace switching buttons and a statusline generated by i3status(1) or
40 similar. It is automatically invoked (and configured through) i3.
41
42 i3bar does not support any color or other markups, so stdin should be plain
43 utf8, one line at a time. If you use *i3status*(1), you therefore should
44 specify 'output_format = none' in the general section of its config file.
45
46 == ENVIRONMENT
47
48 === I3SOCK
49
50 Used as a fallback for the i3 IPC socket path if neither the commandline
51 contains an argument nor the I3_SOCKET_PATH property is set on the X11 root
52 window.
53
54 == EXAMPLES
55
56 Nothing to see here, move along. As stated above, you should not run i3bar manually.
57
58 Instead, see the i3 documentation, especially the User’s Guide.
59
60 == SEE ALSO
61
62 +i3status(1)+ or +conky(1)+ for programs generating a statusline.
63
64 +dzen2(1)+ or +xmobar(1)+ for similar programs to i3bar.
65
66 == AUTHORS
67
68 Axel Wagner and contributors