home *** CD-ROM | disk | FTP | other *** search
/ Aminet 33 / Aminet 33 - October 1999.iso / Aminet / util / misc / VisualGuide.lha / VisualGuide / VisualGuide.help next >
Encoding:
Text File  |  1999-07-29  |  11.2 KB  |  309 lines
  1.  
  2.                                VisualGuide 2.74
  3. ----------------------------------------------------------------------------
  4.  
  5. · Introduction
  6.  
  7.   Makes file-list in AmigaGuide® format from your directories.
  8.   Include: Name, Lenght, Version, Date, Time, Comment.
  9.  
  10.  
  11. · Features
  12.  
  13.   o Executable from CLI and WB.
  14.   o Hard and Soft links support.
  15.   o Version recognizing.
  16.   o MUI interface.
  17.  
  18.  
  19. · Requirements
  20.  
  21.   o For CLI version: AmigaOS 3.x and higher.
  22.   o For GUI version: AmigaOS 3.x and MUI 3.8 and higher.
  23.   o Patched "Version" command (Included or Aminet)
  24.  
  25.  
  26. · Installation
  27.  
  28.   Copy VisualGuide where do you want.
  29.  
  30.  
  31. · Usage
  32.  
  33.                                  CLI Options
  34.                                  -----------
  35. FROM            - Source path. This can be device name or directory.
  36. TO              - Target file path (.guide adding automaticly)
  37. VERSION (VER)   - Enable recognizing version for every listed file. If you scan
  38.                   verymany files/dirs this operation can take some much time.
  39.                   Warning!!! Included Version command have fixed bug with
  40.                   looping when in last 4 bytes have "$"
  41. NOICONS         - Disable saving .info into guide.
  42. NODATE          - Disable saving date into guide.
  43. NOTIME          - Disable saving time into guide.
  44. NOCOMMENT       - Disable saving comment into guide.
  45. INFO            - Filename of included information file.
  46.                 - It may be ASCII file or GUIDE.
  47. HIDDEN          - Dont show in guide files/dirs with "h" flags.
  48. NOGUI           - Disable GUI opening.
  49. NOTE            - Write comment for your file-list.
  50. BUFFER          - Set Buffer size.
  51. TASKPRI         - Set Task priority
  52.  
  53.  Note: You can break listing process by pressing CTRL+C.
  54.  
  55.                                  GUI Options
  56.                                  -----------
  57. Source          - Source path. Same in CLI option.
  58. Destination     - Target file path. Same in CLI option.
  59. Note            - Comment for your file-list, will be added into guide.
  60. Version         - (Checkmark) Enable/Disable version recognizing.
  61. NoIcons         - Disable saving .info in guide.
  62. NoDate          - Disable saving date into guide.
  63. NoTime          - Disable saving time into guide.
  64. NoComment       - Disable saving comment into guide.
  65. Information     - Filename of included information file. It may be ASCII file or GUIDE.
  66. Hidden          - Dont show in guide files/dirs with "h" flags.
  67.  
  68.  
  69.  Note: Anytime you can stop listing process by pressign Abort button.
  70.  
  71.  
  72. · Limitations
  73.  
  74.  VisualGuide use temporary file with fixed name, therefore you cannot run more
  75.  than only one time.
  76.  
  77.  
  78. · History
  79.   o 2.74 - Fixed Enforcer Hit in Write procedure
  80.   o 2.73 - Changed author EMail address  (Sorry)
  81.   o 2.72 - Small optimization speed and size in the procedure "Scan Files".
  82.            Add argument and tooltype "TASKPRI".
  83.            Revorked priority system 
  84.   o 2.71 - Chnaged internal date and time format.
  85.            Seriously reworked internal buffer format.
  86.            Rewrited sorting procedure.
  87.            Speedup saving into guide, when increase saving buffer up to 100Kb.
  88.            You can change buffer size via BUFFER argument or Tooltypes.
  89.   o 2.70 - Added status string.
  90.            Added locale support.
  91.            Reworked "CycleChain" system.
  92.            Reworked "Hotkeys" system for support diffrent locales.
  93.            Added Drag&Drop support.
  94.            Added ToolType'îâ support.
  95.            Fixed small mistake. Now on running VG, in MUI interface correctly
  96.            sets CLI arguments like NODATE, NOTIME è NOCOMMENT.
  97.            You cannot run VG twice (GUI only!).
  98.            Full path to current directory now shows in title of MultiView.
  99.            Rewrited adding Info. (Founded bug in the AsimCDFS)
  100.   o 2.64 - Total size conter is reworked.
  101.            FIXED! Yep is really fixed bug "Comment-Time".
  102.            Some optimization.
  103.   o 2.63 - Add arguments NODATE/S, NOTIME/S, NOCOMMENT/S. Switch off printing: date,
  104.            time and comment into guide, when use guide will be smaller.
  105.            BugFixed recognizing version engine. Before some files cant return right
  106.            version (try 'version version' and 'version name version').
  107.            Reworked GUI.
  108.   o 2.62 - Try to fix bug "Comment-Time".
  109.   o 2.61 - Added bubble help.
  110.   o 2.6  - Added NoIcons, Hidden, Info.
  111.   o 2.5  - Some cosmetic update.
  112.   o 2.4  - First Aminet release.
  113.   o 2.3  - Fixed work with Version.
  114.   o 2.2  - Added version option identify
  115.   o 2.1  - Now work on non-Blizkick systems too.
  116.   o 1.0  - Initial release.
  117.  
  118.  
  119. · Future
  120.  
  121.   o Internal Version command (It will allows run more than one VisualGuide)
  122.   o FTP support for file-list mirroring from ftp-sites.
  123.   o Save Binary + CGI script for publishing catalogs on the web.
  124.   o Aminet support. Getting INDEX file and set comments lines.
  125.  
  126.  
  127. · Author
  128.  
  129. AmiS  amis@cch.pmc.ru
  130.  
  131.  
  132. · Thanks
  133.  
  134. Idea and English Documentation translation - Efim Shuvikov.
  135. Programming Help and Russian Documentation - Denis Sotchenko.
  136. BetaTesting - Agr^Sr, StriderSR, J.Max.
  137.  
  138.  
  139.  
  140.  
  141.  
  142.  
  143.                            Russian Documentation.
  144.  
  145.  
  146.  VisualGuide - ãèïåðòåêñòîâûé êàòàëîãèçàòîð
  147.  
  148. 1) Íàçíà÷åíèå
  149.  
  150.    VG ñîáèðàåò èíôîðìàöèþ î çàäàííîì äèñêå èëè äèðåêòîðèè, è ñîñòàâëÿåò
  151. ãèïåðòåêñòîâûé îò÷¸ò â ôîðìàòå AmigaGuide.  Äëÿ êàæäîãî ôàéëà, êðîìå
  152. îñíîâíûõ äàííûõ (èìÿ/äëèíà/äàòà/âðåìÿ/êîììåíòàðèé) ìîæåò áûòü îïðåäåëåíà
  153. âåðñèÿ.  Êàæäàÿ äèðåêòîðèÿ ïðåäñòàâëÿåòñÿ êàê îòäåëüíàÿ ñòðàíèöà (node).
  154. Êðîìå òîãî, ïðîãðàììà ïðèâîäèò îáùåå êîëè÷åñòâî äèðåêòîðèé, ôàéëîâ, ëèíêîâ
  155. è îáùèé îáú¸ì âñåõ ôàéëîâ êàê äëÿ êàæäîé äèðåêòîðèè, òàê è äëÿ âñåãî
  156. äåðåâà äèðåêòîðèé â öåëîì.  Ê äîêóìåíòó äîáàâëÿåòñÿ ïîëüçîâàòåëüñêèé
  157. êîììåíòàðèé - òåêñòîâàÿ ñòðîêà ïðîèçâîëüíîãî ñîäåðæàíèÿ.
  158.  
  159. 2) Âîçìîæíîñòè
  160.    · Çàïóñê êàê èç CLI, òàê è èç WB
  161.    · Ïîääåðæêà Hard è Soft ëèíêîâ.
  162.    · Îïðåäåëåíèå âåðñèé.
  163.    · MUI supported
  164.  
  165. 3) Òðåáîâàíèÿ ê ñèñòåìå
  166.  
  167.    Äëÿ ðàáîòû VG â CLI íåîáõîäèìà AmigaOS âåðñèè 3 è âûøå.
  168.  
  169.    Äëÿ ðàáîòû GUI íåîáõîäèì MUI (Magic User Interface) âåðñèè 3.8 è âûøå.
  170.  
  171. 4) Èíñòàëëÿöèÿ
  172.  
  173.    Ïîëîæèòå VisualGuide â ëþáóþ äèðåêòîðèþ, ïðîïèñàííóþ â path.
  174.  
  175. 5) Èñïîëüçîâàíèå ïðîãðàììû.
  176.  
  177.    Ïðîãðàììà ìîæåò óïðàâëÿòüñÿ êàê èç CLI, òàê è ñ ïîìîùüþ GUI.
  178.  
  179.    Ïðè ðàáîòå èç CLI äîñòóïíû ñëåäóþùèå êëþ÷è:
  180.  
  181.    FROM     - çàäà¸ò èñõîäíóþ äèðåêòîðèþ.  Ýòî ìîæåò áûòü êàê èìÿ äèñêà, òàê è
  182.               ïîëíûé ïóòü ê ëþáîé äèðåêòîðèè íà äèñêå.
  183.  
  184.    TO       - ðåçóëüòàò ðàáîòû ïðîãðàììû (ôàéë â ôîðìàòå AmigaGuide)
  185.  
  186.    VERSION  - îçíà÷àåò, ÷òî ïðè ñêàíèðîâàíèè äèðåêòîðèè áóäóò îïðåäåëÿòüñÿ
  187.               âåðñèè ôàéëîâ.  Âåðñèè îïðåäåëÿþòñÿ ñèñòåìíîé êîìàíäîé version,
  188.               è ýòî ìîæåò ïðîäîëæàòüñÿ î÷åíü äîëãî.
  189.  
  190.               ÂÍÈÌÀÍÈÅ!!!!: Â êîìïëåêòå ïðèëàãàåòñÿ èñïðàâëåííûé version.
  191.               Ñòàíäàðòíàÿ êîìàíäà version ðàáîòàåò êðàéíå íåóñòîé÷èâî.
  192.  
  193.    NOICONS  - ïîäàâëÿåò ïå÷àòèü èêîíîê.
  194.  
  195.    INFO     - Çàäà¸ò ïîäêëþ÷àåìûé èíôîðìàöèîííûé ôàéë.
  196.               Ôàéë ìîæåò áûòü â ôîðìàòå ASCII òåêñò, èëè AmigaGuide
  197.  
  198.    HIDDEN   - Âñå ôàéëû è äèðåêòîðèè(ñ ñîäåðæèìûì) èìåþùèå ïðèçíàê hidden (ôëàã 'h'),
  199.               íå áóäóò îòîáðàæåíû â ãàéäå.
  200.  
  201.    NOICONS  - â ïîëó÷àåìîì ãàéäå áóäóò îòñóòñòâîâàòü ôàéëû #?.info.
  202.  
  203.    NODATE
  204.    NOTIME
  205.    NOCOMMENT  - íå îòîáðîæàòü ïîëÿ: Date, Time è Comment.
  206.  
  207.    NOGUI    - îçíà÷àåò ðàáîòó òîëüêî èç CLI.  Ãðàôè÷åñêèé èíòåðôåéñ âûçâàí íå
  208.               áóäåò, ïðîãðàììà ñðàçó ïðèñòóïèò ê ðàáîòå.  Ïðè îòñóòñòâèè ýòîãî
  209.               êëþ÷à ïðîãðàììà îòêðîåò îêíî è áóäåò îæèäàòü ðåàêöèè ïîëüçîâàòåëÿ.
  210.               Åñëè áûëè çàäàíû åù¸ êàêèå-ëèáî ïàðàìåòðû, îíè áóäóò çàðàíåå
  211.               óñòàíîâëåíû â èíòåðôåéñå.
  212.    NOTE     - êîììåíòàðèé ê êàòàëîãó, êîòîðûé áóäåò ïðîïèñàí â guide.
  213.    TASKPRI  - Óñòàíàâëèâàåò ïðèîðèòåò.
  214.  
  215.    Âûïîëíåíèå ïðîãðàììû ìîæåò áûòü ïðåðâàíî â ëþáîé ìîìåíò íàæàòèåì CTRL+C.
  216.  
  217.    Åñëè ïàðàìåòð NG íå óêàçàí, ïðîãðàììà ïðè ñòàðòå îòêðûâàåò îêíî.  Âñå
  218. ïàðàìåòðû ìîãóò áûòü ââåäåíû ñ ïîìîùüþ êëàâèàòóðû è ìûøè.  Êíîïêà Make
  219. Guide çàïóñêàåò âûïîëíåíèå, êîòîðîå ìîæåò áûòü ïðåðâàíî â ëþáîé ìîìåíò
  220. êíîïêîé Abort.
  221.  
  222. 6) Èçâåñòíûå íà äàííûé ìîìåíò îøèáêè
  223.  
  224. Ìíå íåèçâåñòíû.
  225.  
  226. 7) Ïëàíû íà áóäóùåå
  227.  
  228.    Â áóäóùèõ âåðñèÿõ ïðîãðàììû áóäåò ðåàëèçîâàí ðÿä íîâûõ âîçìîæíîñòåé äëÿ
  229. ðàáîòû ñ FTP.  Â ÷àñòíîñòè, ïðè ðàáîòå ñ Aminet èç êàæäîé äèðåêòîðèè áóäåò
  230. âûêà÷èâàòüñÿ ôàéë INDEX è íà åãî îñíîâå áóäóò ïîêàçàíû êîììåíòàðèè ê ôàéëàì.
  231.  
  232. 8) Îòëè÷èÿ îò ïðåäûäóùèõ âåðñèé
  233.  
  234. 2.4 -    ïåðâûé ðåëèç.
  235. 2.5 -    íåêîòîðûå êîñìåòè÷åñêèå óñîâåðøåíñòâîâàíèÿ.
  236. 2.6 -    äîáàâëåí ïàðàìåòð NOICONS
  237.     äîáàâëåí ïàðàìåòð INFO
  238.     äîáàâëåí ïàðàìåòð HIDDEN
  239.     Åñëè ïàðàìåòð NOTE îòñóòñòâóåò, â ãàéäå ïðîïàäàåò ñîîòâåòñòâóþùàÿ
  240.     ñòðîêà.
  241. 2.61 -    Äîáàâëåíû âñïëûâàþùèå ïîäñêàçêè.
  242. 2.62 -    ÂÐÎÄÅ èñïðàâëåíà îøèáêà "Comment-Time".
  243. 2.63 -    äîáàâëåíû ïàðàìåòðû NODATE/S, NOTIME/S, NOCOMMENT/S.  Îòêëþ÷àþò ïå÷àòü
  244.     äàò, âðåìåíè è êîìåíòàðèåâ, ÷òî çíà÷èòåëüíî óìåíüøàåò ðàçìåð êàòàëîãà.
  245.     Äîðàáîòàí ìåõàíèçì îïðåäåëåíèÿ âåðñèé. Ðàíåå ó íåêîòîðûõ ôàéëîâ áûëî
  246.     íåâîçìîæíî îïðåäåëèòü âåðñèþ (ïîïðîáóéòå 'version version' è
  247.     'version name version').
  248.     Íåìíîãî ïåðåðàáîòàí GUI.
  249. 2.64 -    Èçìåíåíèÿ â ïîäñ÷¸òå îáùåãî ðàçìåðà ôàéëîâ.
  250.     Òåïåðü ÎÊÎÍ×ÀÒÅËÜÍΠèñïðàâëåí ãëþê "Comment-Time".
  251.     (â åãî ïðîÿâëåíèè áûë âèíîâåí êîðÿâûé "ðóññêèé.language" äëÿ Win
  252.     êîäèðîâêè).
  253.     Íåáîëüøàÿ îïòèìèçàöèÿ.
  254. 2.65 -    Âñòðîåíà ïîääåðæêà Locale.
  255.     Ïîëíàÿ ïîääåðæêà MUI Short Help.
  256. 2.70 -    äîáàâëåíà Ñòàòóñ - ñòðîêà.
  257.     Ïåðåðàáîòàíà ñèñòåìà "CycleChain".
  258.     Áîëå óäîáíàÿ ðàáîòà ñî StringGadget.
  259.     Ïåðåðàáîòàíà ñèñòåìà "Hotkeys" äëÿ áîëåå ïîëíîé ñîâìåñòèìîñòè ñ ðàçëè÷íûìè êàòàëîãàìè.
  260.     Íåáîëüøèå èçìåíåíèÿ â èíòåðôåéñå.
  261.     Drag&Drop ïîääåðæêà.
  262.     Äîáàâëåíà ïîääåðæêà ToolType'îâ.
  263.     Èñïðàâëåíà íåáîëüøàÿ îøèáêà. Òåïåðü ïðè çàïóñêå VG, â MUI èíòåðôåéñå
  264.     ïðàâèëüíî îáðàáàòûâàþòñÿ CLI ïàðàìåòðû NODATE, NOTIME è NOCOMMENT.
  265.     Îòìåíÿåòñÿ âîçìîæíîñòü ïîâòîðíîãî ñòàðòà (GUI only!).
  266.     Â çàãîëîâêå îêíà MultiView ïðè ïîêàçå ãàéäà òåïåðü ñîîáùàåòñÿ ïîëíûé
  267.     ïóòü ê òåêóùåé äèðåêòîðèè.
  268.     Ïåðåïèñàíà ïðîöåäóðà äîáàâëåíèÿ Info - ôàéëà ê ãàéäó. (Íàéäåíà è
  269.     îáîéäåíà îøèáêà â AsimCDFS, íå ïîçâîëÿþùàÿ ïðåäûäóùèì âåðñèÿì VG ÷èòàòü
  270.     Info - ôàéë ñ CD).
  271. 2.71 -    Èçìåí¸í âíóòðåííèé ôîðìàò ïðåäñòàâëåíèÿ äàòû è âðåìåíè.
  272.     Ñèëüíî ïåðåðàáîòàí ôîðìàò âíóòðåííåãî áóôåðà.
  273.     Ïåðåïèñàíà ïðîöåäóðà ñîðòèðîâêè.
  274.     Íà÷àòà ðàáîòà ïî âñòðàèâàíèþ "Save Binary".
  275.         Íåìíîãî óñêîðåíà çàïèñü Guide, çà ñ÷åò óâåëè÷åíèÿ áóôåðà çàïèñè äî 100Kb.
  276.         Áîëåå òîãî, âû ìîæåòå ñàìè óïðàâëÿòü áóôåðîì, óêàçûâàÿ åãî âåëè÷èíó â
  277.         êèëîáàéòàõ â àðãóìåíòå BUFFER èëè â ñîîòâåòñòâóþùåì tooltype'å. Áîëåå
  278.         âûñøèé ïðèîðèòåò èìååò àðãóìåíò.
  279. 2.72 -  Íåáîëüøàÿ îïòèìèçàöèÿ ïî ñêîðîñòè è ðàçìåðó â ïðîöåäóðå ñêàíèðîâàíèÿ
  280.         ôàéëîâ.
  281.         Äîáàâëåí àðãóìåíò è ñîîòâåòñòâóþùèé tooltype, óñòàíàâëèâàþùèé ïðèîðèòåò.
  282.         Íåìíîãî ïåðåäåëàíà ñèñòåìà óñòàíîâêè ïðèîðèòåòîâ.
  283. 2.73 -  Èçìåíåíèÿ â àäðåñå àâòîðà (Sorry)
  284. 2.74 -  Óáðàí Enforcer Hit â ïðîöåäóðå çàïèñè.
  285.  
  286. 9) Îãðàíè÷åíèÿ
  287.  
  288.    Òåêóùàÿ âåðñèÿ VisualGuide'à èñïîëüçóåò äëÿ ðàáîòû temp-ôàéë ñ ÔÈÊÑÈÐÎÂÀÍÍÛÌ
  289. èìåíåì. Ñëåäîâàòåëüíî, íåëüçÿ çàïóñêàòü áîëåå îäíîé âåðñèè ýòîé ïðîãðàììû.
  290. Áóäüòå âíèìàòåëüíû.
  291.  
  292. 10) Ñâåäåíèÿ îá àâòîðå
  293.  
  294. Ñî ìíîé ñâÿçàòüñÿ ìîæíî òàê:
  295.  
  296. AmiS
  297. amis@cch.pmc.ru
  298.  
  299. 11) Áëàãîäàðíîñòè
  300.  
  301.    Õî÷ó âûðàçèòü ñâîè èñêðåííèå áëàãîäàðíîñòè, ëþäÿì ïîìîãàâøèì ìíå â ñîçäàíèè
  302. ýòîé ïðîãðàììû. Îñîáåííî õî÷ó îòìåòèòü ïîìîùü:
  303.      betatester'îâ:  Agr^Sr, StriderSR è J.MAX (Ìàêñèì Ãîëóáöîâ);
  304.      èäåéíîãî âäîõíîâèòåëÿ - S7reaM (Åôèì Øóâèêîâ).
  305.    Ñïåöèàëüíûé "ïîêëîí" RDC (Äåíèñ Ñîò÷åíêî), çà ïîìîùü â íàïèñàíèè äîêóìåíòàöèè
  306. è ïðåäîñòàâëåíèå íåêîòîðûõ àëãîðèòìîâ.
  307.  
  308. ----------------------------------------------------------------------------
  309.