The copy-directory Reference Manual

This is the copy-directory Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 04:53:46 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 copy-directory

Copy a directory.

Maintainer

Fernando Borretti <>

Author

Fernando Borretti <>

Home Page
Source Control

(GIT )

Bug Tracker
License

MIT

Long Description

# copy-directory

[![Build Status](https://travis-ci.org/ceramic/copy-directory.svg?branch=master)](https://travis-ci.org/ceramic/copy-directory) [![Quicklisp](http://quickdocs.org/badge/copy-directory.svg)](http://quickdocs.org/<project name>/)

Copy a directory, using the native ‘cp‘ utility if available.

# Overview

It just copies directories.

# Usage

“‘lisp
(copy-directory:copy #p"/path/to/source/" #p"/path/to/destination/")
“‘

# License

Copyright (c) 2016 Fernando Borretti

Licensed under the MIT License.

Version

0.1

Dependencies
  • uiop (system).
  • cl-fad (system).
  • which (system).
Source

copy-directory.asd.

Child Component

src (module).


3 Modules

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


3.1 copy-directory/src

Source

copy-directory.asd.

Parent Component

copy-directory (system).

Child Component

copy-directory.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 copy-directory/copy-directory.asd

Source

copy-directory.asd.

Parent Component

copy-directory (system).

ASDF Systems

copy-directory.


4.1.2 copy-directory/src/copy-directory.lisp

Source

copy-directory.asd.

Parent Component

src (module).

Packages

copy-directory.

Public Interface

copy (function).

Internals

5 Packages

Packages are listed by definition order.


5.1 copy-directory

Copy a directory.

Source

copy-directory.lisp.

Use List

common-lisp.

Public Interface

copy (function).

Internals

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: copy (source destination)

Copy everything in the source directory to the destination directory. Both pathnames must be absolute directory pathnames. If the cp program is available, use it. If not, uses pure CL code. Returns the destination.

Package

copy-directory.

Source

copy-directory.lisp.


6.2 Internals


6.2.1 Ordinary functions

Function: cl-copy (source destination)

Copy everything under source to destination. Pure CL function.

Package

copy-directory.

Source

copy-directory.lisp.

Function: native-copy (cp-path source destination)

Copy everything from source to destination using native system tools.

Package

copy-directory.

Source

copy-directory.lisp.

Function: subtract-pathname (root pathname)

root is an absolute directory, and pathname is an absolute pathname, such that pathname is inside of root. Remove the common directory components, leaving a relative pathname.

Package

copy-directory.

Source

copy-directory.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables