[segyio] 329/376: Man page for segyio-cath

[Jørgen Kvalsvik]

This is an automated email from the git hooks/post-receive script.

jokva-guest pushed a commit to branch debian
in repository segyio.

commit b15fcefbf18a80fa3ee1cc1e5979c6bc562ab888
Author: Jørgen Kvalsvik <jokva at statoil.com>
Date:   Tue Aug 8 11:47:56 2017 +0200

    Man page for segyio-cath
---
 CMakeLists.txt     |  1 +
 man/CMakeLists.txt |  9 +++++++++
 man/segyio-cath.1  | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 57 insertions(+)

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 08ffba3..352f3eb 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -39,3 +39,4 @@ add_subdirectory(mex)
 add_subdirectory(python)
 
 add_subdirectory(applications)
+add_subdirectory(man)
diff --git a/man/CMakeLists.txt b/man/CMakeLists.txt
new file mode 100644
index 0000000..8b43cbe
--- /dev/null
+++ b/man/CMakeLists.txt
@@ -0,0 +1,9 @@
+project(segyio-man)
+
+if(NOT UNIX)
+    return()
+endif()
+
+install(FILES segyio-cath.1
+        DESTINATION ${CMAKE_INSTALL_MANDIR}
+)
diff --git a/man/segyio-cath.1 b/man/segyio-cath.1
new file mode 100644
index 0000000..b6bad23
--- /dev/null
+++ b/man/segyio-cath.1
@@ -0,0 +1,47 @@
+.TH SEGYIO-CATH 1
+.SH NAME
+segyio-cath \- Concatenate SEG-Y text headers and print on the standard output
+.SH SYNPOSIS
+.B segyio-cath
+[\fIOPTION\fR]...
+[\fIFILE\fR]...
+.SH DESCRIPTION
+.B segyio-cath
+Concatenate the SEG-Y text headers in FILEs.
+
+By default, only the non-extended header is printed, which is equivalent to
+--num 0.
+
+Mandatory arguments to long options are mandatory for short options too.
+
+.SH OPTIONS
+.TP
+.BR \-n ", " \-\-num =\fINUM\fR
+the textual header to show, starts at 0
+
+.TP
+.BR \-a ", " \-\-all
+print all headers
+
+.TP
+.BR \-s ", " \-\-strict
+abort if a header or file is not found
+primarily meant for shell scripts
+
+.TP
+.BR \-S ", " \-\-nonstrict
+ignore missing headers
+this is the default behaviour
+
+.TP
+.BR \-\-version
+output version information and exit
+
+.TP
+.BR \-\-help
+display this help and exit
+
+.SH COPYRIGHT
+Copyright © Statoil ASA. License LPLv3+: GNU LGPL version 3 or later <http://gnu.org/licenses/lgpl.html>.
+
+This is free software: you are free to change and redistribute it.  There is NO WARRANTY, to the extent permitted by law.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/segyio.git