Skip to content

Commit ec1686e

Browse files
Added man page for nxdump
Fixes #375
1 parent 618cd0a commit ec1686e

2 files changed

Lines changed: 47 additions & 0 deletions

File tree

applications/NXdump/CMakeLists.txt

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,20 @@ include_directories(${PROJECT_BINARY_DIR}/bindings/f90)
3333
add_executable (nxdump NXdump.f90)
3434
target_link_libraries(nxdump NeXus_Shared_Library NeXus_F90_Shared_Library)
3535

36+
#-----------------------------------------------------------------------------
37+
# build the manpage
38+
#-----------------------------------------------------------------------------
39+
add_custom_command(OUTPUT nxdump.1
40+
COMMAND rst2man ${CMAKE_CURRENT_SOURCE_DIR}/nxdump.1.rst
41+
> nxdump.1
42+
DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/nxdump.1.rst
43+
COMMENT "generate man page for nxdump")
44+
45+
add_custom_target(nxdump_manpage ALL DEPENDS nxdump.1)
46+
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/nxdump.1
47+
DESTINATION ${CMAKE_INSTALL_MANDIR}/man1
48+
COMPONENT Documentation)
49+
3650
#-----------------------------------------------------------------------------
3751
# install the program binary
3852
#-----------------------------------------------------------------------------

applications/NXdump/nxdump.1.rst

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
======
2+
nxdump
3+
======
4+
5+
-----------------------------
6+
list contents of a NeXus file
7+
-----------------------------
8+
9+
:Manual section: 1
10+
:Manual group: NeXus tools
11+
12+
SYNOPSIS
13+
========
14+
nxdump [NEXUS FILE]
15+
16+
DESCRIPTION
17+
===========
18+
nxdump prompts for a NeXus file name, opens the file, and recursively
19+
lists the groups and their contents, i.e., other groups and fields, within
20+
the file. The name and class of each group, and the name, datatype,
21+
rank and dimensions of each field are output.
22+
23+
OPTIONS
24+
=======
25+
No command line options are supported
26+
27+
SEE ALSO
28+
========.
29+
nxbrowse(1) http://www.nexusformat.org
30+
31+
AUTHOR
32+
======
33+
nxdump was originally written by Ray Osborn <ROsborn@anl.gov>

0 commit comments

Comments
 (0)