home *** CD-ROM | disk | FTP | other *** search
/ PC World 2002 March / PCWorld_2002-03_cd.bin / Software / Komercni / far / Far1703.exe / Plugins / FARCmds / FARCmdsEng.hlf < prev    next >
Encoding:
FAR help  |  2001-04-14  |  7.8 KB  |  240 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 Directory" Command~@TheSameCatalogue@
  11.    ~Configuring FAR Commands~@Config@
  12.  
  13. @Syntax
  14. $^#FARCmds Syntax
  15.    #Command Line Syntax#
  16.  
  17.    <prefix>:<command>[<options>]<separator><object>
  18.  
  19.   or
  20.  
  21.    <command>:[<options>]<separator><object>
  22.  
  23.    where
  24.    #<prefix>#    - always #far#
  25.  
  26.    #<command>#   - one of the following:
  27.                  ~view~@View@    - Viewer
  28.                  ~edit~@Edit@    - Editor
  29.                  ~goto~@Goto@    - Go to given file or directory
  30.                  ~clip~@Clip@    - Put data in the clipboard
  31.                  ~whereis~@WhereIs@ - Locate and jump to given object
  32.  
  33.    #<options>#   - for the "edit" command only; it may be:
  34.                  #[line]#
  35.                  #[line,column]#
  36.                  The square brackets are mandatory.
  37.  
  38.    #<separator># - the separator between the <command> and <object>
  39.                  Specified in the ~plugin configuration~@Config@.
  40.  
  41.    #<object>#    - one of the following:
  42.                  #filename#  - name of the file to be viewed,
  43.                              edited or jumped to.
  44.                  #path#      - file or directory path to jump to.
  45.                  #<command#  - an operating system command
  46.                              The #<# character is mandatory.
  47.                  #<<command# - an operating system command
  48.                              The #<# character is mandatory.
  49.  
  50.    Note:
  51.  
  52.    A command can be executed in a directory different from the
  53.    current directory if the path is specified before an
  54.    operating system command enclosed in #'|'# characters.
  55.    Example: '#edit:<|%TEMP%|dir#'.
  56.  
  57.    See also: ~Contents~@Contents@ | ~Output Redirection~@Direction@ | ~Notes~@Remark@
  58.  
  59. @Clip
  60. $^#The Clip command#
  61.    The #clip# command allows to put data into the Windows clipboard.
  62. The data means the contents of a given file or the output of a program.
  63. The clipboard will contain all the data up to the character with the
  64. code #0x00#, at most 1 megabyte.
  65.  
  66.    #far:clip<separator>filename#
  67.    or
  68.    #clip:<separator>filename#
  69.  
  70.    See also: ~Output Redirection~@Direction@ | ~Notes~@Remark@
  71.  
  72. @View
  73. $^#The View command#
  74.    The #view# command opens the file given in "#filename#" in the FAR
  75. built-in viewer:
  76.  
  77.    #far:view<separator>filename#
  78.    or
  79.    #view:<separator>filename#
  80.  
  81.    See also: ~Output Redirection~@Direction@ | ~Notes~@Remark@
  82.  
  83. @Edit
  84. $^#The Edit command#
  85.    The #edit# command opens the file given in "#filename#" for editing
  86. in the FAR built-in editor. The command may be called in three ways:
  87.  
  88.    1. Open file for editing
  89.  
  90.       #far:edit<separator>filename#
  91.       or
  92.       #edit:<separator>filename#
  93.  
  94.    2. Open file for editing and go to the line "#<line>#"
  95.  
  96.       #far:edit[<line>]<separator>filename#
  97.       or
  98.       #edit:[<line>]<separator>filename#
  99.  
  100.    3. Open a file for editing and go to the given position
  101.  
  102.       #far:edit[<line>,<column>]<separator>filename
  103.       or
  104.       #edit:[<line>,<column>]<separator>filename#
  105.  
  106.    If the file "#filename#" does not exist, it is created. If after creating
  107. the file and leaving the editor the file has not been changed, it is deleted
  108. (the behaviour imitates Shift-F4).
  109.  
  110.    See also: ~Output Redirection~@Direction@ | ~Notes~@Remark@
  111.  
  112. @Goto
  113. $^#The Goto command#
  114.    The #goto# command allows to jump to the given file or directory in one
  115. of two ways:
  116.  
  117.    1. The path to the file or directory is specified directly in the command
  118.  
  119.       #far:goto<separator>path#
  120.       or
  121.       #goto:[<separator>]path#
  122.  
  123.  
  124.    2. The path to the file or directory is taken from a given file "#filename#"
  125.  
  126.       #far:goto[<separator>]<filename#
  127.       or
  128.       #goto:[<separator>]<filename#
  129.  
  130.    If the "#path#" parameter specifies a directory and is terminated with
  131. a backslash ('#\#'), the plugin jumps to the specified directory. If the
  132. path to the directory is not terminated with a backslash, the cursor on the
  133. panels is set to the specified directory.
  134.  
  135.    At most 1299 bytes are read from the file "#filename#" to specify
  136. the path to a directory or file.
  137.  
  138.    See also: ~Contents~@Contents@ | ~Notes~@Remark@
  139.  
  140. @WhereIs
  141. $ #The WhereIs command#
  142.    The #whereis# command locates the given object and, if the search is
  143. successful, jumps to it.
  144.  
  145.    #far:whereis<separator>filename#
  146.    or
  147.    #whereis:<separator>filename#
  148.  
  149.    The search is done in the following order:
  150.    1. The current directory
  151.    2. The directories listed in the environment variable #PATH#
  152.    3. Contents of the registry branch:
  153.       #HKLM\Software\Microsoft\Windows\CurrentVersion\App Paths#
  154.  
  155.    See also: ~Contents~@Contents@ | ~Notes~@Remark@
  156.  
  157. @Direction
  158. $^#Output Redirection#
  159.    The plugin can redirect the output of the given "#command#" to a
  160. temporary file and then open it in the viewer or editor.
  161.  
  162.      in the viewer -
  163.        #far:view <command#
  164.        #view:<command#
  165.  
  166.      in the editor -
  167.        #far:edit <command#
  168.        #edit:<command#
  169.        #far:edit[line] <command#
  170.        #edit[line]:<command#
  171.        #far:edit[line,column] <command#
  172.        #edit[line,column]:<command#
  173.  
  174.      or the contents of the output file can be put into the clipboard
  175.  
  176.        #far:clip <command#
  177.        #clip:<command#
  178.  
  179.    Notes:
  180.  
  181.    1. Everything after the '#<#' character is passed to the command
  182.       processor (%COMSPEC%).
  183.  
  184.    2. The temporary file is deleted automatically when FAR doesn't
  185.       need it anymore.
  186.  
  187.    3. The parameter "#<separator>#" can be omitted.
  188.  
  189.    4. Some programs, instead of writing text to the standard output
  190.       that can be captured by the plugin, output the text directly
  191.       to the console. To save the console output for viewing through
  192.       #Ctrl-O#, use the characters '#<<#' instead of '#<#'.
  193.       This behaviour can be set as the default in the
  194.       ~plugin configuration~@Config@.
  195.  
  196.    See also: ~Contents~@Contents@ | ~Syntax~@Syntax@
  197.  
  198. @TheSameCatalogue
  199. $^#Same Directory#
  200.    To set the same directory in the passive panel as in the active one,
  201. select the item "#Same Directory#" in the ~plugins menu~@:Plugins@
  202. or in the ~disks menu~@:DriveDlg@.
  203.  
  204.    See also: ~Contents~@Contents@ | ~Configuration~@Config@
  205.  
  206. @Remark
  207. $^#Notes#
  208.  
  209.    1. Command names may be shortened to their first letters.
  210.    2. It is possible to put parameters #filename#,
  211.       #path# and #command# in quotes.
  212.    3. It is possible to use environment variables.
  213.    4. If you make a syntax error, the help will pop up.
  214.    5. It is not recommended to use the #<# character as the
  215.       separator.
  216.  
  217.    See also: ~Contents~@Contents@
  218.  
  219. @Config
  220. $^#Configuring FAR Commands#
  221.  #"Add "Same Directory"#      Adds the ~Same Directory~@TheSameCatalogue@ command
  222.  #to the Plugins menu"#       to the ~Plugins menu~@:Plugins@.
  223.  
  224.  #"Add "Same Directory"#      Adds the ~Same Directory~@TheSameCatalogue@ command
  225.  #to the Disks menu"#         to the ~Disks menu~@:DriveDlg@.
  226.  
  227.  #Command/object separator#   Specifies the characters separating
  228.                             <command> and <object> (see ~Syntax~@Syntax@)
  229.                             It may be any character sequence (up to
  230.                             three chars). The default is Space.
  231.  
  232.  #Keep external command#      Saves the text that programs write
  233.  #output#                     directly to the console (bypassing the
  234.                             standard output) and makes it available
  235.                             for viewing through #Ctrl-O#.
  236.                             Enabling this option has the same effect
  237.                             as using #<<# instead of #<#.
  238.  
  239.    See also: ~Contents~@Contents@
  240.