1
- fixity(1) -- Check fixity for AIPs
2
- ==================================
1
+ # fixity(1) -- Check fixity for AIPs
3
2
4
3
## SYNOPSIS
5
4
@@ -24,28 +23,28 @@ running; see the section on _ENVIRONMENT VARIABLES_ for information.
24
23
25
24
## OPTIONS
26
25
27
- * ` --throttle ` <seconds >:
26
+ * ` --throttle <seconds> ` :
28
27
Time (in seconds) to wait when scanning multiple AIPs. This can help reduce
29
28
extended disk load on the Storage Service filesystem on which the AIPs
30
29
reside.
31
30
32
- * ` --force-local ` :
31
+ * ` --force-local ` :
33
32
Request the Storage Service performs a local fixity check, instead of using
34
33
the Space's fixity (this is only available for Arkivum Spaces).
35
34
36
- * ` --debug ` :
35
+ * ` --debug ` :
37
36
Print extra debugging output.
38
37
39
38
## COMMANDS
40
39
41
- * ` scan ` <UUID >:
40
+ * ` scan <UUID> ` :
42
41
Run a fixity scan on a single AIP, using the specified UUID. If the UUID is
43
42
malformed, or the Storage Service does not have an AIP with the specified
44
43
UUID, this will produce an error and exit 1. After the scan completes, a
45
44
brief report will be printed with information on whether the scan succeeded
46
45
or failed.
47
46
48
- * ` scanall ` :
47
+ * ` scanall ` :
49
48
Run a fixity scan on every AIP registered with the target Storage Service
50
49
instance. This command does not take any arguments. A brief report will be
51
50
printed after every AIP is scanned.
@@ -58,26 +57,26 @@ running; see the section on _ENVIRONMENT VARIABLES_ for information.
58
57
The following environment variables ** must** be exported in the environment for
59
58
fixity to operate.
60
59
61
- * ** STORAGE_SERVICE_URL** :
60
+ * ** STORAGE_SERVICE_URL** :
62
61
The base URL to the storage service instance to scan. Must include the port
63
62
number for non port 80 installations. Example:
64
- http://localhost:8000/
63
+ < http://localhost:8000/ >
65
64
66
- * ** STORAGE_SERVICE_USER** :
65
+ * ** STORAGE_SERVICE_USER** :
67
66
Username for API authentication with the storage service. Example:
68
67
test
69
68
70
- * ** STORAGE_SERVICE_KEY** :
69
+ * ** STORAGE_SERVICE_KEY** :
71
70
API key for API authentication with the storage service. Example:
72
71
dfe83300db5f05f63157f772820bb028bd4d0e27
73
72
74
- * ** REPORT_URL** :
73
+ * ** REPORT_URL** :
75
74
The base URL to the remote service to which scan reports will be POSTed.
76
75
77
- * ** REPORT_USERNAME** :
76
+ * ** REPORT_USERNAME** :
78
77
Username for API authentication with the reporting service. Not all
79
78
reporting services require API authentication; leave this unset if API
80
79
access is unauthenticated.
81
80
82
- * ** REPORT_PASSWORD** :
81
+ * ** REPORT_PASSWORD** :
83
82
Password for API authentication with the reporting service; see above.
0 commit comments