1fileutil::paths(n)                                          fileutil::paths(n)
2
3
4
5______________________________________________________________________________
6

NAME

8       fileutil::paths - Manage search path pools
9

SYNOPSIS

11       package require Tcl  8.4
12
13       package require fileutil::paths  ?1?
14
15       ::fileutil::paths poolName
16
17       poolName method ?arg arg ...?
18
19       poolName add path
20
21       poolName clear
22
23       poolName paths
24
25       poolName remove path
26
27______________________________________________________________________________
28

DESCRIPTION

30       Provides a snit class whose instances manage a pool of (search) paths.
31

API

33       The main command provides construction of search path pools:
34
35       ::fileutil::paths poolName
36              Creates  a  new,  empty  pool of search paths with an associated
37              global Tcl command whose name is poolName.  It may  be  used  to
38              invoke  various  operations  on  the pool.  It has the following
39              general form:
40
41              poolName method ?arg arg ...?
42                     method and arguments determine the exact behavior of  the
43                     command.
44
45              If  poolName is specified as %AUTO% a unique name will be gener‐
46              ated by the package itself.  The result of the  command  is  the
47              fully-qualified name of the instance command.
48
49       The following commands are possible for pool objects:
50
51       poolName add path
52              Adds  the  path to the pool.  Nothing is done if the path is al‐
53              ready known to the pool.  The result of the command is the empty
54              string.
55
56       poolName clear
57              Clears  the  entire pool. In other words, removes all paths from
58              it.  The result of the command is the empty string.
59
60       poolName paths
61              Returns the list of all paths known to the pool,  in  the  order
62              they were added.
63
64       poolName remove path
65              Removes the path from the pool, if it is known to the pool.  Un‐
66              known paths are ignored without error.  The result of  the  com‐
67              mand is the empty string.
68

BUGS, IDEAS, FEEDBACK

70       This  document,  and the package it describes, will undoubtedly contain
71       bugs and other problems.  Please report such in the  category  fileutil
72       of  the Tcllib Trackers [http://core.tcl.tk/tcllib/reportlist].  Please
73       also report any ideas for enhancements you may have for either  package
74       and/or documentation.
75
76       When proposing code changes, please provide unified diffs, i.e the out‐
77       put of diff -u.
78
79       Note further that  attachments  are  strongly  preferred  over  inlined
80       patches.  Attachments  can  be  made  by  going to the Edit form of the
81       ticket immediately after its creation, and  then  using  the  left-most
82       button in the secondary navigation bar.
83
84
85
86tcllib                                 1                    fileutil::paths(n)
Impressum