EasyPBI - Revision history

Drulavigne at 16:54, 16 April 2013

2013-04-16T16:54:26Z

Drulavigne at 16:53, 16 April 2013

2013-04-16T16:53:36Z

Show changes

Drulavigne at 16:35, 16 April 2013

2013-04-16T16:35:03Z

Drulavigne at 15:43, 16 April 2013

2013-04-16T15:43:58Z

Drulavigne: Marked this version for translation

2013-04-12T19:18:38Z

Marked this version for translation

Show changes

Drulavigne at 19:18, 12 April 2013

2013-04-12T19:18:31Z

Tigersharke at 11:40, 28 February 2013

2013-02-28T11:40:36Z

Tigersharke at 11:26, 28 February 2013

2013-02-28T11:26:25Z

Tigersharke at 09:08, 19 February 2013

2013-02-19T09:08:14Z

Vater: /* Test and Fine-Tune the Module */

2013-02-11T20:59:21Z

‎Test and Fine-Tune the Module

← Older revision		Revision as of 16:54, 16 April 2013
Line 1:		Line 1:
	<noinclude>{{NavHeader\|back=Control Panel\|forward=About}}</noinclude>		<noinclude>{{NavHeader\|back=Control Panel\|forward=About}}</noinclude>
		+
		+	'''NOTE: this page is deprecated.''' Refer to [[EasyPBI2]] instead.

	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]].		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]].

@@ Line 1: / Line 1: @@
 <!--T:1-->
 <noinclude>{{NavHeader|back=Control Panel|forward=About}}</noinclude>
@@ Line 245: / Line 243: @@
 [[category:webpage referred]]
 </noinclude>

← Older revision		Revision as of 15:43, 16 April 2013
Line 1:		Line 1:
−	<translate><!--T:1-->	+	<translate>
		+
		+	<!--T:1-->
	<noinclude>{{NavHeader\|back=Control Panel\|forward=About}}</noinclude>		<noinclude>{{NavHeader\|back=Control Panel\|forward=About}}</noinclude>

@@ Line 1: / Line 1: @@
-<noinclude>{{NavHeader|back=Control Panel|forward=About}}</noinclude>
+<translate><noinclude>{{NavHeader|back=Control Panel|forward=About}}</noinclude>
 EasyPBI is a graphical application that makes it easy to build a PBI module from a FreeBSD port. Beginning with PC-BSD®&nbsp;9.1, EasyPBI ships with PC-BSD® and can be found in the [[Control Panel]].
@@ Line 172: / Line 172: @@
 [[category:webpage referred]]
 </noinclude>

