From c94282783d90763b9aced1db2ed4f6b2d2c7fcd1 Mon Sep 17 00:00:00 2001 From: Michael Carlberg Date: Sat, 15 Oct 2016 00:30:45 +0200 Subject: [PATCH] fix(docs): Moved configuration details to the github wiki --- README.md | 988 +----------------------------------------------------- 1 file changed, 1 insertion(+), 987 deletions(-) diff --git a/README.md b/README.md index 97bcec8c..c13a572b 100644 --- a/README.md +++ b/README.md @@ -27,25 +27,6 @@ problems by [creating an issue ticket](https://github.com/jaagr/lemonbuddy/issue * [Running](#running) * [Launching the bar in your wm's bootstrap routine](#launching-the-bar-in-your-wms-bootstrap-routine) * [Configuration](#configuration) - * [Fonts](#fonts) - * [Syntax and DSL](#syntax-and-dsl) - * [Application settings](#application-settings) - * [Bar settings](#bar-settings) - * [Modules](#modules) - * [internal/backlight](#module-internalbacklight) - * [internal/battery](#module-internalbattery) - * [internal/bspwm](#module-internalbspwm) - * [internal/cpu](#module-internalcpu) - * [internal/date](#module-internaldate) - * [internal/i3](#module-internali3) - * [internal/memory](#module-internalmemory) - * [internal/mpd](#module-internalmpd) - * [internal/network](#module-internalnetwork) - * [internal/volume](#module-internalvolume) - * [custom/menu](#module-custommenu) - * [custom/script](#module-customscript) - * [custom/text](#module-customtext) -* [Example configurations](#example-configurations) * [License](#license) @@ -75,8 +56,6 @@ Read more about [how the configuration works](#configuration). If you are using **Arch Linux**, you can install the AUR package [lemonbuddy-git](https://aur.archlinux.org/packages/lemonbuddy-git/) to get the latest version, or [lemonbuddy](https://aur.archlinux.org/packages/lemonbuddy/) for the latest stable release. -For **Void Linux** users, the application can be installed using XBPS: `xbps-install -S lemonbuddy`. - If you create a package for any other distribution, please consider contributing the template so that we can make the application available for more people. @@ -100,7 +79,6 @@ Optional dependencies for module support: ~~~ sh $ pacman -S cmake python2 boost xcb-util-wm libxft wireless_tools alsa-lib libmpdclient jsoncpp -$ xbps-install cmake boost-devel libxcb-util-dev alsa-lib-devel i3-devel libmpdclient-devel jsoncpp-devel wireless_tools-devel $ apt-get install cmake cmake-data libboost-dev libfreetype6-dev libxcb1-dev libxcb-util0-dev libxcb-randr0-dev libxcb-ewmh-dev libxcb-icccm4-dev xcb-proto python-xcbgen i3-wm libiw-dev libasound2-dev libmpdclient-dev ~~~ @@ -177,971 +155,7 @@ If you are using **i3**, add the following line to your configuration: ## Configuration -The configuration syntax is a work in progress. Please [create an issue ticket](https://github.com/jaagr/lemonbuddy/issues/new) -and let me know how you think we can improve it. - -The values used in the examples below are to be considered placeholder values, and -the resulting output might not be award-winning. - - -### Fonts - -When working with unicode symbols, remember that fonts render the symbols differently. Changing font -can drastically improve the quality of your bar. [Unifont](http://unifoundry.com/unifont.html) has great unicode coverage, which makes -it really useful. - -Also try different icon fonts, such as [Font Awesome](http://fontawesome.io/icons), [Material Icons](https://design.google.com/icons) and my personal favorite: [Siji](https://github.com/stark/siji). - -*TODO: Describe usage in configuration...* - - -### Syntax and DSL - -*TODO: Clarify...* - -The configuration syntax is based on the `ini` file format. - - ~~~ ini - [section/name] - str = My string - ; Hint: Quote the value to keep the spaces - str = " My string" - bool = true - bool = on - int = 10 - float = 10.0 - - ; Values for a defined bar can be referenced using: - key = ${bar/top.foreground} - - ; Values for the current bar can be referenced using: - key = ${BAR.foreground} - - ; Other values can be referenced using: - key = ${section.key} - - ; Environment variables can be referenced using: - key = ${env:VAR_NAME} - ~~~ - ~~~ ini - [section/name] - ; Most modules define a format-N field - ; For example, the mpd module defines the following formats: - ; format-online = ... - ; format-offline = ... - ; - ; Each format exposes the following fields: - ; format[-NAME]-padding = N (unit: whitespaces) - ; format[-NAME]-margin = N (unit: whitespaces) - ; (See "Bar settings" for more details on "spacing") - ; format[-NAME]-spacing = N (unit: whitespaces) - ; (This value will displace the format block horizontally by +/-N pixels) - ; format[-NAME]-offset = N (unit: pixels) - ; format[-NAME]-foreground = #aa[rrggbb] - ; format[-NAME]-background = #aa[rrggbb] - ; format[-NAME]-underline = #aa[rrggbb] - ; ^ - ; | the underline and overline color is always the same - ; v - ; format[-NAME]-overline = #aa[rrggbb] - ; - ; The rest of the drawtypes follow the same pattern. - ; - ; 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)] = - ; - ; Example: - ; - format-online = - - format-offline = - format-offline-offset = -8 - - ; Cap the song label without trailing ellipsis - label-song-maxlen = 30 - label-song-ellipsis = false - - ; By only specifying alpha value, it will be applied to the bar's default foreground - label-time-foreground = #66 - - label-offline =  mpd is off - label-offline-foreground = #66 - - icon-play =  - icon-pause =  - icon-stop =  - - bar-progress-width = 30 - bar-progress-indicator = | - bar-progress-fill = █ - bar-progress-empty = █ - bar-progress-empty-foreground = #44 - ~~~ - - -### Application settings - ~~~ ini - [settings] - ; Limit the amount of update events within a set timeframe: - ; - "Allow updates within of time" - ; Default values: - throttle-limit = 3 - throttle-ms = 60 - ~~~ - - -### Bar settings - ~~~ ini - [bar/example] - ; Use the following command to list available outputs: - ; If unspecified, the application will pick the first one it finds. - ; $ xrandr -q | grep " connected" | cut -d ' ' -f1 - monitor = HDMI1 - - ; Omit the % to specify the width in pixels - width = 100% - height = 30 - - ; Offset value defined in pixels - offset-x = 0 - offset-y = 0 - - ; Put the bar at the bottom of the screen - bottom = true - - ; Weather to force docking mode or not - ; If you are using i3wm it's recommended to use the default value - ; Default: false - dock = true - - ; This value is used as a multiplier when adding spaces between elements - spacing = 3 - - ; Height of under-/overline - lineheight = 14 - - ; Colors - background = #ee222222 - foreground = #eefafafa - linecolor = ${bar/example.background} - - ; Borders - ; Size to be used for all borders - border-size = 2 - ; Color to be used for all borders - border-color = #ff9900 - ; Per-border values - ;border-top = 1 - ;border-top-color = #ff9900 - ;border-bottom = 2 - ;border-bottom-color = #5d00ff - ;border-left = 3 - ;border-right-color = #ff0059 - - ; Number of spaces to add at the beginning/end of the bar - padding-left = 5 - padding-right = 2 - - ; Amount of spaces to add before/after each module - module-margin-left = 3 - module-margin-right = 3 - - ; Fonts are defined using: ; - font-0 = NotoSans-Regular:size=8;0 - font-1 = MaterialIcons:size=10;0 - font-2 = Termsynu:size=8;-1 - font-3 = FontAwesome:size=10;0 - - ; The separator will be inserted between the output of each module - separator = | - - ; Value to be used to set the WM_NAME atom - ; This defaults to "lemonbuddy-[BAR]_[MONITOR]" - wm-name = mybar - - ; Locale used to localize module output (for example date) - ;locale = sv_SE.UTF-8 - - ; Define what modules to output - modules-left = cpu ram - modules-center = label - modules-right = clock - - ; Position of the tray container - ; If undefined, tray support will be disabled - ; - ; Available positions: - ; left - ; right - tray-position = right - - ; Restack the bar window and put it above the - ; selected window manager's root - ; - ; Fixes the issue where the bar is being drawn - ; on top of fullscreen window's - ; - ; Currently supported WM's: - ; bspwm - ; i3 - ; Default: none - wm-restack = bspwm - ~~~ - -### Modules - -#### Module `internal/backlight` - ~~~ ini - [module/backlight] - type = internal/backlight - - ; Use the following command to list available cards: - ; $ ls -1 /sys/class/backlight/ - card = intel_backlight - ~~~ - -##### Extra formatting (example) - ~~~ ini - ; Available tags: - ;