gri3-wm/man/i3bar.man

69 lines
1.6 KiB
Groff
Raw Normal View History

2010-09-17 18:27:07 +02:00
i3bar(1)
========
Axel Wagner <mail+i3bar@merovius.de>
2011-10-20 23:55:24 +02:00
v4.1, October 2011
2010-09-17 18:27:07 +02:00
== NAME
i3bar - xcb-based status- and workspace-bar
2010-09-17 18:27:07 +02:00
== SYNOPSIS
2011-10-20 23:55:24 +02:00
*i3bar* [*-s* 'sock_path'] [*-b* 'bar_id'] [*-v*] [*-h*]
2010-09-17 18:27:07 +02:00
2011-10-20 23:55:24 +02:00
== WARNING
2010-09-17 18:27:07 +02:00
2011-10-20 23:55:24 +02:00
i3bar will automatically be invoked by i3 for every 'bar' configuration block.
2010-09-17 18:27:07 +02:00
2011-10-20 23:55:24 +02:00
Starting it manually is usually not what you want to do.
2010-09-17 18:27:07 +02:00
2011-10-20 23:55:24 +02:00
You have been warned!
2011-02-21 15:47:58 +01:00
2011-10-20 23:55:24 +02:00
== OPTIONS
*-s, --socket* 'sock_path'::
Overwrites the path to the i3 IPC socket.
2010-09-17 18:27:07 +02:00
2011-10-20 23:55:24 +02:00
*-b, --bar_id* 'bar_id'::
Specifies the bar ID for which to get the configuration from i3.
2010-09-17 18:27:07 +02:00
2011-10-20 23:55:24 +02:00
*-v, --version*::
Display version number and exit.
2010-09-17 18:27:07 +02:00
*-h, --help*::
Display a short help-message and exit
== DESCRIPTION
2011-10-20 23:55:24 +02:00
*i3bar* displays a bar at the bottom (or top) of your monitor(s) containing
workspace switching buttons and a statusline generated by i3status(1) or
similar. It is automatically invoked (and configured through) i3.
2011-10-20 23:55:24 +02:00
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.
2011-01-11 05:02:55 +01:00
== ENVIRONMENT
=== I3SOCK
2011-10-20 23:55:24 +02:00
Used as a fallback for the i3 IPC socket path if neither the commandline
contains an argument nor the I3_SOCKET_PATH property is set on the X11 root
window.
2011-01-11 05:02:55 +01:00
2010-09-17 18:27:07 +02:00
== EXAMPLES
2011-10-20 23:55:24 +02:00
Nothing to see here, move along. As stated above, you should not run i3bar manually.
2011-02-21 15:47:58 +01:00
2011-10-20 23:55:24 +02:00
Instead, see the i3 documentation, especially the Users Guide.
2010-09-17 18:27:07 +02:00
== SEE ALSO
2011-10-20 23:55:24 +02:00
+i3status(1)+ or +conky(1)+ for programs generating a statusline.
+dzen2(1)+ or +xmobar(1)+ for similar programs to i3bar.
2010-09-17 18:27:07 +02:00
== AUTHORS
Axel Wagner and contributors