[NeXus-code-tickets] [NeXusCode] #208: NXdir usage

[NeXus Data Format Library and Applications]

#208: NXdir usage
---------------------------+------------------------------------------------
 Reporter:  Pedro.vicente  |       Owner:  Peter Peterson
     Type:  enhancement    |      Status:  new           
 Priority:  trivial        |   Milestone:                
Component:  applications   |     Version:  trunk         
 Keywords:  NXdir          |  
---------------------------+------------------------------------------------
 Include in the usage message some sentences that explain what the "tree",
 " path" and "data" modes mean.

 Current usage is

 Usage: <PROGRAM_PATH> <filename> [options]
 For all information below the default (when flag is not given) is denoted
 by
 parenthesis, "()".

 About NXdir
   -h|--help                 Print this help information
   --version                 Print the version information

 Node Selection
   -p                        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 "*".

 Output Control
   -o/+o                     Print (or not) the value of selected nodes, if
                             possible. Defaults to false (+o).
   -l|--max-array            Change the number of elements that are printed
 for
                             arrays. Forces "-o". (10)
   -t|--tree-mode <value>    Sets the formatting of the tree. Allowed
 values are
                             (script)|multi|tree
   --path-mode <value>       Select whether paths are written with names or
                             classes. Allowed values are (name)|class|both
   --data-mode <value>       How data is printed. Allowed values are
 (script)
   --printline <value>       How data is printed with respect to tree.
 Allowed
                             values are (single).
   --write-data <filename>   Select a file to write out selected NXdata to.
   --dump <filename>         Generate a binary dump of the selected node.

-- 
Ticket URL: <http://trac.nexusformat.org/code/ticket/208>
NeXus Data Format Library and Applications <http://www.nexusformat.org/>
NeXus Data Format Library and Applications