fileutil::paths(3tcl)

✨ fileutil::paths ✨

okay so bestie, welcome to the manual page for fileutil::paths — it lives in the fileutil corner of the tcllib universe and it's literally just about managing search path pools. cute, right? 💅

---

🎀 NAME 🎀

fileutil::paths — manage search path pools. that's it. that's the whole vibe. 🌸

---

✨ SYNOPSIS ✨

package require Tcl 8.5 9

package require fileutil::paths ?1.1?

::fileutil::paths poolName

poolName method ?arg arg ...?

poolName add path

poolName clear

poolName paths

poolName remove path

---

💖 DESCRIPTION 💖

so basically this thing hands you a snit class, and every instance of it is out here managing a whole pool of (search) paths. one pool, many paths, very demure, very mindful. 🫶

---

🌈 API 🌈

the main command is the one that builds your search path pools for you:

• ::fileutil::paths poolName — creates a brand new, empty pool of search paths, and it comes with a global Tcl command attached whose name is poolName. you use that command to do all the operations on the pool. it's giving builder energy. the general shape of it is:

poolName method ?arg arg ...?

where method plus its args decide exactly what the command does. 👑

and listen — if you pass poolName as %AUTO%, the package itself will generate a unique name for you, no cap. the result of the command is the fully-qualified name of the instance command. slay.

---

🦋 the methods, bestie 🦋

these are the commands you can throw at a pool object:

• poolName add path — adds path to the pool. if the pool already knows that path? nothing happens, zero drama, no duplicates. the result of the command is the empty string.
• poolName clear — clears the ENTIRE pool. like, every path, gone, bye. in other words it removes all paths from it. the result of the command is the empty string.
• poolName paths — returns the list of all paths the pool knows about, in the order they were added. order matters bestie, don't forget it.
• poolName remove path — removes path from the pool, but only if the pool actually knows it. unknown paths get ignored, no error, no yelling, we're chill here. the result of the command is the empty string.

---

💀 BUGS, IDEAS, FEEDBACK 💀

ngl, this document and the package it describes will undoubtedly contain bugs and other problems. like, obviously. please report them in the fileutil category of the Tcllib Trackers: http://core.tcl.tk/tcllib/reportlist. and please also drop any ideas for enhancements you have for the package and/or the documentation — we want them all. 🙈

if you're proposing code changes, please bring unified diffs, i.e. the output of diff -u. periodt.

also, heads up: attachments are strongly preferred over inlined patches. you can attach stuff by going to the Edit form of the ticket right after you create it, and then hitting the left-most button in the secondary navigation bar. iykyk. 🎀

---

🧚 sign-off 🧚

and that's the whole page, bestie!! this was brought to you by tcllib version 1.1, and the manual page itself is fileutil::paths(3tcl). go forth and manage those path pools, you absolute main character. ⭐🌈💜