http://wiki.pcbsd.org/api.php?action=feedcontributions&user=Krismoore&feedformat=atom 2013-05-22T17:26:18Z User contributions MediaWiki 1.20.3 http://wiki.pcbsd.org/index.php/Host_a_Mirror 2013-04-08T16:57:52Z

<p>Krismoore: Change mirror flags to something which helps keep our package sets consistent</p> <hr /> <div>&lt;noinclude&gt;{{NavHeader|back=Purchase PC-BSD® Swag|forward=Seed a Torrent}}&lt;/noinclude&gt;<br /> <br /> We are always interested in more download mirrors. If you have a system with a high-speed connection, 350-500GB of space, and the ability to '''rsync''' with a host, you can greatly help the PC-BSD® project and PC-BSD® users by becoming a mirror. More mirrors means faster download speeds and more geographic locations for users to download from.<br /> <br /> This '''rsync''' command will mirror the entire collection of installation files and PBIs:<br /> <br /> {{txtbox|box='''rsync -vaz --delete-delay --delay-updates isc.pcbsd.org::ftp .'''}}<br /> <br /> That command should be run as a '''cron''' job with a recommended frequency of at least once daily with a preferred interval of every 12 hours.<br /> <br /> Once you have begun the '''rsync''' process, send an email to kris at pcbsd dot org letting him know the URL of the mirror so that the new mirror can get listed and become available to users.<br /> <br /> &lt;noinclude&gt;<br /> [[category:handbook]]<br /> [[category:Supporting PC-BSD®]]<br /> [[category:Host a Mirror]]<br /> &lt;/noinclude&gt;</div>

Krismoore http://wiki.pcbsd.org/index.php/Convert_a_FreeBSD_System_to_PC-BSD%C2%AE 2013-04-08T16:30:10Z

<p>Krismoore: /* Switching to our PKGNG repo */</p> <hr /> <div>{{NavHome|custompagename=Turn FreeBSD into PC-BSD{{r}}|custompagecategory={{PAGENAME}}}}<br /> <br /> == Introduction ==<br /> <br /> With the changeover to PKGNG as the backend in PC-BSD / TrueOS, it is now easier than ever to convert a FreeBSD system into a PC-BSD desktop or TrueOS server. <br /> <br /> Our PKGNG repos can also be used by FreeBSD users who just want access to a full package repo, with frequent updates. <br /> <br /> <br /> <br /> == Switching to our PKGNG repo ==<br /> <br /> On your FreeBSD system, jail, etc, you will first need to install the latest pkgng binaries, located in the ports tree under [http://www.freshports.org/ports-mgmt/pkg/ ports-mgmt/pkg]<br /> <br /> After installing PKGNG, you'll probably want to run the command &quot;'''pkg2ng'''&quot; to import your existing packages. <br /> <br /> Next, you will need to setup access to the PC-BSD repository. Start by creating the file '''/usr/local/etc/pkg.conf''' to look like example below:<br /> <br /> {{txtbox|box=packagesite: {{http}}ftp.pcbsd.org/pub/mirror/packages/9.1-RELEASE/amd64/<br /> PUBKEY: /usr/local/etc/pkg-pubkey.cert<br /> PKG_CACHEDIR: /usr/local/tmp}}<br /> <br /> You will want to change the packagesite: variable to a particular [http://www.pcbsd.org/getmirrors.php?url=packages PC-BSD mirror] close to your location, and in addition change the 9.1-RELEASE / amd64 to the release / architecture you want to use. Click [http://www.pcbsd.org/getmirrors.php?url=packages here] to get a list of mirrors &amp; package sets available.<br /> <br /> Next you will need to download our repo's [http://trac.pcbsd.org/export/21629/pcbsd/current/src-sh/pc-extractoverlay/desktop-overlay/usr/local/etc/pkg-pubkey.cert public key cert file], and copy it to '''/usr/local/etc/pkg-pubkey.cert'''.<br /> <br /> With this in place, you will probably want to start by updating your packages to the latest versions from the repo. You may do so by running the following command:<br /> <br /> {{txtbox|box={{pound}} pkg upgrade -fy}}<br /> <br /> When that command finishes, you should be good to go! You may now use the '''pkg''' command normally to install / remove / upgrade packages from our repo.<br /> <br /> == Converting to PC-BSD ==<br /> <br /> With your initial repo setup complete, it is now easy to convert your system into a PC-BSD desktop using the following commands:<br /> <br /> {{txtbox|box={{pound}} pkg install -yf pcbsd-base<br /> {{pound}} rehash<br /> {{pound}} pbreg set /PC-BSD/SysType PCBSD<br /> {{pound}} pc-extractoverlay desktop<br /> {{pound}} pc-extractoverlay ports}}<br /> <br /> With these commands finished, you can now reboot and the GDM login manager will be started automatically bringing you to your desktop. If you want to run the PC-BSD display wizard / first boot wizards you can also trigger that before rebooting:<br /> <br /> {{txtbox|box={{pound}} touch /var/.runxsetup<br /> {{pound}} touch /var/.pcbsd-firstboot<br /> {{pound}} touch /var/.pcbsd-firstgui}}<br /> <br /> If you are trying to convert a pre-release FreeBSD, such as 10-CURRENT, you may need to specify the PBI version of what to pull from. <br /> <br /> To do so, edit '''/usr/local/etc/pbi.conf''' and add this line:<br /> <br /> PBI_FBSDMAJOR: 9<br /> <br /> TIP!<br /> <br /> If you are using NVIDIA video hardware you may want to load their driver before rebooting into the display wizard:<br /> <br /> {{txtbox|box={{pound}} pc-metapkgmanager add NVIDIA}}<br /> <br /> == Converting to TrueOS ==<br /> <br /> If you wish to convert your server into TrueOS you can quickly do so using the following commands:<br /> <br /> {{txtbox|box={{pound}} pkg install -yf trueos-base<br /> {{pound}} rehash<br /> {{pound}} pbreg set /PC-BSD/SysType TRUEOS<br /> {{pound}} pc-extractoverlay server<br /> {{pound}} pc-extractoverlay ports}}</div>

Krismoore http://wiki.pcbsd.org/index.php/PBI_Build_Testing 2013-04-05T15:28:06Z

<p>Krismoore: </p> <hr /> <div>{{NavHome}}<br /> This area of the wiki is for those who have worked on turning a FreeBSD port into a PBI. Those who wish to add their results may do so in the table below.<br /> <br /> === Getting a port turned into a PBI ===<br /> <br /> If you wish to keep your favorite port across system updates, there is more than one way to accomplish this, but soon to become common is the creation of a PBI. The process of turning a port into a PBI can be a very simple matter of either using [[PBI Module Builder Guide#Creating a New PBI with pbi_makeport|'''pbi_makeport''']] from the commandline, or the GUIfied '''[[EasyPBI]]''' program. However, not every port submits so easily to this conversion process, and sometimes extra interaction is needed in order to succeed. The purpose of this area is to help document how those challenging ports get turned into PBIs and also perhaps, by way of this information, assist with improvement to the tools that would automate the process.<br /> <br /> '''Note:''' This page pertains to PBI version 9.<br /> <br /> === What has been Attempted ===<br /> <br /> <br /> {{Tbl-init|width=100%|caption=: Ports that have been attempted. Is this version of the port a ''One-Click'' PBI creation candidate?}}<br /> {{Tbl-title|width=8%|'''Category'''}}<br /> {{Tbl-title|width=23%|'''Port name'''}}<br /> {{Tbl-title|width=7%|'''Version'''}}<br /> {{Tbl-title|width=10%|'''Options'''}}<br /> {{Tbl-title|width=6%|'''1-Click'''}}<br /> {{Tbl-title|width=49%|'''Special changes (and/or errors)'''}}<br /> |- &lt;!-- PLEASE do not simply update version numbers without having also proven that all the other details remain true. --&gt;<br /> &lt;!-- row 1 --&gt;<br /> {{Tbl-cell|row=1|sysutils}}<br /> {{Tbl-cell|row=1|'''easypbi'''}}<br /> {{Tbl-cell|row=1|1.0}}<br /> {{Tbl-cell|row=1|defaults}}<br /> {{Tbl-cell|row=1|yes}}<br /> {{Tbl-cell|row=1|}}<br /> |-<br /> &lt;!-- row 2 --&gt;<br /> {{Tbl-cell|row=2|www}}<br /> {{Tbl-cell|row=2|'''firefox'''}}<br /> {{Tbl-cell|row=2|8.0,1}}<br /> {{Tbl-cell|row=2|defaults}}<br /> {{Tbl-cell|row=2|yes}}<br /> {{Tbl-cell|row=2|needs adjustment to define desktop icon}}<br /> |-<br /> &lt;!-- row 3 --&gt;<br /> {{Tbl-cell|row=3|mail}}<br /> {{Tbl-cell|row=3|'''gmail-notify'''}}<br /> {{Tbl-cell|row=3|1.6.1.1_4}}<br /> {{Tbl-cell|row=3|defaults}}<br /> {{Tbl-cell|row=3|yes}}<br /> {{Tbl-cell|row=3|needs adjustment to define desktop icon}}<br /> |-<br /> &lt;!-- row 4 --&gt;<br /> {{Tbl-cell|row=4|irc}}<br /> {{Tbl-cell|row=4|'''quassel'''}}<br /> {{Tbl-cell|row=4|0.73}}<br /> {{Tbl-cell|row=4|}}<br /> {{Tbl-cell|row=4|no}}<br /> {{Tbl-cell|row=4|needs work; cannot create monolithic version, other versions have problems.}}<br /> |-<br /> &lt;!-- row 5 --&gt;<br /> {{Tbl-cell|row=5|emulators}}<br /> {{Tbl-cell|row=5|'''virtualbox-ose'''}}<br /> {{Tbl-cell|row=5|4.0.14}}<br /> {{Tbl-cell|row=5|defaults}}<br /> {{Tbl-cell|row=5|no}}<br /> {{Tbl-cell|row=5|seems like it cannot pull-in kernel source}}<br /> |-<br /> &lt;!-- row 6 --&gt;<br /> {{Tbl-cell|row=6|emulators}}<br /> {{Tbl-cell|row=6|'''virtualbox-ose-additions'''}}<br /> {{Tbl-cell|row=6|4.0.14}}<br /> {{Tbl-cell|row=6|defaults}}<br /> {{Tbl-cell|row=6|no}}<br /> {{Tbl-cell|row=6|seems like it cannot pull-in kernel source}}<br /> |-<br /> &lt;!-- row 7 --&gt;<br /> {{Tbl-cell|row=7|emulators}}<br /> {{Tbl-cell|row=7|'''virtualbox-ose-kmod'''}}<br /> {{Tbl-cell|row=7|4.0.14}}<br /> {{Tbl-cell|row=7|defaults}}<br /> {{Tbl-cell|row=7|no}}<br /> {{Tbl-cell|row=7|seems like it cannot pull-in kernel source}}<br /> |-<br /> &lt;!-- row 8 --&gt;<br /> {{Tbl-cell|row=8|deskutils}}<br /> {{Tbl-cell|row=8|'''znotes'''}}<br /> {{Tbl-cell|row=8|0.45}}<br /> {{Tbl-cell|row=8|defaults}}<br /> {{Tbl-cell|row=8|yes}}<br /> {{Tbl-cell|row=8|needs adjustment to define included desktop icon}}<br /> |-<br /> |}<br /> <br /> '''''One-click candidates''''' are fully functional but can have minor flaws, such as a generic desktop/menu icon, or appearing in ''lost &amp; found''. Some ports have various non-default options which may prevent creation or cause a substantially different PBI to be made that either performs differently or lacks certain features (such as NLS).<br /> <br /> &lt;noinclude&gt;{{GroupListHeading|group=tables}}&lt;/noinclude&gt;</div>

Krismoore http://wiki.pcbsd.org/index.php/PBI_Build_Testing 2013-04-05T15:19:23Z

<p>Krismoore: Testing pdfbook functionality</p> <hr /> <div>{{NavHome}}<br /> This area of the wiki is for those who have worked on turning a FreeBSD port into a PBI. Those who wish to add their results may do so in the table below.<br /> <br /> === Getting a port turned into a PBI ===<br /> <br /> If you wish to keep your favorite port across system updates, there is more than one way to accomplish this, but soon to become common is the creation of a PBI. The process of turning a port into a PBI can be a very simple matter of either using [[PBI Module Builder Guide#Creating a New PBI with pbi_makeport|'''pbi_makeport''']] from the commandline, or the GUIfied '''[[EasyPBI]]''' program. However, not every port submits so easily to this conversion process, and sometimes extra interaction is needed in order to succeed. The purpose of this area is to help document how those challenging ports get turned into PBIs and also perhaps, by way of this information, assist with improvement to the tools that would automate the process.<br /> <br /> '''Note:''' This page pertains to PBI version 9.<br /> <br /> === What has been Attempted ===<br /> <br /> <br /> {{Tbl-init|width=100%|caption=: Ports that have been attempted. Is this version of the port a ''One-Click'' PBI creation candidate?}}<br /> {{Tbl-title|width=8%|'''Category'''}}<br /> {{Tbl-title|width=23%|'''Port name'''}}<br /> {{Tbl-title|width=7%|'''Version'''}}<br /> {{Tbl-title|width=10%|'''Options'''}}<br /> {{Tbl-title|width=6%|'''1-Click'''}}<br /> {{Tbl-title|width=49%|'''Special changes (and/or errors)'''}}<br /> |- &lt;!-- PLEASE do not simply update version numbers without having also proven that all the other details remain true. --&gt;<br /> &lt;!-- row 1 --&gt;<br /> {{Tbl-cell|row=1|sysutils}}<br /> {{Tbl-cell|row=1|'''easypbi'''}}<br /> {{Tbl-cell|row=1|1.0}}<br /> {{Tbl-cell|row=1|defaults}}<br /> {{Tbl-cell|row=1|yes}}<br /> {{Tbl-cell|row=1|}}<br /> |-<br /> &lt;!-- row 2 --&gt;<br /> {{Tbl-cell|row=2|www}}<br /> {{Tbl-cell|row=2|'''firefox'''}}<br /> {{Tbl-cell|row=2|8.0,1}}<br /> {{Tbl-cell|row=2|defaults}}<br /> {{Tbl-cell|row=2|yes}}<br /> {{Tbl-cell|row=2|needs adjustment to define desktop icon}}<br /> |-<br /> &lt;!-- row 3 --&gt;<br /> {{Tbl-cell|row=3|mail}}<br /> {{Tbl-cell|row=3|'''gmail-notify'''}}<br /> {{Tbl-cell|row=3|1.6.1.1_4}}<br /> {{Tbl-cell|row=3|defaults}}<br /> {{Tbl-cell|row=3|yes}}<br /> {{Tbl-cell|row=3|needs adjustment to define desktop icon}}<br /> |-<br /> &lt;!-- row 4 --&gt;<br /> {{Tbl-cell|row=4|irc}}<br /> {{Tbl-cell|row=4|'''quassel'''}}<br /> {{Tbl-cell|row=4|0.73}}<br /> {{Tbl-cell|row=4|}}<br /> {{Tbl-cell|row=4|no}}<br /> {{Tbl-cell|row=4|needs work; cannot create monolithic version, other versions have problems.}}<br /> |-<br /> &lt;!-- row 5 --&gt;<br /> {{Tbl-cell|row=5|emulators}}<br /> {{Tbl-cell|row=5|'''virtualbox-ose'''}}<br /> {{Tbl-cell|row=5|4.0.14}}<br /> {{Tbl-cell|row=5|defaults}}<br /> {{Tbl-cell|row=5|no}}<br /> {{Tbl-cell|row=5|seems like it cannot pull-in kernel source}}<br /> |-<br /> &lt;!-- row 6 --&gt;<br /> {{Tbl-cell|row=6|emulators}}<br /> {{Tbl-cell|row=6|'''virtualbox-ose-additions'''}}<br /> {{Tbl-cell|row=6|4.0.14}}<br /> {{Tbl-cell|row=6|defaults}}<br /> {{Tbl-cell|row=6|no}}<br /> {{Tbl-cell|row=6|seems like it cannot pull-in kernel source}}<br /> |-<br /> &lt;!-- row 7 --&gt;<br /> {{Tbl-cell|row=7|emulators}}<br /> {{Tbl-cell|row=7|'''virtualbox-ose-kmod'''}}<br /> {{Tbl-cell|row=7|4.0.14}}<br /> {{Tbl-cell|row=7|defaults}}<br /> {{Tbl-cell|row=7|no}}<br /> {{Tbl-cell|row=7|seems like it cannot pull-in kernel source}}<br /> |-<br /> &lt;!-- row 8 --&gt;<br /> {{Tbl-cell|row=8|deskutils}}<br /> {{Tbl-cell|row=8|'''znotes'''}}<br /> {{Tbl-cell|row=8|0.45}}<br /> {{Tbl-cell|row=8|defaults}}<br /> {{Tbl-cell|row=8|yes}}<br /> {{Tbl-cell|row=8|needs adjustment to define included desktop icon}}<br /> |-<br /> |}<br /> <br /> '''''One-click candidates''''' are fully functional but can have minor flaws, such as a generic desktop/menu icon, or appearing in ''lost &amp; found''. Some ports have various non-default options which may prevent creation or cause a substantially different PBI to be made that either performs differently or lacks certain features (such as NLS).<br /> <br /> &lt;noinclude&gt;{{GroupListHeading|group=tables}}&lt;/noinclude&gt;<br /> <br /> <br /> [{{fullurl:{{FULLPAGENAMEE}}|action=pdfbook}} download this selection of articles as a PDF book]</div>

Krismoore http://wiki.pcbsd.org/index.php/Convert_a_FreeBSD_System_to_PC-BSD%C2%AE 2013-04-02T15:36:00Z

<p>Krismoore: </p> <hr /> <div>{{NavHome|custompagename=Turn FreeBSD into PC-BSD{{r}}|custompagecategory={{PAGENAME}}}}<br /> <br /> == Introduction ==<br /> <br /> With the changeover to PKGNG as the backend in PC-BSD / TrueOS, it is now easier than ever to convert a FreeBSD system into a PC-BSD desktop or TrueOS server. <br /> <br /> Our PKGNG repos can also be used by FreeBSD users who just want access to a full package repo, with frequent updates. <br /> <br /> <br /> <br /> == Switching to our PKGNG repo ==<br /> <br /> On your FreeBSD system, jail, etc, you will first need to install the latest pkgng binaries, located in the ports tree under [http://www.freshports.org/ports-mgmt/pkg/ ports-mgmt/pkg]<br /> <br /> After installing PKGNG, you'll probably want to run the command &quot;'''pkg2ng'''&quot; to import your existing packages. <br /> <br /> Next, you will need to setup access to the PC-BSD repository. Start by creating the file '''/usr/local/etc/pkg.conf''' to look like example below:<br /> <br /> {{txtbox|box=packagesite: {{ftp}}mirrors.isc.org/pub/pcbsd/packages/9.1-RELEASE/amd64/<br /> PUBKEY: /usr/local/etc/pkg-pubkey.cert<br /> PKG_CACHEDIR: /usr/local/tmp}}<br /> <br /> You will want to change the packagesite: variable to a particular [http://www.pcbsd.org/getmirrors.php?url=packages PC-BSD mirror] close to your location, and in addition change the 9.1-RELEASE / amd64 to the release / architecture you want to use. Click [http://www.pcbsd.org/getmirrors.php?url=packages here] to get a list of mirrors &amp; package sets available.<br /> <br /> Next you will need to download our repo's [http://trac.pcbsd.org/export/21629/pcbsd/current/src-sh/pc-extractoverlay/desktop-overlay/usr/local/etc/pkg-pubkey.cert public key cert file], and copy it to '''/usr/local/etc/pkg-pubkey.cert'''.<br /> <br /> With this in place, you will probably want to start by updating your packages to the latest versions from the repo. You may do so by running the following command:<br /> <br /> {{txtbox|box={{pound}} pkg upgrade -fy}}<br /> <br /> When that command finishes, you should be good to go! You may now use the '''pkg''' command normally to install / remove / upgrade packages from our repo. <br /> <br /> <br /> == Converting to PC-BSD ==<br /> <br /> With your initial repo setup complete, it is now easy to convert your system into a PC-BSD desktop using the following commands:<br /> <br /> {{txtbox|box={{pound}} pkg install -yf pcbsd-base<br /> {{pound}} rehash<br /> {{pound}} pbreg set /PC-BSD/SysType PCBSD<br /> {{pound}} pc-extractoverlay desktop<br /> {{pound}} pc-extractoverlay ports}}<br /> <br /> With these commands finished, you can now reboot and the GDM login manager will be started automatically bringing you to your desktop. If you want to run the PC-BSD display wizard / first boot wizards you can also trigger that before rebooting:<br /> <br /> {{txtbox|box={{pound}} touch /var/.runxsetup<br /> {{pound}} touch /var/.pcbsd-firstboot<br /> {{pound}} touch /var/.pcbsd-firstgui}}<br /> <br /> If you are trying to convert a pre-release FreeBSD, such as 10-CURRENT, you may need to specify the PBI version of what to pull from. <br /> <br /> To do so, edit '''/usr/local/etc/pbi.conf''' and add this line:<br /> <br /> PBI_FBSDMAJOR: 9<br /> <br /> TIP!<br /> <br /> If you are using NVIDIA video hardware you may want to load their driver before rebooting into the display wizard:<br /> <br /> {{txtbox|box={{pound}} pc-metapkgmanager add NVIDIA}}<br /> <br /> == Converting to TrueOS ==<br /> <br /> If you wish to convert your server into TrueOS you can quickly do so using the following commands:<br /> <br /> {{txtbox|box={{pound}} pkg install -yf trueos-base<br /> {{pound}} rehash<br /> {{pound}} pbreg set /PC-BSD/SysType TRUEOS<br /> {{pound}} pc-extractoverlay server<br /> {{pound}} pc-extractoverlay ports}}</div>

Krismoore http://wiki.pcbsd.org/index.php/Convert_a_FreeBSD_System_to_PC-BSD%C2%AE 2013-03-17T09:50:42Z

<p>Krismoore: /* Converting to PC-BSD */</p> <hr /> <div>{{NavHome|custompagename=Turn FreeBSD into PC-BSD{{r}}|custompagecategory={{PAGENAME}}}}<br /> <br /> == Introduction ==<br /> <br /> With the changeover to PKGNG as the backend in PC-BSD / TrueOS, it is now easier than ever to convert a FreeBSD system into a PC-BSD desktop or TrueOS server. <br /> <br /> Our PKGNG repos can also be used by FreeBSD users who just want access to a full package repo, with frequent updates. <br /> <br /> <br /> <br /> == Getting Started ==<br /> <br /> On your FreeBSD system, you will first need to install the latest pkgng binaries, located in the ports tree under [[http://www.freshports.org/ports-mgmt/pkg/ ports-mgmt/pkg]]<br /> <br /> After installing PKGNG, you'll probably want to run the command &quot;'''pkg2ng'''&quot; to import your existing packages. <br /> <br /> Next, you will need to setup access to the PC-BSD repository. Start by creating the file '''/usr/local/etc/pkg.conf''' to look like example below:<br /> <br /> {{txtbox|box=packagesite: {{http}}mirrors.isc.org/pub/pcbsd/packages/9.1-RELEASE/amd64<br /> PUBKEY: /usr/local/etc/pkg-pubkey.cert<br /> PKG_CACHEDIR: /usr/local/tmp}}<br /> <br /> You will want to change the packagesite: variable to a particular [http://www.pcbsd.org/getmirrors.php?url=packages PC-BSD mirror] close to your location, and in addition change the 9.1-RELEASE / amd64 to the release / architecture you want to use. Click [http://www.pcbsd.org/getmirrors.php?url=packages here] to get a list of mirrors &amp; package sets available.<br /> <br /> Next you will need to download our repo's [http://trac.pcbsd.org/export/21629/pcbsd/current/src-sh/pc-extractoverlay/desktop-overlay/usr/local/etc/pkg-pubkey.cert public key], and copy it to '''/usr/local/etc/pkg-pubkey.cert'''.<br /> <br /> With this in place, you will probably want to start by updating your packages to the latest versions from the repo. You may do so by running the following command:<br /> <br /> {{txtbox|box={{pound}} pkg upgrade -fy}}<br /> <br /> When that command finishes, you should be good to go! You may now use the '''pkg''' command normally to install / remove / upgrade packages from our repo. <br /> <br /> <br /> === Converting to PC-BSD ===<br /> <br /> With your initial repo setup complete, it is now easy to convert your system into a PC-BSD desktop using the following commands:<br /> <br /> {{txtbox|box={{pound}} pkg install -yf pcbsd-base<br /> {{pound}} rehash<br /> {{pound}} pbreg set /PC-BSD/SysType PCBSD<br /> {{pound}} pc-extractoverlay desktop<br /> {{pound}} pc-extractoverlay ports}}<br /> <br /> With these commands finished, you can now reboot and the GDM login manager will be started automatically bringing you to your desktop. If you want to run the PC-BSD display wizard / first boot wizards you can also trigger that before rebooting:<br /> <br /> {{txtbox|box={{pound}} touch /var/.runxsetup<br /> {{pound}} touch /var/.pcbsd-firstboot<br /> {{pound}} touch /var/.pcbsd-firstgui}}<br /> <br /> If you are trying to convert a pre-release FreeBSD, such as 10-CURRENT, you may need to specify the PBI version of what to pull from. <br /> <br /> To do so, edit '''/usr/local/etc/pbi.conf''' and add this line:<br /> <br /> PBI_FBSDMAJOR: 9<br /> <br /> TIP!<br /> <br /> If you are using NVIDIA video hardware you may want to load their driver before rebooting into the display wizard:<br /> <br /> {{txtbox|box={{pound}} pc-metapkgmanager add NVIDIA}}<br /> <br /> === Converting to TrueOS ===<br /> <br /> If you wish to convert your server into TrueOS you can quickly do so using the following commands:<br /> <br /> {{txtbox|box={{pound}} pkg install -yf trueos-base<br /> {{pound}} rehash<br /> {{pound}} pbreg set /PC-BSD/SysType TRUEOS<br /> {{pound}} pc-extractoverlay server<br /> {{pound}} pc-extractoverlay ports}}</div>

Krismoore http://wiki.pcbsd.org/index.php/Convert_a_FreeBSD_System_to_PC-BSD%C2%AE 2013-02-22T18:52:11Z

<p>Krismoore: /* Converting to TrueOS */</p> <hr /> <div>{{NavHome|custompagename=Turn FreeBSD into PC-BSD{{r}}|custompagecategory={{PAGENAME}}}}<br /> <br /> == Introduction ==<br /> <br /> With the changeover to PKGNG as the backend in PC-BSD / TrueOS, it is now easier than ever to convert a FreeBSD system into a PC-BSD desktop or TrueOS server. <br /> <br /> Our PKGNG repos can also be used by FreeBSD users who just want access to a full package repo, with frequent updates. <br /> <br /> <br /> <br /> == Getting Started ==<br /> <br /> On your FreeBSD system, you will first need to install the latest pkgng binaries, located in the ports tree under [[http://www.freshports.org/ports-mgmt/pkg/ ports-mgmt/pkg]]<br /> <br /> After installing PKGNG, you'll probably want to run the command &quot;'''pkg2ng'''&quot; to import your existing packages. <br /> <br /> Next, you will need to setup access to the PC-BSD repository. Start by creating the file '''/usr/local/etc/pkg.conf''' to look like example below:<br /> <br /> packagesite: http://mirrors.isc.org/pub/pcbsd/packages/9.1-RELEASE/amd64<br /> PUBKEY: /usr/local/etc/pkg-pubkey.cert<br /> PKG_CACHEDIR: /usr/local/tmp<br /> <br /> You will want to change the packagesite: variable to a particular [http://www.pcbsd.org/getmirrors.php?url=packages PC-BSD mirror] close to your location, and in addition change the 9.1-RELEASE / amd64 to the release / architecture you want to use. Click [http://www.pcbsd.org/getmirrors.php?url=packages here] to get a list of mirrors &amp; package sets available.<br /> <br /> Next you will need to download our repo's [http://trac.pcbsd.org/export/21629/pcbsd/current/src-sh/pc-extractoverlay/desktop-overlay/usr/local/etc/pkg-pubkey.cert public key], and copy it to '''/usr/local/etc/pkg-pubkey.cert'''.<br /> <br /> With this in place, you will probably want to start by updating your packages to the latest versions from the repo. You may do so by running the following command:<br /> <br /> # pkg upgrade -fy<br /> <br /> When that command finishes, you should be good to go! You may now use the '''pkg''' command normally to install / remove / upgrade packages from our repo. <br /> <br /> <br /> === Converting to PC-BSD ===<br /> <br /> With your initial repo setup complete, it is now easy to convert your system into a PC-BSD desktop using the following commands:<br /> <br /> # pkg install -yf pcbsd-base<br /> # rehash<br /> # pbreg set /PC-BSD/SysType PCBSD<br /> # pc-extractoverlay desktop<br /> # pc-extractoverlay ports<br /> <br /> With these commands finished, you can now reboot and the GDM login manager will be started automatically bringing you to your desktop. If you want to run the PC-BSD display wizard / first boot wizards you can also trigger that before rebooting:<br /> <br /> # touch /var/.runxsetup<br /> # touch /var/.pcbsd-firstboot<br /> # touch /var/.pcbsd-firstgui<br /> <br /> TIP!<br /> <br /> If you are using NVIDIA video hardware you may want to load their driver before rebooting into the display wizard:<br /> <br /> # pc-metapkgmanager add NVIDIA<br /> <br /> === Converting to TrueOS ===<br /> <br /> If you wish to convert your server into TrueOS you can quickly do so using the following commands:<br /> <br /> # pkg install -yf trueos-base<br /> # rehash<br /> # pbreg set /PC-BSD/SysType TRUEOS<br /> # pc-extractoverlay server<br /> # pc-extractoverlay ports</div>

Krismoore http://wiki.pcbsd.org/index.php/Convert_a_FreeBSD_System_to_PC-BSD%C2%AE 2013-02-22T18:51:54Z

<p>Krismoore: /* Converting to PC-BSD */</p> <hr /> <div>{{NavHome|custompagename=Turn FreeBSD into PC-BSD{{r}}|custompagecategory={{PAGENAME}}}}<br /> <br /> == Introduction ==<br /> <br /> With the changeover to PKGNG as the backend in PC-BSD / TrueOS, it is now easier than ever to convert a FreeBSD system into a PC-BSD desktop or TrueOS server. <br /> <br /> Our PKGNG repos can also be used by FreeBSD users who just want access to a full package repo, with frequent updates. <br /> <br /> <br /> <br /> == Getting Started ==<br /> <br /> On your FreeBSD system, you will first need to install the latest pkgng binaries, located in the ports tree under [[http://www.freshports.org/ports-mgmt/pkg/ ports-mgmt/pkg]]<br /> <br /> After installing PKGNG, you'll probably want to run the command &quot;'''pkg2ng'''&quot; to import your existing packages. <br /> <br /> Next, you will need to setup access to the PC-BSD repository. Start by creating the file '''/usr/local/etc/pkg.conf''' to look like example below:<br /> <br /> packagesite: http://mirrors.isc.org/pub/pcbsd/packages/9.1-RELEASE/amd64<br /> PUBKEY: /usr/local/etc/pkg-pubkey.cert<br /> PKG_CACHEDIR: /usr/local/tmp<br /> <br /> You will want to change the packagesite: variable to a particular [http://www.pcbsd.org/getmirrors.php?url=packages PC-BSD mirror] close to your location, and in addition change the 9.1-RELEASE / amd64 to the release / architecture you want to use. Click [http://www.pcbsd.org/getmirrors.php?url=packages here] to get a list of mirrors &amp; package sets available.<br /> <br /> Next you will need to download our repo's [http://trac.pcbsd.org/export/21629/pcbsd/current/src-sh/pc-extractoverlay/desktop-overlay/usr/local/etc/pkg-pubkey.cert public key], and copy it to '''/usr/local/etc/pkg-pubkey.cert'''.<br /> <br /> With this in place, you will probably want to start by updating your packages to the latest versions from the repo. You may do so by running the following command:<br /> <br /> # pkg upgrade -fy<br /> <br /> When that command finishes, you should be good to go! You may now use the '''pkg''' command normally to install / remove / upgrade packages from our repo. <br /> <br /> <br /> === Converting to PC-BSD ===<br /> <br /> With your initial repo setup complete, it is now easy to convert your system into a PC-BSD desktop using the following commands:<br /> <br /> # pkg install -yf pcbsd-base<br /> # rehash<br /> # pbreg set /PC-BSD/SysType PCBSD<br /> # pc-extractoverlay desktop<br /> # pc-extractoverlay ports<br /> <br /> With these commands finished, you can now reboot and the GDM login manager will be started automatically bringing you to your desktop. If you want to run the PC-BSD display wizard / first boot wizards you can also trigger that before rebooting:<br /> <br /> # touch /var/.runxsetup<br /> # touch /var/.pcbsd-firstboot<br /> # touch /var/.pcbsd-firstgui<br /> <br /> TIP!<br /> <br /> If you are using NVIDIA video hardware you may want to load their driver before rebooting into the display wizard:<br /> <br /> # pc-metapkgmanager add NVIDIA<br /> <br /> === Converting to TrueOS ===<br /> <br /> If you wish to convert your server into TrueOS you can quickly do so using the following commands:<br /> <br /> # pkg install -yf trueos-base<br /> # rehash<br /> # pbreg set /PC-BSD/SysType TRUEOS<br /> # /usr/local/bin/pc-extractoverlay server</div>

Krismoore http://wiki.pcbsd.org/index.php/Convert_a_FreeBSD_System_to_PC-BSD%C2%AE 2013-02-22T18:44:30Z

<p>Krismoore: </p> <hr /> <div>{{NavHome|custompagename=Turn FreeBSD into PC-BSD{{r}}|custompagecategory={{PAGENAME}}}}<br /> <br /> == Introduction ==<br /> <br /> With the changeover to PKGNG as the backend in PC-BSD / TrueOS, it is now easier than ever to convert a FreeBSD system into a PC-BSD desktop or TrueOS server. <br /> <br /> Our PKGNG repos can also be used by FreeBSD users who just want access to a full package repo, with frequent updates. <br /> <br /> <br /> <br /> == Getting Started ==<br /> <br /> On your FreeBSD system, you will first need to install the latest pkgng binaries, located in the ports tree under [[http://www.freshports.org/ports-mgmt/pkg/ ports-mgmt/pkg]]<br /> <br /> After installing PKGNG, you'll probably want to run the command &quot;'''pkg2ng'''&quot; to import your existing packages. <br /> <br /> Next, you will need to setup access to the PC-BSD repository. Start by creating the file '''/usr/local/etc/pkg.conf''' to look like example below:<br /> <br /> packagesite: http://mirrors.isc.org/pub/pcbsd/packages/9.1-RELEASE/amd64<br /> PUBKEY: /usr/local/etc/pkg-pubkey.cert<br /> PKG_CACHEDIR: /usr/local/tmp<br /> <br /> You will want to change the packagesite: variable to a particular [http://www.pcbsd.org/getmirrors.php?url=packages PC-BSD mirror] close to your location, and in addition change the 9.1-RELEASE / amd64 to the release / architecture you want to use. Click [http://www.pcbsd.org/getmirrors.php?url=packages here] to get a list of mirrors &amp; package sets available.<br /> <br /> Next you will need to download our repo's [http://trac.pcbsd.org/export/21629/pcbsd/current/src-sh/pc-extractoverlay/desktop-overlay/usr/local/etc/pkg-pubkey.cert public key], and copy it to '''/usr/local/etc/pkg-pubkey.cert'''.<br /> <br /> With this in place, you will probably want to start by updating your packages to the latest versions from the repo. You may do so by running the following command:<br /> <br /> # pkg upgrade -fy<br /> <br /> When that command finishes, you should be good to go! You may now use the '''pkg''' command normally to install / remove / upgrade packages from our repo. <br /> <br /> <br /> === Converting to PC-BSD ===<br /> <br /> With your initial repo setup complete, it is now easy to convert your system into a PC-BSD desktop using the following commands:<br /> <br /> # pkg install -yf pcbsd-base<br /> # rehash<br /> # pbreg set /PC-BSD/SysType PCBSD<br /> # /usr/local/bin/pc-extractoverlay desktop<br /> <br /> With these commands finished, you can now reboot and the GDM login manager will be started automatically bringing you to your desktop. If you want to run the PC-BSD display wizard / first boot wizards you can also trigger that before rebooting:<br /> <br /> # touch /var/.runxsetup<br /> # touch /var/.pcbsd-firstboot<br /> # touch /var/.pcbsd-firstgui<br /> <br /> TIP!<br /> <br /> If you are using NVIDIA video hardware you may want to load their driver before rebooting into the display wizard:<br /> <br /> # pc-metapkgmanager add NVIDIA<br /> <br /> <br /> === Converting to TrueOS ===<br /> <br /> If you wish to convert your server into TrueOS you can quickly do so using the following commands:<br /> <br /> # pkg install -yf trueos-base<br /> # rehash<br /> # pbreg set /PC-BSD/SysType TRUEOS<br /> # /usr/local/bin/pc-extractoverlay server</div>

Krismoore http://wiki.pcbsd.org/index.php/Convert_a_FreeBSD_System_to_PC-BSD%C2%AE 2013-02-22T18:42:59Z

<p>Krismoore: </p> <hr /> <div>{{NavHome|custompagename=Turn FreeBSD into PC-BSD{{r}}|custompagecategory={{PAGENAME}}}}<br /> <br /> '''Introduction'''<br /> <br /> With the changeover to PKGNG as the backend in PC-BSD / TrueOS, it is now easier than ever to convert a FreeBSD system into a PC-BSD desktop or TrueOS server. <br /> <br /> Our PKGNG repos can also be used by FreeBSD users who just want access to a full package repo, with frequent updates. <br /> <br /> <br /> <br /> '''Getting Started'''<br /> <br /> On your FreeBSD system, you will first need to install the latest pkgng binaries, located in the ports tree under [[http://www.freshports.org/ports-mgmt/pkg/ ports-mgmt/pkg]]<br /> <br /> After installing PKGNG, you'll probably want to run the command &quot;'''pkg2ng'''&quot; to import your existing packages. <br /> <br /> Next, you will need to setup access to the PC-BSD repository. Start by creating the file '''/usr/local/etc/pkg.conf''' to look like example below:<br /> <br /> packagesite: http://mirrors.isc.org/pub/pcbsd/packages/9.1-RELEASE/amd64<br /> PUBKEY: /usr/local/etc/pkg-pubkey.cert<br /> PKG_CACHEDIR: /usr/local/tmp<br /> <br /> You will want to change the packagesite: variable to a particular [http://www.pcbsd.org/getmirrors.php?url=packages PC-BSD mirror] close to your location, and in addition change the 9.1-RELEASE / amd64 to the release / architecture you want to use. Click [http://www.pcbsd.org/getmirrors.php?url=packages here] to get a list of mirrors &amp; package sets available.<br /> <br /> Next you will need to download our repo's [http://trac.pcbsd.org/export/21629/pcbsd/current/src-sh/pc-extractoverlay/desktop-overlay/usr/local/etc/pkg-pubkey.cert public key], and copy it to '''/usr/local/etc/pkg-pubkey.cert'''.<br /> <br /> With this in place, you will probably want to start by updating your packages to the latest versions from the repo. You may do so by running the following command:<br /> <br /> # pkg upgrade -fy<br /> <br /> When that command finishes, you should be good to go! You may now use the '''pkg''' command normally to install / remove / upgrade packages from our repo. <br /> <br /> <br /> '''Converting to PC-BSD'''<br /> <br /> With your initial repo setup complete, it is now easy to convert your system into a PC-BSD desktop using the following commands:<br /> <br /> # pkg install -yf pcbsd-base<br /> # rehash<br /> # pbreg set /PC-BSD/SysType PCBSD<br /> # /usr/local/bin/pc-extractoverlay desktop<br /> <br /> With these commands finished, you can now reboot and the GDM login manager will be started automatically bringing you to your desktop. If you want to run the PC-BSD display wizard / first boot wizards you can also trigger that before rebooting:<br /> <br /> # touch /var/.runxsetup<br /> # touch /var/.pcbsd-firstboot<br /> # touch /var/.pcbsd-firstgui<br /> <br /> TIP!<br /> <br /> If you are using NVIDIA video hardware you may want to load their driver before rebooting into the display wizard:<br /> <br /> # pc-metapkgmanager add NVIDIA<br /> <br /> '''Converting to TrueOS'''<br /> <br /> If you wish to convert your server into TrueOS you can quickly do so using the following commands:<br /> <br /> # pkg install -yf trueos-base<br /> # rehash<br /> # pbreg set /PC-BSD/SysType TRUEOS<br /> # /usr/local/bin/pc-extractoverlay server</div>

Krismoore http://wiki.pcbsd.org/index.php/PC-BSD%C2%AE_9.2_TODO 2012-11-28T17:30:18Z

<p>Krismoore: </p> <hr /> <div>==== New Features / Tools planned for 9.2 ====<br /> {| border=1<br /> ! Feature<br /> ! Owner<br /> ! Skills<br /> ! Status<br /> ! Completion Date<br /> |-<br /> | Enable PEFS via User-Manager, allowing encrypted home directories<br /> | kmoore<br /> | QT4/Shell/Sys<br /> |<br /> |<br /> |-<br /> | add iSCSI initiator GUI front-end to iscontrol(8) for connecting to FreeNAS™ systems<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> | replace firewall GUI with fwbuilder and document how to use<br /> | dru<br /> |<br /> |<br /> |<br /> |-<br /> | add Info button to Service Manager containing description<br /> |<br /> |<br /> | should really be a DESCRIPTION field in rc.d scripts<br /> |<br /> |-<br /> | Animated splash screen<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> | Add help buttons to custom menus, write help text and add to Pootle<br /> | dru<br /> |<br /> |<br /> |<br /> |-<br /> | Front-end to text installer<br /> | jhixson<br /> |<br /> |<br /> |<br /> |-<br /> | Create new Disk Management GUI for post-install usage, ZFS, Advanced FS tasks such as ZFS snapshots, ZFS quota/compression<br /> |<br /> | C++ / QT4<br /> |<br /> |<br /> |-<br /> | Add option to play some simple games while waiting for installation<br /> | kris<br /> | C++ / QT4 / shell<br /> |<br /> |<br /> |-<br /> | Add ability to backup ZFS datasets (in life preserver?)<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> | Add password strength meter to installer and warn if root / user are same. <br /> | kmoore<br /> | C++ / QT4<br /> |<br /> |<br /> |-<br /> | Localize the meta-pkg descriptions<br /> | kmoore<br /> | C++ / Shell<br /> |<br /> |<br /> |-<br /> | C++ / QT CUPS GUI<br /> | Loic Maury<br /> | C++ / C<br /> |<br /> |<br /> |-<br /> | Switch LifePreserver to use /var/ for its backend files<br /> | kmoore<br /> | C++ / Shell<br /> |<br /> |<br /> |-<br /> | changing default language / locale for GDM in pc-sysinstall<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> | add Update All to Appcafe<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> | add option to wireless settings in network manager to select country code<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> | Add directory tree to AppCafe. On app page, at top show Home -&gt; Category -&gt; AppName, clickable<br /> |<br /> | C++ / QT4<br /> |<br /> |<br /> |-<br /> | Add enable / disable startup warden buttons<br /> |<br /> | C++ / QT4<br /> |<br /> |<br /> |-<br /> | Display fetch size / speed on warden downloads<br /> |<br /> | C++ / QT4<br /> |<br /> |<br /> |-<br /> | Display more info about devices in hardware compat GUI<br /> |<br /> | C++ / QT4<br /> |<br /> |<br /> |-<br /> | the psk for WPA networks should be hashed with wpa_passphrase(8)<br /> |<br /> | C++ / QT4<br /> |<br /> |<br /> |-<br /> | Add some kind of low disk space framework that detects both UFS + ZFS space<br /> | kmoore<br /> | C++ / Shell / libpcbsd<br /> |<br /> |<br /> |-<br /> | Improve system update mechanism to update rc.conf / loader.conf defaults (Perhaps with /etc/defaults/rc.conf)<br /> | kmoore<br /> | Shell<br /> |<br /> |<br /> |-<br /> | add bug reporting tool<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> | add a mass delete snapshot function for warden to delete snapshots no longer needed beyond a certain date. (from the command line not GUI)<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> | Add VPN functionality. If not enough time push back to 10.0.<br /> |<br /> |<br /> |<br /> |<br /> |}<br /> <br /> [[category:PC-BSD® Wiki]]<br /> [[category:TODO Lists]]</div>

Krismoore http://wiki.pcbsd.org/index.php/Creating_an_Automated_Installation_with_pc-sysinstall 2012-10-03T19:47:25Z

<p>Krismoore: /* Determine which variables you wish to customize */</p> <hr /> <div>&lt;noinclude&gt;{{NavHeader|back=Upgrading PC-BSD®|forward=Desktops}}&lt;/noinclude&gt;<br /> <br /> PC-BSD® provides a set of Bourne shell scripts that allow advanced users to create automatic or customized PC-BSD® installations. '''pc-sysinstall''' is the name of the master script; it reads a customizable configuration file and uses dozens of backend scripts to perform the installation. You can read more about this utility by typing '''man pc-sysinstall'''.<br /> <br /> Here is a quick overview of the components used by '''pc-sysinstall''':<br /> <br /> * '''/usr/share/pc-sysinstall/backend/''' contains the scripts used by the PC-BSD® installer. Scripts have been divided by function such as ''functions-bsdlabel.sh'' and ''functions-installcomponents.sh''. If you have ever wondered how the PC-BSD® installer works, read through these scripts. This directory also contains the ''parseconfig.sh'' and ''startautoinstall.sh'' scripts which '''pc-sysinstall''' uses to parse the configuration file and begin the installation.<br /> <br /> * '''/usr/share/pc-sysinstall/backend-partmanager/''' contains the scripts which are used by the installer to create and delete partitions.<br /> <br /> * '''/usr/share/pc-sysinstall/backend-query/''' contains the scripts which are used by the installer to detect (e.g. ''detect-nics.sh'') and configure (e.g. ''enable-net.sh'') hardware.<br /> <br /> * '''/usr/share/pc-sysinstall/components/''' contains FreeBSD ports and src and the PBIs for chromium, firefox, opera, and thunderbird.<br /> <br /> * '''/usr/share/pc-sysinstall/conf/''' contains the configuration file ''pc-sysinstall.conf''. It also contains a file indicating which localizations are available (''avail-langs''), a list of files which are not touched during an upgrade (''exclude-from-upgrade''), and a ''license/'' subdirectory containing text files of applicable licenses (e.g. ''bsd-en.txt'' and ''nvidia-en.txt'').<br /> <br /> * '''/usr/share/pc-sysinstall/doc/''' contains the help text that is seen if you run '''pc-sysinstall''' without any arguments.<br /> <br /> * '''/usr/share/examples/pc-sysinstall/''' contains several example configuration files for different scenarios (e.g. ''upgrade'', ''fbsd-netinstall''). The ''README'' file in this directory should be considered as mandatory reading before using '''pc-sysinstall'''.<br /> <br /> * '''/usr/sbin/pc-sysinstall''' this is the script that is used to perform a customized installation.<br /> <br /> To create a custom installation, perform the following steps:<br /> # [[#Determine which variables you wish to customize|Determine which variables you wish to customize]].&lt;br&gt;<br /> # [[#Create a customized configuration|Create a customized configuration]].&lt;br&gt;<br /> # [[#Create a custom installation media|Create a custom installation media]].&lt;br&gt;<br /> These steps are discussed in more detail below.<br /> <br /> == Determine which variables you wish to customize ==<br /> <br /> A list of possible variables can be found in ''/usr/share/examples/pc-sysinstall/README'' and in Table 5.4a. Note that the Table is meant as a quick reference to determine which variables are available. The ''README'' file contains more complete descriptions for each variable. These are assigned their values by using an equal sign (=).<br /> <br /> '''Table 5.4a: Available Variables for Customizing a PC-BSD® Installation'''<br /> <br /> {{tbl-init}}<br /> {{tbl-title|width=20%|Variable}}<br /> {{tbl-title|Options}}<br /> {{tbl-title|Description}}<br /> |-<br /> {{tbl-cell|row=1|content=hostname}}<br /> {{tbl-cell|row=1|should be unique for the network}}<br /> {{tbl-cell|row=1|optional as installer will auto-generate a hostname if empty}}<br /> |-<br /> {{tbl-cell|row=2|content=installMode}}<br /> {{tbl-cell|row=2|fresh, upgrade, or extract}}<br /> {{tbl-cell|row=2|sets the installation type}}<br /> |-<br /> {{tbl-cell|row=3|content=installLocation}}<br /> {{tbl-cell|row=3|/path/to/location}}<br /> {{tbl-cell|row=3|used only when installMode is extract and should point to an already mounted location}}<br /> |-<br /> {{tbl-cell|row=4|content=installInteractive}}<br /> {{tbl-cell|row=4|yes or no}}<br /> {{tbl-cell|row=4|set to no for automated installs without user input}}<br /> |-<br /> {{tbl-cell|row=5|content=netDev}}<br /> {{tbl-cell|row=5|AUTO-DHCP or FreeBSD interface name}}<br /> {{tbl-cell|row=5|type of network connection to use during the installation}}<br /> |-<br /> {{tbl-cell|row=6|content=netIP|other=padding-left: 24px;}}<br /> {{tbl-cell|row=6|IP address of interface used during installation}}<br /> {{tbl-cell|row=6|content=only use if ''netDev'' is set to an interface name}}<br /> |-<br /> {{tbl-cell|row=7|content=netMask|other=padding-left: 24px;}}<br /> {{tbl-cell|row=7|subnet mask of interface}}<br /> {{tbl-cell|row=7|content=only use if netDev is set to an interface name}}<br /> |-<br /> {{tbl-cell|row=8|content=netNameServer|other=padding-left: 24px;}}<br /> {{tbl-cell|row=8|IP address of DNS server}}<br /> {{tbl-cell|row=8|content=only use if netDev is set to an interface name}}<br /> |-<br /> {{tbl-cell|row=9|content=netDefaultRouter|other=padding-left: 24px;}}<br /> {{tbl-cell|row=9|IP address of default gateway}}<br /> {{tbl-cell|row=9|content=only use if netDev is set to an interface name}}<br /> |-<br /> {{tbl-cell|row=10|content=netSaveDev}}<br /> {{tbl-cell|row=10|AUTO-DHCP or FreeBSD interface name(s) (multiple allowed separated by spaces)}}<br /> {{tbl-cell|row=10|content=type of network configuration to enable on the installed system; can set multiple interfaces}}<br /> |-<br /> {{tbl-cell|row=11|content=netSaveIP_''interface name''|other=padding-left: 24px;}}<br /> {{tbl-cell|row=11|IP address of interface ''&lt;interface_name&gt;'' or DHCP}}<br /> {{tbl-cell|row=11|content=only use if netSaveDev is set to an interface name or a list of interface names (repeat for each interface)}}<br /> |-<br /> {{tbl-cell|row=12|content=netSaveMask_''&lt;interface_name&gt;''=}}<br /> {{tbl-cell|row=12|subnet mask of interface ''&lt;interface_name&gt;''}}<br /> {{tbl-cell|row=12|content=only use if netSaveDev is set to an interface name or a list of interface names (repeat for each interface)}}<br /> |-<br /> {{tbl-cell|row=13|content=netSaveNameServer=}}<br /> {{tbl-cell|row=13|IP address of DNS server (multiple allowed separated by spaces)}}<br /> {{tbl-cell|row=13|content=only use if netSaveDev= is set to an interface name or a list of interface names (do not repeat for each interface)}}<br /> |-<br /> {{tbl-cell|row=14|content=netSaveDefaultRouter=}}<br /> {{tbl-cell|row=14|IP address of default gateway}}<br /> {{tbl-cell|row=14|content=only use if netSaveDev= is set to an interface name or a list of interface names (do not repeat for each interface)}}<br /> |-<br /> {{tbl-cell|row=15|content=disk0=}}<br /> {{tbl-cell|row=15|FreeBSD disk device Name, (e.g. ''ad0'')}}<br /> {{tbl-cell|row=15|see ''README'' for examples}}<br /> |-<br /> {{tbl-cell|row=16|content=partition=}}<br /> {{tbl-cell|row=16|content=all, free, s1, s2, s3, s4, image}}<br /> {{tbl-cell|row=16|content=see ''README'' for examples}}<br /> |-<br /> {{tbl-cell|row=17|content=partscheme=}}<br /> {{tbl-cell|row=17|content=MBR or GPT}}<br /> {{tbl-cell|row=17|content=partition scheme type}}<br /> |-<br /> {{tbl-cell|row=18|content=mirror=}}<br /> {{tbl-cell|row=18|content=FreeBSD disk device name (e.g. ''ad1'')}}<br /> {{tbl-cell|row=18|content=sets the target disk for the mirror (i.e. the second disk)}}<br /> |-<br /> {{tbl-cell|row=19|content=mirrorbal=}}<br /> {{tbl-cell|row=19|content=load, prefer, round-robin, split}}<br /> {{tbl-cell|row=19|content=defaults to round-robin if the mirror balance method is not specified}}<br /> |-<br /> {{tbl-cell|row=20|content=bootManager=}}<br /> {{tbl-cell|row=20|content=none, bsd}}<br /> {{tbl-cell|row=20|content=whether or not to install the FreeBSD boot manager}}<br /> |-<br /> {{tbl-cell|row=21|content=image=}}<br /> {{tbl-cell|row=21|content=/path/to/image}}<br /> {{tbl-cell|row=21|content=will write specified image file}}<br /> |-<br /> {{tbl-cell|row=22|content=commitDiskPart}}<br /> {{tbl-cell|row=22|content=}}<br /> {{tbl-cell|row=22|content=this variable is mandatory and must be placed at the end of each diskX= section; create a diskX= section for each disk you wish to configure. }}<br /> |-<br /> {{tbl-cell|row=23|content=commitDiskLabel}}<br /> {{tbl-cell|row=23|content=}}<br /> {{tbl-cell|row=23|content=this variable is mandatory and must be placed at the end of disk's partitioning settings; see the ''README'' for examples on how to set the &lt;File System Type&gt; &lt;Size&gt; &lt;Mountpoint&gt; entries for each disk}}<br /> |-<br /> {{tbl-cell|row=24|content=installMedium=}}<br /> {{tbl-cell|row=24|content=dvd, usb, ftp, rsync, image}}<br /> {{tbl-cell|row=24|content=source to be used for installation}}<br /> |-<br /> {{tbl-cell|row=25|content=installType=}}<br /> {{tbl-cell|row=25|content=PCBSD, FreeBSD}}<br /> {{tbl-cell|row=25|content=determines whether this is a desktop or a server install}}<br /> |-<br /> {{tbl-cell|row=26|content=installFile=}}<br /> {{tbl-cell|row=26|content=e.g. fbsd-release.tbz}}<br /> {{tbl-cell|row=26|content=only set if using a customized installer archive}}<br /> |-<br /> {{tbl-cell|row=27|content=packageType=}}<br /> {{tbl-cell|row=27|content=tar, uzip, split, dist}}<br /> {{tbl-cell|row=27|content=the archive type on the installation media}}<br /> |-<br /> {{tbl-cell|row=28|content=ftpPath=}}<br /> {{tbl-cell|row=28|content=e.g. &lt;nowiki&gt;ftp://ftp.pcbsd.org/pub/mirror/9.1/amd64/netinstall/&lt;/nowiki&gt;}}<br /> {{tbl-cell|row=28|content=location of the installer archive when using installMedium=ftp}}<br /> |-<br /> {{tbl-cell|row=29|content=rsyncPath=}}<br /> {{tbl-cell|row=29|content=e.g. life-preserver/back-2011-09-12T14_53_14}}<br /> {{tbl-cell|row=29|content=location of the rsync data on the remote server when using installMedium=rsync}}<br /> |-<br /> {{tbl-cell|row=30|content=rsyncUser=}}<br /> {{tbl-cell|row=30|content=username}}<br /> {{tbl-cell|row=30|content=set when using installMedium=rsync}}<br /> |-<br /> {{tbl-cell|row=31|content=rsyncHost=}}<br /> {{tbl-cell|row=31|content=IP address of rsync server}}<br /> {{tbl-cell|row=31|content=set when using installMedium=rsync}}<br /> |-<br /> {{tbl-cell|row=32|content=rsyncPort=}}<br /> {{tbl-cell|row=32|content=port number}}<br /> {{tbl-cell|row=32|content=set when using installMedium=rsync}}<br /> |-<br /> {{tbl-cell|row=33|content=installComponents=}}<br /> {{tbl-cell|row=33|content=e.g. amarok,firefox,ports}}<br /> {{tbl-cell|row=33|content=components must exist in ''/PCBSD/pc-sysinstall/components/''}}<br /> |-<br /> {{tbl-cell|row=34|content=upgradeKeepDesktopProfile=}}<br /> {{tbl-cell|row=34|content=yes or no}}<br /> {{tbl-cell|row=34|content=specify if you wish to keep your existing user's desktop profile data during an upgrade }}<br /> |-<br /> {{tbl-cell|row=35|content=rootPass=}}<br /> {{tbl-cell|row=35|content=password}}<br /> {{tbl-cell|row=35|content=set the root password of the installed system to the specified string}}<br /> |-<br /> {{tbl-cell|row=36|content=rootEncPass=}}<br /> {{tbl-cell|row=36|content=encrypted string}}<br /> {{tbl-cell|row=36|content=set root password to specified encrypted string}}<br /> |-<br /> {{tbl-cell|row=37|content=userName=}}<br /> {{tbl-cell|row=37|content=case sensitive value}}<br /> {{tbl-cell|row=37|content=create a separate block of user values for each user you wish to create}}<br /> |-<br /> {{tbl-cell|row=38|content=userComment=}}<br /> {{tbl-cell|row=38|content=description}}<br /> {{tbl-cell|row=38|content=description text can include spaces}}<br /> |-<br /> {{tbl-cell|row=39|content=userPass=}}<br /> {{tbl-cell|row=39|content=case sensitive value}}<br /> {{tbl-cell|row=39|content=password of user}}<br /> |-<br /> {{tbl-cell|row=40|content=userEncPass}}<br /> {{tbl-cell|row=40|content=encrypted string}}<br /> {{tbl-cell|row=40|content=set user password to specified encrypted string}}<br /> |-<br /> {{tbl-cell|row=41|content=userShell=}}<br /> {{tbl-cell|row=41|content=e.g. ''/bin/csh''}}<br /> {{tbl-cell|row=41|content=path to default shell}}<br /> |-<br /> {{tbl-cell|row=42|content=userHome=}}<br /> {{tbl-cell|row=42|content=e.g. ''/home/username''}}<br /> {{tbl-cell|row=42|content=path to home directory}}<br /> |-<br /> {{tbl-cell|row=43|content=userGroups=}}<br /> {{tbl-cell|row=43|content=e.g. wheel,operator}}<br /> {{tbl-cell|row=43|content=comma separated (no spaces) list of groups}}<br /> |-<br /> {{tbl-cell|row=44|content=commitUser}}<br /> {{tbl-cell|row=44|content=}}<br /> {{tbl-cell|row=44|content=mandatory, must be last line in each user block}}<br /> |-<br /> {{tbl-cell|row=45|content=runCommand=}}<br /> {{tbl-cell|row=45|content=path to command}}<br /> {{tbl-cell|row=45|content=run the specified command within chroot of the installed system, after the installation is complete}}<br /> |-<br /> {{tbl-cell|row=46|content=runScript=}}<br /> {{tbl-cell|row=46|content=path to script}}<br /> {{tbl-cell|row=46|content=runs specified script within chroot of the installed system, after the installation is complete}}<br /> |-<br /> {{tbl-cell|row=47|content=runExtCommand=}}<br /> {{tbl-cell|row=47|content=path to command}}<br /> {{tbl-cell|row=47|content=runs a command outside the chroot}}<br /> |-<br /> {{tbl-cell|row=48|content=timeZone=}}<br /> {{tbl-cell|row=48|content=e.g. America/New_York}}<br /> {{tbl-cell|row=48|content=location must exist in ''/usr/share/zoneinfo/''}}<br /> |-<br /> {{tbl-cell|row=49|content=enableNTP=}}<br /> {{tbl-cell|row=49|content=yes or no}}<br /> {{tbl-cell|row=49|content=enable/disable NTP}}<br /> |-<br /> {{tbl-cell|row=50|content=localizeLang=}}<br /> {{tbl-cell|row=50|content=e.g. en}}<br /> {{tbl-cell|row=50|content=sets the system console and Desktop to the target language}}<br /> |-<br /> {{tbl-cell|row=51|content=localizeKeyLayout=}}<br /> {{tbl-cell|row=51|content=e.g. en}}<br /> {{tbl-cell|row=51|content=updates the system's Xorg config to set the keyboard layout}}<br /> |-<br /> {{tbl-cell|row=52|content=localizeKeyModel=}}<br /> {{tbl-cell|row=52|content=e.g. pc104}}<br /> {{tbl-cell|row=52|content=updates the system's Xorg config to set the keyboard model}}<br /> |-<br /> {{tbl-cell|row=53|content=localizeKeyVariant=}}<br /> {{tbl-cell|row=53|content=e.g. intl}}<br /> {{tbl-cell|row=53|content=updates the Xorg config to set the keyboard variant}}<br /> |-<br /> {{tbl-cell|row=54|content=autoLoginUser=}}<br /> {{tbl-cell|row=54|content=username}}<br /> {{tbl-cell|row=54|content=user will be logged in automatically without entering a password}}<br /> |}<br /> <br /> == Create a customized configuration ==<br /> <br /> One way to create this file is to read through the configuration examples in ''/usr/share/examples/pc-sysinstall/'' to find the one that most closely matches your needs. Copy that file (to any location) and customize it so that it includes the variables and values you would like to use in your installation.<br /> <br /> An alternate way to create this file is to perform an installation of the version that you wish to customize. The installer will automatically create a file containing the settings you selected during the installation to ''/root/pc-sysinstall.cfg.'' You can use that configuration file as-is or customize it to meet an installation's needs. This method may prove easier to use if you are performing complex disk layouts.<br /> <br /> If you wish to perform a fully automated installation that does not prompt for any user input, you will also need to review ''/usr/share/examples/pc-sysinstall/pc-autoinstall.conf'' and place a customized copy of that file into ''/boot/pc-autoinstall.conf'' on your installation media.<br /> <br /> Table 5.4b summarizes the additional variables that are available for fully automatic installations. More detailed descriptions can be found in the ''/usr/share/examples/pc-sysinstall/pc-autoinstall.conf'' file. Note that the variables in this file use a different syntax than those in Table 5.4a in that the values follow a colon and space rather than an equal sign.<br /> <br /> '''Table 5.4b.: Additional Variables for Automated Installations'''<br /> <br /> {{tbl-init}}<br /> {{tbl-title|Variable}}<br /> {{tbl-title|Options}}<br /> {{tbl-title|Description}}<br /> |-<br /> {{tbl-cellw|pc_config}}<br /> {{tbl-cellw|URL or /path/to/file}}<br /> {{tbl-cellw|location of customized ''pc-sysinstall.conf''}}<br /> |-<br /> {{tbl-cellg|confirm_install}}<br /> {{tbl-cellg|yes or no}}<br /> {{tbl-cellg|should be set to yes, otherwise booting the wrong disk will result in a system wipe}}<br /> |-<br /> {{tbl-cellw|shutdown_cmd}}<br /> {{tbl-cellw|e.g. '''shutdown -p now'''}}<br /> {{tbl-cellw|good idea to run a shutdown, but can be any command/script you wish to execute post-install}}<br /> |-<br /> {{tbl-cellg|nic_config}}<br /> {{tbl-cellg|dhcp-all or &lt;interface name&gt; &lt;IP address&gt; &lt;subnet mask&gt;}}<br /> {{tbl-cellg|will attempt dhcp on all found NICs until the installation file can be fetched or will setup specified interface}}<br /> |-<br /> {{tbl-cellw|nic_dns}}<br /> {{tbl-cellw|IP address}}<br /> {{tbl-cellw|DNS server to use}} <br /> |-<br /> {{tbl-cellg|nic_gateway}}<br /> {{tbl-cellg|IP address}}<br /> {{tbl-cellg|default gateway to use}}<br /> |-<br /> |}<br /> <br /> === Sample pc-sysinstall.cfg ===<br /> &lt;nowiki&gt;<br /> # Sample configuration file for an installation using pc-sysinstall<br /> <br /> installMode=fresh<br /> installInteractive=no<br /> hostname=myhost.mydomain.com<br /> <br /> # Set the disk parameters - 1st disk<br /> disk0=da0<br /> partition=all<br /> bootManager=none<br /> commitDiskPart<br /> <br /> # Set the disk parameters - 2nd disk<br /> disk1=da1<br /> partition=all<br /> bootManager=none<br /> commitDiskPart<br /> <br /> # Setup the disk label - 1st disk<br /> # All sizes are expressed in MB<br /> # Avail FS Types, UFS, UFS+S, UFS+J, ZFS, SWAP<br /> disk0-part=UFS+S 1024 / <br /> disk0-part=SWAP.eli 2048 none<br /> disk0-part=UFS+S 1024 /tmp<br /> disk0-part=UFS+S 1024 /var<br /> disk0-part=UFS+S 0 /usr<br /> # Size 0 means use the rest of the slice size<br /> # Do it now!<br /> commitDiskLabel<br /> <br /> # Setup the disk label - 2nd disk<br /> # All sizes are expressed in MB<br /> # Avail FS Types, UFS, UFS+S, UFS+J, ZFS, SWAP<br /> disk1-part=UFS+S 1024 /usr/src <br /> disk1-part=UFS+S 4096 /usr/local<br /> disk1-part=UFS+S 0 /usr/ports<br /> # Size 0 means use the rest of the slice size<br /> # Do it now!<br /> commitDiskLabel<br /> <br /> netDev=em1<br /> netIP=172.16.80.250<br /> netMask=255.255.240.0<br /> netNameServer=172.16.80.1<br /> netDefaultRouter=172.16.80.1<br /> netSaveDev=em0 em1 <br /> netSaveIP_em0=192.168.101.42<br /> netSaveIP_em1=172.16.80.156<br /> netSaveMask_em0=255.255.252.0<br /> netSaveMask_em1=255.255.240.0<br /> netSaveNameServer=172.16.80.1<br /> netSaveDefaultRouter=192.168.100.1<br /> <br /> # Set if we are installing via optical, USB, or FTP<br /> installType=FreeBSD<br /> installMedium=ftp<br /> ftpPath=http://pkgbuilder.mydomain.com/images/freebsd/8.2/<br /> packageType=tar<br /> <br /> # List our components to install<br /> #installComponents=ports,src<br /> <br /> # Set the root pass<br /> rootPass=root<br /> <br /> # Setup our users<br /> userName=demo<br /> userComment=Demo User<br /> userPass=demo<br /> userShell=/bin/sh<br /> userHome=/home/demo<br /> commitUser<br /> <br /> # Set up date/time<br /> runCommand=cp /usr/share/zoneinfo/EST5EDT /etc/localtime<br /> runCommand=touch /etc/wall_cmos_clock<br /> runCommand=adjkerntz -a<br /> <br /> # Install packages required for VMware Tools installation/configuration<br /> runCommand=pkg_add -r compat6x-amd64<br /> runCommand=pkg_add -r perl<br /> runCommand=pkg_add -r pcre<br /> runCommand=pkg_add -r puppet<br /> runCommand=pkg_add -r sysrc<br /> <br /> # Fetch/install VMware Tools<br /> runCommand=fetch -o /tmp/vmtools.tar.gz http://pkgbuilder.mydomain.com/images/freebsd/vmware-freebsd-tools.tar.gz<br /> runCommand=zcat /tmp/vmtools.tar.gz | tar -C /tmp -xvf -<br /> runCommand=/tmp/vmware-tools-distrib/vmware-install.pl -d<br /> runCommand=rm -rf /tmp/vmware-tools-distrib<br /> runCommand=/usr/local/sbin/sysrc puppet_enable=YES<br /> # Generate the certificate to be signed by the master<br /> runCommand=/usr/local/bin/puppet agent -t<br /> &lt;/nowiki&gt;<br /> <br /> === Sample pc-autoinstall.conf ===<br /> <br /> &lt;nowiki&gt;<br /> # pc-autoinstall.conf example<br /> #<br /> # Usage: Modify these variables, and copy the file to<br /> # /boot/pc-autoinstall.conf on your PC-BSD installation medium<br /> #<br /> # The conf will then be read at bootup, and your automated<br /> # install will take place<br /> ##################################################################<br /> <br /> # Where the pc-sysinstall main config is located<br /> # Can be either a file on the booted CD / DVD / USB media,<br /> # or a remote file on http / ftp<br /> #<br /> # The value %%NIC_MAC%% is special, and will be substituted with<br /> # the macaddress of the enabled NIC from DHCP or manually set<br /> # with 'nic_config:'<br /> ##################################################################<br /> <br /> # Examples:<br /> # pc_config: ftp://192.168.0.2/cust-install.cfg<br /> # pc_config: http://192.168.0.2/cust-install.cfg<br /> # pc_config: http://192.168.0.2/%%NIC_MAC%%.cfg<br /> # pc_config: /boot/cust-install.cfg<br /> pc_config:<br /> http://pkgbuilder.mydomain.com/images/freebsd/pc-sysinstall.cfg<br /> <br /> # Set this to yes if we should confirm before doing an install<br /> # This should normally be set to yes, otherwise booting the wrong<br /> # disk will result in a system wipe<br /> confirm_install: no<br /> <br /> # Set the command to run post-install, usually best to run shutdown<br /> # but this can be replaced with any other command / script you wish<br /> # to execute post-install<br /> shutdown_cmd: shutdown -r now<br /> <br /> # Options for the network setup, should the cfg need to be fetched<br /> # from a remote location, only necessary when using ftp or http<br /> ##################################################################<br /> <br /> # Special option, will attempt dhcp on all found NICs<br /> # until the file can be fetched, or we run out of interfaces<br /> # nic_config: dhcp-all<br /> <br /> # Line to be passed to the &quot;ifconfig&quot; command to bring up an interface<br /> nic_config: em1 172.16.80.250 255.255.240.0<br /> <br /> # DNS server to use<br /> nic_dns: 172.16.80.1<br /> <br /> # Default router / gateway<br /> nic_gateway: 172.16.80.1<br /> &lt;/nowiki&gt;<br /> <br /> == Create a custom installation media ==<br /> <br /> The installation media can be a CD, DVD, USB, or a directory on an HTTP, FTP, or SSH+rsync server.<br /> <br /> The easiest way to create a custom installation media is to modify an existing installation image. For example, if you have downloaded an ISO for the PC-BSD® version that you wish to customize, the superuser can access the contents of the ISO as follows:<br /> <br /> '''mdconfig -a -t vnode -f PCBSD9.0-x86-DVD.iso -u 1'''<br /> '''mount -t cd9660 /dev/md1 /mnt'''<br /> <br /> Make sure you have '''cd''' 'd into a directory where you would like to copy the contents of the ISO. In the following examples, ''/tmp/custominstall/'' was created for this purpose:<br /> <br /> '''cd /tmp/custominstall'''<br /> '''tar -C /mnt -cf - . | tar -xvf -'''<br /> '''umount /mnt'''<br /> <br /> Alternately, if you have inserted an installation CD or DVD, you can mount the media and copy its contents to your desired directory:<br /> <br /> '''mount -t cd9660 /dev/cd0 /mnt'''<br /> '''cp -R /mnt/* /tmp/custominstall/'''<br /> '''umount /mnt'''<br /> <br /> '''NOTE:''' if you are using an HTTP, FTP, or SSH server as the installation media, untar or copy the files to a directory on the server that is accessible to users. Be sure to configure the server so that the installation files are accessible to the systems that you wish to install.<br /> <br /> If you are creating an automated installation, copy your customized ''pc-autoinstall.conf'' to ''/tmp/custominstall/boot/''.<br /> <br /> Copy your customized configuration file to ''/tmp/custominstall/''. Double-check that the installMedium= variable in your customized configuration file is set to the type of media that you will be installing from.<br /> <br /> You may also need to add some extra files if you set the following variables in your custom configuration file:<br /> <br /> * '''installComponents=''' make sure that any extra components you wish to install exist in ''extras/PBI/'' (if they end in the ''.pbi'' extension) or ''extras/components/'' (if they end in ''.tbz'')<br /> <br /> * '''runCommand=''' make sure the command exists in the specified path<br /> <br /> * '''runScript=''' make sure the script exists in the specified path<br /> <br /> * '''runExtCommand=''' make sure the command exists in the specified path<br /> <br /> If the installation media is a CD or DVD, you will need to create a bootable media that contains the files in your directory. To create a bootable ISO:<br /> <br /> '''cd /tmp/custominstall<br /> '''mkisofs -V mycustominstall -J -R -b boot/cdboot -no-emul-boot -o myinstall.iso'''<br /> <br /> You can then use your favorite burning utility to burn the ISO to the media.<br /> <br /> To begin an installation that requires user interaction:<br /> <br /> '''pc-sysinstall -c /path_to_your_config_file'''<br /> <br /> To begin a fully automated installation, insert the installation media and reboot.<br /> <br /> In a PXE boot environment, '''cp''' your ''pc-sysinstall.conf'' file to ''/boot/'' on the [[Thin_Client#Creating_a_PXE_Boot_Install_Server | PXE Boot Install Server]]. Then, setup a call in ''/etc/rc.local'' that runs this command:<br /> <br /> '''pc-sysinstall start-autoinstall /boot/pc-autoinstall.conf'''<br /> <br /> That will start the installation process, fetch your main configuration file, and perform the actual installation.<br /> <br /> == Additional Resources ==<br /> <br /> * Installing FreeBSD with pc-sysinstall: pages 26-28, {{citelink|url=http://bsdmag.org/magazine/1741-nanobsd-and-alix/|txt=June 2011 issue of BSD Mag}}<br /> <br /> &lt;noinclude&gt;{{refheading}}&lt;/noinclude&gt;<br /> &lt;noinclude&gt;<br /> [[category:handbook]]<br /> [[category:Advanced Installation Topics]]<br /> [[category:Creating an Automated Installation with pc-sysinstall]]<br /> &lt;/noinclude&gt;</div>

Krismoore http://wiki.pcbsd.org/index.php/PBI_Manager 2012-09-24T14:30:31Z

<p>Krismoore: /* Release History */</p> <hr /> <div>&lt;noinclude&gt;{{NavHeader|back=Using AppCafe®|forward=Update Manager}}&lt;/noinclude&gt;<br /> <br /> PBI Manager is a suite of command line utilities which can be used to install, remove, create and manage PBIs. It is also available for [[#Installing PBI Manager|FreeBSD systems]]. The PBI Manager is released under the {{citelink|url=http://www.freebsd.org/copyright/freebsd-license.html|txt=BSD license}}.<br /> <br /> == Features ==<br /> <br /> The 9.x PBI format introduced the following features:<br /> <br /> * '''Upgrade deltas:''' since PBIs are self-contained, installation files tend to be large. In the previous implementation, updating a PBI required the re-downloading of the entire installation archive. For larger applications this could be a time-consuming process, especially over low bandwidth connections. The new PBI specification performs updates using binary diff patches known as PBP (Push Button Patch) files. PBPs are a fraction of the PBI's size; in some cases less than 5% of the original PBI archive. An upgrade automatically checks for for the presence of a PBP file and attempts to use it, only falling back to the original archive should the process fail.<br /> <br /> * '''Library and file sharing:''' in the previous implementation of the PBI format it was common that identical files existed between various applications. These duplicates, while necessary to provide the self-contained functionality, wasted both disk space and runtime memory. This waste of space has been greatly reduced through the use of a hash-dir directory where libraries and common files are shared through a system of hard links. When an identical file is found in a PBI, the original will be removed and a hard-link stored in the hash-dir. After a PBI has been removed, any unneeded files left in the hash-dir are cleaned up by the pbid(8) daemon which monitors and maintains the integrity of the shared files.<br /> <br /> * '''Repository management:''' allows administrators and PBI builders to create and manage their own repositories of PBIs. This repository system provides a number of tools for PBI distribution, release management, and repository browsing. <br /> <br /> * '''Digitally signed PBIs:''' each repository includes an openssl public key file which is installed on the end user's system. Each PBI includes several signatures for the content archive and installation and removal scripts. During the PBI installation process, these signatures are checked to confirm that the archive has not been tampered with during transit. This key file is also used to associate a particular PBI with a parent repository for upgrade purposes, since it is possible that multiple repositories will have the same applications.<br /> <br /> * '''Root password not required:''' most applications can be installed and upgraded by regular user (non-root) accounts. This allows enhanced security in office or home situations, where users can now add/remove desktop applications without needing access to the root password. PBIs that impact on the security of the system (e.g. installing a web server) will require root access.<br /> <br /> * '''Implementation:''' the previous PBI design was developed in QT/KDE C++, making it inappropriate for use at the command line. The new format is implemented 100% in shell and is comprised of command-line utilities, each with an associated man page. These utilities are discussed in more detail in the rest of this section.<br /> <br /> == Additional Resources ==<br /> <br /> * {{citelink|url=http://www.pcbsd.org/~kris/pbi9-slides.pdf|txt=The PBI Format Re-implemented for Free/PC-BSD® (conference slides)}}<br /> <br /> * {{citelink|url=http://www.pcbsd.org/~kris/asiabsdcon2011-pbi9.pdf|txt=The PBI Format Re-implemented for Free/PC-BSD® (formal paper)}}<br /> <br /> * [[PBI9 Format|The PBI Format for 9.0 and Beyond]]<br /> <br /> == Release History ==<br /> <br /> ; 1.0: ({{#dateformat:24 Sept 2012}}) - Kris Moore<br /> <br /> :* Fix build with CLANG<br /> <br /> :* Add support for shared XDG / Mime directories among users<br /> <br /> :* Enhance icons handling when adding to LOCALBASE<br /> <br /> :* Fixed a bug pruning the old version from an INDEX<br /> <br /> :* Get rid of left-over .sha256 files in auto-build directories<br /> <br /> ; 0.9.9: ({{#dateformat:27 Aug 2012}}) - Kris Moore<br /> <br /> :* Added new C .pbiwrapper file, which can set LD* variables, and use setuid among others<br /> <br /> :* Fixed issues doing pkg_add on pkgs which need license agreements<br /> <br /> :* Added support for saving / re-creating users &amp; groups that a port may need<br /> <br /> :* Fixed some issues getting the correct Package Name<br /> <br /> :* Fixed and issue using exclude lists<br /> <br /> :* Added option to view archive contents with pbi_add -i -v<br /> <br /> :* Added internal priority system to pbi autobuilding<br /> <br /> :* Speed up build system with better package caching<br /> <br /> :* Added additional tmpfs support for auto-building, to further speed up process<br /> <br /> :* Auto-source /etc/profile, to catch any HTTP_PROXY / FTP_PROXY values the user may set<br /> <br /> ; 0.9.8: ({{#dateformat:11 May 2011}}) - Kris Moore<br /> <br /> :* Add support for copying linux binaries from ports, with their respective libs<br /> <br /> :* Add GUI speed calculations when downloading<br /> <br /> :* Allow some overrides to built-in defaults, for FreeNAS / pfSense and others<br /> <br /> :* Added fail-safes to make sure the user didn't manually mount things into a PBI directory<br /> <br /> ; 0.9.7: ({{#dateformat:07 Dec 2011}}) - Kris Moore<br /> <br /> :* Use -a flag for fetch to retry after soft failures<br /> <br /> :* Do not create binary patch files, if they are larger than the source<br /> <br /> :* Add ability to use /etc/pbi-make.conf on system, letting us set universal make options<br /> <br /> :* Simplify the startup with less parsing commands<br /> <br /> :* Add new -R flag for pbi_add, which only downloads a PBI from a mirror, without installing it<br /> <br /> :* Add support for using &quot;ccache&quot; automatically if configured on the host system<br /> <br /> :* Fixed a bug using &quot;pbi_create&quot; on a directory manually, make sure file end up in proper PBI application directory<br /> <br /> :* Make sure we use the systems share/icons directory to use shared cursors / icons across all PBIs<br /> <br /> ; 0.9.6: ({{#dateformat:07 Nov 2011}})<br /> <br /> :* Fix some bugs doing cleanup of stagedir / build directories<br /> <br /> :* Properly kill fetch process when canceling a download<br /> <br /> :* Improve buildworld on FreeBSD to use /usr/src if it already has source<br /> <br /> :* Fix some random warnings when building via sudo<br /> <br /> ; 0.9.5: ({{#dateformat:03 Nov 2011}})<br /> <br /> :* Add sizes of PBIs to the meta index files<br /> <br /> :* Fix bug adding default icon to PBIs when none is specified<br /> <br /> :* Fix handling of PBI_PROGREVISION<br /> <br /> :* Make sure we unmount nullfs mounts completely<br /> <br /> ; 0.9.4: ({{#dateformat:19 Oct 2011}})<br /> <br /> :* Fix issue using system-fonts in PBIs<br /> <br /> :* Fix issue removing files which have been set r--<br /> <br /> :* Slow down fetch process to fix issues with fetch protocol errors<br /> <br /> :* Fix bug coping linux libraries into final PBI file<br /> <br /> :* Allow user settings in external-links to overwrite auto-detected values<br /> <br /> :* Fix bug running &quot;stat&quot; on files with spaces in name<br /> <br /> :* Validate the build checksum before doing patching<br /> <br /> :* Speed up builds with optional --tmpfs flags<br /> <br /> :* Add priority system to building modules<br /> <br /> :* Fix issues setting proxy support from pbi.conf / pcbsd.conf files<br /> <br /> :* Validate repo URL's when creating .rpo file<br /> <br /> ; 0.9.3: ({{#dateformat:18 Jul 2011}})<br /> <br /> :* Unset variables between auto-builds<br /> <br /> :* Fixed some warnings with 'cut' when parsing i18n strings<br /> <br /> :* When doing auto-builds, run through alphabetically<br /> <br /> :* Increase check frequency when first trying to download index's<br /> <br /> :* Speed up the hashdir merging<br /> <br /> :* Show repo MD5 with listings<br /> <br /> :* If no index files, do not fail on listing, just show empty repo<br /> <br /> ; 0.9.2: ({{#dateformat:23 May 2011}})<br /> <br /> :* Fixed usage errors with &quot;tr&quot;<br /> <br /> :* Syntax fixes when trying to install app with no meta-data<br /> <br /> :* Fixed some bugs with binary patching<br /> <br /> :* Fixed auto-builder using the PBI_BUILDKEY in modules pbi.conf file<br /> <br /> :* When building ports, do not export PREFIX since it confuses some linux ports<br /> <br /> :* Perform check if user is root, if PBI is flagged root-only<br /> <br /> :* Auto-builder now checks if port is compatible with arch type of system<br /> <br /> ; 0.9.1: ({{#dateformat:3 May 2011}})<br /> <br /> :* Initial public release<br /> <br /> == What is the PBI format? ==<br /> <br /> One of the things holding back mainstream adoption of open source desktops is the package management format. With almost all open source desktops, software is simply treated as part of the operating system. Thus, when performing an update of some seemingly trivial application, you run the risk of potentially needing to upgrade other packages which could break other critical parts of your desktop. <br /> <br /> While package management systems have gotten better at resolving dependency issues, trying to fix conflicts to prevent breakage before it occurs, they still do not address the underlying problem: every software package is a part of the system, and pulling on any one thread has the potential of causing a break somewhere farther down the line.<br /> <br /> The PBI format tries to correct this underlying flaw. Rather than making every application a part of the base system, PBIs are self-contained, including their own dependent library tree and related data. As a result, when you install a PBI there are no dependency issues to resolve, and applications can be added or removed freely, without fear of causing breakage to the desktop or any other installed software.<br /> <br /> == Installing PBI Manager ==<br /> <br /> If you are running PC-BSD® 9 or higher, then the PBI Manager is already installed, and you can use it via the command-line, or a front-end such as the AppCafe®. <br /> <br /> FreeBSD users can install it from the {{citelink|url=http://www.freshports.org/ports-mgmt/pbi-manager|txt=ports tree}}. <br /> <br /> Users interested in installing the development version from our {{citelink|url=http://trac.pcbsd.org/brower/pcbsd/current/src-sh/pbi-manager/|txt=SVN repository}} can do so with the following commands: &lt;!-- Is this still relevant or was this for pre-v9.0? --&gt;<br /> <br /> '''svn co &lt;nowiki&gt;svn://svn.pcbsd.org/pcbsd/current/src-sh/pbi-manager&lt;/nowiki&gt;'''<br /> '''cd pbi-manager'''<br /> '''make install'''<br /> <br /> '''NOTE: The development version may be unstable / buggy, use at your own risk'''<br /> <br /> == Getting PBI Files ==<br /> <br /> A list of approved and available PBIs can be viewed with '''pbi_info -i''' or '''pbi_browser''', and then installed with '''pbi_add -r &lt;pbiname&gt;'''. <br /> <br /> '''NOTE:''' PBI files previously created for PC-BSD® 7.x/8.x will NOT work with PBI Manager as it was designed for version 9.x.<br /> <br /> == Underlying File / Directory Structure ==<br /> <br /> <br /> The underlying files and directories used by PBI Manager are as follows:<br /> <br /> * '''/usr/local/etc/pbi.conf''': location of the PBI Manager configuration file <br /> <br /> * '''/usr/pbi/''': where PBIs are installed on the system<br /> <br /> * '''/var/db/pbi/''': contains data files related to installed PBIs and repositories <br /> <br /> * '''/usr/local/sbin/pbi_*''': location of the PBI Manager commands<br /> <br /> * '''/usr/local/share/pbi-manager/module-examples/convertoldmod.sh''': script which can be used to convert an existing 7.x or 8.x PBI module to the new 9.x format<br /> <br /> == Feedback / Reporting Problems ==<br /> <br /> Feedback, problem reports, and general discussion are welcome on the {{citelink|url=http://lists.pcbsd.org/mailman/listinfo/pbi-dev|txt=PBI Developers Mailing list}}.<br /> <br /> == Command Reference ==<br /> <br /> The following commands are installed by PBI Manager. For more details, refer to that command's man page.<br /> <br /> === pbi_add(1) ===<br /> <br /> Similar to FreeBSD's '''pkg_add''', the '''pbi_add''' command is used for adding/installing PBIs on a system, either from a local file or remotely from a repository. This utility supports the options listed in Table 7.2a.<br /> <br /> '''Table 7.2a: pbi_add Options'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> &lt;!-- row 1 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-e'''}}<br /> {{Tbl-line|bg=ff|align=left|extract only, do not install; will extract the archive to ''~/&lt;pbidirname&gt;'' unless the '''-o''' option is used}}<br /> |-<br /> &lt;!-- row 2 --&gt;<br /> {{Tbl-line|align=left|'''-f'''}}<br /> {{Tbl-line|align=left|force installation, overwriting an already installed copy of the application}}<br /> |- <br /> &lt;!-- row 3 --&gt; <br /> {{Tbl-line|bg=ff|align=left|'''-g'''}}<br /> {{Tbl-line|bg=ff|align=left|show path to icons and images for GUI installations}}<br /> |-<br /> &lt;!-- row 4 --&gt; <br /> {{Tbl-line|bg=ee|align=left|'''-i'''}}<br /> {{Tbl-line|bg=ee|align=left|display information about specified PBI}}<br /> |-<br /> &lt;!-- row 5 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-l'''}} <br /> {{Tbl-line|bg=ff|align=left|display license for specified PBI}}<br /> |-<br /> &lt;!-- row 6 --&gt; <br /> {{Tbl-line|align=left|'''-o outdir'''}}<br /> {{Tbl-line|align=left|specify the directory to use when extracting the PBI with '''-e'''}}<br /> |-<br /> &lt;!-- row 7 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-r'''}}<br /> {{Tbl-line|bg=ff|align=left|remote fetch installation file from update server; the system architecture and version will be automatically determined in order to fetch the correct file}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-R'''}}<br /> {{Tbl-line|bg=ff|align=left|remote fetch the install file from the update server but do not install}}<br /> |-<br /> &lt;!-- row 8 --&gt;<br /> {{Tbl-line|align=left|'''-v'''}}<br /> {{Tbl-line|align=left|enable verbose output}}<br /> |-<br /> &lt;!-- row 9 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''--checkscript'''}}<br /> {{Tbl-line|bg=ff|align=left|display any custom scripts used in the installation/removal of the PBI}}<br /> |-<br /> &lt;!-- row 10 --&gt;<br /> {{Tbl-line|align=left|'''--licagree'''}}<br /> {{Tbl-line|align=left|agree to license terms and conditions; to view the license, use '''-l'''}}<br /> |-<br /> &lt;!-- row 11 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''--no-checksig'''}}<br /> {{Tbl-line|bg=ff|align=left|skip the openssl signature verification of the PBI data}}<br /> |-<br /> &lt;!-- row 12 --&gt;<br /> {{Tbl-line|align=left|'''--no-checksum'''}}<br /> {{Tbl-line|align=left|skip the checksum verification of the archive data}}<br /> |-<br /> &lt;!-- row 13 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''--no-hash'''}}<br /> {{Tbl-line|bg=ff|align=left|disable using the shared hash dir}}<br /> |-<br /> &lt;!-- row 14 --&gt;<br /> {{Tbl-line|align=left|'''--repo repoid'''}}<br /> {{Tbl-line|align=left|specify which repository to use}}<br /> |-<br /> &lt;!-- row 15 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''--rArch arch'''}}<br /> {{Tbl-line|bg=ff|align=left|manually specify the PBI architecture type of i386 or amd64}}<br /> |-<br /> &lt;!-- row 16 --&gt;<br /> {{Tbl-line|align=left|'''--rVer version'''}}<br /> {{Tbl-line|align=left|specify which version of the PBI to install}}<br /> |-<br /> |}<br /> <br /> For security reasons, it is recommend that users first use the '''-e''' and '''--checkscript''' options to view archive contents and installation scripts prior to installing a PBI file.<br /> <br /> To install a PBI, use: '''pbi_add -r PBINAME'''. The following example will install the alpine PBI:<br /> <br /> '''pbi_add -r alpine'''<br /> Downloading ftp://ftp.pcbsd.org/pub/mirror/PBI/mail/alpine/9/x32/alpine-2.00_3-i386.pbi<br /> /usr/pbi/.alpine-2.00_3-i386.pbi.42391 100% of 11 MB 295 kBps 00m00s<br /> Verifying Checksum...OK<br /> Extracting to: /usr/pbi/alpine-i386<br /> Installed: Alpine-2.00_3<br /> <br /> === pbi_addrepo(8) ===<br /> <br /> The '''pbi_addrepo''' command is used to register a new PBI repository on a system. If the '''pbid''' daemon is running, the repository's index and meta files will be automatically fetched and made ready for browsing. The command has one argument: the name of the repository file. Repository files have a ''.rpo'' extension and are created with the '''pbi_makerepo''' command.<br /> <br /> === pbi_autobuild(8) ===<br /> <br /> The '''pbi_autobuild''' command is used on the PBI build system to build any out-of-date or new packages. It can traverse the FreeBSD ports and metadata trees, building missing PBI files or PBIs in which the target port version has been updated. Instructions for using this command to keep a custom repository up-to-date can be found in the section [[Create Your Own PBI Repository#Configure the Automatic Build of Updated Ports|Configure the Automatic Build of Updated Ports]].<br /> <br /> Table 7.2b summarizes this command's options:<br /> <br /> '''Table 7.2b: pbi_autobuild Options'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> &lt;!-- row 1 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-c confdir'''}}<br /> {{Tbl-line|bg=ff|align=left|mandatory; specify the directory containing the PBI configuration modules; any found ''pbi.conf'' files will be parsed, and if PBI_MAKEPORT is set, the target port will be used for the build; if PBI_MAKEPORT is unset, the auto-build will attempt to match the module to a FreeBSD port based upon the dirname of ''pbi.conf''}}<br /> |-<br /> {{Tbl-line|align=left|'''-d portsdir'''}}<br /> {{Tbl-line|align=left|specify an alternative ports directory; defaults to ''/usr/ports/''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-h script'''}}<br /> {{Tbl-line|bg=ff|align=left|specify a helper script to call after building a PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''-o outdir'''}}<br /> {{Tbl-line|align=left|mandatory; the directory to place the finished PBI files}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--genpatch'''}}<br /> {{Tbl-line|bg=ff|align=left|when building a new PBI, check for archived copies and generate smaller patch updates to the new version (*.pbp files)}}<br /> |-<br /> {{Tbl-line|align=left|'''--keep num'''}}<br /> {{Tbl-line|align=left|when building new PBIs, keep &lt;num&gt; copies of past versions of working PBI in ''&lt;outdir&gt;/archived/'' folder; these archived copies can be used with the '''--genpatch''' command to generate update patch files}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--pkgcache'''}}<br /> {{Tbl-line|bg=ff|align=left|enable caching of ''.txz'' pkg files which greatly speeds up subsequent builds of a PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''--prune'''}}<br /> {{Tbl-line|align=left|remove any PBIs which no longer have an associated module}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--tmpfs'''}}<br /> {{Tbl-line|bg=ff|align=left|automatically create and mount a tmp filesystem which can speed up port compiles on systems with available RAM}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|digitally sign the PBI file with the specified openssl private key file}}<br /> |-<br /> |}<br /> <br /> === pbi_browser(1) ===<br /> <br /> The '''pbi_browser''' command provides a CLI front-end to browsing a repository's available PBIs. Options for viewing categories and searching by keyword are available, and once the desired PBI is located, it will show the '''pbi_add''' command which can be used to install the application. Table 7.2c summarizes the available options.<br /> <br /> '''Table 7.2c: pbi_browser Options'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-c category'''}}<br /> {{Tbl-line|bg=ff|align=left|displays a list of PBIs in the specified category}}<br /> |-<br /> {{Tbl-line|align=left|'''-s search'''}}<br /> {{Tbl-line|align=left|search for PBIs containing the specified string in the name, description, or keywords}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--listcats'''}}<br /> {{Tbl-line|bg=ff|align=left|list the available categories}}<br /> |-<br /> {{Tbl-line|align=left|'''--viewall'''}}<br /> {{Tbl-line|align=left|list all available PBIs}}<br /> |-<br /> |}<br /> <br /> === pbi.conf(5) ===<br /> <br /> ''pbi.conf'' is an ASCII text configuration file containing values that are used by the various '''pbi_*''' commands. The proxy variables are only needed if the system uses a proxy server to access the Internet. Table 7.2d lists the supported variables.<br /> <br /> '''Table 7.2d: pbi_conf Variables'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=20%|'''Variable'''}}<br /> {{Tbl-title|width=80%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|PBID_REFRESH}}<br /> {{Tbl-line|bg=ff|align=left|wakeup time in seconds for '''pbid''' to run its checks}}<br /> |-<br /> {{Tbl-line|align=left|PBI_INDEXREFRESH}}<br /> {{Tbl-line|align=left|number of hours representing how often '''pbid''' refreshes the index and meta files from repos; default is every 24 hours}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|PBI_PROXYURL}}<br /> {{Tbl-line|bg=ff|align=left|proxy server IP address}}<br /> |-<br /> {{Tbl-line|align=left|PBI_PROXYPORT}}<br /> {{Tbl-line|align=left|proxy server port number}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|PBI_PROXYTYPE}}<br /> {{Tbl-line|bg=ff|align=left|can be HTTP or SOCKS5}}<br /> |-<br /> {{Tbl-line|align=left|PBI_PROXYUSER}}<br /> {{Tbl-line|align=left|username used to authenticate with proxy server}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|PBI_PROXYPASS}}<br /> {{Tbl-line|bg=ff|align=left|password used to authenticate with proxy server}}<br /> |-<br /> |}<br /> <br /> === pbi_create(1) ===<br /> <br /> The '''pbi_create''' command provides a way for packagers to manually specify a target directory to be compressed into a PBI file. The option '''-b''' can also be used to re-package an already installed PBI back to an archive. PBI creators are encouraged to send a tarball of the resulting PBI module to the {{citelink|url=http://lists.pcbsd.org/mailman/listinfo/pbi-dev|txt=PBI-testing mailing list}} so they can be added to the PC-BSD® PBI repository and made available to other PC-BSD® users.<br /> <br /> Table 7.2e summarizes the available options:<br /> <br /> '''Table 7.2e: pbi_create Options'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-a author'''}}<br /> {{Tbl-line|bg=ff|align=left|specify the author for this PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''-b'''}}<br /> {{Tbl-line|align=left|make a backup of an installed PBI; specify the target PBI name instead of the PBI directory}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-c confdir'''}}<br /> {{Tbl-line|bg=ff|align=left|specify the metadata configuration directory; while not required it is highly recommended as metadata is required to create icons and binary entry-points}}<br /> |-<br /> {{Tbl-line|align=left|'''-d portsdir'''}}<br /> {{Tbl-line|align=left|specify an alternative ports directory; defaults to ''/usr/ports/''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-i icon'''}}<br /> {{Tbl-line|bg=ff|align=left|specify a default icon, relative to ''pbidir/''}}<br /> |-<br /> {{Tbl-line|align=left|'''-n name'''}}<br /> {{Tbl-line|align=left|specify a name for this PBI}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-o outdir'''}}<br /> {{Tbl-line|bg=ff|align=left|place the finished ''.pbi'' file into the specified directory; defaults to $HOME}}<br /> |-<br /> {{Tbl-line|align=left|'''-p port'''}}<br /> {{Tbl-line|align=left|use the given port to get PBI name and version}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-r version'''}}<br /> {{Tbl-line|bg=ff|align=left|specify a version for this PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''-u weburl'''}}<br /> {{Tbl-line|align=left|specify a website URL for the PBI}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--no-hash'''}}<br /> {{Tbl-line|bg=ff|align=left|disable using the shared hash directory which uses hard links to share files between applications}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|digitally sign the PBI file with the specified openssl private key file}}<br /> |-<br /> |}<br /> <br /> As the superuser, you can create a PBI with the '''pbi_create''' command using the following syntax:<br /> <br /> '''pbi_create -a &lt;author&gt; -n &lt;name&gt; -r &lt;version&gt; -w &lt;weburl&gt; &lt;target directory&gt;'''<br /> <br /> Inside the target directory place the application's binaries or scripts along with any required dependencies. To indicate which file(s) represent the runtime command(s), include a file named ''external-links'' in the target directory. That file contains an entry for each command, as seen in the following example:<br /> <br /> # Files to be symlinked into the default LOCALBASE<br /> # One per-line, relative to %%PBI_APPDIR%% and LOCALBASE<br /> # Defaults to keeping any existing files in LOCALBASE<br /> # Use bin-files/ for binaries that need wrapper functionality<br /> <br /> # TARGET LINK IN LOCALBASE ACTION<br /> bin/myapp bin/myapp binary,nocrash<br /> <br /> This entry instructs '''pbi_create''' to make the wrapper scripts for the ''myapp'' binary, along with placing it in the user's PATH at install time.<br /> <br /> It is also possible to include desktop icons and mime entries using the ''xdg-mime/'', ''xdg-desktop/'' and ''xdg-menu/'' directories. The section on how to [[Create PBIs]] contains more details about creating these files. These directories should be created as subdirectories of the target directory of your application.<br /> <br /> === pbi_delete(1) ===<br /> <br /> Similar to FreeBSD's '''pkg_delete''', the '''pbi_delete''' command removes an installed PBI from the system. It also schedules cleaning for the shared library directory, which is performed by '''pbid'''. Table 7.2f summarizes its options:<br /> <br /> '''Table 7.2f: pbi_delete Options'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-v'''}}<br /> {{Tbl-line|bg=ff|align=left|enable verbose output}}<br /> |-<br /> {{Tbl-line|align=left|'''--clean-hdir'''}}<br /> {{Tbl-line|align=left|perform a full cleaning of the shared hash directory, removing any unused files; should only be required after a system crash or failure in removing a PBI}}<br /> |-<br /> |}<br /> <br /> When removing a PBI, you must give its full name. The full name can be found in the output of '''pbi_info'''. The following example searches for the ntop PBI and removes it:<br /> <br /> '''pbi_info | grep ntop'''<br /> ntop-4.0.1_1-i386<br /> '''pbi_delete -v ntop-4.0.1_1-i386'''<br /> Running pre-removal script: /var/db/pbi/installed/ntop-4.0.1_1-i386/pre-remove.sh<br /> Removing: /usr/pbi/ntop-i386<br /> Removing: /var/db/pbi/installed/ntop-4.0.1_1-i386<br /> <br /> === pbi_deleterepo(8) ===<br /> <br /> The '''pbi_deleterepo''' command can be used to remove a registered repository from the system. It takes the repository's ID as the only command argument.<br /> <br /> === pbi_icon(1) ===<br /> <br /> 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 {{citelink|url=http://en.wikipedia.org/wiki/Xdg|XDG}}-compliant to understand a PBI's icon and mime settings. Table 7.2g summarizes this command's options:<br /> <br /> '''Table 7.2g: pbi_icon Options'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add-desktop'''}}<br /> {{Tbl-line|bg=ff|align=left|installs desktop icon; should be run as regular user}}<br /> |-<br /> {{Tbl-line|align=left|'''add-mime'''}}<br /> {{Tbl-line|align=left|installs mime information; should be run as root}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add-menu'''}}<br /> {{Tbl-line|bg=ff|align=left|installs menu icons; should be run as root}}<br /> |-<br /> {{Tbl-line|align=left|'''add-pathlnk'''}}<br /> {{Tbl-line|align=left|installs any $PATH links to ''~/bin'' when run as user or to $LOCALBASE when run as root}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''del-desktop'''}}<br /> {{Tbl-line|bg=ff|align=left|removes desktop icon; should be run as regular user}}<br /> |-<br /> {{Tbl-line|align=left|'''del-menu'''}}<br /> {{Tbl-line|align=left|removes menu icons; should be run as root}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''del-mime'''}}<br /> {{Tbl-line|bg=ff|align=left|removes mime information; should be run as root}}<br /> |-<br /> {{Tbl-line|align=left|'''del-pathlnk'''}}<br /> {{Tbl-line|align=left|removes any $PATH links to ''~/bin'' when run as user or to $LOCALBASE when run as root}}<br /> |-<br /> |}<br /> <br /> === pbi_indextool(1) ===<br /> <br /> The '''pbi_indextool''' command is useful for repository maintainers. It allows PBI files to be added and removed from the repository's ''INDEX'' file. An example of using this command can be found in [[Create Your Own PBI Repository]]. Table 7.2h summarizes the available options:<br /> <br /> '''Table 7.2h: pbi_indextool Options'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Command'''}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=70%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add'''}}<br /> {{Tbl-line|bg=ff|align=left|'''-b vers'''}}<br /> {{Tbl-line|bg=ff|align=left|mark previous versions as having a binary diff patch (''.pbp'' file used for upgrading) available}}<br /> |-<br /> {{Tbl-line|align=left|'''add'''}}<br /> {{Tbl-line|align=left|'''-f pbifile'''}}<br /> {{Tbl-line|align=left|mandatory, name of PBI being added to the target ''INDEX'' file}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add'''}}<br /> {{Tbl-line|bg=ff|align=left|'''-k num'''}}<br /> {{Tbl-line|bg=ff|align=left|number of previous versions of this PBI to keep in the ''INDEX'' file}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add'''}}<br /> {{Tbl-line|bg=ff|align=left|'''-u fileurl'''}}<br /> {{Tbl-line|bg=ff|align=left|mandatory URL to PBI location on server in the format category/pbi_name}}<br /> |-<br /> {{Tbl-line|align=left|'''rem'''}}<br /> {{Tbl-line|align=left|'''-m arch'''}}<br /> {{Tbl-line|align=left|mandatory architecture type for PBI being removed (e.g. i386, amd64)}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''rem'''}}<br /> {{Tbl-line|bg=ff|align=left|'''-n pbiname'''}}<br /> {{Tbl-line|bg=ff|align=left|mandatory name of PBI being removed from the ''INDEX'' file}}<br /> |-<br /> {{Tbl-line|align=left|'''rem'''}}<br /> {{Tbl-line|align=left|'''-v version'''}}<br /> {{Tbl-line|align=left|mandatory, version of the PBI being removed from the ''INDEX'' file}}<br /> |-<br /> |}<br /> <br /> === pbi_info(1) ===<br /> <br /> Similar to FreeBSD's '''pkg_info''' command, the '''pbi_info''' command is used to determine which PBIs are currently installed. Table 7.2i summarizes the available options:<br /> <br /> '''Table 7.2i: pbi_info Options'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-a'''}}<br /> {{Tbl-line|bg=ff|align=left|list all PBIs installed on the system; same as running '''pbi_info''' without an argument}}<br /> |-<br /> {{Tbl-line|align=left|'''-i'''}}<br /> {{Tbl-line|align=left|list all available PBIs from any repo}} <br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-v'''}}<br /> {{Tbl-line|bg=ff|align=left|enable verbose output}}<br /> |-<br /> |}<br /> <br /> === pbi_listrepo(1) ===<br /> <br /> The '''pbi_listrepo''' command manages installed repositories on a system. Table 7.2j summarizes this command's options:<br /> <br /> '''Table 7.2j: pbi_listrepo Options'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--down'''}}<br /> {{Tbl-line|bg=ff|align=left|move the targeted repoID down a single number in priority}}<br /> |-<br /> {{Tbl-line|align=left|'''-mirror URL'''}}<br /> {{Tbl-line|align=left|change the specified repoID's mirror URL}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--up'''}}<br /> {{Tbl-line|bg=ff|align=left|move the targeted repoID up a single number in priority}}<br /> |-<br /> |}<br /> <br /> Run the command without any options to list the IDs of the available repositories.<br /> <br /> === pbi_makepatch(1) ===<br /> <br /> The '''pbi_makepatch''' command is automatically used by '''pbi_autobuild''' to create small ''*.pbp'' (Push Button Patch) files. These files can be downloaded to a user's system in order to update a PBI's version without re-downloading the entire archive. This allows users to download only the incremental changes when a PBI is upgraded. The command can also be run manually by providing two PBI archives to compare and generate a patch file for.<br /> <br /> Table 7.2k summarizes the available options:<br /> <br /> '''Table 7.2k: pbi_makepatch Options<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-o outdir'''}}<br /> {{Tbl-line|bg=ff|align=left|save the resulting ''*pbp'' file to the specified directory}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|use the specified openssl key to digitally sign the patch file}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--tmpfs'''}}<br /> {{Tbl-line|bg=ff|align=left|can reduce building time for large PBIs}}<br /> |-<br /> |}<br /> <br /> === pbi_makeport(1) ===<br /> <br /> The '''pbi_makeport''' command can be used by packagers to build a target FreeBSD port and convert it into a PBI file. Many options are provided to fine-tune the build process, and meta-data modules can also be specified to further improve the resulting PBI file. The first time this command is run, it will build a fresh chroot sandbox environment which can be used for clean-room building of the target port without affecting the host system. More details about how to create a PBI using this command, can be found in the [[PBI Module Builder Guide#Creating a New PBI with pbi makeport | ''PBI Module Builder Guide'']].<br /> <br /> '''NOTE:''' the '''pbi_makeport''' command has support for using {{citelink|url=http://www.freshports.org/devel/ccache/|txt=ccache}} to speed up the compile process. If '''ccache''' is installed on the host system and the CCACHE_DIR variable is set, the '''pbi_makeport''' command will automatically utilize it for the port compile phase. This can be disabled by setting NO_CCACHE=yes in ''/etc/pbi-make.conf'' on the host system, or as an optional make flag in a module's ''pbi.conf'' file. <br /> <br /> Table 7.2l summarizes the available options:<br /> <br /> '''Table 7.2l: pbi_makeport Options'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-B'''}}<br /> {{Tbl-line|bg=ff|align=left|build-only; generally used with '''-k''' to build a port before running '''pbi_create''' manually}}<br /> |-<br /> {{Tbl-line|align=left|'''-c confdir'''}}<br /> {{Tbl-line|align=left|specify the metadata configuration directory; while not required it is highly recommended as metadata is required to create icons and binary entry-points }}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-d portsdir'''}}<br /> {{Tbl-line|bg=ff|align=left|specify an alternative ports directory; defaults to ''/usr/ports''}}<br /> |-<br /> {{Tbl-line|align=left|'''-k'''}}<br /> {{Tbl-line|align=left|keep the build files after building the PBI}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-o outdir'''}}<br /> {{Tbl-line|bg=ff|align=left|the directory to place the finished PBI file; defaults to user's $HOME directory}}<br /> |-<br /> {{Tbl-line|align=left|'''-p prefix'''}}<br /> {{Tbl-line|align=left|manually provide a PREFIX which determines the location where the PBI will be installed on the end-user's system}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--delbuild'''}}<br /> {{Tbl-line|bg=ff|align=left|remove any existing build directories before starting the build}}<br /> |-<br /> {{Tbl-line|align=left|'''--mkdebug'''}}<br /> {{Tbl-line|align=left|will drop to a debugging shell should the port make fail}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--no-prune'''}}<br /> {{Tbl-line|bg=ff|align=left|disable auto-pruning of non-REQUIREDBY ports after the compile phase; by default any ports which are used solely for building and which are not required for program execution will be pruned}}<br /> |-<br /> {{Tbl-line|align=left|'''--pkgdir dir'''}}<br /> {{Tbl-line|align=left|uses the specified directory to cache the .txz package so subsequent builds will not rebuild the port from source<br /> }}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--tmpfs'''}}<br /> {{Tbl-line|bg=ff|align=left|automatically create and mount a tmp filesystem and use it for WRKDIRPREFIX; can speed up port compiles on systems with available RAM}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|digitally sign the PBI file with the specified openssl private key file}}<br /> |-<br /> |}<br /> <br /> === pbi_makerepo(1) ===<br /> <br /> The '''pbi_makerepo''' command allows repository maintainers to create a single ''*.rpo'' file containing various information about the new repository. This ''.rpo'' file can then be installed on the target system with '''pbi_addrepo'''. Table 7.2m summarizes the available options.<br /> <br /> '''Table 7.2m: pbi_makerepo Options'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--desc description'''}}<br /> {{Tbl-line|bg=ff|align=left|required; description of the repo to be shown in the repo list}}<br /> |-<br /> {{Tbl-line|align=left|'''--key keyfile'''}}<br /> {{Tbl-line|align=left|required; OpenSSL public key used to verify the digital signature of PBIs installed from this repo}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--mirror URL'''}}<br /> {{Tbl-line|bg=ff|align=left|required; URL in &lt;nowiki&gt;http://&lt;/nowiki&gt;, &lt;nowiki&gt;https://&lt;/nowiki&gt;, or &lt;nowiki&gt;ftp://&lt;/nowiki&gt; format to download PBIs and updates from}}<br /> |-<br /> {{Tbl-line|align=left|'''--url URL'''}}<br /> {{Tbl-line|align=left|required; URL in &lt;nowiki&gt;http://&lt;/nowiki&gt;, &lt;nowiki&gt;https://&lt;/nowiki&gt;, or &lt;nowiki&gt;ftp://&lt;/nowiki&gt; format to use when downloading the master ''INDEX'' file of available PBIs}}<br /> |-<br /> |}<br /> <br /> === pbi_metatool(1) ===<br /> <br /> The '''pbi_metatool''' command provides a way for repository maintainers to modify the PBI metadata in their repository in order to add or remove application categories or specified PBIs. An example of using this command can be found in [[Create Your Own PBI Repository]]. Table 7.2n summarizes the available options:<br /> <br /> '''Table 7.2n: pbi_metatool Options'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Command'''}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=70%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add''' or '''rem'''}}<br /> {{Tbl-line|bg=ff|align=left|'''--cat'''}}<br /> {{Tbl-line|bg=ff|align=left|indicates that a new category is being added to or removed from the target metafile}}<br /> |-<br /> {{Tbl-line|align=left|'''add''' or '''rem'''}}<br /> {{Tbl-line|align=left|'''--app'''}}<br /> {{Tbl-line|align=left|adds or removes a new PBI to/from the target metafile}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add'''}}<br /> {{Tbl-line|bg=ff|align=left|'''-a author'''}}<br /> {{Tbl-line|bg=ff|align=left|adds the name of the application's author to the target metafile}}<br /> |-<br /> {{Tbl-line|align=left|'''add'''}}<br /> {{Tbl-line|align=left|'''-c category'''}}<br /> {{Tbl-line|align=left|name of new category to add to the target metafile}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add'''}}<br /> {{Tbl-line|bg=ff|align=left|'''-d desc'''}}<br /> {{Tbl-line|bg=ff|align=left|mandatory description of PBI or category being added}}<br /> |-<br /> {{Tbl-line|align=left|'''add'''}}<br /> {{Tbl-line|align=left|'''-i icon'''}}<br /> {{Tbl-line|align=left|mandatory URL to 64x64 ''.png'' icon of PBI or category being added}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add'''}}<br /> {{Tbl-line|bg=ff|align=left|'''-k keywords'''}}<br /> {{Tbl-line|bg=ff|align=left|comma delimited list (with no spaces) of search keywords}}<br /> |-<br /> {{Tbl-line|align=left|'''add'''}}<br /> {{Tbl-line|align=left|'''-l license'''}}<br /> {{Tbl-line|align=left|type of license (e.g. BSD, GPL, Commercial)}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add''' or '''rem'''}}<br /> {{Tbl-line|bg=ff|align=left|'''-n name'''}}<br /> {{Tbl-line|bg=ff|align=left|mandatory name of category or PBI being added to or removed from the target metafile}}<br /> |-<br /> {{Tbl-line|align=left|'''add'''}}<br /> {{Tbl-line|align=left|'''-t type'''}}<br /> {{Tbl-line|align=left|type of application (e.g. Graphical, Text, Service)}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add'''}}<br /> {{Tbl-line|bg=ff|align=left|'''-u URL'''}}<br /> {{Tbl-line|bg=ff|align=left|website of application being added}}<br /> |-<br /> {{Tbl-line|align=left|'''add'''}}<br /> {{Tbl-line|align=left|'''-r'''}}<br /> {{Tbl-line|align=left|include if application needs to be installed as the superuser}}<br /> |-<br /> |}<br /> <br /> === pbi_patch(1) ===<br /> <br /> The '''pbi_patch''' command is used to update an installed PBI to a different version using a small diff Push Button Patch ''*.pbp'' file. This allows the user to perform an incremental upgrade of an installed PBI. The available options are summarized in Table 7.2o.<br /> <br /> '''Table 7.2o: pbi_patch Options'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-e'''}}<br /> {{Tbl-line|bg=ff|align=left|extract only, do not install; will extract the archive to ''~/&lt;pbidirname&gt;'' unless '''-o''' is used.}}<br /> |-<br /> {{Tbl-line|align=left|'''-g'''}}<br /> {{Tbl-line|align=left|extract image data from header; commonly used for GUI installations}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-i'''}}<br /> {{Tbl-line|bg=ff|align=left|display information about this PBI file}}<br /> |-<br /> {{Tbl-line|align=left|'''-o outdir'''}}<br /> {{Tbl-line|align=left|specify the directory to use when only extracting the PBI with '''-e'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--checkscript'''}}<br /> {{Tbl-line|bg=ff|align=left|display any custom scripts used in the installation/removal of this PBI file; recommended if the PBI file is suspect in any way}}<br /> |-<br /> {{Tbl-line|align=left|'''--no-checksig'''}}<br /> {{Tbl-line|align=left|skip the openssl signature verification of the PBI data}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--no-hash'''}}<br /> {{Tbl-line|bg=ff|align=left|disable using the shared hash directory which uses hard links to share files between applications}}<br /> |-<br /> |}<br /> <br /> === pbi_update(1) ===<br /> <br /> The '''pbi_update''' command is used to display information about which PBIs have available updates and to perform the updates. Table 7.2p summarizes the available options.<br /> <br /> '''Table 7.2p: pbi_update Options'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-c'''}}<br /> {{Tbl-line|bg=ff|align=left|check only the specified PBI for available updates}}<br /> |-<br /> {{Tbl-line|align=left|'''--check-all'''}}<br /> {{Tbl-line|align=left|run a full check of all installed PBIs and display list of available updates}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-disable-auto'''}}<br /> {{Tbl-line|bg=ff|align=left|disable auto-updating of the target PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''--enable-auto'''}}<br /> {{Tbl-line|align=left|enable auto-updating of the target PBI}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--update-all'''}}<br /> {{Tbl-line|bg=ff|align=left|update all installed PBIs to the latest versions}}<br /> |-<br /> |}<br /> <br /> === pbi_update_hashdir(1) ===<br /> <br /> The '''pbi_update_hashdir''' command is used by the '''pbid''' daemon to merge the contents of a PBI into the hash directory.<br /> <br /> === pbid(8) ===<br /> <br /> The '''pbid''' command runs a small daemon which performs maintenance of installed PBIs, merges files into the shared hashdir, fetches the repository ''INDEX'' and meta files, and makes the adding and removing of PBIs much faster. It will automatically be started from the''/usr/local/etc/rc.d/pbid'' startup script if ''pbid_enable=&quot;YES&quot;'' is in the ''/etc/rc.conf'' file.<br /> <br /> This utility supports the option summarized in table 7.2q:<br /> <br /> '''Table 7.2q: pbid Options'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-v'''}}<br /> {{Tbl-line|bg=ff|align=left|enable verbose output when the daemon starts}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--refresh'''}}<br /> {{Tbl-line|bg=ff|align=left|schedule a refresh of index and meta files }}<br /> |-<br /> |}<br /> <br /> This command logs its output to ''/var/log/pbid.log''. Check this log for errors should you experience any problems with PBI maintenance.<br /> <br /> &lt;noinclude&gt;{{refheading}}&lt;/noinclude&gt;<br /> &lt;noinclude&gt;<br /> [[category:handbook]]<br /> [[category:Maintaining and Extending PC-BSD®]]<br /> [[category:PBI Manager]]<br /> [[category:protect]]<br /> [[category:Referred by manpage]]<br /> &lt;/noinclude&gt;</div>

Krismoore http://wiki.pcbsd.org/index.php/PBI_Manager 2012-08-27T16:56:26Z

<p>Krismoore: /* Release History */</p> <hr /> <div>&lt;noinclude&gt;{{NavHeader|back=Using AppCafe®|forward=Update Manager}}&lt;/noinclude&gt;<br /> PBI Manager is a suite of command line utilities which can be used to install, remove, create and manage PBIs. It is also available for [[#Installing PBI Manager|FreeBSD systems]]. The PBI Manager is released under the {{citelink|url=http://www.freebsd.org/copyright/freebsd-license.html|BSD license}}.<br /> <br /> == Features ==<br /> <br /> The 9.x PBI format introduced the following features:<br /> <br /> * '''Upgrade deltas:''' since PBIs are self-contained, installation files tend to be large. In the previous implementation, updating a PBI required the re-downloading of the entire installation archive. For larger applications this could be a time-consuming process, especially over low bandwidth connections. The new PBI specification performs updates using binary diff patches known as PBP (Push Button Patch) files. PBPs are a fraction of the PBI's size; in some cases less than 5% of the original PBI archive. An upgrade automatically checks for for the presence of a PBP file and attempts to use it, only falling back to the original archive should the process fail.<br /> <br /> * '''Library and file sharing:''' in the previous implementation of the PBI format it was common that identical files existed between various applications. These duplicates, while necessary to provide the self-contained functionality, wasted both disk space and runtime memory. This waste of space has been greatly reduced through the use of a hash-dir directory where libraries and common files are shared through a system of hard links. When an identical file is found in a PBI, the original will be removed and a hard-link stored in the hash-dir. After a PBI has been removed, any unneeded files left in the hash-dir are cleaned up by the pbid(8) daemon which monitors and maintains the integrity of the shared files.<br /> <br /> * '''Repository management:''' allows administrators and PBI builders to create and manage their own repositories of PBIs. This repository system provides a number of tools for PBI distribution, release management, and repository browsing. <br /> <br /> * '''Digitally signed PBIs:''' each repository includes an openssl public key file which is installed on the end user's system. Each PBI includes several signatures for the content archive and installation and removal scripts. During the PBI installation process, these signatures are checked to confirm that the archive has not been tampered with during transit. This key file is also used to associate a particular PBI with a parent repository for upgrade purposes, since it is possible that multiple repositories will have the same applications.<br /> <br /> * '''Root password not required:''' most applications can be installed and upgraded by regular user (non-root) accounts. This allows enhanced security in office or home situations, where users can now add/remove desktop applications without needing access to the root password. PBIs that impact on the security of the system (e.g. installing a web server) will require root access.<br /> <br /> * '''Implementation:''' the previous PBI design was developed in QT/KDE C++, making it inappropriate for use at the command line. The new format is implemented 100% in shell and is comprised of command-line utilities, each with an associated man page. These utilities are discussed in more detail in the rest of this section.<br /> <br /> == Additional Resources ==<br /> <br /> * {{citelink|url=http://www.pcbsd.org/~kris/pbi9-slides.pdf|The PBI Format Re-implemented for Free/PC-BSD® (conference slides)}}<br /> <br /> * {{citelink|url=http://www.pcbsd.org/~kris/asiabsdcon2011-pbi9.pdf|The PBI Format Re-implemented for Free/PC-BSD® (formal paper)}}<br /> <br /> * [[PBI9 Format|The PBI Format for 9.0 and Beyond]]<br /> <br /> == Release History ==<br /> <br /> '''0.9.9''' (08-27-12) - Kris Moore<br /> <br /> :* Added new C .pbiwrapper file, which can set LD* variables, and use setuid among others<br /> <br /> :* Fixed issues doing pkg_add on pkgs which need license agreements<br /> <br /> :* Added support for saving / re-creating users &amp; groups that a port may need<br /> <br /> :* Fixed some issues getting the correct Package Name<br /> <br /> :* Fixed and issue using exclude lists<br /> <br /> :* Added option to view archive contents with pbi_add -i -v<br /> <br /> :* Added internal priority system to pbi autobuilding<br /> <br /> :* Speed up build system with better package caching<br /> <br /> :* Added additional tmpfs support for auto-building, to further speed up process<br /> <br /> :* Auto-source /etc/profile, to catch any HTTP_PROXY / FTP_PROXY values the user may set<br /> <br /> <br /> '''0.9.8''' (05-11-12) - Kris Moore<br /> <br /> :* Add support for copying linux binaries from ports, with their respective libs<br /> <br /> :* Add GUI speed calculations when downloading<br /> <br /> :* Allow some overrides to built-in defaults, for FreeNAS / pfSense and others<br /> <br /> :* Added fail-safes to make sure the user didn't manually mount things into a PBI directory<br /> <br /> <br /> '''0.9.7''' (12-07-11) - Kris Moore<br /> <br /> :* Use -a flag for fetch to retry after soft failures<br /> <br /> :* Do not create binary patch files, if they are larger than the source<br /> <br /> :* Add ability to use /etc/pbi-make.conf on system, letting us set universal make options<br /> <br /> :* Simplify the startup with less parsing commands<br /> <br /> :* Add new -R flag for pbi_add, which only downloads a PBI from a mirror, without installing it<br /> <br /> :* Add support for using &quot;ccache&quot; automatically if configured on the host system<br /> <br /> :* Fixed a bug using &quot;pbi_create&quot; on a directory manually, make sure file end up in proper PBI application directory<br /> <br /> :* Make sure we use the systems share/icons directory to use shared cursors / icons across all PBIs<br /> <br /> <br /> '''0.9.6''' (11-07-11)<br /> <br /> :* Fix some bugs doing cleanup of stagedir / build directories<br /> <br /> :* Properly kill fetch process when canceling a download<br /> <br /> :* Improve buildworld on FreeBSD to use /usr/src if it already has source<br /> <br /> :* Fix some random warnings when building via sudo<br /> <br /> <br /> '''0.9.5''' (11-03-11)<br /> <br /> :* Add sizes of PBIs to the meta index files<br /> <br /> :* Fix bug adding default icon to PBIs when none is specified<br /> <br /> :* Fix handling of PBI_PROGREVISION<br /> <br /> :* Make sure we unmount nullfs mounts completely<br /> <br /> <br /> '''0.9.4''' (10-19-11)<br /> <br /> :* Fix issue using system-fonts in PBIs<br /> <br /> :* Fix issue removing files which have been set r--<br /> <br /> :* Slow down fetch process to fix issues with fetch protocol errors<br /> <br /> :* Fix bug coping linux libraries into final PBI file<br /> <br /> :* Allow user settings in external-links to overwrite auto-detected values<br /> <br /> :* Fix bug running &quot;stat&quot; on files with spaces in name<br /> <br /> :* Validate the build checksum before doing patching<br /> <br /> :* Speed up builds with optional --tmpfs flags<br /> <br /> :* Add priority system to building modules<br /> <br /> :* Fix issues setting proxy support from pbi.conf / pcbsd.conf files<br /> <br /> :* Validate repo URL's when creating .rpo file<br /> <br /> <br /> '''0.9.3''' (07-18-11)<br /> <br /> :* Unset variables between auto-builds<br /> <br /> :* Fixed some warnings with 'cut' when parsing i18n strings<br /> <br /> :* When doing auto-builds, run through alphabetically<br /> <br /> :* Increase check frequency when first trying to download index's<br /> <br /> :* Speed up the hashdir merging<br /> <br /> :* Show repo MD5 with listings<br /> <br /> :* If no index files, do not fail on listing, just show empty repo<br /> <br /> <br /> '''0.9.2''' (05-23-11)<br /> <br /> :* Fixed usage errors with &quot;tr&quot;<br /> <br /> :* Syntax fixes when trying to install app with no meta-data<br /> <br /> :* Fixed some bugs with binary patching<br /> <br /> :* Fixed auto-builder using the PBI_BUILDKEY in modules pbi.conf file<br /> <br /> :* When building ports, do not export PREFIX since it confuses some linux ports<br /> <br /> :* Perform check if user is root, if PBI is flagged root-only<br /> <br /> :* Auto-builder now checks if port is compatible with arch type of system<br /> <br /> <br /> '''0.9.1''' (05/3/11)<br /> <br /> :* Initial public release<br /> <br /> == What is the PBI format? ==<br /> <br /> One of the things holding back mainstream adoption of open source desktops is the package management format. With almost all open source desktops, software is simply treated as part of the operating system. Thus, when performing an update of some seemingly trivial application, you run the risk of potentially needing to upgrade other packages which could break other critical parts of your desktop. <br /> <br /> While package management systems have gotten better at resolving dependency issues, trying to fix conflicts to prevent breakage before it occurs, they still do not address the underlying problem: every software package is a part of the system, and pulling on any one thread has the potential of causing a break somewhere farther down the line.<br /> <br /> The PBI format tries to correct this underlying flaw. Rather than making every application a part of the base system, PBIs are self-contained, including their own dependent library tree and related data. As a result, when you install a PBI there are no dependency issues to resolve, and applications can be added or removed freely, without fear of causing breakage to the desktop or any other installed software.<br /> <br /> == Installing PBI Manager ==<br /> <br /> If you are running PC-BSD® 9 or higher, then the PBI Manager is already installed, and you can use it via the command-line, or a front-end such as the AppCafe®. <br /> <br /> FreeBSD users can install it from the {{citelink|url=http://www.freshports.org/ports-mgmt/pbi-manager|ports tree}}. <br /> <br /> <br /> Users interested in installing the development version from our {{citelink|url=http://trac.pcbsd.org/brower/pcbsd/current/src-sh/pbi-manager/|SVN repository}} can do so with the following commands: &lt;!-- Is this still relevant or was this for pre-v9.0? --&gt;<br /> <br /> '''svn co &lt;nowiki&gt;svn://svn.pcbsd.org/pcbsd/current/src-sh/pbi-manager&lt;/nowiki&gt;'''<br /> '''cd pbi-manager'''<br /> '''make install'''<br /> <br /> '''NOTE: The development version may be unstable / buggy, use at your own risk'''<br /> <br /> == Getting PBI Files ==<br /> <br /> A list of approved and available PBIs can be viewed with '''pbi_info -i''' or '''pbi_browser''', and then installed with '''pbi_add -r &lt;pbiname&gt;'''. <br /> <br /> '''NOTE:''' PBI files previously created for PC-BSD® 7.x/8.x will NOT work with PBI Manager as it was designed for version 9.x.<br /> <br /> == Underlying File / Directory Structure ==<br /> <br /> <br /> The underlying files and directories used by PBI Manager are as follows:<br /> <br /> * '''/usr/local/etc/pbi.conf''': location of the PBI Manager configuration file <br /> <br /> * '''/usr/pbi/''': where PBIs are installed on the system<br /> <br /> * '''/var/db/pbi/''': contains data files related to installed PBIs and repositories <br /> <br /> * '''/usr/local/sbin/pbi_*''': location of the PBI Manager commands<br /> <br /> * '''/usr/local/share/pbi-manager/module-examples/convertoldmod.sh''': script which can be used to convert an existing 7.x or 8.x PBI module to the new 9.x format<br /> <br /> == Feedback / Reporting Problems ==<br /> <br /> Feedback, problem reports, and general discussion are welcome on the {{citelink|url=http://lists.pcbsd.org/mailman/listinfo/pbi-dev|PBI Developers Mailing list}}. <br /> <br /> == Command Reference ==<br /> <br /> The following commands are installed by PBI Manager. For more details, refer to that command's man page.<br /> <br /> === pbi_add(1) ===<br /> <br /> Similar to FreeBSD's '''pkg_add''', the '''pbi_add''' command is used for adding/installing PBIs on a system, either from a local file or remotely from a repository. This utility supports the options listed in Table 7.2a.<br /> <br /> '''Table 7.2a: pbi_add Options'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> &lt;!-- row 1 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-e'''}}<br /> {{Tbl-line|bg=ff|align=left|extract only, do not install; will extract the archive to ''~/&lt;pbidirname&gt;'' unless the '''-o''' option is used}}<br /> |-<br /> &lt;!-- row 2 --&gt;<br /> {{Tbl-line|align=left|'''-f'''}} <br /> {{Tbl-line|align=left|force installation, overwriting an already installed copy of the application}}<br /> |- <br /> &lt;!-- row 3 --&gt; <br /> {{Tbl-line|bg=ff|align=left|'''-g'''}} <br /> {{Tbl-line|bg=ff|align=left|show path to icons and images for GUI installations}}<br /> |-<br /> &lt;!-- row 4 --&gt; <br /> {{Tbl-line|bg=ee|align=left|'''-i'''}} <br /> {{Tbl-line|bg=ee|align=left|display information about specified PBI}}<br /> |-<br /> &lt;!-- row 5 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-l'''}} <br /> {{Tbl-line|bg=ff|align=left|display license for specified PBI}}<br /> |-<br /> &lt;!-- row 6 --&gt; <br /> {{Tbl-line|align=left|'''-o outdir'''}} <br /> {{Tbl-line|align=left|specify the directory to use when extracting the PBI with '''-e'''}}<br /> |-<br /> &lt;!-- row 7 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-r'''}} <br /> {{Tbl-line|bg=ff|align=left|remote fetch installation file from update server; the system architecture and version will be automatically determined in order to fetch the correct file}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-R'''}} <br /> {{Tbl-line|bg=ff|align=left|remote fetch the install file from the update server but do not install}}<br /> |-<br /> &lt;!-- row 8 --&gt;<br /> {{Tbl-line|align=left|'''-v'''}} <br /> {{Tbl-line|align=left|enable verbose output}}<br /> |-<br /> &lt;!-- row 9 --&gt; <br /> {{Tbl-line|bg=ff|align=left|'''--checkscript'''}} <br /> {{Tbl-line|bg=ff|align=left|display any custom scripts used in the installation/removal of the PBI}} <br /> |-<br /> &lt;!-- row 10 --&gt; <br /> {{Tbl-line|align=left|'''--licagree'''}} <br /> {{Tbl-line|align=left|agree to license terms and conditions; to view the license, use '''-l'''}}<br /> |-<br /> &lt;!-- row 11 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''--no-checksig'''}} <br /> {{Tbl-line|bg=ff|align=left|skip the openssl signature verification of the PBI data}}<br /> |-<br /> &lt;!-- row 12 --&gt;<br /> {{Tbl-line|align=left|'''--no-checksum'''}} <br /> {{Tbl-line|align=left|skip the checksum verification of the archive data}}<br /> |-<br /> &lt;!-- row 13 --&gt; <br /> {{Tbl-line|bg=ff|align=left|'''--no-hash'''}} <br /> {{Tbl-line|bg=ff|align=left|disable using the shared hash dir}} <br /> |-<br /> &lt;!-- row 14 --&gt;<br /> {{Tbl-line|align=left|'''--repo repoid'''}}<br /> {{Tbl-line|align=left|specify which repository to use}}<br /> |-<br /> &lt;!-- row 15 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''--rArch arch'''}}<br /> {{Tbl-line|bg=ff|align=left|manually specify the PBI architecture type of i386 or amd64}}<br /> |-<br /> &lt;!-- row 16 --&gt;<br /> {{Tbl-line|align=left|'''--rVer version'''}}<br /> {{Tbl-line|align=left|specify which version of the PBI to install}}<br /> |-<br /> |}<br /> <br /> For security reasons, it is recommend that users first use the '''-e''' and '''--checkscript''' options to view archive contents and installation scripts prior to installing a PBI file.<br /> <br /> To install a PBI, use: '''pbi_add -r PBINAME'''. The following example will install the alpine PBI:<br /> <br /> '''pbi_add -r alpine'''<br /> Downloading ftp://ftp.pcbsd.org/pub/mirror/PBI/mail/alpine/9/x32/alpine-2.00_3-i386.pbi<br /> /usr/pbi/.alpine-2.00_3-i386.pbi.42391 100% of 11 MB 295 kBps 00m00s<br /> Verifying Checksum...OK<br /> Extracting to: /usr/pbi/alpine-i386<br /> Installed: Alpine-2.00_3<br /> <br /> === pbi_addrepo(8) ===<br /> <br /> The '''pbi_addrepo''' command is used to register a new PBI repository on a system. If the '''pbid''' daemon is running, the repository's index and meta files will be automatically fetched and made ready for browsing. The command has one argument: the name of the repository file. Repository files have a ''.rpo'' extension and are created with the '''pbi_makerepo''' command.<br /> <br /> === pbi_autobuild(8) ===<br /> <br /> The '''pbi_autobuild''' command is used on the PBI build system to build any out-of-date or new packages. The utility is also of interest to PBI testers and system administrators who create and maintain their own internal repository of PBIs. It can traverse the FreeBSD ports and Meta-data trees, building missing PBI files or PBIs in which the target port version has been updated. Table 7.2b summarizes this command's options:<br /> <br /> '''Table 7.2b: pbi_autobuild Options'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> &lt;!-- row 1 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-c confdir'''}}<br /> {{Tbl-line|bg=ff|align=left|specify the directory containing the PBI configuration modules; any found ''pbi.conf'' files will be parsed, and if PBI_MAKEPORT is set, the target port will be used for the build; if PBI_MAKEPORT is unset, the auto-build will attempt to match the module to a FreeBSD port based upon the dirname of ''pbi.conf''}}<br /> |-<br /> {{Tbl-line|align=left|'''-d portsdir'''}}<br /> {{Tbl-line|align=left|specify an alternative ports directory; defaults to ''/usr/ports/''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-h script'''}}<br /> {{Tbl-line|bg=ff|align=left|specify a helper script to call after building a PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''-o outdir'''}}<br /> {{Tbl-line|align=left|the directory to place the finished PBI files; also used to determine which apps are in need of a rebuild if the associated FreeBSD port has been updated}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--genpatch'''}}<br /> {{Tbl-line|bg=ff|align=left|when building a new PBI, check for archived copies and generate smaller patch updates to the new version (*.pbp files)}}<br /> |-<br /> {{Tbl-line|align=left|'''--keep num'''}}<br /> {{Tbl-line|align=left|when building new PBIs, keep &lt;num&gt; copies of past versions of working PBI in ''&lt;outdir&gt;/archived/'' folder; these archived copies can be used with the '''--genpatch''' command to generate update patch files}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--pkgcache'''}}<br /> {{Tbl-line|bg=ff|align=left|enable caching of ''.txz'' pkg files which greatly speeds up subsequent builds of a PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''--prune'''}}<br /> {{Tbl-line|align=left|remove any PBIs which no longer have an associated module in confdir}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--tmpfs'''}}<br /> {{Tbl-line|bg=ff|align=left|automatically create and mount a tmp filesystem and use it for WRKDIRPREFIX; can speed up port compiles on systems with available RAM}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|digitally sign the PBI file with the specified openssl private key file}} <br /> |-<br /> |}<br /> <br /> === pbi_browser(1) ===<br /> <br /> The '''pbi_browser''' command provides a CLI front-end to browsing a repository's available PBIs. Options for viewing categories and searching by keyword are available, and once the desired PBI is located, it will show the '''pbi_add''' command which can be used to install the application. Table 7.2c summarizes the available options.<br /> <br /> '''Table 7.2c: pbi_browser Options'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-c category'''}}<br /> {{Tbl-line|bg=ff|align=left|displays a list of PBIs in the specified category}}<br /> |-<br /> {{Tbl-line|align=left|'''-s search'''}}<br /> {{Tbl-line|align=left|search for PBIs containing the specified string in the name, description, or keywords}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--listcats'''}}<br /> {{Tbl-line|bg=ff|align=left|list the available categories}}<br /> |-<br /> {{Tbl-line|align=left|'''--viewall'''}}<br /> {{Tbl-line|align=left|list all available PBIs}}<br /> |-<br /> |}<br /> <br /> === pbi.conf(5) ===<br /> <br /> ''pbi.conf'' is an ASCII text configuration file containing values that are used by the various '''pbi_*''' commands. The proxy variables are only needed if the system uses a proxy server to access the Internet. Table 7.2d lists the supported variables.<br /> <br /> '''Table 7.2d: pbi_conf Variables'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=20%|'''Variable'''}}<br /> {{Tbl-title|width=80%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|PBID_REFRESH}}<br /> {{Tbl-line|bg=ff|align=left|wakeup time in seconds for '''pbid''' to run its checks}}<br /> |-<br /> {{Tbl-line|align=left|PBI_INDEXREFRESH}}<br /> {{Tbl-line|align=left|number of hours representing how often '''pbid''' refreshes the index and meta files from repos; default is every 24 hours}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|PBI_PROXYURL}}<br /> {{Tbl-line|bg=ff|align=left|proxy server IP address}}<br /> |-<br /> {{Tbl-line|align=left|PBI_PROXYPORT}}<br /> {{Tbl-line|align=left|proxy server port number}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|PBI_PROXYTYPE}}<br /> {{Tbl-line|bg=ff|align=left|can be HTTP or SOCKS5}}<br /> |-<br /> {{Tbl-line|align=left|PBI_PROXYUSER}}<br /> {{Tbl-line|align=left|username used to authenticate with proxy server}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|PBI_PROXYPASS}}<br /> {{Tbl-line|bg=ff|align=left|password used to authenticate with proxy server}}<br /> |-<br /> |}<br /> <br /> === pbi_create(1) ===<br /> <br /> The '''pbi_create''' command provides a way for packagers to manually specify a target directory to be compressed into a PBI file. The option '''-b''' can also be used to re-package an already installed PBI back to an archive. PBI creators are encouraged to send a tarball of the resulting PBI module to the {{citelink|url=http://lists.pcbsd.org/mailman/listinfo/pbi-dev|PBI-testing mailing list}} so they can be added to the PC-BSD® PBI repository and made available to other PC-BSD® users.<br /> <br /> Table 7.2e summarizes the available options:<br /> <br /> '''Table 7.2e: pbi_create Options'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-a author'''}}<br /> {{Tbl-line|bg=ff|align=left|specify the author for this PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''-b'''}} <br /> {{Tbl-line|align=left|make a backup of an installed PBI; specify the target PBI name instead of the PBI directory}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-c confdir'''}}<br /> {{Tbl-line|bg=ff|align=left|specify the metadata configuration directory; while not required it is highly recommended as metadata is required to create icons and binary entry-points}}<br /> |-<br /> {{Tbl-line|align=left|'''-d portsdir'''}}<br /> {{Tbl-line|align=left|specify an alternative ports directory; defaults to ''/usr/ports/''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-i icon'''}}<br /> {{Tbl-line|bg=ff|align=left|specify a default icon, relative to ''pbidir/''}}<br /> |-<br /> {{Tbl-line|align=left|'''-n name'''}}<br /> {{Tbl-line|align=left|specify a name for this PBI}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-o outdir'''}}<br /> {{Tbl-line|bg=ff|align=left|place the finished ''.pbi'' file into the specified directory; defaults to $HOME}}<br /> |-<br /> {{Tbl-line|align=left|'''-p port'''}}<br /> {{Tbl-line|align=left|use the given port to get PBI name and version}}<br /> |- <br /> {{Tbl-line|bg=ff|align=left|'''-r version'''}}<br /> {{Tbl-line|bg=ff|align=left|specify a version for this PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''-u weburl'''}}<br /> {{Tbl-line|align=left|specify a website URL for the PBI}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--no-hash'''}}<br /> {{Tbl-line|bg=ff|align=left|disable using the shared hash directory which uses hard links to share files between applications}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|digitally sign the PBI file with the specified openssl private key file}}<br /> |-<br /> |}<br /> <br /> As the superuser, you can create a PBI with the '''pbi_create''' command using the following syntax: <br /> <br /> '''pbi_create -a &lt;author&gt; -n &lt;name&gt; -r &lt;version&gt; -w &lt;weburl&gt; &lt;target directory&gt;'''<br /> <br /> Inside the target directory place the application's binaries or scripts along with any required dependencies. To indicate which file(s) represent the runtime command(s), include a file named ''external-links'' in the target directory. That file contains an entry for each command, as seen in the following example:<br /> <br /> # Files to be symlinked into the default LOCALBASE<br /> # One per-line, relative to %%PBI_APPDIR%% and LOCALBASE<br /> # Defaults to keeping any existing files in LOCALBASE<br /> # Use bin-files/ for binaries that need wrapper functionality<br /> <br /> # TARGET LINK IN LOCALBASE ACTION<br /> bin/myapp bin/myapp binary,nocrash<br /> <br /> This entry instructs '''pbi_create''' to make the wrapper scripts for the ''myapp'' binary, along with placing it in the user's PATH at install time.<br /> <br /> It is also possible to include desktop icons and mime entries using the ''xdg-mime/'', ''xdg-desktop/'' and ''xdg-menu/'' directories. The section on how to [[Create PBIs]] contains more details about creating these files. These directories should be created as subdirectories of the target directory of your application.<br /> <br /> === pbi_delete(1) ===<br /> <br /> Similar to FreeBSD's '''pkg_delete''', the '''pbi_delete''' command removes an installed PBI from the system. It also schedules cleaning for the shared library directory, which is performed by '''pbid'''. Table 7.2f summarizes its options:<br /> <br /> '''Table 7.2f: pbi_delete Options'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-v'''}} <br /> {{Tbl-line|bg=ff|align=left|enable verbose output}}<br /> |-<br /> {{Tbl-line|align=left|'''--clean-hdir'''}}<br /> {{Tbl-line|align=left|perform a full cleaning of the shared hash directory, removing any unused files; should only be required after a system crash or failure in removing a PBI}}<br /> |-<br /> |}<br /> <br /> When removing a PBI, you must give its full name. The full name can be found in the output of '''pbi_info'''. The following example searches for the ntop PBI and removes it:<br /> <br /> '''pbi_info | grep ntop'''<br /> ntop-4.0.1_1-i386<br /> '''pbi_delete -v ntop-4.0.1_1-i386'''<br /> Running pre-removal script: /var/db/pbi/installed/ntop-4.0.1_1-i386/pre-remove.sh<br /> Removing: /usr/pbi/ntop-i386<br /> Removing: /var/db/pbi/installed/ntop-4.0.1_1-i386<br /> <br /> === pbi_deleterepo(8) ===<br /> <br /> The '''pbi_deleterepo''' command can be used to remove a registered repository from the system. It takes the repository's ID as the only command argument.<br /> <br /> === pbi_icon(1) ===<br /> <br /> 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 {{citelink|url=http://en.wikipedia.org/wiki/Xdg|XDG}}-compliant to understand a PBI's icon and mime settings. Table 7.2g summarizes this command's options:<br /> <br /> '''Table 7.2g: pbi_icon Options'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add-desktop'''}}<br /> {{Tbl-line|bg=ff|align=left|installs desktop icon; should be run as regular user}}<br /> |-<br /> {{Tbl-line|align=left|'''add-mime'''}}<br /> {{Tbl-line|align=left|installs mime information; should be run as root}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add-menu'''}}<br /> {{Tbl-line|bg=ff|align=left|installs menu icons; should be run as root}}<br /> |-<br /> {{Tbl-line|align=left|'''add-pathlnk'''}}<br /> {{Tbl-line|align=left|installs any $PATH links to ''~/bin'' when run as user or to $LOCALBASE when run as root}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''del-desktop'''}}<br /> {{Tbl-line|bg=ff|align=left|removes desktop icon; should be run as regular user}}<br /> |-<br /> {{Tbl-line|align=left|'''del-menu'''}}<br /> {{Tbl-line|align=left|removes menu icons; should be run as root}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''del-mime'''}}<br /> {{Tbl-line|bg=ff|align=left|removes mime information; should be run as root}}<br /> |-<br /> {{Tbl-line|align=left|'''del-pathlnk'''}}<br /> {{Tbl-line|align=left|removes any $PATH links to ''~/bin'' when run as user or to $LOCALBASE when run as root}}<br /> |-<br /> |}<br /> <br /> === pbi_indextool(1) ===<br /> <br /> The '''pbi_indextool''' command is useful for repository maintainers. It allows PBI files to be added and removed from the repository's ''INDEX'' file. An example of using this command can be found in [[Create Your Own PBI Repository]]. Table 7.2h summarizes the available options: <br /> <br /> '''Table 7.2h: pbi_indextool Options'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Command'''}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=70%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add'''}}<br /> {{Tbl-line|bg=ff|align=left|'''-b vers'''}}<br /> {{Tbl-line|bg=ff|align=left|mark previous versions as having a binary diff patch (''.pbp'' file used for upgrading) available}}<br /> |-<br /> {{Tbl-line|align=left|'''add'''}}<br /> {{Tbl-line|align=left|'''-f pbifile'''}}<br /> {{Tbl-line|align=left|mandatory, name of PBI being added to the target ''INDEX'' file}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add'''}}<br /> {{Tbl-line|bg=ff|align=left|'''-k num'''}}<br /> {{Tbl-line|bg=ff|align=left|number of previous versions of this PBI to keep in the ''INDEX'' file}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add'''}}<br /> {{Tbl-line|bg=ff|align=left|'''-u fileurl'''}}<br /> {{Tbl-line|bg=ff|align=left|mandatory URL to PBI location on server in the format category/pbi_name}}<br /> |-<br /> {{Tbl-line|align=left|'''rem'''}}<br /> {{Tbl-line|align=left|'''-m arch'''}}<br /> {{Tbl-line|align=left|mandatory architecture type for PBI being removed (e.g. i386, amd64)}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''rem'''}}<br /> {{Tbl-line|bg=ff|align=left|'''-n pbiname'''}}<br /> {{Tbl-line|bg=ff|align=left|mandatory name of PBI being removed from the ''INDEX'' file}}<br /> |-<br /> {{Tbl-line|align=left|'''rem'''}}<br /> {{Tbl-line|align=left|'''-v version'''}}<br /> {{Tbl-line|align=left|mandatory, version of the PBI being removed from the ''INDEX'' file}}<br /> |-<br /> |}<br /> <br /> === pbi_info(1) ===<br /> <br /> Similar to FreeBSD's '''pkg_info''' command, the '''pbi_info''' command is used to determine which PBIs are currently installed. Table 7.2i summarizes the available options:<br /> <br /> '''Table 7.2i: pbi_info Options'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-a'''}} <br /> {{Tbl-line|bg=ff|align=left|list all PBIs installed on the system; same as running '''pbi_info''' without an argument}}<br /> |-<br /> {{Tbl-line|align=left|'''-i'''}}<br /> {{Tbl-line|align=left|list all available PBIs from any repo}} <br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-v'''}} <br /> {{Tbl-line|bg=ff|align=left|enable verbose output}}<br /> |-<br /> |}<br /> <br /> === pbi_listrepo(1) ===<br /> <br /> The '''pbi_listrepo''' command manages installed repositories on a system. Table 7.2j summarizes this command's options:<br /> <br /> '''Table 7.2j: pbi_listrepo Options'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--down'''}}<br /> {{Tbl-line|bg=ff|align=left|move the targeted repoID down a single number in priority}}<br /> |-<br /> {{Tbl-line|align=left|'''-mirror URL'''}}<br /> {{Tbl-line|align=left|change the specified repoID's mirror URL}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--up'''}}<br /> {{Tbl-line|bg=ff|align=left|move the targeted repoID up a single number in priority}}<br /> |-<br /> |}<br /> <br /> Run the command without any options to list the IDs of the available repositories.<br /> <br /> === pbi_makepatch(1) ===<br /> <br /> The '''pbi_makepatch''' command is automatically used by '''pbi_autobuild''' to create small ''*.pbp'' (Push Button Patch) files. These files can be downloaded to a user's system in order to update a PBI's version without re-downloading the entire archive. This allows users to download only the incremental changes when a PBI is upgraded. The command can also be run manually by providing two PBI archives to compare and generate a patch file for.<br /> <br /> Table 7.2k summarizes the available options:<br /> <br /> '''Table 7.2k: pbi_makepatch Options<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-o outdir'''}}<br /> {{Tbl-line|bg=ff|align=left|save the resulting ''*pbp'' file to the specified directory}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|use the specified openssl key to digitally sign the patch file}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--tmpfs'''}}<br /> {{Tbl-line|bg=ff|align=left|can reduce building time for large PBIs}}<br /> |-<br /> |}<br /> <br /> === pbi_makeport(1) ===<br /> <br /> The '''pbi_makeport''' command can be used by packagers to build a target FreeBSD port and convert it into a PBI file. Many options are provided to fine-tune the build process, and meta-data modules can also be specified to further improve the resulting PBI file. The first time this command is run, it will build a fresh chroot sandbox environment which can be used for clean-room building of the target port without affecting the host system. More details about how to create a PBI using this command, can be found in the [[PBI Module Builder Guide#Creating a New PBI with pbi makeport | ''PBI Module Builder Guide'']].<br /> <br /> '''NOTE:''' the '''pbi_makeport''' command has support for using {{citelink|url=http://www.freshports.org/devel/ccache/|ccache}} to speed up the compile process. If '''ccache''' is installed on the host system and the CCACHE_DIR variable is set, the '''pbi_makeport''' command will automatically utilize it for the port compile phase. This can be disabled by setting NO_CCACHE=yes in ''/etc/pbi-make.conf'' on the host system, or as an optional make flag in a module's ''pbi.conf'' file. <br /> <br /> Table 7.2l summarizes the available options:<br /> <br /> '''Table 7.2l: pbi_makeport Options'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-B'''}} <br /> {{Tbl-line|bg=ff|align=left|build-only; generally used with '''-k''' to build a port before running '''pbi_create''' manually}}<br /> |-<br /> {{Tbl-line|align=left|'''-c confdir'''}}<br /> {{Tbl-line|align=left|specify the metadata configuration directory; while not required it is highly recommended as metadata is required to create icons and binary entry-points }}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-d portsdir'''}}<br /> {{Tbl-line|bg=ff|align=left|specify an alternative ports directory; defaults to ''/usr/ports''}}<br /> |-<br /> {{Tbl-line|align=left|'''-k'''}} <br /> {{Tbl-line|align=left|keep the build files after building the PBI}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-o outdir'''}}<br /> {{Tbl-line|bg=ff|align=left|the directory to place the finished PBI file; defaults to user's $HOME directory}}<br /> |-<br /> {{Tbl-line|align=left|'''-p prefix'''}}<br /> {{Tbl-line|align=left|manually provide a PREFIX which determines the location where the PBI will be installed on the end-user's system}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--delbuild'''}}<br /> {{Tbl-line|bg=ff|align=left|remove any existing build directories before starting the build}}<br /> |-<br /> {{Tbl-line|align=left|'''--mkdebug'''}}<br /> {{Tbl-line|align=left|will drop to a debugging shell should the port make fail}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--no-prune'''}}<br /> {{Tbl-line|bg=ff|align=left|disable auto-pruning of non-REQUIREDBY ports after the compile phase; by default any ports which are used solely for building and which are not required for program execution will be pruned}}<br /> |-<br /> {{Tbl-line|align=left|'''--pkgdir dir'''}}<br /> {{Tbl-line|align=left|uses the specified directory to cache the .txz package so subsequent builds will not rebuild the port from source<br /> }}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--tmpfs'''}}<br /> {{Tbl-line|bg=ff|align=left|automatically create and mount a tmp filesystem and use it for WRKDIRPREFIX; can speed up port compiles on systems with available RAM<br /> }}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|digitally sign the PBI file with the specified openssl private key file}}<br /> |-<br /> |}<br /> <br /> === pbi_makerepo(1) ===<br /> <br /> The '''pbi_makerepo''' command allows repository maintainers to create a single ''*.rpo'' file containing various information about the new repository. This ''.rpo'' file can then be installed on the target system with '''pbi_addrepo'''. Table 7.2m summarizes the available options.<br /> <br /> '''Table 7.2m: pbi_makerepo Options'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--desc description'''}}<br /> {{Tbl-line|bg=ff|align=left|required; description of the repo to be shown in the repo list}}<br /> |-<br /> {{Tbl-line|align=left|'''--key keyfile'''}}<br /> {{Tbl-line|align=left|required; OpenSSL public key used to verify the digital signature of PBIs installed from this repo}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--mirror URL'''}}<br /> {{Tbl-line|bg=ff|align=left|required; URL in &lt;nowiki&gt;http://, https://&lt;/nowiki&gt;, or ftp:// format to download PBIs and updates from}}<br /> |-<br /> {{Tbl-line|align=left|'''--url URL'''}}<br /> {{Tbl-line|align=left|required; URL in &lt;nowiki&gt;http://, https://&lt;/nowiki&gt;, or ftp:// format to use when downloading the master ''INDEX'' file of available PBIs}}<br /> |-<br /> |}<br /> <br /> === pbi_metatool(1) ===<br /> <br /> The '''pbi_metatool''' command provides a way for repository maintainers to modify the PBI metadata in their repository in order to add or remove application categories or specified PBIs. An example of using this command can be found in [[Create Your Own PBI Repository]]. Table 7.2n summarizes the available options:<br /> <br /> '''Table 7.2n: pbi_metatool Options'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Command'''}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=70%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add''' or '''rem'''}}<br /> {{Tbl-line|bg=ff|align=left|'''--cat'''}}<br /> {{Tbl-line|bg=ff|align=left|indicates that a new category is being added to or removed from the target metafile}}<br /> |-<br /> {{Tbl-line|align=left|'''add''' or '''rem'''}}<br /> {{Tbl-line|align=left|'''--app'''}}<br /> {{Tbl-line|align=left|adds or removes a new PBI to/from the target metafile}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add'''}}<br /> {{Tbl-line|bg=ff|align=left|'''-a author'''}}<br /> {{Tbl-line|bg=ff|align=left|adds the name of the application's author to the target metafile}}<br /> |-<br /> {{Tbl-line|align=left|'''add'''}}<br /> {{Tbl-line|align=left|'''-c category'''}}<br /> {{Tbl-line|align=left|name of new category to add to the target metafile}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add'''}}<br /> {{Tbl-line|bg=ff|align=left|'''-d desc'''}}<br /> {{Tbl-line|bg=ff|align=left|mandatory description of PBI or category being added}}<br /> |-<br /> {{Tbl-line|align=left|'''add'''}}<br /> {{Tbl-line|align=left|'''-i icon'''}}<br /> {{Tbl-line|align=left|mandatory URL to 64x64 ''.png'' icon of PBI or category being added}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add'''}}<br /> {{Tbl-line|bg=ff|align=left|'''-k keywords'''}}<br /> {{Tbl-line|bg=ff|align=left|comma delimited list (with no spaces) of search keywords}}<br /> |-<br /> {{Tbl-line|align=left|'''add'''}}<br /> {{Tbl-line|align=left|'''-l license'''}}<br /> {{Tbl-line|align=left|type of license (e.g. BSD, GPL, Commercial)}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add''' or '''rem'''}}<br /> {{Tbl-line|bg=ff|align=left|'''-n name'''}}<br /> {{Tbl-line|bg=ff|align=left|mandatory name of category or PBI being added to or removed from the target metafile}}<br /> |-<br /> {{Tbl-line|align=left|'''add'''}}<br /> {{Tbl-line|align=left|'''-t type'''}}<br /> {{Tbl-line|align=left|type of application (e.g. Graphical, Text, Service)}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add'''}}<br /> {{Tbl-line|bg=ff|align=left|'''-u URL'''}}<br /> {{Tbl-line|bg=ff|align=left|website of application being added}}<br /> |-<br /> {{Tbl-line|align=left|'''add'''}}<br /> {{Tbl-line|align=left|'''-r'''}}<br /> {{Tbl-line|align=left|include if application needs to be installed as the superuser}}<br /> |-<br /> |}<br /> <br /> === pbi_patch(1) ===<br /> <br /> The '''pbi_patch''' command is used to update an installed PBI to a different version using a small diff Push Button Patch ''*.pbp'' file. This allows the user to perform an incremental upgrade of an installed PBI. The available options are summarized in Table 7.2o.<br /> <br /> '''Table 7.2o: pbi_patch Options'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-e'''}} <br /> {{Tbl-line|bg=ff|align=left|extract only, do not install; will extract the archive to ''~/&lt;pbidirname&gt;'' unless '''-o''' is used.}}<br /> |-<br /> {{Tbl-line|align=left|'''-g'''}} <br /> {{Tbl-line|align=left|extract image data from header; commonly used for GUI installations}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-i'''}} <br /> {{Tbl-line|bg=ff|align=left|display information about this PBI file}}<br /> |-<br /> {{Tbl-line|align=left|'''-o outdir'''}}<br /> {{Tbl-line|align=left|specify the directory to use when only extracting the PBI with '''-e'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--checkscript'''}}<br /> {{Tbl-line|bg=ff|align=left|display any custom scripts used in the installation/removal of this PBI file; recommended if the PBI file is suspect in any way}}<br /> |-<br /> {{Tbl-line|align=left|'''--no-checksig'''}}<br /> {{Tbl-line|align=left|skip the openssl signature verification of the PBI data}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--no-hash'''}}<br /> {{Tbl-line|bg=ff|align=left|disable using the shared hash directory which uses hard links to share files between applications}}<br /> |-<br /> |}<br /> <br /> === pbi_update(1) ===<br /> <br /> The '''pbi_update''' command is used to display information about which PBIs have available updates and to perform the updates. Table 7.2p summarizes the available options.<br /> <br /> '''Table 7.2p: pbi_update Options'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-c'''}} <br /> {{Tbl-line|bg=ff|align=left|check only the specified PBI for available updates}}<br /> |-<br /> {{Tbl-line|align=left|'''--check-all'''}}<br /> {{Tbl-line|align=left|run a full check of all installed PBIs and display list of available updates}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-disable-auto'''}}<br /> {{Tbl-line|bg=ff|align=left|disable auto-updating of the target PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''--enable-auto'''}}<br /> {{Tbl-line|align=left|enable auto-updating of the target PBI}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--update-all'''}}<br /> {{Tbl-line|bg=ff|align=left|update all installed PBIs to the latest versions}}<br /> |-<br /> |}<br /> <br /> === pbi_update_hashdir(1) ===<br /> <br /> The '''pbi_update_hashdir''' command is used by the '''pbid''' daemon to merge the contents of a PBI into the hash directory.<br /> <br /> === pbid(8) ===<br /> <br /> The '''pbid''' command runs a small daemon which performs maintenance of installed PBIs, merges files into the shared hashdir, fetches the repository ''INDEX'' and meta files, and makes the adding and removing of PBIs much faster. It will automatically be started from the''/usr/local/etc/rc.d/pbid'' startup script if ''pbid_enable=&quot;YES&quot;'' is in the ''/etc/rc.conf'' file.<br /> <br /> This utility supports the option summarized in table 7.2q:<br /> <br /> '''Table 7.2q: pbid Options'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-v'''}}<br /> {{Tbl-line|bg=ff|align=left|enable verbose output when the daemon starts}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--refresh'''}}<br /> {{Tbl-line|bg=ff|align=left|schedule a refresh of index and meta files }}<br /> |-<br /> |}<br /> <br /> This command logs its output to ''/var/log/pbid.log''. Check this log for errors should you experience any problems with PBI maintenance.<br /> <br /> &lt;noinclude&gt;{{refheading}}&lt;/noinclude&gt;<br /> &lt;noinclude&gt;<br /> [[category:handbook]]<br /> [[category:Maintaining and Extending PC-BSD®]]<br /> [[category:PBI Manager]]<br /> [[category:protect]]<br /> [[category:Referred by manpage]]<br /> &lt;/noinclude&gt;</div>

Krismoore http://wiki.pcbsd.org/index.php/Obtaining_PC-BSD%C2%AE 2012-08-01T15:03:56Z

<p>Krismoore: /* Selecting Which File to Download */</p> <hr /> <div>&lt;noinclude&gt;{{NavHeader|back=Partitioning the Hard Drive|forward=Burning the Installation Media}}&lt;/noinclude&gt;<br /> The installation files for PC-BSD can be downloaded for free and end with an ''.iso'' or ''.img.bz2'' file extension. Depending upon the type of file you choose, the size will vary between ~650MB and ~3.5GB. This section will show you how to select which file to download and how to verify the downloaded file's checksum. The next section will demonstrate how to burn the file to bootable media.<br /> <br /> If you have a slow download connection or wish to support the PC-BSD project financially, you can purchase PC-BSD DVDs from the {{citelink|url=http://www.freebsdmall.com/cgi-bin/fm/scan/su=yes/fi=prod_bsd/sf=sku/sf=title/sf=category/se=pcbsd|FreeBSD Mall}}.<br /> <br /> Members of the PC-BSD project attend many IT conferences across the globe and give out PC-BSD DVDs at conference booths. Visiting a PC-BSD booth is an excellent way to meet other PC-BSD users and to get your questions answered. Check the {{citelink|url=http://blog.pcbsd.org/|PC-BSD Blog}} to see if any events are happening near you. If you are organizing a PC-BSD booth, {{citelink|url=http://pcbsd.org/about/contact-us|contact us}} to arrange for DVDs.<br /> <br /> === Selecting Which File to Download ===<br /> <br /> When you go to the {{citelink|url=http://pcbsd.org/get-it/download-pc-bsd|Download}} page of the PC-BSD website, you will find a number of files available for download:<br /> <br /> * '''DVD-live:''' contains a live version of PC-BSD running the KDE4 desktop; requires a DVD burner. Note that the live version is read-only. It does provide an installer icon on the destkop should you decide to install PC-BSD.<br /> <br /> * '''DVD:''' contains the full version of PC-BSD (all system components, ports, and source); requires a DVD burner.<br /> <br /> * '''USB:''' contains the full version of PC-BSD (all system components, ports, and source); requires a USB memory stick or flash card.<br /> <br /> * '''USB-lite:''' contains a stripped down version of PC-BSD and the LXDE desktop (no system components, ports, or source); requires a USB memory stick or flash card.<br /> <br /> * '''VMware disk image:''' contains the full version of PC-BSD (all system components, ports, and source); requires {{citelink|url=http://vmware.com|VMware}} to be installed.<br /> <br /> * '''VirtualBox disk:''' contains the full version of PC-BSD (all system components, ports, and source); see [[Using VirtualBox|Using VirtualBox]] for instructions on using the VirtualBox disk.<br /> <br /> The larger the installation file size, the more components that come with that installation. <br /> <br /> Regardless of which media you use to install PC-BSD, you have the option to install additional components and applications after the installation using [[System Manager]] and [[Using_AppCafe® | AppCafe®]].<br /> <br /> There are two versions available for each type of file: one for 32-bit (i386) systems and one for 64-bit (amd64) systems. It is important that you download a file that matches your computer's processor type (32- or 64-bit). Each media type includes the ''pcbsd-media-details'' file which identifies the release version, architecture, and media type. <br /> <br /> '''NOTE:''' If you plan to use VirtualBox to install PC-BSD, you can install the 32-bit version, even if your computer is 64-bit. Depending upon your processor's capabilities, you may or may not be able to install the 64-bit version on a 64-bit system using VirtualBox.<br /> <br /> === Data Integrity Check ===<br /> <br /> After downloading the file that is correct for your architecture and installation media, it is a good idea to check that the file is exactly the same as the one on the PC-BSD server. While downloading, a portion of the file may get damaged or lost, making the installation file unusable. Each PC-BSD download has an associated MD5 checksum which is listed next to the download link. If the checksum of the file you downloaded has the same number, your download was successful. If the MD5 numbers don't match, you should download the file again, preferably from a different mirror. In order to verify the checksum, you will need to use a checksum verification utility.<br /> <br /> If you are currently using a Windows system, you can download and install the {{citelink|url=http://www.fastsum.com/|FastSum}} utility. Once installed, launch the program and click the Files button, shown in Figure 2.5a, to browse to the location of your downloaded file:<br /> <br /> '''Figure 2.5a: Verifying a Checksum Using FastSum'''<br /> <br /> [[Image:Fastsum1a.jpeg]]<br /> <br /> Once the file is selected, click the green arrow to calculate the checksum. Once calculated, it will be listed in the Checksum\State column. In this example, the checksum is e66acb8ff1013c6c5e114191e9556580 (though FastSum will capitalize the letters). <br /> <br /> On Linux and BSD systems you can use the built-in '''md5''' (or '''md5sum''') command line tool to check the data integrity of the downloaded file. In this example, the file is located in the Downloads subdirectory of a user's home (~) directory. You should substitute the name and location of the file that you downloaded:<br /> <br /> '''md5 ~/Downloads/PCBSD9.0-RELEASE-x86-DVD.iso '''<br /> MD5 (Desktop/PCBSD9.0-RELEASE-x86-DVD.iso) = e66acb8ff1013c6c5e114191e9556580<br /> &lt;noinclude&gt;{{refheading}}&lt;/noinclude&gt;<br /> &lt;noinclude&gt;<br /> [[category:handbook]]<br /> [[category:Pre-Installation Tasks]]<br /> [[category:Obtaining PC-BSD]]<br /> [[category:Referred by pcbsd.org]]<br /> &lt;/noinclude&gt;</div>

Krismoore http://wiki.pcbsd.org/index.php/PC-BSD%C2%AE_9.2_TODO 2012-07-26T21:22:40Z

<p>Krismoore: /* New Features / Tools planned for 9.2 */</p> <hr /> <div>==== New Features / Tools planned for 9.2 ====<br /> {| border=1<br /> |'''Feature'''<br /> |'''Owner'''<br /> |'''Skills'''<br /> |'''Status'''<br /> |'''Completion Date'''<br /> |-<br /> |Enable PEFS via User-Manager, allowing encrypted home directories<br /> |kmoore<br /> |QT4/Shell/Sys<br /> |<br /> |<br /> |-<br /> |add iSCSI initiator GUI front-end to iscontrol(8) for connecting to FreeNAS™ systems<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |replace firewall GUI with fwbuilder and document how to use<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |add Info button to Service Manager containing description<br /> |<br /> |<br /> |should really be a DESCRIPTION field in rc.d scripts<br /> |<br /> |-<br /> |Animated splash screen<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add help buttons to custom menus, write help text and add to Pootle<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |Front-end to text installer<br /> |jhixson<br /> |<br /> |<br /> |<br /> |-<br /> |Create new Disk Management GUI for post-install usage, ZFS, Advanced FS tasks such as ZFS snapshots, ZFS quota/compression<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Add option to play some simple games while waiting for installation<br /> |kris<br /> |C++ / QT4 / shell<br /> |<br /> |<br /> |-<br /> |Add ability to backup ZFS datasets (in life preserver?)<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add password strength meter to installer and warn if root / user are same. <br /> |kmoore<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Localize the meta-pkg descriptions<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |C++ / QT CUPS GUI<br /> | Loic Maury<br /> |C++ / C<br /> |<br /> |<br /> |-<br /> |Switch LifePreserver to use /var/ for its backend files<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> | changing default language / locale for GDM in pc-sysinstall<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add Update All to Appcafe<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add option to wireless settings in network manager to select country code<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add directory tree to AppCafe. On app page, at top show Home -&gt; Category -&gt; AppName, clickable<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Add enable / disable startup warden buttons<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Display fetch size / speed on warden downloads<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Display more info about devices in hardware compat GUI<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |the psk for WPA networks should be hashed with wpa_passphrase(8)<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Add some kind of low disk space framework that detects both UFS + ZFS space<br /> |kmoore<br /> |C++ / Shell / libpcbsd<br /> |<br /> |<br /> |-<br /> |}<br /> [[category:PC-BSD Wiki]]<br /> [[category:TODO Lists]]</div>

Krismoore http://wiki.pcbsd.org/index.php/PC-BSD%C2%AE_9.2_TODO 2012-07-24T19:28:12Z

<p>Krismoore: /* New Features / Tools planned for 9.2 */</p> <hr /> <div>==== New Features / Tools planned for 9.2 ====<br /> {| border=1<br /> |'''Feature'''<br /> |'''Owner'''<br /> |'''Skills'''<br /> |'''Status'''<br /> |'''Completion Date'''<br /> |-<br /> |Enable PEFS via User-Manager, allowing encrypted home directories<br /> |kmoore<br /> |QT4/Shell/Sys<br /> |<br /> |<br /> |-<br /> |add iSCSI initiator GUI front-end to iscontrol(8) for connecting to FreeNAS™ systems<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |replace firewall GUI with fwbuilder and document how to use<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |add Info button to Service Manager containing description<br /> |<br /> |<br /> |should really be a DESCRIPTION field in rc.d scripts<br /> |<br /> |-<br /> |Animated splash screen<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add help buttons to custom menus, write help text and add to Pootle<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |Front-end to text installer<br /> |jhixson<br /> |<br /> |<br /> |<br /> |-<br /> |Create new Disk Management GUI for post-install usage, ZFS, Advanced FS tasks such as ZFS snapshots, ZFS quota/compression<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Add option to play some simple games while waiting for installation<br /> |kris<br /> |C++ / QT4 / shell<br /> |<br /> |<br /> |-<br /> |Add ability to backup ZFS datasets (in life preserver?)<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add password strength meter to installer and warn if root / user are same. <br /> |kmoore<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Localize the meta-pkg descriptions<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |C++ / QT CUPS GUI<br /> | Loic Maury<br /> |C++ / C<br /> |<br /> |<br /> |-<br /> |Switch LifePreserver to use /var/ for its backend files<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> | changing default language / locale for GDM in pc-sysinstall<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add Update All to Appcafe<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add option to wireless settings in network manager to select country code<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add directory tree to AppCafe. On app page, at top show Home -&gt; Category -&gt; AppName, clickable<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Add enable / disable startup warden buttons<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Display fetch size / speed on warden downloads<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Display more info about devices in hardware compat GUI<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |the psk for WPA networks should be hashed with wpa_passphrase(8)<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |}<br /> [[category:PC-BSD Wiki]]<br /> [[category:TODO Lists]]</div>

Krismoore http://wiki.pcbsd.org/index.php/PC-BSD%C2%AE_9.2_TODO 2012-07-24T19:05:29Z

<p>Krismoore: /* New Features / Tools planned for 9.2 */</p> <hr /> <div>==== New Features / Tools planned for 9.2 ====<br /> {| border=1<br /> |'''Feature'''<br /> |'''Owner'''<br /> |'''Skills'''<br /> |'''Status'''<br /> |'''Completion Date'''<br /> |-<br /> |Enable PEFS via User-Manager, allowing encrypted home directories<br /> |kmoore<br /> |QT4/Shell/Sys<br /> |<br /> |<br /> |-<br /> |add iSCSI initiator GUI front-end to iscontrol(8) for connecting to FreeNAS™ systems<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |replace firewall GUI with fwbuilder and document how to use<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |add Info button to Service Manager containing description<br /> |<br /> |<br /> |should really be a DESCRIPTION field in rc.d scripts<br /> |<br /> |-<br /> |Animated splash screen<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add help buttons to custom menus, write help text and add to Pootle<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |Front-end to text installer<br /> |jhixson<br /> |<br /> |<br /> |<br /> |-<br /> |Create new Disk Management GUI for post-install usage, ZFS, Advanced FS tasks such as ZFS snapshots, ZFS quota/compression<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Add option to play some simple games while waiting for installation<br /> |kris<br /> |C++ / QT4 / shell<br /> |<br /> |<br /> |-<br /> |Add ability to backup ZFS datasets (in life preserver?)<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add password strength meter to installer and warn if root / user are same. <br /> |kmoore<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Localize the meta-pkg descriptions<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |C++ / QT CUPS GUI<br /> | Loic Maury<br /> |C++ / C<br /> |<br /> |<br /> |-<br /> |Switch LifePreserver to use /var/ for its backend files<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> | changing default language / locale for GDM in pc-sysinstall<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add Update All to Appcafe<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add option to wireless settings in network manager to select country code<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add directory tree to AppCafe. On app page, at top show Home -&gt; Category -&gt; AppName, clickable<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Add enable / disable startup warden buttons<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Display fetch size / speed on warden downloads<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Display more info about devices in hardware compat GUI<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |}<br /> [[category:PC-BSD Wiki]]<br /> [[category:TODO Lists]]</div>

Krismoore http://wiki.pcbsd.org/index.php/PC-BSD%C2%AE_9.2_TODO 2012-07-24T18:46:16Z

<p>Krismoore: /* New Features / Tools planned for 9.2 */</p> <hr /> <div>==== New Features / Tools planned for 9.2 ====<br /> {| border=1<br /> |'''Feature'''<br /> |'''Owner'''<br /> |'''Skills'''<br /> |'''Status'''<br /> |'''Completion Date'''<br /> |-<br /> |Enable PEFS via User-Manager, allowing encrypted home directories<br /> |kmoore<br /> |QT4/Shell/Sys<br /> |<br /> |<br /> |-<br /> |add iSCSI initiator GUI front-end to iscontrol(8) for connecting to FreeNAS™ systems<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |replace firewall GUI with fwbuilder and document how to use<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |add Info button to Service Manager containing description<br /> |<br /> |<br /> |should really be a DESCRIPTION field in rc.d scripts<br /> |<br /> |-<br /> |Animated splash screen<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add help buttons to custom menus, write help text and add to Pootle<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |Front-end to text installer<br /> |jhixson<br /> |<br /> |<br /> |<br /> |-<br /> |Create new Disk Management GUI for post-install usage, ZFS, Advanced FS tasks such as ZFS snapshots, ZFS quota/compression<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Add option to play some simple games while waiting for installation<br /> |kris<br /> |C++ / QT4 / shell<br /> |<br /> |<br /> |-<br /> |Add ability to backup ZFS datasets (in life preserver?)<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add password strength meter to installer and warn if root / user are same. <br /> |kmoore<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Localize the meta-pkg descriptions<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |C++ / QT CUPS GUI<br /> | Loic Maury<br /> |C++ / C<br /> |<br /> |<br /> |-<br /> |Switch LifePreserver to use /var/ for its backend files<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> | changing default language / locale for GDM in pc-sysinstall<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add Update All to Appcafe<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add option to wireless settings in network manager to select country code<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add directory tree to AppCafe. On app page, at top show Home -&gt; Category -&gt; AppName, clickable<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Add enable / disable startup warden buttons<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Display fetch size / speed on warden downloads<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |}<br /> [[category:PC-BSD Wiki]]<br /> [[category:TODO Lists]]</div>

Krismoore http://wiki.pcbsd.org/index.php/PC-BSD%C2%AE_9.2_TODO 2012-07-24T18:40:50Z

<p>Krismoore: /* New Features / Tools planned for 9.2 */</p> <hr /> <div>==== New Features / Tools planned for 9.2 ====<br /> {| border=1<br /> |'''Feature'''<br /> |'''Owner'''<br /> |'''Skills'''<br /> |'''Status'''<br /> |'''Completion Date'''<br /> |-<br /> |Enable PEFS via User-Manager, allowing encrypted home directories<br /> |kmoore<br /> |QT4/Shell/Sys<br /> |<br /> |<br /> |-<br /> |add iSCSI initiator GUI front-end to iscontrol(8) for connecting to FreeNAS™ systems<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |replace firewall GUI with fwbuilder and document how to use<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |add Info button to Service Manager containing description<br /> |<br /> |<br /> |should really be a DESCRIPTION field in rc.d scripts<br /> |<br /> |-<br /> |Animated splash screen<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add help buttons to custom menus, write help text and add to Pootle<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |Front-end to text installer<br /> |jhixson<br /> |<br /> |<br /> |<br /> |-<br /> |Create new Disk Management GUI for post-install usage, ZFS, Advanced FS tasks such as ZFS snapshots, ZFS quota/compression<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Add option to play some simple games while waiting for installation<br /> |kris<br /> |C++ / QT4 / shell<br /> |<br /> |<br /> |-<br /> |Add ability to backup ZFS datasets (in life preserver?)<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add password strength meter to installer and warn if root / user are same. <br /> |kmoore<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Localize the meta-pkg descriptions<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |C++ / QT CUPS GUI<br /> | Loic Maury<br /> |C++ / C<br /> |<br /> |<br /> |-<br /> |Switch LifePreserver to use /var/ for its backend files<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> | changing default language / locale for GDM in pc-sysinstall<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add Update All to Appcafe<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add option to wireless settings in network manager to select country code<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add directory tree to AppCafe. On app page, at top show Home -&gt; Category -&gt; AppName, clickable<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |}<br /> [[category:PC-BSD Wiki]]<br /> [[category:TODO Lists]]</div>

Krismoore http://wiki.pcbsd.org/index.php/PC-BSD%C2%AE_9.1_TODO 2012-07-16T20:04:05Z

<p>Krismoore: /* New Features / Tools planned for 9.1 */</p> <hr /> <div>==== New Features / Tools planned for 9.1 ====<br /> {| border=1<br /> |'''Feature'''<br /> |'''Owner'''<br /> |'''Skills'''<br /> |'''Status'''<br /> |'''Completion Date'''<br /> |-<br /> |add inmate browser to Warden GUI<br /> |kmoore<br /> |<br /> |Obsolete now, with meta-pkg support for Jails<br /> |9.1 (7-16-2012)<br /> |-<br /> |Add system info desktop icon to live mode<br /> |kmoore<br /> |<br /> |'''DONE'''<br /> |7-5-12 [[http://trac.pcbsd.org/changeset/17643 17643]]<br /> |-<br /> |Use the [http://wiki.freebsd.org/OliverFromme/BootLoader Graphical Boot Loader] from OliverFromme<br /> |<br /> |C / FreeBSD Commit Access / ?<br /> |DONE<br /> |In 9.0<br /> |-<br /> |Add options for proxy settings in network page of installer<br /> |kris<br /> |C++ / QT4<br /> |'''DONE'''<br /> |5-31-2012 [[http://trac.pcbsd.org/changeset/17119 17119]]<br /> |-<br /> |Speed up installed boot-time, background system services / load desktop immediately?<br /> |kris<br /> |FreeBSD rc.d / Scripting?<br /> |'''DONE'''<br /> |1-16-2012 [[http://trac.pcbsd.org/changeset/14866 14866]]<br /> |-<br /> |Add manual disk configuration to installer and install to specific mount-point<br /> |kris<br /> |C++ / QT4 / shell<br /> |'''DONE'''<br /> |2-17-2012 [[http://trac.pcbsd.org/changeset/15467 15467]]<br /> |-<br /> |Merge Warden® into PC-BSD SVN as a built-in tool for managing jails<br /> |kmoore<br /> |C++ / QT4 / Shell<br /> |'''DONE'''<br /> |<br /> |-<br /> |Show meta-pkg port lists in installer / system tool<br /> |kmoore<br /> |C++ / Shell<br /> |'''DONE'''<br /> |<br /> |-<br /> |Bluetooth GUI<br /> |ken<br /> |<br /> |'''DONE'''<br /> |<br /> |-<br /> |allow pc-sysinstall to import existing ZFS layout<br /> |Kris<br /> |C++<br /> |'''DONE'''<br /> |[[http://trac.pcbsd.org/changeset/15467 15467]]<br /> |-<br /> |Update network GUI to set DNS manually in /etc/dhclient.conf when not using static IPs. <br /> |kmoore<br /> |<br /> |'''DONE'''<br /> |<br /> |-<br /> |Add setting to automatically create desktop / menu icons upon appcafe installations <br /> |kmoore<br /> |C++/QT<br /> |'''DONE'''<br /> |<br /> |-<br /> |In pc-sysinstaller GUI, show native language strings when selecting the initial language, not the english version. <br /> |kmoore<br /> |C++/QT<br /> |'''DONE'''<br /> |<br /> |-<br /> |Create sound mixer control panel app, let user pick default sound device, mixer settings<br /> |kmoore<br /> |C++/QT<br /> |'''DONE'''<br /> |7-16-2012 [[http://trac.pcbsd.org/changeset/17653 17653]]<br /> |-<br /> |Add TRIM support to pc-sysinstall<br /> |kmoore<br /> |<br /> |'''DONE'''<br /> |7-16-2012 [[http://trac.pcbsd.org/changeset/17782 17782]]<br /> |-<br /> |}<br /> [[category:PC-BSD Wiki]]<br /> [[category:TODO Lists]]</div>

Krismoore http://wiki.pcbsd.org/index.php/PC-BSD%C2%AE_9.2_TODO 2012-07-16T20:03:09Z

<p>Krismoore: /* New Features / Tools planned for 9.2 */</p> <hr /> <div>==== New Features / Tools planned for 9.2 ====<br /> {| border=1<br /> |'''Feature'''<br /> |'''Owner'''<br /> |'''Skills'''<br /> |'''Status'''<br /> |'''Completion Date'''<br /> |-<br /> |Enable PEFS via User-Manager, allowing encrypted home directories<br /> |kmoore<br /> |QT4/Shell/Sys<br /> |<br /> |<br /> |-<br /> |add iSCSI initiator GUI front-end to iscontrol(8) for connecting to FreeNAS™ systems<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |replace firewall GUI with fwbuilder and document how to use<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |add Info button to Service Manager containing description<br /> |<br /> |<br /> |should really be a DESCRIPTION field in rc.d scripts<br /> |<br /> |-<br /> |Animated splash screen<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add help buttons to custom menus, write help text and add to Pootle<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |Front-end to text installer<br /> |jhixson<br /> |<br /> |<br /> |<br /> |-<br /> |Create new Disk Management GUI for post-install usage, ZFS, Advanced FS tasks such as ZFS snapshots, ZFS quota/compression<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Add option to play some simple games while waiting for installation<br /> |kris<br /> |C++ / QT4 / shell<br /> |<br /> |<br /> |-<br /> |Add ability to backup ZFS datasets (in life preserver?)<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add password strength meter to installer and warn if root / user are same. <br /> |kmoore<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Localize the meta-pkg descriptions<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |C++ / QT CUPS GUI<br /> | Loic Maury<br /> |C++ / C<br /> |<br /> |<br /> |-<br /> |Switch LifePreserver to use /var/ for its backend files<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> | changing default language / locale for GDM in pc-sysinstall<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add Update All to Appcafe<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add option to wireless settings in network manager to select country code<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |}<br /> [[category:PC-BSD Wiki]]<br /> [[category:TODO Lists]]</div>

Krismoore http://wiki.pcbsd.org/index.php/PC-BSD%C2%AE_9.2_TODO 2012-07-16T19:21:40Z

<p>Krismoore: </p> <hr /> <div>==== New Features / Tools planned for 9.2 ====<br /> {| border=1<br /> |'''Feature'''<br /> |'''Owner'''<br /> |'''Skills'''<br /> |'''Status'''<br /> |'''Completion Date'''<br /> |-<br /> |Enable PEFS via User-Manager, allowing encrypted home directories<br /> |kmoore<br /> |QT4/Shell/Sys<br /> |<br /> |<br /> |-<br /> |add iSCSI initiator GUI front-end to iscontrol(8) for connecting to FreeNAS™ systems<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |replace firewall GUI with fwbuilder and document how to use<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |add Info button to Service Manager containing description<br /> |<br /> |<br /> |should really be a DESCRIPTION field in rc.d scripts<br /> |<br /> |-<br /> |Animated splash screen<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add help buttons to custom menus, write help text and add to Pootle<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |Front-end to text installer<br /> |jhixson<br /> |<br /> |<br /> |<br /> |-<br /> |Create new Disk Management GUI for post-install usage, ZFS, Advanced FS tasks such as ZFS snapshots, ZFS quota/compression<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Add option to play some simple games while waiting for installation<br /> |kris<br /> |C++ / QT4 / shell<br /> |<br /> |<br /> |-<br /> |Add ability to backup ZFS datasets (in life preserver?)<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add password strength meter to installer and warn if root / user are same. <br /> |kmoore<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Localize the meta-pkg descriptions<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |C++ / QT CUPS GUI<br /> | Loic Maury<br /> |C++ / C<br /> |<br /> |<br /> |-<br /> |Switch LifePreserver to use /var/ for its backend files<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> | changing default language / locale for GDM in pc-sysinstall<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add Update All to Appcafe<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add TRIM support to pc-sysinstall / GUI<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add option to wireless settings in network manager to select country code<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |}<br /> [[category:PC-BSD Wiki]]<br /> [[category:TODO Lists]]</div>

Krismoore http://wiki.pcbsd.org/index.php/PC-BSD%C2%AE_version_task_list 2012-07-16T19:16:12Z

<p>Krismoore: </p> <hr /> <div>{{NavHome}}<br /> * [[PC-BSD 7.2 TODO|PC-BSD 7.2 Task List]]<br /> <br /> * [[PC-BSD 8.0 TODO|PC-BSD 8.0 Task List]]<br /> <br /> * [[PC-BSD 8.1 TODO|PC-BSD 8.1 Task List]]<br /> <br /> * [[PC-BSD 8.2 TODO|PC-BSD 8.2 Task List]]<br /> <br /> * [[PC-BSD 9.0 TODO|PC-BSD 9.0 Task List]]<br /> <br /> * [[PC-BSD 9.1 TODO|PC-BSD 9.1 Task List]]<br /> <br /> * [[PC-BSD 9.2 TODO|PC-BSD 9.2 Task List]]<br /> <br /> * [[PC-BSD Life Cycle|PC-BSD Life Cycle ]]</div>

Krismoore http://wiki.pcbsd.org/index.php/PC-BSD%C2%AE_9.1_TODO 2012-07-16T19:14:06Z

<p>Krismoore: /* New Features / Tools planned for 9.1 */</p> <hr /> <div>==== New Features / Tools planned for 9.1 ====<br /> {| border=1<br /> |'''Feature'''<br /> |'''Owner'''<br /> |'''Skills'''<br /> |'''Status'''<br /> |'''Completion Date'''<br /> |-<br /> |add inmate browser to Warden GUI<br /> |kmoore<br /> |<br /> |Obsolete now, with meta-pkg support for Jails<br /> |9.1 (7-16-2012)<br /> |-<br /> |Add system info desktop icon to live mode<br /> |kmoore<br /> |<br /> |'''DONE'''<br /> |7-5-12 [[http://trac.pcbsd.org/changeset/17643 17643]]<br /> |-<br /> |Use the [http://wiki.freebsd.org/OliverFromme/BootLoader Graphical Boot Loader] from OliverFromme<br /> |<br /> |C / FreeBSD Commit Access / ?<br /> |DONE<br /> |In 9.0<br /> |-<br /> |Add options for proxy settings in network page of installer<br /> |kris<br /> |C++ / QT4<br /> |'''DONE'''<br /> |5-31-2012 [[http://trac.pcbsd.org/changeset/17119 17119]]<br /> |-<br /> |Speed up installed boot-time, background system services / load desktop immediately?<br /> |kris<br /> |FreeBSD rc.d / Scripting?<br /> |'''DONE'''<br /> |1-16-2012 [[http://trac.pcbsd.org/changeset/14866 14866]]<br /> |-<br /> |Add manual disk configuration to installer and install to specific mount-point<br /> |kris<br /> |C++ / QT4 / shell<br /> |'''DONE'''<br /> |2-17-2012 [[http://trac.pcbsd.org/changeset/15467 15467]]<br /> |-<br /> |Merge Warden® into PC-BSD SVN as a built-in tool for managing jails<br /> |kmoore<br /> |C++ / QT4 / Shell<br /> |'''DONE'''<br /> |<br /> |-<br /> |Show meta-pkg port lists in installer / system tool<br /> |kmoore<br /> |C++ / Shell<br /> |'''DONE'''<br /> |<br /> |-<br /> |Bluetooth GUI<br /> |ken<br /> |<br /> |'''DONE'''<br /> |<br /> |-<br /> |allow pc-sysinstall to import existing ZFS layout<br /> |Kris<br /> |C++<br /> |'''DONE'''<br /> |[[http://trac.pcbsd.org/changeset/15467 15467]]<br /> |-<br /> |Update network GUI to set DNS manually in /etc/dhclient.conf when not using static IPs. <br /> |kmoore<br /> |<br /> |'''DONE'''<br /> |<br /> |-<br /> |Add setting to automatically create desktop / menu icons upon appcafe installations <br /> |kmoore<br /> |C++/QT<br /> |'''DONE'''<br /> |<br /> |-<br /> |In pc-sysinstaller GUI, show native language strings when selecting the initial language, not the english version. <br /> |kmoore<br /> |C++/QT<br /> |'''DONE'''<br /> |<br /> |-<br /> |Create sound mixer control panel app, let user pick default sound device, mixer settings<br /> |kmoore<br /> |C++/QT<br /> |'''DONE'''<br /> |7-16-2012 [[http://trac.pcbsd.org/changeset/17653 17653]]<br /> |-<br /> |}<br /> [[category:PC-BSD Wiki]]<br /> [[category:TODO Lists]]</div>

Krismoore http://wiki.pcbsd.org/index.php/PC-BSD%C2%AE_9.2_TODO 2012-07-16T19:08:21Z

<p>Krismoore: Created page with &quot;==== New Features / Tools planned for 9.2 ==== {| border=1 |'''Feature''' |'''Owner''' |'''Skills''' |'''Status''' |'''Completion Date''' |- |add iSCSI initiator GUI front-end...&quot;</p> <hr /> <div>==== New Features / Tools planned for 9.2 ====<br /> {| border=1<br /> |'''Feature'''<br /> |'''Owner'''<br /> |'''Skills'''<br /> |'''Status'''<br /> |'''Completion Date'''<br /> |-<br /> |add iSCSI initiator GUI front-end to iscontrol(8) for connecting to FreeNAS™ systems<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |replace firewall GUI with fwbuilder and document how to use<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |add Info button to Service Manager containing description<br /> |<br /> |<br /> |should really be a DESCRIPTION field in rc.d scripts<br /> |<br /> |-<br /> |Animated splash screen<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add help buttons to custom menus, write help text and add to Pootle<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |Front-end to text installer<br /> |jhixson<br /> |<br /> |<br /> |<br /> |-<br /> |Create new Disk Management GUI for post-install usage, ZFS, Advanced FS tasks such as ZFS snapshots, ZFS quota/compression<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Add option to play some simple games while waiting for installation<br /> |kris<br /> |C++ / QT4 / shell<br /> |<br /> |<br /> |-<br /> |Add ability to backup ZFS datasets (in life preserver?)<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add password strength meter to installer and warn if root / user are same. <br /> |kmoore<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Localize the meta-pkg descriptions<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |C++ / QT CUPS GUI<br /> | Loic Maury<br /> |C++ / C<br /> |<br /> |<br /> |-<br /> |Switch LifePreserver to use /var/ for its backend files<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> | changing default language / locale for GDM in pc-sysinstall<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add Update All to Appcafe<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add TRIM support to pc-sysinstall / GUI<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add option to wireless settings in network manager to select country code<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |}<br /> [[category:PC-BSD Wiki]]<br /> [[category:TODO Lists]]</div>

Krismoore http://wiki.pcbsd.org/index.php/PC-BSD%C2%AE_9.1_TODO 2012-07-16T18:43:38Z

<p>Krismoore: /* New Features / Tools planned for 9.1 */</p> <hr /> <div>==== New Features / Tools planned for 9.1 ====<br /> {| border=1<br /> |'''Feature'''<br /> |'''Owner'''<br /> |'''Skills'''<br /> |'''Status'''<br /> |'''Completion Date'''<br /> |-<br /> |add inmate browser to Warden GUI<br /> |kmoore<br /> |<br /> |Obsolete now, with meta-pkg support for Jails<br /> |9.1 (7-16-2012)<br /> |-<br /> |add iSCSI initiator GUI front-end to iscontrol(8) for connecting to FreeNAS™ systems<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |replace firewall GUI with fwbuilder and document how to use<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |add Info button to Service Manager containing description<br /> |<br /> |<br /> |should really be a DESCRIPTION field in rc.d scripts<br /> |<br /> |-<br /> |Animated splash screen<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add system info desktop icon to live mode<br /> |kmoore<br /> |<br /> |'''DONE'''<br /> |7-5-12 [[http://trac.pcbsd.org/changeset/17643 17643]]<br /> |-<br /> |Add help buttons to custom menus, write help text and add to Pootle<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |Use the [http://wiki.freebsd.org/OliverFromme/BootLoader Graphical Boot Loader] from OliverFromme<br /> |<br /> |C / FreeBSD Commit Access / ?<br /> |DONE<br /> |In 9.0<br /> |-<br /> |Front-end to text installer<br /> |jhixson<br /> |<br /> |<br /> |<br /> |-<br /> |Add options for proxy settings in network page of installer<br /> |kris<br /> |C++ / QT4<br /> |'''DONE'''<br /> |5-31-2012 [[http://trac.pcbsd.org/changeset/17119 17119]]<br /> |-<br /> |Speed up installed boot-time, background system services / load desktop immediately?<br /> |kris<br /> |FreeBSD rc.d / Scripting?<br /> |'''DONE'''<br /> |1-16-2012 [[http://trac.pcbsd.org/changeset/14866 14866]]<br /> |-<br /> |Create new Disk Management GUI for post-install usage, ZFS, Advanced FS tasks such as ZFS snapshots, ZFS quota/compression<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Add manual disk configuration to installer and install to specific mount-point<br /> |kris<br /> |C++ / QT4 / shell<br /> |'''DONE'''<br /> |2-17-2012 [[http://trac.pcbsd.org/changeset/15467 15467]]<br /> |-<br /> |Add option to play some simple games while waiting for installation<br /> |kris<br /> |C++ / QT4 / shell<br /> |<br /> |<br /> |-<br /> |Add ability to backup ZFS datasets (in life preserver?)<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Merge Warden® into PC-BSD SVN as a built-in tool for managing jails<br /> |kmoore<br /> |C++ / QT4 / Shell<br /> |'''DONE'''<br /> |<br /> |-<br /> |Add password strength meter to installer and warn if root / user are same. <br /> |kmoore<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Localize the meta-pkg descriptions<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |Show meta-pkg port lists in installer / system tool<br /> |kmoore<br /> |C++ / Shell<br /> |'''DONE'''<br /> |<br /> |-<br /> |C++ / QT CUPS GUI<br /> | Loic Maury<br /> |C++ / C<br /> |<br /> |<br /> |-<br /> |Switch LifePreserver to use /var/ for its backend files<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |Bluetooth GUI<br /> |ken<br /> |<br /> |'''DONE'''<br /> |<br /> |-<br /> |allow pc-sysinstall to import existing ZFS layout<br /> |Kris<br /> |C++<br /> |'''DONE'''<br /> |[[http://trac.pcbsd.org/changeset/15467 15467]]<br /> |-<br /> | changing default language / locale for GDM in pc-sysinstall<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add Update All to Appcafe<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add TRIM support to pc-sysinstall / GUI<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Update network GUI to set DNS manually in /etc/dhclient.conf when not using static IPs. <br /> |kmoore<br /> |<br /> |'''DONE'''<br /> |<br /> |-<br /> |Add setting to automatically create desktop / menu icons upon appcafe installations <br /> |kmoore<br /> |C++/QT<br /> |'''DONE'''<br /> |<br /> |-<br /> |In pc-sysinstaller GUI, show native language strings when selecting the initial language, not the english version. <br /> |kmoore<br /> |C++/QT<br /> |'''DONE'''<br /> |<br /> |-<br /> |add option to wireless settings in network manager to select country code<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Create sound mixer control panel app, let user pick default sound device, mixer settings<br /> |kmoore<br /> |C++/QT<br /> |'''DONE'''<br /> |7-16-2012 [[http://trac.pcbsd.org/changeset/17653 17653]]<br /> |-<br /> |}<br /> [[category:PC-BSD Wiki]]<br /> [[category:TODO Lists]]</div>

Krismoore http://wiki.pcbsd.org/index.php/Meta_Package_Manager 2012-04-30T16:50:16Z

<p>Krismoore: </p> <hr /> <div>&lt;noinclude&gt;{{NavHeader|back=Update Manager|forward=Control Panel}}&lt;/noinclude&gt;<br /> == Description ==<br /> <br /> pc-metapkgmanger is the CLI utility used by the PC-BSD system manager and update utilities for managing collections of FreeBSD packages in PC-BSD, also know as a &quot;meta-package&quot;. It includes the ability to switch between pkgsets, such as &quot;pcbsd&quot; for the desktop, or &quot;warden&quot; for jailed environments or a PC-BSD server installation. <br /> <br /> == Usage ==<br /> <br /> <br /> &lt;code&gt;<br /> pc-metapkgmanager [options]<br /> <br /> Options:<br /> add pkg1,pkg2 &lt;loc&gt; -- Add the specified list of meta-packages <br /> &lt;loc&gt; should be a FTP / HTTP url where pkg_add can fetch packages, or an absolute path to location of pkg files on disk.<br /> checkup -- Check for updates to pkgs<br /> del pkg1,pkg2 -- Delete the specified list of meta-packages<br /> list -- List the available meta-packages<br /> status &lt;pkg&gt; -- List the status of the specified meta-packages<br /> update pkg1,pkg2 &lt;loc&gt; -- Update all system packages, or just &lt;pkg&gt; if specified<br /> &lt;loc&gt; should be a FTP / HTTP url where pkg_add can fetch packages, or an absolute path to location of pkg files on disk.<br /> --pkgset &lt;pkgset&gt; -- Change default pkgset we are using<br /> --chroot &lt;dir&gt; -- Operate on the directory specififed using chroot<br /> &lt;/code&gt;<br /> <br /> == Configuration ==<br /> The default pkgset can be changed by editing /usr/local/etc/pcbsd.conf and editing the PCBSD_METAPKGSET variable. <br /> <br /> == Examples ==<br /> pc-metapkgmanger add LXDE,XFCE,GNOME http://mirrors.isc.org/pub/pcbsd/9.0/amd64/netinstall/packages/<br /> <br /> pc-metapkgmanager del LXDE,GNOME<br /> <br /> <br /> &lt;noinclude&gt;<br /> [[category:handbook]]<br /> &lt;/noinclude&gt;</div>

Krismoore http://wiki.pcbsd.org/index.php/PBI_Module_Builder_Guide 2012-02-22T16:28:49Z

<p>Krismoore: /* PBI Module Components */</p> <hr /> <div>&lt;noinclude&gt;{{NavHeader|back=Test PBIs|forward=Purchase PC-BSD Swag}}&lt;/noinclude&gt;<br /> PC-BSD provides a unique file format known as a PBI (push button installer). PBI files end with the .pbi extension and are self-contained installation programs. This means that even novice users can safely install and uninstall PBIs without inadvertently overwriting or deleting files needed by the operating system or other applications.<br /> <br /> A PBI file includes all the runtime and library dependencies required by the application. This means that a PBI is a large file, but this does not necessarily mean that the installed PBI will be that large. During installation, the PBI system compares the currently installed libraries and files with the ones contained within the PBI file and only installs the ones that are not already installed on the system. A hash database is used to eliminate dependency problems while allowing the computer to share libraries between different programs. <br /> <br /> On PC-BSD, PBIs can be installed using the graphical [[Using AppCafe™ | AppCafe™]] utility or from the command line using [[PBI Manager]].<br /> <br /> The PBI format changed between PC-BSD 8.x and 9.x. This section demonstrates how to create PBIs for PC-BSD 9.x and higher. [[Building PBIs for PC-BSD 8.x and Earlier]] describes the old format, but is considered to be deprecated.<br /> <br /> === Building PBIs for PC-BSD 9.x and higher ===<br /> <br /> Creating a PBI from an existing FreeBSD port is a surprisingly easy and automated process that does not require development skills. Some ports are effortless to convert while more complex ports may require some thought and simple scripting.<br /> <br /> Two utilities are available for converting FreeBSD ports into PBIs. EasyPBI provides a graphical interface and '''pbi_makeport''' provides a command line utility. This section demonstrates how to use both of these tools, explains the components of a PBI module, and provides some troubleshooting tips.<br /> <br /> '''NOTE:''' before creating a PBI, check to see if one exists using the instructions in [[Submit PBI Requests]]. If you decide that you prefer to request a PBI that you need rather than to create one, that page also contains instructions for submitting a PBI request.<br /> <br /> ====Using EasyPBI====<br /> <br /> EasyPBI is a new GUI application created by Jesse Smith and Ken Moore. It streamlines the process of building a PBI from a FreeBSD port. EasyPBI can be installed using AppCafe™ without any additional requirements on a PC-BSD system. For a pure FreeBSD system, you will need to install both the ''sysutils/easypbi'' and ''ports-mgmt/pbi-manager'' ports.<br /> <br /> To run the program, either double-click the EasyPBI desktop icon or type '''EasyPBI''' as your regular user account. This will open the screen shown in Figure 10.7a. Depending upon whether or not ports is installed, you may first receive a pop-up message.<br /> <br /> '''Figure 10.7a: EasyPBI Graphical Interface'''<br /> <br /> [[File:Easypbi.jpeg]]<br /> <br /> To build a PBI using EasyPBI:<br /> <br /> '''1. Create a module for the desired FreeBSD port:''' when you first start EasyPBI, it will check to see if the FreeBSD ports tree is installed into ''/usr/ports''. If it is not, a pop-up message will indicate that you have a choice on how to install the ports tree. If you want the system ports tree to be available for any user, go to Control Panel ➜ System Manager ➜ Tasks ➜ Fetch System Ports Tree. Use this method if multiple users will be using the EasyPBI utility. Alternatively, if you only want the ports tree to be available to the current user, click File ➜ Get Ports from within EasyPBI; this will fetch the ports tree and place it in the user's home directory. <br /> <br /> '''NOTE:''' when determining which PBIs need to be built, refer to the [http://forums.pcbsd.org/forumdisplay.php?f=61 PBI Requests forum] to determine which PBI's have been requested by users. You should also check that a module does not already exist on the [http://trac.pcbsd.org/browser#pbi/modules PBI Modules] section of trac.<br /> <br /> To create a new module, click the &quot;New Module&quot; 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 on the GUI. In the example shown in Figure 10.7b, the ''net/xrdesktop'' port has been selected and the fields have been auto-filled in. <br /> <br /> '''Figure 10.7b: Reviewing the Port's Information'''<br /> <br /> [[File:EasyPBI1a.jpeg]]<br /> <br /> You should review these fields for accuracy. In this example, the port's website had changed and an email was sent to the port author so that the URL could be corrected in the port.<br /> <br /> If you click &quot;Get Port Info&quot; [http://freshports.org FreshPorts.org] will open in the default web browser so that you can view additional information about the port. <br /> <br /> A generic icon will be supplied for the module; you can change the default icon by clicking the &quot;Choose Icon&quot; button. When using a custom icon, use 64x64 .png files with transparent backgrounds. <br /> <br /> If the program provides a GUI, check the box &quot;GUI App&quot;. <br /> <br /> Once the port information is complete, click the &quot;Create Module&quot; button and EasyPBI will produce a generic PBI module. A message will indicate the location of the module, as seen in the example in Figure 10.7c:<br /> <br /> '''Figure 10.7c: PBI Module Created'''<br /> <br /> [[File:EasyPBI2a.jpeg]]<br /> <br /> '''2. Build a PBI from the module:''' once your module is created, click on the &quot;Build PBI&quot; tab and click the Select Module button to browse to the module you just created. You should then review the default settings. Figure 10.7d shows the default settings for our example PBI.<br /> <br /> '''Figure 10.7d: The Build PBI Tab'''<br /> <br /> [[File:EasyPBI3.jpeg]]<br /> <br /> The options in this tab allow you to do the following:<br /> <br /> '''Save Settings as Defaults:''' once you are satisfied with the settings, click this button to have EasyPBI remember your settings between uses.<br /> <br /> '''Change Directory:''' allows you to save the output of the build to a different directory.<br /> <br /> '''Change 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, you can use your own digital signature file by browing to its location.<br /> <br /> '''Use TMPFS:''' if your build system has a lot of RAM, selecting this option can speed up the build.<br /> <br /> '''Select Module:''' select the previously created module which you would like to build.<br /> <br /> '''Build PBI:''' starts the build of the PBI using the settings contained within the PBI module. It will prompt you for the superuser password and requires a working Internet connection 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.<br /> <br /> '''Stop Build:''' stops the build process. Click the &quot;Build PBI&quot; button to resume the build.<br /> <br /> '''Save Build Log:''' useful if the build fails.<br /> <br /> You can produce additional modules from the &quot;Create Module&quot; tab while a PBI build is running. <br /> <br /> If the PBI build fails for some reason, you may need to modify the module. 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 as well as the module to the [http://lists.pcbsd.org/mailman/listinfo/pbi-dev pbi-dev mailing list].<br /> <br /> '''3. Test the PBI:''' once the PBI build is complete, a pop-up message will indicate that the PBI finished building successfully. You will find the PBI in the output directory that you specified in Figure 10.7c. To continue with our example, the following commands will install the PBI so that it can be tested. Note the error message that occurs since the PBI has not been signed yet.<br /> <br /> '''cd /home/dru/EasyPBI/PBI'''<br /> '''pbi_add xrdesktop-1.2_2-i386.pbi'''<br /> pbi_add: No digital signature! If you are *SURE* you trust this PBI, re-install with --no-checksig option.<br /> '''pbi_add --no-checksig xrdesktop-1.2_2-i386.pbi'''<br /> Verifying Checksum...OK<br /> Extracting to /usr/pbi/xrdesktop-i386<br /> Installed: xrdesktop-1.2.2<br /> <br /> '''rehash'''<br /> '''/usr/pbi/xrdesktop-i386/bin/xrdesktop'''<br /> <br /> Once installed, specify the full path to the application's binary to make sure that you are testing the PBI's binary. If the application starts and is a GUI, try using all of the menu items to make sure they work as expected. 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 after some Googling, send the error report the [http://lists.pcbsd.org/mailman/listinfo/pbi-dev pbi-dev mailing list].<br /> <br /> Alternately, if everything seems to be working, send the tarball of the PBI to the [http://lists.pcbsd.org/mailman/listinfo/pbi-dev pbi-dev mailing list]. You will find it in the ''EasyPBI/Modules/'' subdirectory. In our example, the name of the tarball is ''/home/dru/EasyPBI/Modules/xrdesktop.tar.gz''.<br /> <br /> ==== Creating a New PBI with '''pbi_makeport''' ====<br /> <br /> Starting in PC-BSD 9.x and higher, '''pbi_makeport''' is included with the operating system. This utility provides an easy way for a user to convert an existing FreeBSD port into a PBI module. The PBI build server builds modules into PBIs which are then made available to users through AppCafe™. '''man pbi_makeport''' provides details on this application's various usage options. <br /> <br /> When running '''pbi_makeport''' it is possible to supply an optional metadata configuration directory which contains additional data used to supplement the port building and the final PBI file. This configuration directory may contain extra icon data for the desktop, install/uninstall scripts, custom '''make''' options and more. <br /> <br /> Examples of 9.x modules can be found at [http://trac.pcbsd.org/browser/pcbsd/current/src-sh/pbi-manager/module-examples Examples in Subversion].<br /> <br /> FreeBSD ports may contain build dependencies, runtime dependencies, and required libraries. When building a PBI, '''pbi_makeport''' automatically<br /> compiles all of the required dependencies, and, when finished compiling, prunes the build dependencies before packaging the PBI file, leaving only the runtime packages and libraries that are required for the program to work. This means that any files which are included in the PBI are necessary for the program to run, and manually removing them will cause the program to fail.<br /> <br /> ====PBI Module Components====<br /> <br /> A PBI module contains the following components. When creating a PBI module, create a directory on your computer to hold the module's components. For example, if you are creating a PBI module for firefox, create a directory called ''firefox/'' and place the following files within that directory. The directory that you create is referred to as ''%PBI_APPDIR%%''. <br /> <br /> '''1. LICENSE File'''<br /> <br /> The text of a license agreement you want the user to click to accept before installation. This file is optional unless the underlying port is restricted and requires the user to accept a license in order to install and use the software.<br /> <br /> '''2. pbi.conf'''<br /> <br /> The ''pbi.conf'' file is mandatory. It is a simple shell script that contains the information needed to build the PBI. Typically this file requires you to modify a few simple variables, such as the name of the program, its location in the ports tree, and the name of its icon. Sometimes you will need to set a few additional variables in order to make sure that required dependencies are included in the PBI. If you get stuck when creating your own ''pbi.conf'', you can view the ''pbi.conf'' file for every PBI module in [http://trac.pcbsd.org/browser#pbi/modules this section] of the PC-BSD trac repository. Here is an example of the ''pbi.conf'' file for firefox: <br /> &lt;nowiki&gt;<br /> #!/bin/sh<br /> # PBI Build Configuration<br /> # Place over-rides and settings here<br /> #<br /> # XDG Desktop Menu Spec:<br /> # http://standards.freedesktop.org/menu-spec/menu-spec-1.0.html<br /> ##############################################################################<br /> <br /> # Program Name<br /> PBI_PROGNAME=&quot;Firefox&quot;<br /> <br /> # Program Website<br /> PBI_PROGWEB=&quot;http://www.mozilla.com&quot;<br /> <br /> # Program Author / Vendor<br /> PBI_PROGAUTHOR=&quot;The Mozilla Foundation&quot;<br /> <br /> # Default Icon (Relative to %%PBI_APPDIR%% or resources/)<br /> PBI_PROGICON=&quot;share/pixmaps/FireFox-128.png&quot;<br /> <br /> # The target port we are building<br /> PBI_MAKEPORT=&quot;www/firefox&quot;<br /> <br /> # Additional options for make.conf<br /> PBI_MAKEOPTS=&quot;PACKAGE_BUILDING=Y<br /> WITH_CUPS=yes<br /> WITH_GECKO=libxul&quot;<br /> <br /> # Ports to build before / after<br /> PBI_MKPORTBEFORE=&quot;&quot;<br /> PBI_MKPORTAFTER=&quot;audio/esound x11-fonts/dejavu x11-themes/qtcurve-gtk2 devel/gconf2 www/firefox-i18n&quot;<br /> <br /> # Exclude List<br /> PBI_EXCLUDELIST=&quot;./include ./share/doc&quot;<br /> <br /> # Increment to trigger rebuild of PBI on build servers<br /> PBI_BUILDKEY=&quot;04&quot;<br /> <br /> # This app needs to install as root<br /> PBI_REQUIRESROOT=&quot;YES&quot;<br /> <br /> # Set the priority of this build <br /> PBI_AB_PRIORITY=&quot;50&quot;<br /> <br /> # Set the files we want to exclude from the shared hashdir<br /> PBI_HASH_EXCLUDES=&quot;lib/firefox/firefox&quot;<br /> <br /> export PBI_PROGNAME PBI_PROGWEB PBI_PROGAUTHOR PBI_PROGICON PBI_MAKEPORT PBI_MAKEOPTS <br /> PBI_MKPORTBEFORE PBI_MKPORTAFTER PBI_BUILDKEY PBI_REQUIRESROOT PBI_EXCLUDELIST&lt;/nowiki&gt;<br /> <br /> Table 10.7a describes the most commonly used variables. When creating your ''pbi.conf'' file, you will want to refer to the FreeBSD port's ''Makefile'' and ''pkg-descr'' to determine which values to use.<br /> <br /> '''Table 10.7a: Commonly Used pbi.conf Variables'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Variable'''}} <br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROGNAME&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|mandatory; should be the same value as PORTNAME&lt;nowiki&gt;=&lt;/nowiki&gt; in the port's ''Makefile'', but capitalized}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROGWEB&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|mandatory unless does not exist; should be the same value as WWW&lt;nowiki&gt;=&lt;/nowiki&gt; in the port's ''pkg-descr''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROGAUTHOR&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|mandatory; often found in the port's ''pkg-descr'' or at the website for the application}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROGICON&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|mandatory path, relative to %PBI_APPDIR%%, to application icon file in png format}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROGREVISION&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|bump up a PBI's revision number; useful when rebuilding a port with new PBI specific options}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_MAKEPORT&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|mandatory; the path to the port within ''/usr/ports/''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_MAKEOPTS&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|optional; set this to the options that you want saved into ''make.conf'' for the port building process (e.g. WITH_CUPS&lt;nowiki&gt;=&lt;/nowiki&gt;YES)}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_MKPORTBEFORE&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|optional; port(s) to build before starting the target port PBI_MAKEPORT}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_MKPORTAFTER&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|optional; port(s) to build after finishing the target port PBI_MAKEPORT}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_BUILDKEY&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|should not be included; this variable is used on the PBI build server to force the rebuild of a PBI that has failed to build}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_REQUIRESROOT&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|set to to YES to require this app to be installed as root; default is NO which allows it to be installed as a regular user }}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_EXCLUDELIST&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|list of files or directories to exclude from the final archive, such as ''./include'' or ''./share''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_AB_PRIORITY&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|may be set by build server administrator; a higher number indicates a greater priority and will be built before lower priority PBIs}} <br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_AB_NOTMPFS&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|set to YES to disable using tmpfs when doing auto-builds on a server}} <br /> |-<br /> {{Tbl-line|align=left|'''PBI_HASH_EXCLUDES&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|set to a space delimited list of files to exclude from merging into the shared hash-dir}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''export'''}}<br /> {{Tbl-line|bg=ff|align=left|mandatory; followed by a list of all of the variables that will be included when the PBI is built}}<br /> |-<br /> |}<br /> <br /> '''3. external-links'''<br /> <br /> The optional ''external-links'' file contains a list of targets to link into the system's LOCALBASE at PBI installation time. This is useful for placing binaries and files in the user's PATH. When building PBIs from a FreeBSD port, this file is usually not needed, as most binaries and files are auto-detected and placed in the LOCALBASE. Example 10.7a shows an example usage:<br /> <br /> '''Example 10.7a: Example external-links File'''<br /> <br /> &lt;nowiki&gt;<br /> # Files to be Sym-Linked into the default LOCALBASE<br /> # One per-line, relative to %%PBI_APPDIR%% and LOCALBASE<br /> # Defaults to keeping any existing files in LOCALBASE<br /> <br /> <br /> # TARGET LINK IN LOCALBASE ACTION<br /> #etc/rc.d/servfoo etc/rc.d/servfoo keep<br /> #include/libfoo.h include/libfoo.h replace<br /> #etc/rc.d/servfoo etc/rc.d/servfoo keep<br /> bin/firefox3 bin/firefox3 binary,nocrash&lt;/nowiki&gt;<br /> <br /> The flags in the ACTION column are as follows:<br /> <br /> * '''keep''': if this file already exists in LOCALBASE, don't overwrite it<br /> <br /> * '''replace''': replace this file in LOCALBASE if it exists<br /> <br /> * '''binary''': this file is an executable<br /> <br /> * '''nocrash''': used for binary files; don't display crash handler if program exits with non-0 status<br /> <br /> * '''linux''': used for binary files; indicates that this is a Linux application, and needs to be run with Linux compat<br /> <br /> '''4. resources/'''<br /> <br /> The ''resources/'' directory can contain extra files you wish copied into the PBI application directory. This is often the best place for icons and other files not included with a port. <br /> <br /> '''5. scripts/'''<br /> <br /> This directory can contain the following scripts:<br /> <br /> * '''post-install.sh''': script run immediately after the extraction of PBI contents to disk<br /> <br /> * '''post-portmake.sh''': script run during building of the PBI file, after the port compile is finished<br /> <br /> * '''pre-portmake.sh''': script run during building of the PBI file, prior to the port compile<br /> <br /> * '''pre-install.sh''': script run before installation of the PBI; return non-0 to halt installation<br /> <br /> * '''pre-remove.sh''': script run before deletion of the PBI file<br /> <br /> Table 10.7b summarizes the variables that may be used in these scripts:<br /> <br /> '''Table 10.7b Supported Variables<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Variable'''}} <br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROGNAME&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|mandatory; should be the same value as PORTNAME&lt;nowiki&gt;=&lt;/nowiki&gt; in the port's ''Makefile'', but capitalized}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROGDIRNAME&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|name of the subdirectory that is created for the PBI in ''/usr/pbi/'' (e.g. &quot;firefox-amd64&quot; for the 64-bit Firefox PBI)}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROGDIRPATH&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|full path to the PBI install directory (e.g. ''/usr/pbi/firefox-amd64/'' for the 64-bit Firefox PBI)}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROGVERSION&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|version of the program - should be the same value as the DISTVERSION in the port's Makefile }}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_RCDIR&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|location of ''rc.d/'' directory used by PBIs, usually ''/usr/local/etc/rc.d'' }}<br /> |-<br /> {{Tbl-line|align=left|'''SYS_LOCALBASE&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|LOCALBASE of the default system, typically ''/usr/local'' }}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_FAKEBIN_DIR&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|the binary wrapper directory, typically ''/usr/pbi/&lt;pbidir&gt;/.sbin/'' }}<br /> |-<br /> |} <br /> <br /> '''6. xdg-menu/ and xdg-desktop/'''<br /> <br /> The ''xdg-menu/'' and ''xdg-desktop/'' directories can be used to supply menu and desktop icons, respectively. The file that you place in these directories should be in the format ''pbiname.desktop''. Example 10.7b shows the ''firefox.desktop'' files for the firefox PBI:<br /> <br /> '''Example 10.7b: firefox.desktop File'''<br /> <br /> '''more xdg-menu/firefox.desktop'''<br /> #!/usr/bin/env xdg-open<br /> [Desktop Entry]<br /> Value=1.0<br /> Type=Application<br /> Name=FireFox<br /> GenericName=FireFox<br /> Exec=%%PBI_EXEDIR%%/firefox %U<br /> Path=%%PBI_APPDIR%%<br /> Icon=%%PBI_APPDIR%%/share/pixmaps/FireFox-128.png<br /> StartupNotify=true<br /> Categories=Network;<br /> <br /> '''more xdg-desktop/firefox.desktop'''<br /> #!/usr/bin/env xdg-open<br /> [Desktop Entry]<br /> Value=1.0<br /> Type=Application<br /> Name=FireFox<br /> GenericName=FireFox<br /> Exec=%%PBI_EXEDIR%%/firefox %U<br /> Path=%%PBI_APPDIR%%<br /> Icon=%%PBI_APPDIR%%/share/pixmaps/FireFox-128.png<br /> StartupNotify=true <br /> <br /> %%PBI_EXEDIR%% should reference the PBI's executable and any required switches.<br /> <br /> For more details on the XDG menu specifications, please refer to the [http://standards.freedesktop.org/menu-spec/menu-spec-1.0.html freedesktop specifications]. <br /> <br /> '''7. xdg-mime/'''<br /> <br /> The ''xdg-mime/'' directory is used to register file associations according to the [http://standards.freedesktop.org/shared-mime-info-spec/shared-mime-info-spec-latest.html freedesktop MIME specs]. This requires the creation of an XML file. The example shown in Figure 10.7c adds the MIME information for gimp, so that it can be available as an application choice in a web browser:<br /> <br /> '''Example 10.7c: Gimp MIME Info'''<br /> <br /> '''more xdg-mime/gimp-xdg.xml'''<br /> &lt;?xml version=&quot;1.0&quot;?&gt;<br /> &lt;mime-info xmlns='&lt;nowiki&gt;http://www.freedesktop.org/standards/shared-mime-info&lt;/nowiki&gt;'&gt;<br /> &lt;mime-type type=&quot;application/x-gimp&quot;&gt;<br /> &lt;comment&gt;Gimp - XCF File&lt;/comment&gt;<br /> &lt;glob weight=&quot;100&quot; pattern=&quot;*.xcf&quot;/&gt;<br /> &lt;glob weight=&quot;100&quot; pattern=&quot;*.XCF&quot;/&gt;<br /> &lt;/mime-type&gt;<br /> &lt;/mime-info&gt;<br /> <br /> ====Useful Tips====<br /> <br /> If your PBI's executable does not run, it may be because the program executable is actually a wrapper script rather than a binary file. If so, check the first line of the script to make sure it is using the right path for the scripting language. For example, ''#!/bin/python'' is an incorrect path which should be changed to ''#!/usr/pbi/(pbi-name)/bin/python''.<br /> <br /> The suggested path works because each program is packaged with the proper version of the language it uses and you want to make sure it uses that one. This is usually accomplished by putting a quick '''sed''' line in the ''post-install.sh'' script to fix the first line as seen in [http://trac.pcbsd.org/browser/pbi/modules/games/fretsonfire/scripts/post-install.sh?rev=13019 this example].<br /> <br /> When testing the executable, use the one located in ''/usr/pbi/(pbi-name)/bin/'' so all the linking will be properly set up. Otherwise you<br /> can get some interesting errors about missing files.<br /> <br /> = Getting Help =<br /> <br /> The [http://lists.pcbsd.org/mailman/listinfo/pbi-dev PBI Developers mailing list] can help if you:<br /> <br /> * get stuck building a PBI<br /> * need to ask a question about your PBI <br /> * are ready to submit a new module<br /> * find a bug in an existing PBI<br /> * have a bugfix for an existing PBI<br /> &lt;noinclude&gt;[[category:handbook]]&lt;/noinclude&gt;</div>

Krismoore http://wiki.pcbsd.org/index.php/PBI_Module_Builder_Guide 2012-02-22T16:20:10Z

<p>Krismoore: /* PBI Module Components */</p> <hr /> <div>&lt;noinclude&gt;{{NavHeader|back=Test PBIs|forward=Purchase PC-BSD Swag}}&lt;/noinclude&gt;<br /> PC-BSD provides a unique file format known as a PBI (push button installer). PBI files end with the .pbi extension and are self-contained installation programs. This means that even novice users can safely install and uninstall PBIs without inadvertently overwriting or deleting files needed by the operating system or other applications.<br /> <br /> A PBI file includes all the runtime and library dependencies required by the application. This means that a PBI is a large file, but this does not necessarily mean that the installed PBI will be that large. During installation, the PBI system compares the currently installed libraries and files with the ones contained within the PBI file and only installs the ones that are not already installed on the system. A hash database is used to eliminate dependency problems while allowing the computer to share libraries between different programs. <br /> <br /> On PC-BSD, PBIs can be installed using the graphical [[Using AppCafe™ | AppCafe™]] utility or from the command line using [[PBI Manager]].<br /> <br /> The PBI format changed between PC-BSD 8.x and 9.x. This section demonstrates how to create PBIs for PC-BSD 9.x and higher. [[Building PBIs for PC-BSD 8.x and Earlier]] describes the old format, but is considered to be deprecated.<br /> <br /> === Building PBIs for PC-BSD 9.x and higher ===<br /> <br /> Creating a PBI from an existing FreeBSD port is a surprisingly easy and automated process that does not require development skills. Some ports are effortless to convert while more complex ports may require some thought and simple scripting.<br /> <br /> Two utilities are available for converting FreeBSD ports into PBIs. EasyPBI provides a graphical interface and '''pbi_makeport''' provides a command line utility. This section demonstrates how to use both of these tools, explains the components of a PBI module, and provides some troubleshooting tips.<br /> <br /> '''NOTE:''' before creating a PBI, check to see if one exists using the instructions in [[Submit PBI Requests]]. If you decide that you prefer to request a PBI that you need rather than to create one, that page also contains instructions for submitting a PBI request.<br /> <br /> ====Using EasyPBI====<br /> <br /> EasyPBI is a new GUI application created by Jesse Smith and Ken Moore. It streamlines the process of building a PBI from a FreeBSD port. EasyPBI can be installed using AppCafe™ without any additional requirements on a PC-BSD system. For a pure FreeBSD system, you will need to install both the ''sysutils/easypbi'' and ''ports-mgmt/pbi-manager'' ports.<br /> <br /> To run the program, either double-click the EasyPBI desktop icon or type '''EasyPBI''' as your regular user account. This will open the screen shown in Figure 10.7a. Depending upon whether or not ports is installed, you may first receive a pop-up message.<br /> <br /> '''Figure 10.7a: EasyPBI Graphical Interface'''<br /> <br /> [[File:Easypbi.jpeg]]<br /> <br /> To build a PBI using EasyPBI:<br /> <br /> '''1. Create a module for the desired FreeBSD port:''' when you first start EasyPBI, it will check to see if the FreeBSD ports tree is installed into ''/usr/ports''. If it is not, a pop-up message will indicate that you have a choice on how to install the ports tree. If you want the system ports tree to be available for any user, go to Control Panel ➜ System Manager ➜ Tasks ➜ Fetch System Ports Tree. Use this method if multiple users will be using the EasyPBI utility. Alternatively, if you only want the ports tree to be available to the current user, click File ➜ Get Ports from within EasyPBI; this will fetch the ports tree and place it in the user's home directory. <br /> <br /> '''NOTE:''' when determining which PBIs need to be built, refer to the [http://forums.pcbsd.org/forumdisplay.php?f=61 PBI Requests forum] to determine which PBI's have been requested by users. You should also check that a module does not already exist on the [http://trac.pcbsd.org/browser#pbi/modules PBI Modules] section of trac.<br /> <br /> To create a new module, click the &quot;New Module&quot; 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 on the GUI. In the example shown in Figure 10.7b, the ''net/xrdesktop'' port has been selected and the fields have been auto-filled in. <br /> <br /> '''Figure 10.7b: Reviewing the Port's Information'''<br /> <br /> [[File:EasyPBI1a.jpeg]]<br /> <br /> You should review these fields for accuracy. In this example, the port's website had changed and an email was sent to the port author so that the URL could be corrected in the port.<br /> <br /> If you click &quot;Get Port Info&quot; [http://freshports.org FreshPorts.org] will open in the default web browser so that you can view additional information about the port. <br /> <br /> A generic icon will be supplied for the module; you can change the default icon by clicking the &quot;Choose Icon&quot; button. When using a custom icon, use 64x64 .png files with transparent backgrounds. <br /> <br /> If the program provides a GUI, check the box &quot;GUI App&quot;. <br /> <br /> Once the port information is complete, click the &quot;Create Module&quot; button and EasyPBI will produce a generic PBI module. A message will indicate the location of the module, as seen in the example in Figure 10.7c:<br /> <br /> '''Figure 10.7c: PBI Module Created'''<br /> <br /> [[File:EasyPBI2a.jpeg]]<br /> <br /> '''2. Build a PBI from the module:''' once your module is created, click on the &quot;Build PBI&quot; tab and click the Select Module button to browse to the module you just created. You should then review the default settings. Figure 10.7d shows the default settings for our example PBI.<br /> <br /> '''Figure 10.7d: The Build PBI Tab'''<br /> <br /> [[File:EasyPBI3.jpeg]]<br /> <br /> The options in this tab allow you to do the following:<br /> <br /> '''Save Settings as Defaults:''' once you are satisfied with the settings, click this button to have EasyPBI remember your settings between uses.<br /> <br /> '''Change Directory:''' allows you to save the output of the build to a different directory.<br /> <br /> '''Change 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, you can use your own digital signature file by browing to its location.<br /> <br /> '''Use TMPFS:''' if your build system has a lot of RAM, selecting this option can speed up the build.<br /> <br /> '''Select Module:''' select the previously created module which you would like to build.<br /> <br /> '''Build PBI:''' starts the build of the PBI using the settings contained within the PBI module. It will prompt you for the superuser password and requires a working Internet connection 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.<br /> <br /> '''Stop Build:''' stops the build process. Click the &quot;Build PBI&quot; button to resume the build.<br /> <br /> '''Save Build Log:''' useful if the build fails.<br /> <br /> You can produce additional modules from the &quot;Create Module&quot; tab while a PBI build is running. <br /> <br /> If the PBI build fails for some reason, you may need to modify the module. 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 as well as the module to the [http://lists.pcbsd.org/mailman/listinfo/pbi-dev pbi-dev mailing list].<br /> <br /> '''3. Test the PBI:''' once the PBI build is complete, a pop-up message will indicate that the PBI finished building successfully. You will find the PBI in the output directory that you specified in Figure 10.7c. To continue with our example, the following commands will install the PBI so that it can be tested. Note the error message that occurs since the PBI has not been signed yet.<br /> <br /> '''cd /home/dru/EasyPBI/PBI'''<br /> '''pbi_add xrdesktop-1.2_2-i386.pbi'''<br /> pbi_add: No digital signature! If you are *SURE* you trust this PBI, re-install with --no-checksig option.<br /> '''pbi_add --no-checksig xrdesktop-1.2_2-i386.pbi'''<br /> Verifying Checksum...OK<br /> Extracting to /usr/pbi/xrdesktop-i386<br /> Installed: xrdesktop-1.2.2<br /> <br /> '''rehash'''<br /> '''/usr/pbi/xrdesktop-i386/bin/xrdesktop'''<br /> <br /> Once installed, specify the full path to the application's binary to make sure that you are testing the PBI's binary. If the application starts and is a GUI, try using all of the menu items to make sure they work as expected. 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 after some Googling, send the error report the [http://lists.pcbsd.org/mailman/listinfo/pbi-dev pbi-dev mailing list].<br /> <br /> Alternately, if everything seems to be working, send the tarball of the PBI to the [http://lists.pcbsd.org/mailman/listinfo/pbi-dev pbi-dev mailing list]. You will find it in the ''EasyPBI/Modules/'' subdirectory. In our example, the name of the tarball is ''/home/dru/EasyPBI/Modules/xrdesktop.tar.gz''.<br /> <br /> ==== Creating a New PBI with '''pbi_makeport''' ====<br /> <br /> Starting in PC-BSD 9.x and higher, '''pbi_makeport''' is included with the operating system. This utility provides an easy way for a user to convert an existing FreeBSD port into a PBI module. The PBI build server builds modules into PBIs which are then made available to users through AppCafe™. '''man pbi_makeport''' provides details on this application's various usage options. <br /> <br /> When running '''pbi_makeport''' it is possible to supply an optional metadata configuration directory which contains additional data used to supplement the port building and the final PBI file. This configuration directory may contain extra icon data for the desktop, install/uninstall scripts, custom '''make''' options and more. <br /> <br /> Examples of 9.x modules can be found at [http://trac.pcbsd.org/browser/pcbsd/current/src-sh/pbi-manager/module-examples Examples in Subversion].<br /> <br /> FreeBSD ports may contain build dependencies, runtime dependencies, and required libraries. When building a PBI, '''pbi_makeport''' automatically<br /> compiles all of the required dependencies, and, when finished compiling, prunes the build dependencies before packaging the PBI file, leaving only the runtime packages and libraries that are required for the program to work. This means that any files which are included in the PBI are necessary for the program to run, and manually removing them will cause the program to fail.<br /> <br /> ====PBI Module Components====<br /> <br /> A PBI module contains the following components. When creating a PBI module, create a directory on your computer to hold the module's components. For example, if you are creating a PBI module for firefox, create a directory called ''firefox/'' and place the following files within that directory. The directory that you create is referred to as ''%PBI_APPDIR%%''. <br /> <br /> '''1. LICENSE File'''<br /> <br /> The text of a license agreement you want the user to click to accept before installation. This file is optional unless the underlying port is restricted and requires the user to accept a license in order to install and use the software.<br /> <br /> '''2. pbi.conf'''<br /> <br /> The ''pbi.conf'' file is mandatory. It is a simple shell script that contains the information needed to build the PBI. Typically this file requires you to modify a few simple variables, such as the name of the program, its location in the ports tree, and the name of its icon. Sometimes you will need to set a few additional variables in order to make sure that required dependencies are included in the PBI. If you get stuck when creating your own ''pbi.conf'', you can view the ''pbi.conf'' file for every PBI module in [http://trac.pcbsd.org/browser#pbi/modules this section] of the PC-BSD trac repository. Here is an example of the ''pbi.conf'' file for firefox: <br /> &lt;nowiki&gt;<br /> #!/bin/sh<br /> # PBI Build Configuration<br /> # Place over-rides and settings here<br /> #<br /> # XDG Desktop Menu Spec:<br /> # http://standards.freedesktop.org/menu-spec/menu-spec-1.0.html<br /> ##############################################################################<br /> <br /> # Program Name<br /> PBI_PROGNAME=&quot;Firefox&quot;<br /> <br /> # Program Website<br /> PBI_PROGWEB=&quot;http://www.mozilla.com&quot;<br /> <br /> # Program Author / Vendor<br /> PBI_PROGAUTHOR=&quot;The Mozilla Foundation&quot;<br /> <br /> # Default Icon (Relative to %%PBI_APPDIR%% or resources/)<br /> PBI_PROGICON=&quot;share/pixmaps/FireFox-128.png&quot;<br /> <br /> # The target port we are building<br /> PBI_MAKEPORT=&quot;www/firefox&quot;<br /> <br /> # Additional options for make.conf<br /> PBI_MAKEOPTS=&quot;PACKAGE_BUILDING=Y<br /> WITH_CUPS=yes<br /> WITH_GECKO=libxul&quot;<br /> <br /> # Ports to build before / after<br /> PBI_MKPORTBEFORE=&quot;&quot;<br /> PBI_MKPORTAFTER=&quot;audio/esound x11-fonts/dejavu x11-themes/qtcurve-gtk2 devel/gconf2 www/firefox-i18n&quot;<br /> <br /> # Exclude List<br /> PBI_EXCLUDELIST=&quot;./include ./share/doc&quot;<br /> <br /> # Increment to trigger rebuild of PBI on build servers<br /> PBI_BUILDKEY=&quot;04&quot;<br /> <br /> # This app needs to install as root<br /> PBI_REQUIRESROOT=&quot;YES&quot;<br /> <br /> # Set the priority of this build <br /> PBI_AB_PRIORITY=&quot;50&quot;<br /> <br /> # Set the files we want to exclude from the shared hashdir<br /> PBI_HASH_EXCLUDES=&quot;lib/firefox/firefox&quot;<br /> <br /> export PBI_PROGNAME PBI_PROGWEB PBI_PROGAUTHOR PBI_PROGICON PBI_MAKEPORT PBI_MAKEOPTS <br /> PBI_MKPORTBEFORE PBI_MKPORTAFTER PBI_BUILDKEY PBI_REQUIRESROOT PBI_EXCLUDELIST&lt;/nowiki&gt;<br /> <br /> Table 10.7a describes the most commonly used variables. When creating your ''pbi.conf'' file, you will want to refer to the FreeBSD port's ''Makefile'' and ''pkg-descr'' to determine which values to use.<br /> <br /> '''Table 10.7a: Commonly Used pbi.conf Variables'''<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Variable'''}} <br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROGNAME&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|mandatory; should be the same value as PORTNAME&lt;nowiki&gt;=&lt;/nowiki&gt; in the port's ''Makefile'', but capitalized}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROGWEB&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|mandatory unless does not exist; should be the same value as WWW&lt;nowiki&gt;=&lt;/nowiki&gt; in the port's ''pkg-descr''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROGAUTHOR&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|mandatory; often found in the port's ''pkg-descr'' or at the website for the application}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROGICON&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|mandatory path, relative to %PBI_APPDIR%%, to application icon file in png format}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROGREVISION&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|bump up a PBI's revision number; useful when rebuilding a port with new PBI specific options}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_MAKEPORT&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|mandatory; the path to the port within ''/usr/ports/''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_MAKEOPTS&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|optional; set this to the options that you want saved into ''make.conf'' for the port building process (e.g. WITH_CUPS&lt;nowiki&gt;=&lt;/nowiki&gt;YES)}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_MKPORTBEFORE&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|optional; port(s) to build before starting the target port PBI_MAKEPORT}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_MKPORTAFTER&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|optional; port(s) to build after finishing the target port PBI_MAKEPORT}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_BUILDKEY&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|should not be included; this variable is used on the PBI build server to force the rebuild of a PBI that has failed to build}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_REQUIRESROOT&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|set to to YES to require this app to be installed as root; default is NO which allows it to be installed as a regular user }}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_EXCLUDELIST&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|list of files or directories to exclude from the final archive, such as ''./include'' or ''./share''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_AB_PRIORITY&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|may be set by build server administrator; a higher number indicates a greater priority and will be built before lower priority PBIs}} <br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_AB_NOTMPFS&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|set to YES to disable using tmpfs when doing auto-builds on a server}} <br /> |-<br /> {{Tbl-line|align=left|'''PBI_HASH_EXCLUDES&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|set to a space delimited list of files to exclude from merging into the shared hash-dir}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''export'''}}<br /> {{Tbl-line|bg=ff|align=left|mandatory; followed by a list of all of the variables that will be included when the PBI is built}}<br /> |-<br /> |}<br /> <br /> '''3. external-links'''<br /> <br /> The optional ''external-links'' file contains a list of targets to link into the system's LOCALBASE at PBI installation time. This is useful for placing binaries and files in the user's PATH. When building PBIs from a FreeBSD port, this file is usually not needed, as most binaries and files are auto-detected and placed in the LOCALBASE. Example 10.7a shows an example usage:<br /> <br /> '''Example 10.7a: Example external-links File'''<br /> <br /> &lt;nowiki&gt;<br /> # Files to be Sym-Linked into the default LOCALBASE<br /> # One per-line, relative to %%PBI_APPDIR%% and LOCALBASE<br /> # Defaults to keeping any existing files in LOCALBASE<br /> <br /> <br /> # TARGET LINK IN LOCALBASE ACTION<br /> #etc/rc.d/servfoo etc/rc.d/servfoo keep<br /> #include/libfoo.h include/libfoo.h replace<br /> #etc/rc.d/servfoo etc/rc.d/servfoo keep<br /> bin/firefox3 bin/firefox3 binary,nocrash&lt;/nowiki&gt;<br /> <br /> The flags in the ACTION column are as follows:<br /> <br /> * '''keep''': if this file already exists in LOCALBASE, don't overwrite it<br /> <br /> * '''replace''': replace this file in LOCALBASE if it exists<br /> <br /> * '''binary''': this file is an executable<br /> <br /> * '''nocrash''': used for binary files; don't display crash handler if program exits with non-0 status<br /> <br /> * '''linux''': used for binary files; Indicates that this is a linux application, and needs to run with Linux compat<br /> <br /> '''4. resources/'''<br /> <br /> The ''resources/'' directory can contain extra files you wish copied into the PBI application directory. This is often the best place for icons and other files not included with a port. <br /> <br /> '''5. scripts/'''<br /> <br /> This directory can contain the following scripts:<br /> <br /> * '''post-install.sh''': script run immediately after the extraction of PBI contents to disk<br /> <br /> * '''post-portmake.sh''': script run during building of the PBI file, after the port compile is finished<br /> <br /> * '''pre-install.sh''': script run before installation of the PBI; return non-0 to halt installation<br /> <br /> * '''pre-remove.sh''': script run before deletion of the PBI file<br /> <br /> Table 10.7b summarizes the variables that may be used in these scripts:<br /> <br /> '''Table 10.7b Supported Variables<br /> <br /> {{Tbl-init}}<br /> {{Tbl-title|width=15%|'''Variable'''}} <br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROGNAME&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|mandatory; should be the same value as PORTNAME&lt;nowiki&gt;=&lt;/nowiki&gt; in the port's ''Makefile'', but capitalized}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROGDIRNAME&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|name of the subdirectory that is created for the PBI in ''/usr/pbi/'' (e.g. &quot;firefox-amd64&quot; for the 64-bit Firefox PBI)}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROGDIRPATH&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|full path to the PBI install directory (e.g. ''/usr/pbi/firefox-amd64/'' for the 64-bit Firefox PBI)}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROGVERSION&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|version of the program - should be the same value as the DISTVERSION in the port's Makefile }}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_RCDIR&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|location of ''rc.d/'' directory used by PBIs, usually ''/usr/local/etc/rc.d'' }}<br /> |-<br /> {{Tbl-line|align=left|'''SYS_LOCALBASE&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|LOCALBASE of the default system, typically ''/usr/local'' }}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_FAKEBIN_DIR&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|the binary wrapper directory, typically ''/usr/pbi/&lt;pbidir&gt;/.sbin/'' }}<br /> |-<br /> |} <br /> <br /> '''6. xdg-menu/ and xdg-desktop/'''<br /> <br /> The ''xdg-menu/'' and ''xdg-desktop/'' directories can be used to supply menu and desktop icons, respectively. The file that you place in these directories should be in the format ''pbiname.desktop''. Example 10.7b shows the ''firefox.desktop'' files for the firefox PBI:<br /> <br /> '''Example 10.7b: firefox.desktop File'''<br /> <br /> '''more xdg-menu/firefox.desktop'''<br /> #!/usr/bin/env xdg-open<br /> [Desktop Entry]<br /> Value=1.0<br /> Type=Application<br /> Name=FireFox<br /> GenericName=FireFox<br /> Exec=%%PBI_EXEDIR%%/firefox %U<br /> Path=%%PBI_APPDIR%%<br /> Icon=%%PBI_APPDIR%%/share/pixmaps/FireFox-128.png<br /> StartupNotify=true<br /> Categories=Network;<br /> <br /> '''more xdg-desktop/firefox.desktop'''<br /> #!/usr/bin/env xdg-open<br /> [Desktop Entry]<br /> Value=1.0<br /> Type=Application<br /> Name=FireFox<br /> GenericName=FireFox<br /> Exec=%%PBI_EXEDIR%%/firefox %U<br /> Path=%%PBI_APPDIR%%<br /> Icon=%%PBI_APPDIR%%/share/pixmaps/FireFox-128.png<br /> StartupNotify=true <br /> <br /> %%PBI_EXEDIR%% should reference the PBI's executable and any required switches.<br /> <br /> For more details on the XDG menu specifications, please refer to the [http://standards.freedesktop.org/menu-spec/menu-spec-1.0.html freedesktop specifications]. <br /> <br /> '''7. xdg-mime/'''<br /> <br /> The ''xdg-mime/'' directory is used to register file associations according to the [http://standards.freedesktop.org/shared-mime-info-spec/shared-mime-info-spec-latest.html freedesktop MIME specs]. This requires the creation of an XML file. The example shown in Figure 10.7c adds the MIME information for gimp, so that it can be available as an application choice in a web browser:<br /> <br /> '''Example 10.7c: Gimp MIME Info'''<br /> <br /> '''more xdg-mime/gimp-xdg.xml'''<br /> &lt;?xml version=&quot;1.0&quot;?&gt;<br /> &lt;mime-info xmlns='&lt;nowiki&gt;http://www.freedesktop.org/standards/shared-mime-info&lt;/nowiki&gt;'&gt;<br /> &lt;mime-type type=&quot;application/x-gimp&quot;&gt;<br /> &lt;comment&gt;Gimp - XCF File&lt;/comment&gt;<br /> &lt;glob weight=&quot;100&quot; pattern=&quot;*.xcf&quot;/&gt;<br /> &lt;glob weight=&quot;100&quot; pattern=&quot;*.XCF&quot;/&gt;<br /> &lt;/mime-type&gt;<br /> &lt;/mime-info&gt;<br /> <br /> ====Useful Tips====<br /> <br /> If your PBI's executable does not run, it may be because the program executable is actually a wrapper script rather than a binary file. If so, check the first line of the script to make sure it is using the right path for the scripting language. For example, ''#!/bin/python'' is an incorrect path which should be changed to ''#!/usr/pbi/(pbi-name)/bin/python''.<br /> <br /> The suggested path works because each program is packaged with the proper version of the language it uses and you want to make sure it uses that one. This is usually accomplished by putting a quick '''sed''' line in the ''post-install.sh'' script to fix the first line as seen in [http://trac.pcbsd.org/browser/pbi/modules/games/fretsonfire/scripts/post-install.sh?rev=13019 this example].<br /> <br /> When testing the executable, use the one located in ''/usr/pbi/(pbi-name)/bin/'' so all the linking will be properly set up. Otherwise you<br /> can get some interesting errors about missing files.<br /> <br /> = Getting Help =<br /> <br /> The [http://lists.pcbsd.org/mailman/listinfo/pbi-dev PBI Developers mailing list] can help if you:<br /> <br /> * get stuck building a PBI<br /> * need to ask a question about your PBI <br /> * are ready to submit a new module<br /> * find a bug in an existing PBI<br /> * have a bugfix for an existing PBI<br /> &lt;noinclude&gt;[[category:handbook]]&lt;/noinclude&gt;</div>

Krismoore http://wiki.pcbsd.org/index.php/PC-BSD%C2%AE_9.1_TODO 2012-02-17T18:54:23Z

<p>Krismoore: /* New Features / Tools planned for 9.1 */</p> <hr /> <div>==== New Features / Tools planned for 9.1 ====<br /> {| border=1<br /> |'''Feature'''<br /> |'''Owner'''<br /> |'''Skills'''<br /> |'''Status'''<br /> |'''Completion Date'''<br /> |-<br /> |add inmate browser to Warden GUI<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add iSCSI initiator GUI front-end to iscontrol(8) for connecting to FreeNAS™ systems<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |replace firewall GUI with fwbuilder and document how to use<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |add Info button to Service Manager containing description<br /> |<br /> |<br /> |should really be a DESCRIPTION field in rc.d scripts<br /> |<br /> |-<br /> |Animated splash screen<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Create PBI or inmate for BBB<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |Add system info desktop icon to live mode<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add help buttons to custom menus, write help text and add to Pootle<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |Use the [http://wiki.freebsd.org/OliverFromme/BootLoader Graphical Boot Loader] from OliverFromme<br /> |<br /> |C / FreeBSD Commit Access / ?<br /> |DONE<br /> |In 9.0<br /> |-<br /> |Front-end to text installer<br /> |jhixson<br /> |<br /> |<br /> |<br /> |-<br /> |Add options for proxy settings in network page of installer<br /> |kris<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Speed up installed boot-time, background system services / load desktop immediately?<br /> |kris<br /> |FreeBSD rc.d / Scripting?<br /> |'''DONE'''<br /> |1-16-2012 [[http://trac.pcbsd.org/changeset/14866 14866]]<br /> |-<br /> |Create new Disk Management GUI for post-install usage, ZFS, Advanced FS tasks such as ZFS snapshots, ZFS quota/compression<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Add manual disk configuration to installer and install to specific mount-point<br /> |kris<br /> |C++ / QT4 / shell<br /> |'''DONE'''<br /> |2-17-2012 [[http://trac.pcbsd.org/changeset/15467 15467]]<br /> |-<br /> |Add option to play some simple games while waiting for installation<br /> |kris<br /> |C++ / QT4 / shell<br /> |<br /> |<br /> |-<br /> |Add ability to backup ZFS datasets (in life preserver?)<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Merge Warden® into PC-BSD SVN as a built-in tool for managing jails<br /> |kmoore<br /> |C++ / QT4 / Shell<br /> |<br /> |<br /> |-<br /> |Add password strength meter to installer and warn if root / user are same. <br /> |kmoore<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Localize the meta-pkg descriptions<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |Show meta-pkg port lists in installer / system tool<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |C++ / QT CUPS GUI<br /> | Loic Maury<br /> |C++ / C<br /> |<br /> |<br /> |-<br /> |Switch LifePreserver to use /var/ for its backend files<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |Bluetooth GUI<br /> |ken<br /> |<br /> |<br /> |<br /> |-<br /> |allow pc-sysinstall to import existing ZFS layout<br /> |Kris<br /> |C++<br /> |'''DONE'''<br /> |[[http://trac.pcbsd.org/changeset/15467 15467]]<br /> |-<br /> | changing default language / locale for GDM in pc-sysinstall<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add Update All to Appcafe<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add TRIM support to pc-sysinstall / GUI<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Update network GUI to set DNS manually in /etc/dhclient.conf when not using static IPs. <br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add setting to automatically create desktop / menu icons upon appcafe installations <br /> |kmoore<br /> |C++/QT<br /> |<br /> |<br /> |-<br /> |In pc-sysinstaller GUI, show native language strings when selecting the initial language, not the english version. <br /> |kmoore<br /> |C++/QT<br /> |<br /> |<br /> |-<br /> |add option to wireless settings in network manager to select country code<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Create sound mixer control panel app, let user pick default sound device, mixer settings<br /> |<br /> |C++/QT<br /> |<br /> |<br /> |-<br /> |}<br /> [[category:PC-BSD Wiki]]<br /> [[category:TODO Lists]]</div>

Krismoore http://wiki.pcbsd.org/index.php/PC-BSD%C2%AE_9.1_TODO 2012-02-17T17:53:47Z

<p>Krismoore: /* New Features / Tools planned for 9.1 */</p> <hr /> <div>==== New Features / Tools planned for 9.1 ====<br /> {| border=1<br /> |'''Feature'''<br /> |'''Owner'''<br /> |'''Skills'''<br /> |'''Status'''<br /> |'''Completion Date'''<br /> |-<br /> |add inmate browser to Warden GUI<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add iSCSI initiator GUI front-end to iscontrol(8) for connecting to FreeNAS™ systems<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |replace firewall GUI with fwbuilder and document how to use<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |add Info button to Service Manager containing description<br /> |<br /> |<br /> |should really be a DESCRIPTION field in rc.d scripts<br /> |<br /> |-<br /> |Animated splash screen<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Create PBI or inmate for BBB<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |Add system info desktop icon to live mode<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add help buttons to custom menus, write help text and add to Pootle<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |Use the [http://wiki.freebsd.org/OliverFromme/BootLoader Graphical Boot Loader] from OliverFromme<br /> |<br /> |C / FreeBSD Commit Access / ?<br /> |DONE<br /> |In 9.0<br /> |-<br /> |Front-end to text installer<br /> |jhixson<br /> |<br /> |<br /> |<br /> |-<br /> |Add options for proxy settings in network page of installer<br /> |kris<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Speed up installed boot-time, background system services / load desktop immediately?<br /> |kris<br /> |FreeBSD rc.d / Scripting?<br /> |'''DONE'''<br /> |1-16-2012 [[http://trac.pcbsd.org/changeset/14866 14866]]<br /> |-<br /> |Create new Disk Management GUI for post-install usage, ZFS, Advanced FS tasks such as ZFS snapshots, ZFS quota/compression<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Add manual disk configuration to installer and install to specific mount-point<br /> |kris<br /> |C++ / QT4 / shell<br /> |'''DONE'''<br /> |2-17-2012 [[http://trac.pcbsd.org/changeset/15467 15467]]<br /> |-<br /> |Add option to play some simple games while waiting for installation<br /> |kris<br /> |C++ / QT4 / shell<br /> |<br /> |<br /> |-<br /> |Add ability to backup ZFS datasets (in life preserver?)<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Merge Warden® into PC-BSD SVN as a built-in tool for managing jails<br /> |kmoore<br /> |C++ / QT4 / Shell<br /> |<br /> |<br /> |-<br /> |Add password strength meter to installer and warn if root / user are same. <br /> |kmoore<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Localize the meta-pkg descriptions<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |Show meta-pkg port lists in installer / system tool<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |C++ / QT CUPS GUI<br /> | Loic Maury<br /> |C++ / C<br /> |<br /> |<br /> |-<br /> |Switch LifePreserver to use /var/ for its backend files<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |Bluetooth GUI<br /> |ken<br /> |<br /> |<br /> |<br /> |-<br /> |allow pc-sysinstall to import existing ZFS layout<br /> |Kris<br /> |C++<br /> |'''DONE'''<br /> |[[http://trac.pcbsd.org/changeset/15467 15467]]<br /> |-<br /> | changing default language / locale for GDM in pc-sysinstall<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add Update All to Appcafe<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add TRIM support to pc-sysinstall / GUI<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Update network GUI to set DNS manually in /etc/dhclient.conf when not using static IPs. <br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add setting to automatically create desktop / menu icons upon appcafe installations <br /> |kmoore<br /> |C++/QT<br /> |<br /> |<br /> |-<br /> |Show download spec during system installation, and give option to try another mirror if a failure occurs. Also test mirror connection before starting.<br /> |kmoore<br /> |C++/QT<br /> |<br /> |<br /> |-<br /> |In pc-sysinstaller GUI, show native language strings when selecting the initial language, not the english version. <br /> |kmoore<br /> |C++/QT<br /> |<br /> |<br /> |-<br /> |add option to wireless settings in network manager to select country code<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Create sound mixer control panel app, let user pick default sound device, mixer settings<br /> |<br /> |C++/QT<br /> |<br /> |<br /> |-<br /> |}<br /> [[category:PC-BSD Wiki]]<br /> [[category:TODO Lists]]</div>

Krismoore http://wiki.pcbsd.org/index.php/PC-BSD%C2%AE_9.1_TODO 2012-01-26T18:17:06Z

<p>Krismoore: /* New Features / Tools planned for 9.1 */</p> <hr /> <div>==== New Features / Tools planned for 9.1 ====<br /> {| border=1<br /> |'''Feature'''<br /> |'''Owner'''<br /> |'''Skills'''<br /> |'''Status'''<br /> |'''Completion Date'''<br /> |-<br /> |add inmate browser to Warden GUI<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add iSCSI initiator GUI front-end to iscontrol(8) for connecting to FreeNAS™ systems<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |replace firewall GUI with fwbuilder and document how to use<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |add Info button to Service Manager containing description<br /> |<br /> |<br /> |should really be a DESCRIPTION field in rc.d scripts<br /> |<br /> |-<br /> |Animated splash screen<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Create PBI or inmate for BBB<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |Add system info desktop icon to live mode<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add help buttons to custom menus, write help text and add to Pootle<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |Use the [http://wiki.freebsd.org/OliverFromme/BootLoader Graphical Boot Loader] from OliverFromme<br /> |<br /> |C / FreeBSD Commit Access / ?<br /> |DONE<br /> |In 9.0<br /> |-<br /> |Front-end to text installer<br /> |jhixson<br /> |<br /> |<br /> |<br /> |-<br /> |Add options for proxy settings in network page of installer<br /> |kris<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Speed up installed boot-time, background system services / load desktop immediately?<br /> |kris<br /> |FreeBSD rc.d / Scripting?<br /> |'''DONE'''<br /> |1-16-2012 [[http://trac.pcbsd.org/changeset/14866 14866]]<br /> |-<br /> |Create new Disk Management GUI for post-install usage, ZFS, Advanced FS tasks such as ZFS snapshots, ZFS quota/compression<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Add manual disk configuration to installer and install to specific mount-point<br /> |kris<br /> |C++ / QT4 / shell<br /> |<br /> |<br /> |-<br /> |Add option to play some simple games while waiting for installation<br /> |kris<br /> |C++ / QT4 / shell<br /> |<br /> |<br /> |-<br /> |Add ability to backup ZFS datasets (in life preserver?)<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Merge Warden® into PC-BSD SVN as a built-in tool for managing jails<br /> |kmoore<br /> |C++ / QT4 / Shell<br /> |<br /> |<br /> |-<br /> |Pre-select keyboard layout / timezone based upon language selection<br /> |kmoore<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Add password strength meter to installer and warn if root / user are same. <br /> |kmoore<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Localize the meta-pkg descriptions<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |Show meta-pkg port lists in installer / system tool<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |C++ / QT CUPS GUI<br /> | Loic Maury<br /> |C++ / C<br /> |<br /> |<br /> |-<br /> |Switch LifePreserver to use /var/ for its backend files<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |Bluetooth GUI<br /> |ken<br /> |<br /> |<br /> |<br /> |-<br /> |allow pc-sysinstall to import existing ZFS layout<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> | changing default language / locale for GDM in pc-sysinstall<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add Update All to Appcafe<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add TRIM support to pc-sysinstall / GUI<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Update network GUI to set DNS manually in /etc/dhclient.conf when not using static IPs. <br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add setting to automatically create desktop / menu icons upon appcafe installations <br /> |kmoore<br /> |C++/QT<br /> |<br /> |<br /> |-<br /> |Show download spec during system installation, and give option to try another mirror if a failure occurs. Also test mirror connection before starting.<br /> |kmoore<br /> |C++/QT<br /> |<br /> |<br /> |-<br /> |In pc-sysinstaller GUI, show native language strings when selecting the initial language, not the english version. <br /> |kmoore<br /> |C++/QT<br /> |<br /> |<br /> |-<br /> |add option to wireless settings in network manager to select country code<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Create sound mixer control panel app, let user pick default sound device, mixer settings<br /> |<br /> |C++/QT<br /> |<br /> |<br /> |-<br /> |}</div>

Krismoore http://wiki.pcbsd.org/index.php/PC-BSD%C2%AE_9.1_TODO 2012-01-26T18:16:49Z

<p>Krismoore: /* New Features / Tools planned for 9.1 */</p> <hr /> <div>==== New Features / Tools planned for 9.1 ====<br /> {| border=1<br /> |'''Feature'''<br /> |'''Owner'''<br /> |'''Skills'''<br /> |'''Status'''<br /> |'''Completion Date'''<br /> |-<br /> |add inmate browser to Warden GUI<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add iSCSI initiator GUI front-end to iscontrol(8) for connecting to FreeNAS™ systems<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |replace firewall GUI with fwbuilder and document how to use<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |add Info button to Service Manager containing description<br /> |<br /> |<br /> |should really be a DESCRIPTION field in rc.d scripts<br /> |<br /> |-<br /> |Animated splash screen<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Create PBI or inmate for BBB<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |Add system info desktop icon to live mode<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add help buttons to custom menus, write help text and add to Pootle<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |Use the [http://wiki.freebsd.org/OliverFromme/BootLoader Graphical Boot Loader] from OliverFromme<br /> |<br /> |C / FreeBSD Commit Access / ?<br /> |DONE<br /> |In 9.0<br /> |-<br /> |Front-end to text installer<br /> |jhixson<br /> |<br /> |<br /> |<br /> |-<br /> |Add options for proxy settings in network page of installer<br /> |kris<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Speed up installed boot-time, background system services / load desktop immediately?<br /> |jpaetzel<br /> |FreeBSD rc.d / Scripting?<br /> |'''DONE'''<br /> |1-16-2012 [[http://trac.pcbsd.org/changeset/14866 14866]]<br /> |-<br /> |Create new Disk Management GUI for post-install usage, ZFS, Advanced FS tasks such as ZFS snapshots, ZFS quota/compression<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Add manual disk configuration to installer and install to specific mount-point<br /> |kris<br /> |C++ / QT4 / shell<br /> |<br /> |<br /> |-<br /> |Add option to play some simple games while waiting for installation<br /> |kris<br /> |C++ / QT4 / shell<br /> |<br /> |<br /> |-<br /> |Add ability to backup ZFS datasets (in life preserver?)<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Merge Warden® into PC-BSD SVN as a built-in tool for managing jails<br /> |kmoore<br /> |C++ / QT4 / Shell<br /> |<br /> |<br /> |-<br /> |Pre-select keyboard layout / timezone based upon language selection<br /> |kmoore<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Add password strength meter to installer and warn if root / user are same. <br /> |kmoore<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Localize the meta-pkg descriptions<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |Show meta-pkg port lists in installer / system tool<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |C++ / QT CUPS GUI<br /> | Loic Maury<br /> |C++ / C<br /> |<br /> |<br /> |-<br /> |Switch LifePreserver to use /var/ for its backend files<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |Bluetooth GUI<br /> |ken<br /> |<br /> |<br /> |<br /> |-<br /> |allow pc-sysinstall to import existing ZFS layout<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> | changing default language / locale for GDM in pc-sysinstall<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add Update All to Appcafe<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add TRIM support to pc-sysinstall / GUI<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Update network GUI to set DNS manually in /etc/dhclient.conf when not using static IPs. <br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add setting to automatically create desktop / menu icons upon appcafe installations <br /> |kmoore<br /> |C++/QT<br /> |<br /> |<br /> |-<br /> |Show download spec during system installation, and give option to try another mirror if a failure occurs. Also test mirror connection before starting.<br /> |kmoore<br /> |C++/QT<br /> |<br /> |<br /> |-<br /> |In pc-sysinstaller GUI, show native language strings when selecting the initial language, not the english version. <br /> |kmoore<br /> |C++/QT<br /> |<br /> |<br /> |-<br /> |add option to wireless settings in network manager to select country code<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Create sound mixer control panel app, let user pick default sound device, mixer settings<br /> |<br /> |C++/QT<br /> |<br /> |<br /> |-<br /> |}</div>

Krismoore http://wiki.pcbsd.org/index.php/PC-BSD%C2%AE_9.1_TODO 2011-12-28T18:31:44Z

<p>Krismoore: /* New Features / Tools planned for 9.1 */</p> <hr /> <div>==== New Features / Tools planned for 9.1 ====<br /> {| border=1<br /> |'''Feature'''<br /> |'''Owner'''<br /> |'''Skills'''<br /> |'''Status'''<br /> |'''Completion Date'''<br /> |-<br /> |add inmate browser to Warden GUI<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add iSCSI initiator GUI front-end to iscontrol(8) for connecting to FreeNAS™ systems<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |replace firewall GUI with fwbuilder and document how to use<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |add Info button to Service Manager containing description<br /> |<br /> |<br /> |should really be a DESCRIPTION field in rc.d scripts<br /> |<br /> |-<br /> |Animated splash screen<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Create PBI or inmate for BBB<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |Add system info desktop icon to live mode<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add help buttons to custom menus, write help text and add to Pootle<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |Use the [http://wiki.freebsd.org/OliverFromme/BootLoader Graphical Boot Loader] from OliverFromme<br /> |<br /> |C / FreeBSD Commit Access / ?<br /> |<br /> |<br /> |-<br /> |Front-end to text installer<br /> |jhixson<br /> |<br /> |<br /> |<br /> |-<br /> |Add options for proxy settings in network page of installer<br /> |kris<br /> |<br /> |C++ / QT4<br /> |<br /> |-<br /> |Speed up installed boot-time, background system services / load desktop immediately?<br /> |jpaetzel<br /> |FreeBSD rc.d / Scripting?<br /> |<br /> |<br /> |-<br /> |Create new Disk Management GUI for post-install usage, ZFS, Advanced FS tasks such as ZFS snapshots, ZFS quota/compression<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Add manual disk configuration to installer and install to specific mount-point<br /> |kris<br /> |C++ / QT4 / shell<br /> |<br /> |<br /> |-<br /> |Add option to play some simple games while waiting for installation<br /> |kris<br /> |C++ / QT4 / shell<br /> |<br /> |<br /> |-<br /> |Add ability to backup ZFS datasets (in life preserver?)<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Merge &quot;The Warden&quot; into PC-BSD SVN as a built-in tool for managing jails<br /> |kmoore<br /> |C++ / QT4 / Shell<br /> |<br /> |<br /> |-<br /> |Pre-select keyboard layout / timezone based upon language selection<br /> |kmoore<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Add password strength meter to installer and warn if root / user are same. <br /> |kmoore<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Localize the meta-pkg descriptions<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |Show meta-pkg port lists in installer / system tool<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |C++ / QT CUPS GUI<br /> | Loic Maury<br /> |C++ / C<br /> |<br /> |<br /> |-<br /> |Switch LifePreserver to use /var/ for its backend files<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |Bluetooth GUI<br /> |ken<br /> |<br /> |<br /> |<br /> |-<br /> |allow pc-sysinstall to import existing ZFS layout<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> | changing default language / locale for GDM in pc-sysinstall<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add Update All to Appcafe<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add TRIM support to pc-sysinstall / GUI<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Update network GUI to set DNS manually in /etc/dhclient.conf when not using static IPs. <br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add setting to automatically create desktop / menu icons upon appcafe installations <br /> |kmoore<br /> |C++/QT<br /> |<br /> |<br /> |-<br /> |Show download spec during system installation, and give option to try another mirror if a failure occurs. Also test mirror connection before starting.<br /> |kmoore<br /> |C++/QT<br /> |<br /> |<br /> |-<br /> |In pc-sysinstaller GUI, show native language strings when selecting the initial language, not the english version. <br /> |kmoore<br /> |C++/QT<br /> |<br /> |<br /> |-<br /> |}</div>

Krismoore http://wiki.pcbsd.org/index.php/PC-BSD%C2%AE_9.1_TODO 2011-12-28T15:57:05Z

<p>Krismoore: /* New Features / Tools planned for 9.1 */</p> <hr /> <div>==== New Features / Tools planned for 9.1 ====<br /> {| border=1<br /> |'''Feature'''<br /> |'''Owner'''<br /> |'''Skills'''<br /> |'''Status'''<br /> |'''Completion Date'''<br /> |-<br /> |add inmate browser to Warden GUI<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add iSCSI initiator GUI front-end to iscontrol(8) for connecting to FreeNAS™ systems<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |replace firewall GUI with fwbuilder and document how to use<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |add Info button to Service Manager containing description<br /> |<br /> |<br /> |should really be a DESCRIPTION field in rc.d scripts<br /> |<br /> |-<br /> |Animated splash screen<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Create PBI or inmate for BBB<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |Add system info desktop icon to live mode<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add help buttons to custom menus, write help text and add to Pootle<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |Use the [http://wiki.freebsd.org/OliverFromme/BootLoader Graphical Boot Loader] from OliverFromme<br /> |<br /> |C / FreeBSD Commit Access / ?<br /> |<br /> |<br /> |-<br /> |Front-end to text installer<br /> |jhixson<br /> |<br /> |<br /> |<br /> |-<br /> |Add options for proxy settings in network page of installer<br /> |kris<br /> |<br /> |C++ / QT4<br /> |<br /> |-<br /> |Speed up installed boot-time, background system services / load desktop immediately?<br /> |jpaetzel<br /> |FreeBSD rc.d / Scripting?<br /> |<br /> |<br /> |-<br /> |Create new Disk Management GUI for post-install usage, ZFS, Advanced FS tasks such as ZFS snapshots, ZFS quota/compression<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Add manual disk configuration to installer and install to specific mount-point<br /> |kris<br /> |C++ / QT4 / shell<br /> |<br /> |<br /> |-<br /> |Add option to play some simple games while waiting for installation<br /> |kris<br /> |C++ / QT4 / shell<br /> |<br /> |<br /> |-<br /> |Add ability to backup ZFS datasets (in life preserver?)<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Merge &quot;The Warden&quot; into PC-BSD SVN as a built-in tool for managing jails<br /> |kmoore<br /> |C++ / QT4 / Shell<br /> |<br /> |<br /> |-<br /> |Pre-select keyboard layout / timezone based upon language selection<br /> |kmoore<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Add password strength meter to installer and warn if root / user are same. <br /> |kmoore<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Localize the meta-pkg descriptions<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |Show meta-pkg port lists in installer / system tool<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |C++ / QT CUPS GUI<br /> | Loic Maury<br /> |C++ / C<br /> |<br /> |<br /> |-<br /> |Switch LifePreserver to use /var/ for its backend files<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |Bluetooth GUI<br /> |ken<br /> |<br /> |<br /> |<br /> |-<br /> |allow pc-sysinstall to import existing ZFS layout<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> | changing default language / locale for GDM in pc-sysinstall<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add Update All to Appcafe<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add TRIM support to pc-sysinstall / GUI<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Update network GUI to set DNS manually in /etc/dhclient.conf when not using static IPs. <br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add setting to automatically create desktop / menu icons upon appcafe installations <br /> |kmoore<br /> |C++/QT<br /> |<br /> |<br /> |-<br /> |Show download spec during system installation, and give option to try another mirror if a failure occurs. Also test mirror connection before starting.<br /> |kmoore<br /> |C++/QT<br /> |<br /> |<br /> |-<br /> |}</div>

Krismoore http://wiki.pcbsd.org/index.php/PC-BSD%C2%AE_9.1_TODO 2011-12-28T15:35:14Z

<p>Krismoore: /* New Features / Tools planned for 9.1 */</p> <hr /> <div>==== New Features / Tools planned for 9.1 ====<br /> {| border=1<br /> |'''Feature'''<br /> |'''Owner'''<br /> |'''Skills'''<br /> |'''Status'''<br /> |'''Completion Date'''<br /> |-<br /> |add inmate browser to Warden GUI<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add iSCSI initiator GUI front-end to iscontrol(8) for connecting to FreeNAS™ systems<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |replace firewall GUI with fwbuilder and document how to use<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |add Info button to Service Manager containing description<br /> |<br /> |<br /> |should really be a DESCRIPTION field in rc.d scripts<br /> |<br /> |-<br /> |Animated splash screen<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Create PBI or inmate for BBB<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |Add system info desktop icon to live mode<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add help buttons to custom menus, write help text and add to Pootle<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |Use the [http://wiki.freebsd.org/OliverFromme/BootLoader Graphical Boot Loader] from OliverFromme<br /> |<br /> |C / FreeBSD Commit Access / ?<br /> |<br /> |<br /> |-<br /> |Front-end to text installer<br /> |jhixson<br /> |<br /> |<br /> |<br /> |-<br /> |Add options for proxy settings in network page of installer<br /> |kris<br /> |<br /> |C++ / QT4<br /> |<br /> |-<br /> |Speed up installed boot-time, background system services / load desktop immediately?<br /> |jpaetzel<br /> |FreeBSD rc.d / Scripting?<br /> |<br /> |<br /> |-<br /> |Create new Disk Management GUI for post-install usage, ZFS, Advanced FS tasks such as ZFS snapshots, ZFS quota/compression<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Add manual disk configuration to installer and install to specific mount-point<br /> |kris<br /> |C++ / QT4 / shell<br /> |<br /> |<br /> |-<br /> |Add option to play some simple games while waiting for installation<br /> |kris<br /> |C++ / QT4 / shell<br /> |<br /> |<br /> |-<br /> |Add ability to backup ZFS datasets (in life preserver?)<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Merge &quot;The Warden&quot; into PC-BSD SVN as a built-in tool for managing jails<br /> |kmoore<br /> |C++ / QT4 / Shell<br /> |<br /> |<br /> |-<br /> |Pre-select keyboard layout / timezone based upon language selection<br /> |kmoore<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Add password strength meter to installer and warn if root / user are same. <br /> |kmoore<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Localize the meta-pkg descriptions<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |Show meta-pkg port lists in installer / system tool<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |C++ / QT CUPS GUI<br /> | Loic Maury<br /> |C++ / C<br /> |<br /> |<br /> |-<br /> |Switch LifePreserver to use /var/ for its backend files<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |Bluetooth GUI<br /> |ken<br /> |<br /> |<br /> |<br /> |-<br /> |allow pc-sysinstall to import existing ZFS layout<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> | changing default language / locale for GDM in pc-sysinstall<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add Update All to Appcafe<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add TRIM support to pc-sysinstall / GUI<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Update network GUI to set DNS manually in /etc/dhclient.conf when not using static IPs. <br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add setting to automatically create desktop / menu icons upon appcafe installations <br /> |kmoore<br /> |C++/QT<br /> |<br /> |<br /> |-<br /> |}</div>

Krismoore http://wiki.pcbsd.org/index.php/PBI_Module_Builder_Guide 2011-12-22T21:22:47Z

<p>Krismoore: /* PBI Module Components */</p> <hr /> <div>{{NavHeader|back=Test PBIs|forward=Purchase PC-BSD Swag}}<br /> PC-BSD provides a unique file format known as a PBI (push button installer). PBI files end with the .pbi extension and are self-contained installation programs. This means that even novice users can safely install and uninstall PBIs without inadvertently overwriting or deleting files needed by the operating system or other applications.<br /> <br /> A PBI file includes all the runtime and library dependencies required by the application. This means that a PBI is a large file, but this does not necessarily mean that the installed PBI will be that large. During installation, the PBI system compares the currently installed libraries and files with the ones contained within the PBI file and only installs the ones that are not already installed on the system. A hash database is used to eliminate dependency problems while allowing the computer to share libraries between different programs. <br /> <br /> On PC-BSD, PBIs can be installed using the graphical [[Using AppCafe™ | AppCafe™]] utility or from the command line using [[PBI Manager]].<br /> <br /> The PBI format changed between PC-BSD 8.x and 9.x. This means that you should follow the instructions for the PBI format that you wish to create.<br /> <br /> === Building PBIs for PC-BSD 9.x and higher ===<br /> <br /> Creating a PBI from an existing FreeBSD port is a surprisingly easy and automated process that does not require development skills. Some ports are effortless to convert while more complex ports may require some thought and simple scripting.<br /> <br /> Two utilities are available for converting FreeBSD ports into PBIs. EasyPBI provides a graphical interface and '''pbi_makeport''' provides a command line utility. This section demonstrates how to use both of these tools, explains the components of a PBI module, and provides some troubleshooting tips.<br /> <br /> '''NOTE:''' before creating a PBI, check to see if one exists using the instructions in [[Submit PBI Requests]]. If you decide that you prefer to request a PBI that you need rather than to create one, that page also contains instructions for submitting a PBI request.<br /> <br /> ====Using EasyPBI====<br /> <br /> EasyPBI is a new GUI application created by Jesse Smith and Ken Moore. It streamlines the process of building a PBI from a FreeBSD port. To use EasyPBI, the following need to be installed on your PC-BSD system:<br /> <br /> 1. Use Control Panel -&gt; System Manager -&gt; System Packages to install the Development -&gt; Development-Qt package.<br /> <br /> 2. Use AppCafe™ to install the EasyPBI PBI.<br /> <br /> To run the program, either double-click the EasyPBI desktop icon or type '''EasyPBI''' as your regular user account. This will open the screen shown in Figure 10.7a. Depending upon whether or not ports is installed, you may first receive a pop-up message.<br /> <br /> '''Figure 10.7a: EasyPBI Graphical Interface'''<br /> <br /> [[File:Easypbi.jpeg]]<br /> <br /> The two main components to building a PBI are reflected in EasyPBI:<br /> <br /> '''1. Create a module for the desired FreeBSD port:''' when you first start EasyPBI, it will check to see if the FreeBSD ports tree is installed into ''/usr/ports''. If it is not, a pop-up message will indicate that you have a choice on how to install the ports tree. If you want the system ports tree to be available for any user, go to Control Panel -&gt; System Manager -&gt; Tasks -&gt; Fetch System Ports Tree. Use this method if multiple users will be using the EasyPBI utility. Alternatively, if you only want the ports tree to be available to the current user, click File -&gt; Get Ports from within EasyPBI; this will fetch the ports tree and place it in the user's home directory. <br /> <br /> To create a new module, click the &quot;New Module&quot; 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 on the GUI. In the example shown in Figure 10.7b, the ''multimedia/handbrake'' port has been selected and the fields other than &quot;Port's website&quot; have been auto-filled in. <br /> <br /> '''Figure 10.7b: Reviewing the Port's Information'''<br /> <br /> [[File:EasyPBI1.jpeg]]<br /> <br /> '''NOTE:''' when determining which PBIs need to be built, refer to the [http://forums.pcbsd.org/forumdisplay.php?f=61 PBI Requests forum] to determine which PBI's have been requested by users. You should also check that a module does not already exist on the [http://trac.pcbsd.org/browser#pbi/modules PBI Modules] section of trac.<br /> <br /> If you click &quot;Get Port Info&quot; [http://freshports.org FreshPorts.org] will open in the default web browser so that you can view additional information about the port. In this example, FreshPorts does not indicate the port's website, but the [http://forums.pcbsd.org/showthread.php?t=15357 PBI request] does.<br /> <br /> A generic icon will be supplied for the module; you can change the default icon by clicking the &quot;Choose Icon&quot; button. When using a custom icon, use 64x64 .png files with transparent backgrounds. <br /> <br /> If the program provides a GUI, check the box &quot;GUI App&quot;. Since handbrake is a command line program, this box is left unchecked in this example.<br /> <br /> Once the port information is complete, click the &quot;Create Module&quot; button and EasyPBI will produce a generic PBI module. A message will indicate the location of the module, as seen in the example in Figure 10.7c:<br /> <br /> '''Figure 10.7c: PBI Module Created'''<br /> <br /> [[File:Easypbi2.jpeg]]<br /> <br /> '''2. Build a PBI from the module:''' once your module is created, click on the &quot;Build PBI&quot; tab in EasyPBI and review the default settings. Figure 10.7d shows the default settings for our example PBI.<br /> <br /> '''Figure 10.7d: The Build PBI Tab'''<br /> <br /> [[File:Easypbi3.jpeg]]<br /> <br /> The options in this tab allow you to do the following:<br /> <br /> '''Save Settings as Defaults:''' once you are satisfied with the settings, click this button to have EasyPBI remember your settings between uses.<br /> <br /> '''Change Directory:'''<br /> <br /> '''Change File:'''<br /> <br /> '''Use TMPFS:'''<br /> <br /> '''Select Module:''' select the previously created module which you would like to build.<br /> <br /> '''Build PBI:''' starts the build of the PBI using the settings contained within the PBI module. It will prompt you for the superuser password and requires a working Internet connection 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.<br /> <br /> '''Stop Build:''' stops the build process. Click the &quot;Build PBI&quot; button to resume the build.<br /> <br /> '''Save Build Log:''' useful if the build fails.<br /> <br /> You can produce additional modules from the &quot;Create Module&quot; tab while a PBI build is running. <br /> <br /> If the PBI build fails for some reason, you may need to modify the module. 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 as well as the module to the [http://lists.pcbsd.org/mailman/listinfo/pbi-dev pbi-dev mailing list].<br /> <br /> ==== Creating a New PBI with '''pbi_makeport''' ====<br /> <br /> Starting in PC-BSD 9.x and higher, '''pbi_makeport''' is included with the operating system. This utility provides an easy way for a user to convert an existing FreeBSD port into a PBI module. The PBI build server builds modules into PBIs which are then made available to users through AppCafe™. '''man pbi_makeport''' provides details on this application's various usage options. <br /> <br /> When running '''pbi_makeport''' it is possible to supply an optional metadata configuration directory which contains additional data used to supplement the port building and the final PBI file. This configuration directory may contain extra icon data for the desktop, install/uninstall scripts, custom '''make''' options and more. <br /> <br /> Examples of 9.x modules can be found at [http://trac.pcbsd.org/browser/pcbsd/current/src-sh/pbi-manager/module-examples Examples in Subversion].<br /> <br /> FreeBSD ports may contain build dependencies, runtime dependencies, and required libraries. When building a PBI, '''pbi_makeport''' automatically<br /> compiles all of the required dependencies, and, when finished compiling, prunes the build dependencies before packaging the PBI file, leaving only the runtime packages and libraries that are required for the program to work. This means that any files which are included in the PBI are necessary for the program to run, and manually removing them will cause the program to fail.<br /> <br /> ====PBI Module Components====<br /> <br /> A PBI module contains the following components. When creating a PBI module, create a directory on your computer to hold the module's components. For example, if you are creating a PBI module for firefox, create a directory called ''firefox/'' and place the following files within that directory. The directory that you create is referred to as ''%PBI_APPDIR%%''. <br /> <br /> '''1. LICENSE File'''<br /> <br /> The text of a license agreement you want the user to click to accept before installation. This file is optional unless the underlying port is restricted and requires the user to accept a license in order to install and use the software.<br /> <br /> '''2. pbi.conf'''<br /> <br /> The ''pbi.conf'' file is mandatory. It is a simple shell script that contains the information needed to build the PBI. Typically this file requires you to modify a few simple variables, such as the name of the program, its location in the ports tree, and the name of its icon. Sometimes you will need to set a few additional variables in order to make sure that required dependencies are included in the PBI. If you get stuck when creating your own ''pbi.conf'', you can view the ''pbi.conf'' file for every PBI module in [http://trac.pcbsd.org/browser#pbi/modules this section] of the PC-BSD trac repository. Here is an example of the ''pbi.conf'' file for firefox: <br /> &lt;nowiki&gt;<br /> #!/bin/sh<br /> # PBI Build Configuration<br /> # Place over-rides and settings here<br /> #<br /> # XDG Desktop Menu Spec:<br /> # http://standards.freedesktop.org/menu-spec/menu-spec-1.0.html<br /> ##############################################################################<br /> <br /> # Program Name<br /> PBI_PROGNAME=&quot;Firefox&quot;<br /> <br /> # Program Website<br /> PBI_PROGWEB=&quot;http://www.mozilla.com&quot;<br /> <br /> # Program Author / Vendor<br /> PBI_PROGAUTHOR=&quot;The Mozilla Foundation&quot;<br /> <br /> # Default Icon (Relative to %%PBI_APPDIR%% or resources/)<br /> PBI_PROGICON=&quot;share/pixmaps/FireFox-128.png&quot;<br /> <br /> # The target port we are building<br /> PBI_MAKEPORT=&quot;www/firefox&quot;<br /> <br /> # Additional options for make.conf<br /> PBI_MAKEOPTS=&quot;PACKAGE_BUILDING=Y<br /> WITH_CUPS=yes<br /> WITH_GECKO=libxul&quot;<br /> <br /> # Ports to build before / after<br /> PBI_MKPORTBEFORE=&quot;&quot;<br /> PBI_MKPORTAFTER=&quot;audio/esound x11-fonts/dejavu x11-themes/qtcurve-gtk2 devel/gconf2 www/firefox-i18n&quot;<br /> <br /> # Exclude List<br /> PBI_EXCLUDELIST=&quot;./include ./share/doc&quot;<br /> <br /> # Increment to trigger rebuild of PBI on build servers<br /> PBI_BUILDKEY=&quot;04&quot;<br /> <br /> # This app needs to install as root<br /> PBI_REQUIRESROOT=&quot;YES&quot;<br /> <br /> # Set the priority of this build <br /> PBI_AB_PRIORITY=&quot;50&quot;<br /> <br /> # Set the files we want to exclude from the shared hashdir<br /> PBI_HASH_EXCLUDES=&quot;lib/firefox/firefox&quot;<br /> <br /> export PBI_PROGNAME PBI_PROGWEB PBI_PROGAUTHOR PBI_PROGICON PBI_MAKEPORT PBI_MAKEOPTS <br /> PBI_MKPORTBEFORE PBI_MKPORTAFTER PBI_BUILDKEY PBI_REQUIRESROOT PBI_EXCLUDELIST&lt;/nowiki&gt;<br /> <br /> Table 10.7a describes the most commonly used variables. When creating your ''pbi.conf'' file, you will want to refer to the FreeBSD port's ''Makefile'' and ''pkg-descr'' to determine which values to use.<br /> <br /> '''Table 10.7a: Commonly Used pbi.conf Variables'''<br /> <br /> {{Tbl-init|width=100%}}<br /> {{Tbl-title|width=15%|'''Variable'''}} <br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROGNAME&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|mandatory; should be the same value as PORTNAME&lt;nowiki&gt;=&lt;/nowiki&gt; in the port's ''Makefile'', but capitalized}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROGWEB&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|mandatory unless does not exist; should be the same value as WWW&lt;nowiki&gt;=&lt;/nowiki&gt; in the port's ''pkg-descr''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROGAUTHOR&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|mandatory; often found in the port's ''pkg-descr'' or at the website for the application}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROGICON&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|mandatory path, relative to %PBI_APPDIR%%, to application icon file in png format}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROGREVISION&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|bump up a PBI's revision number; useful when rebuilding a port with new PBI specific options}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_MAKEPORT&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|mandatory; the path to the port within ''/usr/ports/''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_MAKEOPTS&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|optional; set this to the options that you want saved into ''make.conf'' for the port building process (e.g. WITH_CUPS&lt;nowiki&gt;=&lt;/nowiki&gt;YES)}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_MKPORTBEFORE&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|optional; port(s) to build before starting the target port PBI_MAKEPORT}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_MKPORTAFTER&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|optional; port(s) to build after finishing the target port PBI_MAKEPORT}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_BUILDKEY&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|should not be included; this variable is used on the PBI build server to force the rebuild of a PBI that has failed to build}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_REQUIRESROOT&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|set to to YES to require this app to be installed as root; default is NO which allows it to be installed as a regular user }}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_EXCLUDELIST&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|list of files or directories to exclude from the final archive, such as ''./include'' or ''./share''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_AB_PRIORITY&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|may be set by build server administrator; a higher number indicates a greater priority and will be built before lower priority PBIs}} <br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_AB_NOTMPFS&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|set to YES to disable using tmpfs when doing auto-builds on a server}} <br /> |-<br /> {{Tbl-line|align=left|'''PBI_HASH_EXCLUDES&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|set to a space delimited list of files to exclude from merging into the shared hash-dir}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''export'''}}<br /> {{Tbl-line|bg=ff|align=left|mandatory; followed by a list of all of the variables that will be included when the PBI is built}}<br /> |-<br /> |}<br /> <br /> '''3. external-links'''<br /> <br /> The optional ''external-links'' file contains a list of targets to link into the system's LOCALBASE at PBI installation time. This is useful for placing binaries and files in the user's PATH. When building PBIs from a FreeBSD port, this file is usually not needed, as most binaries and files are auto-detected and placed in the LOCALBASE. Example 10.7a shows an example usage:<br /> <br /> '''Example 10.7a: Example external-links File'''<br /> <br /> &lt;nowiki&gt;<br /> # Files to be Sym-Linked into the default LOCALBASE<br /> # One per-line, relative to %%PBI_APPDIR%% and LOCALBASE<br /> # Defaults to keeping any existing files in LOCALBASE<br /> <br /> <br /> # TARGET LINK IN LOCALBASE ACTION<br /> #etc/rc.d/servfoo etc/rc.d/servfoo keep<br /> #include/libfoo.h include/libfoo.h replace<br /> #etc/rc.d/servfoo etc/rc.d/servfoo keep<br /> bin/firefox3 bin/firefox3 binary,nocrash&lt;/nowiki&gt;<br /> <br /> The flags in the ACTION column are as follows:<br /> <br /> * '''keep''': if this file already exists in LOCALBASE, don't overwrite it<br /> <br /> * '''replace''': replace this file in LOCALBASE if it exists<br /> <br /> * '''binary''': this file is an executable<br /> <br /> * '''nocrash''': used for binary files; don't display crash handler if program exits with non-0 status<br /> <br /> '''4. resources/'''<br /> <br /> The ''resources/'' directory can contain extra files you wish copied into the PBI application directory. This is often the best place for icons and other files not included with a port. <br /> <br /> '''5. scripts/'''<br /> <br /> This directory can contain the following scripts:<br /> <br /> * '''post-install.sh''': script run immediately after the extraction of PBI contents to disk<br /> <br /> * '''post-portmake.sh''': script run during building of the PBI file, after the port compile is finished<br /> <br /> * '''pre-install.sh''': script run before installation of the PBI; return non-0 to halt installation<br /> <br /> * '''pre-remove.sh''': script run before deletion of the PBI file<br /> <br /> Table 10.7b summarizes the variables that may be used in these scripts:<br /> <br /> '''Table 10.7b Supported Variables<br /> <br /> {{Tbl-init|width=100%}}<br /> {{Tbl-title|width=15%|'''Variable'''}} <br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROGNAME&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|mandatory; should be the same value as PORTNAME&lt;nowiki&gt;=&lt;/nowiki&gt; in the port's ''Makefile'', but capitalized}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROGDIRNAME'''}}<br /> {{Tbl-line|align=left|name of the subdirectory that is created for the PBI in ''/usr/pbi/'' (e.g. &quot;firefox-amd64&quot; for the 64-bit Firefox PBI)}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROGDIRPATH'''}}<br /> {{Tbl-line|bg=ff|align=left|full path to the PBI install directory (e.g. ''/usr/pbi/firefox-amd64/'' for the 64-bit Firefox PBI)}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROGVERSION'''}}<br /> {{Tbl-line|bg=ff|align=left|version of the program - should be the same value as the DISTVERSION in the port's Makefile }}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_RCDIR'''}}<br /> {{Tbl-line|bg=ff|align=left|Location of rc.d directory used by PBIs, usually /usr/local/etc/rc.d }}<br /> |-<br /> {{Tbl-line|align=left|'''SYS_LOCALBASE'''}}<br /> {{Tbl-line|align=left|The LOCALBASE of the default system, typically /usr/local }}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_FAKEBIN_DIR'''}}<br /> {{Tbl-line|bg=ff|align=left|The binary wrapper directory, typically /usr/pbi/&lt;pbidir&gt;/.sbin/ }}<br /> |-<br /> |} <br /> <br /> '''6. xdg-menu/ and xdg-desktop/'''<br /> <br /> The ''xdg-menu/'' and ''xdg-desktop/'' directories can be used to supply menu and desktop icons, respectively. The file that you place in these directories should be in the format ''pbiname.desktop''. Example 10.7b shows the ''firefox.desktop'' files for the firefox PBI:<br /> <br /> '''Example 10.7b: firefox.desktop File'''<br /> <br /> '''more xdg-menu/firefox.desktop'''<br /> #!/usr/bin/env xdg-open<br /> [Desktop Entry]<br /> Value=1.0<br /> Type=Application<br /> Name=FireFox<br /> GenericName=FireFox<br /> Exec=%%PBI_EXEDIR%%/firefox %U<br /> Path=%%PBI_APPDIR%%<br /> Icon=%%PBI_APPDIR%%/share/pixmaps/FireFox-128.png<br /> StartupNotify=true<br /> Categories=Network;<br /> <br /> '''more xdg-desktop/firefox.desktop'''<br /> #!/usr/bin/env xdg-open<br /> [Desktop Entry]<br /> Value=1.0<br /> Type=Application<br /> Name=FireFox<br /> GenericName=FireFox<br /> Exec=%%PBI_EXEDIR%%/firefox %U<br /> Path=%%PBI_APPDIR%%<br /> Icon=%%PBI_APPDIR%%/share/pixmaps/FireFox-128.png<br /> StartupNotify=true <br /> <br /> %%PBI_EXEDIR%% should reference the PBI's executable and any required switches.<br /> <br /> For more details on the XDG menu specifications, please refer to the [http://standards.freedesktop.org/menu-spec/menu-spec-1.0.html freedesktop specifications]. <br /> <br /> '''7. xdg-mime/'''<br /> <br /> The ''xdg-mime/'' directory is used to register file associations according to the [http://standards.freedesktop.org/shared-mime-info-spec/shared-mime-info-spec-latest.html freedesktop MIME specs]. This requires the creation of an XML file. The example shown in Figure 10.7c adds the MIME information for gimp, so that it can be available as an application choice in a web browser:<br /> <br /> '''Example 10.7c: Gimp MIME Info'''<br /> <br /> '''more xdg-mime/gimp-xdg.xml'''<br /> &lt;?xml version=&quot;1.0&quot;?&gt;<br /> &lt;mime-info xmlns='&lt;nowiki&gt;http://www.freedesktop.org/standards/shared-mime-info&lt;/nowiki&gt;'&gt;<br /> &lt;mime-type type=&quot;application/x-gimp&quot;&gt;<br /> &lt;comment&gt;Gimp - XCF File&lt;/comment&gt;<br /> &lt;glob weight=&quot;100&quot; pattern=&quot;*.xcf&quot;/&gt;<br /> &lt;glob weight=&quot;100&quot; pattern=&quot;*.XCF&quot;/&gt;<br /> &lt;/mime-type&gt;<br /> &lt;/mime-info&gt;<br /> <br /> ====Useful Tips====<br /> <br /> If your PBI's executable does not run, it may be because the program executable is actually a wrapper script rather than a binary file. If so, check the first line of the script to make sure it is using the right path for the scripting language. For example, ''#!/bin/python'' is an incorrect path which should be changed to ''#!/usr/pbi/(pbi-name)/bin/python''.<br /> <br /> The suggested path works because each program is packaged with the proper version of the language it uses and you want to make sure it uses that one. This is usually accomplished by putting a quick '''sed''' line in the ''post-install.sh'' script to fix the first line as seen in [http://trac.pcbsd.org/browser/pbi/modules/games/fretsonfire/scripts/post-install.sh?rev=13019 this example].<br /> <br /> When testing the executable, use the one located in ''/usr/pbi/(pbi-name)/bin/'' so all the linking will be properly set up. Otherwise you<br /> can get some interesting errors about missing files.<br /> <br /> === Building PBIs for PC-BSD 8.x and Earlier ===<br /> <br /> Earlier PBI versions were created using the PBI Builder Software. The PBI Builder Software automates the process of converting an existing FreeBSD package into a PBI. Anyone with a bit of time, the willingness to learn new things, and the desire to increase the number of PBIs available to PC-BSD users is welcome to create and submit new PBIs.<br /> <br /> Installing the PBI Builder software relatively easy, simply download the tbz package for you architecture and version of PC-BSD from the [http://www.pcbsd.org/development/get-involved/pbi-porting PBI Builder Homepage], and place it somewhere on your system with several GB of free space. Next run these commands (as root):<br /> <br /> # '''tar xvjpf pbibuild*.tbz'''<br /> # '''ln -s `pwd`/pbi-build /pbi-build'''<br /> <br /> ==== PBI Building Concepts ====<br /> <br /> The PBI Builder software relies on the following concepts:<br /> <br /> '''1. Modules:'''a directory containing the files needed by the PBI. The next section will explain how to configure a module for a new PBI.<br /> <br /> '''2. PBI Sandbox:''' in order to create a clean build environment that does not affect the software running on the host system, all PBI creation is done in the /pbi-build/pbisandbox directory. This is a complete buildworld environment, and you may chroot into it in order to tweak a port build, or inspect the built contents of a port by using this command as the superuser:<br /> <br /> # '''chroot /pbi-build/pbisandbox'''<br /> <br /> '''3. Build command:''' once you have a module, simply cd into the pbi-build directory and specify which module to build. Depending upon the size of the application, the build may take some time to finish. The following example will build the firefox PBI:<br /> <br /> # '''cd /pbi-build'''<br /> # '''./buildpbi.sh webbrowsers/firefox '''<br /> <br /> '''4. Recreate command:''' during the creation of a new module, it may become necessary to recreate the PBI file to test new configurations. If the PBI has already been compiled once, a change often does not require the complete rebuilding of the port from source. By skipping the source build, a new PBI may be generated within moments. To skip the building simply run the 3.makepbi.sh script in /pbi-build/scripts/3.makepbi.sh as shown:<br /> <br /> # '''cd /pbi-build/scripts'''<br /> # '''./3.makepbi.sh webbrowsers/firefox'''<br /> <br /> '''5. Distfiles:''' when running a port build, many files will be downloaded and stored in /usr/ports/distfiles within the /pbi-build/pbisandbox directory. The pbisandbox is removed between builds of modules, but starting in PBI Builder 2.0, the distfiles contents are preserved in the /pbi-build/distfiles directory.<br /> <br /> ==== Working with Modules ====<br /> <br /> When starting the process of creating a new module for the PBI Builder, you should start with an existing module and modify it to suit your program's needs. You can either copy a module from /pbi-build/docs/module-examples, download a module from SVN, or download a template from SVN.<br /> <br /> Modules currently in the PC-BSD Subversion repo can be browsed via the [http://trac.pcbsd.org/browser/pbibuild/modules web].<br /> <br /> To download a specific module, use the following commands, replacing &quot;firefox&quot; with the specific module you intend to checkout.<br /> <br /> # '''cd /pbi-build/modules'''<br /> # '''svn co &lt;nowiki&gt;svn://svn.pcbsd.org/pbibuild/modules/webbrowsers/firefox&lt;/nowiki&gt; webbrowsers/firefox'''<br /> <br /> If you wish to start with a blank module template, you may download by using these commands:<br /> <br /> # '''cd /pbi-build/modules'''<br /> # '''fetch &lt;nowiki&gt;http://www.pcbsd.org/files/templates/module-template.tgz&lt;/nowiki&gt;'''<br /> # '''tar xvzf module-template.tgz'''<br /> <br /> A proper module will contain several files and directories:<br /> <br /> '''Required files / directories'''<br /> <br /> * '''pbi.conf:''' the main configuration file for the module.<br /> <br /> * '''copy-files:''' listing of the files and directories you wish to copy from the pbisandbox environment to your finished PBI file.<br /> <br /> * '''kmenu-dir:''' directory of configuration entries for the K menu.<br /> <br /> * '''overlay-dir:''' directory of contents to be applied to base PBI directory. Icons, PBI setup scripts, and most other files not added via copy-files are placed here.<br /> <br /> '''Optional Files used on a per-need basis'''<br /> <br /> * '''build.sh:''' script to run after the port make and copy-files are processed. <br /> <br /> * '''preportmake.sh:''' script to run in pbisandbox prior to the port make being executed. <br /> <br /> * '''mime-dir:''' directory of mime entries for your PBI.<br /> <br /> ==== The pbi.conf file ====<br /> <br /> This file is the first thing you read for each module.<br /> The available variables are explained with the example of &quot;FireFox&quot; below:<br /> &lt;nowiki&gt;<br /> # Program Name<br /> # The name of the PBI file being built<br /> PROGNAME=&quot;Firefox&quot;<br /> <br /> # Program Website<br /> # Website of the program the module is building<br /> PROGWEB=&quot;http://www.mozilla.com&quot;<br /> <br /> # Program Author<br /> # Who created / maintains the program being built<br /> PROGAUTHOR=&quot;The Mozilla Foundation&quot;<br /> <br /> # Default Icon<br /> # Relative to overlay-dir, the main icon you want to show up for this PBI<br /> PROGICON=&quot;share/pixmaps/FireFox-128.png&quot;<br /> <br /> # Port we want to build<br /> # The port the server will track to determine when it's time for a rebuild<br /> PBIPORT=&quot;/usr/ports/www/firefox/&quot;<br /> <br /> # Set to &quot;Auto or NONE&quot; to have the PBI creator auto-populate libs or not<br /> # This allows you to also use the autolibs/ directory in your overlay-dir as a location for extra<br /> # library files<br /> PROGLIBS=&quot;Auto&quot;<br /> <br /> # PBI Update URL set to &quot;&quot; or the http:// URL of update checker<br /> # Leave this as update.pbidir.com normally<br /> PBIUPDATE=&quot;http://update.pbidir.com&quot;<br /> <br /> # Other Ports we need built<br /> # One per line, any additional ports that need to be built for this PBI<br /> OTHERPORT=&quot;&quot;<br /> <br /> # Enter your custom make options here<br /> # Options that will be put into the make.conf for the build of this port<br /> # Options get inserted into the build's /etc/make.conf file and effect all the ports built for that PBI<br /> MAKEOPTS=&quot;&quot;<br /> <br /> # FBSD7BASE - (7.1 or 7.2)<br /> # This variable can be used to set the specific version of FreeBSD this port needs to be compiled<br /> # under. Use this is a port is known to not build / work when compiled on FreeBSD 7.0 (the default)<br /> FBSD7BASE=&quot;7.2&quot;; export FBSD7BASE<br /> <br /> # This option determines if the pbi-builder will auto-copy files from the target port<br /> # Can be set to YES/NO/FULL<br /> # YES - Copy only target port files automatically<br /> # No - Don't copy any target port files (will need to use copy-files config instead)<br /> # FULL - Copy target port files, and recursive dependency files as well (Makes very large PBI)<br /> PBIAUTOPOPULATE=&quot;YES&quot; ; export PBIAUTOPOPULATE<br /> <br /> # Can be set to OFF/NO to disable copying all files from ports made with the OTHERPORT variable<br /> # Leaving this unset will have the builder auto-copy all files from OTHERPORT targets<br /> PBIAUTOPOPULATE_OTHERPORT=&quot;&quot; ; export PBIAUTOPOPULATE_OTHERPORT<br /> <br /> # Set this variable to any target ports you want to autopopulate files from, in addition to<br /> # the main target port<br /> # List additional ports one-per-line<br /> PBIAUTOPOPULATE_PORTS=&quot;/usr/ports/www/mplayer-plugin/&quot; ; export PBIAUTOPOPULATE_PORTS<br /> <br /> # By default the PBI will remove any xorg-fonts, and create a symlink to the the users system fonts<br /> # Setting this to YES keeps the PBIs internal fonts and doesn't create a link<br /> # PBIDISABLEFONTLINK=&quot;&quot; ; export PBIDISABLEFONTLINK<br /> <br /> # By default the libGL* libraries will be removed from a PBI in order to use the systems libGL<br /> # Set this to YES to keep the PBIs libGL* libraries, and not use the system's<br /> # PBIKEEPGL=&quot;&quot; ; export PBIKEEPGL<br /> <br /> # By default we prune any include/ files used for building,<br /> # Set this to NO to keep any include/ directories in the resulting PBI<br /> # PBIPRUNEINCLUDE=&quot;&quot; ; export PBIPRUNEINCLUDE<br /> <br /> # By default we prune the python files used for building,<br /> # Set this to NO to keep any python files in the resulting PBI<br /> # PBIPRUNEPYTHON=&quot;&quot; ; export PBIPRUNEPYTHON<br /> <br /> # By default we prune any perl files used for building,<br /> # Set this to NO to keep any perl files in the resulting PBI<br /> # PBIPRUNEPERL=&quot;&quot; ; export PBIPRUNEPERL<br /> <br /> # By default we prune any doc files (such as man, info, share/doc)<br /> # Set this to NO to keep any doc files in the resulting PBI<br /> # PBIPRUNEDOC=&quot;&quot; ; export PBIPRUNEDOC<br /> <br /> # Build Key - Change this to anything else to trigger a rebuild<br /> # - The rebuild will take place even if port is still the same ver<br /> BUILDKEY=&quot;01&quot;&lt;/nowiki&gt;<br /> ===== The copy-files configuration =====<br /> <br /> This file is very straight forward, simply list the files you want to copy from the installed port, and where they should go in your PBI directory structure. The first argument should be the file/directory you wish to copy, and the 2nd argument will be the directory within the PBI it needs to be copied to. <br /> <br /> Example copy-files from FileZilla:<br /> <br /> /usr/local/bin/filezilla bin/<br /> /usr/local/bin/fzsftp bin/<br /> /usr/local/bin/gst-* bin/<br /> /usr/local/bin/wxrc* bin/<br /> /usr/local/bin/wxgtk2* bin/<br /> /usr/local/share/filezilla share/filezilla<br /> <br /> ==== The preportmake.sh script ====<br /> <br /> This script, if it present is run right before starting the &quot;make install&quot; of your port. This allows you to make modifications to the pbisandbox environment or to the port building source itself. Normally this won't be<br /> necessary, unless working with a very tricky program to get compiled.<br /> <br /> Example:<br /> &lt;nowiki&gt;<br /> #!/bin/sh<br /> # Script to grab the java files and place them in the right directory<br /> # before starting the build<br /> <br /> cd /usr/ports/distfiles<br /> <br /> fetch ftp://ftp.pcbsd.org/pub/autobuildpkgs/javapack.tbz<br /> tar xvjf javapack.tbz<br /> <br /> cd /usr/ports/java/jdk16/<br /> echo &quot;#!/bin/sh<br /> exit 0&quot; &gt; /usr/ports/java/jdk16/files/license.sh<br /> <br /> cd /usr/ports/devel/automake15<br /> make install clean&lt;/nowiki&gt;<br /> <br /> ==== The build.sh script ====<br /> <br /> Below is the example of the build.sh script, which runs after all the files have been copied to your PBI directory. This allows you to make mods to specific things for your PBI to work properly. In this example we modify the uninstall script to use the right version.<br /> <br /> #!/bin/sh<br /> # PBI building script<br /> # This will run after your port build is complete<br /> # Build your PBI here, and exit 0 on success, or exit 1 on failure.<br /> ##############################################################################<br /> # Available Variables<br /> # PBIDIR = The location of where you can populate your PBI directory<br /> # MODULEDIR = The location of the module directory for this PBI<br /> # PORTVER = Version number of the port we used to build<br /> ##############################################################################<br /> <br /> # Save the right version number in the removepbi.sh script<br /> sed -e &quot;s,CHANGEME,Firefox${PORTVER},g&quot; ${PBIDIR}/scripts/removepbi.sh &gt; /tmp/removepbi.sh<br /> mv /tmp/removepbi.sh ${PBIDIR}/scripts/removepbi.sh<br /> chmod 755 ${PBIDIR}/scripts/removepbi.sh<br /> <br /> ==== The kmenu-dir directory ====<br /> <br /> In this directory you may make any number of files, which contain the .pbc configuration for your kmenu icons. This defines where you would like icons created for your users desktop<br /> <br /> Example of kmenu-dir/firefox file:<br /> <br /> ExePath: bin/firefox<br /> ExeIcon: share/pixmaps/FireFox-128.png<br /> ExeDescr: FireFox<br /> ExeNoDesktop: 0<br /> ExeNoMenu: 0<br /> ExeNoCrashHandler: 0<br /> ExeRunRoot: 0<br /> ExeRunShell: 0<br /> ExeNotify: 1<br /> ExeLink: 0<br /> ExeWebLink: 0<br /> ExeTaskbar: 0<br /> ExeOwndir: 1<br /> ExeKdeCat: Internet<br /> <br /> Line-By-Line description of each entry:<br /> ----<br /> <br /> '''ExePath''': bin/firefox<br /> <br /> This line indicates the binary / script we want this icon to run when the user clicks it. This is relative to the PBI directory, so we use bin/firefox<br /> <br /> '''ExeIcon''': share/pixmaps/FireFox-128.png<br /> <br /> This is the icon you want to show up for this program, again it is relative to the PBI directory<br /> <br /> '''ExeDescr''': FireFox<br /> <br /> This would be the name of the icon in the kmenu or on the users desktop.<br /> <br /> '''ExeNoDesktop''': 0<br /> <br /> This allows you to disable creating a desktop icon for this entry. Set it to '0' if you want a desktop icon, or '1' if you don't wish an icon.<br /> <br /> '''ExeNoMenu''': 0<br /> <br /> This allows you to disable creating a kmenu icon for this entry. Set it to '0' if you want a kmenu icon, or '1' if you don't wish an icon.<br /> <br /> '''ExeNoCrashHandler''': 0<br /> <br /> This option enables / disables the usage of the PC-BSD CrashHandler program. This dialog warns the user that the application has crashed if it returns status non-zero (0), and provides the option to save the output of stdout and stderr from the application. Setting this to &quot;1&quot; disables the CrashHandler helper, which is useful for programs which normally return non-0, such as Window Managers and various apps. <br /> <br /> '''ExeRunRoot''': 0<br /> <br /> This indicates if you want your program to be run as &quot;root&quot; when the user clicks it. Set it to '0' to run as a regular user, or '1' to run kdesu and switch to &quot;root&quot; Set this to '0'<br /> <br /> '''ExeRunShell''': 0<br /> <br /> This indicates if you want your program to be executed in a console session, which may be useful for command-line applications. Set it to '0' if you dont want it to run in console, or set it to '1' if you do.<br /> <br /> '''ExeNotify''': 1<br /> <br /> This indicates if you want to enable launch feedback in KDE, which is the bouncing icon, showing that the program is loading. Set it to '0' to disable launch feedback, or set it to '1' if you want this enabled. Normally it is<br /> best to leave this enabled.<br /> <br /> '''ExeLink''': 0<br /> <br /> This is used to indicate if the ExePath variable was set to a local file / document you want opened with konqueror insetead of just being &quot;run&quot;. This is useful for README type documents. Set this to '1' if you want your document opened with konq, or '0' to just run it as normal.<br /> <br /> '''ExeWebLink''': 0<br /> <br /> This is similar to above, and instead indicates that the ExePath being opened is actual a web URL. Set this to '1' to open it the ExePath with Konq, or '0' to just run it as normal.<br /> <br /> '''ExeTaskbar''': 0<br /> <br /> This indicates if you want this application icon added to the taskbar. Set it to '1' to add it, or '0' to leave it disabled. (THIS FEATURE IS CURRENTLY UNAVAILABLE, BUT WILL BE ADDED DOWN THE ROAD)<br /> <br /> '''ExeOwndir''': 1<br /> <br /> This option is used to specify where you want your Kmenu icon to be placed, and may be set to 0, 1, 2<br /> 0 = Place kmenu icon directory in top level. <br /> I.E. Kmenu -&gt; Firefox -&gt; Firefox<br /> 1 = Place kmenu icon in its own directory in the sub category indicated by ExeKdeCat:<br /> I.E. Kmenu -&gt; Internet -&gt; Firefox -&gt; Firefox<br /> 2 = Place kmenu icon directly in the sub category indicated by ExeKdeCat: <br /> I.E. Kmenu -&gt; Internet -&gt; Firefox<br /> <br /> '''ExeKdeCat''': Internet<br /> <br /> This allows you to choose a kmenu sub-directory to place your icons / directory into, when ExeOwnDir is set to 1 or 2. <br /> Available options are:<br /> &lt;nowiki&gt;<br /> ExeKdeCat: Development<br /> ExeKdeCat: Editors<br /> ExeKdeCat: Edutainment/Languages<br /> ExeKdeCat: Edutainment/Math<br /> ExeKdeCat: Edutainment/Misc<br /> ExeKdeCat: Edutainment/Science<br /> ExeKdeCat: Edutainment/Teaching<br /> ExeKdeCat: Games/Arcade<br /> ExeKdeCat: Games/Board<br /> ExeKdeCat: Games/Card<br /> ExeKdeCat: Games/Kidsgames<br /> ExeKdeCat: Games/TacticStrategy<br /> ExeKdeCat: Games<br /> ExeKdeCat: Graphics<br /> ExeKdeCat: Internet<br /> ExeKdeCat: Multimedia<br /> ExeKdeCat: Office<br /> ExeKdeCat: System<br /> ExeKdeCat: Toys<br /> ExeKdeCat: Utilities&lt;/nowiki&gt;<br /> <br /> ==== The mime-dir directory ====<br /> <br /> This directory allows to you specify mime types for your applications defined in the kmenu-dir entries.<br /> <br /> Example of mime-dir/exe file:<br /> <br /> MimeExt: *.exe; *.EXE<br /> MimeIcon: win_apps.png<br /> MimeProg: 0<br /> <br /> The only catch to this is to note that the &quot;MimeProg: 0&quot; is a pointer to a file in the kmenu-dir structure. In this case you would have to ensure that the application you want to open .exe files gets added first to the template<br /> the server creates. Files in the kmenu-dir are added in the order of a &quot;ls&quot; listing, so if you have a wine-exe entry, you may wish to rename it to 00wine-exe to ensure it is added first, which would make this MimeProg: 0<br /> entry work with it.<br /> <br /> If you have more than 1 mime-type, you would then increment the MimeProg: 0 number to MimeProg: 1, MimeProg: 2, and so forth. Then you would do the same with your kmenu-dir entries, such as 00wine-exe, 01wine-bat, 02wine-msi<br /> <br /> ==== The overlay-dir directory ====<br /> <br /> This folder contains any of the files you wish placed into your PBI program directory. Here is an example from firefox:<br /> <br /> leftside.png<br /> PBI.FirstRun.sh autolibs lib<br /> PBI.RemoveScript.sh bin scripts<br /> PBI.SetupScript.sh header.png share<br /> <br /> In this example you see we have added our PBI.* setup scripts, and the custom graphics we want for the PBI installer. You may also create directories that will be populated with the copy-files configuration, such as share/ or others you may need.<br /> <br /> ==== Useful Tips ====<br /> <br /> '''If the program uses the python programming language:''' use [PBIPRUNEPYTHON=&quot;NO&quot; ; export PBIPRUNEPYTHON] (usually the file is called py-(something) if that file is written in python)<br /> <br /> '''If the program uses the perl programming language:''' use [PBIPRUNEPERL=&quot;NO&quot; ; export PBIPRUNEPERL] (harder to spot, usually the filename has &quot;perl&quot; in it somewhere)<br /> <br /> '''The installed program does not work:''' this is usually because the python or perl option was not set appropriately. This is only noticed at runtime because after building, python and perl files are removed unless instructed otherwise.<br /> <br /> '''If your program path needs to be /usr/local/sbin:''' first, make a kmenu-dir entry similar to the one used by [http://trac.pcbsd.org/browser/pbibuild/modules/archivers/cabextract/kmenu-dir/cabextract cabextract]. Next, make sure that the &quot;ExeNoDesktop&quot; and &quot;ExeNoMenu&quot; options are both set to &quot;1&quot;. Then, in your PBI.SetupScript.sh, you can symlink the wrapper script into /Programs/bin as in [http://trac.pcbsd.org/browser/pbibuild/modules/archivers/cabextract/overlay-dir/PBI.SetupScript.sh this example].<br /> <br /> '''If the underlying port pauses to wait for user acceptance of license agreement:''' put this setting into the MAKEOPTS variable:<br /> <br /> MAKEOPTS=&quot;DISABLE_LICENSES=yes&quot;<br /> <br /> Don't forget to include the license text in the file overlay-dir/LICENSE so the user can read and accept the license during the PBI installation.<br /> <br /> '''If you don't have reliable Internet access and want to avoid running portsnap and build a PBI with pre-fetched distfiles:''' use this variable in /pbi-build/conf/pbibuild.conf:<br /> <br /> PORTSNAP=NO<br /> <br /> Place all of your distfiles into /pbi-build/distfiles; with this variable set, that directory will be nullfs mounted into the PBI sandbox when doing builds.<br /> <br /> '''How does the builder know which port the module is associated with?'''<br /> <br /> The PBI build system will look at the module path first, so if in SVN we are using the module www/firefox, it'll look for a port at www/firefox. However, in some cases a module doesn't use the same port or directory name. In that case, set this variable:<br /> &lt;nowiki&gt; <br /> # The target port we are building<br /> PBI_MAKEPORT=&quot;www/firefox&quot;<br /> export PBI_MAKEPORT&lt;/nowiki&gt;<br /> <br /> That'll let the build server know which specific port this is building.<br /> <br /> = Getting Help =<br /> <br /> The [http://lists.pcbsd.org/mailman/listinfo/pbi-dev PBI Developers mailing list] can help if you:<br /> <br /> * get stuck building a PBI<br /> * need to ask a question about your PBI <br /> * are ready to submit a new module<br /> * find a bug in an existing PBI<br /> * have a bugfix for an existing PBI</div>

Krismoore http://wiki.pcbsd.org/index.php/PBI_Module_Builder_Guide 2011-12-19T15:49:19Z

<p>Krismoore: /* Module Components */</p> <hr /> <div>{{NavHeader|back=Test PBIs|forward=Purchase PC-BSD Swag}}<br /> PC-BSD provides a unique file format known as a PBI (push button installer). PBI files end with the .pbi extension and are self-contained installation programs. This means that even novice users can safely install and uninstall PBIs without inadvertently overwriting or deleting files needed by the operating system or other applications.<br /> <br /> A PBI file includes all the runtime and library dependencies required by the application. This means that a PBI is a large file, but this does not necessarily mean that the installed PBI will be that large. During installation, the PBI system compares the currently installed libraries and files with the ones contained within the PBI file and only installs the ones that are not already installed on the system. A hash database is used to eliminate dependency problems while allowing the computer to share libraries between different programs. <br /> <br /> On PC-BSD, PBIs can be installed using the graphical [[Using AppCafe™ | AppCafe™]] utility or from the command line using [[PBI Manager]].<br /> <br /> The PBI format changed between PC-BSD 8.x and 9.x. This means that you should follow the instructions for the PBI format that you wish to create.<br /> <br /> === Building PBIs for PC-BSD 9.x and higher ===<br /> <br /> Creating a PBI from an existing FreeBSD port is a surprisingly easy and automated process that does not require development skills. Some ports are effortless to convert while more complex ports may require some thought and simple scripting.<br /> <br /> Two utilities are available for converting FreeBSD ports into PBIs. EasyPBI provides a graphical interface and '''pbi_makeport''' provides a command line utility. This section demonstrates how to use both of these tools, explains the components of a PBI module, and provides some troubleshooting tips.<br /> <br /> '''NOTE:''' before creating a PBI, check to see if one exists using the instructions in [[Submit PBI Requests]]. If you decide that you prefer to request a PBI that you need rather than to create one, that page also contains instructions for submitting a PBI request.<br /> <br /> ====Using EasyPBI====<br /> <br /> EasyPBI is a new GUI application created by Jesse Smith and Ken Moore. It streamlines the process of building a PBI from a FreeBSD port. Once this application is available in the FreeBSD ports tree, a PBI will be created. Until then, you can install this application as follows:<br /> <br /> 1. Use Control Panel -&gt; System Manager -&gt; System Packages to install the Development -&gt; Development-Qt package.<br /> <br /> 2. Use AppCafe™ to install the subversion PBI.<br /> <br /> 3. Become the superuser and download the EasyPBI source after '''cd'''ing into your regular user's home directory. These commands are used to download and compile the EasyPBI program:<br /> <br /> '''su'''<br /> Password:<br /> '''cd ~dru'''<br /> '''svn co &lt;nowiki&gt;http://makeapbi.svn.sourceforge.net/svnroot/makeapbi&lt;/nowiki&gt; EasyPBI'''<br /> A EasyPBI/defaulticon.png<br /> A EasyPBI/pbi.h<br /> A EasyPBI/LICENSE<br /> A EasyPBI/mainwindow.h<br /> A EasyPBI/main.cpp<br /> A EasyPBI/EasyPBI.pro.user<br /> A EasyPBI/mainwindow.ui<br /> A EasyPBI/EasyPBI.pro<br /> A EasyPBI/pbi.cpp<br /> A EasyPBI/Makefile<br /> A EasyPBI/mainwindow.cpp<br /> Checked out revision 10.<br /> '''cd EasyPBI/'''<br /> '''qmake-qt4 *.pro'''<br /> '''make'''<br /> <br /> 4. If you wish to update EasyPBI to the latest version at a later date, run this command from your regular user's home directory:<br /> <br /> '''svn update EasyPBI/'''<br /> <br /> To run the program, give your user account permission to the EasyPBI contents, leave the superuser account, then run the EasyPBI executable as your regular user from the EasyPBI directory:<br /> <br /> '''chown -R dru ~dru/EasyPBI'''<br /> '''exit'''<br /> '''EasyPBI/EasyPBI'''<br /> <br /> This will open the screen shown in Figure 10.7a. Depending upon whether or not ports is installed, you may first receive a pop-up message.<br /> <br /> '''Figure 10.7a: EasyPBI Graphical Interface'''<br /> <br /> [[File:Easypbi.jpeg]]<br /> <br /> The two main components to building a PBI are reflected in EasyPBI:<br /> <br /> '''1. Create a module for the desired FreeBSD port:''' when you first start EasyPBI, it will check to see if the FreeBSD ports tree is installed into ''/usr/ports''. If it is not, a pop-up message will indicate that you have a choice on how to install the ports tree. If you want the system ports tree to be available for any user, go to Control Panel -&gt; System Manager -&gt; Tasks -&gt; Fetch System Ports Tree. Use this method if multiple users will be using the EasyPBI utility. Alternatively, if you only want the ports tree to be available to the current user, click File -&gt; Get Ports from within EasyPBI; this will fetch the ports tree and place it in the user's home directory. <br /> <br /> To create a new module, click the &quot;New Module&quot; 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 on the GUI. In the example shown in Figure 10.7b, the ''multimedia/handbrake'' port has been selected and the fields other than &quot;Port's website&quot; have been auto-filled in. <br /> <br /> '''Figure 10.7b: Reviewing the Port's Information'''<br /> <br /> [[File:EasyPBI1.jpeg]]<br /> <br /> '''NOTE:''' when determining which PBIs need to be built, refer to the [http://forums.pcbsd.org/forumdisplay.php?f=61 PBI Requests forum] to determine which PBI's have been requested by users. You should also check that a module does not already exist on the [http://trac.pcbsd.org/browser#pbi/modules PBI Modules] section of trac.<br /> <br /> If you click &quot;Get Port Info&quot; [http://freshports.org FreshPorts.org] will open in the default web browser so that you can view additional information about the port. In this example, FreshPorts does not indicate the port's website, but the [http://forums.pcbsd.org/showthread.php?t=15357 PBI request] does.<br /> <br /> A generic icon will be supplied for the module; you can change the default icon by clicking the &quot;Choose Icon&quot; button. When using a custom icon, use 64x64 .png files with transparent backgrounds. <br /> <br /> If the program provides a GUI, check the box &quot;GUI App&quot;. Since handbrake is a command line program, this box is left unchecked in this example.<br /> <br /> Once the port information is complete, click the &quot;Create Module&quot; button and EasyPBI will produce a generic PBI module. A message will indicate the location of the module, as seen in the example in Figure 10.7c:<br /> <br /> '''Figure 10.7c: PBI Module Created'''<br /> <br /> [[File:Easypbi2.jpeg]]<br /> <br /> '''2. Build a PBI from the module:''' once your module is created, click on the &quot;Build PBI&quot; tab in EasyPBI and review the default settings. Figure 10.7d shows the default settings for our example PBI.<br /> <br /> '''Figure 10.7d: The Build PBI Tab'''<br /> <br /> [[File:Easypbi3.jpeg]]<br /> <br /> The options in this tab allow you to do the following:<br /> <br /> '''Save Settings as Defaults:''' once you are satisfied with the settings, click this button to have EasyPBI remember your settings between uses.<br /> <br /> '''Change Directory:'''<br /> <br /> '''Change File:'''<br /> <br /> '''Use TMPFS:'''<br /> <br /> '''Select Module:''' select the previously created module which you would like to build.<br /> <br /> '''Build PBI:''' starts the build of the PBI using the settings contained within the PBI module. It will prompt you for the superuser password and requires a working Internet connection 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.<br /> <br /> '''Stop Build:''' stops the build process. Click the &quot;Build PBI&quot; button to resume the build.<br /> <br /> '''Save Build Log:''' useful if the build fails.<br /> <br /> You can produce additional modules from the &quot;Create Module&quot; tab while a PBI build is running. <br /> <br /> If the PBI build fails for some reason, you may need to modify the module. 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 as well as the module to the [http://lists.pcbsd.org/mailman/listinfo/pbi-dev pbi-dev mailing list].<br /> <br /> ==== Creating a New PBI with '''pbi_makeport''' ====<br /> <br /> Starting in PC-BSD 9.x and higher, '''pbi_makeport''' is included with the operating system. This utility provides an easy way for a user to convert an existing FreeBSD port into a PBI module. The PBI build server builds modules into PBIs which are then made available to users through AppCafe™. '''man pbi_makeport''' provides details on this application's various usage options. <br /> <br /> When running '''pbi_makeport''' it is possible to supply an optional meta-data configuration directory which contains additional data used to supplement the port building and the final PBI file. This conf directory may contain extra icon data for the desktop, install/uninstall scripts, custom make options and more. <br /> <br /> Examples of 9.x modules can be found at [http://trac.pcbsd.org/browser/pcbsd/current/src-sh/pbi-manager/module-examples Examples in Subversion].<br /> <br /> FreeBSD ports may contain build dependencies, runtime dependencies, and required libraries. When building a PBI, '''pbi_makeport''' automatically<br /> compiles all of the required dependencies, and, when finished compiling, prunes the build dependencies before packaging the PBI file, leaving only the runtime packages and libraries that are required for the program to work. This means that any files which are included in the PBI are necessary for the program to run, and manually removing them will cause the program to fail.<br /> <br /> ====Module Components====<br /> <br /> A PBI module contains the following components. When creating a PBI module, create a directory on your computer to hold the module's components. For example, if you are creating a PBI module for firefox, create a directory called firefox and place the following files within that directory. The directory that you create is referred to as %PBI_APPDIR%%. <br /> <br /> '''1. LICENSE File'''<br /> <br /> The text of a license agreement you want the user to click to accept before installation. This file is optional unless the underlying port is restricted and requires the user to accept a license in order to install and use the software.<br /> <br /> '''2. pbi.conf'''<br /> <br /> The pbi.conf file is mandatory. It is a simple shell script that contains the information needed to build the PBI. Typically this file requires you to modify a few simple variables, such as the name of the program, its location in the ports tree, and the name of its icon. Sometimes you will need to set a few additional variables in order to make sure that required dependencies are included in the PBI. If you get stuck when creating your own pbi.conf, you can view the pbi.conf file for every PBI module in [http://trac.pcbsd.org/browser#pbi/modules this section] of the PC-BSD trac repository. Here is an example of the pbi.conf file for firefox: <br /> &lt;nowiki&gt;<br /> #!/bin/sh<br /> # PBI Build Configuration<br /> # Place over-rides and settings here<br /> #<br /> # XDG Desktop Menu Spec:<br /> # http://standards.freedesktop.org/menu-spec/menu-spec-1.0.html<br /> ##############################################################################<br /> <br /> # Program Name<br /> PBI_PROGNAME=&quot;Firefox&quot;<br /> <br /> # Program Website<br /> PBI_PROGWEB=&quot;http://www.mozilla.com&quot;<br /> <br /> # Program Author / Vendor<br /> PBI_PROGAUTHOR=&quot;The Mozilla Foundation&quot;<br /> <br /> # Default Icon (Relative to %%PBI_APPDIR%% or resources/)<br /> PBI_PROGICON=&quot;share/pixmaps/FireFox-128.png&quot;<br /> <br /> # The target port we are building<br /> PBI_MAKEPORT=&quot;www/firefox&quot;<br /> <br /> # Additional options for make.conf<br /> PBI_MAKEOPTS=&quot;PACKAGE_BUILDING=Y<br /> WITH_CUPS=yes<br /> WITH_GECKO=libxul&quot;<br /> <br /> # Ports to build before / after<br /> PBI_MKPORTBEFORE=&quot;&quot;<br /> PBI_MKPORTAFTER=&quot;audio/esound x11-fonts/dejavu x11-themes/qtcurve-gtk2 devel/gconf2 www/firefox-i18n&quot;<br /> <br /> # Exclude List<br /> PBI_EXCLUDELIST=&quot;./include ./share/doc&quot;<br /> <br /> # Increment to trigger rebuild of PBI on build servers<br /> PBI_BUILDKEY=&quot;04&quot;<br /> <br /> # This app needs to install as root<br /> PBI_REQUIRESROOT=&quot;YES&quot;<br /> <br /> # Set the priority of this build <br /> PBI_AB_PRIORITY=&quot;50&quot;<br /> <br /> # Set the files we want to exclude from the shared hashdir<br /> PBI_HASH_EXCLUDES=&quot;lib/firefox/firefox&quot;<br /> <br /> export PBI_PROGNAME PBI_PROGWEB PBI_PROGAUTHOR PBI_PROGICON PBI_MAKEPORT PBI_MAKEOPTS <br /> PBI_MKPORTBEFORE PBI_MKPORTAFTER PBI_BUILDKEY PBI_REQUIRESROOT PBI_EXCLUDELIST&lt;/nowiki&gt;<br /> <br /> Table 10.7a describes the most commonly used variables. When creating your pbi.conf file, you will want to refer to the port's FreeBSD Makefile and pkg-descr so that you will know which values to input.<br /> <br /> '''Table 10.7a: Commonly Used pbi.conf Variables'''<br /> <br /> {{Tbl-init|width=100%}}<br /> {{Tbl-title|width=15%|'''Variable'''}} <br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROGNAME&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|Mandatory. Should be the same value as PORTNAME&lt;nowiki&gt;=&lt;/nowiki&gt; in the port's Makefile, but capitalized.}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROGWEB&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|Mandatory unless does not exist. Should be the same value as WWW&lt;nowiki&gt;=&lt;/nowiki&gt; in the port's pkg-descr.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROGAUTHOR&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|Mandatory. Often found in the port's pkg-descr or at the website for the application.}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROGICON&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|Mandatory. Path, relative to %PBI_APPDIR%%, to application icon file in png format.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROGREVISION&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|Bump up a PBI's revision number. Useful when rebuilding a port with new PBI specific options.}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_MAKEPORT&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|Mandatory. The path to the port within /usr/ports/.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_MAKEOPTS&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|Optional. Set this to the options that you want saved into make.conf for the port building process. For example: WITH_CUPS&lt;nowiki&gt;=&lt;/nowiki&gt;YES}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_MKPORTBEFORE&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|Optional. Port(s) to build before starting the target port PBI_MAKEPORT.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_MKPORTAFTER&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|Optional. Port(s) to build after finishing the target port PBI_MAKEPORT.}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_BUILDKEY&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|Should not be included. This variable is used on the PBI build server to force the rebuild of a PBI that has failed to build.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_REQUIRESROOT&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|Set to to YES to require this app to be installed as root, default is NO which allows to be installed as user or root mode.}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_EXCLUDELIST&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|List of files / directories to exclude from the final archive, such as ./include ./share}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_AB_PRIORITY&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|Set this to a number, the higher indicates greater priority and will be built before lower priority PBIs.}} <br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_AB_NOTMPFS&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|Set to YES to disable using tmpfs when doing auto-builds on a server.}} <br /> |-<br /> {{Tbl-line|align=left|'''PBI_HASH_EXCLUDES&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|align=left|Set to a space delimited list of files to exclude from merging into the shared hash-dir}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''export'''}}<br /> {{Tbl-line|bg=ff|align=left|Mandatory. Followed by a list of all of the variables that you have set so that they will be included when the PBI is built.}}<br /> |-<br /> |}<br /> <br /> '''3. external-links'''<br /> <br /> The optional external-links file contains a list of targets to link into the system's LOCALBASE at PBI installation time. This is useful for placing binaries and files in the user's PATH. When building PBIs from a FreeBSD port, this file is usually not needed, as most binaries and files are auto-detected and placed in the LOCALBASE. Example 10.7.1.3 shows an example usage:<br /> <br /> '''Example 10.7.1.3: Example external-links File'''<br /> <br /> &lt;nowiki&gt;<br /> # Files to be Sym-Linked into the default LOCALBASE<br /> # One per-line, relative to %%PBI_APPDIR%% and LOCALBASE<br /> # Defaults to keeping any existing files in LOCALBASE<br /> <br /> <br /> # TARGET LINK IN LOCALBASE ACTION<br /> #etc/rc.d/servfoo etc/rc.d/servfoo keep<br /> #include/libfoo.h include/libfoo.h replace<br /> #etc/rc.d/servfoo etc/rc.d/servfoo keep<br /> bin/firefox3 bin/firefox3 binary,nocrash&lt;/nowiki&gt;<br /> <br /> The flags in the ACTION column are as follows:<br /> <br /> * '''keep''': if this file already exists in LOCALBASE, don't overwrite it<br /> <br /> * '''replace''': replace this file in LOCALBASE if it exists<br /> <br /> * '''binary''': this file is an executable<br /> <br /> * '''nocrash''': used for binary files; don't display crash handler if program exits with non-0 status<br /> <br /> '''4. resources/'''<br /> <br /> The resources directory can contain extra files you wish copied into the PBI application directory. This is often the best place for icons and other files not included with a port. <br /> <br /> '''5. scripts/'''<br /> <br /> This directory can contain the following scripts:<br /> <br /> * '''post-install.sh''': script run immediately after the extraction of PBI contents to disk<br /> <br /> * '''post-portmake.sh''': script run during building of the PBI file, after the port-compile is finished<br /> <br /> * '''pre-install.sh''': script run before installation of the PBI; return non-0 to halt installation<br /> <br /> * '''pre-remove.sh''': script run before deletion of the PBI file<br /> <br /> Table 10.7.1.5 summarizes the variables that may be used in these scripts:<br /> <br /> '''Table 10.7.1.5 Supported Variables<br /> <br /> {{Tbl-init|width=100%}}<br /> {{Tbl-title|width=15%|'''Variable'''}} <br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROGNAME&lt;nowiki&gt;=&lt;/nowiki&gt;'''}}<br /> {{Tbl-line|bg=ff|align=left|Mandatory. Should be the same value as PORTNAME&lt;nowiki&gt;=&lt;/nowiki&gt; in the port's Makefile, but capitalized.}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROGDIRNAME'''}}<br /> {{Tbl-line|align=left|This is the name of the directory that is created for the PBI in the /usr/pbi/ directory.&lt;br&gt;(example: &quot;firefox-amd64&quot; for the 64-bit Firefox PBI)}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROGDIRPATH'''}}<br /> {{Tbl-line|bg=ff|align=left|This is the full path to the PBI install directory&lt;br&gt;(example: &quot;/usr/pbi/firefox-amd64/&quot; for the 64-bit Firefox PBI)}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROGVERSION'''}}<br /> {{Tbl-line|align=left|This is the version of the program. Should be the same value as the DISTVERSION= in the port's Makefile.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_RCDIR'''}}<br /> {{Tbl-line|bg=ff|align=left| }}<br /> |-<br /> {{Tbl-line|align=left|'''SYS_LOCALBASE'''}}<br /> {{Tbl-line|align=left| }}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_FAKEBIN_DIR'''}}<br /> {{Tbl-line|bg=ff|align=left| }}<br /> |-<br /> |} <br /> <br /> '''6. xdg-menu/ and xdg-desktop/'''<br /> <br /> The xdg-menu and xdg-desktop directories can be used to supply menu and desktop icons, respectively. The file that you place in these directories should be in the format pbiname.desktop. Example 10.7.1.6 shows the firefox.desktop files for the firefox PBI:<br /> <br /> '''Example 10.7.1.6: firefox.desktop File'''<br /> <br /> '''more xdg-menu/firefox.desktop'''<br /> #!/usr/bin/env xdg-open<br /> [Desktop Entry]<br /> Value=1.0<br /> Type=Application<br /> Name=FireFox<br /> GenericName=FireFox<br /> Exec=%%PBI_EXEDIR%%/firefox %U<br /> Path=%%PBI_APPDIR%%<br /> Icon=%%PBI_APPDIR%%/share/pixmaps/FireFox-128.png<br /> StartupNotify=true<br /> Categories=Network;<br /> <br /> '''more xdg-desktop/firefox.desktop'''<br /> #!/usr/bin/env xdg-open<br /> [Desktop Entry]<br /> Value=1.0<br /> Type=Application<br /> Name=FireFox<br /> GenericName=FireFox<br /> Exec=%%PBI_EXEDIR%%/firefox %U<br /> Path=%%PBI_APPDIR%%<br /> Icon=%%PBI_APPDIR%%/share/pixmaps/FireFox-128.png<br /> StartupNotify=true <br /> <br /> %%PBI_EXEDIR%% should reference the PBI's executable and any required switches.<br /> <br /> For more details on the XDG menu specifications, please refer to the [http://standards.freedesktop.org/menu-spec/menu-spec-1.0.html freedesktop specifications]. <br /> <br /> '''7. xdg-mime/'''<br /> <br /> The xdg-mime directory is used to register file associations according to the [http://standards.freedesktop.org/shared-mime-info-spec/shared-mime-info-spec-latest.html freedesktop MIME specs]. This requires the creation of an XML file. The example shown in Figure 10.7.1.7 adds the MIME information for gimp, so that it can be available as an application choice in a web browser:<br /> <br /> '''Example 10.7.1.7: Gimp MIME Info'''<br /> <br /> '''more xdg-mime/gimp-xdg.xml'''<br /> &lt;?xml version=&quot;1.0&quot;?&gt;<br /> &lt;mime-info xmlns='&lt;nowiki&gt;http://www.freedesktop.org/standards/shared-mime-info&lt;/nowiki&gt;'&gt;<br /> &lt;mime-type type=&quot;application/x-gimp&quot;&gt;<br /> &lt;comment&gt;Gimp - XCF File&lt;/comment&gt;<br /> &lt;glob weight=&quot;100&quot; pattern=&quot;*.xcf&quot;/&gt;<br /> &lt;glob weight=&quot;100&quot; pattern=&quot;*.XCF&quot;/&gt;<br /> &lt;/mime-type&gt;<br /> &lt;/mime-info&gt;<br /> <br /> ====Useful Tips====<br /> <br /> If your PBI's executable does not run, it may be because the program executable is actually a wrapper script rather than a binary file. If so, check the first line of the script to make sure it is using the right path for the scripting language. For example, ''#!/bin/python'' is an incorrect path which should be changed to ''#!/usr/pbi/(pbi-name)/bin/python''.<br /> <br /> The suggested path works because each program is packaged with the proper version of the language it uses and you want to make sure it uses that one. This is usually accomplished by putting a quick '''sed''' line in the ''post-install.sh'' script to fix the first line as seen in [http://trac.pcbsd.org/browser/pbi/modules/games/fretsonfire/scripts/post-install.sh?rev=13019 this example].<br /> <br /> When testing the executable, use the one located in ''/usr/pbi/(pbi-name)/bin/'' so all the linking will be properly set up. Otherwise you<br /> can get some interesting errors about missing files.<br /> <br /> === Building PBIs for PC-BSD 8.x and Earlier ===<br /> <br /> Earlier PBI versions were created using the PBI Builder Software. The PBI Builder Software automates the process of converting an existing FreeBSD package into a PBI. Anyone with a bit of time, the willingness to learn new things, and the desire to increase the number of PBIs available to PC-BSD users is welcome to create and submit new PBIs.<br /> <br /> Installing the PBI Builder software relatively easy, simply download the tbz package for you architecture and version of PC-BSD from the [http://www.pcbsd.org/development/get-involved/pbi-porting PBI Builder Homepage], and place it somewhere on your system with several GB of free space. Next run these commands (as root):<br /> <br /> # '''tar xvjpf pbibuild*.tbz'''<br /> # '''ln -s `pwd`/pbi-build /pbi-build'''<br /> <br /> ==== PBI Building Concepts ====<br /> <br /> The PBI Builder software relies on the following concepts:<br /> <br /> '''1. Modules:'''a directory containing the files needed by the PBI. The next section will explain how to configure a module for a new PBI.<br /> <br /> '''2. PBI Sandbox:''' in order to create a clean build environment that does not affect the software running on the host system, all PBI creation is done in the /pbi-build/pbisandbox directory. This is a complete buildworld environment, and you may chroot into it in order to tweak a port build, or inspect the built contents of a port by using this command as the superuser:<br /> <br /> # '''chroot /pbi-build/pbisandbox'''<br /> <br /> '''3. Build command:''' once you have a module, simply cd into the pbi-build directory and specify which module to build. Depending upon the size of the application, the build may take some time to finish. The following example will build the firefox PBI:<br /> <br /> # '''cd /pbi-build'''<br /> # '''./buildpbi.sh webbrowsers/firefox '''<br /> <br /> '''4. Recreate command:''' during the creation of a new module, it may become necessary to recreate the PBI file to test new configurations. If the PBI has already been compiled once, a change often does not require the complete rebuilding of the port from source. By skipping the source build, a new PBI may be generated within moments. To skip the building simply run the 3.makepbi.sh script in /pbi-build/scripts/3.makepbi.sh as shown:<br /> <br /> # '''cd /pbi-build/scripts'''<br /> # '''./3.makepbi.sh webbrowsers/firefox'''<br /> <br /> '''5. Distfiles:''' when running a port build, many files will be downloaded and stored in /usr/ports/distfiles within the /pbi-build/pbisandbox directory. The pbisandbox is removed between builds of modules, but starting in PBI Builder 2.0, the distfiles contents are preserved in the /pbi-build/distfiles directory.<br /> <br /> ==== Working with Modules ====<br /> <br /> When starting the process of creating a new module for the PBI Builder, you should start with an existing module and modify it to suit your program's needs. You can either copy a module from /pbi-build/docs/module-examples, download a module from SVN, or download a template from SVN.<br /> <br /> Modules currently in the PC-BSD Subversion repo can be browsed via the [http://trac.pcbsd.org/browser/pbibuild/modules web].<br /> <br /> To download a specific module, use the following commands, replacing &quot;firefox&quot; with the specific module you intend to checkout.<br /> <br /> # '''cd /pbi-build/modules'''<br /> # '''svn co &lt;nowiki&gt;svn://svn.pcbsd.org/pbibuild/modules/webbrowsers/firefox&lt;/nowiki&gt; webbrowsers/firefox'''<br /> <br /> If you wish to start with a blank module template, you may download by using these commands:<br /> <br /> # '''cd /pbi-build/modules'''<br /> # '''fetch &lt;nowiki&gt;http://www.pcbsd.org/files/templates/module-template.tgz&lt;/nowiki&gt;'''<br /> # '''tar xvzf module-template.tgz'''<br /> <br /> A proper module will contain several files and directories:<br /> <br /> '''Required files / directories'''<br /> <br /> * '''pbi.conf:''' the main configuration file for the module.<br /> <br /> * '''copy-files:''' listing of the files and directories you wish to copy from the pbisandbox environment to your finished PBI file.<br /> <br /> * '''kmenu-dir:''' directory of configuration entries for the K menu.<br /> <br /> * '''overlay-dir:''' directory of contents to be applied to base PBI directory. Icons, PBI setup scripts, and most other files not added via copy-files are placed here.<br /> <br /> '''Optional Files used on a per-need basis'''<br /> <br /> * '''build.sh:''' script to run after the port make and copy-files are processed. <br /> <br /> * '''preportmake.sh:''' script to run in pbisandbox prior to the port make being executed. <br /> <br /> * '''mime-dir:''' directory of mime entries for your PBI.<br /> <br /> ==== The pbi.conf file ====<br /> <br /> This file is the first thing you read for each module.<br /> The available variables are explained with the example of &quot;FireFox&quot; below:<br /> &lt;nowiki&gt;<br /> # Program Name<br /> # The name of the PBI file being built<br /> PROGNAME=&quot;Firefox&quot;<br /> <br /> # Program Website<br /> # Website of the program the module is building<br /> PROGWEB=&quot;http://www.mozilla.com&quot;<br /> <br /> # Program Author<br /> # Who created / maintains the program being built<br /> PROGAUTHOR=&quot;The Mozilla Foundation&quot;<br /> <br /> # Default Icon<br /> # Relative to overlay-dir, the main icon you want to show up for this PBI<br /> PROGICON=&quot;share/pixmaps/FireFox-128.png&quot;<br /> <br /> # Port we want to build<br /> # The port the server will track to determine when it's time for a rebuild<br /> PBIPORT=&quot;/usr/ports/www/firefox/&quot;<br /> <br /> # Set to &quot;Auto or NONE&quot; to have the PBI creator auto-populate libs or not<br /> # This allows you to also use the autolibs/ directory in your overlay-dir as a location for extra<br /> # library files<br /> PROGLIBS=&quot;Auto&quot;<br /> <br /> # PBI Update URL set to &quot;&quot; or the http:// URL of update checker<br /> # Leave this as update.pbidir.com normally<br /> PBIUPDATE=&quot;http://update.pbidir.com&quot;<br /> <br /> # Other Ports we need built<br /> # One per line, any additional ports that need to be built for this PBI<br /> OTHERPORT=&quot;&quot;<br /> <br /> # Enter your custom make options here<br /> # Options that will be put into the make.conf for the build of this port<br /> # Options get inserted into the build's /etc/make.conf file and effect all the ports built for that PBI<br /> MAKEOPTS=&quot;&quot;<br /> <br /> # FBSD7BASE - (7.1 or 7.2)<br /> # This variable can be used to set the specific version of FreeBSD this port needs to be compiled<br /> # under. Use this is a port is known to not build / work when compiled on FreeBSD 7.0 (the default)<br /> FBSD7BASE=&quot;7.2&quot;; export FBSD7BASE<br /> <br /> # This option determines if the pbi-builder will auto-copy files from the target port<br /> # Can be set to YES/NO/FULL<br /> # YES - Copy only target port files automatically<br /> # No - Don't copy any target port files (will need to use copy-files config instead)<br /> # FULL - Copy target port files, and recursive dependency files as well (Makes very large PBI)<br /> PBIAUTOPOPULATE=&quot;YES&quot; ; export PBIAUTOPOPULATE<br /> <br /> # Can be set to OFF/NO to disable copying all files from ports made with the OTHERPORT variable<br /> # Leaving this unset will have the builder auto-copy all files from OTHERPORT targets<br /> PBIAUTOPOPULATE_OTHERPORT=&quot;&quot; ; export PBIAUTOPOPULATE_OTHERPORT<br /> <br /> # Set this variable to any target ports you want to autopopulate files from, in addition to<br /> # the main target port<br /> # List additional ports one-per-line<br /> PBIAUTOPOPULATE_PORTS=&quot;/usr/ports/www/mplayer-plugin/&quot; ; export PBIAUTOPOPULATE_PORTS<br /> <br /> # By default the PBI will remove any xorg-fonts, and create a symlink to the the users system fonts<br /> # Setting this to YES keeps the PBIs internal fonts and doesn't create a link<br /> # PBIDISABLEFONTLINK=&quot;&quot; ; export PBIDISABLEFONTLINK<br /> <br /> # By default the libGL* libraries will be removed from a PBI in order to use the systems libGL<br /> # Set this to YES to keep the PBIs libGL* libraries, and not use the system's<br /> # PBIKEEPGL=&quot;&quot; ; export PBIKEEPGL<br /> <br /> # By default we prune any include/ files used for building,<br /> # Set this to NO to keep any include/ directories in the resulting PBI<br /> # PBIPRUNEINCLUDE=&quot;&quot; ; export PBIPRUNEINCLUDE<br /> <br /> # By default we prune the python files used for building,<br /> # Set this to NO to keep any python files in the resulting PBI<br /> # PBIPRUNEPYTHON=&quot;&quot; ; export PBIPRUNEPYTHON<br /> <br /> # By default we prune any perl files used for building,<br /> # Set this to NO to keep any perl files in the resulting PBI<br /> # PBIPRUNEPERL=&quot;&quot; ; export PBIPRUNEPERL<br /> <br /> # By default we prune any doc files (such as man, info, share/doc)<br /> # Set this to NO to keep any doc files in the resulting PBI<br /> # PBIPRUNEDOC=&quot;&quot; ; export PBIPRUNEDOC<br /> <br /> # Build Key - Change this to anything else to trigger a rebuild<br /> # - The rebuild will take place even if port is still the same ver<br /> BUILDKEY=&quot;01&quot;&lt;/nowiki&gt;<br /> ===== The copy-files configuration =====<br /> <br /> This file is very straight forward, simply list the files you want to copy from the installed port, and where they should go in your PBI directory structure. The first argument should be the file/directory you wish to copy, and the 2nd argument will be the directory within the PBI it needs to be copied to. <br /> <br /> Example copy-files from FileZilla:<br /> <br /> /usr/local/bin/filezilla bin/<br /> /usr/local/bin/fzsftp bin/<br /> /usr/local/bin/gst-* bin/<br /> /usr/local/bin/wxrc* bin/<br /> /usr/local/bin/wxgtk2* bin/<br /> /usr/local/share/filezilla share/filezilla<br /> <br /> ==== The preportmake.sh script ====<br /> <br /> This script, if it present is run right before starting the &quot;make install&quot; of your port. This allows you to make modifications to the pbisandbox environment or to the port building source itself. Normally this won't be<br /> necessary, unless working with a very tricky program to get compiled.<br /> <br /> Example:<br /> &lt;nowiki&gt;<br /> #!/bin/sh<br /> # Script to grab the java files and place them in the right directory<br /> # before starting the build<br /> <br /> cd /usr/ports/distfiles<br /> <br /> fetch ftp://ftp.pcbsd.org/pub/autobuildpkgs/javapack.tbz<br /> tar xvjf javapack.tbz<br /> <br /> cd /usr/ports/java/jdk16/<br /> echo &quot;#!/bin/sh<br /> exit 0&quot; &gt; /usr/ports/java/jdk16/files/license.sh<br /> <br /> cd /usr/ports/devel/automake15<br /> make install clean&lt;/nowiki&gt;<br /> <br /> ==== The build.sh script ====<br /> <br /> Below is the example of the build.sh script, which runs after all the files have been copied to your PBI directory. This allows you to make mods to specific things for your PBI to work properly. In this example we modify the uninstall script to use the right version.<br /> <br /> #!/bin/sh<br /> # PBI building script<br /> # This will run after your port build is complete<br /> # Build your PBI here, and exit 0 on success, or exit 1 on failure.<br /> ##############################################################################<br /> # Available Variables<br /> # PBIDIR = The location of where you can populate your PBI directory<br /> # MODULEDIR = The location of the module directory for this PBI<br /> # PORTVER = Version number of the port we used to build<br /> ##############################################################################<br /> <br /> # Save the right version number in the removepbi.sh script<br /> sed -e &quot;s,CHANGEME,Firefox${PORTVER},g&quot; ${PBIDIR}/scripts/removepbi.sh &gt; /tmp/removepbi.sh<br /> mv /tmp/removepbi.sh ${PBIDIR}/scripts/removepbi.sh<br /> chmod 755 ${PBIDIR}/scripts/removepbi.sh<br /> <br /> ==== The kmenu-dir directory ====<br /> <br /> In this directory you may make any number of files, which contain the .pbc configuration for your kmenu icons. This defines where you would like icons created for your users desktop<br /> <br /> Example of kmenu-dir/firefox file:<br /> <br /> ExePath: bin/firefox<br /> ExeIcon: share/pixmaps/FireFox-128.png<br /> ExeDescr: FireFox<br /> ExeNoDesktop: 0<br /> ExeNoMenu: 0<br /> ExeNoCrashHandler: 0<br /> ExeRunRoot: 0<br /> ExeRunShell: 0<br /> ExeNotify: 1<br /> ExeLink: 0<br /> ExeWebLink: 0<br /> ExeTaskbar: 0<br /> ExeOwndir: 1<br /> ExeKdeCat: Internet<br /> <br /> Line-By-Line description of each entry:<br /> ----<br /> <br /> '''ExePath''': bin/firefox<br /> <br /> This line indicates the binary / script we want this icon to run when the user clicks it. This is relative to the PBI directory, so we use bin/firefox<br /> <br /> '''ExeIcon''': share/pixmaps/FireFox-128.png<br /> <br /> This is the icon you want to show up for this program, again it is relative to the PBI directory<br /> <br /> '''ExeDescr''': FireFox<br /> <br /> This would be the name of the icon in the kmenu or on the users desktop.<br /> <br /> '''ExeNoDesktop''': 0<br /> <br /> This allows you to disable creating a desktop icon for this entry. Set it to '0' if you want a desktop icon, or '1' if you don't wish an icon.<br /> <br /> '''ExeNoMenu''': 0<br /> <br /> This allows you to disable creating a kmenu icon for this entry. Set it to '0' if you want a kmenu icon, or '1' if you don't wish an icon.<br /> <br /> '''ExeNoCrashHandler''': 0<br /> <br /> This option enables / disables the usage of the PC-BSD CrashHandler program. This dialog warns the user that the application has crashed if it returns status non-zero (0), and provides the option to save the output of stdout and stderr from the application. Setting this to &quot;1&quot; disables the CrashHandler helper, which is useful for programs which normally return non-0, such as Window Managers and various apps. <br /> <br /> '''ExeRunRoot''': 0<br /> <br /> This indicates if you want your program to be run as &quot;root&quot; when the user clicks it. Set it to '0' to run as a regular user, or '1' to run kdesu and switch to &quot;root&quot; Set this to '0'<br /> <br /> '''ExeRunShell''': 0<br /> <br /> This indicates if you want your program to be executed in a console session, which may be useful for command-line applications. Set it to '0' if you dont want it to run in console, or set it to '1' if you do.<br /> <br /> '''ExeNotify''': 1<br /> <br /> This indicates if you want to enable launch feedback in KDE, which is the bouncing icon, showing that the program is loading. Set it to '0' to disable launch feedback, or set it to '1' if you want this enabled. Normally it is<br /> best to leave this enabled.<br /> <br /> '''ExeLink''': 0<br /> <br /> This is used to indicate if the ExePath variable was set to a local file / document you want opened with konqueror insetead of just being &quot;run&quot;. This is useful for README type documents. Set this to '1' if you want your document opened with konq, or '0' to just run it as normal.<br /> <br /> '''ExeWebLink''': 0<br /> <br /> This is similar to above, and instead indicates that the ExePath being opened is actual a web URL. Set this to '1' to open it the ExePath with Konq, or '0' to just run it as normal.<br /> <br /> '''ExeTaskbar''': 0<br /> <br /> This indicates if you want this application icon added to the taskbar. Set it to '1' to add it, or '0' to leave it disabled. (THIS FEATURE IS CURRENTLY UNAVAILABLE, BUT WILL BE ADDED DOWN THE ROAD)<br /> <br /> '''ExeOwndir''': 1<br /> <br /> This option is used to specify where you want your Kmenu icon to be placed, and may be set to 0, 1, 2<br /> 0 = Place kmenu icon directory in top level. <br /> I.E. Kmenu -&gt; Firefox -&gt; Firefox<br /> 1 = Place kmenu icon in its own directory in the sub category indicated by ExeKdeCat:<br /> I.E. Kmenu -&gt; Internet -&gt; Firefox -&gt; Firefox<br /> 2 = Place kmenu icon directly in the sub category indicated by ExeKdeCat: <br /> I.E. Kmenu -&gt; Internet -&gt; Firefox<br /> <br /> '''ExeKdeCat''': Internet<br /> <br /> This allows you to choose a kmenu sub-directory to place your icons / directory into, when ExeOwnDir is set to 1 or 2. <br /> Available options are:<br /> &lt;nowiki&gt;<br /> ExeKdeCat: Development<br /> ExeKdeCat: Editors<br /> ExeKdeCat: Edutainment/Languages<br /> ExeKdeCat: Edutainment/Math<br /> ExeKdeCat: Edutainment/Misc<br /> ExeKdeCat: Edutainment/Science<br /> ExeKdeCat: Edutainment/Teaching<br /> ExeKdeCat: Games/Arcade<br /> ExeKdeCat: Games/Board<br /> ExeKdeCat: Games/Card<br /> ExeKdeCat: Games/Kidsgames<br /> ExeKdeCat: Games/TacticStrategy<br /> ExeKdeCat: Games<br /> ExeKdeCat: Graphics<br /> ExeKdeCat: Internet<br /> ExeKdeCat: Multimedia<br /> ExeKdeCat: Office<br /> ExeKdeCat: System<br /> ExeKdeCat: Toys<br /> ExeKdeCat: Utilities&lt;/nowiki&gt;<br /> <br /> ==== The mime-dir directory ====<br /> <br /> This directory allows to you specify mime types for your applications defined in the kmenu-dir entries.<br /> <br /> Example of mime-dir/exe file:<br /> <br /> MimeExt: *.exe; *.EXE<br /> MimeIcon: win_apps.png<br /> MimeProg: 0<br /> <br /> The only catch to this is to note that the &quot;MimeProg: 0&quot; is a pointer to a file in the kmenu-dir structure. In this case you would have to ensure that the application you want to open .exe files gets added first to the template<br /> the server creates. Files in the kmenu-dir are added in the order of a &quot;ls&quot; listing, so if you have a wine-exe entry, you may wish to rename it to 00wine-exe to ensure it is added first, which would make this MimeProg: 0<br /> entry work with it.<br /> <br /> If you have more than 1 mime-type, you would then increment the MimeProg: 0 number to MimeProg: 1, MimeProg: 2, and so forth. Then you would do the same with your kmenu-dir entries, such as 00wine-exe, 01wine-bat, 02wine-msi<br /> <br /> ==== The overlay-dir directory ====<br /> <br /> This folder contains any of the files you wish placed into your PBI program directory. Here is an example from firefox:<br /> <br /> leftside.png<br /> PBI.FirstRun.sh autolibs lib<br /> PBI.RemoveScript.sh bin scripts<br /> PBI.SetupScript.sh header.png share<br /> <br /> In this example you see we have added our PBI.* setup scripts, and the custom graphics we want for the PBI installer. You may also create directories that will be populated with the copy-files configuration, such as share/ or others you may need.<br /> <br /> ==== Useful Tips ====<br /> <br /> '''If the program uses the python programming language:''' use [PBIPRUNEPYTHON=&quot;NO&quot; ; export PBIPRUNEPYTHON] (usually the file is called py-(something) if that file is written in python)<br /> <br /> '''If the program uses the perl programming language:''' use [PBIPRUNEPERL=&quot;NO&quot; ; export PBIPRUNEPERL] (harder to spot, usually the filename has &quot;perl&quot; in it somewhere)<br /> <br /> '''The installed program does not work:''' this is usually because the python or perl option was not set appropriately. This is only noticed at runtime because after building, python and perl files are removed unless instructed otherwise.<br /> <br /> '''If your program path needs to be /usr/local/sbin:''' first, make a kmenu-dir entry similar to the one used by [http://trac.pcbsd.org/browser/pbibuild/modules/archivers/cabextract/kmenu-dir/cabextract cabextract]. Next, make sure that the &quot;ExeNoDesktop&quot; and &quot;ExeNoMenu&quot; options are both set to &quot;1&quot;. Then, in your PBI.SetupScript.sh, you can symlink the wrapper script into /Programs/bin as in [http://trac.pcbsd.org/browser/pbibuild/modules/archivers/cabextract/overlay-dir/PBI.SetupScript.sh this example].<br /> <br /> '''If the underlying port pauses to wait for user acceptance of license agreement:''' put this setting into the MAKEOPTS variable:<br /> <br /> MAKEOPTS=&quot;DISABLE_LICENSES=yes&quot;<br /> <br /> Don't forget to include the license text in the file overlay-dir/LICENSE so the user can read and accept the license during the PBI installation.<br /> <br /> '''If you don't have reliable Internet access and want to avoid running portsnap and build a PBI with pre-fetched distfiles:''' use this variable in /pbi-build/conf/pbibuild.conf:<br /> <br /> PORTSNAP=NO<br /> <br /> Place all of your distfiles into /pbi-build/distfiles; with this variable set, that directory will be nullfs mounted into the PBI sandbox when doing builds.<br /> <br /> '''How does the builder know which port the module is associated with?'''<br /> <br /> The PBI build system will look at the module path first, so if in SVN we are using the module www/firefox, it'll look for a port at www/firefox. However, in some cases a module doesn't use the same port or directory name. In that case, set this variable:<br /> &lt;nowiki&gt; <br /> # The target port we are building<br /> PBI_MAKEPORT=&quot;www/firefox&quot;<br /> export PBI_MAKEPORT&lt;/nowiki&gt;<br /> <br /> That'll let the build server know which specific port this is building.<br /> <br /> = Getting Help =<br /> <br /> The [http://lists.pcbsd.org/mailman/listinfo/pbi-dev PBI Developers mailing list] can help if you:<br /> <br /> * get stuck building a PBI<br /> * need to ask a question about your PBI <br /> * are ready to submit a new module<br /> * find a bug in an existing PBI<br /> * have a bugfix for an existing PBI</div>

Krismoore http://wiki.pcbsd.org/index.php/PC-BSD%C2%AE_9.1_TODO 2011-12-09T15:22:42Z

<p>Krismoore: /* New Features / Tools planned for 9.1 */</p> <hr /> <div>==== New Features / Tools planned for 9.1 ====<br /> {| border=1<br /> |'''Feature'''<br /> |'''Owner'''<br /> |'''Skills'''<br /> |'''Status'''<br /> |'''Completion Date'''<br /> |-<br /> |add inmate browser to Warden GUI<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add iSCSI initiator GUI front-end to iscontrol(8) for connecting to FreeNAS™ systems<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |replace firewall GUI with fwbuilder and document how to use<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |add Info button to Service Manager containing description<br /> |<br /> |<br /> |should really be a DESCRIPTION field in rc.d scripts<br /> |<br /> |-<br /> |Animated splash screen<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Create PBI or inmate for BBB<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |Add system info desktop icon to live mode<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add help buttons to custom menus, write help text and add to Pootle<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |Use the [http://wiki.freebsd.org/OliverFromme/BootLoader Graphical Boot Loader] from OliverFromme<br /> |<br /> |C / FreeBSD Commit Access / ?<br /> |<br /> |<br /> |-<br /> |Front-end to text installer<br /> |jhixson<br /> |<br /> |<br /> |<br /> |-<br /> |Add options for proxy settings in network page of installer<br /> |kris<br /> |<br /> |C++ / QT4<br /> |<br /> |-<br /> |Speed up installed boot-time, background system services / load desktop immediately?<br /> |jpaetzel<br /> |FreeBSD rc.d / Scripting?<br /> |<br /> |<br /> |-<br /> |Create new Disk Management GUI for post-install usage, ZFS, Advanced FS tasks such as ZFS snapshots, ZFS quota/compression<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Add manual disk configuration to installer and install to specific mount-point<br /> |kris<br /> |C++ / QT4 / shell<br /> |<br /> |<br /> |-<br /> |Add option to play some simple games while waiting for installation<br /> |kris<br /> |C++ / QT4 / shell<br /> |<br /> |<br /> |-<br /> |Add ability to backup ZFS datasets (in life preserver?)<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Merge &quot;The Warden&quot; into PC-BSD SVN as a built-in tool for managing jails<br /> |kmoore<br /> |C++ / QT4 / Shell<br /> |<br /> |<br /> |-<br /> |Pre-select keyboard layout / timezone based upon language selection<br /> |kmoore<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Add password strength meter to installer and warn if root / user are same. <br /> |kmoore<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Localize the meta-pkg descriptions<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |Show meta-pkg port lists in installer / system tool<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |C++ / QT CUPS GUI<br /> | Loic Maury<br /> |C++ / C<br /> |<br /> |<br /> |-<br /> |Switch LifePreserver to use /var/ for its backend files<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |Bluetooth GUI<br /> |ken<br /> |<br /> |<br /> |<br /> |-<br /> |allow pc-sysinstall to import existing ZFS layout<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> | changing default language / locale for GDM in pc-sysinstall<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add Update All to Appcafe<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add TRIM support to pc-sysinstall / GUI<br /> |<br /> |<br /> |<br /> |-<br /> |Update network GUI to set DNS manually in /etc/dhclient.conf when not using static IPs. <br /> |<br /> |<br /> |<br /> |-<br /> |}</div>

Krismoore http://wiki.pcbsd.org/index.php/PC-BSD%C2%AE_9.1_TODO 2011-12-09T15:17:50Z

<p>Krismoore: /* New Features / Tools planned for 9.1 */</p> <hr /> <div>==== New Features / Tools planned for 9.1 ====<br /> {| border=1<br /> |'''Feature'''<br /> |'''Owner'''<br /> |'''Skills'''<br /> |'''Status'''<br /> |'''Completion Date'''<br /> |-<br /> |add inmate browser to Warden GUI<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add iSCSI initiator GUI front-end to iscontrol(8) for connecting to FreeNAS™ systems<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |replace firewall GUI with fwbuilder and document how to use<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |add Info button to Service Manager containing description<br /> |<br /> |<br /> |should really be a DESCRIPTION field in rc.d scripts<br /> |<br /> |-<br /> |Animated splash screen<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Create PBI or inmate for BBB<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |Add system info desktop icon to live mode<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add help buttons to custom menus, write help text and add to Pootle<br /> |dru<br /> |<br /> |<br /> |<br /> |-<br /> |Use the [http://wiki.freebsd.org/OliverFromme/BootLoader Graphical Boot Loader] from OliverFromme<br /> |<br /> |C / FreeBSD Commit Access / ?<br /> |<br /> |<br /> |-<br /> |Front-end to text installer<br /> |jhixson<br /> |<br /> |<br /> |<br /> |-<br /> |Add options for proxy settings in network page of installer<br /> |kris<br /> |<br /> |C++ / QT4<br /> |<br /> |-<br /> |Speed up installed boot-time, background system services / load desktop immediately?<br /> |jpaetzel<br /> |FreeBSD rc.d / Scripting?<br /> |<br /> |<br /> |-<br /> |Create new Disk Management GUI for post-install usage, ZFS, Advanced FS tasks such as ZFS snapshots, ZFS quota/compression<br /> |<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Add manual disk configuration to installer and install to specific mount-point<br /> |kris<br /> |C++ / QT4 / shell<br /> |<br /> |<br /> |-<br /> |Add option to play some simple games while waiting for installation<br /> |kris<br /> |C++ / QT4 / shell<br /> |<br /> |<br /> |-<br /> |Add ability to backup ZFS datasets (in life preserver?)<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Merge &quot;The Warden&quot; into PC-BSD SVN as a built-in tool for managing jails<br /> |kmoore<br /> |C++ / QT4 / Shell<br /> |<br /> |<br /> |-<br /> |Pre-select keyboard layout / timezone based upon language selection<br /> |kmoore<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Add password strength meter to installer and warn if root / user are same. <br /> |kmoore<br /> |C++ / QT4<br /> |<br /> |<br /> |-<br /> |Localize the meta-pkg descriptions<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |Show meta-pkg port lists in installer / system tool<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |C++ / QT CUPS GUI<br /> | Loic Maury<br /> |C++ / C<br /> |<br /> |<br /> |-<br /> |Switch LifePreserver to use /var/ for its backend files<br /> |kmoore<br /> |C++ / Shell<br /> |<br /> |<br /> |-<br /> |Bluetooth GUI<br /> |ken<br /> |<br /> |<br /> |<br /> |-<br /> |allow pc-sysinstall to import existing ZFS layout<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> | changing default language / locale for GDM in pc-sysinstall<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |add Update All to Appcafe<br /> |<br /> |<br /> |<br /> |<br /> |-<br /> |Add TRIM support to pc-sysinstall / GUI<br /> |<br /> |<br /> |<br /> |-<br /> |}</div>

Krismoore http://wiki.pcbsd.org/index.php/PBI_Manager 2011-12-07T20:35:42Z

<p>Krismoore: /* Release History */</p> <hr /> <div>{{NavHeader|back=Using AppCafe™|forward=Update Manager}}<br /> PC-BSD 9.0 introduced PBI Manager, a suite of command line utilities for managing PBIs. PBI Manager's command-line tools can be used to install, remove, create and manage PBIs. It is also available for [[#Installing_PBI_Manager|FreeBSD systems]]. The PBI Manager is released under the [http://www.freebsd.org/copyright/freebsd-license.html BSD license].<br /> <br /> <br /> ===New Features===<br /> <br /> The new PBI format introduces the following features:<br /> <br /> * '''Upgrade deltas:''' since PBIs are self-contained, installation files tend to be large. In the previous implementation, updating a PBI required the re-downloading of the entire installation archive. For larger applications this could be a time-consuming process, especially over low bandwidth connections. The new PBI specification performs updates using binary diff patches known as PBP (Push Button Patch) files. PBPs are a fraction of the PBI's size; in some cases less than 5% of the original PBI archive. An upgrade automatically checks for for the presence of a PBP file and attempts to use it, only falling back to the original archive should the process fail.<br /> <br /> * '''Library and file sharing:''' in the previous implementation of the PBI format it was common that identical files existed between various applications. These duplicates, while necessary to provide self-contained functionality, wasted both disk and runtime memory. This waste of space has been greatly reduced through the use of a hash-dir directory where libraries and common files are shared through a system of hard links. When an identical file is found in a PBI, the original will be removed and a hard-link stored in the hash-dir. After a PBI has been removed, any unneeded files left in the hash-dir are cleaned up by the pbid(8) daemon which monitors and maintains the integrity of the shared files.<br /> <br /> * '''Repository management:''' allows administrators and PBI builders to create and manage their own repositories of PBIs. This repository system provides a number of tools for PBI distribution, release management, and repository browsing. <br /> <br /> * '''Digitally signed PBIs:''' each repository includes an openssl public key file which is installed on the end user's system. Each PBI includes several signatures for the content archive and installation and removal scripts. During the PBI installation process, these signatures are checked to confirm that the archive has not been tampered with during transit. This key file is also used to associate a particular PBI with a parent repository for upgrade purposes, since it is possible that multiple repositories will have the same applications.<br /> <br /> * '''Root password not required:''' most applications can be installed and upgraded by user (non-root) accounts. This allows enhanced security in office or home situations, where users can now add/remove desktop applications without needing access to the root account. PBIs that impact on the security of the system (e.g. installing a web server) will require root access.<br /> <br /> * '''Implementation:''' the previous PBI design was developed in QT/KDE C++, making it inappropriate for use at the command line. The new format is implemented 100% in shell and is comprised of command-line utilities, each with an associated man page. These utilities are discussed in more detail in the rest of this section.<br /> <br /> '''Additional Resources:'''<br /> <br /> [http://www.pcbsd.org/~kris/pbi9-slides.pdf The PBI Format Re-implemented for Free/PC-BSD (conference slides)]<br /> <br /> [http://www.pcbsd.org/~kris/asiabsdcon2011-pbi9.pdf The PBI Format Re-implemented for Free/PC-BSD (formal paper)]<br /> <br /> [[PBI9 Format|The PBI Format for 9.0 and Beyond]]<br /> <br /> === Release History ===<br /> * '''0.9.7''' (12-07-11) - Kris Moore<br /> - Use -a flag for fetch to retry after soft failures<br /> <br /> - Don't create binary patch files, if they are larger than the source<br /> <br /> - Add ability to use /etc/pbi-make.conf on system, letting us set universal make options<br /> <br /> - Simplify the startup with less parsing commands<br /> <br /> - Add new -R flag for pbi_add, which only downloads a PBI from a mirror, without installing it<br /> <br /> - Add support for using &quot;ccache&quot; automatically if configured on the host system<br /> <br /> - Fixed a bug using &quot;pbi_create&quot; on a directory manually, make sure file end up in proper PBI application directory<br /> <br /> - Make sure we use the systems share/icons directory to use shared cursors / icons across all PBIs<br /> <br /> <br /> * '''0.9.6''' (11-07-11)<br /> - Fix some bugs doing cleanup of stagedir / build directories<br /> <br /> - Properly kill fetch process when canceling a download<br /> <br /> - Improve buildworld on FreeBSD to use /usr/src if it already has source<br /> <br /> - Fix some random warnings when building via sudo<br /> <br /> <br /> * '''0.9.5''' (11-03-11)<br /> - Add sizes of PBIs to the meta index files<br /> <br /> - Fix bug adding default icon to PBIs when none is specified<br /> <br /> - Fix handling of PBI_PROGREVISION<br /> <br /> - Make sure we unmount nullfs mounts completely<br /> <br /> <br /> * '''0.9.4''' (10-19-11)<br /> - Fix issue using system-fonts in PBIs<br /> <br /> - Fix issue removing files which have been set r--<br /> <br /> - Slow down fetch process to fix issues with fetch protocol errors<br /> <br /> - Fix bug coping linux libraries into final PBI file<br /> <br /> - Allow user settings in external-links to overwrite auto-detected values<br /> <br /> - Fix bug running &quot;stat&quot; on files with spaces in name<br /> <br /> - Validate the build checksum before doing patching<br /> <br /> - Speed up builds with optional --tmpfs flags<br /> <br /> - Add priority system to building modules<br /> <br /> - Fix issues setting proxy support from pbi.conf / pcbsd.conf files<br /> <br /> - Validate repo URL's when creating .rpo file<br /> <br /> <br /> * '''0.9.3''' (07-18-11)<br /> - Unset variables between auto-builds<br /> <br /> - Fixed some warnings with 'cut' when parsing i18n strings<br /> <br /> - When doing auto-builds, run through alphabetically<br /> <br /> - Increase check frequency when first trying to download index's<br /> <br /> - Speed up the hashdir merging<br /> <br /> - Show repo MD5 with listings<br /> <br /> - If no index files, do not fail on listing, just show empty repo<br /> <br /> <br /> * '''0.9.2''' (05-23-11)<br /> - Fixed usage errors with &quot;tr&quot;<br /> <br /> - Syntax fixes when trying to install app with no meta-data<br /> <br /> - Fixed some bugs with binary patching<br /> <br /> - Fixed auto-builder using the PBI_BUILDKEY in modules pbi.conf file<br /> <br /> - When building ports, don't export PREFIX since it confuses some linux ports<br /> <br /> - Perform check if user is root, if PBI is flagged root-only<br /> <br /> - Auto-builder now checks if port is compatible with arch type of system<br /> <br /> <br /> * '''0.9.1''' - Initial public release (05/3/11)<br /> <br /> === What is the PBI format? ===<br /> <br /> The idea behind the PBI format is that one of the things holding back mainstream adoption of open source desktops is the package management format. With almost all open source desktops, software is simply treated as part of the operating system. Thus, when performing an update of some seemingly trivial application, you run the risk of potentially needing to upgrade other packages which could break other critical parts of your desktop. <br /> <br /> While package management systems have gotten better at resolving these dependency issues, trying to fix conflicts and prevent breakage before it occurs, they still don't address the underlying problem: every software package is a part of the system, and pulling on any one thread has the potential of causing a break somewhere farther down the line.<br /> <br /> The PBI format tries to correct this underlying flaw. Rather than making every application a part of the base system, PBIs are self-contained, including their own dependent library tree and related data. As a result, when you install a PBI there are no dependency issues to resolve, and applications can be added or removed freely, without fear of causing breakage to the desktop or any other installed software.<br /> <br /> === Installing PBI Manager ===<br /> <br /> If you are running PC-BSD 9 or higher, then the PBI Manager is already installed, and you can use it via the command-line, or a front-end such as the AppCafe™. <br /> <br /> FreeBSD users can install it from the [http://www.freshports.org/ports-mgmt/pbi-manager ports tree]. <br /> <br /> <br /> Users interested in installing the development version from our [http://trac.pcbsd.org/brower/pcbsd/current/src-sh/pbi-manager/ SVN repository] can do so with the following commands:<br /> <br /> '''svn co &lt;nowiki&gt;svn://svn.pcbsd.org/pcbsd/current/src-sh/pbi-manager&lt;/nowiki&gt;'''<br /> '''cd pbi-manager'''<br /> '''make install'''<br /> <br /> '''NOTE: The development version may be unstable / buggy, use at your own risk'''<br /> <br /> === Getting PBI Files ===<br /> <br /> The PC-BSD project has begun building PBIs which work with PBI Manager for FreeBSD/PC-BSD 9. A list of approved &amp; available PBIs can be viewed with '''pbi_info -i''' or '''pbi_browser''', and then installed with '''pbi_add -r &lt;pbiname&gt;'''. Until 9.0 is released the number of available PBIs will remain small but may be downloaded directly from the build server:<br /> <br /> [http://pbibuild.pcbsd.org/index.php?ver=9 9.x i386 PBIs]<br /> <br /> [http://pbibuild64.pcbsd.org/index.php?ver=9 9.x amd64 PBIs]<br /> <br /> '''NOTE:''' PBI files previously created for PC-BSD 7.x/8.x will NOT work with PBI Manager, these are specific to PC-BSD 7/8.<br /> <br /> ===Underlying File / Directory Structure===<br /> <br /> <br /> The underlying files / directories used by PBI Manager are as follows:<br /> <br /> '''/usr/local/etc/pbi.conf''': location of the PBI Manager configuration file <br /> <br /> '''/usr/pbi/''': where PBIs are installed on the system<br /> <br /> '''/var/db/pbi/''': contains data files related to installed PBIs and repositories <br /> <br /> '''/usr/local/sbin/pbi_*''': location of the PBI Manager commands<br /> <br /> '''/usr/local/share/pbi-manager/module-examples/convertoldmod.sh''': script which can be used to convert an existing 7.x/8.x PBI module to the new 9.x format.<br /> <br /> === Feedback / Reporting Problems ===<br /> <br /> Feedback, problem reports, and general discussion are welcome on the [http://lists.pcbsd.org/mailman/listinfo/pbi-dev PBI Developers Mailing list]. <br /> <br /> === Command Reference ===<br /> <br /> The following is a list of commands installed by the pbi-manager, along with a small synopsis of each. For more details, please refer to the command's man page.<br /> <br /> ==== pbi_add(1) ====<br /> <br /> Similar to FreeBSD's '''pkg_add''', the '''pbi_add''' command is used for adding/installing PBIs on a system, either from a local file or remotely from a repository. This utility supports the options listed in Table 6.2.4.1: <br /> <br /> '''Table 6.2.4.1: pbi_add Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> &lt;!-- row 1 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-e'''}}<br /> {{Tbl-line|bg=ff|align=left|Extract only, do not install. Will extract the archive to ~/&lt;pbidirname&gt; unless the -o option is used}}<br /> |-<br /> &lt;!-- row 2 --&gt;<br /> {{Tbl-line|align=left|'''-f'''}} <br /> {{Tbl-line|align=left|Force installation, overwriting an already installed copy of the application}}<br /> |- <br /> &lt;!-- row 3 --&gt; <br /> {{Tbl-line|bg=ff|align=left|'''-g'''}} <br /> {{Tbl-line|bg=ff|align=left|Get and show path to icon/images for GUI installations}}<br /> |-<br /> &lt;!-- row 4 --&gt; <br /> {{Tbl-line|bg=ee|align=left|'''-i'''}} <br /> {{Tbl-line|bg=ee|align=left|Display information about specified PBI}}<br /> |-<br /> &lt;!-- row 5 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-l'''}} <br /> {{Tbl-line|bg=ff|align=left|Display LICENSE for specified PBI}}<br /> |-<br /> &lt;!-- row 6 --&gt; <br /> {{Tbl-line|align=left|'''-o outdir'''}} <br /> {{Tbl-line|align=left|Specify the directory to use when extracting the PBI with -e.}}<br /> |-<br /> &lt;!-- row 7 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-r'''}} <br /> {{Tbl-line|bg=ff|align=left|Remote fetch installation file from update server. The system architecture and version will be automatically determined to fetch the correct file.}}<br /> |-<br /> &lt;!-- row 8 --&gt;<br /> {{Tbl-line|align=left|'''-v'''}} <br /> {{Tbl-line|align=left|Enable verbose output}}<br /> |-<br /> &lt;!-- row 9 --&gt; <br /> {{Tbl-line|bg=ff|align=left|'''--checkscript'''}} <br /> {{Tbl-line|bg=ff|align=left|Display any custom scripts used in the installation/removal of this PBI file.}} <br /> |-<br /> &lt;!-- row 10 --&gt; <br /> {{Tbl-line|align=left|'''--licagree'''}} <br /> {{Tbl-line|align=left|Agree to LICENSE terms and conditions. Viewing the license can be done with -l flag}}<br /> |-<br /> &lt;!-- row 11 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''--no-checksig'''}} <br /> {{Tbl-line|bg=ff|align=left|Skip the openssl signature verification of the PBI data}}<br /> |-<br /> &lt;!-- row 12 --&gt;<br /> {{Tbl-line|align=left|'''--no-checksum'''}} <br /> {{Tbl-line|align=left|Skip the checksum verification of the archive data}}<br /> |-<br /> &lt;!-- row 13 --&gt; <br /> {{Tbl-line|bg=ff|align=left|'''--no-hash'''}} <br /> {{Tbl-line|bg=ff|align=left|Disable using shared hash dir which uses hard-links to share files between applications}} <br /> |-<br /> &lt;!-- row 14 --&gt;<br /> {{Tbl-line|align=left|'''--repo repoid'''}}<br /> {{Tbl-line|align=left|Specify which repository to use}}<br /> |-<br /> &lt;!-- row 15 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''--rArch arch'''}}<br /> {{Tbl-line|bg=ff|align=left|Manually specify the PBI architecture type of i386 or amd64}}<br /> |-<br /> &lt;!-- row 16 --&gt;<br /> {{Tbl-line|align=left|'''--rVer version'''}}<br /> {{Tbl-line|align=left|Specify which version of the PBI to install}}<br /> |-<br /> |}<br /> <br /> For security reasons, it is recommend that users first use the -e and --checkscript options to view archive contents and installation scripts prior to installing a PBI file.<br /> <br /> To install a PBI, use: '''pbi_add -r PBINAME'''. The following example will install the alpine PBI:<br /> <br /> '''pbi_add -r alpine'''<br /> Downloading ftp://ftp.pcbsd.org/pub/mirror/PBI/mail/alpine/9/x32/alpine-2.00_3-i386.pbi<br /> /usr/pbi/.alpine-2.00_3-i386.pbi.42391 100% of 11 MB 295 kBps 00m00s<br /> Verifying Checksum...OK<br /> Extracting to: /usr/pbi/alpine-i386<br /> Installed: Alpine-2.00_3<br /> <br /> ==== pbi_addrepo(1) ====<br /> <br /> The '''pbi_addrepo''' command is used to register a new PBI repository on a system. If the '''pbid''' daemon is running, the repository's index and meta files will be automatically fetched and made ready for browsing. The command has one argument, the name of the repository file. Repository files have a .rpo extension and are created with the '''pbi_makerepo''' command.<br /> <br /> ==== pbi_autobuild(1) ====<br /> <br /> The '''pbi_autobuild''' command is used on the PBI build system to build any out-of-date or new packages. The utility is also of interest to PBI testers and system administrators who create and maintain their own internal repository of PBIs. It can traverse the FreeBSD ports and Meta-data trees, building missing PBI files or PBIs in which the target port version has been updated. Table 6.2.4.3 summarizes this command's options:<br /> <br /> '''Table 6.2.4.3: pbi_autobuild Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> &lt;!-- row 1 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-c confdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify the directory containing the PBI configuration modules data to traverse. Any found pbi.conf files will be parsed, and if PBI_MAKEPORT is set, the target port will be used for the build. If PBI_MAKEPORT is unset, the auto-build will attempt to match the module to a FreeBSD port based upon the dirname of pbi.conf}}<br /> |-<br /> {{Tbl-line|align=left|'''-d portsdir'''}}<br /> {{Tbl-line|align=left|Specify an alternative ports-dir; defaults to /usr/ports}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-h script'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify a helper script to call after building a PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''-o outdir'''}}<br /> {{Tbl-line|align=left|The directory to place the finished PBI files. Also used to determine which apps are in need of a rebuild if the associated FreeBSD port has been updated.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--genpatch'''}}<br /> {{Tbl-line|bg=ff|align=left|When building a new PBI, check for archived copies, and generate smaller patch updates to the new version (*.pbp files)}}<br /> |-<br /> {{Tbl-line|align=left|'''--keep num'''}}<br /> {{Tbl-line|align=left|When building new PBIs, keep &lt;num&gt; copies of past versions of working PBI in &lt;outdir&gt;/archived/ folder. These archived copies can be used with the --genpatch command to generate update patch files.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--prune'''}}<br /> {{Tbl-line|bg=ff|align=left|Remove any PBIs which no longer have an associated module in confdir}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|Digitially sign the PBI file with the specified openssl private key file}} <br /> |-<br /> |}<br /> <br /> ==== pbi_browser(1) ====<br /> <br /> The '''pbi_browser''' command provides a CLI front-end to browsing a repository's available PBIs. Options for viewing categories and searching by keyword are available, and once the desired PBI is located, it will show the '''pbi_add''' command which can be used to install the application. Table 6.2.4.4 summarizes the available options.<br /> <br /> '''Table 6.2.4.4: pbi_browser Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-c category'''}}<br /> {{Tbl-line|bg=ff|align=left|Displays a list of PBIs in the specified category}}<br /> |-<br /> {{Tbl-line|align=left|'''-s search'''}}<br /> {{Tbl-line|align=left|Search for PBIs containing the specified string in the name, description, or keywords}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--listcats'''}}<br /> {{Tbl-line|bg=ff|align=left|List the available categories}}<br /> |-<br /> {{Tbl-line|align=left|'''--viewall'''}}<br /> {{Tbl-line|align=left|List all available PBIs}}<br /> |-<br /> |}<br /> <br /> ====pbi.conf(5)====<br /> <br /> pbi.conf is an ASCII text configuration file containing values that are used by the various '''pbi_*''' commands. Table 6.2.4.5 lists the supported variables.<br /> <br /> '''Table 6.2.4.5: pbi_conf Variables'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=20%|'''Switch'''}}<br /> {{Tbl-title|width=80%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_INDEXREFRESH'''}}<br /> {{Tbl-line|bg=ff|align=left|Number of hours. How often pbid refreshes the index/meta files from repos. Default is every 24 hours.}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROXYPASS'''}}<br /> {{Tbl-line|align=left|Password used to authenticate with proxy server.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROXYPORT'''}}<br /> {{Tbl-line|bg=ff|align=left|Proxy server port number.}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROXYTYPE'''}}<br /> {{Tbl-line|align=left|Can be HTTP or SOCKS5.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROXYURL'''}}<br /> {{Tbl-line|bg=ff|align=left|Proxy server IP address.}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROXYUSER'''}}<br /> {{Tbl-line|align=left|Username used to authenticate with proxy server.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBID_REFRESH'''}}<br /> {{Tbl-line|bg=ff|align=left|Wakeup time in seconds for pbid to run its checks.}}<br /> |-<br /> |}<br /> <br /> ==== pbi_create(1) ====<br /> <br /> The '''pbi_create''' command provides a way for packagers to manually specify a target directory to be compressed into a PBI file. The option '''-b''' can also be used to re-package an already installed PBI back to an archive. This command replaces the 8.x PBI Module Builder functionality. PBI creators are encouraged to send a tarball of the resulting PBI module to the [http://lists.pcbsd.org/mailman/listinfo/pbi-dev PBI-testing mailing list] so they can be added to the PC-BSD PBI repository and made available to other PC-BSD users.<br /> <br /> Table 6.2.4.6 summarizes the available options:<br /> <br /> '''Table 6.2.4.6: pbi_create Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-a author'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify the author for this PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''-b'''}} <br /> {{Tbl-line|align=left|Make a backup of an installed PBI. When using this option specify the target PBI name instead of [pbidir]}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-c confdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify the meta-data confdir to use. While not required for building a PBI, it is highly recommended. Without some configuration settings in the meta-data, icons and binary entry-points will not be created.}}<br /> |-<br /> {{Tbl-line|align=left|'''-d portsdir'''}}<br /> {{Tbl-line|align=left|Specify an alternative ports-dir, defaults to /usr/ports}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-i icon'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify a default icon for this PBI, relative to pbidir/}}<br /> |-<br /> {{Tbl-line|align=left|'''-n name'''}}<br /> {{Tbl-line|align=left|Specify a name for this PBI}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-o outdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Place the finished .pbi file into the specified directory. Defaults to $HOME/}}<br /> |-<br /> {{Tbl-line|align=left|'''-p port'''}}<br /> {{Tbl-line|align=left|Use the given port to get PBI name / version from}}<br /> |- <br /> {{Tbl-line|bg=ff|align=left|'''-r version'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify a version for this PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''-u weburl'''}}<br /> {{Tbl-line|align=left|Specify a website URL for the PBI}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--no-hash'''}}<br /> {{Tbl-line|bg=ff|align=left|Disable using the shared-hash dir which uses hard-links to share files between applications}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|Digitially sign the PBI file with the specified openssl private key file}}<br /> |-<br /> |}<br /> <br /> <br /> <br /> Creating a PBI with the '''pbi_create''' command is relatively simple. First, make sure you are &quot;su&quot; to root. Next you will need to run &quot;pbi_create -a &lt;author&gt; -n &lt;name&gt; -r &lt;version&gt; -w &lt;weburl&gt; &lt;target directory&gt;<br /> <br /> Inside the target directory you will need to have your binaries / scripts or other executable ready to run, along with any required dependencies. To indicate which files are going to be the runtime commands, you will need to create a file named &quot;'''external-links'''&quot; in your target directory, with an entry such as this:<br /> <br /> # Files to be Sym-Linked into the default LOCALBASE<br /> # One per-line, relative to %%PBI_APPDIR%% and LOCALBASE<br /> # Defaults to keeping any existing files in LOCALBASE<br /> # Use bin-files/ for binaries that need wrapper functionality<br /> <br /> # TARGET LINK IN LOCALBASE ACTION<br /> bin/myapp bin/myapp binary,nocrash<br /> <br /> This will instruct pbi_creator to make the wrapper scripts for the &quot;myapp&quot; binary, along with placing it in the users PATH at install time.<br /> <br /> It is also possible to include desktop icons / mime entries using the xdg-mime, xdg-desktop and xdg-menu directories. For more details about creating these files, take a look at the [[PBI_Module_Builder_Guide]]. In this case the xdg-mime/ and other directories would also go directly into the target directory of your application.<br /> <br /> ==== pbi_delete(1) ====<br /> <br /> Similar to FreeBSD's '''pkg_delete''', the '''pbi_delete''' command removes an installed PBI from the system. It also schedules cleaning for the shared library directory, which is performed by '''pbid'''. Table 6.2.4.7 summarizes its options:<br /> <br /> '''Table 6.2.4.7: pbi_delete Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-v'''}} <br /> {{Tbl-line|bg=ff|align=left|Enable verbose output}}<br /> |-<br /> {{Tbl-line|align=left|'''--clean-hdir'''}}<br /> {{Tbl-line|align=left|Perform a full cleaning of the shared-hash dir, removing any unused files. This should only need to be done after a system crash or failure in removing a PBI via normal methods.}}<br /> |-<br /> |}<br /> <br /> When removing a PBI, you must give its full name. The full name can be found in the output of '''pbi_info'''. The following example searches for the emacs PBI and removes it:<br /> <br /> '''pbi_info | grep ntop'''<br /> ntop-4.0.1_1-i386<br /> '''pbi_delete -v ntop-4.0.1_1-i386'''<br /> Running pre-removal script: /var/db/pbi/installed/ntop-4.0.1_1-i386/pre-remove.sh<br /> Removing: /usr/pbi/ntop-i386<br /> Removing: /var/db/pbi/installed/ntop-4.0.1_1-i386<br /> <br /> ==== pbi_deleterepo(1) ====<br /> <br /> The '''pbi_deleterepo''' command can be used to remove a registered repository from the system. It takes the repository's ID as the only command argument.<br /> <br /> ==== pbi_icon(1) ====<br /> <br /> 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 [http://en.wikipedia.org/wiki/Xdg XDG]-compliant to understand a PBI's icon and mime settings. Table 6.2.4.9 summarizes this command's options:<br /> <br /> '''Table 6.2.4.9: pbi_icon Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add-desktop'''}}<br /> {{Tbl-line|bg=ff|align=left|Installs any XDG compliant desktop icons, should be run as user.}}<br /> |-<br /> {{Tbl-line|align=left|'''add-menu'''}}<br /> {{Tbl-line|align=left|Installs any XDG compliant menu icons, should be run as root.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add-mime'''}}<br /> {{Tbl-line|bg=ff|align=left|Installs any XDG compliant mime information, should be run as root.}}<br /> |-<br /> {{Tbl-line|align=left|'''add-pathlnk'''}}<br /> {{Tbl-line|align=left|Installs any PATH links to ~/bin as user or to LOCALBASE as root.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''del-desktop'''}}<br /> {{Tbl-line|bg=ff|align=left|Removes any XDG compliant desktop icons, should be run as user.}}<br /> |-<br /> {{Tbl-line|align=left|'''del-menu'''}}<br /> {{Tbl-line|align=left|Removes any XDG compliant menu icons, should be run as root.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''del-mime'''}}<br /> {{Tbl-line|bg=ff|align=left|Removes any XDG compliant menu icons, should be run as root.}}<br /> |-<br /> {{Tbl-line|align=left|'''del-pathlnk'''}}<br /> {{Tbl-line|align=left|Removes any any PATH links to ~/bin as user or to LOCALBASE as root}}<br /> |-<br /> |}<br /> <br /> ==== pbi_indextool(1) ====<br /> <br /> The '''pbi_indextool''' command is useful for repository maintainers. It allows the adding/removing of PBI files available in a particular repository INDEX file without needing to hand-edit the file. Table 6.2.4.10 summarizes the available options:<br /> <br /> '''Table 6.2.4.10: pbi_indextool Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add'''}}<br /> {{Tbl-line|bg=ff|align=left|Adds a PBI to the target INDEX file}}<br /> |-<br /> {{Tbl-line|align=left|'''rem'''}}<br /> {{Tbl-line|align=left|Removes a PBI from the target INDEX file}}<br /> |-<br /> |}<br /> <br /> Run the command with the desired option to receive detailed usage.<br /> <br /> ==== pbi_info(1) ====<br /> <br /> Similar to FreeBSD's '''pkg_info''' command, the '''pbi_info''' command is used to determine which PBIs are currently installed. Table 6.2.4.11 summarizes the available options:<br /> <br /> '''Table 6.2.4.11: pbi_info Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-a'''}} <br /> {{Tbl-line|bg=ff|align=left|List all PBIs installed on the system, same as running pbi_info without an argument.}}<br /> |-<br /> {{Tbl-line|align=left|'''-i'''}}<br /> {{Tbl-line|align=left|List all available PBIs from any repo}} <br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-v'''}} <br /> {{Tbl-line|bg=ff|align=left|Enable verbose output}}<br /> |-<br /> |}<br /> <br /> ==== pbi_listrepo(1) ====<br /> <br /> The '''pbi_listrepo''' command manages installed repositories on a system. Table 6.2.4.12 summarizes this command's options:<br /> <br /> '''Table 6.2.4.12: pbi_listrepo Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--down'''}}<br /> {{Tbl-line|bg=ff|align=left|Move the targeted repoid down a single number in priority}}<br /> |-<br /> {{Tbl-line|align=left|'''-mirror URL'''}}<br /> {{Tbl-line|align=left|Change the specified repoid's mirror URL}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--up'''}}<br /> {{Tbl-line|bg=ff|align=left|Move the targeted repoid up a single number in priority}}<br /> |-<br /> |}<br /> <br /> Run the command without any options to list the IDs of the available repositories.<br /> <br /> ==== pbi_makepatch(1) ====<br /> <br /> The '''pbi_makepatch''' command is automatically used by '''pbi_autobuild''' to create small *.pbp (Push Button Patch) files. These files can be downloaded to a user's system and used to update a PBI's version without re-downloading the entire archive. This allows users to download only the incremental changes when a PBI is upgraded. The command can also be run manually by providing two PBI archives to compare and generate a patch file for.<br /> <br /> Table 6.2.4.13 summarizes the available options:<br /> <br /> '''Table 6.2.4.13: pbi_makepatch Options<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-o outdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Save the resulting .PBP file to the specified directory}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|Use the specified openssl key to digitally sign the patch file}}<br /> |-<br /> |}<br /> <br /> ==== pbi_makeport(1) ====<br /> <br /> The '''pbi_makeport''' command can be used by packagers to build a target FreeBSD port and convert it into a PBI file. Many options are provided to fine-tune the build process, and meta-data modules can also be specified to further improve the resulting PBI file. The first time this command is run, it will build a fresh chroot sandbox environment which can be used for clean-room building of the target port without affecting the host system. PBI creators are encouraged to send a tarball of the resulting PBI module to the [http://lists.pcbsd.org/mailman/listinfo/pbi-dev PBI-testing mailing list] so they can be added to the PC-BSD PBI repository and made available to other PC-BSD users.<br /> <br /> Starting in version '''0.9.7''' the pbi_makeport command has support for using [http://www.freshports.org/devel/ccache/ ccache] to speed up the compile process. If '''ccache''' is installed on the host system, and the CCACHE_DIR variable is set, the pbi_makeport command will automatically utilize it for the port compile phase. This can be disabled by setting NO_CCACHE=yes in /etc/pbi-make.conf on the host system, or as an optional make flag in a modules pbi.conf file. <br /> <br /> Table 6.2.4.14 summarizes the available options:<br /> <br /> '''Table 6.2.4.14: pbi_makeport Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-B'''}} <br /> {{Tbl-line|bg=ff|align=left|Build-only, after the port make process has finished, do not generate the PBI file. Generally used with -k to build a port before running pbi_create manually.}}<br /> |-<br /> {{Tbl-line|align=left|'''-c confdir'''}}<br /> {{Tbl-line|align=left|Specify the meta-data confdir to use. While not required for building a PBI, it is highly recommended. Without some configuration settings in the meta-data, icons and binary entry-points will not be created.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-d portsdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify an alternative ports-dir, defaults to /usr/ports}}<br /> |-<br /> {{Tbl-line|align=left|'''-k'''}} <br /> {{Tbl-line|align=left|Keep the build files after a success or failure compiling/building the PBI}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-o outdir'''}}<br /> {{Tbl-line|bg=ff|align=left|The directory to place the finished PBI file, defaults to user's $HOME directory}}<br /> |-<br /> {{Tbl-line|align=left|'''-p prefix'''}}<br /> {{Tbl-line|align=left|Manually provide a PREFIX, which determines the location where the PBI will end up being installed on the end-user's system.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--delbuild'''}}<br /> {{Tbl-line|bg=ff|align=left|Remove any existing build dirs before starting the build}}<br /> |-<br /> {{Tbl-line|align=left|'''--mkdebug'''}}<br /> {{Tbl-line|align=left|Will drop to a debugging shell should the port make fail}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--no-prune'''}}<br /> {{Tbl-line|bg=ff|align=left|Disable auto-pruning of non REQUIREDBY ports after the compile phase. By default any ports which are used solely for building and which are not required for program execution will be pruned.}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|Digitially sign the PBI file with the specified openssl private key file}}<br /> |-<br /> |}<br /> <br /> ==== pbi_makerepo(1) ====<br /> <br /> The '''pbi_makerepo''' command allows repository maintainers to create a single *.rpo file containing various information about the new repository. This .rpo file can then be installed on the target system with '''pbi_addrepo'''. Table 6.2.4.15 summarizes the available options.<br /> <br /> '''Table 6.2.4.15: pbi_makerepo Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--desc description'''}}<br /> {{Tbl-line|bg=ff|align=left|Required. Description of the repo to be shown in the repo list}}<br /> |-<br /> {{Tbl-line|align=left|'''--key keyfile'''}}<br /> {{Tbl-line|align=left|Required. OpenSSL public key used to verify the digital signature of PBIs installed from this repo}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--mirror URL'''}}<br /> {{Tbl-line|bg=ff|align=left|Required. The URL to download PBIs and updates from}}<br /> |-<br /> {{Tbl-line|align=left|'''--url URL'''}}<br /> {{Tbl-line|align=left|Required. The URL to use when downloading the master INDEX files of available PBIs}}<br /> |-<br /> |}<br /> <br /> ==== pbi_metatool(1) ====<br /> <br /> The '''pbi_metatool''' command provides a way for repository maintainers to modify the PBI meta-data in their repository in order to add or remove application categories or specified PBIs. This meta-data may contain information such as Name, Description, Icon, Keywords, License and more for the respective PBI file. Table 6.2.4.16 summarizes the available options:<br /> <br /> '''Table 6.2.4.16: pbi_metatool Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add'''}}<br /> {{Tbl-line|bg=ff|align=left|Adds a category or application to the target metafile}}<br /> |-<br /> {{Tbl-line|align=left|'''rem'''}}<br /> {{Tbl-line|align=left|Remove a category or application to the target metafile}}<br /> |-<br /> |}<br /> <br /> Run the command with the desired option to receive detailed usage.<br /> <br /> ==== pbi_patch(1) ====<br /> <br /> The '''pbi_patch''' command is used to update an installed PBI to a different version using the small diff Push Button Patch *.pbp file. This allows the user to perform an incremental upgrade of an installed PBI. The available options are summarized in Table 6.2.4.17.<br /> <br /> '''Table 6.2.4.17: pbi_patch Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-e'''}} <br /> {{Tbl-line|bg=ff|align=left|Extract only, do not install. Will extract the archive to ~/&lt;pbidirname&gt; unless the -o option is used.}}<br /> |-<br /> {{Tbl-line|align=left|'''-g'''}} <br /> {{Tbl-line|align=left|Extract image data from header, commonly used for GUI installations}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-i'''}} <br /> {{Tbl-line|bg=ff|align=left|Display information about this PBI file}}<br /> |-<br /> {{Tbl-line|align=left|'''-o outdir'''}}<br /> {{Tbl-line|align=left|Specify the directory to use when only extracting the PBI with -e.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--checkscript'''}}<br /> {{Tbl-line|bg=ff|align=left|Display any custom scripts used in the installation / removal of this PBI file. Recommended that these be checked if the PBI file is suspect in any way.}}<br /> |-<br /> {{Tbl-line|align=left|'''--no-checksig'''}}<br /> {{Tbl-line|align=left|Skip the openssl signature verification of the PBI data}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--no-hash'''}}<br /> {{Tbl-line|bg=ff|align=left|Disable using the shared-hash dir, which uses hard-links to share files between applications}}<br /> |-<br /> |}<br /> <br /> ==== pbi_update(1) ====<br /> <br /> The '''pbi_update''' command is used to display information about which PBIs have available updates from their repository and to perform the updates. Table 6.2.4.18 summarizes the available options.<br /> <br /> '''Table 6.2.4.18: pbi_update Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-c'''}} <br /> {{Tbl-line|bg=ff|align=left|Check-only the specified PBI for available updates.}}<br /> |-<br /> {{Tbl-line|align=left|'''--check-all'''}}<br /> {{Tbl-line|align=left|Run a full check of all installed PBIs and display list of available updates.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-disable-auto'''}}<br /> {{Tbl-line|bg=ff|align=left|Disable auto-updating of the target PBI.}}<br /> |-<br /> {{Tbl-line|align=left|'''--enable-auto'''}}<br /> {{Tbl-line|align=left|Enable auto-updating of the target PBI.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--update-all'''}}<br /> {{Tbl-line|bg=ff|align=left|Update all installed PBIs to the latest versions available.}}<br /> |-<br /> |}<br /> <br /> ====pbi_update_hashdir(1)====<br /> <br /> The '''pbi_update_hashdir''' command is used by the '''pbid''' daemon to merge the contents of a PBI into the hashdir.<br /> <br /> ==== pbid(8) ====<br /> <br /> The '''pbid''' command runs a small daemon which performs maintenance of installed PBIs, merges files into the shared hashdir, fetches the repository INDEX and meta files, and makes the adding and removing of PBIs much faster. It will automatically be started from the /usr/local/etc/rc.d/pbid startup script if pbid_enable=&quot;YES&quot; is in the /etc/rc.conf file.<br /> <br /> This utility supports the option summarized in table 6.2.4.19:<br /> <br /> '''Table 6.2.4.19: pbid Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-v'''}}<br /> {{Tbl-line|bg=ff|align=left|Enable verbose output when the daemon starts}}<br /> |-<br /> |}<br /> <br /> This command logs its output to /var/log/pbid.log. Check this log for errors should you experience any problems with PBI maintenance.</div>

Krismoore http://wiki.pcbsd.org/index.php/Java,_Flash,_and_Fonts 2011-12-05T16:35:26Z

<p>Krismoore: /* Java */</p> <hr /> <div>{{NavHeader|back=Common Tasks|forward=Multimedia}}<br /> <br /> ==Java==<br /> <br /> AppCafe™ also allows you to install the Open Java Development Kit (OpenJDK, used by Java developers) and the Java Runtime Environment (JRE, used by java applications). Simply search for &quot;java&quot; within AppCafe™ if you wish to install these applications. The OpenJDK PBI includes the IcedTea browser plugin, which will work on FireFox, Chrome and Opera without any additional setup.<br /> <br /> ==Flash==<br /> PC-BSD installs and configures the Adobe Flash player (version 10) plugin for you. This means that flash should &quot;just work&quot; when browsing the web. You'll find several web browsers in the Web Browsers category of [[Using AppCafe|AppCafe™]], including Firefox, Opera, and Chromium.<br /> <br /> If flash does not seem to be working, running the following command as your regular user account should fix the problem: <br /> <br /> '''flashpluginctl on'''<br /> <br /> ==Fonts==<br /> <br /> ===Installing Microsoft True Type Fonts===<br /> <br /> If you would like to install Microsoft True Type fonts, click on the AppCafe™ icon on your Desktop. Search for &quot;fonts&quot; in the search bar and you should see a result similar to Figure 8.1a:<br /> <br /> '''Figure 8.1a: Using AppCafe™ to Install MS TrueType Fonts'''<br /> <br /> [[Image:Fonts1a.png]]<br /> <br /> Click the download button to install the fonts PBI. It will automatically setup your system to use these fonts.<br /> <br /> ===Installing Fonts in KDE===<br /> <br /> If you already have a collection of fonts that you have downloaded or purchased, you can configure your PC-BSD system to use these as well using the Font Installer utility.<br /> <br /> Click the KDE menu → System Settings → Font Installer to start this utility. In Figure 8.1b, &quot;All Fonts&quot; is currently selected under the Group column, showing all of the fonts installed on this system.<br /> <br /> '''Figure i.1b: Using Font Installer to Install Fonts'''<br /> <br /> [[Image:Fonts1.png]]<br /> <br /> To install your fonts, highlight &quot;Personal Fonts&quot; under the Group column, then click the +Add button. This will allow you to browse to the font you wish to add. You can add multiple fonts in the same directory by holding down the Ctrl key while making your selection. Click the Open button, which will install the font for you. When it is finished, you will see the message in Figure 8.1c:<br /> <br /> '''Figure 8.1c: Fonts Have Been Successfully Installed'''<br /> <br /> [[Image:Fonts3.png]]<br /> <br /> Your newly installed font(s) should now show up in the &quot;Personal Fonts&quot; section in the Groups column and be available to the applications you use.</div>

Krismoore http://wiki.pcbsd.org/index.php/PBI_Manager 2011-12-02T21:51:55Z

<p>Krismoore: /* pbi_create(1) */</p> <hr /> <div>{{NavHeader|back=Using AppCafe™|forward=Update Manager}}<br /> PC-BSD 9.0 introduced PBI Manager, a suite of command line utilities for managing PBIs. PBI Manager's command-line tools can be used to install, remove, create and manage PBIs. It is also available for [[#Installing_PBI_Manager|FreeBSD systems]]. The PBI Manager is released under the [http://www.freebsd.org/copyright/freebsd-license.html BSD license].<br /> <br /> <br /> ===New Features===<br /> <br /> The new PBI format introduces the following features:<br /> <br /> * '''Upgrade deltas:''' since PBIs are self-contained, installation files tend to be large. In the previous implementation, updating a PBI required the re-downloading of the entire installation archive. For larger applications this could be a time-consuming process, especially over low bandwidth connections. The new PBI specification performs updates using binary diff patches known as PBP (Push Button Patch) files. PBPs are a fraction of the PBI's size; in some cases less than 5% of the original PBI archive. An upgrade automatically checks for for the presence of a PBP file and attempts to use it, only falling back to the original archive should the process fail.<br /> <br /> * '''Library and file sharing:''' in the previous implementation of the PBI format it was common that identical files existed between various applications. These duplicates, while necessary to provide self-contained functionality, wasted both disk and runtime memory. This waste of space has been greatly reduced through the use of a hash-dir directory where libraries and common files are shared through a system of hard links. When an identical file is found in a PBI, the original will be removed and a hard-link stored in the hash-dir. After a PBI has been removed, any unneeded files left in the hash-dir are cleaned up by the pbid(8) daemon which monitors and maintains the integrity of the shared files.<br /> <br /> * '''Repository management:''' allows administrators and PBI builders to create and manage their own repositories of PBIs. This repository system provides a number of tools for PBI distribution, release management, and repository browsing. <br /> <br /> * '''Digitally signed PBIs:''' each repository includes an openssl public key file which is installed on the end user's system. Each PBI includes several signatures for the content archive and installation and removal scripts. During the PBI installation process, these signatures are checked to confirm that the archive has not been tampered with during transit. This key file is also used to associate a particular PBI with a parent repository for upgrade purposes, since it is possible that multiple repositories will have the same applications.<br /> <br /> * '''Root password not required:''' most applications can be installed and upgraded by user (non-root) accounts. This allows enhanced security in office or home situations, where users can now add/remove desktop applications without needing access to the root account. PBIs that impact on the security of the system (e.g. installing a web server) will require root access.<br /> <br /> * '''Implementation:''' the previous PBI design was developed in QT/KDE C++, making it inappropriate for use at the command line. The new format is implemented 100% in shell and is comprised of command-line utilities, each with an associated man page. These utilities are discussed in more detail in the rest of this section.<br /> <br /> '''Additional Resources:'''<br /> <br /> [http://www.pcbsd.org/~kris/pbi9-slides.pdf The PBI Format Re-implemented for Free/PC-BSD (conference slides)]<br /> <br /> [http://www.pcbsd.org/~kris/asiabsdcon2011-pbi9.pdf The PBI Format Re-implemented for Free/PC-BSD (formal paper)]<br /> <br /> [[PBI9 Format|The PBI Format for 9.0 and Beyond]]<br /> <br /> === Release History ===<br /> * '''0.9.6''' (11-07-11)<br /> - Fix some bugs doing cleanup of stagedir / build directories<br /> <br /> - Properly kill fetch process when canceling a download<br /> <br /> - Improve buildworld on FreeBSD to use /usr/src if it already has source<br /> <br /> - Fix some random warnings when building via sudo<br /> <br /> <br /> * '''0.9.5''' (11-03-11)<br /> - Add sizes of PBIs to the meta index files<br /> <br /> - Fix bug adding default icon to PBIs when none is specified<br /> <br /> - Fix handling of PBI_PROGREVISION<br /> <br /> - Make sure we unmount nullfs mounts completely<br /> <br /> <br /> * '''0.9.4''' (10-19-11)<br /> - Fix issue using system-fonts in PBIs<br /> <br /> - Fix issue removing files which have been set r--<br /> <br /> - Slow down fetch process to fix issues with fetch protocol errors<br /> <br /> - Fix bug coping linux libraries into final PBI file<br /> <br /> - Allow user settings in external-links to overwrite auto-detected values<br /> <br /> - Fix bug running &quot;stat&quot; on files with spaces in name<br /> <br /> - Validate the build checksum before doing patching<br /> <br /> - Speed up builds with optional --tmpfs flags<br /> <br /> - Add priority system to building modules<br /> <br /> - Fix issues setting proxy support from pbi.conf / pcbsd.conf files<br /> <br /> - Validate repo URL's when creating .rpo file<br /> <br /> <br /> * '''0.9.3''' (07-18-11)<br /> - Unset variables between auto-builds<br /> <br /> - Fixed some warnings with 'cut' when parsing i18n strings<br /> <br /> - When doing auto-builds, run through alphabetically<br /> <br /> - Increase check frequency when first trying to download index's<br /> <br /> - Speed up the hashdir merging<br /> <br /> - Show repo MD5 with listings<br /> <br /> - If no index files, do not fail on listing, just show empty repo<br /> <br /> <br /> * '''0.9.2''' (05-23-11)<br /> - Fixed usage errors with &quot;tr&quot;<br /> <br /> - Syntax fixes when trying to install app with no meta-data<br /> <br /> - Fixed some bugs with binary patching<br /> <br /> - Fixed auto-builder using the PBI_BUILDKEY in modules pbi.conf file<br /> <br /> - When building ports, don't export PREFIX since it confuses some linux ports<br /> <br /> - Perform check if user is root, if PBI is flagged root-only<br /> <br /> - Auto-builder now checks if port is compatible with arch type of system<br /> <br /> <br /> * '''0.9.1''' - Initial public release (05/3/11)<br /> <br /> === What is the PBI format? ===<br /> <br /> The idea behind the PBI format is that one of the things holding back mainstream adoption of open source desktops is the package management format. With almost all open source desktops, software is simply treated as part of the operating system. Thus, when performing an update of some seemingly trivial application, you run the risk of potentially needing to upgrade other packages which could break other critical parts of your desktop. <br /> <br /> While package management systems have gotten better at resolving these dependency issues, trying to fix conflicts and prevent breakage before it occurs, they still don't address the underlying problem: every software package is a part of the system, and pulling on any one thread has the potential of causing a break somewhere farther down the line.<br /> <br /> The PBI format tries to correct this underlying flaw. Rather than making every application a part of the base system, PBIs are self-contained, including their own dependent library tree and related data. As a result, when you install a PBI there are no dependency issues to resolve, and applications can be added or removed freely, without fear of causing breakage to the desktop or any other installed software.<br /> <br /> === Installing PBI Manager ===<br /> <br /> If you are running PC-BSD 9 or higher, then the PBI Manager is already installed, and you can use it via the command-line, or a front-end such as the AppCafe™. <br /> <br /> FreeBSD users can install it from the [http://www.freshports.org/ports-mgmt/pbi-manager ports tree]. <br /> <br /> <br /> Users interested in installing the development version from our [http://trac.pcbsd.org/brower/pcbsd/current/src-sh/pbi-manager/ SVN repository] can do so with the following commands:<br /> <br /> '''svn co &lt;nowiki&gt;svn://svn.pcbsd.org/pcbsd/current/src-sh/pbi-manager&lt;/nowiki&gt;'''<br /> '''cd pbi-manager'''<br /> '''make install'''<br /> <br /> '''NOTE: The development version may be unstable / buggy, use at your own risk'''<br /> <br /> === Getting PBI Files ===<br /> <br /> The PC-BSD project has begun building PBIs which work with PBI Manager for FreeBSD/PC-BSD 9. A list of approved &amp; available PBIs can be viewed with '''pbi_info -i''' or '''pbi_browser''', and then installed with '''pbi_add -r &lt;pbiname&gt;'''. Until 9.0 is released the number of available PBIs will remain small but may be downloaded directly from the build server:<br /> <br /> [http://pbibuild.pcbsd.org/index.php?ver=9 9.x i386 PBIs]<br /> <br /> [http://pbibuild64.pcbsd.org/index.php?ver=9 9.x amd64 PBIs]<br /> <br /> '''NOTE:''' PBI files previously created for PC-BSD 7.x/8.x will NOT work with PBI Manager, these are specific to PC-BSD 7/8.<br /> <br /> ===Underlying File / Directory Structure===<br /> <br /> <br /> The underlying files / directories used by PBI Manager are as follows:<br /> <br /> '''/usr/local/etc/pbi.conf''': location of the PBI Manager configuration file <br /> <br /> '''/usr/pbi/''': where PBIs are installed on the system<br /> <br /> '''/var/db/pbi/''': contains data files related to installed PBIs and repositories <br /> <br /> '''/usr/local/sbin/pbi_*''': location of the PBI Manager commands<br /> <br /> '''/usr/local/share/pbi-manager/module-examples/convertoldmod.sh''': script which can be used to convert an existing 7.x/8.x PBI module to the new 9.x format.<br /> <br /> === Feedback / Reporting Problems ===<br /> <br /> Feedback, problem reports, and general discussion are welcome on the [http://lists.pcbsd.org/mailman/listinfo/pbi-dev PBI Developers Mailing list]. <br /> <br /> === Command Reference ===<br /> <br /> The following is a list of commands installed by the pbi-manager, along with a small synopsis of each. For more details, please refer to the command's man page.<br /> <br /> ==== pbi_add(1) ====<br /> <br /> Similar to FreeBSD's '''pkg_add''', the '''pbi_add''' command is used for adding/installing PBIs on a system, either from a local file or remotely from a repository. This utility supports the options listed in Table 6.2.4.1: <br /> <br /> '''Table 6.2.4.1: pbi_add Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> &lt;!-- row 1 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-e'''}}<br /> {{Tbl-line|bg=ff|align=left|Extract only, do not install. Will extract the archive to ~/&lt;pbidirname&gt; unless the -o option is used}}<br /> |-<br /> &lt;!-- row 2 --&gt;<br /> {{Tbl-line|align=left|'''-f'''}} <br /> {{Tbl-line|align=left|Force installation, overwriting an already installed copy of the application}}<br /> |- <br /> &lt;!-- row 3 --&gt; <br /> {{Tbl-line|bg=ff|align=left|'''-g'''}} <br /> {{Tbl-line|bg=ff|align=left|Get and show path to icon/images for GUI installations}}<br /> |-<br /> &lt;!-- row 4 --&gt; <br /> {{Tbl-line|bg=ee|align=left|'''-i'''}} <br /> {{Tbl-line|bg=ee|align=left|Display information about specified PBI}}<br /> |-<br /> &lt;!-- row 5 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-l'''}} <br /> {{Tbl-line|bg=ff|align=left|Display LICENSE for specified PBI}}<br /> |-<br /> &lt;!-- row 6 --&gt; <br /> {{Tbl-line|align=left|'''-o outdir'''}} <br /> {{Tbl-line|align=left|Specify the directory to use when extracting the PBI with -e.}}<br /> |-<br /> &lt;!-- row 7 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-r'''}} <br /> {{Tbl-line|bg=ff|align=left|Remote fetch installation file from update server. The system architecture and version will be automatically determined to fetch the correct file.}}<br /> |-<br /> &lt;!-- row 8 --&gt;<br /> {{Tbl-line|align=left|'''-v'''}} <br /> {{Tbl-line|align=left|Enable verbose output}}<br /> |-<br /> &lt;!-- row 9 --&gt; <br /> {{Tbl-line|bg=ff|align=left|'''--checkscript'''}} <br /> {{Tbl-line|bg=ff|align=left|Display any custom scripts used in the installation/removal of this PBI file.}} <br /> |-<br /> &lt;!-- row 10 --&gt; <br /> {{Tbl-line|align=left|'''--licagree'''}} <br /> {{Tbl-line|align=left|Agree to LICENSE terms and conditions. Viewing the license can be done with -l flag}}<br /> |-<br /> &lt;!-- row 11 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''--no-checksig'''}} <br /> {{Tbl-line|bg=ff|align=left|Skip the openssl signature verification of the PBI data}}<br /> |-<br /> &lt;!-- row 12 --&gt;<br /> {{Tbl-line|align=left|'''--no-checksum'''}} <br /> {{Tbl-line|align=left|Skip the checksum verification of the archive data}}<br /> |-<br /> &lt;!-- row 13 --&gt; <br /> {{Tbl-line|bg=ff|align=left|'''--no-hash'''}} <br /> {{Tbl-line|bg=ff|align=left|Disable using shared hash dir which uses hard-links to share files between applications}} <br /> |-<br /> &lt;!-- row 14 --&gt;<br /> {{Tbl-line|align=left|'''--repo repoid'''}}<br /> {{Tbl-line|align=left|Specify which repository to use}}<br /> |-<br /> &lt;!-- row 15 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''--rArch arch'''}}<br /> {{Tbl-line|bg=ff|align=left|Manually specify the PBI architecture type of i386 or amd64}}<br /> |-<br /> &lt;!-- row 16 --&gt;<br /> {{Tbl-line|align=left|'''--rVer version'''}}<br /> {{Tbl-line|align=left|Specify which version of the PBI to install}}<br /> |-<br /> |}<br /> <br /> For security reasons, it is recommend that users first use the -e and --checkscript options to view archive contents and installation scripts prior to installing a PBI file.<br /> <br /> To install a PBI, use: '''pbi_add -r PBINAME'''. The following example will install the alpine PBI:<br /> <br /> '''pbi_add -r alpine'''<br /> Downloading ftp://ftp.pcbsd.org/pub/mirror/PBI/mail/alpine/9/x32/alpine-2.00_3-i386.pbi<br /> /usr/pbi/.alpine-2.00_3-i386.pbi.42391 100% of 11 MB 295 kBps 00m00s<br /> Verifying Checksum...OK<br /> Extracting to: /usr/pbi/alpine-i386<br /> Installed: Alpine-2.00_3<br /> <br /> ==== pbi_addrepo(1) ====<br /> <br /> The '''pbi_addrepo''' command is used to register a new PBI repository on a system. If the '''pbid''' daemon is running, the repository's index and meta files will be automatically fetched and made ready for browsing. The command has one argument, the name of the repository file. Repository files have a .rpo extension and are created with the '''pbi_makerepo''' command.<br /> <br /> ==== pbi_autobuild(1) ====<br /> <br /> The '''pbi_autobuild''' command is used on the PBI build system to build any out-of-date or new packages. The utility is also of interest to PBI testers and system administrators who create and maintain their own internal repository of PBIs. It can traverse the FreeBSD ports and Meta-data trees, building missing PBI files or PBIs in which the target port version has been updated. Table 6.2.4.3 summarizes this command's options:<br /> <br /> '''Table 6.2.4.3: pbi_autobuild Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> &lt;!-- row 1 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-c confdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify the directory containing the PBI configuration modules data to traverse. Any found pbi.conf files will be parsed, and if PBI_MAKEPORT is set, the target port will be used for the build. If PBI_MAKEPORT is unset, the auto-build will attempt to match the module to a FreeBSD port based upon the dirname of pbi.conf}}<br /> |-<br /> {{Tbl-line|align=left|'''-d portsdir'''}}<br /> {{Tbl-line|align=left|Specify an alternative ports-dir; defaults to /usr/ports}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-h script'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify a helper script to call after building a PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''-o outdir'''}}<br /> {{Tbl-line|align=left|The directory to place the finished PBI files. Also used to determine which apps are in need of a rebuild if the associated FreeBSD port has been updated.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--genpatch'''}}<br /> {{Tbl-line|bg=ff|align=left|When building a new PBI, check for archived copies, and generate smaller patch updates to the new version (*.pbp files)}}<br /> |-<br /> {{Tbl-line|align=left|'''--keep num'''}}<br /> {{Tbl-line|align=left|When building new PBIs, keep &lt;num&gt; copies of past versions of working PBI in &lt;outdir&gt;/archived/ folder. These archived copies can be used with the --genpatch command to generate update patch files.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--prune'''}}<br /> {{Tbl-line|bg=ff|align=left|Remove any PBIs which no longer have an associated module in confdir}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|Digitially sign the PBI file with the specified openssl private key file}} <br /> |-<br /> |}<br /> <br /> ==== pbi_browser(1) ====<br /> <br /> The '''pbi_browser''' command provides a CLI front-end to browsing a repository's available PBIs. Options for viewing categories and searching by keyword are available, and once the desired PBI is located, it will show the '''pbi_add''' command which can be used to install the application. Table 6.2.4.4 summarizes the available options.<br /> <br /> '''Table 6.2.4.4: pbi_browser Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-c category'''}}<br /> {{Tbl-line|bg=ff|align=left|Displays a list of PBIs in the specified category}}<br /> |-<br /> {{Tbl-line|align=left|'''-s search'''}}<br /> {{Tbl-line|align=left|Search for PBIs containing the specified string in the name, description, or keywords}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--listcats'''}}<br /> {{Tbl-line|bg=ff|align=left|List the available categories}}<br /> |-<br /> {{Tbl-line|align=left|'''--viewall'''}}<br /> {{Tbl-line|align=left|List all available PBIs}}<br /> |-<br /> |}<br /> <br /> ====pbi.conf(5)====<br /> <br /> pbi.conf is an ASCII text configuration file containing values that are used by the various '''pbi_*''' commands. Table 6.2.4.5 lists the supported variables.<br /> <br /> '''Table 6.2.4.5: pbi_conf Variables'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=20%|'''Switch'''}}<br /> {{Tbl-title|width=80%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_INDEXREFRESH'''}}<br /> {{Tbl-line|bg=ff|align=left|Number of hours. How often pbid refreshes the index/meta files from repos. Default is every 24 hours.}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROXYPASS'''}}<br /> {{Tbl-line|align=left|Password used to authenticate with proxy server.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROXYPORT'''}}<br /> {{Tbl-line|bg=ff|align=left|Proxy server port number.}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROXYTYPE'''}}<br /> {{Tbl-line|align=left|Can be HTTP or SOCKS5.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROXYURL'''}}<br /> {{Tbl-line|bg=ff|align=left|Proxy server IP address.}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROXYUSER'''}}<br /> {{Tbl-line|align=left|Username used to authenticate with proxy server.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBID_REFRESH'''}}<br /> {{Tbl-line|bg=ff|align=left|Wakeup time in seconds for pbid to run its checks.}}<br /> |-<br /> |}<br /> <br /> ==== pbi_create(1) ====<br /> <br /> The '''pbi_create''' command provides a way for packagers to manually specify a target directory to be compressed into a PBI file. The option '''-b''' can also be used to re-package an already installed PBI back to an archive. This command replaces the 8.x PBI Module Builder functionality. PBI creators are encouraged to send a tarball of the resulting PBI module to the [http://lists.pcbsd.org/mailman/listinfo/pbi-dev PBI-testing mailing list] so they can be added to the PC-BSD PBI repository and made available to other PC-BSD users.<br /> <br /> Table 6.2.4.6 summarizes the available options:<br /> <br /> '''Table 6.2.4.6: pbi_create Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-a author'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify the author for this PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''-b'''}} <br /> {{Tbl-line|align=left|Make a backup of an installed PBI. When using this option specify the target PBI name instead of [pbidir]}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-c confdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify the meta-data confdir to use. While not required for building a PBI, it is highly recommended. Without some configuration settings in the meta-data, icons and binary entry-points will not be created.}}<br /> |-<br /> {{Tbl-line|align=left|'''-d portsdir'''}}<br /> {{Tbl-line|align=left|Specify an alternative ports-dir, defaults to /usr/ports}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-i icon'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify a default icon for this PBI, relative to pbidir/}}<br /> |-<br /> {{Tbl-line|align=left|'''-n name'''}}<br /> {{Tbl-line|align=left|Specify a name for this PBI}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-o outdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Place the finished .pbi file into the specified directory. Defaults to $HOME/}}<br /> |-<br /> {{Tbl-line|align=left|'''-p port'''}}<br /> {{Tbl-line|align=left|Use the given port to get PBI name / version from}}<br /> |- <br /> {{Tbl-line|bg=ff|align=left|'''-r version'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify a version for this PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''-u weburl'''}}<br /> {{Tbl-line|align=left|Specify a website URL for the PBI}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--no-hash'''}}<br /> {{Tbl-line|bg=ff|align=left|Disable using the shared-hash dir which uses hard-links to share files between applications}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|Digitially sign the PBI file with the specified openssl private key file}}<br /> |-<br /> |}<br /> <br /> <br /> <br /> Creating a PBI with the '''pbi_create''' command is relatively simple. First, make sure you are &quot;su&quot; to root. Next you will need to run &quot;pbi_create -a &lt;author&gt; -n &lt;name&gt; -r &lt;version&gt; -w &lt;weburl&gt; &lt;target directory&gt;<br /> <br /> Inside the target directory you will need to have your binaries / scripts or other executable ready to run, along with any required dependencies. To indicate which files are going to be the runtime commands, you will need to create a file named &quot;'''external-links'''&quot; in your target directory, with an entry such as this:<br /> <br /> # Files to be Sym-Linked into the default LOCALBASE<br /> # One per-line, relative to %%PBI_APPDIR%% and LOCALBASE<br /> # Defaults to keeping any existing files in LOCALBASE<br /> # Use bin-files/ for binaries that need wrapper functionality<br /> <br /> # TARGET LINK IN LOCALBASE ACTION<br /> bin/myapp bin/myapp binary,nocrash<br /> <br /> This will instruct pbi_creator to make the wrapper scripts for the &quot;myapp&quot; binary, along with placing it in the users PATH at install time.<br /> <br /> It is also possible to include desktop icons / mime entries using the xdg-mime, xdg-desktop and xdg-menu directories. For more details about creating these files, take a look at the [[PBI_Module_Builder_Guide]]. In this case the xdg-mime/ and other directories would also go directly into the target directory of your application.<br /> <br /> ==== pbi_delete(1) ====<br /> <br /> Similar to FreeBSD's '''pkg_delete''', the '''pbi_delete''' command removes an installed PBI from the system. It also schedules cleaning for the shared library directory, which is performed by '''pbid'''. Table 6.2.4.7 summarizes its options:<br /> <br /> '''Table 6.2.4.7: pbi_delete Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-v'''}} <br /> {{Tbl-line|bg=ff|align=left|Enable verbose output}}<br /> |-<br /> {{Tbl-line|align=left|'''--clean-hdir'''}}<br /> {{Tbl-line|align=left|Perform a full cleaning of the shared-hash dir, removing any unused files. This should only need to be done after a system crash or failure in removing a PBI via normal methods.}}<br /> |-<br /> |}<br /> <br /> When removing a PBI, you must give its full name. The full name can be found in the output of '''pbi_info'''. The following example searches for the emacs PBI and removes it:<br /> <br /> '''pbi_info | grep ntop'''<br /> ntop-4.0.1_1-i386<br /> '''pbi_delete -v ntop-4.0.1_1-i386'''<br /> Running pre-removal script: /var/db/pbi/installed/ntop-4.0.1_1-i386/pre-remove.sh<br /> Removing: /usr/pbi/ntop-i386<br /> Removing: /var/db/pbi/installed/ntop-4.0.1_1-i386<br /> <br /> ==== pbi_deleterepo(1) ====<br /> <br /> The '''pbi_deleterepo''' command can be used to remove a registered repository from the system. It takes the repository's ID as the only command argument.<br /> <br /> ==== pbi_icon(1) ====<br /> <br /> 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 [http://en.wikipedia.org/wiki/Xdg XDG]-compliant to understand a PBI's icon and mime settings. Table 6.2.4.9 summarizes this command's options:<br /> <br /> '''Table 6.2.4.9: pbi_icon Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add-desktop'''}}<br /> {{Tbl-line|bg=ff|align=left|Installs any XDG compliant desktop icons, should be run as user.}}<br /> |-<br /> {{Tbl-line|align=left|'''add-menu'''}}<br /> {{Tbl-line|align=left|Installs any XDG compliant menu icons, should be run as root.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add-mime'''}}<br /> {{Tbl-line|bg=ff|align=left|Installs any XDG compliant mime information, should be run as root.}}<br /> |-<br /> {{Tbl-line|align=left|'''add-pathlnk'''}}<br /> {{Tbl-line|align=left|Installs any PATH links to ~/bin as user or to LOCALBASE as root.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''del-desktop'''}}<br /> {{Tbl-line|bg=ff|align=left|Removes any XDG compliant desktop icons, should be run as user.}}<br /> |-<br /> {{Tbl-line|align=left|'''del-menu'''}}<br /> {{Tbl-line|align=left|Removes any XDG compliant menu icons, should be run as root.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''del-mime'''}}<br /> {{Tbl-line|bg=ff|align=left|Removes any XDG compliant menu icons, should be run as root.}}<br /> |-<br /> {{Tbl-line|align=left|'''del-pathlnk'''}}<br /> {{Tbl-line|align=left|Removes any any PATH links to ~/bin as user or to LOCALBASE as root}}<br /> |-<br /> |}<br /> <br /> ==== pbi_indextool(1) ====<br /> <br /> The '''pbi_indextool''' command is useful for repository maintainers. It allows the adding/removing of PBI files available in a particular repository INDEX file without needing to hand-edit the file. Table 6.2.4.10 summarizes the available options:<br /> <br /> '''Table 6.2.4.10: pbi_indextool Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add'''}}<br /> {{Tbl-line|bg=ff|align=left|Adds a PBI to the target INDEX file}}<br /> |-<br /> {{Tbl-line|align=left|'''rem'''}}<br /> {{Tbl-line|align=left|Removes a PBI from the target INDEX file}}<br /> |-<br /> |}<br /> <br /> Run the command with the desired option to receive detailed usage.<br /> <br /> ==== pbi_info(1) ====<br /> <br /> Similar to FreeBSD's '''pkg_info''' command, the '''pbi_info''' command is used to determine which PBIs are currently installed. Table 6.2.4.11 summarizes the available options:<br /> <br /> '''Table 6.2.4.11: pbi_info Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-a'''}} <br /> {{Tbl-line|bg=ff|align=left|List all PBIs installed on the system, same as running pbi_info without an argument.}}<br /> |-<br /> {{Tbl-line|align=left|'''-i'''}}<br /> {{Tbl-line|align=left|List all available PBIs from any repo}} <br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-v'''}} <br /> {{Tbl-line|bg=ff|align=left|Enable verbose output}}<br /> |-<br /> |}<br /> <br /> ==== pbi_listrepo(1) ====<br /> <br /> The '''pbi_listrepo''' command manages installed repositories on a system. Table 6.2.4.12 summarizes this command's options:<br /> <br /> '''Table 6.2.4.12: pbi_listrepo Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--down'''}}<br /> {{Tbl-line|bg=ff|align=left|Move the targeted repoid down a single number in priority}}<br /> |-<br /> {{Tbl-line|align=left|'''-mirror URL'''}}<br /> {{Tbl-line|align=left|Change the specified repoid's mirror URL}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--up'''}}<br /> {{Tbl-line|bg=ff|align=left|Move the targeted repoid up a single number in priority}}<br /> |-<br /> |}<br /> <br /> Run the command without any options to list the IDs of the available repositories.<br /> <br /> ==== pbi_makepatch(1) ====<br /> <br /> The '''pbi_makepatch''' command is automatically used by '''pbi_autobuild''' to create small *.pbp (Push Button Patch) files. These files can be downloaded to a user's system and used to update a PBI's version without re-downloading the entire archive. This allows users to download only the incremental changes when a PBI is upgraded. The command can also be run manually by providing two PBI archives to compare and generate a patch file for.<br /> <br /> Table 6.2.4.13 summarizes the available options:<br /> <br /> '''Table 6.2.4.13: pbi_makepatch Options<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-o outdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Save the resulting .PBP file to the specified directory}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|Use the specified openssl key to digitally sign the patch file}}<br /> |-<br /> |}<br /> <br /> ==== pbi_makeport(1) ====<br /> <br /> The '''pbi_makeport''' command can be used by packagers to build a target FreeBSD port and convert it into a PBI file. Many options are provided to fine-tune the build process, and meta-data modules can also be specified to further improve the resulting PBI file. The first time this command is run, it will build a fresh chroot sandbox environment which can be used for clean-room building of the target port without affecting the host system. PBI creators are encouraged to send a tarball of the resulting PBI module to the [http://lists.pcbsd.org/mailman/listinfo/pbi-dev PBI-testing mailing list] so they can be added to the PC-BSD PBI repository and made available to other PC-BSD users.<br /> <br /> Starting in version '''0.9.7''' the pbi_makeport command has support for using [http://www.freshports.org/devel/ccache/ ccache] to speed up the compile process. If '''ccache''' is installed on the host system, and the CCACHE_DIR variable is set, the pbi_makeport command will automatically utilize it for the port compile phase. This can be disabled by setting NO_CCACHE=yes in /etc/pbi-make.conf on the host system, or as an optional make flag in a modules pbi.conf file. <br /> <br /> Table 6.2.4.14 summarizes the available options:<br /> <br /> '''Table 6.2.4.14: pbi_makeport Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-B'''}} <br /> {{Tbl-line|bg=ff|align=left|Build-only, after the port make process has finished, do not generate the PBI file. Generally used with -k to build a port before running pbi_create manually.}}<br /> |-<br /> {{Tbl-line|align=left|'''-c confdir'''}}<br /> {{Tbl-line|align=left|Specify the meta-data confdir to use. While not required for building a PBI, it is highly recommended. Without some configuration settings in the meta-data, icons and binary entry-points will not be created.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-d portsdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify an alternative ports-dir, defaults to /usr/ports}}<br /> |-<br /> {{Tbl-line|align=left|'''-k'''}} <br /> {{Tbl-line|align=left|Keep the build files after a success or failure compiling/building the PBI}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-o outdir'''}}<br /> {{Tbl-line|bg=ff|align=left|The directory to place the finished PBI file, defaults to user's $HOME directory}}<br /> |-<br /> {{Tbl-line|align=left|'''-p prefix'''}}<br /> {{Tbl-line|align=left|Manually provide a PREFIX, which determines the location where the PBI will end up being installed on the end-user's system.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--delbuild'''}}<br /> {{Tbl-line|bg=ff|align=left|Remove any existing build dirs before starting the build}}<br /> |-<br /> {{Tbl-line|align=left|'''--mkdebug'''}}<br /> {{Tbl-line|align=left|Will drop to a debugging shell should the port make fail}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--no-prune'''}}<br /> {{Tbl-line|bg=ff|align=left|Disable auto-pruning of non REQUIREDBY ports after the compile phase. By default any ports which are used solely for building and which are not required for program execution will be pruned.}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|Digitially sign the PBI file with the specified openssl private key file}}<br /> |-<br /> |}<br /> <br /> ==== pbi_makerepo(1) ====<br /> <br /> The '''pbi_makerepo''' command allows repository maintainers to create a single *.rpo file containing various information about the new repository. This .rpo file can then be installed on the target system with '''pbi_addrepo'''. Table 6.2.4.15 summarizes the available options.<br /> <br /> '''Table 6.2.4.15: pbi_makerepo Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--desc description'''}}<br /> {{Tbl-line|bg=ff|align=left|Required. Description of the repo to be shown in the repo list}}<br /> |-<br /> {{Tbl-line|align=left|'''--key keyfile'''}}<br /> {{Tbl-line|align=left|Required. OpenSSL public key used to verify the digital signature of PBIs installed from this repo}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--mirror URL'''}}<br /> {{Tbl-line|bg=ff|align=left|Required. The URL to download PBIs and updates from}}<br /> |-<br /> {{Tbl-line|align=left|'''--url URL'''}}<br /> {{Tbl-line|align=left|Required. The URL to use when downloading the master INDEX files of available PBIs}}<br /> |-<br /> |}<br /> <br /> ==== pbi_metatool(1) ====<br /> <br /> The '''pbi_metatool''' command provides a way for repository maintainers to modify the PBI meta-data in their repository in order to add or remove application categories or specified PBIs. This meta-data may contain information such as Name, Description, Icon, Keywords, License and more for the respective PBI file. Table 6.2.4.16 summarizes the available options:<br /> <br /> '''Table 6.2.4.16: pbi_metatool Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add'''}}<br /> {{Tbl-line|bg=ff|align=left|Adds a category or application to the target metafile}}<br /> |-<br /> {{Tbl-line|align=left|'''rem'''}}<br /> {{Tbl-line|align=left|Remove a category or application to the target metafile}}<br /> |-<br /> |}<br /> <br /> Run the command with the desired option to receive detailed usage.<br /> <br /> ==== pbi_patch(1) ====<br /> <br /> The '''pbi_patch''' command is used to update an installed PBI to a different version using the small diff Push Button Patch *.pbp file. This allows the user to perform an incremental upgrade of an installed PBI. The available options are summarized in Table 6.2.4.17.<br /> <br /> '''Table 6.2.4.17: pbi_patch Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-e'''}} <br /> {{Tbl-line|bg=ff|align=left|Extract only, do not install. Will extract the archive to ~/&lt;pbidirname&gt; unless the -o option is used.}}<br /> |-<br /> {{Tbl-line|align=left|'''-g'''}} <br /> {{Tbl-line|align=left|Extract image data from header, commonly used for GUI installations}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-i'''}} <br /> {{Tbl-line|bg=ff|align=left|Display information about this PBI file}}<br /> |-<br /> {{Tbl-line|align=left|'''-o outdir'''}}<br /> {{Tbl-line|align=left|Specify the directory to use when only extracting the PBI with -e.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--checkscript'''}}<br /> {{Tbl-line|bg=ff|align=left|Display any custom scripts used in the installation / removal of this PBI file. Recommended that these be checked if the PBI file is suspect in any way.}}<br /> |-<br /> {{Tbl-line|align=left|'''--no-checksig'''}}<br /> {{Tbl-line|align=left|Skip the openssl signature verification of the PBI data}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--no-hash'''}}<br /> {{Tbl-line|bg=ff|align=left|Disable using the shared-hash dir, which uses hard-links to share files between applications}}<br /> |-<br /> |}<br /> <br /> ==== pbi_update(1) ====<br /> <br /> The '''pbi_update''' command is used to display information about which PBIs have available updates from their repository and to perform the updates. Table 6.2.4.18 summarizes the available options.<br /> <br /> '''Table 6.2.4.18: pbi_update Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-c'''}} <br /> {{Tbl-line|bg=ff|align=left|Check-only the specified PBI for available updates.}}<br /> |-<br /> {{Tbl-line|align=left|'''--check-all'''}}<br /> {{Tbl-line|align=left|Run a full check of all installed PBIs and display list of available updates.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-disable-auto'''}}<br /> {{Tbl-line|bg=ff|align=left|Disable auto-updating of the target PBI.}}<br /> |-<br /> {{Tbl-line|align=left|'''--enable-auto'''}}<br /> {{Tbl-line|align=left|Enable auto-updating of the target PBI.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--update-all'''}}<br /> {{Tbl-line|bg=ff|align=left|Update all installed PBIs to the latest versions available.}}<br /> |-<br /> |}<br /> <br /> ====pbi_update_hashdir(1)====<br /> <br /> The '''pbi_update_hashdir''' command is used by the '''pbid''' daemon to merge the contents of a PBI into the hashdir.<br /> <br /> ==== pbid(8) ====<br /> <br /> The '''pbid''' command runs a small daemon which performs maintenance of installed PBIs, merges files into the shared hashdir, fetches the repository INDEX and meta files, and makes the adding and removing of PBIs much faster. It will automatically be started from the /usr/local/etc/rc.d/pbid startup script if pbid_enable=&quot;YES&quot; is in the /etc/rc.conf file.<br /> <br /> This utility supports the option summarized in table 6.2.4.19:<br /> <br /> '''Table 6.2.4.19: pbid Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-v'''}}<br /> {{Tbl-line|bg=ff|align=left|Enable verbose output when the daemon starts}}<br /> |-<br /> |}<br /> <br /> This command logs its output to /var/log/pbid.log. Check this log for errors should you experience any problems with PBI maintenance.</div>

Krismoore http://wiki.pcbsd.org/index.php/PBI_Manager 2011-11-30T18:49:18Z

<p>Krismoore: /* pbi_makeport(1) */</p> <hr /> <div>{{NavHeader|back=Using AppCafe™|forward=Update Manager}}<br /> PC-BSD 9.0 introduced PBI Manager, a suite of command line utilities for managing PBIs. PBI Manager's command-line tools can be used to install, remove, create and manage PBIs. It is also available for [[#Installing_PBI_Manager|FreeBSD systems]]. The PBI Manager is released under the [http://www.freebsd.org/copyright/freebsd-license.html BSD license].<br /> <br /> <br /> ===New Features===<br /> <br /> The new PBI format introduces the following features:<br /> <br /> * '''Upgrade deltas:''' since PBIs are self-contained, installation files tend to be large. In the previous implementation, updating a PBI required the re-downloading of the entire installation archive. For larger applications this could be a time-consuming process, especially over low bandwidth connections. The new PBI specification performs updates using binary diff patches known as PBP (Push Button Patch) files. PBPs are a fraction of the PBI's size; in some cases less than 5% of the original PBI archive. An upgrade automatically checks for for the presence of a PBP file and attempts to use it, only falling back to the original archive should the process fail.<br /> <br /> * '''Library and file sharing:''' in the previous implementation of the PBI format it was common that identical files existed between various applications. These duplicates, while necessary to provide self-contained functionality, wasted both disk and runtime memory. This waste of space has been greatly reduced through the use of a hash-dir directory where libraries and common files are shared through a system of hard links. When an identical file is found in a PBI, the original will be removed and a hard-link stored in the hash-dir. After a PBI has been removed, any unneeded files left in the hash-dir are cleaned up by the pbid(8) daemon which monitors and maintains the integrity of the shared files.<br /> <br /> * '''Repository management:''' allows administrators and PBI builders to create and manage their own repositories of PBIs. This repository system provides a number of tools for PBI distribution, release management, and repository browsing. <br /> <br /> * '''Digitally signed PBIs:''' each repository includes an openssl public key file which is installed on the end user's system. Each PBI includes several signatures for the content archive and installation and removal scripts. During the PBI installation process, these signatures are checked to confirm that the archive has not been tampered with during transit. This key file is also used to associate a particular PBI with a parent repository for upgrade purposes, since it is possible that multiple repositories will have the same applications.<br /> <br /> * '''Root password not required:''' most applications can be installed and upgraded by user (non-root) accounts. This allows enhanced security in office or home situations, where users can now add/remove desktop applications without needing access to the root account. PBIs that impact on the security of the system (e.g. installing a web server) will require root access.<br /> <br /> * '''Implementation:''' the previous PBI design was developed in QT/KDE C++, making it inappropriate for use at the command line. The new format is implemented 100% in shell and is comprised of command-line utilities, each with an associated man page. These utilities are discussed in more detail in the rest of this section.<br /> <br /> '''Additional Resources:'''<br /> <br /> [http://www.pcbsd.org/~kris/pbi9-slides.pdf The PBI Format Re-implemented for Free/PC-BSD (conference slides)]<br /> <br /> [http://www.pcbsd.org/~kris/asiabsdcon2011-pbi9.pdf The PBI Format Re-implemented for Free/PC-BSD (formal paper)]<br /> <br /> [[PBI9 Format|The PBI Format for 9.0 and Beyond]]<br /> <br /> === Release History ===<br /> * '''0.9.6''' (11-07-11)<br /> - Fix some bugs doing cleanup of stagedir / build directories<br /> <br /> - Properly kill fetch process when canceling a download<br /> <br /> - Improve buildworld on FreeBSD to use /usr/src if it already has source<br /> <br /> - Fix some random warnings when building via sudo<br /> <br /> <br /> * '''0.9.5''' (11-03-11)<br /> - Add sizes of PBIs to the meta index files<br /> <br /> - Fix bug adding default icon to PBIs when none is specified<br /> <br /> - Fix handling of PBI_PROGREVISION<br /> <br /> - Make sure we unmount nullfs mounts completely<br /> <br /> <br /> * '''0.9.4''' (10-19-11)<br /> - Fix issue using system-fonts in PBIs<br /> <br /> - Fix issue removing files which have been set r--<br /> <br /> - Slow down fetch process to fix issues with fetch protocol errors<br /> <br /> - Fix bug coping linux libraries into final PBI file<br /> <br /> - Allow user settings in external-links to overwrite auto-detected values<br /> <br /> - Fix bug running &quot;stat&quot; on files with spaces in name<br /> <br /> - Validate the build checksum before doing patching<br /> <br /> - Speed up builds with optional --tmpfs flags<br /> <br /> - Add priority system to building modules<br /> <br /> - Fix issues setting proxy support from pbi.conf / pcbsd.conf files<br /> <br /> - Validate repo URL's when creating .rpo file<br /> <br /> <br /> * '''0.9.3''' (07-18-11)<br /> - Unset variables between auto-builds<br /> <br /> - Fixed some warnings with 'cut' when parsing i18n strings<br /> <br /> - When doing auto-builds, run through alphabetically<br /> <br /> - Increase check frequency when first trying to download index's<br /> <br /> - Speed up the hashdir merging<br /> <br /> - Show repo MD5 with listings<br /> <br /> - If no index files, do not fail on listing, just show empty repo<br /> <br /> <br /> * '''0.9.2''' (05-23-11)<br /> - Fixed usage errors with &quot;tr&quot;<br /> <br /> - Syntax fixes when trying to install app with no meta-data<br /> <br /> - Fixed some bugs with binary patching<br /> <br /> - Fixed auto-builder using the PBI_BUILDKEY in modules pbi.conf file<br /> <br /> - When building ports, don't export PREFIX since it confuses some linux ports<br /> <br /> - Perform check if user is root, if PBI is flagged root-only<br /> <br /> - Auto-builder now checks if port is compatible with arch type of system<br /> <br /> <br /> * '''0.9.1''' - Initial public release (05/3/11)<br /> <br /> === What is the PBI format? ===<br /> <br /> The idea behind the PBI format is that one of the things holding back mainstream adoption of open source desktops is the package management format. With almost all open source desktops, software is simply treated as part of the operating system. Thus, when performing an update of some seemingly trivial application, you run the risk of potentially needing to upgrade other packages which could break other critical parts of your desktop. <br /> <br /> While package management systems have gotten better at resolving these dependency issues, trying to fix conflicts and prevent breakage before it occurs, they still don't address the underlying problem: every software package is a part of the system, and pulling on any one thread has the potential of causing a break somewhere farther down the line.<br /> <br /> The PBI format tries to correct this underlying flaw. Rather than making every application a part of the base system, PBIs are self-contained, including their own dependent library tree and related data. As a result, when you install a PBI there are no dependency issues to resolve, and applications can be added or removed freely, without fear of causing breakage to the desktop or any other installed software.<br /> <br /> === Installing PBI Manager ===<br /> <br /> If you are running PC-BSD 9 or higher, then the PBI Manager is already installed, and you can use it via the command-line, or a front-end such as the AppCafe™. <br /> <br /> FreeBSD users can install it from the [http://www.freshports.org/ports-mgmt/pbi-manager ports tree]. <br /> <br /> <br /> Users interested in installing the development version from our [http://trac.pcbsd.org/brower/pcbsd/current/src-sh/pbi-manager/ SVN repository] can do so with the following commands:<br /> <br /> '''svn co &lt;nowiki&gt;svn://svn.pcbsd.org/pcbsd/current/src-sh/pbi-manager&lt;/nowiki&gt;'''<br /> '''cd pbi-manager'''<br /> '''make install'''<br /> <br /> '''NOTE: The development version may be unstable / buggy, use at your own risk'''<br /> <br /> === Getting PBI Files ===<br /> <br /> The PC-BSD project has begun building PBIs which work with PBI Manager for FreeBSD/PC-BSD 9. A list of approved &amp; available PBIs can be viewed with '''pbi_info -i''' or '''pbi_browser''', and then installed with '''pbi_add -r &lt;pbiname&gt;'''. Until 9.0 is released the number of available PBIs will remain small but may be downloaded directly from the build server:<br /> <br /> [http://pbibuild.pcbsd.org/index.php?ver=9 9.x i386 PBIs]<br /> <br /> [http://pbibuild64.pcbsd.org/index.php?ver=9 9.x amd64 PBIs]<br /> <br /> '''NOTE:''' PBI files previously created for PC-BSD 7.x/8.x will NOT work with PBI Manager, these are specific to PC-BSD 7/8.<br /> <br /> ===Underlying File / Directory Structure===<br /> <br /> <br /> The underlying files / directories used by PBI Manager are as follows:<br /> <br /> '''/usr/local/etc/pbi.conf''': location of the PBI Manager configuration file <br /> <br /> '''/usr/pbi/''': where PBIs are installed on the system<br /> <br /> '''/var/db/pbi/''': contains data files related to installed PBIs and repositories <br /> <br /> '''/usr/local/sbin/pbi_*''': location of the PBI Manager commands<br /> <br /> '''/usr/local/share/pbi-manager/module-examples/convertoldmod.sh''': script which can be used to convert an existing 7.x/8.x PBI module to the new 9.x format.<br /> <br /> === Feedback / Reporting Problems ===<br /> <br /> Feedback, problem reports, and general discussion are welcome on the [http://lists.pcbsd.org/mailman/listinfo/pbi-dev PBI Developers Mailing list]. <br /> <br /> === Command Reference ===<br /> <br /> The following is a list of commands installed by the pbi-manager, along with a small synopsis of each. For more details, please refer to the command's man page.<br /> <br /> ==== pbi_add(1) ====<br /> <br /> Similar to FreeBSD's '''pkg_add''', the '''pbi_add''' command is used for adding/installing PBIs on a system, either from a local file or remotely from a repository. This utility supports the options listed in Table 6.2.4.1: <br /> <br /> '''Table 6.2.4.1: pbi_add Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> &lt;!-- row 1 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-e'''}}<br /> {{Tbl-line|bg=ff|align=left|Extract only, do not install. Will extract the archive to ~/&lt;pbidirname&gt; unless the -o option is used}}<br /> |-<br /> &lt;!-- row 2 --&gt;<br /> {{Tbl-line|align=left|'''-f'''}} <br /> {{Tbl-line|align=left|Force installation, overwriting an already installed copy of the application}}<br /> |- <br /> &lt;!-- row 3 --&gt; <br /> {{Tbl-line|bg=ff|align=left|'''-g'''}} <br /> {{Tbl-line|bg=ff|align=left|Get and show path to icon/images for GUI installations}}<br /> |-<br /> &lt;!-- row 4 --&gt; <br /> {{Tbl-line|bg=ee|align=left|'''-i'''}} <br /> {{Tbl-line|bg=ee|align=left|Display information about specified PBI}}<br /> |-<br /> &lt;!-- row 5 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-l'''}} <br /> {{Tbl-line|bg=ff|align=left|Display LICENSE for specified PBI}}<br /> |-<br /> &lt;!-- row 6 --&gt; <br /> {{Tbl-line|align=left|'''-o outdir'''}} <br /> {{Tbl-line|align=left|Specify the directory to use when extracting the PBI with -e.}}<br /> |-<br /> &lt;!-- row 7 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-r'''}} <br /> {{Tbl-line|bg=ff|align=left|Remote fetch installation file from update server. The system architecture and version will be automatically determined to fetch the correct file.}}<br /> |-<br /> &lt;!-- row 8 --&gt;<br /> {{Tbl-line|align=left|'''-v'''}} <br /> {{Tbl-line|align=left|Enable verbose output}}<br /> |-<br /> &lt;!-- row 9 --&gt; <br /> {{Tbl-line|bg=ff|align=left|'''--checkscript'''}} <br /> {{Tbl-line|bg=ff|align=left|Display any custom scripts used in the installation/removal of this PBI file.}} <br /> |-<br /> &lt;!-- row 10 --&gt; <br /> {{Tbl-line|align=left|'''--licagree'''}} <br /> {{Tbl-line|align=left|Agree to LICENSE terms and conditions. Viewing the license can be done with -l flag}}<br /> |-<br /> &lt;!-- row 11 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''--no-checksig'''}} <br /> {{Tbl-line|bg=ff|align=left|Skip the openssl signature verification of the PBI data}}<br /> |-<br /> &lt;!-- row 12 --&gt;<br /> {{Tbl-line|align=left|'''--no-checksum'''}} <br /> {{Tbl-line|align=left|Skip the checksum verification of the archive data}}<br /> |-<br /> &lt;!-- row 13 --&gt; <br /> {{Tbl-line|bg=ff|align=left|'''--no-hash'''}} <br /> {{Tbl-line|bg=ff|align=left|Disable using shared hash dir which uses hard-links to share files between applications}} <br /> |-<br /> &lt;!-- row 14 --&gt;<br /> {{Tbl-line|align=left|'''--repo repoid'''}}<br /> {{Tbl-line|align=left|Specify which repository to use}}<br /> |-<br /> &lt;!-- row 15 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''--rArch arch'''}}<br /> {{Tbl-line|bg=ff|align=left|Manually specify the PBI architecture type of i386 or amd64}}<br /> |-<br /> &lt;!-- row 16 --&gt;<br /> {{Tbl-line|align=left|'''--rVer version'''}}<br /> {{Tbl-line|align=left|Specify which version of the PBI to install}}<br /> |-<br /> |}<br /> <br /> For security reasons, it is recommend that users first use the -e and --checkscript options to view archive contents and installation scripts prior to installing a PBI file.<br /> <br /> To install a PBI, use: '''pbi_add -r PBINAME'''. The following example will install the alpine PBI:<br /> <br /> '''pbi_add -r alpine'''<br /> Downloading ftp://ftp.pcbsd.org/pub/mirror/PBI/mail/alpine/9/x32/alpine-2.00_3-i386.pbi<br /> /usr/pbi/.alpine-2.00_3-i386.pbi.42391 100% of 11 MB 295 kBps 00m00s<br /> Verifying Checksum...OK<br /> Extracting to: /usr/pbi/alpine-i386<br /> Installed: Alpine-2.00_3<br /> <br /> ==== pbi_addrepo(1) ====<br /> <br /> The '''pbi_addrepo''' command is used to register a new PBI repository on a system. If the '''pbid''' daemon is running, the repository's index and meta files will be automatically fetched and made ready for browsing. The command has one argument, the name of the repository file. Repository files have a .rpo extension and are created with the '''pbi_makerepo''' command.<br /> <br /> ==== pbi_autobuild(1) ====<br /> <br /> The '''pbi_autobuild''' command is used on the PBI build system to build any out-of-date or new packages. The utility is also of interest to PBI testers and system administrators who create and maintain their own internal repository of PBIs. It can traverse the FreeBSD ports and Meta-data trees, building missing PBI files or PBIs in which the target port version has been updated. Table 6.2.4.3 summarizes this command's options:<br /> <br /> '''Table 6.2.4.3: pbi_autobuild Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> &lt;!-- row 1 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-c confdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify the directory containing the PBI configuration modules data to traverse. Any found pbi.conf files will be parsed, and if PBI_MAKEPORT is set, the target port will be used for the build. If PBI_MAKEPORT is unset, the auto-build will attempt to match the module to a FreeBSD port based upon the dirname of pbi.conf}}<br /> |-<br /> {{Tbl-line|align=left|'''-d portsdir'''}}<br /> {{Tbl-line|align=left|Specify an alternative ports-dir; defaults to /usr/ports}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-h script'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify a helper script to call after building a PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''-o outdir'''}}<br /> {{Tbl-line|align=left|The directory to place the finished PBI files. Also used to determine which apps are in need of a rebuild if the associated FreeBSD port has been updated.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--genpatch'''}}<br /> {{Tbl-line|bg=ff|align=left|When building a new PBI, check for archived copies, and generate smaller patch updates to the new version (*.pbp files)}}<br /> |-<br /> {{Tbl-line|align=left|'''--keep num'''}}<br /> {{Tbl-line|align=left|When building new PBIs, keep &lt;num&gt; copies of past versions of working PBI in &lt;outdir&gt;/archived/ folder. These archived copies can be used with the --genpatch command to generate update patch files.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--prune'''}}<br /> {{Tbl-line|bg=ff|align=left|Remove any PBIs which no longer have an associated module in confdir}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|Digitially sign the PBI file with the specified openssl private key file}} <br /> |-<br /> |}<br /> <br /> ==== pbi_browser(1) ====<br /> <br /> The '''pbi_browser''' command provides a CLI front-end to browsing a repository's available PBIs. Options for viewing categories and searching by keyword are available, and once the desired PBI is located, it will show the '''pbi_add''' command which can be used to install the application. Table 6.2.4.4 summarizes the available options.<br /> <br /> '''Table 6.2.4.4: pbi_browser Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-c category'''}}<br /> {{Tbl-line|bg=ff|align=left|Displays a list of PBIs in the specified category}}<br /> |-<br /> {{Tbl-line|align=left|'''-s search'''}}<br /> {{Tbl-line|align=left|Search for PBIs containing the specified string in the name, description, or keywords}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--listcats'''}}<br /> {{Tbl-line|bg=ff|align=left|List the available categories}}<br /> |-<br /> {{Tbl-line|align=left|'''--viewall'''}}<br /> {{Tbl-line|align=left|List all available PBIs}}<br /> |-<br /> |}<br /> <br /> ====pbi.conf(5)====<br /> <br /> pbi.conf is an ASCII text configuration file containing values that are used by the various '''pbi_*''' commands. Table 6.2.4.5 lists the supported variables.<br /> <br /> '''Table 6.2.4.5: pbi_conf Variables'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=20%|'''Switch'''}}<br /> {{Tbl-title|width=80%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_INDEXREFRESH'''}}<br /> {{Tbl-line|bg=ff|align=left|Number of hours. How often pbid refreshes the index/meta files from repos. Default is every 24 hours.}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROXYPASS'''}}<br /> {{Tbl-line|align=left|Password used to authenticate with proxy server.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROXYPORT'''}}<br /> {{Tbl-line|bg=ff|align=left|Proxy server port number.}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROXYTYPE'''}}<br /> {{Tbl-line|align=left|Can be HTTP or SOCKS5.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROXYURL'''}}<br /> {{Tbl-line|bg=ff|align=left|Proxy server IP address.}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROXYUSER'''}}<br /> {{Tbl-line|align=left|Username used to authenticate with proxy server.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBID_REFRESH'''}}<br /> {{Tbl-line|bg=ff|align=left|Wakeup time in seconds for pbid to run its checks.}}<br /> |-<br /> |}<br /> <br /> ==== pbi_create(1) ====<br /> <br /> The '''pbi_create''' command provides a way for packagers to manually specify a target directory to be compressed into a PBI file. The option '''-b''' can also be used to re-package an already installed PBI back to an archive. This command replaces the 8.x PBI Module Builder functionality. PBI creators are encouraged to send a tarball of the resulting PBI module to the [http://lists.pcbsd.org/mailman/listinfo/pbi-dev PBI-testing mailing list] so they can be added to the PC-BSD PBI repository and made available to other PC-BSD users.<br /> <br /> Table 6.2.4.6 summarizes the available options:<br /> <br /> '''Table 6.2.4.6: pbi_create Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-a author'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify the author for this PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''-b'''}} <br /> {{Tbl-line|align=left|Make a backup of an installed PBI. When using this option specify the target PBI name instead of [pbidir]}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-c confdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify the meta-data confdir to use. While not required for building a PBI, it is highly recommended. Without some configuration settings in the meta-data, icons and binary entry-points will not be created.}}<br /> |-<br /> {{Tbl-line|align=left|'''-d portsdir'''}}<br /> {{Tbl-line|align=left|Specify an alternative ports-dir, defaults to /usr/ports}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-i icon'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify a default icon for this PBI, relative to pbidir/}}<br /> |-<br /> {{Tbl-line|align=left|'''-n name'''}}<br /> {{Tbl-line|align=left|Specify a name for this PBI}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-o outdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Place the finished .pbi file into the specified directory. Defaults to $HOME/}}<br /> |-<br /> {{Tbl-line|align=left|'''-p port'''}}<br /> {{Tbl-line|align=left|Use the given port to get PBI name / version from}}<br /> |- <br /> {{Tbl-line|bg=ff|align=left|'''-r version'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify a version for this PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''-u weburl'''}}<br /> {{Tbl-line|align=left|Specify a website URL for the PBI}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--no-hash'''}}<br /> {{Tbl-line|bg=ff|align=left|Disable using the shared-hash dir which uses hard-links to share files between applications}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|Digitially sign the PBI file with the specified openssl private key file}}<br /> |-<br /> |}<br /> <br /> ==== pbi_delete(1) ====<br /> <br /> Similar to FreeBSD's '''pkg_delete''', the '''pbi_delete''' command removes an installed PBI from the system. It also schedules cleaning for the shared library directory, which is performed by '''pbid'''. Table 6.2.4.7 summarizes its options:<br /> <br /> '''Table 6.2.4.7: pbi_delete Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-v'''}} <br /> {{Tbl-line|bg=ff|align=left|Enable verbose output}}<br /> |-<br /> {{Tbl-line|align=left|'''--clean-hdir'''}}<br /> {{Tbl-line|align=left|Perform a full cleaning of the shared-hash dir, removing any unused files. This should only need to be done after a system crash or failure in removing a PBI via normal methods.}}<br /> |-<br /> |}<br /> <br /> When removing a PBI, you must give its full name. The full name can be found in the output of '''pbi_info'''. The following example searches for the emacs PBI and removes it:<br /> <br /> '''pbi_info | grep ntop'''<br /> ntop-4.0.1_1-i386<br /> '''pbi_delete -v ntop-4.0.1_1-i386'''<br /> Running pre-removal script: /var/db/pbi/installed/ntop-4.0.1_1-i386/pre-remove.sh<br /> Removing: /usr/pbi/ntop-i386<br /> Removing: /var/db/pbi/installed/ntop-4.0.1_1-i386<br /> <br /> ==== pbi_deleterepo(1) ====<br /> <br /> The '''pbi_deleterepo''' command can be used to remove a registered repository from the system. It takes the repository's ID as the only command argument.<br /> <br /> ==== pbi_icon(1) ====<br /> <br /> 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 [http://en.wikipedia.org/wiki/Xdg XDG]-compliant to understand a PBI's icon and mime settings. Table 6.2.4.9 summarizes this command's options:<br /> <br /> '''Table 6.2.4.9: pbi_icon Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add-desktop'''}}<br /> {{Tbl-line|bg=ff|align=left|Installs any XDG compliant desktop icons, should be run as user.}}<br /> |-<br /> {{Tbl-line|align=left|'''add-menu'''}}<br /> {{Tbl-line|align=left|Installs any XDG compliant menu icons, should be run as root.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add-mime'''}}<br /> {{Tbl-line|bg=ff|align=left|Installs any XDG compliant mime information, should be run as root.}}<br /> |-<br /> {{Tbl-line|align=left|'''add-pathlnk'''}}<br /> {{Tbl-line|align=left|Installs any PATH links to ~/bin as user or to LOCALBASE as root.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''del-desktop'''}}<br /> {{Tbl-line|bg=ff|align=left|Removes any XDG compliant desktop icons, should be run as user.}}<br /> |-<br /> {{Tbl-line|align=left|'''del-menu'''}}<br /> {{Tbl-line|align=left|Removes any XDG compliant menu icons, should be run as root.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''del-mime'''}}<br /> {{Tbl-line|bg=ff|align=left|Removes any XDG compliant menu icons, should be run as root.}}<br /> |-<br /> {{Tbl-line|align=left|'''del-pathlnk'''}}<br /> {{Tbl-line|align=left|Removes any any PATH links to ~/bin as user or to LOCALBASE as root}}<br /> |-<br /> |}<br /> <br /> ==== pbi_indextool(1) ====<br /> <br /> The '''pbi_indextool''' command is useful for repository maintainers. It allows the adding/removing of PBI files available in a particular repository INDEX file without needing to hand-edit the file. Table 6.2.4.10 summarizes the available options:<br /> <br /> '''Table 6.2.4.10: pbi_indextool Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add'''}}<br /> {{Tbl-line|bg=ff|align=left|Adds a PBI to the target INDEX file}}<br /> |-<br /> {{Tbl-line|align=left|'''rem'''}}<br /> {{Tbl-line|align=left|Removes a PBI from the target INDEX file}}<br /> |-<br /> |}<br /> <br /> Run the command with the desired option to receive detailed usage.<br /> <br /> ==== pbi_info(1) ====<br /> <br /> Similar to FreeBSD's '''pkg_info''' command, the '''pbi_info''' command is used to determine which PBIs are currently installed. Table 6.2.4.11 summarizes the available options:<br /> <br /> '''Table 6.2.4.11: pbi_info Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-a'''}} <br /> {{Tbl-line|bg=ff|align=left|List all PBIs installed on the system, same as running pbi_info without an argument.}}<br /> |-<br /> {{Tbl-line|align=left|'''-i'''}}<br /> {{Tbl-line|align=left|List all available PBIs from any repo}} <br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-v'''}} <br /> {{Tbl-line|bg=ff|align=left|Enable verbose output}}<br /> |-<br /> |}<br /> <br /> ==== pbi_listrepo(1) ====<br /> <br /> The '''pbi_listrepo''' command manages installed repositories on a system. Table 6.2.4.12 summarizes this command's options:<br /> <br /> '''Table 6.2.4.12: pbi_listrepo Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--down'''}}<br /> {{Tbl-line|bg=ff|align=left|Move the targeted repoid down a single number in priority}}<br /> |-<br /> {{Tbl-line|align=left|'''-mirror URL'''}}<br /> {{Tbl-line|align=left|Change the specified repoid's mirror URL}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--up'''}}<br /> {{Tbl-line|bg=ff|align=left|Move the targeted repoid up a single number in priority}}<br /> |-<br /> |}<br /> <br /> Run the command without any options to list the IDs of the available repositories.<br /> <br /> ==== pbi_makepatch(1) ====<br /> <br /> The '''pbi_makepatch''' command is automatically used by '''pbi_autobuild''' to create small *.pbp (Push Button Patch) files. These files can be downloaded to a user's system and used to update a PBI's version without re-downloading the entire archive. This allows users to download only the incremental changes when a PBI is upgraded. The command can also be run manually by providing two PBI archives to compare and generate a patch file for.<br /> <br /> Table 6.2.4.13 summarizes the available options:<br /> <br /> '''Table 6.2.4.13: pbi_makepatch Options<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-o outdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Save the resulting .PBP file to the specified directory}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|Use the specified openssl key to digitally sign the patch file}}<br /> |-<br /> |}<br /> <br /> ==== pbi_makeport(1) ====<br /> <br /> The '''pbi_makeport''' command can be used by packagers to build a target FreeBSD port and convert it into a PBI file. Many options are provided to fine-tune the build process, and meta-data modules can also be specified to further improve the resulting PBI file. The first time this command is run, it will build a fresh chroot sandbox environment which can be used for clean-room building of the target port without affecting the host system. PBI creators are encouraged to send a tarball of the resulting PBI module to the [http://lists.pcbsd.org/mailman/listinfo/pbi-dev PBI-testing mailing list] so they can be added to the PC-BSD PBI repository and made available to other PC-BSD users.<br /> <br /> Starting in version '''0.9.7''' the pbi_makeport command has support for using [http://www.freshports.org/devel/ccache/ ccache] to speed up the compile process. If '''ccache''' is installed on the host system, and the CCACHE_DIR variable is set, the pbi_makeport command will automatically utilize it for the port compile phase. This can be disabled by setting NO_CCACHE=yes in /etc/pbi-make.conf on the host system, or as an optional make flag in a modules pbi.conf file. <br /> <br /> Table 6.2.4.14 summarizes the available options:<br /> <br /> '''Table 6.2.4.14: pbi_makeport Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-B'''}} <br /> {{Tbl-line|bg=ff|align=left|Build-only, after the port make process has finished, do not generate the PBI file. Generally used with -k to build a port before running pbi_create manually.}}<br /> |-<br /> {{Tbl-line|align=left|'''-c confdir'''}}<br /> {{Tbl-line|align=left|Specify the meta-data confdir to use. While not required for building a PBI, it is highly recommended. Without some configuration settings in the meta-data, icons and binary entry-points will not be created.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-d portsdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify an alternative ports-dir, defaults to /usr/ports}}<br /> |-<br /> {{Tbl-line|align=left|'''-k'''}} <br /> {{Tbl-line|align=left|Keep the build files after a success or failure compiling/building the PBI}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-o outdir'''}}<br /> {{Tbl-line|bg=ff|align=left|The directory to place the finished PBI file, defaults to user's $HOME directory}}<br /> |-<br /> {{Tbl-line|align=left|'''-p prefix'''}}<br /> {{Tbl-line|align=left|Manually provide a PREFIX, which determines the location where the PBI will end up being installed on the end-user's system.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--delbuild'''}}<br /> {{Tbl-line|bg=ff|align=left|Remove any existing build dirs before starting the build}}<br /> |-<br /> {{Tbl-line|align=left|'''--mkdebug'''}}<br /> {{Tbl-line|align=left|Will drop to a debugging shell should the port make fail}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--no-prune'''}}<br /> {{Tbl-line|bg=ff|align=left|Disable auto-pruning of non REQUIREDBY ports after the compile phase. By default any ports which are used solely for building and which are not required for program execution will be pruned.}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|Digitially sign the PBI file with the specified openssl private key file}}<br /> |-<br /> |}<br /> <br /> ==== pbi_makerepo(1) ====<br /> <br /> The '''pbi_makerepo''' command allows repository maintainers to create a single *.rpo file containing various information about the new repository. This .rpo file can then be installed on the target system with '''pbi_addrepo'''. Table 6.2.4.15 summarizes the available options.<br /> <br /> '''Table 6.2.4.15: pbi_makerepo Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--desc description'''}}<br /> {{Tbl-line|bg=ff|align=left|Required. Description of the repo to be shown in the repo list}}<br /> |-<br /> {{Tbl-line|align=left|'''--key keyfile'''}}<br /> {{Tbl-line|align=left|Required. OpenSSL public key used to verify the digital signature of PBIs installed from this repo}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--mirror URL'''}}<br /> {{Tbl-line|bg=ff|align=left|Required. The URL to download PBIs and updates from}}<br /> |-<br /> {{Tbl-line|align=left|'''--url URL'''}}<br /> {{Tbl-line|align=left|Required. The URL to use when downloading the master INDEX files of available PBIs}}<br /> |-<br /> |}<br /> <br /> ==== pbi_metatool(1) ====<br /> <br /> The '''pbi_metatool''' command provides a way for repository maintainers to modify the PBI meta-data in their repository in order to add or remove application categories or specified PBIs. This meta-data may contain information such as Name, Description, Icon, Keywords, License and more for the respective PBI file. Table 6.2.4.16 summarizes the available options:<br /> <br /> '''Table 6.2.4.16: pbi_metatool Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add'''}}<br /> {{Tbl-line|bg=ff|align=left|Adds a category or application to the target metafile}}<br /> |-<br /> {{Tbl-line|align=left|'''rem'''}}<br /> {{Tbl-line|align=left|Remove a category or application to the target metafile}}<br /> |-<br /> |}<br /> <br /> Run the command with the desired option to receive detailed usage.<br /> <br /> ==== pbi_patch(1) ====<br /> <br /> The '''pbi_patch''' command is used to update an installed PBI to a different version using the small diff Push Button Patch *.pbp file. This allows the user to perform an incremental upgrade of an installed PBI. The available options are summarized in Table 6.2.4.17.<br /> <br /> '''Table 6.2.4.17: pbi_patch Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-e'''}} <br /> {{Tbl-line|bg=ff|align=left|Extract only, do not install. Will extract the archive to ~/&lt;pbidirname&gt; unless the -o option is used.}}<br /> |-<br /> {{Tbl-line|align=left|'''-g'''}} <br /> {{Tbl-line|align=left|Extract image data from header, commonly used for GUI installations}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-i'''}} <br /> {{Tbl-line|bg=ff|align=left|Display information about this PBI file}}<br /> |-<br /> {{Tbl-line|align=left|'''-o outdir'''}}<br /> {{Tbl-line|align=left|Specify the directory to use when only extracting the PBI with -e.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--checkscript'''}}<br /> {{Tbl-line|bg=ff|align=left|Display any custom scripts used in the installation / removal of this PBI file. Recommended that these be checked if the PBI file is suspect in any way.}}<br /> |-<br /> {{Tbl-line|align=left|'''--no-checksig'''}}<br /> {{Tbl-line|align=left|Skip the openssl signature verification of the PBI data}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--no-hash'''}}<br /> {{Tbl-line|bg=ff|align=left|Disable using the shared-hash dir, which uses hard-links to share files between applications}}<br /> |-<br /> |}<br /> <br /> ==== pbi_update(1) ====<br /> <br /> The '''pbi_update''' command is used to display information about which PBIs have available updates from their repository and to perform the updates. Table 6.2.4.18 summarizes the available options.<br /> <br /> '''Table 6.2.4.18: pbi_update Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-c'''}} <br /> {{Tbl-line|bg=ff|align=left|Check-only the specified PBI for available updates.}}<br /> |-<br /> {{Tbl-line|align=left|'''--check-all'''}}<br /> {{Tbl-line|align=left|Run a full check of all installed PBIs and display list of available updates.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-disable-auto'''}}<br /> {{Tbl-line|bg=ff|align=left|Disable auto-updating of the target PBI.}}<br /> |-<br /> {{Tbl-line|align=left|'''--enable-auto'''}}<br /> {{Tbl-line|align=left|Enable auto-updating of the target PBI.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--update-all'''}}<br /> {{Tbl-line|bg=ff|align=left|Update all installed PBIs to the latest versions available.}}<br /> |-<br /> |}<br /> <br /> ====pbi_update_hashdir(1)====<br /> <br /> The '''pbi_update_hashdir''' command is used by the '''pbid''' daemon to merge the contents of a PBI into the hashdir.<br /> <br /> ==== pbid(8) ====<br /> <br /> The '''pbid''' command runs a small daemon which performs maintenance of installed PBIs, merges files into the shared hashdir, fetches the repository INDEX and meta files, and makes the adding and removing of PBIs much faster. It will automatically be started from the /usr/local/etc/rc.d/pbid startup script if pbid_enable=&quot;YES&quot; is in the /etc/rc.conf file.<br /> <br /> This utility supports the option summarized in table 6.2.4.19:<br /> <br /> '''Table 6.2.4.19: pbid Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-v'''}}<br /> {{Tbl-line|bg=ff|align=left|Enable verbose output when the daemon starts}}<br /> |-<br /> |}<br /> <br /> This command logs its output to /var/log/pbid.log. Check this log for errors should you experience any problems with PBI maintenance.</div>

Krismoore http://wiki.pcbsd.org/index.php/PBI_Manager 2011-11-07T19:00:01Z

<p>Krismoore: /* Release History */</p> <hr /> <div>{{NavHeader|back=Using AppCafe™|forward=Update Manager}}<br /> PC-BSD 9.0 introduced PBI Manager, a suite of command line utilities for managing PBIs. PBI Manager's command-line tools can be used to install, remove, create and manage PBIs. It is also available for [[#Installing_PBI_Manager|FreeBSD systems]]. The PBI Manager is released under the [http://www.freebsd.org/copyright/freebsd-license.html BSD license].<br /> <br /> <br /> ===New Features===<br /> <br /> The new PBI format introduces the following features:<br /> <br /> * '''Upgrade deltas:''' since PBIs are self-contained, installation files tend to be large. In the previous implementation, updating a PBI required the re-downloading of the entire installation archive. For larger applications this could be a time-consuming process, especially over low bandwidth connections. The new PBI specification performs updates using binary diff patches known as PBP (Push Button Patch) files. PBPs are a fraction of the PBI's size; in some cases less than 5% of the original PBI archive. An upgrade automatically checks for for the presence of a PBP file and attempts to use it, only falling back to the original archive should the process fail.<br /> <br /> * '''Library and file sharing:''' in the previous implementation of the PBI format it was common that identical files existed between various applications. These duplicates, while necessary to provide self-contained functionality, wasted both disk and runtime memory. This waste of space has been greatly reduced through the use of a hash-dir directory where libraries and common files are shared through a system of hard links. When an identical file is found in a PBI, the original will be removed and a hard-link stored in the hash-dir. After a PBI has been removed, any unneeded files left in the hash-dir are cleaned up by the pbid(8) daemon which monitors and maintains the integrity of the shared files.<br /> <br /> * '''Repository management:''' allows administrators and PBI builders to create and manage their own repositories of PBIs. This repository system provides a number of tools for PBI distribution, release management, and repository browsing. <br /> <br /> * '''Digitally signed PBIs:''' each repository includes an openssl public key file which is installed on the end user's system. Each PBI includes several signatures for the content archive and installation and removal scripts. During the PBI installation process, these signatures are checked to confirm that the archive has not been tampered with during transit. This key file is also used to associate a particular PBI with a parent repository for upgrade purposes, since it is possible that multiple repositories will have the same applications.<br /> <br /> * '''Root password not required:''' most applications can be installed and upgraded by user (non-root) accounts. This allows enhanced security in office or home situations, where users can now add/remove desktop applications without needing access to the root account. PBIs that impact on the security of the system (e.g. installing a web server) will require root access.<br /> <br /> * '''Implementation:''' the previous PBI design was developed in QT/KDE C++, making it inappropriate for use at the command line. The new format is implemented 100% in shell and is comprised of command-line utilities, each with an associated man page. These utilities are discussed in more detail in the rest of this section.<br /> <br /> '''Additional Resources:'''<br /> <br /> [http://www.pcbsd.org/~kris/pbi9-slides.pdf The PBI Format Re-implemented for Free/PC-BSD (conference slides)]<br /> <br /> [http://www.pcbsd.org/~kris/asiabsdcon2011-pbi9.pdf The PBI Format Re-implemented for Free/PC-BSD (formal paper)]<br /> <br /> [[PBI9 Format|The PBI Format for 9.0 and Beyond]]<br /> <br /> === Release History ===<br /> * '''0.9.6''' (11-07-11)<br /> - Fix some bugs doing cleanup of stagedir / build directories<br /> <br /> - Properly kill fetch process when canceling a download<br /> <br /> - Improve buildworld on FreeBSD to use /usr/src if it already has source<br /> <br /> - Fix some random warnings when building via sudo<br /> <br /> <br /> * '''0.9.5''' (11-03-11)<br /> - Add sizes of PBIs to the meta index files<br /> <br /> - Fix bug adding default icon to PBIs when none is specified<br /> <br /> - Fix handling of PBI_PROGREVISION<br /> <br /> - Make sure we unmount nullfs mounts completely<br /> <br /> <br /> * '''0.9.4''' (10-19-11)<br /> - Fix issue using system-fonts in PBIs<br /> <br /> - Fix issue removing files which have been set r--<br /> <br /> - Slow down fetch process to fix issues with fetch protocol errors<br /> <br /> - Fix bug coping linux libraries into final PBI file<br /> <br /> - Allow user settings in external-links to overwrite auto-detected values<br /> <br /> - Fix bug running &quot;stat&quot; on files with spaces in name<br /> <br /> - Validate the build checksum before doing patching<br /> <br /> - Speed up builds with optional --tmpfs flags<br /> <br /> - Add priority system to building modules<br /> <br /> - Fix issues setting proxy support from pbi.conf / pcbsd.conf files<br /> <br /> - Validate repo URL's when creating .rpo file<br /> <br /> <br /> * '''0.9.3''' (07-18-11)<br /> - Unset variables between auto-builds<br /> <br /> - Fixed some warnings with 'cut' when parsing i18n strings<br /> <br /> - When doing auto-builds, run through alphabetically<br /> <br /> - Increase check frequency when first trying to download index's<br /> <br /> - Speed up the hashdir merging<br /> <br /> - Show repo MD5 with listings<br /> <br /> - If no index files, do not fail on listing, just show empty repo<br /> <br /> <br /> * '''0.9.2''' (05-23-11)<br /> - Fixed usage errors with &quot;tr&quot;<br /> <br /> - Syntax fixes when trying to install app with no meta-data<br /> <br /> - Fixed some bugs with binary patching<br /> <br /> - Fixed auto-builder using the PBI_BUILDKEY in modules pbi.conf file<br /> <br /> - When building ports, don't export PREFIX since it confuses some linux ports<br /> <br /> - Perform check if user is root, if PBI is flagged root-only<br /> <br /> - Auto-builder now checks if port is compatible with arch type of system<br /> <br /> <br /> * '''0.9.1''' - Initial public release (05/3/11)<br /> <br /> === What is the PBI format? ===<br /> <br /> The idea behind the PBI format is that one of the things holding back mainstream adoption of open source desktops is the package management format. With almost all open source desktops, software is simply treated as part of the operating system. Thus, when performing an update of some seemingly trivial application, you run the risk of potentially needing to upgrade other packages which could break other critical parts of your desktop. <br /> <br /> While package management systems have gotten better at resolving these dependency issues, trying to fix conflicts and prevent breakage before it occurs, they still don't address the underlying problem: every software package is a part of the system, and pulling on any one thread has the potential of causing a break somewhere farther down the line.<br /> <br /> The PBI format tries to correct this underlying flaw. Rather than making every application a part of the base system, PBIs are self-contained, including their own dependent library tree and related data. As a result, when you install a PBI there are no dependency issues to resolve, and applications can be added or removed freely, without fear of causing breakage to the desktop or any other installed software.<br /> <br /> === Installing PBI Manager ===<br /> <br /> If you are running PC-BSD 9 or higher, then the PBI Manager is already installed, and you can use it via the command-line, or a front-end such as the AppCafe™. <br /> <br /> FreeBSD users can install it from the [http://www.freshports.org/ports-mgmt/pbi-manager ports tree]. <br /> <br /> <br /> Users interested in installing the development version from our [http://trac.pcbsd.org/brower/pcbsd/current/src-sh/pbi-manager/ SVN repository] can do so with the following commands:<br /> <br /> '''svn co &lt;nowiki&gt;svn://svn.pcbsd.org/pcbsd/current/src-sh/pbi-manager&lt;/nowiki&gt;'''<br /> '''cd pbi-manager'''<br /> '''make install'''<br /> <br /> '''NOTE: The development version may be unstable / buggy, use at your own risk'''<br /> <br /> === Getting PBI Files ===<br /> <br /> The PC-BSD project has begun building PBIs which work with PBI Manager for FreeBSD/PC-BSD 9. A list of approved &amp; available PBIs can be viewed with '''pbi_info -i''' or '''pbi_browser''', and then installed with '''pbi_add -r &lt;pbiname&gt;'''. Until 9.0 is released the number of available PBIs will remain small but may be downloaded directly from the build server:<br /> <br /> [http://pbibuild.pcbsd.org/index.php?ver=9 9.x i386 PBIs]<br /> <br /> [http://pbibuild64.pcbsd.org/index.php?ver=9 9.x amd64 PBIs]<br /> <br /> '''NOTE:''' PBI files previously created for PC-BSD 7.x/8.x will NOT work with PBI Manager, these are specific to PC-BSD 7/8.<br /> <br /> ===Underlying File / Directory Structure===<br /> <br /> <br /> The underlying files / directories used by PBI Manager are as follows:<br /> <br /> '''/usr/local/etc/pbi.conf''': location of the PBI Manager configuration file <br /> <br /> '''/usr/pbi/''': where PBIs are installed on the system<br /> <br /> '''/var/db/pbi/''': contains data files related to installed PBIs and repositories <br /> <br /> '''/usr/local/sbin/pbi_*''': location of the PBI Manager commands<br /> <br /> '''/usr/local/share/pbi-manager/module-examples/convertoldmod.sh''': script which can be used to convert an existing 7.x/8.x PBI module to the new 9.x format.<br /> <br /> === Feedback / Reporting Problems ===<br /> <br /> Feedback, problem reports, and general discussion are welcome on the [http://lists.pcbsd.org/mailman/listinfo/pbi-dev PBI Developers Mailing list]. <br /> <br /> === Command Reference ===<br /> <br /> The following is a list of commands installed by the pbi-manager, along with a small synopsis of each. For more details, please refer to the command's man page.<br /> <br /> ==== pbi_add(1) ====<br /> <br /> Similar to FreeBSD's '''pkg_add''', the '''pbi_add''' command is used for adding/installing PBIs on a system, either from a local file or remotely from a repository. This utility supports the options listed in Table 6.2.4.1: <br /> <br /> '''Table 6.2.4.1: pbi_add Options'''<br /> <br /> {{Tbl-init|width=80%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> &lt;!-- row 1 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-e'''}}<br /> {{Tbl-line|bg=ff|align=left|Extract only, do not install. Will extract the archive to ~/&lt;pbidirname&gt; unless the -o option is used}}<br /> |-<br /> &lt;!-- row 2 --&gt;<br /> {{Tbl-line|align=left|'''-f'''}} <br /> {{Tbl-line|align=left|Force installation, overwriting an already installed copy of the application}}<br /> |- <br /> &lt;!-- row 3 --&gt; <br /> {{Tbl-line|bg=ff|align=left|'''-g'''}} <br /> {{Tbl-line|bg=ff|align=left|Get and show path to icon/images for GUI installations}}<br /> |-<br /> &lt;!-- row 4 --&gt; <br /> {{Tbl-line|bg=ee|align=left|'''-i'''}} <br /> {{Tbl-line|bg=ee|align=left|Display information about specified PBI}}<br /> |-<br /> &lt;!-- row 5 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-l'''}} <br /> {{Tbl-line|bg=ff|align=left|Display LICENSE for specified PBI}}<br /> |-<br /> &lt;!-- row 6 --&gt; <br /> {{Tbl-line|align=left|'''-o outdir'''}} <br /> {{Tbl-line|align=left|Specify the directory to use when extracting the PBI with -e.}}<br /> |-<br /> &lt;!-- row 7 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-r'''}} <br /> {{Tbl-line|bg=ff|align=left|Remote fetch installation file from update server. The system architecture and version will be automatically determined to fetch the correct file.}}<br /> |-<br /> &lt;!-- row 8 --&gt;<br /> {{Tbl-line|align=left|'''-v'''}} <br /> {{Tbl-line|align=left|Enable verbose output}}<br /> |-<br /> &lt;!-- row 9 --&gt; <br /> {{Tbl-line|bg=ff|align=left|'''--checkscript'''}} <br /> {{Tbl-line|bg=ff|align=left|Display any custom scripts used in the installation/removal of this PBI file.}} <br /> |-<br /> &lt;!-- row 10 --&gt; <br /> {{Tbl-line|align=left|'''--licagree'''}} <br /> {{Tbl-line|align=left|Agree to LICENSE terms and conditions. Viewing the license can be done with -l flag}}<br /> |-<br /> &lt;!-- row 11 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''--no-checksig'''}} <br /> {{Tbl-line|bg=ff|align=left|Skip the openssl signature verification of the PBI data}}<br /> |-<br /> &lt;!-- row 12 --&gt;<br /> {{Tbl-line|align=left|'''--no-checksum'''}} <br /> {{Tbl-line|align=left|Skip the checksum verification of the archive data}}<br /> |-<br /> &lt;!-- row 13 --&gt; <br /> {{Tbl-line|bg=ff|align=left|'''--no-hash'''}} <br /> {{Tbl-line|bg=ff|align=left|Disable using shared hash dir which uses hard-links to share files between applications}} <br /> |-<br /> &lt;!-- row 14 --&gt;<br /> {{Tbl-line|align=left|'''--repo repoid'''}}<br /> {{Tbl-line|align=left|Specify which repository to use}}<br /> |-<br /> &lt;!-- row 15 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''--rArch arch'''}}<br /> {{Tbl-line|bg=ff|align=left|Manually specify the PBI architecture type of i386 or amd64}}<br /> |-<br /> &lt;!-- row 16 --&gt;<br /> {{Tbl-line|align=left|'''--rVer version'''}}<br /> {{Tbl-line|align=left|Specify which version of the PBI to install}}<br /> |-<br /> |}<br /> <br /> For security reasons, it is recommend that users first use the -e and --checkscript options to view archive contents and installation scripts prior to installing a PBI file.<br /> <br /> To install a PBI, use: '''pbi_add -r PBINAME'''. The following example will install the alpine PBI:<br /> <br /> '''pbi_add -r alpine'''<br /> Downloading ftp://ftp.pcbsd.org/pub/mirror/PBI/mail/alpine/9/x32/alpine-2.00_3-i386.pbi<br /> /usr/pbi/.alpine-2.00_3-i386.pbi.42391 100% of 11 MB 295 kBps 00m00s<br /> Verifying Checksum...OK<br /> Extracting to: /usr/pbi/alpine-i386<br /> Installed: Alpine-2.00_3<br /> <br /> ==== pbi_addrepo(1) ====<br /> <br /> The '''pbi_addrepo''' command is used to register a new PBI repository on a system. If the '''pbid''' daemon is running, the repository's index and meta files will be automatically fetched and made ready for browsing. The command has one argument, the name of the repository file. Repository files have a .rpo extension and are created with the '''pbi_makerepo''' command.<br /> <br /> ==== pbi_autobuild(1) ====<br /> <br /> The '''pbi_autobuild''' command is used on the PBI build system to build any out-of-date or new packages. The utility is also of interest to PBI testers and system administrators who create and maintain their own internal repository of PBIs. It can traverse the FreeBSD ports and Meta-data trees, building missing PBI files or PBIs in which the target port version has been updated. Table 6.2.4.3 summarizes this command's options:<br /> <br /> '''Table 6.2.4.3: pbi_autobuild Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> &lt;!-- row 1 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-c confdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify the directory containing the PBI configuration modules data to traverse. Any found pbi.conf files will be parsed, and if PBI_MAKEPORT is set, the target port will be used for the build. If PBI_MAKEPORT is unset, the auto-build will attempt to match the module to a FreeBSD port based upon the dirname of pbi.conf}}<br /> |-<br /> {{Tbl-line|align=left|'''-d portsdir'''}}<br /> {{Tbl-line|align=left|Specify an alternative ports-dir; defaults to /usr/ports}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-h script'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify a helper script to call after building a PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''-o outdir'''}}<br /> {{Tbl-line|align=left|The directory to place the finished PBI files. Also used to determine which apps are in need of a rebuild if the associated FreeBSD port has been updated.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--genpatch'''}}<br /> {{Tbl-line|bg=ff|align=left|When building a new PBI, check for archived copies, and generate smaller patch updates to the new version (*.pbp files)}}<br /> |-<br /> {{Tbl-line|align=left|'''--keep num'''}}<br /> {{Tbl-line|align=left|When building new PBIs, keep &lt;num&gt; copies of past versions of working PBI in &lt;outdir&gt;/archived/ folder. These archived copies can be used with the --genpatch command to generate update patch files.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--prune'''}}<br /> {{Tbl-line|bg=ff|align=left|Remove any PBIs which no longer have an associated module in confdir}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|Digitially sign the PBI file with the specified openssl private key file}} <br /> |-<br /> |}<br /> <br /> ==== pbi_browser(1) ====<br /> <br /> The '''pbi_browser''' command provides a CLI front-end to browsing a repository's available PBIs. Options for viewing categories and searching by keyword are available, and once the desired PBI is located, it will show the '''pbi_add''' command which can be used to install the application. Table 6.2.4.4 summarizes the available options.<br /> <br /> '''Table 6.2.4.4: pbi_browser Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-c category'''}}<br /> {{Tbl-line|bg=ff|align=left|Displays a list of PBIs in the specified category}}<br /> |-<br /> {{Tbl-line|align=left|'''-s search'''}}<br /> {{Tbl-line|align=left|Search for PBIs containing the specified string in the name, description, or keywords}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--listcats'''}}<br /> {{Tbl-line|bg=ff|align=left|List the available categories}}<br /> |-<br /> {{Tbl-line|align=left|'''--viewall'''}}<br /> {{Tbl-line|align=left|List all available PBIs}}<br /> |-<br /> |}<br /> <br /> ====pbi.conf(5)====<br /> <br /> pbi.conf is an ASCII text configuration file containing values that are used by the various '''pbi_*''' commands. Table 6.2.4.5 lists the supported variables.<br /> <br /> '''Table 6.2.4.5: pbi_conf Variables'''<br /> <br /> {{Tbl-init|width=75%}}<br /> {{Tbl-title|width=20%|'''Switch'''}}<br /> {{Tbl-title|width=80%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_INDEXREFRESH'''}}<br /> {{Tbl-line|bg=ff|align=left|Number of hours. How often pbid refreshes the index/meta files from repos. Default is every 24 hours.}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROXYPASS'''}}<br /> {{Tbl-line|align=left|Password used to authenticate with proxy server.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROXYPORT'''}}<br /> {{Tbl-line|bg=ff|align=left|Proxy server port number.}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROXYTYPE'''}}<br /> {{Tbl-line|align=left|Can be HTTP or SOCKS5.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROXYURL'''}}<br /> {{Tbl-line|bg=ff|align=left|Proxy server IP address.}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROXYUSER'''}}<br /> {{Tbl-line|align=left|Username used to authenticate with proxy server.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBID_REFRESH'''}}<br /> {{Tbl-line|bg=ff|align=left|Wakeup time in seconds for pbid to run its checks.}}<br /> |-<br /> |}<br /> <br /> ==== pbi_create(1) ====<br /> <br /> The '''pbi_create''' command provides a way for packagers to manually specify a target directory to be compressed into a PBI file. The option '''-b''' can also be used to re-package an already installed PBI back to an archive. This command replaces the 8.x PBI Module Builder functionality. PBI creators are encouraged to send a tarball of the resulting PBI module to the [http://lists.pcbsd.org/mailman/listinfo/pbi-dev PBI-testing mailing list] so they can be added to the PC-BSD PBI repository and made available to other PC-BSD users.<br /> <br /> Table 6.2.4.6 summarizes the available options:<br /> <br /> '''Table 6.2.4.6: pbi_create Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-a author'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify the author for this PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''-b'''}} <br /> {{Tbl-line|align=left|Make a backup of an installed PBI. When using this option specify the target PBI name instead of [pbidir]}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-c confdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify the meta-data confdir to use. While not required for building a PBI, it is highly recommended. Without some configuration settings in the meta-data, icons and binary entry-points will not be created.}}<br /> |-<br /> {{Tbl-line|align=left|'''-d portsdir'''}}<br /> {{Tbl-line|align=left|Specify an alternative ports-dir, defaults to /usr/ports}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-i icon'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify a default icon for this PBI, relative to pbidir/}}<br /> |-<br /> {{Tbl-line|align=left|'''-n name'''}}<br /> {{Tbl-line|align=left|Specify a name for this PBI}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-o outdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Place the finished .pbi file into the specified directory. Defaults to $HOME/}}<br /> |-<br /> {{Tbl-line|align=left|'''-p port'''}}<br /> {{Tbl-line|align=left|Use the given port to get PBI name / version from}}<br /> |- <br /> {{Tbl-line|bg=ff|align=left|'''-r version'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify a version for this PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''-u weburl'''}}<br /> {{Tbl-line|align=left|Specify a website URL for the PBI}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--no-hash'''}}<br /> {{Tbl-line|bg=ff|align=left|Disable using the shared-hash dir which uses hard-links to share files between applications}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|Digitially sign the PBI file with the specified openssl private key file}}<br /> |-<br /> |}<br /> <br /> ==== pbi_delete(1) ====<br /> <br /> Similar to FreeBSD's '''pkg_delete''', the '''pbi_delete''' command removes an installed PBI from the system. It also schedules cleaning for the shared library directory, which is performed by '''pbid'''. Table 6.2.4.7 summarizes its options:<br /> <br /> '''Table 6.2.4.7: pbi_delete Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-v'''}} <br /> {{Tbl-line|bg=ff|align=left|Enable verbose output}}<br /> |-<br /> {{Tbl-line|align=left|'''--clean-hdir'''}}<br /> {{Tbl-line|align=left|Perform a full cleaning of the shared-hash dir, removing any unused files. This should only need to be done after a system crash or failure in removing a PBI via normal methods.}}<br /> |-<br /> |}<br /> <br /> When removing a PBI, you must give its full name. The full name can be found in the output of '''pbi_info'''. The following example searches for the emacs PBI and removes it:<br /> <br /> '''pbi_info | grep ntop'''<br /> ntop-4.0.1_1-i386<br /> '''pbi_delete -v ntop-4.0.1_1-i386'''<br /> Running pre-removal script: /var/db/pbi/installed/ntop-4.0.1_1-i386/pre-remove.sh<br /> Removing: /usr/pbi/ntop-i386<br /> Removing: /var/db/pbi/installed/ntop-4.0.1_1-i386<br /> <br /> ==== pbi_deleterepo(1) ====<br /> <br /> The '''pbi_deleterepo''' command can be used to remove a registered repository from the system. It takes the repository's ID as the only command argument.<br /> <br /> ==== pbi_icon(1) ====<br /> <br /> 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 [http://en.wikipedia.org/wiki/Xdg XDG]-compliant to understand a PBI's icon and mime settings. Table 6.2.4.9 summarizes this command's options:<br /> <br /> '''Table 6.2.4.9: pbi_icon Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add-desktop'''}}<br /> {{Tbl-line|bg=ff|align=left|Installs any XDG compliant desktop icons, should be run as user.}}<br /> |-<br /> {{Tbl-line|align=left|'''add-menu'''}}<br /> {{Tbl-line|align=left|Installs any XDG compliant menu icons, should be run as root.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add-mime'''}}<br /> {{Tbl-line|bg=ff|align=left|Installs any XDG compliant mime information, should be run as root.}}<br /> |-<br /> {{Tbl-line|align=left|'''add-pathlnk'''}}<br /> {{Tbl-line|align=left|Installs any PATH links to ~/bin as user or to LOCALBASE as root.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''del-desktop'''}}<br /> {{Tbl-line|bg=ff|align=left|Removes any XDG compliant desktop icons, should be run as user.}}<br /> |-<br /> {{Tbl-line|align=left|'''del-menu'''}}<br /> {{Tbl-line|align=left|Removes any XDG compliant menu icons, should be run as root.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''del-mime'''}}<br /> {{Tbl-line|bg=ff|align=left|Removes any XDG compliant menu icons, should be run as root.}}<br /> |-<br /> {{Tbl-line|align=left|'''del-pathlnk'''}}<br /> {{Tbl-line|align=left|Removes any any PATH links to ~/bin as user or to LOCALBASE as root}}<br /> |-<br /> |}<br /> <br /> ==== pbi_indextool(1) ====<br /> <br /> The '''pbi_indextool''' command is useful for repository maintainers. It allows the adding/removing of PBI files available in a particular repository INDEX file without needing to hand-edit the file. Table 6.2.4.10 summarizes the available options:<br /> <br /> '''Table 6.2.4.10: pbi_indextool Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add'''}}<br /> {{Tbl-line|bg=ff|align=left|Adds a PBI to the target INDEX file}}<br /> |-<br /> {{Tbl-line|align=left|'''rem'''}}<br /> {{Tbl-line|align=left|Removes a PBI from the target INDEX file}}<br /> |-<br /> |}<br /> <br /> Run the command with the desired option to receive detailed usage.<br /> <br /> ==== pbi_info(1) ====<br /> <br /> Similar to FreeBSD's '''pkg_info''' command, the '''pbi_info''' command is used to determine which PBIs are currently installed. Table 6.2.4.11 summarizes the available options:<br /> <br /> '''Table 6.2.4.11: pbi_info Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-a'''}} <br /> {{Tbl-line|bg=ff|align=left|List all PBIs installed on the system, same as running pbi_info without an argument.}}<br /> |-<br /> {{Tbl-line|align=left|'''-i'''}}<br /> {{Tbl-line|align=left|List all available PBIs from any repo}} <br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-v'''}} <br /> {{Tbl-line|bg=ff|align=left|Enable verbose output}}<br /> |-<br /> |}<br /> <br /> ==== pbi_listrepo(1) ====<br /> <br /> The '''pbi_listrepo''' command manages installed repositories on a system. Table 6.2.4.12 summarizes this command's options:<br /> <br /> '''Table 6.2.4.12: pbi_listrepo Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--down'''}}<br /> {{Tbl-line|bg=ff|align=left|Move the targeted repoid down a single number in priority}}<br /> |-<br /> {{Tbl-line|align=left|'''-mirror URL'''}}<br /> {{Tbl-line|align=left|Change the specified repoid's mirror URL}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--up'''}}<br /> {{Tbl-line|bg=ff|align=left|Move the targeted repoid up a single number in priority}}<br /> |-<br /> |}<br /> <br /> Run the command without any options to list the IDs of the available repositories.<br /> <br /> ==== pbi_makepatch(1) ====<br /> <br /> The '''pbi_makepatch''' command is automatically used by '''pbi_autobuild''' to create small *.pbp (Push Button Patch) files. These files can be downloaded to a user's system and used to update a PBI's version without re-downloading the entire archive. This allows users to download only the incremental changes when a PBI is upgraded. The command can also be run manually by providing two PBI archives to compare and generate a patch file for.<br /> <br /> Table 6.2.4.13 summarizes the available options:<br /> <br /> '''Table 6.2.4.13: pbi_makepatch Options<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-o outdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Save the resulting .PBP file to the specified directory}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|Use the specified openssl key to digitally sign the patch file}}<br /> |-<br /> |}<br /> <br /> ==== pbi_makeport(1) ====<br /> <br /> The '''pbi_makeport''' command can be used by packagers to build a target FreeBSD port and convert it into a PBI file. Many options are provided to fine-tune the build process, and meta-data modules can also be specified to further improve the resulting PBI file. The first time this command is run, it will build a fresh chroot sandbox environment which can be used for clean-room building of the target port without affecting the host system. PBI creators are encouraged to send a tarball of the resulting PBI module to the [http://lists.pcbsd.org/mailman/listinfo/pbi-dev PBI-testing mailing list] so they can be added to the PC-BSD PBI repository and made available to other PC-BSD users.<br /> <br /> Table 6.2.4.14 summarizes the available options:<br /> <br /> '''Table 6.2.4.14: pbi_makeport Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-B'''}} <br /> {{Tbl-line|bg=ff|align=left|Build-only, after the port make process has finished, do not generate the PBI file. Generally used with -k to build a port before running pbi_create manually.}}<br /> |-<br /> {{Tbl-line|align=left|'''-c confdir'''}}<br /> {{Tbl-line|align=left|Specify the meta-data confdir to use. While not required for building a PBI, it is highly recommended. Without some configuration settings in the meta-data, icons and binary entry-points will not be created.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-d portsdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify an alternative ports-dir, defaults to /usr/ports}}<br /> |-<br /> {{Tbl-line|align=left|'''-k'''}} <br /> {{Tbl-line|align=left|Keep the build files after a success or failure compiling/building the PBI}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-o outdir'''}}<br /> {{Tbl-line|bg=ff|align=left|The directory to place the finished PBI file, defaults to user's $HOME directory}}<br /> |-<br /> {{Tbl-line|align=left|'''-p prefix'''}}<br /> {{Tbl-line|align=left|Manually provide a PREFIX, which determines the location where the PBI will end up being installed on the end-user's system.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--delbuild'''}}<br /> {{Tbl-line|bg=ff|align=left|Remove any existing build dirs before starting the build}}<br /> |-<br /> {{Tbl-line|align=left|'''--mkdebug'''}}<br /> {{Tbl-line|align=left|Will drop to a debugging shell should the port make fail}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--no-prune'''}}<br /> {{Tbl-line|bg=ff|align=left|Disable auto-pruning of non REQUIREDBY ports after the compile phase. By default any ports which are used solely for building and which are not required for program execution will be pruned.}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|Digitially sign the PBI file with the specified openssl private key file}}<br /> |-<br /> |}<br /> <br /> ==== pbi_makerepo(1) ====<br /> <br /> The '''pbi_makerepo''' command allows repository maintainers to create a single *.rpo file containing various information about the new repository. This .rpo file can then be installed on the target system with '''pbi_addrepo'''. Table 6.2.4.15 summarizes the available options.<br /> <br /> '''Table 6.2.4.15: pbi_makerepo Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--desc description'''}}<br /> {{Tbl-line|bg=ff|align=left|Required. Description of the repo to be shown in the repo list}}<br /> |-<br /> {{Tbl-line|align=left|'''--key keyfile'''}}<br /> {{Tbl-line|align=left|Required. OpenSSL public key used to verify the digital signature of PBIs installed from this repo}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--mirror URL'''}}<br /> {{Tbl-line|bg=ff|align=left|Required. The URL to download PBIs and updates from}}<br /> |-<br /> {{Tbl-line|align=left|'''--url URL'''}}<br /> {{Tbl-line|align=left|Required. The URL to use when downloading the master INDEX files of available PBIs}}<br /> |-<br /> |}<br /> <br /> ==== pbi_metatool(1) ====<br /> <br /> The '''pbi_metatool''' command provides a way for repository maintainers to modify the PBI meta-data in their repository in order to add or remove application categories or specified PBIs. This meta-data may contain information such as Name, Description, Icon, Keywords, License and more for the respective PBI file. Table 6.2.4.16 summarizes the available options:<br /> <br /> '''Table 6.2.4.16: pbi_metatool Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add'''}}<br /> {{Tbl-line|bg=ff|align=left|Adds a category or application to the target metafile}}<br /> |-<br /> {{Tbl-line|align=left|'''rem'''}}<br /> {{Tbl-line|align=left|Remove a category or application to the target metafile}}<br /> |-<br /> |}<br /> <br /> Run the command with the desired option to receive detailed usage.<br /> <br /> ==== pbi_patch(1) ====<br /> <br /> The '''pbi_patch''' command is used to update an installed PBI to a different version using the small diff Push Button Patch *.pbp file. This allows the user to perform an incremental upgrade of an installed PBI. The available options are summarized in Table 6.2.4.17.<br /> <br /> '''Table 6.2.4.17: pbi_patch Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-e'''}} <br /> {{Tbl-line|bg=ff|align=left|Extract only, do not install. Will extract the archive to ~/&lt;pbidirname&gt; unless the -o option is used.}}<br /> |-<br /> {{Tbl-line|align=left|'''-g'''}} <br /> {{Tbl-line|align=left|Extract image data from header, commonly used for GUI installations}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-i'''}} <br /> {{Tbl-line|bg=ff|align=left|Display information about this PBI file}}<br /> |-<br /> {{Tbl-line|align=left|'''-o outdir'''}}<br /> {{Tbl-line|align=left|Specify the directory to use when only extracting the PBI with -e.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--checkscript'''}}<br /> {{Tbl-line|bg=ff|align=left|Display any custom scripts used in the installation / removal of this PBI file. Recommended that these be checked if the PBI file is suspect in any way.}}<br /> |-<br /> {{Tbl-line|align=left|'''--no-checksig'''}}<br /> {{Tbl-line|align=left|Skip the openssl signature verification of the PBI data}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--no-hash'''}}<br /> {{Tbl-line|bg=ff|align=left|Disable using the shared-hash dir, which uses hard-links to share files between applications}}<br /> |-<br /> |}<br /> <br /> ==== pbi_update(1) ====<br /> <br /> The '''pbi_update''' command is used to display information about which PBIs have available updates from their repository and to perform the updates. Table 6.2.4.18 summarizes the available options.<br /> <br /> '''Table 6.2.4.18: pbi_update Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-c'''}} <br /> {{Tbl-line|bg=ff|align=left|Check-only the specified PBI for available updates.}}<br /> |-<br /> {{Tbl-line|align=left|'''--check-all'''}}<br /> {{Tbl-line|align=left|Run a full check of all installed PBIs and display list of available updates.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-disable-auto'''}}<br /> {{Tbl-line|bg=ff|align=left|Disable auto-updating of the target PBI.}}<br /> |-<br /> {{Tbl-line|align=left|'''--enable-auto'''}}<br /> {{Tbl-line|align=left|Enable auto-updating of the target PBI.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--update-all'''}}<br /> {{Tbl-line|bg=ff|align=left|Update all installed PBIs to the latest versions available.}}<br /> |-<br /> |}<br /> <br /> ====pbi_update_hashdir(1)====<br /> <br /> The '''pbi_update_hashdir''' command is used by the '''pbid''' daemon to merge the contents of a PBI into the hashdir.<br /> <br /> ==== pbid(8) ====<br /> <br /> The '''pbid''' command runs a small daemon which performs maintenance of installed PBIs, merges files into the shared hashdir, fetches the repository INDEX and meta files, and makes the adding and removing of PBIs much faster. It will automatically be started from the /usr/local/etc/rc.d/pbid startup script if pbid_enable=&quot;YES&quot; is in the /etc/rc.conf file.<br /> <br /> This utility supports the option summarized in table 6.2.4.19:<br /> <br /> '''Table 6.2.4.19: pbid Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-v'''}}<br /> {{Tbl-line|bg=ff|align=left|Enable verbose output when the daemon starts}}<br /> |-<br /> |}<br /> <br /> This command logs its output to /var/log/pbid.log. Check this log for errors should you experience any problems with PBI maintenance.</div>

Krismoore http://wiki.pcbsd.org/index.php/PBI_Manager 2011-11-07T18:59:51Z

<p>Krismoore: /* Release History */</p> <hr /> <div>{{NavHeader|back=Using AppCafe™|forward=Update Manager}}<br /> PC-BSD 9.0 introduced PBI Manager, a suite of command line utilities for managing PBIs. PBI Manager's command-line tools can be used to install, remove, create and manage PBIs. It is also available for [[#Installing_PBI_Manager|FreeBSD systems]]. The PBI Manager is released under the [http://www.freebsd.org/copyright/freebsd-license.html BSD license].<br /> <br /> <br /> ===New Features===<br /> <br /> The new PBI format introduces the following features:<br /> <br /> * '''Upgrade deltas:''' since PBIs are self-contained, installation files tend to be large. In the previous implementation, updating a PBI required the re-downloading of the entire installation archive. For larger applications this could be a time-consuming process, especially over low bandwidth connections. The new PBI specification performs updates using binary diff patches known as PBP (Push Button Patch) files. PBPs are a fraction of the PBI's size; in some cases less than 5% of the original PBI archive. An upgrade automatically checks for for the presence of a PBP file and attempts to use it, only falling back to the original archive should the process fail.<br /> <br /> * '''Library and file sharing:''' in the previous implementation of the PBI format it was common that identical files existed between various applications. These duplicates, while necessary to provide self-contained functionality, wasted both disk and runtime memory. This waste of space has been greatly reduced through the use of a hash-dir directory where libraries and common files are shared through a system of hard links. When an identical file is found in a PBI, the original will be removed and a hard-link stored in the hash-dir. After a PBI has been removed, any unneeded files left in the hash-dir are cleaned up by the pbid(8) daemon which monitors and maintains the integrity of the shared files.<br /> <br /> * '''Repository management:''' allows administrators and PBI builders to create and manage their own repositories of PBIs. This repository system provides a number of tools for PBI distribution, release management, and repository browsing. <br /> <br /> * '''Digitally signed PBIs:''' each repository includes an openssl public key file which is installed on the end user's system. Each PBI includes several signatures for the content archive and installation and removal scripts. During the PBI installation process, these signatures are checked to confirm that the archive has not been tampered with during transit. This key file is also used to associate a particular PBI with a parent repository for upgrade purposes, since it is possible that multiple repositories will have the same applications.<br /> <br /> * '''Root password not required:''' most applications can be installed and upgraded by user (non-root) accounts. This allows enhanced security in office or home situations, where users can now add/remove desktop applications without needing access to the root account. PBIs that impact on the security of the system (e.g. installing a web server) will require root access.<br /> <br /> * '''Implementation:''' the previous PBI design was developed in QT/KDE C++, making it inappropriate for use at the command line. The new format is implemented 100% in shell and is comprised of command-line utilities, each with an associated man page. These utilities are discussed in more detail in the rest of this section.<br /> <br /> '''Additional Resources:'''<br /> <br /> [http://www.pcbsd.org/~kris/pbi9-slides.pdf The PBI Format Re-implemented for Free/PC-BSD (conference slides)]<br /> <br /> [http://www.pcbsd.org/~kris/asiabsdcon2011-pbi9.pdf The PBI Format Re-implemented for Free/PC-BSD (formal paper)]<br /> <br /> [[PBI9 Format|The PBI Format for 9.0 and Beyond]]<br /> <br /> === Release History ===<br /> * '''0.9.6''' (11-07-11)<br /> - Fix some bugs doing cleanup of stagedir / build directories<br /> <br /> - Properly kill fetch process when canceling a download<br /> <br /> - Improve buildworld on FreeBSD to use /usr/src if it already has source<br /> <br /> - Fix some random warnings when building via sudo<br /> <br /> * '''0.9.5''' (11-03-11)<br /> - Add sizes of PBIs to the meta index files<br /> <br /> - Fix bug adding default icon to PBIs when none is specified<br /> <br /> - Fix handling of PBI_PROGREVISION<br /> <br /> - Make sure we unmount nullfs mounts completely<br /> <br /> <br /> * '''0.9.4''' (10-19-11)<br /> - Fix issue using system-fonts in PBIs<br /> <br /> - Fix issue removing files which have been set r--<br /> <br /> - Slow down fetch process to fix issues with fetch protocol errors<br /> <br /> - Fix bug coping linux libraries into final PBI file<br /> <br /> - Allow user settings in external-links to overwrite auto-detected values<br /> <br /> - Fix bug running &quot;stat&quot; on files with spaces in name<br /> <br /> - Validate the build checksum before doing patching<br /> <br /> - Speed up builds with optional --tmpfs flags<br /> <br /> - Add priority system to building modules<br /> <br /> - Fix issues setting proxy support from pbi.conf / pcbsd.conf files<br /> <br /> - Validate repo URL's when creating .rpo file<br /> <br /> <br /> * '''0.9.3''' (07-18-11)<br /> - Unset variables between auto-builds<br /> <br /> - Fixed some warnings with 'cut' when parsing i18n strings<br /> <br /> - When doing auto-builds, run through alphabetically<br /> <br /> - Increase check frequency when first trying to download index's<br /> <br /> - Speed up the hashdir merging<br /> <br /> - Show repo MD5 with listings<br /> <br /> - If no index files, do not fail on listing, just show empty repo<br /> <br /> <br /> * '''0.9.2''' (05-23-11)<br /> - Fixed usage errors with &quot;tr&quot;<br /> <br /> - Syntax fixes when trying to install app with no meta-data<br /> <br /> - Fixed some bugs with binary patching<br /> <br /> - Fixed auto-builder using the PBI_BUILDKEY in modules pbi.conf file<br /> <br /> - When building ports, don't export PREFIX since it confuses some linux ports<br /> <br /> - Perform check if user is root, if PBI is flagged root-only<br /> <br /> - Auto-builder now checks if port is compatible with arch type of system<br /> <br /> <br /> * '''0.9.1''' - Initial public release (05/3/11)<br /> <br /> === What is the PBI format? ===<br /> <br /> The idea behind the PBI format is that one of the things holding back mainstream adoption of open source desktops is the package management format. With almost all open source desktops, software is simply treated as part of the operating system. Thus, when performing an update of some seemingly trivial application, you run the risk of potentially needing to upgrade other packages which could break other critical parts of your desktop. <br /> <br /> While package management systems have gotten better at resolving these dependency issues, trying to fix conflicts and prevent breakage before it occurs, they still don't address the underlying problem: every software package is a part of the system, and pulling on any one thread has the potential of causing a break somewhere farther down the line.<br /> <br /> The PBI format tries to correct this underlying flaw. Rather than making every application a part of the base system, PBIs are self-contained, including their own dependent library tree and related data. As a result, when you install a PBI there are no dependency issues to resolve, and applications can be added or removed freely, without fear of causing breakage to the desktop or any other installed software.<br /> <br /> === Installing PBI Manager ===<br /> <br /> If you are running PC-BSD 9 or higher, then the PBI Manager is already installed, and you can use it via the command-line, or a front-end such as the AppCafe™. <br /> <br /> FreeBSD users can install it from the [http://www.freshports.org/ports-mgmt/pbi-manager ports tree]. <br /> <br /> <br /> Users interested in installing the development version from our [http://trac.pcbsd.org/brower/pcbsd/current/src-sh/pbi-manager/ SVN repository] can do so with the following commands:<br /> <br /> '''svn co &lt;nowiki&gt;svn://svn.pcbsd.org/pcbsd/current/src-sh/pbi-manager&lt;/nowiki&gt;'''<br /> '''cd pbi-manager'''<br /> '''make install'''<br /> <br /> '''NOTE: The development version may be unstable / buggy, use at your own risk'''<br /> <br /> === Getting PBI Files ===<br /> <br /> The PC-BSD project has begun building PBIs which work with PBI Manager for FreeBSD/PC-BSD 9. A list of approved &amp; available PBIs can be viewed with '''pbi_info -i''' or '''pbi_browser''', and then installed with '''pbi_add -r &lt;pbiname&gt;'''. Until 9.0 is released the number of available PBIs will remain small but may be downloaded directly from the build server:<br /> <br /> [http://pbibuild.pcbsd.org/index.php?ver=9 9.x i386 PBIs]<br /> <br /> [http://pbibuild64.pcbsd.org/index.php?ver=9 9.x amd64 PBIs]<br /> <br /> '''NOTE:''' PBI files previously created for PC-BSD 7.x/8.x will NOT work with PBI Manager, these are specific to PC-BSD 7/8.<br /> <br /> ===Underlying File / Directory Structure===<br /> <br /> <br /> The underlying files / directories used by PBI Manager are as follows:<br /> <br /> '''/usr/local/etc/pbi.conf''': location of the PBI Manager configuration file <br /> <br /> '''/usr/pbi/''': where PBIs are installed on the system<br /> <br /> '''/var/db/pbi/''': contains data files related to installed PBIs and repositories <br /> <br /> '''/usr/local/sbin/pbi_*''': location of the PBI Manager commands<br /> <br /> '''/usr/local/share/pbi-manager/module-examples/convertoldmod.sh''': script which can be used to convert an existing 7.x/8.x PBI module to the new 9.x format.<br /> <br /> === Feedback / Reporting Problems ===<br /> <br /> Feedback, problem reports, and general discussion are welcome on the [http://lists.pcbsd.org/mailman/listinfo/pbi-dev PBI Developers Mailing list]. <br /> <br /> === Command Reference ===<br /> <br /> The following is a list of commands installed by the pbi-manager, along with a small synopsis of each. For more details, please refer to the command's man page.<br /> <br /> ==== pbi_add(1) ====<br /> <br /> Similar to FreeBSD's '''pkg_add''', the '''pbi_add''' command is used for adding/installing PBIs on a system, either from a local file or remotely from a repository. This utility supports the options listed in Table 6.2.4.1: <br /> <br /> '''Table 6.2.4.1: pbi_add Options'''<br /> <br /> {{Tbl-init|width=80%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> &lt;!-- row 1 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-e'''}}<br /> {{Tbl-line|bg=ff|align=left|Extract only, do not install. Will extract the archive to ~/&lt;pbidirname&gt; unless the -o option is used}}<br /> |-<br /> &lt;!-- row 2 --&gt;<br /> {{Tbl-line|align=left|'''-f'''}} <br /> {{Tbl-line|align=left|Force installation, overwriting an already installed copy of the application}}<br /> |- <br /> &lt;!-- row 3 --&gt; <br /> {{Tbl-line|bg=ff|align=left|'''-g'''}} <br /> {{Tbl-line|bg=ff|align=left|Get and show path to icon/images for GUI installations}}<br /> |-<br /> &lt;!-- row 4 --&gt; <br /> {{Tbl-line|bg=ee|align=left|'''-i'''}} <br /> {{Tbl-line|bg=ee|align=left|Display information about specified PBI}}<br /> |-<br /> &lt;!-- row 5 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-l'''}} <br /> {{Tbl-line|bg=ff|align=left|Display LICENSE for specified PBI}}<br /> |-<br /> &lt;!-- row 6 --&gt; <br /> {{Tbl-line|align=left|'''-o outdir'''}} <br /> {{Tbl-line|align=left|Specify the directory to use when extracting the PBI with -e.}}<br /> |-<br /> &lt;!-- row 7 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-r'''}} <br /> {{Tbl-line|bg=ff|align=left|Remote fetch installation file from update server. The system architecture and version will be automatically determined to fetch the correct file.}}<br /> |-<br /> &lt;!-- row 8 --&gt;<br /> {{Tbl-line|align=left|'''-v'''}} <br /> {{Tbl-line|align=left|Enable verbose output}}<br /> |-<br /> &lt;!-- row 9 --&gt; <br /> {{Tbl-line|bg=ff|align=left|'''--checkscript'''}} <br /> {{Tbl-line|bg=ff|align=left|Display any custom scripts used in the installation/removal of this PBI file.}} <br /> |-<br /> &lt;!-- row 10 --&gt; <br /> {{Tbl-line|align=left|'''--licagree'''}} <br /> {{Tbl-line|align=left|Agree to LICENSE terms and conditions. Viewing the license can be done with -l flag}}<br /> |-<br /> &lt;!-- row 11 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''--no-checksig'''}} <br /> {{Tbl-line|bg=ff|align=left|Skip the openssl signature verification of the PBI data}}<br /> |-<br /> &lt;!-- row 12 --&gt;<br /> {{Tbl-line|align=left|'''--no-checksum'''}} <br /> {{Tbl-line|align=left|Skip the checksum verification of the archive data}}<br /> |-<br /> &lt;!-- row 13 --&gt; <br /> {{Tbl-line|bg=ff|align=left|'''--no-hash'''}} <br /> {{Tbl-line|bg=ff|align=left|Disable using shared hash dir which uses hard-links to share files between applications}} <br /> |-<br /> &lt;!-- row 14 --&gt;<br /> {{Tbl-line|align=left|'''--repo repoid'''}}<br /> {{Tbl-line|align=left|Specify which repository to use}}<br /> |-<br /> &lt;!-- row 15 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''--rArch arch'''}}<br /> {{Tbl-line|bg=ff|align=left|Manually specify the PBI architecture type of i386 or amd64}}<br /> |-<br /> &lt;!-- row 16 --&gt;<br /> {{Tbl-line|align=left|'''--rVer version'''}}<br /> {{Tbl-line|align=left|Specify which version of the PBI to install}}<br /> |-<br /> |}<br /> <br /> For security reasons, it is recommend that users first use the -e and --checkscript options to view archive contents and installation scripts prior to installing a PBI file.<br /> <br /> To install a PBI, use: '''pbi_add -r PBINAME'''. The following example will install the alpine PBI:<br /> <br /> '''pbi_add -r alpine'''<br /> Downloading ftp://ftp.pcbsd.org/pub/mirror/PBI/mail/alpine/9/x32/alpine-2.00_3-i386.pbi<br /> /usr/pbi/.alpine-2.00_3-i386.pbi.42391 100% of 11 MB 295 kBps 00m00s<br /> Verifying Checksum...OK<br /> Extracting to: /usr/pbi/alpine-i386<br /> Installed: Alpine-2.00_3<br /> <br /> ==== pbi_addrepo(1) ====<br /> <br /> The '''pbi_addrepo''' command is used to register a new PBI repository on a system. If the '''pbid''' daemon is running, the repository's index and meta files will be automatically fetched and made ready for browsing. The command has one argument, the name of the repository file. Repository files have a .rpo extension and are created with the '''pbi_makerepo''' command.<br /> <br /> ==== pbi_autobuild(1) ====<br /> <br /> The '''pbi_autobuild''' command is used on the PBI build system to build any out-of-date or new packages. The utility is also of interest to PBI testers and system administrators who create and maintain their own internal repository of PBIs. It can traverse the FreeBSD ports and Meta-data trees, building missing PBI files or PBIs in which the target port version has been updated. Table 6.2.4.3 summarizes this command's options:<br /> <br /> '''Table 6.2.4.3: pbi_autobuild Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> &lt;!-- row 1 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-c confdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify the directory containing the PBI configuration modules data to traverse. Any found pbi.conf files will be parsed, and if PBI_MAKEPORT is set, the target port will be used for the build. If PBI_MAKEPORT is unset, the auto-build will attempt to match the module to a FreeBSD port based upon the dirname of pbi.conf}}<br /> |-<br /> {{Tbl-line|align=left|'''-d portsdir'''}}<br /> {{Tbl-line|align=left|Specify an alternative ports-dir; defaults to /usr/ports}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-h script'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify a helper script to call after building a PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''-o outdir'''}}<br /> {{Tbl-line|align=left|The directory to place the finished PBI files. Also used to determine which apps are in need of a rebuild if the associated FreeBSD port has been updated.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--genpatch'''}}<br /> {{Tbl-line|bg=ff|align=left|When building a new PBI, check for archived copies, and generate smaller patch updates to the new version (*.pbp files)}}<br /> |-<br /> {{Tbl-line|align=left|'''--keep num'''}}<br /> {{Tbl-line|align=left|When building new PBIs, keep &lt;num&gt; copies of past versions of working PBI in &lt;outdir&gt;/archived/ folder. These archived copies can be used with the --genpatch command to generate update patch files.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--prune'''}}<br /> {{Tbl-line|bg=ff|align=left|Remove any PBIs which no longer have an associated module in confdir}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|Digitially sign the PBI file with the specified openssl private key file}} <br /> |-<br /> |}<br /> <br /> ==== pbi_browser(1) ====<br /> <br /> The '''pbi_browser''' command provides a CLI front-end to browsing a repository's available PBIs. Options for viewing categories and searching by keyword are available, and once the desired PBI is located, it will show the '''pbi_add''' command which can be used to install the application. Table 6.2.4.4 summarizes the available options.<br /> <br /> '''Table 6.2.4.4: pbi_browser Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-c category'''}}<br /> {{Tbl-line|bg=ff|align=left|Displays a list of PBIs in the specified category}}<br /> |-<br /> {{Tbl-line|align=left|'''-s search'''}}<br /> {{Tbl-line|align=left|Search for PBIs containing the specified string in the name, description, or keywords}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--listcats'''}}<br /> {{Tbl-line|bg=ff|align=left|List the available categories}}<br /> |-<br /> {{Tbl-line|align=left|'''--viewall'''}}<br /> {{Tbl-line|align=left|List all available PBIs}}<br /> |-<br /> |}<br /> <br /> ====pbi.conf(5)====<br /> <br /> pbi.conf is an ASCII text configuration file containing values that are used by the various '''pbi_*''' commands. Table 6.2.4.5 lists the supported variables.<br /> <br /> '''Table 6.2.4.5: pbi_conf Variables'''<br /> <br /> {{Tbl-init|width=75%}}<br /> {{Tbl-title|width=20%|'''Switch'''}}<br /> {{Tbl-title|width=80%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_INDEXREFRESH'''}}<br /> {{Tbl-line|bg=ff|align=left|Number of hours. How often pbid refreshes the index/meta files from repos. Default is every 24 hours.}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROXYPASS'''}}<br /> {{Tbl-line|align=left|Password used to authenticate with proxy server.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROXYPORT'''}}<br /> {{Tbl-line|bg=ff|align=left|Proxy server port number.}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROXYTYPE'''}}<br /> {{Tbl-line|align=left|Can be HTTP or SOCKS5.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROXYURL'''}}<br /> {{Tbl-line|bg=ff|align=left|Proxy server IP address.}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROXYUSER'''}}<br /> {{Tbl-line|align=left|Username used to authenticate with proxy server.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBID_REFRESH'''}}<br /> {{Tbl-line|bg=ff|align=left|Wakeup time in seconds for pbid to run its checks.}}<br /> |-<br /> |}<br /> <br /> ==== pbi_create(1) ====<br /> <br /> The '''pbi_create''' command provides a way for packagers to manually specify a target directory to be compressed into a PBI file. The option '''-b''' can also be used to re-package an already installed PBI back to an archive. This command replaces the 8.x PBI Module Builder functionality. PBI creators are encouraged to send a tarball of the resulting PBI module to the [http://lists.pcbsd.org/mailman/listinfo/pbi-dev PBI-testing mailing list] so they can be added to the PC-BSD PBI repository and made available to other PC-BSD users.<br /> <br /> Table 6.2.4.6 summarizes the available options:<br /> <br /> '''Table 6.2.4.6: pbi_create Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-a author'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify the author for this PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''-b'''}} <br /> {{Tbl-line|align=left|Make a backup of an installed PBI. When using this option specify the target PBI name instead of [pbidir]}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-c confdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify the meta-data confdir to use. While not required for building a PBI, it is highly recommended. Without some configuration settings in the meta-data, icons and binary entry-points will not be created.}}<br /> |-<br /> {{Tbl-line|align=left|'''-d portsdir'''}}<br /> {{Tbl-line|align=left|Specify an alternative ports-dir, defaults to /usr/ports}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-i icon'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify a default icon for this PBI, relative to pbidir/}}<br /> |-<br /> {{Tbl-line|align=left|'''-n name'''}}<br /> {{Tbl-line|align=left|Specify a name for this PBI}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-o outdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Place the finished .pbi file into the specified directory. Defaults to $HOME/}}<br /> |-<br /> {{Tbl-line|align=left|'''-p port'''}}<br /> {{Tbl-line|align=left|Use the given port to get PBI name / version from}}<br /> |- <br /> {{Tbl-line|bg=ff|align=left|'''-r version'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify a version for this PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''-u weburl'''}}<br /> {{Tbl-line|align=left|Specify a website URL for the PBI}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--no-hash'''}}<br /> {{Tbl-line|bg=ff|align=left|Disable using the shared-hash dir which uses hard-links to share files between applications}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|Digitially sign the PBI file with the specified openssl private key file}}<br /> |-<br /> |}<br /> <br /> ==== pbi_delete(1) ====<br /> <br /> Similar to FreeBSD's '''pkg_delete''', the '''pbi_delete''' command removes an installed PBI from the system. It also schedules cleaning for the shared library directory, which is performed by '''pbid'''. Table 6.2.4.7 summarizes its options:<br /> <br /> '''Table 6.2.4.7: pbi_delete Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-v'''}} <br /> {{Tbl-line|bg=ff|align=left|Enable verbose output}}<br /> |-<br /> {{Tbl-line|align=left|'''--clean-hdir'''}}<br /> {{Tbl-line|align=left|Perform a full cleaning of the shared-hash dir, removing any unused files. This should only need to be done after a system crash or failure in removing a PBI via normal methods.}}<br /> |-<br /> |}<br /> <br /> When removing a PBI, you must give its full name. The full name can be found in the output of '''pbi_info'''. The following example searches for the emacs PBI and removes it:<br /> <br /> '''pbi_info | grep ntop'''<br /> ntop-4.0.1_1-i386<br /> '''pbi_delete -v ntop-4.0.1_1-i386'''<br /> Running pre-removal script: /var/db/pbi/installed/ntop-4.0.1_1-i386/pre-remove.sh<br /> Removing: /usr/pbi/ntop-i386<br /> Removing: /var/db/pbi/installed/ntop-4.0.1_1-i386<br /> <br /> ==== pbi_deleterepo(1) ====<br /> <br /> The '''pbi_deleterepo''' command can be used to remove a registered repository from the system. It takes the repository's ID as the only command argument.<br /> <br /> ==== pbi_icon(1) ====<br /> <br /> 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 [http://en.wikipedia.org/wiki/Xdg XDG]-compliant to understand a PBI's icon and mime settings. Table 6.2.4.9 summarizes this command's options:<br /> <br /> '''Table 6.2.4.9: pbi_icon Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add-desktop'''}}<br /> {{Tbl-line|bg=ff|align=left|Installs any XDG compliant desktop icons, should be run as user.}}<br /> |-<br /> {{Tbl-line|align=left|'''add-menu'''}}<br /> {{Tbl-line|align=left|Installs any XDG compliant menu icons, should be run as root.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add-mime'''}}<br /> {{Tbl-line|bg=ff|align=left|Installs any XDG compliant mime information, should be run as root.}}<br /> |-<br /> {{Tbl-line|align=left|'''add-pathlnk'''}}<br /> {{Tbl-line|align=left|Installs any PATH links to ~/bin as user or to LOCALBASE as root.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''del-desktop'''}}<br /> {{Tbl-line|bg=ff|align=left|Removes any XDG compliant desktop icons, should be run as user.}}<br /> |-<br /> {{Tbl-line|align=left|'''del-menu'''}}<br /> {{Tbl-line|align=left|Removes any XDG compliant menu icons, should be run as root.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''del-mime'''}}<br /> {{Tbl-line|bg=ff|align=left|Removes any XDG compliant menu icons, should be run as root.}}<br /> |-<br /> {{Tbl-line|align=left|'''del-pathlnk'''}}<br /> {{Tbl-line|align=left|Removes any any PATH links to ~/bin as user or to LOCALBASE as root}}<br /> |-<br /> |}<br /> <br /> ==== pbi_indextool(1) ====<br /> <br /> The '''pbi_indextool''' command is useful for repository maintainers. It allows the adding/removing of PBI files available in a particular repository INDEX file without needing to hand-edit the file. Table 6.2.4.10 summarizes the available options:<br /> <br /> '''Table 6.2.4.10: pbi_indextool Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add'''}}<br /> {{Tbl-line|bg=ff|align=left|Adds a PBI to the target INDEX file}}<br /> |-<br /> {{Tbl-line|align=left|'''rem'''}}<br /> {{Tbl-line|align=left|Removes a PBI from the target INDEX file}}<br /> |-<br /> |}<br /> <br /> Run the command with the desired option to receive detailed usage.<br /> <br /> ==== pbi_info(1) ====<br /> <br /> Similar to FreeBSD's '''pkg_info''' command, the '''pbi_info''' command is used to determine which PBIs are currently installed. Table 6.2.4.11 summarizes the available options:<br /> <br /> '''Table 6.2.4.11: pbi_info Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-a'''}} <br /> {{Tbl-line|bg=ff|align=left|List all PBIs installed on the system, same as running pbi_info without an argument.}}<br /> |-<br /> {{Tbl-line|align=left|'''-i'''}}<br /> {{Tbl-line|align=left|List all available PBIs from any repo}} <br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-v'''}} <br /> {{Tbl-line|bg=ff|align=left|Enable verbose output}}<br /> |-<br /> |}<br /> <br /> ==== pbi_listrepo(1) ====<br /> <br /> The '''pbi_listrepo''' command manages installed repositories on a system. Table 6.2.4.12 summarizes this command's options:<br /> <br /> '''Table 6.2.4.12: pbi_listrepo Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--down'''}}<br /> {{Tbl-line|bg=ff|align=left|Move the targeted repoid down a single number in priority}}<br /> |-<br /> {{Tbl-line|align=left|'''-mirror URL'''}}<br /> {{Tbl-line|align=left|Change the specified repoid's mirror URL}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--up'''}}<br /> {{Tbl-line|bg=ff|align=left|Move the targeted repoid up a single number in priority}}<br /> |-<br /> |}<br /> <br /> Run the command without any options to list the IDs of the available repositories.<br /> <br /> ==== pbi_makepatch(1) ====<br /> <br /> The '''pbi_makepatch''' command is automatically used by '''pbi_autobuild''' to create small *.pbp (Push Button Patch) files. These files can be downloaded to a user's system and used to update a PBI's version without re-downloading the entire archive. This allows users to download only the incremental changes when a PBI is upgraded. The command can also be run manually by providing two PBI archives to compare and generate a patch file for.<br /> <br /> Table 6.2.4.13 summarizes the available options:<br /> <br /> '''Table 6.2.4.13: pbi_makepatch Options<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-o outdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Save the resulting .PBP file to the specified directory}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|Use the specified openssl key to digitally sign the patch file}}<br /> |-<br /> |}<br /> <br /> ==== pbi_makeport(1) ====<br /> <br /> The '''pbi_makeport''' command can be used by packagers to build a target FreeBSD port and convert it into a PBI file. Many options are provided to fine-tune the build process, and meta-data modules can also be specified to further improve the resulting PBI file. The first time this command is run, it will build a fresh chroot sandbox environment which can be used for clean-room building of the target port without affecting the host system. PBI creators are encouraged to send a tarball of the resulting PBI module to the [http://lists.pcbsd.org/mailman/listinfo/pbi-dev PBI-testing mailing list] so they can be added to the PC-BSD PBI repository and made available to other PC-BSD users.<br /> <br /> Table 6.2.4.14 summarizes the available options:<br /> <br /> '''Table 6.2.4.14: pbi_makeport Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-B'''}} <br /> {{Tbl-line|bg=ff|align=left|Build-only, after the port make process has finished, do not generate the PBI file. Generally used with -k to build a port before running pbi_create manually.}}<br /> |-<br /> {{Tbl-line|align=left|'''-c confdir'''}}<br /> {{Tbl-line|align=left|Specify the meta-data confdir to use. While not required for building a PBI, it is highly recommended. Without some configuration settings in the meta-data, icons and binary entry-points will not be created.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-d portsdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify an alternative ports-dir, defaults to /usr/ports}}<br /> |-<br /> {{Tbl-line|align=left|'''-k'''}} <br /> {{Tbl-line|align=left|Keep the build files after a success or failure compiling/building the PBI}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-o outdir'''}}<br /> {{Tbl-line|bg=ff|align=left|The directory to place the finished PBI file, defaults to user's $HOME directory}}<br /> |-<br /> {{Tbl-line|align=left|'''-p prefix'''}}<br /> {{Tbl-line|align=left|Manually provide a PREFIX, which determines the location where the PBI will end up being installed on the end-user's system.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--delbuild'''}}<br /> {{Tbl-line|bg=ff|align=left|Remove any existing build dirs before starting the build}}<br /> |-<br /> {{Tbl-line|align=left|'''--mkdebug'''}}<br /> {{Tbl-line|align=left|Will drop to a debugging shell should the port make fail}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--no-prune'''}}<br /> {{Tbl-line|bg=ff|align=left|Disable auto-pruning of non REQUIREDBY ports after the compile phase. By default any ports which are used solely for building and which are not required for program execution will be pruned.}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|Digitially sign the PBI file with the specified openssl private key file}}<br /> |-<br /> |}<br /> <br /> ==== pbi_makerepo(1) ====<br /> <br /> The '''pbi_makerepo''' command allows repository maintainers to create a single *.rpo file containing various information about the new repository. This .rpo file can then be installed on the target system with '''pbi_addrepo'''. Table 6.2.4.15 summarizes the available options.<br /> <br /> '''Table 6.2.4.15: pbi_makerepo Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--desc description'''}}<br /> {{Tbl-line|bg=ff|align=left|Required. Description of the repo to be shown in the repo list}}<br /> |-<br /> {{Tbl-line|align=left|'''--key keyfile'''}}<br /> {{Tbl-line|align=left|Required. OpenSSL public key used to verify the digital signature of PBIs installed from this repo}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--mirror URL'''}}<br /> {{Tbl-line|bg=ff|align=left|Required. The URL to download PBIs and updates from}}<br /> |-<br /> {{Tbl-line|align=left|'''--url URL'''}}<br /> {{Tbl-line|align=left|Required. The URL to use when downloading the master INDEX files of available PBIs}}<br /> |-<br /> |}<br /> <br /> ==== pbi_metatool(1) ====<br /> <br /> The '''pbi_metatool''' command provides a way for repository maintainers to modify the PBI meta-data in their repository in order to add or remove application categories or specified PBIs. This meta-data may contain information such as Name, Description, Icon, Keywords, License and more for the respective PBI file. Table 6.2.4.16 summarizes the available options:<br /> <br /> '''Table 6.2.4.16: pbi_metatool Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add'''}}<br /> {{Tbl-line|bg=ff|align=left|Adds a category or application to the target metafile}}<br /> |-<br /> {{Tbl-line|align=left|'''rem'''}}<br /> {{Tbl-line|align=left|Remove a category or application to the target metafile}}<br /> |-<br /> |}<br /> <br /> Run the command with the desired option to receive detailed usage.<br /> <br /> ==== pbi_patch(1) ====<br /> <br /> The '''pbi_patch''' command is used to update an installed PBI to a different version using the small diff Push Button Patch *.pbp file. This allows the user to perform an incremental upgrade of an installed PBI. The available options are summarized in Table 6.2.4.17.<br /> <br /> '''Table 6.2.4.17: pbi_patch Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-e'''}} <br /> {{Tbl-line|bg=ff|align=left|Extract only, do not install. Will extract the archive to ~/&lt;pbidirname&gt; unless the -o option is used.}}<br /> |-<br /> {{Tbl-line|align=left|'''-g'''}} <br /> {{Tbl-line|align=left|Extract image data from header, commonly used for GUI installations}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-i'''}} <br /> {{Tbl-line|bg=ff|align=left|Display information about this PBI file}}<br /> |-<br /> {{Tbl-line|align=left|'''-o outdir'''}}<br /> {{Tbl-line|align=left|Specify the directory to use when only extracting the PBI with -e.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--checkscript'''}}<br /> {{Tbl-line|bg=ff|align=left|Display any custom scripts used in the installation / removal of this PBI file. Recommended that these be checked if the PBI file is suspect in any way.}}<br /> |-<br /> {{Tbl-line|align=left|'''--no-checksig'''}}<br /> {{Tbl-line|align=left|Skip the openssl signature verification of the PBI data}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--no-hash'''}}<br /> {{Tbl-line|bg=ff|align=left|Disable using the shared-hash dir, which uses hard-links to share files between applications}}<br /> |-<br /> |}<br /> <br /> ==== pbi_update(1) ====<br /> <br /> The '''pbi_update''' command is used to display information about which PBIs have available updates from their repository and to perform the updates. Table 6.2.4.18 summarizes the available options.<br /> <br /> '''Table 6.2.4.18: pbi_update Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-c'''}} <br /> {{Tbl-line|bg=ff|align=left|Check-only the specified PBI for available updates.}}<br /> |-<br /> {{Tbl-line|align=left|'''--check-all'''}}<br /> {{Tbl-line|align=left|Run a full check of all installed PBIs and display list of available updates.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-disable-auto'''}}<br /> {{Tbl-line|bg=ff|align=left|Disable auto-updating of the target PBI.}}<br /> |-<br /> {{Tbl-line|align=left|'''--enable-auto'''}}<br /> {{Tbl-line|align=left|Enable auto-updating of the target PBI.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--update-all'''}}<br /> {{Tbl-line|bg=ff|align=left|Update all installed PBIs to the latest versions available.}}<br /> |-<br /> |}<br /> <br /> ====pbi_update_hashdir(1)====<br /> <br /> The '''pbi_update_hashdir''' command is used by the '''pbid''' daemon to merge the contents of a PBI into the hashdir.<br /> <br /> ==== pbid(8) ====<br /> <br /> The '''pbid''' command runs a small daemon which performs maintenance of installed PBIs, merges files into the shared hashdir, fetches the repository INDEX and meta files, and makes the adding and removing of PBIs much faster. It will automatically be started from the /usr/local/etc/rc.d/pbid startup script if pbid_enable=&quot;YES&quot; is in the /etc/rc.conf file.<br /> <br /> This utility supports the option summarized in table 6.2.4.19:<br /> <br /> '''Table 6.2.4.19: pbid Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-v'''}}<br /> {{Tbl-line|bg=ff|align=left|Enable verbose output when the daemon starts}}<br /> |-<br /> |}<br /> <br /> This command logs its output to /var/log/pbid.log. Check this log for errors should you experience any problems with PBI maintenance.</div>

Krismoore http://wiki.pcbsd.org/index.php/PBI_Manager 2011-11-07T18:59:39Z

<p>Krismoore: /* Release History */</p> <hr /> <div>{{NavHeader|back=Using AppCafe™|forward=Update Manager}}<br /> PC-BSD 9.0 introduced PBI Manager, a suite of command line utilities for managing PBIs. PBI Manager's command-line tools can be used to install, remove, create and manage PBIs. It is also available for [[#Installing_PBI_Manager|FreeBSD systems]]. The PBI Manager is released under the [http://www.freebsd.org/copyright/freebsd-license.html BSD license].<br /> <br /> <br /> ===New Features===<br /> <br /> The new PBI format introduces the following features:<br /> <br /> * '''Upgrade deltas:''' since PBIs are self-contained, installation files tend to be large. In the previous implementation, updating a PBI required the re-downloading of the entire installation archive. For larger applications this could be a time-consuming process, especially over low bandwidth connections. The new PBI specification performs updates using binary diff patches known as PBP (Push Button Patch) files. PBPs are a fraction of the PBI's size; in some cases less than 5% of the original PBI archive. An upgrade automatically checks for for the presence of a PBP file and attempts to use it, only falling back to the original archive should the process fail.<br /> <br /> * '''Library and file sharing:''' in the previous implementation of the PBI format it was common that identical files existed between various applications. These duplicates, while necessary to provide self-contained functionality, wasted both disk and runtime memory. This waste of space has been greatly reduced through the use of a hash-dir directory where libraries and common files are shared through a system of hard links. When an identical file is found in a PBI, the original will be removed and a hard-link stored in the hash-dir. After a PBI has been removed, any unneeded files left in the hash-dir are cleaned up by the pbid(8) daemon which monitors and maintains the integrity of the shared files.<br /> <br /> * '''Repository management:''' allows administrators and PBI builders to create and manage their own repositories of PBIs. This repository system provides a number of tools for PBI distribution, release management, and repository browsing. <br /> <br /> * '''Digitally signed PBIs:''' each repository includes an openssl public key file which is installed on the end user's system. Each PBI includes several signatures for the content archive and installation and removal scripts. During the PBI installation process, these signatures are checked to confirm that the archive has not been tampered with during transit. This key file is also used to associate a particular PBI with a parent repository for upgrade purposes, since it is possible that multiple repositories will have the same applications.<br /> <br /> * '''Root password not required:''' most applications can be installed and upgraded by user (non-root) accounts. This allows enhanced security in office or home situations, where users can now add/remove desktop applications without needing access to the root account. PBIs that impact on the security of the system (e.g. installing a web server) will require root access.<br /> <br /> * '''Implementation:''' the previous PBI design was developed in QT/KDE C++, making it inappropriate for use at the command line. The new format is implemented 100% in shell and is comprised of command-line utilities, each with an associated man page. These utilities are discussed in more detail in the rest of this section.<br /> <br /> '''Additional Resources:'''<br /> <br /> [http://www.pcbsd.org/~kris/pbi9-slides.pdf The PBI Format Re-implemented for Free/PC-BSD (conference slides)]<br /> <br /> [http://www.pcbsd.org/~kris/asiabsdcon2011-pbi9.pdf The PBI Format Re-implemented for Free/PC-BSD (formal paper)]<br /> <br /> [[PBI9 Format|The PBI Format for 9.0 and Beyond]]<br /> <br /> === Release History ===<br /> * '''0.9.6''' (11-03-11)<br /> - Fix some bugs doing cleanup of stagedir / build directories<br /> <br /> - Properly kill fetch process when canceling a download<br /> <br /> - Improve buildworld on FreeBSD to use /usr/src if it already has source<br /> <br /> - Fix some random warnings when building via sudo<br /> <br /> * '''0.9.5''' (11-03-11)<br /> - Add sizes of PBIs to the meta index files<br /> <br /> - Fix bug adding default icon to PBIs when none is specified<br /> <br /> - Fix handling of PBI_PROGREVISION<br /> <br /> - Make sure we unmount nullfs mounts completely<br /> <br /> <br /> * '''0.9.4''' (10-19-11)<br /> - Fix issue using system-fonts in PBIs<br /> <br /> - Fix issue removing files which have been set r--<br /> <br /> - Slow down fetch process to fix issues with fetch protocol errors<br /> <br /> - Fix bug coping linux libraries into final PBI file<br /> <br /> - Allow user settings in external-links to overwrite auto-detected values<br /> <br /> - Fix bug running &quot;stat&quot; on files with spaces in name<br /> <br /> - Validate the build checksum before doing patching<br /> <br /> - Speed up builds with optional --tmpfs flags<br /> <br /> - Add priority system to building modules<br /> <br /> - Fix issues setting proxy support from pbi.conf / pcbsd.conf files<br /> <br /> - Validate repo URL's when creating .rpo file<br /> <br /> <br /> * '''0.9.3''' (07-18-11)<br /> - Unset variables between auto-builds<br /> <br /> - Fixed some warnings with 'cut' when parsing i18n strings<br /> <br /> - When doing auto-builds, run through alphabetically<br /> <br /> - Increase check frequency when first trying to download index's<br /> <br /> - Speed up the hashdir merging<br /> <br /> - Show repo MD5 with listings<br /> <br /> - If no index files, do not fail on listing, just show empty repo<br /> <br /> <br /> * '''0.9.2''' (05-23-11)<br /> - Fixed usage errors with &quot;tr&quot;<br /> <br /> - Syntax fixes when trying to install app with no meta-data<br /> <br /> - Fixed some bugs with binary patching<br /> <br /> - Fixed auto-builder using the PBI_BUILDKEY in modules pbi.conf file<br /> <br /> - When building ports, don't export PREFIX since it confuses some linux ports<br /> <br /> - Perform check if user is root, if PBI is flagged root-only<br /> <br /> - Auto-builder now checks if port is compatible with arch type of system<br /> <br /> <br /> * '''0.9.1''' - Initial public release (05/3/11)<br /> <br /> === What is the PBI format? ===<br /> <br /> The idea behind the PBI format is that one of the things holding back mainstream adoption of open source desktops is the package management format. With almost all open source desktops, software is simply treated as part of the operating system. Thus, when performing an update of some seemingly trivial application, you run the risk of potentially needing to upgrade other packages which could break other critical parts of your desktop. <br /> <br /> While package management systems have gotten better at resolving these dependency issues, trying to fix conflicts and prevent breakage before it occurs, they still don't address the underlying problem: every software package is a part of the system, and pulling on any one thread has the potential of causing a break somewhere farther down the line.<br /> <br /> The PBI format tries to correct this underlying flaw. Rather than making every application a part of the base system, PBIs are self-contained, including their own dependent library tree and related data. As a result, when you install a PBI there are no dependency issues to resolve, and applications can be added or removed freely, without fear of causing breakage to the desktop or any other installed software.<br /> <br /> === Installing PBI Manager ===<br /> <br /> If you are running PC-BSD 9 or higher, then the PBI Manager is already installed, and you can use it via the command-line, or a front-end such as the AppCafe™. <br /> <br /> FreeBSD users can install it from the [http://www.freshports.org/ports-mgmt/pbi-manager ports tree]. <br /> <br /> <br /> Users interested in installing the development version from our [http://trac.pcbsd.org/brower/pcbsd/current/src-sh/pbi-manager/ SVN repository] can do so with the following commands:<br /> <br /> '''svn co &lt;nowiki&gt;svn://svn.pcbsd.org/pcbsd/current/src-sh/pbi-manager&lt;/nowiki&gt;'''<br /> '''cd pbi-manager'''<br /> '''make install'''<br /> <br /> '''NOTE: The development version may be unstable / buggy, use at your own risk'''<br /> <br /> === Getting PBI Files ===<br /> <br /> The PC-BSD project has begun building PBIs which work with PBI Manager for FreeBSD/PC-BSD 9. A list of approved &amp; available PBIs can be viewed with '''pbi_info -i''' or '''pbi_browser''', and then installed with '''pbi_add -r &lt;pbiname&gt;'''. Until 9.0 is released the number of available PBIs will remain small but may be downloaded directly from the build server:<br /> <br /> [http://pbibuild.pcbsd.org/index.php?ver=9 9.x i386 PBIs]<br /> <br /> [http://pbibuild64.pcbsd.org/index.php?ver=9 9.x amd64 PBIs]<br /> <br /> '''NOTE:''' PBI files previously created for PC-BSD 7.x/8.x will NOT work with PBI Manager, these are specific to PC-BSD 7/8.<br /> <br /> ===Underlying File / Directory Structure===<br /> <br /> <br /> The underlying files / directories used by PBI Manager are as follows:<br /> <br /> '''/usr/local/etc/pbi.conf''': location of the PBI Manager configuration file <br /> <br /> '''/usr/pbi/''': where PBIs are installed on the system<br /> <br /> '''/var/db/pbi/''': contains data files related to installed PBIs and repositories <br /> <br /> '''/usr/local/sbin/pbi_*''': location of the PBI Manager commands<br /> <br /> '''/usr/local/share/pbi-manager/module-examples/convertoldmod.sh''': script which can be used to convert an existing 7.x/8.x PBI module to the new 9.x format.<br /> <br /> === Feedback / Reporting Problems ===<br /> <br /> Feedback, problem reports, and general discussion are welcome on the [http://lists.pcbsd.org/mailman/listinfo/pbi-dev PBI Developers Mailing list]. <br /> <br /> === Command Reference ===<br /> <br /> The following is a list of commands installed by the pbi-manager, along with a small synopsis of each. For more details, please refer to the command's man page.<br /> <br /> ==== pbi_add(1) ====<br /> <br /> Similar to FreeBSD's '''pkg_add''', the '''pbi_add''' command is used for adding/installing PBIs on a system, either from a local file or remotely from a repository. This utility supports the options listed in Table 6.2.4.1: <br /> <br /> '''Table 6.2.4.1: pbi_add Options'''<br /> <br /> {{Tbl-init|width=80%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> &lt;!-- row 1 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-e'''}}<br /> {{Tbl-line|bg=ff|align=left|Extract only, do not install. Will extract the archive to ~/&lt;pbidirname&gt; unless the -o option is used}}<br /> |-<br /> &lt;!-- row 2 --&gt;<br /> {{Tbl-line|align=left|'''-f'''}} <br /> {{Tbl-line|align=left|Force installation, overwriting an already installed copy of the application}}<br /> |- <br /> &lt;!-- row 3 --&gt; <br /> {{Tbl-line|bg=ff|align=left|'''-g'''}} <br /> {{Tbl-line|bg=ff|align=left|Get and show path to icon/images for GUI installations}}<br /> |-<br /> &lt;!-- row 4 --&gt; <br /> {{Tbl-line|bg=ee|align=left|'''-i'''}} <br /> {{Tbl-line|bg=ee|align=left|Display information about specified PBI}}<br /> |-<br /> &lt;!-- row 5 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-l'''}} <br /> {{Tbl-line|bg=ff|align=left|Display LICENSE for specified PBI}}<br /> |-<br /> &lt;!-- row 6 --&gt; <br /> {{Tbl-line|align=left|'''-o outdir'''}} <br /> {{Tbl-line|align=left|Specify the directory to use when extracting the PBI with -e.}}<br /> |-<br /> &lt;!-- row 7 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-r'''}} <br /> {{Tbl-line|bg=ff|align=left|Remote fetch installation file from update server. The system architecture and version will be automatically determined to fetch the correct file.}}<br /> |-<br /> &lt;!-- row 8 --&gt;<br /> {{Tbl-line|align=left|'''-v'''}} <br /> {{Tbl-line|align=left|Enable verbose output}}<br /> |-<br /> &lt;!-- row 9 --&gt; <br /> {{Tbl-line|bg=ff|align=left|'''--checkscript'''}} <br /> {{Tbl-line|bg=ff|align=left|Display any custom scripts used in the installation/removal of this PBI file.}} <br /> |-<br /> &lt;!-- row 10 --&gt; <br /> {{Tbl-line|align=left|'''--licagree'''}} <br /> {{Tbl-line|align=left|Agree to LICENSE terms and conditions. Viewing the license can be done with -l flag}}<br /> |-<br /> &lt;!-- row 11 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''--no-checksig'''}} <br /> {{Tbl-line|bg=ff|align=left|Skip the openssl signature verification of the PBI data}}<br /> |-<br /> &lt;!-- row 12 --&gt;<br /> {{Tbl-line|align=left|'''--no-checksum'''}} <br /> {{Tbl-line|align=left|Skip the checksum verification of the archive data}}<br /> |-<br /> &lt;!-- row 13 --&gt; <br /> {{Tbl-line|bg=ff|align=left|'''--no-hash'''}} <br /> {{Tbl-line|bg=ff|align=left|Disable using shared hash dir which uses hard-links to share files between applications}} <br /> |-<br /> &lt;!-- row 14 --&gt;<br /> {{Tbl-line|align=left|'''--repo repoid'''}}<br /> {{Tbl-line|align=left|Specify which repository to use}}<br /> |-<br /> &lt;!-- row 15 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''--rArch arch'''}}<br /> {{Tbl-line|bg=ff|align=left|Manually specify the PBI architecture type of i386 or amd64}}<br /> |-<br /> &lt;!-- row 16 --&gt;<br /> {{Tbl-line|align=left|'''--rVer version'''}}<br /> {{Tbl-line|align=left|Specify which version of the PBI to install}}<br /> |-<br /> |}<br /> <br /> For security reasons, it is recommend that users first use the -e and --checkscript options to view archive contents and installation scripts prior to installing a PBI file.<br /> <br /> To install a PBI, use: '''pbi_add -r PBINAME'''. The following example will install the alpine PBI:<br /> <br /> '''pbi_add -r alpine'''<br /> Downloading ftp://ftp.pcbsd.org/pub/mirror/PBI/mail/alpine/9/x32/alpine-2.00_3-i386.pbi<br /> /usr/pbi/.alpine-2.00_3-i386.pbi.42391 100% of 11 MB 295 kBps 00m00s<br /> Verifying Checksum...OK<br /> Extracting to: /usr/pbi/alpine-i386<br /> Installed: Alpine-2.00_3<br /> <br /> ==== pbi_addrepo(1) ====<br /> <br /> The '''pbi_addrepo''' command is used to register a new PBI repository on a system. If the '''pbid''' daemon is running, the repository's index and meta files will be automatically fetched and made ready for browsing. The command has one argument, the name of the repository file. Repository files have a .rpo extension and are created with the '''pbi_makerepo''' command.<br /> <br /> ==== pbi_autobuild(1) ====<br /> <br /> The '''pbi_autobuild''' command is used on the PBI build system to build any out-of-date or new packages. The utility is also of interest to PBI testers and system administrators who create and maintain their own internal repository of PBIs. It can traverse the FreeBSD ports and Meta-data trees, building missing PBI files or PBIs in which the target port version has been updated. Table 6.2.4.3 summarizes this command's options:<br /> <br /> '''Table 6.2.4.3: pbi_autobuild Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> &lt;!-- row 1 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-c confdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify the directory containing the PBI configuration modules data to traverse. Any found pbi.conf files will be parsed, and if PBI_MAKEPORT is set, the target port will be used for the build. If PBI_MAKEPORT is unset, the auto-build will attempt to match the module to a FreeBSD port based upon the dirname of pbi.conf}}<br /> |-<br /> {{Tbl-line|align=left|'''-d portsdir'''}}<br /> {{Tbl-line|align=left|Specify an alternative ports-dir; defaults to /usr/ports}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-h script'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify a helper script to call after building a PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''-o outdir'''}}<br /> {{Tbl-line|align=left|The directory to place the finished PBI files. Also used to determine which apps are in need of a rebuild if the associated FreeBSD port has been updated.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--genpatch'''}}<br /> {{Tbl-line|bg=ff|align=left|When building a new PBI, check for archived copies, and generate smaller patch updates to the new version (*.pbp files)}}<br /> |-<br /> {{Tbl-line|align=left|'''--keep num'''}}<br /> {{Tbl-line|align=left|When building new PBIs, keep &lt;num&gt; copies of past versions of working PBI in &lt;outdir&gt;/archived/ folder. These archived copies can be used with the --genpatch command to generate update patch files.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--prune'''}}<br /> {{Tbl-line|bg=ff|align=left|Remove any PBIs which no longer have an associated module in confdir}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|Digitially sign the PBI file with the specified openssl private key file}} <br /> |-<br /> |}<br /> <br /> ==== pbi_browser(1) ====<br /> <br /> The '''pbi_browser''' command provides a CLI front-end to browsing a repository's available PBIs. Options for viewing categories and searching by keyword are available, and once the desired PBI is located, it will show the '''pbi_add''' command which can be used to install the application. Table 6.2.4.4 summarizes the available options.<br /> <br /> '''Table 6.2.4.4: pbi_browser Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-c category'''}}<br /> {{Tbl-line|bg=ff|align=left|Displays a list of PBIs in the specified category}}<br /> |-<br /> {{Tbl-line|align=left|'''-s search'''}}<br /> {{Tbl-line|align=left|Search for PBIs containing the specified string in the name, description, or keywords}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--listcats'''}}<br /> {{Tbl-line|bg=ff|align=left|List the available categories}}<br /> |-<br /> {{Tbl-line|align=left|'''--viewall'''}}<br /> {{Tbl-line|align=left|List all available PBIs}}<br /> |-<br /> |}<br /> <br /> ====pbi.conf(5)====<br /> <br /> pbi.conf is an ASCII text configuration file containing values that are used by the various '''pbi_*''' commands. Table 6.2.4.5 lists the supported variables.<br /> <br /> '''Table 6.2.4.5: pbi_conf Variables'''<br /> <br /> {{Tbl-init|width=75%}}<br /> {{Tbl-title|width=20%|'''Switch'''}}<br /> {{Tbl-title|width=80%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_INDEXREFRESH'''}}<br /> {{Tbl-line|bg=ff|align=left|Number of hours. How often pbid refreshes the index/meta files from repos. Default is every 24 hours.}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROXYPASS'''}}<br /> {{Tbl-line|align=left|Password used to authenticate with proxy server.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROXYPORT'''}}<br /> {{Tbl-line|bg=ff|align=left|Proxy server port number.}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROXYTYPE'''}}<br /> {{Tbl-line|align=left|Can be HTTP or SOCKS5.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROXYURL'''}}<br /> {{Tbl-line|bg=ff|align=left|Proxy server IP address.}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROXYUSER'''}}<br /> {{Tbl-line|align=left|Username used to authenticate with proxy server.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBID_REFRESH'''}}<br /> {{Tbl-line|bg=ff|align=left|Wakeup time in seconds for pbid to run its checks.}}<br /> |-<br /> |}<br /> <br /> ==== pbi_create(1) ====<br /> <br /> The '''pbi_create''' command provides a way for packagers to manually specify a target directory to be compressed into a PBI file. The option '''-b''' can also be used to re-package an already installed PBI back to an archive. This command replaces the 8.x PBI Module Builder functionality. PBI creators are encouraged to send a tarball of the resulting PBI module to the [http://lists.pcbsd.org/mailman/listinfo/pbi-dev PBI-testing mailing list] so they can be added to the PC-BSD PBI repository and made available to other PC-BSD users.<br /> <br /> Table 6.2.4.6 summarizes the available options:<br /> <br /> '''Table 6.2.4.6: pbi_create Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-a author'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify the author for this PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''-b'''}} <br /> {{Tbl-line|align=left|Make a backup of an installed PBI. When using this option specify the target PBI name instead of [pbidir]}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-c confdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify the meta-data confdir to use. While not required for building a PBI, it is highly recommended. Without some configuration settings in the meta-data, icons and binary entry-points will not be created.}}<br /> |-<br /> {{Tbl-line|align=left|'''-d portsdir'''}}<br /> {{Tbl-line|align=left|Specify an alternative ports-dir, defaults to /usr/ports}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-i icon'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify a default icon for this PBI, relative to pbidir/}}<br /> |-<br /> {{Tbl-line|align=left|'''-n name'''}}<br /> {{Tbl-line|align=left|Specify a name for this PBI}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-o outdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Place the finished .pbi file into the specified directory. Defaults to $HOME/}}<br /> |-<br /> {{Tbl-line|align=left|'''-p port'''}}<br /> {{Tbl-line|align=left|Use the given port to get PBI name / version from}}<br /> |- <br /> {{Tbl-line|bg=ff|align=left|'''-r version'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify a version for this PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''-u weburl'''}}<br /> {{Tbl-line|align=left|Specify a website URL for the PBI}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--no-hash'''}}<br /> {{Tbl-line|bg=ff|align=left|Disable using the shared-hash dir which uses hard-links to share files between applications}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|Digitially sign the PBI file with the specified openssl private key file}}<br /> |-<br /> |}<br /> <br /> ==== pbi_delete(1) ====<br /> <br /> Similar to FreeBSD's '''pkg_delete''', the '''pbi_delete''' command removes an installed PBI from the system. It also schedules cleaning for the shared library directory, which is performed by '''pbid'''. Table 6.2.4.7 summarizes its options:<br /> <br /> '''Table 6.2.4.7: pbi_delete Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-v'''}} <br /> {{Tbl-line|bg=ff|align=left|Enable verbose output}}<br /> |-<br /> {{Tbl-line|align=left|'''--clean-hdir'''}}<br /> {{Tbl-line|align=left|Perform a full cleaning of the shared-hash dir, removing any unused files. This should only need to be done after a system crash or failure in removing a PBI via normal methods.}}<br /> |-<br /> |}<br /> <br /> When removing a PBI, you must give its full name. The full name can be found in the output of '''pbi_info'''. The following example searches for the emacs PBI and removes it:<br /> <br /> '''pbi_info | grep ntop'''<br /> ntop-4.0.1_1-i386<br /> '''pbi_delete -v ntop-4.0.1_1-i386'''<br /> Running pre-removal script: /var/db/pbi/installed/ntop-4.0.1_1-i386/pre-remove.sh<br /> Removing: /usr/pbi/ntop-i386<br /> Removing: /var/db/pbi/installed/ntop-4.0.1_1-i386<br /> <br /> ==== pbi_deleterepo(1) ====<br /> <br /> The '''pbi_deleterepo''' command can be used to remove a registered repository from the system. It takes the repository's ID as the only command argument.<br /> <br /> ==== pbi_icon(1) ====<br /> <br /> 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 [http://en.wikipedia.org/wiki/Xdg XDG]-compliant to understand a PBI's icon and mime settings. Table 6.2.4.9 summarizes this command's options:<br /> <br /> '''Table 6.2.4.9: pbi_icon Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add-desktop'''}}<br /> {{Tbl-line|bg=ff|align=left|Installs any XDG compliant desktop icons, should be run as user.}}<br /> |-<br /> {{Tbl-line|align=left|'''add-menu'''}}<br /> {{Tbl-line|align=left|Installs any XDG compliant menu icons, should be run as root.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add-mime'''}}<br /> {{Tbl-line|bg=ff|align=left|Installs any XDG compliant mime information, should be run as root.}}<br /> |-<br /> {{Tbl-line|align=left|'''add-pathlnk'''}}<br /> {{Tbl-line|align=left|Installs any PATH links to ~/bin as user or to LOCALBASE as root.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''del-desktop'''}}<br /> {{Tbl-line|bg=ff|align=left|Removes any XDG compliant desktop icons, should be run as user.}}<br /> |-<br /> {{Tbl-line|align=left|'''del-menu'''}}<br /> {{Tbl-line|align=left|Removes any XDG compliant menu icons, should be run as root.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''del-mime'''}}<br /> {{Tbl-line|bg=ff|align=left|Removes any XDG compliant menu icons, should be run as root.}}<br /> |-<br /> {{Tbl-line|align=left|'''del-pathlnk'''}}<br /> {{Tbl-line|align=left|Removes any any PATH links to ~/bin as user or to LOCALBASE as root}}<br /> |-<br /> |}<br /> <br /> ==== pbi_indextool(1) ====<br /> <br /> The '''pbi_indextool''' command is useful for repository maintainers. It allows the adding/removing of PBI files available in a particular repository INDEX file without needing to hand-edit the file. Table 6.2.4.10 summarizes the available options:<br /> <br /> '''Table 6.2.4.10: pbi_indextool Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add'''}}<br /> {{Tbl-line|bg=ff|align=left|Adds a PBI to the target INDEX file}}<br /> |-<br /> {{Tbl-line|align=left|'''rem'''}}<br /> {{Tbl-line|align=left|Removes a PBI from the target INDEX file}}<br /> |-<br /> |}<br /> <br /> Run the command with the desired option to receive detailed usage.<br /> <br /> ==== pbi_info(1) ====<br /> <br /> Similar to FreeBSD's '''pkg_info''' command, the '''pbi_info''' command is used to determine which PBIs are currently installed. Table 6.2.4.11 summarizes the available options:<br /> <br /> '''Table 6.2.4.11: pbi_info Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-a'''}} <br /> {{Tbl-line|bg=ff|align=left|List all PBIs installed on the system, same as running pbi_info without an argument.}}<br /> |-<br /> {{Tbl-line|align=left|'''-i'''}}<br /> {{Tbl-line|align=left|List all available PBIs from any repo}} <br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-v'''}} <br /> {{Tbl-line|bg=ff|align=left|Enable verbose output}}<br /> |-<br /> |}<br /> <br /> ==== pbi_listrepo(1) ====<br /> <br /> The '''pbi_listrepo''' command manages installed repositories on a system. Table 6.2.4.12 summarizes this command's options:<br /> <br /> '''Table 6.2.4.12: pbi_listrepo Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--down'''}}<br /> {{Tbl-line|bg=ff|align=left|Move the targeted repoid down a single number in priority}}<br /> |-<br /> {{Tbl-line|align=left|'''-mirror URL'''}}<br /> {{Tbl-line|align=left|Change the specified repoid's mirror URL}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--up'''}}<br /> {{Tbl-line|bg=ff|align=left|Move the targeted repoid up a single number in priority}}<br /> |-<br /> |}<br /> <br /> Run the command without any options to list the IDs of the available repositories.<br /> <br /> ==== pbi_makepatch(1) ====<br /> <br /> The '''pbi_makepatch''' command is automatically used by '''pbi_autobuild''' to create small *.pbp (Push Button Patch) files. These files can be downloaded to a user's system and used to update a PBI's version without re-downloading the entire archive. This allows users to download only the incremental changes when a PBI is upgraded. The command can also be run manually by providing two PBI archives to compare and generate a patch file for.<br /> <br /> Table 6.2.4.13 summarizes the available options:<br /> <br /> '''Table 6.2.4.13: pbi_makepatch Options<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-o outdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Save the resulting .PBP file to the specified directory}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|Use the specified openssl key to digitally sign the patch file}}<br /> |-<br /> |}<br /> <br /> ==== pbi_makeport(1) ====<br /> <br /> The '''pbi_makeport''' command can be used by packagers to build a target FreeBSD port and convert it into a PBI file. Many options are provided to fine-tune the build process, and meta-data modules can also be specified to further improve the resulting PBI file. The first time this command is run, it will build a fresh chroot sandbox environment which can be used for clean-room building of the target port without affecting the host system. PBI creators are encouraged to send a tarball of the resulting PBI module to the [http://lists.pcbsd.org/mailman/listinfo/pbi-dev PBI-testing mailing list] so they can be added to the PC-BSD PBI repository and made available to other PC-BSD users.<br /> <br /> Table 6.2.4.14 summarizes the available options:<br /> <br /> '''Table 6.2.4.14: pbi_makeport Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-B'''}} <br /> {{Tbl-line|bg=ff|align=left|Build-only, after the port make process has finished, do not generate the PBI file. Generally used with -k to build a port before running pbi_create manually.}}<br /> |-<br /> {{Tbl-line|align=left|'''-c confdir'''}}<br /> {{Tbl-line|align=left|Specify the meta-data confdir to use. While not required for building a PBI, it is highly recommended. Without some configuration settings in the meta-data, icons and binary entry-points will not be created.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-d portsdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify an alternative ports-dir, defaults to /usr/ports}}<br /> |-<br /> {{Tbl-line|align=left|'''-k'''}} <br /> {{Tbl-line|align=left|Keep the build files after a success or failure compiling/building the PBI}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-o outdir'''}}<br /> {{Tbl-line|bg=ff|align=left|The directory to place the finished PBI file, defaults to user's $HOME directory}}<br /> |-<br /> {{Tbl-line|align=left|'''-p prefix'''}}<br /> {{Tbl-line|align=left|Manually provide a PREFIX, which determines the location where the PBI will end up being installed on the end-user's system.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--delbuild'''}}<br /> {{Tbl-line|bg=ff|align=left|Remove any existing build dirs before starting the build}}<br /> |-<br /> {{Tbl-line|align=left|'''--mkdebug'''}}<br /> {{Tbl-line|align=left|Will drop to a debugging shell should the port make fail}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--no-prune'''}}<br /> {{Tbl-line|bg=ff|align=left|Disable auto-pruning of non REQUIREDBY ports after the compile phase. By default any ports which are used solely for building and which are not required for program execution will be pruned.}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|Digitially sign the PBI file with the specified openssl private key file}}<br /> |-<br /> |}<br /> <br /> ==== pbi_makerepo(1) ====<br /> <br /> The '''pbi_makerepo''' command allows repository maintainers to create a single *.rpo file containing various information about the new repository. This .rpo file can then be installed on the target system with '''pbi_addrepo'''. Table 6.2.4.15 summarizes the available options.<br /> <br /> '''Table 6.2.4.15: pbi_makerepo Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--desc description'''}}<br /> {{Tbl-line|bg=ff|align=left|Required. Description of the repo to be shown in the repo list}}<br /> |-<br /> {{Tbl-line|align=left|'''--key keyfile'''}}<br /> {{Tbl-line|align=left|Required. OpenSSL public key used to verify the digital signature of PBIs installed from this repo}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--mirror URL'''}}<br /> {{Tbl-line|bg=ff|align=left|Required. The URL to download PBIs and updates from}}<br /> |-<br /> {{Tbl-line|align=left|'''--url URL'''}}<br /> {{Tbl-line|align=left|Required. The URL to use when downloading the master INDEX files of available PBIs}}<br /> |-<br /> |}<br /> <br /> ==== pbi_metatool(1) ====<br /> <br /> The '''pbi_metatool''' command provides a way for repository maintainers to modify the PBI meta-data in their repository in order to add or remove application categories or specified PBIs. This meta-data may contain information such as Name, Description, Icon, Keywords, License and more for the respective PBI file. Table 6.2.4.16 summarizes the available options:<br /> <br /> '''Table 6.2.4.16: pbi_metatool Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add'''}}<br /> {{Tbl-line|bg=ff|align=left|Adds a category or application to the target metafile}}<br /> |-<br /> {{Tbl-line|align=left|'''rem'''}}<br /> {{Tbl-line|align=left|Remove a category or application to the target metafile}}<br /> |-<br /> |}<br /> <br /> Run the command with the desired option to receive detailed usage.<br /> <br /> ==== pbi_patch(1) ====<br /> <br /> The '''pbi_patch''' command is used to update an installed PBI to a different version using the small diff Push Button Patch *.pbp file. This allows the user to perform an incremental upgrade of an installed PBI. The available options are summarized in Table 6.2.4.17.<br /> <br /> '''Table 6.2.4.17: pbi_patch Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-e'''}} <br /> {{Tbl-line|bg=ff|align=left|Extract only, do not install. Will extract the archive to ~/&lt;pbidirname&gt; unless the -o option is used.}}<br /> |-<br /> {{Tbl-line|align=left|'''-g'''}} <br /> {{Tbl-line|align=left|Extract image data from header, commonly used for GUI installations}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-i'''}} <br /> {{Tbl-line|bg=ff|align=left|Display information about this PBI file}}<br /> |-<br /> {{Tbl-line|align=left|'''-o outdir'''}}<br /> {{Tbl-line|align=left|Specify the directory to use when only extracting the PBI with -e.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--checkscript'''}}<br /> {{Tbl-line|bg=ff|align=left|Display any custom scripts used in the installation / removal of this PBI file. Recommended that these be checked if the PBI file is suspect in any way.}}<br /> |-<br /> {{Tbl-line|align=left|'''--no-checksig'''}}<br /> {{Tbl-line|align=left|Skip the openssl signature verification of the PBI data}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--no-hash'''}}<br /> {{Tbl-line|bg=ff|align=left|Disable using the shared-hash dir, which uses hard-links to share files between applications}}<br /> |-<br /> |}<br /> <br /> ==== pbi_update(1) ====<br /> <br /> The '''pbi_update''' command is used to display information about which PBIs have available updates from their repository and to perform the updates. Table 6.2.4.18 summarizes the available options.<br /> <br /> '''Table 6.2.4.18: pbi_update Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-c'''}} <br /> {{Tbl-line|bg=ff|align=left|Check-only the specified PBI for available updates.}}<br /> |-<br /> {{Tbl-line|align=left|'''--check-all'''}}<br /> {{Tbl-line|align=left|Run a full check of all installed PBIs and display list of available updates.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-disable-auto'''}}<br /> {{Tbl-line|bg=ff|align=left|Disable auto-updating of the target PBI.}}<br /> |-<br /> {{Tbl-line|align=left|'''--enable-auto'''}}<br /> {{Tbl-line|align=left|Enable auto-updating of the target PBI.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--update-all'''}}<br /> {{Tbl-line|bg=ff|align=left|Update all installed PBIs to the latest versions available.}}<br /> |-<br /> |}<br /> <br /> ====pbi_update_hashdir(1)====<br /> <br /> The '''pbi_update_hashdir''' command is used by the '''pbid''' daemon to merge the contents of a PBI into the hashdir.<br /> <br /> ==== pbid(8) ====<br /> <br /> The '''pbid''' command runs a small daemon which performs maintenance of installed PBIs, merges files into the shared hashdir, fetches the repository INDEX and meta files, and makes the adding and removing of PBIs much faster. It will automatically be started from the /usr/local/etc/rc.d/pbid startup script if pbid_enable=&quot;YES&quot; is in the /etc/rc.conf file.<br /> <br /> This utility supports the option summarized in table 6.2.4.19:<br /> <br /> '''Table 6.2.4.19: pbid Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-v'''}}<br /> {{Tbl-line|bg=ff|align=left|Enable verbose output when the daemon starts}}<br /> |-<br /> |}<br /> <br /> This command logs its output to /var/log/pbid.log. Check this log for errors should you experience any problems with PBI maintenance.</div>

Krismoore http://wiki.pcbsd.org/index.php/PBI_Manager 2011-11-03T17:27:50Z

<p>Krismoore: /* Release History */</p> <hr /> <div>{{NavHeader|back=Using AppCafe™|forward=Update Manager}}<br /> PC-BSD 9.0 introduced PBI Manager, a suite of command line utilities for managing PBIs. PBI Manager's command-line tools can be used to install, remove, create and manage PBIs. It is also available for [[#Installing_PBI_Manager|FreeBSD systems]]. The PBI Manager is released under the [http://www.freebsd.org/copyright/freebsd-license.html BSD license].<br /> <br /> <br /> ===New Features===<br /> <br /> The new PBI format introduces the following features:<br /> <br /> * '''Upgrade deltas:''' since PBIs are self-contained, installation files tend to be large. In the previous implementation, updating a PBI required the re-downloading of the entire installation archive. For larger applications this could be a time-consuming process, especially over low bandwidth connections. The new PBI specification performs updates using binary diff patches known as PBP (Push Button Patch) files. PBPs are a fraction of the PBI's size; in some cases less than 5% of the original PBI archive. An upgrade automatically checks for for the presence of a PBP file and attempts to use it, only falling back to the original archive should the process fail.<br /> <br /> * '''Library and file sharing:''' in the previous implementation of the PBI format it was common that identical files existed between various applications. These duplicates, while necessary to provide self-contained functionality, wasted both disk and runtime memory. This waste of space has been greatly reduced through the use of a hash-dir directory where libraries and common files are shared through a system of hard links. When an identical file is found in a PBI, the original will be removed and a hard-link stored in the hash-dir. After a PBI has been removed, any unneeded files left in the hash-dir are cleaned up by the pbid(8) daemon which monitors and maintains the integrity of the shared files.<br /> <br /> * '''Repository management:''' allows administrators and PBI builders to create and manage their own repositories of PBIs. This repository system provides a number of tools for PBI distribution, release management, and repository browsing. <br /> <br /> * '''Digitally signed PBIs:''' each repository includes an openssl public key file which is installed on the end user's system. Each PBI includes several signatures for the content archive and installation and removal scripts. During the PBI installation process, these signatures are checked to confirm that the archive has not been tampered with during transit. This key file is also used to associate a particular PBI with a parent repository for upgrade purposes, since it is possible that multiple repositories will have the same applications.<br /> <br /> * '''Root password not required:''' most applications can be installed and upgraded by user (non-root) accounts. This allows enhanced security in office or home situations, where users can now add/remove desktop applications without needing access to the root account. PBIs that impact on the security of the system (e.g. installing a web server) will require root access.<br /> <br /> * '''Implementation:''' the previous PBI design was developed in QT/KDE C++, making it inappropriate for use at the command line. The new format is implemented 100% in shell and is comprised of command-line utilities, each with an associated man page. These utilities are discussed in more detail in the rest of this section.<br /> <br /> '''Additional Resources:'''<br /> <br /> [http://www.pcbsd.org/~kris/pbi9-slides.pdf The PBI Format Re-implemented for Free/PC-BSD (conference slides)]<br /> <br /> [http://www.pcbsd.org/~kris/asiabsdcon2011-pbi9.pdf The PBI Format Re-implemented for Free/PC-BSD (formal paper)]<br /> <br /> [[PBI9 Format|The PBI Format for 9.0 and Beyond]]<br /> <br /> === Release History ===<br /> * '''0.9.5''' (11-03-11)<br /> - Add sizes of PBIs to the meta index files<br /> <br /> - Fix bug adding default icon to PBIs when none is specified<br /> <br /> - Fix handling of PBI_PROGREVISION<br /> <br /> - Make sure we unmount nullfs mounts completely<br /> <br /> <br /> * '''0.9.4''' (10-19-11)<br /> - Fix issue using system-fonts in PBIs<br /> <br /> - Fix issue removing files which have been set r--<br /> <br /> - Slow down fetch process to fix issues with fetch protocol errors<br /> <br /> - Fix bug coping linux libraries into final PBI file<br /> <br /> - Allow user settings in external-links to overwrite auto-detected values<br /> <br /> - Fix bug running &quot;stat&quot; on files with spaces in name<br /> <br /> - Validate the build checksum before doing patching<br /> <br /> - Speed up builds with optional --tmpfs flags<br /> <br /> - Add priority system to building modules<br /> <br /> - Fix issues setting proxy support from pbi.conf / pcbsd.conf files<br /> <br /> - Validate repo URL's when creating .rpo file<br /> <br /> <br /> * '''0.9.3''' (07-18-11)<br /> - Unset variables between auto-builds<br /> <br /> - Fixed some warnings with 'cut' when parsing i18n strings<br /> <br /> - When doing auto-builds, run through alphabetically<br /> <br /> - Increase check frequency when first trying to download index's<br /> <br /> - Speed up the hashdir merging<br /> <br /> - Show repo MD5 with listings<br /> <br /> - If no index files, do not fail on listing, just show empty repo<br /> <br /> <br /> * '''0.9.2''' (05-23-11)<br /> - Fixed usage errors with &quot;tr&quot;<br /> <br /> - Syntax fixes when trying to install app with no meta-data<br /> <br /> - Fixed some bugs with binary patching<br /> <br /> - Fixed auto-builder using the PBI_BUILDKEY in modules pbi.conf file<br /> <br /> - When building ports, don't export PREFIX since it confuses some linux ports<br /> <br /> - Perform check if user is root, if PBI is flagged root-only<br /> <br /> - Auto-builder now checks if port is compatible with arch type of system<br /> <br /> <br /> * '''0.9.1''' - Initial public release (05/3/11)<br /> <br /> === What is the PBI format? ===<br /> <br /> The idea behind the PBI format is that one of the things holding back mainstream adoption of open source desktops is the package management format. With almost all open source desktops, software is simply treated as part of the operating system. Thus, when performing an update of some seemingly trivial application, you run the risk of potentially needing to upgrade other packages which could break other critical parts of your desktop. <br /> <br /> While package management systems have gotten better at resolving these dependency issues, trying to fix conflicts and prevent breakage before it occurs, they still don't address the underlying problem: every software package is a part of the system, and pulling on any one thread has the potential of causing a break somewhere farther down the line.<br /> <br /> The PBI format tries to correct this underlying flaw. Rather than making every application a part of the base system, PBIs are self-contained, including their own dependent library tree and related data. As a result, when you install a PBI there are no dependency issues to resolve, and applications can be added or removed freely, without fear of causing breakage to the desktop or any other installed software.<br /> <br /> === Installing PBI Manager ===<br /> <br /> If you are running PC-BSD 9 or higher, then the PBI Manager is already installed, and you can use it via the command-line, or a front-end such as the AppCafe™. <br /> <br /> FreeBSD users can install it from the [http://www.freshports.org/ports-mgmt/pbi-manager ports tree]. <br /> <br /> <br /> Users interested in installing the development version from our [http://trac.pcbsd.org/brower/pcbsd/current/src-sh/pbi-manager/ SVN repository] can do so with the following commands:<br /> <br /> '''svn co &lt;nowiki&gt;svn://svn.pcbsd.org/pcbsd/current/src-sh/pbi-manager&lt;/nowiki&gt;'''<br /> '''cd pbi-manager'''<br /> '''make install'''<br /> <br /> '''NOTE: The development version may be unstable / buggy, use at your own risk'''<br /> <br /> === Getting PBI Files ===<br /> <br /> The PC-BSD project has begun building PBIs which work with PBI Manager for FreeBSD/PC-BSD 9. A list of approved &amp; available PBIs can be viewed with '''pbi_info -i''' or '''pbi_browser''', and then installed with '''pbi_add -r &lt;pbiname&gt;'''. Until 9.0 is released the number of available PBIs will remain small but may be downloaded directly from the build server:<br /> <br /> [http://pbibuild.pcbsd.org/index.php?ver=9 9.x i386 PBIs]<br /> <br /> [http://pbibuild64.pcbsd.org/index.php?ver=9 9.x amd64 PBIs]<br /> <br /> '''NOTE:''' PBI files previously created for PC-BSD 7.x/8.x will NOT work with PBI Manager, these are specific to PC-BSD 7/8.<br /> <br /> ===Underlying File / Directory Structure===<br /> <br /> <br /> The underlying files / directories used by PBI Manager are as follows:<br /> <br /> '''/usr/local/etc/pbi.conf''': location of the PBI Manager configuration file <br /> <br /> '''/usr/pbi/''': where PBIs are installed on the system<br /> <br /> '''/var/db/pbi/''': contains data files related to installed PBIs and repositories <br /> <br /> '''/usr/local/sbin/pbi_*''': location of the PBI Manager commands<br /> <br /> '''/usr/local/share/pbi-manager/module-examples/convertoldmod.sh''': script which can be used to convert an existing 7.x/8.x PBI module to the new 9.x format.<br /> <br /> === Feedback / Reporting Problems ===<br /> <br /> Feedback, problem reports, and general discussion are welcome on the [http://lists.pcbsd.org/mailman/listinfo/pbi-dev PBI Developers Mailing list]. <br /> <br /> === Command Reference ===<br /> <br /> The following is a list of commands installed by the pbi-manager, along with a small synopsis of each. For more details, please refer to the command's man page.<br /> <br /> ==== pbi_add(1) ====<br /> <br /> Similar to FreeBSD's '''pkg_add''', the '''pbi_add''' command is used for adding/installing PBIs on a system, either from a local file or remotely from a repository. This utility supports the options listed in Table 6.2.4.1: <br /> <br /> '''Table 6.2.4.1: pbi_add Options'''<br /> <br /> {{Tbl-init|width=80%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> &lt;!-- row 1 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-e'''}}<br /> {{Tbl-line|bg=ff|align=left|Extract only, do not install. Will extract the archive to ~/&lt;pbidirname&gt; unless the -o option is used}}<br /> |-<br /> &lt;!-- row 2 --&gt;<br /> {{Tbl-line|align=left|'''-f'''}} <br /> {{Tbl-line|align=left|Force installation, overwriting an already installed copy of the application}}<br /> |- <br /> &lt;!-- row 3 --&gt; <br /> {{Tbl-line|bg=ff|align=left|'''-g'''}} <br /> {{Tbl-line|bg=ff|align=left|Get and show path to icon/images for GUI installations}}<br /> |-<br /> &lt;!-- row 4 --&gt; <br /> {{Tbl-line|bg=ee|align=left|'''-i'''}} <br /> {{Tbl-line|bg=ee|align=left|Display information about specified PBI}}<br /> |-<br /> &lt;!-- row 5 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-l'''}} <br /> {{Tbl-line|bg=ff|align=left|Display LICENSE for specified PBI}}<br /> |-<br /> &lt;!-- row 6 --&gt; <br /> {{Tbl-line|align=left|'''-o outdir'''}} <br /> {{Tbl-line|align=left|Specify the directory to use when extracting the PBI with -e.}}<br /> |-<br /> &lt;!-- row 7 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-r'''}} <br /> {{Tbl-line|bg=ff|align=left|Remote fetch installation file from update server. The system architecture and version will be automatically determined to fetch the correct file.}}<br /> |-<br /> &lt;!-- row 8 --&gt;<br /> {{Tbl-line|align=left|'''-v'''}} <br /> {{Tbl-line|align=left|Enable verbose output}}<br /> |-<br /> &lt;!-- row 9 --&gt; <br /> {{Tbl-line|bg=ff|align=left|'''--checkscript'''}} <br /> {{Tbl-line|bg=ff|align=left|Display any custom scripts used in the installation/removal of this PBI file.}} <br /> |-<br /> &lt;!-- row 10 --&gt; <br /> {{Tbl-line|align=left|'''--licagree'''}} <br /> {{Tbl-line|align=left|Agree to LICENSE terms and conditions. Viewing the license can be done with -l flag}}<br /> |-<br /> &lt;!-- row 11 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''--no-checksig'''}} <br /> {{Tbl-line|bg=ff|align=left|Skip the openssl signature verification of the PBI data}}<br /> |-<br /> &lt;!-- row 12 --&gt;<br /> {{Tbl-line|align=left|'''--no-checksum'''}} <br /> {{Tbl-line|align=left|Skip the checksum verification of the archive data}}<br /> |-<br /> &lt;!-- row 13 --&gt; <br /> {{Tbl-line|bg=ff|align=left|'''--no-hash'''}} <br /> {{Tbl-line|bg=ff|align=left|Disable using shared hash dir which uses hard-links to share files between applications}} <br /> |-<br /> &lt;!-- row 14 --&gt;<br /> {{Tbl-line|align=left|'''--repo repoid'''}}<br /> {{Tbl-line|align=left|Specify which repository to use}}<br /> |-<br /> &lt;!-- row 15 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''--rArch arch'''}}<br /> {{Tbl-line|bg=ff|align=left|Manually specify the PBI architecture type of i386 or amd64}}<br /> |-<br /> &lt;!-- row 16 --&gt;<br /> {{Tbl-line|align=left|'''--rVer version'''}}<br /> {{Tbl-line|align=left|Specify which version of the PBI to install}}<br /> |-<br /> |}<br /> <br /> For security reasons, it is recommend that users first use the -e and --checkscript options to view archive contents and installation scripts prior to installing a PBI file.<br /> <br /> To install a PBI, use: '''pbi_add -r PBINAME'''. The following example will install the alpine PBI:<br /> <br /> '''pbi_add -r alpine'''<br /> Downloading ftp://ftp.pcbsd.org/pub/mirror/PBI/mail/alpine/9/x32/alpine-2.00_3-i386.pbi<br /> /usr/pbi/.alpine-2.00_3-i386.pbi.42391 100% of 11 MB 295 kBps 00m00s<br /> Verifying Checksum...OK<br /> Extracting to: /usr/pbi/alpine-i386<br /> Installed: Alpine-2.00_3<br /> <br /> ==== pbi_addrepo(1) ====<br /> <br /> The '''pbi_addrepo''' command is used to register a new PBI repository on a system. If the '''pbid''' daemon is running, the repository's index and meta files will be automatically fetched and made ready for browsing. The command has one argument, the name of the repository file. Repository files have a .rpo extension and are created with the '''pbi_makerepo''' command.<br /> <br /> ==== pbi_autobuild(1) ====<br /> <br /> The '''pbi_autobuild''' command is used on the PBI build system to build any out-of-date or new packages. The utility is also of interest to PBI testers and system administrators who create and maintain their own internal repository of PBIs. It can traverse the FreeBSD ports and Meta-data trees, building missing PBI files or PBIs in which the target port version has been updated. Table 6.2.4.3 summarizes this command's options:<br /> <br /> '''Table 6.2.4.3: pbi_autobuild Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> &lt;!-- row 1 --&gt;<br /> {{Tbl-line|bg=ff|align=left|'''-c confdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify the directory containing the PBI configuration modules data to traverse. Any found pbi.conf files will be parsed, and if PBI_MAKEPORT is set, the target port will be used for the build. If PBI_MAKEPORT is unset, the auto-build will attempt to match the module to a FreeBSD port based upon the dirname of pbi.conf}}<br /> |-<br /> {{Tbl-line|align=left|'''-d portsdir'''}}<br /> {{Tbl-line|align=left|Specify an alternative ports-dir; defaults to /usr/ports}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-h script'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify a helper script to call after building a PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''-o outdir'''}}<br /> {{Tbl-line|align=left|The directory to place the finished PBI files. Also used to determine which apps are in need of a rebuild if the associated FreeBSD port has been updated.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--genpatch'''}}<br /> {{Tbl-line|bg=ff|align=left|When building a new PBI, check for archived copies, and generate smaller patch updates to the new version (*.pbp files)}}<br /> |-<br /> {{Tbl-line|align=left|'''--keep num'''}}<br /> {{Tbl-line|align=left|When building new PBIs, keep &lt;num&gt; copies of past versions of working PBI in &lt;outdir&gt;/archived/ folder. These archived copies can be used with the --genpatch command to generate update patch files.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--prune'''}}<br /> {{Tbl-line|bg=ff|align=left|Remove any PBIs which no longer have an associated module in confdir}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|Digitially sign the PBI file with the specified openssl private key file}} <br /> |-<br /> |}<br /> <br /> ==== pbi_browser(1) ====<br /> <br /> The '''pbi_browser''' command provides a CLI front-end to browsing a repository's available PBIs. Options for viewing categories and searching by keyword are available, and once the desired PBI is located, it will show the '''pbi_add''' command which can be used to install the application. Table 6.2.4.4 summarizes the available options.<br /> <br /> '''Table 6.2.4.4: pbi_browser Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-c category'''}}<br /> {{Tbl-line|bg=ff|align=left|Displays a list of PBIs in the specified category}}<br /> |-<br /> {{Tbl-line|align=left|'''-s search'''}}<br /> {{Tbl-line|align=left|Search for PBIs containing the specified string in the name, description, or keywords}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--listcats'''}}<br /> {{Tbl-line|bg=ff|align=left|List the available categories}}<br /> |-<br /> {{Tbl-line|align=left|'''--viewall'''}}<br /> {{Tbl-line|align=left|List all available PBIs}}<br /> |-<br /> |}<br /> <br /> ====pbi.conf(5)====<br /> <br /> pbi.conf is an ASCII text configuration file containing values that are used by the various '''pbi_*''' commands. Table 6.2.4.5 lists the supported variables.<br /> <br /> '''Table 6.2.4.5: pbi_conf Variables'''<br /> <br /> {{Tbl-init|width=75%}}<br /> {{Tbl-title|width=20%|'''Switch'''}}<br /> {{Tbl-title|width=80%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_INDEXREFRESH'''}}<br /> {{Tbl-line|bg=ff|align=left|Number of hours. How often pbid refreshes the index/meta files from repos. Default is every 24 hours.}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROXYPASS'''}}<br /> {{Tbl-line|align=left|Password used to authenticate with proxy server.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROXYPORT'''}}<br /> {{Tbl-line|bg=ff|align=left|Proxy server port number.}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROXYTYPE'''}}<br /> {{Tbl-line|align=left|Can be HTTP or SOCKS5.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBI_PROXYURL'''}}<br /> {{Tbl-line|bg=ff|align=left|Proxy server IP address.}}<br /> |-<br /> {{Tbl-line|align=left|'''PBI_PROXYUSER'''}}<br /> {{Tbl-line|align=left|Username used to authenticate with proxy server.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''PBID_REFRESH'''}}<br /> {{Tbl-line|bg=ff|align=left|Wakeup time in seconds for pbid to run its checks.}}<br /> |-<br /> |}<br /> <br /> ==== pbi_create(1) ====<br /> <br /> The '''pbi_create''' command provides a way for packagers to manually specify a target directory to be compressed into a PBI file. The option '''-b''' can also be used to re-package an already installed PBI back to an archive. This command replaces the 8.x PBI Module Builder functionality. PBI creators are encouraged to send a tarball of the resulting PBI module to the [http://lists.pcbsd.org/mailman/listinfo/pbi-dev PBI-testing mailing list] so they can be added to the PC-BSD PBI repository and made available to other PC-BSD users.<br /> <br /> Table 6.2.4.6 summarizes the available options:<br /> <br /> '''Table 6.2.4.6: pbi_create Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-a author'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify the author for this PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''-b'''}} <br /> {{Tbl-line|align=left|Make a backup of an installed PBI. When using this option specify the target PBI name instead of [pbidir]}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-c confdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify the meta-data confdir to use. While not required for building a PBI, it is highly recommended. Without some configuration settings in the meta-data, icons and binary entry-points will not be created.}}<br /> |-<br /> {{Tbl-line|align=left|'''-d portsdir'''}}<br /> {{Tbl-line|align=left|Specify an alternative ports-dir, defaults to /usr/ports}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-i icon'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify a default icon for this PBI, relative to pbidir/}}<br /> |-<br /> {{Tbl-line|align=left|'''-n name'''}}<br /> {{Tbl-line|align=left|Specify a name for this PBI}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-o outdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Place the finished .pbi file into the specified directory. Defaults to $HOME/}}<br /> |-<br /> {{Tbl-line|align=left|'''-p port'''}}<br /> {{Tbl-line|align=left|Use the given port to get PBI name / version from}}<br /> |- <br /> {{Tbl-line|bg=ff|align=left|'''-r version'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify a version for this PBI}}<br /> |-<br /> {{Tbl-line|align=left|'''-u weburl'''}}<br /> {{Tbl-line|align=left|Specify a website URL for the PBI}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--no-hash'''}}<br /> {{Tbl-line|bg=ff|align=left|Disable using the shared-hash dir which uses hard-links to share files between applications}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|Digitially sign the PBI file with the specified openssl private key file}}<br /> |-<br /> |}<br /> <br /> ==== pbi_delete(1) ====<br /> <br /> Similar to FreeBSD's '''pkg_delete''', the '''pbi_delete''' command removes an installed PBI from the system. It also schedules cleaning for the shared library directory, which is performed by '''pbid'''. Table 6.2.4.7 summarizes its options:<br /> <br /> '''Table 6.2.4.7: pbi_delete Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-v'''}} <br /> {{Tbl-line|bg=ff|align=left|Enable verbose output}}<br /> |-<br /> {{Tbl-line|align=left|'''--clean-hdir'''}}<br /> {{Tbl-line|align=left|Perform a full cleaning of the shared-hash dir, removing any unused files. This should only need to be done after a system crash or failure in removing a PBI via normal methods.}}<br /> |-<br /> |}<br /> <br /> When removing a PBI, you must give its full name. The full name can be found in the output of '''pbi_info'''. The following example searches for the emacs PBI and removes it:<br /> <br /> '''pbi_info | grep ntop'''<br /> ntop-4.0.1_1-i386<br /> '''pbi_delete -v ntop-4.0.1_1-i386'''<br /> Running pre-removal script: /var/db/pbi/installed/ntop-4.0.1_1-i386/pre-remove.sh<br /> Removing: /usr/pbi/ntop-i386<br /> Removing: /var/db/pbi/installed/ntop-4.0.1_1-i386<br /> <br /> ==== pbi_deleterepo(1) ====<br /> <br /> The '''pbi_deleterepo''' command can be used to remove a registered repository from the system. It takes the repository's ID as the only command argument.<br /> <br /> ==== pbi_icon(1) ====<br /> <br /> 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 [http://en.wikipedia.org/wiki/Xdg XDG]-compliant to understand a PBI's icon and mime settings. Table 6.2.4.9 summarizes this command's options:<br /> <br /> '''Table 6.2.4.9: pbi_icon Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add-desktop'''}}<br /> {{Tbl-line|bg=ff|align=left|Installs any XDG compliant desktop icons, should be run as user.}}<br /> |-<br /> {{Tbl-line|align=left|'''add-menu'''}}<br /> {{Tbl-line|align=left|Installs any XDG compliant menu icons, should be run as root.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add-mime'''}}<br /> {{Tbl-line|bg=ff|align=left|Installs any XDG compliant mime information, should be run as root.}}<br /> |-<br /> {{Tbl-line|align=left|'''add-pathlnk'''}}<br /> {{Tbl-line|align=left|Installs any PATH links to ~/bin as user or to LOCALBASE as root.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''del-desktop'''}}<br /> {{Tbl-line|bg=ff|align=left|Removes any XDG compliant desktop icons, should be run as user.}}<br /> |-<br /> {{Tbl-line|align=left|'''del-menu'''}}<br /> {{Tbl-line|align=left|Removes any XDG compliant menu icons, should be run as root.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''del-mime'''}}<br /> {{Tbl-line|bg=ff|align=left|Removes any XDG compliant menu icons, should be run as root.}}<br /> |-<br /> {{Tbl-line|align=left|'''del-pathlnk'''}}<br /> {{Tbl-line|align=left|Removes any any PATH links to ~/bin as user or to LOCALBASE as root}}<br /> |-<br /> |}<br /> <br /> ==== pbi_indextool(1) ====<br /> <br /> The '''pbi_indextool''' command is useful for repository maintainers. It allows the adding/removing of PBI files available in a particular repository INDEX file without needing to hand-edit the file. Table 6.2.4.10 summarizes the available options:<br /> <br /> '''Table 6.2.4.10: pbi_indextool Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add'''}}<br /> {{Tbl-line|bg=ff|align=left|Adds a PBI to the target INDEX file}}<br /> |-<br /> {{Tbl-line|align=left|'''rem'''}}<br /> {{Tbl-line|align=left|Removes a PBI from the target INDEX file}}<br /> |-<br /> |}<br /> <br /> Run the command with the desired option to receive detailed usage.<br /> <br /> ==== pbi_info(1) ====<br /> <br /> Similar to FreeBSD's '''pkg_info''' command, the '''pbi_info''' command is used to determine which PBIs are currently installed. Table 6.2.4.11 summarizes the available options:<br /> <br /> '''Table 6.2.4.11: pbi_info Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-a'''}} <br /> {{Tbl-line|bg=ff|align=left|List all PBIs installed on the system, same as running pbi_info without an argument.}}<br /> |-<br /> {{Tbl-line|align=left|'''-i'''}}<br /> {{Tbl-line|align=left|List all available PBIs from any repo}} <br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-v'''}} <br /> {{Tbl-line|bg=ff|align=left|Enable verbose output}}<br /> |-<br /> |}<br /> <br /> ==== pbi_listrepo(1) ====<br /> <br /> The '''pbi_listrepo''' command manages installed repositories on a system. Table 6.2.4.12 summarizes this command's options:<br /> <br /> '''Table 6.2.4.12: pbi_listrepo Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--down'''}}<br /> {{Tbl-line|bg=ff|align=left|Move the targeted repoid down a single number in priority}}<br /> |-<br /> {{Tbl-line|align=left|'''-mirror URL'''}}<br /> {{Tbl-line|align=left|Change the specified repoid's mirror URL}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--up'''}}<br /> {{Tbl-line|bg=ff|align=left|Move the targeted repoid up a single number in priority}}<br /> |-<br /> |}<br /> <br /> Run the command without any options to list the IDs of the available repositories.<br /> <br /> ==== pbi_makepatch(1) ====<br /> <br /> The '''pbi_makepatch''' command is automatically used by '''pbi_autobuild''' to create small *.pbp (Push Button Patch) files. These files can be downloaded to a user's system and used to update a PBI's version without re-downloading the entire archive. This allows users to download only the incremental changes when a PBI is upgraded. The command can also be run manually by providing two PBI archives to compare and generate a patch file for.<br /> <br /> Table 6.2.4.13 summarizes the available options:<br /> <br /> '''Table 6.2.4.13: pbi_makepatch Options<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-o outdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Save the resulting .PBP file to the specified directory}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|Use the specified openssl key to digitally sign the patch file}}<br /> |-<br /> |}<br /> <br /> ==== pbi_makeport(1) ====<br /> <br /> The '''pbi_makeport''' command can be used by packagers to build a target FreeBSD port and convert it into a PBI file. Many options are provided to fine-tune the build process, and meta-data modules can also be specified to further improve the resulting PBI file. The first time this command is run, it will build a fresh chroot sandbox environment which can be used for clean-room building of the target port without affecting the host system. PBI creators are encouraged to send a tarball of the resulting PBI module to the [http://lists.pcbsd.org/mailman/listinfo/pbi-dev PBI-testing mailing list] so they can be added to the PC-BSD PBI repository and made available to other PC-BSD users.<br /> <br /> Table 6.2.4.14 summarizes the available options:<br /> <br /> '''Table 6.2.4.14: pbi_makeport Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-B'''}} <br /> {{Tbl-line|bg=ff|align=left|Build-only, after the port make process has finished, do not generate the PBI file. Generally used with -k to build a port before running pbi_create manually.}}<br /> |-<br /> {{Tbl-line|align=left|'''-c confdir'''}}<br /> {{Tbl-line|align=left|Specify the meta-data confdir to use. While not required for building a PBI, it is highly recommended. Without some configuration settings in the meta-data, icons and binary entry-points will not be created.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-d portsdir'''}}<br /> {{Tbl-line|bg=ff|align=left|Specify an alternative ports-dir, defaults to /usr/ports}}<br /> |-<br /> {{Tbl-line|align=left|'''-k'''}} <br /> {{Tbl-line|align=left|Keep the build files after a success or failure compiling/building the PBI}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-o outdir'''}}<br /> {{Tbl-line|bg=ff|align=left|The directory to place the finished PBI file, defaults to user's $HOME directory}}<br /> |-<br /> {{Tbl-line|align=left|'''-p prefix'''}}<br /> {{Tbl-line|align=left|Manually provide a PREFIX, which determines the location where the PBI will end up being installed on the end-user's system.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--delbuild'''}}<br /> {{Tbl-line|bg=ff|align=left|Remove any existing build dirs before starting the build}}<br /> |-<br /> {{Tbl-line|align=left|'''--mkdebug'''}}<br /> {{Tbl-line|align=left|Will drop to a debugging shell should the port make fail}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--no-prune'''}}<br /> {{Tbl-line|bg=ff|align=left|Disable auto-pruning of non REQUIREDBY ports after the compile phase. By default any ports which are used solely for building and which are not required for program execution will be pruned.}}<br /> |-<br /> {{Tbl-line|align=left|'''--sign keyfile'''}}<br /> {{Tbl-line|align=left|Digitially sign the PBI file with the specified openssl private key file}}<br /> |-<br /> |}<br /> <br /> ==== pbi_makerepo(1) ====<br /> <br /> The '''pbi_makerepo''' command allows repository maintainers to create a single *.rpo file containing various information about the new repository. This .rpo file can then be installed on the target system with '''pbi_addrepo'''. Table 6.2.4.15 summarizes the available options.<br /> <br /> '''Table 6.2.4.15: pbi_makerepo Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--desc description'''}}<br /> {{Tbl-line|bg=ff|align=left|Required. Description of the repo to be shown in the repo list}}<br /> |-<br /> {{Tbl-line|align=left|'''--key keyfile'''}}<br /> {{Tbl-line|align=left|Required. OpenSSL public key used to verify the digital signature of PBIs installed from this repo}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--mirror URL'''}}<br /> {{Tbl-line|bg=ff|align=left|Required. The URL to download PBIs and updates from}}<br /> |-<br /> {{Tbl-line|align=left|'''--url URL'''}}<br /> {{Tbl-line|align=left|Required. The URL to use when downloading the master INDEX files of available PBIs}}<br /> |-<br /> |}<br /> <br /> ==== pbi_metatool(1) ====<br /> <br /> The '''pbi_metatool''' command provides a way for repository maintainers to modify the PBI meta-data in their repository in order to add or remove application categories or specified PBIs. This meta-data may contain information such as Name, Description, Icon, Keywords, License and more for the respective PBI file. Table 6.2.4.16 summarizes the available options:<br /> <br /> '''Table 6.2.4.16: pbi_metatool Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''add'''}}<br /> {{Tbl-line|bg=ff|align=left|Adds a category or application to the target metafile}}<br /> |-<br /> {{Tbl-line|align=left|'''rem'''}}<br /> {{Tbl-line|align=left|Remove a category or application to the target metafile}}<br /> |-<br /> |}<br /> <br /> Run the command with the desired option to receive detailed usage.<br /> <br /> ==== pbi_patch(1) ====<br /> <br /> The '''pbi_patch''' command is used to update an installed PBI to a different version using the small diff Push Button Patch *.pbp file. This allows the user to perform an incremental upgrade of an installed PBI. The available options are summarized in Table 6.2.4.17.<br /> <br /> '''Table 6.2.4.17: pbi_patch Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-e'''}} <br /> {{Tbl-line|bg=ff|align=left|Extract only, do not install. Will extract the archive to ~/&lt;pbidirname&gt; unless the -o option is used.}}<br /> |-<br /> {{Tbl-line|align=left|'''-g'''}} <br /> {{Tbl-line|align=left|Extract image data from header, commonly used for GUI installations}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-i'''}} <br /> {{Tbl-line|bg=ff|align=left|Display information about this PBI file}}<br /> |-<br /> {{Tbl-line|align=left|'''-o outdir'''}}<br /> {{Tbl-line|align=left|Specify the directory to use when only extracting the PBI with -e.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--checkscript'''}}<br /> {{Tbl-line|bg=ff|align=left|Display any custom scripts used in the installation / removal of this PBI file. Recommended that these be checked if the PBI file is suspect in any way.}}<br /> |-<br /> {{Tbl-line|align=left|'''--no-checksig'''}}<br /> {{Tbl-line|align=left|Skip the openssl signature verification of the PBI data}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--no-hash'''}}<br /> {{Tbl-line|bg=ff|align=left|Disable using the shared-hash dir, which uses hard-links to share files between applications}}<br /> |-<br /> |}<br /> <br /> ==== pbi_update(1) ====<br /> <br /> The '''pbi_update''' command is used to display information about which PBIs have available updates from their repository and to perform the updates. Table 6.2.4.18 summarizes the available options.<br /> <br /> '''Table 6.2.4.18: pbi_update Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-c'''}} <br /> {{Tbl-line|bg=ff|align=left|Check-only the specified PBI for available updates.}}<br /> |-<br /> {{Tbl-line|align=left|'''--check-all'''}}<br /> {{Tbl-line|align=left|Run a full check of all installed PBIs and display list of available updates.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-disable-auto'''}}<br /> {{Tbl-line|bg=ff|align=left|Disable auto-updating of the target PBI.}}<br /> |-<br /> {{Tbl-line|align=left|'''--enable-auto'''}}<br /> {{Tbl-line|align=left|Enable auto-updating of the target PBI.}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''--update-all'''}}<br /> {{Tbl-line|bg=ff|align=left|Update all installed PBIs to the latest versions available.}}<br /> |-<br /> |}<br /> <br /> ====pbi_update_hashdir(1)====<br /> <br /> The '''pbi_update_hashdir''' command is used by the '''pbid''' daemon to merge the contents of a PBI into the hashdir.<br /> <br /> ==== pbid(8) ====<br /> <br /> The '''pbid''' command runs a small daemon which performs maintenance of installed PBIs, merges files into the shared hashdir, fetches the repository INDEX and meta files, and makes the adding and removing of PBIs much faster. It will automatically be started from the /usr/local/etc/rc.d/pbid startup script if pbid_enable=&quot;YES&quot; is in the /etc/rc.conf file.<br /> <br /> This utility supports the option summarized in table 6.2.4.19:<br /> <br /> '''Table 6.2.4.19: pbid Options'''<br /> <br /> {{Tbl-init|width=90%}}<br /> {{Tbl-title|width=15%|'''Switch'''}}<br /> {{Tbl-title|width=85%|'''Description'''}}<br /> |-<br /> {{Tbl-line|bg=ff|align=left|'''-v'''}}<br /> {{Tbl-line|bg=ff|align=left|Enable verbose output when the daemon starts}}<br /> |-<br /> |}<br /> <br /> This command logs its output to /var/log/pbid.log. Check this log for errors should you experience any problems with PBI maintenance.</div>

Krismoore http://wiki.pcbsd.org/index.php/Burning_the_Installation_Media 2011-11-01T14:17:09Z

<p>Krismoore: /* Writing the IMG File on a Linux or BSD System */</p> <hr /> <div>{{NavHeader|back=Obtaining PC-BSD|forward=PC-BSD Live Mode}}<br /> Once you have downloaded and verified the PC-BSD file, you will need to burn it to the correct media. This section demonstrates how to do so using several different applications and operating systems.<br /> <br /> ===Burning the CD/DVD ISO File on Windows===<br /> <br /> Several burning applications are available for Windows. This section will demonstrate how to use Windows 7's Disc Image Burner, ImgBurn, Nero, and InfraRecorder.<br /> <br /> ====Windows 7 Disc Image Burner====<br /> <br /> Windows 7 has built-in support for writing ISO images to disc. Right-click on the .iso file in Windows Explorer and select &quot;Burn disc image&quot; to launch Windows Disc Image Burner, shown in Figure 2.7.1a. Click &quot;Burn&quot; to write the disc. See the Microsoft article [http://windows.microsoft.com/en-US/windows7/Burn-a-CD-or-DVD-from-an-ISO-file Burn a CD or DVD from an ISO file] for more information.<br /> <br /> '''Figure 2.7.1a: Windows Disc Image Burner'''<br /> <br /> [[Image:Windows7discburner.png]]<br /> <br /> ====ImgBurn====<br /> <br /> [http://www.imgburn.com/ ImgBurn] is an easy to use image burner for Windows that is available for free download. After installing and launching ImgBurn, insert a blank DVD media and select &quot;Write image file to disk&quot; from the main menu, seen in Figure 2.7.1b:<br /> <br /> '''Figure 2.7.1b: Initial ImgBurn Screen'''<br /> <br /> [[Image:Imgburn1a.png]]<br /> <br /> You can then use File -&gt; Browse for a source file... to select the .iso file to burn; once selected, your screen should look similar to Figure 2.7.1c. Click the Write icon in the lower left corner to begin the burn.<br /> <br /> '''Figure 2.7.1c: Selecting the Source File (.iso) and Destination (DVD burner) in ImgBurn<br /> <br /> [[Image:Imgburn2a.png]]<br /> <br /> ImgBurn will provide a status bar to indicate the progress of the burn. When it is finished, ImgBurn will eject the DVD tray then reclose it in order to verify the burn. If the tray does not return itself, which may occur on a laptop, push the tray back in if you wish to verify the burn.<br /> <br /> ====Nero====<br /> <br /> [http://www.nero.com/ Nero] is a popular commercial burning application for Windows. Although it is commercial, there are several free trial versions available for download from the Nero website. Depending upon the version you download and install, your screens may vary slightly from those shown here. This section demonstrates using Nero BurnLite 10.<br /> <br /> To burn an ISO, launch Nero BurnLite, click the &quot;Data Burning&quot; tab, and then the + Add button to browse to the location of your .iso file. An example is seen in Figure 2.7.1d:<br /> <br /> '''Figure 2.7.1d: Ready to Burn an ISO Using Nero BurnLite'''<br /> <br /> [[Image:Nero1.png]]<br /> <br /> Click the Burn button and Nero will start burning your disk. When it is finished, Nero will alert you that the burning process is complete and will eject the DVD.<br /> <br /> ====InfraRecorder====<br /> <br /> [http://infrarecorder.org/ InfraRecorder] is an open source burning application for both CDs and DVDs. Once installed, open InfraRecorder and click on the &quot;Write Image&quot; button shown in Figure 2.7.1e:<br /> <br /> '''Figure 2.7.1e: Initial InfraRecorder Screen'''<br /> <br /> [[File:Pic1.png]]<br /> <br /> InfraRecorder will display a screen where you can browse to the location of the PC-BSD image. Once selected, you will be presented with an options screen shown in Figure 2.7.1f:<br /> <br /> '''Figure 2.7.1f: Burn Options in InfraRecorder'''<br /> <br /> [[Image:Infrarecorder1.png]]<br /> <br /> You can accept the defaults and click OK to start the burn. When finished, the tray with the DVD will open and a dialog box will appear indicating that the burning process has finished.<br /> <br /> ===Burning the CD/DVD ISO File on a Unix System===<br /> <br /> This section demonstrates how to burn the installation ISO using the following tools that may be available on a Linux or BSD system: K3B, Brasero, and growisofs.<br /> <br /> ====K3B====<br /> <br /> The KDE desktop environment provides the [http://k3b.plainblack.com/ K3B] burning application. K3B has a similar interface to burning software found on Windows and is equally easy to use.<br /> <br /> '''NOTE:''' depending upon your distribution, K3B may or may not be included with the installation of KDE. If it does not appear in the KDE application launcher, you should be able to install it using your operating system's software management system. On a FreeBSD system, you can install the K3B package. If you are running an older version of KDE, use the '''pkg_add -r k3b''' command. If you are running KDE4, use the '''pkg_add -r k3b-kde4''' command instead. On a PC-BSD system, you can install the K3B PBI using [[Using AppCafe™]].<br /> <br /> To burn your ISO, launch K3B and click &quot;Tools → Burn Image...&quot;. Figure 2.7.2a demonstrates this screen on a KDE4 system. On a KDE3 system, the menu item may appear as &quot;Burn DVD ISO Image...&quot;.<br /> <br /> '''Figure 2.7.2a: Selecting the Burn Image Tool Within K3B'''<br /> <br /> [[Image:K3b2a.png]]<br /> <br /> A new window, seen in Figure 2.7.2b, will launch. Click the blue folder to browse to the location of your .iso file. <br /> <br /> '''Figure 2.7.2b: K3B's Burn Image Screen'''<br /> <br /> [[Image:K3b2b.png]]<br /> <br /> Once your file is listed, ensure a blank DVD is inserted and click the &quot;Start&quot; button. K3B will automatically eject the DVD once the burn is complete.<br /> <br /> ====Brasero====<br /> <br /> [http://gnomebaker.sourceforge.net/ Brasero] is an easy to use CD-ROM/DVD burner included with the GNOME desktop. To launch Brasero, click Applications -&gt; Sound &amp; Video -&gt; Brasero Disk Burner and the dialog window shown in Figure 2.7.2c will be displayed.<br /> <br /> '''Figure 2.7.2c: Brasero's Initial Screen'''<br /> <br /> [[Image:Brasero1a.png]]<br /> <br /> If you click on Burn image -&gt; Click here to select a disk image, you will be able to select your .iso file. Once selected, click &quot;Open&quot; to return to the screen seen in Figure 2.7.2d:<br /> <br /> '''Figure 2.7.2d: Viewing the Image to Burn and the DVD Hardware Properties Within Brasero'''<br /> <br /> [[Image:Brasero2.png]]<br /> <br /> The name and size of your .iso file should appear and, assuming a blank DVD is inserted, Brasero will indicate the size of the media. The lower portion of Figure 2.7.2d shows the menu that appears if you click on the Properties button. You can change these options if you wish, but it is fine to keep the default settings. When you are ready, click the &quot;Burn&quot; button and Brasero will burn your ISO.<br /> <br /> ====growisofs====<br /> <br /> If you are familiar with using the command line on a FreeBSD system, you can use the '''growisofs''' command line utility to burn the DVD. This utility is included with the dvd+rw-tools FreeBSD port. If that software is not yet installed, issue this command as the superuser:<br /> <br /> '''pkg_add -r dvd+rw-tools'''<br /> <br /> Depending upon the type of DVD burner hardware, you may have to configure the system to use it. If the device is ATAPI (i.e. not USB or SCSI), the ATAPI driver must be loaded. The superuser can issue this command:<br /> <br /> '''kldload atapicam'''<br /> <br /> If you just get your prompt back, the driver successfully loaded. If you get the message &quot;kldload: can't load atapicam: File exists&quot;, this means that the driver was already loaded. If the device is USB or SCSI, no additional drivers need to be loaded if you are running the generic FreeBSD kernel. After inserting the DVD media into the device, you can start the burn using this command:<br /> <br /> '''growisofs -Z /dev/cd0=PCBSD9.0-BETA2-x86-DVD.iso'''<br /> <br /> If your device is not the first CD device, change the number 0 accordingly. If your ISO has a different name, substitute the correct name in the command shown above.<br /> <br /> ===Burning the CD/DVD ISO File on a Mac OSX System===<br /> <br /> To burn the ISO on a Mac OSX system, go to Finder -&gt; Applications -&gt; Utilities -&gt; Disk Utility. With a blank media inserted into the burner, highlight the device representing the CD/DVD writer and click the Burn button. This will open up a browser where you can select the ISO that you with to burn. In the example shown in Figure 2.7.3a, the DVD ISO has been selected and the device is a Sony DVD writer.<br /> <br /> '''Figure 2.7.3a: Using Disk Utility on Mac OSX'''<br /> <br /> [[Image:Mac.png]]<br /> <br /> Once the ISO is highlighted, click the Burn button. A pop-up message will indicate that the device is ready to burn. Click burn once more and Disk Utility will write the ISO to the CD/DVD media.<br /> <br /> ===Creating a Bootable USB from an ISO using UNetbootin===<br /> <br /> [http://unetbootin.sourceforge.net/| UNetbootin] is a utility that converts an ISO to a bootable USB. This ability is handy if you don't have a CD/DVD device and prefer to use a graphical utility to manipulate an ISO rather than the command line '''dd''' utility to burn an .img file. To use UNetbootin you will need to download a PC-BSD ISO file (CD or DVD) and a USB thumb drive large enough to hold that file.<br /> <br /> UNetbootin downloads are available for Windows, Mac OSX, and Linux. This section demonstrates how to create a bootable USB using a Windows 7 system.<br /> <br /> After downloading and launching UNetbootin, you should see the screen shown in Figure 2.7.4a.<br /> <br /> '''Figure 2.7.4a: Selecting the ISO in UNetbootin'''<br /> <br /> [[File:Unetbootin.png]]<br /> <br /> In the Diskimage section, use the ... browse button to locate the ISO that you downloaded. Insert the USB thumb drive and ensure that the drive letter for the USB thumb drive is the same as the one shown in Windows Explorer. Click the OK button to extract and copy the files to the thumb drive. The application will tell you when it is finished. You can now reboot the system with the USB thumb drive inserted to start the PC-BSD installer.<br /> <br /> NEEDS MODIFICATION OF SOMETHING FOR THIS TO WORK<br /> <br /> http://sourceforge.net/apps/trac/unetbootin/wiki<br /> <br /> ===Writing an IMG File to USB===<br /> <br /> To write an .img.bz2 file you will need the following:<br /> <br /> * a utility that can extract bz2 zipped files<br /> <br /> * a utility that can write the image to a USB media<br /> <br /> * a USB thumb drive or hard drive large enough to hold the image. Be aware that some cheaper USB thumb drives do not have the capacity that they advertise. For example, a 4GB USB drive may actually contain less than the ~3.8GB required for a full image installation. If your installation fails, try using a larger capacity USB thumb drive.<br /> <br /> The utilities that you use will depend upon your operating system.<br /> <br /> Once the image is written, you can boot from the removable device and proceed with the [[Installing PC-BSD|installation]]. If you are using the boot-only img file, you will also need to refer to the section [[Install PC-BSD Over a Network]] as this image requires an Internet connection to download the rest of the files needed to complete the installation of PC-BSD.<br /> <br /> '''NOTE:''' if the system does not boot from the removable device, check the boot order in your system BIOS. <br /> <br /> ====Writing the IMG File on a Linux or BSD System====<br /> <br /> If you selected to download an .img.bz2 file instead of an ISO, you can write the image file to a flash card or removable USB drive using the '''bunzip2''' and '''dd''' command line utilities on a BSD or Linux system. On a FreeBSD system, the superuser can use these commands to extract the specified image and write it to the first plugged in USB device:<br /> <br /> '''bunzip2 PCBSD9.0-BETA1.5-x86-USBFULL.img.bz2'''<br /> '''dd if=PCBSD9.0-BETA1.5-x86-USBFULL.img of=/dev/da0 bs=64k'''<br /> 63200+0 records in<br /> 63200+0 records out<br /> 4141875200 bytes transferred in 1395.261087 secs (2968531 bytes/sec)<br /> <br /> When using the '''dd''' command:<br /> <br /> * '''if=''' refers to the input file; in our case, the name of the file to be written; it should end with an .img extension<br /> <br /> * '''of=''' refers to the output file; in our case, the device name of the flash card or removable USB drive. You may have to increment the number in the name if it is not the first USB device. On Linux the first USB device is usually /dev/sdb. When in doubt plug in the USB device, then run the command &quot;dmesg&quot;. The last paragraph of the dmesg output will provide the proper name. Probably &quot;sdb&quot; or &quot;sdc&quot;. <br /> <br /> * '''bs=''' refers to the block size<br /> <br /> '''NOTE For Linux Users:''' On Linux, you will see two (or more, as the case may be) device nodes corresponding to the usb stick. For example, '''/dev/sdc''' and '''/dev/sdc1'''. ''You can get the device node corresponding to the usb stick from the output of '''mount'''''. The latter file '''/dev/sdc1''' corresponds to primary partition of the usb stick. Before using the '''dd''' command, ensure that the usb stick is unmounted. When using the '''dd''' command, remember to use '''/dev/sdc''' (device node without the number) as the option for the output file '''of='''. Also, remember that once the dd completes, you might not be able to mount the usb stick properly on Linux, for Linux has a very limited support of UFS, the BSD file system that gets created on the usb. Hence, it is not quite possible to even look at the files and directories created on the usb stick from Linux.<br /> <br /> ====Writing the IMG File on a Windows System====<br /> <br /> To burn the .img file on a Windows system, you can use [https://launchpad.net/win32-image-writer win32-image-writer]. You'll also need a utility that can extract .bz2 files such as [http://www.7-zip.org/ 7-Zip].<br /> <br /> When downloading win32-image-writer, download the latest version that ends in -binary.zip and use a utility such as WinZip or 7zip to unzip the executable.<br /> <br /> To extract the PC-BSD image file using 7-Zip, browse to the location containing your downloaded .img.bz2 file, as seen in Figure 2.7.4a.<br /> <br /> '''Figure 2.7.4a: Using 7-Zip to Extract Image File'''<br /> <br /> [[Image:7zip.jpeg]]<br /> <br /> Click the Extract button and browse to the location where you would like to save the extracted image. Once extracted, your image will end in .img and is now ready to be written to a USB device using the win32-image-writer application.<br /> <br /> If you launch win32-image-writer.exe, it will start the Win32 Disk Imager utility, shown in Figure 2.7.4b. Use the browse button to browse to the location of the .img file. Insert a USB thumb drive and select its drive letter (in this example, drive F). Click the Write button and the image will be written to the USB thumb drive.<br /> <br /> '''Figure 2.7.4b: Using Win32 Disk Imager to Write the Image'''<br /> <br /> [[File:Image.jpeg]]<br /> <br /> ====Writing the IMG File on a Mac OSX System====<br /> <br /> To extract the img.bz2 file on a Mac system, use Finder to browse to the location of the file, as seen in Figure 2.7.4c.<br /> <br /> '''Figure 2.7.4c: Extracting the Image on Mac'''<br /> <br /> [[File:Mac1.png]]<br /> <br /> Simply double-click the file to extract it to the .img format. Finder will create a second file with the .img extension.<br /> <br /> To burn that .img file, insert a USB stick and open Terminal. Run the '''diskutil list''' command to find out the device name of the USB disk, unmount the USB disk, then use '''dd''' to write the image. In the example shown in Figure 2.7.4d, an 8GB USB stick has a device name of /dev/disk1.<br /> <br /> '''Figure 2.7.4d: Writing the Image File Within Terminal'''<br /> <br /> [[File:Mac2.png]]</div>

Krismoore http://wiki.pcbsd.org/index.php/PBI_Module_Builder_Guide 2011-10-26T18:16:53Z

<p>Krismoore: /* Module Components */</p> <hr /> <div>{{NavHeader|back=Test PBIs|forward=Purchase PC-BSD Swag}}<br /> The PBI format changed between PC-BSD 8.x and 9.x. This means that you should follow the instructions for the PBI format that you wish to create.<br /> <br /> === Building PBIs for PC-BSD 9.x and higher ===<br /> <br /> ==== Creating a New PBI with '''pbi_makeport''' ====<br /> <br /> Starting in PC-BSD 9.x and higher, '''pbi_makeport''' is included with the operating system. This utility provides an easy way for a user to convert an existing FreeBSD port into a PBI module. The PBI build server builds modules into PBIs which are then made available to users through AppCafe™. '''man pbi_makeport''' provides details on this application's various usage options. <br /> <br /> When running '''pbi_makeport''' it is possible to supply an optional meta-data configuration directory which contains additional data used to supplement the port building and the final PBI file. This conf directory may contain extra icon data for the desktop, install/uninstall scripts, custom make options and more. <br /> <br /> Examples of 9.x modules can be found at [http://trac.pcbsd.org/browser/pcbsd/current/src-sh/pbi-manager/module-examples Examples in Subversion].<br /> <br /> ====Module Components====<br /> <br /> A PBI module contains the following components. When creating a PBI module, create a directory on your computer to hold the module's components. For example, if you are creating a PBI module for firefox, create a directory called firefox and place the following files within that directory. The directory that you create is referred to as %PBI_APPDIR%%. <br /> <br /> '''1. LICENSE File'''<br /> <br /> The text of a license agreement you want the user to click to accept before installation. This file is optional unless the underlying port is restricted and requires the user to accept a license in order to install and use the software.<br /> <br /> '''2. pbi.conf'''<br /> <br /> The pbi.conf file is mandatory. It is a simple shell script that contains the information needed to build the PBI. Typically this file requires you to modify a few simple variables, such as the name of the program, its location in the ports tree, and the name of its icon. Sometimes you will need to set a few additional variables in order to make sure that required dependencies are included in the PBI. If you get stuck when creating your own pbi.conf, you can view the pbi.conf file for every PBI module in [http://trac.pcbsd.org/browser#pbi/modules this section] of the PC-BSD trac repository. Here is an example of the pbi.conf file for firefox: <br /> &lt;nowiki&gt;<br /> #!/bin/sh<br /> # PBI Build Configuration<br /> # Place over-rides and settings here<br /> #<br /> # XDG Desktop Menu Spec:<br /> # http://standards.freedesktop.org/menu-spec/menu-spec-1.0.html<br /> ##############################################################################<br /> <br /> # Program Name<br /> PBI_PROGNAME=&quot;Firefox&quot;<br /> <br /> # Program Website<br /> PBI_PROGWEB=&quot;http://www.mozilla.com&quot;<br /> <br /> # Program Author / Vendor<br /> PBI_PROGAUTHOR=&quot;The Mozilla Foundation&quot;<br /> <br /> # Default Icon (Relative to %%PBI_APPDIR%% or resources/)<br /> PBI_PROGICON=&quot;share/pixmaps/FireFox-128.png&quot;<br /> <br /> # The target port we are building<br /> PBI_MAKEPORT=&quot;www/firefox&quot;<br /> <br /> # Additional options for make.conf<br /> PBI_MAKEOPTS=&quot;PACKAGE_BUILDING=Y<br /> WITH_CUPS=yes<br /> WITH_GECKO=libxul&quot;<br /> <br /> # Ports to build before / after<br /> PBI_MKPORTBEFORE=&quot;&quot;<br /> PBI_MKPORTAFTER=&quot;audio/esound x11-fonts/dejavu x11-themes/qtcurve-gtk2 devel/gconf2 www/firefox-i18n&quot;<br /> <br /> # Exclude List<br /> PBI_EXCLUDELIST=&quot;./include ./share/doc&quot;<br /> <br /> # Increment to trigger rebuild of PBI on build servers<br /> PBI_BUILDKEY=&quot;04&quot;<br /> <br /> # This app needs to install as root<br /> PBI_REQUIRESROOT=&quot;YES&quot;<br /> <br /> # Set the priority of this build <br /> PBI_AB_PRIORITY=&quot;50&quot;<br /> <br /> # Set the files we want to exclude from the shared hashdir<br /> PBI_HASH_EXCLUDES=&quot;lib/firefox/firefox&quot;<br /> <br /> export PBI_PROGNAME PBI_PROGWEB PBI_PROGAUTHOR PBI_PROGICON PBI_MAKEPORT PBI_MAKEOPTS <br /> PBI_MKPORTBEFORE PBI_MKPORTAFTER PBI_BUILDKEY PBI_REQUIRESROOT PBI_EXCLUDELIST&lt;/nowiki&gt;<br /> <br /> Table 10.7a describes the most commonly used variables. When creating your pbi.conf file, you will want to refer to the port's FreeBSD Makefile and pkg-descr so that you will know which values to input.<br /> <br /> '''Table 10.7a: Commonly Used pbi.conf Variables'''<br /> <br /> {| border=&quot;1&quot;<br /> |'''Variable''' <br /> |'''Description'''<br /> |-<br /> |PBI_PROGNAME=<br /> |Mandatory. Should be the same value as PORTNAME= in the port's Makefile, but capitalized.<br /> |-<br /> |PBI_PROGWEB=<br /> |Mandatory unless does not exist. Should be the same value as WWW= in the port's pkg-descr.<br /> |-<br /> |PBI_PROGAUTHOR=<br /> |Mandatory. Often found in the port's pkg-descr or at the website for the application.<br /> |-<br /> |PBI_PROGICON=<br /> |Mandatory. Path, relative to %PBI_APPDIR%%, to application icon file in png format.<br /> |-<br /> |PBI_PROGREVISION=<br /> |Bump up a PBIs revision number. Useful when rebuilding a port with new PBI specific options. <br /> |-<br /> |PBI_MAKEPORT=<br /> |Mandatory. The path to the port within /usr/ports/.<br /> |-<br /> |PBI_MAKEOPTS=<br /> |Optional. Set this to the options that you want saved into make.conf for the port building process. For example: WITH_CUPS=YES<br /> |-<br /> |PBI_MKPORTBEFORE=<br /> |Optional. Port(s) to build before starting the target port PBI_MAKEPORT.<br /> |-<br /> |PBI_MKPORTAFTER=<br /> |Optional. Port(s) to build after finishing the target port PBI_MAKEPORT.<br /> |-<br /> |PBI_BUILDKEY=<br /> |Should not be included. This variable is used on the PBI build server to force the rebuild of a PBI that has failed to build.<br /> |-<br /> |PBI_REQUIRESROOT=<br /> |Set to to YES to require this app to be installed as root, default is NO which allows to be installed as user or root mode.<br /> |-<br /> |PBI_EXCLUDELIST=<br /> |List of files / directories to exclude from the final archive, such as ./include ./share<br /> |-<br /> |PBI_AB_PRIORITY=<br /> |Set this to a number, the higher indicates greater priority and will be built before lower priority PBIs. <br /> |-<br /> |PBI_HASH_EXCLUDES=<br /> |Set to a space delimited list of files to exclude from merging into the shared hash-dir<br /> |-<br /> |export<br /> |Mandatory. Followed by a list of all of the variables that you have set so that they will be included when the PBI is built.<br /> |-<br /> |}<br /> <br /> '''3. external-links'''<br /> <br /> The optional external-links file contains a list of targets to link into the system's LOCALBASE at PBI installation time. This is useful for placing binaries and files in the user's PATH. When building PBIs from a FreeBSD port, this file is usually not needed, as most binaries and files are auto-detected and placed in the LOCALBASE. Example 10.7.1.3 shows an example usage:<br /> <br /> '''Example 10.7.1.3: Example external-links File'''<br /> <br /> &lt;nowiki&gt;<br /> # Files to be Sym-Linked into the default LOCALBASE<br /> # One per-line, relative to %%PBI_APPDIR%% and LOCALBASE<br /> # Defaults to keeping any existing files in LOCALBASE<br /> <br /> <br /> # TARGET LINK IN LOCALBASE ACTION<br /> #etc/rc.d/servfoo etc/rc.d/servfoo keep<br /> #include/libfoo.h include/libfoo.h replace<br /> #etc/rc.d/servfoo etc/rc.d/servfoo keep<br /> bin/firefox3 bin/firefox3 binary,nocrash&lt;/nowiki&gt;<br /> <br /> The flags in the ACTION column are as follows:<br /> <br /> * '''keep''': if this file already exists in LOCALBASE, don't overwrite it<br /> <br /> * '''replace''': replace this file in LOCALBASE if it exists<br /> <br /> * '''binary''': this file is an executable<br /> <br /> * '''nocrash''': used for binary files; don't display crash handler if program exits with non-0 status<br /> <br /> '''4. resources/'''<br /> <br /> The resources directory can contain extra files you wish copied into the PBI application directory. This is often the best place for icons and other files not included with a port. <br /> <br /> '''5. scripts/'''<br /> <br /> This directory can contain the following scripts:<br /> <br /> * '''post-install.sh''': script run immediately after the extraction of PBI contents to disk<br /> <br /> * '''post-portmake.sh''': script run during building of the PBI file, after the port-compile is finished<br /> <br /> * '''pre-install.sh''': script run before installation of the PBI; return non-0 to halt installation<br /> <br /> * '''pre-remove.sh''': script run before deletion of the PBI file<br /> <br /> Table 10.7.1.5 summarizes the variables that may be used in these scripts:<br /> <br /> '''Table 10.7.1.5 Supported Variables<br /> <br /> {| border=&quot;1&quot;<br /> |'''Variable''' <br /> |'''Description'''<br /> |-<br /> |PBI_PROGNAME=<br /> |Should be the same value as PORTNAME= in the port's Makefile, but capitalized.<br /> |-<br /> |PBI_PROGDIRNAME <br /> |This is the name of the directory that is created for the PBI in the /usr/pbi/ directory.<br /> (example: &quot;firefox-amd64&quot; for the 64-bit Firefox PBI)<br /> |-<br /> |PBI_PROGDIRPATH<br /> |This is the full path to the PBI install directory <br /> (example: &quot;/usr/pbi/firefox-amd64/&quot; for the 64-bit Firefox PBI)<br /> |-<br /> |PBI_PROGVERSION<br /> |This is the version of the program. Should be the same value as the DISTVERSION= in the port's Makefile.<br /> |-<br /> |PBI_RCDIR<br /> |<br /> |-<br /> |SYS_LOCALBASE<br /> |<br /> |-<br /> |PBI_FAKEBIN_DIR<br /> |<br /> |-<br /> |} <br /> <br /> '''6. xdg-menu/ and xdg-desktop/'''<br /> <br /> The xdg-menu and xdg-desktop directories can be used to supply menu and desktop icons, respectively. The file that you place in these directories should be in the format pbiname.desktop. Example 10.7.1.6 shows the firefox.desktop files for the firefox PBI:<br /> <br /> '''Example 10.7.1.6: firefox.desktop File'''<br /> <br /> '''more xdg-menu/firefox.desktop'''<br /> #!/usr/bin/env xdg-open<br /> [Desktop Entry]<br /> Value=1.0<br /> Type=Application<br /> Name=FireFox<br /> GenericName=FireFox<br /> Exec=%%PBI_EXEDIR%%/firefox %U<br /> Path=%%PBI_APPDIR%%<br /> Icon=%%PBI_APPDIR%%/share/pixmaps/FireFox-128.png<br /> StartupNotify=true<br /> Categories=Network;<br /> <br /> '''more xdg-desktop/firefox.desktop'''<br /> #!/usr/bin/env xdg-open<br /> [Desktop Entry]<br /> Value=1.0<br /> Type=Application<br /> Name=FireFox<br /> GenericName=FireFox<br /> Exec=%%PBI_EXEDIR%%/firefox %U<br /> Path=%%PBI_APPDIR%%<br /> Icon=%%PBI_APPDIR%%/share/pixmaps/FireFox-128.png<br /> StartupNotify=true <br /> <br /> %%PBI_EXEDIR%% should reference the PBI's executable and any required switches.<br /> <br /> For more details on the XDG menu specifications, please refer to the [http://standards.freedesktop.org/menu-spec/menu-spec-1.0.html freedesktop specifications]. <br /> <br /> '''7. xdg-mime/'''<br /> <br /> The xdg-mime directory is used to register file associations according to the [http://standards.freedesktop.org/shared-mime-info-spec/shared-mime-info-spec-latest.html freedesktop MIME specs]. This requires the creation of an XML file. The example shown in Figure 10.7.1.7 adds the MIME information for gimp, so that it can be available as an application choice in a web browser:<br /> <br /> '''Example 10.7.1.7: Gimp MIME Info'''<br /> <br /> '''more xdg-mime/gimp-xdg.xml'''<br /> &lt;?xml version=&quot;1.0&quot;?&gt;<br /> &lt;mime-info xmlns='http://www.freedesktop.org/standards/shared-mime-info'&gt;<br /> &lt;mime-type type=&quot;application/x-gimp&quot;&gt;<br /> &lt;comment&gt;Gimp - XCF File&lt;/comment&gt;<br /> &lt;glob weight=&quot;100&quot; pattern=&quot;*.xcf&quot;/&gt;<br /> &lt;glob weight=&quot;100&quot; pattern=&quot;*.XCF&quot;/&gt;<br /> &lt;/mime-type&gt;<br /> &lt;/mime-info&gt;<br /> <br /> === Building PBIs for PC-BSD 8.x and Earlier ===<br /> <br /> Earlier PBI versions were created using the PBI Builder Software. The PBI Builder Software automates the process of converting an existing FreeBSD package into a PBI. Anyone with a bit of time, the willingness to learn new things, and the desire to increase the number of PBIs available to PC-BSD users is welcome to create and submit new PBIs.<br /> <br /> Installing the PBI Builder software relatively easy, simply download the tbz package for you architecture and version of PC-BSD from the [http://www.pcbsd.org/development/get-involved/pbi-porting PBI Builder Homepage], and place it somewhere on your system with several GB of free space. Next run these commands (as root):<br /> <br /> # '''tar xvjpf pbibuild*.tbz'''<br /> # '''ln -s `pwd`/pbi-build /pbi-build'''<br /> <br /> ==== PBI Building Concepts ====<br /> <br /> The PBI Builder software relies on the following concepts:<br /> <br /> '''1. Modules:'''a directory containing the files needed by the PBI. The next section will explain how to configure a module for a new PBI.<br /> <br /> '''2. PBI Sandbox:''' in order to create a clean build environment that does not affect the software running on the host system, all PBI creation is done in the /pbi-build/pbisandbox directory. This is a complete buildworld environment, and you may chroot into it in order to tweak a port build, or inspect the built contents of a port by using this command as the superuser:<br /> <br /> # '''chroot /pbi-build/pbisandbox'''<br /> <br /> '''3. Build command:''' once you have a module, simply cd into the pbi-build directory and specify which module to build. Depending upon the size of the application, the build may take some time to finish. The following example will build the firefox PBI:<br /> <br /> # '''cd /pbi-build'''<br /> # '''./buildpbi.sh webbrowsers/firefox '''<br /> <br /> '''4. Recreate command:''' during the creation of a new module, it may become necessary to recreate the PBI file to test new configurations. If the PBI has already been compiled once, a change often does not require the complete rebuilding of the port from source. By skipping the source build, a new PBI may be generated within moments. To skip the building simply run the 3.makepbi.sh script in /pbi-build/scripts/3.makepbi.sh as shown:<br /> <br /> # '''cd /pbi-build/scripts'''<br /> # '''./3.makepbi.sh webbrowsers/firefox'''<br /> <br /> '''5. Distfiles:''' when running a port build, many files will be downloaded and stored in /usr/ports/distfiles within the /pbi-build/pbisandbox directory. The pbisandbox is removed between builds of modules, but starting in PBI Builder 2.0, the distfiles contents are preserved in the /pbi-build/distfiles directory.<br /> <br /> ==== Working with Modules ====<br /> <br /> When starting the process of creating a new module for the PBI Builder, you should start with an existing module and modify it to suit your program's needs. You can either copy a module from /pbi-build/docs/module-examples, download a module from SVN, or download a template from SVN.<br /> <br /> Modules currently in the PC-BSD Subversion repo can be browsed via the [http://trac.pcbsd.org/browser/pbibuild/modules web].<br /> <br /> To download a specific module, use the following commands, replacing &quot;firefox&quot; with the specific module you intend to checkout.<br /> <br /> # '''cd /pbi-build/modules'''<br /> # '''svn co &lt;nowiki&gt;svn://svn.pcbsd.org/pbibuild/modules/webbrowsers/firefox&lt;/nowiki&gt; webbrowsers/firefox'''<br /> <br /> If you wish to start with a blank module template, you may download by using these commands:<br /> <br /> # '''cd /pbi-build/modules'''<br /> # '''fetch &lt;nowiki&gt;http://www.pcbsd.org/files/templates/module-template.tgz&lt;/nowiki&gt;'''<br /> # '''tar xvzf module-template.tgz'''<br /> <br /> A proper module will contain several files and directories:<br /> <br /> '''Required files / directories'''<br /> <br /> * '''pbi.conf:''' the main configuration file for the module.<br /> <br /> * '''copy-files:''' listing of the files and directories you wish to copy from the pbisandbox environment to your finished PBI file.<br /> <br /> * '''kmenu-dir:''' directory of configuration entries for the K menu.<br /> <br /> * '''overlay-dir:''' directory of contents to be applied to base PBI directory. Icons, PBI setup scripts, and most other files not added via copy-files are placed here.<br /> <br /> '''Optional Files used on a per-need basis'''<br /> <br /> * '''build.sh:''' script to run after the port make and copy-files are processed. <br /> <br /> * '''preportmake.sh:''' script to run in pbisandbox prior to the port make being executed. <br /> <br /> * '''mime-dir:''' directory of mime entries for your PBI.<br /> <br /> ==== The pbi.conf file ====<br /> <br /> This file is the first thing you read for each module.<br /> The available variables are explained with the example of &quot;FireFox&quot; below:<br /> &lt;nowiki&gt;<br /> # Program Name<br /> # The name of the PBI file being built<br /> PROGNAME=&quot;Firefox&quot;<br /> <br /> # Program Website<br /> # Website of the program the module is building<br /> PROGWEB=&quot;http://www.mozilla.com&quot;<br /> <br /> # Program Author<br /> # Who created / maintains the program being built<br /> PROGAUTHOR=&quot;The Mozilla Foundation&quot;<br /> <br /> # Default Icon<br /> # Relative to overlay-dir, the main icon you want to show up for this PBI<br /> PROGICON=&quot;share/pixmaps/FireFox-128.png&quot;<br /> <br /> # Port we want to build<br /> # The port the server will track to determine when it's time for a rebuild<br /> PBIPORT=&quot;/usr/ports/www/firefox/&quot;<br /> <br /> # Set to &quot;Auto or NONE&quot; to have the PBI creator auto-populate libs or not<br /> # This allows you to also use the autolibs/ directory in your overlay-dir as a location for extra<br /> # library files<br /> PROGLIBS=&quot;Auto&quot;<br /> <br /> # PBI Update URL set to &quot;&quot; or the http:// URL of update checker<br /> # Leave this as update.pbidir.com normally<br /> PBIUPDATE=&quot;http://update.pbidir.com&quot;<br /> <br /> # Other Ports we need built<br /> # One per line, any additional ports that need to be built for this PBI<br /> OTHERPORT=&quot;&quot;<br /> <br /> # Enter your custom make options here<br /> # Options that will be put into the make.conf for the build of this port<br /> # Options get inserted into the build's /etc/make.conf file and effect all the ports built for that PBI<br /> MAKEOPTS=&quot;&quot;<br /> <br /> # FBSD7BASE - (7.1 or 7.2)<br /> # This variable can be used to set the specific version of FreeBSD this port needs to be compiled<br /> # under. Use this is a port is known to not build / work when compiled on FreeBSD 7.0 (the default)<br /> FBSD7BASE=&quot;7.2&quot;; export FBSD7BASE<br /> <br /> # This option determines if the pbi-builder will auto-copy files from the target port<br /> # Can be set to YES/NO/FULL<br /> # YES - Copy only target port files automatically<br /> # No - Don't copy any target port files (will need to use copy-files config instead)<br /> # FULL - Copy target port files, and recursive dependency files as well (Makes very large PBI)<br /> PBIAUTOPOPULATE=&quot;YES&quot; ; export PBIAUTOPOPULATE<br /> <br /> # Can be set to OFF/NO to disable copying all files from ports made with the OTHERPORT variable<br /> # Leaving this unset will have the builder auto-copy all files from OTHERPORT targets<br /> PBIAUTOPOPULATE_OTHERPORT=&quot;&quot; ; export PBIAUTOPOPULATE_OTHERPORT<br /> <br /> # Set this variable to any target ports you want to autopopulate files from, in addition to<br /> # the main target port<br /> # List additional ports one-per-line<br /> PBIAUTOPOPULATE_PORTS=&quot;/usr/ports/www/mplayer-plugin/&quot; ; export PBIAUTOPOPULATE_PORTS<br /> <br /> # By default the PBI will remove any xorg-fonts, and create a symlink to the the users system fonts<br /> # Setting this to YES keeps the PBIs internal fonts and doesn't create a link<br /> # PBIDISABLEFONTLINK=&quot;&quot; ; export PBIDISABLEFONTLINK<br /> <br /> # By default the libGL* libraries will be removed from a PBI in order to use the systems libGL<br /> # Set this to YES to keep the PBIs libGL* libraries, and not use the system's<br /> # PBIKEEPGL=&quot;&quot; ; export PBIKEEPGL<br /> <br /> # By default we prune any include/ files used for building,<br /> # Set this to NO to keep any include/ directories in the resulting PBI<br /> # PBIPRUNEINCLUDE=&quot;&quot; ; export PBIPRUNEINCLUDE<br /> <br /> # By default we prune the python files used for building,<br /> # Set this to NO to keep any python files in the resulting PBI<br /> # PBIPRUNEPYTHON=&quot;&quot; ; export PBIPRUNEPYTHON<br /> <br /> # By default we prune any perl files used for building,<br /> # Set this to NO to keep any perl files in the resulting PBI<br /> # PBIPRUNEPERL=&quot;&quot; ; export PBIPRUNEPERL<br /> <br /> # By default we prune any doc files (such as man, info, share/doc)<br /> # Set this to NO to keep any doc files in the resulting PBI<br /> # PBIPRUNEDOC=&quot;&quot; ; export PBIPRUNEDOC<br /> <br /> # Build Key - Change this to anything else to trigger a rebuild<br /> # - The rebuild will take place even if port is still the same ver<br /> BUILDKEY=&quot;01&quot;&lt;/nowiki&gt;<br /> ===== The copy-files configuration =====<br /> <br /> This file is very straight forward, simply list the files you want to copy from the installed port, and where they should go in your PBI directory structure. The first argument should be the file/directory you wish to copy, and the 2nd argument will be the directory within the PBI it needs to be copied to. <br /> <br /> Example copy-files from FileZilla:<br /> <br /> /usr/local/bin/filezilla bin/<br /> /usr/local/bin/fzsftp bin/<br /> /usr/local/bin/gst-* bin/<br /> /usr/local/bin/wxrc* bin/<br /> /usr/local/bin/wxgtk2* bin/<br /> /usr/local/share/filezilla share/filezilla<br /> <br /> ==== The preportmake.sh script ====<br /> <br /> This script, if it present is run right before starting the &quot;make install&quot; of your port. This allows you to make modifications to the pbisandbox environment or to the port building source itself. Normally this won't be<br /> necessary, unless working with a very tricky program to get compiled.<br /> <br /> Example:<br /> &lt;nowiki&gt;<br /> #!/bin/sh<br /> # Script to grab the java files and place them in the right directory<br /> # before starting the build<br /> <br /> cd /usr/ports/distfiles<br /> <br /> fetch ftp://ftp.pcbsd.org/pub/autobuildpkgs/javapack.tbz<br /> tar xvjf javapack.tbz<br /> <br /> cd /usr/ports/java/jdk16/<br /> echo &quot;#!/bin/sh<br /> exit 0&quot; &gt; /usr/ports/java/jdk16/files/license.sh<br /> <br /> cd /usr/ports/devel/automake15<br /> make install clean&lt;/nowiki&gt;<br /> <br /> ==== The build.sh script ====<br /> <br /> Below is the example of the build.sh script, which runs after all the files have been copied to your PBI directory. This allows you to make mods to specific things for your PBI to work properly. In this example we modify the uninstall script to use the right version.<br /> <br /> #!/bin/sh<br /> # PBI building script<br /> # This will run after your port build is complete<br /> # Build your PBI here, and exit 0 on success, or exit 1 on failure.<br /> ##############################################################################<br /> # Available Variables<br /> # PBIDIR = The location of where you can populate your PBI directory<br /> # MODULEDIR = The location of the module directory for this PBI<br /> # PORTVER = Version number of the port we used to build<br /> ##############################################################################<br /> <br /> # Save the right version number in the removepbi.sh script<br /> sed -e &quot;s,CHANGEME,Firefox${PORTVER},g&quot; ${PBIDIR}/scripts/removepbi.sh &gt; /tmp/removepbi.sh<br /> mv /tmp/removepbi.sh ${PBIDIR}/scripts/removepbi.sh<br /> chmod 755 ${PBIDIR}/scripts/removepbi.sh<br /> <br /> ==== The kmenu-dir directory ====<br /> <br /> In this directory you may make any number of files, which contain the .pbc configuration for your kmenu icons. This defines where you would like icons created for your users desktop<br /> <br /> Example of kmenu-dir/firefox file:<br /> <br /> ExePath: bin/firefox<br /> ExeIcon: share/pixmaps/FireFox-128.png<br /> ExeDescr: FireFox<br /> ExeNoDesktop: 0<br /> ExeNoMenu: 0<br /> ExeNoCrashHandler: 0<br /> ExeRunRoot: 0<br /> ExeRunShell: 0<br /> ExeNotify: 1<br /> ExeLink: 0<br /> ExeWebLink: 0<br /> ExeTaskbar: 0<br /> ExeOwndir: 1<br /> ExeKdeCat: Internet<br /> <br /> Line-By-Line description of each entry:<br /> ----<br /> <br /> '''ExePath''': bin/firefox<br /> <br /> This line indicates the binary / script we want this icon to run when the user clicks it. This is relative to the PBI directory, so we use bin/firefox<br /> <br /> '''ExeIcon''': share/pixmaps/FireFox-128.png<br /> <br /> This is the icon you want to show up for this program, again it is relative to the PBI directory<br /> <br /> '''ExeDescr''': FireFox<br /> <br /> This would be the name of the icon in the kmenu or on the users desktop.<br /> <br /> '''ExeNoDesktop''': 0<br /> <br /> This allows you to disable creating a desktop icon for this entry. Set it to '0' if you want a desktop icon, or '1' if you don't wish an icon.<br /> <br /> '''ExeNoMenu''': 0<br /> <br /> This allows you to disable creating a kmenu icon for this entry. Set it to '0' if you want a kmenu icon, or '1' if you don't wish an icon.<br /> <br /> '''ExeNoCrashHandler''': 0<br /> <br /> This option enables / disables the usage of the PC-BSD CrashHandler program. This dialog warns the user that the application has crashed if it returns status non-zero (0), and provides the option to save the output of stdout and stderr from the application. Setting this to &quot;1&quot; disables the CrashHandler helper, which is useful for programs which normally return non-0, such as Window Managers and various apps. <br /> <br /> '''ExeRunRoot''': 0<br /> <br /> This indicates if you want your program to be run as &quot;root&quot; when the user clicks it. Set it to '0' to run as a regular user, or '1' to run kdesu and switch to &quot;root&quot; Set this to '0'<br /> <br /> '''ExeRunShell''': 0<br /> <br /> This indicates if you want your program to be executed in a console session, which may be useful for command-line applications. Set it to '0' if you dont want it to run in console, or set it to '1' if you do.<br /> <br /> '''ExeNotify''': 1<br /> <br /> This indicates if you want to enable launch feedback in KDE, which is the bouncing icon, showing that the program is loading. Set it to '0' to disable launch feedback, or set it to '1' if you want this enabled. Normally it is<br /> best to leave this enabled.<br /> <br /> '''ExeLink''': 0<br /> <br /> This is used to indicate if the ExePath variable was set to a local file / document you want opened with konqueror insetead of just being &quot;run&quot;. This is useful for README type documents. Set this to '1' if you want your document opened with konq, or '0' to just run it as normal.<br /> <br /> '''ExeWebLink''': 0<br /> <br /> This is similar to above, and instead indicates that the ExePath being opened is actual a web URL. Set this to '1' to open it the ExePath with Konq, or '0' to just run it as normal.<br /> <br /> '''ExeTaskbar''': 0<br /> <br /> This indicates if you want this application icon added to the taskbar. Set it to '1' to add it, or '0' to leave it disabled. (THIS FEATURE IS CURRENTLY UNAVAILABLE, BUT WILL BE ADDED DOWN THE ROAD)<br /> <br /> '''ExeOwndir''': 1<br /> <br /> This option is used to specify where you want your Kmenu icon to be placed, and may be set to 0, 1, 2<br /> 0 = Place kmenu icon directory in top level. <br /> I.E. Kmenu -&gt; Firefox -&gt; Firefox<br /> 1 = Place kmenu icon in its own directory in the sub category indicated by ExeKdeCat:<br /> I.E. Kmenu -&gt; Internet -&gt; Firefox -&gt; Firefox<br /> 2 = Place kmenu icon directly in the sub category indicated by ExeKdeCat: <br /> I.E. Kmenu -&gt; Internet -&gt; Firefox<br /> <br /> '''ExeKdeCat''': Internet<br /> <br /> This allows you to choose a kmenu sub-directory to place your icons / directory into, when ExeOwnDir is set to 1 or 2. <br /> Available options are:<br /> &lt;nowiki&gt;<br /> ExeKdeCat: Development<br /> ExeKdeCat: Editors<br /> ExeKdeCat: Edutainment/Languages<br /> ExeKdeCat: Edutainment/Math<br /> ExeKdeCat: Edutainment/Misc<br /> ExeKdeCat: Edutainment/Science<br /> ExeKdeCat: Edutainment/Teaching<br /> ExeKdeCat: Games/Arcade<br /> ExeKdeCat: Games/Board<br /> ExeKdeCat: Games/Card<br /> ExeKdeCat: Games/Kidsgames<br /> ExeKdeCat: Games/TacticStrategy<br /> ExeKdeCat: Games<br /> ExeKdeCat: Graphics<br /> ExeKdeCat: Internet<br /> ExeKdeCat: Multimedia<br /> ExeKdeCat: Office<br /> ExeKdeCat: System<br /> ExeKdeCat: Toys<br /> ExeKdeCat: Utilities&lt;/nowiki&gt;<br /> <br /> ==== The mime-dir directory ====<br /> <br /> This directory allows to you specify mime types for your applications defined in the kmenu-dir entries.<br /> <br /> Example of mime-dir/exe file:<br /> <br /> MimeExt: *.exe; *.EXE<br /> MimeIcon: win_apps.png<br /> MimeProg: 0<br /> <br /> The only catch to this is to note that the &quot;MimeProg: 0&quot; is a pointer to a file in the kmenu-dir structure. In this case you would have to ensure that the application you want to open .exe files gets added first to the template<br /> the server creates. Files in the kmenu-dir are added in the order of a &quot;ls&quot; listing, so if you have a wine-exe entry, you may wish to rename it to 00wine-exe to ensure it is added first, which would make this MimeProg: 0<br /> entry work with it.<br /> <br /> If you have more than 1 mime-type, you would then increment the MimeProg: 0 number to MimeProg: 1, MimeProg: 2, and so forth. Then you would do the same with your kmenu-dir entries, such as 00wine-exe, 01wine-bat, 02wine-msi<br /> <br /> ==== The overlay-dir directory ====<br /> <br /> This folder contains any of the files you wish placed into your PBI program directory. Here is an example from firefox:<br /> <br /> leftside.png<br /> PBI.FirstRun.sh autolibs lib<br /> PBI.RemoveScript.sh bin scripts<br /> PBI.SetupScript.sh header.png share<br /> <br /> In this example you see we have added our PBI.* setup scripts, and the custom graphics we want for the PBI installer. You may also create directories that will be populated with the copy-files configuration, such as share/ or others you may need.<br /> <br /> ==== Useful Tips ====<br /> <br /> '''If the program uses the python programming language:''' use [PBIPRUNEPYTHON=&quot;NO&quot; ; export PBIPRUNEPYTHON] (usually the file is called py-(something) if that file is written in python)<br /> <br /> '''If the program uses the perl programming language:''' use [PBIPRUNEPERL=&quot;NO&quot; ; export PBIPRUNEPERL] (harder to spot, usually the filename has &quot;perl&quot; in it somewhere)<br /> <br /> '''The installed program does not work:''' this is usually because the python or perl option was not set appropriately. This is only noticed at runtime because after building, python and perl files are removed unless instructed otherwise.<br /> <br /> '''If your program path needs to be /usr/local/sbin:''' first, make a kmenu-dir entry similar to the one used by [http://trac.pcbsd.org/browser/pbibuild/modules/archivers/cabextract/kmenu-dir/cabextract cabextract]. Next, make sure that the &quot;ExeNoDesktop&quot; and &quot;ExeNoMenu&quot; options are both set to &quot;1&quot;. Then, in your PBI.SetupScript.sh, you can symlink the wrapper script into /Programs/bin as in [http://trac.pcbsd.org/browser/pbibuild/modules/archivers/cabextract/overlay-dir/PBI.SetupScript.sh this example].<br /> <br /> '''If the underlying port pauses to wait for user acceptance of license agreement:''' put this setting into the MAKEOPTS variable:<br /> <br /> MAKEOPTS=&quot;DISABLE_LICENSES=yes&quot;<br /> <br /> Don't forget to include the license text in the file overlay-dir/LICENSE so the user can read and accept the license during the PBI installation.<br /> <br /> '''If you don't have reliable Internet access and want to avoid running portsnap and build a PBI with pre-fetched distfiles:''' use this variable in /pbi-build/conf/pbibuild.conf:<br /> <br /> PORTSNAP=NO<br /> <br /> Place all of your distfiles into /pbi-build/distfiles; with this variable set, that directory will be nullfs mounted into the PBI sandbox when doing builds.<br /> <br /> '''How does the builder know which port the module is associated with?'''<br /> <br /> The PBI build system will look at the module path first, so if in SVN we are using the module www/firefox, it'll look for a port at www/firefox. However, in some cases a module doesn't use the same port or directory name. In that case, set this variable:<br /> <br /> # The target port we are building<br /> PBI_MAKEPORT=&quot;www/firefox&quot;<br /> export PBI_MAKEPORT<br /> <br /> That'll let the build server know which specific port this is building.<br /> <br /> = Getting Help =<br /> <br /> The [http://lists.pcbsd.org/mailman/listinfo/pbi-dev PBI Developers mailing list] can help if you:<br /> <br /> * get stuck building a PBI<br /> * need to ask a question about your PBI <br /> * are ready to submit a new module<br /> * find a bug in an existing PBI<br /> * have a bugfix for an existing PBI</div>

Krismoore