Added man page for nxdump

Fixes #375
nexusformat · Dec 9, 2015 · ec1686e · ec1686e
1 parent 618cd0a
commit ec1686e
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 0 deletions.
diff --git a/applications/NXdump/CMakeLists.txt b/applications/NXdump/CMakeLists.txt
@@ -33,6 +33,20 @@ include_directories(${PROJECT_BINARY_DIR}/bindings/f90)
 add_executable (nxdump NXdump.f90)
 target_link_libraries(nxdump NeXus_Shared_Library NeXus_F90_Shared_Library)
 
+#-----------------------------------------------------------------------------
+# build the manpage
+#-----------------------------------------------------------------------------
+add_custom_command(OUTPUT nxdump.1
+                   COMMAND rst2man ${CMAKE_CURRENT_SOURCE_DIR}/nxdump.1.rst 
+                           > nxdump.1
+                   DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/nxdump.1.rst
+                   COMMENT "generate man page for nxdump")
+
+add_custom_target(nxdump_manpage ALL DEPENDS nxdump.1)
+install(FILES ${CMAKE_CURRENT_BINARY_DIR}/nxdump.1
+        DESTINATION ${CMAKE_INSTALL_MANDIR}/man1
+        COMPONENT Documentation)
+
 #-----------------------------------------------------------------------------
 # install the program binary
 #-----------------------------------------------------------------------------

diff --git a/applications/NXdump/nxdump.1.rst b/applications/NXdump/nxdump.1.rst
@@ -0,0 +1,33 @@
+======
+nxdump 
+======
+
+-----------------------------
+list contents of a NeXus file
+-----------------------------
+
+:Manual section: 1
+:Manual group: NeXus tools
+
+SYNOPSIS
+========
+    nxdump [NEXUS FILE]
+
+DESCRIPTION
+===========
+    nxdump prompts for a NeXus file name, opens the file, and recursively 
+    lists the groups and their contents, i.e., other groups and fields, within 
+    the file.  The name and class of each group, and the name, datatype, 
+    rank and dimensions of each field are output.
+
+OPTIONS
+=======
+    No command line options are supported
+
+SEE ALSO
+========.
+    nxbrowse(1) http://www.nexusformat.org
+
+AUTHOR
+======
+   nxdump was originally written by Ray Osborn <[email protected]>