You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
285 lines
7.4 KiB
285 lines
7.4 KiB
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3. |
|
.TH NEOFETCH "1" "December 2016" "Neofetch 2.1.0" "User Commands" |
|
.SH NAME |
|
Neofetch \- manual page for Neofetch 2.1.0 |
|
.SH SYNOPSIS |
|
.B neofetch |
|
\fI\,--option "value" --option "value"\/\fR |
|
.SH DESCRIPTION |
|
Neofetch is a CLI system information tool written in BASH. |
|
.PP |
|
NOTE: Every launch flag has a config option. |
|
.SH OPTIONS |
|
INFO |
|
.TP |
|
\fB\-\-disable\fR infoname |
|
Allows you to disable an info line from appearing |
|
in the output. |
|
.IP |
|
NOTE: You can supply multiple args. eg. 'neofetch \fB\-\-disable\fR cpu gpu disk shell' |
|
.TP |
|
\fB\-\-os_arch\fR on/off |
|
Hide/Show OS architecture. |
|
.TP |
|
\fB\-\-speed_type\fR type |
|
Change the type of cpu speed to display. |
|
Possible values: current, min, max, bios, |
|
scaling_current, scaling_min, scaling_max |
|
.IP |
|
NOTE: This only support Linux with cpufreq. |
|
.TP |
|
\fB\-\-cpu_shorthand\fR type |
|
Shorten the output of CPU |
|
Possible values: name, speed, tiny, on, off |
|
.TP |
|
\fB\-\-cpu_cores\fR type |
|
Whether or not to display the number of CPU cores |
|
Takes: logical, physical, off |
|
.IP |
|
NOTE: 'physical' doesn't work on BSD. |
|
.TP |
|
\fB\-\-cpu_speed\fR on/off |
|
Hide/Show cpu speed. |
|
.TP |
|
\fB\-\-cpu_temp\fR on/off |
|
Hide/Show cpu temperature. |
|
.IP |
|
NOTE: This only works on Linux and BSD. |
|
.IP |
|
NOTE: For FreeBSD\-based systems, you need to enable coretemp kernel module. |
|
.TP |
|
\fB\-\-distro_shorthand\fR on/off |
|
Shorten the output of distro (tiny, on, off) |
|
.IP |
|
NOTE: This option won't work in Windows (Cygwin) |
|
.TP |
|
\fB\-\-kernel_shorthand\fR on/off |
|
Shorten the output of kernel |
|
.IP |
|
NOTE: This option won't work in BSDs (except PacBSD and PC\-BSD) |
|
.TP |
|
\fB\-\-uptime_shorthand\fR on/off |
|
Shorten the output of uptime (tiny, on, off) |
|
.TP |
|
\fB\-\-refresh_rate\fR on/off |
|
Whether to display the refresh rate of each monitor |
|
Unsupported on Windows |
|
.TP |
|
\fB\-\-gpu_brand\fR on/off |
|
Enable/Disable GPU brand in output. (AMD/NVIDIA/Intel) |
|
.TP |
|
\fB\-\-gtk_shorthand\fR on/off |
|
Shorten output of gtk theme/icons |
|
.TP |
|
\fB\-\-gtk2\fR on/off |
|
Enable/Disable gtk2 theme/font/icons output |
|
.TP |
|
\fB\-\-gtk3\fR on/off |
|
Enable/Disable gtk3 theme/font/icons output |
|
.TP |
|
\fB\-\-shell_path\fR on/off |
|
Enable/Disable showing $SHELL path |
|
.TP |
|
\fB\-\-shell_version\fR on/off |
|
Enable/Disable showing $SHELL version |
|
.TP |
|
\fB\-\-ip_host\fR url |
|
URL to query for public IP |
|
.TP |
|
\fB\-\-song_shorthand\fR on/off |
|
Print the Artist/Title on seperate lines |
|
.TP |
|
\fB\-\-install_time\fR on/off |
|
Enable/Disable showing the time in Install Date output. |
|
.PP |
|
TEXT FORMATTING |
|
.TP |
|
\fB\-\-colors\fR x x x x x x |
|
Changes the text colors in this order: |
|
title, @, underline, subtitle, colon, info |
|
.TP |
|
\fB\-\-underline\fR on/off |
|
Enable/Disable the underline. |
|
.TP |
|
\fB\-\-underline_char\fR char |
|
Character to use when underlining title |
|
.TP |
|
\fB\-\-bold\fR on/off |
|
Enable/Disable bold text |
|
.PP |
|
COLOR BLOCKS |
|
.TP |
|
\fB\-\-color_blocks\fR on/off |
|
Enable/Disable the color blocks |
|
.TP |
|
\fB\-\-block_width\fR num |
|
Width of color blocks in spaces |
|
.TP |
|
\fB\-\-block_height\fR num |
|
Height of color blocks in lines |
|
.TP |
|
\fB\-\-block_range\fR start end |
|
Range of colors to print as blocks |
|
.PP |
|
BARS |
|
.TP |
|
\fB\-\-bar_char\fR 'elapsed char' 'total char' |
|
Characters to use when drawing bars. |
|
.TP |
|
\fB\-\-bar_border\fR on/off |
|
Whether or not to surround the bar with '[]' |
|
.TP |
|
\fB\-\-bar_length\fR num |
|
Length in spaces to make the bars. |
|
.TP |
|
\fB\-\-bar_colors\fR num num |
|
Colors to make the bar. |
|
Set in this order: elapsed, total |
|
.TP |
|
\fB\-\-cpu_display\fR mode |
|
Bar mode. |
|
Takes: bar, infobar, barinfo, off |
|
.TP |
|
\fB\-\-memory_display\fR mode |
|
Bar mode. |
|
Takes: bar, infobar, barinfo, off |
|
.TP |
|
\fB\-\-battery_display\fR mode |
|
Bar mode. |
|
Takes: bar, infobar, barinfo, off |
|
.TP |
|
\fB\-\-disk_display\fR mode |
|
Bar mode. |
|
Takes: bar, infobar, barinfo, off |
|
.PP |
|
IMAGE |
|
.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 |
|
.TP |
|
\fB\-\-size\fR 00px | \fB\-\-size\fR 00% |
|
How to size the image. |
|
Possible values: auto, 00px, 00%, none |
|
.TP |
|
\fB\-\-crop_mode\fR mode |
|
Which crop mode to use |
|
Takes the values: normal, fit, fill |
|
.TP |
|
\fB\-\-crop_offset\fR value |
|
Change the crop offset for normal mode. |
|
Possible values: northwest, north, northeast, |
|
west, center, east, southwest, south, southeast |
|
.TP |
|
\fB\-\-xoffset\fR px |
|
How close the image will be to the left edge of the |
|
window. This only works with w3m. |
|
.TP |
|
\fB\-\-yoffset\fR px |
|
How close the image will be to the top edge of the |
|
window. This only works with w3m. |
|
.TP |
|
\fB\-\-bg_color\fR color |
|
Background color to display behind transparent image. |
|
This only works with w3m. |
|
.TP |
|
\fB\-\-gap\fR num |
|
Gap between image and text. |
|
.IP |
|
NOTE: \fB\-\-gap\fR can take a negative value which will move the text closer to the left side. |
|
.TP |
|
\fB\-\-clean\fR |
|
Delete cached files and thumbnails. |
|
.PP |
|
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 varients. |
|
.IP |
|
NOTE: Use 'arch_old' or 'ubuntu_old' to use the old logos. |
|
.IP |
|
NOTE: Ubuntu has flavor varients. |
|
.IP |
|
NOTE: Change this to 'Lubuntu', 'Xubuntu', 'Ubuntu\-GNOME', 'Ubuntu\-Studio' or 'Ubuntu\-Budgie' to use the flavors. |
|
.TP |
|
\fB\-\-ascii_logo_size\fR |
|
Size of ascii logo. |
|
Supported distros: Arch, Gentoo, Crux, OpenBSD. |
|
.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. |
|
.PP |
|
SCREENSHOT |
|
.TP |
|
\fB\-s\fR, \fB\-\-scrot\fR \fI\,/path/to/img\/\fP |
|
Take a screenshot, if path is left empty the screenshot function will use $scrot_dir and $scrot_name. |
|
.TP |
|
\fB\-su\fR, \fB\-\-upload\fR \fI\,/path/to/img\/\fP |
|
Same as \fB\-\-scrot\fR but uploads the scrot to a website. |
|
.TP |
|
\fB\-\-image_host\fR |
|
Website to upload scrots to. Takes: imgur, teknik |
|
.TP |
|
\fB\-\-scrot_cmd\fR cmd |
|
Screenshot program to launch |
|
.PP |
|
OTHER |
|
.TP |
|
\fB\-\-config\fR \fI\,/path/to/config\/\fP |
|
Specify a path to a custom config file |
|
.TP |
|
\fB\-\-config\fR none |
|
Launch the script without a config file |
|
.TP |
|
\fB\-\-help\fR |
|
Print this text and exit |
|
.TP |
|
\fB\-\-version\fR |
|
Show neofetch version |
|
.TP |
|
\fB\-v\fR |
|
Display error messages. |
|
.TP |
|
\fB\-vv\fR |
|
Display a verbose log for error reporting. |
|
.PP |
|
DEVELOPER |
|
.TP |
|
\fB\-\-gen\-man\fR |
|
Generate a manpage for Neofetch in your PWD. |
|
.SH AUTHOR |
|
Written by Dylan Araps with help from the following people: |
|
.PP |
|
https://github.com/dylanaraps/neofetch/contributors |
|
.SH "REPORTING BUGS" |
|
Report bugs to https://github.com/dylanaraps/neofetch/issues |
|
.SH COPYRIGHT |
|
Copyright \(co 2016 Dylan Araps |
|
.PP |
|
License MIT: Permission is hereby granted, free of charge, to any person obtaining a copy |
|
of this software and associated documentation files (the 'Software'), to deal |
|
in the Software without restriction, including without limitation the rights |
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
|
copies of the Software, and to permit persons to whom the Software is |
|
furnished to do so, subject to the following conditions: |
|
.PP |
|
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
|
SOFTWARE.
|
|
|