pspp-dump-sav: Add manpage.
authorBen Pfaff <blp@cs.stanford.edu>
Wed, 25 Jan 2012 06:09:18 +0000 (22:09 -0800)
committerBen Pfaff <blp@cs.stanford.edu>
Wed, 25 Jan 2012 06:09:18 +0000 (22:09 -0800)
Makefile.am
utilities/automake.mk
utilities/pspp-dump-sav.1 [new file with mode: 0644]

index 28e9ffc6b250078acdc65da2ddebfc1bfee5dd52..3d2e6916e16c1654997c726e3eb0143be924dbe0 100644 (file)
@@ -40,6 +40,7 @@ noinst_LTLIBRARIES=
 noinst_PROGRAMS=
 check_PROGRAMS=
 bin_PROGRAMS=
+man_MANS =
 DIST_HOOKS =
 INSTALL_DATA_HOOKS = 
 UNINSTALL_DATA_HOOKS =
index ec4ccf20da7d3531fab9ea0dd78e25c230d7211b..0a30558a4b4e25190e09554e1e8a38b722872bb3 100644 (file)
@@ -1,7 +1,7 @@
 bin_PROGRAMS += utilities/pspp-dump-sav
+man_MANS += utilities/pspp-dump-sav.1
 utilities_pspp_dump_sav_SOURCES = \
        src/libpspp/integer-format.c \
        src/libpspp/float-format.c \
        utilities/pspp-dump-sav.c
 utilities_pspp_dump_sav_CPPFLAGS = $(AM_CPPFLAGS) -DINSTALLDIR=\"$(bindir)\"
-
diff --git a/utilities/pspp-dump-sav.1 b/utilities/pspp-dump-sav.1
new file mode 100644 (file)
index 0000000..e5ebabc
--- /dev/null
@@ -0,0 +1,55 @@
+.\" -*- nroff -*-
+.de IQ
+.  br
+.  ns
+.  IP "\\$1"
+..
+.TH pspp\-dump\-sav 1 "January 2012" "PSPP" "PSPP Manual"
+.
+.SH NAME
+pspp\-dump\-sav \- dissect SPSS system file
+.
+.SH SYNOPSIS
+\fBpspp\-dump\-sav\fR [\fB\-d \fR| \fB\-\-data\fR[\fB=\fImaxcases\fR]] \fIfile\fR...
+.br
+\fBpspp\-dump\-sav \-\-help\fR | \fB\-h\fR
+.br
+\fBpspp\-dump\-sav \-\-version\fR | \fB\-v\fR
+.
+.SH DESCRIPTION
+The \fBpspp\-dump\-sav\fR program reads each SPSS system file
+\fIfile\fR and prints its contents.  The output format is useful for
+debugging system file readers and writers and for discovering how to
+interpret unknown or poorly understood records.  End users may find
+the output useful for providing the PSPP developers information about
+system files that PSPP does not accurately read.
+.
+.SH "OPTIONS"
+.
+.IP "\fB\-d\fR[\fImaxcases\fR]"
+.IQ "\fB\-\-data\fR[\fB=\fImaxcases\fR]"
+By default, \fBpspp\-dump\-sav\fR does not print any of the data in a
+system file, only the file headers.  Specify this option to print the
+data as well.  If \fImaxcases\fR is specified, then it limits the
+number of cases printed.
+.
+.IP "\fB\-h\fR"
+.IQ "\fB\-\-help\fR"
+Prints a usage message on stdout and exits.
+.
+.IP "\fB\-v\fR"
+.IQ "\fB\-\-version\fR"
+Prints version information on stdout and exits.
+.
+.SH "BUGS"
+Some errors that prevent files from being interpreted successfully
+cause \fBpspp\-dump\-sav\fR to exit without reading any additional
+files given on the command line.
+.
+.SH "AUTHORS"
+Ben Pfaff and John Darrington.
+.
+.SH "SEE ALSO"
+.
+.BR pspp (1),
+.BR psppire (1).