%ė VAX-11 Librarian V03-00`b‚pø‹Ā›˙ž.‹Œ?-¨4Š6:U5[;BIGFILE7DELDIR DOCHFOLDERi HELP_FILESSEND>VOLSER ­ Áq‚pø‹1 SEND SEND username --G Prompts you for subject, invokes EDT to allow you to enter the messageMtext. When you exit from EDT the message is mailed to the user. You are askedKif you wish to send more mail; note that this will go to the SAME USER. YouLare not prompted for another user name, as username is given on the originalcommand line. G If you give an incorrect username, SEND will report that the mail was Lnot delivered, will preserve the message text (but not t he subject line) in 2MAIL.TMP in your current directory, and will exit.C You can specify multiple usernames separated by commas as long as there are no intervening blanks.3 To use SEND to a distribution list, use this form: SEND '"@LIST"'SEND --H When used with no username given, SEND will send the mail to yourself. LThis is useful for stashing away reminders, etc. If you do this by accident 5you can get into normal MAIL and FORWARD the message.ww ­ ęļwŒ1 DOC D The VAX Document System is intended to make writingD inter-office memos, letters, and system documentation easy. ItD is a menu-driven interface to several programs: EDT, SPELL,D and two versions of Runoff, DSR and ROF (John Clement's RSXD version). It provides easy access to several printers: theD Diablo 630, the console LA120, the Advertising DepartmentA LA120, and the line printer (for fast, upper case p H A foreign command is defined in the system login procedure, so thatH all any user has to do to enter the document system is to typeH "DOC". Your current directory will be used in creating or locatingH files. If you have more than one directory you should select the- correct directory before entering DOC. H Optionally he may follow the DOC command with a one to nine char-! acter document name, e.g.:  DOC project H From this poi roofs). 2 USE D A foreign command is defined in the system login procedure, soD that all any user has to do to enter the document system is toD type "DOC". Your current directory will be used in creating orD locating files. If you have more than one directory you should8 select the correct directory before entering DOC. D Optionally he may follow the DOC command with a one to nine% character document name, e.g.:  DOC project D  From this point on, the system will display menus that should be self-explanatory. s 2 FILE_NAMES DIf no document name is given, DOC will default to a file specifica-Dtion of "MEMO.RNO". You will be informed of this default and asked@if you wish to change the file specification or document name. DYou may give a full file specification if you want to use DOC to5edit and process a file with a different name, e.g. o DOC SPECIAL.TXT lDNormally, DOC will be used to create and edit Runoff source files,Dand to process them through Runoff to produce a printable outputLfile. All you need to specify is the document name, from one toEnine characters. DOC will take care of assigning proper file types. i 3 FILE_TYPES OD When you are using the DSR version of Runoff, the file specifi- cations used will be: 1 For source files: document.RNOt1 For output files: document.MEMlD The file C Different file types are used for the different versionsC of Runoff to help you remember which version of RunoffC should be used to process a given file. There is nothingC to prevent you producing a file once with DSR as your de-C fault and later selecting ROF to actually output theC file; be aware, however, that not all commands from oneC version are recognized by the other, and the format ofC the types shown will be used whether you are producing a; memo, a letter, a system document, or anything else. y 3 ROF_TYPES D When you are using the ROF version of Runoff, the file specifi- cations used will be: 1 For source files: document.ROFf1 For output files: document.DOC D The file types shown will be used whether you are producing a; memo, a letter, a system document, or anything else. (  COMMENT? Different file types are used for the different ver- ? sions of Runoff to help you remember which version ofl? Runoff should be used to process a given file. Theref? is nothing to prevent you producing a file once with ? DSR as your default and later selecting ROF to actu- ? ally output the file; be aware, however, that notd? all commands from one version are recognized by theh? other, and th e format of the output may differ ? slightly. The ".LIST" command, for instance, indentsh? differently in the two versions; ROF supports Diabloe1 escape sequences, while DSR does not. ? On the assumption that you may forget which versions? of Runoff you used when you first created a document,s? most commands check for existance of a document witho? a particular file type and warn you if it does notn? exis t, reminding you which version of Runoff is yourr? current default. If you enter DOC and attempt toi? call up a document for editing and are told it doesa? not exist, try changing versions of Runoff and at- ? tempting to edit again; possibly the file wast+ created using the other Runoff. 2 MENU_COMMANDS D The main menu of DOC lists thirteen functions that you mayC select. They are briefly described in sect ions that follow. u 3 CREATE sD To create a new document, select the CREATE option. If theD name you have chosen already exists in your directory you will8 be notified and asked to choose a different name. T You should select the version of Runoff you want to use beforeL you begin to create a document. (See Section 4.10) The reason:D when you first create a document, DOC inserts many Runoff com-D mands into the file you are c reating. The commands insertedD depend on the version of Runoff currently selected. The de-D fault version of Runoff is DSR, so if you expect to use DiabloD escape sequences, the first thing you should do after entering3 DOC is to select ROF as your default Runoff. pD If you create a document under DSR called "DOC1.RNO", you willD be allowed to create another document under ROF calledD "DOC1.ROF". These are considered to be different docume nts.D Under some circumstances you may want two versions of the sameD document, one that can be processed by DSR and the other byD ROF. This would be true if, for internal use, you wanted theD more elegant output of ROF, but wished to be able to send theA Runoff source file to other VAX users who do not have ROF. uD It is advisable, however, to use unique document names. TheD FOLDER sub-system will not handle duplicate names, even if theD file type is different. An alternative way of handling this isD to store .RNO files in one folder, and .ROF files in another folder. 4 TYPES_OF_DOCUMENTS yD You can create four types of documents with DOC: memos,. letters, system documents, and "other". 3 Input of responses to prompts? When responding to a prompt for author or subject foreG any document type, if you want to preserve lower case G inpu t you must enclose the input in double quotes.n? If double quotes are not used the command procedureo? will automatically transpose your input into upper ? case. If you forget this, you can still go back and , edit the lines in your document. 5 MEMOS L Memos are pre-formatted in the now familiar way with a largeD "MEMO" heading and appropriate fields for author, addressee,D subject, and persons to be copied (at the end of the memo).= You will be prompted for input to the required fields. 5 LETTERS L Letters are pre-formatted with the return address and date al-D igned against the right margin, followed by the destinationD name and address left-justified, a salutation line, and a clos-D ing. Normally you will be prompted separately for each line ofD each address. The letter produced will not go on RecordD letterhead; the letter option is intended for quick notes and (gasp!) personal use. D If you wish you may pre-define the return address informationD by creating a file in your login directory called ADDRESS.DEF.: Here is a sample ADDRESS.DEF file for Allen Watson: ( $ AUTHOR :== "Allen A. Watson"4 $ ATITLE :== "Manager, Systems Technology"! $ RET1 :== "THE RECORD"t' $ RET2 :== "150 River Street"a+ $ RET3 :== "Hackensack, NJ 07602"  D If an ADDRESS.DEF file exists in your directory you will beD asked if you want to use the default information. If you replyD "YES", the fields will be filled in automatically as you pro-$ gress through the input form. 5 SYSTEM_DOCUMENTS FL System Documents are documents intended to describe some aspectD of our VAX/VMS system or RSX11M-Plus system. This document is' an example of a system document. 5 DATE_SUBSTITUTION D F or all three of the above document types, date substitution isD used. That is, when you process the document through RunoffD the date information for today is automatically inserted. SeeD the DSR manual or Pocket Reference for information on how to use $$DATE, $$TIME, etc. pD Both versions of Runoff support change bars (marginal lines in-D dicating portions of a document which have altered since theD last issue of the document). Authors of system doc uments espe-D cially are encouraged to use change bars to aid readers in lo-" cating updated information. 3 EDIT sD Once you have begun to create a document and have exited theD editor, further changes to the document must be made using theD EDIT option. EDIT opens your document for editing. It auto-D matically places a comment line at the top of the file indicat-D ing the date the file was last edited, and by whom. You are: free to delete th ese lines if you do not want them. D EDT is always called in "Change Mode", that is, full screenD edit mode. You may use any valid EDT commands. When done, youD may EXIT or QUIT (if you wish to discard your changes). Nor-D mally you will EXIT, and EDT will create a new version of yourD document file. When in DOC, EDT is always started using theD system EDT initialization file found in SYS$COM. If you needD information on what keys are defined by t his file, see the Sys- tem Manager. sD If the system fails during an EDIT, you cannot perform and EDTD "/RECOVER" command from within DOC. The suggested procedure in& the event of a system crash is: D 1. When the system comes back up, log on and change to: the directory that contains your document. D 2. Type in the normal command to invoke EDT in RecoveryD mode, giving the full name of the document file9 including file type, for example: - EDT/RECOVER DOCUMENT1.ROF oD 3. EDT will now call up the last complete version of yourD document and will re-create every keystroke of the ed-D iting session that was interrupted by the system crash. D 4. When EDT has finished recovering your edits, use@ CTRL/Z and EXIT to save the edits to this point. D 5. Now, re-en!ter the DOC system by typing, for example: ! DOC DOCUMENT1 e3 VIEW D The VIEW option allows you to see at your terminal the format-; ted results of passing your document through Runoff. d( 1.1.1 Underlining when VIEWing - D Underscoring, if present in your document, creates uniqueD problems when you are using DSR. You will be asked whether or? not you want the underscoring to appear at the terminal. WD If you answe"r "yes", underscoring will be done with hyphens onD a second line so that the text and underscores will both be vi-D sible on your terminal (video screens can't overprint). ThisL means that extra lines are used for the underscoring. When youD do final output to a printer, however, underlining is done withD overprinting, using only one line. Therefore, your final out-D put will have fewer lines than the "VIEW" version, with moreD lines of text per pag#e. Page breaks will come in a different place. tD If you answer "no" to the underscoring question, underscoresD will be omitted from the version you see on the screen, and theC page breaks will be the same as your final printed document. oD If page break points are important to you, I suggest you viewD your document twice: once to check for proper underscoring,) and once to check the page breaks. 4 ROF_FILES D When you VIEW a file $with the ROF version of Runoff, DOC isD able to substitute VT100 control characters in place of theD Diablo control characters, so that both underlining and boldingD or shadow printing will appear on the screen in the same way asD they will in final output. That is, for underlining the VT100D underline mode is used; for shadow printing the VT100 boldD mode is used. The modes may even be mixed (an underlined word( in a bold sentence, for example). D % The selection of the appropriate variant, for Diablo or for+ VT100, is done automatically by DOC. t5 ROF files created prior to 3/2/84e? If you created files for ROF prior to 3/2/84, they 1 will contain the following two lines: / .VARIANT DIABLO .;.VARIANT VIEW e? These two lines should be deleted from the file priora4 to further editing and output using DOC. 3 CHECK_SPELLING rD This & option uses a DECUS program called SPELL to check theD spelling of every word in your document. Runoff command lines are ignored. D SPELL has two modes: interactive and automatic. It is advis-L able not to use interactive spelling checking, because it re-L quires a response every time it detects a suspect word. ManyD of the technical terms and proper names used in our memos andD documentation will appear to be a misspelled word ' to SPELL, forD example, "SYSGEN" and "Schrumpf". So it is best to select theD non-interactive mode. This will list all suspect words withD the line number of the line containing it. If you see a trulyD misspelled word on the list you may then use the EDIT option to! find and correct the word. D For more information on using SPELL (outside of the DOC sys- tem), see "HELP SPELL". 3 RUNOFF aD The RUNOFF option reads the file you have creat (ed, which con-D tains DSR or ROF commands, and produces an output file format-D ted according to those commands. You must choose RUNOFF before( you can print the final document. D The RUNOFF option will use whichever version of Runoff is cur-D rently your default, either DSR or ROF. If you give only a do-D cument name, it will default to the appropriate file types asD described above. You can override this by using the CHOOSE op-D tion to specify both ) the document name and file type. In thisD way you can create a document with DSR as your default, andD ".RNO" as the file type, and then change to ROF as your defaultD and use CHOOSE to make the file name "docname.RNO". (I don'tD know why you would want to do this, but I want to point out it is possible.) D DSR will produce a file called "docname.MEM", and ROF will pro-( duce a file called "docname.DOC". 3 PRINT D The PRINT option *allows you to direct that a file produced byD the RUNOFF option be printed. It checks to see that an appro-D priate file exists. If you are using DSR, there must be aD "docname.MEM" file present in your directory; if you are using/ ROF, there must be a "docname.DOC" file. 6 ROF files can go only to the DiabloG Documents created using ROF must be sent to the ? Diablo printer. They cannot reproduce correctly onT +? any other printer because spacing between words is? done with special control characters to achieve vari-r able spacing. iD You are offered a choice of four printers: the Diablo (inD ISD), the console LA120 (not normally set up as a print queueD any more), the Advertising Department LA120 (intended for useD by Advertising Department), and the line printer (all upper-/ case) which can be used for fast proofs. iD Y ,ou can specify how many copies of the file you want printed. 3 CHOOSE sD The CHOOSE option allows you to completely specify the fileD name you are manipulating. Its primary purpose is to change2 document names within a single DOC session. L If you specify the file type, your specification will overrideD the defaults used by DOC for Runoff source files. That is, youD can create and edit files such as "docname.TXT" or "doc-D name.LET" -. You can also VIEW and RUNOFF such files. However,D the RUNOFF option will always produce either .MEM or .DOCD files, and the PRINT, PURGE and DELETE options will always ex-1 pect one or the other of these file types. p3 PURGE D The PURGE option allows you to clean up your directory afterD multiple edits and RUNOFFs have been performed on a document;D it will use the document name you have specified and will de-L lete all but the most rec .ent version of both the source andD output files for Runoff. If you have DSR as your default Ru-D noff, PURGE will operate on .RNO and .MEM files; if you haveD ROF, it will operate on .ROF and .DOC files. The system PurgeD command will report the results of the purge; for example, ifD you PURGE all "DOC1" files, it will report a warning message if! no "DOC1.MEM" file exists. l 3 DELETE UD The DELETE option allows you to delete documents you n /o longerD need. Like PURGE, it will operate on different file types de-D pending on the Runoff you have currently selected. When youL delete a document, it is gone forever; there is no way (short& of backup tapes) to recover it. 3 CHANGE_RUNOFF_VERSION D The CHANGE option changes between versions of Runoff. If youD are currently using DSR it will change to ROF, or vice versa.D CHANGE also changes the default file type to correspond to the 0$ Runoff version you are using. D When you select ROF, the following escape flags and sequencesD are automatically defined for you when you create a document: 7 [ Half space paper down (for superscript)h3 ] Half space paper up (for subscript)v+ * Shadow print next charactera' ^* Lock in shadow printingN$ \* Stop shadow printing D If you want to use any of the characters "*", "[", o1r "]" asD regular text characters you can either "flag accept" them, likeD this: "_*", or you can "undefine" them as flag characters by9 including a command such as this in your document: l .NO FLAGS SPECIAL *  or " .NO FLAGS SPECIAL * [ ] D The first command would allow normal use of the asterisk only;D the second command would allow normal use of all three char- acters. D To re-establish use of "*" for shadow printing you2 would enter the line,  .FLAGS SPECIAL * 3 INDEX D The INDEX option produces an index of all .RNO and .ROF filesD in your directory. When you create a document using DOC, aD subject line is always asked for and inserted into your docu-B ment. This subject line is reproduced by the INDEX option.  Here is a sample index: ) Index for all RNO and ROF files  DOCUMENT SUBJECTl ------------- - 3------6 ALTSTART.RNO Alternate VAX startup methodsC RNOCOMPAR.RNO ^*Comparison of Three Versions of RUNOFF\* 6 RSXSYSGEN.RNO RSX11M-PLUS POST SYSGEN NOTES8 SHACOMPAR.RNO Comparison of shadow pair disks' WHEREIS.RNO Lost documentaB FOLDER.ROF File Folder Command Procedure: FOLDER.COM; FOLDERDOC.ROF CONTROL FILE TO PRODUCE FOLDER.DOC ; FOLDERHLP.ROF CONTROL FILE TO PRODUCE FOLDER.HLP.> VAXDOC.ROF 4 ^*Bergen Record VAX Document System\*; The following documents had no subject indicated.e' CHARTHED.RNO;1 - 7 recordsO( HELPDODOC.ROF;1 - 2 records( HELPDOHLP.ROF;1 - 2 recordsD Note that some documents are listed with "no subject indi-D cated". This means either that the document was not createdD using DOC, or else the subject line is no longer within theD file. Documents with multiple versions will be listed once f5or each version. 3 TOGGLE_EDITOR D The TOGGLE option allows you to switch back and forth betweenD two different text editor programs, EDT and EMACS. EDT is theD standard DEC text editor, and EMACS is a special multi-buffer,D multi-window editor. For more information on these editors seeD HELP EDIT and HELP EMACS, or read the related document on the editor. E Files created with EDT can be edited with EMACS, or vice versa. i 3 FOLDER tD b The FOLDER option allows you to enter the "File Folder Mainte-D nance" menu. This is a sub-system of DOC that can be used toD archive documents in a "file folder" with other related docu-D ments. For more information, see the separate document on@ "FOLDER: File Folder Maintenance" or type "HELP FOLDER". 2 KNOWN_BUGS tD Sometimes DOC appears to lock up after a SPELL operation. ThisD occurs most often if you do SPELL followed by EDIT. If thisB:ēĢĀĶ+ËkŒ WATSON DOCēĢ@ÖŠËkŒ WATSON DOCēĢ`]FĖkŒ WATSON DOCēĢ# cŊDŗlŒ WATSON HELP_FILESēĢ€‹‰‰nŒ WATSON FOLDERēĢ@û{ôŠnŒ WATSON FOLDERēĢ@™Pm‹nŒ WATSON FOLDERēĢ#€ônŒ WATSON HELP_FILESēĢ#@“ÉAnŒ WATSON HELP_FILESēĢ#§ŅnŒ WATSON HELP_FILESēĢ đĢˆuŒ WATSON DELDIRēĢžÜė´wŒ WATSON DOCēĢ`fˆĩwŒ WATSON DOCēĢ@xOčĩwŒ WATSON DOCēĢ ŅKļwŒ WA9­`yˆuŒ1 DELDIR>Deletes an entire directory tree and all its files, including subdirectory files.aTo invoke: CMD DELDIRm or @SYS$COM:DELDIR1DELDIR asks for the directory to be deleted, e.g.  WATSON.ARTICLES.TEST1&And the disk on which it resides, e.g. USER$DISKGIt then proceeds to delete all files in the directory named and all itstDsubdirectories, and then cycles through deleting the directory filesuntil they are all gone.FSystem level users can delete 9H A foreign command is defined in the system login procedure, so thatH all any user has to do to enter the document system is to typeH "DOC". Your current directory will be used in creating or locatingH files. If you have more than one directory you should select the- correct directory before entering DOC. H Optionally he may follow the DOC command with a one to nine char-! acter document name, e.g.:  DOC project H From this poiany directory tree; non-privileged users<can use DELDIR only to delete directories they have created.wwIF, .ENDIF, and .IFNOT commandsD within a file you can cause it to have differently formattedD outputs depending on the setting of the .VARIANT command. TheL textual material of the file is not enclosed in IF blocks, butL the formatting material is. A document is sectionalized byD Header Level commands, while a Help File is sectionalized by7TSON DOCēĢ ¯y†Œ WATSON BIGFILEēĢĀĐ Ÿ.‹Œ WATSON VOLSER=­`‰y†Œ 1 BIGFILEAJ The BIGFILE command procedure will list directories in order from largestE file to smallest. It is located in the SYS$COM directory. To use it:C # @SYS$COM:BIGFILE {directory-spec}n e orr  CMD BIGFILE {directory-spec} eO If the directory specification is given, BIGFILE will report on that directory - or set of directories (i.e. [...] is legal).  I If no directory specification is given, BIGFILE runs against the current directory.c G BIG=C Different file types are used for the different versionsC of Runoff to help you remember which version of RunoffC should be used to process a given file. There is nothingC to prevent you producing a file once with DSR as your de-C fault and later selecting ROF to actually output theC file; be aware, however, that not all commands from oneC version are recognized by the other, and the format ofC the FILE uses DIRECTORY/SIZE, MUNG (TECO running a text-editing macro), H SORT, and the LIST utility to produce its output. When the directory isG listed, you are in the LIST program and can use any of the commands it F recognizes. Mainly you need for next screenful, and "X" to exit.G When LIST exits, it asks "Delete?". This refers to the file created byaA BIGFILE called BIGFILE.TMP. If you answer "NO", the file will bee2 preserved so you can refer to it at your leisure.ww DOC will be used ­Ā›˙ž.‹Œ 1 VOLSER J The command procedure SYS$COM:VOLSER.COM will report on the volume serialK number of a mounted disk pack. The serial number reported is that recorded I when the pack was formatted; some disks may have invalid numbers if they1 were not formatted to include the serial number.  s Use: @SYS$COM:VOLSER device or CMD VOLSER device ww For source files: document.RNOt1 For output files: document.MEMlD The file @types shown will be used whether you are producing a; memo, a letter, a system document, or anything else. y 3 ROF_TYPES D When you are using the ROF version of Runoff, the file specifi- cations used will be:  r1 For source files: document.ROF-1 For output files: document.DOCoD The file types shown will be used whether you are producing a; memo, a letter, a system document, or anything else. s( A COMMENT? Different file types are used for the different ver- ? sions of Runoff to help you remember which version of ? Runoff should be used to process a given file. There ? is nothing to prevent you producing a file once withe? DSR as your default and later selecting ROF to actu-r? ally output the file; be aware, however, that notf? all commands from one version are recognized by the ? other, and Bthe format of the output may differf? slightly. The ".LIST" command, for instance, indents ? differently in the two versions; ROF supports Diablo"1 escape sequences, while DSR does not. i? On the assumption that you may forget which versiona? of Runoff you used when you first created a document,m? most commands check for existance of a document with ? a particular file type and warn you if it does nots? exCist, reminding you which version of Runoff is yourf? current default. If you enter DOC and attempt tod? call up a document for editing and are told it doesl? not exist, try changing versions of Runoff and at-o? tempting to edit again; possibly the file wasy+ created using the other Runoff. 2 MENU_COMMANDS D The main menu of DOC lists thirteen functions that you mayC select. They are briefly described in seDctions that follow. 3 CREATE sD To create a new document, select the CREATE option. If theD name you have chosen already exists in your directory you will8 be notified and asked to choose a different name. T You should select the version of Runoff you want to use beforeL you begin to create a document. (See Section 4.10) The reason:D when you first create a document, DOC inserts many Runoff com-D mands into the file you areE creating. The commands insertedD depend on the version of Runoff currently selected. The de-D fault version of Runoff is DSR, so if you expect to use DiabloD escape sequences, the first thing you should do after entering3 DOC is to select ROF as your default Runoff. cD If you create a document under DSR called "DOC1.RNO", you willD be allowed to create another document under ROF calledD "DOC1.ROF". These are considered to be different docuFments.D Under some circumstances you may want two versions of the sameD document, one that can be processed by DSR and the other byD ROF. This would be true if, for internal use, you wanted theD more elegant output of ROF, but wished to be able to send theA Runoff source file to other VAX users who do not have ROF. eD It is advisable, however, to use unique document names. TheD FOLDER sub-system will not handle duplicate names, even if theD fil|e type is different. An alternative way of handling this isD to store .RNO files in one folder, and .ROF files in another folder. 4 TYPES_OF_DOCUMENTS eD You can create four types of documents with DOC: memos,. letters, system documents, and "other". 3 Input of responses to promptsv? When responding to a prompt for author or subject foroG any document type, if you want to preserve lower case G in|3 Level_Titles ED The text for help file entries must be "one word", so if youD want multiple words they should be joined by an underscore asD you see them in this document. Remember when typing in suchD titles to your ROF source file that to ROF the underscore isD the "Accept Character" flag; therefore to type in the text4 "Level_Titles" you must type "Level__Titles". 3 Level_Numbering D To keep the level number in your Help File I­ā0jl‹nŒ 1 FOLDER F FOLDER is a command procedure stored in SYS$COM that provides aF menu-driven interface to four utility programs or "tools" fromV the LBL Software Tools package: admin, ar, delta, and get. The? use of these tools is transparent to the user of FOLDER. OF FOLDER allows you to store your files in "folders" (archiveF files, in the terms of the Software Tools), and to delete themF from your directory. T Jhis helps keep your directory uncluttered.F A "folder" is simply another file with a file type of ".FLD". ItF can contain many different documents, programs, or command proce-F dures. Thus you can store related files in one folder to keep them together. F For instance, if you write a lot of memos, you might want toF create a "memo" folder and to store your old memos in it. Pro-F grammers may create an appropriately named folder for program2 K modules that are parts of the same project. F FOLDER also allows you to update files you have stored in yourF folder. When you update a file, instead of writing an entirelyF new copy of the file into the folder, FOLDER analyzes the old andF new version and stores only the changes. When you first store aF file, and when you update it, you are asked for comments. TheF original comments should be a brief description of the document;F the comments part Lcan be as long as you wish. When you update aF file, you should describe the revisions you made. FOLDER canF print out a "revision history" on request, which consists of allC the comment blocks you have inserted as revisions were made. tF When you retrieve a file from the folder, you can retrieve eitherF the latest version or a specific version number, which you canF select after reviewing the revision history. This is especiallyF useful for program so Murces, when it is sometimes necessary to re-F trieve an older version of a program (especially when the latest, changes did not work as anticipated). 2 Invoking_FOLDER.COM F You invoke FOLDER in one of two ways. It has been integratedF into the VAX Document System (DOC), and may be selected from the% main menu as Option Number 13. DF To use FOLDER directly (for things other than .RNO and .ROFF files), you must enter the DCL command "@SYS$COM: NFOLDER". YouF may, if you wish, define a foreign command to make using FOLDER* easier. For example, if you enter: & FOL*DER :== @SYS$COM:FOLDER F then during the rest of your login session you may invoke FOLDERF simply by typing "FOL". To define this for every time you log= on, insert the above line into your SYSLOGIN.COM file. F When invoking FOLDER directly, it expects a file name or fileF specification as an argument. If you do no Ot give a file type asF part of the argument, the file type will default to ".RNO". ForF example, if you are going to store a command procedure in a file folder, you could type:  FOL MYPROC.COM oF When you first enter FOLDER, it will always ask you what folderF you want to use. If you have not created any folders yet (asF will be the case the first time you try it), just enter anything.F If you enter "JUNK", for example, FOLDER will look Pfor a fileF called "JUNK.FLD" and find that no such file exists. It willF tell you the folder does not exist, and give you a list of theF folders that do exist. The menu will then be displayed; you canG select the "Create Folder" option and create the folder you want. oN If you do have folders, but enter a new name, FOLDER will insistF you use the name of an existing folder. If you really want a newF folder, when you get the menu you can g Qo ahead and create it.F This is to keep you from asking for a folder than does not existF and then trying to do things to it, which could cause FOLDER no end of problems. i2 FILE lF The "File New Document" option puts a file into a folder for theN first time. Since the ar program uses the same command to add aF new entry as it does to update an existing one, FOLDER warns youF that if a file of the same name already exists in the folder, theF R file you have currently selected will replace it. FOLDER offersF to show you an index of the file folder so you can be sure thereF are no duplicate names. If you are not certain about duplicate' names, always ask for the index. eF If you do not ask for the index, or if you ask and then tellF FOLDER to go ahead and file the new document, FOLDER will do so. N What happens internally? The program admin is run to create aF new "tcs" (*Text S*Control *System) version of your file. It asksF you to enter some relevant comments describing the file you areF about to store away. You can type as many lines of comments asF you wish. When you are done typing comments, enter a line con-N taining nothing but a "." (period). This is what the admin pro-N gram calls a "dot-line". This tells admin you have finished your- comments, and the file is stored away. (N Next, the program  Tar is run to store the "tcs" file into theN folder. Note that what is stored is not an exact copy of yourV file, but the "tcs" version created by admin. This need not con-F cern you, though; FOLDER will always take care to restore theF file to its original form when you extract it from the folder later. F Finally, FOLDER will notify you it has stored your file in theF folder, and will ask you if you wish to delete U the file youN stored and all other files having the same name. For example ifF you have stored away DOC1.RNO, you probably have a DOC1.MEM fileF in your directory too. FOLDER will show you a list of all theF files having "DOC1" as the first part of their name, and will askN if you want to delete all of them. If you don't want to do this,= just say "NO", and FOLDER will not delete any of them. h2 GET_LASTVERSION F The "Get Last Ve Vrsion" option will look in the folder you haveF currently selected and will retrieve from it the last version of the file you ask for. F If a version of that file already exists in your directory,F FOLDER will warn you that the version you extract will become theF new "latest version" in your directory, and asks if you want toF do that. This is to keep you from unknowingly superceding a? newer version of a file from an old one from the folder. w WN FOLDER will use ar to extract the "tcs" file from the folder, andN will then use get to pull the latest version out of the tcs file.N Get will notify you what version number is being gotten; you! will see a line like this: t! folder.rof Version 1.2 O2 Cleaning up After a CrashA If the system should crash, or if FOLDER exits abnor- A mally after you have been working for awhile, it is XahA good idea to clean old "tcs" files out of your direc- & tory by using the command:  DELETE *.TCS;* A Once you have extracted a tcs file from its folder,eA FOLDER does not bother to extract it again, but leavesnA it around in case you refer to it again. When FOLDERoA exits normally, all "tcs" files are deleted. If theeA system crashes this does not get done, so you should doDA it. If Yold tcs files are left around, you may possibly A get the wrong version of a document when you re-entert FOLDER. 2 GET_SPECIFIC_VERSION F This option operates just like "Get Latest Version" (see commentsF on that option), except that it allows you to retrieve a version! other than the latest one. nF After checking to see if the file you are extracting already ex-F ists in the directory (as "Get Latest Version" does), this optionF d Zisplays the revision history of the file, with version numbers,F and asks which version you want to retrieve. You must enter theF version number as it is shown in the revision history, e.g.F "1.3". FOLDER makes no validity check on the number you enter;N if you receive an error message from get you probably entered the number wrong. 2 UPDATE uF The Update option will store a new version of a file already inF the folder. It will compare [the old and new versions, report onF the number of lines changed, deleted, and inserted, and ask forF comments regarding the contents of the revision. (The program( delta is used to do this.) F If the file you are storing does not exist in the folder, FOLDERN will ask if you want to store the file as a new file in theF folder. If you say "YES", the "File New Document" function will) be executed instead of the Update. dF Like \ the "File New Document" option, Update will then ask if youN wish to delete all files having the same name as the document.F It lists the files for you and asks if you wish to delete all ofF them. If you do not, just answer "NO". Since the purpose of us-F ing folders is to keep your directory small, it is generally aF good idea to say "YES". But check the list of files first, be-F cause there may be some there you don't expect and don't want to ] delete. 2 DELETE F The Delete option will delete a file from the folder. It firstB notifies you of exactly what it intends to do, for example: 6 Deleting document BACKUPS from folder MEMOS " Is this correct? [Y/N] F This is done just as a precaution, in case you select the Delete3 option by mistake (typing the wrong number). lF If you say "Yes", the delete occurs, and then you are asked ifF you want to delete any related files. ^ This question appears onlyF if files having the same name as the document you deleted existF in the directory. A directory listing of the related files isN given, and you are asked if you wish to delete all of them. YouF cannot select just a few to delete; if you want to do that, youF will have to leave FOLDER, get back to DCL, and use the normal DCL DELETE command. 2 LIST yF The List option will display a list of all files in your fol_der.F The list will contain one line per file, and will appear like this: F operdocs.tcs 5504 asc 19-feb-84 18:36:55 watson (allen wat- son)uF emacs.tcs 13862 asc 19-feb-84 19:21:04 watson (allen wat- son)DF scratches.tcs 4445 asc 19-feb-84 19:22:43 watson (allen wat- son) F As you can see, the entries in the folder are all "tcs" files.F The number in the next column is the number of characters in theF file. `Then, "asc" indicates that they are ASCII filesF (containing text of some sort). Other types that may appear hereF are "bin" for binary. Finally, the date and time of the lastF change are shown, along with the user name and account owner of& the person who made the change. F If you want to find out more about the contents of a particularF file in the folder, use the "Show Revision History" option des-" cribed in the next section. 2 SHOW_RaEVISION_HISTORY F This option will show the revision history, along with any com-D ments that were inserted, of a particular file in the folder. 9 Here is a sample of a revision history for a file: u0 *** Version # 1.2 19-Feb-84 23:08:03 watsonC Added description of Option 12 for switching between EMACS andp EDT 0 *** Version # 1.1 17-Feb-84 19:25:00 watson+ Original version, Author: Allen Watsonh, Documents the VAX Document system using#c EDT, EMACS, DSR, ROF, SPELL , with PURGE, DELETE, and INDEX commands.2 CREATE_FOLDER F The Create New Folder option does just what it says: it createsF a new, empty folder for you to use, and assigns it as your cur-F rent folder. All you have to do is specify a name for the newF folder. FOLDER checks to make sure you don't already have a< folder by that name, and then creates the new folder. 2 CHANGE_DOCUMENT_NAME ,F This option aĸ occurs, use CTRL/Y to exit from DOC, and then re-enter DOC. 2 USER_DEFAULTS D DOC will normally start up with EDT as the text editor and DSRD as the Runoff program of choice. You can change these during+ the session using options 10 and 12. uD If, however, you wish to use EMACS all the time as your editorD and ROF as your version of Runoff, you can set up a file inD your directory to cause DOC to select different defaults for you. eD dllows you to select a new document or file name.F You can enter any valid file specification; you do not have toF restrict yourself to .RNO or .ROF files. If you do not enter aF file type, FOLDER will supply the file type by default, usuallyF .RNO. FOLDER checks to see if the file you named exists andF warns you if it doesn't, but then proceeds as if nothing wereF wrong. Sometimes you will need to select the name of a file thatF does not exist, f eor instance, when you are about to retrieve a file from a folder. 2 CHANGE_FOLDER_NAME RF This option selects a new file folder to work with. (Note thatN it does not change the name of a folder from one thing toF another; that can be done with the DCL RENAME command.) TheF first seven options (File, Get Latest, Get Earlier, Update, De-F lete, List, and Show) will now all refer to this newly selected folder. F The "Cha fnge Folder Name" option is actually the same part of theF program you went through when you first entered FOLDER; it per-F forms the same checks and presents the same dialogue. See the+ description under "Invoking FOLDER". h2 EXIT F The Exit option leaves the FOLDER procedure. If FOLDER was in-F voked directly, it returns you to DCL command level. If FOLDERF was invoked from the DOC system, it returns you to the main menu of DOC. 2 ADDITION gAL_DOCUMENTATION hN For additional documentation on the programs admin, ar, delta andN get, you must refer to the documents provided with the SoftwareF Tools. If you have not already defined the tools as foreign com-F mands in your LOGIN.COM file, enter the following line to define& the "man" (for manual) command:  man :== $ST_BIN:man F Now, to obtain documentation on any of the four programs used by7 FOLDER, just type a "man" chommand. For example:  man delta F If you would like a printed copy of the program documentation,F re-direct the output of man to a file, and then print the file. For example: n man delta >delta.doc e% print/que=diablo delta.doc MF It is not advisable to print Software Tools documentation on theF upper case line printer, since many characters that are used inF the documents are not available on the line printer; the Diablo2 printer has all the appropriate characters. wwan delta  G If you would like a printed copy of the program documentation, G re-direct the output of man to a file, and then print the file.  For example:  man delta >delta.doc & print/que=diablo delta.doc  G It is not advisable to print Software Tools documentation on the G upper case line printer, since many characters that are used in G the documents are no j­@8ĐnŒ 1 HELP_FILES D The ROF version of Runoff has several really nice features thatD allow you to create a document and an accompanying on-line helpD file at the same time. This memo will attempt to give you someD guidelines for doing this. Basically, you create a text fileD with imbedded ROF commands and, by passing it through ROFD twice, create both a document and a Help File that contains theD same material in suitable format for inc klusion in a Help Li- brary. 2 Creating_Automatically eD By appropriate use of the .IF, .ENDIF, and .IFNOT commandsD within a file you can cause it to have differently formattedD outputs depending on the setting of the .VARIANT command. TheL textual material of the file is not enclosed in IF blocks, butL the formatting material is. A document is sectionalized byD Header Level commands, while a Help File is sectionalized by7l numbered references that must occur in column 1. dD A suggested use of Variant names is "DOC" for document and6 "HELP" for Help files. Sample section follows:   .IF DOC  .HL 1 HELP__FILESo .ENDIF DOC .IF HELP .LM 0 .P 1 HELP__FILESr l .LM 5u .ENDIF HELPc 3 Using_Macros oD The typing of the IF blocks can be automated also by means ofD macros in EDT or EMACS. This docum ment and associated Help FileD were created using such a macro in EMACS, set up so that allD that needed to be typed was the text to go into the HL and HelpD File entry line. See the manual for the editor you use onD creation of keyboard macros. (Al Watson will gladly share his EMACS macro.) t3 Variant_Commands D In ROF the Variant command must appear in a file being pro-D cessed by ROF; in DSR the Variant is specified in a commandD lin ne switch. You can produce Help files using DSR as well asD ROF, but ROF has the ability to turn underscoring and boldingD into VT100 escape sequences that display as underline or bold< modes on the VT100. This is very nice in Help Files. D If your file is stable you may find it easiest (using ROF) toD imbed a command at the top of the file, either .VARIANT HELP orD .VARIANT DOC. Run it through ROF once, then edit the "VARIANT"D line, and run it through oagain. For an alternate method, see$ the section on REQUIRE_FILES. 3 Require_Files D For documents that will be updated fairly often it is easiestD to use separate control files. If your document is calledD DOC1.ROF, leave out the variant command entirely and create twoD other files called DOC1HLP.ROF and DOC1DOC.ROF. These filesD should contain only two REQUIRE commands, first a .REQUIRED "SYS$COM:HELPVAR.ROF" (to produce a help p file) orD "SYS$COM:DOCVAR.ROF" (to produce a document file) and then aD .REQUIRE "DOC1.ROF" command. To produce a document, you wouldD ROF DOC1.DOC=DOC1DOC.ROF; to produce a help file you would ROFD DOC1.HLP/-CR=DOC1HLP.ROF. (In the VAX Document System you can-D not currently specify the output file type. A ".DOC" file isD always produced. You should therefore RENAME the output fileD after producing a help file.) The switch "/-CR" is necessary toD q suppress printer control carriage returns in the output file;D including such characters in a Help file does strange things to the HELP processor. D If you get a bunch of error messages about things being alreadyD defined, it may be because the file defining Diablo escape se-D quences, ROFSTUFF.ROF, got included twice. See the section on "document headings". 4 Example / Examples of variant using REQUIRE files. JL DOC1.ROF file crontains your text, with imbedded IF and ENDIF5 statements for DOC and HELP commands and text. o$ DOC1DOC.ROF contains: ( .REQUIRE "SYS$COM:DOCVAR.ROF"  .REQUIRE "DOC1.ROF" ? This file produces your document file when processed by: t# ROF DOC1.DOC=DOC1DOC.ROF y$ DOC1HLP.ROF contains: ) .REQUIRE "SYS$COM:HELPVAR.ROF" t .REQUIRE "DOC1.ROF" ; This file produces your help file when processed by: e' s ROF DOC1.HLP/-CR=DOC1HLP.ROF 3 DOCUMENT_HEADINGS D If you have used the VAX Document system (DOC) to produce yourD document, you will have heading material such as the MEMO logoD or a title page that is meant to be part of the document, butD which should not appear in the Help File. Bracket this mater-D ial with ".IF" and ".ENDIF" statements, with ".IF DOC" going atD the very top and ".ENDIF DOC" going after the line "Text begins here". D N tote that in the middle of the header material is a .REQUIRED command calling for inclusion of ROFSTUFF.ROF (if you are usingD ROF). If you are going to process the file separately (withoutD control files using .REQUIRE commands) this command should beL outside of any IF blocks, but must precede the Date line; theD simplest thing to do is to put an ENDIF in front of it and an IF following it:  .ENDIF DOC) .REQUIRE "SYS$uCOM:ROFSTUFF.ROF"  .IF DOC D If, however, you are going to process your file by means of Re-L quire commands as described earlier, don't put an ENDIF/IF pairD around the Require line in your main file. ROFSTUFF.ROF is in-D cluded by the DOCVAR.ROF and HELPVAR.ROF files, so you don'tD need it again in your main document. Instead, delete the line( from your main document entirely. , POSSIBLE CHANGESGv I am thinking about altering DOC so that it always ? uses Require commands to process files. The ".RE- ? QUIRE SYS$COM:ROFSTUFF.ROF" would never be in the ? main file. DOC would create a temporary file ? "require"-ing an appropriate header file and then the ? main document. This would solve two problems; the ? one discussed above about creating document or help ? files, and one encountered x in using the VIEW option ? of DOC, where you have to edit the .VARIANT line in ? your source file to view a ROF file at the terminal. ? The problem with making such a change is, that files ? would always have to be processed from DOC; if you ? tried to run ROF directly on the file from DCL level, ? all the Diablo or VT100 escape sequences would be un- ? defined. So, I am betwixt and between about what to  do. x3 Level_Titles D The text for help file entries must be "one word", so if youD want multiple words they should be joined by an underscore asD you see them in this document. Remember when typing in suchD titles to your ROF source file that to ROF the underscore isD the "Accept Character" flag; therefore to type in the text4 "Level_Titles" you must type "Level__Titles". 3 Level_Numbering D To keep the level number in your Help File y n3 Level_Titles mD The text for help file entries must be "one word", so if youD want multiple words they should be joined by an underscore asD you see them in this document. Remember when typing in suchD titles to your ROF source file that to ROF the underscore isD the "Accept Character" flag; therefore to type in the text4 "Level_Titles" you must type "Level__Titles". 3 Level_Numbering D To keep the level number in your Help F zile in step with theD numbering of your Header Level commands for Runoff, do not putD any text in front of the first Header Level 1 command that youD want to appear in the Help File. Or, in other words, start theD text with a Header Level 1 command and use only one such com- mand in the document. D If your document naturally divides into several main sectionsD and you want to use Header Level 1 for them, but want to pro-D duce a single Help File, t{hen you should insert a Help Level 1D line at the very top, and make the following Help Level numbers7 one greater than the corresponding Header Level. i 2 Storing D To store your Help File in the system Help Libraries (so thatD it is available via the HELP command) requires system-levelD privileges; please contact a member of Systems Technology to assist you. 3 Libraries D This information is for Systems Technology Department members. D  The standard VMS help library should not be used for locallyD written help files. Instead, use either SYSUTL.HLB (for systemD utility programs, primarily from DECUS), or RECORD.HLB (forL help files related to procedures and programs unique to TheL Record). Both are located in the SYS$HELP directory. There is: also a GAMES.HLB for help related to game programs. D To store a new help library use a command of the following form: ~put you must enclose the input in double quotes. ? If double quotes are not used the command procedureu? will automatically transpose your input into uppery? case. If you forget this, you can still go back and , edit the lines in your document. 5 MEMOS L Memos are pre-formatted in the now familiar way with a largeD "MEMO" heading and appropriate fields for author, addressee,D subject, and persons to b~F Like the "File New Document" option, Update will then ask if youN wish to delete all files having the same name as the document.F It lists the files for you and asks if you wish to delete all ofF them. If you do not, just answer "NO". Since the purpose of us-F ing folders is to keep your directory small, it is generally aF good idea to say "YES". But check the list of files first, be-F cause there may be some there you don't expect and don't we copied (at the end of the memo).= You will be prompted for input to the required fields. 5 LETTERS L Letters are pre-formatted with the return address and date al-D igned against the right margin, followed by the destinationD name and address left-justified, a salutation line, and a clos-D ing. Normally you will be prompted separately for each line ofD each address. The letter produced will not go on RecordD letterhead; the letter opt€ion is intended for quick notes and (gasp!) personal use. D If you wish you may pre-define the return address informationD by creating a file in your login directory called ADDRESS.DEF.: Here is a sample ADDRESS.DEF file for Allen Watson: ( $ AUTHOR :== "Allen A. Watson"4 $ ATITLE :== "Manager, Systems Technology"! $ RET1 :== "THE RECORD"r' $ RET2 :== "150 River Street"s+ $ RET3 :== "Hackensack, NJ 07602" ‚ D If an ADDRESS.DEF file exists in your directory you will beD asked if you want to use the default information. If you replyD "YES", the fields will be filled in automatically as you pro-$ gress through the input form. 5 SYSTEM_DOCUMENTS L System Documents are documents intended to describe some aspectD of our VAX/VMS system or RSX11M-Plus system. This document is' an example of a system document. 5 DATE_SUBSTITUTION D 7 LIBR/HELP/INSERT library-spec help-file-spec ID To replace an existing library, use /REPLACE instead of /IN- SERT. D By separating the material we write into separate libraries weD don't have to worry when DEC replaces their main help library file.ww who made the change. F If you want to find out more about the contents of a particularF file in the folder, use the "Show Revision History" option des-" cribed in the next sectioƒ For all three of the above document types, date substitution isD used. That is, when you process the document through RunoffD the date information for today is automatically inserted. SeeD the DSR manual or Pocket Reference for information on how to use $$DATE, $$TIME, etc. sD Both versions of Runoff support change bars (marginal lines in-D dicating portions of a document which have altered since theD last issue of the document). Authors of system d„ocuments espe-D cially are encouraged to use change bars to aid readers in lo-" cating updated information. 3 EDIT (D Once you have begun to create a document and have exited theD editor, further changes to the document must be made using theD EDIT option. EDIT opens your document for editing. It auto-D matically places a comment line at the top of the file indicat-D ing the date the file was last edited, and by whom. You are: free to delete …these lines if you do not want them. D EDT is always called in "Change Mode", that is, full screenD edit mode. You may use any valid EDT commands. When done, youD may EXIT or QUIT (if you wish to discard your changes). Nor-D mally you will EXIT, and EDT will create a new version of yourD document file. When in DOC, EDT is always started using theD system EDT initialization file found in SYS$COM. If you needD information on what keys are defined by‡ this file, see the Sys- tem Manager. .D If the system fails during an EDIT, you cannot perform and EDTD "/RECOVER" command from within DOC. The suggested procedure in& the event of a system crash is: D 1. When the system comes back up, log on and change to: the directory that contains your document. D 2. Type in the normal command to invoke EDT in RecoveryD mode, giving the full name of the document file9 ‡F The "Change Folder Name" option is actually the same part of theF program you went through when you first entered FOLDER; it per-F forms the same checks and presents the same dialogue. See the + description under "Invoking FOLDER". 2 EXIT F The Exit option leaves the FOLDER procedure. If FOLDER was in-F voked directly, it returns you to DCL command level. If FOLDERF was invoked from the DOC system, it returns you to the main menu of ˆ including file type, for example: - EDT/RECOVER DOCUMENT1.ROF D 3. EDT will now call up the last complete version of yourD document and will re-create every keystroke of the ed-D iting session that was interrupted by the system crash. D 4. When EDT has finished recovering your edits, use@ CTRL/Z and EXIT to save the edits to this point. D 5. Now, re-‰enter the DOC system by typing, for example: ! DOC DOCUMENT1 e3 VIEW D The VIEW option allows you to see at your terminal the format-; ted results of passing your document through Runoff. ( 1.1.1 Underlining when VIEWing - D Underscoring, if present in your document, creates uniqueD problems when you are using DSR. You will be asked whether or? not you want the underscoring to appear at the terminal. oD If you ansŠwer "yes", underscoring will be done with hyphens onD a second line so that the text and underscores will both be vi-D sible on your terminal (video screens can't overprint). ThisL means that extra lines are used for the underscoring. When youD do final output to a printer, however, underlining is done withD overprinting, using only one line. Therefore, your final out-D put will have fewer lines than the "VIEW" version, with moreD lines of text per p‹age. Page breaks will come in a different place. eD If you answer "no" to the underscoring question, underscoresD will be omitted from the version you see on the screen, and theC page breaks will be the same as your final printed document. TD If page break points are important to you, I suggest you viewD your document twice: once to check for proper underscoring,) and once to check the page breaks. 4 ROF_FILES D When you VIEW a filŒe with the ROF version of Runoff, DOC isD able to substitute VT100 control characters in place of theD Diablo control characters, so that both underlining and boldingD or shadow printing will appear on the screen in the same way asD they will in final output. That is, for underlining the VT100D underline mode is used; for shadow printing the VT100 boldD mode is used. The modes may even be mixed (an underlined word( in a bold sentence, for example). D The selection of the appropriate variant, for Diablo or for+ VT100, is done automatically by DOC. w5 ROF files created prior to 3/2/84 ? If you created files for ROF prior to 3/2/84, they1 will contain the following two lines: g/ .VARIANT DIABLO .;.VARIANT VIEW s? These two lines should be deleted from the file priorf4 to further editing and output using DOC. 3 CHECK_SPELLING aD ThiŽs option uses a DECUS program called SPELL to check theD spelling of every word in your document. Runoff command lines are ignored. o D SPELL has two modes: interactive and automatic. It is advis-L able not to use interactive spelling checking, because it re-L quires a response every time it detects a suspect word. ManyD of the technical terms and proper names used in our memos andD documentation will appear to be a misspelled word to SPELL, forD example, "SYSGEN" and "Schrumpf". So it is best to select theD non-interactive mode. This will list all suspect words withD the line number of the line containing it. If you see a trulyD misspelled word on the list you may then use the EDIT option to! find and correct the word. rD For more information on using SPELL (outside of the DOC sys- tem), see "HELP SPELL". 3 RUNOFF D The RUNOFF option reads the file you have created, which con-D tains DSR or ROF commands, and produces an output file format-D ted according to those commands. You must choose RUNOFF before( you can print the final document. D The RUNOFF option will use whichever version of Runoff is cur-D rently your default, either DSR or ROF. If you give only a do-D cument name, it will default to the appropriate file types asD described above. You can override this by using the CHOOSE op-D tion to specify ‘both the document name and file type. In thisD way you can create a document with DSR as your default, andD ".RNO" as the file type, and then change to ROF as your defaultD and use CHOOSE to make the file name "docname.RNO". (I don'tD know why you would want to do this, but I want to point out it is possible.) mD DSR will produce a file called "docname.MEM", and ROF will pro-( duce a file called "docname.DOC". 3 PRINT D The PRINT opt’ion allows you to direct that a file produced byD the RUNOFF option be printed. It checks to see that an appro-D priate file exists. If you are using DSR, there must be aD "docname.MEM" file present in your directory; if you are using/ ROF, there must be a "docname.DOC" file. 6 ROF files can go only to the DiabloG Documents created using ROF must be sent to the? Diablo printer. They cannot reproduce correctly “ on ? any other printer because spacing between words isy? done with special control characters to achieve vari-  able spacing. D You are offered a choice of four printers: the Diablo (inD ISD), the console LA120 (not normally set up as a print queueD any more), the Advertising Department LA120 (intended for useD by Advertising Department), and the line printer (all upper-/ case) which can be used for fast proofs. oD ” You can specify how many copies of the file you want printed. 3 CHOOSE uD The CHOOSE option allows you to completely specify the fileD name you are manipulating. Its primary purpose is to change2 document names within a single DOC session. L If you specify the file type, your specification will overrideD the defaults used by DOC for Runoff source files. That is, youD can create and edit files such as "docname.TXT" or "doc-D name.•LET". You can also VIEW and RUNOFF such files. However,D the RUNOFF option will always produce either .MEM or .DOCD files, and the PRINT, PURGE and DELETE options will always ex-1 pect one or the other of these file types. I3 PURGE D The PURGE option allows you to clean up your directory afterD multiple edits and RUNOFFs have been performed on a document;D it will use the document name you have specified and will de-L lete all but the most– recent version of both the source andD output files for Runoff. If you have DSR as your default Ru-D noff, PURGE will operate on .RNO and .MEM files; if you haveD ROF, it will operate on .ROF and .DOC files. The system PurgeD command will report the results of the purge; for example, ifD you PURGE all "DOC1" files, it will report a warning message if! no "DOC1.MEM" file exists. l 3 DELETE nD The DELETE option allows you to delete documents y—ou no longerD need. Like PURGE, it will operate on different file types de-D pending on the Runoff you have currently selected. When youL delete a document, it is gone forever; there is no way (short& of backup tapes) to recover it. 3 CHANGE_RUNOFF_VERSION D The CHANGE option changes between versions of Runoff. If youD are currently using DSR it will change to ROF, or vice versa.D CHANGE also changes the default file type to correspond to˜ the$ Runoff version you are using. D When you select ROF, the following escape flags and sequencesD are automatically defined for you when you create a document: 7 [ Half space paper down (for superscript).3 ] Half space paper up (for subscript)f+ * Shadow print next charactero' ^* Lock in shadow printing $ \* Stop shadow printing D If you want to use any of the characters "*", "[™", or "]" asD regular text characters you can either "flag accept" them, likeD this: "_*", or you can "undefine" them as flag characters by9 including a command such as this in your document:  .NO FLAGS SPECIAL *  or " .NO FLAGS SPECIAL * [ ] D The first command would allow normal use of the asterisk only;D the second command would allow normal use of all three char- acters. D To re-establish use of "*" for shadow printingš you would enter the line,  .FLAGS SPECIAL * i3 INDEX D The INDEX option produces an index of all .RNO and .ROF filesD in your directory. When you create a document using DOC, aD subject line is always asked for and inserted into your docu-B ment. This subject line is reproduced by the INDEX option.  Here is a sample index: ) Index for all RNO and ROF files  DOCUMENT SUBJECT ------------›- -------6 ALTSTART.RNO Alternate VAX startup methodsC RNOCOMPAR.RNO ^*Comparison of Three Versions of RUNOFF\*l6 RSXSYSGEN.RNO RSX11M-PLUS POST SYSGEN NOTES8 SHACOMPAR.RNO Comparison of shadow pair disks' WHEREIS.RNO Lost documentcB FOLDER.ROF File Folder Command Procedure: FOLDER.COM; FOLDERDOC.ROF CONTROL FILE TO PRODUCE FOLDER.DOCi; FOLDERHLP.ROF CONTROL FILE TO PRODUCE FOLDER.HLPm> VAXDOC.ROFœ ^*Bergen Record VAX Document System\*; The following documents had no subject indicated. ' CHARTHED.RNO;1 - 7 records ( HELPDODOC.ROF;1 - 2 records( HELPDOHLP.ROF;1 - 2 recordsD Note that some documents are listed with "no subject indi-D cated". This means either that the document was not createdD using DOC, or else the subject line is no longer within theD file. Documents with multiple versions will be listed onžce for each version. 3 TOGGLE_EDITOR D The TOGGLE option allows you to switch back and forth betweenD two different text editor programs, EDT and EMACS. EDT is theD standard DEC text editor, and EMACS is a special multi-buffer,D multi-window editor. For more information on these editors seeD HELP EDIT and HELP EMACS, or read the related document on the editor. E Files created with EDT can be edited with EMACS, or vice versa. e 3 FOLDER bžD The FOLDER option allows you to enter the "File Folder Mainte-D nance" menu. This is a sub-system of DOC that can be used toD archive documents in a "file folder" with other related docu-D ments. For more information, see the separate document on@ "FOLDER: File Folder Maintenance" or type "HELP FOLDER". 2 KNOWN_BUGS eD Sometimes DOC appears to lock up after a SPELL operation. ThisD occurs most often if you do SPELL followed by EDIT. If th isB occurs, use CTRL/Y to exit from DOC, and then re-enter DOC. 2 USER_DEFAULTS D DOC will normally start up with EDT as the text editor and DSRD as the Runoff program of choice. You can change these during+ the session using options 10 and 12. sD If, however, you wish to use EMACS all the time as your editorD and ROF as your version of Runoff, you can set up a file inD your directory to cause DOC to select different defaults for you.  D You can use DOC to create this Defaults Control File. TypeD "DOC DOCDEF.COM" or if you are already in DOC, use option 7 toD change your document name to DOCDEF.COM. Create the documentD (or file) using the "other" type document, and delete the com-7 ment line at the top so you have a blank screen. D You now need to create what is called a VMS Command Procedure.D Here is a sample DOCDEF.COM command procedure to set yourself; up with ROF as yourĄ Runoff and EMACS as your editor: s < $! Set up default editor and runoff for VAXDOC.COM $ FTYPE :== .ROF! $ FILESPEC :== MEMO.ROFa $ OUTYPE :== .DOC 0 $ USEDSR == 0 ! Assume user wants ROF. $ USEROF == 1u $ RUNOFF_VER :== ROF $ TEXTED :== EMACS D The first six lines define things for using ROF as your versionC of Runoff. The last line selects EMACS as your text editor. oD IĨf you wanted to set up DOC to choose EMACS as your editor butD you wanted DSR for doing Runoff, your DOCDEF.COM would have only one line:  $ TEXTED :== EMACS nD If you wanted ROF as your Runoff, but wished to retain EDT asD your text editor, you would make your DOCDEF.COM with the first( six lines exactly as shown above. D Once DOCDEF.COM has been set up correctly you will never have to change it.  =ww.ROF  $ OUTYPE :== Ŗ You can use DOC to create this Defaults Control File. TypeD "DOC DOCDEF.COM" or if you are already in DOC, use option 7 toD change your document name to DOCDEF.COM. Create the documentD (or file) using the "other" type document, and delete the com-7 ment line at the top so you have a blank screen. eD You now need to create what is called a VMS Command Procedure.D Here is a sample DOCDEF.COM command procedure to set yourself; up with ROF as your Run¤off and EMACS as your editor: < $! Set up default editor and runoff for VAXDOC.COM $ FTYPE :== .ROF! $ FILESPEC :== MEMO.ROFx $ OUTYPE :== .DOC.0 $ USEDSR == 0 ! Assume user wants ROF. $ USEROF == 1a $ RUNOFF_VER :== ROF $ TEXTED :== EMACS D The first six lines define things for using ROF as your versionC of Runoff. The last line selects EMACS as your text editor. D If you wanted to set up DOC to choose EMACS as your editor butD you wanted DSR for doing Runoff, your DOCDEF.COM would have only one line: k $ TEXTED :== EMACS sD If you wanted ROF as your Runoff, but wished to retain EDT asD your text editor, you would make your DOCDEF.COM with the first( six lines exactly as shown above. D Once DOCDEF.COM has been set up correctly you will never have to change it. wwYou can change these during , Ļ the session using options 10 and 12.  E If, however, you wish to use EMACS all the time as your editor E and ROF as your version of Runoff, you can set up a file in E your directory to cause DOC to select different defaults for you.  E You can use DOC to create this Defaults Control File. Type E "DOC DOCDEF.COM" or if you are already in DOC, use option 7 to E change your document name to DOCDEF.COM. Create the document E (or§ file) using the "other" type document, and delete the com- 8 ment line at the top so you have a blank screen.  E You now need to create what is called a VMS Command Procedure. E Here is a sample DOCDEF.COM command procedure to set yourself < up with ROF as your Runoff and EMACS as your editor: = $! Set up default editor and runoff for VAXDOC.COM  $ FTYPE :== .ROF " $ FILESPEC :== MEMO.ROF  $ OUTYPE :== .DOC 1¨ $ USEDSR == 0 ! Assume user wants ROF.  $ USEROF == 1  $ RUNOFF_VER :== ROF  $ TEXTED :== EMACS  E The first six lines define things for using ROF as your version D of Runoff. The last line selects EMACS as your text editor.  E If you wanted to set up DOC to choose EMACS as your editor but E you wanted DSR for doing Runoff, your DOCDEF.COM would have  only one line:   $ TEXTED :== EMACS  E If you wanted ROF as your Runoff, but wished to retain EDT as E your text editor, you would make your DOCDEF.COM with the first ) six lines exactly as shown above.  E Once DOCDEF.COM has been set up correctly you will never have  to change it. ww