| 1 | .TH NXDIFF 1 "October 2011" |
|---|
| 2 | .\" Please adjust this date whenever revising the manpage. |
|---|
| 3 | .\" |
|---|
| 4 | .\" Some roff macros, for reference: |
|---|
| 5 | .\" .nh disable hyphenation |
|---|
| 6 | .\" .hy enable hyphenation |
|---|
| 7 | .\" .ad l left justify |
|---|
| 8 | .\" .ad b justify to both left and right margins |
|---|
| 9 | .\" .nf disable filling |
|---|
| 10 | .\" .fi enable filling |
|---|
| 11 | .\" .br insert line break |
|---|
| 12 | .\" .sp <n> insert n+1 empty lines |
|---|
| 13 | .\" for manpage-specific macros, see man(7) |
|---|
| 14 | .SH NAME |
|---|
| 15 | nxdiff \- compare two NeXus files |
|---|
| 16 | .SH SYNOPSIS |
|---|
| 17 | .B nxdiff |
|---|
| 18 | [options] [\fIleft\fP] [-o|--append \fIright\fP] |
|---|
| 19 | .SH DESCRIPTION |
|---|
| 20 | The |
|---|
| 21 | .B nxdiff |
|---|
| 22 | utility compares two files that are readable by the NeXus API. In the |
|---|
| 23 | difference the '<' or '-' symbol means that the field exists in the left file |
|---|
| 24 | but not the right. '>' or '+' symbol means that the field exists in the right |
|---|
| 25 | file but not the left. '|' symbol means that the field has changed between the |
|---|
| 26 | two files. |
|---|
| 27 | .PP |
|---|
| 28 | .\" TeX users may be more comfortable with the \fB<whatever>\fP and |
|---|
| 29 | .\" \fI<whatever>\fP escape sequences to invode bold face and italics, |
|---|
| 30 | .\" respectively. |
|---|
| 31 | .SH OPTIONS |
|---|
| 32 | The following options are supported |
|---|
| 33 | .TP |
|---|
| 34 | .B --version |
|---|
| 35 | show the version number and exit |
|---|
| 36 | .TP |
|---|
| 37 | .B -h|--help |
|---|
| 38 | show the help message and exit |
|---|
| 39 | .TP |
|---|
| 40 | .B -v|--verbose |
|---|
| 41 | Enable verbose print statements |
|---|
| 42 | .TP |
|---|
| 43 | .B -q|--brief |
|---|
| 44 | Disable verbose print statements |
|---|
| 45 | .TP |
|---|
| 46 | .B -u |
|---|
| 47 | Use the unified output format. |
|---|
| 48 | .TP |
|---|
| 49 | .B -s|--report-identical-files |
|---|
| 50 | Report when two files are the same. |
|---|
| 51 | .TP |
|---|
| 52 | .B -S|--suppress-common-lines |
|---|
| 53 | Do not output common lines |
|---|
| 54 | .TP |
|---|
| 55 | .B --show-values |
|---|
| 56 | Show the values of arrays that do not match |
|---|
| 57 | .TP |
|---|
| 58 | .B --num-values=NUMVALUES |
|---|
| 59 | Set the number of values to show in "--show-values" mode. If not specified the default is ten (10). To show all values specify minus one (-1). |
|---|
| 60 | .TP |
|---|
| 61 | .B --show-percent=THRESHOLD |
|---|
| 62 | Set a threshold for the minimum percentage difference shown in values. This turns on "--show-values" mode and overrides "--num-values". |
|---|
| 63 | .TP |
|---|
| 64 | .B --show-nan-diffs |
|---|
| 65 | Whether or not to show the indices that changed to nan when using "--show-percent" mode. |
|---|
| 66 | .TP |
|---|
| 67 | .B -L|--ignore-links |
|---|
| 68 | Only compare the original copy of links |
|---|
| 69 | .TP |
|---|
| 70 | .B --ignore-note-meta |
|---|
| 71 | Ignore the author and date fields in notes |
|---|
| 72 | .TP |
|---|
| 73 | .B --ignore-ts |
|---|
| 74 | Ignore differences in the version of ts used |
|---|
| 75 | .SH SEE ALSO |
|---|
| 76 | .BR nxconvert(1), |
|---|
| 77 | .BR nxdir (1), |
|---|
| 78 | .BR nxtranslate (1), |
|---|
| 79 | .BR http://www.nexusformat.org |
|---|
| 80 | .SH AUTHOR |
|---|
| 81 | .B nxdiff |
|---|
| 82 | was originally written by Peter Peterson |
|---|
| 83 | .nh |
|---|
| 84 | <petersonpf@ornl.gov> |
|---|
| 85 | .hy |
|---|
| 86 | and may be used by others. |
|---|
