The cl-diskspace Reference Manual

Table of Contents

The cl-diskspace Reference Manual

This is the cl-diskspace Reference Manual, version 0.3.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Thu Mar 11 12:00:27 2021 GMT+0.

1 Introduction

cl-diskspace

cl-diskspace is a Common Lisp feature to list disks with command line tool df(Linux/Mac) or GetLogicalDrives(Windows), and get disk space information using statvfs(Unix/Linux/Mac) or GetDiskFreeSpace(Windows), supports Unix/Linux/Mac/Windows.

License

Copyright (c) 2015 Muyinliu Xing Released under the ISC License.

Compatibility

| Common Lisp | Linux | Mac | Unix | Windows | |---------------|:-------:|:----:|:-----:|:-------:| | SBCL | Yes | Yes | | Yes |

Note: I don't have Unix system so haven't test on Unix yet.

Note: Have test in Windows XP/Windows 7/Windows 8.1/Windows 10

Note: Welcome to reply test results in other Common Lisp implements.

Install and load with QuickLisp

In shell:

git clone https://github.com/muyinliu/cl-diskspace.git
cp -r cl-diskspace ~/quicklisp/local-projects/

In Common Lisp:

(ql:quickload 'cl-diskspace)

Usage

List all disks

(diskspace:list-all-disks)

Will get something like this:

("/" "/Volumes/Seagate1T")

Note: result in Mac

(diskspace:list-all-disks)

Will get something like this:

("C:\\" "D:\\")

Note: result in Windows

Get all disk space information

(diskspace:list-all-disk-info)

Will get something like this:

((:DISK "/" :TOTAL 127175917568 :FREE 16509661184 :AVAILABLE
16247517184 :USE-PERCENT 87))

Get all disk space information in human-readable

(diskspace:list-all-disk-info t)

Will get something like this:

((:DISK "/" :TOTAL "118.44G" :FREE "15.38G" :AVAILABLE
"15.13G" :USE-PERCENT 87))

Get disk space information

(diskspace:disk-space "/")

Will get something like this:

127175917568
16509661184
16247517184

Note: the total space is 118.44G, free space is 15.38G and available space is 15.13G

Get disk space information in human-readable

(diskspace:disk-space "/" t)

Will get something like this:

"118.44G"
"15.38G"
"15.13G"

Get disk total space

(diskspace:disk-total-space "/")

Will get something like this:

127175917568

Get disk total space in human-readable

(diskspace:disk-total-space "/" t)

Will get something like this:

"118.4G"

Get disk free space

(diskspace:disk-free-space "/")

Will get something like this:

16509661184

Get disk free space in human-readable

(diskspace:disk-free-space "/" t)

Will get something like this:

"15.38G"

Get disk available space

(diskspace:disk-available-space "/")

Will get something like this:

16247517184

Get disk available space in human-readable

(diskspace:disk-available-space "/" t)

Will get something like this:

"15.13G"

2 Systems

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

2.1 cl-diskspace

Author

Muyinliu Xing <muyinliu@gmail.com>

License

ISC

Description

List disks, get disk total/free/usable space information.

Version

0.3.1

Dependencies

• cffi
• cl-ppcre
• uiop

Source

cl-diskspace.asd (file)

Component

src (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 cl-diskspace/src

Parent

cl-diskspace (system)

Location

src/

Components

• packages.lisp (file)
• utils.lisp (file)
• unix (module)
• common.lisp (file)

3.2 cl-diskspace/src/unix

Dependency

utils.lisp (file)

Parent

src (module)

Location

src/unix/

Components

• grovel-statvfs.lisp (file)
• cl-diskspace-list-all-disks-with-df.lisp (file)
• cl-diskspace-statvfs.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 cl-diskspace.asd

Location

cl-diskspace.asd

Systems

cl-diskspace (system)

4.1.2 cl-diskspace/src/packages.lisp

Parent

src (module)

Location

src/packages.lisp

Packages

cl-diskspace

4.1.3 cl-diskspace/src/utils.lisp

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/utils.lisp

Exported Definitions

size-in-human-readable (function)

4.1.4 cl-diskspace/src/unix/grovel-statvfs.lisp

Parent

unix (module)

Location

src/unix/grovel-statvfs.lisp

4.1.5 cl-diskspace/src/unix/cl-diskspace-list-all-disks-with-df.lisp

Dependency

grovel-statvfs.lisp (file)

Parent

unix (module)

Location

src/unix/cl-diskspace-list-all-disks-with-df.lisp

Exported Definitions

list-all-disks (function)

4.1.6 cl-diskspace/src/unix/cl-diskspace-statvfs.lisp

Dependency

cl-diskspace-list-all-disks-with-df.lisp (file)

Parent

unix (module)

Location

src/unix/cl-diskspace-statvfs.lisp

Exported Definitions

• disk-available-space (function)
• disk-free-space (function)
• disk-space (function)
• disk-total-space (function)

Internal Definitions

• %statvfs (function)
• statvfs (function)

4.1.7 cl-diskspace/src/common.lisp

Dependency

unix (module)

Parent

src (module)

Location

src/common.lisp

Exported Definitions

list-all-disk-info (function)

5 Packages

Packages are listed by definition order.

5.1 cl-diskspace

Source

packages.lisp (file)

Nicknames

• ds
• diskspace

Use List

• cffi-grovel
• cffi
• common-lisp

Exported Definitions

• disk-available-space (function)
• disk-free-space (function)
• disk-space (function)
• disk-total-space (function)
• list-all-disk-info (function)
• list-all-disks (function)
• size-in-human-readable (function)

Internal Definitions

• %statvfs (function)
• size-of-fsblkcnt (constant)
• size-of-fsfilcnt (constant)
• size-of-statvfs (constant)
• st-nosuid (constant)
• st-rdonly (constant)
• statvfs (function)
• statvfs-tclass (class)

6 Definitions

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

6.1 Exported definitions

6.1.1 Functions

Function: disk-available-space PATH &optional HUMAN-READABLE-P

Disk available space.

Package

cl-diskspace

Source

cl-diskspace-statvfs.lisp (file)

Function: disk-free-space PATH &optional HUMAN-READABLE-P

Disk free space.

Package

cl-diskspace

Source

cl-diskspace-statvfs.lisp (file)

Function: disk-space PATH &optional HUMAN-READABLE-P

Disk space information include total/free/available space.

Package

cl-diskspace

Source

cl-diskspace-statvfs.lisp (file)

Function: disk-total-space PATH &optional HUMAN-READABLE-P

Disk total space.

Package

cl-diskspace

Source

cl-diskspace-statvfs.lisp (file)

Function: list-all-disk-info &optional HUMAN-READABLE-P

List disk information. example result:
((:DISK "/" :TOTAL 19993329664 :FREE 6154420224 :AVAILABLE 6154420224 :USE-PERCENT 69)
(:DISK "/mnt" :TOTAL 21136445440 :FREE 2048335872 :AVAILABLE 974667776 :USE-PERCENT 95))

((:DISK "/" :TOTAL "18.62 GB" :FREE "5.73 GB" :AVAILABLE "5.73 GB" :USE-PERCENT 69)
(:DISK "/mnt" :TOTAL "19.68 GB" :FREE "1.91 GB" :AVAILABLE "929.52 MB" :USE-PERCENT 95))

Package

cl-diskspace

Source

common.lisp (file)

Function: list-all-disks ()

List all physical disk use command line tool df. note: size in KB.

Package

cl-diskspace

Source

cl-diskspace-list-all-disks-with-df.lisp (file)

Function: size-in-human-readable NUMBER

Package

cl-diskspace

Source

utils.lisp (file)

6.2 Internal definitions

6.2.1 Constants

Constant: size-of-fsblkcnt

Package

cl-diskspace

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-diskspace-20180131-git/src/unix/grovel-statvfs.processed-grovel-file

Constant: size-of-fsfilcnt

Package

cl-diskspace

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-diskspace-20180131-git/src/unix/grovel-statvfs.processed-grovel-file

Constant: size-of-statvfs

Package

cl-diskspace

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-diskspace-20180131-git/src/unix/grovel-statvfs.processed-grovel-file

Constant: st-nosuid

Package

cl-diskspace

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-diskspace-20180131-git/src/unix/grovel-statvfs.processed-grovel-file

Constant: st-rdonly

Package

cl-diskspace

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-diskspace-20180131-git/src/unix/grovel-statvfs.processed-grovel-file

6.2.2 Functions

Function: %statvfs PATH BUF

Package

cl-diskspace

Source

cl-diskspace-statvfs.lisp (file)

Function: statvfs PATH

Package

cl-diskspace

Source

cl-diskspace-statvfs.lisp (file)

6.2.3 Classes

Class: statvfs-tclass ()

Package

cl-diskspace

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-diskspace-20180131-git/src/unix/grovel-statvfs.processed-grovel-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