Docs: Write documentation for new image modes
This commit is contained in:
Dylan Araps
parent
5c425e2b8e
commit
3b1dc8ce24
57
neofetch
57
neofetch
|
|
@ -3701,10 +3701,40 @@ BARS:
|
|||
Takes: bar, infobar, barinfo, off
|
||||
--disk_display mode Bar mode.
|
||||
Takes: bar, infobar, barinfo, off
|
||||
|
||||
IMAGE BACKEND:
|
||||
--image_backend backend Which image backend to use.
|
||||
Possible values: 'ascii', 'w3m', 'iterm2', 'tycat', 'off'
|
||||
--image_source source Which image or ascii file to use.
|
||||
Possible values: 'auto', 'ascii', 'wallpaper', '/path/to/img', '/path/to/ascii', '/path/to/dir/'
|
||||
--w3m Shortcut to use 'w3m' backend.
|
||||
--iterm2 Shortcut to use 'iterm2' backend.
|
||||
--tycat Shortcut to use 'tycat' backend.
|
||||
--ascii Shortcut to use 'ascii' backend.
|
||||
--off Shortcut to use 'off' backend.
|
||||
|
||||
ASCII:
|
||||
--ascii_colors x x x x x x Colors to print the ascii art
|
||||
--ascii_distro distro Which Distro's ascii art to print
|
||||
|
||||
NOTE: Arch and Ubuntu have 'old' logo variants.
|
||||
|
||||
NOTE: Use 'arch_old' or 'ubuntu_old' to use the old logos.
|
||||
|
||||
NOTE: Ubuntu has flavor variants.
|
||||
|
||||
NOTE: Change this to 'Lubuntu', 'Xubuntu', 'Ubuntu-GNOME', 'Ubuntu-Studio' or 'Ubuntu-Budgie' to use the flavors.
|
||||
|
||||
NOTE: Alpine, Arch, Crux, Gentoo, OpenBSD, and Void have a smaller logo variant.
|
||||
|
||||
NOTE: Change this to 'alpine_small', 'arch_small', 'crux_small', 'gentoo_small', 'openbsd_small', and 'void_small' to use the small logos.
|
||||
|
||||
--ascii_bold on/off Whether or not to bold the ascii logo.
|
||||
-L, --logo Hide the info text and only show the ascii logo.
|
||||
|
||||
Possible values: bar, infobar, barinfo, off
|
||||
|
||||
IMAGE:
|
||||
--image type Image source. Where and what image we display.
|
||||
Possible values: wall, ascii,
|
||||
/path/to/img, /path/to/dir/, off
|
||||
--size 00px | --size 00% How to size the image.
|
||||
Possible values: auto, 00px, 00%, none
|
||||
--crop_mode mode Which crop mode to use
|
||||
|
|
@ -3725,27 +3755,6 @@ IMAGE:
|
|||
|
||||
--clean Delete cached files and thumbnails.
|
||||
|
||||
ASCII:
|
||||
--ascii value Where to get the ascii from, Possible values:
|
||||
distro, /path/to/ascii
|
||||
--ascii_colors x x x x x x Colors to print the ascii art
|
||||
--ascii_distro distro Which Distro's ascii art to print
|
||||
|
||||
NOTE: Arch and Ubuntu have 'old' logo variants.
|
||||
|
||||
NOTE: Use 'arch_old' or 'ubuntu_old' to use the old logos.
|
||||
|
||||
NOTE: Ubuntu has flavor variants.
|
||||
|
||||
NOTE: Change this to 'Lubuntu', 'Xubuntu', 'Ubuntu-GNOME', 'Ubuntu-Studio' or 'Ubuntu-Budgie' to use the flavors.
|
||||
|
||||
NOTE: Alpine, Arch, Crux, Gentoo, OpenBSD, and Void have a smaller logo variant.
|
||||
|
||||
NOTE: Change this to 'alpine_small', 'arch_small', 'crux_small', 'gentoo_small', 'openbsd_small', and 'void_small' to use the small logos.
|
||||
|
||||
--ascii_bold on/off Whether or not to bold the ascii logo.
|
||||
-L, --logo Hide the info text and only show the ascii logo.
|
||||
|
||||
SCREENSHOT:
|
||||
-s, --scrot /path/to/img Take a screenshot, if path is left empty the screen-
|
||||
shot function will use \$scrot_dir and \$scrot_name.
|
||||
|
|
|
|||
85
neofetch.1
85
neofetch.1
|
|
@ -171,12 +171,58 @@ Takes: bar, infobar, barinfo, off
|
|||
\fB\-\-disk_display\fR mode
|
||||
Bar mode.
|
||||
Takes: bar, infobar, barinfo, off
|
||||
.SS "IMAGE:"
|
||||
.SS "IMAGE BACKEND:"
|
||||
.TP
|
||||
\fB\-\-image\fR type
|
||||
Image source. Where and what image we display.
|
||||
Possible values: wall, ascii,
|
||||
\fI\,/path/to/img\/\fP, /path/to/dir/, off
|
||||
\fB\-\-image_backend\fR backend
|
||||
Which image backend to use.
|
||||
Possible values: 'ascii', 'w3m', 'iterm2', 'tycat', 'off'
|
||||
.TP
|
||||
\fB\-\-image_source\fR source
|
||||
Which image or ascii file to use.
|
||||
Possible values: 'auto', 'ascii', 'wallpaper', '/path/to/img', '/path/to/ascii', '/path/to/dir/'
|
||||
.TP
|
||||
\fB\-\-w3m\fR
|
||||
Shortcut to use 'w3m' backend.
|
||||
.TP
|
||||
\fB\-\-iterm2\fR
|
||||
Shortcut to use 'iterm2' backend.
|
||||
.TP
|
||||
\fB\-\-tycat\fR
|
||||
Shortcut to use 'tycat' backend.
|
||||
.TP
|
||||
\fB\-\-ascii\fR
|
||||
Shortcut to use 'ascii' backend.
|
||||
.TP
|
||||
\fB\-\-off\fR
|
||||
Shortcut to use 'off' backend.
|
||||
.SS "ASCII:"
|
||||
.TP
|
||||
\fB\-\-ascii_colors\fR x x x x x x
|
||||
Colors to print the ascii art
|
||||
.TP
|
||||
\fB\-\-ascii_distro\fR distro
|
||||
Which Distro's ascii art to print
|
||||
.IP
|
||||
NOTE: Arch and Ubuntu have 'old' logo variants.
|
||||
.IP
|
||||
NOTE: Use 'arch_old' or 'ubuntu_old' to use the old logos.
|
||||
.IP
|
||||
NOTE: Ubuntu has flavor variants.
|
||||
.IP
|
||||
NOTE: Change this to 'Lubuntu', 'Xubuntu', 'Ubuntu\-GNOME', 'Ubuntu\-Studio' or 'Ubuntu\-Budgie' to use the flavors.
|
||||
.IP
|
||||
NOTE: Alpine, Arch, Crux, Gentoo, OpenBSD, and Void have a smaller logo variant.
|
||||
.IP
|
||||
NOTE: Change this to 'alpine_small', 'arch_small', 'crux_small', 'gentoo_small', 'openbsd_small', and 'void_small' to use the small logos.
|
||||
.TP
|
||||
\fB\-\-ascii_bold\fR on/off
|
||||
Whether or not to bold the ascii logo.
|
||||
.TP
|
||||
\fB\-L\fR, \fB\-\-logo\fR
|
||||
Hide the info text and only show the ascii logo.
|
||||
.IP
|
||||
Possible values: bar, infobar, barinfo, off
|
||||
.SS "IMAGE:"
|
||||
.TP
|
||||
\fB\-\-size\fR 00px | \fB\-\-size\fR 00%
|
||||
How to size the image.
|
||||
|
|
@ -210,35 +256,6 @@ NOTE: \fB\-\-gap\fR can take a negative value which will move the text closer to
|
|||
.TP
|
||||
\fB\-\-clean\fR
|
||||
Delete cached files and thumbnails.
|
||||
.SS "ASCII:"
|
||||
.TP
|
||||
\fB\-\-ascii\fR value
|
||||
Where to get the ascii from, Possible values:
|
||||
distro, \fI\,/path/to/ascii\/\fP
|
||||
.TP
|
||||
\fB\-\-ascii_colors\fR x x x x x x
|
||||
Colors to print the ascii art
|
||||
.TP
|
||||
\fB\-\-ascii_distro\fR distro
|
||||
Which Distro's ascii art to print
|
||||
.IP
|
||||
NOTE: Arch and Ubuntu have 'old' logo variants.
|
||||
.IP
|
||||
NOTE: Use 'arch_old' or 'ubuntu_old' to use the old logos.
|
||||
.IP
|
||||
NOTE: Ubuntu has flavor variants.
|
||||
.IP
|
||||
NOTE: Change this to 'Lubuntu', 'Xubuntu', 'Ubuntu\-GNOME', 'Ubuntu\-Studio' or 'Ubuntu\-Budgie' to use the flavors.
|
||||
.IP
|
||||
NOTE: Alpine, Arch, Crux, Gentoo, OpenBSD, and Void have a smaller logo variant.
|
||||
.IP
|
||||
NOTE: Change this to 'alpine_small', 'arch_small', 'crux_small', 'gentoo_small', 'openbsd_small', and 'void_small' to use the small logos.
|
||||
.TP
|
||||
\fB\-\-ascii_bold\fR on/off
|
||||
Whether or not to bold the ascii logo.
|
||||
.TP
|
||||
\fB\-L\fR, \fB\-\-logo\fR
|
||||
Hide the info text and only show the ascii logo.
|
||||
.SS "SCREENSHOT:"
|
||||
.TP
|
||||
\fB\-s\fR, \fB\-\-scrot\fR \fI\,/path/to/img\/\fP
|
||||
|
|
|
|||
Loading…
Reference in New Issue