mirror of
https://github.com/dylanaraps/neofetch.git
synced 2025-10-04 09:08:38 +00:00
Compare commits
1 Commits
Author | SHA1 | Date | |
---|---|---|---|
|
942f6cc4a7 |
2
.github/ISSUE_TEMPLATE.md
vendored
2
.github/ISSUE_TEMPLATE.md
vendored
@@ -2,8 +2,6 @@
|
||||
|
||||
If you're suggesting a new feature then just a description will suffice.
|
||||
|
||||
- [ ] Does this issue still occur in the master branch? (**Required if issue**)
|
||||
|
||||
|
||||
#### Neofetch version
|
||||
|
||||
|
17
.travis.yml
17
.travis.yml
@@ -9,15 +9,14 @@ before_install:
|
||||
- if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew update; fi
|
||||
- if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew install screenresolution; fi
|
||||
|
||||
install:
|
||||
# Install a custom version of shellcheck instead of Travis CI's default
|
||||
- scversion="latest" # or "v0.4.7", or "latest"
|
||||
- wget "https://storage.googleapis.com/shellcheck/shellcheck-${scversion}.linux.x86_64.tar.xz"
|
||||
- tar --xz -xvf "shellcheck-${scversion}.linux.x86_64.tar.xz"
|
||||
- shellcheck() { "shellcheck-${scversion}/shellcheck" "$@"; }
|
||||
|
||||
script:
|
||||
- time ./neofetch --travis -v
|
||||
- if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then shellcheck -e SC2244 -e SC2243 neofetch; fi
|
||||
# See this wiki page for why we're disabling these errors.
|
||||
# https://github.com/dylanaraps/neofetch/wiki/Shellcheck-Exclusions
|
||||
- if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then shellcheck neofetch -e SC1090,SC2009,SC2012,SC2016,SC2034,SC2128,SC2153,SC2154,SC2178,SC2010,SC1004,SC1091,SC1117; fi
|
||||
# The if statement is here to invert the exit code from grep.
|
||||
# grep normally errors if no match is found but we want the opposite.
|
||||
# We invert it so grep fails if a match is found.
|
||||
# Check for lines longer than 100 chars.
|
||||
- if grep '.\{102\}' neofetch; then (exit 1); else (exit 0); fi
|
||||
# There are 3 lines that must be longer than 100 chars.
|
||||
- if (("$(grep '.\{101\}' neofetch | wc -l)" > 3)); then (exit 1); else (exit 0); fi
|
||||
|
2744
CHANGELOG.md
Normal file
2744
CHANGELOG.md
Normal file
File diff suppressed because it is too large
Load Diff
@@ -23,15 +23,20 @@
|
||||
and variable names.
|
||||
- Keep lines below `100` characters long.
|
||||
- Use `[[ ]]` for tests.
|
||||
- Quote **EVERYTHING**.
|
||||
- Double Quote **EVERYTHING**.
|
||||
- Don’t use single quotes, except for special cases.
|
||||
|
||||
### ShellCheck
|
||||
|
||||
For your contribution to be accepted, your changes need to pass
|
||||
ShellCheck.
|
||||
|
||||
Run ShellCheck with the following command:
|
||||
|
||||
```sh
|
||||
shellcheck neofetch
|
||||
# Why do we exclude numerous tests?
|
||||
# See: https://github.com/dylanaraps/neofetch/wiki/Shellcheck-Exclusions
|
||||
shellcheck neofetch -e SC1090,SC2009,SC2012,SC2016,SC2034,SC2128,SC2153,SC2154,SC2178,SC2010,SC1004,SC1091,SC1117
|
||||
```
|
||||
|
||||
**Note**: If you have trouble installing ShellCheck. You can open a pull
|
||||
@@ -53,8 +58,6 @@ request on the repo and our Travis.ci hook will run ShellCheck for you.
|
||||
- Use `bash`'s built-in syntax (`file="$(< /path/to/file.txt)")`).
|
||||
- Don’t use `grep "pattern" | awk '{ printf }'`.
|
||||
- Use `awk '/pattern/ { printf }'`
|
||||
- Don’t use `wc`.
|
||||
- Use `${#var}` or `${#arr[@]}`.
|
||||
|
||||
|
||||
### If Statements
|
||||
|
@@ -1,6 +1,6 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2015-2020 Dylan Araps
|
||||
Copyright (c) 2016-2018 Dylan Araps
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
36
README.md
36
README.md
@@ -2,9 +2,11 @@
|
||||
<p align="center">A command-line system information tool written in bash 3.2+</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://discord.gg/BtnTPFF"><img src="https://img.shields.io/discord/440354555197128704.svg"></a>
|
||||
<a href="https://travis-ci.org/dylanaraps/neofetch"><img src="https://travis-ci.org/dylanaraps/neofetch.svg?branch=master"></a>
|
||||
<a href="./LICENSE.md"><img src="https://img.shields.io/badge/license-MIT-blue.svg"></a>
|
||||
<a href="https://github.com/dylanaraps/neofetch/releases"><img src="https://img.shields.io/github/release/dylanaraps/neofetch.svg"></a>
|
||||
<a href="https://repology.org/metapackage/neofetch"><img src="https://repology.org/badge/tiny-repos/neofetch.svg" alt="Packaging status"></a>
|
||||
<a href="https://www.patreon.com/dyla"><img src="https://img.shields.io/badge/donate-patreon-yellow.svg"></a>
|
||||
</p>
|
||||
|
||||
<img src="https://i.imgur.com/GFmC5Ad.png" alt="neofetch" align="right" height="240px">
|
||||
@@ -23,3 +25,35 @@ Neofetch supports almost 150 different operating systems. From Linux to Windows,
|
||||
|
||||
|
||||
### More: \[[Dependencies](https://github.com/dylanaraps/neofetch/wiki/Dependencies)\] \[[Installation](https://github.com/dylanaraps/neofetch/wiki/Installation)\] \[[Wiki](https://github.com/dylanaraps/neofetch/wiki)\]
|
||||
|
||||
## Articles
|
||||
|
||||
- https://lamiradadelreplicante.com/2016/05/15/la-informacion-de-tu-sistema-en-la-terminal-con-neofetch/
|
||||
- https://linuxconfig.org/how-to-display-system-information-with-neofetch
|
||||
- https://www.2daygeek.com/neofetch-display-linux-systems-information-ascii-distribution-logo-terminal/
|
||||
- https://www.cyberciti.biz/howto/neofetch-awesome-system-info-bash-script-for-linux-unix-macos/
|
||||
- https://www.lffl.org/2016/11/neofetch-le-informazioni-sistema-sul-terminale-stile.html
|
||||
- https://www.maketecheasier.com/display-system-information-neofetch-linux/
|
||||
- https://www.omgubuntu.co.uk/2016/11/neofetch-terminal-system-info-app
|
||||
- https://www.omgubuntu.co.uk/2016/12/cli-system-tool-neofetch-2-0-released
|
||||
- https://www.omgubuntu.co.uk/2017/01/neofetch-3-0-released
|
||||
- https://www.ostechnix.com/neofetch-display-linux-systems-information/
|
||||
- https://www.techrepublic.com/article/how-to-get-all-the-information-you-need-about-your-linux-machine-with-a-single-command/
|
||||
- https://www.tecmint.com/neofetch-shows-linux-system-information-with-logo/
|
||||
- https://www.youtube.com/watch?v=bgepGW858fc
|
||||
- https://www.linuxuprising.com/2018/05/display-system-information-on-linux.html
|
||||
|
||||
|
||||
## Thanks
|
||||
|
||||
- [Contributors](https://github.com/dylanaraps/neofetch/contributors)
|
||||
- [Packagers](https://github.com/dylanaraps/neofetch/issues/115)
|
||||
- [Screenfetch](https://github.com/KittyKatt/screenFetch)
|
||||
- [ufetch](https://github.com/jschx/ufetch)
|
||||
|
||||
|
||||
## Donate
|
||||
|
||||
Donations will allow me to spend more time working on `neofetch`.
|
||||
|
||||
If you like `neofetch` and want to give back in some way you can donate here: **https://patreon.com/dyla**
|
||||
|
120
neofetch.1
120
neofetch.1
@@ -1,10 +1,10 @@
|
||||
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.12.
|
||||
.TH NEOFETCH "1" "January 2020" "Neofetch 7.0.0" "User Commands"
|
||||
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
|
||||
.TH NEOFETCH "1" "May 2018" "Neofetch 4.0.3" "User Commands"
|
||||
.SH NAME
|
||||
Neofetch \- A fast, highly customizable system info script
|
||||
.SH SYNOPSIS
|
||||
.B neofetch
|
||||
\fI\,func_name --option "value" --option "value"\/\fR
|
||||
\fI\,--option "value" --option "value"\/\fR
|
||||
.SH DESCRIPTION
|
||||
Neofetch is a CLI system information tool written in BASH. Neofetch
|
||||
displays information about your system next to an image, your OS logo,
|
||||
@@ -14,24 +14,6 @@ NOTE: Every launch flag has a config option.
|
||||
.SH OPTIONS
|
||||
.SS "INFO:"
|
||||
.TP
|
||||
func_name
|
||||
Specify a function name (second part of info() from config) to
|
||||
quickly display only that function's information.
|
||||
.IP
|
||||
Example: neofetch uptime \fB\-\-uptime_shorthand\fR tiny
|
||||
.IP
|
||||
Example: neofetch uptime disk wm memory
|
||||
.IP
|
||||
This can be used in bars and scripts like so:
|
||||
.IP
|
||||
memory="$(neofetch memory)"; memory="${memory##*: }"
|
||||
.IP
|
||||
For multiple outputs at once (each line of info in an array):
|
||||
.IP
|
||||
IFS=$'\en' read \fB\-d\fR "" \fB\-ra\fR info < <(neofetch memory uptime wm)
|
||||
.IP
|
||||
info=("${info[@]##*: }")
|
||||
.TP
|
||||
\fB\-\-disable\fR infoname
|
||||
Allows you to disable an info line from appearing
|
||||
in the output. 'infoname' is the function name from the
|
||||
@@ -40,9 +22,6 @@ For example: 'info "Memory" memory' would be '\-\-disable memory'
|
||||
.IP
|
||||
NOTE: You can supply multiple args. eg. 'neofetch \fB\-\-disable\fR cpu gpu'
|
||||
.TP
|
||||
\fB\-\-package_managers\fR on/off
|
||||
Hide/Show Package Manager names . (on, tiny, off)
|
||||
.TP
|
||||
\fB\-\-os_arch\fR on/off
|
||||
Hide/Show OS architecture.
|
||||
.TP
|
||||
@@ -80,7 +59,7 @@ NOTE: For FreeBSD and NetBSD\-based systems, you need to enable
|
||||
coretemp kernel module. This only supports newer Intel processors.
|
||||
.TP
|
||||
\fB\-\-distro_shorthand\fR on/off
|
||||
Shorten the output of distro (on, tiny, off)
|
||||
Shorten the output of distro (tiny, on, off)
|
||||
.IP
|
||||
NOTE: This option won't work in Windows (Cygwin)
|
||||
.TP
|
||||
@@ -90,7 +69,7 @@ Shorten the output of kernel
|
||||
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 (on, tiny, 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
|
||||
@@ -104,9 +83,6 @@ Which GPU to display. (all, dedicated, integrated)
|
||||
.IP
|
||||
NOTE: This only supports Linux.
|
||||
.TP
|
||||
\fB\-\-de_version\fR on/off
|
||||
Show/Hide Desktop Environment version
|
||||
.TP
|
||||
\fB\-\-gtk_shorthand\fR on/off
|
||||
Shorten output of gtk theme/icons
|
||||
.TP
|
||||
@@ -130,37 +106,32 @@ NOTE: Multiple values can be given. (\fB\-\-disk_show\fR '/' '/dev/sdc1')
|
||||
.TP
|
||||
\fB\-\-disk_subtitle\fR type
|
||||
What information to append to the Disk subtitle.
|
||||
Takes: name, mount, dir, none
|
||||
Takes: name, mount, dir
|
||||
.IP
|
||||
\&'name' shows the disk's name (sda1, sda2, etc)
|
||||
.IP
|
||||
\&'mount' shows the disk's mount point (/, \fI\,/mnt/Local\/\fP Disk, etc)
|
||||
.IP
|
||||
\&'dir' shows the basename of the disks's path. (/, Local Disk, etc)
|
||||
.IP
|
||||
\&'none' shows only 'Disk' or the configured title.
|
||||
.TP
|
||||
\fB\-\-disk_percent\fR on/off
|
||||
Hide/Show disk percent.
|
||||
.TP
|
||||
\fB\-\-ip_host\fR url
|
||||
URL to query for public IP
|
||||
.TP
|
||||
\fB\-\-ip_timeout\fR int
|
||||
Public IP timeout (in seconds).
|
||||
.TP
|
||||
\fB\-\-song_format\fR format
|
||||
Print the song data in a specific format (see config file).
|
||||
.TP
|
||||
\fB\-\-song_shorthand\fR on/off
|
||||
Print the Artist/Album/Title on separate lines.
|
||||
.TP
|
||||
\fB\-\-memory_percent\fR on/off
|
||||
Display memory percentage.
|
||||
.TP
|
||||
\fB\-\-music_player\fR player\-name
|
||||
Manually specify a player to use.
|
||||
Available values are listed in the config file
|
||||
.TP
|
||||
\fB\-\-install_time\fR on/off
|
||||
Enable/Disable showing the time in Install Date output.
|
||||
.TP
|
||||
\fB\-\-install_time_format\fR 12h/24h
|
||||
Set time format in Install Date to be 12 hour or 24 hour.
|
||||
.SS "TEXT FORMATTING:"
|
||||
.TP
|
||||
\fB\-\-colors\fR x x x x x x
|
||||
@@ -175,17 +146,11 @@ Character to use when underlining title
|
||||
.TP
|
||||
\fB\-\-bold\fR on/off
|
||||
Enable/Disable bold text
|
||||
.TP
|
||||
\fB\-\-separator\fR string
|
||||
Changes the default ':' separator to the specified string.
|
||||
.SS "COLOR BLOCKS:"
|
||||
.TP
|
||||
\fB\-\-color_blocks\fR on/off
|
||||
Enable/Disable the color blocks
|
||||
.TP
|
||||
\fB\-\-col_offset\fR auto/num
|
||||
Left\-padding of color blocks
|
||||
.TP
|
||||
\fB\-\-block_width\fR num
|
||||
Width of color blocks in spaces
|
||||
.TP
|
||||
@@ -228,25 +193,20 @@ Possible values: bar, infobar, barinfo, off
|
||||
.TP
|
||||
\fB\-\-backend\fR backend
|
||||
Which image backend to use.
|
||||
Possible values: 'ascii', 'caca', 'chafa', 'jp2a', 'iterm2',
|
||||
\&'off', 'sixel', 'tycat', 'w3m', 'kitty'
|
||||
Possible values: 'ascii', 'caca', 'jp2a', 'iterm2', 'off',
|
||||
\&'sixel', 'tycat', 'w3m'
|
||||
.TP
|
||||
\fB\-\-source\fR source
|
||||
Which image or ascii file to use.
|
||||
Possible values: 'auto', 'ascii', 'wallpaper', '/path/to/img',
|
||||
\&'/path/to/ascii', '/path/to/dir/', 'command output' [ascii]
|
||||
\&'/path/to/ascii', '/path/to/dir/'
|
||||
.TP
|
||||
\fB\-\-ascii\fR source
|
||||
Shortcut to use 'ascii' backend.
|
||||
.IP
|
||||
NEW: neofetch \fB\-\-ascii\fR "$(fortune | cowsay \fB\-W\fR 30)"
|
||||
.TP
|
||||
\fB\-\-caca\fR source
|
||||
Shortcut to use 'caca' backend.
|
||||
.TP
|
||||
\fB\-\-chafa\fR source
|
||||
Shortcut to use 'chafa' backend.
|
||||
.TP
|
||||
\fB\-\-iterm2\fR source
|
||||
Shortcut to use 'iterm2' backend.
|
||||
.TP
|
||||
@@ -283,51 +243,18 @@ Colors to print the ascii art
|
||||
.TP
|
||||
\fB\-\-ascii_distro\fR distro
|
||||
Which Distro's ascii art to print
|
||||
.TP
|
||||
NOTE: AIX, Alpine, Anarchy, Android, Antergos, antiX, AOSC,
|
||||
Apricity, ArcoLinux, ArchBox, ARCHlabs, ArchStrike,
|
||||
XFerience, ArchMerge, Arch, Artix, Arya, Bedrock, Bitrig,
|
||||
BlackArch, BLAG, BlankOn, BlueLight, bonsai, BSD,
|
||||
BunsenLabs, Calculate, Carbs, CentOS, Chakra, ChaletOS,
|
||||
Chapeau, Chrom, Cleanjaro, ClearOS, Clear_Linux, Clover,
|
||||
Condres, Container_Linux, CRUX, Cucumber, Debian, Deepin,
|
||||
DesaOS, Devuan, DracOS, DragonFly, Drauger, Elementary,
|
||||
EndeavourOS, Endless, EuroLinux, Exherbo, Fedora, Feren, FreeBSD,
|
||||
FreeMiNT, Frugalware, Funtoo, GalliumOS, Gentoo, Pentoo,
|
||||
gNewSense, GNU, GoboLinux, Grombyang, Guix, Haiku, Huayra,
|
||||
Hyperbola, janus, Kali, KaOS, KDE_neon, Kibojoe, Kogaion,
|
||||
Korora, KSLinux, Kubuntu, LEDE, LFS, Linux_Lite,
|
||||
LMDE, Lubuntu, Lunar, macos, Mageia, MagpieOS, Mandriva,
|
||||
Manjaro, Maui, Mer, Minix, LinuxMint, MX_Linux, Namib,
|
||||
Neptune, NetBSD, Netrunner, Nitrux, NixOS, Nurunner,
|
||||
NuTyX, OBRevenge, OpenBSD, OpenIndiana, OpenMandriva,
|
||||
OpenWrt, osmc, Oracle, PacBSD, Parabola, Pardus, Parrot,
|
||||
Parsix, TrueOS, PCLinuxOS, Peppermint, popos, Porteus,
|
||||
PostMarketOS, Proxmox, Puppy, PureOS, Qubes, Radix, Raspbian,
|
||||
Reborn_OS, Redstar, Redcore, Redhat, Refracted_Devuan, Regata,
|
||||
Rosa, sabotage, Sabayon, Sailfish, SalentOS, Scientific, Septor,
|
||||
SharkLinux, Siduction, Slackware, SliTaz, SmartOS, Solus,
|
||||
Source_Mage, Sparky, Star, SteamOS, SunOS, openSUSE_Leap,
|
||||
openSUSE_Tumbleweed, openSUSE, SwagArch, Tails, Trisquel,
|
||||
Ubuntu\-Budgie, Ubuntu\-GNOME, Ubuntu\-MATE, Ubuntu\-Studio, Ubuntu,
|
||||
Void, Obarun, windows10, Windows7, Xubuntu, Zorin, and IRIX
|
||||
have ascii logos
|
||||
.IP
|
||||
NOTE: Arch, Ubuntu, Redhat, and Dragonfly have 'old' logo variants.
|
||||
NOTE: Arch and Ubuntu have 'old' logo variants.
|
||||
.IP
|
||||
NOTE: Use '{distro name}_old' to use the old logos.
|
||||
NOTE: Use 'arch_old' or 'ubuntu_old' to use the old logos.
|
||||
.IP
|
||||
NOTE: Ubuntu has flavor variants.
|
||||
.TP
|
||||
NOTE: Change this to Lubuntu, Kubuntu, Xubuntu, Ubuntu\-GNOME,
|
||||
Ubuntu\-Studio, Ubuntu\-Mate or Ubuntu\-Budgie to use the flavors.
|
||||
NOTE: Change this to 'Lubuntu', 'Xubuntu', 'Ubuntu\-GNOME',
|
||||
\&'Ubuntu\-Studio' or 'Ubuntu\-Budgie' to use the flavors.
|
||||
.TP
|
||||
NOTE: Arcolinux, Dragonfly, Fedora, Alpine, Arch, Ubuntu,
|
||||
CRUX, Debian, Gentoo, FreeBSD, Mac, NixOS, OpenBSD, android,
|
||||
Antrix, CentOS, Cleanjaro, ElementaryOS, GUIX, Hyperbola,
|
||||
Manjaro, MXLinux, NetBSD, Parabola, POP_OS, PureOS,
|
||||
Slackware, SunOS, LinuxLite, OpenSUSE, Raspbian,
|
||||
postmarketOS, and Void have a smaller logo variant.
|
||||
NOTE: Alpine, Arch, CRUX, Debian, Gentoo, FreeBSD, Mac, NixOS,
|
||||
OpenBSD, and Void have a smaller logo variant.
|
||||
.IP
|
||||
NOTE: Use '{distro name}_small' to use the small variants.
|
||||
.TP
|
||||
@@ -336,6 +263,8 @@ 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\-\-loop\fR
|
||||
@@ -383,9 +312,6 @@ Specify a path to a custom config file
|
||||
\fB\-\-config\fR none
|
||||
Launch the script without a config file
|
||||
.TP
|
||||
\fB\-\-no_config\fR
|
||||
Don't create the user config file.
|
||||
.TP
|
||||
\fB\-\-print_config\fR
|
||||
Print the default config file to stdout.
|
||||
.TP
|
||||
|
Reference in New Issue
Block a user