Archives/fuse-friends_fuse-native
1
0
Fork 0
mirror of https://github.com/fuse-friends/fuse-native synced 2024-10-27 18:34:01 +00:00
Code Issues Releases Wiki Activity

cli docs

Browse Source
This commit is contained in:
Mathias Buus 2019-12-18 10:32:09 +01:00
parent 8aa9c5d885
commit b746b10658
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -90,6 +90,8 @@ Might require `sudo` access.
Unconfigures FUSE on your machine. Basically undos any change the above
method does.
See the CLI section below on how to run these commands from the command line if you prefer doing that.
### 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.
@ -307,6 +309,17 @@ Called when a new directory is being created
Called when a directory is being removed
## CLI
There is a CLI tool available to help you configure the FUSE kernel extension setup
if you don't want to use the JavaScript API for that
```
npm install -g fuse-native
fuse-native is-configured # checks if the kernel extension is already configured
fuse-native configure # configures the kernel extension
```
## License
MIT for these bindings.