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

The cl-diskspace Reference Manual

This is the cl-diskspace Reference Manual, version 0.3.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:08:47 2024 GMT+0.

Next: Systems, Previous: The cl-diskspace Reference Manual, Up: The cl-diskspace Reference Manual [Contents][Index]

1 Introduction

Next: Modules, Previous: Introduction, Up: The cl-diskspace Reference Manual [Contents][Index]

2 Systems

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

cl-diskspace

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

2.1 `cl-diskspace`

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

Author

Muyinliu Xing <muyinliu@gmail.com>

License

ISC

Version

0.3.1

Defsystem Dependency

cffi-grovel (system).

Dependencies

cffi (system).
cl-ppcre (system).
uiop (system).

Source

cl-diskspace.asd.

Child Component

src (module).

Next: Files, Previous: Systems, Up: The cl-diskspace Reference Manual [Contents][Index]

3 Modules

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

cl-diskspace/src
cl-diskspace/src/unix

Next: cl-diskspace/src/unix, Previous: Modules, Up: Modules [Contents][Index]

3.1 `cl-diskspace/src`

Source

cl-diskspace.asd.

Parent Component

cl-diskspace (system).

Child Components

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

Previous: cl-diskspace/src, Up: Modules [Contents][Index]

3.2 `cl-diskspace/src/unix`

Dependency

utils.lisp (file).

Source

cl-diskspace.asd.

Parent Component

src (module).

Child Components

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

Next: Packages, Previous: Modules, Up: The cl-diskspace Reference Manual [Contents][Index]

4 Files

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

Lisp

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

4.1 Lisp

cl-diskspace/cl-diskspace.asd
cl-diskspace/src/packages.lisp
cl-diskspace/src/utils.lisp
cl-diskspace/src/unix/grovel-statvfs.lisp
cl-diskspace/src/unix/cl-diskspace-list-all-disks-with-df.lisp
cl-diskspace/src/unix/cl-diskspace-statvfs.lisp
cl-diskspace/src/common.lisp

Next: cl-diskspace/src/packages.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

4.1.1 `cl-diskspace/cl-diskspace.asd`

Source: cl-diskspace.asd.
Parent Component: cl-diskspace (system).
ASDF Systems: cl-diskspace.

Next: cl-diskspace/src/utils.lisp, Previous: cl-diskspace/cl-diskspace.asd, Up: Lisp [Contents][Index]

4.1.2 `cl-diskspace/src/packages.lisp`

Source: cl-diskspace.asd.
Parent Component: src (module).
Packages: cl-diskspace.

Next: cl-diskspace/src/unix/grovel-statvfs.lisp, Previous: cl-diskspace/src/packages.lisp, Up: Lisp [Contents][Index]

4.1.3 `cl-diskspace/src/utils.lisp`

Dependency: packages.lisp (file).
Source: cl-diskspace.asd.
Parent Component: src (module).
Public Interface: size-in-human-readable (function).

Next: cl-diskspace/src/unix/cl-diskspace-list-all-disks-with-df.lisp, Previous: cl-diskspace/src/utils.lisp, Up: Lisp [Contents][Index]

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

Source: cl-diskspace.asd.
Parent Component: unix (module).

Next: cl-diskspace/src/unix/cl-diskspace-statvfs.lisp, Previous: cl-diskspace/src/unix/grovel-statvfs.lisp, Up: Lisp [Contents][Index]

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

Dependency: grovel-statvfs.lisp (file).
Source: cl-diskspace.asd.
Parent Component: unix (module).
Public Interface: list-all-disks (function).

Next: cl-diskspace/src/common.lisp, Previous: cl-diskspace/src/unix/cl-diskspace-list-all-disks-with-df.lisp, Up: Lisp [Contents][Index]

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

Dependency

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

Source

cl-diskspace.asd.

Parent Component

unix (module).

Public Interface

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

Internals

%statvfs (function).
statvfs (function).

Previous: cl-diskspace/src/unix/cl-diskspace-statvfs.lisp, Up: Lisp [Contents][Index]

4.1.7 `cl-diskspace/src/common.lisp`

Dependency: unix (module).
Source: cl-diskspace.asd.
Parent Component: src (module).
Public Interface: list-all-disk-info (function).

Next: Definitions, Previous: Files, Up: The cl-diskspace Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

cl-diskspace

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

5.1 `cl-diskspace`

Source

packages.lisp.

Nicknames

diskspace
ds

Use List

cffi.
cffi-grovel.
common-lisp.

Public Interface

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

Internals

%statvfs (function).
statvfs (function).

Next: Indexes, Previous: Packages, Up: The cl-diskspace Reference Manual [Contents][Index]

6 Definitions

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

Public Interface
Internals

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

6.1 Public Interface

Ordinary functions

Previous: Public Interface, Up: Public Interface [Contents][Index]

6.1.1 Ordinary functions

Function: disk-available-space (path &optional human-readable-p) ¶

Disk available space.

Package: cl-diskspace.
Source: cl-diskspace-statvfs.lisp.

Function: disk-free-space (path &optional human-readable-p) ¶

Disk free space.

