From dcde0edbccb34848eaadbca265743af02aef0c84 Mon Sep 17 00:00:00 2001 From: Mathias Buus Date: Tue, 17 Dec 2019 15:28:35 +0100 Subject: [PATCH] docs for configure,unconfigure --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 2023ad2..012a54b 100644 --- a/README.md +++ b/README.md @@ -75,6 +75,21 @@ Create a new `Fuse` object. ``` Additionally, all (FUSE-specific options)[http://man7.org/linux/man-pages/man8/mount.fuse.8.html] will be passed to the underlying FUSE module (though we use camel casing instead of snake casing). +#### `Fuse.isConfigured(cb)` + +Returns `true` if FUSE has been configured on your machine and ready to be used, `false` otherwise. + +#### `Fuse.configure(cb)` + +Configures FUSE on your machine by enabling the FUSE kernel extension. +You usually want to do this as part of an installation phase for your app. +Might require `sudo` access. + +#### `Fuse.unconfigure(cb)` + +Unconfigures FUSE on your machine. Basically undos any change the above +method does. + ### FUSE API Most of the [FUSE api](http://fuse.sourceforge.net/doxygen/structfuse__operations.html) is supported. In general the callback for each op should be called with `cb(returnCode, [value])` where the return code is a number (`0` for OK and `< 0` for errors). See below for a list of POSIX error codes.