home *** CD-ROM | disk | FTP | other *** search
/ BBS 1 / BBS#1.iso / communic / dized49g.ha / DIZEDIT.DOC next >
Text File  |  1994-03-30  |  13KB  |  302 lines
  1. DIZEDIT Version 4.9g
  2. Copyright (c) 1993 GDSOFT
  3.  
  4. March 30, 1994
  5.  
  6. WHAT IS IT :
  7. ------------
  8.  
  9. DIZEDIT  is a  simple utility  that  allows  editing of  those nice  little
  10. description files  commonly found in archive  files (ZIP,ARJ,LZH). Many BBS
  11. systems use this  file as the ACTUAL description  whenever the archive file
  12. is uploaded to them. Commonly, the file is named FILE_ID.DIZ, however other
  13. variations are FILE.DES  or FILE.SDI. In this document,  I'll refer to this
  14. file regardless of the flavor as the FILE_ID.
  15.  
  16. DIZEDIT  easily allows  you to  create the  existing FILE_ID  if it already
  17. exists in the archive, and if not,  it allows you to create it.
  18.  
  19. Additionally, with Version 4.0, several useful abilities have been added :
  20.  
  21.      ....  Convert archives to a DEFAULT format.
  22.      ....  REPACK archives to minimize size
  23.      ....  Recognizes most ARJ,ZIP and LZH SFX files
  24.      ....  Strip or add Archive comments (ARJ and ZIP ONLY)
  25.      ....  Automatic VIRUS SCAN using popular SCAN programs.
  26.      ....  Update ARCHIVE date with TODAY,NEWEST,OLDEST file date.
  27.      ....  Add BBS files to the archive such as ADS etc.
  28.      ....  Included  an  .INI  file  which  can  be edited
  29.            interactively to save setup information.
  30.  
  31. BASIC STARTUP :
  32. ---------------
  33.  
  34. Unpack the  distribution archive to some  directory on your disk,  and type
  35. the command  : DIZEDIT <ENTER>.  If it is  the first time  you have used to
  36. program,  DIZEDIT will  create a  DIZEDIT.INI file  on the  same path  that
  37. DIZEDIT.EXE exists.  This is a  plain vanilla ASCII  file and contains  the
  38. following information :
  39.  
  40. MARGIN=40 (anything from 30 to 78 chars)
  41. COLOR=BLUE (Choices are : BLUE,RED,GREEN,CYAN,MAGENTA)
  42. INSERT=ON (Start DIZEDIT in insert mode.  Could be OFF)
  43. FORCEDIZ=NO (ABSOLUTELY save FILE_ID.DIZ no matter if SDI or DES file)
  44. DOUBLEUP=NO (Save the ORIGINAL FILE_ID.DIZ as ARCHIVENAME.DIZ in the file )
  45. SAVEDIZPATH=D:\SOMEPATH (path for saving DIZ's ..  OPTIONAL)
  46. SWAPDRIVE=D (The drive DIZEDIT should create SWAP on.  Use FASTEST drive.)
  47. EMS=YES     (Use EMS for Swapping if available.  Make this NO for 286/386sx)
  48. MARKEOF=YES (Include Ctrl[Z] as EOF Marker.  Maybe you DO NOT want it)
  49.  
  50. ARJ=D:\UTILITY\ARJ.EXE A (The address of ARJ.EXE PLUS extra switches)
  51. PKZIP=D:\UTILITY\PKZIP.EXE -EX  $B -a -r  -p (ditto, whatever you use)
  52. PKUNZIP=D:\UTILITY\PKUNZIP.EXE -d -$         (ditto again)
  53. LZH=D:\UTILITY\LHA.EXE (ditto again and again)
  54. SCAN=D:\TOOLS\SCAN.EXE /NOMEM /BELL  (use any switches you like)
  55.  
  56. DATE=NEWEST,EXT (sets archive date to newest PLUS extension, OR
  57.                  oldest PLUS extension OR
  58.                  TODAY (today's date) OR
  59.                  just blank for NOTHING (current archive date)).
  60. COMMENT=D:\TURBO\ARCS\ZIPLOGO.TXT (the address and name of a comment file)
  61. BBSAD=D:\BBS\ABBS.TXT (name and address of file to add to archive).
  62. DEFAULT=ZIP (ARJ,ZIP, or LZH.  Archives WILL be converted to this)
  63. REPACK=NO (Repack archives for MAXIMUM compression .. either YES or NO)
  64.  
  65. The easiest  way to create this  file is to execute  DIZEDIT. A DIZEDIT.INI
  66. file will  AUTOMATICALLY be created. Press  the F1 key BEFORE  selecting an
  67. archive  file,  and  DIZEDIT  will  allow  you  to  edit these values. When
  68. finished,  press F10  to save  your changes.  The changes  WILL TAKE EFFECT
  69. IMMEDIATELY, so you don't have to exit DIZEDIT and re-run it. Of course you
  70. can use any ASCII word processor  to change your DIZEDIT settings. Also, if
  71. you want DIZEDIT  to return to whatever the default  value was, just DELETE
  72. everything AFTER the EQUAL (=) sign. For example, to STRIP all comments for
  73. archives as they are process, just DELETE everthing AFTER the COMMENT= line
  74. from DIZEDIT.INI.
  75.  
  76. You can  use the F2 key  when in the FILE_ID  edit window to write  out the
  77. current FILE_ID to any valid directory on  your disk. This is useful if you
  78. want to save them for creating BBS lists or whatever. The file will be name
  79. ARCHIVENAME+.DIZ
  80.  
  81. Additional NEW  features of DIZEDIT are :
  82.  
  83. The file copy function. Press F4 on a valid file, and you will be permitted
  84. to copy the  file to any path on  your system. This is nice  if you want to
  85. create  an upload  directory to  send a  group of  files somewhere. You can
  86. change the  current drive using  F8. This  let's  you pick any  path on any
  87. drive on your system. Also, on the file selection screen, you can press the
  88. DELETE key, and you'll be able to DELETE or MOVE the archive if you desire.
  89.  
  90. AH... NOW FOR THE GOOD PART
  91. ---------------------------
  92.  
  93. You will be  presented with a directory list of  the current directory. You
  94. can select the '..' entry to get  to the ROOT directory. From there, select
  95. a directory where there  are files that have ZIP, ARJ  or LZH files. Select
  96. anyone of  them, and DIZEDIT will  open the archive and  extract all of the
  97. files to a "blind" directory that it creates.
  98.  
  99. The DEFAULT  file that DIZEDIT looks  for is FILE_ID.DIZ. If  that does NOT
  100. exist, then it looks  for a file with the extension of  "DES". If that does
  101. NOT exist  then it looks  for a file  with the extension  of "SDI". If your
  102. archive contains NONE of these then DIZEDIT will present you with a list of
  103. the files in this archive. You may choose one of them to be READIN, and the
  104. DIZEDIT  permits editing.  This is  useful  if  you DO  NOT already  have a
  105. FILE_ID, and  you want to  use the DOC   file or a  TXT file as  a basis to
  106. create from. The file that will be created in this case is FILE_ID.DIZ.
  107.  
  108. If one  of these files  already exist, then  DIZEDIT permits editing.
  109.  
  110. You can  enter up to  4096 characters.  BE  WARNED !!! Many  BBS sites ONLY
  111. permit 15 lines by 40 characters to be displayed in their descriptions. You
  112. can have as many  lines as you have memory for, and each  line can be up to
  113. 78 characters.
  114.  
  115. FORCEDIZ SWITCH
  116. ---------------
  117.  
  118. This switch allows you to FORCE and  FILE_ID.DIZ to be saved in the archive
  119. even when there is already a SDI or DES file.
  120.  
  121.  
  122. DOUBLEUP SWITCH
  123. ---------------
  124.  
  125. This switch allows you to FORCE the ORIGINAL FILE_ID.DIZ to be saved in the
  126. archive along with the edited FILE_ID. In order to make this work, you MUST
  127. have this  switch set to  YES in  the  INI file. Save  the ORIGINAL FILE_ID
  128. using F2. Edit your FILE_ID. When you press F10 to save the edited FILE_ID,
  129. DIZEDIT will place  the saved FILE_ID in the archive  too. It will be named
  130. ARCHIVENAME.DIZ.
  131.  
  132. MARKEOF SWITCH
  133. --------------
  134.  
  135. Normally, text files are marked with  a character #26 (Ctrl[Z]) to indicate
  136. the end of  file. If you use other  programs that DO NOT like  this Ctrl[Z]
  137. character, you  can tell DIZEDIT  to eliminate it  by using the  INI switch
  138. "MARKEOF=NO".  The  default  is  to  include  this  EOF  marker as the last
  139. character of the FILE_ID.DIZ.
  140.  
  141. LAST.DIZ FILE
  142. -------------
  143.  
  144. Once a  FILE_ID is saved,  DIZEDIT creates a  buffer of the  LAST data, and
  145. whenever you use  F1 to READIN files, you will  notice the file LAST.DIZ in
  146. the list.  You may select  this file. This  makes it nice  and easy to edit
  147. multiple archives in a series.
  148.  
  149.  
  150. ARCHIVE PROGRAM LOCATIONS
  151. -------------------------
  152.  
  153. Again,  DIZEDIT recognizes  the extensions  ZIP,ARJ, and  LZH. In order for
  154. DIZEDIT to work for each of these respective archives, you MUST have a copy
  155. of  the following  files SOMEWHERE  on your  path. DIZEDIT  will search for
  156. them, and if NOT  found, will tell you. You must then  make sure that these
  157. files are in the same directory as  DIZEDIT.EXE or in a directory listed in
  158. your PATH statement.
  159.  
  160.                 ZIP - PKZIP.EXE and PKUNZIP.EXE
  161.                 ARJ - ARJ.EXE
  162.                 LZH - LHA.EXE or LHARC.EXE
  163.  
  164. From there,  if a file  in the files  display window ends  in one of  these
  165. extensions, simply press  <ENTER>, and the FILE_ID for  that archive can be
  166. edited. At anytime, you can press the 'F1' key, and READIN any file on your
  167. disk  as a  basis for  the FILE_ID.  To save  the FILE_ID  and re-pack  the
  168. archive, press the 'F10' key. Pressing ESCAPE exits WITHOUT saving.
  169.  
  170.  
  171. A WORD ABOUT THE DIZEDIT SWAP AREA
  172. ----------------------------------
  173.  
  174. DIZEDIT  creates a  temporary directory  that it  uses to  unpack files for
  175. viewing or printing.  Normally, this directory is created  on the same disk
  176. that the program is on. PKZIP also uses a temporary file to do its work.
  177.  
  178. DIZEDIT will use  the same temporary disk that you  assign for PKZIP unless
  179. you have SWAPFILE=somedisk in the DIZEDIT INI File.
  180.  
  181. You  may have  this temporary  file  created  in a  different directory  by
  182. setting the  environment variable PKTMP.  Set this equal  to the drive  you
  183. wish  to  use  as  your  temporary  file  location  and  ARCTOOL  temporary
  184. directory.
  185.  
  186. For optimal  performance on your  local harddrive, the  PKTMP could be  set
  187. equal to  a RAM drive  if a large  enough one is  available. This will make
  188. EVERYTHING run VERY FAST !!!! The  temporary file location must have enough
  189. free space to hold ALL the files in their UNCOMPRESSED state.
  190.  
  191. A one or two MEG RAM drive would be sufficient for most compressed files.
  192.  
  193. DIZEDIT  swaps to  EMS (see  switch in  the INI  file) memory if available.
  194. Becuase it's executing PKZIP and PKUNZIP  as external shells, there may not
  195. be enough  EMS memory available for  PKUNZIP to do it's  job properly. This
  196. might be ESPECIALLY TRUE on 286/386sx machines. If you have one of these, I
  197. recommend setting the  "EMS=" switch in the INI file  to "EMS=NO". Also, if
  198. you  machine should  hang after  unpacking the  archive, try  changing this
  199. switch to NO as well.
  200.  
  201. COMMAND LINE  USAGE
  202. -------------------
  203.  
  204. DIZEDIT  if "batch  file" capable,  and can  be executed  directly from the
  205. command line such as :
  206.  
  207.                         DIZEDIT \PATH\SOMEZIP.ZIP
  208.  
  209. In this  case, DIZEDIT does NOT  show you the normal  selection screen, but
  210. instead goes DIRECTLY to the archive specified if it exists. You MUST enter
  211. the FULL name and COMPLETE path of  the archive file. You will then be able
  212. to edit the FILE_ID.DIZ for the named file.
  213.  
  214.  
  215. MULITASKERS - OS2/WINDOWS/DESQVIEW
  216. ----------------------------------
  217.  
  218. Just for your information, DIZEDIT  will run nicely under WINDOWS, DESQVIEW
  219. and OS/2. It'll give up the  timeslices to allow these operating systems to
  220. work properly.
  221.  
  222.  
  223. BASIC COMMANDS AND CURSOR MOVEMENT :
  224. ------------------------------------
  225.  
  226. DIZEDIT uses the normal cursor keys to go LEFT, RIGHT, UP, DOWN, HOME, END,
  227. PGUP, PGDN.
  228.  
  229. The editor is "WORDSTAR" compatible.
  230.  
  231. Here is a list of the function and CTRL keys and what each does :
  232.  
  233. Command                  Description
  234. --------------------     ------------------------------------------------
  235.  
  236. PROGRAM KEYS (BEFORE Archive is selected)
  237.  
  238. [F1]                  -  Edit the DIZEDIT.INI File
  239. [F4]                  -  Copy the selected file to another path.
  240. [F8]                  -  Select another path or drive to work from.
  241. [DEL]                 -  Permits archive to be DELETED or MOVED.
  242. [ESC]                 -  Quit DIZEDIT
  243.  
  244. EDITOR KEYS   (AFTER Archive is selected)
  245.  
  246. [F1]                  -  Presents a list of files to be READIN.
  247. [F2]                  -  Allows the current FILE_ID to be written to disk.
  248. [F10]                 -  Save the current FILE_ID and repack the archive.
  249. [ESC]                 -  Quit back to the file selection screen.
  250.  
  251. INSERT                -  Toggle INSERT/OVERWRITE Mode
  252. DELETE                -  Delete Character
  253. [CTRL]-[Y]            -  Delete current line
  254. [CTRL]-[B]            -  Reformat paragraph
  255. [CTRL]-[O][J]         -  Reformat & Justify paragraph
  256. [CTRL]-[S]            -  Character Left
  257. [CTRL]-[D]            -  Character Right
  258. [CTRL]-[A]            -  Word Left
  259. [CTRL]-[F]            -  Word Right
  260. [CTRL]-[E]            -  Line Up
  261. [CTRL]-[X]            -  Line Down
  262. [CTRL]-[W]            -  Scroll Up
  263. [CTRL]-[Z]            -  Scroll Down
  264. [CTRL]-[Q]            -  Delete To End Of Line
  265. [CTRL]-[T]            -  Delete Word
  266.  
  267.  
  268. MANY Thanks to Felix Mueller and James Duckworth, Guy Hunter and others for
  269. recommending MANY IMPORTANT improvements to DIZEDIT !!
  270.  
  271. Well, that's  pretty much it.  I think that  you will find  DIZEDIT easy to
  272. use, FAST, and  once you get used to using  it, indispensable !! Especially
  273. if you maintain a BBS.
  274.  
  275. If you like DIZEDIT, then please register it. For those who do, I will send
  276. my super dooper BONUS archive as well. Believe me there are many goodies on
  277. this  BONUS  disk.  including  ARCTOOL,  ARCPLUS  and  FILEMANAGER PLUS, an
  278. exciting NEW program which does ALL that you could EVER want a file manager
  279. program to do and MUCH MORE, including DIZEDIT built in !!!
  280.  
  281.  
  282. To register, send a FORMATTED, BLANK diskette to
  283.  
  284.         GDSOFT
  285.         G.D. DAVIS
  286.         57280 Osage Drive
  287.         Goshen, Indiana 46526
  288.  
  289.         Please Include a $15.00 registration fee.
  290.  
  291.         Make sure that you include your return address.
  292.  
  293.  
  294. If you have any comments or questions,  I would REALLY love to receive your
  295. comments  or  suggestions.  I  can  be  reached  by  leaving  mail on GENIE
  296. (G.D.DAVIS) or CompuServe (72067,2726), or write to me at the above address
  297. or better yet,  call GDSOFT BBS (219) 875-8133,  HST 14400,8,N,1 v.32/v.42.
  298. This is a FREE BBS, and you'll  find MANY GDSOFT programs and files as well
  299. as lots of other goodies.
  300.  
  301. Thank you for using DIZEDIT.
  302.