The path-parse Reference Manual

Table of Contents

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 2.3 "Robert April" on Tue Feb 20 09:09:39 2018 GMT+0.


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

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.


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

2 Systems

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


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

2.1 path-parse

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

Description

Parse the PATH environment variable, portably.

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
Source

path-parse.asd (file)

Component

src (module)


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

3 Modules

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


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

3.1 path-parse/src

Parent

path-parse (system)

Location

src/

Component

path-parse.lisp (file)


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

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 files   [Contents][Index]

4.1.1 path-parse.asd

Location

path-parse.asd

Systems

path-parse (system)


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

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

Parent

src (module)

Location

src/path-parse.lisp

Packages

path-parse

Exported Definitions

path (function)

Internal Definitions

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

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 (file)

Use List

common-lisp

Exported Definitions

path (function)

Internal Definitions

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

6 Definitions

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


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

6.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Functions

Function: path ()

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

Package

path-parse

Source

path-parse.lisp (file)


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

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Special variables

Special Variable: +env-var+

The name of the environment variable.

Package

path-parse

Source

path-parse.lisp (file)

Special Variable: +separator+

The separator character.

Package

path-parse

Source

path-parse.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

6.2.2 Functions

Function: expand-pathname PATHNAME

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

Package

path-parse

Source

path-parse.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   M   P  
Index Entry  Section

F
File, Lisp, path-parse.asd: The path-parse<dot>asd file
File, Lisp, path-parse/src/path-parse.lisp: The path-parse/src/path-parse<dot>lisp file

L
Lisp File, path-parse.asd: The path-parse<dot>asd file
Lisp File, path-parse/src/path-parse.lisp: The path-parse/src/path-parse<dot>lisp file

M
Module, path-parse/src: The path-parse/src module

P
path-parse.asd: The path-parse<dot>asd file
path-parse/src: The path-parse/src module
path-parse/src/path-parse.lisp: The path-parse/src/path-parse<dot>lisp file

Jump to:   F   L   M   P  

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

A.2 Functions

Jump to:   E   F   P  
Index Entry  Section

E
expand-pathname: Internal functions

F
Function, expand-pathname: Internal functions
Function, path: Exported functions

P
path: Exported functions

Jump to:   E   F   P  

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

A.3 Variables

Jump to:   +  
S  
Index Entry  Section

+
+env-var+: Internal special variables
+separator+: Internal special variables

S
Special Variable, +env-var+: Internal special variables
Special Variable, +separator+: Internal special variables

Jump to:   +  
S  

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

A.4 Data types

Jump to:   P   S  
Index Entry  Section

P
Package, path-parse: The path-parse package
path-parse: The path-parse system
path-parse: The path-parse package

S
System, path-parse: The path-parse system

Jump to:   P   S