@@ Line 13: / Line 13: @@
 If multiple users will be using the EasyPBI utility, go to ''[[Control Panel]]'' ➜ [[System Manager#Install FreeBSD Source and Ports| ''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]]'' subdirectory located in your home directory.
-−
-−
 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.
@@ Line 24: / Line 22: @@
 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.
 You should review these fields for accuracy. If you click "Get Port Info" {{citelink|url=http://freshports.org|txt=FreshPorts.org}} will open in the default web browser so that you can view additional information about the port.
@@ Line 33: / Line 29: @@
 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 subdirectory of the ''EasyPBI/Modules'' directory in your home directory. In this example, the module is located in ''EasyPBI/Modules/trickle''.
+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 subdirectory of the ''EasyPBI/Modules'' directory in your home directory. In this example, the module is located in ''EasyPBI/Modules/trickle''. [[File:Easypbi1c.png|thumb|'''Figure 8.1c: Review the New Module''']]
 === Build the Module ===
@@ Line 40: / Line 36: @@
 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.
 The top half of this screen contains modifiable settings which are used when building PBIs:
@@ Line 49: / Line 43: @@
 '''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. [[Create Your Own PBI Repository]] provides instructions for creating a signature file.
+'''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. [[File:Easypbi3b.png|thumb|393px|'''Figure 8.1d: The Build PBI Tab''']] [[Create Your Own PBI Repository]] provides instructions for creating a signature file.
 '''Use TMPFS:''' if your build system has a lot of RAM, selecting this option can speed up the build.
@@ Line 73: / Line 67: @@
 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.
+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.[[File:easypbi4a.png|thumb|393px|'''Figure 8.1e: EasyPBI Module Editor''']]
 {{txtbox|box='''su'''
@@ Line 96: / Line 90: @@
 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 un-grey-out the settings in this screen.
 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.
@@ Line 107: / Line 99: @@
 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 you choose to replace the ''Program Icon'', use a 64x64 ''.png'' file with a transparent background. [[File:Easypbi5a.png|thumb|393px|'''Figure 8.1f: PBI Module Resource Configuration''']]
 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.
@@ Line 120: / Line 112: @@
 This tab, shown in Figure 8.1f, is used to add additional files to the PBI module.
 An example of an additional file would be an application that requires the user to accept a License. Use the ''+&nbsp;Add Resource'' button to browse to the location of the ''LICENSE'' file.

@@ Line 83: / Line 83: @@
 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'''
+{{txtbox|box='''su'''
- Password:
+Password:
- '''cd ~dru/EasyPBI/PBI'''
+'''cd ~dru/EasyPBI/PBI'''
- '''ls'''
+'''ls'''
- trickle-1.07_2_amd64.pbi    trickle-1.07_2_amd64.pbi.sha256
+trickle-1.07_2_amd64.pbi    trickle-1.07_2_amd64.pbi.sha256
- '''pbi_add --no-checksig trickle-1.07_2_amd64.pbi'''
+'''pbi_add --no-checksig trickle-1.07_2_amd64.pbi'''
- Verifying Checksum...OK
+Verifying Checksum...OK
- Extracting to: /usr/pbi/trickle-amd64
+Extracting to: /usr/pbi/trickle-amd64
- Installed: trickle-1.07_2
+Installed: trickle-1.07_2}}
 If the module installs successfully, perform the following tests:

@@ Line 95: / Line 95: @@
 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.
+* 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.
@@ Line 103: / Line 103: @@
 * 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|url=http://lists.pcbsd.org/mailman/listinfo/pbi-dev|txt=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 un-grey-out the settings in this screen.
+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 un-grey-out the settings in this screen.
 '''Figure 8.1e: EasyPBI Module Editor'''
@@ Line 109: / Line 109: @@
 [[File:easypbi4a.png]]
-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.
+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.
 ==== pbi.conf ====
-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.
+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 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 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.
+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''.
+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.
+If the resulting PBI needs to be run as the root user, check the ''Require Root Permissions'' box.
 ==== Resources ====
@@ Line 135: / Line 135: @@
 [[Image:Easypbi5a.png]]
-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.
+An example of an additional file would be an application that requires the user to accept a License. Use the ''+&nbsp;Add Resource'' button to browse to the location of the ''LICENSE'' file.
 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.
@@ Line 149: / Line 149: @@
 [[Image:Easypbi6a.png]]
-If the "Create Desktop/Menu Entries" box was checked when creating the module and EasyPBI detects that 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. If your application is graphical but EasyPBI did not detect it, you can manually add the desired entries using the "Remove Desktop Entry" and "Remove Menu Entry" buttons.
+If the ''Create Desktop/Menu Entries'' box was checked when creating the module and EasyPBI detects that 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. If your application is graphical but EasyPBI did not detect it, you can manually add the desired entries using the ''Remove Desktop Entry'' and ''Remove Menu Entry'' buttons.
-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.
+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 ''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 ''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.
+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 a desktop entry, select an ''Executable'', input an ''Entry Label'', and click the ''+&nbsp;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".
+To add an application menu entry, select an ''Executable'', input an ''Entry Label'', and click the ''+&nbsp;Add Menu Entry'' button. The generated ''.desktop'' file will appear under ''Current Menu Entries''.
 ==== External-Links ====
@@ Line 171: / Line 171: @@
 [[Image:Easypbi7a.png]]
-To customize how a binary starts, highlight it and click the "Action" drop-down menu. The possible actions are:
+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.
@@ Line 183: / Line 183: @@
 * '''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.
+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 ===