PBI Manager

From PC-BSD Wiki
Jump to: navigation, search
This page contains changes which are not marked for translation.

PBI Manager is a suite of command line utilities which can be used to install, remove, and manage PBIs.

This chapter provides an overview of the commands that are installed by PBI Manager. When using these commands, note that single character options can not be stacked. As an example, you must type pbi_add -i -v as pbi_add -iv will fail with a syntax error.



The pbi meta-command can be used to install, uninstall, and get information about PBIs. Unlike the other pbi_* commands, it uses a space instead of an underscore. For example, pbi add is equivalent to pbi_add and either command can be used to install a PBI.

This meta-command expects to be given a sub-command, and then a suitable option for that sub-command. To see the available options for a sub-command, use the built-in help system. For example, to see the available options for the add sub-command, type pkg help add. Table 7.3a summarizes the available sub-commands.

Table  Is there no version? 7.3a: pbi Sub-Commands [Tables 1]
Sub-Command Description
add installs the specified PBI
delete uninstalls the specified PBI
help shows the options for the specified sub-command
icon adds or deletes the PBI's desktop icon, menu icon, or MIME registration
info shows all available PBIs or lists the packages installed into a specified jail
install equivalent to add


The pbi_add command is used to install a specified PBI. Table 7.3b summarizes the available options.

Table  Is there no version? 7.3b: pbi_add Options [Tables 2]
Switch Description
-f force installation, overwriting an already installed copy of the application
-i display information about specified PBI; if combined with -v, will display all of the files that will be installed with the PBI
-j <jailname> installs the PBI into the specified jail
-J used to create a new jail and install specified PBI into it
-l display LICENSE text for specified PBI
-v enable verbose output
--licagree if the PBI has a license, agree to it

The following example installs the alpine PBI. When prompted, input your password.

sudo pbi_add alpine

Password: Updating repository catalogue Installing: alpine The following 2 packages will be installed:

       Installing pico-alpine: 2.00_1
       Installing alpine: 2.00_4

The installation will require 9 MB more space 2 MB to be downloaded pico-alpine-2.00_1.txz 100% 314KB 313.9KB/s 313.9KB/s 00:01 alpine-2.00_4.txz 100% 1701KB 1.7MB/s 1.4MB/s 00:01 Checking integrity... done The following 2 packages will be installed:

       Installing pico-alpine: 2.00_1
       Installing alpine: 2.00_4

The installation will require 9 MB more space 0 B to be downloaded Checking integrity... done [1/2] Installing pico-alpine-2.00_1... done [2/2] Installing alpine-2.00_4... done ******************************************************************************* *** To use GnuPG with Alpine, take a look at the mail/pine-pgp-filters port ***



The pbi_* commands support several environment variables which can be stored in the ASCII text configuration file, /usr/local/etc/pbi.conf. These proxy variables are only needed if the system uses a proxy server to access the Internet. Table 7.3c lists the supported variables.

Table  Is there no version? 7.3c: pbi.conf Variables [Tables 3]
Variable Description
PBI_PROXYURL proxy server IP address
PBI_PROXYPORT proxy server port number
PBI_PROXYUSER username used to authenticate with proxy server
PBI_PROXYPASS password used to authenticate with proxy server


The pbi_delete command removes an installed PBI from the system. Table 7.3d summarizes its one available option:

Table  Is there no version? 7.3d: pbi_delete Options [Tables 4]
Switch Description
-f force the removal of the application, even if other applications depend upon it
-j <jail> deletes the application from the specified jail
-v enable verbose output

The following example uninstalls the previously installed alpine PBI:

sudo pbi_delete alpine

Password: Updating repository catalogue Deinstallation has been requested for the following 1 packages:


The deinstallation will free 8 MB [1/1] Deleting alpine-2.00_4... done Deinstallation has been requested for the following 2 packages:



The deinstallation will free 2 MB [1/2] Deleting openjpeg-2.1.0... done

[2/2] Deleting pico-alpine-2.00_1... done


The pbi_icon command provides a number of options for adding desktop icons, menu entries, and MIME data for an installed PBI. Not all PBIs will contain desktop/menu/MIME data. Additionally, the window manager must be XDG[1]-compliant to understand a PBI's icon and mime settings. Table 7.3e summarizes this command's options:

Table  Is there no version? 7.3e: pbi_icon Options [Tables 5]
Switch Description
add-desktop installs desktop icon; should be run as regular user
add-mime installs mime information; should be run as root
add-menu installs menu icons; should be run as root
del-desktop removes desktop icon; should be run as regular user
del-menu removes menu icons; should be run as root
del-mime removes mime information; should be run as root


The pbi_info command is used to determine which PBIs are currently installed. Table 7.3f summarizes the available options:

Table  Is there no version? 7.3f: pbi_info Options [Tables 6]
Switch Description
-a list all PBIs installed on the system; same as running pbi_info without an argument
-j <jailname> list PBIs installed in the specified jail
-v includes verbose information about each PBI


This command is used to make the INDEX for a custom PBI repository which can then be used in AppCafe®. Refer to Create Your Own PBI Repository for instructions on how to create a custom repository.


To check for a newer version of the PC-BSD® PBI-INDEX.txz file, type sudo pbi_updateindex and input your password when prompted. If a newer version is available, this command fetches and extracts it so that the system has the most recent list of available PBIs.

  1. http://en.wikipedia.org/wiki/Xdg


  1. [[PBI Manager|Table  Is there no version? 7.3a: pbi Sub-Commands]]
  2. [[PBI Manager|Table  Is there no version? 7.3b: pbi_add Options]]
  3. [[PBI Manager|Table  Is there no version? 7.3c: pbi.conf Variables]]
  4. [[PBI Manager|Table  Is there no version? 7.3d: pbi_delete Options]]
  5. [[PBI Manager|Table  Is there no version? 7.3e: pbi_icon Options]]
  6. [[PBI Manager|Table  Is there no version? 7.3f: pbi_info Options]]

Personal tools