home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 2 / FFMCD02.bin / new / amigalibdisks / disk944 / lhf / lhfed.doc < prev    next >
Text File  |  1993-12-21  |  9KB  |  234 lines
  1.  
  2.       
  3.              LhfEd v1.03
  4.              (c) Copyright 1993 by author Stefan Pampin.
  5.              Written using varios translators.
  6.    
  7.       
  8.  1) Introduction 
  9.  ---------------------------------------------------------------------------
  10.    This file describes the program LhfEd. It is help program to Lhf described
  11.  in the file 'Lhf.doc'. The same Disclaimer,Copyright and Distribution notes
  12.  applies to this program, LhfEd, as the program Lhf. See the file 'Lhf.doc'.
  13.    With LhfEd you can add some gadgets to Lhf's main window. The action when
  14.  these gadgets are selected is partially described in 'Lhf.doc'. In short
  15.  a string is parsed for conversion codes wich are substituted and the final
  16.  result is executed as a command line. This program lets you define the
  17.  button text, the conversion string, and select some options. Furthermore you
  18.  can save and edit your buttons.
  19.  
  20.  2) Requirements
  21.  ---------------------------------------------------------------------------
  22.   LhfEd should run with all amigas version 1.3 or higher. The colors will
  23.  look inverted on the 1.3 system. The 1.3 system need the run command
  24.  available (simply put it in the c: directory or better, do an SetPatch
  25.  and make it resident) to execute the command line later when invoking
  26.  the buttons in Lhf. The 'asynchronously' option is ignored under 1.3.
  27.  
  28.  3) Running LhfEd
  29.  --------------------------------------------------------------------------    
  30.    You can start LhfEd from either the CLI or the Workbench. LhfEd ignore
  31.  every argument and have no console output so the functionality should be
  32.  equivalent.
  33.  
  34.  4) Backup
  35.  --------------------------------------------------------------------------
  36.    Before you starting adding buttons to Lhf make a backup of the executable
  37.  file 'Lhf' since there is no way back.
  38.  
  39.  4) Main Window
  40.  --------------------------------------------------------------------------
  41.   4.1) [ LhfCopy ] (string gadget)
  42.     Here you can enter a path to an existing unmodified copy of 'Lhf'.
  43.  
  44.   4.2) [ Load ] (gadget) 
  45.     Pressing this will load the buttons earlier defined and saved in the
  46.   copy with path entered in the string gadget.
  47.  
  48.   4.3) [ Save ] (gadget)
  49.    Pressing this will save the buttons showen in the gadget array to the
  50.   path entered in the string gadget. Note that the path can be changed
  51.   after a load.   
  52.   
  53.   4.4) [ buttons ] (gadget array)
  54.    Simply press the button you want to edit. A edit window will appear.
  55.    Also see 4.5-8.
  56.   
  57.   4.5) [ Copy ] (gadget)
  58.    Pressing this, then a source button and finally and destination button
  59.    will copy the source to the destination button. 
  60.    Cancel a copy by pressing the edit gadget.
  61.  
  62.   4.6) [ Swap ] (gadget)
  63.    Pressing this and then two buttons will swap the the buttons.
  64.    Cancel a swap by pressing the edit gadget.
  65.    
  66.   4.7) [ Delete ] (gadget)
  67.    Pressing this you can delete a button by pressing it.
  68.    Cancel a deletion by pressing the edit gadget.
  69.  
  70.   4.8) [ Edit ]
  71.    Press this you can edit buttons by pressing them until you press
  72.    the copy, the swap or the delete gadget.
  73.  
  74.  
  75.  5) Edit Window
  76.  ----------------------------------------------------------------------------
  77.   5.1) [Text] (string gadget)
  78.     This is the gadget text for the button. Enter a space character (' ') if
  79.   you dont want any text.
  80.   
  81.   5.2) [Command] (string gadgets)
  82.     Here you enter a string with conversion codes described under 6).
  83.   
  84.   5.3) [Window] (string gadgets)
  85.     Here you enter a window name. Typically a CON: window or NIL: (See your
  86.   AmigaDOS userguide). Note that some programs needs a window but does not
  87.   use them. In these cases an AUTO window is preferable. This is also the 
  88.   default under 2.0.     
  89.   
  90.   5.4) [CD to] (gadget)
  91.      With this you can select between  
  92.     1) Lhf process's current directory
  93.     2) The source directory
  94.     3) The destination directory
  95.      to be the current directory during execution of the command.
  96.  
  97.   5.5) [Act on files] (toggle gadget)
  98.      Choose this if you want the command be execute for selected dirs.
  99.      (See note)
  100.  
  101.   5.6) [Act on dirs] (toggle gadget)
  102.      Choose this if you want the command be execute for selected dirs.
  103.      (See note)
  104.    
  105.   Note: If neither 'Act on files' nor 'Act on dirs' is selected, the
  106.       action will be independent of the entry selection an executed
  107.       once. 
  108.         
  109.   5.7) [Act recursively] (toggle gadget)
  110.      Choose this if you want the selection apply recursively on subdirs.
  111.  
  112.   5.8) [Act asyncronously] (toggle gadget)
  113.      Choose this if you want the command line to be 'runned'. The 1.3
  114.      rom does not support it (so you must enter 'Run ' before your 
  115.      command line if you use 1.3).
  116.   
  117.   5.9) [WB to front] (toggle gadget)
  118.      Choose this if you want to bring the WB screen to front BEFORE the
  119.      command is executed.
  120.  
  121.   5.10) [Back to front] (toggle gadget)
  122.      Choose this if you want to bring the Lhf screen to front AFTER the
  123.      command is executed (runned).
  124.  
  125.   5.11) [Common window] (toggle gadget)
  126.      Choose this if you want the window used be common to each entry 
  127.      execution. Note that this will only have affect in mode 2).
  128.  
  129.   5.12) [No archive entries] (toggle gadget)
  130.      With this option you can avoid execution (of non-consistent) 
  131.      archive entries. 
  132.     
  133.  
  134.  6) Conversion codes.
  135.  ----------------------------------------------------------------------------
  136.    %S    Source directory      
  137.    %D    Dest   directory
  138.    -------------------
  139.     This is what you see in the Lhf's main window's string gadgets.
  140.    A slash is always added if needed before adding any file path. If
  141.    the destination path is not valid %D defaults to %S.  
  142.    
  143.    %s     Source path
  144.    %d    Dest   path
  145.    %p    Common path
  146.    %t[n] Source path
  147.    -------------------
  148.    %s is the full path of the selected entry.
  149.    %p is the same path relative to %S.          
  150.    %d is the same as '%D%p'.      
  151.    %t is the same as %s but says that if this is an temporarily
  152.       extracted file, delete it after execution. With the 
  153.       optionally decimal value n, you can ask for a delay about
  154.       n system ticks before deletion. If deletion failed it will
  155.       delay another n ticks to next try. It only tries 5 times.
  156.  
  157.    Paths are not enclosed with quotes. One reason is that there
  158.    are still commands that can not handle them. Simply write 
  159.    '"%s"' instead of '%s' if you want it enclosed.
  160.  
  161.    %% = %
  162.    ------    
  163.     To enable input of '%'.
  164.    
  165.    Note: Most conversion characters requires a source and/or
  166.    destination box with file or archives entries. If this is
  167.    not satisfiated Lhf will refuse to execute the command.   
  168.          
  169.    Selection within archives.
  170.    --------------------------
  171.      When a button action is performed for entries selected in an 
  172.    archive they are extracted to a subdirectory 'DirWork' of your
  173.    prefered work directory. That directory now becomes your source
  174.    directory. Note that the conversion expression '%t' is very 
  175.    useful in this context.
  176.     
  177.    Some examples.
  178.    --------------
  179.     1) Lha -r x "%t"
  180.        - Extract all files in the selected (Lha-compatiable) archives.
  181.     
  182.     2) Editor "%t"         
  183.        - Call my editor for the selected file.
  184.              The asyncronously option can not be used here because then
  185.              Lhf could delete the file %t before it is loaded by your
  186.              editor. If you may circumstance this be appending a delay
  187.              count i.e. change "%t" to "%t<delay>". 
  188.     
  189.     3) "%t"    
  190.           - Execute a the commands selected. The same note as above
  191.          applies here.    
  192.         
  193.     4) Echo "%%D = %D, %%S = %S"
  194.        - Useful exampel to learn about Lhf's command button action.    
  195.     
  196.     5) Protect "%t" -d
  197.        - Here you will only protect copies of archive files.
  198.  
  199.     6) Copy "%s" "%D"
  200.        - If you prefer the system copy command before the built in
  201.          one.
  202.         
  203.  7) Limits
  204.  ----------------------------------------------------------------------------
  205.   - All paths are currently supposed to be less than 288 bytes.
  206.   - The total command line size when preforming a user-defined button
  207.     must be atmost 1k.
  208.   - Button text are bounded by 9 characters (more will not be displayed by Lhf)
  209.   - Button conversion strings are bounded by 288.
  210.  
  211.  8) History
  212.  -------