home *** CD-ROM | disk | FTP | other *** search
/ SPACE 2 / SPACE - Library 2 - Volume 1.iso / program / 712 / tcli / tclihelp.dat < prev    next >
Encoding:
Text File  |  1993-06-16  |  33.5 KB  |  967 lines

  1. `ATTRIB`ATTR`CHMOD`
  2.      830
  3. `BG`
  4.     3752
  5. `BUFFER`
  6.     5198
  7. `CAPS`
  8.     5844
  9. `CD`CHDIR`
  10.     6358
  11. `CHKDSK`
  12.     6731
  13. `CLS`
  14.     7350
  15. `CP`COPY`
  16.     7549
  17. `CURSOR`
  18.     9209
  19. `DA`
  20.     9802
  21. `DATE`
  22.    10116
  23. `DIR`LS`
  24.    10587
  25. `ECHO`
  26.    11867
  27. `EDLIN`ED`
  28.    12580
  29. `ERA`ERASE`DEL`DELETE`RM`
  30.    13399
  31. `EXIT`BYE`QUIT`
  32.    14299
  33. `FG`
  34.    14508
  35. `FIND`GREP`
  36.    14677
  37. `FORMAT`
  38.    16277
  39. `FREE`
  40.    17398
  41. `GOTO`
  42.    17935
  43. `IF`
  44.    18558
  45. `LC`
  46.    20054
  47. `LET`
  48.    20529
  49. `MKDIR`
  50.    21347
  51. `MODE`
  52.    21663
  53. `MORE`PAGE`PG`
  54.    22804
  55. `PATH`
  56.    23146
  57. `PAUSE`
  58.    25053
  59. `PRINT`
  60.    25326
  61. `PROMPT`
  62.    25527
  63. `PWD`
  64.    27779
  65. `READ`
  66.    28037
  67. `MV`MOVE`REN`RENAME`
  68.    28534
  69. `RMDIR`
  70.    29646
  71. `SUBST`
  72.    30018
  73. `TIME`
  74.    31494
  75. `TREE`
  76.    32093
  77. `CAT`TYPE`
  78.    32899
  79. `VER`
  80.    33185
  81. `VERIFY`
  82.    33381
  83. ``
  84. Command:  @
  85. Function: Displays and modifies file attribute flags.
  86. Syntax:   @@@@@@ [+A|-A] [+H|-H] [+R|-R] [+S|-S] [path][fname]
  87. Aliases:  ATTRIB, ATTR, CHMOD
  88.  
  89. The ST file system supports four user-modifiable flags for each file/directory.
  90. @@@@@@ allows you to modify these flags.  The "+" sign indicates that the flag
  91. is to be set, and "-" indicates that the flag is to be reset.
  92.  
  93. If no filename is specified, but flags are, TCLI assumes all files in the
  94. current directory on the current drive are to be modified.  If no flags or
  95. filenames are specified, @@@@@@ will display the attributes of the files in the
  96. current directory on the current drive.  The format of the display is
  97.  
  98.    ahrs filename.ext
  99.  
  100. where a, h, r, and s indicate the appropriate flags.  If a letter appears next
  101. to a filename, it indicates that the corresponding flag is set; if, instead, a
  102. dash (-) appears, it indicates that the flag is not set.
  103.  
  104. +A/-A: Archive Flag
  105. -------------------
  106.  
  107. The first flag is the archive bit, which is reset every time a file is written
  108. to.  This is useful when developing a project from a RAMdisk, or when you want
  109. to keep an updated copy of your source code on a floppy.  For example, let's
  110. assume that a project is being developed on drive C, written in C.  This
  111. project spans many files, which we would like to back up on a floppy whenever
  112. we change the source code.  To begin, we would set the archive bits on all of
  113. our source files like this:
  114.  
  115.    @@@@@@ +A C:\SOURCE\*.C
  116.  
  117. At the end of our development session, we would use the COPY command to back up
  118. only those files that have been modified, by using this command:
  119.  
  120.    COPY C:\SOURCE\*.C A:\BACKUP\ /R
  121.  
  122. This tells TCLI to copy all unarchived .C files from C:\SOURCE\ to the \BACKUP
  123. directory on drive A, and to reset the archive bits of those files that were
  124. successfully backed up.  (See the COPY command description for more
  125. information)
  126.  
  127. +H/-H: Hidden Flag
  128. ------------------
  129.  
  130. The hidden flag determines whether the file specified should be visible to the
  131. normal directory search.  If a file is hidden (+H), TCLI will not display it in
  132. its directory listing; however, it can still be accessed by TCLI commands, and
  133. by most other programs.  The GEM desktop doesn't support the hidden flags, so
  134. these files will still appear in the desktop window.
  135.  
  136. +R/-R: Read-only Flag
  137. ---------------------
  138.  
  139. The read-only flag enables the user to write-protect the file(s) specified by
  140. setting the read-only bit.  When a write is attempted to a read-only file, an
  141. "access denied" error message is returned.  To regain write access to the file,
  142. you must reset the read-only bit.
  143.  
  144. +S/-S: System File Flag
  145. -----------------------
  146.  
  147. The system file flag, for all practical purposes, performs the same task as the
  148. hidden flag.  As with the hidden flags, the GEM desktop does not support the
  149. system file flags.
  150. `
  151. Command:  BG
  152. Function: Changes/displays the background color.
  153. Syntax:   BG [color]
  154.  
  155. The default color configuration of TCLI is white text on a black background.
  156. These colors can easily be changed to any of the 512 colors that the ST
  157. supports.  The BG command is used to change the background, while FG is used to
  158. change the foreground (text) color (see below).
  159.  
  160. BG accepts either a named color that is predefined within TCLI, or a
  161. three-character string of the form "RGB", where R, G, and B are digits between
  162. "0" and "7", inclusive.  R, G, and B indicate level of the red, green, and blue
  163. color components, with "0" being the absence of that color, and "7" being the
  164. maximum presence of the respective color.
  165.  
  166. The predefined colors that BG recognizes are as follows:
  167.  
  168.     Aqua                     Green
  169.     Black                    LightBlue
  170.     Blue                     Orange
  171.     Brown                    Pink
  172.     DarkBlue                 Purple
  173.     DarkRed                  Red
  174.     ForestGreen (Forest)     White
  175.     Gray (Grey)              Yellow
  176.  
  177. The names in parentheses indicate alternative names for the respective colors.
  178.  
  179. If BG is executed without a parameter, it will display the current RGB
  180. settings.
  181.  
  182. Examples:
  183.  
  184.     BG WHITE
  185.     BG 777
  186.  
  187. These two commands both set the background color to white.  If the BG command
  188. were then executed without parameters, TCLI would display:
  189.  
  190.     BG = 777
  191. `
  192. Command:  BUFFER
  193. Function: Toggles keyboard buffering on/off.
  194. Syntax:   BUFFER [ON|OFF]
  195.  
  196. This command toggles the keyboard buffering.  When it is OFF, TCLI intercepts
  197. all keyboard input, and provides protection against accidentally exiting TCLI
  198. by pressing CONTROL-C.  However, keystrokes are not buffered; you have to wait
  199. until the current process is finished before you can enter the next command.
  200.  
  201. When BUFFER is ON, the keyboard input is buffered, but pressing CONTROL-C while
  202. anything is being displayed on the screen will abort TCLI, with no questions
  203. asked.
  204.  
  205. Using BUFFER with no parameters displays the current setting.
  206. `
  207. Command:  CAPS
  208. Function: Turns the uppercase conversion of characters on/off.
  209. Syntax:   CAPS [ON|OFF]
  210.  
  211. This command allows you to change whether TCLI capitalizes your input or not.
  212. This can be useful when you're dealing with variables and don't care if the
  213. output of the ECHO command is capitalized or not.
  214.  
  215. When CAPS is ON, all input is capitalized; when it's off, the command line
  216. parameters for certain commands (ECHO, etc.) is left unchanged.
  217.  
  218. Using CAPS by itself displays the current setting.
  219. `
  220. Command:  @
  221. Function: Changes the current working directory.
  222. Syntax:   @ path
  223. Alias:    CD, CHDIR
  224.  
  225. The @@@@@ command changes the current directory for the specified drive, or the
  226. current drive if none is specified.  The current directory can be displayed by
  227. using the PWD command (see below), or by using the $P option in the command
  228. prompt (see PROMPT below).
  229. `
  230. Command:  CHKDSK
  231. Function: Displays information on the drive specified.
  232. Syntax:   CHKDSK [n:]
  233.  
  234. The CHKDSK command displays information about the disk specified, or the
  235. current disk.  The first item it displays is the disk size; this is the total
  236. amount of storage space on the disk (in bytes).  Next, it displays the number
  237. of hidden files, directories, and user files, as well as separate totals of the
  238. number of bytes in each of these groups.  Next, the number of bytes available
  239. on the disk is displayed, and finally, the total amount of RAM in the computer
  240. and the total amount of free RAM available.
  241. `
  242. Command:  CLS
  243. Function: Clears the screen.
  244. Syntax:   CLS
  245.  
  246. The CLS command can be used to clear the screen.  It is especially useful after
  247. a batch file has executed, to clean up the display.
  248. `
  249. Command:  @
  250. Function: Copies/moves files from one place to another.
  251. Syntax:   @@@@ [n:][path]from [[n:][path]to] [/A|/R] [/M]
  252. Alias:    COPY, CP
  253.  
  254. The @@@@ command copies or moves files from one location to another.  In the
  255. simplest case, one file is copied directly to another place:
  256.  
  257.    @@@@ EXECS\FILE.DAT B:\
  258.  
  259. When a single file is copied, it can also be renamed in the process:
  260.  
  261.    @@@@ EXECS\FILE.DAT B:\NEWFILE.DAT
  262.  
  263. Wildcards may be specified in the source, but in this case, the destination
  264. must be ONLY a path name, so renaming is not possible:
  265.  
  266.    @@@@ EXECS\*.C B:\FILES\
  267.  
  268. The following command will copy all files in the C:\EXECS directory to the
  269. current directory on the B drive:
  270.  
  271.    @@@@ EXECS\*.* B:
  272.  
  273. By using the /A option, @@@@ will only copy files that do not have their
  274. archive bit set (see ATTRIB).
  275.  
  276. By using the /R option, @@@@ will only copy files whose archive bit is not set,
  277. but it will then set the archive bit if the copy was successful.  If the /R
  278. option is used, the /A option does not have to be specified.  For example, to
  279. archive all files under C:\SOURCE onto the current directory on drive B:,
  280. automatically flagging the archived files as archived, this command would be
  281. used:
  282.  
  283.    @@@@ C:\SOURCE\ B: /R
  284.  
  285. The /M option is used to move files from one disk to another.  The specified
  286. files are copied to the new disk, then deleted from the old one if the copy was
  287. successful.  This option can be combined with the /A option, or, equivalently
  288. in this case, the /R option.
  289.  
  290. The following example will move all .C files from C:\SOURCE to D:\SOURCE:
  291.  
  292.    @@@@ C:\SOURCE\*.C D:\SOURCE\ /M
  293. `
  294. Command:  CURSOR
  295. Function: Defines the flash rate for the cursor.
  296. Syntax:   CURSOR [x]      (where "x" is an integer between 1 and 255)
  297.  
  298. To make the cursor flash, use the CURSOR command.  By entering a number between
  299. 1 and 255, the cursor will start flashing at the desired rate (which depends on
  300. your monitor).  The lower the number, the faster the cursor will flash.  To
  301. stop the cursor from flashing, enter the CURSOR command with no parameters.
  302.  
  303. NOTE:  Sometimes there is a delay between the execution of this command
  304.        and the actual change in the cursor's flash rate.
  305. `
  306. Command:  DA
  307. Function: Allows access to Desk Accessories.
  308. Syntax:   DA
  309.  
  310. This command allows you to access desk accessories. When you invoke DA, the
  311. screen is cleared, and a menu bar appears at the top of the screen.  Run the
  312. appropriate desk accessory, then choose "Return to TCLI" to exit back to TCLI.
  313. `
  314. Command:  DATE
  315. Function: Displays/sets the system date.
  316. Syntax:   DATE [month-day-year]
  317.  
  318. To display the system date, enter the DATE command with no parameters.  To set
  319. the system date, specify the date in the format described above.  The day and
  320. month can be any valid day and month, and the year can be in either a two-digit
  321. or four-digit format.  The following two commands set the date to February 1,
  322. 1993:
  323.  
  324.    DATE 2-1-1993
  325.         and
  326.    DATE 2-1-93
  327. `
  328. Command:  @
  329. Function: Displays a directory of files on a disk.
  330. Syntax:   @ [n:][path][fname] [/P] [/W]
  331. Alias:    DIR, LS
  332.  
  333. To display a listing of the files on a disk (or in a directory), use the @@@
  334. command.
  335.  
  336. The default directory will be displayed in a format that displays the filename,
  337. extension, size, and time and date of creation or last modification.  This
  338. listing will be sorted first on the file's extension, and secondly on the
  339. filename.  At the end of the directory, the number of files and the amount of
  340. free space on the disk are displayed.
  341.  
  342. If a filename is specified, the directory will be scanned for files matching
  343. the filename; wildcards are, of course, permitted.  Only files matching the
  344. specified name will be displayed.  For example, the following command will
  345. display all filenames in C:\SOURCE\ ending in .C:
  346.  
  347.    @ C:\SOURCE\*.C
  348.  
  349. If the /P option is specified, the directory contents are displayed one
  350. screenful at a time.  When the screen fills up, you will be told to press any
  351. key to continue; do so, and the next page will be displayed.
  352.  
  353. If the /W option is specified, the directory is displayed in a compressed
  354. format.  Only the filenames are displayed; directories are identified by a
  355. backslash (\) before their names.
  356. `
  357. Command:  ECHO
  358. Function: Turns batch command echo on or off; displays messages.
  359. Syntax:   ECHO [ON|OFF|Message]
  360.  
  361. The ECHO command is used to turn off or turn on the display of batch file
  362. commands as they are executed.  To supress the display of batch file commands,
  363. use ECHO OFF; to resume display of the commands, use ECHO ON.
  364.  
  365. If anything other than ON or OFF is passed into ECHO as a parameter, that
  366. string is displayed on the screen.  If no parameters are specified, a blank
  367. line is printed.  This can be useful in a batch file to keep the user updated
  368. on what is happening; enter "ECHO ON" as the first line in the batch file, then
  369. use subsequent ECHO commands to display status information.
  370. `
  371. Command:  @
  372. Function: Allows the user to create a line-oriented text file.
  373. Syntax:   @ [n:][path]fname
  374. Alias:    ED, EDLIN
  375.  
  376. The @@@@@ command can be used to create a short text file from within TCLI (to
  377. create large files or to edit existing files, use a full-fledged text editor).
  378. @@@@@ will only accept lines up to 78 characters as input to the file.  The
  379. current line can be edited by using BACKSPACE on that line; once RETURN is
  380. pressed, however, the line is added to the file.  To end @@@@@, press RETURN on
  381. a blank line.
  382.  
  383. If the file specified exists, you will be asked if you want to overwrite the
  384. file; enter 'Y' (or 'y') to overwrite it and create a new file, or anything
  385. else to abort @@@@@.
  386.  
  387. @@@@@ is of most use as a quick editor when creating short batch files or very
  388. small programs.
  389. `
  390. Command:  @
  391. Function: Removes the file(s) specified from a disk.
  392. Syntax:   @ [n:][path]fname
  393. Aliases:  ERA, ERASE, DELETE, DEL, RM
  394.  
  395. To erase a file or group of files, use the @@@@@@ command.  @@@@@@ does not
  396. prompt you before deleting files unless you are deleting all files on a disk or
  397. in a directory (i.e., "@@@@@@ *.*"), so be sure that you do want to delete the
  398. files before you press RETURN.
  399.  
  400. It is a good idea to have an "unerase" utility around, in case you do
  401. accidentally erase a file you need.  If you do inadvertently erase a file, DO
  402. NOT write to the disk!  If you write to the disk after deleting a file, the
  403. file will probably be rendered unrecoverable.
  404.  
  405. If you attempt to erase all the files in a directory, @@@@@@ will ask you if
  406. you're sure you want to do that.  If you do, enter "Y" or "y", and the files
  407. will be erased; otherwise, the @@@@@@ will be aborted.
  408. `
  409. Command:  @
  410. Function: Returns to the program that called TCLI.
  411. Syntax:   @
  412. Aliases:  BYE, EXIT, QUIT
  413.  
  414. To leave TCLI and return to the desktop (or whatever program called TCLI), use
  415. the @@@@ command.
  416. `
  417. Command:  FG
  418. Function: Sets/displays the foreground (text) color.
  419. Syntax:   FG [color]
  420.  
  421. The FG command sets TCLI's text color.  It works exactly the same as BG.
  422. `
  423. Command:  @
  424. Function: Searches the file(s) specified for the indicated search term.
  425. Syntax:   @ "string" [n:][path]fname
  426. Alias:    FIND, GREP
  427.  
  428. The @@@@ command is provided to search through line-oriented text files for a
  429. specific search term.  Only the first 128 characters in each line is actually
  430. searched; this should pose no problem for the average text file.
  431.  
  432. @@@@ displays each occurence of the search term in the file by displaying the
  433. line number and the line itself.  It then displays the total number of
  434. occurences of the string in the file.  The search is not case-sensitive, since
  435. @@@@ converts everything to upper-case as it searches for the string.
  436.  
  437. By using wildcard characters, a group of files can be searched for the string.
  438. In this case, @@@@ displays the name of each file being searched, the lines in
  439. which the search term is found, the total number of occurences of the string
  440. within each file, and finally, the total number of occurences found within the
  441. group of files.
  442.  
  443. As an example, suppose you want to search all Pascal source files in the
  444. current directory for the term "PROCEDURE".  You would enter a command like
  445. this:
  446.  
  447.    @@@@ "Procedure" *.PAS
  448.  
  449. It is often useful to redirect the output of the @@@@ command to a disk file or
  450. the printer.  To redirect output to a file called "PROC.FND", for example, you
  451. would enter:
  452.  
  453.    @@@@ "Procedure" *.PAS >PROC.FND
  454.  
  455. Having done that, you can browse through the file, display it using the TYPE
  456. command, or print it out.  See the section on I/O Redirection for information
  457. on how to do this.
  458. `
  459. Command:  FORMAT
  460. Function: Format a floppy disk.
  461. Syntax:   FORMAT [n:] [/T:tracks] [/N:sectors] [/1]
  462.  
  463. The FORMAT command is used to format a floppy disk.  By specifying the number
  464. of tracks (80-82) and the number of sectors per track (9-11), you can generate
  465. a variety of disk formats for the ST.  The default format uses both sides of
  466. the disk, 80 tracks, and 10 sectors per track, yielding approximately 800K of
  467. storage space per disk.  These defaults can be changed by using the "/T:"
  468. option to specify tracks, "/N:" to specify sectors per track, and "/1" to force
  469. a single-sided format.  For example, to format a disk in drive A to 80 tracks,
  470. 9 sectors per track, single sided, you would enter:
  471.  
  472.    FORMAT A: /N:9 /1
  473.  
  474. To format the same disk to double-sided, simply leave off the "/1":
  475.  
  476.    FORMAT A: /N:9
  477.  
  478. To format a disk to 81 tracks, 11 sectors per track (not a recommended format,
  479. but possible), use the following:
  480.  
  481.    FORMAT A: /T:81 /N:11
  482.  
  483. Be aware that formatting a disk will erase everything on it.  To help guard
  484. against this, TCLI will prompt you when you try to format a disk.
  485. `
  486. Command:  FREE
  487. Function: Toggles the display of disk free space for DIR command.
  488. Syntax:   FREE [ON|OFF]
  489.  
  490. This command allows you to turn off the display of free space in the DIR
  491. command.  When you execute the DIR command, the amount of free space left on
  492. the disk is displayed.  This causes a delay while the computer tries to figure
  493. out how much space is left, especially if the disk is a floppy.  Turn this
  494. feature off with the FREE OFF command.
  495.  
  496. If FREE is invoked with no parameters, the current setting is displayed.
  497. `
  498. Command:  GOTO
  499. Function: Goes to a specified line in a batch file.
  500. Syntax:   GOTO label
  501.  
  502. This command, executable only from within a batch file, transfers execution of
  503. the batch file to the specified label.  The label must exist somewhere in the
  504. batch file, on a line by itself, preceded only by a colon (":").
  505.  
  506. In the following batch file, the ECHO statement is never executed:
  507.  
  508.    REM Batch file starts here...
  509.    GOTO CONT
  510.    ECHO This is never displayed.
  511.    :CONT
  512.    REM Batch file continues here...
  513.  
  514. Obviously, this command is most useful with a conditional statement (see the IF
  515. command, below).
  516. `
  517. Command:  IF
  518. Function: Allows conditional execution of commands.
  519. Syntax:   IF [NOT] expression command
  520.  
  521. This command, only available from within batch files, allows the batch file to
  522. conditionally execute commands.
  523.  
  524. The "expression" statement must be one of these two forms:
  525.  
  526.    string1==string2
  527.          or
  528.     exist filename
  529.  
  530. For example, the COPY command below is executed ONLY if the source file exists,
  531. and the destination file doesn't exist:
  532.  
  533.    if not exist c:file.dat goto no_copy
  534.    if exist a:file.dat goto no_copy
  535.    copy c:file.dat a:
  536.    goto continue
  537.    :no_copy
  538.    echo Error - Source doesn't exist, or destination does exist.
  539.    :continue
  540.    rem Batch file continues here.
  541.  
  542. You can also compare strings with IF, which will substitute any variables that
  543. are included:
  544.  
  545.    :loop
  546.    echo 1. ST-Writer
  547.    echo 2. Personal Pascal
  548.    echo 3. Laser C
  549.    echo
  550.    echo Enter your choice:
  551.    read c
  552.    if %C==1 goto do_stwriter
  553.    if %C==2 goto do_pascal
  554.    if %C==3 goto do_laserc
  555.    if %C==4 goto end
  556.    echo Bad choice! Try again.
  557.    goto loop
  558.    :do_stwriter
  559.    cd \stwriter
  560.    stwriter
  561.    goto loop
  562.    :do_pascal
  563.    cd \pascal
  564.    pascal
  565.    goto loop
  566.    :do_laserc
  567.    cd \laser_c
  568.    laser
  569.    goto loop
  570.    :end
  571.    echo Later, dude!
  572.  
  573. Note that the variable name "C" MUST be capitalized when the CAPS option is
  574. turned off; if CAPS is ON, there will be no problem if it is not capitalized,
  575. since TCLI will capitalize it for you.
  576. `
  577. Command:  LC
  578. Function: Returns a line count of the file(s) specified.
  579. Syntax:   LC [n:][path]fname
  580.  
  581. The LC command can be used to count lines in text files.  This is useful when
  582. developing a large project that spans several files; you can simply use the
  583. command
  584.  
  585.    LC *.C
  586.  
  587. to count the number of lines of source code you have in your project.  LC will
  588. display line counts for each file matching the filename, then it will give a
  589. cumulative total at the end.
  590. `
  591. Command:  LET
  592. Function: Assigns a value to a variable.
  593. Syntax:   LET x=[string]
  594.  
  595. This command allows a variable to be changed.  There are twenty-six available
  596. variables, the letters A through Z.  It doesn't matter in the LET command
  597. whether the variable name is capitalized.  However, it DOES matter when the
  598. variable name is used elsewhere.
  599.  
  600. The following batch file illustrates the use of the LET command.
  601.  
  602.    echo What's your first name?
  603.    read f
  604.    echo What's your last name?
  605.    read l
  606.    let n=%F %L
  607.    echo Your name must be %N!
  608.  
  609. Notice that when the variables are referenced, they MUST be capitalized.
  610.  
  611. Variables are global; once they are set to a value, other batch files can
  612. access the variable's value.  This is a convenient way to pass values back and
  613. forth between batch files.
  614. `
  615. Command:  MKDIR
  616. Function: Creates a directory.
  617. Syntax:   MKDIR [n:][path]dirname
  618.  
  619. To create a directory on a disk, use the MKDIR command.  Give the new directory
  620. name as a parameter, and, if possible, the new directory will be created on the
  621. drive specified, or on the current drive, if none is specified.
  622. `
  623. Command:  MODE
  624. Function: Switches between low and high resolution.
  625. Syntax:   MODE [40|80]
  626.  
  627. If you will be using a low-resolution drawing program, or any other program
  628. that only runs in low resolution, you will have to switch to low resolution at
  629. the desktop, then run TCLI.  But a command line interpreter is not well suited
  630. to a 40-column display; the screen tends to get cluttered, and text files can't
  631. be viewed correctly.  TCLI solves this problem by enabling you to switch to
  632. another resolution, without changing the "actual" resolution of the system.  To
  633. do this, use the desktop to switch to low resolution.  Next, run TCLI, and
  634. enter this command:
  635.  
  636.    MODE 80
  637.  
  638. When you do, the screen should be switched to high resolution.  But the ST is
  639. not really in high-res mode; only text-based .TOS and .TTP programs will run in
  640. high resolution.  .PRG programs will revert back to low resolution, so you
  641. could then run your drawing package, then exit back to TCLI in high
  642. resolution.
  643.  
  644. You can also switch to low resolution from high by entering "MODE 40", but all
  645. .PRG programs will still execute in high resolution.
  646. `
  647. Command:  @
  648. Function: Displays a text file, one screenful at a time.
  649. Syntax:   @ [n:][path]fname
  650. Aliases:  MORE, PAGE, PG
  651.  
  652. The @@@@ command allows the user to view a text file, one screen at a time.
  653. When the screen fills up, a message telling you to strike a key will appear.
  654. Press any key, and more of the file will be displayed.
  655. `
  656. Command:  PATH
  657. Function: Specifies a path to be searched for programs.
  658. Syntax:   PATH [path;][path;]...[path]
  659.  
  660. When an unknown command is entered into TCLI, it looks in the current directory
  661. for the file.  If it is not found there, it will search through the directories
  662. contained in PATH to find the program.
  663.  
  664. PATH defaults to ";", which is the null path, indicating that no path other
  665. than the current one should be checked.  If you have a directory called EXECS
  666. on drive C, in which some executable programs are stored, you can enter
  667.  
  668.    PATH C:\EXECS\
  669.  
  670. and TCLI will search that directory every time it fails to find a program in
  671. the current directory.  If you have several directories, you could enter:
  672.  
  673.    PATH C:\EXECS\;C:\FILES\
  674.  
  675. Each of these directories will be searched when a program is not found in the
  676. current directory.
  677.  
  678. If you have an existing path and would like to append directories to it, enter
  679. a semicolon (;) before the first path in it.  For example, if we had executed
  680. the last example above, and we wanted to add "C:\EDITORS\" to our search path,
  681. we would enter
  682.  
  683.    PATH ;C:\EDITORS\
  684.  
  685. and our path would now be
  686.  
  687.    C:\EXECS\;C:\FILES\;C:\EDITORS\
  688.  
  689. If you will always be working with one drive, you can omit the drive letters
  690. and colons from the path names; however, if you will be using other drives, it
  691. is a good idea to leave the drive names in place.  This is because, if no drive
  692. is specified, TCLI will search through the PATH directories using the current
  693. drive; if another drive is made to be the current drive, then the paths
  694. probably won't exist there, and you'll get an error message.
  695.  
  696. To display the current PATH, enter PATH with no parameters.
  697.  
  698. NOTE: Although programs can be executed from the alternate paths, their
  699.       resource files, data files, etc., can only be accessed if they are
  700.       in the CURRENT directory.
  701. `
  702. Command:  PAUSE
  703. Function: Pauses a batch file, asking the user to press a key.
  704. Syntax:   PAUSE
  705.  
  706. This command enables a batch file to stop execution, and wait for the user to
  707. press any key.  When the user presses a key, the batch file continues where it
  708. left off.
  709. `
  710. Command:  PRINT
  711. Function: Print a file on the printer.
  712. Syntax:   PRINT filename
  713.  
  714. This command prints the specified file on the printer.  It is functionally
  715. equivalent to "TYPE filename >PRN:"
  716. `
  717. Command:  PROMPT
  718. Function: Changes the command prompt.
  719. Syntax:   PROMPT [string]
  720.  
  721. The PROMPT command enables the user to customize the TCLI prompt.  The default
  722. prompt is the current drive followed by a greater-than sign (">"), but PROMPT
  723. allows this to be modified to include the time, date, current path, and other
  724. items.
  725.  
  726. The prompt string can contain any text the user wants; the following control
  727. characters serve special purposes and display the data indicated:
  728.  
  729.     $b     "|" character
  730.     $d     Date
  731.     $e     ESC
  732.     $h     Backspace
  733.     $g     ">" character
  734.     $l     "<" character
  735.     $n     Current drive
  736.     $p     Current directory
  737.     $q     "=" character
  738.     $t     Current time
  739.     $v     TCLI version
  740.     $$     "$" character
  741.     $X     CR/LF (where "X" is any character other than those listed above)
  742.  
  743.  
  744. If no string is specified, the prompt is reset to the default string.
  745.  
  746. PROMPT Examples:
  747. ---------------
  748.  
  749.    Prompt String                      Prompt Displayed
  750.    -------------                      ----------------
  751.  
  752.    $n:$p\                             C:\CURRENT\PATH\
  753.    $p$g                               \CURRENT\PATH>
  754.    It's $t, okay?                     It's 1:30:10 PM, okay?
  755.    It's $t on$x$d. The current$x      It's 1:30:10 PM on
  756.       path is $n:$p\ $g               7-20-1992. The current
  757.                                       path is C:\CURRENT\PATH\ >
  758.  
  759. By using "$e" (ESC) in the command line, you can access the ST's built-in VT52
  760. emulator routines.  To see "$e" in action, try the following command:
  761.  
  762.    prompt $ej$eH$epDrive: $n:  Path: $p\  Time: $t  Date: $d$eK$eq$ek==$g
  763.  
  764. This command changes the command prompt to display the current drive, path,
  765. time and date at the top of the screen, in reverse video.  It works like this:
  766. "$ej" saves the current cursor position, "$eH" takes the cursor to the home
  767. position, without clearing the screen, and "$ep" causes all text to be
  768. displayed in reverse video.  The text string, along with the PROMPT variables,
  769. is then displayed.  "$eK" clears the rest of the line, "$eq" restores normal
  770. video output, "$ek" returns the cursor to its saved position, and the prompt
  771. that is displayed is changed to "==>".
  772. `
  773. Command:  PWD
  774. Function: Displays the current directory.
  775. Syntax:   PWD [n:]
  776.  
  777. To display the current directory of a disk drive, use the PWD command.  This is
  778. of most use when you don't have the prompt set up to display the current
  779. working directory.
  780. `
  781. Command:  READ
  782. Function: Allows a batch file to read input from the user.
  783. Syntax:   READ x
  784.  
  785. This command reads input from the user, from within a batch file.  It assigns
  786. whatever the user enters to the variable specified; variables are simply
  787. letters of the alphabet.  When used with the READ command, variable names do
  788. not have to be capitalized.
  789.  
  790. Variable names are global, so once a variable has been set, other batch files
  791. can use the same variable, with its contents unchanged.
  792. `
  793. Command:  @
  794. Function: Renames a file.
  795. Syntax:   @ [n:][path][fname]
  796. Aliases:  MOVE, MV, REN, RENAME
  797.  
  798. The @@@@@@ command allows the user to rename a file on disk.  Wildcards are not
  799. allowed; only one specific file can be renamed at one time.
  800.  
  801. For example, the following command renames the file "C:\PATH\FILE.DAT" to
  802. "NEWFILE.DAT":
  803.  
  804.    @@@@@@ C:\PATH\FILE.DAT NEWFILE.DAT
  805.  
  806. Note that the second filename does not need the drive or path specified to
  807. perform a rename.
  808.  
  809. The @@@@@@ command can also be used to move a file from one directory to
  810. another.  To do this, simply specify the destination path (with respect to the
  811. current directory) along with the second filename.  Even in this case, the
  812. second filename is REQUIRED!  The following command moves the file "FILE.DAT"
  813. from \PATH\ to \NEWPATH\FILES\:
  814.  
  815.    @@@@@@ \PATH\FILE.DAT \NEWPATH\FILES\FILE.DAT
  816.  
  817. The file can, of course, be renamed in the course of a move:
  818.  
  819.    @@@@@@ \PATH\FILE.DAT \NEWPATH\FILES\NEWFILE.DAT
  820.  
  821. This command can not be used to move files between disks; see the COPY command
  822. for details on how to do that.
  823. `
  824. Command:  RMDIR
  825. Function: Deletes an empty directory.
  826. Syntax:   RMDIR [n:][path][dirname]
  827.  
  828. The RMDIR command allows the user to delete empty directories.  If this command
  829. is attempted on a directory that contains files, an error (access denied) will
  830. be returned.
  831.  
  832. For example, to remove a directory called "C:\FILES\SUBDIR", enter:
  833.  
  834.    RMDIR C:\FILES\SUBDIR
  835. `
  836. Command:  SUBST
  837. Function: Allows the substitution of paths by drive letters.
  838. Syntax:   SUBST [n:] [[n:]path]
  839.  
  840. The SUBST command allows the user to replace commonly used path names by a
  841. simple drive letter.  For example, suppose a user wants to easily access files
  842. under a directory called "\SOURCE\FILES\" on drive C.  The following command
  843. could be entered:
  844.  
  845.    SUBST Z: C:\SOURCE\FILES\
  846.  
  847. and from then on, the files under that directory could be accessed as Z:fname.
  848. If a file called "FILE.DAT" existed under this directory, it could then be
  849. accessed as "Z:FILE.DAT".  The command
  850.  
  851.    COPY Z:FILE.DAT B:
  852.  
  853. would copy the file C:\SOURCE\FILES\FILE.DAT to the current directory on drive
  854. B:.
  855.  
  856. The substitutions are performed internally by TCLI, before parameters are
  857. passed to the called program.  This way, if the filename "Z:FILE.DAT" is
  858. entered as a parameter to an external program, the actual filename (i.e.,
  859. "C:\SOURCE\FILES\FILE.DAT") would be passed to the program.  Substitutions are
  860. not valid within any called programs, however; a "drive not valid" error will
  861. likely be returned if an attempt is made to access a SUBSTituted drive.
  862.  
  863. If no drive is specified, the current drive is inserted into the substituted
  864. filename.
  865.  
  866. The CD command can not be use with a SUBSTituted drive; using it shouldn't
  867. cause any problem, but no error indicating that it failed will be returned.
  868.  
  869. To release a substituted drive, simply enter "SUBST n:".
  870. `
  871. Command:  TIME
  872. Function: Displays/sets the current time.
  873. Syntax:   TIME [[h]h:mm[:ss] [AM|PM]]
  874.  
  875. The TIME command is used to set the computer's internal clock.  At least one
  876. "hours" digit is necessary, as well as both "minutes" digits; seconds are
  877. optional, as is an AM/PM designation.  If neither AM nor PM is specified, the
  878. time is interpreted in a twenty-four hour format.  Examples:
  879.  
  880.    TIME 1:30 PM
  881.    TIME 01:30:00 PM
  882.    TIME 13:30
  883.    TIME 13:30:00
  884.  
  885. All four of these commands set the clock to 1:30 PM.
  886.  
  887. If TIME is entered with no parameters, the current time is displayed.
  888. `
  889. Command:  TREE
  890. Function: Displays a directory tree of the disk/directory specified.
  891. Syntax:   TREE [n:][path] [/F]
  892.  
  893. The TREE command is used to display a visual interpretation of the directory
  894. structure on a disk.  If no drive is specified, the current drive is used.  If
  895. no path is specified, the tree display begins with the current path on the
  896. drive being scanned.
  897.  
  898. By default, the TREE command will display only the directories that it
  899. encounters during its disk traversal.  To force TREE to also display files
  900. contained in the directories, specify the "/F" option.
  901.  
  902. This command displays the directory structure under the current directory on
  903. drive C:
  904.  
  905.    TREE C:
  906.  
  907. This command displays drive C:'s entire directory structure, regardless of the
  908. current directory:
  909.  
  910.    TREE C:\
  911. `
  912. Command:  @
  913. Function: Displays a file on the screen.
  914. Syntax:   @ [n:][path][fname]
  915. Alias:    CAT, TYPE
  916.  
  917. The @@@@ command is used to display the contents of a text file.  Wildcards can
  918. be specified; each file matching the wildcard specification will be display on
  919. the screen.
  920. `
  921. Command:  VER
  922. Function: Display the version of TCLI.
  923. Syntax:   VER
  924.  
  925. The VER command simply displays the version number of TCLI, and the amount of
  926. installed and free RAM on your computer.
  927. `
  928. Command:  VERIFY
  929. Function: Toggles the Write Verify feature on/off.
  930. Syntax:   VERIFY [ON|OFF]
  931.  
  932. By default, when the ST writes a sector to a disk, it immediately reads that
  933. sector back into memory, and compares it to the one it just wrote.  If they
  934. match byte for byte, then the sector was successfully written.  This is the
  935. ST's way of verifying that files are correctly written to the disk.  Bad
  936. sectors are, fortunately, a rare occurrence.
  937.  
  938. The TOS Command Line Interpreter offers you the option to turn off the
  939. write-verify feature, which will result in noticeably faster disk writes, at
  940. the expense of some reliability.  Since disk write errors are so rare, turning
  941. write-verify off can usually result in better productivity.
  942.  
  943. To turn off write-verify, use the command VERIFY OFF; to turn it back on, enter
  944. VERIFY ON.
  945. `
  946.  
  947.  
  948.  
  949.  
  950.  
  951.  
  952.  
  953.  
  954.  
  955.  
  956.  
  957.  
  958.  
  959.  
  960.  
  961.  
  962.  
  963.  
  964.  
  965.  
  966.  
  967.