From: John Darrington Date: Wed, 28 Mar 2012 19:18:18 +0000 (+0200) Subject: Documentation: Add a @pspp macro X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=620d94c8a41811d8dc8ba8a0f500896a9a894a18;hp=cdae9856ee4695fef212a4dcf24d81dff484c7d4;p=pspp Documentation: Add a @pspp macro --- diff --git a/doc/bugs.texi b/doc/bugs.texi index cbf10efbb6..96c1ed2227 100644 --- a/doc/bugs.texi +++ b/doc/bugs.texi @@ -3,12 +3,12 @@ @cindex bugs -Occasionally users encounter problems with PSPP. +Occasionally users encounter problems with @pspp{}. When such problems arise we do our best to fix them, but our limited resources mean that certain issues may remain for some time. If you discover a bug, please first: @itemize @bullet -@item Try an up to date version of PSPP; it may be that the problem +@item Try an up to date version of @pspp{}; it may be that the problem has recently been fixed. @item If the problem persists in the up to date version; check to see if it has already been reported. @@ -16,14 +16,14 @@ If you discover a bug, please first: been reported, please file a report. @end itemize -To see a list of reported bugs, visit PSPP's project webpage at +To see a list of reported bugs, visit @pspp{}'s project webpage at @uref{http://savannah.gnu.org/bugs/?group=pspp} Alternatively, bug reports may be sent by email to @email{bug-gnu-pspp@@gnu.org}. In your bug report please include: @itemize @bullet -@item The version of PSPP which you are using. +@item The version of @pspp{} which you are using. @item The operating system and type of computer on which it is running. @item A sample of the syntax which causes the problem or, if it is a user interface problem, the sequence of steps required to reproduce it. diff --git a/doc/combining.texi b/doc/combining.texi index a4f683d569..1f31ff64aa 100644 --- a/doc/combining.texi +++ b/doc/combining.texi @@ -67,7 +67,7 @@ be read as input. For each input file, specify FILE with a system file or portable file's name as a string, a dataset (@pxref{Datasets}) or file handle name, (@pxref{File Handles}), or an asterisk (@samp{*}) to use the active dataset as input. Use of portable files on FILE is a -PSPP extension. +@pspp{} extension. At least two FILE subcommands must be specified. If the active dataset is used as an input source, then @cmd{TEMPORARY} must not be in @@ -91,11 +91,11 @@ The DROP, KEEP, and RENAME subcommands have no effect on IN variables. If BY is used (see below), the SORT keyword must be specified after a FILE if that input file is not already sorted on the BY variables. -When SORT is specified, PSPP sorts the input file's data on the BY +When SORT is specified, @pspp{} sorts the input file's data on the BY variables before it applies it to the command. When SORT is used, BY -is required. SORT is a PSPP extension. +is required. SORT is a @pspp{} extension. -PSPP merges the dictionaries of all of the input files to form the +@pspp{} merges the dictionaries of all of the input files to form the dictionary of the new active dataset, like so: @itemize @bullet @@ -142,7 +142,7 @@ variables, then SORT must be specified for those input files. The variables listed on BY may include (A) or (D) annotations to specify ascending or descending sort order. @xref{SORT CASES}, for more details on this notation. Adding (A) or (D) to the BY subcommand -specification is a PSPP extension. +specification is a @pspp{} extension. The DROP subcommand can be used to specify a list of variables to exclude from the output. By contrast, the KEEP subcommand can be used @@ -193,7 +193,7 @@ Once per command: which replaces the active dataset, consists all of the cases in all of the input files. -ADD FILES shares the bulk of its syntax with other PSPP commands for +ADD FILES shares the bulk of its syntax with other @pspp{} commands for combining multiple data files. @xref{Combining Files Common Syntax}, above, for an explanation of this common syntax. @@ -232,7 +232,7 @@ Once per command: @cmd{MATCH FILES} merges sets of corresponding cases in multiple input files into single cases in the output, combining their data. -MATCH FILES shares the bulk of its syntax with other PSPP commands for +MATCH FILES shares the bulk of its syntax with other @pspp{} commands for combining multiple data files. @xref{Combining Files Common Syntax}, above, for an explanation of this common syntax. @@ -297,7 +297,7 @@ Once per command: @cmd{UPDATE} updates a @dfn{master file} by applying modifications from one or more @dfn{transaction files}. -UPDATE shares the bulk of its syntax with other PSPP commands for +UPDATE shares the bulk of its syntax with other @pspp{} commands for combining multiple data files. @xref{Combining Files Common Syntax}, above, for an explanation of this common syntax. @@ -316,7 +316,7 @@ case in the master file: When a match is found, then the values of the variables present in the transaction file replace those variable's values in the new active file. If there are matching cases in more than more transaction file, -PSPP applies the replacements from the first transaction file, then +@pspp{} applies the replacements from the first transaction file, then from the second transaction file, and so on. Similarly, if a single transaction file has cases with duplicate BY values, then those are applied in order to the master file. diff --git a/doc/data-io.texi b/doc/data-io.texi index cfb99eb792..dc916424a8 100644 --- a/doc/data-io.texi +++ b/doc/data-io.texi @@ -6,19 +6,19 @@ @cindex cases @cindex observations -Data are the focus of the PSPP language. +Data are the focus of the @pspp{} language. Each datum belongs to a @dfn{case} (also called an @dfn{observation}). Each case represents an individual or ``experimental unit''. For example, in the results of a survey, the names of the respondents, their sex, age, etc.@: and their responses are all data and the data pertaining to single respondent is a case. This chapter examines -the PSPP commands for defining variables and reading and writing data. +the @pspp{} commands for defining variables and reading and writing data. There are alternative commands to read data from predefined sources such as system files or databases (@xref{GET, GET DATA}.) @quotation Note -These commands tell PSPP how to read data, but the data will not +These commands tell @pspp{} how to read data, but the data will not actually be read until a procedure is executed. @end quotation @@ -56,7 +56,7 @@ END DATA. @end display @cmd{BEGIN DATA} and @cmd{END DATA} can be used to embed raw ASCII -data in a PSPP syntax file. @cmd{DATA LIST} or another input +data in a @pspp{} syntax file. @cmd{DATA LIST} or another input procedure must be used before @cmd{BEGIN DATA} (@pxref{DATA LIST}). @cmd{BEGIN DATA} and @cmd{END DATA} must be used together. @cmd{END DATA} must appear by itself on a single line, with no leading @@ -83,7 +83,7 @@ The file named INLINE, which represents data entered between @cmd{BEGIN DATA} and @cmd{END DATA}, cannot be closed. Attempts to close it with @cmd{CLOSE FILE HANDLE} have no effect. -@cmd{CLOSE FILE HANDLE} is a PSPP extension. +@cmd{CLOSE FILE HANDLE} is a @pspp{} extension. @node DATAFILE ATTRIBUTE @section DATAFILE ATTRIBUTE @@ -99,15 +99,15 @@ DATAFILE ATTRIBUTE @cmd{DATAFILE ATTRIBUTE} adds, modifies, or removes user-defined attributes associated with the active dataset. Custom data file -attributes are not interpreted by PSPP, but they are saved as part of +attributes are not interpreted by @pspp{}, but they are saved as part of system files and may be used by other software that reads them. Use the ATTRIBUTE subcommand to add or modify a custom data file attribute. Specify the name of the attribute as an identifier (@pxref{Tokens}), followed by the desired value, in parentheses, as a quoted string. Attribute names that begin with @code{$} are reserved -for PSPP's internal use, and attribute names that begin with @code{@@} -or @code{$@@} are not displayed by most PSPP commands that display +for @pspp{}'s internal use, and attribute names that begin with @code{@@} +or @code{$@@} are not displayed by most @pspp{} commands that display other attributes. Other attribute names are not treated specially. Attributes may also be organized into arrays. To assign to an array @@ -146,8 +146,8 @@ DATASET DISPLAY. @end display The @cmd{DATASET} commands simplify use of multiple datasets within a -PSPP session. They allow datasets to be created and destroyed. At -any given time, most PSPP commands work with a single dataset, called +@pspp{} session. They allow datasets to be created and destroyed. At +any given time, most @pspp{} commands work with a single dataset, called the active dataset. @vindex DATASET NAME @@ -188,7 +188,7 @@ all datasets except for the active dataset, which becomes unnamed. The DATASET DISPLAY command lists all the currently defined datasets. Many DATASET commands accept an optional WINDOW subcommand. In the -PSPPIRE GUI, the value given for this subcommand influences how the +@pspp{}IRE GUI, the value given for this subcommand influences how the dataset's window is displayed. Outside the GUI, the WINDOW subcommand has no effect. The valid values are: @@ -222,7 +222,7 @@ Used to read text or binary data, @cmd{DATA LIST} is the most fundamental data-reading command. Even the more sophisticated input methods use @cmd{DATA LIST} commands as a building block. Understanding @cmd{DATA LIST} is important to understanding how to use -PSPP to read your data files. +@pspp{} to read your data files. There are two major variants of @cmd{DATA LIST}, which are fixed format and free format. In addition, free format has a minor variant, @@ -415,7 +415,7 @@ Case NAME INFO1 INFO2 INFO3 3 Bill Yates 9 18 6 @end example -The @code{TABLE} keyword causes PSPP to print out a table +The @code{TABLE} keyword causes @pspp{} to print out a table describing the four variables defined. @item @@ -613,7 +613,7 @@ read as one record. In CHARACTER mode only, tabs are expanded to spaces by input programs, except by @cmd{DATA LIST FREE} with explicitly specified delimiters. -Each tab is 4 characters wide by default, but TABWIDTH (a PSPP +Each tab is 4 characters wide by default, but TABWIDTH (a @pspp{} extension) may be used to specify an alternate width. Use a TABWIDTH of 0 to suppress tab expansion. @@ -631,7 +631,7 @@ variable-length binary records. LRECL may be specified, but its value is ignored. The data for each record is both preceded and followed by a 32-bit signed integer in little-endian byte order that specifies the length of the record. (This redundancy permits records in these -files to be efficiently read in reverse order, although PSPP always +files to be efficiently read in reverse order, although @pspp{} always reads them in forward order.) The length does not include either integer. @@ -642,7 +642,7 @@ the modern successors of those operating systems. For more information, see @cite{OS/400 Tape and Diskette Device Programming}, available on IBM's website. -Alphanumeric data in mode 360 files are encoded in EBCDIC. PSPP +Alphanumeric data in mode 360 files are encoded in EBCDIC. @pspp{} translates EBCDIC to or from the host's native format as necessary on input or output, using an ASCII/EBCDIC translation that is one-to-one, so that a ``round trip'' from ASCII to EBCDIC back to ASCII, or vice @@ -701,7 +701,7 @@ buffer is also flushed at end of file regardless of the final record's SCC. The maximum length of a logical record in VARIABLE mode is limited -only by memory available to PSPP. Segments are limited to 65,527 +only by memory available to @pspp{}. Segments are limited to 65,527 bytes, as in VARIABLE mode. This format is similar to what IBM documentation call @code{*VS} @@ -732,7 +732,7 @@ END INPUT PROGRAM. @cmd{INPUT PROGRAM}@dots{}@cmd{END INPUT PROGRAM} specifies a complex input program. By placing data input commands within @cmd{INPUT -PROGRAM}, PSPP programs can take advantage of more complex file +PROGRAM}, @pspp{} programs can take advantage of more complex file structures than available with only @cmd{DATA LIST}. The first sort of extended input program is to simply put multiple @cmd{DATA @@ -959,7 +959,7 @@ are specified, PRINT outputs a single blank line. The OUTFILE subcommand specifies the file to receive the output. The file may be a file name as a string or a file handle (@pxref{File Handles}). If OUTFILE is not present then output will be sent to -PSPP's output listing file. When OUTFILE is present, a space is +@pspp{}'s output listing file. When OUTFILE is present, a space is inserted at beginning of each output line, even lines that otherwise would be blank. diff --git a/doc/data-selection.texi b/doc/data-selection.texi index d46dd310aa..d62782c1ce 100644 --- a/doc/data-selection.texi +++ b/doc/data-selection.texi @@ -1,7 +1,7 @@ @node Data Selection @chapter Selecting data for analysis -This chapter documents PSPP commands that temporarily or permanently +This chapter documents @pspp{} commands that temporarily or permanently select data records from the active dataset for analysis. @menu @@ -53,7 +53,7 @@ N [OF CASES] num_of_cases [ESTIMATED]. @cmd{N OF CASES} limits the number of cases processed by any procedures that follow it in the command stream. @code{N OF CASES -100}, for example, tells PSPP to disregard all cases after the first +100}, for example, tells @pspp{} to disregard all cases after the first 100. When @cmd{N OF CASES} is specified after @cmd{TEMPORARY}, it affects @@ -75,7 +75,7 @@ file. @cmd{N OF CASES} with the @code{ESTIMATED} keyword gives an estimated number of cases before @cmd{DATA LIST} or another command to read in data. @code{ESTIMATED} never limits the number of cases processed by -procedures. PSPP currently does not make use of case count estimates. +procedures. @pspp{} currently does not make use of case count estimates. @node SAMPLE @section SAMPLE diff --git a/doc/expressions.texi b/doc/expressions.texi index db842f2a1d..65778d0424 100644 --- a/doc/expressions.texi +++ b/doc/expressions.texi @@ -3,7 +3,7 @@ @cindex expressions, mathematical @cindex mathematical expressions -Expressions share a common syntax each place they appear in PSPP +Expressions share a common syntax each place they appear in @pspp{} commands. Expressions are made up of @dfn{operands}, which can be numbers, strings, or variable names, separated by @dfn{operators}. There are five types of operators: grouping, arithmetic, logical, @@ -30,7 +30,7 @@ full-fledged expressions in themselves. @cindex Boolean @cindex values, Boolean -Some PSPP operators and expressions work with Boolean values, which +Some @pspp{} operators and expressions work with Boolean values, which represent true/false conditions. Booleans have only three possible values: 0 (false), 1 (true), and system-missing (unknown). System-missing is neither true nor false and indicates that the true @@ -238,7 +238,7 @@ True if @var{a} is not equal to @var{b}. @cindex @code{(} @cindex @code{)} @cindex names, of functions -PSPP functions provide mathematical abilities above and beyond +@pspp{} functions provide mathematical abilities above and beyond those possible using simple operators. Functions have a common syntax: each is composed of a function name followed by a left parenthesis, one or more arguments, and a right parenthesis. @@ -349,7 +349,7 @@ results. @deftypefnx {Function} {} ACOS (@var{number}) Takes the arccosine, in radians, of @var{number}. Results in system-missing if @var{number} is not between -1 and 1 inclusive. -This function is a PSPP extension. +This function is a @pspp{} extension. @end deftypefn @cindex arcsine @@ -698,7 +698,7 @@ Returns @var{string}, changing lowercase letters to uppercase letters. @cindex dates @cindex dates, valid -For compatibility, PSPP considers dates before 15 Oct 1582 invalid. +For compatibility, @pspp{} considers dates before 15 Oct 1582 invalid. Most time and date functions will not accept earlier dates. @menu @@ -717,8 +717,8 @@ Most time and date functions will not accept earlier dates. @cindex time, concepts @cindex time, intervals -Times and dates are handled by PSPP as single numbers. A -@dfn{time} is an interval. PSPP measures times in seconds. +Times and dates are handled by @pspp{} as single numbers. A +@dfn{time} is an interval. @pspp{} measures times in seconds. Thus, the following intervals correspond with the numeric values given: @example @@ -731,9 +731,9 @@ Thus, the following intervals correspond with the numeric values given: @cindex dates, concepts @cindex time, instants of A @dfn{date}, on the other hand, is a particular instant in the past -or the future. PSPP represents a date as a number of seconds since +or the future. @pspp{} represents a date as a number of seconds since midnight preceding 14 Oct 1582. Because midnight preceding the dates -given below correspond with the numeric PSPP dates given: +given below correspond with the numeric @pspp{} dates given: @example 15 Oct 1582 86,400 @@ -773,7 +773,7 @@ vice versa. @cindex examination, of times @cindex time, lengths of -These functions take numeric arguments in PSPP time format and +These functions take numeric arguments in @pspp{} time format and give numeric results. @cindex days @@ -886,18 +886,18 @@ Results in a date value corresponding to the day @cindex date examination @cindex arguments, of date extraction functions -These functions take numeric arguments in PSPP date or time +These functions take numeric arguments in @pspp{} date or time format and give numeric results. These names are used for arguments: @table @var @item date -A numeric value in PSPP date format. +A numeric value in @pspp{} date format. @item time -A numeric value in PSPP time format. +A numeric value in @pspp{} time format. @item time-or-date -A numeric value in PSPP time or date format. +A numeric value in @pspp{} time or date format. @end table @cindex days @@ -1025,7 +1025,7 @@ accuracy of some procedures may be affected. If necessary, convert times or dates in seconds to some other unit, like days or years, before performing analysis. -PSPP supplies a few functions for date arithmetic: +@pspp{} supplies a few functions for date arithmetic: @deftypefn {Function} {} DATEDIFF (@var{date2}, @var{date1}, @var{unit}) Returns the span of time from @var{date1} to @var{date2} in terms of @@ -1098,7 +1098,7 @@ use of a large value will increase memory consumption. @cindex Julian date @deftypefn {Function} {} YRMODA (@var{year}, @var{month}, @var{day}) @var{year} is a year, either between 0 and 99 or at least 1582. -Unlike other PSPP date functions, years between 0 and 99 always +Unlike other @pspp{} date functions, years between 0 and 99 always correspond to 1900 through 1999. @var{month} is a month between 1 and 13. @var{day} is a day between 0 and 31. A @var{day} of 0 refers to the last day of the previous month, and a @var{month} of 13 refers to @@ -1121,7 +1121,7 @@ associated label, then this function returns the empty string. @node Statistical Distribution Functions @subsection Statistical Distribution Functions -PSPP can calculate several functions of standard statistical +@pspp{} can calculate several functions of standard statistical distributions. These functions are named systematically based on the function and the distribution. The table below describes the statistical distribution functions in general: @@ -1236,7 +1236,7 @@ Exponential distribution with scale parameter @var{a}. The inverse of Exponential power distribution with positive scale parameter @var{a} and nonnegative power parameter @var{b}. Constraints: @var{a} > 0, @var{b} >= 0, @var{x} >= 0, 0 <= @var{p} <= 1. This distribution is a -PSPP extension. +@pspp{} extension. @end deftypefn @deftypefn {Function} {} PDF.F (@var{x}, @var{df1}, @var{df2}) @@ -1341,7 +1341,7 @@ Equivalent to RV.NORMAL(0, @var{sigma}). @deftypefn {Function} {} PDF.NTAIL (@var{x}, @var{a}, @var{sigma}) @deftypefnx {Function} {} RV.NTAIL (@var{a}, @var{sigma}) Normal tail distribution with lower limit @var{a} and standard -deviation @var{sigma}. This distribution is a PSPP extension. +deviation @var{sigma}. This distribution is a @pspp{} extension. Constraints: @var{a} > 0, @var{x} > @var{a}, 0 < @var{p} < 1. @end deftypefn @@ -1359,14 +1359,14 @@ parameter @var{b}. Constraints: @var{a} > 0, @var{b} > 0, @var{x} >= @deftypefnx {Function} {} IDF.RAYLEIGH (@var{p}, @var{sigma}) @deftypefnx {Function} {} RV.RAYLEIGH (@var{sigma}) Rayleigh distribution with scale parameter @var{sigma}. This -distribution is a PSPP extension. Constraints: @var{sigma} > 0, +distribution is a @pspp{} extension. Constraints: @var{sigma} > 0, @var{x} > 0. @end deftypefn @deftypefn {Function} {} PDF.RTAIL (@var{x}, @var{a}, @var{sigma}) @deftypefnx {Function} {} RV.RTAIL (@var{a}, @var{sigma}) Rayleigh tail distribution with lower limit @var{a} and scale -parameter @var{sigma}. This distribution is a PSPP extension. +parameter @var{sigma}. This distribution is a @pspp{} extension. Constraints: @var{a} > 0, @var{sigma} > 0, @var{x} > @var{a}. @end deftypefn @@ -1399,14 +1399,14 @@ distribution takes an additional parameter @var{lambda}. Constraints: @deftypefnx {Function} {} CDF.T1G (@var{x}, @var{a}, @var{b}) @deftypefnx {Function} {} IDF.T1G (@var{p}, @var{a}, @var{b}) Type-1 Gumbel distribution with parameters @var{a} and @var{b}. This -distribution is a PSPP extension. Constraints: 0 < @var{p} < 1. +distribution is a @pspp{} extension. Constraints: 0 < @var{p} < 1. @end deftypefn @deftypefn {Function} {} PDF.T2G (@var{x}, @var{a}, @var{b}) @deftypefnx {Function} {} CDF.T2G (@var{x}, @var{a}, @var{b}) @deftypefnx {Function} {} IDF.T2G (@var{p}, @var{a}, @var{b}) Type-2 Gumbel distribution with parameters @var{a} and @var{b}. This -distribution is a PSPP extension. Constraints: @var{x} > 0, 0 < +distribution is a @pspp{} extension. Constraints: @var{x} > 0, 0 < @var{p} < 1. @end deftypefn diff --git a/doc/files.texi b/doc/files.texi index 86aecab52c..a68e0031d7 100644 --- a/doc/files.texi +++ b/doc/files.texi @@ -172,17 +172,17 @@ Each may be present any number of times. @cmd{GET} never modifies a file on disk. Only the active dataset read from the file is affected by these subcommands. -PSPP tries to automatically detect the encoding of string data in the +@pspp{} tries to automatically detect the encoding of string data in the file. Sometimes, however, this does not work well encoding, -especially for files written by old versions of SPSS or PSPP. Specify +especially for files written by old versions of SPSS or @pspp{}. Specify the ENCODING subcommand with an IANA character set name as its string -argument to override the default. The ENCODING subcommand is a PSPP +argument to override the default. The ENCODING subcommand is a @pspp{} extension. @cmd{GET} does not cause the data to be read, only the dictionary. The data is read later, when a procedure is executed. -Use of @cmd{GET} to read a portable file is a PSPP extension. +Use of @cmd{GET} to read a portable file is a @pspp{} extension. @node GET DATA @section GET DATA @@ -201,7 +201,7 @@ and data read from the specified source. The TYPE subcommand is mandatory and must be the first subcommand specified. It determines the type of the file or source to read. -PSPP currently supports the following file types: +@pspp{} currently supports the following file types: @table @asis @item GNM @@ -311,8 +311,8 @@ The server may be located locally or remotely. Variables are automatically created based on the table column names or the names specified in the SQL query. Postgres data types of high precision, will loose precision when -imported into PSPP. -Not all the postgres data types are able to be represented in PSPP. +imported into @pspp{}. +Not all the postgres data types are able to be represented in @pspp{}. If a datum cannot be represented a warning will be issued and that datum will be set to SYSMIS. @@ -345,7 +345,7 @@ The default value is 4096. If your SQL statement fetches a large number of cases but only a small number of variables, then the data transfer may be faster if you increase this value. Conversely, if the number of variables is large, or if the machine on which -PSPP is running has only a +@pspp{} is running has only a small amount of memory, then a smaller value will be better. @@ -397,7 +397,7 @@ percent, approximately, of the cases contained in the file. (The percentage is approximate, because there is no way to accurately count the number of cases in the file without reading the entire file. The number of cases in some kinds of unusual files cannot be estimated; -PSPP will read all cases in such files.) +@pspp{} will read all cases in such files.) FIRSTCASE and IMPORTCASE may be used with delimited and fixed-format data. The remaining subcommands, which apply only to one of the two file @@ -456,7 +456,7 @@ can be used to quote values within fields in the input. A field that begins with one of the specified quote characters ends at the next matching quote. Intervening delimiters become part of the field, instead of terminating it. The ability to specify more than one quote -character is a PSPP extension. +character is a @pspp{} extension. By default, a character specified on QUALIFIER cannot itself be embedded within a field that it quotes, because the quote character @@ -465,7 +465,7 @@ quote character within a quoted field inserts a single instance of the quote into the field. For example, if @samp{'} is specified on QUALIFIER, then without ESCAPE @code{'a''b'} specifies a pair of fields that contain @samp{a} and @samp{b}, but with ESCAPE it -specifies a single field that contains @samp{a'b}. ESCAPE is a PSPP +specifies a single field that contains @samp{a'b}. ESCAPE is a @pspp{} extension. The DELCASE subcommand controls how data may be broken across lines in @@ -662,7 +662,7 @@ DROP, KEEP, and RENAME follow the syntax used by @cmd{GET} (@pxref{GET}). @cmd{IMPORT} does not cause the data to be read, only the dictionary. The data is read later, when a procedure is executed. -Use of @cmd{IMPORT} to read a system file is a PSPP extension. +Use of @cmd{IMPORT} to read a system file is a @pspp{} extension. @node SAVE @section SAVE @@ -902,7 +902,7 @@ XEXPORT The @cmd{EXPORT} transformation writes the active dataset dictionary and data to a specified portable file. -This transformation is a PSPP extension. +This transformation is a @pspp{} extension. It is similar to the @cmd{EXPORT} procedure, with two differences: diff --git a/doc/flow-control.texi b/doc/flow-control.texi index b396e1f3b1..bee6df1484 100644 --- a/doc/flow-control.texi +++ b/doc/flow-control.texi @@ -5,7 +5,7 @@ @cindex flow of control @cindex control flow -This chapter documents PSPP commands used for conditional execution, +This chapter documents @pspp{} commands used for conditional execution, looping, and flow of control. @menu diff --git a/doc/installing.texi b/doc/installing.texi index 5a9c2791c8..4482f42f97 100644 --- a/doc/installing.texi +++ b/doc/installing.texi @@ -1,19 +1,19 @@ @node Installation -@appendix Installing PSPP +@appendix Installing @pspp{} @cindex installation -@cindex PSPP, installing +@cindex @pspp{}, installing @cindex GNU C compiler @cindex gcc @cindex compiler, recommended @cindex compiler, gcc -PSPP is written in ISO C and primarily targeted at UNIX-like -environments. To install PSPP under a UNIX-like operating system, +@pspp{} is written in ISO C and primarily targeted at UNIX-like +environments. To install @pspp{} under a UNIX-like operating system, follow the steps below. @enumerate @item -@code{cd} to the directory containing the PSPP source. +@code{cd} to the directory containing the @pspp{} source. @cindex configure, GNU @cindex GNU configure @@ -36,23 +36,23 @@ correctly under your configuration, contact the author. @cindex self-tests, running @item -Type @samp{make check} to run self-tests on the compiled PSPP package. +Type @samp{make check} to run self-tests on the compiled @pspp{} package. @cindex installation -@cindex PSPP, installing +@cindex @pspp{}, installing @cindex @file{/usr/local/share/pspp/} @cindex @file{/usr/local/bin/} @cindex @file{/usr/local/info/} @cindex documentation, installing @item Become the superuser and type @samp{make install} to install the -PSPP binaries, by default in @file{/usr/local/bin/}. The +@pspp{} binaries, by default in @file{/usr/local/bin/}. The directory @file{/usr/local/share/pspp/} is created and populated with -files needed by PSPP at runtime. This step will also cause the -PSPP documentation to be installed in @file{/usr/local/info/}, +files needed by @pspp{} at runtime. This step will also cause the +@pspp{} documentation to be installed in @file{/usr/local/info/}, but only if that directory already exists. @item -(optional) Type @samp{make clean} to delete the PSPP binaries +(optional) Type @samp{make clean} to delete the @pspp{} binaries from the source tree. @end enumerate diff --git a/doc/introduction.texi b/doc/introduction.texi index f96a2329e3..4ab79595e8 100644 --- a/doc/introduction.texi +++ b/doc/introduction.texi @@ -2,18 +2,18 @@ @chapter Introduction @cindex introduction -@cindex PSPP language -@cindex language, PSPP -PSPP is a tool for statistical analysis of sampled data. It reads a +@cindex @pspp{} language +@cindex language, @pspp{} +@pspp{} is a tool for statistical analysis of sampled data. It reads a syntax file and a data file, analyzes the data, and writes the results to a listing file or to standard output. -The language accepted by PSPP is similar to those accepted by SPSS -statistical products. The details of PSPP's language are given +The language accepted by @pspp{} is similar to those accepted by SPSS +statistical products. The details of @pspp{}'s language are given later in this manual. -@cindex files, PSPP -@cindex output, PSPP +@cindex files, @pspp{} +@cindex output, @pspp{} @cindex PostScript @cindex PDF @cindex HTML @@ -21,13 +21,13 @@ later in this manual. @cindex graphics @cindex Ghostscript @cindex Free Software Foundation -PSPP produces tables and charts as output, which it can produce in +@pspp{} produces tables and charts as output, which it can produce in several formats; currently, ASCII, PostScript, PDF, HTML, and SVG are supported. -The current version of PSPP, @value{VERSION}, is woefully incomplete in -terms of its statistical procedure support. PSPP is a work in progress. +The current version of @pspp{}, @value{VERSION}, is woefully incomplete in +terms of its statistical procedure support. @pspp{} is a work in progress. The author hopes to fully support all features in the products -that PSPP replaces, eventually. The author welcomes questions, +that @pspp{} replaces, eventually. The author welcomes questions, comments, donations, and code submissions. @xref{Bugs,,Submitting Bug Reports}, for instructions on contacting the author. diff --git a/doc/invoking.texi b/doc/invoking.texi index 08a187ec80..7dcee49158 100644 --- a/doc/invoking.texi +++ b/doc/invoking.texi @@ -1,12 +1,12 @@ @node Invoking PSPP @chapter Invoking @command{pspp} @cindex invocation -@cindex PSPP, invoking +@cindex @pspp{}, invoking -PSPP has two separate user interfaces. This chapter describes -@command{pspp}, PSPP's command-line driven text-based user interface. +@pspp{} has two separate user interfaces. This chapter describes +@command{pspp}, @pspp{}'s command-line driven text-based user interface. The following chapter briefly describes PSPPIRE, the graphical user -interface to PSPP. +interface to @pspp{}. The sections below describe the @command{pspp} program's command-line interface. @@ -73,20 +73,20 @@ corresponding short options. @table @code @item @var{syntax-file} Read and execute the named syntax file. If no syntax files are -specified, PSPP prompts for commands. If any syntax files are -specified, PSPP by default exits after it runs them, but you may make +specified, @pspp{} prompts for commands. If any syntax files are +specified, @pspp{} by default exits after it runs them, but you may make it prompt for commands by specifying @samp{-} as an additional syntax file. @item -o @var{output-file} -Write output to @var{output-file}. PSPP has several different output +Write output to @var{output-file}. @pspp{} has several different output drivers that support output in various formats (use @option{--help} to list the available formats). Specify this option more than once to produce multiple output files, presumably in different formats. Use @samp{-} as @var{output-file} to write output to standard output. -If no @option{-o} option is used, then PSPP writes output to standard +If no @option{-o} option is used, then @pspp{} writes output to standard output in plain text format. @item -O @var{option}=@var{value} @@ -95,14 +95,14 @@ Sets an option for the output file configured by a preceding A few options that apply generically are listed below. @item -O format=@var{format} -PSPP uses the extension of the file name given on @option{-o} to +@pspp{} uses the extension of the file name given on @option{-o} to select an output format. Use this option to override this choice by specifying an alternate format, e.g.@: @option{-o pspp.out -O html} to write HTML to a file named @file{pspp.out}. Use @option{--help} to list the available formats. @item -O device=@{terminal|listing@} -Sets whether PSPP considers the output device configured by the +Sets whether @pspp{} considers the output device configured by the preceding @option{-o} to be a terminal or a listing device. This affects what output will be sent to the device, as configured by the SET command's output routing subcommands (@pxref{SET}). By default, @@ -116,7 +116,7 @@ no effect. @item -e @var{error-file} @itemx --error-file=@var{error-file} -Configures a file to receive PSPP error, warning, and note messages in +Configures a file to receive @pspp{} error, warning, and note messages in plain text format. Use @samp{-} as @var{error-file} to write messages to standard output. The default error file is standard output in the absence of these options, but this is suppressed if an output device @@ -134,7 +134,7 @@ Appends @var{dir} to the set of directories searched by INCLUDE Clears all directories from the include path, including directories inserted in the include path by default. The default include path is @file{.} (the current directory), followed by @file{.pspp} in the -user's home directory, followed by PSPP's system configuration +user's home directory, followed by @pspp{}'s system configuration directory (usually @file{/etc/pspp} or @file{/usr/local/etc/pspp}). @item -b @@ -147,13 +147,13 @@ interactive mode, respectively, rather than the default ``auto'' mode. @item -r @itemx --no-statrc -Disables running @file{rc} at PSPP startup time. +Disables running @file{rc} at @pspp{} startup time. @item -a @{enhanced|compatible@} @itemx --algorithm=@{enhanced|compatible@} -With @code{enhanced}, the default, PSPP uses the best implemented +With @code{enhanced}, the default, @pspp{} uses the best implemented algorithms for statistical procedures. With @code{compatible}, -however, PSPP will in some cases use inferior algorithms to produce +however, @pspp{} will in some cases use inferior algorithms to produce the same results as the proprietary program SPSS. Some commands have subcommands that override this setting on a per @@ -161,24 +161,24 @@ command basis. @item -x @{enhanced|compatible@} @itemx --syntax=@{enhanced|compatible@} -With @code{enhanced}, the default, PSPP accepts its own extensions +With @code{enhanced}, the default, @pspp{} accepts its own extensions beyond those compatible with the proprietary program SPSS. With -@code{compatible}, PSPP rejects syntax that uses these extensions. +@code{compatible}, @pspp{} rejects syntax that uses these extensions. @item --syntax-encoding=@var{encoding} Specifies @var{encoding} as the encoding for syntax files named on the command line. The @var{encoding} also becomes the default encoding -for other syntax files read during the PSPP session by the +for other syntax files read during the @pspp{} session by the @cmd{INCLUDE} and @cmd{INSERT} commands. @xref{INSERT}, for the accepted forms of @var{encoding}. @item --help -Prints a message describing PSPP command-line syntax and the available +Prints a message describing @pspp{} command-line syntax and the available device formats, then exits. @item -V @itemx --version -Prints a brief message listing PSPP's version, warranties you don't +Prints a brief message listing @pspp{}'s version, warranties you don't have, copying conditions and copyright, and e-mail address for bug reports, then exits. @@ -188,7 +188,7 @@ Disables certain unsafe operations. This includes the ERASE and HOST commands, as well as use of pipes as input and output files. @item --testing-mode -Invoke heuristics to assist with testing PSPP. For use by @code{make +Invoke heuristics to assist with testing @pspp{}. For use by @code{make check} and similar scripts. @end table @@ -199,12 +199,12 @@ check} and similar scripts. @cindex SVG To produce output in PDF, PostScript, and SVG formats, specify -@option{-o @var{file}} on the PSPP command line, optionally followed +@option{-o @var{file}} on the @pspp{} command line, optionally followed by any of the options shown in the table below to customize the output format. PDF, PostScript, and SVG output is only available if your installation -of PSPP was compiled with the Cairo library. +of @pspp{} was compiled with the Cairo library. @table @code @item -O format=@{pdf|ps|svg@} @@ -277,9 +277,9 @@ millimeters. @node Plain Text Output Options @section Plain Text Output Options -PSPP can produce plain text output, drawing boxes using ASCII or +@pspp{} can produce plain text output, drawing boxes using ASCII or Unicode line drawing characters. To produce plain text output, -specify @option{-o @var{file}} on the PSPP command line, optionally +specify @option{-o @var{file}} on the @pspp{} command line, optionally followed by options from the table below to customize the output format. @@ -298,16 +298,16 @@ default is the file name specified on @option{-o} with the extension stripped off and replaced by @file{-#.png}. Specify @code{none} to disable chart output. Charts are always -disabled if your installation of PSPP was compiled without the +disabled if your installation of @pspp{} was compiled without the Cairo library. @item -O paginate=@var{boolean} -If set, PSPP writes an ASCII formfeed the end of every page. Default: +If set, @pspp{} writes an ASCII formfeed the end of every page. Default: @code{off}. @item -O headers=@var{boolean} -If enabled, PSPP prints two lines of header information giving title -and subtitle, page number, date and time, and PSPP version are printed +If enabled, @pspp{} prints two lines of header information giving title +and subtitle, page number, date and time, and @pspp{} version are printed at the top of every page. These two lines are in addition to any top margin requested. Default: @code{off}. @@ -324,11 +324,11 @@ number to track the width of the terminal as it changes. Default: @code{79}. @item -O top-margin=@var{top-margin-lines} -Length of the top margin, in lines. PSPP subtracts this value from +Length of the top margin, in lines. @pspp{} subtracts this value from the page length. Default: @code{0}. @item -O bottom-margin=@var{bottom-margin-lines} -Length of the bottom margin, in lines. PSPP subtracts this value from +Length of the bottom margin, in lines. @pspp{} subtracts this value from the page length. Default: @code{0}. @item -O box=@{ascii|unicode@} @@ -347,7 +347,7 @@ you might pass the output. Default: @code{none}. @section HTML Output Options @cindex HTML To produce output in HTML format, specify @option{-o @var{file}} on -the PSPP command line, optionally followed by any of the options shown +the @pspp{} command line, optionally followed by any of the options shown in the table below to customize the output format. @table @code @@ -374,10 +374,10 @@ The default value is true. @section OpenDocument Output Options To produce output as an OpenDocument text (ODT) document, specify -@option{-o @var{file}} on the PSPP command line. If @var{file} does +@option{-o @var{file}} on the @pspp{} command line. If @var{file} does not end in @file{.odt}, you must also specify @option{-O format=odt}. -ODT support is only available if your installation of PSPP was +ODT support is only available if your installation of @pspp{} was compiled with the libxml2 library. The OpenDocument output format does not have any configurable options. @@ -386,7 +386,7 @@ The OpenDocument output format does not have any configurable options. @section Comma-Separated Value Output Options To produce output in comma-separated value (CSV) format, specify -@option{-o @var{file}} on the PSPP command line, optionally followed +@option{-o @var{file}} on the @pspp{} command line, optionally followed by any of the options shown in the table below to customize the output format. @@ -440,9 +440,9 @@ Successive output items are separated by a blank line. @chapter Invoking @command{psppire} @section The graphic user interface @cindex Graphic user interface -@cindex PSPPIRE +@cindex @pspp{}IRE -The PSPPIRE graphic user interface for PSPP can perform all +The @pspp{}IRE graphic user interface for @pspp{} can perform all functionality of the command line interface. In addition it gives an instantaneous view of the data, variables and statistical output. @@ -451,6 +451,6 @@ command prompt. Alternatively many systems have a system of interactive menus or buttons from which @command{psppire} can be started by a series of mouse clicks. -Once the principles of the PSPP system are understood, +Once the principles of the @pspp{} system are understood, the graphic user interface is designed to be largely intuitive, and for this reason is covered only very briefly by this manual. diff --git a/doc/language.texi b/doc/language.texi index a5ef4b69d6..96c9598b82 100644 --- a/doc/language.texi +++ b/doc/language.texi @@ -1,9 +1,9 @@ @node Language -@chapter The PSPP language -@cindex language, PSPP -@cindex PSPP, language +@chapter The @pspp{} language +@cindex language, @pspp{} +@cindex @pspp{}, language -This chapter discusses elements common to many PSPP commands. +This chapter discusses elements common to many @pspp{} commands. Later chapters will describe individual commands in detail. @menu @@ -14,7 +14,7 @@ Later chapters will describe individual commands in detail. * Order of Commands:: Commands combine to form syntax files. * Missing Observations:: Handling missing observations. * Datasets:: Data organization. -* Files:: Files used by PSPP. +* Files:: Files used by @pspp{}. * File Handles:: How files are named. * BNF:: How command syntax is described. @end menu @@ -27,10 +27,10 @@ Later chapters will describe individual commands in detail. @cindex tokens @cindex lexical analysis -PSPP divides most syntax file lines into series of short chunks +@pspp{} divides most syntax file lines into series of short chunks called @dfn{tokens}. Tokens are then grouped to form commands, each of which tells -PSPP to take some action---read in data, write out data, perform +@pspp{} to take some action---read in data, write out data, perform a statistical procedure, etc. Each type of token is described below. @@ -155,11 +155,11 @@ of, e.g.@:, an identifier or a floating-point number. @node Commands @section Forming commands of tokens -@cindex PSPP, command structure +@cindex @pspp{}, command structure @cindex language, command structure @cindex commands, structure -Most PSPP commands share a common structure. A command begins with a +Most @pspp{} commands share a common structure. A command begins with a command name, such as @cmd{FREQUENCIES}, @cmd{DATA LIST}, or @cmd{N OF CASES}. The command name may be abbreviated to its first word, and each word in the command name may be abbreviated to its first three @@ -207,23 +207,23 @@ accepted regardless of syntax mode. The default mode for reading commands from a file is @dfn{auto mode}. It is the same as batch mode, except that a line with a non-blank in the leftmost column only starts a new command if that line begins with -the name of a PSPP command. This correctly interprets most valid PSPP +the name of a @pspp{} command. This correctly interprets most valid @pspp{} syntax files regardless of the syntax mode for which they are intended. The @option{--interactive} (or @option{-i}) or @option{--batch} (or -@option{-b}) options set the syntax mode for files listed on the PSPP +@option{-b}) options set the syntax mode for files listed on the @pspp{} command line. @xref{Main Options}, for more details. @node Types of Commands @section Types of Commands -Commands in PSPP are divided roughly into six categories: +Commands in @pspp{} are divided roughly into six categories: @table @strong @item Utility commands @cindex utility commands -Set or display various global options that affect PSPP operations. +Set or display various global options that affect @pspp{} operations. May appear anywhere in a syntax file. @xref{Utilities, , Utility commands}. @@ -263,17 +263,17 @@ active dataset (the data) to be read. @cindex commands, ordering @cindex order of commands -PSPP does not place many restrictions on ordering of commands. The +@pspp{} does not place many restrictions on ordering of commands. The main restriction is that variables must be defined before they are otherwise referenced. This section describes the details of command ordering, but most users will have no need to refer to them. -PSPP possesses five internal states, called initial, INPUT PROGRAM, +@pspp{} possesses five internal states, called initial, INPUT PROGRAM, FILE TYPE, transformation, and procedure states. (Please note the distinction between the @cmd{INPUT PROGRAM} and @cmd{FILE TYPE} @emph{commands} and the INPUT PROGRAM and FILE TYPE @emph{states}.) -PSPP starts in the initial state. Each successful completion +@pspp{} starts in the initial state. Each successful completion of a command may cause a state transition. Each type of command has its own rules for state transitions: @@ -361,7 +361,7 @@ Cause a transition to the procedure state. @cindex missing values @cindex values, missing -PSPP includes special support for unknown numeric data values. +@pspp{} includes special support for unknown numeric data values. Missing observations are assigned a special value, called the @dfn{system-missing value}. This ``value'' actually indicates the absence of a value; it means that the actual value is unknown. Procedures @@ -390,14 +390,14 @@ handle missing values. @cindex variable @cindex dictionary -PSPP works with data organized into @dfn{datasets}. A dataset +@pspp{} works with data organized into @dfn{datasets}. A dataset consists of a set of @dfn{variables}, which taken together are said to form a @dfn{dictionary}, and one or more @dfn{cases}, each of which has one value for each variable. -At any given time PSPP has exactly one distinguished dataset, called -the @dfn{active dataset}. Most PSPP commands work only with the -active dataset. In addition to the active dataset, PSPP also supports +At any given time @pspp{} has exactly one distinguished dataset, called +the @dfn{active dataset}. Most @pspp{} commands work only with the +active dataset. In addition to the active dataset, @pspp{} also supports any number of additional open datasets. The @cmd{DATASET} commands can choose a new active dataset from among those that are open, as well as create and destroy datasets (@pxref{DATASET}). @@ -406,7 +406,7 @@ The sections below describe variables in more detail. @menu * Attributes:: Attributes of variables. -* System Variables:: Variables automatically defined by PSPP. +* System Variables:: Variables automatically defined by @pspp{}. * Sets of Variables:: Lists of variable names. * Input and Output Formats:: Input and output formats. * Scratch Variables:: Variables deleted by procedures. @@ -436,11 +436,11 @@ on a line: @code{FOO.} will be divided into two separate tokens, @cindex @samp{_} The final character in a variable name should not be @samp{_}, because -some such identifiers are used for special purposes by PSPP +some such identifiers are used for special purposes by @pspp{} procedures. -As with all PSPP identifiers, variable names are not case-sensitive. -PSPP capitalizes variable names on output the same way they were +As with all @pspp{} identifiers, variable names are not case-sensitive. +@pspp{} capitalizes variable names on output the same way they were capitalized at their point of definition in the input. @cindex variables, type @@ -505,7 +505,7 @@ ATTRIBUTE}. @end table @node System Variables -@subsection Variables Automatically Defined by PSPP +@subsection Variables Automatically Defined by @pspp{} @cindex system variables @cindex variables, system @@ -522,12 +522,12 @@ shuffled around. @cindex @code{$DATE} @item $DATE -Date the PSPP process was started, in format A9, following the +Date the @pspp{} process was started, in format A9, following the pattern @code{DD MMM YY}. @cindex @code{$JDATE} @item $JDATE -Number of days between 15 Oct 1582 and the time the PSPP process +Number of days between 15 Oct 1582 and the time the @pspp{} process was started. @cindex @code{$LENGTH} @@ -586,7 +586,7 @@ input field as a number or a string. It might specify that the field contains an ordinary decimal number, a time or date, a number in binary or hexadecimal notation, or one of several other notations. Input formats are used by commands such as @cmd{DATA LIST} that read data or -syntax files into the PSPP active dataset. +syntax files into the @pspp{} active dataset. Every input format corresponds to a default @dfn{output format} that specifies the formatting used when the value is output later. It is @@ -605,7 +605,7 @@ created variables have identical print and write formats, and most of the time, the distinction between print and write formats is unimportant. -Input and output formats are specified to PSPP with a @dfn{format +Input and output formats are specified to @pspp{} with a @dfn{format specification} of the form @code{TYPEw} or @code{TYPEw.d}, where @code{TYPE} is one of the format types described later, @code{w} is a field width measured in columns, and @code{d} is an optional number of @@ -613,7 +613,7 @@ decimal places. If @code{d} is omitted, a value of 0 is assumed. Some formats do not allow a nonzero @code{d} to be specified. The following sections describe the input and output formats supported -by PSPP. +by @pspp{}. @menu * Basic Numeric Formats:: @@ -1055,7 +1055,7 @@ lowercase are accepted on input; output is in uppercase. Other than the hexadecimal representation, these formats are equivalent to PIB and RB formats, respectively. However, bytes in PIBHEX format are always ordered with the most-significant byte first (big-endian -order), regardless of the host machine's native byte order or PSPP +order), regardless of the host machine's native byte order or @pspp{} settings. Field widths must be even and between 2 and 16. RBHEX format allows no @@ -1067,10 +1067,10 @@ with half the given width. @cindex time formats @cindex date formats -In PSPP, a @dfn{time} is an interval. The time formats translate -between human-friendly descriptions of time intervals and PSPP's +In @pspp{}, a @dfn{time} is an interval. The time formats translate +between human-friendly descriptions of time intervals and @pspp{}'s internal representation of time intervals, which is simply the number of -seconds in the interval. PSPP has two time formats: +seconds in the interval. @pspp{} has two time formats: @float @multitable {Time Format} {@code{dd-mmm-yyyy HH:MM:SS.ss}} {@code{01-OCT-1978 04:31:17.01}} @@ -1080,11 +1080,11 @@ seconds in the interval. PSPP has two time formats: @end multitable @end float -A @dfn{date} is a moment in the past or the future. Internally, PSPP +A @dfn{date} is a moment in the past or the future. Internally, @pspp{} represents a date as the number of seconds since the @dfn{epoch}, midnight, Oct. 14, 1582. The date formats translate between -human-readable dates and PSPP's numeric representation of dates and -times. PSPP has several date formats: +human-readable dates and @pspp{}'s numeric representation of dates and +times. @pspp{} has several date formats: @float @multitable {Date Format} {@code{dd-mmm-yyyy HH:MM:SS.ss}} {@code{01-OCT-1978 04:31:17.01}} @@ -1205,7 +1205,7 @@ by the format's decimal places). @end table For the time and date formats, the default output format is the same as -the input format, except that PSPP increases the field width, if +the input format, except that @pspp{} increases the field width, if necessary, to the minimum allowed for output. Time or dates narrower than the field width are right-justified within @@ -1285,9 +1285,9 @@ to copy its value into an ordinary variable, then use that ordinary variable in the analysis. @node Files -@section Files Used by PSPP +@section Files Used by @pspp{} -PSPP makes use of many files each time it runs. Some of these it +@pspp{} makes use of many files each time it runs. Some of these it reads, some it writes, some it creates. Here is a table listing the most important of these files: @@ -1299,8 +1299,8 @@ most important of these files: @item command file @itemx syntax file These names (synonyms) refer to the file that contains instructions -that tell PSPP what to do. The syntax file's name is specified on -the PSPP command line. Syntax files can also be read with +that tell @pspp{} what to do. The syntax file's name is specified on +the @pspp{} command line. Syntax files can also be read with @cmd{INCLUDE} (@pxref{INCLUDE}). @cindex file, data @@ -1312,10 +1312,10 @@ be embedded in a syntax file with @cmd{BEGIN DATA} and @cmd{END DATA}. @cindex file, output @cindex output file @item listing file -One or more output files are created by PSPP each time it is +One or more output files are created by @pspp{} each time it is run. The output files receive the tables and charts produced by statistical procedures. The output files may be in any number of formats, -depending on how PSPP is configured. +depending on how @pspp{} is configured. @cindex system file @cindex file, system @@ -1348,22 +1348,22 @@ read compressed data from a file using a program such as @samp{zcat} (e.g.@: @code{GET '|zcat mydata.sav.gz'}), and for many other purposes. -PSPP also supports declaring named file handles with the @cmd{FILE +@pspp{} also supports declaring named file handles with the @cmd{FILE HANDLE} command. This command associates an identifier of your choice (the file handle's name) with a file. Later, the file handle name can -be substituted for the name of the file. When PSPP syntax accesses a +be substituted for the name of the file. When @pspp{} syntax accesses a file multiple times, declaring a named file handle simplifies updating the syntax later to use a different file. Use of @cmd{FILE HANDLE} is also required to read data files in binary formats. @xref{FILE HANDLE}, for more information. -In some circumstances, PSPP must distinguish whether a file handle +In some circumstances, @pspp{} must distinguish whether a file handle refers to a system file or a portable file. When this is necessary to read a file, e.g.@: as an input file for @cmd{GET} or @cmd{MATCH FILES}, -PSPP uses the file's contents to decide. In the context of writing a -file, e.g.@: as an output file for @cmd{SAVE} or @cmd{AGGREGATE}, PSPP +@pspp{} uses the file's contents to decide. In the context of writing a +file, e.g.@: as an output file for @cmd{SAVE} or @cmd{AGGREGATE}, @pspp{} decides based on the file's name: if it ends in @samp{.por} (with any -capitalization), then PSPP writes a portable file; otherwise, PSPP +capitalization), then @pspp{} writes a portable file; otherwise, @pspp{} writes a system file. INLINE is reserved as a file handle name. It refers to the ``data @@ -1382,7 +1382,7 @@ more information. @cindex command syntax, description of @cindex description of command syntax -The syntax of some parts of the PSPP language is presented in this +The syntax of some parts of the @pspp{} language is presented in this manual using the formalism known as @dfn{Backus-Naur Form}, or BNF. The following table describes BNF: @@ -1390,7 +1390,7 @@ following table describes BNF: @cindex keywords @cindex terminals @item -Words in all-uppercase are PSPP keyword tokens. In BNF, these are +Words in all-uppercase are @pspp{} keyword tokens. In BNF, these are often called @dfn{terminals}. There are some special terminals, which are written in lowercase for clarity: diff --git a/doc/license.texi b/doc/license.texi index 25fe4cdc06..e3dfdc0b4c 100644 --- a/doc/license.texi +++ b/doc/license.texi @@ -7,25 +7,25 @@ @cindex copyright @cindex obligations, your -PSPP is not in the public domain. It is copyrighted and there are +@pspp{} is not in the public domain. It is copyrighted and there are restrictions on its distribution, but these restrictions are designed to permit everything that a good cooperating citizen would want to do. What is not allowed is to try to prevent others from further sharing any version of this program that they might get from you. Specifically, we want to make sure that you have the right to give -away copies of PSPP, that you receive source code or else can get it +away copies of @pspp{}, that you receive source code or else can get it if you want it, that you can change these programs or use pieces of them in new free programs, and that you know you can do these things. To make sure that everyone has such rights, we have to forbid you to deprive anyone else of these rights. For example, if you distribute -copies of PSPP, you must give the recipients all the rights that you +copies of @pspp{}, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must tell them their rights. Also, for our own protection, we must make certain that everyone finds -out that there is no warranty for PSPP. If these programs are +out that there is no warranty for @pspp{}. If these programs are modified by someone else and passed on, we want their recipients to know that what they have is not what we distributed, so that any problems introduced by others will not reflect on our reputation. @@ -36,7 +36,7 @@ program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. -The precise conditions of the license for PSPP are found in the +The precise conditions of the license for @pspp{} are found in the GNU General Public License. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth diff --git a/doc/not-implemented.texi b/doc/not-implemented.texi index 39c3a67041..5a858d0314 100644 --- a/doc/not-implemented.texi +++ b/doc/not-implemented.texi @@ -1,7 +1,7 @@ @node Not Implemented @chapter Not Implemented -This chapter lists parts of the PSPP language that are not yet +This chapter lists parts of the @pspp{} language that are not yet implemented. @cindex unimplemented commands diff --git a/doc/pspp.texinfo b/doc/pspp.texinfo index 8783e664a2..78e2ef8e9e 100644 --- a/doc/pspp.texinfo +++ b/doc/pspp.texinfo @@ -19,6 +19,12 @@ \CMDNAME\ @end macro +@c Use this macro to refer to PSPP itself . Not when giving a shell command line example. +@macro pspp +PSPP +@end macro + + @ifset MISSING_CLICKSEQUENCE @alias clicksequence = asis @macro click {} @@ -33,7 +39,7 @@ @dircategory Math @direntry * PSPP: (pspp). Statistical analysis package. -* PSPPIRE: (pspp). Graphical user interface to PSPP. +* PSPPIRE: (pspp). Graphical user interface to @pspp{}. @end direntry @copying diff --git a/doc/regression.texi b/doc/regression.texi index 9885d8444a..80f5eaf68d 100644 --- a/doc/regression.texi +++ b/doc/regression.texi @@ -78,9 +78,9 @@ Analysis of variance table for the model. The covariance matrix for the estimated model coefficients. @end table -The SAVE subcommand causes PSPP to save the residuals or predicted +The SAVE subcommand causes @pspp{} to save the residuals or predicted values from the fitted -model to the active dataset. PSPP will store the residuals in a variable +model to the active dataset. @pspp{} will store the residuals in a variable called RES1 if no such variable exists, RES2 if RES1 already exists, RES3 if RES1 and RES2 already exist, etc. It will choose the name of the variable for the predicted values similarly, but with PRED as a @@ -88,7 +88,7 @@ prefix. @node Examples @subsection Examples -The following PSPP syntax will generate the default output and save the +The following @pspp{} syntax will generate the default output and save the predicted values and residuals to the active dataset. @example diff --git a/doc/statistics.texi b/doc/statistics.texi index 2f7022ba52..f7e3a0fe65 100644 --- a/doc/statistics.texi +++ b/doc/statistics.texi @@ -1,7 +1,7 @@ @node Statistics @chapter Statistics -This chapter documents the statistical procedures that PSPP supports so +This chapter documents the statistical procedures that @pspp{} supports so far. @menu @@ -241,7 +241,7 @@ factors for the analysis. Variables listed before the first BY keyword (if any) are the dependent variables. The dependent variables may optionally be followed by a list of -factors which tell PSPP how to break down the analysis for each +factors which tell @pspp{} how to break down the analysis for each dependent variable. Following the dependent variables, factors may be specified. @@ -287,7 +287,7 @@ If each of which contain boxplots for all the cells. If /COMPARE=VARIABLES is specified, then one plot per cell is produced, each containing one boxplot per dependent variable. -If the /COMPARE subcommand is omitted, then PSPP behaves as if +If the /COMPARE subcommand is omitted, then @pspp{} behaves as if /COMPARE=GROUPS were given. The ID subcommand is relevant only if /PLOT=BOXPLOT or @@ -457,7 +457,7 @@ times as needed. This is the only required subcommand in @dfn{general mode}. Occasionally, one may want to invoke a special mode called @dfn{integer -mode}. Normally, in general mode, PSPP automatically determines +mode}. Normally, in general mode, @pspp{} automatically determines what values occur in the data. In integer mode, the user specifies the range of values that the data assumes. To invoke this mode, specify the VARIABLES subcommand, giving a range of data values in parentheses for @@ -943,7 +943,7 @@ significance of observing the observed proportion or less is reported. That is to say, the test is always performed in the observed direction. -PSPP uses a very precise approximation to the gamma function to +@pspp{} uses a very precise approximation to the gamma function to compute the binomial significance. Thus, exact results are reported even for very large sample sizes. @@ -1274,7 +1274,7 @@ It operates in one of three modes: Each of these modes are described in more detail below. There are two optional subcommands which are common to all modes. -The @cmd{/CRITERIA} subcommand tells PSPP the confidence interval used +The @cmd{/CRITERIA} subcommand tells @pspp{} the confidence interval used in the tests. The default value is 0.95. @@ -1308,7 +1308,7 @@ mean. The value given to the @cmd{TESTVAL} subcommand is the value against which you wish to test. In this mode, you must also use the @cmd{/VARIABLES} subcommand to -tell PSPP which variables you wish to test. +tell @pspp{} which variables you wish to test. @node Independent Samples Mode @comment node-name, next, previous, up @@ -1319,7 +1319,7 @@ The @cmd{GROUPS} subcommand invokes Independent Samples mode or This mode is used to test whether two groups of values have the same population mean. In this mode, you must also use the @cmd{/VARIABLES} subcommand to -tell PSPP the dependent variables you wish to test. +tell @pspp{} the dependent variables you wish to test. The variable given in the @cmd{GROUPS} subcommand is the independent variable which determines to which group the samples belong. @@ -1386,7 +1386,7 @@ subcommand. The list of variables must be followed by the @code{BY} keyword and the name of the independent (or factor) variable. -You can use the @code{STATISTICS} subcommand to tell PSPP to display +You can use the @code{STATISTICS} subcommand to tell @pspp{} to display ancilliary information. The options accepted are: @itemize @item DESCRIPTIVES @@ -1403,7 +1403,7 @@ The subcommand must be followed by a list of numerals which are the coefficients of the groups to be tested. The number of coefficients must correspond to the number of distinct groups (or values of the independent variable). -If the total sum of the coefficients are not zero, then PSPP will +If the total sum of the coefficients are not zero, then @pspp{} will display a warning, but will proceed with the analysis. The @code{CONTRAST} subcommand may be given up to 10 times in order to specify different contrast tests. diff --git a/doc/transformation.texi b/doc/transformation.texi index 1c42e5425d..7ca689c27b 100644 --- a/doc/transformation.texi +++ b/doc/transformation.texi @@ -2,7 +2,7 @@ @chapter Data transformations @cindex transformations -The PSPP procedures examined in this chapter manipulate data and +The @pspp{} procedures examined in this chapter manipulate data and prepare the active dataset for later analyses. They do not produce output, as a rule. @@ -42,7 +42,7 @@ handle (@pxref{File Handles}), or a dataset by its name (@pxref{Datasets}). The aggregated cases are written to this file. If @samp{*} is specified, then the aggregated cases replace the active dataset's data. -Use of OUTFILE to write a portable file is a PSPP extension. +Use of OUTFILE to write a portable file is a @pspp{} extension. If OUTFILE=@samp{*} is given, then the subcommand MODE may also be specified. diff --git a/doc/tutorial.texi b/doc/tutorial.texi index 2432dc3e51..ca8a839980 100644 --- a/doc/tutorial.texi +++ b/doc/tutorial.texi @@ -3,18 +3,18 @@ @include tut.texi @node Using PSPP -@chapter Using PSPP +@chapter Using @pspp{} -PSPP is a tool for the statistical analysis of sampled data. +@pspp{} is a tool for the statistical analysis of sampled data. You can use it to discover patterns in the data, to explain differences in one subset of data in terms of another subset and to find out whether certain beliefs about the data are justified. This chapter does not attempt to introduce the theory behind the statistical analysis, -but it shows how such analysis can be performed using PSPP. +but it shows how such analysis can be performed using @pspp{}. -For the purposes of this tutorial, it is assumed that you are using PSPP in its +For the purposes of this tutorial, it is assumed that you are using @pspp{} in its interactive mode from the command line. However, the example commands can also be typed into a file and executed in a post-hoc mode by typing @samp{pspp @var{filename}} at a shell prompt, @@ -25,15 +25,15 @@ and use the @clicksequence{Run} menu when a syntax fragment is ready to be executed. Whichever method you choose, the syntax is identical. -When using the interactive method, PSPP tells you that it's waiting for your -data with a string like @prompt{PSPP>} or @prompt{data>}. +When using the interactive method, @pspp{} tells you that it's waiting for your +data with a string like @prompt{@pspp{}>} or @prompt{data>}. In the examples of this chapter, whenever you see text like this, it -indicates the prompt displayed by PSPP, @emph{not} something that you +indicates the prompt displayed by @pspp{}, @emph{not} something that you should type. Throughout this chapter reference is made to a number of sample data files. So that you can try the examples for yourself, -you should have received these files along with your copy of PSPP.@c +you should have received these files along with your copy of @pspp{}.@c @footnote{These files contain purely fictitious data. They should not be used for research purposes.} @note{Normally these files are installed in the directory @@ -53,8 +53,8 @@ the examples accordingly.} @section Preparation of Data Files -Before analysis can commence, the data must be loaded into PSPP and -arranged such that both PSPP and humans can understand what +Before analysis can commence, the data must be loaded into @pspp{} and +arranged such that both @pspp{} and humans can understand what the data represents. There are two aspects of data: @@ -105,14 +105,14 @@ and reads data into them by manual input. @float Example, data-list @cartouche @example -@prompt{PSPP>} data list list /forename (A12) height. -@prompt{PSPP>} begin data. +@prompt{@pspp{}>} data list list /forename (A12) height. +@prompt{@pspp{}>} begin data. @prompt{data>} Ahmed 188 @prompt{data>} Bertram 167 @prompt{data>} Catherine 134.231 @prompt{data>} David 109.1 @prompt{data>} end data -@prompt{PSPP>} +@prompt{@pspp{}>} @end example @end cartouche @caption{Manual entry of data using the @cmd{DATA LIST} command. @@ -127,11 +127,11 @@ There are several things to note about this example. @item The words @samp{data list list} are an example of the @cmd{DATA LIST} command. @xref{DATA LIST}. -It tells PSPP to prepare for reading data. +It tells @pspp{} to prepare for reading data. The word @samp{list} intentionally appears twice. The first occurrence is part of the @cmd{DATA LIST} call, whilst the second -tells PSPP that the data is to be read as free format data with +tells @pspp{} that the data is to be read as free format data with one record per line. @item @@ -148,14 +148,14 @@ For more information on data formats, @pxref{Input and Output Formats}. @item -Normally, PSPP displays the prompt @prompt{PSPP>} whenever it's +Normally, @pspp{} displays the prompt @prompt{@pspp{}>} whenever it's expecting a command. However, when it's expecting data, the prompt changes to @prompt{data>} so that you know to enter data and not a command. @item At the end of every command there is a terminating @samp{.} which tells -PSPP that the end of a command has been encountered. +@pspp{} that the end of a command has been encountered. You should not enter @samp{.} when data is expected (@i{ie.} when the @prompt{data>} prompt is current) since it is appropriate only for terminating commands. @@ -168,7 +168,7 @@ terminating commands. Once the data has been entered, you could type @example -@prompt{PSPP>} list /format=numbered. +@prompt{@pspp{}>} list /format=numbered. @end example @noindent to list the data. @@ -215,7 +215,7 @@ Zachariah 113.02 You can can tell the @cmd{DATA LIST} command to read the data directly from this file instead of by manual entry, with a command like: @example -@prompt{PSPP>} data list file='mydata.dat' list /forename (A12) height. +@prompt{@pspp{}>} data list file='mydata.dat' list /forename (A12) height. @end example @noindent Notice however, that it is still necessary to specify the names of the @@ -226,13 +226,13 @@ parameters. For full details refer to @pxref{DATA LIST}. @node Reading data from a pre-prepared PSPP file -@subsection Reading data from a pre-prepared PSPP file +@subsection Reading data from a pre-prepared @pspp{} file @cindex system files @vindex GET -When working with other PSPP users, or users of other software which -uses the PSPP data format, you may be given the data in -a pre-prepared PSPP file. +When working with other @pspp{} users, or users of other software which +uses the @pspp{} data format, you may be given the data in +a pre-prepared @pspp{} file. Such files contain not only the data, but the variable definitions, along with their formats, labels and other meta-data. Conventionally, these files (sometimes called ``system'' files) @@ -240,25 +240,25 @@ have the suffix @file{.sav}, but that is not mandatory. The following syntax loads a file called @file{my-file.sav}. @example -@prompt{PSPP>} get file='my-file.sav'. +@prompt{@pspp{}>} get file='my-file.sav'. @end example @noindent You will encounter several instances of this in future examples. @node Saving data to a PSPP file. -@subsection Saving data to a PSPP file. +@subsection Saving data to a @pspp{} file. @cindex saving @vindex SAVE If you want to save your data, along with the variable definitions so -that you or other PSPP users can use it later, you can do this with +that you or other @pspp{} users can use it later, you can do this with the @cmd{SAVE} command. The following syntax will save the existing data and variables to a file called @file{my-new-file.sav}. @example -@prompt{PSPP>} save outfile='my-new-file.sav'. +@prompt{@pspp{}>} save outfile='my-new-file.sav'. @end example @noindent If @file{my-new-file.sav} already exists, then it will be overwritten. @@ -301,7 +301,7 @@ At the very least, it's good practice to check for errors. @cindex errors, in data Data from real sources is rarely error free. -PSPP has a number of procedures which can be used to help +@pspp{} has a number of procedures which can be used to help identify data which might be incorrect. The @cmd{DESCRIPTIVES} command (@pxref{DESCRIPTIVES}) is used to generate @@ -317,8 +317,8 @@ data and identify the erroneous values. @float Example, descriptives @cartouche @example -@prompt{PSPP>} get file='@value{example-dir}/physiology.sav'. -@prompt{PSPP>} descriptives sex, weight, height. +@prompt{@pspp{}>} get file='@value{example-dir}/physiology.sav'. +@prompt{@pspp{}>} descriptives sex, weight, height. @end example Output: @@ -363,7 +363,7 @@ represent data entry errors. @cartouche [@dots{} continue from @ref{descriptives}] @example -@prompt{PSPP>} examine height, weight /statistics=extreme(3). +@prompt{@pspp{}>} examine height, weight /statistics=extreme(3). @end example Output: @@ -403,13 +403,13 @@ They are possibly erroneous.} If possible, suspect data should be checked and re-measured. However, this may not always be feasible, in which case the researcher may decide to disregard these values. -PSPP has a feature whereby data can assume the special value `SYSMIS', and +@pspp{} has a feature whereby data can assume the special value `SYSMIS', and will be disregarded in future analysis. @xref{Missing Observations}. You can set the two suspect values to the `SYSMIS' value using the @cmd{RECODE} command. @example -PSPP> recode height (179 = SYSMIS). -PSPP> recode weight (LOWEST THRU 0 = SYSMIS). +@pspp{}> recode height (179 = SYSMIS). +@pspp{}> recode weight (LOWEST THRU 0 = SYSMIS). @end example @noindent The first command says that for any observation which has a @@ -434,7 +434,7 @@ Data entry errors are not the only reason for wanting to recode data. The sample file @file{hotel.sav} comprises data gathered from a customer satisfaction survey of clients at a particular hotel. In @ref{reliability}, this file is loaded for analysis. -The line @code{display dictionary.} tells PSPP to display the +The line @code{display dictionary.} tells @pspp{} to display the variables and associated data. The output from this command has been omitted from the example for the sake of clarity, but you will notice that each of the variables @@ -479,19 +479,19 @@ you will notice that they ask very similar questions. One would therefore expect the values of these variables (after recoding) to closely follow one another, and we can test that with the @cmd{RELIABILITY} command (@pxref{RELIABILITY}). -@ref{reliability} shows a PSPP session where the user (after recoding +@ref{reliability} shows a @pspp{} session where the user (after recoding negatively scaled variables) requests reliability statistics for @var{v1}, @var{v3} and @var{v5}. @float Example, reliability @cartouche @example -@prompt{PSPP>} get file='@value{example-dir}/hotel.sav'. -@prompt{PSPP>} display dictionary. -@prompt{PSPP>} * recode negatively worded questions. -@prompt{PSPP>} compute v3 = 6 - v3. -@prompt{PSPP>} compute v5 = 6 - v5. -@prompt{PSPP>} reliability v1, v3, v5. +@prompt{@pspp{}>} get file='@value{example-dir}/hotel.sav'. +@prompt{@pspp{}>} display dictionary. +@prompt{@pspp{}>} * recode negatively worded questions. +@prompt{@pspp{}>} compute v3 = 6 - v3. +@prompt{@pspp{}>} compute v5 = 6 - v5. +@prompt{@pspp{}>} reliability v1, v3, v5. @end example Output (dictionary information omitted for clarity): @@ -569,11 +569,11 @@ an appropriate non-parametric test instead of a linear one. @float Example, normality @cartouche @example -@prompt{PSPP>} get file='@value{example-dir}/repairs.sav'. -@prompt{PSPP>} examine mtbf +@prompt{@pspp{}>} get file='@value{example-dir}/repairs.sav'. +@prompt{@pspp{}>} examine mtbf /statistics=descriptives. -@prompt{PSPP>} compute mtbf_ln = ln (mtbf). -@prompt{PSPP>} examine mtbf_ln +@prompt{@pspp{}>} compute mtbf_ln = ln (mtbf). +@prompt{@pspp{}>} examine mtbf_ln /statistics=descriptives. @end example @@ -642,7 +642,7 @@ the same distribution as another, or whether the mean of a dataset significantly differs from a particular value. -This section presents just some of the possible tests that PSPP offers. +This section presents just some of the possible tests that @pspp{} offers. The researcher starts by making a @dfn{null hypothesis}. Often this is a hypothesis which he suspects to be false. @@ -695,7 +695,7 @@ Levene test for equal variances. If the variances are equal, then a more powerful form of the T-test can be used. However if it is unsafe to assume equal variances, then an alternative calculation is necessary. -PSPP performs both calculations. +@pspp{} performs both calculations. For the @var{height} variable, the output shows the significance of the Levene test to be 0.33 which means there is a @@ -718,9 +718,9 @@ suggest that the body temperature of male and female persons are different. @float Example, t-test @cartouche @example -@prompt{PSPP>} get file='@value{example-dir}/physiology.sav'. -@prompt{PSPP>} recode height (179 = SYSMIS). -@prompt{PSPP>} t-test group=sex(0,1) /variables = height temperature. +@prompt{@pspp{}>} get file='@value{example-dir}/physiology.sav'. +@prompt{@pspp{}>} recode height (179 = SYSMIS). +@prompt{@pspp{}>} t-test group=sex(0,1) /variables = height temperature. @end example Output: @example @@ -784,9 +784,9 @@ identifies the potential linear relationship. @xref{REGRESSION}. @float Example, regression @cartouche @example -@prompt{PSPP>} get file='@value{example-dir}/repairs.sav'. -@prompt{PSPP>} regression /variables = mtbf duty_cycle /dependent = mttr. -@prompt{PSPP>} regression /variables = mtbf /dependent = mttr. +@prompt{@pspp{}>} get file='@value{example-dir}/repairs.sav'. +@prompt{@pspp{}>} regression /variables = mtbf duty_cycle /dependent = mttr. +@prompt{@pspp{}>} regression /variables = mtbf /dependent = mttr. @end example Output: @example @@ -851,7 +851,7 @@ suggesting that at the 0.06 level, the formula predictor of the time to repair. -@c LocalWords: PSPP dir itemize noindent var cindex dfn cartouche samp xref +@c LocalWords: @pspp{} dir itemize noindent var cindex dfn cartouche samp xref @c LocalWords: pxref ie sav Std Dev kilograms SYSMIS sansserif pre pspp emph @c LocalWords: Likert Cronbach's Cronbach mtbf npplot ln myfile cmd NPAR Sig @c LocalWords: vindex Levene Levene's df Diff clicksequence mydata dat ascii diff --git a/doc/utilities.texi b/doc/utilities.texi index 35dd393a78..b40d8c8e67 100644 --- a/doc/utilities.texi +++ b/doc/utilities.texi @@ -21,13 +21,13 @@ encountered in the input. * ERASE:: Erase a file. * EXECUTE:: Execute pending transformations. * FILE LABEL:: Set the active dataset's label. -* FINISH:: Terminate the PSPP session. +* FINISH:: Terminate the @pspp{} session. * HOST:: Temporarily return to the operating system. * INCLUDE:: Include a file within the current one. * INSERT:: Insert a file within the current one. * PERMISSIONS:: Change permissions on a file. * PRESERVE and RESTORE:: Saving settings and restoring them later. -* SET:: Adjust PSPP runtime parameters. +* SET:: Adjust @pspp{} runtime parameters. * SHOW:: Display runtime parameters. * SUBTITLE:: Provide a document subtitle. * TITLE:: Provide a document title. @@ -87,7 +87,7 @@ Two possibles syntaxes: @end display @cmd{COMMENT} is ignored. It is used to provide information to -the author and other readers of the PSPP syntax file. +the author and other readers of the @pspp{} syntax file. @cmd{COMMENT} can extend over any number of lines. Don't forget to terminate it with a dot or a blank line. @@ -139,7 +139,7 @@ DISPLAY FILE LABEL. active dataset, if any. @xref{FILE LABEL}. -This command is a PSPP extension. +This command is a @pspp{} extension. @node DROP DOCUMENTS @section DROP DOCUMENTS @@ -200,7 +200,7 @@ FILE LABEL file_label. @cmd{FILE LABEL} provides a title for the active dataset. This title will be saved into system files and portable files that are -created during this PSPP run. +created during this @pspp{} run. file_label need not be quoted. If quotes are included, they become part of the file label. @@ -213,7 +213,7 @@ included, they become part of the file label. FINISH. @end display -@cmd{FINISH} terminates the current PSPP session and returns +@cmd{FINISH} terminates the current @pspp{} session and returns control to the operating system. @node HOST @@ -226,15 +226,15 @@ HOST. HOST COMMAND=['command'...]. @end display -@cmd{HOST} suspends the current PSPP session and temporarily returns control +@cmd{HOST} suspends the current @pspp{} session and temporarily returns control to the operating system. This command cannot be used if the SAFER setting is active. If the COMMAND subcommand is specified, as a sequence of shell -commands as quoted strings within square brackets, then PSPP executes +commands as quoted strings within square brackets, then @pspp{} executes them together in a single subshell. -If no subcommands are specified, then PSPP invokes an interactive +If no subcommands are specified, then @pspp{} invokes an interactive subshell. @node INCLUDE @@ -245,7 +245,7 @@ subshell. INCLUDE [FILE=]'file-name' [ENCODING='encoding']. @end display -@cmd{INCLUDE} causes the PSPP command processor to read an +@cmd{INCLUDE} causes the @pspp{} command processor to read an additional command file as if it were included bodily in the current command file. If errors are encountered in the included file, then command processing will @@ -315,10 +315,10 @@ systems support all character sets. @item @code{Auto,@var{encoding}} Automatically detects whether a syntax file is encoded in an Unicode -encoding such as UTF-8, UTF-16, or UTF-32. If it is not, then PSPP +encoding such as UTF-8, UTF-16, or UTF-32. If it is not, then @pspp{} generally assumes that the file is encoded in @var{encoding} (an IANA character set name). However, if @var{encoding} is UTF-8, and the -syntax file is not valid UTF-8, PSPP instead assumes that the file +syntax file is not valid UTF-8, @pspp{} instead assumes that the file is encoded in @code{windows-1252}. For best results, @var{encoding} should be an ASCII-compatible @@ -455,7 +455,7 @@ SET @end display @cmd{SET} allows the user to adjust several parameters relating to -PSPP's execution. Since there are many subcommands to this command, its +@pspp{}'s execution. Since there are many subcommands to this command, its subcommands will be examined in groups. On subcommands that take boolean values, ON and YES are synonym, and @@ -498,25 +498,25 @@ epoch. If AUTOMATIC (the default) is specified, then the epoch begins @item RIB @anchor{SET RIB} -PSPP extension to set the byte ordering (endianness) used for reading +@pspp{} extension to set the byte ordering (endianness) used for reading data in IB or PIB format (@pxref{Binary and Hexadecimal Numeric Formats}). In MSBFIRST ordering, the most-significant byte appears at the left end of a IB or PIB field. In LSBFIRST ordering, the least-significant byte appears at the left end. VAX ordering is like MSBFIRST, except that each pair of bytes is in reverse order. NATIVE, the default, is equivalent to MSBFIRST or LSBFIRST depending on the -native format of the machine running PSPP. +native format of the machine running @pspp{}. @item RRB @anchor{SET RRB} -PSPP extension to set the floating-point format used for reading data in +@pspp{} extension to set the floating-point format used for reading data in RB format (@pxref{Binary and Hexadecimal Numeric Formats}). The possibilities are: @table @asis @item NATIVE -The native format of the machine running PSPP. Equivalent to either IDL +The native format of the machine running @pspp{}. Equivalent to either IDL or IDB. @item ISL @@ -558,16 +558,16 @@ formats are only for use with very old input files. The default is NATIVE. @end table -Interaction subcommands affect the way that PSPP interacts with an +Interaction subcommands affect the way that @pspp{} interacts with an online user. The interaction subcommands are @table @asis @item MXERRS -The maximum number of errors before PSPP halts processing of the current +The maximum number of errors before @pspp{} halts processing of the current command file. The default is 50. @item MXWARNS -The maximum number of warnings + errors before PSPP halts processing the +The maximum number of warnings + errors before @pspp{} halts processing the current command file. The special value of zero means that all warning situations should be ignored. No warnings will be issued, except a single initial warning advising the user @@ -575,7 +575,7 @@ that warnings will not be given. The default value is 100. @end table -Syntax execution subcommands control the way that PSPP commands +Syntax execution subcommands control the way that @pspp{} commands execute. The syntax execution subcommands are @table @asis @@ -607,13 +607,13 @@ RANDOM, which will obtain an initial seed from the current time of day. Currently not used. @item WORKSPACE -The maximum amount of memory that PSPP will use to store data being processed. -If memory in excess of the workspace size is required, then PSPP will start +The maximum amount of memory that @pspp{} will use to store data being processed. +If memory in excess of the workspace size is required, then @pspp{} will start to use temporary files to store the data. Setting a higher value will, in general, mean procedures will run faster, but may cause other applications to run slower. On platforms without virtual memory management, setting a very large workspace -may cause PSPP to abort. +may cause @pspp{} to abort. @cindex workspace @cindex memory, amount used to store cases @end table @@ -644,24 +644,24 @@ default is F8.2. @xref{Input and Output Formats}. @item WIB @anchor{SET WIB} -PSPP extension to set the byte ordering (endianness) used for writing +@pspp{} extension to set the byte ordering (endianness) used for writing data in IB or PIB format (@pxref{Binary and Hexadecimal Numeric Formats}). In MSBFIRST ordering, the most-significant byte appears at the left end of a IB or PIB field. In LSBFIRST ordering, the least-significant byte appears at the left end. VAX ordering is like MSBFIRST, except that each pair of bytes is in reverse order. NATIVE, the default, is equivalent to MSBFIRST or LSBFIRST depending on the -native format of the machine running PSPP. +native format of the machine running @pspp{}. @item WRB @anchor{SET WRB} -PSPP extension to set the floating-point format used for writing data in +@pspp{} extension to set the floating-point format used for writing data in RB format (@pxref{Binary and Hexadecimal Numeric Formats}). The choices are the same as SET RIB. The default is NATIVE. @end table -In the PSPP text-based interface, the output routing subcommands +In the @pspp{} text-based interface, the output routing subcommands affect where output is sent. The following values are allowed for each of these subcommands: @@ -701,7 +701,7 @@ Applies to everything not in one of the above categories, such as the results of statistical procedures. The default is BOTH. @end table -These subcommands have no effect on output in the PSPP GUI +These subcommands have no effect on output in the @pspp{} GUI environment. Output driver option subcommands affect output drivers' settings. These @@ -741,7 +741,7 @@ files. These subcommands are These subcommands, which are synonyms, control the journal. The default is ON, which causes commands entered interactively to be written to the journal file. Commands included from syntax files that -are included interactively and error messages printed by PSPP are also +are included interactively and error messages printed by @pspp{} are also written to the journal file, prefixed by @samp{>}. OFF disables use of the journal. @@ -750,7 +750,7 @@ be specified. @end table System file subcommands affect the default format of system files -produced by PSPP. These subcommands are +produced by @pspp{}. These subcommands are @table @asis @item COMPRESSION @@ -794,8 +794,8 @@ as a locale name. If given as a locale name, only the character encoding of the locale is relevant. -System files written by PSPP will use this encoding. -System files read by PSPP, for which the encoding is unknown, will be +System files written by @pspp{} will use this encoding. +System files read by @pspp{}, for which the encoding is unknown, will be interpreted using this encoding. The full list of valid encodings and locale names/alias are operating system @@ -849,7 +849,7 @@ SHOW [WIDTH] @end display -@cmd{SHOW} can be used to display the current state of PSPP's execution +@cmd{SHOW} can be used to display the current state of @pspp{}'s execution parameters. Parameters that can be changed using @cmd{SET} (@pxref{SET}), can be examined using @cmd{SHOW} using the subcommand with the same name. @code{SHOW} supports the following additional @@ -867,11 +867,11 @@ Shows the operating system details. @item TEMPDIR Shows the path of the directory where temporary files will be stored. @item VERSION -Shows the version of this installation of PSPP. +Shows the version of this installation of @pspp{}. @item WARRANTY -Show details of the lack of warranty for PSPP. +Show details of the lack of warranty for @pspp{}. @item COPYING / LICENSE -Display the terms of PSPP's copyright licence (@pxref{License}). +Display the terms of @pspp{}'s copyright licence (@pxref{License}). @end table Specifying @cmd{SHOW} without any subcommands is equivalent to SHOW ALL. @@ -886,7 +886,7 @@ SUBTITLE 'subtitle_string'. SUBTITLE subtitle_string. @end display -@cmd{SUBTITLE} provides a subtitle to a particular PSPP +@cmd{SUBTITLE} provides a subtitle to a particular @pspp{} run. This subtitle appears at the top of each output page below the title, if headers are enabled on the output device. @@ -904,7 +904,7 @@ TITLE 'title_string'. TITLE title_string. @end display -@cmd{TITLE} provides a title to a particular PSPP run. +@cmd{TITLE} provides a title to a particular @pspp{} run. This title appears at the top of each output page, if headers are enabled on the output device. diff --git a/doc/variables.texi b/doc/variables.texi index 8ef31fc91c..6fd4944a9f 100644 --- a/doc/variables.texi +++ b/doc/variables.texi @@ -117,7 +117,7 @@ In the second for, all datafile and variable attributes are displayed. With the @code{VECTOR} keyword, @cmd{DISPLAY} lists all the currently declared vectors. If the SORTED keyword is given, the vectors are listed in alphabetical order; otherwise, they are listed in textual -order of definition within the PSPP syntax file. +order of definition within the @pspp{} syntax file. For related commands, see @ref{DISPLAY DOCUMENTS} and @ref{DISPLAY FILE LABEL}. @@ -341,13 +341,13 @@ category in the set: @itemize @minus @item VARLABELS, the default, uses variable labels or, for variables without -variable labels, variable names. PSPP warns if two variables have the +variable labels, variable names. @pspp{} warns if two variables have the same variable label, since these categories cannot be distinguished in output. @item COUNTEDVALUES instead uses each variable's value label for the counted -value. PSPP warns if two variables have the same value label for the +value. @pspp{} warns if two variables have the same value label for the counted value or if one of the variables lacks a value label, since such categories cannot be distinguished in output. @end itemize @@ -368,7 +368,7 @@ It is mutually exclusive with LABEL. The MCGROUP subcommand creates a new multiple category set or replaces an existing multiple response set. The NAME and VARIABLES specifications are required, and LABEL is optional. Their meanings -are as described above to MDGROUP. PSPP warns if two variables in the +are as described above to MDGROUP. @pspp{} warns if two variables in the set have different value labels for a single value, since each of the variables in the set should have the same possible categories. @@ -497,7 +497,7 @@ VARIABLE ATTRIBUTE @cmd{VARIABLE ATTRIBUTE} adds, modifies, or removes user-defined attributes associated with variables in the active dataset. Custom -variable attributes are not interpreted by PSPP, but they are saved as +variable attributes are not interpreted by @pspp{}, but they are saved as part of system files and may be used by other software that reads them. @@ -510,8 +510,8 @@ attributes. Specify the name of the attribute as an identifier (@pxref{Tokens}), followed by the desired value, in parentheses, as a quoted string. The specified attributes are then added or modified in the variables specified on VARIABLES. Attribute names that begin with -@code{$} are reserved for PSPP's internal use, and attribute names -that begin with @code{@@} or @code{$@@} are not displayed by most PSPP +@code{$} are reserved for @pspp{}'s internal use, and attribute names +that begin with @code{@@} or @code{$@@} are not displayed by most @pspp{} commands that display other attributes. Other attribute names are not treated specially. @@ -577,7 +577,7 @@ VARIABLE ALIGNMENT @cmd{VARIABLE ALIGNMENT} sets the alignment of variables for display editing purposes. This only has effect for third party software. It does not affect -the display of variables in the PSPP output. +the display of variables in the @pspp{} output. @@ -598,7 +598,7 @@ VARIABLE WIDTH @cmd{VARIABLE WIDTH} sets the column width of variables for display editing purposes. This only affects third party software. It does not affect -the display of variables in the PSPP output. +the display of variables in the @pspp{} output. @node VARIABLE LEVEL