Difference between revisions of "EasyPBI2/9.2"
|Line 198:||Line 198:|
==== XDG Entries ==== <!--T:33-->
==== XDG Entries ==== <!--T:33-->
This tab allows
This taballows to create desktop icons and menu entries the application be easily started from within a desktop environment. This is important step for graphical applications as it the primary method with the program.
'''Figure 8.: Desktop Entries'''
Revision as of 07:05, 3 July 2013
(Sorry for the inconvenience)
EasyPBI is a graphical application that makes it easy to build a PBI module from a FreeBSD port. EasyPBI version 2 ships with PC-BSD® rolling releases and can be found in the Control Panel. If you are running PC-BSD® 9.1-RELEASE, the EasyPBI found in the control panel is for the original version. You can upgrade this version following the instructions in the next section.
The new features built into EasyPBI version 2 include:
- The ability to package a local directory into a PBI without using the FreeBSD Ports Collection.
- An additional option for building 32-bit PBIs on 64-bit systems.
- Complete support for editing installation wrapper scripts as well as a basic template for creating new binary wrapper scripts.
- Improved support for the creation and editing of XDG desktop and menu entries with easy MIME type integration.
- The OptionsNG format for setting port build options is enabled by default.
- Support for multiple lines when specifying build options.
- New "Settings" dialog for setting and changing default directory paths, PBI build settings, and external utilities.
- New "Ports" dialog displays the last time the ports tree was updated and simplifies the process of using portsnap or svn to update the system ports tree.
- New "About" dialog for quickly viewing information about EasyPBI such as its license information and development history.
Getting EasyPBI Version 2
If you are running a rolling release, you already have EasyPBI version 2. You can verify this by going to Control Panel ➜ EasyPBI ➜ Information ➜ About EasyPBI.
If you are running PC-BSD® 9.1-RELEASE, you can install EasyPBI version 2 Using AppCafe®. You will need to specify the full path to EasyPBI2 in order to run this version by typing /usr/pbi/easypbi-amd64/bin/EasyPBI.
If you are running FreeBSD, you can install the sysutils/easypbi/ package or port. To start the application, type EasyPBI.
The rest of this section demonstrates how to use EasyPBI version 2 to convert an existing FreeBSD port into a PC-BSD® PBI. You may wish to skim the section on how to Create PBIs first, as well as refer to that section should you have trouble creating a PBI or wish to create a more complex PBI.
Quick Start to Creating a PBI Module
Before building a PBI, refer to the PBI Requests forum to determine which PBIs have been requested by users. You should also check that a module does not already exist for the PBI in the PBI Modules repository. Existing PBI modules are listed alphabetically, according to their category in the ports collection.
When EasyPBI starts up, it automatically checks to see if the FreeBSD ports tree is installed. If it is not, the message shown in Figure 8.1a will appear.
Figure 8.1a: Ports Tree not Installed
Since the ports tree is needed to create PBIs, click OK to close this message then go to Options → EasyPBI Settings → FreeBSD Ports to access the screen shown in Figure 8.1b.
Figure 8.1b: Updating FreeBSD Ports
Click the "Ports Tree" drop-down menu to select to install the ports tree to a specified directory ("Other"), only within the current user's home directory, or in /usr/ports so that it is available to other users. After making your selection, clock "OK" to install the ports collection.
Once the ports tree is installed, you are ready to create a new module. Click the “New” button to access the screen shown in Figure 8.1c.
Figure 8.1c: Creating a New Module
Use the FreeBSD Port “Select” button to browse to the desired port from the FreeBSD ports tree. A generic icon will be supplied for the module. You can change the default icon by clicking the Icon File “Select” button. When selecting a custom icon, use a 64x64 .png file with a transparent background. After making your selections, click “OK”.
EasyPBI will automatically supply the port information for the PBI and display the results. In the example shown in Figure 8.1d, the net-p2p/linuxdcpp port has been selected.
Figure 8.1d: Module Program Information
Click the “Save Configuration” button to save the automatically generated PBI module settings. You can then expand the “PBI Builder” tab and click the “Build PBI” button to build the PBI. This screen is shown in Figure 8.1e.
Figure 8.1e: Building the PBI Module
The next section describes all of the EasyPBI settings should you wish to further customize the module before building it. Otherwise, you can skip to the section on Testing and Submitting the Module.
The previous section demonstrated how to quickly generate a PBI using the default module settings. This section describes which options are available for customizing PBI modules.
To setup the options for building PBIs, click “Options” → “EasyPBI Settings”. There are three available tabs which are discussed in this section.
FreeBSD Ports Tab
Figure 8.1f shows the FreeBSD Ports tab on a system that already has FreeBSD ports installed to /usr/ports.
Figure 8.1f: FreeBSD Ports Settings
In this example, the ports tree was last updated on July 2. To update the ports tree, click the "Update" button. To install the ports tree into another directory, click the drop-down "Ports Tree" menu.
PBI Builds Tab
The PBI Builds tab is shown in Figure 8.1g.
Figure 8.1g: PBI Build Settings
The options in this screen can be summarized as follows:
PBI Output Dir: specifies the directory to store the built module. By default, it is the EasyPBI/PBI subdirectory of the user's home directory. Click the “Select” button to browse to another location.
Digitally Sign PBI: if you check this box, you will be prompted to select the location of the file containing the OpenSSL signature which will be used to digitally sign the PBI so that it is ready for for tamper-evident distribution. Create Your Own PBI Repository provides instructions for creating a signature file.
Use TMPFS: if your build system has more than 2GB of RAM, checking this option can speed up the build as it instructs the PBI build process to save all of the relevant port build pieces into memory rather than disk. If you get “Out of memory” errors when building a large port, you can uncheck this option for that particular build.
Use Package Caching: this setting is recommended as it saves all compiled ports as packages in the system cache in order to speed up subsequent builds by using the pre-built packages from the cache whenever possible rather than re-compiling every port dependency. Two additional options for dealing with the cache are available. The first option is to clear all packages from the cache and start fresh. The second option is to add a problematic package to the “Ignore” list. This will remove the specified package from the cache before starting each build, ensuring that it will always compile that port for each build that requires it.
Local Paths Tab
The Local Paths tab is shown in Figure 8.1h.
Figure 8.1h: Local Paths Settings
The options in this screen allow you to configure the following paths:
External Utilities: the default paths of the utilities used by EasyPBI to build PBI modules. The "Auto-Detect" button can be used to detect a new path if a missing utility is installed onto a FreeBSD system running EasyPBI.
Default Search Paths: the default directory that new modules are saved to, the initial search location for icons and other resources, and the default icon used by PBI modules.
The module editor pane for EasyPBI2 supports complete control over all the options available when creating PBI modules. Most of these options are not necessary for the majority of PBI modules, but they are available for applications that need some extra tweaking to work properly.
EasyPBI provides suggestions and default settings whenever there is a green arrow next to an option within the module editor. Click the arrow to view the suggestions, then click a suggestion to instruct EasyPBI to add it to the proper option within the module.
This section describes the five tabs that are available within the module editor pane.
Figure 8.1i shows the PBI Configuration tab of the module editor pane. This tab is used to set the required information about the program being packaged as a PBI.
Figure 8.1i: PBI Configuration
As seen in the Quick Start, EasyPBI automatically fill in the port information when you browse to a FreeBSD port to convert into a PBI. Under "Program Information" the port's name, website, author (FreeBSD maintainer), and default icon are filled in for you. You should review these fields for accuracy:
- if necessary, correct the capitalization in "Name".
- if the application's author is not listed in the port information, it will instead list the email address of the FreeBSD port maintainer. If the application has a specific author, this should be corrected.
- if you wish to change the default icon, see the next section on the Resources tab to add additional icons to the drop-down selection list.
The "Build Information" box provides all of the options available for building the PBI. If you selected to build a PBI from local sources in Figure 8.1c, this section will only contain the local directory to be packaged as a PBI. If you are building a PBI from a FreeBSD port, there are a number of other options as seen in Figure 8.1i.
When converting a FreeBSD port to a PBI, the only required option is the “Main FreeBSD Port”. This is set automatically based upon the port that you selected in Figure 8.3c, but you can change your initial port selection by clicking the “Change Port” button.
Some FreeBSD port provide build options. If you click “Information” → “FreeBSD Ports”, the FreshPorts entry for that port will open up in a web browser. Look for the "Configuration Options" for that entry. If there are any options, you can enable them in the “Port Build Options” box. EasyPBI will autodetect the available options and provide them as suggestions. Clicking the button with the green arrow to see the options and to select the build options to use. The selected options will be added to the "Port Build Options" box. If the port does not have any options, no suggestions will appear when you click the green arrow.
If you discover that the port appears to be missing a dependancy for the application you are packaging as a PBI, you can add additional FreeBSD ports to the "Make Port Before/After” options. If the missing dependency is causing the port to not build properly, add it to the “Make Port Before” option. If it is a missing runtime dependency, add it to the “Make Port After” option.
The last option is for both local and port PBI modules. The “Requires Root Permissions” checkbox lets you set whether the PBI can only be installed and uninstalled using root privileges. This is important if the program requires special users or groups to be created, or an installation script needs access to the local system to make modifications.
NOTE: changes within this screen will not be saved until you click the “Save Configuration” button. Be sure to save any changes before leaving this tab.
The resources tab, shown in Figure 8.1j, displays any extra files to included in the PBI. If you click the entry for an image file, the full size image with size and type information will be displayed. For other types of files, such as scripts, EasyPBI will attempt to display the text inside the file.
Figure 8.1j: Resource Options
This tab is mainly used to add PNG images to be used as PBI icons. One additional use is to create a wrapper script for starting the application. This is generally used for applications that have an environment variable that needs to be set before starting the program, such as JAVA_HOME.
EasyPBI will assist in creating a wrapper script if you click the “+Wrapper Script” button. This will prompt for a filename in the format application_name.sh. Click the "OK" button and an entry will appear as EasyPBI automatically generates the script from a template that sets the most commonly used variables. In the example shown in Figure 8.1k, click the area below the DO SOMETHING HERE comment to customize the script. Creating a wrapper script is considered an advanced task that requires some knowledge of shell scripting, so feel free to ask for help on the PBI Discussion forum or on the PBI developers mailing list.
Figure 8.1k: Edit the Automatically Generated Script
This tab, shown in Figure 8.1l, allows is used to create desktop icons and menu entries so that the application can be easily started from within a desktop environment. This is important step for graphical applications as it configures the primary method for interacting with the program.
Figure 8.1l: Desktop Entries
The entries currently configured for the module will appear in the left side of the tab. Click an existing entry to display its details on the right. You may remove an entry by clicking the “minus” button, or create a new entry by clicking on the white paper button under the entry list. On the right side of the tab you can edit the currently selected entry and click the “Save” button to overwrite it, or click “Add” to save the details as a new entry, easily letting you make copies of any entry.
Figure 8.1h shows the options that are available for desktop entries, and while the labels are fairly self-explanatory, lets go through and explain them. First is the “Name” for the entry. This is the text that the application user will see for the entry, and usually you just make it the full name of the application that the entry starts up. Next is the actual binary/executable that is used to start the application. EasyPBI will try to make recommendations based upon the main FreeBSD port being used, but you can manually set this as needed. After that is the icon to be used for the application. Just as with the program configuration, the available options are dependent upon the PNG resources available in the PBI. The two checkboxes at the end are more for special-case options. The “Open in Terminal” checkbox let you specify whether the application needs to be opened in an X terminal. This is useful for running some text-based programs that need to be embedded into a console for user interaction. The “Make Invisible” option lets you setup the entry to not actually be shown. This is not as useful for desktop entries (where the whole purpose is to be seen), but will come in much more handy with menu entries.
Figure 8.1i: Menu Entries
Figure 8.1i shows the options that are available for menu entries. Most of them are exactly the same as the ones for desktop entries, but there are two new ones that will be rather important. The first new option is labelled “Category” and this is the menu category that the entry will be placed under when listed in the desktop environment. The available menu categories are listed by EasyPBI in the suggestions box, with a small arrow next to the one that EasyPBI recommends for the application based upon the main FreeBSD port information. The last option is called “MIME Patterns” and lets you associate a space-seperated list of file types with the application. This becomes extremely useful when paired with the “Make Invisible” option. For example, let's assume that your application has three main binaries, one each for two different aspects of the program, and an additional one that basically askes which of the other two you want to use. You could setup menu entries for all three binaries, but make the two specific ones invisible and associate file types with them. This means that when a user tries to open one of those file types, it will automatically run the particular binary that uses it, rather than prompting the user for input about what to do with the file.
This tab (as shown in figure 8.1j) allows you to view and edit any installation scripts that are included within the PBI. If you click on the pulldown box, you will see a list of the scripts that are available, with icons next to them indicating if that script exists in the module. Selecting a script will give you the option to either create it (if it does not exist) or will display the full script in a box for editing.
NOTE: Changes to the script of any kind (including creating one) will not be saved to the module until you click the “Save” button. So be sure to save your work before moving to other tabs or scripts!
ADDITIONAL NOTE: For “Local Source” PBI's, the only valid scripts are "pre-install.sh", “post-install.sh”, and “pre-remove.sh”. Later versions of EasyPBI will automatically change the list of valid scripts appropriately.
Figure 8.1j: Installation Scripts
This tab lets you setup links for files within the PBI onto the local system. This is generally used only for additional command-line program binaries, or binaries in dependencies to the main FreeBSD port being packaged as a PBI. This becomes very important when you start adding additional files (such as wrapper scripts) to the PBI that are not included in the port. If you are packaging a local directory into a PBI instead of using the FreeBSD ports, this is the method by which you setup what the main binaries are for the application. The “File” entry is for the file location in the PBI directory, and the “Link To” option is where you want to link it on the base system (relative to /usr/local/). The “File Type” option lets you set what type of link it needs to be, with options available from the suggestions button. Details about the different file types are available below. EasyPBI will suggest any binaries that it detects from the main port (in case you want to set a different file type), but in general this is not used very often.
NOTE: The files that you want to have listed here are any files that need to be available on the users general system path. For FreeBSD ports, the binaries from the main port are already setup for this by default (you don't need to add them here unless you want to change the file type).
- binary: indicates that this is an executable. The PBI 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 file when linking a file into the LOCALBASE. By default, LOCALBASE is set to /usr/local.
- replace: instructs the PBI to overwrite an existing file 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.
Figure 8.1k: External Links
EasyPBI provides a front-end to the PBI build structure, allowing you to use a PBI module to build the full PBI on your local system. As shown in figure 8.1l, this interface is relatively simple, with buttons to start and stop the build, as well as save the build log (in case you need to seek assistance). If you are using a 64-bit system, there is also an additional checkbox allowing you to build a 32-bit PBI rather than keeping with the system architecture. Performing a PBI build will require administrator (root) access on your system, as well as an active internet connection if building a PBI from a FreeBSD port. The current options for the PBI build process can be configured in the EasyPBI settings. EasyPBI can only perform one build at a time, and you are able to load and edit other PBI modules while a PBI is building in the background. You will receive a notification about the success/failure of the PBI build when it is finished, or you can keep an eye on the build log to see how it is progressing.
Figure 8.1l: PBI Builder
Example: Converting a FreeBSD port to a PBI
Step 1: Create a PBI module
Click on the "New" button at the top of the window to open up the small dialog shown in figure 8.1m.
Figure 8.1m: New Module Dialog
Make sure that the "FreeBSD Port" option is selected, then click select the FreeBSD port that you wish to convert. You may either type in the port directory/name manually, or click the "Select" button to open up the current FreeBSD ports directory for selecting a port. Once this is done, you may either select a PNG icon to use for the application, or simply use the default icon supplied by EasyPBI. Click "OK" to create the new module.
Step 2: (OPTIONAL) Checking the new module
Once a new module has been created, it is usually a good idea to just browse through the module in the editor and make sure that everything looks good. The main things to check are on the "PBI Configuration" tab (figure 8.1n), but if it is a graphical application you will also want to go to the "XDG Entries" tab and create a desktop/menu entry for the application (figure 8.1o).
Figure 8.1n: Example Module Configuration
Figure 8.1o: Example Menu Entry
Step 3: Build the PBI
Open up the PBI Builder, then click on "Build PBI" to start the build process. This will require root permissions as well as an internet connection, and might take a while to finish (depending on your system hardware and PBI build settings). Once the PBI build is finished, a notification window will appear telling you whether the build was successful or not.
NOTE: While a PBI build is running, you may go ahead and create/edit other PBI modules without interfering with the build process.
NOTE 2: To install a newly-created PBI, you can either open up the PBI output directory in a file manager and double-click on the PBI file, or you can run "pbi_add <pbi-file>" from the command line.
Figure 8.1p: Example PBI Build
Example: Creating a PBI from a local directory
Submit the Module
Once you are satisfied with a PBI, make sure that the module is loaded, then click on the “Options” → “Package Module” menu 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. This means that if you look at the path for the currently loaded module at the top of the screen, you can find the packaged form of the module in the same directory.
If you send that file to the, 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.