Add rudimentary man page for aec

diff --git a/INSTALL b/INSTALL
index 349b7df..85c67d5 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -44,7 +44,7 @@ Unpack the tar archive and change into the unpacked directory.
 
   mkdir build
   cd build
-  cmake ..  # CMAKE_INSTALL_PREFIX=~/.local
+  cmake ..
   make install
 
 You can set options for compiling using the CMake GUI by replacing the cmake

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
index 6ddf029..3d2029d 100644 (file)
--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -37,7 +37,10 @@ else(WIN32)
     ARCHIVE
     DESTINATION ${CMAKE_INSTALL_LIBDIR}
     COMPONENT libraries)
+  install(FILES aec.1
+    DESTINATION ${CMAKE_INSTALL_FULL_MANDIR}/man1 COMPONENT doc)
 endif(WIN32)
+
 install(FILES libaec.h szlib.h
   DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
   COMPONENT headers)
@@ -46,4 +49,4 @@ install(TARGETS aec_client
   DESTINATION ${CMAKE_INSTALL_BINDIR}
   COMPONENT applications)
 
-set(CPACK_COMPONENTS_ALL applications libraries headers)
+set(CPACK_COMPONENTS_ALL applications libraries headers doc)

diff --git a/src/Makefile.am b/src/Makefile.am
index 549d6bc..2270c17 100644 (file)
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -16,6 +16,7 @@ noinst_PROGRAMS = utime
 utime_SOURCES = utime.c
 aec_LDADD = libaec.la
 aec_SOURCES = aec.c
+dist_man_MANS = aec.1
 
 EXTRA_DIST = CMakeLists.txt benc.sh bdec.sh
 CLEANFILES = bench.dat bench.rz

diff --git a/src/aec.1 b/src/aec.1
new file mode 100644 (file)
index 0000000..fa7dc1f
--- /dev/null
+++ b/src/aec.1
@@ -0,0 +1,57 @@
+.TH AEC 1
+.SH NAME
+aec \- compress or expand files
+.SH SYNOPSIS
+.B aec
+[\fB\-3\fR]
+[\fB\-b\fR \fIBYTES\fR]
+[\fB\-d\fR]
+[\fB\-j\fR \fISAMPLES\fR]
+[\fB\-m\fR]
+[\fB\-n\fR \fIBITS\fR]
+[\fB\-N\fR]
+[\fB\-p\fR]
+[\fB\-r\fR \fIBLOCKS\fR]
+[\fB\-s\fR]
+[\fB\-t\fR]
+.IR infile
+.IR outfile
+.SH DESCRIPTION
+.IR Aec
+performs lossless compression and decompression with  Golomb-Rice coding
+as defined in the Space Data System Standard documents 121.0-B-2.
+.SH OPTIONS
+.TP
+\fB \-3\fR
+24 bit samples are stored in 3 bytes
+.TP
+\fB \-b\fR\ \fI\,BYTES\fR
+internal buffer size in bytes
+.TP
+\fB \-d\fR
+decompress \fIinfile\fR; if option \-d is not used then compress
+\fIinfile\fR
+.TP
+\fB \-j\fR \fI\,SAMPLES\fR
+block size in samples
+.TP
+\fB \-m\fR
+samples are MSB first; default is LSB first
+.TP
+\fB \-n\fR \fI\,BITS\fR
+bits per sample
+.TP
+\fB \-N\fR
+disable pre/post processing
+.TP
+\fB \-p\fR
+pad RSI to byte boundary
+.TP
+\fB \-r\fR \fI\,BLOCKS\fR
+reference sample interval in blocks
+.TP
+\fB \-s\fR
+samples are signed; default is unsigned
+.TP
+\fB \-t\fR
+use restricted set of code options