Created page with "<noinclude><translate> <!--T:1--> {{NavHeader|back=Control Panel|forward=About}}</noinclude> <!--T:2--> {{note|icon64=This page is for EasyPBI version 2.0 and later, which w..."
New page
<noinclude><translate>
<!--T:1-->
{{NavHeader|back=Control Panel|forward=About}}</noinclude>
<!--T:2-->
{{note|icon64=This page is for EasyPBI version 2.0 and later, which was introduced after PC-BSD® 9.1. {{local|link=EasyPBI}} explains the 9.1 version of EasyPBI. Since this version adds many features, users are encouraged to install version 2 as described in the next section.}}
<!--T:3-->
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.
== Getting EasyPBI Version 2 == <!--T:89-->
<!--T:90-->
If you are running a release later than PC-BSD® 9.1-RELEASE, you already have EasyPBI version 2. You can verify this by going to <span class=traverse>Control Panel{{rarr}}EasyPBI{{rarr}}Information{{rarr}}About EasyPBI</span>.
<!--T:91-->
If you are running PC-BSD® 9.1-RELEASE, you can install EasyPBI version 2 using {{local|link=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'''.
<!--T:92-->
If you are running FreeBSD, you can install the sysutils/easypbi/ package or port. To start the application, type '''EasyPBI'''.
<!--T:93-->
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 {{local|link=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== <!--T:98-->
<!--T:99-->
Before building a PBI, refer to the {{citelink|fdpcbsd|url=61|txt=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 {{citelink|url=https://github.com/pcbsd/pbi/tree/master/modules|txt=PBI Modules repository}}. Existing PBI modules are listed alphabetically, according to their category in the ports collection.
<!--T:100-->
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.
<!--T:96-->
[[File:EasypbiMissingUtils2.png|frame|'''Figure 8.1a: Ports Tree not Installed''']]
<!--T:101-->
Since the ports tree is needed to create PBIs, click OK to close this message then go to <span class=traverse>Options{{rarr}}EasyPBI Settings{{rarr}}FreeBSD Ports</span> to access the screen shown in Figure 8.1b.
<!--T:103-->
[[File:EasypbiFreebsdports1.png|thumb|393px|'''Figure 8.1b: Updating FreeBSD Ports''']]
<!--T:104-->
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, click the "Create Dir" button to be prompted for your password in order to install the ports collection.
<!--T:105-->
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.
<!--T:107-->
[[File:Newmodule1.png|thumb|393px|'''Figure 8.1c: Creating a New Module''']]
<!--T:108-->
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”.
<!--T:109-->
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.
<!--T:110-->
[[File:Newmodule2.png|thumb|393px|'''Figure 8.1d: Module Program Information''']]
<!--T:111-->
You are now ready to build and test the PBI.
<!--T:112-->
The next section describes all of the EasyPBI settings should you wish to further customize the module before building it. Otherwise, you can skip ahead to the section on {{local|link=EasyPBI2|anchor=Build.2C_Test.2C_and_Submit_the_PBI|building and testing the PBI module}}.
== Advanced Configuration == <!--T:113-->
<!--T:114-->
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.
=== EasyPBI Settings === <!--T:12-->
To setup the options for building PBIs, click <span class=traverse>''Options''{{rarr}}''EasyPBI Settings''</span>. There are three available tabs which are discussed in this section.
==== FreeBSD Ports Tab ==== <!--T:115-->
<!--T:116-->
Figure 8.1e shows the FreeBSD Ports tab on a system that already has FreeBSD ports installed to ''/usr/ports''.
<!--T:118-->
[[File:Freebsdports.png|thumb|393px|'''Figure 8.1e: FreeBSD Ports Settings''']]
<!--T:119-->
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 ==== <!--T:120-->
<!--T:121-->
The PBI Builds tab is shown in Figure 8.1f.
<!--T:123-->
[[File:Builds.png|thumb|393px|'''Figure 8.1f: PBI Build Settings''']]
<!--T:124-->
The options in this screen can be summarized as follows:
<!--T:125-->
'''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.
<!--T:126-->
'''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. {{local|link=Create Your Own PBI Repository}} provides instructions for creating a signature file.
<!--T:127-->
'''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.
<!--T:128-->
'''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 ==== <!--T:129-->
<!--T:130-->
The Local Paths tab is shown in Figure 8.1g.
<!--T:132-->
[[File:Paths.png|thumb|393px|'''Figure 8.1g: Local Paths Settings''']]
<!--T:133-->
The options in this screen allow you to configure the following paths:
<!--T:134-->
'''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.
<!--T:135-->
'''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.
=== Module Editor === <!--T:24-->
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.
<!--T:136-->
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.
<!--T:137-->
This section describes the five tabs that are available within the module editor pane.
==== PBI Configuration ==== <!--T:25-->
Figure 8.1h 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.
<!--T:27-->
[[File:Newmodule2.png|thumb|393px|'''Figure 8.1h: PBI Configuration''']]
<!--T:138-->
As seen in the {{local|link=EasyPBI2|anchor=Quick_Start_to_Creating_a_PBI_Module|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:
<!--T:139-->
* if necessary, correct the capitalization in "Name".
<!--T:140-->
* 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.
<!--T:141-->
* 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.
<!--T:142-->
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.
<!--T:143-->
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.
<!--T:144-->
Some FreeBSD ports provide build options. If you click <span class=traverse>Information{{rarr}}FreeBSD Ports</span>, the {{citelink|url=http://freshports.org|txt=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.
<!--T:145-->
If you discover that the port appears to be missing a dependency 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.
<!--T:146-->
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.
<!--T:29-->
{{note|icon64=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.}}
==== Resources ==== <!--T:30-->
The resources tab, shown in Figure 8.1i, 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.
<!--T:148-->
[[File:Easypbiresources1.png|thumb|393px|'''Figure 8.1i: Resource Options''']]
<!--T:149-->
This tab is mainly used to add PNG images to be used as PBI icons. If you add an icon, use a 64x64
''.png'' file with a transparent background.
<!--T:150-->
An example of an additional file would be an application that requires the user to accept a License. Use the “+Add File” button to browse to the location of the ''LICENSE'' file.
<!--T:151-->
If the application uses custom installer graphics, add them using this screen.
<!--T:152-->
Another 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''. A custom script could also be used to verify that the service is enabled or to generate a custom configuration file.
<!--T:153-->
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.1j, 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 {{citelink|fdpcbsd|url=12|txt=PBI Discussion forum}} or on the {{citelink|pcbsdlist|url=pbi-dev|txt=PBI developers mailing list}}.
<!--T:155-->
[[File:Script.png|thumb|393px|'''Figure 8.1j: Edit the Automatically Generated Script''']]
==== XDG Entries ==== <!--T:33-->
This tab, shown in Figure 8.1k, 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.
<!--T:157-->
[[File:Easypbixdgdesktop.png|thumb|393px|'''Figure 8.1k: Desktop Entries''']]
<!--T:158-->
As seen in this example, 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 can remove an entry by clicking the “-” (minus sign) button, or create a new entry by clicking on the white paper button under the entry list. On the right side of this tab, you can edit the currently selected entry and click the “Save” button to overwrite the current entry with the new settings. Alternately, click “Add” to copy the existing details to a new entry.
<!--T:159-->
The "Entry Details" section of this tab are as follows when the "Desktop" button is selected:
<!--T:160-->
* '''Name:''' this is the text that will appear for the desktop menu entry, and is usually the full name of the application.
<!--T:161-->
* '''Executable:''' click the green arrow to select the executable or script that is used to start the application. Some ports have multiple binaries, so select the one associated with the program. If you created a script in the Resources tab, it will be added to the list and should be selected.
<!--T:162-->
* '''Icon:''' the available icons will include the default icon and any that you added in the Resources tab.
<!--T:163-->
* '''Open in Terminal:''' used to 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.
<!--T:164-->
* '''Make Invisible:''' if checked, the entry will be hidden. This is not as useful for desktop entries but can be handy with menu entries.
<!--T:165-->
* '''Requires Root:''' if checked, the user will be prompted for their password when the application starts.
<!--T:39-->
Figure 8.1l shows the "Entry Details" that are available when "Menu" is selected.
<!--T:167-->
[[File:Easypbixdgmenu.png|thumb|393px|'''Figure 8.1l: Menu Entry Details''']]
<!--T:168-->
This screen adds two fields:
<!--T:169-->
* '''Category:''' indicates the menu category that the entry will be placed under when listed in the desktop environment. Click the green arrow to see the available menu categories. The recommended category will have a small black arrow next to it.
<!--T:170-->
* '''MIME Patterns:''' used to associate a space-separated list of file types with the application. This is useful when paired with the “Make Invisible” option. For example, consider an application which has two binaries representing two different aspects of the program and an additional binary that asks which of the two you want to use. You could create 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.
==== Scripts ==== <!--T:40-->
This tab, shown in figure 8.1m, is used to view and edit installation scripts used by the PBI.
<!--T:172-->
[[File:Easypbiscripts.png|thumb|393px|'''Figure 8.1m: Installation Scripts''']]
<!--T:173-->
If you click on the drop-down menu, you will see a list of available scripts, with an icon indicating whether or not that script exists in the module. Selecting a script will activate a "Create" button if the script does not exist, or will display the full script in a box for editing.
<!--T:174-->
For “Local Source” PBIs, the only valid scripts are ''pre-install.sh'', ''post-install.sh'', and ''pre-remove.sh''. EasyPBI will only display the list of valid scripts.
<!--T:41-->
{{note|icon64=Changes to the scripts in this screen will not be saved until you click the “Save ” button. Be sure to save your work before leaving this tab.}}
==== External Links ==== <!--T:44-->
This tab, shown in Figure 8.1n, is used to setup links for additional binaries within the PBI.
<!--T:176-->
[[File:Easypbiexternallinks.png|thumb|393px|'''Figure 8.1n: External Links''']]
<!--T:177-->
This screen becomes important if you add additional files to the PBI, such as wrapper scripts, that are not included in the FreeBSD port. Also, if you are packaging a local directory into a PBI instead of using a FreeBSD port, this screen is needed to setup the main binaries for the application.
<!--T:178-->
When adding an entry, configure the following fields:
<!--T:179-->
* '''File:''' the binary location in the PBI directory. Click the green arrow to select the binary to link. For FreeBSD ports, the binaries from the port are already configured, so you do not need to add them here unless you want to change the "File Type".
<!--T:180-->
* '''Link To:''' input the path to link the binary to on the base system, relative to ''/usr/local/''.
<!--T:181-->
* '''File Type:''' click the green arrow to set the type of link.
<!--T:182-->
The following "File Type"s are supported:
<!--T:183-->
* '''binary:''' indicates that this is an executable. The PBI will automatically create the necessary wrapper and PATH links.
<!--T:47-->
* '''linux:''' indicates that this is a Linux executable. EasyPBI will automatically create the necessary Linux wrapper and PATH links.
<!--T:48-->
* '''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''.
<!--T:49-->
* '''replace:''' instructs the PBI to overwrite an existing file when linking a file into the LOCALBASE.
<!--T:50-->
* '''nocrash:''' disables the crashhandler GUI from running on this PBI. However, the glue for the crash handler is not built into the base system yet.
== Build, Test, and Submit the PBI == <!--T:53-->
The PBI Builder pane provides a graphical front-end to the PBI build structure. Once you have finished using "Module Editor", click the "PBI Builder" pane to build the PBI on your local system.
<!--T:184-->
In the example shown in Figure 8.1o, the user has created a PBI module for the FreeBSD port p7zip. Since this is the module that appears at the top of the screen, this is the module that will be built if the user clicks the "Build PBI" button.
<!--T:186-->
[[File:Easypbibuildsettings.png|thumb|393px|'''Figure 8.1o: PBI Builder''']]
<!--T:187-->
To build a different module, either click the "Load" button to browse to the location of a previously saved PBI module or the "New" button to select a different FreeBSD port or local source to build.
<!--T:188-->
To start the build of the PBI module, click the "Build PBI" button. A pop-up message will remind you that a working Internet connection is required so that the build process can download the source required to build the port. It will also prompt for the user's password.
<!--T:189-->
The first time you build a PBI, EasyPBI will download the chroot environment used to build PBIs. Subsequent builds will reuse this environment. The build process itself may take some time, depending upon the size of the port selected and the speed of your computer. Build messages will be displayed in the white window. EasyPBI will inform you when the PBI build is finished, and whether it was successful or not.
<!--T:190-->
If you wish to build a 32-bit version of the PBI on a 64-bit system, check the box "Build 32-bit".
<!--T:191-->
During the build, you can create additional PBI modules by clicking the "Module Editor" pane. Click the "PBI Builder (Working)" pane to check on the status of the build. However, you can only build one PBI module at a time. If you need to stop the build process, click the "Cancel Build" button.
<!--T:192-->
If the build fails, you may need to modify the module using "Module Editor". Click the "Save Build Log" button and browse to the location to save the log file which can be read with any ASCII text editor. Read the saved log to determine the error so that you can modify the module as needed. If you are unsure how to fix the PBI module, send the log for the failure to the {{citelink|pcbsdlist|url=pbi-dev|txt=pbi-dev mailing list}}.
===Test the PBI=== <!--T:193-->
<!--T:194-->
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 your PBI directory, and use the '''pbi_add''' command. Unless you have specified your own digital signature, include the ''--no-checksig'' option.
<!--T:195-->
{{txtbox|box='''su'''
Password:
'''cd ~dru/EasyPBI/PBI'''
'''ls'''
p7zip-9.20.1-amd64.pbi p7zip-9.20.1-amd64.pbi.sha256{{nbsp|16}}
'''pbi_add --no-checksig p7zip-9.20.1-amd64.pbi'''
Verifying Checksum...OK
Extracting to: /usr/pbi/p7zip-amd64
Installed: p7zip-9.20.1}}
<!--T:196-->
If the module installs successfully, perform the following tests:
<!--T:197-->
* for a graphical application, 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.
<!--T:198-->
* 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.
<!--T:199-->
* for a graphical application, 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 {{citelink|pcbsdlist|url=pbi-dev|txt=pbi-dev mailing list}}.
<!--T:200-->
If you modify any settings in the PBI's module, rebuild the PBI then test again to see if the changes fixed the PBI.
===Submit the PBI Module=== <!--T:201-->
<!--T:202-->
Once you are satisfied with the PBI, go to <span class=traverse>Options{{rarr}}Package Module</span>. A pop-up window will indicate that the module has been successfully packaged within the default "Modules" directory. The file name for the example PBI would be ''~dru/EasyPBI/Modules/p7zip.tar.gz''.
If you send that file to the {{citelink|pcbsdlist|url=pbi-dev|txt=pbi-dev mailing list}}, it will be added to the PC-BSD® build servers so that 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.
<!--T:203-->
<noinclude>
{{refheading}}
[[category:EasyPBI2]]
[[category:Control Panel]]
[[category:handbook]]
[[category:webpage referred]]
</translate>
<languages/>
</noinclude>