Add (un)installation scripts.

README.md

@@ -1,8 +1,8 @@
 # DBus Prettifier
 
-I noticed that when working with `qdbus` that I would get long and unformatted
+I noticed when working with `qdbus` that I would get long and unformatted
-outputs that are extremely difficult to read. This small program will prettify a
+outputs that are extremely difficult to read. This small program will prettify
-file with the output so that it is much  more readable.
+a file with the output so that it is much more readable.
 
 ## Usage
 
@@ -12,18 +12,29 @@ To run the program, simply run it as follows:
 qdbus-prettifier <in-file> [out-file]
 ```
 
-## Building
+If `<in-file>` is defined as `-` this tells the program to read from `stdin`
+allowing input to be piped. If the `[out-file]` option is omitted then output is
+sent to `stdout`.
+
+For more information, check out the `-h` option.
+
+## Building & Installation
 
 To compile the program, install the Rust suite, namely the compiler and Cargo.
 Once installed you can run `cargo build --release` to generate a release build
 of the project which will be found at `target/release/dbus-prettifier`.
 
-To install you can use the `install` command as follows:
+To install the program you can use the `install` script. By default this will
+install to `/usr/local`, but this can be changed by setting the `PREFIX`
+variable prior to the command. For example:
 
 ```console
-install -Dm755 target/release/dbus-prettifier /usr/local/bin
+PREFIX=/usr ./install
 ```
 
+Similarly, to uninstall simply run the `uninstall` script. It uses the same
+`PREFIX` variable.
+
 ## License
 
 This program is licensed under the terms & conditions of the [Zlib

dbus-prettifier.1

@@ -0,0 +1,37 @@
+.TH dbus-prettifier "1" "October 2025" "dbus-prettifier 1.2.0" "User Commands"
+.SH "NAME"
+dbus-prettifier - A tool to prettify the output of qdbus.
+.SH "SYNOPSIS"
+.B dbus-prettifier
+<\fIin-file\fR> [\fIout-file\fR]
+
+.B dbus-prettifier
+\fI-h\fR | \fI-v\fR
+
+.SH "DESCRIPTION"
+Takes input from qdbus (either stored in a file or from \fIstdin\fR) and stores
+it in the provided \fIout-file\fR.
+
+.SH "ARGUMENTS"
+.TP
+\fBin-file\fR
+File containing qdbus output (if \fI-\fR then input is from \fIstdin\fR)
+.TP
+\fBout-file\fR
+File to write formatted output to (if omitted then \fIstdout\fR is used)
+.TP
+\fB\-h\fR
+Show help information
+.TP
+\fB\-v\fR
+Show version information
+
+.SH "AUTHOR"
+Written by Nicolás A. Ortega Froysa.
+
+.SH "COPYRIGHT"
+Copyright \(co 2024 Ortega Froysa, Nicolás A. <nicolas@ortegas.org>.
+License: ZLib License.
+
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.

install

@@ -0,0 +1,17 @@
+#!/bin/bash
+set -euo pipefail
+
+PREFIX=${PREFIX:="/usr/local"}
+
+if ! [ -f "./target/release/dbus-prettifier" ]
+then
+	>&2 echo "Failed to find release target. Please compile the project with 'cargo build --release'."
+	exit 1
+fi
+
+gzip -k ./dbus-prettifier.1
+
+install -Dm644 ./dbus-prettifier.1.gz "$PREFIX/share/man/man1/"
+install -Dm755 ./target/release/dbus-prettifier "$PREFIX/bin/"
+
+rm -f ./dbus-prettifier.1.gz

uninstall

@@ -0,0 +1,13 @@
+#!/bin/bash
+set -euo pipefail
+
+PREFIX=${PREFIX:="/usr/local"}
+
+if ! [ -f "$PREFIX/bin/dbus-prettifier" ]
+then
+	>&2 echo "Installation not found in prefix '$PREFIX'."
+	exit 1
+fi
+
+rm -f "$PREFIX/bin/dbus-prettifier"
+rm -f "$PREFIX/share/man/man1/dbus-prettifier.1.gz"