fastfetch-cli/fastfetch
1
0
Fork 0
mirror of https://github.com/fastfetch-cli/fastfetch.git synced 2026-09-13 10:52:08 +02:00
Code Issues Packages Projects Releases 10 Wiki Activity

Update logo doc

Browse Source
This commit is contained in:
Linus Dierheimer
2023-01-14 17:54:21 +01:00
parent f13a502123
commit b6abc6e326
1 changed files with 16 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/logo.md
+16 -18
View File
@@ -1,8 +1,6 @@
# Logo Documentation
# Logo options
## Logo options
### General
## General
| Option | Default | Description |
|--------|---------|-------------|
@@ -20,7 +18,7 @@ All filesytem paths can be:
* Relative to any of the directories listed by `fastfetch --list-data-paths` + `/logos`
For example, the file `~/.local/share/fastfetch/logos/shrek` can simply be referenced as `shrek`.
### Text
## Text
| Option | Default | Description |
|--------|---------|-------------|
@@ -30,7 +28,7 @@ All filesytem paths can be:
* Color placeholders are in the form `$[1-9]`. To print a `$`, use `$$`.
* If a color placeholder value is not set, the placeholder is simply discarded.
### Image
## Image
| Option | Default | Description |
|--------|---------|-------------|
@@ -40,9 +38,9 @@ All filesytem paths can be:
* If one of the height / width options is set, but the other not, the aspect ratio is preserved.
* If neither height nor width is set, the original size is used.
## Logo types
# Logo types
### auto
## auto
Trys to detect the logo type depending on the value of `--logo`, in the following order:
* If the value is empty / not set, an autodected builtin logo is displayed.
@@ -51,7 +49,7 @@ Trys to detect the logo type depending on the value of `--logo`, in the followin
* If the value is the path to a text file, the content is displayed.
* The autodetected builtin logo is displayed.
### builtin
## builtin
The value of `--logo` is interpreted as the name of a builtin logo.
* If the value is empty / not set, it is autodetected.
@@ -60,45 +58,45 @@ The value of `--logo` is interpreted as the name of a builtin logo.
* All builtin logos set default values for `--logo-color-[1-9]`.
* Use `none` to disable the logo, but keep key colors from the detected logo.
### file
## file
The value of `--logo` is interpreted as the path to a file. The content of the file is displayed.
* If the file can't be read, the autodetected builtin logo is displayed.
### file-raw
## file-raw
The value of `--logo` is interpreted as the path to a file. The content of the file is displayed.
* No color placeholder replacement is done.
* If the file can't be read, the autodetected builtin logo is displayed.
### data
## data
The value of `--logo` is interpreted as the logo and directly displayed.
* If the value is empty / not set, the autodetected builtin logo is displayed.
### data-raw
## data-raw
The value of `--logo` is interpreted as the logo and directly displayed.
* No color placeholder replacement is done.
* If the value is empty / not set, the autodetected builtin logo is displayed.
### sixel
## sixel
The value of `--logo` is interpreted as the path to an image file. It is displayed using the sixel graphics protocol.
* `fastfetch` must be compiled with the `imagemagick6` or `imagemagick7` feature.
### kitty
## kitty
The value of `--logo` is interpreted as the path to an image file. It is displayed using the kitty graphics protocol.
* If the file is a png file, and both `--logo-width` and `--logo-height` are specified, the image is directly send to the terminal emulator.
* Otherwise `fastfetch` must be compiled with the `imagemagick6` or `imagemagick7` feature.
### iterm
## iterm
The value of `--logo` is interpreted as the path to an image file. It is displayed using the iTerm graphics protocol.
* Both `--logo-width` and `--logo-height` must be specified.
### chafa
## chafa
The value of `--logo` is interpreted as the path to an image file. It is converted to an ascii logo using `libchafa`.
* `fastfetch` must be compiled with the `chafa` feature.
@@ -110,7 +108,7 @@ The value of `--logo` is interpreted as the path to an image file. It is convert
* Use `--chafa-dither-mode` to set the dither mode.
* See the [chafa documentation](https://hpjansson.org/chafa/man/) for more information.
### raw
## raw
The value of `--logo` is interpreted as the path to a binary file. It is printed as-is.
* Both `--logo-width` and `--logo-height` must be specified.