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

The pero Reference Manual

This is the pero Reference Manual, version 0.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 07:16:03 2024 GMT+0.

Next: Systems, Previous: The pero Reference Manual, Up: The pero Reference Manual [Contents][Index]

1 Introduction

Next: Modules, Previous: Introduction, Up: The pero Reference Manual [Contents][Index]

2 Systems

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

pero

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

2.1 `pero`

Logging and text file perations library

Author

Walpurgisnatch

License

MIT

Version

0.1.0

Dependencies

alexandria (system).
local-time (system).

Source

pero.asd.

Child Component

src (module).

Next: Files, Previous: Systems, Up: The pero Reference Manual [Contents][Index]

3 Modules

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

pero/src

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

3.1 `pero/src`

Source

pero.asd.

Parent Component

pero (system).

Child Components

utils.lisp (file).
templates.lisp (file).
pero.lisp (file).

Next: Packages, Previous: Modules, Up: The pero Reference Manual [Contents][Index]

4 Files

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

Lisp

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

Next: pero/src/utils.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

4.1.1 `pero/pero.asd`

Source: pero.asd.
Parent Component: pero (system).
ASDF Systems: pero.

Next: pero/src/templates.lisp, Previous: pero/pero.asd, Up: Lisp [Contents][Index]

4.1.2 `pero/src/utils.lisp`

Source

pero.asd.

Parent Component

src (module).

Packages

pero.utils.

Public Interface

merge-with-dir (function).
mkdir (function).
mklist (function).
pathname-as-directory (function).

Internals

component-present-p (function).
directory-pathname-p (function).

Next: pero/src/pero.lisp, Previous: pero/src/utils.lisp, Up: Lisp [Contents][Index]

4.1.3 `pero/src/templates.lisp`

Dependency

utils.lisp (file).

Source

pero.asd.

Parent Component

src (module).

Packages

pero.templates.

Public Interface

basic (function).
current-time (function).

Previous: pero/src/templates.lisp, Up: Lisp [Contents][Index]

4.1.4 `pero/src/pero.lisp`

Dependency

templates.lisp (file).

Source

pero.asd.

Parent Component

src (module).

Packages

pero.

Public Interface

create-template (function).
logger-setup (function).
write-hashtable-to (function).
write-hashvalues-to (function).
write-line-to (function).
write-list-to (function).
write-log (function).

Internals

*dir* (special variable).
*log-templates* (special variable).
add-template (function).
create-message (function).
parse-template (function).
template-path (function).
template-string (function).

Next: Definitions, Previous: Files, Up: The pero Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

pero
pero.templates
pero.utils

Next: pero.templates, Previous: Packages, Up: Packages [Contents][Index]

5.1 `pero`

Source

pero.lisp.

Use List

common-lisp.

Public Interface

create-template (function).
logger-setup (function).
write-hashtable-to (function).
write-hashvalues-to (function).
write-line-to (function).
write-list-to (function).
write-log (function).

Internals

*dir* (special variable).
*log-templates* (special variable).
add-template (function).
create-message (function).
parse-template (function).
template-path (function).
template-string (function).

Next: pero.utils, Previous: pero, Up: Packages [Contents][Index]

5.2 `pero.templates`

Source

templates.lisp.

Use List

common-lisp.

Public Interface

basic (function).
current-time (function).

Previous: pero.templates, Up: Packages [Contents][Index]

5.3 `pero.utils`

Source

utils.lisp.

Use List

common-lisp.

Public Interface

merge-with-dir (function).
mkdir (function).
mklist (function).
pathname-as-directory (function).

Internals

component-present-p (function).
directory-pathname-p (function).

Next: Indexes, Previous: Packages, Up: The pero Reference Manual [Contents][Index]

6 Definitions

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

Public Interface
Internals

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

6.1 Public Interface

Ordinary functions

Previous: Public Interface, Up: Public Interface [Contents][Index]

6.1.1 Ordinary functions

Function: basic () ¶

Package: pero.templates.
Source: templates.lisp.

Function: create-template (&rest templates) ¶

Package: pero.
Source: pero.lisp.

Function: current-time () ¶

Package: pero.templates.
Source: templates.lisp.

Function: logger-setup (dir &key template) ¶

Package: pero.
Source: pero.lisp.

Function: merge-with-dir (child parent) ¶

Package: pero.utils.
Source: utils.lisp.

Function: mkdir (dir &optional parent) ¶

Package: pero.utils.
Source: utils.lisp.

Function: mklist (x) ¶

Package: pero.utils.
Source: utils.lisp.

Function: pathname-as-directory (name) ¶

Package: pero.utils.
Source: utils.lisp.

Function: write-hashtable-to (file table &optional format-string) ¶

Package: pero.
Source: pero.lisp.

Function: write-hashvalues-to (file table &optional format-string) ¶

Package: pero.
Source: pero.lisp.

Function: write-line-to (file line) ¶

Package: pero.
Source: pero.lisp.

Function: write-list-to (file list &optional format-string) ¶

Package: pero.
Source: pero.lisp.

Function: write-log (template &rest args) ¶

