.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH NXDIR 1 "June 2010"
.\" 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
nxdir \- inspect a NeXus file non interactively
.SH SYNOPSIS
.B nxdir
.RI filename
.RI [ options ] 
.SH DESCRIPTION
.B nxdir
allows to retrieve the structure and/or data of a NeXus file.
.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
About NXdir
.TP
.B  -h|--help
Print help information and exit.
.TP
.B --version
Print version information and exit.
.PP
Node Selection
.TP
.B -p \fIpath\fP
Path inside the file to look in. This can be 
absolute or relative and can be class or name of a 
given field. To anchor the path at the beginning or 
end place a "/" there.
To specify that a level must exist, but
the name or class can be anything, use a dot ".".
To specify that any number of levels can exist, use 
a star "*".
.PP
Output Control
.TP
.B -o/+o
Print (or not) the value of selected nodes, if possible. Defaults to false (+o).
.TP
.B -l|--max-array
Change the number of elements that are printed for arrays. Forces "-o". (default: 10)
.TP
.B -t|--tree-mode \fIvalue\fP
Sets the formatting of the tree. Allowed values are: script, multi, tree. Default is \fBscript\fP.
.TP
.B --path-mode \fIvalue\fP
Select whether paths are written with names or classes. Allowed values are: name, class, both. Default is \fBname\fP.
.TP
.B --data-mode \fIvalue\fP
How data is printed. Allowed value is script
.TP
.B --printline \fIvalue\fP
How data is printed with respect to tree. Allowed values is single
.TP
.B --write-data \fIfilename\fP
Select a file to write out selected NXdata to.
.TP
.B --dump \fIfilename\fP
Generate a binary dump of the selected node.
.SH SEE ALSO
.BR nxbrowse (1)
.BR http://www.nexusformat.org
.br
.SH AUTHOR
nxdir was originally written by P. F. Peterson 
.nh
<petersonpf@ornl.gov>
.hy
.PP
This manual page was written by Tobias Richter 
.nh
<Tobias.Richter@diamond.ac.uk>
.hy
and may be used by others.