This is the fof Reference Manual, version 0.2.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jun 15 05:33:08 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
fofFile-object finder. Enable rapid file search, inspection and manipulation.
Pierre Neidhardt <mail@ambrevar.xyz>
GPL3+
0.2.0
fof/package (system).
fof/packagePierre Neidhardt <mail@ambrevar.xyz>
GPL3+
trivial-package-local-nicknames (system).
named-readtables (system).
fof/file (system).
fof/predicates (system).
fof/filePierre Neidhardt <mail@ambrevar.xyz>
GPL3+
alexandria (system).
hu.dwim.defclass-star (system).
local-time (system).
magicffi (system).
osicat (system).
serapeum (system).
str (system).
trivia (system).
fof/predicatesPierre Neidhardt <mail@ambrevar.xyz>
GPL3+
fof/file (system).
local-time (system).
serapeum (system).
str (system).
trivia (system).
Files are sorted by type and then listed depth-first from the systems components trees.
fof/file/file-type.lispfof/file (system).
*finder-constructor* (special variable).
*finder-include-directories* (special variable).
*print-abbreviate-home?* (special variable).
*print-abbreviation-length* (special variable).
*print-abbreviation-threshold* (special variable).
*print-date?* (special variable).
*print-reader-macro* (special variable).
*print-relative-path?* (special variable).
*print-size?* (special variable).
access-date (reader method).
(setf access-date) (writer method).
basename (method).
creation-date (reader method).
current-directory (function).
description (reader method).
directory? (method).
disk-usage (reader method).
exists? (method).
extension (method).
(setf extension) (method).
file (function).
file (class).
file+mime (function).
file+mime (class).
file-kind (type).
file=? (function).
file? (method).
finder (function).
finder* (function).
group (method).
group-id (reader method).
(setf group-id) (writer method).
initialize-instance (method).
initialize-instance (method).
inode (reader method).
kind (reader method).
link-count (reader method).
list-directory (function).
mime-encoding (reader method).
mime-type (reader method).
modification-date (reader method).
(setf modification-date) (writer method).
parent (method).
path (method).
path (method).
path (reader method).
(setf path) (method).
permissions (reader method).
(setf permissions) (writer method).
print-object (method).
relative-path (method).
relative-path (method).
separator (function).
size (reader method).
user (method).
user-id (reader method).
(setf user-id) (writer method).
with-current-directory (macro).
%description (function).
%magic-cookie-description (special variable).
%magic-cookie-mime (special variable).
%mime-type+encoding (function).
*touch-command* (special variable).
+ls-time-format+ (special variable).
depth (function).
disk-usage* (method).
file+mimep (function).
file-reader (function).
filep (function).
finder*+mime (function).
finder+mime (function).
function-specifier (type).
group-id->name (function).
ls-l (function).
magic-cookie-description (function).
magic-cookie-mime (function).
match-depth< (function).
match-path (function).
match-path-end (function).
max-width (function).
parent? (function).
permissions->unix (function).
print-file (function).
read-/etc/group (function).
shorten-home (function).
shorten-path (function).
uiop-path (method).
uiop-path (method).
uiop-path (method).
fof/predicates/file-type.lispfof/predicates (system).
date< (function).
date> (function).
elf-binary? (function).
elf-library? (function).
executable? (function).
extension= (function).
group= (function).
hidden? (function).
kind= (function).
name~ (function).
path$ (function).
path~ (function).
user= (function).
depth< (function).
group-specifier (type).
user-specifier (type).
Packages are listed by definition order.
fof/fileFile class.
common-lisp.
*finder-constructor* (special variable).
*finder-include-directories* (special variable).
*print-abbreviate-home?* (special variable).
*print-abbreviation-length* (special variable).
*print-abbreviation-threshold* (special variable).
*print-date?* (special variable).
*print-reader-macro* (special variable).
*print-relative-path?* (special variable).
*print-size?* (special variable).
access-date (generic reader).
(setf access-date) (generic writer).
basename (generic function).
creation-date (generic reader).
current-directory (function).
description (generic reader).
directory? (generic function).
disk-usage (generic reader).
exists? (generic function).
extension (generic function).
(setf extension) (generic function).
file (function).
file (class).
file+mime (function).
file+mime (class).
file-kind (type).
file=? (function).
file? (generic function).
finder (function).
finder* (function).
group (generic function).
group-id (generic reader).
(setf group-id) (generic writer).
inode (generic reader).
kind (generic reader).
link-count (generic reader).
list-directory (function).
mime-encoding (generic reader).
mime-type (generic reader).
modification-date (generic reader).
(setf modification-date) (generic writer).
parent (generic function).
path (generic function).
(setf path) (generic function).
permissions (generic reader).
(setf permissions) (generic writer).
relative-path (generic function).
separator (function).
size (generic reader).
user (generic function).
user-id (generic reader).
(setf user-id) (generic writer).
with-current-directory (macro).
%description (function).
%magic-cookie-description (special variable).
%magic-cookie-mime (special variable).
%mime-type+encoding (function).
*touch-command* (special variable).
+ls-time-format+ (special variable).
depth (function).
disk-usage* (generic function).
file+mimep (function).
file-reader (function).
filep (function).
finder*+mime (function).
finder+mime (function).
function-specifier (type).
group-id->name (function).
ls-l (function).
magic-cookie-description (function).
magic-cookie-mime (function).
match-depth< (function).
match-path (function).
match-path-end (function).
max-width (function).
parent? (function).
permissions->unix (function).
print-file (function).
read-/etc/group (function).
shorten-home (function).
shorten-path (function).
uiop-path (generic function).
fof/packageFile object finder.
This is the meta package which includes all others.
fof
fof/predicatesAll predicates for the FOF finder.
fof/p
common-lisp.
fof/file.
date< (function).
date> (function).
elf-binary? (function).
elf-library? (function).
executable? (function).
extension= (function).
group= (function).
hidden? (function).
kind= (function).
name~ (function).
path$ (function).
path~ (function).
user= (function).
depth< (function).
group-specifier (type).
user-specifier (type).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Function that takes a path and returns a ‘file’-like object.
When non-nil ‘finder’ includes directories.
Whether to abbreviate the user home directory to ’~’.
Maximum abbreviation length, for each directory.
Abbreviate printout if strictly longer than this value. Set to 0 to stop abbreviating.
Call BODY while the POSIX current working directory is set to FILE.
This is just like ‘uiop:with-current-directory’ except that it takes a ‘file’
object.
Return a file predicate that matches on modification time less recent than TIMESTAMP.
Return a file predicate that matches on modification time more recent than TIMESTAMP.
Return a predicate for files that match one of the provided extensions.
Return true if FILE1 and FILE2 point to the same file. They might not be the same objects.
List files in current directory that satisfy all PREDICATE-SPECIFIERS
Directories are ignored.
Without PREDICATE-SPECIFIERS, list all files.
A predicate specifier can be:
- a string, in which case it is turned into (match-path STRING);
- a pathname, in which case it is turned into (match-path-end PATHNAME);
- a list of predicates, in which case it is turned into (apply #’alexandria:disjoin PREDICATES);
- a function (a predicate).
For a more tunable finder, see ‘finder*’.
List FILES (including directories) that satisfy all PREDICATES.
Without PREDICATES, list all files.
Recur in subdirectories when they satisfy all RECUR-PREDICATES. Without RECUR-PREDICATES, recur in all subdirectories.
Return a predicate for files that match one of the provided ‘group-specifier’s.
Return a predicate for files that match one of the provided ‘file-kind’s.
Return entries in PATH.
By default, directories come first.
If SORT is non nil, sort them alphabetically.
Second value is the list of directories, third value is the non-directories.
Return a predicate that matches when one of the names is contained in the file basename.
Return a predicate that matches when one of the path suffixes matches the file path.
Return a predicate that matches when one of the path elements is contained in the file path.
Return a predicate for files that match one of the provided ‘user-specifier’s.
pathname)) ¶Useful so that ‘path’ can be called both on a ‘file’ or a ‘pathname’. A trailing separator is automatically append for directories, if missing. This is to be consistent with the ‘path’ method for ‘file’.
string)) ¶Useful so that ‘path’ can be called both on a ‘file’ or a ‘string’.
A trailing separator is automatically append for directories, if missing.
This is to be consistent with the ‘path’ method for ‘file’.
file) &optional parent-directory) ¶Return path of FILE relative to PARENT-DIRECTORY.
If PARENT-DIRECTORY is not a parent of FILE, return FILE’s path.
pathname) &optional parent-directory) ¶Return PATH relative to PARENT-DIRECTORY.
If PARENT-DIRECTORY is not a parent of PATH, return PATH.
(setf access-date).
access-date.
basename.
creation-date.
directory?.
disk-usage.
disk-usage*.
exists?.
(setf extension).
extension.
file?.
group.
(setf group-id).
group-id.
initialize-instance.
inode.
kind.
link-count.
(setf modification-date).
modification-date.
parent.
(setf path).
path.
(setf permissions).
permissions.
print-object.
relative-path.
size.
uiop-path.
user.
(setf user-id).
user-id.
string
(error "path required")
:path
path.
This slot is read-only.
0
:link-count
This slot is read-only.
fof/file:file-kind
:regular-file
:kind
kind.
This slot is read-only.
0
:disk-usage
This slot is read-only.
0
:user-id
0
:group-id
(local-time:unix-to-timestamp 0)
:creation-date
This slot is read-only.
(local-time:unix-to-timestamp 0)
:modification-date
(local-time:unix-to-timestamp 0)
:access-date
(or null (cons (member :user-read :user-write :user-exec :group-read :group-write :group-exec :other-read :other-write :other-exec :set-user-id :set-group-id :sticky)))
(quote nil)
:permissions
file.
""
:mime-type
This slot is read-only.
""
:mime-encoding
This slot is read-only.
""
:description
This slot is read-only.
Internal storage for ‘magic-cookie-description’.
Internal storage for ‘magic-cookie-mime’.
Return the PATH description as per the ‘file’ UNIX command.
Return a pair of MIME type and MIME encoding for PATH.
Return NIL if FILE is not a child of PARENT.
Return a predicate that matches when the argument file is in a subdirectory of ROOT less deep than LEVEL.
Mimicks Unix’ ‘ls -l’.
Same as ‘magic-cooke-mime’ but for ‘file’ descriptions. See ‘%description’.
Return internal, persistent MIME cookie for ‘magicffi’ calls.
Benchmark on thousands of files shows that
keeping the same cookie saves about 15% of time.
Return a predicate that matches when the argument file is in a subdirectory of ROOT less deep than LEVEL.
Return a predicate that matches when one of the path elements is contained in
the file path.
Useful for ‘finder’.
Return a predicate that matches when one of the path suffixes matches
the file path.
Useful for ‘finder’.
Return true if PARENT is a parent of FILE.
When ABBREVIATE-HOME?, abbreviate user home directory regardless of ABBREVIATION-THRESHOLD.
| Jump to: | %
(
A B C D E F G H I K L M N P R S U W |
|---|
| Jump to: | %
(
A B C D E F G H I K L M N P R S U W |
|---|
| Jump to: | %
*
+
A C D G I K L M P S U |
|---|
| Jump to: | %
*
+
A C D G I K L M P S U |
|---|
| Jump to: | C F G P S T U |
|---|
| Jump to: | C F G P S T U |
|---|