.TH NXSUMMARY 1 "October 2011"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
nxdiff \- Generate summary of a NeXus file
.SH SYNOPSIS
.B nxsummary
[--xml] [--value \fIlabel\fP] [--writeconfig \fIconfig\fP]
                [--config \fIconfig\fP] [--verbose] [--] [--version] [-h]
                [\fIfilename\fP]
.SH DESCRIPTION
The
.B nxsummary
utility prints summary information about NeXus files. This program relies
heavily on the configuration file that is located in 
"\fB${HOME}/.nxsummary.conf\fP" or "\fB/etc/nxsummary.conf\fP". A sample configuration
file can be obtained using the "\fB--writeconfig\fP" flag. Each \fIitem\fP tag in 
the file describes a node to print from the NeXus file. The \fIpath\fP
attribute describes where in the NeXus file to get information from. The 
\fIlabel\fP attributes is what will be printed when showing the value of 
the specified field. The optional \fIoperation\fP attribute provides for 
certain operations to be performed on the data before printing out the 
result. Valid operations are:

   \fBCOUNT\fP - The number of elements in the requested field.

   \fBDIMS\fP - The dimensions of the requested field.

   \fBSUM\fP - Add together all of the array elements and print the
   result.

   \fBUNITS:\fP\fInewunits\fP - Specify the units to print the result in.

.PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
.\" respectively.
.SH OPTIONS
The following options are supported
.TP
.B --version
Displays version information and exits.
.TP
.B -h|--help
Displays usage information and exits.
.TP
.B --xml
Print results as xml
.TP
.B --value \fIlabel\fP
Get value of the item pointed to by the label
.TP
.B --writeconfig \fIconfig\fP
Write the default configuration out to a file
.TP
.B --config \fIconfig\fP
Specify configuration file
.TP
.B --verbose
Turn on verbose printing
.TP
.B --|--ignore_rest
Ignores the rest of the labeled arguments following this flag.
.SH SEE ALSO
.BR nxconvert(1),
.BR nxdir (1),
.BR nxtranslate (1),
.BR http://www.nexusformat.org
.SH AUTHOR
.B nxsummary
was originally written by Peter Peterson 
.nh
<petersonpf@ornl.gov>
.hy
and may be used by others.