basis/alien/libraries/finder/finder-docs.factor

   1 USING: help.markup help.syntax ;
   2 IN: alien.libraries.finder
   3
   4 HELP: find-library*
   5 { $values
   6   { "name" "a shared library name" }
   7   { "path/f" { $maybe "filesystem path" } }
   8 }
   9 { $description
  10   "Returns a filesystem path for a plain shared library name, or f if no library can be found."
  11 } ;
  12
  13 HELP: find-library
  14 { $values
  15   { "name" "a shared library name" }
  16   { "path/library-not-found" "a filesystem path or " { $snippet "name" } }
  17 }
  18 { $description
  19   "Used to load libraries whose exact filenames is not known in advance:"
  20   { $code
  21     "<< \"sqlite\" \"sqlite3\" find-library cdecl add-library >>"
  22   }
  23   "Note the parse time evaluation with " { $link POSTPONE: << } "."
  24 } ;