home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / editors / hypsh40a.arj / HYPOP.LZH / MSDOS.HYP < prev    next >
Text File  |  1991-04-22  |  29KB  |  1,052 lines

  1. .REMARK
  2. MSDOS Hyperfile copyright (c) N.G.Taylor 1989
  3. .
  4. .HEADER
  5.  $1 - $2   ~C639 ~NMSDOS~K9~E
  6. ═════════════════════════════════════════════════════════════════════════════
  7. .
  8.  
  9. .FOOTER
  10. ~L20═════════════════════════════════════════════════════════════════════════════
  11. 1 ~MGeneral~K1~E 2 ~MDisk~K2~E 3 ~MDirectories~K3~E 4 ~MFiles~K4~E 5 ~MScreen~K5~E 6 ~MPrinter~K6~E 7 ~MBatch~K7~E 8 ~ADOS Terms~PN@MDOS Terms~K8~E
  12. .
  13. .CHECK +fa
  14.  
  15. .INDEX
  16. indicate that index is required
  17.  
  18. .
  19. .MENU Disk
  20. ASSIGN
  21. CHKDSK
  22. DISKCOMP
  23. DISKCOPY
  24. FORMAT
  25. LABEL
  26. SYS
  27. VERIFY
  28. VOL
  29. .
  30.  
  31. .MENU General
  32. BREAK
  33. DATE
  34. KEYBUK
  35. PATH
  36. PROMPT
  37. SET
  38. TIME
  39. VER
  40. .
  41. .MENU Screen
  42. CLS
  43. CTTY
  44. MODE
  45. .
  46.  
  47. .MENU Printer
  48. GRAPHICS
  49. PRINT
  50. .
  51.  
  52. .MENU Directories
  53. CHDIR
  54. DIR
  55. JOIN
  56. MKDIR
  57. RMDIR
  58. SUBST
  59. TREE
  60. XCOPY
  61. .
  62.  
  63. .MENU Files
  64. APPEND
  65. ATTRIB
  66. COMP
  67. COPY
  68. DEL
  69. EDLIN
  70. ERASE
  71. FIND
  72. MORE
  73. RENAME
  74. REPLACE
  75. SORT
  76. TYPE
  77. .
  78.  
  79. .MENU Batch
  80. ECHO
  81. IF
  82. GOTO
  83. FOR
  84. PAUSE
  85. REM
  86. Parameter
  87. SHIFT
  88. .
  89.  
  90. .CHECK -fa
  91.  
  92. .
  93. .MENU DOS Terms
  94. Environment variable
  95. ASCII
  96. Internal command
  97. External command
  98. Filespec
  99. Wildcard
  100. Subdirectory
  101. Root directory
  102. Default directory
  103. Default drive
  104. Status code
  105. Filter
  106. .
  107. .NOTE Help
  108. Use TAB or cursor keys to move.
  109. LEFT Mouse button or RETURN is
  110.  used for selection of an item.
  111. RIGHT button or ESCAPE key is
  112.  used to select the control menu
  113. Press F10 to exit
  114. .
  115.  
  116. .NOTE Filespec
  117.  
  118. This should take the form
  119.  
  120. [d:][\][path\][filename.filetype]
  121.  
  122. Where filename can be up to 8
  123. characters and filetype can be up
  124. to 3 characters.
  125. .
  126.  
  127. .NOTE MSDOS
  128. This document describes the commands
  129. available under MSDOS version 3.2
  130. .
  131.  
  132. .NOTE Filter
  133. A filter is a program which reads from
  134. its standard input and writes to its
  135. standard output. Input and output can
  136. be redirected to/from a file or piped
  137. to/from another program. e.g.
  138.  
  139. FILTERPROG < INPUT.FIL > OUTPUT.FIL
  140.  
  141. PROGRAM1 | FILTERPROG | PROGRAM2
  142. .
  143. .NOTE Status Code
  144. Sometimes referred to as the exit code
  145. this code is the value returned to DOS
  146. by a program when it terminates. It may
  147. be tested using the batch ~FIF~E command.
  148. The success status is normally 0.
  149. .
  150. .NOTE Root directory
  151. The Root directory is the highest level
  152. directory in the directory structure on
  153. a disk. The pathname symbol '\' at the
  154. start of a pathname indicates the root
  155. node in the hierarchy, the rest of the
  156. pathname being relative to this.
  157. .
  158. .NOTE Subdirectory
  159. A subdirectory is one which is held
  160. within another directory. A structure
  161. of directories can exist to any level.
  162. .
  163. .NOTE Internal command
  164. An internal command is one which is
  165. built into the DOS command processor
  166. and does not reside as a file on
  167. the disk.
  168. .
  169. .NOTE External command
  170. An external command is one which
  171. resides as a program file on the
  172. disk. It is held in a file with
  173. the extension of .EXE or .COM
  174.  
  175. .
  176. .NOTE ASCII
  177. ASCII is an abbreviation for the
  178. code used to store textual data
  179. on a computer:- American Standard
  180. Code for Information Interchange
  181. .
  182. .NOTE Default Directory
  183.  The current directory which will be
  184.  used to refer to programs and files
  185.  if a direct pathname to the file is
  186.  not given. Other directories may be
  187.  searched for files using the ~FPATH~E
  188.  and ~FAPPEND~E commands to specify a
  189.  search path.
  190. .
  191. .NOTE Default Drive
  192.  The current disk drive which is used
  193.  for all file specifications which do
  194.  not include a drive specification in
  195.  their pathname. The default drive is
  196.  indicated on the DOS command line in
  197.  the prompt.
  198. .
  199. .NOTE Wildcard
  200.  A wildcard file specification allows
  201.  all files matching a pattern to be
  202.  selected. The '*' wildcard matches
  203.  any number of characters in a file
  204.  name or extension. The '?' wildcard
  205.  matches any single character. e.g.
  206.  
  207.  *.EXE    - all programs
  208.  *.H??    - all HyperShell data files
  209. .
  210. .NOTE Environment variable
  211.  An environment variable is a
  212.  variable used by programs and
  213.  batch files, set up using the
  214.  ~FSET~E command.
  215. .
  216. .NOTE sorry
  217. Sorry, but there are no
  218. commands in this file
  219. which start with $\ !
  220. .
  221. .NOTE MSDOS
  222.       This file is a help file for MSDOS version 3.2. To get help on
  223.       a topic, select the menu below which describes the area you want
  224.       help with. You can then select the command for which you require
  225.       help. Press the number adjacent to the menu to select it.
  226.  
  227.       To get help on a specific command, type the first letter of the
  228.       command, and a menu of those commands starting with that letter
  229.       will be displayed. For a full list, press F2. To search for a
  230.       word in the file, press F6.
  231.  
  232.       To list the MSDOS hyperfile, Press '0'.
  233.  
  234.       Note: MSDOS versions 3.3 and 4.0 have certain differences
  235.       in some commands and have some additional commands.
  236. .
  237. .SCRIPT SETUP
  238. O#
  239. O44
  240. O*41
  241. KF1NHelp
  242. KM1HELP
  243. K#aA@CA
  244. K#bA@CB
  245. K#cA@CC
  246. K#dA@CD
  247. K#eA@CE
  248. K#fA@CF
  249. K#gA@CG
  250. K#hNsorry(H)
  251. K#iA@CI
  252. K#jA@CJ
  253. K#kA@CK
  254. K#lA@CL
  255. K#mA@CM
  256. K#nNsorry(N)
  257. K#oNsorry(O)
  258. K#pA@CP
  259. K#qNsorry(Q)
  260. K#rA@CR
  261. K#sA@CS
  262. K#tA@CT
  263. K#uNsorry(U)
  264. K#vA@CV
  265. K#wNsorry(W)
  266. K#xA@CX
  267. K#yNsorry(Y)
  268. K#zNsorry(Z)
  269. K#0SList
  270. .
  271. .SCRIPT List
  272. O91;TMSDOS.HYP;O90
  273. .
  274. .REMARK
  275. Start of main frame area
  276. .FRAME MSDOS Hyperfile
  277. .TITLE Help file for MSDOS version 3.2
  278. [a]  ~FAPPEND~E  ~FASSIGN~E  ~FATTRIB~E  ~FBREAK~E  
  279. [c]  ~FCHDIR~E   ~FCHKDSK~E  ~FCLS~E     ~FCOMP~E      ~FCOPY~E    ~FCTTY~E  
  280. [d]  ~FDATE~E    ~FDEL~E     ~FDIR~E     ~FDISKCOMP~E  ~FDISKCOPY~E  
  281. [e]  ~FECHO~E    ~FEDLIN~E   ~FERASE~E  
  282. [f]  ~FFIND~E    ~FFOR~E     ~FFORMAT~E  
  283. [g]  ~FGOTO~E    ~FGRAPHICS~E  
  284. [i]  ~FIF~E  
  285. [j]  ~FJOIN~E  
  286. [k]  ~FKEYBUK~E  
  287. [l]  ~FLABEL~E  
  288. [m]  ~FMKDIR~E   ~FMODE~E    ~FMORE~E  
  289. [p]  ~FPATH~E    ~FPAUSE~E   ~FPRINT~E    ~FPROMPT~E  ~FParameter~E  
  290. [r]  ~FREM~E     ~FRENAME~E  ~FREPLACE~E  ~FRMDIR~E  
  291. [s]  ~FSET~E     ~FSHIFT~E   ~FSORT~E     ~FSUBST~E   ~FSYS~E  
  292. [t]  ~FTIME~E    ~FTREE~E    ~FTYPE~E  
  293. [v]  ~FVER~E     ~FVERIFY~E  ~FVOL~E  
  294. [x]  ~FXCOPY~E  
  295. .END
  296.  
  297. .FRAME APPEND
  298. .TITLE Set a search path for data files
  299.       APPEND [d:]\path[;[d:]\path..]
  300.  
  301.       This sets up a sequence of pathnames that are searched for data
  302.       files when the data file is not in the default directory.
  303. .
  304. .END
  305.  
  306. .FRAME ASSIGN
  307. .TITLE Assign drive letter to another drive
  308.       ASSIGN requested-drive=searched-drive
  309.  
  310.       ASSIGN instructs DOS to use a disk drive other than
  311.       the one specified in a file operation.
  312.  
  313. e.g.  ASSIGN A=C
  314.  
  315.       This will cause all references to A: to use drive C: instead
  316. .
  317. .END
  318.  
  319. .FRAME ATTRIB
  320. .TITLE Set file attributes
  321.       ATTRIB [+R or -R] [+A or -A] [d:][\][path\]filename.filetype
  322.  
  323.       OPTIONS
  324.       -------
  325.       +R   Make the file Read-Only.
  326.       -R   Make the file Read-Write again.
  327.       +A   Force the file to be backed-up even if it has not been changed.
  328.       -A   Stop the file from being backed-up even though it has been changed.
  329.  
  330.       Wildcard file specifications can be used.
  331. .
  332. .FRAME BREAK
  333. .TITLE Set break level
  334.       BREAK ON or BREAK OFF
  335.  
  336.       ON  -  check for Ctrl Break on every DOS operation
  337.  
  338.       OFF -  check for Ctrl Break only during a screen, keyboard,
  339.              printer or comms operation
  340.  
  341.       No parameter - show current setting
  342. .
  343. .FRAME CHDIR
  344. .TITLE Change to new directory for drive
  345.       CHDIR [d:][\]path
  346.  
  347.       CD [d:][\]path
  348.  
  349.       CHDIR changes the default directory associated with the
  350.       default drive or a named drive.
  351.  
  352.       If used without parameters, the default directory is displayed.
  353.  
  354. .
  355. .END
  356.  
  357. .FRAME CHKDSK
  358. .TITLE Carry out disk and memory check
  359.       CHKDSK d:[\][path\][filename.filetype][/F][/N]
  360.  
  361.       OPTIONS
  362.       -------
  363.       /F   Fix errors as the disk is processed.
  364.       /N   Display messages as the disk is processed.
  365.  
  366.       CHKDSK performs checks on the memory in the PC and on the
  367.       directories in the specified (or default) drive. Any filenames
  368.       specified are checked for non-contiguous sectors.
  369.  
  370.       Wildcard characters can be used for the file specification.
  371.  
  372. .
  373. .FRAME CLS
  374. .TITLE Clear screen
  375.       CLS
  376.  
  377.       CLS clears the screen display.
  378.  
  379.       This is a DOS internal command
  380. .
  381. .FRAME COMP
  382. .TITLE Compare two files
  383.       COMP [option[option...]] [d:][\][path\]filename.filetype [d:][\][path\]
  384.            filename.filetype
  385.  
  386.       OPTIONS
  387.       -------
  388.       /A /C /L /LBn /N /T /W /n       See Also: ~FCOMP Parameters~E
  389.  
  390.       COMP compares two files and reports on any differences.
  391.       It can also be used to compare sets of files.
  392.  
  393.       Wildcard characters are allowed in the file specifications.
  394.  
  395.       When differences are found, the offset in the file, and the
  396.       contents in each file, are displayed. A count of the differences
  397.       is reported at the end of processing.
  398. .
  399. .FRAME COMP Parameters
  400. .TITLE Parameters for COMP command
  401. /A To indicate where the difference is just display the last line of
  402.    the previous matching section and the first line of the following
  403.    matching section - not all the lines in between. (The lines in
  404.    between are represented by ...).
  405. /C Treat all letters as upper case in the comparison.
  406. /L Force a line by line comparison. (Used when the filetype of either
  407.    file is EXE, COM, SYS, OBJ, LIB or BIN.)
  408. /LBn Set the buffer size to n lines. (The default is 100 lines; the
  409.      maximum depends on the amount of memory space your PC has.)
  410. /N Add line numbers when reporting where the differences are.
  411. /T Don't expand tab characters to spaces. (The default is to interpret each
  412.    tab character as spaces up to the start of the next 8 character column.
  413. /W Interpret all tabs and multiple spaces as single spaces; ignore spaces at
  414.    the beginning and end of any line.
  415. /nn Set the number of identical lines required before the comparison
  416.     resynchronises to nn. (The default is 2 lines).
  417. .END
  418. .FRAME COPY
  419. .TITLE Copy files
  420.       COPY [d:][\][path\]source[/A][/B] [d:][\][path\]destination[/A][/B][/V]
  421.  
  422.     OPTIONS
  423.     -------
  424.     SOURCE
  425.       /A  The file is treated as an ASCII text file. The contents are copied
  426.           up to, but not including, the first Ctrl-Z (end of file) character.
  427.       /B  The entire file is copied, regardless of any Ctrl-Z (end of file)
  428.           character found in the file.
  429.  
  430.     DESTINATION
  431.       /A  The file is treated as an ASCII text file. A Ctrl-Z (end of file)
  432.           character is added to the end of the file.
  433.       /B  No Ctrl-Z (end of file) character is added to the end of the file.
  434.       /V  The destination file is compared with the source file to verify
  435.           the accuracy of the copy.
  436.  
  437.     Wildcard characters may be used in the source file specification.
  438. .
  439. .FRAME CTTY
  440. .TITLE Change default console device
  441.       CTTY device
  442.  
  443.       CTTY redirects the standard console interaction to an
  444.       auxiliary device. The device may be one of AUX, COM1,
  445.       COM2 or CON. CON is the default console device, and
  446.       setting to this has the effect of resetting the console
  447.       to keyboard and screen.
  448.  
  449.       CTTY is a DOS internal command.
  450. .
  451. .FRAME DATE
  452. .TITLE Show or set date
  453.       DATE [dd-mm-yy]
  454.  
  455.       DATE displays and optionally sets the system date
  456.  
  457.       DATE is a DOS internal command.
  458. .
  459. .FRAME DEL
  460. .TITLE Delete file(s)
  461.       DEL [d:][\][path\]filename.filetype
  462.  
  463.       DEL erases files from disk on the specified drive in the
  464.       specified directory.
  465.  
  466.       Wildcard file specifications are permitted. If all files are
  467.       specified with a *.* wildcard, the confirmatory prompt:-
  468.  
  469.       Are you sure(Y/N)
  470.  
  471.       Is issued before doing the deletion.
  472.  
  473.       DEL is a short form of the ERASE command, and is a
  474.       DOS internal command.
  475. .
  476. .FRAME DIR
  477. .TITLE List (matching) file names
  478.       DIR [d:][\][path\][filename.filetype][/P][/W]
  479.  
  480.       Display a directory listing of files in the specified directory,
  481.       or default directory if no directory specified.
  482.  
  483.       OPTIONS
  484.       -------
  485.       /P  The display pauses after every screenful of information.
  486.           Press any key to see the next screenful.
  487.  
  488.       /W  Just the filenames and filetypes, with 5 files on each line.
  489.  
  490.       Wildcard file specifications may be used with DIR.
  491. .
  492. .FRAME DISKCOMP
  493. .TITLE Compare disks
  494.       DISKCOMP source-drive: target-drive:[/1][/8]
  495.  
  496.       OPTIONS
  497.       -------
  498.       /1   Compare just the first side of the disks.
  499.       /8   Compare just the first eight sectors of each track.
  500.  
  501.       DISKCOMP compares two disks to verify that they are identical.
  502.       If any differences are found, the track number and side are
  503.       reported.
  504. .
  505. .FRAME DISKCOPY
  506. .TITLE Copy entire disk
  507.       DISKCOPY source-drive: target-drive:
  508.  
  509.       OPTIONS
  510.       -------
  511.       /1  - only copy the first side, even if double sided.
  512.  
  513.       DISKCOPY copies the contents of a floppy disk from one
  514.       drive to another.
  515. .
  516. .FRAME EDLIN
  517. .TITLE Line editor
  518.       EDLIN [d:][\][path\]filename.filetype[/B]
  519.  
  520.       OPTIONS
  521.       -------
  522.       /B   Don't interpret Ctrl-Z characters as end of file.
  523.  
  524.       EDLIN invokes the MSDOS line editor to edit the specified
  525.       file.
  526.  
  527.       EDLIN commands are detailed in ~FEDLIN COMMANDS~E.
  528. .
  529. .FRAME EDLIN COMMANDS
  530. .TITLE Commands used within EDLIN
  531.       EDLIN Commands are as follows:-
  532.       n                 edit line n
  533.       [n]A              append n lines
  534.       [n],[m],l[,c]C    Copy a range of lines
  535.       [n][,m]D          Delete a range of lines
  536.       E                 End edit, save file, return to DOS
  537.       [n]               Insert lines before line n
  538.       [n][,m]L          List range of lines
  539.       [n][,m]lM         Move range of lines
  540.       [n][,m]P          Display range of lines in pages
  541.       Q                 Quit to DOS without saving
  542.       [n][,m][?]Rold-string[Ctrl-Z[newstring]]  Replace all old with new
  543.       [n][,m][?]Sstring Search for string in range
  544.       [l]Tfilespec      Transfer file into edit buffer before line l
  545.       [n]W              Write first n lines to disk
  546. .
  547. .FRAME ERASE
  548. .TITLE Delete file(s)
  549.       ERASE [d:][\][path\]filename.filetype
  550.  
  551.       This command is the same as the ~FDEL~E command (viz.).
  552.  
  553. .
  554. .FRAME FIND
  555. .TITLE Find text string in a file
  556.       FIND [/V][/C][/N] "string" [d:][\][path\]filename.filetype
  557.  
  558.       OPTIONS
  559.       -------
  560.       /V  Display all lines except those containing the specified string.
  561.       /C  Display the number of lines in which the string was found.
  562.       /N  Number of lines according to their position in the file.
  563.  
  564.       FIND reads the named file or files, or acts as a filter if no
  565.       files are specified, searching its input for "string"
  566.       where "string" is an alphanumeric string specifying exact case
  567.       of letters.
  568.  
  569. e.g.  FIND "fred" NAME1.LST NAME2.LST
  570.  
  571.       ~FDIR~E | FIND "EXE"
  572.  
  573. .
  574. .FRAME FORMAT
  575. .TITLE Format Disk in specified drive
  576.       FORMAT d:[option[option...]]
  577.  
  578.       OPTIONS
  579.       -------
  580.       /1    Format a single sided disk.
  581.       /8    Format with 8 usable sectors per track.
  582.       /B    Reserve space for hidden system files.
  583.       /N:n  Format with n sectors per track (n=8,9)
  584.       /T:t  Format with t tracks (t=40,80)
  585.       /V    Prompt for a disk label after the format has been completed (the
  586.             label which is shown on the screen every time you use the DIR
  587.             command to display the contents of the disk - can be up to 11
  588.             characters long.
  589.       /S    Format and prepare for use as a startup disk by copying the
  590.             system files from the default drive to the newly formatted disk.
  591.  
  592. .
  593. .FRAME GRAPHICS
  594. .TITLE Set up graphics driver for printer
  595.       GRAPHICS printer-type[/R][/B]
  596.  
  597. ---------------------- PRINTER TYPES -------------------------
  598. COLOR1     IBM PC Color Printer (or compatible) with a black ribbon.
  599. COLOR4     IBM PC Color Printer (or compatible) with an RGB (Red, Green,
  600.            Blue) ribbon.
  601. COLOR8     IBM PC Color Printer (or compatible) with a CMY (Cyan,Magenta,
  602.            Yellow and Black) ribbon.
  603. COMPACT    IBM PC Compact Printer (or compatible).
  604. GRAPHICS   IBM PC Graphics Printer (or compatible, e.g AMSTRAD DMP3000).
  605. COLORJET   IBM Colorjet Printer (or compatible).
  606.  
  607. ----------------------- OPTIONS -------------------------------
  608. /R  Print foreground light, background dark as seen on the monitor.
  609.     If this option is not selected, then the foreground is printed
  610.     dark and the background light.
  611. /B  Print the background colour. If this option is not selected the
  612.     background colour is not printed. (PRINTER TYPES COLOR4 & 8 ONLY).
  613. /F  Turn the screen dump round through 90 Degrees.
  614. /C  Centre the screen dump on the page.
  615. .
  616. .FRAME JOIN
  617. .TITLE Join drive as directory
  618.       JOIN d: [d:][\]path
  619.  
  620.       JOIN d:/D
  621.  
  622.       JOIN joins a disk drive to a directory on another drive.
  623.  
  624.       The /D switch breaks any join so made
  625.  
  626.       The directory to be joined to must be empty, and must be in
  627.       the root directory. If it does not exist, it will be created.
  628.  
  629.       References to files beneath this directory will be referred
  630.       to the drive joined at that point.
  631.  
  632. .
  633. .FRAME KEYBUK
  634. .TITLE Set for british keyboard
  635.       KEYBUK
  636.  
  637.       This sets the keyboard up for U.K. usage
  638.  
  639.  
  640. .
  641. .FRAME LABEL
  642. .TITLE Label a disk
  643.       LABEL [d:] label
  644.  
  645.       LABEL creates, or changes, a disk label. The label
  646.       can be up to 11 characters long, including spaces.
  647.  
  648.       If no parameter is specified, the label is displayed.
  649.  
  650.       All characters except *?/\|.,;:+=<>[] can be used.
  651.  
  652. .
  653. .FRAME MKDIR
  654. .TITLE Create subdirectory
  655.       MKDIR [d:][\]path
  656.  
  657.       MKDIR creates a new subdirectory on the specified (or default)
  658.       drive and directory.
  659.  
  660.       MKDIR is a DOS internal command
  661.  
  662.       See also ~FRMDIR~E
  663. .
  664. .FRAME MODE
  665. .TITLE Set device mode
  666.       MODE device:setting[,setting...]
  667.  
  668.       Sets up a device mode as follows:-
  669.  
  670.       MODE LPTn:w,v (n = 1,2,3:w = 80,132:v = 6,8) - set printer
  671.  
  672.       MODE [w],[s[,T]] (w = 40,80,BW40,BW80,CO40,CO80,MONO) - screen mode
  673.        (s = L,R)   - shift left/right one/two characters
  674.        (T)         - test pattern display for alignment
  675.  
  676.       MODE COMn:baud[,parity[,databits[,stopbits[,P]]]]
  677.         (n = 1,2:baud=110 to 9600:parity=N,E,O:databits=7,8)
  678.         (stopbits=1,2:P indicates printer) - set comms port
  679.  
  680.       MODE LPTn:=COMm (n=1,2,3:m=1,2) - redirect printer output to
  681.         serial port.
  682. .
  683. .FRAME MORE
  684. .TITLE Display output a screenful at a time
  685.       MORE < filespec
  686.  
  687.       MORE is used to display a text file a page at a time. It is used
  688.       as a filter, and has its input redirected or piped into it. When
  689.       each page is complete, the message "--More--" appears on the bottom
  690.       line and the program waits for a key to be pressed.
  691.  
  692. e.g.  ~FDIR~E | MORE
  693.  
  694.       to display a long directory listing a page at a time
  695.  
  696.       MORE < TEXT.FIL
  697.  
  698.       to display the file TEXT.FIL a page at a time
  699. .
  700. .END
  701.  
  702. .
  703. .FRAME PATH
  704. .TITLE Set search path for executables
  705.       PATH [d:]\path[;[d:]\path...]
  706.  
  707.       PATH specifies the list of directories searched when programs
  708.       or batch files are not in the default directory.
  709.  
  710.       If no parameters are specified, the current value is shown.
  711.  
  712.       PATH; clears the search path, so that only the default directory
  713.       is searched.
  714.  
  715.       PATH is a DOS internal command
  716. .
  717. .FRAME PRINT
  718. .TITLE Spool file for printing
  719. PRINT [d:][\][path\]filename.filetype[[d:][\][path\]filename.filetype...]
  720.                                                              [\P][\C][\T]
  721.  
  722.       OPTIONS
  723.       -------
  724.       /C   Remove this and following files (up to the next file listed with
  725.            the P option) from the list of files waiting to be printed.
  726.       /P   Add this and following files (up to the next file listed with the
  727.            /C option) to the list of files waiting to be printed.
  728.       /T   Stop the current file from being printed.
  729.  
  730.       PRINT controls the print spooler, to enable files to be sent to
  731.       the printer as a background process whilst other work is done.
  732. .
  733. .END
  734. .FRAME PROMPT
  735. .TITLE Set prompt string
  736.       PROMPT prompt-text
  737.       where [prompt-text] is: letter:$$character[letter:$$character...]
  738.  
  739.       $$T   Time.
  740.       $$d   Date.
  741.       $$n   The drive letter of the default drive.
  742.       $$p   The current directory on the default drive.
  743.       $$v   The MS-DOS version number.
  744.       $$$$   A $$ character.
  745.       $$g   A ">" character.
  746.       $$l   A "<" character.
  747.       $$b   A : character.
  748.       $$q   A = character.
  749.       $$h   A Backspace character.
  750.       $$e   An ESCape character.
  751.       $$_   A new line.
  752.  
  753.       PROMPT sets the DOS prompt string.
  754. .
  755. .FRAME RENAME
  756. .TITLE Rename file
  757.       RENAME [d:][\][path\]old-name new-name
  758.  
  759.       Renames a file to a new name
  760.  
  761.       RENAME may be shortened to REN
  762.  
  763.       Wildcards can be used in the filename or extension part
  764.       of the file specification to enable a set of files to be
  765.       renamed.
  766.  
  767.       RENAME is a DOS internal command
  768. .
  769. .FRAME REPLACE
  770. .TITLE Replace old versions and add new
  771.       REPLACE source-drive:[\][path\]filename.filetype
  772.               target-drive:[\][path][option[option...]]
  773.  
  774.       OPTIONS
  775.       -------
  776.       /A   Add new files to the target directory.
  777.       /D   Replace only if the source file is more recent.
  778.       /P   Prompt for confirmation before replacing a target file or adding a
  779.            new source file.
  780.       /R   Search both the given target directory and its subdirectories for
  781.            old versions of the files.
  782.       /S   Replace both read-write and read-only files.
  783.       /w   Wait for a key to be pressed before starting replacing and adding
  784.            files.
  785.  
  786.       REPLACE updates a second directory with uptodate versions of files,
  787.       and adds new files. Wildcard file specifications may be used.
  788. .
  789. .FRAME RMDIR
  790. .TITLE Delete subdirectory
  791.       RMDIR [d:][\]path
  792.  
  793.       RMDIR removes a subdirectory.
  794.  
  795.       RMDIR can be shortened to RD.
  796.  
  797.       The directory must be empty before it can be deleted.
  798.  
  799.       RMDIR is a DOS internal command
  800. .
  801. .END
  802.  
  803.  
  804. .
  805. .FRAME SET
  806. .TITLE Set environment variable
  807.       SET variable=string
  808.  
  809.       SET inserts variables into the DOS environment list.
  810.       These are known as environment variables.
  811.  
  812.       If no parameters are specified, the current settings are
  813.       shown.
  814.  
  815.       If the 'string' parameter is null (e.g. 'SET variable=')
  816.       the variable is removed from the environment.
  817.  
  818.       This is a DOS internal command
  819.  
  820. e.g.  SET NAME=FRED
  821. .
  822. .FRAME SORT
  823. .TITLE Sort file
  824.       SORT [/R][/+n]  [d:][\][path\]filename.filetype] [ destination]
  825.  
  826.       OPTIONS
  827.       -------
  828.       /R   Reverse the sort, highest sequence comes first
  829.       /+N  Sort at Column N.
  830.  
  831.       SORT sorts the input text file and writes out the sorted data.
  832.  
  833.       SORT can be used as a filter program
  834.  
  835. e.g.  ~FDIR~E | SORT /R
  836. .
  837. .FRAME SUBST
  838. .TITLE Subst name of imaginary drive for path
  839.       SUBST d: [d:][\]path
  840.  
  841.       SUBST allows a pathname to be referenced as a psuedo
  842.       disk drive, allowing the use of software that can only
  843.       work with a fixed drive letter.
  844.  
  845.  
  846. .
  847. .FRAME SYS
  848. .TITLE Setup a boot disk
  849.       SYS d:
  850.  
  851.       SYS copies the system files from the default drive to
  852.       the specified drive
  853.  
  854.       The disk must have been formatted using the /S or /B option
  855.       on the FORMAT command, or the directory must be empty.
  856. .
  857. .FRAME TIME
  858. .TITLE Show/set time
  859.       TIME [hh:mm]
  860.  
  861.       TIME displays and optionally sets the system time.
  862.  
  863. .
  864. .FRAME TREE
  865. .TITLE Display subdirectory tree
  866.       TREE [d:][/F]
  867.  
  868.       If the option /F is used, the names of the files in each directory are
  869.       also listed.
  870.  
  871.       TREE displays the hierarchy of subdirectories and optionally lists
  872.       the files in each subdirectory.
  873. .
  874. .FRAME TYPE
  875. .TITLE Display file on screen
  876.       TYPE [d:][\][path\]filename.filetype
  877.  
  878.       TYPE displays the textual contents of the specified file.
  879. .
  880. .FRAME VER
  881. .TITLE Give MSDOS version
  882.       VER
  883.  
  884.       This prints out the MSDOS version number, showing
  885.       the major version number and the revision level.
  886. .
  887. .FRAME VERIFY
  888. .TITLE Set disk verify On/Off
  889.       VERIFY ON or VERIFY OFF
  890.  
  891.       VERIFY ON enables disk verify operation, so that data is
  892.       chacked after it is written to the disk.
  893.  
  894.       VERIFY OFF disables the disk write verification.
  895.  
  896.       If no parameters are specified, the current setting is shown.
  897.  
  898.       VERIFY is a DOS internal command
  899. .
  900. .FRAME VOL
  901. .TITLE Display disk volume label
  902.       VOL d:
  903.  
  904.       VOL displays the label of the disk on the specified drive.
  905.  
  906.       VOL is a DOS internal command.
  907. .
  908. .FRAME XCOPY
  909. .TITLE Copy (extended)
  910.       XCOPY [d:][\][path\]source[d:][\][path\]destination [option[option...]]
  911.  
  912.       OPTIONS
  913.       -------
  914.       /A          Only copy files that have the Archive attribute set.
  915.       /D:dd-mm-yy Only copy files that have been changed on or after the given
  916.                   date.
  917.       /E          Copy entry subdirectories as well as ones with files in them.
  918.       /M          Only copy files that have the Archive attribute set.
  919.       /P          Confirm each copy.
  920.       /S          Copy files from both the given directory and from its subdi-
  921.                   rectories.
  922.       /V          Verify each copy as it is written, to check that the new file
  923.                   is identical to the original.
  924.       /W          Wait until a key is pressed before starting the copy.
  925.  
  926.       XCOPY provides an extended copy command that does selective copying.
  927.       Wildcard file specifications may be used.
  928. .
  929. .FRAME ECHO
  930. .TITLE Display message
  931.  
  932.       ECHO message
  933.  
  934.       ECHO displays a message to the screen from a batch file
  935.  
  936.       The forms:-
  937.  
  938.       ECHO ON
  939.  
  940.       and
  941.  
  942.       ECHO OFF
  943.  
  944.       Enable or disable the display of commands as they are executed
  945.       in a batch file. This is enabled by default.
  946.  
  947.       If no parameters are supplied, the current status is displayed.
  948. .
  949. .FRAME FOR
  950. .TITLE Operate on group of files
  951.  
  952.       FOR %%var IN wildcardspec DO command
  953.  
  954.       FOR executes the given command for each file matching the
  955.       Wildcard file specification.
  956.  
  957.       The variable var may be substituted into the command to
  958.       provide the name of the current file in the group.
  959.  
  960. e.g.  FOR %%a IN *.TXT DO TYPE %%a
  961.  
  962.       This allows all files with the extension TXT to be typed.
  963.  
  964.       This is a useful way of allowing wildcard specifications
  965.       to be used with commands that do not support them directly.
  966. .
  967. .FRAME GOTO
  968. .TITLE Branch to a label in a batch file
  969.  
  970.       GOTO label
  971.  
  972.       GOTO transfers control to a specified label in a batch
  973.       file. If the label does not exist, the batch file
  974.       aborts with an error message.
  975.  
  976. e.g.  :HERE
  977.       ECHO AGAIN
  978.       GOTO HERE
  979.  
  980.       Loops indefinately displaying the message "AGAIN"
  981. .
  982. .FRAME IF
  983. .TITLE Test a condition in batch file
  984.       IF {NOT} condition command
  985.  
  986.       If evaluates the condition, and if it is true (or false if
  987.       NOT is specified), the command is executed.
  988.  
  989.       The condition may take one of the following forms:-
  990.  
  991.       EXIST filename       This tests to see if the file exists
  992.  
  993.       ERRORLEVEL n         This tests the exit status of the previous
  994.                            command, and if it is greater than or equal
  995.                            to 'n' the condition is true
  996.  
  997.       string==string       This tests one string against another, and
  998.                            they are equal, the condition is true
  999. .
  1000. .FRAME PAUSE
  1001. .TITLE Await depression of key
  1002.       PAUSE {remark}
  1003.  
  1004.       PAUSE causes the system to stop until a key is pressed
  1005.       The optional remark is displayed prior to the pause, if
  1006.       specified.
  1007. .
  1008. .FRAME REM
  1009. .TITLE Remark in batch file
  1010.  
  1011. ---------------------  REM - Internal Batch Subcommand  -----------------------
  1012.  
  1013. REM denotes a remark (comment) in a batch file.
  1014.  
  1015. FORMAT:   REM [remark]
  1016.  
  1017. REMARKS:
  1018.  
  1019.    Remarks may be any string of characters.  The maximum length of a remark is
  1020.    123 characters.  Note that remarks will not be displayed during batch file
  1021.    execution if ECHO has been set to OFF.
  1022.  
  1023. EXAMPLE:  Display the remark, "This Batch File Backs Up the Budget Files:"
  1024.  
  1025.           REM This Batch File Backs Up the Budget Files
  1026. .
  1027. .FRAME Parameter
  1028. .TITLE Supplying parameters to a batch file
  1029.       Parameters
  1030.  
  1031.       Up to 10 parameters may be supplied to a batch file,
  1032.       or more if ~FSHIFT~E is used. These parameters are
  1033.       treated like environment variables, and have the names
  1034.       %0 to %9
  1035.  
  1036.       Environment variables set using the ~FSET~E command can be
  1037.       expanded within the batch file using the notation:-
  1038.  
  1039.       %variablename%
  1040.  
  1041.       Where variablename is the environment variable.
  1042. .
  1043. .FRAME SHIFT
  1044. .TITLE Shift arguments
  1045.       SHIFT
  1046.  
  1047.       SHIFT moves all replaceable ~Fparameter~Es to a batch
  1048.       command file down one in number, so that %1 becomes %0,
  1049.       %2 becomes, %1 etc. This permits more than the ten
  1050.       directly usable parameters to be entered.
  1051. .
  1052.