cl-mount-info/README.txt

cage


Table of Contents
─────────────────

1. Introduction
2. Install
3. The wrapper
.. 1. The simple API
.. 2. The low level API
4. Issues
5. BUGS
6. License
7. NO WARRANTY


1 Introduction
══════════════

  cl-mount-info is a (thin) wrapper around `getmntent(3)' and related C
  functions.

  This library, on GNU/Linux allow to get information about the mounted
  filesystem on your computer. See getmntent(3) for details.


2 Install
═════════

  Just clone the repo where can be reached by ASDF.


3 The wrapper
═════════════

  The file `src/cffi.lisp' Contains the low levels wrapper, whilst the
  file api.lisp allow the filesystem information query with a simpler
  interface.


3.1 The simple API
──────────────────

  ┌────
  │
  │ (mountpoint->device "/") ; -> the device where "/" is mounted
  │
  │ (mountpoint->fstype "/") ; the filesystem of the device where "/" is mounted
  │
  │ (mountpoint->mnt-options "/") ; -> mount option as list
  │
  └────

  The above functions use an optional arguments to specify the file
  where mounted filesystem information are stored: default is
  `/etc/mtab'.


3.2 The low level API
─────────────────────

  See getmntent(3)


4 Issues
════════

  Note that the whole library is in an alpha stage, testing is still in
  progress, please see [section below]

  This library works on GNU/Linux only.


[section below] See section 7


5 BUGS
══════

  Please file bug report on the [issue tracker]


[issue tracker] <https://notabug.org/cage/cl-mount-info/issues>


6 License
═════════

  This library is released under Lisp Lesser General Public license (see
  COPYING.LESSER file)

  Examples are released under GPL version 3 or later


7 NO WARRANTY
═════════════

  This library is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.