Skip to content

Commit 01d4a01

Browse files
committed
assets: update example configs + query: auto: fix auto disk query from config's auto.disk.fmt
1 parent f2273d0 commit 01d4a01

File tree

9 files changed

+162
-294
lines changed

9 files changed

+162
-294
lines changed

customfetch.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ Padding of the logo from the left
201201
Padding of the layout from the top
202202
.TP
203203
\fB\-\-title\-sep\fR <string>
204-
A character (or string) to use in $<builtin.title_sep>
204+
A character (or string) to use in $<title_sep>
205205
.TP
206206
\fB\-\-sep\-reset\fR <string>
207207
A character (or string) that when encountered, will automatically reset color

examples/config_cool.toml

Lines changed: 55 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -1,87 +1,17 @@
11
[config]
2-
# customfetch is designed with customizability in mind
3-
# here is how it works:
4-
# the variable "layout" is used for showing the infos
5-
# as like as the user want, no limitation.
6-
# inside here there are 5 "tags": $<> $() ${} $[] $%%
7-
8-
# The Info tag $<> lets you print the value of a member of a module.
9-
# e.g $<user.name> will print the username, $<os.kernel_version> will print the kernel version and so on.
10-
# All the modules and their members are listed in the `--list-modules` argument
11-
12-
# The Bash command tag $() will execute bash commands and print the output.
13-
# e.g $(echo \"hello world\") will indeed echo out hello world.
14-
# you can even use pipes
15-
# e.g $(echo \"hello world\" | cut -d' ' -f2) will only print world
16-
17-
# The Conditional tag $[] is used to display different outputs based on the comparison.
18-
# syntax MUST be $[something,equalToSomethingElse,iftrue,ifalse]
19-
# note: putting spaces between commas, could change the expected result
20-
#
21-
# Each part can have a tag or anything else.
22-
# e.g $[$<user.name>,$(echo $USER),the name is correct,the name is NOT correct]
23-
#
24-
# This is useful when on some terminal or WM the detection can be different than others
25-
# Or maybe even on holidays for printing special texts
26-
# e.g $[$(date +%d-%m),25-12,${red}Happy ${white}Christmas!,]
27-
28-
# The Color tag ${} is used for printing the text of a certain color.
29-
# e.g "${red}hello world" will indeed print "hello world" in red (or the color you set in the variable)
30-
# The colors can be predefined such as: black, red, green, blue, cyan, yellow, magenta, white.
31-
# They can be configured in the config file.
32-
#
33-
# They can have hexcodes colors (e.g "#5522dd").
34-
# You can apply special effects to colors by using the following symbols before the '#' in hex codes:
35-
#
36-
# Terminal and GUI GUI Only
37-
# * b - for background color. * o - for overline
38-
# * u - to underline the text * a(value) - for fg alpha (either a plain integer between 1 and 65536 or a percentage value like `50%`)
39-
# * ! - for bold text * L(value) - to underline the text with a style (`none`, `single`, `double`, `low`, `error`)
40-
# * i - for italic text * U(value) - for choosing the underline color (hexcode without #)
41-
# * s - for strikethrough text * B(value) - for bg color text (same value as above)
42-
# * S(value) - for strikethrough color (same value as above)
43-
# Terminal Only * O(value) - for overline color (same value as above)
44-
# * l - for blinking text * A(value) - for bg alpha (same value as a(value))
45-
# * w(value) - for specify font weight (`ultralight`, `light`, `normal`, `bold`, `ultrabold`, `heavy`, or a numeric weight)
46-
#
47-
# Alternatively, ANSI escape codes can be used, e.g ${\e[1;32m} or ${\e[38;2;34;255;11m}.
48-
#
49-
# To reset colors, use ${0} for a normal reset or ${1} for a bold reset.
50-
#
51-
# To use the colors that the ascii art logo uses, use ${auto} for getting the 1st color, ${auto4} for the 4th one and so on.
52-
# If you're using GUI mode and wants to display a custom source that's an image, all the auto colors will be the same colors as the distro ones
53-
54-
# The Percentage tag $%% is used for displaying the percentage between 2 numbers.\
55-
# It **Must** contain a comma for separating the 2. They can be either be taken from a tag or it put yourself.\
56-
# For example: $%50,100%
57-
# For inverting colors of bad and great (red and green), before the first '%' put '!'
58-
# without quotes ofc
59-
60-
################################################################
61-
# Little FAQ
62-
# Q: Why when I use & or < in the config or ASCII art, it won't work on GUI mode?
63-
# A: replace "<" with "\\<" in the config, or "\<" in the ascii art. Same goes for &
64-
# It won't affect the printing in terminal
65-
#
66-
# Q: I want to use `cbonsai` as ASCII art, how do I use it?
67-
# A: First off, create a text file and there put only `$(!cbonsai -p)`
68-
# Save the file and use `-s "/path/to/text/file"`.
69-
# Use `--offset` (`-o`) for aligning and put it under the bonsai.
70-
#
71-
# Read the manual customfetch.1 for more infos with $() tag
72-
#
73-
# Q: Can I run recursive tags?
74-
# A: If "$<disk($<disk($[1,1,$(echo -n $<disk(/).mountdir>),23]).mountdir>).disk>" works,
75-
# Then I guess yeah
76-
################################################################
772

