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 Sat Dec 03 22:50:10 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


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).


3 Modules

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


3.1 pero/src

Source

pero.asd.

Parent Component

pero (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 pero/pero.asd

Source

pero.asd.

Parent Component

pero (system).

ASDF Systems

pero.


4.1.2 pero/src/utils.lisp

Source

pero.asd.

Parent Component

src (module).

Packages

pero.utils.

Public Interface
Internals

4.1.3 pero/src/templates.lisp

Dependency

utils.lisp (file).

Source

pero.asd.

Parent Component

src (module).

Packages

pero.templates.

Public Interface

4.1.4 pero/src/pero.lisp

Dependency

templates.lisp (file).

Source

pero.asd.

Parent Component

src (module).

Packages

pero.

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 pero

Source

pero.lisp.

Use List

common-lisp.

Public Interface
Internals

5.2 pero.utils

Source

utils.lisp.

Use List

common-lisp.

Public Interface
Internals

5.3 pero.templates

Source

templates.lisp.

Use List

common-lisp.

Public Interface

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: 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-dataset-to (file &key hashvalue hashtable list if-exists)
Package

pero.

Source

pero.lisp.

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

pero.

Source

pero.lisp.

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

pero.

Source

pero.lisp.


6.2 Internals


6.2.1 Special variables

Special Variable: *dir*
Package

pero.

Source

pero.lisp.

Special Variable: *log-templates*
Package

pero.

Source

pero.lisp.


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.


Appendix A Indexes


A.1 Concepts


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-dataset-to: Public ordinary functions
Function, write-line-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-dataset-to: Public ordinary functions
write-line-to: Public ordinary functions
write-log: Public ordinary functions