From: John Darrington Date: Wed, 4 Apr 2012 23:06:29 +0000 (+0200) Subject: Documentation: Yet more markup X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fbuilds%2F20120408030503%2Fpspp;p=pspp Documentation: Yet more markup --- diff --git a/doc/combining.texi b/doc/combining.texi index 00f6067a98..3b4eb902e0 100644 --- a/doc/combining.texi +++ b/doc/combining.texi @@ -117,7 +117,7 @@ similarly for value labels and missing values. @item The file label of the new active dataset (@pxref{FILE LABEL}) is that of the -first specified FILE that has a file label. +first specified @subcmd{FILE} that has a file label. @item The documents in the new active dataset (@pxref{DOCUMENT}) are the @@ -132,7 +132,7 @@ active dataset is not weighted. The remaining subcommands apply to the output file as a whole, rather than to individual input files. They must be specified at the end of -the command specification, following all of the FILE and related +the command specification, following all of the @subcmd{FILE} and related subcommands. The most important of these subcommands is @subcmd{BY}, which specifies a set of one or more variables that may be used to find corresponding cases in each of the input files. The variables @@ -250,7 +250,7 @@ to cases output after their input has been exhausted. @item If @subcmd{BY} is used, @cmd{MATCH FILES} combines cases from each input file that -have identical values for the BY variables. +have identical values for the @subcmd{BY} variables. When @subcmd{BY} is used, @subcmd{TABLE} subcommands may be used to introduce @dfn{table lookup file}. @subcmd{TABLE} has same syntax as @subcmd{FILE}, and the @subcmd{RENAME}, @subcmd{IN}, and diff --git a/doc/data-io.texi b/doc/data-io.texi index 7d11cc6f05..4862ccc596 100644 --- a/doc/data-io.texi +++ b/doc/data-io.texi @@ -304,7 +304,7 @@ of variable specifications may be present. Each variable specification consists of a list of variable names followed by a description of their location on the input line. Sets of -variables may be specified using the @code{DATA LIST} TO convention +variables may be specified using the @cmd{DATA LIST} @subcmd{TO} convention (@pxref{Sets of Variables}). There are two ways to specify the location of the variable on the line: columnar style and FORTRAN style. @@ -906,14 +906,14 @@ printed. Keyword VARIABLES is optional. If @subcmd{VARIABLES} subcommand is no specified then all variables in the active dataset are printed. The @subcmd{CASES} subcommand can be used to specify a subset of cases to be -printed. Specify FROM and the case number of the first case to print, -TO and the case number of the last case to print, and BY and the number +printed. Specify @subcmd{FROM} and the case number of the first case to print, +@subcmd{TO} and the case number of the last case to print, and @subcmd{BY} and the number of cases to advance between printing cases, or any subset of those -settings. If CASES is not specified then all cases are printed. +settings. If @subcmd{CASES} is not specified then all cases are printed. -The @subcmd{FORMAT} subcommand can be used to change the output format. NUMBERED -will print case numbers along with each case; UNNUMBERED, the default, -causes the case numbers to be omitted. The WRAP and SINGLE settings are +The @subcmd{FORMAT} subcommand can be used to change the output format. @subcmd{NUMBERED} +will print case numbers along with each case; @subcmd{UNNUMBERED}, the default, +causes the case numbers to be omitted. The @subcmd{WRAP} and @subcmd{SINGLE} settings are currently not used. Case numbers start from 1. They are counted after all transformations @@ -1034,7 +1034,7 @@ With @subcmd{OUTFILE}, @cmd{PRINT EJECT} writes its output to the specified file The first line of output is written with @samp{1} inserted in the first column. Commonly, this is the only line of output. If additional lines of output are specified, these additional lines are -written with a space inserted in the first column, as with PRINT. +written with a space inserted in the first column, as with @subcmd{PRINT}. @xref{PRINT}, for more information on syntax and usage. diff --git a/doc/expressions.texi b/doc/expressions.texi index 65778d0424..77908e35ed 100644 --- a/doc/expressions.texi +++ b/doc/expressions.texi @@ -1,3 +1,9 @@ +@c Use @func when refering to a function. +@c Use @deftypefn for their definitions +@macro func{NAME} +@code{/NAME/} +@end macro + @node Expressions @chapter Mathematical Expressions @cindex expressions, mathematical @@ -244,9 +250,9 @@ syntax: each is composed of a function name followed by a left parenthesis, one or more arguments, and a right parenthesis. Function names are not reserved. Their names are specially treated -only when followed by a left parenthesis, so that @code{EXP(10)} -refers to the constant value @code{e} raised to the 10th power, but -@code{EXP} by itself refers to the value of variable EXP. +only when followed by a left parenthesis, so that @samp{EXP(10)} +refers to the constant value @math{e} raised to the 10th power, but +@samp{EXP} by itself refers to the value of a variable called @code{EXP}. The sections below describe each function in detail. @@ -273,7 +279,7 @@ Advanced mathematical functions take numeric arguments and produce numeric results. @deftypefn {Function} {} EXP (@var{exponent}) -Returns @i{e} (approximately 2.71828) raised to power @var{exponent}. +Returns @math{e} (approximately 2.71828) raised to power @var{exponent}. @end deftypefn @cindex logarithms @@ -283,12 +289,12 @@ not positive, the result is system-missing. @end deftypefn @deftypefn {Function} {} LN (@var{number}) -Takes the base-@i{e} logarithm of @var{number}. If @var{number} is +Takes the base-@math{e} logarithm of @var{number}. If @var{number} is not positive, the result is system-missing. @end deftypefn @deftypefn {Function} {} LNGAMMA (@var{number}) -Yields the base-@i{e} logarithm of the complete gamma of @var{number}. +Yields the base-@math{e} logarithm of the complete gamma of @var{number}. If @var{number} is a negative integer, the result is system-missing. @end deftypefn @@ -381,7 +387,7 @@ Takes the sine of @var{angle} which should be in radians. @deftypefn {Function} {} TAN (@var{angle}) Takes the tangent of @var{angle} which should be in radians. Results in system-missing at values -of @var{angle} that are too close to odd multiples of pi/2. +of @var{angle} that are too close to odd multiples of @math{\pi/2}. Portability: none. @end deftypefn @@ -443,7 +449,7 @@ String comparisons are performed according to the rules given in Results in true if @var{value} is equal to any of the @var{set} values. Otherwise, results in false. If @var{value} is system-missing, returns system-missing. System-missing values in -@var{set} do not cause ANY to return system-missing. +@var{set} do not cause @func{ANY} to return system-missing. @end deftypefn @deftypefn {Function} {} RANGE (@var{value}, @var{low}, @var{high} [, @var{low}, @var{high}]@dots{}) @@ -452,7 +458,7 @@ Results in true if @var{value} is in any of the intervals bounded by Each @var{low} must be less than or equal to its corresponding @var{high} value. @var{low} and @var{high} must be given in pairs. If @var{value} is system-missing, returns system-missing. -System-missing values in @var{set} do not cause RANGE to return +System-missing values in @var{set} do not cause @func{RANGE} to return system-missing. @end deftypefn @@ -475,10 +481,10 @@ using the @code{@var{var1} TO @var{var2}} syntax. Unlike most functions, statistical functions can return non-missing values even when some of their arguments are missing. Most statistical functions, by default, require only 1 non-missing value to -have a non-missing return, but CFVAR, SD, and VARIANCE require 2. +have a non-missing return, but @func{CFVAR}, @func{SD}, and @func {VARIANCE} require 2. These defaults can be increased (but not decreased) by appending a dot and the minimum number of valid arguments to the function name. For -example, @code{MEAN.3(X, Y, Z)} would only return non-missing if all +example, @subcmd{MEAN.3(X, Y, Z)} would only return non-missing if all of @samp{X}, @samp{Y}, and @samp{Z} were valid. @cindex coefficient of variation @@ -1144,7 +1150,7 @@ a probability. Tail probability function for @var{dist}, that is, the probability that a random variate drawn from the distribution is greater than @var{x}. The domain of @var{x} depends @var{dist}. The result is a -probability. Only a few distributions include an SIG function. +probability. Only a few distributions include an @func{SIG} function. @item IDF.@var{dist} (@var{p}[, @var{param}@dots{}]) Inverse distribution function for @var{dist}, the value of @var{x} for @@ -1160,7 +1166,7 @@ distribution. Noncentral probability density function. The result is the density of the given noncentral distribution at @var{x}. The domain of @var{x} depends on @var{dist}. The range is nonnegative real numbers. Only a -few distributions include an NPDF function. +few distributions include an @func{NPDF} function. @item NCDF.@var{dist} (@var{x}[, @var{param}@dots{}]) Noncentral cumulative distribution function for @var{dist}, that is, diff --git a/doc/files.texi b/doc/files.texi index 375a9529c3..04bbff40fc 100644 --- a/doc/files.texi +++ b/doc/files.texi @@ -178,7 +178,7 @@ is affected by these subcommands. @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 -the @subcmd{ENCODING} subcommand with an IANA character set name as its string +the @subcmd{ENCODING} subcommand with an @acronym{IANA} character set name as its string argument to override the default. The @subcmd{ENCODING} subcommand is a @pspp{} extension. diff --git a/doc/invoking.texi b/doc/invoking.texi index 14b1ad0bed..f327b1cc5e 100644 --- a/doc/invoking.texi +++ b/doc/invoking.texi @@ -70,7 +70,7 @@ corresponding short options. @end example @end table -@table @code +@table @asis @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 @@ -78,7 +78,7 @@ 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} +@item @option{-o @var{output-file}} 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 @@ -89,19 +89,19 @@ 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 output in plain text format. -@item -O @var{option}=@var{value} +@item @option{-O @var{option}=@var{value}} Sets an option for the output file configured by a preceding @option{-o}. Most options are specific to particular output formats. A few options that apply generically are listed below. -@item -O format=@var{format} +@item @option{-O format=@var{format}} @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@} +@item @option{-O device=@{terminal|listing@}} 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 @@ -109,13 +109,13 @@ SET command's output routing subcommands (@pxref{SET}). By default, output written to standard output is considered a terminal device and other output is considered a listing device. -@item --no-output +@item @option{--no-output} Disables output entirely, if neither @option{-o} nor @option{-O} is also used. If one of those options is used, @option{--no-output} has no effect. -@item -e @var{error-file} -@itemx --error-file=@var{error-file} +@item @option{-e @var{error-file}} +@itemx @option{--error-file=@var{error-file}} 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 @@ -124,33 +124,33 @@ writes to standard output (or another terminal), to avoid printing every message twice. Use @samp{none} as @var{error-file} to explicitly suppress the default. -@item -I @var{dir} -@itemx --include=@var{dir} -Appends @var{dir} to the set of directories searched by INCLUDE -(@pxref{INCLUDE}) and INSERT (@pxref{INSERT}). +@item @option{-I @var{dir}} +@itemx @option{--include=@var{dir}} +Appends @var{dir} to the set of directories searched by the @cmd{INCLUDE} +(@pxref{INCLUDE}) and @cmd{INSERT} (@pxref{INSERT}) commands. -@item -I- -@itemx --no-include +@item @option{-I-} +@itemx @option{--no-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 directory (usually @file{/etc/pspp} or @file{/usr/local/etc/pspp}). -@item -b -@item --batch -@item -i -@itemx --interactive +@item @option{-b} +@item @option{--batch} +@item @option{-i} +@itemx @option{--interactive} These options forces syntax files to be interpreted in batch mode or interactive mode, respectively, rather than the default ``auto'' mode. @xref{Syntax Variants}, for a description of the differences. -@item -r -@itemx --no-statrc +@item @option{-r} +@itemx @option{--no-statrc} Disables running @file{rc} at @pspp{} startup time. -@item -a @{enhanced|compatible@} -@itemx --algorithm=@{enhanced|compatible@} +@item @option{-a @{enhanced|compatible@}} +@itemx @option{--algorithm=@{enhanced|compatible@}} 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 @@ -159,37 +159,37 @@ the same results as the proprietary program SPSS. Some commands have subcommands that override this setting on a per command basis. -@item -x @{enhanced|compatible@} -@itemx --syntax=@{enhanced|compatible@} +@item @option{-x @{enhanced|compatible@}} +@itemx @option{--syntax=@{enhanced|compatible@}} 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. -@item --syntax-encoding=@var{encoding} +@item @option{--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 @cmd{INCLUDE} and @cmd{INSERT} commands. @xref{INSERT}, for the accepted forms of @var{encoding}. -@item --help +@item @option{--help} Prints a message describing @pspp{} command-line syntax and the available device formats, then exits. -@item -V -@itemx --version +@item @option{-V} +@itemx @option{--version} 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. -@item -s -@itemx --safer -Disables certain unsafe operations. This includes the ERASE and -HOST commands, as well as use of pipes as input and output files. +@item @option{-s} +@itemx @option{--safer} +Disables certain unsafe operations. This includes the @subcmd{ERASE} and +@subcmd{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 -check} and similar scripts. +@item @option{--testing-mode} +Invoke heuristics to assist with testing @pspp{}. For use +by @command{make check} and similar scripts. @end table @node PDF PostScript and SVG Output Options @@ -206,13 +206,13 @@ format. PDF, PostScript, and SVG output is only available if your installation of @pspp{} was compiled with the Cairo library. -@table @code -@item -O format=@{pdf|ps|svg@} +@table @asis +@item @option{-O format=@{pdf|ps|svg@}} Specify the output format. This is only necessary if the file name given on @option{-o} does not end in @file{.pdf}, @file{.ps}, or @file{.svg}. -@item -O paper-size=@var{paper-size} +@item @option{-O paper-size=@var{paper-size}} Paper size, as a name (e.g.@: @code{a4}, @code{letter}) or measurements (e.g.@: @code{210x297}, @code{8.5x11in}). @@ -224,26 +224,26 @@ taken from the locale. Otherwise, if @file{/etc/papersize} exists, the default paper size is read from it. As a last resort, A4 paper is assumed. -@item -O foreground-color=@var{color} -@itemx -O background-color=@var{color} +@item @option{-O foreground-color=@var{color}} +@itemx @option{-O background-color=@var{color}} Sets @var{color} as the color to be used for the background or foreground. Color should be given in the format @code{#@var{RRRR}@var{GGGG}@var{BBBB}}, where @var{RRRR}, @var{GGGG} and @var{BBBB} are 4 character hexadecimal representations of the red, green and blue components respectively. -@item -O orientation=@var{orientation} +@item @option{-O orientation=@var{orientation}} Either @code{portrait} or @code{landscape}. Default: @code{portrait}. -@item -O left-margin=@var{dimension} -@itemx -O right-margin=@var{dimension} -@itemx -O top-margin=@var{dimension} -@itemx -O bottom-margin=@var{dimension} +@item @option{-O left-margin=@var{dimension}} +@itemx @option{-O right-margin=@var{dimension}} +@itemx @option{-O top-margin=@var{dimension}} +@itemx @option{-O bottom-margin=@var{dimension}} Sets the margins around the page. See below for the allowed forms of @var{dimension} Default: @code{0.5in}. -@item -O prop-font=@var{font-name} -@itemx -O emph-font=@var{font-name} -@itemx -O fixed-font=@var{font-name} +@item @option{-O prop-font=@var{font-name}} +@itemx @option{-O emph-font=@var{font-name}} +@itemx @option{-O fixed-font=@var{font-name}} Sets the font used for proportional, emphasized, or fixed-pitch text. Most systems support CSS-like font names such as ``serif'' and ``monospace'', but a wide range of system-specific font are likely to @@ -252,19 +252,19 @@ be supported as well. Default: proportional font @code{serif}, emphasis font @code{serif italic}, fixed-pitch font @code{monospace}. -@item -O font-size=@var{font-size} +@item @option{-O font-size=@var{font-size}} Sets the size of the default fonts, in thousandths of a point. Default: 10000 (10 point). -@item -O line-gutter=@var{dimension} +@item @option{-O line-gutter=@var{dimension}} Sets the width of white space on either side of lines that border text or graphics objects. Default: @code{1pt}. -@item -O line-spacing=@var{dimension} +@item @option{-O line-spacing=@var{dimension}} Sets the spacing between the lines in a double line in a table. Default: @code{1pt}. -@item -O line-width=@var{dimension} +@item @option{-O line-width=@var{dimension}} Sets the width of the lines used in tables. Default: @code{0.5pt}. @end table @@ -285,12 +285,12 @@ format. Plain text output is encoded in UTF-8. -@table @code -@item -O format=txt +@table @asis +@item @option{-O format=txt} Specify the output format. This is only necessary if the file name given on @option{-o} does not end in @file{.txt} or @file{.list}. -@item -O charts=@{@var{template}.png|none@} +@item @option{-O charts=@{@var{template}.png|none@}} Name for chart files included in output. The value should be a file name that includes a single @samp{#} and ends in @file{png}. When a chart is output, the @samp{#} is replaced by the chart number. The @@ -301,43 +301,43 @@ Specify @code{none} to disable chart output. Charts are always disabled if your installation of @pspp{} was compiled without the Cairo library. -@item -O paginate=@var{boolean} +@item @option{-O paginate=@var{boolean}} If set, @pspp{} writes an ASCII formfeed the end of every page. Default: @code{off}. -@item -O headers=@var{boolean} +@item @option{-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 at the top of every page. These two lines are in addition to any top margin requested. Default: @code{off}. -@item -O length=@var{line-count} +@item @option{-O length=@var{line-count}} Physical length of a page. Headers and margins are subtracted from this value. You may specify the number of lines as a number, or for screen output you may specify @code{auto} to track the height of the terminal as it changes. Default: @code{66}. -@item -O width=@var{character-count} +@item @option{-O width=@var{character-count}} Width of a page, in characters. Margins are subtracted from this value. For screen output you may specify @code{auto} in place of a number to track the width of the terminal as it changes. Default: @code{79}. -@item -O top-margin=@var{top-margin-lines} +@item @option{-O top-margin=@var{top-margin-lines}} 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} +@item @option{-O bottom-margin=@var{bottom-margin-lines}} Length of the bottom margin, in lines. @pspp{} subtracts this value from the page length. Default: @code{0}. -@item -O box=@{ascii|unicode@} +@item @option{-O box=@{ascii|unicode@}} Sets the characters used for lines in tables. The default, @code{ascii}, uses @samp{-}, @samp{|}, and @samp{+} for single-width lines and @samp{=} and @samp{#} for double-width lines. Specify @code{unicode} to use Unicode box drawing characters. -@item -O emphasis=@{none|bold|underline@} +@item @option{-O emphasis=@{none|bold|underline@}} How to emphasize text. Bold and underline emphasis are achieved with overstriking, which may not be supported by all the software to which you might pass the output. Default: @code{none}. @@ -350,20 +350,20 @@ To produce output in HTML format, specify @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. -@table @code -@item -O format=html +@table @asis +@item @option{-O format=html} Specify the output format. This is only necessary if the file name given on @option{-o} does not end in @file{.html}. -@item -O charts=@{@var{template}.png|none@} +@item @option{-O charts=@{@var{template}.png|none@}} Sets the name used for chart files. @xref{Plain Text Output Options}, for details. -@item -O borders=@var{boolean} +@item @option{-O borders=@var{boolean}} Decorate the tables with borders. If set to false, the tables produced will have no borders. The default value is true. -@item -O css=@var{boolean} +@item @option{-O css=@var{boolean}} Use cascading style sheets. Cascading style sheets give an improved appearance and can be used to produce pages which fit a certain web site's style. The default value is true. @@ -390,16 +390,16 @@ To produce output in comma-separated value (CSV) format, specify by any of the options shown in the table below to customize the output format. -@table @code -@item -O format=csv +@table @asis +@item @option{-O format=csv} Specify the output format. This is only necessary if the file name given on @option{-o} does not end in @file{.csv}. -@item -O separator=@var{field-separator} +@item @option{-O separator=@var{field-separator}} Sets the character used to separate fields. Default: a comma (@samp{,}). -@item -O quote=@var{qualifier} +@item @option{-O quote=@var{qualifier}} Sets @var{qualifier} as the character used to quote fields that contain white space, the separator (or any of the characters in the separator, if it contains more than one character), or the quote @@ -407,7 +407,7 @@ character itself. If @var{qualifier} is longer than one character, only the first character is used; if @var{qualifier} is the empty string, then fields are never quoted. -@item -O captions=@var{boolean} +@item @option{-O captions=@var{boolean}} Whether table captions should be printed. Default: @code{on}. @end table diff --git a/doc/regression.texi b/doc/regression.texi index e362c7fef1..127ec71645 100644 --- a/doc/regression.texi +++ b/doc/regression.texi @@ -63,7 +63,7 @@ All other subcommands are optional: The @subcmd{STATISTICS} subcommand specifies the statistics to be displayed: -@table @code +@table @subcmd @item ALL All of the statistics below. @item R @@ -80,9 +80,11 @@ The covariance matrix for the estimated model coefficients. The @subcmd{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 -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 +called @samp{RES1} if no such variable exists, @samp{RES2} if @samp{RES1} +already exists, +@samp{RES3} if @samp{RES1} and @samp{RES2} already exist, etc. It will +choose the name of +the variable for the predicted values similarly, but with @samp{PRED} as a prefix. @node Examples diff --git a/doc/statistics.texi b/doc/statistics.texi index f8a8864da7..0ae3d37862 100644 --- a/doc/statistics.texi +++ b/doc/statistics.texi @@ -51,17 +51,18 @@ variables to be analyzed. Keyword @subcmd{VARIABLES} is optional. All other subcommands are optional: The @subcmd{MISSING} subcommand determines the handling of missing variables. If -INCLUDE is set, then user-missing values are included in the -calculations. If NOINCLUDE is set, which is the default, user-missing -values are excluded. If VARIABLE is set, then missing values are -excluded on a variable by variable basis; if LISTWISE is set, then +@subcmd{INCLUDE} is set, then user-missing values are included in the +calculations. If @subcmd{NOINCLUDE} is set, which is the default, user-missing +values are excluded. If @subcmd{VARIABLE} is set, then missing values are +excluded on a variable by variable basis; if @subcmd{LISTWISE} is set, then the entire case is excluded whenever any value in that case has a -system-missing or, if INCLUDE is set, user-missing value. +system-missing or, if @subcmd{INCLUDE} is set, user-missing value. The @subcmd{FORMAT} subcommand affects the output format. Currently the -LABELS/NOLABELS and NOINDEX/INDEX settings are not used. When SERIAL is +@subcmd{LABELS/NOLABELS} and @subcmd{NOINDEX/INDEX} settings are not used. +When @subcmd{SERIAL} is set, both valid and missing number of cases are listed in the output; -when NOSERIAL is set, only valid cases are listed. +when @subcmd{NOSERIAL} is set, only valid cases are listed. The @subcmd{SAVE} subcommand causes @cmd{DESCRIPTIVES} to calculate Z scores for all the specified variables. The Z scores are saved to new variables. @@ -69,7 +70,7 @@ Variable names are generated by trying first the original variable name with Z prepended and truncated to a maximum of 8 characters, then the names ZSC000 through ZSC999, STDZ00 through STDZ09, ZZZZ00 through ZZZZ09, ZQZQ00 through ZQZQ09, in that sequence. In addition, Z score -variable names can be specified explicitly on VARIABLES in the variable +variable names can be specified explicitly on @subcmd{VARIABLES} in the variable list by enclosing them in parentheses after each variable. The @subcmd{STATISTICS} subcommand specifies the statistics to be displayed: @@ -106,11 +107,11 @@ Standard error of the skewness. @end table The @subcmd{SORT} subcommand specifies how the statistics should be sorted. Most -of the possible values should be self-explanatory. NAME causes the +of the possible values should be self-explanatory. @subcmd{NAME} causes the statistics to be sorted by name. By default, the statistics are listed -in the order that they are specified on the @subcmd{VARIABLES} subcommand. The A -and D settings request an ascending or descending sort order, -respectively. +in the order that they are specified on the @subcmd{VARIABLES} subcommand. +The @subcmd{A} and @subcmd{D} settings request an ascending or descending +sort order, respectively. @node FREQUENCIES @section FREQUENCIES @@ -166,13 +167,14 @@ respectively, by frequency count. @end itemize The @subcmd{MISSING} subcommand controls the handling of user-missing values. -When EXCLUDE, the default, is set, user-missing values are not included -in frequency tables or statistics. When INCLUDE is set, user-missing +When @subcmd{EXCLUDE}, the default, is set, user-missing values are not included +in frequency tables or statistics. When @subcmd{INCLUDE} is set, user-missing are included. System-missing values are never included in statistics, but are listed in frequency tables. -The available STATISTICS are the same as available in @cmd{DESCRIPTIVES} -(@pxref{DESCRIPTIVES}), with the addition of MEDIAN, the data's median +The available @subcmd{STATISTICS} are the same as available +in @cmd{DESCRIPTIVES} (@pxref{DESCRIPTIVES}), with the addition +of @subcmd{MEDIAN}, the data's median value, and MODE, the mode. (If there are multiple modes, the smallest value is reported.) By default, the mean, standard deviation of the mean, minimum, and maximum are reported for each variable. @@ -238,14 +240,14 @@ normal distribution, and for finding outliers and extreme values. The @subcmd{VARIABLES} subcommand is mandatory. It specifies the dependent variables and optionally variables to use as factors for the analysis. -Variables listed before the first BY keyword (if any) are the +Variables listed before the first @subcmd{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 dependent variable. Following the dependent variables, factors may be specified. -The factors (if desired) should be preceeded by a single BY keyword. +The factors (if desired) should be preceeded by a single @subcmd{BY} keyword. The format for each factor is @display @var{factorvar} [BY @var{subfactorvar}]. @@ -317,7 +319,7 @@ calculation of the descriptives command. The default is 95%. The @subcmd{PERCENTILES} subcommand specifies which percentiles are to be calculated, and which algorithm to use for calculating them. The default is to calculate the 5, 10, 25, 50, 75, 90, 95 percentiles using the -HAVERAGE algorithm. +@subcmd{HAVERAGE} algorithm. The @subcmd{TOTAL} and @subcmd{NOTOTAL} subcommands are mutually exclusive. If @subcmd{NOTOTAL} is given and factors have been specified in the @subcmd{VARIABLES} subcommand, @@ -394,15 +396,15 @@ CORRELATIONS The @cmd{CORRELATIONS} procedure produces tables of the Pearson correlation coefficient for a set of variables. The significance of the coefficients are also given. -At least one @subcmd{VARIABLES} subcommand is required. If the WITH keyword is used, then a non-square -correlation table will be produced. -The variables preceding WITH, will be used as the rows of the table, and the variables following -will be the columns of the table. +At least one @subcmd{VARIABLES} subcommand is required. If the @subcmd{WITH} +keyword is used, then a non-square correlation table will be produced. +The variables preceding @subcmd{WITH}, will be used as the rows of the table, +and the variables following will be the columns of the table. If no @subcmd{WITH} subcommand is given, then a square, symmetrical table using all variables is produced. The @cmd{MISSING} subcommand determines the handling of missing variables. -If INCLUDE is set, then user-missing values are included in the +If @subcmd{INCLUDE} is set, then user-missing values are included in the calculations, but system-missing values are not. If @subcmd{EXCLUDE} is set, which is the default, user-missing values are excluded as well as system-missing values. @@ -426,13 +428,13 @@ If @subcmd{SIG} is specified, then no highlighting is performed. This is the de @cindex covariance The @subcmd{STATISTICS} subcommand requests additional statistics to be displayed. The keyword -DESCRIPTIVES requests that the mean, number of non-missing cases, and the non-biased +@subcmd{DESCRIPTIVES} requests that the mean, number of non-missing cases, and the non-biased estimator of the standard deviation are displayed. These statistics will be displayed in a separated table, for all the variables listed in any @subcmd{/VARIABLES} subcommand. The @subcmd{XPROD} keyword requests cross-product deviations and covariance estimators to be displayed for each pair of variables. -The keyword ALL is the union of @subcmd{DESCRIPTIVES} and @subcmd{XPROD}. +The keyword @subcmd{ALL} is the union of @subcmd{DESCRIPTIVES} and @subcmd{XPROD}. @node CROSSTABS @section CROSSTABS @@ -483,9 +485,9 @@ In general mode, numeric and string variables may be specified on TABLES. In integer mode, only numeric variables are allowed. The @subcmd{MISSING} subcommand determines the handling of user-missing values. -When set to TABLE, the default, missing values are dropped on a table by -table basis. When set to INCLUDE, user-missing values are included in -tables and statistics. When set to REPORT, which is allowed only in +When set to @subcmd{TABLE}, the default, missing values are dropped on a table by +table basis. When set to @subcmd{INCLUDE}, user-missing values are included in +tables and statistics. When set to @subcmd{REPORT}, which is allowed only in integer mode, user-missing values are included in tables but marked with an @samp{M} (for ``missing'') and excluded from statistical calculations. @@ -496,10 +498,10 @@ The @subcmd{FORMAT} subcommand controls the characteristics of the crosstabulation tables to be displayed. It has a number of possible settings: -@itemize @subcmd{} +@itemize @asis @item -TABLES, the default, causes crosstabulation tables to be output. -NOTABLES suppresses them. +@subcmd{TABLES}, the default, causes crosstabulation tables to be output. +@subcmd{NOTABLES} suppresses them. @item @subcmd{PIVOT}, the default, causes each @subcmd{TABLES} subcommand to be displayed in a @@ -544,7 +546,8 @@ Suppress cells entirely. @end table @samp{/CELLS} without any settings specified requests @subcmd{COUNT}, @subcmd{ROW}, -@subcmd{COLUMN}, and @subcmd{TOTAL}. If CELLS is not specified at all then only @subcmd{COUNT} +@subcmd{COLUMN}, and @subcmd{TOTAL}. +If @subcmd{CELLS} is not specified at all then only @subcmd{COUNT} will be selected. The @subcmd{STATISTICS} subcommand selects statistics for computation: @@ -593,7 +596,7 @@ some statistics are calculated only in integer mode. @samp{/STATISTICS} without any settings selects CHISQ. If the @subcmd{STATISTICS} subcommand is not given, no statistics are calculated. -@strong{Please note:} Currently the implementation of CROSSTABS has the +@strong{Please note:} Currently the implementation of @cmd{CROSSTABS} has the followings bugs: @itemize @bullet @@ -644,18 +647,19 @@ FACTOR VARIABLES=@var{var_list} [ /MISSING=[@{LISTWISE, PAIRWISE@}] [@{INCLUDE, EXCLUDE@}] ] @end display -The FACTOR command performs Factor Analysis or Principal Axis Factoring on a dataset. It may be used to find +The @cmd{FACTOR} command performs Factor Analysis or Principal Axis Factoring on a dataset. It may be used to find common factors in the data or for data reduction purposes. The @subcmd{VARIABLES} subcommand is required. It lists the variables which are to partake in the analysis. The @subcmd{/EXTRACTION} subcommand is used to specify the way in which factors (components) are extracted from the data. -If PC is specified, then Principal Components Analysis is used. If PAF is specified, then Principal Axis Factoring is +If @subcmd{PC} is specified, then Principal Components Analysis is used. +If @subcmd{PAF} is specified, then Principal Axis Factoring is used. By default Principal Components Analysis will be used. The @subcmd{/ROTATION} subcommand is used to specify the method by which the extracted solution will be rotated. -Three methods are available: VARIMAX (which is the default), EQUAMAX, and QUARTIMAX. -If don't want any rotation to be performed, the word NOROTATE will prevent the command from performing any +Three methods are available: @subcmd{VARIMAX} (which is the default), @subcmd{EQUAMAX}, and @subcmd{QUARTIMAX}. +If don't want any rotation to be performed, the word @subcmd{NOROTATE} will prevent the command from performing any rotation on the data. Oblique rotations are not supported. The @subcmd{/METHOD} subcommand should be used to determine whether the covariance matrix or the correlation matrix of the data is @@ -685,15 +689,15 @@ The @subcmd{/PRINT} subcommand may be used to select which features of the analy @item ALL All of the above are printed. @item DEFAULT - Identical to INITIAL and EXTRACTION. + Identical to @subcmd{INITIAL} and @subcmd{EXTRACTION}. @end itemize If @subcmd{/PLOT=EIGEN} is given, then a ``Scree'' plot of the eigenvalues will be printed. This can be useful for visualizing which factors (components) should be retained. -The @subcmd{/FORMAT} subcommand determined how data are to be displayed in loading matrices. If SORT is specified, then the variables -are sorted in descending order of significance. If BLANK(@var{n}) is specified, then coefficients whose absolute value is less -than @var{n} will not be printed. If the keyword DEFAULT is given, or if no @subcmd{/FORMAT} subcommand is given, then no sorting is +The @subcmd{/FORMAT} subcommand determined how data are to be displayed in loading matrices. If @subcmd{SORT} is specified, then the variables +are sorted in descending order of significance. If @subcmd{BLANK(@var{n})} is specified, then coefficients whose absolute value is less +than @var{n} will not be printed. If the keyword @subcmd{DEFAULT} is given, or if no @subcmd{/FORMAT} subcommand is given, then no sorting is performed, and all coefficients will be printed. The @subcmd{/CRITERIA} subcommand is used to specify how the number of extracted factors (components) are chosen. @@ -1522,7 +1526,7 @@ more variables whose values are to be ranked. After each variable, @samp{A} or @samp{D} may appear, indicating that the variable is to be ranked in ascending or descending order. Ascending is the default. -If a BY keyword appears, it should be followed by a list of variables +If a @subcmd{BY} keyword appears, it should be followed by a list of variables which are to serve as group variables. In this case, the cases are gathered into groups, and ranks calculated for each group. @@ -1531,7 +1535,7 @@ The @subcmd{TIES} subcommand specifies how tied values are to be treated. The default is to take the mean value of all the tied cases. The @subcmd{FRACTION} subcommand specifies how proportional ranks are to be -calculated. This only has any effect if NORMAL or PROPORTIONAL rank +calculated. This only has any effect if @subcmd{NORMAL} or @subcmd{PROPORTIONAL} rank functions are requested. The @subcmd{PRINT} subcommand may be used to specify that a summary of the rank diff --git a/doc/transformation.texi b/doc/transformation.texi index 960e782a0c..605c08cd94 100644 --- a/doc/transformation.texi +++ b/doc/transformation.texi @@ -42,9 +42,9 @@ 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 @subcmd{OUTFILE} to write a portable file is a @pspp{} extension. -If OUTFILE=@samp{*} is given, then the subcommand MODE may also be +If @subcmd{OUTFILE=*} is given, then the subcommand @subcmd{MODE} may also be specified. The mode subcommand has two possible values: @subcmd{ADDVARIABLES} or @subcmd{REPLACE}. In @subcmd{REPLACE} mode, the entire active dataset is replaced by a new dataset @@ -100,110 +100,112 @@ list. Each set must have exactly as many source variables as aggregation variables. Each aggregation variable receives the results of applying the specified aggregation function to the corresponding source -variable. The MEAN, MEDIAN, SD, and SUM aggregation functions may only be +variable. The @subcmd{MEAN}, @subcmd{MEDIAN}, @subcmd{SD}, and @subcmd{SUM} +aggregation functions may only be applied to numeric variables. All the rest may be applied to numeric and string variables. The available aggregation functions are as follows: @table @asis -@item FGT(@var{var_name}, @var{value}) +@item @subcmd{FGT(@var{var_name}, @var{value})} Fraction of values greater than the specified constant. The default format is F5.3. -@item FIN(@var{var_name}, @var{low}, @var{high}) +@item @subcmd{FIN(@var{var_name}, @var{low}, @var{high})} Fraction of values within the specified inclusive range of constants. The default format is F5.3. -@item FLT(@var{var_name}, @var{value}) +@item @subcmd{FLT(@var{var_name}, @var{value})} Fraction of values less than the specified constant. The default format is F5.3. -@item FIRST(@var{var_name}) +@item @subcmd{FIRST(@var{var_name})} First non-missing value in break group. The aggregation variable receives the complete dictionary information from the source variable. The sort performed by @cmd{AGGREGATE} (and by @cmd{SORT CASES}) is stable, so that the first case with particular values for the break variables before sorting will also be the first case in that break group after sorting. -@item FOUT(@var{var_name}, @var{low}, @var{high}) +@item @subcmd{FOUT(@var{var_name}, @var{low}, @var{high})} Fraction of values strictly outside the specified range of constants. The default format is F5.3. -@item LAST(@var{var_name}) +@item @subcmd{LAST(@var{var_name})} Last non-missing value in break group. The aggregation variable receives the complete dictionary information from the source variable. The sort performed by @cmd{AGGREGATE} (and by @cmd{SORT CASES}) is stable, so that the last case with particular values for the break variables before sorting will also be the last case in that break group after sorting. -@item MAX(@var{var_name}) +@item @subcmd{MAX(@var{var_name})} Maximum value. The aggregation variable receives the complete dictionary information from the source variable. -@item MEAN(@var{var_name}) +@item @subcmd{MEAN(@var{var_name})} Arithmetic mean. Limited to numeric values. The default format is F8.2. -@item MEDIAN(@var{var_name}) +@item @subcmd{MEDIAN(@var{var_name})} The median value. Limited to numeric values. The default format is F8.2. -@item MIN(@var{var_name}) +@item @subcmd{MIN(@var{var_name})} Minimum value. The aggregation variable receives the complete dictionary information from the source variable. -@item N(@var{var_name}) +@item @subcmd{N(@var{var_name})} Number of non-missing values. The default format is F7.0 if weighting is not enabled, F8.2 if it is (@pxref{WEIGHT}). -@item N +@item @subcmd{N} Number of cases aggregated to form this group. The default format is F7.0 if weighting is not enabled, F8.2 if it is (@pxref{WEIGHT}). -@item NMISS(@var{var_name}) +@item @subcmd{NMISS(@var{var_name})} Number of missing values. The default format is F7.0 if weighting is not enabled, F8.2 if it is (@pxref{WEIGHT}). -@item NU(@var{var_name}) +@item @subcmd{NU(@var{var_name})} Number of non-missing values. Each case is considered to have a weight of 1, regardless of the current weighting variable (@pxref{WEIGHT}). The default format is F7.0. -@item NU +@item @subcmd{NU} Number of cases aggregated to form this group. Each case is considered to have a weight of 1, regardless of the current weighting variable. The default format is F7.0. -@item NUMISS(@var{var_name}) +@item @subcmd{NUMISS(@var{var_name})} Number of missing values. Each case is considered to have a weight of 1, regardless of the current weighting variable. The default format is F7.0. -@item PGT(@var{var_name}, @var{value}) +@item @subcmd{PGT(@var{var_name}, @var{value})} Percentage between 0 and 100 of values greater than the specified constant. The default format is F5.1. -@item PIN(@var{var_name}, @var{low}, @var{high}) +@item @subcmd{PIN(@var{var_name}, @var{low}, @var{high})} Percentage of values within the specified inclusive range of constants. The default format is F5.1. -@item PLT(@var{var_name}, @var{value}) +@item @subcmd{PLT(@var{var_name}, @var{value})} Percentage of values less than the specified constant. The default format is F5.1. -@item POUT(@var{var_name}, @var{low}, @var{high}) +@item @subcmd{POUT(@var{var_name}, @var{low}, @var{high})} Percentage of values strictly outside the specified range of constants. The default format is F5.1. -@item SD(@var{var_name}) +@item @subcmd{SD(@var{var_name})} Standard deviation of the mean. Limited to numeric values. The default format is F8.2. -@item SUM(var_name) +@item @subcmd{SUM(@var{var_name})} Sum. Limited to numeric values. The default format is F8.2. @end table Aggregation functions compare string values in terms of internal -character codes. On most modern computers, this is a form of ASCII. +character codes. +On most modern computers, this is @acronym{ASCII} or a superset thereof. The aggregation functions listed above exclude all user-missing values from calculations. To include user-missing values, insert a period @@ -240,18 +242,18 @@ By default, increasing values of a source variable (for a string, this is based on character code comparisons) are recoded to increasing values of its target variable. To cause increasing values of a source variable to be recoded to decreasing values of its target variable (@var{n} down -to 1), specify DESCENDING. +to 1), specify @subcmd{DESCENDING}. -PRINT is currently ignored. +@subcmd{PRINT} is currently ignored. The @subcmd{GROUP} subcommand is relevant only if more than one variable is to be recoded. It causes a single mapping between source and target values to be used, instead of one map per variable. -If /BLANK=MISSING is given, then string variables which contain only -whitespace are recoded as SYSMIS. If /BLANK=VALID is given then they -will be allocated a value like any other. /BLANK is not relevant -to numeric values. /BLANK=VALID is the default. +If @subcmd{/BLANK=MISSING} is given, then string variables which contain only +whitespace are recoded as SYSMIS. If @subcmd{/BLANK=VALID} is given then they +will be allocated a value like any other. @subcmd{/BLANK} is not relevant +to numeric values. @subcmd{/BLANK=VALID} is the default. @cmd{AUTORECODE} is a procedure. It causes the data to be read. @@ -310,8 +312,8 @@ Each @var{value} takes one of the following forms: @var{num1} THRU @var{num2} MISSING SYSMIS -In addition, @var{num1} and @var{num2} can be LO or LOWEST, or HI or HIGHEST, -respectively. +where @var{num1} is a numeric expression or the words @subcmd{LO} or @subcmd{LOWEST} + and @var{num2} is a numeric expression or @subcmd{HI} or @subcmd{HIGHEST}. @end display @cmd{COUNT} creates or replaces a numeric @dfn{target} variable that @@ -327,11 +329,11 @@ User-missing values of test variables are treated just like any other values. They are @strong{not} treated as system-missing values. User-missing values that are criterion values or inside ranges of criterion values are counted as any other values. However (for numeric -variables), keyword MISSING may be used to refer to all system- +variables), keyword @subcmd{MISSING} may be used to refer to all system- and user-missing values. @cmd{COUNT} target variables are assigned values in the order -specified. In the command @code{COUNT @var{A}=@var{A} @var{B}(1) /@var{B}=@var{A} @var{B}(2).}, the +specified. In the command @subcmd{COUNT @var{A}=@var{A} @var{B}(1) /@var{B}=@var{A} @var{B}(2).}, the following actions occur: @itemize @minus @@ -504,7 +506,7 @@ RECODE @var{src_vars} [INTO @var{dest_vars}]. @end display -Following the RECODE keyword itself comes @var{src_vars} which is a list +Following the @cmd{RECODE} keyword itself comes @var{src_vars} which is a list of variables whose values are to be transformed. These variables may be string variables or they may be numeric. However the list must be homogeneous; you may not mix string variables and diff --git a/doc/utilities.texi b/doc/utilities.texi index 7d4a7c343d..d370d80844 100644 --- a/doc/utilities.texi +++ b/doc/utilities.texi @@ -107,7 +107,7 @@ They can be viewed using @cmd{SYSFILE INFO} or @cmd{DISPLAY DOCUMENTS}. They can be removed from the active dataset with @cmd{DROP DOCUMENTS}. -Specify the @var{documentary text} following the DOCUMENT keyword. +Specify the @var{documentary text} following the @subcmd{DOCUMENT} keyword. It is interpreted literally --- any quotes or other punctuation marks will be included in the file. You can extend the documentary text over as many lines as necessary. @@ -169,11 +169,11 @@ Use @cmd{ECHO} to write arbitrary text to the output stream. The text should be @vindex ERASE @display -ERASE FILE file_name. +ERASE FILE @var{file_name}. @end display @cmd{ERASE FILE} deletes a file from the local filesystem. -file_name must be quoted. +@var{file_name} must be quoted. This command cannot be used if the SAFER (@pxref{SET}) setting is active. @@ -305,7 +305,7 @@ environment variables, e.g.@: @env{LANG} or @env{LC_ALL}, determine the system locale. @item @var{charset_name} -One of the character set names listed by IANA at +One of the character set names listed by @acronym{IANA} at @uref{http://www.iana.org/assignments/character-sets}. Some examples are @code{ASCII} (United States), @code{ISO-8859-1} (western Europe), @code{EUC-JP} (Japan), and @code{windows-1252} (Windows). Not all @@ -314,20 +314,20 @@ 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{} -generally assumes that the file is encoded in @var{encoding} (an IANA +generally assumes that the file is encoded in @var{encoding} (an @acronym{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 is encoded in @code{windows-1252}. -For best results, @var{encoding} should be an ASCII-compatible -encoding (the most common locale encodings are all ASCII-compatible), -because encodings that are not ASCII compatible cannot be +For best results, @var{encoding} should be an @acronym{ASCII}-compatible +encoding (the most common locale encodings are all @acronym{ASCII}-compatible), +because encodings that are not @acronym{ASCII} compatible cannot be automatically distinguished from UTF-8. @item @code{Auto} @item @code{Auto,Locale} Automatic detection, as above, with the default encoding taken from -the system locale or the setting on SET LOCALE. +the system locale or the setting on @subcmd{SET LOCALE}. @end table When ENCODING is not specified, the default is taken from the @@ -473,7 +473,7 @@ default. Any real value may be assigned. @item DECIMAL @anchor{SET DECIMAL} This value may be set to @subcmd{DOT} or @subcmd{COMMA}. -Setting it to DOT causes the decimal point character to be +Setting it to @subcmd{DOT} causes the decimal point character to be @samp{.} and the grouping character to be @samp{,}. Setting it to @subcmd{COMMA} causes the decimal point character to be @samp{,} and the grouping @@ -498,11 +498,11 @@ epoch. If @subcmd{AUTOMATIC} (the default) is specified, then the epoch begins @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 +Formats}). In @subcmd{MSBFIRST} ordering, the most-significant byte appears at +the left end of a IB or PIB field. In @subcmd{LSBFIRST} ordering, the +least-significant byte appears at the left end. @subcmd{VAX} ordering is like +@subcmd{MSBFIRST}, except that each pair of bytes is in reverse order. @subcmd{NATIVE}, +the default, is equivalent to @subcmd{MSBFIRST} or @subcmd{LSBFIRST} depending on the native format of the machine running @pspp{}. @item RRB @@ -580,9 +580,9 @@ execute. The syntax execution subcommands are @item LOCALE Overrides the system locale for the purpose of reading and writing syntax and data files. The argument should be a locale name in the -general form @code{language_country.encoding}, where @code{language} -and @code{country} are 2-character language and country abbreviations, -respectively, and @code{encoding} is an IANA character set name. +general form @code{@var{language}_@var{country}.@var{encoding}}, where @var{language} +and @var{country} are 2-character language and country abbreviations, +respectively, and @var{encoding} is an @acronym{IANA} character set name. Example locales are @code{en_US.UTF-8} (UTF-8 encoded English as spoken in the United States) and @code{ja_JP.EUC-JP} (EUC-JP encoded Japanese as spoken in Japan). @@ -631,8 +631,8 @@ Set up custom currency formats. @xref{Custom Currency Formats}, for details. @item DECIMAL -The default DOT setting causes the decimal point character to be -@samp{.}. A setting of COMMA causes the decimal point character to be +The default @subcmd{DOT} setting causes the decimal point character to be +@samp{.}. A setting of @subcmd{COMMA} causes the decimal point character to be @samp{,}. @item FORMAT @@ -644,11 +644,11 @@ default is F8.2. @xref{Input and Output Formats}. @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 +Formats}). In @subcmd{MSBFIRST} ordering, the most-significant byte appears at +the left end of a IB or PIB field. In @subcmd{LSBFIRST} ordering, the +least-significant byte appears at the left end. @subcmd{VAX} ordering is like +@subcmd{MSBFIRST}, except that each pair of bytes is in reverse order. @subcmd{NATIVE}, +the default, is equivalent to @subcmd{MSBFIRST} or @subcmd{LSBFIRST} depending on the native format of the machine running @pspp{}. @item WRB @@ -656,7 +656,7 @@ native format of the machine running @pspp{}. @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. +are the same as @subcmd{SET RIB}. The default is @subcmd{NATIVE}. @end table In the @pspp{} text-based interface, the output routing subcommands @@ -685,18 +685,18 @@ These output routing subcommands are: @table @asis @item ERRORS -Applies to error and warning messages. The default is BOTH. +Applies to error and warning messages. The default is @subcmd{BOTH}. @item MESSAGES -Applies to notes. The default is BOTH. +Applies to notes. The default is @subcmd{BOTH}. @item PRINTBACK Determines whether the syntax used for input is printed back as part -of the output. The default is NONE. +of the output. The default is @subcmd{NONE}. @item RESULTS Applies to everything not in one of the above categories, such as the -results of statistical procedures. The default is BOTH. +results of statistical procedures. The default is @subcmd{BOTH}. @end table These subcommands have no effect on output in the @pspp{} GUI @@ -711,14 +711,14 @@ subcommands are @itemx MORE @itemx WIDTH @itemx TNUMBERS -The TNUMBERS option sets the way in which values are displayed in output tables. -The valid settings are VALUES, LABELS and BOTH. -If TNUMBERS is set to VALUES, then all values are displayed with their literal value +The @subcmd{TNUMBERS} option sets the way in which values are displayed in output tables. +The valid settings are @subcmd{VALUES}, @subcmd{LABELS} and @subcmd{BOTH}. +If @subcmd{TNUMBERS} is set to @subcmd{VALUES}, then all values are displayed with their literal value (which for a numeric value is a number and for a string value an alphanumeric string). -If TNUMBERS is set to LABELS, then values are displayed using their assigned labels if any. +If @subcmd{TNUMBERS} is set to @subcmd{LABELS}, then values are displayed using their assigned labels if any. (@xref{VALUE LABELS}.) If the a value has no label, then it will be displayed using its literal value. -If TNUMBERS is set to BOTH, then values will be displayed with both their label +If @subcmd{TNUMBERS} is set to @subcmd{BOTH}, then values will be displayed with both their label (if any) and their literal value in parenthesis. @end table @@ -737,10 +737,10 @@ files. These subcommands are @item JOURNAL @itemx LOG These subcommands, which are synonyms, control the journal. The -default is ON, which causes commands entered interactively to be +default is @subcmd{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 -written to the journal file, prefixed by @samp{>}. OFF disables use +written to the journal file, prefixed by @samp{>}. @subcmd{OFF} disables use of the journal. The journal is named @file{pspp.jnl} by default. A different name may @@ -756,7 +756,7 @@ Not currently used. @item SCOMPRESSION Whether system files created by @cmd{SAVE} or @cmd{XSAVE} are -compressed by default. The default is ON. +compressed by default. The default is @subcmd{ON}. @end table Security subcommands affect the operations that commands are allowed to @@ -854,7 +854,7 @@ subcommands: @item @subcmd{ALL} Show all settings. @item @subcmd{CC} -Show all custom currency settings (CCA through CCE). +Show all custom currency settings (@subcmd{CCA} through @subcmd{CCE}). @item @subcmd{DIRECTORY} Shows the current working directory. @item @subcmd{ENVIRONMENT} diff --git a/doc/variables.texi b/doc/variables.texi index f19581ac1a..b0e7f350fb 100644 --- a/doc/variables.texi +++ b/doc/variables.texi @@ -210,8 +210,8 @@ where @var{missing_values} takes one of the following forms: @var{string1} @var{string1}, @var{string2} @var{string1}, @var{string2}, @var{string3} -As part of a range, LO or LOWEST may take the place of @var{num1}; -HI or HIGHEST may take the place of @var{num2}. +As part of a range, @subcmd{LO} or @subcmd{LOWEST} may take the place of @var{num1}; +@subcmd{HI} or @subcmd{HIGHEST} may take the place of @var{num2}. @end display @cmd{MISSING VALUES} sets user-missing values for numeric and string @@ -223,7 +223,8 @@ Specify a list of variables, followed by a list of their user-missing values in parentheses. Up to three discrete values may be given, or, for numeric variables only, a range of values optionally accompanied by a single discrete value. Ranges may be open-ended on one end, indicated -through the use of the keyword LO or LOWEST or HI or HIGHEST. +through the use of the +keyword @subcmd{LO} or @subcmd{LOWEST} or @subcmd{HI} or @subcmd{HIGHEST}. The @cmd{MISSING VALUES} command takes effect immediately. It is not affected by conditional and looping constructs such as @cmd{DO IF} or @@ -664,5 +665,5 @@ WRITE FORMATS @var{var_list} (@var{fmt_spec}) [@var{var_list} (@var{fmt_spec})]@ @cmd{WRITE FORMATS} sets the write formats for the specified variables to the specified format specification. Its syntax is identical to -that of FORMATS (@pxref{FORMATS}), but @cmd{WRITE FORMATS} sets only +that of @cmd{FORMATS} (@pxref{FORMATS}), but @cmd{WRITE FORMATS} sets only write formats, not print formats.