cufetch.1

.\" It was automatically generated by help2man 1.49.3 at the beggining
.TH CUSTOMFETCH "1" "August 2024" "customfetch @VERSION@ branch @BRANCH@" "User Commands"
.SH NAME
customfetch \- A command\-line and GUI system information tool (or neofetch like program)
.SH SYNOPSIS
.B cufetch
[\fI\,OPTION\/\fR]...
.SH CONFIGURATION
customfetch focus point is to be customizable and fast at the same time.
.PP
How does it work?
.PP
We use the \fBconfig.toml\fR file, in there we got an array variable called "layout". That's the variable where you customize how the infos should be displayed.
.PP
You have 5 tags:
.br
* \fB$<module.member>\fR - Used for printing the value of a member of a module.
.br
* \fB${color}\fR - Used for displaying text in a specific color.
.br
* \fB$(bash command)\fR - Used to execute bash commands and print the output.
.br
* \fB$[something,equalToSomething,ifTrue,ifFalse]\fR - Conditional tag to display different outputs based on the comparison.
.br
* \fB$%n1,n2%\fR - Used to print the percentage and print with colors
.PP
They can be used in the ascii art text file and layout, but how to use them?
.br
Here's a simple bare-minimal example:
.br
layout = [
.br
	"My OS is $<os.name>, and username is $<user.name>",
.br
	"The color of the following text will be ${red}red",
.br
	"This is a $(echo \\"bash command\\")",
.br
	"Check if \\\\$<user.name> is correct: $[$<user.name>,toni,indeed,it's not toni but $(echo $USER)]",
.br
	"The discount between 50$ and 100$ is $%50,100%"
.br
]
.PP
* The \fBInfo tag $<>\fR will prints the value of a member of a module.
.br
  All the modules and their members are listed in the `--list-modules` argument
.PP
* The \fBColor tag ${}\fR is used for printing the text of a certain color.
.br
  The colors can be predefined such as: \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.
.br
  They can have hexcodes colors (e.g "#5522dd").
.br
  You can apply special effects to colors by using the following symbols before the '#' in hex codes:
.br
  * \fBb\fR for background color.
.br
  * \fBu\fR for underlining the text.
.br
  * \fB!\fR for bold text.
.br
  * \fBi\fR for italic text.
.PP
  Alternatively, ANSI escape codes can be used, e.g "\\e[1;31m" and "\\e[38;5;160m", but \fBnote\fR that 256-color ANSI escape codes (those that starts with \\[38 or \\[48) cannot be used in GUI mode.
.PP
  You can also use them inside the tag, like \fB${!#343345}\fR or \fB${\\e[1;31m}\fR.
.PP
  To reset colors, use \fB${0}\fR for a normal reset or \fB${1}\fR for a bold reset.
.PP
  To use the colors that the ascii art logo uses, use \fB${auto}\fR for getting the 1st color, \fB${auto4}\fR for the 4th one and so on.
.br
  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
.PP
* The \fBConditional tag $[]\fR is used to display different outputs based on the comparison.
.br
  The syntax \fBMUST\fR be: $[something,equalToSomethingElse,ifTrue,ifFalse] \fBnote:\fR putting spaces could change the expected result
.br
  Each part can have a tag or anything else.
.PP
  For example: $[$<user.name>,$(echo $USER),correct,NOT correct]
.br
  This is useful when on some terminal or WM the detection can be different than others
.PP
* The \fBBash command tag $()\fR speaks for itself.
.br
  It can execute normal bash commands and print the output of it.
.PP
  \fBNOTE:\fR if you try to use programs such as cbonsai in an ASCII art, put a '!' before the command.
.br
  example: $(!cbonsai -p)
.PP
* The \fBPercentage tag $%%\fR is used for displaying the percentage between 2 numbers.
.br
  It \fBMust\fR contain a comma for separating the 2. They can be either be taken from a tag or it put yourself.
.br
  For example: $%50,100%
.br
  For inverting colors of bad and great (red and green), before the first '%' put '!' (without quotes ofc)
.PP
To escape any $ or bracket, just use \\
.SH OPTIONS
.TP
\fB\-n\fR, \fB\-\-no\-display\fR
Do not display the ascii art
.TP
\fB\-s\fR, \fB\-\-source\-path\fR <path>
Path to the ascii art file to display
.TP
\fB\-C\fR, \fB\-\-config\fR <path>
Path to the config file to use
.TP
\fB\-a\fR, \fB\-\-ascii-logo-type\fR [<name>]
The type of ASCII art to apply ("small" or "old").
.br
Basically will add "_<type>" to the logo filename.
.br
It will return the regular linux ascii art if it doesn't exist.
.br
Leave it empty for regular.
.TP
\fB\-D\fR, \fB\-\-data\-dir\fR <path>
Path to the data dir where we'll taking the distros ascii arts (must contain subdirectory called "ascii")
.TP
\fB\-d\fR, \fB\-\-distro\fR <name>
Print a custom distro logo (must be the same name, uppercase or lowercase, e.g "windows 11" or "ArCh")
.TP
\fB\-f\fR, \fB\-\-font\fR <name>
The font to be used in GUI mode (syntax must be "[FAMILY\-LIST] [STYLE\-OPTIONS] [SIZE]" without the square brackets [])
.br
An example: "[Liberation Mono] [Normal] [12]", which can be "Liberation Mono Normal 12"
.TP
\fB\-i\fR, \fB\-\-image\-backend\fR <name>
\fB\fI(EXPERIMENTAL)\fR Image backend tool for displaying images in terminal. Right now only kitty and viu are supported
.br
It's recommended to use GUI mode for the moment if something doesn't work
.TP
\fB\-g\fR, \fB\-\-gui\fR
Use GUI mode instead of priting in the terminal (use \fB\-V\fR to check if it's enabled)
.TP
\fB\-o\fR, \fB\-\-offset\fR <num>
Offset between the ascii art and the system infos
.TP
\fB\-l\fR. \fB\-\-list\-modules\fR
Print the list of the tags and its members
.TP
\fB\-h\fR, \fB\-\-help\fR
Print this help menu
.TP
\fB\-L\fR, \fB\-\-logo\-only\fR
Print only the logo
.TP
\fB\-V\fR, \fB\-\-version\fR
Print the version along with the git branch it was built
.TP
\fB\-\-bg\-image\fR <path>
Path to image to be used in the background in GUI (put "disable" for disabling in the config)
.TP
\fB\-\-logo\-padding\-top\fR <num>
Padding of the logo from the top
.TP
\fB\-\-logo\-padding\-left\fR <num>
Padding of the logo from the left
.TP
\fB\-\-title\-sep\fR <string>
A char (or string) to use in $<builtin.title_sep>
.TP
\fB\-\-sep\-reset\fR <string>
A separator (or string) that when encountered, will automatically reset color
.TP
\fB\-\-sep\-reset\-after\fR [<num>]
Reset color either before of after 'sep-reset' (1 = after && 0 = before)
.TP
\fB\-\-gen\-config\fR [<path>]
Generate default config file to config folder (if path, it will generate to the path)
.br
Will ask for confirmation if file exists already
.TP
\fB\-\-color\fR <string>
Replace instances of a color with another value.
.br
Syntax MUST be "name=value" with no space between "=", example: --color "foo=#444333".
.br
Thus replaces any instance of foo with #444333. Can be done with multiple colors separately.
.br
Matter of fact, you can: --color "#hexcode=#anotherhexcode"
.SH BUGS
\fR
Report any bugs to \fIhttps://github.com/Toni500github/customfetch/issues\fR