/[pspp]/pspp/doc/files.texi
ViewVC logotype

Diff of /pspp/doc/files.texi

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.4 by blp, Tue Apr 26 06:32:02 2005 UTC revision 1.5 by blp, Sun Aug 21 07:21:06 2005 UTC
# Line 12  portable files. Line 12  portable files.
12  * MATCH FILES::                 Merge system files.  * MATCH FILES::                 Merge system files.
13  * SAVE::                        Write to a system file.  * SAVE::                        Write to a system file.
14  * SYSFILE INFO::                Display system file dictionary.  * SYSFILE INFO::                Display system file dictionary.
15  * XSAVE::                       Write to a system file, as a transform.  * XEXPORT::                     Write to a portable file, as a transformation.
16    * XSAVE::                       Write to a system file, as a transformation.
17  @end menu  @end menu
18    
19  @node APPLY DICTIONARY, EXPORT, System and Portable Files, System and Portable Files  @node APPLY DICTIONARY
20  @section APPLY DICTIONARY  @section APPLY DICTIONARY
21  @vindex APPLY DICTIONARY  @vindex APPLY DICTIONARY
22    
# Line 61  the active file weighting variable. Line 62  the active file weighting variable.
62  active  active
63  file.  The system file is not modified.  file.  The system file is not modified.
64    
65  @node EXPORT, GET, APPLY DICTIONARY, System and Portable Files  @node EXPORT
66  @section EXPORT  @section EXPORT
67  @vindex EXPORT  @vindex EXPORT
68    
69  @display  @display
70  EXPORT  EXPORT
71          /OUTFILE='filename'          /OUTFILE='filename'
72            /UNSELECTED=@{RETAIN,DELETE@}
73            /DIGITS=n
74          /DROP=var_list          /DROP=var_list
75          /KEEP=var_list          /KEEP=var_list
76          /RENAME=(src_names=target_names)@dots{}          /RENAME=(src_names=target_names)@dots{}
77            /TYPE=@{COMM,TAPE@}
78            /MAP
79  @end display  @end display
80    
81  The @cmd{EXPORT} procedure writes the active file dictionary and data to a  The @cmd{EXPORT} procedure writes the active file dictionary and data to a
82  specified portable file.  specified portable file.
83    
84    By default, cases excluded with FILTER are written to the portable
85    file.  These can be excluded by specifying DELETE on the UNSELECTED
86    subcommand.  Specifying RETAIN makes the default explicit.
87    
88    Portable files express real numbers in base 30.  Integers are always
89    expressed to the maximum precision needed to make them exact.
90    Non-integers are, by default, expressed to the machine's maximum
91    natural precision (approximately 15 decimal digits on many machines).
92    If many numbers require this many digits, the portable file may
93    significantly increase in size.  As an alternative, the DIGITS
94    subcommand may be used to specify the number of decimal digits of
95    precision to write.  DIGITS applies only to non-integers.
96    
97  The OUTFILE subcommand, which is the only required subcommand, specifies  The OUTFILE subcommand, which is the only required subcommand, specifies
98  the portable file to be written as a file name string or a file handle  the portable file to be written as a file name string or a file handle
99  (@pxref{FILE HANDLE}).  (@pxref{FILE HANDLE}).
# Line 83  the portable file to be written as a fil Line 101  the portable file to be written as a fil
101  DROP, KEEP, and RENAME follow the same format as the SAVE procedure  DROP, KEEP, and RENAME follow the same format as the SAVE procedure
102  (@pxref{SAVE}).  (@pxref{SAVE}).
103    
104    The TYPE subcommand specifies the character set for use in the
105    portable file.  Its value is currently not used.
106    
107    The MAP subcommand is currently ignored.
108    
109  @cmd{EXPORT} is a procedure.  It causes the active file to be read.  @cmd{EXPORT} is a procedure.  It causes the active file to be read.
110    
111  @node GET, IMPORT, EXPORT, System and Portable Files  @node GET
112  @section GET  @section GET
113  @vindex GET  @vindex GET
114    
# Line 130  is affected by these subcommands. Line 153  is affected by these subcommands.
153  @cmd{GET} does not cause the data to be read, only the dictionary.  The data  @cmd{GET} does not cause the data to be read, only the dictionary.  The data
154  is read later, when a procedure is executed.  is read later, when a procedure is executed.
155    
156  @node IMPORT, MATCH FILES, GET, System and Portable Files  @node IMPORT
157  @section IMPORT  @section IMPORT
158  @vindex IMPORT  @vindex IMPORT
159    
# Line 158  DROP, KEEP, and RENAME follow the syntax Line 181  DROP, KEEP, and RENAME follow the syntax
181  @cmd{IMPORT} does not cause the data to be read, only the dictionary.  The  @cmd{IMPORT} does not cause the data to be read, only the dictionary.  The
182  data is read later, when a procedure is executed.  data is read later, when a procedure is executed.
183    
184  @node MATCH FILES, SAVE, IMPORT, System and Portable Files  @node MATCH FILES
185  @section MATCH FILES  @section MATCH FILES
186  @vindex MATCH FILES  @vindex MATCH FILES
187    
# Line 224  FIRST, LAST, and MAP are currently ignor Line 247  FIRST, LAST, and MAP are currently ignor
247  @cmd{MATCH FILES} may not be specified following @cmd{TEMPORARY}  @cmd{MATCH FILES} may not be specified following @cmd{TEMPORARY}
248  (@pxref{TEMPORARY}) if the active file is used as an input source.  (@pxref{TEMPORARY}) if the active file is used as an input source.
249    
250  @node SAVE, SYSFILE INFO, MATCH FILES, System and Portable Files  @node SAVE
251  @section SAVE  @section SAVE
252  @vindex SAVE  @vindex SAVE
253    
254  @display  @display
255  SAVE  SAVE
256          /OUTFILE='filename'          /OUTFILE='filename'
257            /UNSELECTED=@{RETAIN,DELETE@}
258          /@{COMPRESSED,UNCOMPRESSED@}          /@{COMPRESSED,UNCOMPRESSED@}
259            /PERMISSIONS=@{WRITEABLE,READONLY@}
260          /DROP=var_list          /DROP=var_list
261          /KEEP=var_list          /KEEP=var_list
262          /VERSION=version          /VERSION=version
263          /RENAME=(src_names=target_names)@dots{}          /RENAME=(src_names=target_names)@dots{}
264            /NAMES
265            /MAP
266  @end display  @end display
267    
268  The @cmd{SAVE} procedure causes the dictionary and data in the active  The @cmd{SAVE} procedure causes the dictionary and data in the active
# Line 246  OUTFILE is the only required subcommand. Line 273  OUTFILE is the only required subcommand.
273  file to be written as a string file name or a file handle (@pxref{FILE  file to be written as a string file name or a file handle (@pxref{FILE
274  HANDLE}).  HANDLE}).
275    
276    By default, cases excluded with FILTER are written to the system file.
277    These can be excluded by specifying DELETE on the UNSELECTED
278    subcommand.  Specifying RETAIN makes the default explicit.
279    
280  The COMPRESS and UNCOMPRESS subcommand determine whether the saved  The COMPRESS and UNCOMPRESS subcommand determine whether the saved
281  system file is compressed.  By default, system files are compressed.  system file is compressed.  By default, system files are compressed.
282  This default can be changed with the SET command (@pxref{SET}).  This default can be changed with the SET command (@pxref{SET}).
283    
284    The PERMISSIONS subcommand specifies permissions for the new system
285    file.  WRITEABLE, the default, creates the file with read and write
286    permission.  READONLY creates the file for read-only access.
287    
288  By default, all the variables in the active file dictionary are written  By default, all the variables in the active file dictionary are written
289  to the system file.  The DROP subcommand can be used to specify a list  to the system file.  The DROP subcommand can be used to specify a list
290  of variables not to be written.  In contrast, KEEP specifies variables  of variables not to be written.  In contrast, KEEP specifies variables
# Line 274  the active file.  DROP, KEEP, and RENAME Line 309  the active file.  DROP, KEEP, and RENAME
309  written to disk.  written to disk.
310    
311  The VERSION subcommand specifies the version of the file format. Valid  The VERSION subcommand specifies the version of the file format. Valid
312  versions are '3' and '3x'.  Version 3x system files are identical to  versions are 2 and 3.  The default version is 3.  In version 2 system
313  version 3 files, except that variable names greater than 8 bytes will  files, variable names longer than 8 bytes will be truncated.  The two
314  be truncated.  The default version is 3.  The VERSION subcommand is  versions are otherwise identical.
315  optional.  There is no need ever to use it.  
316    The NAMES and MAP subcommands are currently ignored.
317    
318  @cmd{SAVE} causes the data to be read.  It is a procedure.  @cmd{SAVE} causes the data to be read.  It is a procedure.
319    
320  @node SYSFILE INFO, XSAVE, SAVE, System and Portable Files  @node SYSFILE INFO
321  @section SYSFILE INFO  @section SYSFILE INFO
322  @vindex SYSFILE INFO  @vindex SYSFILE INFO
323    
# Line 297  a system file and displays information o Line 333  a system file and displays information o
333    
334  @cmd{SYSFILE INFO} does not affect the current active file.  @cmd{SYSFILE INFO} does not affect the current active file.
335    
336  @node XSAVE,  , SYSFILE INFO, System and Portable Files  @node XEXPORT
337    @section XEXPORT
338    @vindex XEXPORT
339    
340    @display
341    EXPORT
342            /OUTFILE='filename'
343            /DIGITS=n
344            /DROP=var_list
345            /KEEP=var_list
346            /RENAME=(src_names=target_names)@dots{}
347            /TYPE=@{COMM,TAPE@}
348            /MAP
349    @end display
350    
351    The @cmd{EXPORT} transformation writes the active file dictionary and
352    data to a specified portable file.
353    
354    This transformation is a PSPP extension.
355    
356    It is similar to the @cmd{EXPORT} procedure, with two differences:
357    
358    @itemize
359    @item
360    @cmd{XEXPORT} is a transformation, not a procedure.  It is executed when
361    the data is read by a procedure or procedure-like command.
362    
363    @item
364    @cmd{XEXPORT} does not support the UNSELECTED subcommand.
365    @end itemize
366    
367    @xref{EXPORT}, for more information.
368    
369    @node XSAVE,  , XEXPORT, System and Portable Files
370  @section XSAVE  @section XSAVE
371  @vindex XSAVE  @vindex XSAVE
372    
# Line 305  a system file and displays information o Line 374  a system file and displays information o
374  XSAVE  XSAVE
375          /OUTFILE='filename'          /OUTFILE='filename'
376          /@{COMPRESSED,UNCOMPRESSED@}          /@{COMPRESSED,UNCOMPRESSED@}
377            /PERMISSIONS=@{WRITEABLE,READONLY@}
378          /DROP=var_list          /DROP=var_list
379          /KEEP=var_list          /KEEP=var_list
380            /VERSION=version
381          /RENAME=(src_names=target_names)@dots{}          /RENAME=(src_names=target_names)@dots{}
382            /NAMES
383            /MAP
384  @end display  @end display
385    
386  The @cmd{XSAVE} transformation writes the active file dictionary and  The @cmd{XSAVE} transformation writes the active file dictionary and
387  data to a  data to a system file stored on disk.  It is similar to the @cmd{SAVE}
388  system file stored on disk.  procedure, with two differences:
389    
390    @itemize
391    @item
392    @cmd{XSAVE} is a transformation, not a procedure.  It is executed when
393    the data is read by a procedure or procedure-like command.
394    
395    @item
396    @cmd{XSAVE} does not support the UNSELECTED subcommand.
397    @end itemize
398    
399  @cmd{XSAVE} is a transformation, not a procedure.  It is executed when the  @xref{SAVE}, for more information.
 data is read by a procedure or procedure-like command.  In all other  
 respects, @cmd{XSAVE} is identical to @cmd{SAVE}.  @xref{SAVE}, for  
 more information on syntax and usage.  
400  @setfilename ignored  @setfilename ignored

Legend:
Removed from v.1.4  
changed lines
  Added in v.1.5

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26