X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=doc%2Futilities.texi;h=116c49fa8cb6b5a6ca4dc359bbad58108798f587;hb=6f422d9a7e709779c5ba8d1589fe294849dd38e8;hp=3196684966eadb474eafe4ca6e0c87baa73ec656;hpb=8acca2de53c1852f38726f70fc6516b34732a79f;p=pspp-builds.git diff --git a/doc/utilities.texi b/doc/utilities.texi index 31966849..116c49fa 100644 --- a/doc/utilities.texi +++ b/doc/utilities.texi @@ -1,4 +1,4 @@ -@node Utilities, Not Implemented, Statistics, Top +@node Utilities @chapter Utilities Commands that don't fit any other category are placed here. @@ -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 @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 + + +@node DOCUMENT @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,12 +84,14 @@ 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 +@node DISPLAY DOCUMENTS @section DISPLAY DOCUMENTS @vindex DISPLAY DOCUMENTS @@ -76,7 +103,7 @@ DISPLAY DOCUMENTS. document is preceded by a line giving the time and date that it was added. @xref{DOCUMENT}. -@node DISPLAY FILE LABEL, DROP DOCUMENTS, DISPLAY DOCUMENTS, Utilities +@node DISPLAY FILE LABEL @section DISPLAY FILE LABEL @vindex DISPLAY FILE LABEL @@ -90,7 +117,7 @@ if any. @xref{FILE LABEL}. This command is a PSPP extension. -@node DROP DOCUMENTS, ECHO, DISPLAY FILE LABEL, Utilities +@node DROP DOCUMENTS @section DROP DOCUMENTS @vindex DROP DOCUMENTS @@ -104,7 +131,7 @@ New documents can be added with @cmd{DOCUMENT} (@pxref{DOCUMENT}). @cmd{DROP DOCUMENTS} changes only the active file. It does not modify any system files stored on disk. -@node ECHO, ERASE, DROP DOCUMENTS, Utilities +@node ECHO @section ECHO @vindex ECHO @@ -114,7 +141,7 @@ ECHO 'arbitrary text' . Use @cmd{ECHO} to write arbitrary text to the output stream. The text should be enclosed in quotation marks following the normal rules for string tokens (@pxref{Tokens}). -@node ERASE, EXECUTE, ECHO, Utilities +@node ERASE @comment node-name, next, previous, up @section ERASE @vindex ERASE @@ -128,7 +155,7 @@ file_name must be quoted. This command cannot be used if the SAFER setting is active. -@node EXECUTE, FILE LABEL, ERASE, Utilities +@node EXECUTE @section EXECUTE @vindex EXECUTE @@ -139,7 +166,7 @@ EXECUTE. @cmd{EXECUTE} causes the active file to be read and all pending transformations to be executed. -@node FILE LABEL, FINISH, EXECUTE, Utilities +@node FILE LABEL @section FILE LABEL @vindex FILE LABEL @@ -154,7 +181,7 @@ created during this PSPP run. file_label need not be quoted. If quotes are included, they become part of the file label. -@node FINISH, HOST, FILE LABEL, Utilities +@node FINISH @section FINISH @vindex FINISH @@ -165,7 +192,7 @@ FINISH. @cmd{FINISH} terminates the current PSPP session and returns control to the operating system. -@node HOST, INCLUDE, FINISH, Utilities +@node HOST @comment node-name, next, previous, up @section HOST @vindex HOST @@ -179,7 +206,7 @@ to the operating system. This command cannot be used if the SAFER setting is active. -@node INCLUDE, PERMISSIONS, HOST, Utilities +@node INCLUDE @section INCLUDE @vindex INCLUDE @vindex @@ @@ -197,7 +224,7 @@ command file. Include files may be nested to any depth, up to the limit of available memory. -@node PERMISSIONS, SET, INCLUDE, Utilities +@node PERMISSIONS @comment node-name, next, previous, up @section PERMISSIONS @vindex PERMISSIONS @@ -222,7 +249,7 @@ unchanged. This command cannot be used if the SAFER setting is active. -@node SET, SHOW, PERMISSIONS, Utilities +@node SET @section SET @vindex SET @@ -594,7 +621,7 @@ When set, this setting cannot be reset during the same session, for obvious security reasons. @end table -@node SHOW, SUBTITLE, SET, Utilities +@node SHOW @comment node-name, next, previous, up @section SHOW @vindex SHOW @@ -643,7 +670,7 @@ Display the terms of PSPP's copyright licence (@pxref{License}). Specifying @cmd{SHOW} without any subcommands is equivalent to SHOW ALL. -@node SUBTITLE, TITLE, SHOW, Utilities +@node SUBTITLE @section SUBTITLE @vindex SUBTITLE @@ -661,7 +688,7 @@ Specify a subtitle as a string in quotes. The alternate syntax that did not require quotes is now obsolete. If it is used then the subtitle is converted to all uppercase. -@node TITLE, , SUBTITLE, Utilities +@node TITLE @section TITLE @vindex TITLE