tests: Skip PSPP permissions test if permissions don't work as expected.
[pspp.git] / doc / pspp.texi
blob204feada5862577aad02fbdf37cbf51b6c870e80
1 \input texinfo @c -*- texinfo -*-
2 @c PSPP - a program for statistical analysis.
3 @c Copyright (C) 2017, 2019, 2020 Free Software Foundation, Inc.
4 @c Permission is granted to copy, distribute and/or modify this document
5 @c under the terms of the GNU Free Documentation License, Version 1.3
6 @c or any later version published by the Free Software Foundation;
7 @c with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
8 @c A copy of the license is included in the section entitled "GNU
9 @c Free Documentation License".
11 @c %**start of header
12 @setfilename pspp.info
13 @settitle PSPP
14 @c For double-sided printing, uncomment:
15 @c @setchapternewpage odd
16 @c %**end of header
18 @macro gui
19 graphic user interface
20 @end macro
22 @macro psppsyntax{FILE}
23 @html
24 <div class="pspp-syntax">
25 @end html
26 @cartouche
27 @smallexample
28 @verbatiminclude pspp-figures/\FILE\
29 @end smallexample
30 @end cartouche
31 @html
32 </div>
33 @end html
34 @end macro
36 @macro psppimage{FILE}
37 @cartouche
38 @ifhtml
39 @image{screenshots/\FILE\-ad} @c Adwaita theme is better for web pages.
40 @end ifhtml
41 @iftex
42 @image{screenshots/\FILE\-hc,433.62pt} @c High Contrast theme, width \\the\\hsize
43 @end iftex
44 @ifinfo
45 @image{screenshots/\FILE\-ad} @c Adwaita theme for stand aloneinfo
46 @end ifinfo
47 @end cartouche
48 @end macro
50 @macro psppoutput{FILE}
51 @c Use @image for Info and for plaintext output.
52 @ifinfo
54 @noindent @image{pspp-figures/\FILE\}
56 @end ifinfo
57 @ifplaintext
59 @noindent @image{pspp-figures/\FILE\}
61 @end ifplaintext
62 @c Use HTML for HTML output.
63 @ifhtml
64 @cartouche
65 @html
67 <div class="pspp">
68 @include pspp-figures/\FILE\.html
69 </div>
71 @end html
72 @end cartouche
73 @end ifhtml
74 @c Use the Texi-fied version of the plaintext output for other output formats.
75 @c Some of these could do better, but we have not yet implemented it.
76 @ifnotinfo
77 @ifnotplaintext
78 @ifnothtml
79 @smallexample
80 @include pspp-figures/\FILE\.texi
81 @end smallexample
82 @end ifnothtml
83 @end ifnotplaintext
84 @end ifnotinfo
85 @end macro
87 @macro note{param1}
88 @quotation
89 @strong{Please note:} \param1\
90 @end quotation
91 @end macro
93 @ifnottex
94 @macro times{}
96 @end macro
97 @macro ne{}
98
99 @end macro
100 @end ifnottex
102 @c A macro to indicate variable names used in examples.
103 @c NOT metasyntactical variables - for that use @var
104 @macro exvar{VAR}
105 @b{\VAR\}
106 @end macro
108 @include version.texi
110 @c This macro should be used for marking command names.  For the purposes of markup,
111 @c  no distinction is made between ``commands'' and ``procedures''.
112 @macro cmd{CMDNAME}
113 @code{\CMDNAME\}
114 @end macro
116 @c This macro is used for fragments of command syntax that are not in themselves command names.
117 @c It does not necessarily have to be a subcommand.
118 @macro subcmd{CMDNAME}
119 @code{\CMDNAME\}
120 @end macro
122 @c Use this macro to refer to PSPP itself .  Not when giving a shell command line example.
123 @macro pspp
124 @sc{pspp}
125 @end macro
127 @iftex
128 @finalout
129 @end iftex
131 @dircategory Math
132 @direntry
133 * PSPP: (pspp).             Statistical analysis package.
134 * PSPPIRE: (pspp).          Graphical user interface to @pspp{}.
135 @end direntry
137 @copying
138 This manual is for GNU PSPP version @value{VERSION},
139 software for statistical analysis.
141 Copyright @copyright{} 1997, 1998, 2004, 2005, 2009, 2012, 2013, 2014, 2016, 2019, 2020 Free Software Foundation, Inc.
143 @quotation
144 Permission is granted to copy, distribute and/or modify this document
145 under the terms of the GNU Free Documentation License, Version 1.3
146 or any later version published by the Free Software Foundation;
147 with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
148 A copy of the license is included in the section entitled "GNU
149 Free Documentation License".
150 @end quotation
151 @end copying
153 @titlepage
154 @title PSPP Users' Guide
155 @subtitle GNU PSPP Statistical Analysis Software
156 @subtitle Release @value{VERSION}
157 @page
158 @vskip 0pt plus 1filll
159 @insertcopying
160 @end titlepage
162 @contents
165 @ifnottex
166 @node Top
167 @top GNU PSPP
169 @insertcopying
170 @end ifnottex
172 @menu
173 * Introduction::                Description of the package.
174 * License::                     Your rights and obligations.
176 * Invoking PSPP::               Starting the PSPP text-based interface.
177 * Invoking PSPPIRE::            Starting the PSPP graphical user interface.
178 * Using PSPP::                  How to use PSPP --- A brief tutorial.
179 * Language::                    Basics of the PSPP command language.
180 * Expressions::                 Numeric and string expression syntax.
182 * Data Input and Output::       Reading data from user files.
183 * System and Portable File IO:: Reading and writing system & portable files.
184 * Combining Data Files::        Combining data from multiple files.
185 * Manipulating Variables::      Adjusting and examining variables.
186 * Data Manipulation::           Simple operations on data.
187 * Data Selection::              Select certain cases for analysis.
188 * Conditionals and Looping::    Doing things many times or not at all.
189 * Statistics::                  Basic statistical procedures.
190 * Matrices::                    Matrix operations and transformations.
191 * Utilities::                   Other commands.
193 * Invoking pspp-convert::       Utility for converting among file formats.
194 * Invoking pspp-output::        Utility for working with viewer (SPV) files.
195 * Invoking pspp-dump-sav::      Utility for examining raw .sav files.
196 * Not Implemented::             What's not here yet
197 * Bugs::                        Known problems; submitting bug reports.
199 * Function Index::              Index of PSPP functions for expressions.
200 * Command Index::               Index of PSPP procedures.
201 * Concept Index::               Index of concepts.
203 * GNU Free Documentation License:: License for copying this manual.
204 @end menu
206 @include introduction.texi
207 @include license.texi
209 @include invoking.texi
210 @include tutorial.texi
211 @include language.texi
212 @include expressions.texi
213 @include data-io.texi
214 @include files.texi
215 @include combining.texi
216 @include variables.texi
217 @include transformation.texi
218 @include data-selection.texi
219 @include flow-control.texi
220 @include statistics.texi
221 @include matrices.texi
222 @include utilities.texi
224 @include pspp-convert.texi
225 @include pspp-output.texi
226 @include pspp-dump-sav.texi
227 @include not-implemented.texi
228 @include bugs.texi
230 @include function-index.texi
231 @include command-index.texi
232 @include concept-index.texi
234 @include fdl.texi
236 @bye