home *** CD-ROM | disk | FTP | other *** search
/ ftp.texkom.ru / ftp.texkom.ru.tar / ftp.texkom.ru / Plugins.zip / Plugins / FARCmds / FARCmdsEng.hlf < prev    next >
Text File  |  2003-02-24  |  14KB  |  415 lines
  1. .Language=English,English (English)
  2. .PluginContents=FAR Commands
  3.  
  4. @Contents
  5. $^#FAR Commands#
  6.    The FAR Commands Plugin (FARCmds) provides additional features that may
  7. be used in the User Menu, file associations or the command line.
  8.  
  9.    ~Syntax~@Syntax@
  10.    ~"Same Folder" Command~@TheSameFolder@
  11.    ~Configuring FAR Commands~@Config@
  12.  
  13. @Syntax
  14. $^#FARCmds Syntax
  15.    #Command Line Syntax#
  16.  
  17.    <prefix>:<command>[<options>] <object>
  18.  
  19.   or
  20.  
  21.    <command>:[<options>] <object>
  22.  
  23.   where
  24.  
  25.    #<prefix>#    - always #far#
  26.  
  27.    #<command>#   - one of the following:
  28.                  ~view~@View@    - Viewer
  29.                  ~edit~@Edit@    - Editor
  30.                  ~goto~@Goto@    - Jump to a file or folder
  31.                  ~clip~@Clip@    - Put data in the clipboard
  32.                  ~whereis~@WhereIs@ - Locate and jump to an object
  33.                  ~macro~@Macro@   - Macros
  34.                  ~ln~@Ln@       - create of links
  35.                  ~run~@Run@     - execute commands
  36.  
  37.    #<options>#   - only for the #edit# command; one of the following:
  38.                  #[line]#
  39.                  #[line,column]#
  40.                  The square brackets are mandatory.
  41.  
  42.    #<object>#    - one of the following:
  43.                  #filename#  - name of the file to be viewed,
  44.                              edited or jumped to.
  45.                  #path#      - file or directory path to jump to.
  46.                  #<command#  - ~intercept output~@Direction@  of operation
  47.                              system command.
  48.                              Symbol #<# is obligatory.
  49.                  #<<command# - ~intercept output~@Direction@  of operation
  50.                              system command.
  51.                              Symbol #<<# is obligatory.
  52.  
  53.  
  54.    Note:
  55.  
  56.    A command can be executed in a directory different from the
  57.    current directory if the path is specified before an
  58.    operating system command enclosed in #'|'# characters.
  59.    Example: '#edit:<|%TEMP%|dir#'.
  60.  
  61.    See also: ~Contents~@Contents@ | ~Output Redirection~@Direction@ | ~Notes~@Remark@
  62.  
  63. @Clip
  64. $^#The Clip command#
  65.    The #clip# command puts data into the Windows clipboard.
  66. The data can be the contents of a file or the output of a program.
  67. The clipboard will contain all the data up to the character with the
  68. code #0x00# (1 megabyte at most).
  69.  
  70.    #far:clip filename#
  71.    or
  72.    #clip:filename#
  73.  
  74.    See also: ~Output Redirection~@Direction@ | ~Notes~@Remark@
  75.  
  76. @Run
  77. $ #The Run command#
  78.    The #run# command executes an operating system #command# redirecting
  79. its output to the specified file #"filename"#. Output can also be displayed
  80. on the screen or hidden from the user using ~Output Redirection~@Direction@ modifiers.
  81.  
  82.    #far:run filename<command#
  83.    #run:filename<command#
  84.  
  85.    See also: ~Output Redirection~@Direction@ | ~Remarks~@Remark@
  86.  
  87.  
  88. @View
  89. $^#The View command#
  90.    The #view# command opens the file "#filename#" in the FAR
  91. built-in ~viewer~@:Viewer@:
  92.  
  93.    #far:view filename#
  94.    or
  95.    #view:filename#
  96.  
  97.    See also: ~Output Redirection~@Direction@ | ~Notes~@Remark@
  98.  
  99. @Edit
  100. $^#The Edit command#
  101.    The #edit# command opens the file "#filename#" for editing
  102. in the FAR built-in ~editor~@:Editor@. The command may be invoked in three ways:
  103.  
  104.    1. Open a file for editing
  105.  
  106.       #far:edit filename#
  107.       or
  108.       #edit:filename#
  109.  
  110.    2. Open a file for editing and go to the line "#<line>#"
  111.  
  112.       #far:edit[<line>] filename#
  113.       or
  114.       #edit:[<line>] filename#
  115.  
  116.    3. Open a file for editing and go to the given position
  117.  
  118.       #far:edit[<line>,<column>] filename
  119.       or
  120.       #edit:[<line>,<column>] filename#
  121.  
  122.    If the file "#filename#" does not exist, it will be created.
  123.    If the newly created file is not changed before leaving the editor, it will
  124. be deleted (same behaviour as Shift-F4).
  125.  
  126.    If the filename contains square brackets (for example: "[1].txt"), then for
  127. the correct opening of the file in the editor you must provide at least one delimiter
  128. (e.g. a space) before the filename, or enclose it in quotation marks:
  129.  
  130.    edit: [1].txt
  131.    edit:"[1].txt"
  132.  
  133.    See also: ~Output Redirection~@Direction@ | ~Notes~@Remark@
  134.  
  135. @Goto
  136. $^#The Goto command#
  137.    The #goto# command jumps to a file or a folder. The path can be
  138.    specified in two ways:
  139.  
  140.    1. Directly as a parameter of the command
  141.  
  142.       #far:goto path#
  143.       or
  144.       #goto:path#
  145.  
  146.    2. The path is taken from the file "#filename#"
  147.  
  148.       #far:goto <filename#
  149.       or
  150.       #goto: <filename#
  151.  
  152.    If the parameter "#path#" specifies a folder and is terminated with
  153. a backslash ('#\#'), the plugin jumps to the specified folder. If the
  154. path to the folder is not terminated with a backslash, the cursor on the
  155. panels is positioned to the specified folder.
  156.  
  157.    At most 1299 bytes are read from the file "#filename#" to specify
  158. the path to a directory or file.
  159.  
  160.    When panels are turned off, the cursor is not positioned on the requested object,
  161. only the switching to the required folder occurs.
  162.  
  163.    See also: ~Contents~@Contents@ | ~Notes~@Remark@
  164.  
  165. @Ln
  166. $ #諼á¡ñá Ln#
  167. $ #The Ln command#
  168.  
  169.    The #ln# command creates and deletes ~links~@:HardSymLink@
  170. to files and folders. Hardlinks are created for files, symlinks are
  171. created for folders. It is possible to mount local disks on file system
  172. with #ln# command (so-called "volume mount points").
  173.  
  174.    #ln# syntax:
  175.  
  176.    #far:ln [/msg] [/n] source destination#
  177.    or
  178.    #ln:[/msg] [/n] source destination#
  179.  
  180.    if "destination" is
  181.  
  182.      a #file#   : hardlink is created
  183.      a #folder# : symlink is crearted
  184.      a #drive#  : drive is mounted in case of a "drive" sequence:
  185.                   'drive_letter' ':' '\', e.g. "C:\"
  186.  
  187.    switch #/msg# turns on the output of error messages
  188.  
  189.    switch #/n# disables automatic update of panels after creation of link
  190.  
  191.    Mounted drives (or volume mount points) is a Windows 2000/XP feature,
  192. that allows to display specified disks as folders. Example:
  193.  
  194.    #ln: E:\ C:\cdrom#
  195.  
  196.     After this command the folder C:\cdrom will display the contents of drive E:
  197.  
  198.    See also: ~Contents~@Contents@ | ~Remarks~@Remark@
  199.  
  200. @WhereIs
  201. $ #The WhereIs command#
  202.    The #whereis# command locates the given object and jumps to it if the search was
  203. successful.
  204.  
  205.    #far:whereis filename#
  206.    or
  207.    #whereis:filename#
  208.  
  209.    The search is performed in the following order:
  210.  
  211.    1. Current folder
  212.    2. Windows 95: Windows' system foder (SYSTEM)
  213.       Windows NT: 32 bit Windows' system folder (SYSTEM32)
  214.    3. Windows NT: 16 bit Windows' system folder (SYSTEM)
  215.    4. Windows folder.
  216.    5. Folders in the system environment variable #PATH#
  217.    6. Contents of the registry key:
  218.       #HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\App Paths#
  219.    7. Contents of the registry key:
  220.       #HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\App Paths#
  221.  
  222.    When panels are turned off, the cursor is not positioned on the requested object,
  223. only the switching to the required folder occurs.
  224.  
  225.    See also: ~Contents~@Contents@ | ~Notes~@Remark@
  226.  
  227. @Macro
  228. $ #The Macro command#
  229.    The #macro# command loads macros from the registry or saves macros in the
  230. registry. Also it can post the key sequence to FAR Manager as if they were
  231. typed from the keyboard.
  232.  
  233.    1. Load macros from the registry:
  234.  
  235.       #far:macro load#
  236.       or
  237.       #macro:load#
  238.  
  239.    2. Save macros to the registry:
  240.  
  241.       #far:macro save#
  242.       or
  243.       #macro:save#
  244.  
  245.    3. Post a key sequence:
  246.  
  247.       #far:macro post sequence#
  248.       ¿½¿
  249.       #macro:post sequence#
  250.  
  251.       "sequence" is a sequence of key names as they are stored in
  252.       the registry by FAR Manager. For example:
  253.  
  254.       macro:post F4 F12 0 Tab F4 F12 0
  255.  
  256.       The sequence is executed only after return the FAR Manager receives control.
  257.  
  258.  
  259.    See also: ~Contents~@Contents@
  260.  
  261. @Direction
  262. $ #Output Redirection#
  263.    Plugin can redirect the output of the specified #<command#.
  264.  
  265.    #command#     - #[stream][mode][|path|]command#.
  266.  
  267.                  #stream# - controls which output stream(s) to redirect.
  268.                           #1# - redirect only standart output
  269.                               stream #stdout#.
  270.                           #2# - redirect only standart output
  271.                               stream #stderr#.
  272.                           #*# - redirect #stderr# and #stdout# as
  273.                               one stream
  274.                           #?# - redirect #stderr# and #stdout# as
  275.                               different streams. For commands ~view~@View@
  276.                               and ~edit~@Edit@ the streams will
  277.                               be opened in separate windows. For other
  278.                               commands same behavior as #*#.
  279.  
  280.                  #mode#   - controls direct console output
  281.                             (not via standard streams)
  282.                           #># - ignore the console output of the
  283.                               program and display only message
  284.                               about its execution
  285.                           #<# - save console output and make it
  286.                               available for viewing with #Ctrl-O#,
  287.                           #+# - same as #<#, but displays on the
  288.                               screen redirected output of the program
  289.                               along with console output.
  290.  
  291.                  #|path|# - command can be executed in the folder
  292.                             defferent from the current one if this
  293.                             parameter is present (enclosed in pipes #'|'#).
  294.                             For example: '#edit:<|%TEMP%|dir#'.
  295.  
  296.  
  297.    Default values of #stream# and #mode# can be defined in
  298. ~plugin config~@Config@.
  299.  
  300.    Progam output is placed in a temporary file. The output
  301.    can also be saved to a user-defined file:
  302.  
  303.        #far:run filename<command#
  304.        #run:filename<command#
  305.  
  306.      or opened
  307.  
  308.      in viewer
  309.  
  310.        #far:view <command#
  311.        #view:<command#
  312.  
  313.      or in editor
  314.  
  315.        #far:edit <command#
  316.        #edit:<command#
  317.        #far:edit[line] <command#
  318.        #edit:[line] <command#
  319.        #far:edit[line,column] <command#
  320.        #edit:[line,column] <command#
  321.  
  322.      or the output can be placed into clipboard
  323.  
  324.        #far:clip <command#
  325.        #clip:<command#
  326.  
  327.    Notes:
  328.  
  329.    1: The entire string after the symbol '#<#' and optional modifiers
  330.       is sent to the command processor (%COMSPEC%)
  331.  
  332.    2. Temporary file is deleted automatically when FAR Manager
  333.       doesn't need it.
  334.  
  335.    3. Some programs do not use standard output stream(s), but
  336.       print directly to the console. To store console output
  337.       and make it available for viewing with #Ctrl-O#, or to
  338.       ignore it, use modifiers '#<#', '#>#' ¿ '#+#'.
  339.       You can change default behavior in the ~configuration~@Config@.
  340.  
  341.    See also: ~Contents~@Contents@ | ~Syntax~@Syntax@
  342.  
  343. @TheSameFolder
  344. $^#Same Folder
  345.    To set the current folder of the passive panel to the same as
  346. in the active one, choose the item "#Same Directory#" in the ~plugins menu~@:Plugins@
  347. or in the ~drives menu~@:DriveDlg@.
  348.  
  349.    See also: ~Contents~@Contents@ | ~Configuration~@Config@
  350.  
  351. @Remark
  352. $^#Notes#
  353.  
  354.    1. When using prefix #far# command names may be shortened to
  355.       their first letters. Example:
  356.       #far:v# is the same as #far:view# or #view:#
  357.  
  358.    2. It is possible to enclose parameters #filename#,
  359.       #path# and #command# in quotes.
  360.  
  361.    3. You can use environment variables.
  362.  
  363.    4. If you make a syntax error, the help will pop up.
  364.  
  365.    See also: ~Contents~@Contents@
  366.  
  367. @Config
  368. $^#Configuring FAR Commands#
  369.  
  370.  #"Add "Same Folder"#            Adds the ~Same Folder~@TheSameFolder@ command
  371.  #to the Plugins menu"#          to the ~Plugins menu~@:Plugins@.
  372.  
  373.  #"Add "Same Folder"#            Adds the ~Same Folder~@TheSameFolder@ command
  374.  #to the Disks menu"#            to the ~Disks menu~@:DriveDlg@.
  375.  
  376.  #External commands screen output# Control program screen output
  377.  
  378.    #Hide external command#       Hides program output. Only a message with
  379.    #output#                      the size of intercepted output will be
  380.                                displayed. Same as using #<># instead of #<#.
  381.  
  382.    #Keep external command#       Saves the text output by programs directly
  383.    #output#                      to the console for viewing by#Ctrl-O#.
  384.                                Same as using #<<# instead of #<#.
  385.  
  386.    #Duplicate intercepted#       Saves for viewing by #Ctrl-O# both the
  387.    #output to screen#            direct console output and intercepted
  388.                                output.
  389.                                Same as using #<+# instead of #<#.
  390.  
  391.  
  392.  #Intercepting output#           Controlling of program output interception:
  393.  
  394.    #Intercept both#              Intercept standart output stream #stdout#
  395.    #stdout and stderr#           and standart error stream #stderr# as
  396.                                one stream.
  397.                                Same as using #<*# instead of #<#.
  398.  
  399.  
  400.    #Intercept stdout only#       Intercept only #stdout#.
  401.    #(Standard output stream)#    Same as using #<1# instead of #<#.
  402.  
  403.    #Intercept stderr only#       Intercept only #stderr#.
  404.    #(Standard errors stream)#    Same as using #<2# instead of #<#.
  405.  
  406.  
  407.    #Intercept stdout and #       Intercept stdout and #stderr#
  408.    #stderr separately#           separately. It has sense only in
  409.                                commands #far:view <# and #far:edit <#.
  410.                                In other cases same as #<*#.
  411.                                Can't be used with #<+#.
  412.                                Same as using  #<?# instead of #<#.
  413.  
  414.    See also: ~Contents~@Contents@
  415.