(Sorry for the inconvenience)
EasyPBI is a graphical application that makes it easy to build a PBI module from a FreeBSD port. Beginning with PC-BSD 9.1, EasyPBI ships with PC-BSD and can be found in the Control Panel.
This section demonstrates how to use this utility to convert an existing FreeBSD port into a PC-BSD PBI. You may wish to skim the PBI Module Builder Guide first, as well as refer to that Guide should you have trouble creating a PBI or wish to create a more complex PBI.
To start EasyPBI, double-click its icon in Control Panel or type EasyPBI from within an X terminal as your regular user account.
If the ports collection is not installed, you will receive the message shown in Figure 8.1a the first time you start EasyPBI.
Figure 8.1a: Ports Must be Installed to Use EasyPBI
If multiple users will be using the EasyPBI utility, go to Control Panel -> System Manager -> Tasks and click the "Fetch Ports Tree" button. Alternately, use the following command as the superuser: portsnap fetch extract. Either of these methods will install the ports collection into /usr/ports.
If you are the only user who will be using the EasyPBI utility, click OK to launch the main EasyPBI screen, shown in Figure 8.1b. Click File ➜ Get Ports which will download the ports collection to the EasyPBI sub-directory located in your home directory.
Figure 8.1b: EasyPBI Graphical Interface
If the ports collection was already installed or was installed using System Manager or portsnap, the message in the bottom area of the screen will instead indicate "To get started, please push the "New Module" button.
Creating a PBI Module
Before building a PBI, refer to the PBI Requests forum to determine which PBI's have been requested by users. You should also check that a module does not already exist for the PBI in the PBI Modules section of trac. Existing modules are listed alphabetically, according to their category in the ports collection.
To create a new module, click the "New Module" button and use the browser to select the desired port from the FreeBSD ports tree. Once a port is selected, EasyPBI will attempt to automatically supply the port information for the PBI and display the results in the GUI. In the example shown in Figure 8.1c, the net/trickle port has been selected and the fields have been auto-filled in.
Figure 8.1c: Review the New Module
You should review these fields for accuracy. If you click "Get Port Info" FreshPorts.org will open in the default web browser so that you can view additional information about the port.
A generic icon will be supplied for the module; you can change the default icon by clicking the "Choose Icon" button. When using a custom icon, use a 64x64 .png file with a transparent background.
Check the "Create Desktop/Menu Entries" if you wish the program's icon to be available on the desktop and in the desktop's application menu.
Once the port information is complete, click the "Create Module" button and EasyPBI will produce the PBI module. The module will be named after the port and will be stored in a sub-directory of the EasyPBI/Modules directory in your home directory. In this example, the module is located in EasyPBI/Modules/trickle.
Build the Module
Creating the module itself is very quick and takes less than a minute. However, you still need to build and test the module to make sure that the application works as expected. Depending upon the complexity of the application, you may have to edit the initial module then rebuild and retest it until you are satisfied with the PBI for the application.
Once the module is created, you are ready to build a PBI from the module. Click on the "Build PBI" tab and click the "Select Module" button to browse to the module you created. Figure 8.1d shows this tab with our example PBI selected.
Figure 8.1d: The Build PBI Tab
The top half of this screen contains editable settings which are used when building PBIs:
Save Settings as Defaults: the settings in this section revert back to the default settings when you exit EasyPBI. This allows you to override the default settings for a particular build. If you wish your changes to be permanent, click this button.
Output Directory: specifies the directory to store the built module. By default, it is the EasyPBI/PBI subdirectory of the user's home directory. Click the "Change Directory" button to select another location.
Digital Signature File: the PBIs available from the PC-BSD repositories are digitally signed by the PC-BSD project's signature file. If you are creating your own repository, click the "Change File" button to select your own digital signature file.
Use TMPFS: if your build system has a lot of RAM, selecting this option can speed up the build.
Use Package Caching: this setting is recommended as it reuses previously built packages to speed up subsequent builds.
The rest of this screen is used to build the specified module:
Select Module: select the previously created module to build.
Build PBI: starts the build of the PBI module. It will prompt you for the superuser password and requires a working Internet connection in order to build the PBI. This process may take quite a while, depending upon the port selected and the speed of your computer. The build messages will be displayed in the window at the bottom of the tab. EasyPBI will inform you when the PBI build is finished, and whether it was successful or not.
Stop Build: stops the build process. Click the "Build PBI" button to resume the build.
Save Build Log: useful if the build fails. Will prompt you to select the location to store build.log which can be read with any ASCII text editor.
You can produce additional modules from the "Create Module" tab while a PBI build is running.
If the PBI build fails for some reason, you may need to modify the module as described in the next section. Use the build log to determine the error and modify the module as needed. If you are unsure how to fix the module, send the build.log for the failure to the pbi-dev mailing list.
Test and Fine-Tune the Module
Once your build is finished, test the PBI to ensure that it installs and that the application works.
To install the PBI, become the superuser, cd to the "Output Directory", and use the pbi_add command. Unless you have specified your own digital signature, include the --no-checksig option.
su Password: cd ~dru/EasyPBI/PBI ls trickle-1.07_2_amd64.pbi trickle-1.07_2_amd64.pbi.sha256 pbi_add --no-checksig trickle-1.07_2_amd64.pbi Verifying Checksum...OK Extracting to: /usr/pbi/trickle-amd64 Installed: trickle-1.07_2
If the module installs successfully, perform the following tests:
- if you checked the box "Create Desktop/Menu Entries", verify that a desktop icon was created (from a desktop that supports icons), that an entry was added to that desktop's application menu, and that the application successfully launches from the application menu. If you used a custom icon, verify that the icon was used.
- start the application from the command line to determine if there are any error messages at application launch. When starting the application, specify the full path to the application's binary to make sure that you are testing the PBI's binary.
- for GUI applications, go through the various menus to see if they produce any errors.
- if you encounter any error messages in either starting or using the application, record them. If the fix for resolving the error messages is not clear to you, send the error report the pbi-dev mailing list.
The "Module Editor" tab, seen in Figure 8.1e, can be used to modify the module's settings. Use the "Select Module" button to browse to the location of the module and to ungrey out the settings in this screen.
Figure 8.1e: EasyPBI Module Editor
Several tabs are provided, allowing you to customize the PBI module. It should be noted that most PBI modules do not require you to make any configuration changes in the Module Editor tab. This tab allows the creation of more complex PBI modules that require additional FreeBSD ports or scripts which are not provided by the default FreeBSD port.
The rest of this section describes the actions available within each tab. If you modify any settings in the PBI module, rebuild it then test again to see if the changes fixed the PBI.
Typically the "Program Name", "Program Website", and "Program Author" are left at their default values. If this information is incorrect, you should email the FreeBSD port maintainer shown in the Program Author field so that the information can be corrected in the FreeBSD port.
If you choose to replace the "Program Icon", use a 64x64 .png file with a transparent background.
If your PBI requires a dependency that is not provided by the FreeBSD port, use the + button next to "Make Port Before" to select the needed port.
If you wish an additional port to be included with your PBI, use the + button next to "Make Port After" to select the desired port.
The "Make Options" field lets you specify a space separated list of options. The available options and their default settings will be listed in the OPTIONS= section of the port's Makefile.
If the resulting PBI needs to be run as the root user, check the "Require Root Permissions" box.
This tab, shown in Figure 8.1f, is used to add additional files to the PBI module.
Figure 8.1f: PBI Module Resource Configuration
An example of an additional file would be an application that requires the user to accept a License. Use the "+Add Resource" button to browse to the location of the LICENSE file. The built PBI will automatically prompt the user to accept the License the first time the application is launched, regardless of whether it was started from the command line or the GUI.
Another example would be when you wish to use a custom script to start the application rather than starting the application binary directly. A custom script could also be used to verify that the service is enabled or to generate a custom configuration file.
This tab, shown in Figure 8.1g, is used to fine-tune the desktop icon and the application menu entry for the application.
Figure 8.1g: Customizing the PBI's Desktop and Menu Entries
If the "Create Desktop/Menu Entries" box was checked when creating the module and the application is graphical, the default entries for the application will be listed. In our PBI example, trickle is a command line application so no entries were created by default.
Buttons are provided to "Remove Desktop Entry" or "Remove Menu Entry", should you wish to do so.
Under "Executable", the drop-down menu will display all of the binaries that came with the application. Select the binary that should launch when the user clicks the desktop icon or selects the application from the application menu. Alternately, you can select "Custom Binary" and input the path to the desired executable.
The "Entry Label" field allows you to customize the name that will appear with the icon and application menu entry.
The "Icon" drop-down menu allows you to select the .png file to use for the icon. This file must exist in ~/EasyPBI/Modules/PBI_name/resources in order to appear in the drop-down menu. Use the "Select Module" button to re-select the module if you add the icon after loading the module.
The "Menu Category" drop-down menu is used to select the category the application menu entry will be added to.
To add a desktop entry, select an "Executable", input an "Entry Label", and click the "+Add Desktop Entry" button. This will generate the .desktop file to be used by XDG-compliant desktops. The entry will appear under "Current Desktop Entries".
To add an application menu entry, select an "Executable", input an "Entry Label", and click the "+Add Menu Entry" button. The generated .desktop file will appear under "Current Menu Entries".
This tab, shown in Figure 8.1h, is used to customize how the specified binary starts.
Figure 8.1h: Configuring Custom Links for the PBI
To customize how a binary starts, highlight it and click the "Action" drop-down menu. The possible actions are:
- binary: indicates that this is an executable. EasyPBI will automatically create the necessary wrapper and PATH links for you.
- linux: indicates that this is a Linux executable. EasyPBI will automatically create the necessary Linux wrapper and PATH links for you.
- keep: instructs the PBI to not overwrite an existing binary when linking a file into the LOCALBASE. By default, LOCALBASE is set to /usr/local.
- replace: instructs the PBI to overwrite an existing binary when linking a file into the LOCALBASE.
- nocrash: disables the crashhandler GUI from running on this PBI. Note that the glue for the crash handler is not built into the base system yet.
If you select an Action, use the up arrow to add it. If you change your mind, click the "Clear Changes" button.
Submit the Module
Once you are satisfied with the PBI, go to the "Module Editor" tab and use the "Select Module" button to select the PBI's module. Then click the "Package Module" button. A pop-up window will indicate that the module has been compressed and that a .tar.gz file has been added to the PBI module directory. The file name for our example PBI is ~dru/EasyPBI/Modules/tricle.tar.gz.
If you send that file to the pbi-dev mailing list, it will be added to the PC-BSD build servers so that the 32- and 64-bit versions of the PBI can be built. Once the built PBIs are tested, they will be added to AppCafe® so that other PC-BSD users can benefit from the PBI.