Package: pero.
Source: pero.lisp.

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

6.2 Internals

Special variables
Ordinary functions

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

6.2.1 Special variables

Special Variable: *dir* ¶

Package: pero.
Source: pero.lisp.

Special Variable: *log-templates* ¶

Package: pero.
Source: pero.lisp.

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

6.2.2 Ordinary functions

Function: add-template (log template file) ¶

Package: pero.
Source: pero.lisp.

Function: component-present-p (value) ¶

Package: pero.utils.
Source: utils.lisp.

Function: create-message (template args) ¶

Package: pero.
Source: pero.lisp.

Function: directory-pathname-p (p) ¶

Package: pero.utils.
Source: utils.lisp.

Function: parse-template (templates) ¶

Package: pero.
Source: pero.lisp.

Function: template-path (log) ¶

Package: pero.
Source: pero.lisp.

Function: template-string (template) ¶

Package: pero.
Source: pero.lisp.

Previous: Definitions, Up: The pero Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	A B C D F L M P T W

	Index Entry	Section

A
	`add-template`:	Private ordinary functions

B
	`basic`:	Public ordinary functions

C
	`component-present-p`:	Private ordinary functions
	`create-message`:	Private ordinary functions
	`create-template`:	Public ordinary functions
	`current-time`:	Public ordinary functions

D
	`directory-pathname-p`:	Private ordinary functions

F
	`Function, add-template`:	Private ordinary functions
	`Function, basic`:	Public ordinary functions
	`Function, component-present-p`:	Private ordinary functions
	`Function, create-message`:	Private ordinary functions
	`Function, create-template`:	Public ordinary functions
	`Function, current-time`:	Public ordinary functions
	`Function, directory-pathname-p`:	Private ordinary functions
	`Function, logger-setup`:	Public ordinary functions
	`Function, merge-with-dir`:	Public ordinary functions
	`Function, mkdir`:	Public ordinary functions
	`Function, mklist`:	Public ordinary functions
	`Function, parse-template`:	Private ordinary functions
	`Function, pathname-as-directory`:	Public ordinary functions
	`Function, template-path`:	Private ordinary functions
	`Function, template-string`:	Private ordinary functions
	`Function, write-hashtable-to`:	Public ordinary functions
	`Function, write-hashvalues-to`:	Public ordinary functions
	`Function, write-line-to`:	Public ordinary functions
	`Function, write-list-to`:	Public ordinary functions
	`Function, write-log`:	Public ordinary functions

L
	`logger-setup`:	Public ordinary functions

M
	`merge-with-dir`:	Public ordinary functions
	`mkdir`:	Public ordinary functions
	`mklist`:	Public ordinary functions

P
	`parse-template`:	Private ordinary functions
	`pathname-as-directory`:	Public ordinary functions

T
	`template-path`:	Private ordinary functions
	`template-string`:	Private ordinary functions

W
	`write-hashtable-to`:	Public ordinary functions
	`write-hashvalues-to`:	Public ordinary functions
	`write-line-to`:	Public ordinary functions
	`write-list-to`:	Public ordinary functions
	`write-log`:	Public ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* S

	Index Entry	Section

*
	`dir`:	Private special variables
	`log-templates`:	Private special variables

S
	`Special Variable, dir`:	Private special variables
	`Special Variable, log-templates`:	Private special variables

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

A.4 Data types

Jump to:	F M P S T U

	Index Entry	Section

F
	`File, pero.asd`:	The pero/pero․asd file
	`File, pero.lisp`:	The pero/src/pero․lisp file
	`File, templates.lisp`:	The pero/src/templates․lisp file
	`File, utils.lisp`:	The pero/src/utils․lisp file

M
	`Module, src`:	The pero/src module

P
	`Package, pero`:	The pero package
	`Package, pero.templates`:	The pero․templates package
	`Package, pero.utils`:	The pero․utils package
	`pero`:	The pero system
	`pero`:	The pero package
	`pero.asd`:	The pero/pero․asd file
	`pero.lisp`:	The pero/src/pero․lisp file
	`pero.templates`:	The pero․templates package
	`pero.utils`:	The pero․utils package

S
	`src`:	The pero/src module
	`System, pero`:	The pero system

T
	`templates.lisp`:	The pero/src/templates․lisp file

U
	`utils.lisp`:	The pero/src/utils․lisp file

The pero Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 pero

3 Modules

3.1 pero/src

4 Files

4.1 Lisp

4.1.1 pero/pero.asd

4.1.2 pero/src/utils.lisp

4.1.3 pero/src/templates.lisp

4.1.4 pero/src/pero.lisp

5 Packages

5.1 pero

5.2 pero.templates

5.3 pero.utils

6 Definitions

6.1 Public Interface

6.1.1 Ordinary functions

6.2 Internals

6.2.1 Special variables

6.2.2 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `pero`

3.1 `pero/src`

4.1.1 `pero/pero.asd`

4.1.2 `pero/src/utils.lisp`

4.1.3 `pero/src/templates.lisp`

4.1.4 `pero/src/pero.lisp`

5.1 `pero`

5.2 `pero.templates`

5.3 `pero.utils`