The which Reference Manual

This is the which Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jan 15 08:06:47 2023 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 which

The which UNIX command in Common Lisp.

Maintainer

Fernando Borretti <>

Author

Fernando Borretti <>

Home Page

https://github.com/eudoxia0/which

Source Control

(GIT git@github.com:eudoxia0/which.git)

Bug Tracker

https://github.com/eudoxia0/which/issues

License

MIT

Long Description

# which

[![Build Status](https://travis-ci.org/eudoxia0/which.svg?branch=master)](https://travis-ci.org/eudoxia0/which)
[![Coverage Status](https://coveralls.io/repos/github/eudoxia0/which/badge.svg?branch=master)](https://coveralls.io/github/eudoxia0/which?branch=master)

The which UNIX command in Common Lisp.

# Usage

“‘lisp
CL-USER> (ql:quickload :which)
To load "which":
Load 1 ASDF system:
which
; Loading "which"
[package which]
(:WHICH)

CL-USER> (which:which "bash")
#P"/bin/bash"

CL-USER> (which:which "qooblooxbar")
NIL
“‘

# License

Copyright (c) 2016 Fernando Borretti

Licensed under the MIT License.

Version

0.1

Dependencies
  • path-parse (system).
  • cl-fad (system).
  • uiop (system).
Source

which.asd.

Child Component

src (module).


3 Modules

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


3.1 which/src

Source

which.asd.

Parent Component

which (system).

Child Component

which.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 which/which.asd

Source

which.asd.

Parent Component

which (system).

ASDF Systems

which.


4.1.2 which/src/which.lisp

Source

which.asd.

Parent Component

src (module).

Packages

which.

Public Interface

which (function).

Internals

directory-files (function).


5 Packages

Packages are listed by definition order.


5.1 which

A clone of the UNIX which command.

Source

which.lisp.

Use List

common-lisp.

Public Interface

which (function).

Internals

directory-files (function).


6 Definitions

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


6.1 Public Interface


6.1.1 Ordinary functions

Function: which (program-name)

Return the absolute pathname to the executable name (a string), if any, otherwise return NIL.

Package

which.

Source

which.lisp.


6.2 Internals


6.2.1 Ordinary functions

Function: directory-files (directory)
Package

which.

Source

which.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions


A.3 Variables