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

   1 USING: help.markup help.syntax io.files.info ;
   2 IN: io.files.links
   3
   4 HELP: make-link
   5 { $values { "target" "a path to the symbolic link's target" } { "symlink" "a path to new symbolic link" } }
   6 { $description "Creates a symbolic link." } ;
   7
   8 HELP: read-link
   9 { $values { "symlink" "a path to an existing symbolic link" } { "path" "the path pointed to by the symbolic link" } }
  10 { $description "Reads the symbolic link and returns its target path." } ;
  11
  12 HELP: copy-link
  13 { $values { "target" "a path to an existing symlink" } { "symlink" "a path to a new symbolic link" } }
  14 { $description "Copies a symbolic link without following the link." } ;
  15
  16 { make-link read-link copy-link } related-words
  17
  18 ARTICLE: "io.files.links" "Symbolic links"
  19 "Reading and creating links:"
  20 { $subsection read-link }
  21 { $subsection make-link }
  22 "Copying links:"
  23 { $subsection copy-link }
  24 "Not all operating systems support symbolic links."
  25 { $see-also link-info } ;
  26
  27 ABOUT: "io.files.links"