The trivial-package-manager Reference Manual

This is the trivial-package-manager Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 07:11:29 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 trivial-package-manager

Functions for installing packages from distro-specific package manager.

Author

Masataro Asai

Contact

License

LLGPL

Version

0.1

Dependencies
  • alexandria (system).
  • trivial-features (system).
  • trivial-open-browser (system).
Source

trivial-package-manager.asd.

Child Component

package.lisp (file).


3 Files

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


3.1 Lisp


3.1.1 trivial-package-manager/trivial-package-manager.asd

Source

trivial-package-manager.asd.

Parent Component

trivial-package-manager (system).

ASDF Systems

trivial-package-manager.

Packages

trivial-package-manager-asd.


3.1.2 trivial-package-manager/package.lisp

Source

trivial-package-manager.asd.

Parent Component

trivial-package-manager (system).

Packages

trivial-package-manager.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 trivial-package-manager-asd

Source

trivial-package-manager.asd.

Use List
  • asdf/interface.
  • common-lisp.

4.2 trivial-package-manager

Source

package.lisp.

Nickname

tpm

Use List
  • alexandria.
  • common-lisp.
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *search-engines*
Package

trivial-package-manager.

Source

package.lisp.


5.1.2 Ordinary functions

Function: browse-package (query-string)

Query-String is a string designator.
Open several package search engines on a browser

Package

trivial-package-manager.

Source

package.lisp.

Function: do-install (&key apt dnf yum pacman yaourt brew macports fink choco from-source env-alist)

Install the specified packages when the corresponding package manager is present in the system. Managers are detected simply by ‘which‘ command.

Package

trivial-package-manager.

Source

package.lisp.

Function: ensure-library (library &rest rest &key apt dnf yum pacman yaourt brew macports fink choco from-source env-alist)

Library is a shared library name to be checked by PKG-CONFIG command.
Each keyword argument specifies the package names to be passed on to the corresponding package manager. The value of each argument can be a string or a list of strings.

If none of the package managers are available / when the package is missing (e.g. older distro), FROM-SOURCE argument can specify the shell command for fetching/building/installing the program from the source code. The command is executed in the *default-pathname-defaults*,
so care must be taken to bind the appropriate value to the variable.

Example:

(ensure-library "libcurl" :apt "libcurl4-openssl-dev")
(ensure-library "libcurl" :apt ’("libcurl4-openssl-dev")) ; both are ok

Package

trivial-package-manager.

Source

package.lisp.

Function: ensure-program (program &rest rest &key apt dnf yum pacman yaourt brew macports fink choco from-source env-alist)

PROGRAM is a program name to be checked by WHICH command.
Each keyword argument specifies the package names to be passed on to the corresponding package manager. The value of each argument can be a string or a list of strings.

If none of the package managers are available / when the package is missing (e.g. older distro), FROM-SOURCE argument can specify the shell command for fetching/building/installing the program from the source code. The command is executed in the *default-pathname-defaults*,
so care must be taken to bind the appropriate value to the variable.

Example:

(ensure-program "gnome-mines" :apt "gnome-mines")
(ensure-program "gnome-mines" :apt ’("gnome-mines")) ; both are ok

Package

trivial-package-manager.

Source

package.lisp.

Function: pkg-config (name)
Package

trivial-package-manager.

Source

package.lisp.

Function: which (name)
Package

trivial-package-manager.

Source

package.lisp.


5.2 Internals


5.2.1 Ordinary functions

Function: %run (args)

Simple wrapper for run-program, input/error/output are inherited.

Package

trivial-package-manager.

Source

package.lisp.

Function: %run-p (args)
Package

trivial-package-manager.

Source

package.lisp.

Function: call-with-env (env-alist fn)
Package

trivial-package-manager.

Source

package.lisp.

Function: sudo (commands)
Package

trivial-package-manager.

Source

package.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*search-engines*: Public special variables

S
Special Variable, *search-engines*: Public special variables