(index ("pathname?" 0) ("check-pathname" 178) ("error-pathname" 178) ("filename?" 354) ("check-filename" 510) ("error-filename" 510) ("dot-filename?" 686) ("dot-pathname?" 874) ("check-directory" 1066) ("error-directory" 1245) ("directory-fold" 1335) ("create-pathname-directory" 2150) ("make-program-filename" 2384) ("make-shell-filename" 2683) ("file-exists-in-directory?" 3010) ("which-command-pathnames" 3381) ("which-command-pathname" 3892) ("remove-dotfiles" 4162) ("directory-utility-stack" 4297) ("push-directory" 4515) ("pop-directory" 4679) ("pop-toplevel-directory" 4797))
(def (sig (procedure "(pathname? OBJ) -> boolean" (id pathname?))) (p "Does not verify existence of the file, just whether the pathname has a directory and/or file component."))
(def (sig (procedure "(check-pathname LOCATION OBJECT [ARGNAM]) -> pathname" (id check-pathname)) (procedure "(error-pathname LOCATION OBJECT [ARGNAM])" (id error-pathname))))
(def (sig (procedure "(filename? OBJ) -> boolean" (id filename?))) (p "Does not verify existence of the file, just whether it has a directory component."))
(def (sig (procedure "(check-filename LOCATION OBJECT [ARGNAM]) -> filename" (id check-filename)) (procedure "(error-filename LOCATION OBJECT [ARGNAM])" (id error-filename))))
(def (sig (procedure "(dot-filename? PATHNAME) -> boolean" (id dot-filename?))) (p "Does the " (tt "OBJECT") " name a file with a dot-name?") (p "Does not verify existence of the file!"))
(def (sig (procedure "(dot-pathname? PATHNAME) -> boolean" (id dot-pathname?))) (p "Is any directory in the " (tt "PATHNAME") " a dot-filename?") (p "Does not verify existence of the file!"))
(def (sig (procedure "(check-directory LOCATION OBJECT [ARGNAM]) -> directoryname" (id check-directory))) (p "Does the " (tt "OBJECT") " name an existing " (tt "directory") ">"))
(def (sig (procedure "(error-directory LOCATION OBJECT [ARGNAM])" (id error-directory))))
(def (sig (procedure "(directory-fold FUNCTION IDENTITY DIRECTORY [#:dotfiles? DOTFILES?]) -> *" (id directory-fold))) (p "Invokes " (tt "FUNCTION") " on each " (tt "filename") " in the " (tt "DIRECTORY") " and the recursive value from " (tt "IDENTITY") ". Returns the final value.") (dl (dt (tt "FUNCTION")) (dd (tt "(filename * -> *)") ".") (dt (tt "DOTFILES")) (dd (tt "boolean") " ; include files with a " (tt "\".\"") " prefix ; Default " (tt "#f") ".")) (p (i "Note") " that only the " (tt "filename") " is passed and not the complete " (tt "pathname") ". The " (tt "\".\"") " and " (tt "\"..\"") " filenames are not supplied no matter the " (tt "DOTFILES?") " setting.") (p "On a " (i "Windows") " platform hidden files have a " (tt "hidden") " attribute so this routine is rather " (i "*nix") " centric."))
(def (sig (procedure "(create-pathname-directory PATHNAME)" (id create-pathname-directory))) (p "Ensures the directory component of " (tt "PATHNAME") " exist.") (p "Like the " (i "*nix") " `\"mkdir -p `dirname PATHNAME`\" command."))
(def (sig (procedure "(make-program-filename COMMAND) -> *" (id make-program-filename))) (p "Returns the platform specific form of an executable command filename.") (p "On " (i "Windows") " the " (tt "\"exe\"") " extension is added unless an extension is already present. Does nothing otherwise."))
(def (sig (procedure "(make-shell-filename COMMAND) -> *" (id make-shell-filename))) (p "Returns the platform specific form of a shell command filename.") (p "On " (i "Windows") " the " (tt "\"bat\"") " extension is added unless an extension is already present. Otherwise conditionally adds the " (tt "\"sh\"") " extension."))
(def (sig (procedure "(file-exists-in-directory? FILENAME [DIRECTORY ...]) -> (or #f pathname)" (id file-exists-in-directory?))) (p "Returns the pathname when " (tt "FILENAME") " exists in the " (tt "DIRECTORY ...") ", otherwise #f.") (p (tt "DIRECTORY ...") " as make-pathname.") (p "When only the " (tt "FILENAME") " argument supplied then the same as file-exists?."))
(def (sig (procedure "(which-command-pathnames COMMAND-NAME [ENVIRONMENT-VARIABLE]) -> (or #f (list-of pathname))" (id which-command-pathnames))) (p "Returns the pathnames of " (tt "COMMAND-NAME") " in the " (tt "ENVIRONMENT-VARIABLE") " where the file exists, or #f when nothing found.") (p "The default " (tt "ENVIRONMENT-VARIABLE") " is \"PATH\".") (p "Uses the platform specific \"PATH\" environment variable element separator - a " (i "Windows") " " (tt "#\\;") ", and a " (i "*nix") " " (tt "#\\:") "."))
(def (sig (procedure "(which-command-pathname COMMAND-NAME [ENVIRONMENT-VARIABLE]) -> (or #f pathname)" (id which-command-pathname))) (p "Same as which-command-pathnames but returns the first pathname only.") (p "Like the " (i "*nix") " `which COMMAND-NAME` command."))
(def (sig (procedure "(remove-dotfiles FILES)" (id remove-dotfiles))) (p "Remove dot files from a directory list. Useful with glob."))
(def (sig (parameter "(directory-utility-stack [STACK]) -> stack" (id directory-utility-stack))) (p "Which " (tt "stack") " to use for directory stack operations.") (p (tt "stack") " is from " (int-link "stack") "."))
(def (sig (procedure "(push-directory DIRECTORY)" (id push-directory))) (p "Push the current directory and change to the " (tt "string") " " (tt "DIRECTORY") "."))
(def (sig (procedure "(pop-directory) -> string" (id pop-directory))) (p "Pop the last directory and change to it."))
(def (sig (procedure "(pop-toplevel-directory) -> string" (id pop-toplevel-directory))) (p "Pop the earliest directory and change to it."))
