*DBASE HELP TEXT FILE DBASEMSG.TXT VERSION 1.17 FOR dBASE II v2.43* Copyright 1983 Ashton-Tate and RSP, Inc. Written by Wayne Ratliff, Jim Taylor, and Howard Dickler INTRODUCTION This entry is intended to give you on-line information about your your dBASE II Database Management System. It explains the disk files you have received, and gives suggestions on tapping the power now available to you for data management. Using the on- line HELP in conjunction with your Manual, you will soon be creating databases and writing command procedures to do your work. >>>>>>> type any key to continue <<<<<<< HOW TO USE THE 'HELP' FACILITY Information about your dBASE II system can be obtained by typing HELP and the name of a dBASE II command and any of the following key words: DBASE ERRORS FULL SCREEN FUNCTIONS GLOSSARY HELP INSTALL LIMITS NEW RUNTIME >Note: Only the first four letters of the command or key word is needed. dBASE will then look up the entry for the key word and display it. If there is no information on the subject, then dBASE will say "No help messages found". When there is more text to display than what is shown, you will see the word WAITING (like this). >>>>>>> type any key to continue <<<<<<< The essential dBASE II files on this disk are: DBASE.COM -- main system program file DBASEOVR.COM -- overlay file and system messages DBASEMSG.TXT -- this HELP file (only necessary if you use HELP) *EXIT *FULL SCREEN FULL-SCREEN CURSOR MOVEMENT CODES -- ALL COMMANDS ctrl-X moves cursor DOWN to the next field (also ctrl-F). ctrl-E moves cursor UP to the previous field (also ctrl-A). ctrl-D moves cursor AHEAD one character. ctrl-S or moves cursor BACK one character. ctrl-G or deletes character under cursor. ctrl-Y blanks out current field to right of cursor. ctrl-V toggles between overwrite and INSERT modes. ctrl-Q ignores changes to current record and returns to dot. ctrl-W saves all changes and returns to dot prompt. IN EDIT MODE ctrl-U toggles the record DELETE mark on and off. ctrl-C saves current record and ADVANCES to next record. ctrl-R saves current record and BACKS to previous record. ctrl-Q ignores changes to current record and returns to dot. ctrl-W saves all changes and returns to dot prompt. IN BROWSE MODE ctrl-B pans the window RIGHT one field. ctrl-Z pans the window LEFT one field. IN MODIFY MODE ctrl-T DELETES current line, moves all lower lines up. ctrl-N INSERTS new line at cursor position. ctrl-C scrolls down a half page. ctrl-R scrolls up one line. ctrl-Q ignores all changes and returns. ctrl-W writes all changes to disk and returns to "." prompt. IN APPEND MODE terminates APPEND when cursor is in first position of first field. ctrl-Q ignores current record and returns to "." prompt. ctrl-W saves current record and moves to next record and terminates APPEND when cursor is in first position of first field. CONTROL KEY STROKES OPERABLE WHEN NOT IN FULL SCREEN ctrl-P toggles your printer ON and OFF. ctrl-R repeats last executed command. ctrl-X clears the command line without executing command. ctrl-H backspaces one character. ctrl-M emulates a carriage return. ctrl-S starts/stops CPU operation. *EXIT *INSTALL In order to use dBASE II's full screen editing capability, your terminal must be properly installed. Many dBASE formats are pre- installed. If yours is not, your screen will appear jumbled when you attempt to perform such full screen operations as APPEND and EDIT. To correct this, you must install dBASE II by running the installation program, INSTALL.COM or INSTALL.EXE. Refer to your Manual for complete instructions on running the install program. Since you may diagnose your terminal's status at any time by running STARTUP.PRG (called from the dBASE II "." prompt by entering the command DO STARTUP), you would be wise to use it before attempting to INSTALL dBASE II. It will tell you if you need to run the installation program, and can be used later to check the results if you do. *EXIT *NEW > New commands and changes to dBASE II since version 2.3 HELP -- user aid command. REINDEX -- realigns and updates existing index file. SET F -- sets value of function key on IBM PC, Victor, TI Professional, and IBM PC compatible terminals. SET COLOR -- alters display color on all terminals listed above except the Victor. SET SPACE -- determines whether or not a numeric field will print in column zero using the ? command. Has no effect on REPORT FORM. TEXT -- displays multiple lines of text, terminated by ENDTEXT. RANK() -- function returns ASCII value of first character. TEST() -- function determines validity of . Supplemented Commands: APPEND, EDIT, INSERT -- can now use a format file for screen control. BROWSE -- can now be given a list of fields to work with. DISPLAY STATUS -- shows database and index files in use and SET settings. READ, REPLACE -- can be directed not to update the index file if the data being changed is not part of the key expression. RELEASE -- can now release subsets of memory variables. RESTORE -- can restore additively to existing memory variables. SAVE -- can now save subsets of memory variables. SET RAW ON -- eliminates extra spaces in DISPLAY and ? commands and allows semicolons to be displayed. UPDATE -- REPLACE clause can now include WITH phrases. *EXIT *GLOSSARY dBASE II TERMINOLOGY or -- any valid dBASE command or function. -- character string(s). In most instances must be delimited with single quotes (''), double quotes (""), or brackets ([]). -- an whose content is defined as Character in type. May be a cstring, a memvar or field of type C or any combination of these items concatenated with the dBASE operators. -- any non-alphanumeric character used to demarcate data, e.g., single quotes (''), double quotes (""), brackets ([]), colons (::), commas (,,), etc. or -- an item or group of items and operators whose value can be determined by dBASE. s may be defined as C, N, or L depending on the type of data they contain. -- a list of expressions separated by commas. -- a database field name. -- a list of field names separated by commas. -- name of file you wish to create or access. -- name of index file you wish to create or access. -- list of field(s) or portion(s) thereof used to create index files or sorted databases. -- the name of a memory variable. -- list of memory variables separated by commas. -- a number which dBASE regards as a literal value. -- an whose content is defined as Numeric. -- command option specifying range of records dBASE must treat in executing command. has three possible values: ALL records in file; NEXT records in file; and RECORD . Default value varies from command to command. -- allows batch manipulation of files of same type and/or with matching characters in filename using operating system "wild cards," ? and *. Also allows batch manipulation of groups of with matching characters in name. -- the name of a database field or . *EXIT *? *?? > ? -- Evaluates and displays the value of an expression. In command files (and elsewhere) can be used without expression to space down a line at output. Examples: . ? 6/3 2 . ? 'CITY' CITY . ? CITY (field of file in use) Managua > ?? -- Same as ?, but displays result on same line as entry. *EXIT *@ > @ -- Displays user formatted data on screen or printer at spec- ified x,y coordinates (x=line,y=column). Syntax: @ [SAY [USING '']] [GET [PICTURE '']] Examples: . @ 3,23 SAY AMOUNT * 1.06 USING '$$$,$$$.99' . @ 14,23 SAY "ENTER PHONE" GET PHONE PICTURE '(###)###-####' . @ LINE+2,45 SAY TOTAL USING '99999.99' *EXIT *ACCEPT > ACCEPT -- Prompts user to enter character string information into a designated memory variable. Syntax: ACCEPT [''] TO Examples: . ACCEPT "What is your name?" to NAME What is your name?: [user's response stored to NAME] . ? NAME [user's response displayed] *EXIT *APPEND > APPEND FROM -- Appends data from another file to the bottom of the file in use. The FROM file may be a database file, a file in System Data Format, or a comma delimited file. Records marked for deletion in the FROM file will not be appended. Syntax: APPEND FROM [FOR ] [SDF/DELIMITED] Examples: . APPEND FROM MAILLIST FOR NAME='N' . APPEND FROM TEST.TXT DELIMITED > APPEND BLANK -- Appends a blank record to the bottom of the file in use. > APPEND -- Allows user to add new records to database in use using full screen. *EXIT *BROWSE > BROWSE -- Brings up full screen viewing and editing of the database in use. Syntax: BROWSE [FIELDS ] *EXIT *CANCEL > CANCEL -- In a command file, stops command file execution and returns user to dBASE "." prompt. Example: ACCEPT "Enter 'Q' to stop this humble machine. " TO NEXT IF NEXT = 'Q' CANCEL ENDIF *EXIT *CLEAR > CLEAR -- Closes all databases in use, releases all memory variables, and SELECTs PRIMARY work area. > CLEAR GETS -- Commands dBASE to forget all active GET state- ments without erasing the screen. *EXIT *COPY > COPY -- Copies the contents of the database in use to another file. COPY will create the TO file if it does not exist and will destroy an already existing file of that name. Records that are marked for deletion will not be copied. Syntax: COPY TO [] [FIELD ] [FOR/WHILE ] [SDF/DELIMITED [WITH ]] > COPY STRUCTURE -- A special form of COPY that uses the database structure to create the TO file. If the EXTENDED syntax is used, a database whose records represent the structure of file in use is created. Otherwise, a database file with a duplicate structure is created. Syntax: COPY TO STRUCTURE [EXTENDED] [FIELDS ] *EXIT *COUNT > COUNT -- Counts the number of records in the database in use that meet a specified condition. Default value is COUNT all records. Syntax: COUNT [scope] [FOR/WHILE ] [TO ] Example: . COUNT NEXT 25 FOR GRADE > 'B-' TO DEANLST *EXIT *CREATE > CREATE -- Creates a new database. Normally, the user will be prompted for the file structure, but the FROM syntax may be used to create a database from a structure extended file. Syntax: CREATE [FROM ] *EXIT *DELETE > DELETE -- Marks database record(s) for deletion. Records that are marked for deletion are indicated with an asterisk and will not be erased until the PACK command is given. The default scope is the current record. SET DELETED ON will ignore records that are marked for deletion when used with certain commands. Syntax: DELETE [] [FOR/WHILE ] Examples: . DELETE ALL FOR COMPANY = 'ZMB' . DELETE RECORD 15 > DELETE FILE -- Erases files from the disk directory. The file must be closed in order to delete it. Syntax: DELETE FILE *EXIT *DISPLAY > DISPLAY -- Displays a specific set of information to the screen or the printer. The information may be the the fields of the database file in use intermixed with other expressions, the disk directory, the active memory variables, the struc- ture of the database in use, or the status of the files in use and the set parameters, depending on which syntax is used. When displaying fields in a database, the default scope is the current record. If another scope is specified, the command will pause after each 15 records. Syntax: DISPLAY [] [FOR/WHILE ] [] [OFF] [FIELDS ] DISPLAY FILES [ON ] [LIKE ] DISPLAY MEMORY DISPLAY STRUCTURE DISPLAY STATUS *EXIT *DO *DO WHILE *ENDDO *LOOP > DO -- opens and executes specified command file. > DO WHILE -- Begins a command file construct that allows conditionaì looping® Commandó in between this commanä and the ENDDO command are executeä aó lonç aó thå expressioî ió true. The LOOP clause is optional, and causes command file control to go back to the DO WHILE command. Must be closed by ENDDO. Syntax: DO WHILE [LOOP] [] ENDDO Example: USE MAILLIST DO WHILE .NOT. EOF IF ZIP = '90005' SKIP LOOP ENDIF ? NAME ? PHONE SKIP ENDDO *EXIT *CASE *OTHERWISE *ENDCASE > DO CASE -- A command file construct used to choose one and only one of several possible execution paths. The OTHERWISE clause is optional, and executes when no other CASE is true. ENDCASE is needed to close command. Syntax: DO CASE CASE [] [[CASE ] []...] [OTHERWISE] [] ENDCASE Example: USE MAILLIST ACCEPT "WHICH MENU OPTION DO YOU PREFER?" to Choice DO CASE CASE Choice = '1' DO Clabels CASE Choice = '2' DO Cappend CASE Choice = '3' DO Cedit OTHERWISE RETURN ENDCASE *EXIT *EDIT > EDIT -- Allows full screen, selective editing of database in use by record number. The prompt "ENTER RECORD #" will be displayed if no record number is supplied. When editing of á particulaò recorä ió completed¬ ctrl-× bringó bacë the record number prompt. To terminate EDIT mode, answer the prompt with a carriage return. Syntax: EDIT [] *EXIT *EJECT > EJECT -- Causes printer to do a form feed (page eject) if PRINT is SET ON or FORMAT is SET TO PRINT. When using @...SAY commands for direct page formatting, EJECT will zero out the row and column counters. *EXIT *ERASE > ERASE -- Clears any pending GETs and erase the screen. In interactive mode, the "." prompt will appear at top left corner of screen. *EXIT *FIND > FIND -- When using indexed files, positions to first record indexed by . The need not be in quotes. *EXIT *GO *GOTO > GO or GOTO -- Positions the record pointer to a specific record in the database file. GO and GOTO are be used inter- changeably. Syntax: GOTO [RECORD] GOTO BOTTOM GOTO TOP *EXIT *HELP dBASE II ON-LINE HELP FACILITY Below you will find a list of all dBASE commands. Each entry in this list corresponds to an entry in the HELP file. In the latter, you will find a brief synopsis of each command along with its correct syntax. Please remember, however, that HELP file information is limited, and is only meant to cut down on the number of trips you will have to make to the dBASE II Manual. To access the entry for the dBASE command (or other Help File entry) you wish to review, simply respond to the dBASE "." prompt by entering HELP and a return (e.g. HELP CREATE ). dBASE will access the information you wish to see, and then return you to the "." prompt so you can go right back to work. In some cases the entry will take up more space than is provided by a single screen. (This is one of them.) To bring up the next screen of information, just hit any console character: this will tell dBASE to stop "Waiting." If you wish to exit the HELP file before viewing an entire entry, simply hit ESCape. >>>> Type 'HELP dBASE' for other <<<<<< >>>>> important information <<<<< > ? -- displays an expression, variable, or field. > ?? -- displays an expression, variable, or field without a proceeding blank line. > @ -- displays formatted data on screen or printer. > ACCEPT -- allows input of character strings into memory variables. > APPEND -- adds information to the bottom of the database in use. > BROWSE -- full screen window viewing and editing of database. > CANCEL -- cancels command file execution. > CLEAR -- closes databases in use and releases current memory variables. > CONTINUE -- continue the searching action of a LOCATE command. > COPY -- creates a copy of an open database. > COUNT -- counts the number of records in file which meet selected criteria. > CREATE -- creates new database. > DELETE -- deletes a file or marks records for deletion. > DISPLAY -- display files, database records or structure, memory variables, or status. > DO -- executes command files or begins a programming construct. > EDIT -- initiates edit of records in a database. > EJECT -- ejects a page on the printer. > ELSE -- alternate path of command execution within IF. > ENDCASE -- terminates a DO CASE structure. > ENDDO -- terminates DO WHILE structure. > ENDIF -- terminates an IF structure. > ENDTEXT -- terminates a TEXT structure. > ERASE -- clears all pending GETs and erases the screen. > FIND -- positions to record corresponding to key in index file. > GO or GOTO -- positions to specific record in file. > HELP -- access help file overview or specific help file entry. > IF -- allows conditional execution of commands. > INDEX -- creates an index file. > INPUT -- allows input of expressions into memory variables. > INSERT -- insert new record in database. > JOIN -- joins output of two databases. > LIST -- lists files, database records or structure, memory variables, and status. > LOCATE -- find a record that meets a specific condition. > LOOP -- skips to beginning of DO WHILE structure. > MODIFY -- create and/or edit command file or modify structure of existing database. > NOTE or * -- allows insertion of comments in command file. > PACK -- removes records marked for deletion. > QUIT -- exits dBASE and returns to operating system. > READ -- initiates full screen editing of formatted screen by accepting input into variables accessed with @...GET. > RECALL -- removes delete marker from deleted record. > REINDEX -- update open index files. > RELEASE -- eliminates unwanted memory variables and releases memory space. > REMARK -- permits display of any characters on the screen or the printer. > RENAME -- rename a file. > REPLACE -- change information in record(s) or entire database field by field. > REPORT -- format and display a report of information. > RESET -- reset operating system (CP/M only) after placing new disk in drive. > RESTORE -- retrieves memory variables stored in MEM file. > RETURN -- ends a command file. > SAVE -- copies current memory variables to a MEM file. > SELECT -- switches between USE files in PRIMARY and SECONDARY areas. > SET -- sets dBASE control parameters. > SKIP -- position forwards or backwards in database. > SORT -- create a new database sorted on one of the data fields. > STORE -- creates memory variables. > SUM -- compute and display the sum of database field(s). > TEXT -- allows output of block of text from a command file. > TOTAL -- creates summary copy of database combining information from specified fields or records meeting selected criteria. > UPDATE -- allows batch updates of a database. > USE -- specifies database to USE until next USE command is issued. > WAIT -- suspends command file processing until a key is pressed. >>>>> Other key words <<<<< (e.g. HELP RUNTIME) DBASE ERRORS FULL SCREEN FUNCTIONS GLOSSARY INSTALL LIMITS NEW RUNTIME *EXIT *IF *ELSE *ENDIF > IF -- A command file construct that permits permits conditional execution of commands between the IF and the ENDIF. ELSE clause is optional. Must end with ENDIF. Syntax: IF [ELSE ] ENDIF Example: IF STATE = "CA" DO INSTATE ELSE DO OUTSTATE ENDIF *EXIT *INDEX > INDEX -- Creates an index file for the database in use based on the value of the key expression. Syntax: INDEX ON TO *EXIT *INPUT > INPUT -- Prompts user to enter an expression and stores the response in a memory variable. Syntax: INPUT [""] TO Example: . INPUT 'Prompt user for input' TO X Prompt user for input: 12 [user input, 12, stored to X] . ? X 12 *EXIT *INSERT > INSERT -- Allows user to insert record into the database file in use immediately after or before the current record. A full screen will be displayed for entering data unless the BLANK is used. If the database file in use has one or more index files open, INSERT is equivalent to APPEND. Syntax: INSERT [BEFORE] [BLANK] *EXIT *JOIN > JOIN -- Creates a new database by combining the records of files in use in the PRIMARY and SECONDARY work areas. Records are added to the new file when the FOR expression is true. JOIN must be executed from the PRIMARY area. Syntax: JOIN TO FOR [FIELDS ] Example: . SELECT SECONDARY . USE MAILLIST . SELECT PRIMARY . USE NAMES . JOIN TO NAMEJ FOR LAST <> S.LAST *EXIT *LIST > LIST -- Lists a specific set of information to the screen or the printer. The information may be the the fields of the database file in use intermixed with other expressions, the disk directory, the active memory variables, the structure of the database in use, or the status of the files in use and the set parameters, depending on which syntax is used. This command is identical to DISPLAY except when listing fields in a database, the default scope is ALL records, and there is no periodic pause. Syntax: LIST [] [FOR/WHILE ] [] [OFF] [FIELDS ] LIST FILES [ON ] [LIKE ] LIST MEMORY LIST STRUCTURE LIST STATUS Examples: . LIST FILES ON C LIKE *.FRM . LIST NEXT 25 NAME, PHONE FOR CONTRIB > 100 *EXIT *LOCATE *CONTINUE > LOCATE -- Finds the first record in the database file for which the FOR expression is true. Use CONTINUE to find subsequent records that meet the specified condition. The user may manipulate records before resuming search with CONTINUE. Syntax: LOCATE [] FOR Example: . LOCATE ALL FOR ZIP >= '95000' .AND. ZIP < '96000' RECORD: 00123 . DISPLAY . CONTINUE RECORD: 00232 *EXIT *MODIFY > MODIFY STRUCTURE -- Allows user to alter the structure of the database in use. This command will warn the user before erasing all the data in the file. To alter structure without loss of data, use COPY STRUCTURE, USE, and APPEND as illustrated in the example below. Example: . USE NAMES . COPY STRUCTURE TO TEMP . USE TEMP . NOTE No data will be lost since file is empty. . NOTE Do not change any field names. . MODIFY STRUCTURE . NOTE The next command brings data into the modified database. . APPEND FROM NAMES . RENAME NAMES TO NAMES.BAK . NOTE USE will close TEMP so that the file can be RENAMEd. . USE . RENAME TEMP TO NAMES > MODIFY COMMAND -- Calls the dBASE text editor and brings up or creates designated file. Primarily used for creating and editing command (.PRG), text (.TXT), and format (.FMT) files, but may be employed as a simple full screen word processor. *EXIT *NOTE > NOTE or * -- Permits the inclusion of comments in a command or format file. Comments following NOTE or * will not be read when file is executed. *EXIT *PACK > PACK -- Erases records marked for deletion from the database in use. If index files are in use, they will be automatically updated. *EXIT *QUIT > QUIT -- Closes all files, terminates dBASE, and returns control to the operating system. Optionally calls programs from system level. Syntax: QUIT [TO ] *EXIT *READ > READ -- Initiates full screen mode for entry or editing of fields or variables. The full screen prompts and window are created by @...SAY...GET commands. Syntax: READ [NOUPDATE] Example: STORE ' ' TO Name STORE ' ' TO Phone @ 4,4 SAY 'Name ' GET Name @ 6,4 SAY 'Phone ' GET Phone PICTURE '(###)###-####' READ *EXIT *RECALL > RECALL -- Reinstates record(s) that are marked for deletion in the database file in use. Default scope is current record. Syntax: RECALL [] [FOR/WHILE ] *EXIT *REINDEX > REINDEX -- Allows updating of up to seven open index files without supplying the corresponding key expressions. Example: . USE MAILLIST INDEX INDEXA, INDEXB, INDEXC . REINDEX *EXIT *RELEASE > RELEASE -- Erases unwanted memory variables and opens memory space for further use. Syntax: RELEASE RELEASE ALL [LIKE ] RELEASE ALL [EXCEPT ] Examples: . STORE O TO N, N1, N2, N10, V7 . RELEASE ALL LIKE N? [N10 and V7 will remain] . RELEASE ALL EXCEPT V* [N10 will remain] . RELEASE ALL [Nothing will remain] *EXIT *REMARK > REMARK -- Permits the display of any characters to the screen or printer. Example: . SET PRINT ON . REMARK This remark will be printed. . SET PRINT OFF . REMARK This remark will be displayed on the screen. *EXIT *RENAME > RENAME -- Changes the name of a file on the disk directory. dBASE uses a default file extension of DBF. Files that are currently open cannot be RENAMEd. Syntax: RENAME TO Example: . RENAME REVIEW.FRM TO REVIEW2.FRM *EXIT *REPLACE > REPLACE -- Allows the user to replace the contents of specified fields in the database in use. If index file is in use and the key field is being REPLACEd, the index will be updated automatically if the NOUPDATE clause is not used. For this reason, it is not advisable to do block replacements on the key field. The default scope is the current record. Syntax: REPLACE [] WITH [, WITH ] [FOR/WHILE ] [NOUPDATE] Example: . USE MXPROJ . REPLACE ALL COST WITH COST * 6.1 FOR ITEM = 'ELEC' *EXIT *REPORT > REPORT -- Used for creating and displaying a REPORT FORM file (.FRM). This file displays specified information from a database in a pre-defined format. Outputs results to screen or printer. Syntax: REPORT [FORM
] [] [TO PRINT] [PLAIN] [FOR/WHILE ] *EXIT *RESET > RESET [] -- With CP/M, resets the bit map for the drive specified. Use this command after changing disks on any drive other than the one containing dBASE. Never change a disk without first closing all files. Before opening the files on the new disk, issue the RESET command. *EXIT *RESTORE > RESTORE -- Retrieves and activates the set of memory variables previously SAVEd to a memory file. Unless ADDITIVE is used, currently defined variables are lost. Syntax: RESTORE FROM [ADDITIVE] *EXIT *RETURN > RETURN -- Used in a command file to return control to the command file which called it or to dBASE "." prompt. *EXIT *SAVE > SAVE -- Copies specified memory variables to the designated memory (.MEM) file. Syntax: SAVE TO [ALL LIKE/EXCEPT ] Examples: . STORE 0 TO N1, N2, N10, V1, V2, V10 . SAVE TO NUMBER ALL LIKE N* [saves N1, N2, N10] . SAVE TO NUMBER ALL LIKE N? [saves N1, N2] . SAVE TO NUMBER ALL EXCEPT ?1* [saves N2, V2] . SAVE TO NUMBER [saves all] *EXIT *SELECT *PRIMARY *SECONDARY > SELECT -- Activates the specified work area without closing or opening any files, permitting the user to work with two database files simultaneously and maintain record pointers in both. Primary area is active upon bringing up dBASE and after issuing a CLEAR. Syntax: SELECT PRIMARY/secondary *EXIT *SET > SET -- Sets dBASE control parameters. All SET commands are listed below in alphabetic order. NOTE that some SETs are of the ON/OFF type, and others require some user option to be given. The default value of the ON/OFF SET commands is in uppercase. Syntax: SET [ON/OFF] SET TO