github.com/scaleoutsean/fusego@v0.0.0-20220224074057-4a6429e46bb8/doc.go (about)

     1  // Copyright 2015 Google Inc. All Rights Reserved.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  // Package fuse enables writing and mounting user-space file systems.
    16  //
    17  // The primary elements of interest are:
    18  //
    19  //  *  The fuseops package, which defines the operations that fuse might send
    20  //     to your userspace daemon.
    21  //
    22  //  *  The Server interface, which your daemon must implement.
    23  //
    24  //  *  fuseutil.NewFileSystemServer, which offers a convenient way to implement
    25  //     the Server interface.
    26  //
    27  //  *  Mount, a function that allows for mounting a Server as a file system.
    28  //
    29  // Make sure to see the examples in the sub-packages of samples/, which double
    30  // as tests for this package: http://godoc.org/github.com/scaleoutsean/fusego/samples
    31  //
    32  // In order to use this package to mount file systems on OS X, the system must
    33  // have FUSE for OS X installed (see http://osxfuse.github.io/). Do note that
    34  // there are several OS X-specific oddities; grep through the documentation for
    35  // more info.
    36  package fuse