zsnes/Macros/DocMacros.txt

@@ -0,0 +1,55 @@
+[INNNNNNNNNNNNNNNNNNNNN PROGRESS !]
+
+Macros start-up :
+-----------------
+
+* In order to be recognized by the application, the macro file has to be
+located in the "Macros" folder (or any of its sub-folder).
+* A header tells the application in which menu to hook-up the macro :
+
+#!CVSGUI1.0 [--admin|--selection|--files|--folder]  --name "The name which appears in the menu"
+
+Built-in TCL commands available anywhere :
+------------------------------------------
+
+* cvs : the cvs command.
+
+* cvsout ?arg arg...?
+  output a set of strings to the console window.
+
+* cvserr ?arg arg...?
+  output a set of strings to the console window.
+
+* cvsentries pathName funcName
+  load the CVS/Entries informations from pathName and set the funcName with
+  a "cvsbrowser" like syntax (see below).
+
+Built-in TCL commands only from the Selections menu :
+-----------------------------------------------------
+
+* cvsbrowser :
+  - cvsbrowser get : returns a list of the selected items in the browser. A simple
+    return is : {"C:/myproject/foo.c" "C:/myproject/foo.rc"}
+  - cvsbrowser info fileName arrayName : set the array "arrayName" with a set of informations
+    about "fileName". If the browser has such an information, the array "arrayName" contains :
+	  + $arrayName(name) :        the file name
+	  + $arrayName(kind) :        [file|folder]
+	  + $arrayName(path) :        the file path
+	  + $arrayName(missing) :     [0|1]
+	  + $arrayName(unknown) :     [0|1]
+	  + $arrayName(ignored) :     [0|1]
+	  + $arrayName(locked) :	  [0|1]
+	  + $arrayName(modified) :    [0|1]
+	  + $arrayName(status) :      A string like "Mod. file" or "Unknown folder"
+	  + if the element is a file (if $arrayName(kind) is "file")
+         + $arrayName(revision) :     the file revision (i.e. 1.1, 1.2.3.4...)
+         + $arrayName(timestamp) :    the time stamp on the server
+         + $arrayName(option) :       the substitution option (i.e. -kb)
+         + $arrayName(tag) :          the tag name (if any)
+         + $arrayName(conflict) :     the conflict desc. (if any)
+
+Built-in TCL commands only from the Files/Folder menu :
+-------------------------------------------------------
+
+* cvssel : return a list of the selected file(s) or folder(s). A simple list is
+  {"C:/myproject/foo.c", "C:/myproject/rsr/foo.rc"} or {"C:/myproject", "C:/myproject/rsr"}