nixo
/
gri3-wm
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

i3bar: update manpage

This commit is contained in:
Michael Stapelberg 2011-10-20 22:55:24 +01:00
parent caee0a0fda
commit d970b19b59
1 changed files with 29 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
i3bar/doc/i3bar.man
View File

@ -1,7 +1,7 @@
i3bar(1) i3bar(1)
======== ========
Axel Wagner <mail+i3bar@merovius.de> Axel Wagner <mail+i3bar@merovius.de>
v0.7, July 2011 v4.1, October 2011
== NAME == NAME
@ -9,81 +9,59 @@ i3bar - xcb-based status- and workspace-bar
== SYNOPSIS == SYNOPSIS
*i3bar* [*-s* 'sock_path'] [*-c* 'command'] [*-m*|*-d*['pos']] [*-f* 'font'] [*-V*] [*-h*] *i3bar* [*-s* 'sock_path'] [*-b* 'bar_id'] [*-v*] [*-h*]
== WARNING
i3bar will automatically be invoked by i3 for every 'bar' configuration block.
Starting it manually is usually not what you want to do.
You have been warned!
== OPTIONS == OPTIONS
*-s, --socket* 'sock_path':: *-s, --socket* 'sock_path'::
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' Overwrites the path to the i3 IPC socket.
*-c, --command* 'command':: *-b, --bar_id* 'bar_id'::
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* Specifies the bar ID for which to get the configuration from i3.
*-m, --hide*:: *-v, --version*::
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. Display version number and exit.
If *-c* is specified, the childprocess is sent a 'SIGSTOP' on hiding and a 'SIGCONT' on unhiding of the bars.
This is the default behavior of i3bar.
*-d*['pos']*, --dock*[*=*'pos']::
Put i3bar in dockmode. This will reserve some space for it, so it does not overlap other clients.
You can specify either *bottom* (default) or *top* as 'pos'.
*-f, --font* 'font'::
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+++'.
*-V, --verbose*::
Be (very) verbose with the debug-output. If not set, only errors are reported to 'stderr'
*-h, --help*:: *-h, --help*::
Display a short help-message and exit Display a short help-message and exit
== DESCRIPTION == DESCRIPTION
*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. *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.
It does not sample any status-information itself, so you still need a program like *i3status*(1) or *conky*(1) for that. 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
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. specify 'output_format = none' in the general section of its config file.
Also, you should disable the internal workspace bar of *i3*(1), when using *i3bar* by specifying 'workspace_bar no' in your *i3*-configfile.
== COLORS
*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.
For now this happens with the following command-line-options:
*--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*
For each specified option you need to give a HEX-colorcode.
Be advised that this command-line-options are only temporary and are very likely to be removed, when we finally have a config-file.
== ENVIRONMENT == ENVIRONMENT
=== I3SOCK === I3SOCK
If no ipc-socket is specified on the commandline, this variable is used Used as a fallback for the i3 IPC socket path if neither the commandline
to determine the path, at wich the unix domain socket is expected, on which contains an argument nor the I3_SOCKET_PATH property is set on the X11 root
to connect to i3. window.
== EXAMPLES == EXAMPLES
To get a docked bar with some statusinformation, you use Nothing to see here, move along. As stated above, you should not run i3bar manually.
*i3status | i3bar --dock* Instead, see the i3 documentation, especially the User’s Guide.
If you rather have it displayed at the top of the screen, you use
*i3status | i3bar --dock=top*
If you want it to hide when not needed, you should instead simply use
*i3bar -c i3status*
== SEE ALSO == SEE ALSO
+i3(1)+, +i3-wsbar(1)+, +dzen2(1)+, +i3status(1)+ +i3status(1)+ or +conky(1)+ for programs generating a statusline.
+dzen2(1)+ or +xmobar(1)+ for similar programs to i3bar.
== AUTHORS == AUTHORS