PkgBrowser

A utility for browsing pacman databases and the AUR

© 2010-2019, kachelaqa <kachelaqa@gmail.com>


Command Line Usage

usage: pkgbrowser [opts]

options:
 -h  display this help and exit
 -V  display version information
 -u  create/update files cache

Configuration Files

The possible locations for configuration files are:

  • User-specific

    $HOME/.config/pkgbrowser/pkgbrowser.conf

  • System-wide

    /etc/pkgbrowser/pkgbrowser.conf

All configuration files are pure ASCII and use an INI-style format.

Cache Options

  • Extended File Searches

    By default, when looking for which package owns a file, only the file-lists of installed packages are available for searching.

    To extend the searches to non-installed packages, the necessary file-lists can be downloaded and cached on the local system.

    The cache can be created/updated with the following command:

    pkgbrowser -u
  • Cache Directory

    The default location for the cache directory is:

    /var/cache/pkgbrowser

    This location can be changed by adding an option to one of the configuration files as follows:

    [options]
    cache-directory=/some/other/location

Search Options

  • Include AUR

    By default, this option is unchecked when pkgbrowser starts. This can be changed by adding a line to one of the configuration files as follows:

    [options]
    include-aur=true

Search Syntax

    Search patterns consist of one or more terms connected together by operators. The terms and operators can be in any order, and spacing is mostly optional. All searches ignore case, except for file searches, which are case-sensitive.

  • Boolean Operators

    The logical OR operator is specified by a pipe character "|", and the logical NOT operator is specified by a tilde character "~". If the OR operator is not present, the AND operator is implied by default.

    The pattern below uses all three boolean operators:

    red blue | green ~ yellow

    It is logically equivalent to:

    (red AND blue) OR (green AND NOT yellow)
  • Grouping Operators

    The boolean operators are normally evaluated from left to right, but the order can be changed by grouping the terms with parentheses.

    The pattern below groups the middle two terms into an OR statement:

    red (blue | green) ~ yellow

    It is logically equivalent to:

    red AND (blue OR green) AND NOT yellow
  • Exact Operator

    By default, searches look for keys that contain the given terms. Keys can be matched exactly by using the Exact operator, which is specified by an equals character "=".

    The pattern below uses both default and exact matching:

    red | = green

    This will match "redden" or "green", but not "greener" or "greenish".

  • Literal Operators

    Single or double quotes can be used to cancel the normal meaning of spaces and the other operator characters:

    "red blue" | 'green yellow'

    They can also be used with the Exact operator to search for empty fields. So the following pattern matches either "yellow", or nothing

    yellow | = ""
  • RegExp Operator

    The percent character "%" can be used to indicate that the following term is to be treated as a regular expression. Optionally, the term can be quoted in order to avoid conflicts with the other operators.

    The following pattern shows the use of the RegExp operator:

    % ^yellow | ~ % blue$

    This will match any key that either begins with "yellow", or does not end with "blue".

  • Matching Files

    When searching for files, only whole path components will be matched (unless the RegExp operator is used). In addition, the Exact operator will only match full, absolute paths.

    The following pattern shows three different ways of getting the same match:

    red | bin/red | = /bin/red
  • Matching Orphans

    A list of orphaned packages can be produced by selecting the Maintainer key and using an empty field search (see the Literal Operators section, above).

  • AUR Limitations

    When making AUR searches, terms using the NOT or RegExp operators must be ANDed with at least one other term that does not itself use one of those operators.

    For example, the pattern below produces an error because it includes an unqualified NOT term:

    green | blue | ~ red

    The final term must be ANDed with at least one other positive term in order for the pattern to be valid:

    green | blue | yellow ~ red

    For AUR maintainer searches, the Exact operator is redundant and the RegExp operator should not be used at all. It is only possible to find exact matches, so the full maintainer name is always required.

Dependency Tree

This information page shows a hierarchy of all of the unique dependencies needed to install a package. For AUR packages, this may also include some additional dependencies required by the build process.

Missing dependencies are indicated in the tree by either a single asterisk (*) for official packages, or a double asterisk (**) for AUR packages.

The page also includes a few items of statistical information:

  • Installed

    Shows the total size and number of installed dependencies.

  • Missing

    Shows the total size and number of non-installed dependencies (but note that these totals cannot include AUR packages, the number of which will be shown separately).

Package Log

This information page shows pacman logfile entries that relate to installing, upgrading and removing a package. In addition, if a package replaces other packages, the entries for the replaced packages will also be shown.

Package Cache

This information page shows a list of the package-files that have been cached by pacman and/or archived by the Arch Linux Archive. In addition, if a package replaces other packages, the package-files for the replaced packages will also be shown.

Package Backup

This information page shows a list of the backup files belonging to a package (i.e. those for which .pacnew or .pacsave files may be generated). Also, each backup file is preceeded by an indication of its current status.

Context Menu Commands

Several additional commands can be accessed via the context menu for each information page:

  • Find

    Shows the find-bar, which provides incremental text-search for the current page.

  • Export

    Allows the package information for any page to be saved a text file.

  • Send To List

    Can be used to send a group of package-links (e.g. Dependencies, Required By) to the packages list.

Main Menu Commands

  • File > Work Offline

    If this item is checked, it will prevent all access to online resources (such as the AUR). The setting is preserved between sessions.

  • File > Refresh

    This can be used to synchronize with the pacman databases after any system changes.

  • File > Cancel Task

    This can be used to cancel a long-running task.

  • File > Quit

    Quit the application.

  • Tools > Show Statistics

    Show a dialog displaying high-level statistics about the currently installed packages.

  • Tools > Copy List

    Copies the current list of packages to the clipboard.

  • Tools > Clear Bookmarks

    Removes all the current bookmarks.

  • Help > Manual

    View the application manual.

  • Help > About

    View the application details and licence.

  • Help > About Qt

    View information about the Qt Toolkit.

Shortcuts

F1View the application manual.
F9Move focus to the filters panel.
F10Move focus to the packages panel.
F11Move focus to the information panel.
F12Move focus to the search box.
F3Start or stop the current search.
Ctrl+OOpen the file search dialog.
Alt+LeftGo back in the information history.
Alt+RightGo forward in the information history.
Ctrl+BBookmark the current package.
DeleteDelete the selected bookmark.
F7Show the bookmarks menu.
Ctrl+SShow the statistics dialog.
Ctrl+LCopy the package list.
Ctrl+FShow the find-bar.
EscapeHide the find-bar (when it has the keyboard focus).
F5Refresh after system changes.
Ctrl+WCancel the current task.
Ctrl+QQuit the application.