1[comment {-*- tcl -*- doctools manpage}]
2[manpage_begin fileutil::multi n 0.1]
3[moddesc   {file utilities}]
4[titledesc {Multi-file operation, scatter/gather, standard object}]
5[category  {Programming tools}]
6[require Tcl 8.4]
7[require fileutil::multi [opt 0.1]]
8[require fileutil::multi::op [opt 0.1]]
9[require wip [opt 1.0]]
10[description]
11[keywords {file utilities} copy move remove multi-file]
12[para]
13
14This package provides a single command to perform actions on multiple
15files selected by glob patterns. It is a thin layer over the package
16[package fileutil::multi::op] which provides objects for the
17same. This package simply creates a single such object and directs all
18file commands to it.
19
20[para]
21
22At the core is a domain specific language allowing the easy
23specification of multi-file copy and/or move and/or deletion
24operations. Alternate names would be scatter/gather processor, or
25maybe even assembler.
26
27For the detailed specification of this language, and examples, please
28see the documention for the package [package fileutil::multi::op].
29
30[section {PUBLIC API}]
31
32The main command of the package is:
33
34[list_begin definitions]
35
36[call [cmd ::fileutil::multi] [opt [arg word]...]]
37
38This command interprets the specified words as file commands to
39execute. See the section [sectref-external {FILE API}] of the
40documentation for the package [package fileutil::multi::op] for
41the set of acceptable commands, their syntax, and semantics.
42
43[para]
44
45The result of the command is the result generated by the last file
46command it executed.
47
48[list_end]
49
50[section {BUGS, IDEAS, FEEDBACK}]
51
52This document, and the package it describes, will undoubtedly contain
53bugs and other problems.
54
55Please report such in the category [emph fileutil] of the
56[uri {http://sourceforge.net/tracker/?group_id=12883} {Tcllib SF Trackers}].
57
58Please also report any ideas for enhancements you may have for either
59package and/or documentation.
60
61[manpage_end]
62