extra/ldcache/ldcache-docs.factor

   1 ! Copyright (C) 2017 Björn Lindqvist.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: help.markup help.syntax strings ;
   4 IN: ldcache
   5
   6 HELP: search
   7 { $values
   8   { "entries" { $sequence ldcache-entry } }
   9   { "namespec" "library name" }
  10   { "arch" "architecture" }
  11   { "entry/f" { $maybe ldcache-entry } }
  12 }
  13 { $description "Searches among the entries for an entry with a matching name and architecture." } ;
  14
  15 HELP: find-so
  16 { $values { "namespec" "library name" } { "so-name/f" { $maybe string } } }
  17 { $description "Looks up the library named 'namespec' from the system cache." } ;
  18
  19 ARTICLE: "ldcache" "LD Cache"
  20 "Vocab for interfacing with the '/etc/ld.so.cache' Unix file." ;
  21
  22 ABOUT: "ldcache"