Next: , Previous: , Up: Epkg User Manual   [Contents][Index]

4 Describing a Package

To display details about a single package in a buffer use the command epkg-describe-package. In buffers which list packages RET is bound to epkg-list-describe-package, which displays the package at point in another buffer.

By default the description buffer shows a tree of the packages the described package depends on. Click on the symbol before the package name to expand the node to show the dependencies of that dependency.

The first column lists the names of package that provide the feature(s) in the third column. The second column shows the type of the package in the first column.

The features in the third column are displayed in bold or using the regular font weight to indicate whether it is a hard (mandatory) or soft (optional) dependency.

Note that dependencies are determined automatically and even when a feature is shown using a bold face it might actually be optional. This could for example be the case when a feature is only required by one library that isn’t required by any of the other libraries of the package it belongs to. Or a feature might even only be required by a single command, and the respective require form is only evaluated when that command is called.

Reverse dependencies are also displayed in a second tree. Here the first column lists the names of packages which depend on features from the described package and the third column shows which of these libraries are required.

Command: epkg-describe-package

This command displays information about a package in a separate buffer. The name of the package to be displayed is read in the minibuffer.

Command: epkg-list-describe-package

This command displays information about the package at point in a separate buffer.

It is only intended to be used in buffers which list packages. In other buffers, or in a list buffer when you want to display a package other than the one at point use epkg-describe-package.

User Option: epkg-describe-package-slots

The value of this option is a list of slots to be displayed when displaying information about an Epkg package in a help buffer.

Each element of the list can be a function, a slot symbol, or nil. Functions are called with one argument, the Epkg object, and should insert a representation of the value at point. Raw slot symbols cause its non-nil value to be inserted as-is. If a slot’s value is nil, then nothing is inserted. Elements that are nil stand for empty lines.

User Option: epkg-describe-package-slots-width

The value of this option specifies the width used to display slot names in buffers displaying information about an Epkg package.

Next: Package Types, Previous: Listing Packages, Up: Epkg User Manual   [Contents][Index]