Listing Packages (Epkg User Manual)

3 Listing Packages

Epkg provides several commands for listing packages.

In the buffer which lists packages, typing RET displays information about the package at point in another buffer.

User Option: epkg-list-exclude-types ¶: The value of this option is a list of package types. Most commands that list packages exclude any package whose type matches one of the types listed here. The command epkg-list-packages-of-type does not respect this option, and you can tell the other commands to ignore it as well by using a prefix argument.

User Option: epkg-list-columns ¶

This option lists the columns used in buffers that list packages.

Each element has the form (HEADER WIDTH SORT PROPS SLOT FORMAT).

HEADER is the string displayed in the header.
WIDTH is the width of the column.
SORT is a boolean or a function. If it is t, then the column can be sorted alphanumerically, if it is nil then it can not. If it is a function then that is used as sort’s PREDICATE.
PROPS is an alist, supported keys are :right-align and :pad-right.
SLOT is an Epkg object slot or type.
FORMAT is a function, which is called with one argument, the slot value, and has to return a representation of that. If FORMAT is nil, then the value is inserted as-is.

If an elements SLOT is downloads, then the respective SORT should be epkg-list-sort-by-downloads. If an elements SLOT is stars, then the respective SORT should be epkg-list-sort-by-stars.

User Option: epkg-list-mode-hook ¶: This hook is run after entering Epkg-List mode, the mode used in buffers that list packages.

Command: epkg-list-packages ¶: This command displays a list of all mirrored (and possibly also shelved) packages.

Command: epkg-list-matching-packages ¶: This command displays a list of packages whose name or summary matches a SQLite LIKE pattern, which is read in the minibuffer.

Command: epkg-list-keyworded-packages ¶

This command displays a list of packages that have a keyword set, which is read in the minibuffer.

Only keywords that are members of finder-known-keywords are offered as completion candidates, but you can also enter other keywords.

Command: epkg-list-packages-by-author ¶: This command displays a list of packages which are authored or maintained by a person. The person, a name or email address, is read in the minibuffer.

By default all of the above commands omit shelved packages from their output. With a prefix argument or when epkg-list-packages-omit-shelved is nil, then they don’t omit any packages. However the following command ignores this option and always lists shelved packages when appropriate.

Command: epkg-list-packages-of-type ¶: This command displays a list of packages of a certain type. The type is read in the minibuffer. To list all packages of a certain type and its subtypes use TYPE* instead of just TYPE.