summaryrefslogtreecommitdiff
path: root/docs/filesystems.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/filesystems.rst')
-rw-r--r--docs/filesystems.rst39
1 files changed, 39 insertions, 0 deletions
diff --git a/docs/filesystems.rst b/docs/filesystems.rst
new file mode 100644
index 0000000..18d4bb1
--- /dev/null
+++ b/docs/filesystems.rst
@@ -0,0 +1,39 @@
+Filesystems
+===========
+
+This page lists the builtin filesystems.
+
+
+fs.osfs.OSFS
+------------
+An interface to the OS Filesystem
+
+fs.memoryfs.MemoryFS
+--------------------
+A filesystem that exists entirely in memory
+
+fs.mountfs.MountFS
+------------------
+A filesystem that can map directories in to other filesystems (like a symlink)
+
+fs.multifs.MultiFS
+------------------
+A filesystem that overlays other filesystems
+
+fs.sftpfs.SFTPFS
+----------------
+A secure FTP filesystem
+
+fs.s3fs.S3FS
+------------
+A filesystem to access an Amazon S3 service
+
+fs.tempfs.TempFS
+----------------
+Creates a temporary filesystem in an OS provided location
+
+fs.zipfs.ZipFS
+--------------
+A filesystem for zip files
+
+