(index ("event?" 0) ("event-wd" 0) ("event-flags" 0) ("event-cookie" 0) ("event-name" 0) ("%init!" 988) ("%clean-up!" 1103) ("%add-watch!" 1249) ("%remove-watch!" 2302) ("%next-events!" 2452) ("init!" 2820) ("clean-up!" 3074) ("%fd" 3267) ("%fd" 3267) ("add-watch!" 3513) ("remove-watch!" 4561) ("add-watch-recursively!" 4706) ("wd->path" 5265) ("wd-list" 5400) ("path-list" 5502) ("next-events!" 5598) ("%events" 5961) ("next-event!" 5961) ("event->pathname" 6378) ("max-queued-events" 6530) ("max-user-instances" 6530) ("max-user-watches" 6530))
(def (sig (procedure "(event? X)" (id event?)) (procedure "(event-wd EVENT)" (id event-wd)) (procedure "(event-flags EVENT)" (id event-flags)) (procedure "(event-cookie EVENT)" (id event-cookie)) (procedure "(event-name EVENT)" (id event-name))) (p "Event predicate and accessors for event records.  An event has a watch descriptor for associating it with a watch, a list of flags associated with the event, a cookie that is set for " (tt "rename") " events to allow connecting the old and new file name and a name that is set for file events inside a watched directory.") (p "The event flag list consists of at least one of the following symbols:") (ul (li (tt "access")) (li (tt "attrib")) (li (tt "close-write")) (li (tt "close-nowrite")) (li (tt "create")) (li (tt "delete")) (li (tt "delete-self")) (li (tt "ignore")) (li (tt "isdir")) (li (tt "modify")) (li (tt "move-self")) (li (tt "moved-from")) (li (tt "moved-to")) (li (tt "open")) (li (tt "q-overflow")) (li (tt "unmount"))))
(def (sig (procedure "(%init!)" (id %init!))) (p "Initializes an user instance and returns its file descriptor."))
(def (sig (procedure "(%clean-up! FD)" (id %clean-up!))) (p "Frees the user instance associated with " (tt "FD") " and all associated watches."))
(def (sig (procedure "(%add-watch! FD PATH FLAGS)" (id %add-watch!))) (p "Adds a watch for " (tt "PATH") " which must be an absolute or relative path pointing to a file or directory.  " (tt "FLAGS") " is a list of at least one symbol describing the events one is interested in.  Returns a watch descriptor associated with the watch.") (p "The event flag list consists of at least one of the following event type symbols:") (ul (li (tt "access")) (li (tt "attrib")) (li (tt "close-write")) (li (tt "close-nowrite")) (li (tt "create")) (li (tt "delete")) (li (tt "delete-self")) (li (tt "modify")) (li (tt "move-self")) (li (tt "moved-from")) (li (tt "moved-to")) (li (tt "open"))) (p "Further convenience flags:") (ul (li (tt "move") " (equivalent to " (tt "(moved-from moved-to)") ")") (li (tt "close") " (equivalent to " (tt "(close-write close-nowrite)") ")") (li (tt "all-events") " (catches all event types)")) (p "Further options:") (ul (li (tt "dont-follow")) (li (tt "excl-unlink")) (li (tt "mask-add")) (li (tt "oneshot")) (li (tt "onlydir"))))
(def (sig (procedure "(%remove-watch! FD WD)" (id %remove-watch!))) (p "Removes a watch as identified by the given watch descriptor " (tt "WD") "."))
(def (sig (procedure "(%next-events! FD)" (id %next-events!))) (p "Blocks the current thread to wait for events and returns a list of at least one event record.  Note that calling this procedure does " (i "not") " block other SRFI-18 threads.  In other words, it is possible to have a background thread reacting to file events while other threads proceed normally."))
(def (sig (procedure "(init!)" (id init!))) (p "Initializes an user instance, returning " (tt "#t") " when successful and " (tt "#f") " if it has been initialized before.  This procedure must be called before manipulating watches and fetching events."))
(def (sig (procedure "(clean-up!)" (id clean-up!))) (p "Frees the user instance and all associated watches, returning " (tt "#t") " when successful and " (tt "#f") " on subsequent attempts."))
(def (sig (parameter "(%fd)" (id %fd)) (parameter "(%fd FD)" (id %fd))) (p "Parameter holding the user instance file descriptor.  You shouldn't need to mess with this unless you insist on using more than one user instance for watching events."))
(def (sig (procedure "(add-watch! PATH FLAGS)" (id add-watch!))) (p "Adds a watch for " (tt "PATH") " which must be an absolute or relative path pointing to a file or directory.  " (tt "FLAGS") " is a list of at least one symbol describing the events one is interested in.  Returns a watch descriptor associated with the watch.") (p "The event flag list consists of at least one of the following event type symbols:") (ul (li (tt "access")) (li (tt "attrib")) (li (tt "close-write")) (li (tt "close-nowrite")) (li (tt "create")) (li (tt "delete")) (li (tt "delete-self")) (li (tt "modify")) (li (tt "move-self")) (li (tt "moved-from")) (li (tt "moved-to")) (li (tt "open"))) (p "Further convenience flags:") (ul (li (tt "move") " (equivalent to " (tt "(moved-from moved-to)") ")") (li (tt "close") " (equivalent to " (tt "(close-write close-nowrite)") ")") (li (tt "all-events") " (catches all event types)")) (p "Further options:") (ul (li (tt "dont-follow")) (li (tt "excl-unlink")) (li (tt "mask-add")) (li (tt "oneshot")) (li (tt "onlydir"))))
(def (sig (procedure "(remove-watch! WD)" (id remove-watch!))) (p "Removes a watch as identified by the given watch descriptor " (tt "WD") "."))
(def (sig (procedure "(add-watch-recursively! PATH FLAGS)" (id add-watch-recursively!))) (p "Adds a watch for " (tt "PATH") " and traverses it recursively to add watches for any directories found in it.  Each watch is applied with " (tt "FLAGS") ", refer to the documentation of " (tt "add-watch!") " for further details.  Returns a list of watch descriptors associated with each established watch.  Note that this procedure does " (i "not") " work in an atomic manner, it cannot be guaranteed that all directories in " (tt "PATH") " will receive watches."))
(def (sig (procedure "(wd->path WD)" (id wd->path))) (p "Returns the path the watch associated with " (tt "WD") " was created with."))
(def (sig (procedure "(wd-list)" (id wd-list))) (p "Returns a list of all known watch descriptors."))
(def (sig (procedure "(path-list)" (id path-list))) (p "Returns a list of all watched paths."))
(def (sig (procedure "(next-events!)" (id next-events!))) (p "Blocks the current thread to wait for events and returns a list of at least one event record.  Note that calling this procedure does " (i "not") " block other SRFI-18 threads.  In other words, it is possible to have a background thread reacting to file events while other threads proceed normally."))
(def (sig (parameter "(%events)" (id %events)) (procedure "(next-event!)" (id next-event!))) (p "Convenience procedure for fetching one event at a time.  This calls " (tt "next-events!") " internally for filling up an event queue and returns one event from it.  The event queue itself is available under " (tt "%events") " and can be manipulated with the queue procedures from the " (tt "data-structures") " unit."))
(def (sig (procedure "(event->pathname EVENT)" (id event->pathname))) (p "Convenience procedure for reconstructing the full path name from an event."))
(def (sig (procedure "(max-queued-events)" (id max-queued-events)) (procedure "(max-user-instances)" (id max-user-instances)) (procedure "(max-user-watches)" (id max-user-watches))) (p "Convenience procedures for querying usage limits from " (tt "/proc/sys/fs/inotify") "."))
