basis/io/files/types/types-docs.factor

   1 USING: help.markup help.syntax ;
   2 IN: io.files.types
   3
   4 HELP: +regular-file+
   5 { $description "A regular file. This type exists on all platforms. See " { $link "io.files" } " for words operating on files." } ;
   6
   7 HELP: +directory+
   8 { $description "A directory. This type exists on all platforms. See " { $link "io.directories" } " for words operating on directories." } ;
   9
  10 HELP: +symbolic-link+
  11 { $description "A symbolic link file.  This type is currently implemented on Unix platforms only. See " { $link "io.files.links" } " for words operating on symbolic links." } ;
  12
  13 HELP: +character-device+
  14 { $description "A Unix character device file. This type exists on Unix platforms only." } ;
  15
  16 HELP: +block-device+
  17 { $description "A Unix block device file. This type exists on Unix platforms only." } ;
  18
  19 HELP: +fifo+
  20 { $description "A Unix fifo file. This type exists on Unix platforms only." } ;
  21
  22 HELP: +socket+
  23 { $description "A Unix socket file. This type exists on Unix platforms only." } ;
  24
  25 HELP: +unknown+
  26 { $description "A unknown file type." } ;
  27
  28 ARTICLE: "file-types" "File types"
  29 "Platform-independent types:"
  30 { $subsections
  31     +regular-file+
  32     +directory+
  33 }
  34 "Platform-specific types:"
  35 { $subsections
  36     +character-device+
  37     +block-device+
  38     +fifo+
  39     +symbolic-link+
  40     +socket+
  41     +unknown+
  42 } ;
  43
  44 ABOUT: "file-types"