Codebase list i3-gaps / e6d2486 man / i3bar.1
e6d2486

Tree @e6d2486 (Download .tar.gz)

i3bar.1 @e6d2486raw · history · blame

'\" t
.\"     Title: i3bar
.\"    Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 08/30/2019
.\"    Manual: i3 Manual
.\"    Source: i3 4.17.1
.\"  Language: English
.\"
.TH "I3BAR" "1" "08/30/2019" "i3 4\&.17\&.1" "i3 Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
i3bar \- xcb\-based status\- and workspace\-bar
.SH "SYNOPSIS"
.sp
\fBi3bar\fR [\fB\-s\fR \fIsock_path\fR] [\fB\-b\fR \fIbar_id\fR] [\fB\-v\fR] [\fB\-h\fR]
.SH "WARNING"
.sp
i3bar will automatically be invoked by i3 for every \fIbar\fR configuration block\&.
.sp
Starting it manually is usually not what you want to do\&.
.sp
You have been warned!
.SH "OPTIONS"
.PP
\fB\-s, \-\-socket\fR \fIsock_path\fR
.RS 4
Overwrites the path to the i3 IPC socket\&.
.RE
.PP
\fB\-b, \-\-bar_id\fR \fIbar_id\fR
.RS 4
Specifies the bar ID for which to get the configuration from i3\&.
.RE
.PP
\fB\-v, \-\-version\fR
.RS 4
Display version number and exit\&.
.RE
.PP
\fB\-h, \-\-help\fR
.RS 4
Display a short help\-message and exit
.RE
.SH "DESCRIPTION"
.sp
\fBi3bar\fR 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\&.
.sp
i3bar supports colors via a JSON protocol starting from v4\&.2, see \m[blue]\fBhttps://i3wm\&.org/docs/i3bar\-protocol\&.html\fR\m[]
.SH "ENVIRONMENT"
.SS "I3SOCK"
.sp
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\&.
.SH "EXAMPLES"
.sp
Nothing to see here, move along\&. As stated above, you should not run i3bar manually\&.
.sp
Instead, see the i3 documentation, especially the User\(cqs Guide\&.
.SH "SEE ALSO"
.sp
i3status(1), j4status(1) or conky(1) for programs generating a statusline\&.
.sp
dzen2(1) or xmobar(1) for similar programs to i3bar\&.
.SH "AUTHORS"
.sp
Axel Wagner and contributors