Running JWAT-Tools

Installing and running

To install JWAT-Tools simply unpack the archive.

To run JWAT-Tools use the Windows or Linux scripts included in the package.

The scripts can be called from any location.

Windows scripts

jwattools.cmd

jwattools_debug.cmd

jwattools_debug_suspended.cmd

Linux scripts

jwattools.sh

jwattools_debug.sh

jwattools_debug_suspended.sh

Options

This is the new style usage introduced with v0.5.5.

The command line interface is work in progress. There may come more refactoring.

Commandline options (v0.5.5)

C:\Java\workspace\jwat-tools>target\jwat-tools-0.5.5-SNAPSHOT\jwattools.cmd
JWATTools v0.5.5
Usage: JWATTools [-dte19] command [file ...]
Commands:
   arc2warc     convert ARC to WARC
   cdx          create a CDX index (unsorted)
   compress     compress
   decompress   decompress
   extract      extract ARC/WARC record(s)
   interval     interval extract
   pathindex    create a heritrix path index (unsorted)
   test         test validity of ARC/WARC/GZip file(s)
   unpack       unpack multifile GZip
Options:
   -r      recursive (currently has no effect)
   -w<x>   set the amount of worker thread(s) (defaults to 1)
Test options:
   -e   show errors
   -l   relaxed URL URI validation
   -x   to validate text/xml payload (eg. mets)
Compress options:
   -1, --fast   compress faster
   -9, --slow   compress better

C:\Java\workspace\jwat-tools>

This is the old style usage for v0.5.4. (It will be removed once a binary v0.5.5 has been uploaded)

Commandline options (v0.5.4)

C:\Java\workspace\jwat-tools>target\jwat-tools-0.5.4-SNAPSHOT\jwattools.cmd
JWATTools v0.5.4
usage: JWATTools [-dte19] [file ...]
 -t   test validity of ARC, WARC and/or GZip file(s)
 -r   recursive
 -e   show errors
 -l   relaxed URL URI validation
 -x   to validate text/xml payload (eg. mets)
 -d   decompress
 -1   compress faster
 -9   compress better
 -i   interval extract
 -u   unpack multifile gzip
 -c   convert arc to warc
 -C   output CDX

You can supply one or more files. Each file can contain * and/or ? wildcards, but only in the filename part of the path. You can use more wildcards at the same time if you want.

-t (test)

Reads and validates all the files supplied. Files which are not recognized as either GZip, ARC or WARC are skipped. If wildcards are used, files that do not match are also skipped.

Use -e for more than a summary of errors.

-d (decompress)

Decompress one or more (multi-part) GZip files and write the decompressed data to a new file, one for each input file.
Useful for decompressing ARC and/or WARC files.

-r (recursive)

Is currently ignored. All operations are currently recursive.

-1..-9 (compress)

Compress normal and/or WARC files.

-i (interval extract)

Extract an interval from a given file. Interval can be expressed as offset, offset2 or offset,+length. Offset and length can be expressed in hex by pre-pending "$" or "0x".

-u (unpack)

Unpack a (multi-file)GZip and save each entry as individual files.

-c (convert)

Convert ARC files to WARC.

-C (output CDX)

Index one or more ARC/WARC files and output the result in CDX format.