|
1 | 1 | .\" It was automatically generated by help2man 1.49.3 at the beggining |
2 | 2 | .TH CUSTOMFETCH "1" "August 2024" "customfetch @VERSION@ branch @BRANCH@" "User Commands" |
3 | 3 | .SH NAME |
4 | | -customfetch \- A command\-line and GUI system information tool (or neofetch like program), which its focus point is customizability and perfomance |
| 4 | +customfetch \- A command\-line and GUI system information tool (or neofetch like program) |
5 | 5 | .SH SYNOPSIS |
6 | 6 | .B cufetch |
7 | 7 | [\fI\,OPTION\/\fR]... |
| 8 | +.SH CONFIGURATION |
| 9 | +customfetch focus point is to be customizable and fast at the same time. |
| 10 | +.PP |
| 11 | +How does it work? |
| 12 | +.PP |
| 13 | +We got the config.toml file, in there we got an array variable called "layout". That's the variable where you customize how the infos should be displayed. |
| 14 | +.br |
| 15 | +You have 3 components: $<module.submod>, ${color}, $(bash command). They can be used in the ascii art text file and layout, but how to use them? |
| 16 | +.PP |
| 17 | +Here's a simple bare-minimal example: |
| 18 | +.br |
| 19 | +layout = [ |
| 20 | +.br |
| 21 | + "My OS is $<os.name>, and username is $<user.name>", |
| 22 | +.br |
| 23 | + "The color of the following text will be ${red}red", |
| 24 | +.br |
| 25 | + "And this is a $(echo \\"bash command\\")" |
| 26 | +.br |
| 27 | +] |
| 28 | +.PP |
| 29 | +The \fBInfo component $<>\fR let's you print a part of a module. All the modules and their parts are listed in the `--list-modules` argument |
| 30 | +.PP |
| 31 | +The \fBColor component ${}\fR is used for printing the text of a certain color. |
| 32 | +.br |
| 33 | +The colors can be: \fIblack\fR, \fIred\fR, \fIgreen\fR, \fIblue\fR, \fIcyan\fR, \fIyellow\fR, \fImagenta\fR, \fIwhite\fR and they can be configured in the config file. |
| 34 | +.br |
| 35 | +They can have hexcodes colors, e.g "#5522dd". |
| 36 | +.br |
| 37 | +It's possible to enable multiple options, put these symbols before '#': |
| 38 | +.br |
| 39 | +* \fBb\fR for making the color in the background |
| 40 | +.br |
| 41 | +* \fBu\fR for underline the text |
| 42 | +.br |
| 43 | +* \fB!\fR for making the text bold |
| 44 | +.br |
| 45 | +* \fBi\fR for making the text italic |
| 46 | + |
| 47 | +OR They can have ANSI escape codes, e.g "\\e[1;31m" and "\\e[38;5;160m" (\fBNOTE\fR: 256 colors ANSI escape codes, those that have \\e[38 or \\e[48, can't be used in GUI) |
| 48 | +.br |
| 49 | +You can also use them inside the component, like ${!#343345} or ${\\e[1;31m}. |
| 50 | +.PP |
| 51 | +To reset colors use ${0} or ${1} for reset and bold text. |
| 52 | +.br |
| 53 | +To instead use the colors that the ascii art logo uses, use ${auto} for getting the 1st color, ${auto4} for the 4th one and so on. |
| 54 | +.PP |
| 55 | +The \fBBash command component $()\fR speaks for itself. It can execute normal bash commands. |
| 56 | +.PP |
| 57 | +To escape any $ or bracket, just use \\ |
8 | 58 | .SH OPTIONS |
9 | 59 | .TP |
10 | 60 | \fB\-n\fR, \fB\-\-no\-display\fR |
@@ -82,46 +132,6 @@ Syntax MUST be "name=value" with no space beetween "=", example: --color "foo=#4 |
82 | 132 | Thus replaces any instance of foo with #444333. Can be done with multiple colors separetly. |
83 | 133 | .br |
84 | 134 | Matter of fact, you can: --color "#hexcode=#anotherhexcode" |
85 | | -.SH CONFIGURATION |
86 | | -customfetch is a command\-line and GUI system information tool (or "neofetch like program"). It's focus point is being customizable and fast at the same time. |
87 | | -.PP |
88 | | -How does it work? |
89 | | -.PP |
90 | | -We got the config.toml file, in there we got an array variable called "layout". That's the variable where you customize how the infos should be displayed. |
91 | | -.br |
92 | | -You have 3 components: $<module.submod>, ${color}, $(bash command). They can be used in the ascii art text file and layout, but how to use them? |
93 | | -.PP |
94 | | -Here's a simple bare-minimal example: |
95 | | -.br |
96 | | -layout = [ |
97 | | -.br |
98 | | - "My OS is $<os.name>, and username is $<user.name>", |
99 | | -.br |
100 | | - "The color of the following text will be ${red}red", |
101 | | -.br |
102 | | - "And this is a $(echo \\"bash command\\")" |
103 | | -.br |
104 | | -] |
105 | | -.PP |
106 | | -The \fBInfo component $<>\fR let's you print a part of a module. All the modules and their parts are listed in the `--list-modules` argument |
107 | | -.PP |
108 | | -The \fBColor component ${}\fR is used for printing the text of a certain color. |
109 | | -.br |
110 | | -The colors can be: \fIblack\fR, \fIred\fR, \fIgreen\fR, \fIblue\fR, \fIcyan\fR, \fIyellow\fR, \fImagenta\fR, \fIwhite\fR and they can be configured in the config file. |
111 | | -.br |
112 | | -These can have hexcodes colors, e.g "#5522dd" or "!#888eed" for bold color text |
113 | | -.br |
114 | | -OR They can have ANSI escape codes, e.g "\\e[1;31m" and "\\e[38;5;160m" (\fBNOTE\fR: 256 colors ANSI escape codes, those that have \\e[38 or \\e[48, can't be used in GUI) |
115 | | -.br |
116 | | -You can also use them inside the component, like ${!#343345} or ${\\e[1;31m}. |
117 | | -.PP |
118 | | -To reset colors use ${0} or ${1} for reset and bold text. |
119 | | -.br |
120 | | -To instead use the colors that the ascii art logo uses, use ${auto} for getting the 1st color, ${auto4} for the 4th one and so on. |
121 | | -.PP |
122 | | -The \fBBash command component $()\fR speaks for itself. It can execute normal bash commands. |
123 | | -.PP |
124 | | -To escape any $ or bracket, just use \\ |
125 | 135 | .SH BUGS |
126 | 136 | \fR |
127 | 137 | Report any bugs to \fIhttps://github.com/Toni500github/customfetch/issues\fR |
0 commit comments