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