X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=doc%2Futilities.texi;h=009706e22584dc8591508992813cd6d4ff08cd9d;hb=04bf0e1fed86a5dc9032f2fc8d89ed6217b566e1;hp=3c688292ebc23c6b84d7c774bc3432825acb0bb6;hpb=009350385d97d9fba2b33ea68cfe8b1aeebf1529;p=pspp diff --git a/doc/utilities.texi b/doc/utilities.texi index 3c688292eb..009706e225 100644 --- a/doc/utilities.texi +++ b/doc/utilities.texi @@ -9,6 +9,7 @@ they take effect only once, unconditionally, at the time that they are encountered in the input. @menu +* ADD DOCUMENT:: Add documentary text to the active file. * COMMENT:: Document your syntax file. * DOCUMENT:: Document the active file. * DISPLAY DOCUMENTS:: Display active file documents. @@ -28,7 +29,29 @@ encountered in the input. * TITLE:: Provide a document title. @end menu -@node COMMENT, DOCUMENT, Utilities, Utilities +@node ADD DOCUMENT, COMMENT, Utilities, Utilities +@comment node-name, next, previous, up +@section ADD DOCUMENT +@vindex ADD DOCUMENT + +@display +ADD DOCUMENT + 'line one' 'line two' @dots{} 'last line' . +@end display + + +@cmd{ADD DOCUMENT} adds one or more lines of descriptive commentary to +the active file. Documents added in this way are saved to system files. +They can be viewed using @cmd{SYSFILE INFO} or @cmd{DISPLAY +DOCUMENTS}. They can be removed from the active file with @cmd{DROP +DOCUMENTS}. + +Each line of documentary text must be enclosed in quotation marks, and +may not be more than 80 bytes long. @xref{DOCUMENT}. + + + +@node COMMENT, DOCUMENT, ADD DOCUMENT, Utilities @section COMMENT @vindex COMMENT @vindex * @@ -45,12 +68,14 @@ 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. + + @node DOCUMENT, DISPLAY DOCUMENTS, COMMENT, Utilities @section DOCUMENT @vindex DOCUMENT @display -DOCUMENT documentary_text. +DOCUMENT @var{documentary_text}. @end display @cmd{DOCUMENT} adds one or more lines of descriptive commentary to the @@ -59,10 +84,12 @@ They can be viewed using @cmd{SYSFILE INFO} or @cmd{DISPLAY DOCUMENTS}. They can be removed from the active file with @cmd{DROP DOCUMENTS}. -Specify the documentary text following the DOCUMENT keyword. You can -extend the documentary text over as many lines as necessary. Lines are -truncated at 80 characters width. Don't forget to terminate -the command with a dot or a blank line. +Specify the @var{documentary text} following the 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. +Lines are truncated at 80 bytes. Don't forget to terminate +the command with a dot or a blank line. @xref{ADD DOCUMENT}. @node DISPLAY DOCUMENTS, DISPLAY FILE LABEL, DOCUMENT, Utilities @section DISPLAY DOCUMENTS @@ -88,6 +115,8 @@ DISPLAY FILE LABEL. active file, if any. @xref{FILE LABEL}. +This command is a PSPP extension. + @node DROP DOCUMENTS, ECHO, DISPLAY FILE LABEL, Utilities @section DROP DOCUMENTS @vindex DROP DOCUMENTS @@ -184,8 +213,8 @@ This command cannot be used if the SAFER setting is active. @display Two possible syntaxes: - INCLUDE 'filename'. - @@filename. + INCLUDE 'file-name'. + @@file-name. @end display @cmd{INCLUDE} causes the PSPP command processor to read an @@ -205,7 +234,7 @@ memory. @display PERMISSIONS - FILE='filename' + FILE='file-name' /PERMISSIONS = @{READONLY,WRITEABLE@}. @end display @@ -232,6 +261,8 @@ SET /DECIMAL=@{DOT,COMMA@} /FORMAT=fmt_spec /EPOCH=@{AUTOMATIC,year@} + /RIB=@{NATIVE,MSBFIRST,LSBFIRST,VAX@} + /RRB=@{NATIVE,ISL,ISB,IDL,IDB,VF,VD,VG,ZS,ZL@} (program input) /ENDCMD='.' @@ -258,6 +289,8 @@ SET /CC@{A,B,C,D,E@}=@{'npre,pre,suf,nsuf','npre.pre.suf.nsuf'@} /DECIMAL=@{DOT,COMMA@} /FORMAT=fmt_spec + /WIB=@{NATIVE,MSBFIRST,LSBFIRST,VAX@} + /WRB=@{NATIVE,ISL,ISB,IDL,IDB,VF,VD,VG,ZS,ZL@} (output routing) /ECHO=@{ON,OFF@} @@ -270,12 +303,12 @@ SET (output driver options) /HEADERS=@{NO,YES,BLANK@} /LENGTH=@{NONE,length_in_lines@} - /LISTING=@{ON,OFF,filename@} + /LISTING=@{ON,OFF,'file-name'@} /MORE=@{ON,OFF@} /WIDTH=@{NARROW,WIDTH,n_characters@} (logging) - /JOURNAL=@{ON,OFF@} [filename] + /JOURNAL=@{ON,OFF@} ['file-name'] (system files) /COMPRESSION=@{ON,OFF@} @@ -320,22 +353,86 @@ system-missing value to be assigned to null items. This is the default. Any real value may be assigned. @item DECIMAL +@anchor{SET DECIMAL} The default DOT setting causes the decimal point character to be -@samp{.}. A setting of COMMA causes the decimal point character to be -@samp{,}. +@samp{.} and the grouping character to be @samp{,}. A setting of COMMA +causes the decimal point character to be @samp{,} and the grouping +character to be @samp{.}. @item FORMAT Allows the default numeric input/output format to be specified. The -default is F8.2. @xref{Input/Output Formats}. +default is F8.2. @xref{Input and Output Formats}. @item EPOCH @anchor{SET EPOCH} Specifies the range of years used when a 2-digit year is read from a data file or used in a date construction expression (@pxref{Date -Construction}). If a 4-digit year is specified, then 2-digit years -are interpreted starting from that year, known as the epoch. If -AUTOMATIC (the default) is specified, then the epoch begins 69 years -before the current date. +Construction}). If a 4-digit year is specified for the epoch, then +2-digit years are interpreted starting from that year, known as the +epoch. If AUTOMATIC (the default) is specified, then the epoch begins +69 years before the current date. + +@item RIB +@anchor{SET RIB} + +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. + +@item RRB +@anchor{SET RRB} + +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 +or IDB. + +@item ISL +32-bit IEEE 754 single-precision floating point, in little-endian byte +order. + +@item ISB +32-bit IEEE 754 single-precision floating point, in big-endian byte +order. + +@item IDL +64-bit IEEE 754 double-precision floating point, in little-endian byte +order. + +@item IDB +64-bit IEEE 754 double-precision floating point, in big-endian byte +order. + +@item VF +32-bit VAX F format, in VAX-endian byte order. + +@item VD +64-bit VAX D format, in VAX-endian byte order. + +@item VG +64-bit VAX G format, in VAX-endian byte order. + +@item ZS +32-bit IBM Z architecture short format hexadecimal floating point, in +big-endian byte order. + +@item ZL +64-bit IBM Z architecture long format hexadecimal floating point, in +big-endian byte order. + +Z architecture also supports IEEE 754 floating point. The ZS and ZL +formats are only for use with very old input files. +@end table +The default is NATIVE. @end table Program input subcommands affect the way that programs are parsed when @@ -408,18 +505,10 @@ subcommands are @itemx CCC @itemx CCD @itemx CCE -Set up custom currency formats. The argument is a string which must -contain exactly three commas or exactly three periods. If commas, then -the grouping character for the currency format is @samp{,}, and the -decimal point character is @samp{.}; if periods, then the situation is -reversed. - -The commas or periods divide the string into four fields, which are, in -order, the negative prefix, prefix, suffix, and negative suffix. When a -value is formatted using the custom currency format, the prefix precedes -the value formatted and the suffix follows it. In addition, if the -value is negative, the negative prefix precedes the prefix and the -negative suffix follows the suffix. +@anchor{CCx Settings} + +Set up custom currency formats. @xref{Custom Currency Formats}, for +details. @item DECIMAL The default DOT setting causes the decimal point character to be @@ -428,7 +517,26 @@ The default DOT setting causes the decimal point character to be @item FORMAT Allows the default numeric input/output format to be specified. The -default is F8.2. @xref{Input/Output Formats}. +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 +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. + +@item WRB +@anchor{SET WRB} + +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 Output routing subcommands affect where the output of transformations @@ -504,7 +612,7 @@ The HOST command. @item The PERMISSIONS command. @item -Pipe filenames (filenames beginning or ending with @samp{|}). +Pipes (file names beginning or ending with @samp{|}). @end itemize Be aware that this setting does not guarantee safety (commands can still