Update docs

This commit is contained in:
Dylan Araps 2016-11-01 17:57:08 +11:00
parent 4e2bfe531c
commit a37a3eec31
3 changed files with 2 additions and 155 deletions

View file

@ -1,173 +1,20 @@
## Contributors ## Contributors
- **[@konimex](https://github.com/konimex)**
- **[@iandrewt](https://github.com/iandrewt)**
- **[@coypoop](https://github.com/coypoop)**
- **[@ncmprhnsbl](https://github.com/ncmprhnsbl)**
- **[@koreacomputercenter](https://github.com/koreacomputercenter)**
## General ## General
- Added new function called `checkoldflags` which informs users about deprecated config options.
- Change all `OS X` references to `macOS`. **[@iandrewt](https://github.com/iandrewt)**
- Fix corrupted text when long lines are cut-off.
- Don't dynamically place prompt in `image=off` mode.
- Cursor Position: Fix issues when using URxvt+Padding
## Operating System ## Operating System
![android](https://u.teknik.io/4XdJy.png)
- Added support for Android.
- Dependencies:
- Required: `bash` and `busybox`
- Note: I recommend installing `termux` from the Play Store or F-Droid. Termux provides you with a fully working Linux environment, doesn't require root acess and includes all dependencies.
- Added support for Bitrig. **[@konimex](https://github.com/konimex)**
- Added support for Sparky Linux.
- Added support for Porteus. **[@ncmprhnsbl](https://github.com/ncmprhnsbl)**
- Added support for Red Star OS. **[@koreacomputercenter](https://github.com/koreacomputercenter)**
## Packages ## Packages
- Neofetch is now in Gentoo's official repos.
## Images ## Images
**Fixed rendering issues in URxvt when using an XFT font.**
![scrot](https://i.sli.mg/6qp9Cg.png)
This was first thought to be an issue between URxvt and W3m-img and I apologize for immediately closing bug reports and dismissing comments about this.
I spent yesterday trying to fix this issue and found out that launching neofetch with `--bold off`
reduced the rendering problems. I did more digging and found out that removing all text formatting fixes the issue entirely. I later found out that adding a single unformatted character before the formatted text fixed the issue while keeping the formatting the same.
I opened up this PR https://github.com/dylanaraps/neofetch/pull/358 which added options to enable a border between the image and the text to fix the issue. **[@konimex](https://github.com/konimex)** later commented informing me that we could just use a `zero-width space` to fix the issue and that we didn't need a new function/args/ugly border. doh
The final fix was as simple as adding a zero-width space before the info, here's the commit.
https://github.com/dylanaraps/neofetch/commit/3e9c3d648cb4c6f0d5fe5f0b96f9e29429af39d9
**Removed hard dependency on `\033[14t`**
Neofetch no longer requires a terminal emulator that supports `\033[14t` this means that neofetch now works in Konsole. Instead of using the escape sequence users now have three options for getting the terminal size in pixels.
- `xdotool`
- `xwininfo` + `xprop`
- `xwininfo` + `xdpyinfo`
Neofetch will detect whatever combination you have insalled and use these programs.
Note: `\033[14t` is still supported, if images already work for you then you don't have to install anything else.
- [w3m-img] Draw the image twice to fix rendering issues in Konsole.
- [w3m-img] Fix cursor position when using `yoffset`.
- [w3m-img] Add `-bg` support with the new option `--bg_color`.
- `neofetch --bg_color blue` will make the background behind the image blue.
- Note: The background color is only visible behind transparent parts of the image.
- If the terminal width is found as `0`, fallback to ascii mode.
## Ascii ## Ascii
- Bold ascii art by default.
- Fixed incorrect prompt location when using `ascii_logo_size small`.
- Fixed incorrect colors used on light terminals.
- Update Void Linux ascii art. **[@ncmprhnsbl](https://github.com/ncmprhnsbl)**
- Update Solus ascii art.
## Info ## Info
**Distro**<br \>
- Expanded `distro_shorthand` to macOS, BSD and Solaris. **[@konimex](https://github.com/konimex)**
- Removed `osx_buildversion` and `osx_codename` in favour of `distro_shorthand`. **[@konimex](https://github.com/konimex)**
**Desktop Environment**<br \>
- [Windows] Added support for showing DE.
- Windows 8 and above: `Modern UI/Metro`
- Windows 7 and below: `Aero`
**Window Manager**<br \>
- [Windows] Added support for custom WMs/Shells.
- Neofetch now detects `blackbox`, `bugn`, `Windawesome`, `emerge` and `litestep`.
**Window Manager Theme**<br \>
- [Windows] Added support for Blackbox themes.
**CPU**<br \>
- Added `cpu_speed` which lets you hide/show the speed in the output.
- Expanded `cpu_cores` option by adding two new values, `logical` and `physical`.
- `logical`: Show all virtual cores (hyperthreaded).
- `physical`: Only show physical cores.
- [Linux] Added support for showing CPU temperature.
- Added new option called `cpu_temp`.
- Note: This is disabled by default and can be enabled by changing the value of `cpu_temp` in your config to `on`.
- [macOS] Print physical cores instead of hyper-threaded cores. **[@iandrewt](https://github.com/iandrewt)**
- [iOS] Rewrite CPU function.
**GPU**
- [iOS] Rewrite GPU function.
- [Linux] Rewrite GPU function.
- Neofetch also caches the info until reboot.
**Uptime**<br \>
- Rewrote uptime function to use seconds since boot instead of the `uptime` command.
- Every OS/Distro now has the pretty `uptime -p` output!
- Remove `up` from output.
**Resolution**<br \>
- [macOS] Add @2x label for retina resolutions. **[@iandrewt](https://github.com/iandrewt)**
**Memory**<br \>
- [Linux] Correctly calculate used memory.
- The output should now match `conky`, `htop` and etc.
- Source: https://github.com/KittyKatt/screenFetch/issues/386#issuecomment-249312716
- [NetBSD] Fix memory output for sizes over 4GB. **[@coypoop](https://github.com/coypoop)**
**Shell**<br \>
- Hide shell path by default.
- Show shell version by default.
**Battery**<br \>
- [Linux] Rewrote and simplified battery function.
- Removed `battery_shorthand`
- Removed `battery_num`
**Theme Font**<br \>
- [XFCE] Fixed incorrect font output.
**Color Blocks**<br \>
- Fixed `block_width` not working.
- Fixed `% s` appearing in color blocks when neofetch is run from `tty`
- Fixed `block_width` being off by one. A value of `2` made the blocks `3` wide instead of `2` wide.
**Terminal and Terminal Font**<br \>
- [Linux] Use `/proc/$PPID/comm` instead of parsing `ps`.
- Uppercase first letter of `termfont` output.
- Don't print broken output of busybox's `ps`.
- Remove path from output.
**Song**<br \>
- [macOS] Fix iTunes automatically opening. **[@iandrewt](https://github.com/iandrewt)**
- Added support for Audacious. **[@ncmprhnsbl](https://github.com/ncmprhnsbl)**
- Rewrote song function, it's now much faster/cleaner.

View file

@ -3204,7 +3204,7 @@ getargs() {
-v) verbose="on" ;; -v) verbose="on" ;;
-vv) set -x; verbose="on" ;; -vv) set -x; verbose="on" ;;
--help) usage ;; --help) usage ;;
--version) printf "%s\n" "Neofetch 1.9"; exit ;; --version) printf "%s\n" "Neofetch 2.0"; exit ;;
esac esac
shift shift

View file

@ -1,4 +1,4 @@
.TH NEOFETCH "1" "June 2016" "1.8" "User Commands" .TH NEOFETCH "1" "June 2016" "2.0" "User Commands"
.SH NAME .SH NAME
neofetch \- simple system information script neofetch \- simple system information script