From: Robert D. <rob...@us...> - 2004-10-31 17:53:24
|
Update of /cvsroot/maxima/maxima/doc/info In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv10884/doc/info Modified Files: Input.texi Log Message: Cut out descriptions of obsolete functions BACKUP, BATCON, NOSTRING, and SPRINT, and obsolete variables BATCHKILL, BATCOUNT, CHANGE_FILEDEFAULTS, DIREC, DSKALL, FILENAME, FILENUM, FILE_STRING_PRINT, LINEDISP, and PARSEWINDOW. Source code untouched. Also put in some comments, marked by !!! and ???, for future content changes. Index: Input.texi =================================================================== RCS file: /cvsroot/maxima/maxima/doc/info/Input.texi,v retrieving revision 1.13 retrieving revision 1.14 diff -u -d -r1.13 -r1.14 --- Input.texi 31 Oct 2004 00:36:24 -0000 1.13 +++ Input.texi 31 Oct 2004 17:53:11 -0000 1.14 @@ -94,12 +94,6 @@ CLOSEFILE closes the transcript file opened by APPENDFILE or WRITEFILE. @end defun -@c @node BACKUP, BATCH, APPENDFILE, Input and Output -@c @unnumberedsec phony -@defun BACKUP () -To "back up" and see what you did, see PLAYBACK. - -@end defun @c @node BATCH, BATCHKILL, BACKUP, Input and Output @c @unnumberedsec phony @defun BATCH (file-specification) @@ -125,16 +119,6 @@ how the file argument is interpreted, and files in general. @end defun -@c @node BATCHKILL, BATCHLOAD, BATCH, Input and Output -@c @unnumberedsec phony -@defvar BATCHKILL - default: [FALSE] if TRUE then the effect of all previous -BATCH files is nullified because a KILL(ALL) and a RESET() will be -done automatically when the next one is read in. If BATCHKILL is -bound to any other atom then a KILL of the value of BATCHKILL will be -done. - -@end defvar @c @node BATCHLOAD, BATCON, BATCHKILL, Input and Output @c @unnumberedsec phony @defun BATCHLOAD (file-specification) @@ -142,20 +126,6 @@ terminal output or labels. @end defun -@c @node BATCON, BATCOUNT, BATCHLOAD, Input and Output -@c @unnumberedsec phony -@defun BATCON (argument) -continues BATCHing in a file which was interrupted. - -@end defun -@c @node BATCOUNT, BOTHCASES, BATCON, Input and Output -@c @unnumberedsec phony -@defvar BATCOUNT - default: [0] may be set to the number of the last expression -BATCHed in from a file. Thus BATCON(BATCOUNT-1) will resume BATCHing -from the expression before the last BATCHed in from before. - -@end defvar @c @node BOTHCASES, CHANGE_FILEDEFAULTS, BATCOUNT, Input and Output @c @unnumberedsec phony @defvar BOTHCASES @@ -203,19 +173,6 @@ @end defvar -@c @node CHANGE_FILEDEFAULTS, CLOSEFILE, BOTHCASES, Input and Output -@c @unnumberedsec phony -@defvar CHANGE_FILEDEFAULTS - default: [TRUE] on PDP10 systems, and FALSE -elsewhere. Controls whether the user doing a LOADFILE or BATCH has -his file defaults changed to the file LOADFILEd or BATCHed. The TRUE -setting is for people who like DDT-style file defaulting. The FALSE -setting is for people who like the conventions of other operating -systems, who like LISP-style file defaulting, or who write packages -which do LOADFILEs or BATCHes which should not interfere with their -user's file defaults. - -@end defvar @c @node CLOSEFILE, COLLAPSE, CHANGE_FILEDEFAULTS, Input and Output @c @unnumberedsec phony @defun CLOSEFILE () @@ -266,16 +223,6 @@ effect. @end defvar -@c @node DIREC, DISP, CURSORDISP, Input and Output -@c @unnumberedsec phony -@defvar DIREC - - The value of this variable is the default file directory for -SAVE, STORE, FASSAVE, and STRINGOUT. It is initialized to the user's -login name, if he has a disk directory, and to one of the USERSi -directories otherwise. DIREC determines to what directory disk files -will be written. - -@end defvar @c @node DISP, DISPCON, DIREC, Input and Output @c @unnumberedsec phony @defun DISP (expr1,expr2, ...) @@ -287,6 +234,8 @@ @end defun @c @node DISPCON, DISPLAY, DISP, Input and Output @c @unnumberedsec phony +@c HMM, THIS NEXT ITEM IS DEFINED IN A SHARE FILE (itensor.lisp); +@c DOES ITS DESCRIPTION WANT TO BE ELSEWHERE ??? @defun DISPCON (tensor1,tensor2,...) displays the contraction properties of the tensori as were given to DEFCON. DISPCON(ALL) displays all the @@ -360,15 +309,6 @@ the case of A^^B). @end defun -@c @node DSKALL, ERROR_SIZE, DISPTERMS, Input and Output -@c @unnumberedsec phony -@defvar DSKALL - default: [] If TRUE will cause values, functions, arrays, and -rules to be written periodically onto the disk in addition to labelled -expressions. TRUE is the default value whereas if DSKALL is FALSE -then only labelled expresions will be written. - -@end defvar @c @node ERROR_SIZE, ERROR_SYMS, DSKALL, Input and Output @c @unnumberedsec phony @defvar ERROR_SIZE @@ -431,6 +371,7 @@ @end defvar @c @node FASSAVE, FILEDEFAULTS, EXPTDISPFLAG, Input and Output @c @unnumberedsec phony +@c IS THIS FUNCTION EXPECTED TO WORK ANYMORE ??? IF NOT I'LL CUT IT. @defun FASSAVE (args) is similar to SAVE but produces a FASL file in which the sharing of subexpressions which are shared in core is preserved in @@ -443,17 +384,10 @@ large files. FASSAVE may be used while a WRITEFILE is in progress. @end defun -@c @node FILENAME, FILENAME_MERGE, FILEDEFAULTS, Input and Output -@c @unnumberedsec phony -@defvar FILENAME - default: [] - The value of this variable is the first name -of the files which are generated by the automatic disk storage scheme. -The default value is the first three characters of the user's login -name concatenated with the lowest unused integer, e.g. ECR1. - -@end defvar @c @node FILENAME_MERGE, FILENUM, FILENAME, Input and Output @c @unnumberedsec phony +@c THIS FUNCTION DOES EXIST BUT IT TAKES NO MORE THAN 2 ARGUMENTS !!! +@c ALSO THE DESCRIPTION SHOULD BE CLARIFIED, PERHAPS WITH EXAMPLES !!! @defun FILENAME_MERGE ("filename1","filename2",...) ; merges together filenames. What this means is that it returns "filename1" except @@ -461,15 +395,6 @@ "filename2", and if they are missing there, then from "filename3". @end defun -@c @node FILENUM, FILE_SEARCH, FILENAME_MERGE, Input and Output -@c @unnumberedsec phony -@defvar FILENUM - default: [0] - The default second file name for files generated -by SAVE, STRINGOUT, or FASSAVE if no file names are specified by the -user. It is an integer, and is incremented by one each time a new file -is written. - -@end defvar @c @node FILE_SEARCH, FILE_STRING_PRINT, FILENUM, Input and Output @c @unnumberedsec phony @defun FILE_SEARCH (filename) @@ -546,21 +471,9 @@ expands into @code{/home/wfs/neumann.lisp}, @code{/home/gcj/neumann.lisp}, @code{/home/wfs/neumann.mac}, and @code{/home/gcj/neumann.mac}. @end defvar -@c @node FILE_STRING_PRINT, FILE_TYPE, FILE_SEARCH, Input and Output -@c @unnumberedsec phony -@defvar FILE_STRING_PRINT - default: [FALSE] on MC, [TRUE] elsewhere. If -TRUE, filenames are output as strings; if FALSE, as lists. For -example, the message when an out of core file is loaded into -MACSYMA (e.g. the LIMIT package), appears on MC in list format as - LIMIT FASL DSK MACSYM being loaded -and in string format as: - DSK:MACSYM;LIMIT FASL being loaded -The string format is like the top level (DDT) file specifications. - -@end defvar @c @node FILE_TYPE, GRIND, FILE_STRING_PRINT, Input and Output @c @unnumberedsec phony +@c THIS FUNCTION DOES EXIST BUT DESCRIPTION SHOULD BE UPDATED !!! @defun FILE_TYPE ("filename") ; returns FASL, LISP, or MACSYMA, depending on what kind of file it is. FASL means a compiled Lisp file, which @@ -580,12 +493,14 @@ @end defun @c @node IBASE, INCHAR, GRIND, Input and Output @c @unnumberedsec phony +@c ALSO MENTION OBASE HERE !!! @defvar IBASE default: [10] - the base for inputting numbers. @end defvar @c @node INCHAR, LDISP, IBASE, Input and Output @c @unnumberedsec phony +@c UPDATE -- DEFAULT IS NOW %i !!! @defvar INCHAR default: [C] - the alphabetic prefix of the names of expressions typed by the user. @@ -607,22 +522,15 @@ @end defun @c @node LINECHAR, LINEDISP, LDISPLAY, Input and Output @c @unnumberedsec phony +@c UPDATE -- DEFAULT IS NOW %t !!! @defvar LINECHAR default: [E] - the alphabetic prefix of the names of intermediate displayed expressions. @end defvar -@c @node LINEDISP, LINEL, LINECHAR, Input and Output -@c @unnumberedsec phony -@defvar LINEDISP - default: [TRUE] - Allows the use of line graphics in the -drawing of equations on those systems which support them (e.g. the -Lisp Machine). This can be disabled by setting LINEDISP to FALSE. It -is automatically disabled during WRITEFILE. - -@end defvar @c @node LINEL, LOAD, LINEDISP, Input and Output @c @unnumberedsec phony +@c STILL EXISTS, NEEDS UPDATING !!! @defvar LINEL default: [] - the number of characters which are printed on a line. It is initially set by MACSYMA to the line length of the type of @@ -633,6 +541,7 @@ @end defvar @c @node LOAD, LOADFILE, LINEL, Input and Output @c @unnumberedsec phony +@c IN GREAT NEED OF CLARIFICATION AND UPDATING !!! @defun LOAD ("filename") ; takes one argument, a filename represented as a "string" (i.e. inside quotation marks), or as list (e.g. inside square @@ -704,6 +613,7 @@ @end defun @c @node LOADPRINT, NOSTRING, LOADFILE, Input and Output @c @unnumberedsec phony +@c SEEMS TO STILL EXIST; NEEDS UPDATING !!! @defvar LOADPRINT default: [TRUE] - governs the printing of messages accompanying loading of files. The following options are available: @@ -713,23 +623,16 @@ means never print the loading message. @end defvar -@c @node NOSTRING, OBASE, LOADPRINT, Input and Output -@c @unnumberedsec phony -@defun NOSTRING (arg) -displays all input lines when playing back rather than -STRINGing them. If arg is GRIND then the display will be in a more -readable format. One may include any number of options as in -PLAYBACK([5,10],20,TIME,SLOW). - -@end defun @c @node OBASE, OUTCHAR, NOSTRING, Input and Output @c @unnumberedsec phony +@c ALSO MENTION IBASE HERE !!! @defvar OBASE default: [10] the base for display of numbers. @end defvar @c @node OUTCHAR, PACKAGEFILE, OBASE, Input and Output @c @unnumberedsec phony +@c UPDATE -- DEFAULT IS NOW %o !!! @defvar OUTCHAR default: [D] - the alphabetic prefix of the names of outputted expressions. @@ -737,6 +640,7 @@ @end defvar @c @node PACKAGEFILE, PARSEWINDOW, OUTCHAR, Input and Output @c @unnumberedsec phony +@c STILL EXISTS, NEEDS CLARIFICATION !!! @defvar PACKAGEFILE default:[FALSE] - Package designers who use SAVE, FASSAVE, or TRANSLATE to create packages (files) for others @@ -751,16 +655,6 @@ init files. @end defvar -@c @node PARSEWINDOW, PFEFORMAT, PACKAGEFILE, Input and Output -@c @unnumberedsec phony -@defvar PARSEWINDOW - default:[10] - the maximum number of "lexical tokens" -that are printed out on each side of the error-point when a syntax -(parsing) error occurs. This option is especially useful on slow -terminals. Setting it to -1 causes the entire input string to be -printed out when an error occurs. - -@end defvar @c @node PFEFORMAT, PRINT, PARSEWINDOW, Input and Output @c @unnumberedsec phony @defvar PFEFORMAT @@ -782,13 +676,6 @@ @end defun -@defun SPRINT (exp1, exp2, ...) -evaluates and displays its arguments one -after the other "on a line" starting at the leftmost position. The -numbers are printed with the '-' right next to the number, and -it disregards line length. -@end defun - @defun TCL_OUTPUT (LIST INDEX &optional-skip) prints a TCL list based on LIST extracting the INDEX slot. Here skip defaults to 2, meaning that every other element @@ -805,6 +692,7 @@ @c @node READ, READONLY, PRINT, Input and Output @c @unnumberedsec phony +@c COULD NOTE THAT EXPRESSION IS COMMA OR DOLLAR SIGN TERMINATED !!! @defun READ (string1, ...) prints its arguments, then reads in and evaluates one expression. For example: A:READ("ENTER THE NUMBER OF VALUES"). @@ -845,6 +733,7 @@ @end defvar @c @node SAVE, SAVEDEF, RMXCHAR, Input and Output @c @unnumberedsec phony +@c IN GREAT NEED OF UPDATING AND CLARIFICATION !!! @defun SAVE (filename,arg1, arg2,...,argi) saves quantities described by its arguments on disk and keeps them in core also. @@ -873,6 +762,7 @@ @end defvar @c @node SHOW, SHOWRATVARS, SAVEDEF, Input and Output @c @unnumberedsec phony +@c THIS FUNCTION IS IN THE SHARE PACKAGE itensor.lisp -- DOES THIS DESCRIPTION WANT TO BE ELSEWHERE ??? @defun SHOW (exp) will display exp with the indexed objects in it shown having covariant indices as subscripts,contravariant indices as @@ -997,6 +887,7 @@ @c @node TTYOFF, WRITEFILE, STRINGOUT, Input and Output @c @unnumberedsec phony +@c SHOULD NOTE THAT TTYOFF:TRUE DOESN'T STOP OUTPUT PRINTED BY LISP FCNS !!! (E.G. DESCRIBE) @defvar TTYOFF default: [FALSE] - if TRUE stops printing output to the console. |