mirror of https://github.com/polybar/polybar.git
130 lines
4.6 KiB
Groff
130 lines
4.6 KiB
Groff
.TH lemonbuddy_config 5 2016-10-18 "lemonbuddy 2.0.0" "User Configuration"
|
|
.SH NAME
|
|
.\" This man page will need lots of updating as documentation about lemonbuddy
|
|
.\" configuration improves.
|
|
\fBlemonbuddy_config\fR \- Configuration for a \fBlemonbuddy\fR(1) bar.
|
|
.SH SYNOPSIS
|
|
.BR $XDG_CONFIG_HOME/.config/lemonbuddy/config
|
|
.P
|
|
.BR ~/.config/lemonbuddy/config
|
|
.SH SYNTAX
|
|
.nf
|
|
.TP
|
|
The configuration syntax is based on the \fIini\fR file format.
|
|
.TP
|
|
A sample config section with various field types:
|
|
|
|
[section/name]
|
|
str = My string
|
|
; Quote the value to keep surrounding spaces
|
|
str = " My string"
|
|
bool = true
|
|
bool = on
|
|
int = 10
|
|
float = 10.0
|
|
.TP
|
|
Values defined in another section can be referenced using:
|
|
|
|
key = \fI${bar/top.foreground}\fR
|
|
.TP
|
|
Read the value of an environment variable using:
|
|
|
|
key = \fI${env:MYVAR}\fR
|
|
.TP
|
|
Use BAR to target the section of the current bar:
|
|
|
|
key = \fI${BAR.foreground}\fR
|
|
.TP
|
|
Most modules define a format-N field. The formats define a set of tags. For example, the mpd module defines the following formats:
|
|
|
|
\fIformat-online\fR = ... <label-song> <icon-play> ...
|
|
\fIformat-offline\fR = the server is offline
|
|
.TP
|
|
The modules will toggle between the formats and only show the one defined for the current module state.
|
|
.TP
|
|
Each format contains the following fields:
|
|
|
|
format[-NAME]-padding = N (unit: whitespaces)
|
|
format[-NAME]-margin = N (unit: whitespaces)
|
|
format[-NAME]-spacing = N (unit: whitespaces)
|
|
format[-NAME]-offset = N (unit: pixels)
|
|
format[-NAME]-foreground = #aa[rrggbb]
|
|
format[-NAME]-background = #aa[rrggbb]
|
|
format[-NAME]-underline = #aa[rrggbb]
|
|
format[-NAME]-overline = #aa[rrggbb]
|
|
.TP
|
|
The rest of the drawtypes follow the same pattern.
|
|
|
|
.\" TODO: Describe the drawtypes
|
|
label-NAME[-(foreground|background|(under|over)line|font|padding|maxlen|ellipsis)] = ?
|
|
icon-NAME[-(foreground|background|(under|over)line|font|padding)] = ?
|
|
ramp-NAME-[0-9]+[-(foreground|background|(under|over)line|font|padding)] = ?
|
|
animation-NAME-[0-9]+[-(foreground|background|(under|over)line|font|padding)] = ?
|
|
|
|
bar-NAME-width = N (unit: characters)
|
|
bar-NAME-format = (tokens: %fill% %indicator% %empty%)
|
|
bar-NAME-foreground-[0-9]+ = #aarrggbb
|
|
bar-NAME-indicator[-(foreground|background|(under|over)line|font|padding)] =
|
|
bar-NAME-fill[-(foreground|background|(under|over)line|font|padding)] =
|
|
bar-NAME-empty[-(foreground|background|(under|over)line|font|padding)] =
|
|
|
|
|
|
.fi
|
|
.SH APPLICATION SETTINGS
|
|
These settings should exist in the `settings` section within the configuration file.
|
|
.TP
|
|
\fBthrottle-limit\fR and \fBthrottle-ms\fR
|
|
Limit the amount of update events within a set timeframe. Allow at most \fIthrottle-limit\fR updates within \fIthrottle-ms\fR milliseconds.
|
|
.SH BAR SETTINGS
|
|
These settings should be defined in the [bar/\fIBAR\-NAME\fR] section.
|
|
.TP
|
|
.BR monitor
|
|
Which display to output the bar to. You can get a list of available outputs by using the command `xrandr -q | grep " connected" | cut -d ' ' -f1`.
|
|
If unspecified, the application will pick the first one it finds.
|
|
.TP
|
|
\fBwidth\fR, \fBheight\fR
|
|
How large the bar should be. You can specify the values as a percentage of the screen, for example `85%`, or omit the `%` and give the dimension(s) in pixels.
|
|
.TP
|
|
\fBoffset-x\fR, \fBoffset-y\fR
|
|
The window offset value in pixels.
|
|
.TP
|
|
.BR bottom
|
|
Put the bar at the bottom of the screen.
|
|
.TP
|
|
.BR dock
|
|
If this boolean is set to `true`, then force the X window to dock itself.
|
|
If you are using \fBi3\fR(1) it is recommended to use the default value.
|
|
.TP
|
|
.BR spacing
|
|
This integer value is used as a multiplier when adding spaces between elements.
|
|
.TP
|
|
.BR lineheight
|
|
How high underlines and overlines should be.
|
|
.TP
|
|
\fBbackground\fR, \fBforeground\fR, \fBlinecolor\fR
|
|
Specify the colors used to draw the bar.
|
|
.TP
|
|
\fBpadding-left\fR, \fBpadding-right\fR
|
|
Specify the number of spaces to add at the start or end of the entire bar.
|
|
.TP
|
|
\fBmodule-margin-left\fR, \fBmodule-margin-right\fR
|
|
Specify the number of spaces to add before or after each module.
|
|
.TP
|
|
.BR font\-\fIid\fR
|
|
Here you can specify which fonts you wish to use. You need to set \fIid\fR to be a positive integer. The font should be specified in the following format: `\fIFONT\-NAME\fR:size=\fIFONT\-SIZE\fR;\fIOFFSET\fR`. For example, you could set `font\-0` to be `NotoSans-Regular:size=8;0`.
|
|
.TP
|
|
.BR wm-name
|
|
The value to set \fIWM_NAME\fR to when running. This defaults to `lemonbuddy\-\fIBAR-NAME\fR_\fIMONITOR\fR`.
|
|
.TP
|
|
.BR locale
|
|
Which locale to use.
|
|
.TP
|
|
\fBmodules-left\fR, \fBmodules-center\fR, \fBmodules-right\fR
|
|
Define which modules to use in the bar.
|
|
.SH EXAMPLES
|
|
.\" TODO add examples
|
|
There are no examples yet.
|
|
.SH SEE ALSO
|
|
.TP
|
|
\fBlemonbuddy\fR(1)
|