fastfetch/README.md

117 lines
7.5 KiB
Markdown
Raw Normal View History

2022-08-28 17:39:01 +02:00
# <center> Fastfetch </center>
2021-03-07 13:12:45 +01:00
2022-09-04 18:07:15 +02:00
Fastfetch is a [neofetch](https://github.com/dylanaraps/neofetch)-like tool for fetching system information and displaying them in a pretty way. It is written in pure c, with performance and customizability in mind. Currently Linux, Android and MacOS are supported.
2022-08-28 17:39:01 +02:00
2022-08-28 18:34:54 +02:00
<img src="screenshots/example1.png" width="49%" align="left" />
<img src="https://upload.wikimedia.org/wikipedia/commons/2/24/Transparent_Square_Tiles_Texture.png" width="49%" height="16px" align="left" />
<img src="screenshots/example4.png" width="49%" align="left" />
2022-08-29 09:24:03 +02:00
<img src="https://upload.wikimedia.org/wikipedia/commons/2/24/Transparent_Square_Tiles_Texture.png" width="49%" height="16px" align="left" />
2022-08-28 18:42:53 +02:00
<img src="screenshots/example2.png" width="48%" align="top" />
<img src="screenshots/example3.png" width="48%" align="top" />
2022-08-28 18:34:54 +02:00
<img src="screenshots/example5.png" height="15%" align="top" />
2021-03-07 13:12:45 +01:00
## Customization
2021-05-19 20:08:29 +02:00
With customization and speed being two competing goals, this project actually builds two executables.
The main one being `fastfetch`, which can be very greatly configured via flags. These flags can be made persistent in `~/.config/fastfetch/config.conf`. To view the available options run `fastfetch --help`.
2022-04-12 18:34:40 -05:00
The second executable being built is called `flashfetch`, which is configured at compile time to eliminate any possible overhead. Configuration of it can be very easily done in [`src/flashfetch.c`](src/flashfetch.c).
2021-05-19 20:08:29 +02:00
At the moment the performance difference is measurable, but too small to be human recognizable. But the leap will get bigger with more and more options coming, and on slow machines this might actually make a difference.
2022-08-28 17:39:01 +02:00
There are some premade config files in [`presets`](presets), including the ones used for the screenshots above. You can load them using `--load-config <filename>`. They may also serve as a good example for format arguments.
2021-03-07 13:12:45 +01:00
## Dependencies
2022-01-23 12:02:26 +01:00
Fastfetch dynamically loads needed libraries if they are available. Therefore its only hard dependencies are `libc` (any implementation of the c standard library), `libdl` and `libpthread`. They are all shipped with [`glibc`](https://www.gnu.org/software/libc/), which is already installed on most linux distributions, so you probably don't have to worry about it.
2022-01-23 12:00:28 +01:00
The following libraries are used if present at runtime:
2022-06-05 00:18:40 +02:00
* [`libpci`](https://github.com/pciutils/pciutils): GPU output.
* [`libvulkan`](https://www.vulkan.org/): Vulkan module & fallback for GPU output.
* [`libxcb-randr`](https://xcb.freedesktop.org/),
2022-06-04 19:30:26 +02:00
[`libXrandr`](https://gitlab.freedesktop.org/xorg/lib/libxrandr),
[`libxcb`](https://xcb.freedesktop.org/),
2022-06-05 00:18:40 +02:00
[`libX11`](https://gitlab.freedesktop.org/xorg/lib/libx11): At least one of them sould be present in X11 sessions for better resolution detection and faster WM detection. The `*randr` ones provide multi monitor support The `libxcb*` ones usually have better performance.
* [`libwayland-client`](https://wayland.freedesktop.org/): Better resolution performance and output in wayland sessions. Supports different refresh rates per monitor.
* [`libGIO`](https://developer.gnome.org/gio/unstable/): Needed for values that are only stored GSettings.
* [`libDConf`](https://developer.gnome.org/dconf/unstable/): Needed for values that are only stored in DConf + Fallback for GSettings.
* [`libmagickcore` (ImageMagick)](https://www.imagemagick.org/): Images in terminal using sixel or kitty graphics protocol.
* [`libchafa`](https://github.com/hpjansson/chafa): Image output as ascii art.
* [`libZ`](https://www.zlib.net/): Faster image output when using kitty graphics protocol.
* [`libDBus`](https://www.freedesktop.org/wiki/Software/dbus): Needed for detecting current media player and song.
* [`libEGL`](https://www.khronos.org/registry/EGL/),
2022-06-04 19:30:26 +02:00
[`libGLX`](https://dri.freedesktop.org/wiki/GLX/),
[`libOSMesa`](https://docs.mesa3d.org/osmesa.html): At least one of them is needed by the OpenGL module for gl context creation.
2022-06-05 00:18:40 +02:00
* [`libOpenCL`](https://www.khronos.org/opencl/): OpenCL module
* [`libXFConf`](https://gitlab.xfce.org/xfce/xfconf): Needed for XFWM theme and XFCE Terminal font.
* [`libsqlite3`](https://www.sqlite.org/index.html): Needed for rpm package count.
* [`librpm`](http://rpm.org/): Slower fallback for rpm package count. Needed on openSUSE.
* [`libplist`](https://github.com/libimobiledevice/libplist): Binary `plist` file parser. Needed for iTerm2 Terminal font.
2021-03-07 13:12:45 +01:00
2021-04-25 16:16:40 +02:00
## Support status
All categories not listed here should work without needing a specific implementation.
2022-02-25 13:30:37 +01:00
##### Available Modules
2022-02-13 23:51:13 +01:00
```
2022-09-08 14:51:31 +02:00
Title, Separator, OS, Host, Kernel, Uptime, Processes, Packages, Shell, Resolution, DE, WM, WMTheme, Theme, Icons, Font, Cursor, Terminal, Terminal Font, CPU, CPUUsage, GPU, Memory, Swap, Disk, Battery, Player, Media, Vulkan, OpenGL, OpenCL, LocalIP, PublicIP, DateTime, Date, Time, Locale, Colors, Break, Custom
2022-02-13 23:51:13 +01:00
```
2021-06-14 14:57:45 +05:30
##### Logos
2021-04-25 16:16:40 +02:00
```
2022-09-11 21:10:32 +02:00
AlmaLinux, Alpine, Android, Arch, Arco, Artix, Bedrock, CachyOS, CentOS, Debian, Devuan, Deepin, Endeavour, Fedora, Garuda, Gentoo, KDE Neon, KISS, Kubuntu, LangitKetujuh, Linux, MacOS, Manjaro, Mint, MSYS2, NixOS, OpenSUSE, OpenSUSE Tumbleweed, OpenSUSE LEAP, Pop!_OS, RebornOS, RedstarOS, Rocky, Rosa, Slackware, Ubuntu, Void, Zorin
2021-04-25 16:16:40 +02:00
```
2021-11-12 01:39:21 +01:00
* Most of the logos have a small variant. Access it by appending _small to the logo name.
* Some logos have an old variant. Access it by appending _old to the logo name.
2022-03-09 17:39:36 +01:00
* Unknown/unsupported logos will be replaced with a generic linux logo when running fastfetch.
2021-11-12 01:39:21 +01:00
* Get a list of all available logos with `fastfetch --print-logos`.
2022-04-22 15:51:54 +02:00
* Printing images as logo is supported using Sixel or Kitty graphics protocol.
2021-05-08 18:35:51 +02:00
2021-06-14 14:57:45 +05:30
##### Package managers
2021-04-25 16:16:40 +02:00
```
Pacman, dpkg, rpm, emerge, xbps, nix, Flatpak, Snap, apk, brew, MacPorts
2021-04-25 16:16:40 +02:00
```
2021-06-14 14:57:45 +05:30
##### WM themes
2021-04-25 16:16:40 +02:00
```
2021-05-14 12:47:12 +02:00
KWin, Mutter, Muffin, Marco, XFWM, Openbox (LXDE, LXQT & without DE)
2021-04-25 16:16:40 +02:00
```
2021-06-14 14:57:45 +05:30
##### DE versions
2021-05-14 12:47:12 +02:00
```
2021-05-17 07:52:16 +02:00
KDE Plasma, Gnome, Cinnamon, Mate, XFCE4, LXQt
2021-05-14 12:47:12 +02:00
```
2021-06-14 14:57:45 +05:30
##### Terminal fonts
2021-04-25 16:16:40 +02:00
```
2022-07-12 16:49:39 +02:00
konsole, gnome-terminal-server, tilix, xfce4-terminal, alacritty, lxterminal, TTY
2021-04-25 16:16:40 +02:00
```
2021-03-07 13:12:45 +01:00
## Building
2022-01-23 12:07:49 +01:00
fastfetch uses [`cmake`](https://cmake.org/) and [`pkg-config`](https://www.freedesktop.org/wiki/Software/pkg-config/) for building. The simplest steps to build the fastfetch and flashfetch binaries are:
```bash
2021-07-06 21:25:12 +02:00
mkdir -p build
cd build
cmake ..
2022-06-08 12:07:06 +02:00
cmake --build . --target fastfetch --target flashfetch
```
2022-01-23 12:00:28 +01:00
If pkg-config fails to find the headers for a library listed in [dependencies](#dependencies), fastfetch will simply build without support for that specific feature. This means, it won't look for it at runtime and just act like it isn't available.
2021-06-08 20:01:29 +02:00
2021-03-07 13:12:45 +01:00
## Packaging
2022-06-08 12:11:00 +02:00
### Repositories
[![Packaging status](https://repology.org/badge/vertical-allrepos/fastfetch.svg?header=)](https://repology.org/project/fastfetch/versions)
2022-06-08 12:07:06 +02:00
### Manual
* DEB / RPM package: `cmake --build . --target package`
* Install directly: `cmake --install . --prefix /usr/local`
2021-03-07 13:12:45 +01:00
## FAQ
Q: Why do you need a very performant version of neofetch?
> I like putting neofetch in my ~/.bashrc to have a system overwiew whenever i use the terminal, but the slow speed annoyed me, so i created this. Also neofetch didn't output everything correctly (e.g Font is displayed as "[Plasma], Noto Sans, 10 [GTK2/3]") and writing my own tool gave me the possibility to fine tune it to run perfectly on at least my configuration.
Q: It does not display [*] correctly for me, what can i do?
> This is most likely because your system is not implemented (yet). At the moment i am focusing more on making the core app better, than adding more configurations. Feel free to open a pull request if you want to add support for your configuration