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