From: Friedrich Beckmann Date: Tue, 30 Sep 2014 07:57:04 +0000 (+0200) Subject: doc: Add PSPPIRE manpage, add example to manpages, install manpages. X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?p=pspp;a=commitdiff_plain;h=674231519c0e08f05f73d87dbee4987c3a8840a3 doc: Add PSPPIRE manpage, add example to manpages, install manpages. --- diff --git a/doc/automake.mk b/doc/automake.mk index 2dedc304d6..7c349b4159 100644 --- a/doc/automake.mk +++ b/doc/automake.mk @@ -41,8 +41,10 @@ doc_pspp_dev_TEXINFOS = doc/version-dev.texi \ doc/dev/portable-file-format.texi \ doc/dev/q2c.texi -EXTRA_DIST += doc/pspp.man \ - doc/get-commands.pl +dist_man_MANS += doc/pspp.1 \ + doc/psppire.1 + +EXTRA_DIST += doc/get-commands.pl $(srcdir)/doc/ni.texi: $(top_srcdir)/src/language/command.def doc/get-commands.pl @$(MKDIR_P) doc diff --git a/doc/pspp.1 b/doc/pspp.1 new file mode 100644 index 0000000000..d0ee7ffb27 --- /dev/null +++ b/doc/pspp.1 @@ -0,0 +1,70 @@ +.\" PSPP - computes sample statistics. +.\" Copyright (C) 1997, 1998 Free Software Foundation, Inc. +.\" +.\" This program is free software: you can redistribute it and/or modify +.\" it under the terms of the GNU General Public License as published by +.\" the Free Software Foundation, either version 3 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public License +.\" along with this program. If not, see . +.\" +.TH pspp 1 "29 Sep 2014" "GNU" "PSPP manual" +.SH NAME +pspp \- a system for statistical analysis +.SH SYNOPSIS +.B pspp +.RI [ options ] " file"... +.SH DESCRIPTION +\fBpspp\fP performs statistical analysis on +sampled data. Detailed documentation is available in html, pdf and info format. +If the info system is installed, you can view the documentation with +.IP +.B info pspp +.PP +On Debian GNU/Linux systems, full documentation is available in +\fB/usr/share/doc/pspp\fP in HTML and PDF formats and in +\fB/usr/share/info\fP in info format. Documentation is +also available at \fBhttp://www.gnu.org/software/pspp\fP. +.SH OPTIONS +.TP +.B \-\-help +Show summary of options. +.TP +.B \-\-version +Show version of program. +.SH EXAMPLE +Create a file \fBexample.sps\fP with the following content: +.PP +.nf +.RS +* Example sps file +data list / v0 to v2 1-9. +begin data. + 12 12 89 + 56 12 77 + 78 12 73 + 90 91 + 37 97 85 +end data. + +descript all + /stat=all + /format=serial. +.RE +.fi +.PP +and run pspp with +.IP +.B pspp example.sps +.PP +More examples files are in \fB/usr/share/pspp/examples\fP +.SH SEE ALSO +.BR psppire (1), pspp\-dump\-sav (1), pspp\-convert (1). +.SH AUTHOR +pspp was written by Ben Pfaff, John Darrington and others diff --git a/doc/pspp.man b/doc/pspp.man deleted file mode 100644 index 025fbb15fa..0000000000 --- a/doc/pspp.man +++ /dev/null @@ -1,42 +0,0 @@ -.\" PSPP - computes sample statistics. -.\" Copyright (C) 1997, 1998 Free Software Foundation, Inc. -.\" -.\" This program is free software: you can redistribute it and/or modify -.\" it under the terms of the GNU General Public License as published by -.\" the Free Software Foundation, either version 3 of the License, or -.\" (at your option) any later version. -.\" -.\" This program is distributed in the hope that it will be useful, -.\" but WITHOUT ANY WARRANTY; without even the implied warranty of -.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -.\" GNU General Public License for more details. -.\" -.\" You should have received a copy of the GNU General Public License -.\" along with this program. If not, see . -.\" -.TH pspp 1 "4 Jul 1997" "manpage v1.0" "PSPP manual" -.SH NAME -pspp \- a system for statistical analysis -.SH SYNOPSIS -.B pspp -\&.\|.\|. -.SH DESCRIPTION -.B pspp -starts up the PSPP program. PSPP performs statistical analysis on -sampled data. Please see Info document `pspp' for more details on -using PSPP. For other miscellaneous information about PSPP, see -the PSPP FAQ, which should be installed in /usr/doc/pspp. - -These documents and others are available in various formats. On -Debian GNU/Linux systems, full documentation is available in directory -`/usr/doc/pspp', in HTML and ASCII formats, and in `/usr/info', in -Info format. TeX can be used to convert the Texinfo documentation in -the source distribution to nice-looking output for printing. - -Documentation is also at http://www.gnu.org/software/pspp. - -.SH BUGS - -Probably a lot. Known bugs are listed in the documentation files -BUGS, LANGUAGE, and TODO, depending on type. Please see those files -for more details. diff --git a/doc/psppire.1 b/doc/psppire.1 new file mode 100644 index 0000000000..c834a1cfd9 --- /dev/null +++ b/doc/psppire.1 @@ -0,0 +1,86 @@ +.\" PSPP - computes sample statistics. +.\" Copyright (C) 2014 Free Software Foundation, Inc. +.\" +.\" This program is free software: you can redistribute it and/or modify +.\" it under the terms of the GNU General Public License as published by +.\" the Free Software Foundation, either version 3 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public License +.\" along with this program. If not, see . +.\" +.TH PSPPIRE 1 "August 30, 2014" "GNU" "PSPP manual" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +psppire \- graphical interface to pspp +.SH SYNOPSIS +.B psppire +.RI [ options ] " files" ... +.SH DESCRIPTION +\fBpsppire\fP is a graphical interface to \fBpspp\fP. This +interface allows you to enter data and variable definitions +interactively. Commands may be executed in syntax form, or by +using the interactive dialog boxes available from the dropdown +menus. Up to date documentation is available via +.IP +.B info pspp +.PP +Documentation is also available as pdf or html. On GNU/Linux based +systems you find this documentation in \fB/usr/share/doc/pspp\fP. +.SH OPTIONS +.TP +.B \-\-help +Show summary of options. +.TP +.B \-\-version +Show version of program. +.SH EXAMPLE +Create a file \fBexample.sps\fP with the following content: +.PP +.nf +.RS +* Example sps file +data list + / v0 to v2 1-9. +begin data. + 12 12 89 + 56 12 77 + 78 12 73 + 90 91 + 37 97 85 + 52 82 + 12 79 + 26 78 76 + 29 13 71 +end data. + +examine v0 + /plot=all. +.RE +.fi +.PP +and run psppire with +.IP +.B psppire example.sps +.PP +More examples files are in \fB/usr/share/pspp/examples\fP +.SH SEE ALSO +.BR pspp (1), pspp\-dump\-sav (1), pspp\-convert (1). +.SH AUTHOR +psppire was written by John Darrington.