leenfetch 1.0.3

.\" Automatically generated by Pandoc 3.4
.\"
.TH "leenfetch" "1" "" "Leenfetch 1.0.3" "Manual"
.SH leenfetch \[em] User Commands
.SS NAME
leenfetch \[em] a modern, minimal, and the fastest system info tool,
written in Rust.
.SS SYNOPSIS
.IP
.EX
leenfetch [OPTIONS]
.EE
.SS DESCRIPTION
\f[B]leenfetch\f[R] is a modern, fast, and highly configurable system
information tool written in Rust.
It displays system information alongside a distribution logo or custom
ASCII art, similar to Neofetch, and is designed for both terminal
enthusiasts and new users.
.PP
Configuration lives in a single JSON\-with\-comments file
(\f[CR]config.jsonc\f[R]), with inline explanations for every option.
.PP
leenfetch can also accept \f[B]piped input\f[R] to render as ASCII art.
This allows users to display custom text logos via standard input.
.SS OPTIONS
.IP \[bu] 2
\f[CR]\-v\f[R], \f[CR]\-\-version\f[R]
.PD 0
.P
.PD
Print version information and exit.
.IP \[bu] 2
\f[CR]\-h\f[R], \f[CR]\-\-help\f[R]
.PD 0
.P
.PD
Show usage information and exit.
.IP \[bu] 2
\f[CR]\-l\f[R], \f[CR]\-\-list\-options\f[R]
.PD 0
.P
.PD
List all configuration keys and accepted values.
.IP \[bu] 2
\f[CR]\-i\f[R], \f[CR]\-\-init\f[R]
.PD 0
.P
.PD
Create the default configuration file if it does not exist.
.IP \[bu] 2
\f[CR]\-r\f[R], \f[CR]\-\-reinit\f[R]
.PD 0
.P
.PD
Delete the configuration file and regenerate it with bundled defaults.
.IP \[bu] 2
\f[CR]\-\-config <PATH>\f[R]
.PD 0
.P
.PD
Load configuration from a custom JSONC file.
.IP \[bu] 2
\f[CR]\-\-no\-config\f[R]
.PD 0
.P
.PD
Ignore files and run with built\-in defaults.
.IP \[bu] 2
\f[CR]\-\-ascii_distro <DISTRO>\f[R]
.PD 0
.P
.PD
Override the ASCII art distribution for this run (e.g., \f[CR]arch\f[R],
\f[CR]ubuntu\f[R], \f[CR]debian\f[R]).
.IP \[bu] 2
\f[CR]\-\-ascii_colors <COLORS>\f[R]
.PD 0
.P
.PD
Override the ASCII palette (comma\-separated indices such as
\f[CR]1,2,3,4,5,6,7\f[R] or \f[CR]distro\f[R]).
.IP \[bu] 2
\f[CR]\-\-custom_ascii_path <PATH>\f[R]
.PD 0
.P
.PD
Use a custom ASCII art file for this run.
.IP \[bu] 2
\f[CR]\-\-color\-blocks <GLYPH>\f[R]
.PD 0
.P
.PD
Change the glyph used for the color swatch (default: \f[CR]●\f[R]).
.IP \[bu] 2
\f[CR]\-\-battery\-display <MODE>\f[R]
.PD 0
.P
.PD
Switch battery output between \f[CR]off\f[R], \f[CR]bar\f[R],
\f[CR]infobar\f[R], and \f[CR]barinfo\f[R].
.IP \[bu] 2
\f[CR]\-\-disk\-display <MODE>\f[R]
.PD 0
.P
.PD
Select disk output (\f[CR]info\f[R], \f[CR]percentage\f[R],
\f[CR]infobar\f[R], \f[CR]barinfo\f[R], \f[CR]bar\f[R]).
.IP \[bu] 2
\f[CR]\-\-disk\-subtitle <MODE>\f[R]
.PD 0
.P
.PD
Choose disk labels (\f[CR]name\f[R], \f[CR]dir\f[R], \f[CR]none\f[R],
\f[CR]mount\f[R]).
.IP \[bu] 2
\f[CR]\-\-memory\-unit <UNIT>\f[R]
.PD 0
.P
.PD
Force memory units (\f[CR]kib\f[R], \f[CR]mib\f[R], \f[CR]gib\f[R]).
.IP \[bu] 2
\f[CR]\-\-packages <MODE>\f[R]
.PD 0
.P
.PD
Control package summaries (\f[CR]off\f[R], \f[CR]on\f[R],
\f[CR]tiny\f[R]).
.IP \[bu] 2
\f[CR]\-\-uptime <MODE>\f[R] / \f[CR]\-\-os\-age <MODE>\f[R]
.PD 0
.P
.PD
Pick shorthand (\f[CR]full\f[R], \f[CR]tiny\f[R], \f[CR]seconds\f[R]).
.IP \[bu] 2
\f[CR]\-\-distro\-display <MODE>\f[R]
.PD 0
.P
.PD
Set OS detail level (e.g., \f[CR]name\f[R], \f[CR]name_version\f[R],
\f[CR]name_model_arch\f[R]).
.IP \[bu] 2
\f[CR]\-\-cpu\-temp\-unit <UNIT>\f[R]
.PD 0
.P
.PD
Select CPU temperature units (\f[CR]C\f[R], \f[CR]F\f[R], or
\f[CR]off\f[R] to hide).
.IP \[bu] 2
\f[CR]\-\-only <LIST>\f[R]
.PD 0
.P
.PD
Render only the listed modules (comma\-separated).
.IP \[bu] 2
\f[CR]\-\-hide <LIST>\f[R]
.PD 0
.P
.PD
Hide specific modules (comma\-separated).
.IP \[bu] 2
Boolean toggles follow a paired pattern\[em]use
\f[CR]\-\-cpu\-speed\f[R] / \f[CR]\-\-no\-cpu\-speed\f[R],
\f[CR]\-\-shell\-path\f[R] / \f[CR]\-\-no\-shell\-path\f[R],
\f[CR]\-\-memory\-percent\f[R] / \f[CR]\-\-no\-memory\-percent\f[R],
\f[CR]\-\-refresh\-rate\f[R] / \f[CR]\-\-no\-refresh\-rate\f[R], etc.
.SS CONFIGURATION
leenfetch uses a single JSONC file for configuration, typically located
at:
.IP
.EX
$XDG_CONFIG_HOME/leenfetch/
\[ti]/.config/leenfetch/
.EE
.PP
The configuration file is: \- \f[B]config.jsonc\f[R]: Includes
\f[CR]flags\f[R], an ordered \f[CR]modules\f[R] (\f[CR]layout\f[R])
array, and an optional \f[CR]logo\f[R] override.
Use strings like \f[CR]\[dq]break\[dq]\f[R] for spacers or objects with
\f[CR]type\f[R]/\f[CR]key\f[R] to control the output.
JSONC keeps comments intact so every option is documented in place.
.PP
Edit the file to adjust appearance, enabled modules, spacing, or output
order.
.SS EXAMPLES
.IP \[bu] 2
\f[CR]leenfetch\f[R]
.PD 0
.P
.PD
Display system information using the current configuration.
.IP \[bu] 2
\f[CR]leenfetch \-\-ascii_distro debian\f[R]
.PD 0
.P
.PD
Show system info with Debian ASCII art, regardless of detected distro.
.IP \[bu] 2
\f[CR]leenfetch \-\-init\f[R]
.PD 0
.P
.PD
Create the default config file if missing.
.IP \[bu] 2
\f[CR]leenfetch \-\-reinit\f[R]
.PD 0
.P
.PD
Delete and regenerate the config file.
.IP \[bu] 2
\f[CR]echo \[dq]Rustacean\[dq] | leenfetch\f[R]
.PD 0
.P
.PD
Display system info with a piped ASCII logo generated from the input
text.
.IP \[bu] 2
\f[CR]fortune | cowsay | leenfetch\f[R]
.PD 0
.P
.PD
fortune generates a random quote.
cowsay wraps it in a cow speech bubble (ASCII art).
leenfetch takes piped input and displays it as an ASCII logo.
.SS ENVIRONMENT
.IP \[bu] 2
\f[B]XDG_CONFIG_HOME\f[R]: Specifies the base directory for
user\-specific configuration files.
Defaults to \f[CR]\[ti]/.config\f[R] if not set.
.SS FILE
.IP \[bu] 2
\f[CR]\[ti]/.config/leenfetch/config.jsonc\f[R]
.SS WIKI
Please report bugs or feature requests at:
.PD 0
.P
.PD
https://github.com/drunkleen/leenfetch/wiki
.SS BUGS
Please report bugs or feature requests at:
.PD 0
.P
.PD
https://github.com/drunkleen/leenfetch/issues
.SS AUTHOR
Written by DrunkLeen \c
.MT snape@drunkleen.com
.ME \c