From 6907b31ddf09b55f7e8fa499693f59c15c348231 Mon Sep 17 00:00:00 2001
From: "Douglas Cerna (Soy Douglas)" <douglascerna@yahoo.com>
Date: Thu, 7 Dec 2023 16:01:03 +0100
Subject: [PATCH] Lint docs fixity

---
 docs/fixity.1.md | 27 +++++++++++++--------------
 1 file changed, 13 insertions(+), 14 deletions(-)

diff --git a/docs/fixity.1.md b/docs/fixity.1.md
index 56f8230..cfccb8b 100644
--- a/docs/fixity.1.md
+++ b/docs/fixity.1.md
@@ -1,5 +1,4 @@
-fixity(1) -- Check fixity for AIPs
-==================================
+# fixity(1) -- Check fixity for AIPs
 
 ## SYNOPSIS
 
@@ -24,28 +23,28 @@ running; see the section on _ENVIRONMENT VARIABLES_ for information.
 
 ## OPTIONS
 
-  * `--throttle` <seconds>:
+* `--throttle <seconds>`:
     Time (in seconds) to wait when scanning multiple AIPs. This can help reduce
     extended disk load on the Storage Service filesystem on which the AIPs
     reside.
 
-  * `--force-local`:
+* `--force-local`:
     Request the Storage Service performs a local fixity check, instead of using
     the Space's fixity (this is only available for Arkivum Spaces).
 
-  * `--debug`:
+* `--debug`:
     Print extra debugging output.
 
 ## COMMANDS
 
-  * `scan` <UUID>:
+* `scan <UUID>`:
     Run a fixity scan on a single AIP, using the specified UUID. If the UUID is
     malformed, or the Storage Service does not have an AIP with the specified
     UUID, this will produce an error and exit 1. After the scan completes, a
     brief report will be printed with information on whether the scan succeeded
     or failed.
 
-  * `scanall`:
+* `scanall`:
     Run a fixity scan on every AIP registered with the target Storage Service
     instance. This command does not take any arguments. A brief report will be
     printed after every AIP is scanned.
@@ -58,26 +57,26 @@ running; see the section on _ENVIRONMENT VARIABLES_ for information.
 The following environment variables **must** be exported in the environment for
 fixity to operate.
 
-  * **STORAGE_SERVICE_URL**:
+* **STORAGE_SERVICE_URL**:
     The base URL to the storage service instance to scan. Must include the port
     number for non port 80 installations. Example:
-      http://localhost:8000/
+      <http://localhost:8000/>
 
-  * **STORAGE_SERVICE_USER**:
+* **STORAGE_SERVICE_USER**:
     Username for API authentication with the storage service. Example:
       test
 
-  * **STORAGE_SERVICE_KEY**:
+* **STORAGE_SERVICE_KEY**:
     API key for API authentication with the storage service. Example:
       dfe83300db5f05f63157f772820bb028bd4d0e27
 
-  * **REPORT_URL**:
+* **REPORT_URL**:
     The base URL to the remote service to which scan reports will be POSTed.
 
-  * **REPORT_USERNAME**:
+* **REPORT_USERNAME**:
     Username for API authentication with the reporting service. Not all
     reporting services require API authentication; leave this unset if API
     access is unauthenticated.
 
-  * **REPORT_PASSWORD**:
+* **REPORT_PASSWORD**:
     Password for API authentication with the reporting service; see above.