.\"                                      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 NXBROWSE 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
nxbrowse \- browse a NeXus file
.SH SYNOPSIS
.B nxbrowse
.RI [ filename ] 
.SH DESCRIPTION
.B nxbrowse
asks for a filename is none is given on the command line. The file is opened and can be interactively
explored using the commands described below.
.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
No command line options are supported.
.SH COMMANDS
When the file is opened 
.B nxbrowse
will print out its version number and the contents of the NXroot node of the NeXus file followed by its prompt:
.B NX>
.br
These case insensitive commands are recognised:
.TP
.B help
Give out list of available commands. Synonym:
.B info
.TP
.B exit 
Exit the program. Synonym: 
.B quit
.TP
.B dir
List the contents of the current group. Synonym:
.B ls
.TP
.B open \fIgroupName\fP
Open the NeXus group groupName. Same as:
.B cd \fIgroupName\fP
.TP
.B close
Closes the NeXus group groupName, i.e. moves up one level in the hierarchy. Same as:
.B cd ..
.TP
.B read \fIdataItem\fP [\fIdimension indicies ...\fP]
Print the contents of the NeXus data item labelled dataItem.
\fIdimension indicies\fP is an optional comma separated list of dimensions of the 
correct rank to specify one value.
.TP
.B dump \fIdataItem\fP \fIfileName\fP
Write the contents of the NeXus data item labelled dataItem to a new file named fileName.
.TP
.B byteaschar
Toggle treating (signed and unsigned) byte data as characters.
.PP
If your version of 
.B nxbrowse 
has been compiled with readline support you can use 
tab completion for commands, groups and data.
.SH SEE ALSO
.BR nxdir (1)
.BR http://www.nexusformat.org
.br
.SH AUTHOR
nxbrowse was originally written by Ray Osborn 
.nh
<ROsborn@anl.gov>
.hy
.PP
This manual page was written by Tobias Richter 
.nh
<Tobias.Richter@diamond.ac.uk>
.hy
and may be used by others.