fusego/README.md

31 lines
1.2 KiB
Markdown
Raw Normal View History

2015-02-27 01:24:28 +03:00
[![GoDoc](https://godoc.org/github.com/jacobsa/ogletest?status.svg)](https://godoc.org/github.com/jacobsa/fuse)
2015-07-27 04:53:29 +03:00
This package allows for writing and mounting user-space file systems from Go.
Install it as follows:
2015-02-27 01:24:28 +03:00
2015-07-27 04:53:29 +03:00
go get -u github.com/jacobsa/fuse
2015-02-27 01:24:28 +03:00
2015-07-27 04:53:29 +03:00
Afterward, see the documentation for the following three packages:
2015-02-27 01:24:28 +03:00
2015-07-27 04:53:29 +03:00
* Package [fuse][] provides support for mounting a new file system and
reading requests from the kernel.
2015-02-27 01:24:28 +03:00
2015-07-27 04:53:29 +03:00
* Package [fuseops][] enumerates the supported requests from the kernel, and
provides documentation on their semantics.
2015-02-27 03:46:57 +03:00
2015-07-27 04:53:29 +03:00
* Package [fuseutil][], in particular the `FileSystem` interface, provides a
convenient way to create a file system type and export it to the kernel via
`fuse.Mount`.
2015-02-27 01:24:28 +03:00
2015-07-27 04:53:29 +03:00
Make sure to also see the sub-packages of the [samples][] package for examples
and tests.
2015-03-24 08:41:03 +03:00
2015-07-27 04:53:29 +03:00
This package owes its inspiration and most of its kernel-related code to
[bazil.org/fuse][bazil].
[fuse]: http://godoc.org/github.com/jacobsa/fuse
[fuseops]: http://godoc.org/github.com/jacobsa/fuse/fuseops
[fuseutil]: http://godoc.org/github.com/jacobsa/fuse/fuseutil
2015-03-24 08:41:03 +03:00
[samples]: http://godoc.org/github.com/jacobsa/fuse/samples
2015-07-27 04:53:29 +03:00
[bazil]: http://godoc.org/bazil.org/fuse