Make configure create doc/examples so the Makefiles don't need to.
[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 @verbatiminclude \FILE\
28 @end cartouche
29 @html
30 </div>
31 @end html
32 @end macro
33
34 @macro psppoutput{FILE}
35 @ifnothtml
36 @verbatiminclude \FILE\.out
37 @end ifnothtml
38 @ifhtml
39 @cartouche
40 @html
41
42 <div class="pspp">
43 @include \FILE\.html
44 </div>
45
46 @end html
47 @end cartouche
48 @end ifhtml
49 @end macro
50
51 @macro note{param1}
52 @quotation
53 @strong{Please note:} \param1\
54 @end quotation
55 @end macro
56
57 @c A macro to indicate variable names used in examples.
58 @c NOT metasyntactical variables - for that use @var
59 @macro exvar{VAR}
60 @b{\VAR\}
61 @end macro
62
63 @include version.texi
64
65 @c This macro should be used for marking command names.  For the purposes of markup,
66 @c  no distinction is made between ``commands'' and ``procedures''.
67 @macro cmd{CMDNAME}
68 @code{\CMDNAME\}
69 @end macro
70
71 @c This macro is used for fragments of command syntax that are not in themselves command names.
72 @c It does not necessarily have to be a subcommand.
73 @macro subcmd{CMDNAME}
74 @code{\CMDNAME\}
75 @end macro
76
77 @c Use this macro to refer to PSPP itself .  Not when giving a shell command line example.
78 @macro pspp
79 @sc{pspp}
80 @end macro
81
82
83 @ifset MISSING_CLICKSEQUENCE
84 @alias clicksequence = asis
85 @macro click {}
86 ->
87 @end macro
88 @end ifset
89
90 @iftex
91 @finalout
92 @end iftex
93
94 @dircategory Math
95 @direntry
96 * PSPP: (pspp).             Statistical analysis package.
97 * PSPPIRE: (pspp).          Graphical user interface to @pspp{}.
98 @end direntry
99
100 @copying
101 This manual is for GNU PSPP version @value{VERSION},
102 software for statistical analysis.
103
104 Copyright @copyright{} 1997, 1998, 2004, 2005, 2009, 2012, 2013, 2014, 2016, 2019 Free Software Foundation, Inc.
105
106 @quotation
107 Permission is granted to copy, distribute and/or modify this document
108 under the terms of the GNU Free Documentation License, Version 1.3
109 or any later version published by the Free Software Foundation;
110 with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
111 A copy of the license is included in the section entitled "GNU
112 Free Documentation License".
113 @end quotation
114 @end copying
115
116 @titlepage
117 @title PSPP Users' Guide
118 @subtitle GNU PSPP Statistical Analysis Software
119 @subtitle Release @value{VERSION}
120 @page
121 @vskip 0pt plus 1filll
122 @insertcopying
123 @end titlepage
124
125 @contents
126
127
128 @ifnottex
129 @node Top
130 @top GNU PSPP
131
132 @insertcopying
133 @end ifnottex
134
135 @menu
136 * Introduction::                Description of the package.
137 * License::                     Your rights and obligations.
138
139 * Invoking PSPP::               Starting the PSPP text-based interface.
140 * Invoking PSPPIRE::            Starting the PSPP graphical user interface.
141 * Using PSPP::                  How to use PSPP --- A brief tutorial.
142 * Language::                    Basics of the PSPP command language.
143 * Expressions::                 Numeric and string expression syntax.
144
145 * Data Input and Output::       Reading data from user files.
146 * System and Portable File IO:: Reading and writing system & portable files.
147 * Combining Data Files::        Combining data from multiple files.
148 * Variable Attributes::         Adjusting and examining variables.
149 * Data Manipulation::           Simple operations on data.
150 * Data Selection::              Select certain cases for analysis.
151 * Conditionals and Looping::    Doing things many times or not at all.
152 * Statistics::                  Basic statistical procedures.
153 * Utilities::                   Other commands.
154
155 * Invoking pspp-convert::       Utility for converting among file formats.
156 * Invoking pspp-output::        Utility for working with viewer (SPV) files.
157 * Invoking pspp-dump-sav::      Utility for examining raw .sav files.
158 * Not Implemented::             What's not here yet
159 * Bugs::                        Known problems; submitting bug reports.
160
161 * Function Index::              Index of PSPP functions for expressions.
162 * Command Index::               Index of PSPP procedures.
163 * Concept Index::               Index of concepts.
164
165 * GNU Free Documentation License:: License for copying this manual.
166 @end menu
167
168 @include introduction.texi
169 @include license.texi
170
171 @include invoking.texi
172 @include tutorial.texi
173 @include language.texi
174 @include expressions.texi
175 @include data-io.texi
176 @include files.texi
177 @include combining.texi
178 @include variables.texi
179 @include transformation.texi
180 @include data-selection.texi
181 @include flow-control.texi
182 @include statistics.texi
183 @include utilities.texi
184
185 @include pspp-convert.texi
186 @include pspp-output.texi
187 @include pspp-dump-sav.texi
188 @include not-implemented.texi
189 @include bugs.texi
190
191 @include function-index.texi
192 @include command-index.texi
193 @include concept-index.texi
194
195 @include fdl.texi
196
197 @bye