lexer: Keep entire source file in memory.
[pspp] / doc / pspp.texi
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".
10
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
17
18 @macro gui
19 graphic user interface
20 @end macro
21
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
35
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
49
50 @macro psppoutput{FILE}
51 @c Use @image for Info and for plaintext output.
52 @ifinfo
53
54 @noindent @image{pspp-figures/\FILE\}
55
56 @end ifinfo
57 @ifplaintext
58
59 @noindent @image{pspp-figures/\FILE\}
60
61 @end ifplaintext
62 @c Use HTML for HTML output.
63 @ifhtml
64 @cartouche
65 @html
66
67 <div class="pspp">
68 @include pspp-figures/\FILE\.html
69 </div>
70
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
86
87 @macro note{param1}
88 @quotation
89 @strong{Please note:} \param1\
90 @end quotation
91 @end macro
92
93 @c A macro to indicate variable names used in examples.
94 @c NOT metasyntactical variables - for that use @var
95 @macro exvar{VAR}
96 @b{\VAR\}
97 @end macro
98
99 @include version.texi
100
101 @c This macro should be used for marking command names.  For the purposes of markup,
102 @c  no distinction is made between ``commands'' and ``procedures''.
103 @macro cmd{CMDNAME}
104 @code{\CMDNAME\}
105 @end macro
106
107 @c This macro is used for fragments of command syntax that are not in themselves command names.
108 @c It does not necessarily have to be a subcommand.
109 @macro subcmd{CMDNAME}
110 @code{\CMDNAME\}
111 @end macro
112
113 @c Use this macro to refer to PSPP itself .  Not when giving a shell command line example.
114 @macro pspp
115 @sc{pspp}
116 @end macro
117
118 @iftex
119 @finalout
120 @end iftex
121
122 @dircategory Math
123 @direntry
124 * PSPP: (pspp).             Statistical analysis package.
125 * PSPPIRE: (pspp).          Graphical user interface to @pspp{}.
126 @end direntry
127
128 @copying
129 This manual is for GNU PSPP version @value{VERSION},
130 software for statistical analysis.
131
132 Copyright @copyright{} 1997, 1998, 2004, 2005, 2009, 2012, 2013, 2014, 2016, 2019, 2020 Free Software Foundation, Inc.
133
134 @quotation
135 Permission is granted to copy, distribute and/or modify this document
136 under the terms of the GNU Free Documentation License, Version 1.3
137 or any later version published by the Free Software Foundation;
138 with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
139 A copy of the license is included in the section entitled "GNU
140 Free Documentation License".
141 @end quotation
142 @end copying
143
144 @titlepage
145 @title PSPP Users' Guide
146 @subtitle GNU PSPP Statistical Analysis Software
147 @subtitle Release @value{VERSION}
148 @page
149 @vskip 0pt plus 1filll
150 @insertcopying
151 @end titlepage
152
153 @contents
154
155
156 @ifnottex
157 @node Top
158 @top GNU PSPP
159
160 @insertcopying
161 @end ifnottex
162
163 @menu
164 * Introduction::                Description of the package.
165 * License::                     Your rights and obligations.
166
167 * Invoking PSPP::               Starting the PSPP text-based interface.
168 * Invoking PSPPIRE::            Starting the PSPP graphical user interface.
169 * Using PSPP::                  How to use PSPP --- A brief tutorial.
170 * Language::                    Basics of the PSPP command language.
171 * Expressions::                 Numeric and string expression syntax.
172
173 * Data Input and Output::       Reading data from user files.
174 * System and Portable File IO:: Reading and writing system & portable files.
175 * Combining Data Files::        Combining data from multiple files.
176 * Manipulating Variables::      Adjusting and examining variables.
177 * Data Manipulation::           Simple operations on data.
178 * Data Selection::              Select certain cases for analysis.
179 * Conditionals and Looping::    Doing things many times or not at all.
180 * Statistics::                  Basic statistical procedures.
181 * Matrices::                    Matrix operations and transformations.
182 * Utilities::                   Other commands.
183
184 * Invoking pspp-convert::       Utility for converting among file formats.
185 * Invoking pspp-output::        Utility for working with viewer (SPV) files.
186 * Invoking pspp-dump-sav::      Utility for examining raw .sav files.
187 * Not Implemented::             What's not here yet
188 * Bugs::                        Known problems; submitting bug reports.
189
190 * Function Index::              Index of PSPP functions for expressions.
191 * Command Index::               Index of PSPP procedures.
192 * Concept Index::               Index of concepts.
193
194 * GNU Free Documentation License:: License for copying this manual.
195 @end menu
196
197 @include introduction.texi
198 @include license.texi
199
200 @include invoking.texi
201 @include tutorial.texi
202 @include language.texi
203 @include expressions.texi
204 @include data-io.texi
205 @include files.texi
206 @include combining.texi
207 @include variables.texi
208 @include transformation.texi
209 @include data-selection.texi
210 @include flow-control.texi
211 @include statistics.texi
212 @include matrices.texi
213 @include utilities.texi
214
215 @include pspp-convert.texi
216 @include pspp-output.texi
217 @include pspp-dump-sav.texi
218 @include not-implemented.texi
219 @include bugs.texi
220
221 @include function-index.texi
222 @include command-index.texi
223 @include concept-index.texi
224
225 @include fdl.texi
226
227 @bye