Package: cl-diskspace.
Source: cl-diskspace-statvfs.lisp.

Function: disk-space (path &optional human-readable-p) ¶

Disk space information include total/free/available space.

Package: cl-diskspace.
Source: cl-diskspace-statvfs.lisp.

Function: disk-total-space (path &optional human-readable-p) ¶

Disk total space.

Package: cl-diskspace.
Source: cl-diskspace-statvfs.lisp.

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.

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.

Function: size-in-human-readable (number) ¶

Package: cl-diskspace.
Source: utils.lisp.

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

6.2 Internals

Ordinary functions

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

6.2.1 Ordinary functions

Function: %statvfs (path buf) ¶

Package: cl-diskspace.
Source: cl-diskspace-statvfs.lisp.

Function: statvfs (path) ¶

Package: cl-diskspace.
Source: cl-diskspace-statvfs.lisp.

Previous: Definitions, Up: The cl-diskspace Reference Manual [Contents][Index]

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

A.1 Concepts

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

A.2 Functions

Jump to:	% D F L S

	Index Entry	Section

%
	`%statvfs`:	Private ordinary functions

D
	`disk-available-space`:	Public ordinary functions
	`disk-free-space`:	Public ordinary functions
	`disk-space`:	Public ordinary functions
	`disk-total-space`:	Public ordinary functions

F
	`Function, %statvfs`:	Private ordinary functions
	`Function, disk-available-space`:	Public ordinary functions
	`Function, disk-free-space`:	Public ordinary functions
	`Function, disk-space`:	Public ordinary functions
	`Function, disk-total-space`:	Public ordinary functions
	`Function, list-all-disk-info`:	Public ordinary functions
	`Function, list-all-disks`:	Public ordinary functions
	`Function, size-in-human-readable`:	Public ordinary functions
	`Function, statvfs`:	Private ordinary functions

L
	`list-all-disk-info`:	Public ordinary functions
	`list-all-disks`:	Public ordinary functions

S
	`size-in-human-readable`:	Public ordinary functions
	`statvfs`:	Private ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

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

A.4 Data types

Jump to:	C F G M P S U

	Index Entry	Section

C
	`cl-diskspace`:	The cl-diskspace system
	`cl-diskspace`:	The cl-diskspace package
	`cl-diskspace-list-all-disks-with-df.lisp`:	The cl-diskspace/src/unix/cl-diskspace-list-all-disks-with-df․lisp file
	`cl-diskspace-statvfs.lisp`:	The cl-diskspace/src/unix/cl-diskspace-statvfs․lisp file
	`cl-diskspace.asd`:	The cl-diskspace/cl-diskspace․asd file
	`common.lisp`:	The cl-diskspace/src/common․lisp file

F
	`File, cl-diskspace-list-all-disks-with-df.lisp`:	The cl-diskspace/src/unix/cl-diskspace-list-all-disks-with-df․lisp file
	`File, cl-diskspace-statvfs.lisp`:	The cl-diskspace/src/unix/cl-diskspace-statvfs․lisp file
	`File, cl-diskspace.asd`:	The cl-diskspace/cl-diskspace․asd file
	`File, common.lisp`:	The cl-diskspace/src/common․lisp file
	`File, grovel-statvfs.lisp`:	The cl-diskspace/src/unix/grovel-statvfs․lisp file
	`File, packages.lisp`:	The cl-diskspace/src/packages․lisp file
	`File, utils.lisp`:	The cl-diskspace/src/utils․lisp file

G
	`grovel-statvfs.lisp`:	The cl-diskspace/src/unix/grovel-statvfs․lisp file

M
	`Module, src`:	The cl-diskspace/src module
	`Module, unix`:	The cl-diskspace/src/unix module

P
	`Package, cl-diskspace`:	The cl-diskspace package
	`packages.lisp`:	The cl-diskspace/src/packages․lisp file

S
	`src`:	The cl-diskspace/src module
	`System, cl-diskspace`:	The cl-diskspace system

U
	`unix`:	The cl-diskspace/src/unix module
	`utils.lisp`:	The cl-diskspace/src/utils․lisp file

The cl-diskspace Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 cl-diskspace

3 Modules

3.1 cl-diskspace/src

3.2 cl-diskspace/src/unix

4 Files

4.1 Lisp

4.1.1 cl-diskspace/cl-diskspace.asd

4.1.2 cl-diskspace/src/packages.lisp

4.1.3 cl-diskspace/src/utils.lisp

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

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

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

4.1.7 cl-diskspace/src/common.lisp

5 Packages

5.1 cl-diskspace

6 Definitions

6.1 Public Interface

6.1.1 Ordinary functions

6.2 Internals

6.2.1 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `cl-diskspace`

3.1 `cl-diskspace/src`

3.2 `cl-diskspace/src/unix`

4.1.1 `cl-diskspace/cl-diskspace.asd`

4.1.2 `cl-diskspace/src/packages.lisp`

4.1.3 `cl-diskspace/src/utils.lisp`

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

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

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

4.1.7 `cl-diskspace/src/common.lisp`

5.1 `cl-diskspace`