README.txt 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  1. cage
  2. Table of Contents
  3. ─────────────────
  4. 1. Introduction
  5. 2. Install
  6. 3. The wrapper
  7. .. 1. The simple API
  8. .. 2. The low level API
  9. 4. Issues
  10. 5. BUGS
  11. 6. License
  12. 7. NO WARRANTY
  13. 1 Introduction
  14. ══════════════
  15. cl-mount-info is a (thin) wrapper around `getmntent(3)' and related C
  16. functions.
  17. This library, on GNU/Linux allow to get information about the mounted
  18. filesystem on your computer. See getmntent(3) for details.
  19. 2 Install
  20. ═════════
  21. Just clone the repo where can be reached by ASDF.
  22. 3 The wrapper
  23. ═════════════
  24. The file `src/cffi.lisp' Contains the low levels wrapper, whilst the
  25. file api.lisp allow the filesystem information query with a simpler
  26. interface.
  27. 3.1 The simple API
  28. ──────────────────
  29. ┌────
  30. │ (mountpoint->device "/") ; -> the device where "/" is mounted
  31. │ (mountpoint->fstype "/") ; the filesystem of the device where "/" is mounted
  32. │ (mountpoint->mnt-options "/") ; -> mount option as list
  33. └────
  34. The above functions use an optional arguments to specify the file
  35. where mounted filesystem information are stored: default is
  36. `/etc/mtab'.
  37. 3.2 The low level API
  38. ─────────────────────
  39. See getmntent(3)
  40. 4 Issues
  41. ════════
  42. Note that the whole library is in an alpha stage, testing is still in
  43. progress, please see [section below]
  44. This library works on GNU/Linux only.
  45. [section below] See section 7
  46. 5 BUGS
  47. ══════
  48. Please file bug report on the [issue tracker]
  49. [issue tracker] <https://notabug.org/cage/cl-mount-info/issues>
  50. 6 License
  51. ═════════
  52. This library is released under Lisp Lesser General Public license (see
  53. COPYING.LESSER file)
  54. Examples are released under GPL version 3 or later
  55. 7 NO WARRANTY
  56. ═════════════
  57. This library is distributed in the hope that it will be useful, but
  58. WITHOUT ANY WARRANTY; without even the implied warranty of
  59. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  60. Lesser General Public License for more details.