You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

32 lines
821 B
ReStructuredText

5 years ago
##############################
Python-SimpleZFS documentation
##############################
The module implements a simple and straight-forward (hopefully) API for interacting with ZFS. It consists of two main
classes :class:`~simplezfs.zfs.ZFS` and :class:`~simplezfs.zpool.ZPool` that can be thought of as wrappers around the
ZFS command line utilities ``zfs(8)`` and ``zpool(8)``. This module provides two implementations:
* The ``cli``-API wrapps the command line utilities
* And the ``native``-API uses ``libzfs_core``.
At the time of writing, the ``native``-API has not been implemented.
.. toctree::
:maxdepth: 2
:caption: Contents:
quickstart
security
guide
properties_metadata
testing
api
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`