home *** CD-ROM | disk | FTP | other *** search
/ ftp.funduc.com / 2014.08.ftp.funduc.com.tar / ftp.funduc.com / dirtkt-64.zip / DTScriptCommands.txt < prev    next >
Text File  |  2008-12-04  |  20KB  |  474 lines
  1. #             Directory Toolkit Command Script Syntax 
  2. #                           (Ver 6.1)
  3. #                       Funduc Software, Inc
  4. #                        Copyright 1997-2009
  5. #      http://www.funduc.comááááhttp://www.searchandreplace.com
  6. #        support@funduc.com áááásupport@searchandreplace.comá
  7. #
  8.  
  9. # Comment lines are prefaced with # character.  Comments should
  10. # not be placed after script commands -- keep comments on 
  11. # separate lines.
  12.  
  13. # Note: All script commands and comments must begin in column 1!!!
  14.  
  15. # GENERAL COMMENTS
  16. # ================
  17. # The [Default] Section, which is optional, is used to specify 
  18. # parameters for all [Action ]s in the script.  You can also specify 
  19. # parameters in specific [ActionX] section(s).  For example, 
  20. # see [Action3] section below.
  21.  
  22. # All scripts must have at least one [Action ] section!!  For this model
  23. # script, [Action1] and [Default] are redundant -- both have the same 
  24. # path settings.  In actual use, for single [Action] scripts you would
  25. # not specify [Default] and would instead use [Action1] alone
  26.  
  27. # If present, [Default] should always be specified first.  The order 
  28. # of processing for the [Action ] sections is determined by their number.
  29. # They can be placed in any order within the script.  Furthermore, numbers 
  30. # do not need to be inclusive -- you can skip numbers.  For example, if 
  31. # your script has [Action8] [Action2] [Action5] they will be processed 
  32. # in the order: [Action2] [Action5] [Action8].  Please see the F1 hlp
  33. # for more information.
  34.  
  35. # If an [Action] number is duplicated, the program will process 
  36. # the first of that number as it is found in the script.  For 
  37. # example, in a script with [Action1], [Action2], [Action3], [Action2], 
  38. # the first [Action2] will be processed. The 2nd is ignored.
  39.  
  40. [Default]
  41.  
  42. # *** PATH SETTING ***
  43. # Note: If Path1= or Path2= setting are listed in [Default], create a 
  44. # [Action1] tag with no Path1= or Path2= setting in order to use 
  45. # Path1= or Path2= as specified in [Default]. 
  46. # If your [Action1] section has a Path1= and Path2= settings 
  47. # they will supercede what is specified in [Default].
  48. Path1=i:\test
  49. Path2=i:\testsr
  50.  
  51. # Alternate Specification:
  52. # Paths can also be specified in the form of variables that can then
  53. # be employed as needed within specific [Action] sections.  For example,
  54.  
  55. # TestPath1=D:\Test\Folder1
  56. # TestPath2=D:\Test\Folder2
  57. # MyDocsForWork=C:\Documents and Settings\BillsWork\My Documents
  58. # DocsForGaming=C:\Documents and Settings\Game Player\My Documents
  59.  
  60. # The variable names can be any string except they must not begin 
  61. # with the # or ' characters and they should not contain spaces
  62.  
  63. # It is OK to use both forms within a single script. 
  64.  
  65. # See the program F1 hlp, [Action4] and [Action5] sections 
  66. # below, and the Example4.cfg sample script included with the 
  67. # program for more info.
  68.  
  69.  
  70. # *** SYNCHRONIZE/COMPARE OPERATION TO PERFORM ***
  71. # If not specified, Default Operation = 6.
  72. # Use only one switch per [ActionX] section.  
  73. # Use a value of 6 (Compare Only) to generate an output report 
  74. # without performing any synchronize operations.
  75.  
  76. # Note: The - value, 'prompted' switches below bring up the Directory
  77. # Toolkit synchronize dialog, with that function pre-selected.  You can 
  78. # then cancel or permit the operation.  If you use your script with our 
  79. # Folder Synchronize utility, 'prompted' synchronize is not available
  80. # for that product.  Folder Synchronize will instead carry out that 
  81. # 'No Prompt' counterpart.  Use Confirm Updates=1 with Folder Synchronize 
  82. # if you want an opportunity for user intervention. 
  83.  
  84. # To cause Directory Toolkit to display two paths in a compare but take 
  85. # no further action:
  86. #    - Make a script with only one [Action].  You must have only one 
  87. #      action, otherwise selecting OK in the synchronize dialog will 
  88. #      cause the program to continue on to the next step.
  89. #    - Use Operation=-8 
  90. #    - Select the OK button in the Synchronize dialog. 
  91. #  Alternatively, use the Directory Toolkit /s and /t command line switches 
  92. # to launch the program on the two paths in question.
  93.  
  94. #                   SWITCH VALUE             
  95. #                    No 
  96. # OPERATION        Prompt Prompted ACTION
  97. # ---------------- ------ -------- ------------------
  98. # Synchronize         0     -2     Update & Add in both directions
  99. # Augment             1     -3     Add only new to target
  100. # Refresh             2     -4     Update only existing in target
  101. # Update              3     -5     Update & Add new to target
  102. # Prune               4     -6     Update, Add new, Remove Orphans
  103. # Remove Identical    5     -7     Remove identical files from target
  104. # Compare Only        6     -8     Display only - No synch operations
  105. # Recreate Dirs       7     -9     Recreate directory structure only.
  106. #                                    No other files are copied.
  107. # Delete Empty Dirs   8    -10     Delete empty directories from the 
  108. #                                    target. No other files are copied.
  109. # Prompt only               -1     Display synch dialog with no default
  110. #                                    negative values above serve as 
  111. #                                    default settings in dialog.  This 
  112. #                                    provides an opportunity to check 
  113. #                                    progress or perform other tasks
  114. #                                    before continuing
  115. Operation=6
  116.  
  117.  
  118. # *** FILE MASK ***
  119. # File masks are specified with the Mask= switch.  Complex file masks
  120. # can be used.
  121. # If no mask is specified the default assumed is *.*
  122. # See the Directory Toolkit complex mask dialog for a builder to 
  123. # help you construct complex masks. 
  124. # Examples: 
  125. #  Mask                   Effect
  126. #  --------------------   ---------------------------------------------------
  127. #  *.i??                  Include files ending with .i followed by 3 characters
  128. #  win.ini                This would be found by the above. 
  129. #  ~moricons.dll          Exclude this specific file.
  130. #  ~\images\te*\          A wildcard (te*) to skip images\test, images\testing, etc.
  131. #  ~\*\junk*\*\*.*        Skips all files in any subdir junk* and all under that
  132. # All subdir specifications are relative Path1= and Path2=
  133. # Separate multiple specifications with ; character.  For example,
  134. #  *.*;~\*\junk*\*\*.*
  135. #
  136. Mask=*.*
  137.  
  138. # *** PROCESS SUBDIRECTORIES ***
  139. # Use the switch to include or not include subdirectories.  If not 
  140. # specified, Search_subdir=1 is assumed.
  141. # Possible Values:
  142. #  0 = Do not recurse subdirs
  143. #  1 = Include subdirs
  144. Search_subdir=1
  145.  
  146. # *** OUTPUT FILE FUNCTIONS ***
  147. # To create an Output File of the results, specify a path & file
  148. # name using the Output File= switch.  Leave blank to not write an
  149. # output file.  To write to the output file in Append mode, also 
  150. # specify Append to Output File=1
  151. #
  152. # IMPORTANT: Use a path for the output file other than one being used
  153. # during a synchronize operation.  If your output file is in a path that
  154. # is being actively synchronized you may get file sharing errors.
  155. #
  156. # It is OK to define different Output Files for each [ActionX] section.
  157. # Possible Values for append switch:
  158. #  0 = Output file is overwritten.
  159. #  1 = Output writes are in append mode.
  160. Output File=
  161. Append to Output File=1
  162.  
  163. # *** REPLACEMENT CONFIRMATIONS ***
  164. # This switch controls whether prompting for replaces is made.
  165. # The Use OS Operations= switch to determine the style of the 
  166. # prompting offered.  If not specified, Confirm Updates=1
  167. # is assumed. 
  168. # Possible Values:
  169. #  0 = No update prompts for file replacements are supplied. 
  170. #  1 = Confirmation prompts will be made. 
  171. Confirm Updates=1
  172.  
  173. # *** USE OS vs INTERNAL CONFIRMATION DIALOGS ***
  174. # The Use OS Operations= switch controls the type of file
  175. # confirmation dialog used: internal vs. standard Windows
  176. # dialogs.  This is the same as the Native file operations 
  177. # setting.  The internal dialogs provide more information and
  178. # choices than the native Windows dialogs.  Some network drivers
  179. # & removable media may require 'native' mode.  If you have
  180. # trouble with subdirs not being created on a path, try
  181. # Use OS Operations=1. 
  182. # The default if not specified is Use OS Operations=0
  183. # Possible Values:
  184. # 0 = Use internal file confirmation dialogs.
  185. # 1 = Use native OS file operations.
  186. Use OS Operations=0
  187.  
  188.  
  189. # *** DISPLAY ERROR MESSAGES ***
  190. # This switch is for future use within Directory Toolkit. 
  191. # If you use Folder Synchronize, the Display Error Messages= switch
  192. # to controls whether or not the program issues small Action
  193. # Completed message boxes after a script is complete.  We recommend
  194. # setting this switch to Display Error Messages=1 if you are doing
  195. # operations to/from floppy media because this will help the program
  196. # detect some OS- related driver error messages for some
  197. # manufacturer's drivers such as zip disks, CDRW drives, etc.  For
  198. # totally silent operations specify Display Error Messages=0.
  199. Display Error Messages=1
  200.  
  201. # *** BINARY FILE CONTENTS COMPARISON ***
  202. # Use this to perform a byte level contents comparison when two
  203. # files have an alike name but different file date.  The files will
  204. # be considered identical if the contents are the same.  Enable this
  205. # only if you need it -- because the entire file must be read,
  206. # processing will be slower, especially when network paths are
  207. # involved.  If not specified, Check Same Size Files=0 is assumed.
  208. # Possible Values:
  209. #  0 = Do not perform binary file comparison.
  210. #  1 = Perform binary file comparison.
  211. Check Same Size Files=0
  212.  
  213. # *** BINARY FILE CONTENTS COMPARISON - SAME DATE FILES ***
  214. # To not perform a binary contents check on same date/size files,
  215. # specify Binary Check Same Date Files=0.  This will speed up
  216. # operations when Check Same Size Files=1 is enabled.  Use this only
  217. # if you are sure your same date/size files are identical.  This
  218. # switch has no effect if Check Same Size Files=0 is specified.  If
  219. # not specified, Binary Check Same Date Files=1 is assumed.
  220. # Possible Values: 
  221. #  0 = Do not binary compare same size/date files.
  222. #  1 = Perform binary file compare on all files.
  223. Binary Check Same Date Files=1
  224.  
  225. #**** UNIX COMPARE MODES ****
  226. # Two special 'Unix' Directory Compare modes are available as a
  227. # subset of Binary File Comparison (above) to compare files that
  228. # have matching date/time stamps but different file sizes.  The
  229. # first, 'Ignore Whitespace Compare', disregards whitespace
  230. # including spaces and line terminators.  This mode can be used to
  231. # compare Unix vs.  PC files that are the same name and have matching
  232. # time/date stamps.  The second, 'Ignore Case Compare', disregards
  233. # the case of the text within the files.
  234. # 
  235. # Important Notes - Please Read:
  236. # - The Check Same Size Files=1 switch MUST also be specified for 
  237. #   either of these switches to work.
  238. # - Ignore Whitespace Compare can be done alone. 
  239. # - To use Ignore Case Compare you MUST also enable Ignore Whitespace
  240. #   Compare.
  241. # - The default for both switches if not specified is =0, e.g.,
  242. #   Ignore Whitespace Compare=0, Ignore Case Compare=0
  243. # 
  244. # Settings if you want Unix Compare alone:
  245. #  Check Same Size Files=1
  246. #  Ignore Whitespace Compare=1
  247. #  Ignore Case Compare=0
  248. # 
  249. # Settings if you want Unix Compare and Ignore Case Compare:
  250. #  Check Same Size Files=1
  251. #  Ignore Whitespace Compare=1
  252. #  Ignore Case Compare=1
  253.  
  254. # *** DISPLAY DIFFERENT / IDENTICAL FILES ***
  255. # Use these switches to control whether the program includes
  256. # different &/or identical in your synchronize or comparison
  257. # operation.  If not specified, Show Different=1 and 
  258. # Show Identical=1 are assumed. 
  259. # Possible Values:
  260. #  0 = Do not include those files
  261. #  1 = Include those files
  262. Show Different=1
  263. Show Identical=1
  264.  
  265. # *** INCLUDE FILES THAT EXIST ONLY IN ONE PATH ***
  266. # Show Files in 1 Dir= is used to control whether orphan files in
  267. # one or the other path are included in an operation.  In most cases
  268. # you will probably want Show Files in 1 Dir=1.  If not specified, 
  269. # Show Files in 1 Dir=1 is assumed.
  270. # Possible Values:
  271. #  0 = Do not include files that exist in one dir only.
  272. #  1 = Include files that exist in one directory only.
  273. Show Files in 1 Dir=1
  274.  
  275. # *** OVERWRITE BLOCKS - NEWER &/or OLDER FILES ***
  276. # The two switches below are used to prevent the replacement of
  277. # newer and/or older files.  For safety reasons you probably should
  278. # keep 'Newer Overwrite' turned off -- If enabled, a synchronize
  279. # could replace newer files with older versions!!!  If 'Newer
  280. # Overwrite' is not specified the program default is disabled.
  281. # 'Older Overwrite' should probably be enabled (this is the
  282. # default).  If you disable 'Older Overwrite', older versions of
  283. # files will not be updated with newer versions during a
  284. # synchronize.  If not specified, Newer Overwrite=0 and 
  285. # Older Overwrite= 1 are assumed.
  286. # Possible Values:
  287. #  0 = Do not overwrite.
  288. #  1 = Allow overwrites.
  289. Newer Overwrite=0
  290. Older Overwrite=1
  291.  
  292.  
  293. # *** LOCATE SAME NAMED FILES ***
  294. # Use the Match In Subdir=1 switch to enable a special mode to 
  295. # search for duplicate files on your disk, e.g., to scan for 
  296. # duplicate DLLs or ferret out like-named documents across 
  297. # different subdirectories.  In general, you would specify the 
  298. # same path for Path1= and Path2= when using this mode, although 
  299. # it is OK to scan two different paths.  
  300. # Do not enable Match In Subdir=1 if you do not need it - the file 
  301. # lists returned are generally not what you would want for a typical 
  302. # synchronize operation.  Operation=6, which is a comparison only, 
  303. # is the most common operation usage when Match In Subdir=1 is used. 
  304. # The default is Match In Subdir=0 
  305. # Possible Values:
  306. #  0 = Do not search for duplicate files in the paths.
  307. #  1 = Perform a Match Duplicate Files comparison. 
  308. Match In Subdir=0
  309.  
  310. # *** TIME CHECK PRECISION ***
  311. # Because NT-class operating systems such as Windows NT/2000/XP use
  312. # a more accurate time stamp than Windows 95/98, comparisons between
  313. # a Win95/98 and NT-class machine may lead to false mismatches a
  314. # second apart (Win95/98 precision is on even seconds).  The 
  315. # Time Check Precision= switch can be used to establish a +/- range, 
  316. # inside of which two files will be considered identical if their 
  317. # name & size are the same.  Specify the value in seconds to use 
  318. # for Time Check Precision.  If not specified, Time Check Precision=3 
  319. # is assumed.
  320. Time Check Precision=3
  321.  
  322. # *** PATH 2 TIME COMPENSATION *** 
  323. # The Add Seconds To Second Dir= switch can be used compensate for a
  324. # known, exact time difference between two paths.  This switch can
  325. # be useful if time zone differences are affecting the reported file
  326. # times for one or the other path and if you do not wish to use
  327. # 'Binary File Contents' compare mode (Check Same Size Files=
  328. # switch).  If Add Seconds To Second Dir= is specified the program
  329. # adds or subtracts the specified number of seconds from the
  330. # reported file times for Path2.  
  331. # For example, if Add Seconds To Second Dir=3600 is specified and 
  332. # a file time stamp is 08:00, the program will use 09:00 for the 
  333. # file time when evaluating comparisons.  The value can be + or -.  
  334. # All files in path2 are affected.  Add Seconds To Second Dir= is 
  335. # a fixed value, not a range.  Omit this switch entirely if you do 
  336. # not need it.
  337. # Add Seconds To Second Dir=
  338.  
  339. # *** CASE SENSITIVE NAME MATCHING ***
  340. # Use this to compare file names case sensitive or not.  If not 
  341. # specified, Case Sensitive=0 is assumed.
  342. # Possible Values:
  343. #  0 = File name matching not case sensitive.
  344. #  1 = File name matching is case sensitive.
  345. Case Sensitive=0
  346.  
  347. # *** GROUPING SIMILAR FILES ***
  348. # When Group Files=1 is specified, the program clusters files in a
  349. # comparison display by file name, with orphaned files grouped at
  350. # the top or bottom of the list.  When Group Files=0, comparisons are
  351. # organized such that 'missing' or 'unmatched' files are visible
  352. # within the context of other files according to the sort order.  If
  353. # not specified, Group Files=0 is assumed.
  354. # Possible Values:
  355. #  0 = Do not group files.
  356. #  1 = Group files.
  357. Group Files=0
  358.  
  359. # *** DISPLAY AND OUTPUT COLUMN SETTINGS ***
  360. # The Display Columns= and Output Columns= switches can be used to
  361. # control the layout of Funduc Software's Directory Toolkit GUI
  362. # display and the layout of the output report in Directory Toolkit
  363. # and Funduc Software's Folder Synchronize.  The default used for a
  364. # script are the settings in place when the program was last run
  365. # interactively.  Describing the possible manual settings is
  366. # complicated.  Please see 'ScriptColumnDefinitionSettings.txt', that
  367. # is installed in the program path, more information and some example
  368. # settings.
  369. # Display Columns=
  370. # Output Columns=
  371.  
  372. # *** SORTING OPTIONS ***
  373. # To sort the file listing, use one of the values below.
  374. # To control ascending vs descending, use the Sort Type= 
  375. # switch.
  376. # Field to sort on:
  377. # SORT_BY_NONE = -1 (default if nothing specified)
  378. # SORT_BY_NAME = 0
  379. # SORT_BY_TYPE = 1
  380. # SORT_BY_DATE = 2
  381. # SORT_BY_SIZE = 3
  382. # SORT_BY_PATH = 4
  383. # SORT_BY_CHKSUM = 5
  384. # SORT_BY_CRC32 = 6
  385. # SORT_BY_ADATE = 7
  386. # SORT_BY_CDATE = 8
  387. Sort Compare=-1
  388.  
  389. # For Ascending vs Descending, Sort Type= values are:
  390. # 0 = Descending
  391. # 1 = Ascending 
  392. Sort Type=1
  393.  
  394. # *** FILTERING FILES ***
  395. #
  396. # The Mask= switch filters files by name &/or path.
  397. #
  398. # Other switches are available to filter files by size, date, and
  399. # file attribute.  Reverse Filters= switch is used to cause these 
  400. # switches to function as 'exclude' or 'include'. 
  401. # 
  402. # The values at below are the defaults if not specified (all
  403. # files included).  Omit those entirely if you do not need any
  404. # special settings.  The switches work in tandem with each other and
  405. # the combinations of values is very complex.  Please see the file,
  406. # 'ScriptFilterSettings.txt', that is installed with the program
  407. # for more information.
  408. # 
  409. # The program has a special string - %%today%% - that can be used
  410. # for the two date filters.  %%today%% uses the current computer date
  411. # for the respective filter setting.  You can add or subtract days
  412. # by specifying a +/- value before the ending %% characters.  
  413. # 
  414. # Examples: 
  415. #  %%today-5%% uses a date filter of the current date minus 5 days
  416. #  %%today+1%% adds one day to the current date
  417. #
  418. # Defaults: 
  419. # Min Size Filter=
  420. # Max Size Filter=
  421. # Min Date Filter= 
  422. # Max Date Filter= 
  423. # Skip Files Mask=0 
  424. # Ignore Attributes=55 
  425. # Reverse Filters=0
  426.  
  427.  
  428. # *** ADDITIONAL ACTIONS ***
  429. #
  430. # Scripts can carry out more than one action.  To do this, make
  431. # [Action ] sections as modeled below.  They can be specified in 
  432. # any order in the script.  The program parses the entire 
  433. # script and implements the 'Actions' sequentially, based 
  434. # on their number, 
  435. # e.g., [Action1], [Action2], [Action3], etc.
  436. # Settings specified in [Default] will be in effect if that same
  437. # switch is not specified in a given Action section.
  438.  
  439. [Action1]
  440. Path1=i:\test
  441. Path2=i:\testsr
  442.  
  443. [Action2]
  444. Path1=i:\testsr
  445. Path2=i:\test
  446. Operation=1
  447.  
  448. [Action3]
  449. Path1=C:\My Documents\Current Projects
  450. Path2=C:\My Documents\Backup
  451. Operation=1
  452. Mask=*.doc;*.txt;~\*\Project10\*\*.doc
  453. Confirm Updates=1
  454. Search_subdir=1
  455.  
  456. # The next two [Action] sections use the "Alternate Specification" 
  457. # described in the [Default] section. Note that [Action5] uses a literal
  458. # path and a variable path that is defined in the [Default] section.
  459. [Action4]
  460. Path1=TestPath2
  461. Path2=MyDocsForWork
  462. Operation=2
  463. Mask=*.doc
  464. Confirm Updates=0
  465. Search_subdir=1
  466.  
  467. [Action5]
  468. Path1=D:\Old_Work_Stuff
  469. Path2=MyDocsForWork
  470. Operation=2
  471. Mask=*.txt
  472. Confirm Updates=0
  473. Search_subdir=1
  474.