Skip to content

Commit

Permalink
updated readme so text can be copied directly to usage.md in jpylyzer…
Browse files Browse the repository at this point in the history
… website
  • Loading branch information
bitsgalore committed Aug 12, 2019
1 parent 978cdf8 commit 9fb5274
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,23 @@ Please visit the jpylyzer homepage for links to the most recent package download

- [![Build Status](http://jenkins.opf-labs.org/buildStatus/icon?job=jpylyser)](http://jenkins.opf-labs.org/job/jpylyser/) OPF Jenkins

## Command line use
<!-- Start of text to be copied to usage.md of jpylyzer website -->

### Usage
## Using jpylyzer from the command line

Calling *jpylyzer* in a command window without any arguments results in the following helper message:

usage: jpylyzer [-h] [--format FMT] [--legacyout] [--mix {1,2}] [--nopretty]
[--nullxml] [--recurse] [--verbose] [--version] [--wrapper]
jp2In [jp2In ...]

With:
### Positional arguments

|Argument|Description|
|:--|:--|
|`jp2In`|input JP2 image(s), may be one or more (whitespace-separated) path expressions; prefix wildcard (\*) with backslash (\\) in Linux|

### Optional arguments

|Argument|Description|
|:--|:--|
Expand All @@ -38,17 +46,16 @@ With:
|`[--verbose]`|report test results in verbose format|
|`[-v, --version]`|show program's version number and exit|
|`[--wrapper, -w]`|wrap output for individual image(s) in 'results' XML element (deprecated from jpylyzer 2.x onward, only takes effect if `--legacyout` is used)|
|`jp2In`|input JP2 image(s), may be one or more (whitespace-separated) path expressions; prefix wildcard (\*) with backslash (\\) in Linux.|

## Output
## Output

Output is directed to the standard output device (*stdout*).

### Example

`jpylyzer rubbish.jp2 > rubbish.xml`

In the above example, output is redirected to the file 'rubbish.xml'.
In the above example, output is redirected to the file &#8216;rubbish.xml&#8217;. By default *jpylyzer*&#8217;s XML is pretty-printed, so you should be able to view the file using your favourite text editor. Alternatively use a dedicated XML editor, or open the file in your web browser.

## Output format

Expand Down Expand Up @@ -117,6 +124,8 @@ myFile = "/home/johan/jpylyzer-test-files/rubbish.j2c"
myResult = jpylyzer.checkOneFile(myFile, 'j2c')
```

<!-- End of text to be copied to usage.md of jpylyzer website -->

## Debian packages build process

The [Vagrant directory](vagrant) of this repo contains instructions on how to build Debian packages using [VirtualBox](https://www.virtualbox.org/) and [Vagrant](https://www.vagrantup.com/). A Vagrantfile and provisioning scripts are included for a number of target platforms, which should make the process of building the packages fairly easy.
Expand Down

0 comments on commit 9fb5274

Please sign in to comment.