The cl-mount-info Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

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 Fri Jun 26 10:23:50 2020 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

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.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

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
Source

cl-mount-info.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

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)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 cl-mount-info/package.lisp

Parent

cl-mount-info (system)

Location

package.lisp

Packages

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 cl-mount-info/cffi.lisp

Dependency

package.lisp (file)

Parent

cl-mount-info (system)

Location

cffi.lisp

Exported Definitions
Internal Definitions

mntent-tclass (class)


Next: , Previous: , Up: Lisp files   [Contents][Index]

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)


Previous: , Up: Lisp files   [Contents][Index]

3.1.5 cl-mount-info/api.lisp

Dependency

conditions.lisp (file)

Parent

cl-mount-info (system)

Location

api.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

4.1 cl-mount-info.conditions

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

open-file-failed (condition)

Internal Definitions

Previous: , Up: Packages   [Contents][Index]

4.2 cl-mount-info

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Previous: , Up: Exported definitions   [Contents][Index]

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)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Previous: , Up: Internal definitions   [Contents][Index]

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)

Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-mount-info.asd: The cl-mount-info․asd file
cl-mount-info/api.lisp: The cl-mount-info/api․lisp file
cl-mount-info/cffi.lisp: The cl-mount-info/cffi․lisp file
cl-mount-info/conditions.lisp: The cl-mount-info/conditions․lisp file
cl-mount-info/package.lisp: The cl-mount-info/package․lisp file

F
File, Lisp, cl-mount-info.asd: The cl-mount-info․asd file
File, Lisp, cl-mount-info/api.lisp: The cl-mount-info/api․lisp file
File, Lisp, cl-mount-info/cffi.lisp: The cl-mount-info/cffi․lisp file
File, Lisp, cl-mount-info/conditions.lisp: The cl-mount-info/conditions․lisp file
File, Lisp, cl-mount-info/package.lisp: The cl-mount-info/package․lisp file

L
Lisp File, cl-mount-info.asd: The cl-mount-info․asd file
Lisp File, cl-mount-info/api.lisp: The cl-mount-info/api․lisp file
Lisp File, cl-mount-info/cffi.lisp: The cl-mount-info/cffi․lisp file
Lisp File, cl-mount-info/conditions.lisp: The cl-mount-info/conditions․lisp file
Lisp File, cl-mount-info/package.lisp: The cl-mount-info/package․lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   A   E   F   G   L   M   S  
Index Entry  Section

A
all-infos: Exported functions

E
end-mntent: Exported functions

F
file-path: Internal generic functions
file-path: Internal generic functions
Function, all-infos: Exported functions
Function, end-mntent: Exported functions
Function, get-mntent: Exported functions
Function, lispify-plist-mntent: Exported functions
Function, mntent-all-infos: Internal functions
Function, mntent-info: Internal functions
Function, mountpoint->device: Exported functions
Function, mountpoint->fstype: Exported functions
Function, mountpoint->mnt-options: Exported functions
Function, mountpoint-to->*: Internal functions
Function, set-mntent: Exported functions

G
Generic Function, file-path: Internal generic functions
get-mntent: Exported functions

L
lispify-plist-mntent: Exported functions

M
Method, file-path: Internal generic functions
mntent-all-infos: Internal functions
mntent-info: Internal functions
mountpoint->device: Exported functions
mountpoint->fstype: Exported functions
mountpoint->mnt-options: Exported functions
mountpoint-to->*: Internal functions

S
set-mntent: Exported functions

Jump to:   A   E   F   G   L   M   S  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   +  
C   F   S  
Index Entry  Section

+
+option-separator+: Internal constants
+suboption-separator+: Internal constants

C
Constant, +option-separator+: Internal constants
Constant, +suboption-separator+: Internal constants

F
file-path: Exported conditions

S
Slot, file-path: Exported conditions

Jump to:   +  
C   F   S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   M   O   P   S  
Index Entry  Section

C
cl-mount-info: The cl-mount-info system
cl-mount-info: The cl-mount-info package
cl-mount-info.conditions: The cl-mount-info․conditions package
Class, mntent-tclass: Internal classes
Condition, open-file-failed: Exported conditions

M
mntent-tclass: Internal classes

O
open-file-failed: Exported conditions

P
Package, cl-mount-info: The cl-mount-info package
Package, cl-mount-info.conditions: The cl-mount-info․conditions package

S
System, cl-mount-info: The cl-mount-info system

Jump to:   C   M   O   P   S