!HELP format documentation for Edinburgh utilities. ADC. Nov 1982. 1 EUCSD The Edinburgh University Computer Science Dept. is located at the following address. Computer Science Dept. The Kings Buildings, Mayfield Road, Edinburgh Scotland The following nonstandard commands supported on this system originated there: BE CLEAN FDUMP FILES FIND GONE LAYOUT NAME NAMETT NLINES NOTIFY PERUSE SUICIDE USERS VECCE WHOIS ! * * * * * * HELP information is available about all these commands. Manuals are available for some from the above address. 1 NOTIFY Broadcasts a line of text to another user logged into the system, or to all users. Format: NOTIFY username "text-string" A username specified as a wild card "*" causes the text-string to be displayed on all terminals at which users are currently logged on. Examples NOTIFY ALAN "Coffee time?" NOTIFY * "All DRA1: users please PURGE! See also HELP SET TERMINAL /NOBROADCAST This is not a standard command and therefore its name cannot be abbreviated. 1 FILES Lists the names of files in the current directory. Format: FILES filespec Filespec may be omitted, in which case all files in the current directory are displayed Examples FILES display all files in default directory FILES .LIS display all files of type .LIS FILES FRED display all files whose filename part is FRED FILES *.*; display only top versions of all files Only files whose names match the filespec, which may contain wild cards, are displayed. This is not a standard command and therefore its name cannot be abbreviated. 2 Qualifiers /ALL The /ALL qualifier causes FILES to display the names of all files in the current directory and also the names of all files in any subdirectories of the current directory. 1 USERS Lists the names of users currently logged in to the system. Format: USERS The default output for each user consists of the owner name string (usually a user's real name), the username and the location of the terminal at which the user is logged in. Only interactive users are listed, although a count of the number of batch jobs currently executing is displayed along with the interactive user count in a summary at the end of the list. This is not a standard command and therefore its name cannot be abbreviated. 2 Qualifiers /BRIEF By default, USERS displays the name and owner name of logged in users, one per line. The /BRIEF qualifier causes only usernames to be output, eight per line. /VERY_BRIEF Only the current number of interactive users and batch jobs is displayed, along with the current limit on the number of interactive users set by the system manager. /GROUP[=nnn] Displays only users in the specified group. nnn is must be an octal group number in the range 0 to 377. If omitted the selected group is the group to which the requesting user belongs. /TERMINALS The device name of the terminal at which each user is logged in is displayed in the form TTcn: beside the username in question. /PID The process id (PID) of each user is displayed along with the default information (username, owner string, terminal location). 1 LAYOUT Invokes the LAYOUT document formatter. This program produces a paged, formatted output document from a free format text input file containing embedded control directives. The syntax of these directives is defined in a manual "LAYOUT" available from the Edinburgh University Computer Science Department Secretary. (See HELP EUCSD). The input text file may be created or altered using any VAX/VMS text editor. (See HELP VECCE). Format: LAYOUT filename Note that the extension .LAY is assumed for the given filename and may not be specified in the command line. This command produces a file filename.LIS which may be printed using the command PRINT/NOFEED filename This is not a standard command and therefore its name cannot be abbreviated. 2 Commands Only the major commands are shown here. Refer to the printed guide for more detailed information. Commands are embedded in free text. Spaces and newlines in the text are normally COMPLETELY IGNORED. Formatting of the output text can ONLY be done using the "$" directives. Only the $A command must come at the start of a line. Numeric parameters to layout commands other than $A always default to one. Use %word to underline "word" in the output text. ENVIRONMENT SETTING TEXT FORMATTING $A INVERT=0;MARK=2;PAGE=57 $P Indicates a para. break in the text MUST start every LAYOUT file. $Vn Ensures following section won't $A JUST=n n=1 to justify right start < n lines from the end of a page, text margin. 0 is default. $Bn Forces n blank lines into the text at $A INDENT=n this point. n=0 if only 1 newline reqd. Following text is indented $L0 Input text is copied verbatim to the to tab stop NUMBER n (not output until the next $ command appears column n!) till the next in the input stream. $A INDENT command is seen. $L0M as for L0, text auto-centred. $A TAB=x,y,z,... $L0U " " " " auto-underlined. Defines tab stop nos. 1,2, $L0MU does both 3,.. to be at col. nos. x, $In Ignore current $A INDENT setting & y,z,... force this line to start at tab stop n. $A PAGENO=1 auto-page numbers. $Tn Jump to tab stop n Remember the text editor does not understand LAYOUT commands, and that LAYOUT commands only affect input text appearing AFTER them. 1 FDUMP Produces a readable dump of the contents of a 'binary' file. Output is produced in the following format: Format: FDUMP filespec The filespec may not contain wildcard characters. Output is produced in the following format: 00000000 00000000 00000000 00000000 [00000000] |________________| "00000000" represents a hexadecimal number. The underscores represent single ISO character codes. Control codes are replaced by the underscore character. The number in brackets [...] is the byte offset from the start of the file of the leftmost character between the vertical bars. Characters at sequentially higher addresses are displayed left to right here, whereas the numeric display shows bytes at sequentially increasing addresses reading from right to left. This is not a standard command and therefore its name cannot be abbreviated. 2 Qualifiers /OUTPUT=filespec If this qualifier is used, FDUMP will write output to the specified file or device. If the /OUTPUT qualifier is omitted, output is written to SYS$OUTPUT. 1 PERUSE Allows a user to scan the contents of a file at a VT100 terminal. Format: PERUSE filespec The filespec may contain wild card characters. This is not a standard command and therefore its name cannot be abbreviated. 2 Qualifiers /WIDE Display the filename currently being processed as double width characters. /UNDERLINE Underlines the status line area where the filename being processed is displayed. /SUB=character Be default, control characters appearing in the file being perused are displayed as question mark "?" characters. This qualifier allows a user to alter this convention. The specified character will be used instead of the question mark. Examples PERUSE FRED.LIS/SUB=_ replace control characters by underscores. PERUSE/SUB=* *.OBJ replace control characters by asterisks. 1 WHOIS Allows you to find the User Identification Code (UIC) corresponding to a given username, or to find the username corresponding to a particular UIC. The owner string, usually the real name of a person corresponding to a "username", is also displayed in either case. Formats: WHOIS username WHOIS uic A UIC may be specified in any of the following forms: [ggg,mmm] ggg and mmm must both be octal numbers in the range 0 ggg,mmm to 377 or "*" which is a wild card representing all ggg mmm groups/members. Examples WHOIS ALAN username specified WHOIS [1,4] UIC specified WHOIS 10 40 fully abbreviated UIC WHOIS [300,*] all users in group 100 This is not a standard command and therefore its name cannot be abbreviated. 1 SUICIDE Allows a user to delete processes which he has previously created by logging in at other terminals. Format: $ RUN $EDINB:SUICIDE The program will prompt with the name and location of each terminal at which the user is logged in. Reply with 'D' or 'Y' to delete the process running on that terminal. Reply with carriage return to leave the process unaffacted and proceed to the next one. 1 NAME This command accepts a single text string parameter. It searches the user authorization file to display the usernames of all users whose real names roughly match the given text string. This command is normally used to discover the username by which a particular person is known to the system. (E.g. in order to send MAIL to the user). Format: NAME text-string Examples NAME ALAN NAME CORICANEC 1 NAMETT Lists the device names and locations of terminals attatched to the system. Format: NAMETT location The location string may be omitted, in which case the names of all terminal devices attached to the system are displayed along with their locations. If specified, only terminals whose location string contains the specified location are displayed. Examples NAMETT - Display names of all terminals NAMETT front office - Displays names of all terminals in the front office This is not a standard command and therefore its name cannot be abbreviated. 1 GONE This command logs you off the system, but allows you to leave a message describing where you are going, which may be read by other users. The time at which you leave is recorded in the message automatically. See also HELP FIND. Format: GONE "where" Examples GONE "to the pictures" GONE "for tea" This is not a standard command and therefore its name cannot be abbreviated. 1 FIND Displays the whereabouts of other users. Format: FIND username-list The username-list conists of a list of usernames separated by commas. The message displayed by FIND is either the location of the target user's terminal (if the user is logged on currently), the message left by the GONE command if the user is not currently logged on but logged out using GONE rather than LOGOUT, or "nowhere to be found" otherwise. Examples FIND ALAN FIND MIKE,RICHARD,PETER This is not a standard command and therefore its name cannot be abbreviated. 1 NLINES Displays the number of records in a file. For a text file created by an editor or a listing file produced by most programs this will be the number of lines of text in the file. Format: NLINES filespec The filespec may contain wild card characters, allowing groups of files to be scanned. This is not a standard command and therefore its name cannot be abbreviated. 1 VECCE Invokes the Edinburgh Compatible Context Editor. Formats: V - You are prompted for input and output filenames. V filespec - Edit contents of filespec. Write altered data to a new version of filespec when the edit operation is closed (with the %C command). V file-1/file-2 - Edit contents of file-1. When the edit is closed using %C, the modified data will be written to file-2. An edit may be aborted at any time using CTRL/Y without affecting the contents of the input file. CTRL/C may be used to abort an editor command. If either file-1 or file-2 is omitted, the null device NL: is assumed. The form V /file-2 may therefore be used to create a new file, called file-2. Wild card file specifications may not be used in any case. If VECCE cannot write to an output file, you will be prompted to supply an alternative file name. 2 Commands VECCE commands are completely documented in a document describing this portable text editor, available from the Edinburgh University Computer Science Dept. (See HELP EUCSD). A short summary of the major commands follows. MOVING AROUND ALTERING TEXT INSERTING TEXT SPECIAL COMMANDS F/search-text/ O -overwrite text I/new-text/ %C - Close edit S/substitute-text/ F-/reverse-find/ D/delete-text/ G0 - Get lines of %S=filespec En, E-n - erase text into file, - inlcude text Cursor keys n characters left terminate with from a secondary /right. n=0 from a ':' line. file (by moving Ln Rn cursor to end of over text to be - Left/Right n line. n=1 if included and killing characters. omitted. text to be left out). 0=to end of line $ - Switch between Mn M-n Kn, K-n - delete main/secondary files. - Move forward/ n lines forward/ back n lines. back. n=0 => to PROGRAMMED COMMANDS 0=to end/start end/start of file of file. If If omitted, 1 line. ... - any list of commands is omitted, 1 line. executed left to right. (...) n - command list done n times. (n=0 is till command fails) 1 BE Format: BE directory-spec This command allows the user to make a different directory the current default directory and/or change the current default device. The directory spec may not contain wild cards but may be a logical name. The normal directory brackets [] may be omitted if desired. The form "BE device-name" may be used to alter only the current default device. If the directory-spec is omitted, the user's login default directory is assumed. In any case, if the specified directory does not exist an informational message will be displayed. Examples: BE - return to "home" directory BE ALAN - default directory [ALAN] BE JIM.DOCS.PROPOSALS - go into a subdirectory of [JIM] BE .XYZ - go into subdirectory [XYZ] of the current default directory. BE SYS$SYSDISK - change default directory to the system disk This is not a standard command and therefore its name cannot be abbreviated. 2 Directory_Specification The directory specification which may be used with the BE command consists of a list of directory elements separated by dots "." and optionally enclosed in square brackets [] and preceded by a device specification ("device-name:"). The complete specification taken left to right forms a description of a path to be taken from the current default directory to a new default directory. The supported directory elements are: Null - Indicates the current default directory. Filename - If the filename is the first directory element in a directory specification, it is taken as a subdirectory of the master directory on the current default device. This is normally some user's top directory. E.g. BE SYS$SYSDISK:SYSMGR to set the current default directory to SYS$SYSDISK:[SYSMGR]. If the filename is not the first directory element it indicates the name of a subdirectory of the directory specified by the part of the directory specification to the right of the filename. E.g. BE PROJ.SOURCES where "SOURCES" indicates a subdirectory of another directory, "PROJ". Also BE .ABC where the left hand directory specification is null indicates a subdirectory of the previous default directory. - or ^ Both indicate the directory within which the current directory is nested. E.g. if the current directory specification were SYS$SYSDISK:[TEMPFILES.SORT] the command BE^ will set the default directory string to SYS$SYSDISK:[TEMPFILES] * - An asterisk indicates the user's login directory. E.g. BE *.TEST will set the default directory string to DBA2:[FRED.TEST] if your username is FRED, no matter what the old value of the default directory string was. % - Indicates the top directory of the current default directory string. E.g. if the current default directory string is _CSA1:[MINE.X.Y.Z] then the command BE %.A will change the default directory string to to _CSA1:[MINE.A] 2 Change_UIC The BE command can be used to alter both the User Identification Code (UIC) and default directory string associated with a process in a single operation. Formats: BE (USERNAME,ggg,mmm) If USERNAME is omitted, the username of the current process is assumed. If "ggg" or "mmm" is ommitted, the group or member field of the current UIC is used respectively. The effect of this form of the command is to change the UIC associated with the current process to [ggg,mmm] and set the default directory string to the login default directory for the specified user. Examples: BE (JIM,,) - Set UIC to JIM's UIC and change default directory string to JIM's login default directory (probably [JIM]). BE (,300,1) - Change UIC to [300,1], retaining previous default directory string. 1 CLEAN Format: CLEAN filespec Given a filespec (see HELP SPECIFY FILES), which may contain wild card characters, CLEAN prompts at the user's terminal with the name of each file matching the file specification. In response to the prompt the user may enter a carriage return character to proceed to the next file, or a single letter command to perform some processing on this particular file (e.g. TYPE or DELETE the file). The program will terminate when all files which match the filespec have been processed or when the user enters CONTROL-Z from the keyboard. The command HELP in response to a CLEAN prompt will display a short description of the effect of each command letter. This is not a standard command and therefore its name cannot be abbreviated.