3+
# For more information on how customfetch works and the layout,
4+
# Read either:
5+
# * -w or --how-it-works
6+
# * the manual customfetch.1
7+
# * if on the android app, click the button "how it works" during widget configuration
788

799
# Old pipelines screensavers inspired layout
80-
# This is really system depedent and really meassy
10+
# This is really system depedent and really messy
8111
# but proves how customizable you can be
8212
layout = [
8313
"${red}$<user.name>${0}@${cyan}$<os.hostname>",
84-
"$<builtin.title_sep>",
14+
"$<title_sep>",
8515
"${red}$<os.name> ${cyan} $<system.arch>${cyan} \\<- Arch ",
8616
"${red} ^ ${green} $<os.kernel> \\<━━━┓",
8717
"${red} | ${green}┃",
@@ -102,15 +32,15 @@ layout = [
10232
#"${!#ffff2a}DE -> $<user.de_name> $<user.de_version>",
10333
" ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓",
10434
" ┃ ┃",
105-
" ┃ ${!#448aa4}Disk (/) -> $<disk(/).disk> ┃",
106-
"System Infos ━━━━━━━━━━━━━━━━┫ ${magenta}CPU -> $<cpu.cpu> ┃",
107-
" ┃ ${blue}GPU -> $<gpu.vendor> $<gpu.name> ┃",
108-
" ┃ ${!#03ff93}RAM usage -> $<ram.ram> ┃",
35+
" ┃ ${!#448aa4}Disk (/) -> $<disk(/)> ┃",
36+
"System Infos ━━━━━━━━━━━━━━━━┫ ${magenta}CPU -> $<cpu> ┃",
37+
" ┃ ${blue}GPU -> $<gpu> ┃",
38+
" ┃ ${!#03ff93}RAM usage -> $<ram> ┃",
10939
" ┃ ┃",
11040
" ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛",
11141
"",
112-
"$<builtin.colors>", # normal colors
113-
"$<builtin.colors_light>" # light colors
42+
"$<colors>", # normal colors
43+
"$<colors_light>" # light colors
11444
]
11545

11646
# display ascii-art or image/gif (GUI only) near layout
@@ -129,7 +59,7 @@ data-dir = "/usr/share/customfetch"
12959
# Leave empty it for regular.
13060
ascii-logo-type = ""
13161

132-
# A char (or string) to use in $<builtin.title_sep>
62+
# A char (or string) to use in $<title_sep>
13363
title-sep = "-"
13464

13565
# A separator (or string) that when ecountered, will automatically
@@ -142,10 +72,6 @@ sep-reset = "->"
14272
# false = before ("test ${0}-> ")
14373
sep-reset-after = false
14474

145-
# Warn against tradeoffs between slower queries for availability
146-
# e.g. falling back to gsettings when we can't find the config file for GTK
147-
slow-query-warnings = false
148-
14975
# Offset between the ascii art and the layout
15076
offset = 5
15177

@@ -158,6 +84,21 @@ logo-padding-top = 0
15884
# Padding of the layout from the top
15985
layout-padding-top = 0
16086

87+
# Usually in neofetch/fastfetch, when your terminal size is too small,
88+
# to render some text in 1 line, they don't wrap those lines, instead they truncate them.
89+
# Enable/Disable if you want this
90+
wrap-lines = false
91+
92+
# Used in disk, ram and swap modules.
93+
# If true, we're going to use the SI standard byte unit (1kB == 1000 bytes)
94+
# Else if false, we using the IEC byte unit (1KiB == 1024 bibytes)
95+
# Really nerdy stuff
96+
use-SI-byte-unit = false
97+
98+
# Warn against tradeoffs between slower queries for availability
99+
# e.g. falling back to gsettings when we can't find the config file for GTK
100+
slow-query-warnings = false
101+
161102
# Colors in terminal
162103
black = "\e[1;30m"
163104
red = "\e[1;31m"
@@ -174,12 +115,6 @@ white = "\e[1;37m"
174115
# Syntax must be "name=value", e.g "purple=magenta" or "orange=!#F08000"
175116
alias-colors = ["purple=magenta"]
176117

177-
# Used in disk, ram and swap modules.
178-
# If true, we're going to use the SI standard byte unit (1kB == 1000 bytes)
179-
# Else if false, we using the IEC byte unit (1KiB == 1024 bibytes)
180-
# Really nerdy stuff
181-
use-SI-byte-unit = false
182-
183118
# Colors to be used in percentage tag and modules members.
184119
# They are used as if you're using the color tag.
185120
# It's an array just for "convinience"
@@ -188,10 +123,31 @@ use-SI-byte-unit = false
188123
# 3rd color for bad
189124
percentage-colors = ["green", "yellow", "red"]
190125

191-
# Usually in neofetch/fastfetch, when your terminal size is too small,
192-
# to render some text in 1 line, they don't wrap those lines, instead they truncate them.
193-
# Enable/Disable if you want this
194-
wrap-lines = false
126+
# $<auto.disk> config
127+
[auto.disk]
128+
# Format for displaying the auto detected disks infos
129+
# %1 = mount directory
130+
# %2 = device path
131+
# %3 = type of filesystem
132+
# %4 = total amount of storage
133+
# %5 = free amount of storage
134+
# %6 = used amount of storage
135+
# %7 = percentage of used storage
136+
# %8 = percentage of free storage
137+
fmt = "${auto}Disk (%1): $<disk(%1)>"
138+
139+
# Only print disks that matches the description
140+
# of the following types:
141+
# regular = Regular disks (internel M.2 SSD, ...) (won't be specified)
142+
# removable = External disks (USB, SATA, ...)
143+
# read-only = Disks with read-only filesystems
144+
# hidden = Disks that are not really mounted by the user
145+
display-types = ["regular", "removable", "read-only"]
146+
147+
# In some OSes such as NixOS or Android, there might be some directories that are bind mounted.
148+
# Bind mounted directories create an additional view of an existing directory,
149+
# and `statfs()` on the mount point will return the filesystem statistics of the original directory.
150+
show-duplicated = false
195151

196152
# $<os.uptime> config
197153
[os.uptime]
@@ -223,7 +179,7 @@ dpkg-files = ["/var/lib/dpkg/status"]
223179
flatpak-dirs = ["/var/lib/flatpak/app/", "~/.local/share/flatpak/app/"]
224180
apk-files = ["/var/lib/apk/db/installed"]
225181

226-
# GUI options
182+
# GUI app options
227183
[gui]
228184

229185
# Font to be used

0 commit comments

Comments
 (0)