Skip to content

Commit 8ac2c18

Browse files
committed
Lint docs fixity
1 parent d500f7c commit 8ac2c18

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

docs/fixity.1.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
fixity(1) -- Check fixity for AIPs
2-
==================================
1+
# fixity(1) -- Check fixity for AIPs
32

43
## SYNOPSIS
54

@@ -24,28 +23,28 @@ running; see the section on _ENVIRONMENT VARIABLES_ for information.
2423

2524
## OPTIONS
2625

27-
* `--throttle` <seconds>:
26+
* `--throttle <seconds>`:
2827
Time (in seconds) to wait when scanning multiple AIPs. This can help reduce
2928
extended disk load on the Storage Service filesystem on which the AIPs
3029
reside.
3130

32-
* `--force-local`:
31+
* `--force-local`:
3332
Request the Storage Service performs a local fixity check, instead of using
3433
the Space's fixity (this is only available for Arkivum Spaces).
3534

36-
* `--debug`:
35+
* `--debug`:
3736
Print extra debugging output.
3837

3938
## COMMANDS
4039

41-
* `scan` <UUID>:
40+
* `scan <UUID>`:
4241
Run a fixity scan on a single AIP, using the specified UUID. If the UUID is
4342
malformed, or the Storage Service does not have an AIP with the specified
4443
UUID, this will produce an error and exit 1. After the scan completes, a
4544
brief report will be printed with information on whether the scan succeeded
4645
or failed.
4746

48-
* `scanall`:
47+
* `scanall`:
4948
Run a fixity scan on every AIP registered with the target Storage Service
5049
instance. This command does not take any arguments. A brief report will be
5150
printed after every AIP is scanned.
@@ -58,26 +57,26 @@ running; see the section on _ENVIRONMENT VARIABLES_ for information.
5857
The following environment variables **must** be exported in the environment for
5958
fixity to operate.
6059

61-
* **STORAGE_SERVICE_URL**:
60+
* **STORAGE_SERVICE_URL**:
6261
The base URL to the storage service instance to scan. Must include the port
6362
number for non port 80 installations. Example:
64-
http://localhost:8000/
63+
<http://localhost:8000/>
6564

66-
* **STORAGE_SERVICE_USER**:
65+
* **STORAGE_SERVICE_USER**:
6766
Username for API authentication with the storage service. Example:
6867
test
6968

70-
* **STORAGE_SERVICE_KEY**:
69+
* **STORAGE_SERVICE_KEY**:
7170
API key for API authentication with the storage service. Example:
7271
dfe83300db5f05f63157f772820bb028bd4d0e27
7372

74-
* **REPORT_URL**:
73+
* **REPORT_URL**:
7574
The base URL to the remote service to which scan reports will be POSTed.
7675

77-
* **REPORT_USERNAME**:
76+
* **REPORT_USERNAME**:
7877
Username for API authentication with the reporting service. Not all
7978
reporting services require API authentication; leave this unset if API
8079
access is unauthenticated.
8180

82-
* **REPORT_PASSWORD**:
81+
* **REPORT_PASSWORD**:
8382
Password for API authentication with the reporting service; see above.

0 commit comments

Comments
 (0)