-
Notifications
You must be signed in to change notification settings - Fork 49
How to use BIL commandline
Justin Littman edited this page Jul 29, 2014
·
1 revision
justin@lawrencium$ ./bag --help
Usage: bag <operation> [operation arguments] [--help]
Parameters:
<operation>
Valid operations are: baginplace, bob, checkpayloadoxum, create, fillholey, generatepayloadoxum, makecomplete, makeholey, retrieve, sword, update, updatetagmanifests, verifycomplete, verifypayloadmanifests, verifytagmanifests and verifyvalid.
Operation explanations:
baginplace: Creates a bag-in-place. The source must be a directory on a filesystem and may already have a data directory.
bob: Sends a bag using BOB.
checkpayloadoxum: Generates Payload-Oxum and checks against Payload-Oxum in bag-info.txt.
create: Creates a bag from supplied files/directories, completes the bag, and then writes in a specified format.
fillholey: Retrieves any missing pieces of a local bag specified in the fetch.txt.
generatepayloadoxum: Generates and returns the Payload-Oxum for the bag.
makecomplete: Completes a bag and then writes in a specified format. Completing a bag fills in any missing parts.
makeholey: Generates a fetch.txt and then writes bag in a specified format.
retrieve: Retrieves a bag exposed by a web server. A local holey bag is not required.
sword: Sends a bag using SWORD.
update: Updates the manifests and (if it exists) the bag-info.txt for a bag.
updatetagmanifests: Updates the tag manifests for a bag. The bag must be unserialized.
verifycomplete: Verifies the completeness of a bag.
verifypayloadmanifests: Verifies the checksums in all payload manifests.
verifytagmanifests: Verifies the checksums in all tag manifests.
verifyvalid: Verifies the validity of a bag.
[--help]
Prints usage message for the operation.
Examples:
bag verifyvalid --help
Prints help for the verifyvalid operation.
justin@lawrencium$ ./bag verifyvalid --help
Usage: bag verifyvalid <source> [--version <version>] [--missingbagittolerant] [--additionaldirectorytolerant] [--help]
Operation explanation:
Verifies the validity of a bag.
Operation parameters:
<source>
The location of the source bag.
[--version <version>]
The version used to check the bag. Valid values are 0.93 and 0.94 and
0.95 and 0.96. Default is to discover from the bag-it.txt or latest
version.
[--missingbagittolerant]
Tolerant of a missing bag-it.txt.
[--additionaldirectorytolerant]
Tolerant of additional directories in the bag_dir.
[--help]
Prints help.
Examples:
bag verifyvalid /bags/mybag
Returning success.
justin@lawrencium$ ./bag verifyvalid ~/tmp/bag
Performing operation: verifyvalid
Result is true.
Operation completed.
Returning success.