From: Alexander Barton <alex@barton.de>
Date: Wed, 1 Nov 2023 19:46:47 +0000 (+0100)
Subject: README.md: Add a prerequisites and a hints section
X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a8fa92f5b2882c57838bebf84a570da83da984a1;p=pdfman.git

README.md: Add a prerequisites and a hints section
---

diff --git a/README.md b/README.md
index f37cbaf..f40f599 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,18 @@ can make use of your preferred PDF file viewer and all of its functionality.
 The conversion is only done once and a cached PDF file gets used for subsequent
 invocations for the same topic.
 
+## Prerequisites
+
+The `pdfman` script makes use of the following tools, which need to be available
+on the local system in the default search `$PATH`:
+
+- `open`(1)
+- Either `ps2pdf`(1) of the Ghostscript suite _or_ `pstopdf`(1) which was
+  included in Apple macOS up to version 13 "Ventura".
+
+Note: `pdfman` silently falls back to "normal" `man`(1) behavior if any of the
+required tools is _not_ found.
+
 ## Usage
 
 ```bash
@@ -16,3 +28,15 @@ pdfman [-v] [-T] [<section>] <topic> ...
 pdfman <man(1) options> <arguments> ...
 pdfman {--help|--version>}
 ```
+
+- `-v`: Enable verbose output.
+- `-T`: Force regular `man`(1) behavior, don't use PDF files.
+
+### Hint
+
+You can setup an alias from `man` to `pdfman` in your shell startup files to not
+forget to use it :-)
+
+```bash
+alias man=pdfman
+```