home *** CD-ROM | disk | FTP | other *** search
/ PC World 2002 March / PCWorld_2002-03_cd.bin / Software / Vyzkuste / far / Far1703.exe / TechInfo.txt < prev    next >
Encoding:
Text File  |  2001-04-16  |  20.6 KB  |  446 lines
  1.  
  2.                    FAR Manager Technical Information
  3.                    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  4.  
  5.    This document contains technical details on  some  options  that  can  be
  6.    set/changed only in the system registry.
  7.  
  8. 0. Key "/u <username>"
  9.    The data from [HKCU\Software\Far] is copied into [HKCU\Software\Far\Users]
  10.    only if the following registry branch doesn't exist:
  11.    [HKCU\Software\Far\Users\<username>].
  12.    That means that changing  parameters  described  below  will  not  affect
  13.    existing user  profiles.  Setting  for  "<username>"  should  be  changed
  14.    relative to the branch [HKCU\Software\Far\Users\<username>].
  15.  
  16. 1. [HKEY_CURRENT_USER\Software\Far\Editor]
  17.    "WordDiv":REG_SZ
  18.    Words delimiters. Used with  internal  editor  word  Ctrl-Left/Ctrl-Right
  19.    functions and "whole words" search.
  20.    Maximum 255 characters.
  21.  
  22. 2. [HKEY_LOCAL_MACHINE\Software\Far\System]
  23.    "TemplatePluginsPath":REG_SZ
  24.    This is a template for the personal plugins path.
  25.    Environment variables can be used here.
  26.    Example:
  27.     "%SystemRoot%\Profiles\%USERNAME%\FAR\Plugins"
  28.    This path will be used for newly created users (/u command  line  switch)
  29.    as the default value for:
  30.     "Options|System settings|Path for personal plugins"
  31.  
  32. 3. New command line parameter - "/co".
  33.    Forces FAR to load plugins from the cache only.
  34.    In this mode FAR loads  faster,  but  new  or  updated  plugins  are  not
  35.    recognized.
  36.    When "/co" command line parameter is used then "/p" is ignored.
  37.    Using this parameter makes sense ONLY if the list of installed plugins is
  38.    stable. After updating plugins it is necessary to load FAR  without  this
  39.    parameter.
  40.    If there is no plugins cache, no plugins will be loaded.
  41.  
  42. 4. [HKEY_CURRENT_USER\Software\Far\Policies]
  43.    "DisabledOptions":REG_DWORD
  44.    The key "Policies/DisabledOptions" of DWORD type controls access  to  the
  45.    items of the Options menu. The access is specified with a bit mask. If  a
  46.    bit is set, the access to the respective option is denied.
  47.  
  48.    Bit numbers:
  49.  
  50.      0 - System settings
  51.      1 - Panel settings
  52.      2 - Interface settings
  53.      3 - Languages
  54.      4 - Plugins configuration
  55.      6 - Confirmations
  56.      7 - File panel modes
  57.      8 - File descriptions
  58.      9 - Folder description files
  59.     11 - Viewer settings
  60.     12 - Editor settings
  61.     14 - Colors
  62.     15 - Files highlighting
  63.     17 - Save setup
  64.  
  65.    The numbers 5,10,13,16 are ignored.
  66.  
  67. 5. [HKEY_CURRENT_USER\Software\Far\Dialog]
  68.    "EULBsClear":REG_DWORD
  69.    The key "Dialog/EULBsClear" of  DWORD  type  specifies  behavior  of  the
  70.    BackSpace key  in  dialogs  for  edit  lines  which  have  the  condition
  71.    "UnChanged".
  72.    If the value is not equal to 0, pressing the BackSpace  key  deletes  the
  73.    entire line, just like pressing Del.
  74.  
  75. 6. [HKEY_CURRENT_USER\Software\Far\Panel]
  76.    "RightClickRule":REG_DWORD
  77.    The key "Panel/RightClickRule" of DWORD type specifies  behavior  of  the
  78.    right mouse button for the case if the button was  pressed  in  an  empty
  79.    panel column:
  80.      0 - position to and select the last file in the previous panel
  81.          column.
  82.      1 - position to the last file in the previous panel column, but do
  83.          not select it (as if the left mouse button was clicked).
  84.      2 - do not change position and do not select a file (default)
  85.    In any case, if the panel column is not empty, the file is selected.
  86.  
  87. 7. [HKEY_CURRENT_USER\Software\Far\System]
  88.    "AllCtrlAltShiftRule":REG_DWORD
  89.    The key "System/AllCtrlAltShiftRule" of DWORD type specifies behavior  of
  90.    the Ctrl-Alt-Shift combination for  temporary  hiding  of  the  interface
  91.    objects:
  92.    If the bit is set, hiding is enabled.
  93.  
  94.    Bit numbers:
  95.      0 - File panels
  96.      1 - Editor
  97.      2 - Viewer
  98.      3 - Help window
  99.      4 - Dialogs
  100.    By default hiding of all objects is enabled.
  101.  
  102. 8. [HKEY_CURRENT_USER\Software\Far\Panel]
  103.    "CtrlAltShiftRule":REG_DWORD
  104.    The key "Panel/CtrlAltShiftRule" of DWORD type specifies behavior of  the
  105.    Ctrl-Alt-Shift for temporary hiding of the panels:
  106.      0 - hide panels (like Ctrl-O).
  107.      1 - hide panels and command line.
  108.      2 - hide panels, command line and KeyBar.
  109.    The default value is 0.
  110.  
  111. 9. [HKEY_CURRENT_USER\Software\Far\System]
  112.    "CmdHistoryRule":REG_DWORD
  113.    The key "System/CmdHistoryRule"  of  DWORD  type  specifies  behavior  of
  114.    command history recalling in the command line, if Esc was  pressed  after
  115.    Ctrl-E/Ctrl-X:
  116.       0 - Change the position in history.
  117.       1 - Do not change the position in history.
  118.    The default value is 0.
  119.  
  120. 10.[HKEY_CURRENT_USER\Software\Far\XLat]
  121.    "CmdLineKey":REG_SZ
  122.    "DialogKey":REG_SZ
  123.    "EditorKey":REG_SZ
  124.    "AltCmdLineKey":REG_SZ
  125.    "AltDialogKey":REG_SZ
  126.    "AltEditorKey":REG_SZ
  127.    The "XLat/*Key" parameters of REG_SZ types specify the names of the  keys
  128.    used to invoke the Xlat feature to translate the selected block according
  129.    to the rules table (see %FAR%\Addons\Xlat\*.reg):
  130.       "AltCmdLineKey", "CmdLineKey" - in the command line.
  131.       "AltDialogKey",  "DialogKey"  - in the dialog input lines.
  132.       "AltEditorKey",  "EditorKey"  - in the internal editor.
  133.    Parameters "Alt*Key" allow to set alternative keys.
  134.    The default keys are CtrlShiftX.
  135.  
  136. 11.[HKEY_CURRENT_USER\Software\Far\System]
  137.    "MaxPositionCache":REG_DWORD
  138.    The key "System/MaxPositionCache" of DWORD type specifies the size of the
  139.    cache used to save bookmarks of the editor/viewer. The minimal  value  is
  140.    16, maximum is 128. The default value is 64.
  141.  
  142. 12.[HKEY_CURRENT_USER\Software\Far\Help]
  143.    "ActivateURL":REG_DWORD
  144.    The key "Help/ActivateURL" of DWORD type allows to control URL references
  145.    activation in HLF files:
  146.      0 - do not use URL activation.
  147.      1 - use URL activation.
  148.      2 - use URL activation, but show a warning message.
  149.    If activation is on and nothing happens, then  try  to  add  256  to  the
  150.    current value, it will enable the  second  activation  variant.  If  this
  151.    doesn't help, then email to farbugs@newmail.ru and specify the  following
  152.    information:  the  FAR  manager  version   number,   current   value   of
  153.    "ActivateURL" and the internet browser and mail client types.
  154.    The default value is 1.
  155.  
  156. 13.[HKEY_CURRENT_USER\Software\Far\Editor]
  157.    "BSLikeDel":REG_DWORD
  158.    The "Editor/BSLikeDel" key of  the  DWORD  type  allows  to  control  the
  159.    BackSpace key behavior in the editor.  If  this  value  is  nonzero,  the
  160.    BackSpace deletes the vertical block like the DEL key.
  161.    By default this value is equal to 1 (BS  deletes  the  selected  vertical
  162.    block).
  163.  
  164. 14.[HKEY_CURRENT_USER\Software\Far\Panel]
  165.    "CtrlFRule":REG_DWORD
  166.    The  "Panel/CtrlFRule"  parameter  (DWORD  type)  specifies  the   Ctrl-F
  167.    behavior. When it is 0, the pathname of the file is put into the  command
  168.    line as is, otherwise - as it  is  shown  on  the  panel  (that  is,  the
  169.    filename may be converted to lowercase or the  short  file  name  may  be
  170.    used).
  171.    The default is 1 (as it is shown on the panel).
  172.  
  173. 15.[HKEY_CURRENT_USER\Software\Far\System]
  174.    "SetAttrFolderRules":REG_DWORD
  175.    The "System\SetAttrFolderRules" key of DWORD type specifies the  behavior
  176.    of the attribute settings dialog when changing attributes  for  a  single
  177.    directory. If this option is set to  1,  then  the  "Process  subfolders"
  178.    checkbox will be unset for a single directory. Setting this option  to  0
  179.    enables the same behavior as in FAR prior to the version 1.70.
  180.    By default the value 1 is used  (the  checkbox  is  unset  for  a  single
  181.    directory).
  182.  
  183. 16.[HKEY_CURRENT_USER\Software\Far\XLat]
  184.    "WordDivForXlat":REG_SZ
  185.    Word delimiter symbols for the XLat function (for transliteration of  the
  186.    currrent word without selection). Can contain no more than  255  symbols.
  187.    The default value is ' \t!#$%^&*()+|"=\[]/@?'.
  188.  
  189. 17.[HKEY_CURRENT_USER\Software\Far\System]
  190.    "ExceptRules":REG_DWORD
  191.    The key "System\ExceptRules" of DWORD type  specifies  the  behavior  for
  192.    exception dialogs and is intended for plugin developers. If this value is
  193.    1, then the "Debugger" button will be added to the exception dialogs  and
  194.    pressing  it  will  invoke  the  system  debugger  registered  under  the
  195.    following registry key:
  196.    HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\AeDebug.
  197.    The value 0 means that this button will not be shown and the plugin  that
  198.    raises an exception will be unloaded. The default value is 0.
  199.  
  200. 18.[HKEY_CURRENT_USER\Software\Far\Editor]
  201.    "EditorF7Rules":REG_DWORD
  202.    The key "Editor/EditorF7Rules"  of  DWORD  type  allows  to  control  the
  203.    behavior of the search function in the editor. If this value is  0,  then
  204.    F7 (search) will work as in FAR prior to version  1.70.  By  default  the
  205.    value 1 is used (the first search begins from the current  position,  the
  206.    following search - from the next position).
  207.  
  208. 19.[HKEY_CURRENT_USER\Software\Far\Editor]
  209.    "ReadOnlyLock":REG_DWORD
  210.    The key "Editor/ReadOnlyLock" of DWORD type specifies the editor behavior
  211.    when opening a file with the "Read only" attribute  (additionally  it  is
  212.    possible to specify "System" and "Hidden" attributes).
  213.    Bits in the value:
  214.      0 - if set, then when opening a file with specified attributes,
  215.          the editor will disable file modification (as if Ctrl-L was
  216.          pressed after opening a file).
  217.      1 - if set, then the editor will show a warning dialog before
  218.          opening a file, asking whether the user wants to edit such a file.
  219.      2-4 always 0 (not used).
  220.      5 - if set, apply additionally to files with "Hidden" attribute.
  221.      6 - if set, apply additionally to files with "System" attribute.
  222.    For example, the value 0x43 means: warn and disable file modification
  223.    for files with "ReadOnly" and "System" attributes.
  224.    The default value is 0x0002 (show a warning dialog).
  225.  
  226. 20.[HKEY_CURRENT_USER\Software\Far\Editor]
  227.    "FileSizeLimit":REG_DWORD
  228.    The key "Editor/FileSizeLimit" of DWORD type specifies the  maximum  size
  229.    of files that can be edited in bytes. If the size of a file being  edited
  230.    exceeds the maximum size, a warning message will be shown before  opening
  231.    the file. The value 0 disables the size checking and the warning.
  232.    The default value is 0 (unlimited size).
  233.  
  234. 21.[HKEY_CURRENT_USER\Software\Far\Interface]
  235.    "HotkeyRules":REG_DWORD
  236.    The  key  "Interface/HotkeyRules"  of  DWORD  type  allows  to  select  a
  237.    mechanism for handling keyboard shortcuts:
  238.      1 - use an advanced shortcut handling mechanism not dependent on the
  239.          active keyboard layout.
  240.      0 - use a mechanism compatible with FAR 1.65 and lower.
  241.    This rule should be used only if you generate keyboard layouts using the
  242.    tool "Janko's Keyboard Generator" (http://solair.eunet.yu/~janko/engdload.htm)
  243.    or similar tools that produce incorrect .kbd files.
  244.    The default value is 1.
  245.  
  246. 22.[HKEY_CURRENT_USER\Software\Far\KeyMacros]
  247.    Registry section  containing  macro  commands.  All  macro  commands  are
  248.    divided into 9 areas:
  249.  
  250.    Area           Usage
  251.    ──────────────────────────────────────────────────
  252.    "Shell"        File panels
  253.    "Viewer"       Internal viewer
  254.    "Editor"       Internal editor
  255.    "Dialog"       Dialogs
  256.    "Search"       Quick file search
  257.    "Disks"        Select drive menu
  258.    "MainMenu"     Main menu
  259.    "Help"         Help window
  260.    "Info"         Info panel
  261.    "QView"        Quick view panel
  262.    "Tree"         Tree panel
  263.    "Other"        Screen grabber, vertical menus
  264.    ──────────────────────────────────────────────────
  265.    Each macro command has a separate branch in the registry. The name of the
  266.    branch is the name of the key to which the macro command is assigned.
  267.    Each macro command is described with the following parameters:
  268.  
  269.    Parameter             Type       Default   Assignment
  270.    ───────────────────────────────────────────────────────────────────────
  271.    "Sequence"            REG_SZ               Macro key combination
  272.    "DisableOutput"       REG_DWORD  1         Disable screen output
  273.                                               while playing macro
  274.    "RunAfterFARStart"    REG_DWORD  0         Play macro after FAR start
  275.    "EmptyCommandLine"    REG_DWORD  0         Play macro when command
  276.                                               line is empty
  277.    "NotEmptyCommandLine" REG_DWORD  0         Play macro when command
  278.                                               line is not empty
  279.    "NoFilePanels"        REG_DWORD  0         Do not execute in file panels.
  280.    "NoPluginPanels"      REG_DWORD  0         Do not execute in plugin panels.
  281.    "Description"         REG_SZ               Comment (not used)
  282.    ───────────────────────────────────────────────────────────────────────
  283.    "Sequence" is a mandatory parameter, other values can be omitted and  use
  284.    the default values.
  285.  
  286.    The "Sequence" key combination contains the list of keys in the macro  in
  287.    string form. Each key has its string equivalent, space  or  tab  are  key
  288.    separators. In FAR 1.70 beta 3 there are 7 new pseudo keys  (they  cannot
  289.    be entered from the keyboard!):
  290.       "$Day", "$Month", "$Year", "$Hour", "$Min", "$Sec" are replaced with
  291.        components of the current system time (the year is represented with
  292.        4 digits, all other components - with 2 digits with leading zeros).
  293.          For example "$Year . $Day . $Month . t x t" macro will generate a
  294.          string "2000.21.12.txt" for 21 December 2000.
  295.       "$MMode" - change macro mode
  296.          Toggles the display mode ("DisableOutput"). Works as a trigger.
  297.  
  298.    Notes:
  299.    a)  Errors  in  "Sequence"  key  combination   are   ignored.   The   key
  300.    specifications in the "Sequence" string are case insensitive.
  301.  
  302.    b) It is not possible to assign a macro to the Esc key interactively.
  303.  
  304.    c) On startup, FAR loads all macro commands  contained  in  the  registry
  305.    into memory. After creating a new macro, it is saved  into  the  registry
  306.    immediately, if "Auto save setup" is enabled.
  307.  
  308.    d) The flags "NoFilePanels" and  "NoPluginPanels"  have  higher  priority
  309.    than the flags "NoFolders" and "NoFiles".
  310.  
  311.    e) A macro command with the registry name starting with the character '~'
  312.    is considered inactive.
  313.  
  314.    f) To manipulate macro commands we recommend to use the  "Macro  browser"
  315.    plugin by Konstantin Melnikov. This  module  supports  viewing,  editing,
  316.    copying and moving macro commands to any areas, copying and moving  macro
  317.    commands to  other  FAR  users,  exporting  macro  commands  to  a  file,
  318.    inserting macro commands into the  editor,  entering  new,  removing  and
  319.    switching off macro commands installed in FAR.
  320.  
  321. 23.[HKEY_CURRENT_USER\Software\Far\System]
  322.    "CopyBufferSize":REG_DWORD
  323.    The key "System/CopyBufferSize" of DWORD type sets the size of  the  copy
  324.    buffer. If it is set to 0, the default size  is  used.  By  default,  the
  325.    value is 0, meaning that the size of the copy buffer is 0x10000 bytes.
  326.  
  327. 24.[HKEY_CURRENT_USER\Software\Far\Interface]
  328.    "ShiftsKeyRules":REG_DWORD
  329.    The key "Interface/ShiftsKeyRules" of DWORD type  allows  to  choose  the
  330.    mechanism for handling keyboard shortcuts  with  modifiers  Alt-,  Ctrl-,
  331.    Alt-Shift-, Ctrl-Shift-, Ctrl-Alt- in non-English keyboard layouts.
  332.      1 - use an advanced mechanism for handling keyboard shortcuts. For
  333.          example, Alt-NonEnglishCharacter will be translated to
  334.          Alt-EnglishCharacter (except for quick search in the panels).
  335.      0 - use the mechanism compatible with FAR 1.70 beta 2 and lower.
  336.    The default value is 1.
  337.  
  338.  
  339. 25.[HKEY_CURRENT_USER\Software\Far\Interface]
  340.    "CursorSize1":REG_DWORD
  341.    "CursorSize2":REG_DWORD
  342.    The keys "Interface/CursorSize1"  and  "Interface/CursorSize2"  of  DWORD
  343.    type allow to set  the  insert  mode  cursor  size  for  the  window  and
  344.    fullscreen modes of FAR. The values of the parameters (numbers between  1
  345.    and 100) specify the fraction of the character cell (in percents)  filled
  346.    by the cursor. The cursor can change from a completely  full  cell  to  a
  347.    horizontal line at the bottom of the cell.
  348.    The values equal to 0 allow to use the system console settings.
  349.    The default values are:
  350.      "CursorSize1"=15
  351.      "CursorSize2"=10
  352.  
  353.  
  354. 26.[HKEY_CURRENT_USER\Software\Far\System]
  355.    "CopyTimeRule":REG_DWORD
  356.    The key  "System/CopyTimeRule"  of  DWORD  type  specifies  the  mode  of
  357.    displaying the information on the average copying speed, elapsed  copying
  358.    time and the estimated time until the completion of the operation in  the
  359.    copy dialog.
  360.    Bit numbers:
  361.      0 - if set, the information is shown when copying to NUL.
  362.      1 - if set, the information is shown during normal copy operations.
  363.    As this function requires some time to gather statistics, it is  possible
  364.    that you won't see anything when copying  small  files  with  the  option
  365.    "Show total copy progress indicator" disabled.
  366.    Examples:
  367.      0x01 - show the information only when copying to NUL
  368.      0x02 - show the information only during normal copy operations
  369.      0x03 - always show the information about copying time and speed
  370.    The default value is 0 (display of information is disabled).
  371.  
  372. 27.[HKEY_CURRENT_USER\Software\Far\System]
  373.    "ConsoleDetachKey":REG_SZ
  374.    The key "System/ConsoleDetachKey" of REG_SZ type allows  to  specify  the
  375.    key combination that can be used to detach the FAR Manager console from a
  376.    non-interactive process running in it.
  377.    If a long-running process (for example,  archiving)  was  run  in  a  FAR
  378.    console, and for some reasons this very instance of  FAR  is  needed  (an
  379.    editor in the background) or it is undesirable to run a new  instance  of
  380.    FAR, pressing this key combination will create  a  new  console  for  FAR
  381.    where it will continue running as if the process has already  ended,  and
  382.    the process will continue working in the old console.
  383.    For example, the value of "ConsoleDetachKey" equal to "CtrlAltX"  assigns
  384.    the shortcut Ctrl-Alt-X to the detach function.
  385.    The default value is "" (no shortcut assigned).
  386.  
  387. 28.[HKEY_CURRENT_USER\Software\Far\Colors]
  388.    The registry branch describing file highlighting
  389.    (HKCU\Software\Far\Highlight) has been moved as a subbranch into
  390.    HKCU\Software\Far\Colors\Highlight.
  391.  
  392. 29.[HKEY_CURRENT_USER\Software\Far\System]
  393.    "WipeSymbol":REG_DWORD
  394.    The "System/WipeSymbol" key of DWORD type specifies the code of the
  395.    filler character for the "Wipe file" operation (Alt-Del). The lower byte
  396.    of the parameter is used.
  397.    The default value is 0.
  398.  
  399. 30.[HKEY_CURRENT_USER\Software\Far\Policies]
  400.    "ShowHiddenDrives":REG_DWORD
  401.    The key "Policies/ShowHiddenDrives" of DWORD type allows FAR to
  402.    use the Windows settings for hiding logical drives from the system
  403.    ("Hide Drives in My Computer")
  404.      0 - FAR shows only allowed drives (taking into account the value
  405.          of the system policy parameter "NoDrives").
  406.      1 - the feature is disabled, FAR shows all the drives,
  407.          independently of the value of the "NoDrives" registry setting
  408.          ([HKCU\Software\Microsoft\Windows\CurrentVersion\Policies\Explorer])
  409.    The default value is 1.
  410.  
  411. 31.[HKEY_CURRENT_USER\Software\Far\System]
  412.    "FlagPosixSemantics":REG_DWORD
  413.    The "System/FlagPosixSemantics" key of DWORD type specifies the
  414.    behaviour of the history and position cache for the internal viewer
  415.    and editor.
  416.      0 - file names are case insensitive
  417.      1 - file names are case sensitive
  418.    This parameter is meaningful only under Windows NT/2000.
  419.    The default value is:
  420.      Windows 9x       = 0
  421.      Windows NT/2000  = 1
  422.  
  423. 32.[HKEY_CURRENT_USER\Software\Far\Editor]
  424.    "CharCodeBase":REG_DWORD
  425.    The key "Editor/CharCodeBase" of REG_DWORD type allows to change
  426.    the representation of the current character code in the editor
  427.    status line. Can have one of the following values:
  428.      0 - octal value (3 characters with leading zeros)
  429.      1 - decimal value (3 characters with leading spaces)
  430.      2 - hexadecimal value (2 digits + the character 'h')
  431.    The default value is 1 - decimal value.
  432.  
  433. 33.[HKEY_CURRENT_USER\Software\Far\System]
  434.    "MouseWheelDelta":REG_DWORD
  435.    The key "System/MouseWheelDelta" of DWORD type specifies the number
  436.    of keypresses of the Up/Down keys that are sent when the mouse
  437.    wheel is rotated and the keys Ctrl/Shift/Alt are not pressed.
  438.    Rotating the wheel when Shift is pressed is equivalent to pressing
  439.    PgUp/PgDn. Rotating the wheel when Alt is pressed always causes the
  440.    scrolling by one position.
  441.    This parameter has effect only under Windows 2000.
  442.    The default value is 1.
  443.  
  444.  
  445.                                      [ FAR manager development group ]
  446.