From e11e73d8a60a01a941fcf1ed7149ccb9ffefd701 Mon Sep 17 00:00:00 2001 From: emma Date: Wed, 7 Sep 2022 22:06:14 -0400 Subject: [PATCH 1/2] updated README.md --- README.md | 31 +++++++++++++++++++++++++------ 1 file changed, 25 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2c169c0..e71c2c8 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file +## 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. \ No newline at end of file From a10f4a3ceb6f3e3bb0cdd7d74a811bfd6d5d7490 Mon Sep 17 00:00:00 2001 From: emma Date: Wed, 21 Sep 2022 22:03:02 -0400 Subject: [PATCH 2/2] added more readme info --- README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e71c2c8..80f87be 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ 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. +send `image/jpeg` MIME type files to your image viewer. ## Installation @@ -14,15 +14,21 @@ AUR](https://aur.archlinux.org/packages/xdg-sanity). ### From Source -First, make sure you have `curl(1)` and `handlr` installed. Then, clone this +First, make sure you have `curl(1)` and `handlr(1)` 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`. +This is usually `/usr/local/bin`. Make sure the installation location is in your +`$PATH`. -Then, create a `xdg-sanity.desktop` file either manually or with `gendesk(1)`, +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 +usually `/usr/local/applications`. Set your default web browser to that `.desktop` file. -Now, add your default web browser to `/etc/xdg-sanity/xdg-sanity.conf` so the -script can forward links to it. \ No newline at end of file +Add your default web browser to `/etc/xdg-sanity/xdg-sanity.conf` so the +script can forward links to it. + +### Usage + +Open links from applications outside your web browser as normal. Alternatively, +you can call `xdg-sanity` directly with the only argument accepted being a URI. \ No newline at end of file