mirror of
https://github.com/JakeStanger/ironbar.git
synced 2024-10-26 09:38:51 +03:00
Merge pull request #608 from JakeStanger/docs/fixes
Documentation fixes
This commit is contained in:
commit
a47ef0c763
@ -59,6 +59,10 @@ Ironbar is designed to support anything from a lightweight bar to a full desktop
|
|||||||
|
|
||||||
[![Packaging status](https://repology.org/badge/vertical-allrepos/ironbar.svg)](https://repology.org/project/ironbar/versions)
|
[![Packaging status](https://repology.org/badge/vertical-allrepos/ironbar.svg)](https://repology.org/project/ironbar/versions)
|
||||||
|
|
||||||
|
Ironbar can be installed from source or using your preferred package manager.
|
||||||
|
|
||||||
|
It is also recommended to install a [Nerd Font](https://www.nerdfonts.com/#home) for displaying symbols.
|
||||||
|
|
||||||
### Cargo
|
### Cargo
|
||||||
|
|
||||||
[crate](https://crates.io/crates/ironbar)
|
[crate](https://crates.io/crates/ironbar)
|
||||||
|
@ -9,6 +9,8 @@ cargo build --release
|
|||||||
install target/release/ironbar ~/.local/bin/ironbar
|
install target/release/ironbar ~/.local/bin/ironbar
|
||||||
```
|
```
|
||||||
|
|
||||||
|
It is also recommended to install a [Nerd Font](https://www.nerdfonts.com/#home) for displaying symbols.
|
||||||
|
|
||||||
## Build requirements
|
## Build requirements
|
||||||
|
|
||||||
To build from source, you must have GTK (>= 3.22) and GTK Layer Shell installed.
|
To build from source, you must have GTK (>= 3.22) and GTK Layer Shell installed.
|
||||||
|
@ -9,6 +9,8 @@ If you want to see some ready-to-go config files check
|
|||||||
the [examples folder](https://github.com/JakeStanger/ironbar/tree/master/examples)
|
the [examples folder](https://github.com/JakeStanger/ironbar/tree/master/examples)
|
||||||
and the example pages in the sidebar.
|
and the example pages in the sidebar.
|
||||||
|
|
||||||
|
The examples make use of [Nerd Fonts](https://www.nerdfonts.com/#home) for displaying symbols.
|
||||||
|
|
||||||
## 1. Create config file
|
## 1. Create config file
|
||||||
|
|
||||||
The config file lives inside the `ironbar` directory in your XDG_CONFIG_DIR, which is usually `~/.config/ironbar`.
|
The config file lives inside the `ironbar` directory in your XDG_CONFIG_DIR, which is usually `~/.config/ironbar`.
|
||||||
|
@ -84,11 +84,10 @@ and will be replaced with values from the current battery state:
|
|||||||
|
|
||||||
| Selector | Description |
|
| Selector | Description |
|
||||||
|---------------------------------|--------------------------------|
|
|---------------------------------|--------------------------------|
|
||||||
| `.upower` | Upower widget container. |
|
| `.upower` | Upower widget button. |
|
||||||
| `.upower .button` | Upower widget button. |
|
| `.upower .contents` | Upower widget button contents. |
|
||||||
| `.upower .button .contents` | Upower widget button contents. |
|
| `.upower .icon` | Upower widget battery icon. |
|
||||||
| `.upower .button .icon` | Upower widget battery icon. |
|
| `.upower .label` | Upower widget button label. |
|
||||||
| `.upower .button .label` | Upower widget button label. |
|
|
||||||
| `.popup-upower` | Upower popup box. |
|
| `.popup-upower` | Upower popup box. |
|
||||||
| `.popup-upower .upower-details` | Label inside the popup. |
|
| `.popup-upower .upower-details` | Label inside the popup. |
|
||||||
|
|
||||||
|
@ -55,7 +55,7 @@ let {
|
|||||||
interval.networks = 3
|
interval.networks = 3
|
||||||
|
|
||||||
format = [
|
format = [
|
||||||
" {cpu_percent}% | {temp_c:k10temp_Tccd1}°C"
|
" {cpu_percent}% | {temp_c:k10temp-Tccd1}°C"
|
||||||
" {memory_used} / {memory_total} GB ({memory_percent}%)"
|
" {memory_used} / {memory_total} GB ({memory_percent}%)"
|
||||||
"| {swap_used} / {swap_total} GB ({swap_percent}%)"
|
"| {swap_used} / {swap_total} GB ({swap_percent}%)"
|
||||||
" {disk_used:/} / {disk_total:/} GB ({disk_percent:/}%)"
|
" {disk_used:/} / {disk_total:/} GB ({disk_percent:/}%)"
|
||||||
|
@ -63,7 +63,7 @@
|
|||||||
"networks": 3
|
"networks": 3
|
||||||
},
|
},
|
||||||
"format": [
|
"format": [
|
||||||
" {cpu_percent}% | {temp_c:k10temp_Tccd1}°C",
|
" {cpu_percent}% | {temp_c:k10temp-Tccd1}°C",
|
||||||
" {memory_used} / {memory_total} GB ({memory_percent}%)",
|
" {memory_used} / {memory_total} GB ({memory_percent}%)",
|
||||||
"| {swap_used} / {swap_total} GB ({swap_percent}%)",
|
"| {swap_used} / {swap_total} GB ({swap_percent}%)",
|
||||||
" {disk_used:/} / {disk_total:/} GB ({disk_percent:/}%)",
|
" {disk_used:/} / {disk_total:/} GB ({disk_percent:/}%)",
|
||||||
|
@ -53,7 +53,7 @@ interval = 500
|
|||||||
[[end]]
|
[[end]]
|
||||||
type = "sys_info"
|
type = "sys_info"
|
||||||
format = [
|
format = [
|
||||||
" {cpu_percent}% | {temp_c:k10temp_Tccd1}°C",
|
" {cpu_percent}% | {temp_c:k10temp-Tccd1}°C",
|
||||||
" {memory_used} / {memory_total} GB ({memory_percent}%)",
|
" {memory_used} / {memory_total} GB ({memory_percent}%)",
|
||||||
"| {swap_used} / {swap_total} GB ({swap_percent}%)",
|
"| {swap_used} / {swap_total} GB ({swap_percent}%)",
|
||||||
" {disk_used:/} / {disk_total:/} GB ({disk_percent:/}%)",
|
" {disk_used:/} / {disk_total:/} GB ({disk_percent:/}%)",
|
||||||
|
@ -43,7 +43,7 @@ end:
|
|||||||
disks: 300
|
disks: 300
|
||||||
networks: 3
|
networks: 3
|
||||||
format:
|
format:
|
||||||
- {cpu_percent}% | {temp_c:k10temp_Tccd1}°C
|
- {cpu_percent}% | {temp_c:k10temp-Tccd1}°C
|
||||||
- {memory_used} / {memory_total} GB ({memory_percent}%)
|
- {memory_used} / {memory_total} GB ({memory_percent}%)
|
||||||
- '| {swap_used} / {swap_total} GB ({swap_percent}%)'
|
- '| {swap_used} / {swap_total} GB ({swap_percent}%)'
|
||||||
- {disk_used:/} / {disk_total:/} GB ({disk_percent:/}%)
|
- {disk_used:/} / {disk_total:/} GB ({disk_percent:/}%)
|
||||||
|
60
examples/test.corn
Normal file
60
examples/test.corn
Normal file
@ -0,0 +1,60 @@
|
|||||||
|
let {
|
||||||
|
$config_dir = "/home/jake/.config/ironbar"
|
||||||
|
|
||||||
|
$workspaces = { type = "workspaces" }
|
||||||
|
$launcher = { type = "launcher" }
|
||||||
|
$volume = {
|
||||||
|
type = "volume"
|
||||||
|
format = "{icon} {percentage}%"
|
||||||
|
max_volume = 100
|
||||||
|
icons.volume_high = ""
|
||||||
|
icons.volume_medium = ""
|
||||||
|
icons.volume_low = ""
|
||||||
|
icons.muted = ""
|
||||||
|
}
|
||||||
|
$network_manager = { type = "networkmanager" }
|
||||||
|
$clock = {
|
||||||
|
type = "clock"
|
||||||
|
// disable_popup = true
|
||||||
|
// format = "<span color='#f2777a'>%d/%m/%Y</span> <span color='#69c'>%H:%M:%S</span>"
|
||||||
|
}
|
||||||
|
$tray = { type = "tray" prefer_theme_icons = false }
|
||||||
|
|
||||||
|
// $label = { type = "label" label = "<span color='#color'>hello</span>" }
|
||||||
|
$label = { type = "label" label = "#random" }
|
||||||
|
$clipboard = { type = "clipboard" }
|
||||||
|
|
||||||
|
$notifications = {
|
||||||
|
type = "notifications"
|
||||||
|
show_count = true
|
||||||
|
|
||||||
|
icons.closed_none = ""
|
||||||
|
icons.closed_some = ""
|
||||||
|
icons.closed_dnd = ""
|
||||||
|
icons.open_none = ""
|
||||||
|
icons.open_some = ""
|
||||||
|
icons.open_dnd = ""
|
||||||
|
}
|
||||||
|
|
||||||
|
$focused = { type = "focused" }
|
||||||
|
|
||||||
|
$cairo = { type = "cairo" path = "$config_dir/clock.lua" frequency = 50 width = 300 height = 300 }
|
||||||
|
|
||||||
|
$custom = {
|
||||||
|
type = "custom"
|
||||||
|
bar = [ { type = "button" on_click = "popup:toggle" widgets = [ $focused ] } ]
|
||||||
|
popup = [ { type = "box" orientation = "v" widgets = [ $clock $cairo ] } ]
|
||||||
|
}
|
||||||
|
|
||||||
|
$mpris = { type = "music" }
|
||||||
|
} in {
|
||||||
|
// ironvar_defaults.color = "red"
|
||||||
|
|
||||||
|
position = "bottom"
|
||||||
|
|
||||||
|
icon_theme = "Paper"
|
||||||
|
|
||||||
|
start = [ $workspaces $label ]
|
||||||
|
center = [ $custom ]
|
||||||
|
end = [ $notifications $clock ]
|
||||||
|
}
|
Loading…
Reference in New Issue
Block a user