The path-parse Reference Manual

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

The path-parse Reference Manual

This is the path-parse Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 05:33:18 2022 GMT+0.

Table of Contents


1 Introduction

path-parse

Build Status Coverage Status

Parse the PATH environment variable, portable.

Usage

CL-USER> (ql:quickload :path-parse)
To load "path-parse":
  Load 1 ASDF system:
    path-parse
; Loading "path-parse"

(:PATH-PARSE)
CL-USER> (path-parse:path)
(#P"/usr/local/bin/" #P"/usr/bin/" #P"/bin/" #P"/usr/local/games/"
 #P"/usr/games/")

License

Copyright (c) 2016 Fernando Borretti

Licensed under the MIT License.


2 Systems

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


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

2.1 path-parse

Parse the PATH environment variable, portably.

Maintainer

Fernando Borretti <eudoxiahp@gmail.com>

Author

Fernando Borretti <eudoxiahp@gmail.com>

Home Page

https://github.com/eudoxia0/path-parse

Source Control

(GIT git@github.com:eudoxia0/path-parse.git)

Bug Tracker

https://github.com/eudoxia0/path-parse/issues

License

MIT

Long Description

# path-parse

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

Parse the ‘PATH‘ environment variable, portable.

# Usage

“‘lisp
CL-USER> (ql:quickload :path-parse)
To load "path-parse":
Load 1 ASDF system:
path-parse
; Loading "path-parse"

(:PATH-PARSE)
CL-USER> (path-parse:path)
(#P"/usr/local/bin/" #P"/usr/bin/" #P"/bin/" #P"/usr/local/games/"
#P"/usr/games/")
“‘

# License

Copyright (c) 2016 Fernando Borretti

Licensed under the MIT License.

Version

0.1

Dependencies
  • uiop (system).
  • split-sequence (system).
Source

path-parse.asd.

Child Component

src (module).


3 Modules

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


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

3.1 path-parse/src

Source

path-parse.asd.

Parent Component

path-parse (system).

Child Component

path-parse.lisp (file).


4 Files

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


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

4.1 Lisp


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

4.1.1 path-parse/path-parse.asd

Source

path-parse.asd.

Parent Component

path-parse (system).

ASDF Systems

path-parse.


4.1.2 path-parse/src/path-parse.lisp

Source

path-parse.asd.

Parent Component

src (module).

Packages

path-parse.

Public Interface

path (function).

Internals

5 Packages

Packages are listed by definition order.


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

5.1 path-parse

Portably parse the PATH environment variable.

Source

path-parse.lisp.

Use List

common-lisp.

Public Interface

path (function).

Internals

6 Definitions

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


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

6.1 Public Interface


6.1.1 Ordinary functions

Function: path ()

Return a list of absolute pathnames where executables might be located.

Package

path-parse.

Source

path-parse.lisp.


6.2 Internals


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

6.2.1 Special variables

Special Variable: +env-var+

The name of the environment variable.

Package

path-parse.

Source

path-parse.lisp.

Special Variable: +separator+

The separator character.

Package

path-parse.

Source

path-parse.lisp.


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

6.2.2 Ordinary functions

Function: expand-pathname (pathname)

Expand a pathname, resolving . and .. using the current working directory.

Package

path-parse.

Source

path-parse.lisp.


Appendix A Indexes


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

A.1 Concepts


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

A.2 Functions

Jump to:   E   F   P  
Index Entry  Section

E
expand-pathname: Private ordinary functions

F
Function, expand-pathname: Private ordinary functions
Function, path: Public ordinary functions

P
path: Public ordinary functions

Jump to:   E   F   P