basis/tools/files/files-docs.factor

   1 ! Copyright (C) 2008 Doug Coleman.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: help.markup help.syntax ;
   4 IN: tools.files
   5
   6 HELP: directory.
   7 { $values
   8      { "path" "a pathname string" }
   9 }
  10 { $description "Prints information about all files in a directory to the output stream in a cross-platform way similar to the Unix " { $snippet "ls" } " command." } ;
  11
  12 ARTICLE: "tools.files" "Files tools"
  13 "The " { $vocab-link "tools.files" } " vocabulary implements directory files and file-systems listing in a cross-platform way." $nl
  14 "Listing a directory:"
  15 { $subsections directory. } ;
  16
  17 ABOUT: "tools.files"