mirror of
https://github.com/vale981/yabar
synced 2025-03-04 17:11:38 -05:00
Add more syntax highlighting to documentation
This commit is contained in:
Jack Henschel
parent
28f98a5808
commit
fde727da17
1 changed files with 48 additions and 49 deletions
|
|
@ -8,11 +8,11 @@ yabar - a modern and lightweight status bar for X window managers
|
|||
|
||||
SYNOPSIS
|
||||
--------
|
||||
*yabar* [-c CONFIG_FILE] [-v] [-h]
|
||||
*yabar* [-c 'CONFIG_FILE'] [-v] [-h]
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
Yabar is a modern and lightweight status bar that is intended to be used along with minimal X window managers like bspwm and i3. Yabar has the following features:
|
||||
Yabar is a modern and lightweight status bar that is intended to be used along with minimal X window managers like 'bspwm' and 'i3'. Yabar has the following features:
|
||||
|
||||
* Extremely configurable with easy configuration system using a single config file.
|
||||
* A growing set of ready-to-use internal blocks developed in plain C.
|
||||
|
|
@ -29,7 +29,7 @@ A Yabar session should contain one or more bars within the same session. Each ba
|
|||
|
||||
CONFIGURATION
|
||||
-------------
|
||||
Yabar currently by default accepts configuration from the config file ~/.config/yabar/yabar.conf or using yabar -c [CONFIG_FILE]. The config file should like something like this:
|
||||
Yabar currently by default accepts configuration from the config file '~/.config/yabar/yabar.conf' or using 'yabar -c CONFIG_FILE'. The config file should like something like this:
|
||||
|
||||
----
|
||||
bar-list: ["bar1", "bar2", ...];
|
||||
|
|
@ -52,56 +52,56 @@ BAR-SPECIFIC OPTIONS
|
|||
--------------------
|
||||
Each bar can have its own font, position (currently only top and bottom), background color, height, horizontal and vertical gaps, and other options.
|
||||
|
||||
* Font: Yabar currently accepts a string that contains a font or a list of fonts
|
||||
* *Font*: Yabar currently accepts a string that contains a font or a list of fonts
|
||||
(similar to i3). Example:
|
||||
----
|
||||
font: "Droid Sans, FontAwesome Bold 9";
|
||||
----
|
||||
|
||||
* Position: Yabar currently accepts top and bottom. Example:
|
||||
* *Position*: Position Yabar at the top or bottom. Example:
|
||||
----
|
||||
position: "top";
|
||||
----
|
||||
|
||||
* Gaps: You can define the size of horizontal and vertical gaps in pixels. Default is zero. Examples:
|
||||
* *Gaps*: You can define the size of horizontal and vertical gaps in pixels. Default is zero. Examples:
|
||||
----
|
||||
gap-horizontal: 20;
|
||||
gap-vertical: 5;
|
||||
----
|
||||
|
||||
* Height: Default is 20 pixels. Example:
|
||||
* *Height*: Default is 20 pixels. Example:
|
||||
----
|
||||
height: 25;
|
||||
----
|
||||
|
||||
* Width: The default bar width is screen size - 2 * horizontal gap. However, if this option is used, the bar starts at horizontal gap and ends at horizontal gap + width. Example:
|
||||
* *Width*: The default bar width is 'screen size - 2 * horizontal gap'. However, if this option is used, the bar starts at 'horizontal gap' and ends at 'horizontal gap + width'. Example:
|
||||
----
|
||||
width: 800;
|
||||
----
|
||||
|
||||
* Monitor: This option is used to specify the monitor using randr extension for the bar to be drawn on. You can find the name of your monitors using xrandr -q command. The default value is the first active monitor. Fallback monitors can be provided if the first option is unavailable. Example:
|
||||
* *Monitor*: This option is used to specify the monitor using randr extension for the bar to be drawn on. You can find the name of your monitors using 'xrandr -q' command. The default value (when this option is not provided) is the first active monitor. Fallback monitors can be provided if the first option is unavailable. Example:
|
||||
----
|
||||
monitor: "LVDS1 VGA1";
|
||||
----
|
||||
|
||||
* Underline and overline sizes: This option defines the thickness of underlines and overlines. Default is 0. Example:
|
||||
* *Underline* and *overline sizes*: This option defines the thickness of underlines and overlines. Default is 0. Example:
|
||||
----
|
||||
underline-size: 2;
|
||||
overline-size: 2;
|
||||
----
|
||||
|
||||
* Slack: You can define the size of the slack (i.e. the unused space between blocks). Default is 0. Example:
|
||||
* *Slack*: You can define the size of the slack (i.e. the unused space between blocks). Default is 0. Example:
|
||||
----
|
||||
slack-size: 2;
|
||||
----
|
||||
|
||||
* Borders: You can optionally define a size and a color for a border surrounding the bar. Default is no borders. Example:
|
||||
* *Borders*: You can optionally define a size and a color for a border surrounding the bar. Default is no borders. Example:
|
||||
----
|
||||
border-size: 2;
|
||||
border-color-rgb: 0xffffff;
|
||||
----
|
||||
|
||||
* Inheritance: As the config file gets larger because you want to add several bars, you may find yourself adding many identical option values for every added bar. This optional entry is added in order to inherit the options from a precedent bar into your next bar. You can also override the inherited options with new values.
|
||||
* *Inheritance*: As the config file gets larger because you want to add several bars, you may find yourself adding many identical option values for every added bar. This optional entry is added in order to inherit the options from a precedent bar into your next bar. You can also override the inherited options with new values.
|
||||
----
|
||||
inherit: "bar1";
|
||||
----
|
||||
|
|
@ -111,7 +111,7 @@ You can also inherit a bar with not only its bar-specific options, but also with
|
|||
inherit-all: "bar1";
|
||||
----
|
||||
|
||||
* Button commands: Yabar already supports mouse button commands for each block. Moreover, yabar seeks to make the entire bar clickable even if the pressed area does not belong to any block or the corresponding button command for that block is not defined. Example:
|
||||
* *Button commands*: Yabar already supports mouse button commands for each block. Moreover, yabar seeks to make the entire bar clickable even if the pressed area does not belong to any block or the corresponding button command for that block is not defined. Example:
|
||||
----
|
||||
command-button4: "xbacklight -inc 1";
|
||||
command-button5: "xbacklight -dec 1";
|
||||
|
|
@ -121,65 +121,64 @@ BLOCK-SPECIFIC OPTIONS
|
|||
----------------------
|
||||
Each block can have its own command, background, foreground (i.e. font), underline and overline colors, alignment and other options.
|
||||
|
||||
* Execution: The path to the command (executable or script) to be executed. Yabar consumes the output of the command/script's stdout and shows it on the bar. Example:
|
||||
* *Execution*: The path to the command (executable or script) to be executed. Yabar consumes the output of the command/script's stdout and shows it on the bar. Example:
|
||||
----
|
||||
exec: "date";
|
||||
----
|
||||
|
||||
* Alignment: Yabar accepts left, center or right alignments. Consecutive blocks will be placed to the right of each other. Example:
|
||||
* *Alignment*: Yabar accepts left, center or right alignments. Consecutive blocks will be placed to the right of each other. Example:
|
||||
----
|
||||
align: "right";
|
||||
----
|
||||
|
||||
* Justify: By default yabar centers the text inside the block size. However, you can optionally justify the text to the left or the right.
|
||||
* *Justify*: By default yabar centers the text inside the block size. However, you can optionally justify the text to the left or the right.
|
||||
----
|
||||
justify: "left";
|
||||
----
|
||||
|
||||
* Type: The block type can be periodic where the command is executed within a fixed interval of time, persistent where the command runs in a persistent way like xtitle or once where the command is executed only once where the intended info should not change like in whoami. Examples:
|
||||
* *Type*: The block type can be *periodic* where the command is executed within a fixed interval of time, *persistent* where the command runs in a persistent way like 'xtitle' or *once* where the command is executed only once where the intended info should not change like in 'whoami'. Examples:
|
||||
----
|
||||
type: "periodic";
|
||||
type: "persist";
|
||||
type: "once";
|
||||
----
|
||||
|
||||
* Interval: In seconds. This is only useful when the block type is periodic. Example:
|
||||
* *Interval*: In seconds. This is only useful when the block type is *periodic*. Example:
|
||||
----
|
||||
interval: 3;
|
||||
----
|
||||
|
||||
|
||||
* Fixed size: You should define the fixed width size of the block. Yabar currently only supports fixed widths. You can deduce the appropriate width using trial and error. The current default value is 80 but you are encouraged to override it to a more appropriate value. Example:
|
||||
* *Fixed size*: You should define the fixed width size of the block. Yabar currently only supports fixed widths. You can deduce the appropriate width using trial and error. The current default value is 80 but you are encouraged to override it to a more appropriate value. Example:
|
||||
----
|
||||
fixed-size: 90;
|
||||
----
|
||||
|
||||
* Pango markup: Yabar accepts either true or false without quotes. Default is false. Example:
|
||||
* *Pango markup*: Yabar accepts either true or false without quotes. Default is false. Example:
|
||||
----
|
||||
pango-markup: true;
|
||||
----
|
||||
|
||||
* Colors: A block has 4 kinds of colors. Background, foreground which is the font color when pango markup is not used, underline and overline. Colors are accepted in hex RRGGBB and AARRGGBB representations. Note that the values are integers and not double-quoted strings. Examples:
|
||||
* *Colors*: A block has 4 kinds of colors. 'Background', 'foreground' which is the font color when pango markup is not used, 'underline' and 'overline'. Colors are accepted in hex 'RRGGBB' and 'AARRGGBB' representations. Note that the values are integers and not double-quoted strings. Examples:
|
||||
----
|
||||
foreground-color-rgb : 0xeeeeee;
|
||||
background-color-argb : 0x1dc93582;
|
||||
underline-color-rgb : 0x1d1d1d;
|
||||
overline-color-argb : 0xf0642356;
|
||||
foreground-color-rgb: 0xeeeeee;
|
||||
background-color-argb: 0x1dc93582;
|
||||
underline-color-rgb: 0x1d1d1d;
|
||||
overline-color-argb: 0xf0642356;
|
||||
----
|
||||
|
||||
* Button commands: This option is used to invoke a command/script upon a mouse button press. You have 5 buttons that usually represent left click, right click, middle click, scroll up and scroll down respectively but this may not be the case for everyone. Examples:
|
||||
* *Button commands*: This option is used to invoke a command/script upon a mouse button press. You have 5 buttons that usually represent left click, right click, middle click, scroll up and scroll down respectively but this may not be the case for everyone. Examples:
|
||||
----
|
||||
command-button1: "pavucontrol";
|
||||
command-button4: "pactl set-sink-volume 0 +10%";
|
||||
command-button5: "pactl set-sink-volume 0 -10%";
|
||||
----
|
||||
|
||||
* Inheritance: As the config gets larger because you want to add many blocks, you may find yourself adding many identical option values for every added block. This optional entry is added in order to inherit the options from a precedent block into your new block. You can also override the inherited options with new values.
|
||||
* *Inheritance*: As the config gets larger because you want to add many blocks, you may find yourself adding many identical option values for every added block. This optional entry is added in order to inherit the options from a precedent block into your new block. You can also override the inherited options with new values.
|
||||
----
|
||||
inherit: "bar1.block1";
|
||||
----
|
||||
|
||||
* Icons and images: Yabar supports drawing icons and images inside blocks using gdk-pixbuf and cairo. The images are drawn before drawing text so they may act as backgrounds if desired. You can control the horizontal and vertical shift and the width and height scale for the image/icon. Example:
|
||||
* *Icons* and *images*: Yabar supports drawing icons and images inside blocks using 'gdk-pixbuf' and 'cairo'. The images are drawn before drawing text so they may act as backgrounds if desired. You can control the horizontal and vertical shift and the width and height scale for the image/icon. Example:
|
||||
----
|
||||
image: "/usr/share/icons/Numix/16/apps/google.svg";
|
||||
image-shift-x: 2; #integer value
|
||||
|
|
@ -188,16 +187,16 @@ image-scale-width: 0.4; #float value
|
|||
image-scale-height: 0.4; #float value
|
||||
----
|
||||
|
||||
* Variable width: Use this optional feature in order to fit the block width into the current text width and subsequently save empty space inside the bar. Example:
|
||||
* *Variable width*: Use this optional feature in order to fit the block width into the current text width and subsequently save empty space inside the bar. Example:
|
||||
----
|
||||
variable-size: true;
|
||||
----
|
||||
|
||||
DYNAMIC COLORS FOR BLOCKS
|
||||
-------------------------
|
||||
You can change block colors (background, foreground, underline and overline) within runtime. Along with pango markup format, you can fully control how a block looks throughout yabar's session.
|
||||
You can change block colors ('background', 'foreground', 'underline' and 'overline') within runtime. Along with pango markup format, you can fully control how a block looks throughout yabar's session.
|
||||
|
||||
If you wish to change one or more of the 4 color types, you must begin your string-to-be-drawn (i.e. the output string to stdout by your shell script) with !Y FORMAT Y!. The FORMAT statement should contain the color type (BG or bg for background, FG or fg for foreground, U or u for underline and O or o for overline). The color must be in hex AARRGGBB (So if you want to add an rgb color just make it FFxxxxxx). Examples:
|
||||
If you wish to change one or more of the 4 color types, you must begin your string-to-be-drawn (i.e. the output string to stdout by your shell script) with '!Y FORMAT Y!'. The 'FORMAT' statement should contain the color type ('BG' or 'bg' for background, 'FG' or 'fg' for foreground, 'U' or 'u' for underline and 'O' or 'o' for overline). The color must be in hex 'AARRGGBB' (So if you want to add an RGB color just make it 'FFxxxxxx'). Examples:
|
||||
----
|
||||
"!Y BG 0xFFFF0000 fg0xFF00ff00 U0xFFFAC739 Y!"
|
||||
"!Ybg0xff00ff00Y!"
|
||||
|
|
@ -207,7 +206,7 @@ The spaces are just skipped automatically. Keep in mind that You can always dyna
|
|||
|
||||
ENVIRONMENT VARIABLES
|
||||
---------------------
|
||||
Yabar sets a handful of environment variables before executing your commands/scripts that are defined in the command-button{1-5} entry. Such env variables can be useful when drawing your window on the corresponding button press. Current env variables are:
|
||||
Yabar sets a handful of environment variables before executing your commands/scripts that are defined in the 'command-button{1-5}' entry. Such env variables can be useful when drawing your window on the corresponding button press. Current env variables are:
|
||||
|
||||
----
|
||||
$YABAR_BLOCK_X # The beginning x axis for the block
|
||||
|
|
@ -230,7 +229,7 @@ internal-spacing # takes a true or false value, used to add space pads to preven
|
|||
|
||||
Yabar has a growing set of internal blocks. The current blocks are:
|
||||
|
||||
* Date and time: You can control the output format using the standard C library format in 'time.h'. Example:
|
||||
* *Date and time*: You can control the output format using the standard C library format in 'time.h'. Example:
|
||||
----
|
||||
exec: "YABAR_DATE";
|
||||
internal-option1: "%a %d %b, %I:%M"; # Format String
|
||||
|
|
@ -238,39 +237,39 @@ internal-prefix: " ";
|
|||
interval: 2;
|
||||
----
|
||||
|
||||
* Window title: Uses EWMH to show the current window title. Example:
|
||||
* *Window title*: Uses EWMH to show the current window title. Example:
|
||||
----
|
||||
exec: "YABAR_TITLE";
|
||||
fixed-size: 300;
|
||||
----
|
||||
|
||||
* Workspace: Uses EWMH to show the current workspace/desktop. Example:
|
||||
* *Workspace*: Uses EWMH to show the current workspace/desktop. Example:
|
||||
----
|
||||
exec: "YABAR_WORKSPACE";
|
||||
internal-option1: " "; #Type all your workspace names (usually font icons) separated by a space between one another.
|
||||
----
|
||||
|
||||
* Uptime: displays system uptime in 'hours:minutes' format.
|
||||
* *Uptime*: displays system uptime in 'hours:minutes' format.
|
||||
----
|
||||
exec: "YABAR_UPTIME";
|
||||
interval: 5;
|
||||
----
|
||||
|
||||
* Thermal: It checks the thermal value in the file '/sys/class/NAME/temp'. Example:
|
||||
* *Thermal*: It checks the thermal value in the file '/sys/class/NAME/temp'. Example:
|
||||
----
|
||||
exec: "YABAR_THERMAL";
|
||||
internal-option1: "thermal_zone0";
|
||||
interval: 1;
|
||||
----
|
||||
|
||||
* Brightness: It checks the brightness value in the file '/sys/class/backlight/NAME/brightness'. Example:
|
||||
* *Brightness*: It checks the brightness value in the file '/sys/class/backlight/NAME/brightness'. Example:
|
||||
----
|
||||
exec: "YABAR\_BRIGHTNESS";
|
||||
exec: "YABAR_BRIGHTNESS";
|
||||
internal-option1: "intel_backlight";
|
||||
interval: 1;
|
||||
----
|
||||
|
||||
* Network bandwidth: It checks the total transmitted and received bytes in the files '/sys/class/net/NAME/statistics/tx_bytes' and '/sys/class/net/NAME/statistics/rx_bytes' and converts them to rates. Example:
|
||||
* *Network bandwidth*: It checks the total transmitted and received bytes in the files '/sys/class/net/NAME/statistics/tx_bytes' and '/sys/class/net/NAME/statistics/rx_bytes' and converts them to rates. Example:
|
||||
----
|
||||
exec: "YABAR_BANDWIDTH";
|
||||
internal-option1: "default"; #Possible values are 'default' or any interface name (e.g. 'eth0', 'wlan1')
|
||||
|
|
@ -278,13 +277,13 @@ internal-option2: " "; #Two Strings (usually 2 font icons) to be injected
|
|||
interval: 2;
|
||||
----
|
||||
|
||||
* RAM Usage: It checks the file '/proc/meminfo' and computes the total used memory. Example:
|
||||
* *RAM Usage*: It checks the file '/proc/meminfo' and computes the total used memory. Example:
|
||||
----
|
||||
exec: "YABAR_MEMORY";
|
||||
interval: 1;
|
||||
----
|
||||
|
||||
* CPU total load: It checks out the file '/proc/stat' and computes the total load percentage: Example:
|
||||
* *CPU total load*: It checks out the file '/proc/stat' and computes the total load percentage: Example:
|
||||
----
|
||||
exec: "YABAR_CPU";
|
||||
interval: 2;
|
||||
|
|
@ -293,7 +292,7 @@ internal-suffix: "%";
|
|||
internal-spacing: true;
|
||||
----
|
||||
|
||||
* Disk IO activity: It checks the file '/sys/class/block/NAME/stat' and computes the read and write rates. Example:
|
||||
* *Disk IO activity*: It checks the file '/sys/class/block/NAME/stat' and computes the read and write rates. Example:
|
||||
----
|
||||
exec: "YABAR_DISKIO";
|
||||
internal-option1: "sda";
|
||||
|
|
@ -301,7 +300,7 @@ internal-option2: " "; #Two Strings (usually 2 font icons) to be injected
|
|||
interval: 1;
|
||||
----
|
||||
|
||||
* Battery: It checks the files '/sys/class/power_supply/NAME/capacity' and '/sys/class/power_supply/NAME/status' and extracts the capacity value. Example:
|
||||
* *Battery*: It checks the files '/sys/class/power_supply/NAME/capacity' and '/sys/class/power_supply/NAME/status' and extracts the capacity value. Example:
|
||||
----
|
||||
exec: "YABAR_BATTERY";
|
||||
internal-option1: "BAT0";
|
||||
|
|
@ -310,7 +309,7 @@ internal-suffix: "%";
|
|||
internal-spacing: true;
|
||||
----
|
||||
|
||||
* Volume: It uses ALSA to display sound volume in percentage. Example:
|
||||
* *Volume*: It uses ALSA to display sound volume in percentage. Example:
|
||||
----
|
||||
exec: "YABAR_VOLUME";
|
||||
interval: 1;
|
||||
|
|
@ -320,7 +319,7 @@ internal-option3 : " "; # characters to display when sound is on or off (s
|
|||
internal-suffix: "%";
|
||||
----
|
||||
|
||||
* Disk space usage: Display used/total space (e.g. 84G/320G) for one or multiple file systems. Example:
|
||||
* *Disk space usage*: Display used/total space (e.g. 84G/320G) for one or multiple file systems. Example:
|
||||
----
|
||||
exec: "YABAR_DISKSPACE";
|
||||
align: "right";
|
||||
|
|
@ -338,7 +337,7 @@ internal-option1: "/dev/sda";
|
|||
|
||||
LICENSE
|
||||
-------
|
||||
Yabar is licensed under the MIT license. For more info check out the file 'LICENSE'.
|
||||
Yabar is licensed under the *MIT license*. For more info check out the file 'LICENSE'.
|
||||
|
||||
AUTHORS
|
||||
------
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue