(feat) pathdmt readme setup guide prepared

This commit is contained in:
Shubham Tiwary 2025-03-13 00:47:11 +05:30 committed by GitHub
parent 2904446b50
commit d089dfb841
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -0,0 +1,30 @@
## Pathfmt plugin
This plugin adds current path information (ex: `~/Downloads/images/...`) into your terminal.
To use it, add `pathfmt` to the plugins array of your zshrc file:
```
plugins=(... pathfmt ...)
```
### Configuration (required)
Add these into your zshrc file:
```
#options = absolute/user/host
PATHFMT_MODE="user"
RPROMPT='$(path_format)'
```
<br>
### Things to Note:
`PATHFMT_MODE` has three modes:
```
1. absolute - full path (from /).
2. user - path from $USER/<path>
3. host - user@machine/<path>
```
Requires [`inetutils`]([url](https://launchpad.net/ubuntu/+source/inetutils)) for the host mode
> may show: user@unknown when not found & in host mode