Skip to content

Commit

Permalink
Lint docs fixity
Browse files Browse the repository at this point in the history
  • Loading branch information
replaceafill committed Dec 7, 2023
1 parent 1833264 commit 6907b31
Showing 1 changed file with 13 additions and 14 deletions.
27 changes: 13 additions & 14 deletions docs/fixity.1.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
fixity(1) -- Check fixity for AIPs
==================================
# fixity(1) -- Check fixity for AIPs

## SYNOPSIS

Expand All @@ -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.
Expand All @@ -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.

0 comments on commit 6907b31

Please sign in to comment.