home *** CD-ROM | disk | FTP | other *** search
/ PC World 2000 August / PCWorld_2000-08_cd.bin / Software / TemaCD / wincvs / data1.cab / Example_Files / Macros / DocMacros.txt < prev    next >
Encoding:
INI File  |  1999-03-23  |  2.3 KB  |  56 lines
  1. [INNNNNNNNNNNNNNNNNNNNN PROGRESS !]
  2.  
  3. Macros start-up :
  4. -----------------
  5.  
  6. * In order to be recognized by the application, the macro file has to be
  7. located in the "Macros" folder (or any of its sub-folder).
  8. * A header tells the application in which menu to hook-up the macro :
  9.  
  10. #!CVSGUI1.0 [--admin|--selection|--files|--folder]  --name "The name which appears in the menu"
  11.  
  12. Built-in TCL commands available anywhere :
  13. ------------------------------------------
  14.  
  15. * cvs : the cvs command.
  16.  
  17. * cvsout ?arg arg...?
  18.   output a set of strings to the console window.
  19.  
  20. * cvserr ?arg arg...?
  21.   output a set of strings to the console window.
  22.  
  23. * cvsentries pathName funcName
  24.   load the CVS/Entries informations from pathName and set the funcName with
  25.   a "cvsbrowser" like syntax (see below).
  26.  
  27. Built-in TCL commands only from the Selections menu :
  28. -----------------------------------------------------
  29.  
  30. * cvsbrowser :
  31.   - cvsbrowser get : returns a list of the selected items in the browser. A simple
  32.     return is : {"C:/myproject/foo.c" "C:/myproject/foo.rc"}
  33.   - cvsbrowser info fileName arrayName : set the array "arrayName" with a set of informations
  34.     about "fileName". If the browser has such an information, the array "arrayName" contains :
  35.       + $arrayName(name) :        the file name
  36.       + $arrayName(kind) :        [file|folder]
  37.       + $arrayName(path) :        the file path
  38.       + $arrayName(missing) :     [0|1]
  39.       + $arrayName(unknown) :     [0|1]
  40.       + $arrayName(ignored) :     [0|1]
  41.       + $arrayName(locked) :      [0|1]
  42.       + $arrayName(modified) :    [0|1]
  43.       + $arrayName(status) :      A string like "Mod. file" or "Unknown folder"
  44.       + if the element is a file (if $arrayName(kind) is "file")
  45.          + $arrayName(revision) :     the file revision (i.e. 1.1, 1.2.3.4...)
  46.          + $arrayName(timestamp) :    the time stamp on the server
  47.          + $arrayName(option) :       the substitution option (i.e. -kb)
  48.          + $arrayName(tag) :          the tag name (if any)
  49.          + $arrayName(conflict) :     the conflict desc. (if any)
  50.  
  51. Built-in TCL commands only from the Files/Folder menu :
  52. -------------------------------------------------------
  53.  
  54. * cvssel : return a list of the selected file(s) or folder(s). A simple list is
  55.   {"C:/myproject/foo.c", "C:/myproject/rsr/foo.rc"} or {"C:/myproject", "C:/myproject/rsr"}
  56.