The cl-mount-info Reference Manual

Table of Contents

The cl-mount-info Reference Manual

This is the cl-mount-info Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Oct 13 09:53:44 2021 GMT+0.

1 Introduction

* 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.

* Install

  Just clone the repo where can be reached by ASDF.

* 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.

** The simple API

  #+BEGIN_SRC common-lisp

  (mountpoint->device "/") ; -> the device where "/" is mounted

  (mountpoint->fstype "/") ; the filesystem of the device where "/" is mounted

  (mountpoint->mnt-options "/") ; -> mount option as list

  #+END_SRC

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

** The low level API

  See getmntent(3)

* Issues

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

  This library works on GNU/Linux only.

* BUGS

  Please file bug report on
  the [[https://notabug.org/cage/cl-mount-info/issues][issue tracker]]

* License
  © 2020 cage, puercopop
  This library is released under Lisp Lesser General Public license (see
  COPYING.LESSER file)

  Examples are released under GPL version 3 or later

* 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.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 cl-mount-info

Maintainer

cage

Author

cage

Bug Tracker

https://notabug.org/cage/cl-mount-info/issues

License

LLGPLv3 or later

Description

Get information about mounted filesystems on GNU/linux.

Version

0.0.1

Dependencies

• alexandria
• cffi
• cl-ppcre

Source

cl-mount-info.asd (file)

Components

• package.lisp (file)
• cffi.lisp (file)
• conditions.lisp (file)
• api.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 cl-mount-info.asd

Location

/home/quickref/quicklisp/dists/quicklisp/software/cl-mount-info-20200218-git/cl-mount-info.asd

Systems

cl-mount-info (system)

3.1.2 cl-mount-info/package.lisp

Parent

cl-mount-info (system)

Location

package.lisp

Packages

• cl-mount-info.conditions
• cl-mount-info

3.1.3 cl-mount-info/cffi.lisp

Dependency

package.lisp (file)

Parent

cl-mount-info (system)

Location

cffi.lisp

Exported Definitions

• end-mntent (function)
• get-mntent (function)
• lispify-plist-mntent (function)
• set-mntent (function)

Internal Definitions

mntent-tclass (class)

3.1.4 cl-mount-info/conditions.lisp

Dependency

cffi.lisp (file)

Parent

cl-mount-info (system)

Location

conditions.lisp

Exported Definitions

open-file-failed (condition)

Internal Definitions

file-path (method)

3.1.5 cl-mount-info/api.lisp

Dependency

conditions.lisp (file)

Parent

cl-mount-info (system)

Location

api.lisp

Exported Definitions

• all-infos (function)
• mountpoint->device (function)
• mountpoint->fstype (function)
• mountpoint->mnt-options (function)

Internal Definitions

• +option-separator+ (constant)
• +suboption-separator+ (constant)
• mntent-all-infos (function)
• mntent-info (function)
• mountpoint-to->* (function)

4 Packages

Packages are listed by definition order.

4.1 cl-mount-info.conditions

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

open-file-failed (condition)

Internal Definitions

• file-path (generic function)
• file-path (method)

4.2 cl-mount-info

Source

package.lisp (file)

Use List

• cl-ppcre
• alexandria
• cffi
• common-lisp

Exported Definitions

• all-infos (function)
• end-mntent (function)
• get-mntent (function)
• lispify-plist-mntent (function)
• mountpoint->device (function)
• mountpoint->fstype (function)
• mountpoint->mnt-options (function)
• set-mntent (function)

Internal Definitions

• +option-separator+ (constant)
• +suboption-separator+ (constant)
• mntent-all-infos (function)
• mntent-info (function)
• mntent-tclass (class)
• mountpoint-to->* (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Functions

Function: all-infos &optional MOUNT-INFO-FILE

Package

cl-mount-info

Source

api.lisp (file)

Function: end-mntent STREAM

Package

cl-mount-info

Source

cffi.lisp (file)

Function: get-mntent STREAM

Package

cl-mount-info

Source

cffi.lisp (file)

Function: lispify-plist-mntent STRUCT-AS-PLIST

Package

cl-mount-info

Source

cffi.lisp (file)

Function: mountpoint->device MOUNTPOINT &optional MOUNT-INFO-FILE

Package

cl-mount-info

Source

api.lisp (file)

Function: mountpoint->fstype MOUNTPOINT &optional MOUNT-INFO-FILE

Package

cl-mount-info

Source

api.lisp (file)

Function: mountpoint->mnt-options MOUNTPOINT &optional MOUNT-INFO-FILE

Package

cl-mount-info

Source

api.lisp (file)

Function: set-mntent FILENAME TYPE

Package

cl-mount-info

Source

cffi.lisp (file)

5.1.2 Conditions

Condition: open-file-failed ()

Length error

Package

cl-mount-info.conditions

Source

conditions.lisp (file)

Direct superclasses

error (condition)

Direct methods

file-path (method)

Direct slots

Slot: file-path

Initargs

:file-path

Readers

file-path (generic function)

5.2 Internal definitions

5.2.1 Constants

Constant: +option-separator+

Package

cl-mount-info

Source

api.lisp (file)

Constant: +suboption-separator+

Package

cl-mount-info

Source

api.lisp (file)

5.2.2 Functions

Function: mntent-all-infos &optional MOUNT-INFO-FILE

Package

cl-mount-info

Source

api.lisp (file)

Function: mntent-info MTAB PLIST-KEY LOOKING-FOR-VALUE

Package

cl-mount-info

Source

api.lisp (file)

Function: mountpoint-to->* MOUNT-INFO-FILE MOUNTPOINT KEY

Package

cl-mount-info

Source

api.lisp (file)

5.2.3 Generic functions

Generic Function: file-path CONDITION

Package

cl-mount-info.conditions

Methods

Method: file-path (CONDITION open-file-failed)

Source

conditions.lisp (file)

5.2.4 Classes

Class: mntent-tclass ()

Package

cl-mount-info

Source

cffi.lisp (file)

Direct superclasses

• translatable-foreign-type (class)
• foreign-struct-type (class)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types