home *** CD-ROM | disk | FTP | other *** search
/ 73.234.73.94.ip.orionnet.ru / 73.234.73.94.ip.orionnet.ru.tar / 73.234.73.94.ip.orionnet.ru / Far30b3000.x86.20121208.msi / Plugins.Install.txt < prev    next >
Text File  |  2012-01-15  |  5KB  |  122 lines
  1. 
  2.                     The Far File and Archive Manager
  3.                     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  4.                     How to install/uninstall plugins
  5.                     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  6.  
  7. This document contains instructions for the following procedures:
  8.  
  9. 1. Installing a plugin
  10.  
  11. 2. Removing a plugin
  12.  
  13. 3. Updating a plugin
  14.  
  15.  
  16. INSTALLING A PLUGIN
  17. ~~~~~~~~~~~~~~~~~~~
  18. 1. Read the plugin documentation (file_id.diz, readme.txt, whatsnew.txt
  19.    doc\*.*, etc.) to find the installation instructions, the minimum version
  20.    of Far required for correct plugin operation and so on.
  21.  
  22.    Install the plugin as described there.
  23.  
  24. 2. If there are no installation instructions in the documentation, or
  25.    if it was impossible to install the plugin according to the
  26.    instructions given in the documentation, install the plugin
  27.    the following way:
  28.  
  29.    a) Create a subfolder with an arbitrary name in the Plugins subfolder
  30.       of the folder where Far is installed.
  31.  
  32.    b) Copy the contents of the plugin distribution archive to that
  33.       folder (at the least *.dll, *.hlf, *.lng files should be copied)
  34.  
  35.    c) Restart Far manager.
  36.  
  37.    If successful, the plugin will add a menu item to the plugins menu or
  38.    will perform the necessary functions as described in its documentation.
  39.  
  40.    d) Press F1 then Shift-F2, select from the list the help topic that
  41.       corresponds to the installed plugin and carefully read it contents.
  42.  
  43.    e) Open the configuration menu of the installed plugin (F9,
  44.       Options->Plugins configuration), if it exists, and configure it.
  45.  
  46. 3. Tip: so the hotkeys in the plugins menu (F11) will not change after
  47.    changes in the plugins set, set them by pressing F4 in that menu.
  48.  
  49. REMOVING A PLUGIN
  50. ~~~~~~~~~~~~~~~~~
  51. 1. Read the plugin documentation (help, readme.txt, doc\*.*, etc.) to find
  52.    the instructions for removing the plugin. Remove the plugin as described
  53.    there.
  54.  
  55. 2. If there are no removal instructions in the documentation, or it was
  56.    impossible to remove the plugin according to the instructions given
  57.    in the documentation, remove the plugin in the following way:
  58.  
  59.    a) If there are several running Far Manager instances, close all but one.
  60.  
  61.    b) Move (F6) the subfolder of the plugin from the plugins folder (by
  62.       default it is located at the Plugins subfolder at the folder where Far
  63.       Manager is installed) to some other folder on the same drive (for
  64.       example one level up to the folder where Far Manager is installed).
  65.  
  66.    c) If the folder was successfully moved, restart Far and skip to
  67.       instruction `e' below.
  68.  
  69.    d) If the plugin has locked its working folder, and moving it is not
  70.       possible
  71.  
  72.       - quit Far Manager
  73.  
  74.       - start a new Far Manager instance with the "/p" command line
  75.         argument (Far Manager will start with no plugins).
  76.  
  77.    e) Delete the folder containing the plugin to be removed.
  78.  
  79.    f) If after removing the plugin you notice strange behaviour from the
  80.       Far Manager (incorrect plugins list in F11 plugins menu, crashes,
  81.       etc.) clear plugins cache:
  82.       Far.exe /clearcache
  83.  
  84. UPDATING A PLUGIN
  85. ~~~~~~~~~~~~~~~~~
  86.  
  87. Sometimes there will be a need to install new versions of existing plugins.
  88. The easiest way to do it is to remove the old version and then to install
  89. the new one (see previous sections). However this procedure may not always
  90. be satisfactory as it might lead to the lose of existing settings for that
  91. plugin. For this reason, updating a plugin is better done this way:
  92.  
  93. 1. Read the documentation of the new plugin version (file_id.diz,
  94.    readme.txt, whatsnew.txt, doc\*.*, etc.) for clarifications on how to
  95.    install the new version. Update the plugin in the way described there.
  96.  
  97. 2. If the documentation contains no instructions on how to update the
  98.    plugin, or if it was impossible to update the plugin according to the
  99.    instructions given in the documentation, then update the plugin in the
  100.    following way:
  101.  
  102.    a) Complete instructions `a' to `d' of the "Removing a plugin" section
  103.       above.
  104.  
  105.    b) If the old folder does not contain additional configuration, data
  106.       or any other important files, you can safely delete it, but it is
  107.       better to save it for a while at some other location to ease an
  108.       installation roll-back of the old version if the new version will
  109.       be unsatisfactory for some reason.
  110.  
  111.    c) Create a folder with the same name as the one of the old version in
  112.       the Plugins subfolder of the folder where Far is installed.
  113.  
  114.    d) Copy the contents of the plugin distribution archive to that
  115.       folder (at the least *.dll, *.hlf, *.lng files should be copied)
  116.  
  117.    e) If needed, copy there all additional configuration, data or any other
  118.       important files from the old version folder.
  119.  
  120.    f) Complete instructions `c' to `e' of the "Installing a plugin" section
  121.       above.
  122.