home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 430.lha / IntuiFace_v1.0 / intuiface_eng.doc < prev    next >
Encoding:
Text File  |  1990-10-05  |  17.2 KB  |  552 lines
  1.  
  2.  
  3.  
  4.                                  -----------
  5.                                   IntuiFace
  6.                                  -----------
  7.  
  8.  
  9.  
  10.  
  11.  
  12.                                  a program by
  13.  
  14.                                 Matthias Zepf
  15.  
  16.  
  17.                                (C)opyright 1990
  18.  
  19.                                   Shareware
  20.  
  21.  
  22.  
  23.  
  24.  
  25. Contents
  26.  
  27. 1.  Introduction
  28.     1.1.  Copyright
  29.     1.2.  Distribution
  30.     1.3.  Registered Users
  31. 2.  Installation
  32.     2.1.  On a disk based System
  33.     2.2.  On a harddisk based System
  34. 3.  Functions/Limits
  35.     3.1.  What is a Archive?
  36.     3.2.  Functions and Possibilies of IntuiFace
  37.     3.3.  Limits of IntuiFace
  38. 4.  Handling
  39.     4.1.  The "Defaults" Window, first Installation
  40.     4.2.  The gadgets in the main Window
  41.     4.3.  Creating an Archive
  42.     4.4.  Extracting file from Archive
  43. 5.  Error Messages
  44. 6.  Known Bugs/Problems
  45.     6.1.  Known bugs
  46.     6.2.  Problems/Limits
  47. 7.  Further Developement
  48.     7.1.  Future Options
  49.     7.2.  Your Bug Report
  50.     7.3.  Your Suggestion
  51.  
  52.  
  53. 1.  Introduction
  54. ----------------
  55.  
  56.  
  57. 1.1.  Copyright
  58. ---------------
  59.  
  60. IntuiFace  (C)opyright 1990 by Matthias Zepf
  61.                                Riegeläckerstraße 27
  62.                                D-7250 Leonberg
  63.                                West Germany
  64.                                (+49) 7152 41917
  65. All rights reserved.
  66.  
  67.  
  68. 1.2.  Distribution
  69. ------------------
  70.  
  71. IntuiFace  is  socalled SHAREWARE.  This means you are allowed to make
  72. as  lot as copies you want.  Give this copies to your friends, but you
  73. must not make any commercial profit!  The German Public Domain distri-
  74. butor "Stefan Ossowski" may not distribute this program!
  75.  
  76. If  you  like  IntuiFace  and  you want to use register at the author.
  77. Send  US-$  15.- to the author.  As registered user you are allowed to
  78. use  IntuiFace  and  you  will  get one (1) free update if a update is
  79. necessary (this is selected by the author only).
  80.  
  81.  
  82. 1.3.  Registered Users
  83. ----------------------
  84.  
  85. The following Amiga users are registered and legal users of IntuiFace:
  86.  
  87. 001. Markus Stoll                        D-7000 Stuttgart-Heumaden
  88. 002. Hanns-Eugen Stöffler                D-7000 Stuttgart-Feuerbach
  89. 003. Ingo Feulner                        D-7030 Böblingen
  90. 004. Markus Mayer                        D-7250 Leonberg-Warmbronn
  91. 005. Heiko Rath                          D-6150 Weiterstadt
  92.  
  93. --------------------------------------------------------------------------
  94.  
  95.  
  96. 2.  Installation
  97. ----------------
  98.  
  99.  
  100. 2.1.  Installation on a disk based system
  101. -----------------------------------------
  102.  
  103. The  installation  of  IntuiFace on any disk is very simple.  There is
  104. only the programm "Intuiface" and the icon "IntuiFace.info".  You will
  105. also  find  the  manual  called  "IntuiFace.Doc" and its icon.  (It is
  106. possible  the  name  changed to something like "IntuiFace_Eng" for the
  107. english  version.)  If  you  want  to copy IntuiFace to your disk then
  108. simply  drag  its  icon  and move it to the destination.  You may also
  109. copy  it  with CLI/Shell by using a command like "copy df0:IntuiFace#?
  110. Workbench:Utilities".   The  configuration of IntuiFace is explaned in
  111. chapter 4.1.
  112. Please  verify  that the commands "run", "execute", "cd", "endcli" and
  113. "copy"  are  available in the logical directory "C:".  IntuiFace needs
  114. these commands to run correct.
  115.  
  116.  
  117. 2.2.  Installation on a harddisk based system
  118. ---------------------------------------------
  119.  
  120. The  installation  of  IntuiFace  on  harddisks  is  also very simple.
  121. Please  read  first  the instructions for installation on a disk based
  122. system (chapter 2.1.), there you will find list of the supplied files.
  123. Install  IntuiFace on harddisk in the same way as you would install it
  124. on  a disk based system, by moving the Intuiface icon to your selected
  125. harddisk partition.
  126. Please  verify  that the commands "run", "execute", "cd", "endcli" and
  127. "copy"  are  available in the logical directory "C:".  IntuiFace needs
  128. these commands to run correct.
  129.  
  130.  
  131. 3.  Functions/Limits
  132. --------------------
  133.  
  134.  
  135. 3.1.  What is a Archive?
  136. ------------------------
  137.  
  138. Long  time  ago,  a program called "Arc" was developed for MS-DOS.  It
  139. made  it  possible to compress serveral files into one file.  This was
  140. especially  done  for  transfer  via  telephone lines, to cut down the
  141. costs.
  142. Nowadays  there  are serveral archive programs, called "PkArc", "Zoo",
  143. "PkZip",  "LhArc",  "Ice", "Pak", etc.  The most of them are available
  144. for the Amiga computer, too.  Here is a list:
  145.  
  146. - ARC        : The oldest one, nearly everbody has got it.
  147.  
  148. - ZOO        : Very fast one with high compression rate.
  149.  
  150. - LHARC        : Not very fast, but the highest compression rate.
  151.  
  152. - PKAZIP    : High compression rate, not very fast but not too
  153.           slow and nice Intuition interface for simple use.
  154.  
  155.  
  156. 3.2.  Functions and Possibilities of IntuiFace
  157. ----------------------------------------------
  158.  
  159. Only  PkAZip  has  got  a Intuition interface for simple use.  All the
  160. other  archive  programs  must be directed by CLI-commands.  IntuiFace
  161. gives  you  a Intuition interface for the other three archive programs
  162. (Arc, Zoo and LhArc)!
  163. Of  course,  the  programs  Arc,  Zoo  and  LhArc  are not included in
  164. IntuiFace.  IntuiFace is only an interface between the archive program
  165. and  the use to make it very simple for the user to create and extract
  166. archives.
  167.  
  168.  
  169. 3.3.  Limits of IntuiFace
  170. -------------------------
  171.  
  172. The  programs Arc, Zoo and LhArc give you different possibilies how to
  173. handle  and  modify  an  archive.   There  are serveral functions like
  174. archiving, extracting, deleting, showing, etc.
  175.  
  176. IntuiFace only supports the most important functions:
  177.  
  178. 1. Create an archive and add files to it.
  179. 2. Add files to an exstiting archive (works in the same way as 1.).
  180. 3. Show contents of an archive.
  181. 4. Extract files of an archive.
  182.  
  183. All  the  other  functions  are not supported.  If you need one of the
  184. other functions, you must open a CLI and type them in.
  185.  
  186.  
  187. ----------------------------------------------------------------------
  188.  
  189.  
  190. 4.  Handling
  191. ------------
  192.  
  193.  
  194. 4.1.  The "Defaults" window, first installation
  195. -----------------------------------------------
  196.  
  197. Before  you  start  using  IntuiFace,  you  must configurate it.  This
  198. configaration  is  saved and then loaded as standard for future use of
  199. IntuiFace.   Please open Intuiface by double click on its icon or type
  200. IntuiFace in a CLI.  A window named "IntuiFace" will be opened on your
  201. Workbench  screen.  The  different  gadgets  will  be explained later.
  202. Please  click  on the gadget "Defaults" (middle, right).  A new window
  203. opens.
  204. This  new  window  (called  "Intuiface  Defaults")  gives you serveral
  205. gadgets to configurate IntuiFace.  If you don't know how to use string
  206. gadgets, please look into your AmigaDOS manual.
  207.  
  208. - Default Destination Dir
  209.  
  210. You may enter the path and name of a directory here, which you want to
  211. use  as  your  default directory for archives and files extracted from
  212. archives.
  213.  
  214. - Extract with path (only Zoo archives)
  215.  
  216. If  you  select  this  option  files archived in a Zoo archive will be
  217. extracted  with  its complete path.  Arc doesn't support storing paths
  218. into  an  archive  and  files  in  LhArc  archives  are extracted with
  219. complete path every time.  Your are not able to turn this of.
  220.  
  221. - Convert path
  222.  
  223. If  you  type  in  "Fonts:" as source directory in IntuiFace, "Fonts:"
  224. will leave in that string gadget if this switch is turned off.  If you
  225. turn   on   this   switch,   IntuiFace   will   convert   "Fonts:"  to
  226. "Workbench:Fonts"  (or  equivalent).   So  the  logical  path  will be
  227. converted to the real physical path.
  228.  
  229. - Save every Quit
  230.  
  231. If  you  switch  on  this  switch  every  time you quit IntuiFace, the
  232. defaults will be saved.  So IntuiFace will start up every time in that
  233. configaration, you leaved it last time.
  234.  
  235. - Show >info< files
  236.  
  237. Info  files are icons on the Workbench.  If you select this option the
  238. info  files  are  also  shown in IntuiFace's list.  If it is off, info
  239. files are hidden.  Turning on the function will automatically turn off
  240. the next switch.
  241.  
  242. - Automatically archive >info< files
  243.  
  244. If  this  switch  is  on,  icons  (info  files)  will be automatically
  245. archived, if file with icon is archived.  Turning on the function will
  246. automatically turn off the prev.  switch.
  247.  
  248. - Window position
  249.  
  250. In this two string gadgets you may enter the position of the IntuiFace
  251. window.  The window will automatically moved there, if the position is
  252. inside the borders of the Workbench screen.
  253.  
  254. - Current (window position)
  255.  
  256. If  you  click  onto  the  "Current"  gadget the values of the current
  257. window  position of IntuiFace will be entered into the window position
  258. string gadgets.
  259.  
  260. - Path for ...
  261.  
  262. In this string gadgets you must enter the path and name of the archive
  263. programs.   Only  when  entered a correct path and name IntuiFace will
  264. work correct.
  265. IntuiFace requires the following archive programs:
  266.  
  267. - ARC V0.23 - comp. MS-DOS V5.0
  268. - ZOO V2.01
  269. - LHARC V1.10
  270.  
  271. If  you  do  not  own  this  programs look into local BBS' or ask your
  272. dealer  for  this  public domain programs.  You will also find them on
  273. Fish disks.
  274. If  you  do not use the correct version of an archive program I cannot
  275. guarantee  the  correct work of Intuiface.  It is possible you get any
  276. errors or Gurus!
  277.  
  278. Now  an example:  If your program "Arc" is in your directory "C:" then
  279. please  enter  in  the  string  gadget  "Path  for  ARC" exactly this:
  280. "C:Arc".  Please do it in the same way for Zoo and LhArc.
  281.  
  282. When  entered all default data you should click onto "Save" to save it
  283. on  disk  or  harddisk.   The  defaults  will  be  saved  to  the file
  284. >S:IntuiFaceDefaults<.   If you click onto "Use" the data will be used
  285. for  this  session  but  not  saved.  If you click onto "Cancel" every
  286. changes are gone.
  287.  
  288. At   your   next   IntuiFace   session   this  configuration  will  be
  289. automatically taken from >S:IntuiFaceDefaults<.
  290.  
  291.  
  292. 4.2.  The gadgets in the main window
  293. ------------------------------------
  294.  
  295. Now  back  in  the  main window of IntuiFace I'll explain the differnt
  296. gadgets available:
  297.  
  298. - Parent Dir
  299.  
  300. Click  on  this  gadget  to  go  to  the  parent directory (as sources
  301. directory).   If  you  have  reached the root directory of the device,
  302. there will come up warning message.
  303.  
  304. - Devices
  305.  
  306. Click  to this gadget and there will be a list of all mounted volumes.
  307. Now you are able to select a volume by double click onto that volume.
  308.  
  309. - About
  310.  
  311. A window with information about IntuiFace will come up.
  312.  
  313. - Defaults
  314.  
  315. Look chapter 4.1.
  316.  
  317. - All
  318.  
  319. Select all entries.
  320.  
  321. - None
  322.  
  323. Deselect all entries.
  324.  
  325. - Arc, Zoo, LhArc
  326.  
  327. Create an archive. Look chapter 4.3.
  328.  
  329. - Extract
  330.  
  331. Extract files from archive. Look chapter 4.4.
  332.  
  333. - Arrows, Prop Gadget, File and Dir List
  334.  
  335. The  file  and  dir list show the contents of any directory (as source
  336. directory).  If that list has more entries than rows, you will be able
  337. to  control the displayed entries with the arrows and the prop gadget.
  338. All arrows have the same function.
  339. To  select  or deselect an entry simple click onto it.  If you want to
  340. select  more  than  one entry then hold left mouse botton and move the
  341. mouse  point  across  all  the  wished entries.  All entries under the
  342. pointer will be selected/deselected.
  343. On the leftmost side of the list you see special information about the
  344. entry.   A  directory is indicated by "Dir>".  Double click onto a dir
  345. entry  will  bring  up the contents of this directory.  "Arc>", "Zoo>"
  346. and  "LhArc>"  indicate  archive files.  Double click on archive files
  347. will  bring up the archive contents for extracting.  Double click onto
  348. a "Device>" will bring up the root directory of that device.
  349.  
  350. - String Gadgets
  351.  
  352. The  source  string gadget every time shows the current path.  You may
  353. also  edit  this string gadget to change path.  The destination string
  354. gadget  shows  the  destination  path.  To change this path click into
  355. string gadget and edit contents.
  356.  
  357.  
  358. 4.3.  Create an archive
  359. -----------------------
  360.  
  361. Creating  an  archive  is  very simple by using IntuiFace.  Select the
  362. files you want to archive, type a path and archive name in destination
  363. string  gadget  and click onto the desired archive program gadget.  If
  364. you  made  everything  correct, a window will open and you can look to
  365. the archive program's output.
  366.  
  367.  
  368. 4.4.  Extract files from an archive
  369. -----------------------------------
  370.  
  371. Extracing  files  is also very simple.  Double click onto the entry of
  372. the  desired  archive.  Contents will come up.  Select all entries you
  373. want  extract  and  click  onto extract gadget.  Of course, you should
  374. select a possible destination path with enough space for the files you
  375. want  to  extract.  If you made everything correct, a window will open
  376. and you are able to watch the archive program's output.
  377.  
  378.  
  379. 5.  Error messages
  380. ------------------
  381.  
  382. - Please enter correct destination directory.
  383.  
  384. The  path of your destination directory is not possible.  Please enter
  385. a correct one.
  386.  
  387. - This directory or file does not exist.
  388.  
  389. You  typed  in  a  path  and name of a directory or file that does not
  390. exist.   Please  try  again or use try and error principle by clicking
  391. onto  devices  gadget  and  then going through directories by clicking
  392. onto them.
  393.  
  394. - Directories cannot be archived.
  395.  
  396. Complete directories cannot be archived with the current version.
  397.  
  398. - Devices cannot be archived.
  399.  
  400. Devices and volumes cannot be archived.
  401.  
  402. - Archive name is missing in lower gadget.
  403.  
  404. You  did  not enter a name for archive to create.  Please enter a path
  405. and name in lower/destination string gadget.
  406.  
  407. - Wrong archive program was choosen.
  408.  
  409. You  tried  to  use a archive program not fitting to the suffix of the
  410. archive  name.   Please  remove  the  suffix  or use the corresponding
  411. archive program.
  412.  
  413. - Please enter a complete path for destination.
  414.  
  415. You  did  not  enter  a  complete  and  correct  path  for destination
  416. directory.  Correct path and try again.
  417.  
  418. - Destination path not possible.
  419.  
  420. The  destination  path  you entered is not possible.  Correct path and
  421. try again.
  422.  
  423. - Problems with Workbench. Moving window is not possible.
  424.  
  425. There  are  some  problems  with the system software.  Better stop all
  426. activities and reset your Amiga.  Then try again.
  427.  
  428. - Window position not possible.
  429.  
  430. The desired position is not possible. Standard position will be used.
  431.  
  432. - Values for window don't fit.
  433.  
  434. The  values  for  window position you entered are not on the Workbench
  435. screen.  Please try again or move window and click current gadget.
  436.  
  437. - >S:IntuifaceDefaults< cannot be opened.
  438.  
  439. Something is accessing >S:IntuiFaceDefaults<.  Saving your defaults is
  440. not possible.
  441.  
  442. - Not enough RAM for save available.
  443.  
  444. There  is  not  enough  free memory for the desired operation.  Please
  445. closed other applications and try again.
  446.  
  447. - Root directory reached.
  448.  
  449. You tried to go to the parent dir, but your are in the root directory.
  450. There is no parent dir available.
  451.  
  452. - Archive program cannot be found.
  453.  
  454. The  selected archive program is missing.  Please goto defaults window
  455. and set the correct path for the desired archive program.
  456.  
  457. - Fatal error while accessing achive. See manual.
  458.  
  459. An  error  occured  while  access  the archive contents.  Propably the
  460. archive is corrupt.  Please try to extract files using Intuiface.
  461.  
  462. - Temp file in directory >T:< cannot be created.
  463.  
  464. You didn't assign "T:" to any directory or device is write protected.
  465.  
  466. - There is not enough RAM for this operation.
  467.  
  468. Close some other applications to free some memory and try again.
  469.  
  470.  
  471. 6.  Known Bugs/Problems
  472. -----------------------
  473.  
  474.  
  475. 6.1.  Known Bugs
  476. ----------------
  477.  
  478. There are no known bugs in IntuiFace V1.00.
  479.  
  480.  
  481. 6.2.  Problems/Limits
  482. ---------------------
  483.  
  484. The following limits are caused by programing technic of IntuiFace:
  485.  
  486. - Paths may contain maximum of 255 chars.
  487.  
  488. - The  maximum  of  entries  in  files and dir list is only limited by
  489.   available  free  memory.   It  will  take  some  time to read a long
  490.   directory from disk/harddisk.
  491.  
  492.  
  493. 7.  Further Developement
  494. ------------------------
  495.  
  496.  
  497. 7.1.  Future Options
  498. --------------------
  499.  
  500. IntuiFace V1.00 was developed on an Amiga 1000 with 2.5 Meg of RAM and
  501. harddisk  by using Kickstart and Workbench 1.3 Rev.  34.28.  IntuiFace
  502. was  tested  on an Amiga 2500 and it works correct.  IntuiFace is able
  503. to   run   correct   on   higher  Kickstart  and  Workbench  versions.
  504. Developement  took about 14 week-ends.  IntuiFace is written completly
  505. in Assembler.
  506.  
  507. Following further developement is planned:
  508.  
  509. - new  version  if  there  will  come  up a new version of Arc, Zoo or
  510.   LhArc, inkomp.  to the old one.
  511.  
  512. - new  version  if  there  will  come up a new archive program without
  513.   Intuition interface.
  514.  
  515.  
  516. 7.2.  Your Bug report
  517. ---------------------
  518.  
  519.  
  520. If you will find an error/bug in IntuiFace please write to:
  521.  
  522.     Matthias Zepf
  523.     Riegeläckerstraße 27
  524.         D-7250 Leonberg
  525.     West Germany
  526.  
  527. If  you  are  able  to  use  electronic  mail,  you'll reach me in the
  528. following nets:
  529.  
  530. sub-net :  ...!doitcr!nadia!amylnd!agnus -or-
  531.            agnus@amylnd.stgt.sub.org
  532. cbm-net :  ...!cbmvax!cbmehq!cbmger!isolde!amylnd!agnus
  533. internet:  ...!uunet!cbmvax!cbmehq!cbmger!isolde!amylnd!agnus -or-
  534.            agnus@amylnd.stgt.sub.org
  535. Fido-net:  Matthias Zepf @ 2:507/630.7633
  536.  
  537. Of  course,  you may reach me by a phone call.  Please dial (+49) 7152
  538. 41917,  but remember current time!  Please call only between 18.00 and
  539. 23.00 o'clock CET (Central European Time)!!
  540.  
  541. If  you  write  a  error  report, please make it as exact as possible.
  542. Write also down version numbers of IntuiFace, system software, archive
  543. programs, etc.
  544.  
  545.  
  546. 7.3.  Your Suggestion
  547. ---------------------
  548.  
  549. If  you  think  there  is  something to do better in IntuiFace, please
  550. write to the same address listed in chapter 7.2.
  551.  
  552.