updated README.md

This commit is contained in:
Emma Tebibyte 2022-09-07 22:06:14 -04:00
parent ffcf3ad4b0
commit e11e73d8a6
1 changed files with 25 additions and 6 deletions

View File

@ -1,9 +1,28 @@
# xdg-sanity
This script is built to replace your default web browser in your desktop/XDG
settings. It intercepts http/s URIs sent to the default browser by XDG settings
and sends it to the appropriate application. For example, it will send
image/jpeg MIME type files to your image viewer.
The `xdg-sanity` script is built to replace your default web browser in your
desktop/XDG settings. It intercepts http/s URIs sent to the default browser by
`xdg-open` and sends it to the appropriate application. For example, it will
send image/jpeg MIME type files to your image viewer.
Add your default web browser to `/etc/xdg-sanity.conf` so the script can forward
links to it.
## Installation
### Arch
I maintain a package [on the
AUR](https://aur.archlinux.org/packages/xdg-sanity).
### From Source
First, make sure you have `curl(1)` and `handlr` installed. Then, clone this
repository and move the `xdg-sanity/` folder into `/etc` and `xdg-sanity.sh` to
`xdg-sanity` wherever your operating system stores locally-installed binaries.
This is usually `/usr/local/bin`.
Then, create a `xdg-sanity.desktop` file either manually or with `gendesk(1)`,
placing it, also, where your OS stores locally-installed `.desktop` files,
usually `/usr/local/applications`. Set your default web browser to be that
`.desktop` file.
Now, add your default web browser to `/etc/xdg-sanity/xdg-sanity.conf` so the
script can forward links to it.