pfetch/README.md

59 lines
1.1 KiB
Markdown
Raw Normal View History

2019-09-24 09:33:23 +02:00
# pfetch
A pretty system information tool written in POSIX `sh`.
2019-09-24 12:07:10 +02:00
```sh
➜ pfetch
___ goldie@KISS
(.· | os KISS Linux
(<> | host Lenovo YOGA 900-13ISK
/ __ \ kernel 5.3.1-coffee
( / \ /| uptime 6h 20m
_/\ __)/_) pkgs 130
\/-____\/ memory 1721MiB / 7942MiB
```
2019-09-24 12:43:18 +02:00
2019-09-24 13:50:14 +02:00
## Configuration
`pfetch` is configured through environment variables.
```sh
# Which information to display.
# NOTE: If 'ascii' will be used, it must come first.
# Valid: space separated string
PF_INFO="ascii title distro host kernel uptime pkgs memory"
# Example: Only ASCII.
PF_INFO="ascii"
# Example: Only Information.
PF_INFO="title distro host kernel uptime pkgs memory"
# Separator between info name and info data.
# Valid: string
PF_SEP=":"
# Color of info names:
# Valid: 0-9
PF_COL1=4
# Color of info data:
# Valid: 0-9
PF_COL2=7
# Alignment padding.
# Valid: int
PF_ALIGN=""
```
2019-09-24 12:43:18 +02:00
## TODO
2019-09-24 13:41:47 +02:00
- [x] Store ascii "width" for dynamic padding.
2019-09-24 12:43:18 +02:00
- [ ] OS support.
- [x] Linux
- [ ] OpenBSD
- [ ] FreeBSD
- [ ] macOS
- [ ] ???????
2019-09-24 13:41:47 +02:00
- [x] Add an environment variable for setting info.