LemonBoy / bar

A featherweight, lemon-scented, bar based on xcb
MIT License
1.61k stars 194 forks source link

=head1 NAME

lemonbar - Featherweight lemon-scented bar

=for HTML

=head1 SYNOPSIS

I [-h | -g IBIB<+>IB<+>I | -o | -b | -d | -f I | -p | -n I | -u I | -B I | -F I | -U I]

=head1 DESCRIPTION

B (formerly known as B) is a lightweight statusbar based on XCB. Provides full UTF-8 support, basic formatting, RandR and Xinerama support and EWMH compliance without wasting your precious memory.

=head1 INPUT

The data to be parsed is read from the standard input, parsing and printing the input data are delayed until a newline is found.

=head1 OPTIONS

=over

=item B<-h>

Display the help and exit.

=item B<-g> IBIB<+>IB<+>I

Set the window geometry. If a parameter is omitted it's filled with the default value. If the I parameter is specified along with the B<-b> switch then the position is relative to the bottom of the screen.

=item B<-o> I

Set next output to I. May be used multiple times; order is significant. If any B<-o> options are given, only B<-o> specified monitors will be used. Invalid output names are silently ignored. (only supported on randr configurations at this time)

=item B<-b>

Dock the bar at the bottom of the screen.

=item B<-d>

Force docking without asking the window manager. This is needed if the window manager isn't EWMH compliant.

=item B<-f> I

Specifies a font to use. Can be used multiple times to load more than a single font.

=item B<-p>

Make the bar permanent, don't exit after the standard input is closed.

=item B<-n> I

Set the WM_NAME atom value for the bar.

=item B<-u> I

Sets the underline width in pixels. The default is 1.

=item B<-B> I

Set the background color of the bar. I must be specified in the hex format (#aarrggbb, #rrggbb, #rgb). If no compositor such as compton or xcompmgr is running the alpha channel is silently ignored.

=item B<-F> I

Set the foreground color of the bar. Accepts the same color formats as B<-B>.

=item B<-U> I

Set the underline color of the bar. Accepts the same color formats as B<-B>.

=back

=head1 FORMATTING

lemonbar provides a screenrc-inspired formatting syntax to allow full customization at runtime. Every formatting block is opened with C<%{> and closed by C<}> and accepts the following commands, the parser tries its best to handle malformed input. Use C<%%> to get a literal percent sign (C<%>).

=over

=item B

Swap the current background and foreground colors.

=item B

Aligns the following text to the left side of the screen.

=item B

Aligns the following text to the center of the screen.

=item B

Aligns the following text to the right side of the screen.

=item BI

Offset the current position by I pixels in the alignment direction.

=item BI

Set the text background color. The parameter I can be I<-> or a color in one of the formats mentioned before. The special value I<-> resets the color to the default one.

=item BI

Set the text foreground color. The parameter I can be I<-> or a color in one of the formats mentioned before. The special value I<-> resets the color to the default one.

=item BI

Set the font used to draw the following text. The parameter I can either be I<-> or the 1-based index of the slot which contains the desired font. If the parameter is I<-> lemonbar resets to the normal behavior (matching the first font that can be used for the character). If the selected font can't be used to draw a character, lemonbar will fall back to normal behavior for that character

=item BI

Set the text underline color. The parameter I can be I<-> or a color in one of the formats mentioned before. The special value I<-> resets the color to the default one.

=item BI