Changeset 1473f60


Ignore:
Timestamp:
05/12/15 13:48:15 (8 weeks ago)
Author:
dlavigne <dru@…>
Branches:
master
Children:
2140ace5
Parents:
598d540
git-author:
dlavigne <dru@…> (05/12/15 13:47:59)
git-committer:
dlavigne <dru@…> (05/12/15 13:48:15)
Message:

Review sections 8.1 and 8.2.

Location:
src-qt5/docs
Files:
1 added
5 edited

Legend:

Unmodified
Added
Removed
  • src-qt5/docs/controlpanel.rst

    recd8854 r1473f60  
    4343desktops are installed using :ref:`AppCafe®`. 
    4444 
    45 The following utilities are found in the Control Panel of a PC-BSD® system, regardless of the desktop that is installed:  
     45The following utilities are found in the Control Panel of a PC-BSD® system, regardless of which desktops are installed:  
    4646 
    4747**Software and updates**  
     
    100100 
    101101* :ref:`Warden®` 
     102 
     103This chapter describes these utilities in more detail. 
    102104 
    103105.. index:: configuration 
     
    107109======= 
    108110 
    109 PBIng provides an information wrapper around existing FreeBSD packages. This wrapper, known as a PBI module, contains the metadata which displays information 
    110 about the PBI in :ref:`AppCafe®`, such as screenshots, similar applications, search terms, and plugins. With PBIng, you no longer have to build PBIs. 
    111 Instead, you can modify the information contained in PBI modules in order to create a custom PBI repository which can be added to AppCafe®. Since PBI modules 
     111The PBI format provides an information wrapper around existing packages. This wrapper, known as a PBI module, contains the metadata which displays information 
     112about the PBI in :ref:`AppCafe®`, such as screenshots, similar applications, search terms, and plugins. The EasyPBI utility can be used to 
     113modify the information contained in PBI modules in order to create a custom PBI repository which can be added to AppCafe®. Since PBI modules 
    112114are comprised of ASCII text files, they can be easily edited using the graphical EasyPBI utility or manually with a text editor. 
    113115 
     
    116118custom modules, refer to :ref:`Create Your Own PBI Repository` for instructions on how to add the custom repository to AppCafe®.  
    117119 
    118 .. note:: if your goal is to make a change to a single PBI, not a custom repository, refer to :ref:`Make Minor Modifications to a PBI Module`.  
     120.. note:: if your goal is to make a change to a single PBI, rather than an entire custom package repository, use the instructions in :ref:`Make Minor Modifications to a PBI Module`.  
    119121 
    120122.. index:: EasyPBI 
     
    146148 
    147149* **Icon File:** by default, a generic PBI icon will be used. If the application has its own icon, use the "Select" button to browse to the location of the 
    148   icon. When selecting a custom icon, use a 64x64 .png file with a transparent background. 
    149  
    150 * **Quick Module:** check this box if the system is not currently connected to the Internet. Otherwise, EasyPBI does a scan of the package in order to 
     150  icon. When selecting a custom icon, use a 64x64 :file:`.png` file with a transparent background. 
     151 
     152* **Quick Module:** check this box if the system is not currently connected to the Internet. Otherwise, EasyPBI does a scan of the package from the official repository in order to 
    151153  automatically fill in the module's information. This information can be filled in manually, as described in the next screen. 
    152154 
     
    167169  click the green arrow to select "Graphical", "Text", or "Server". The PBI will be assigned the icon for that search selection.  
    168170 
    169 * **Search Tags:** a comma delimited with no space list of tags. If a user types one of the tags into the search bar of AppCafe®, the PBI will be listed. 
     171* **Search Tags:** a comma delimited, with no spaces, list of tags. If a user types one of the tags into the search bar of AppCafe®, the PBI will be listed. 
    170172 
    171173* **Plugins:** if the application, such as a web browser, has associated plugins, click the "+" button to browse to the location of the plugin packages. These 
     
    192194 
    193195The "XDG Shortcuts" tab, shown in Figure 8.1d, is used to create desktop icons and menu entries so that the application can be easily started from within a desktop 
    194 environment. This is important step for graphical applications as it configures the primary method for interacting with the program. 
     196environment. This is important for graphical applications as it configures the primary method for interacting with the program. 
    195197 
    196198**Figure 8.1d: XDG Shortcuts Configuration** 
     
    251253The "Service Configuration" tab, shown in Figure 8.1f, allows you to setup a remote graphical configuration interface for the application. This is generally 
    252254used for services or daemons that do not have a configuration interface and lets the user perform tasks with that service such as modifying runtime 
    253 configuration options or starting, stopping, and restarting the service. Any configurations will appear in the new AppCafe® web interface 
    254 (:command:`pc-softweb`), which allows the user to manage those services from remote systems or phones. 
     255configuration options or starting, stopping, and restarting the service. Any configurations will appear in the "Configuration" tab of AppCafe®. 
    255256 
    256257**Figure 8.1f: Service Configuration** 
     
    265266.. image:: images/easypbi7.png 
    266267 
    267 The following fields are available when adding a visual option. Examples for values to use in these fields can be found in the 
    268 `service configuration file for irc/bitlbee <https://github.com/pcbsd/pcbsd/blob/master/pbi-modules/irc/bitlbee/service-configfile>`_.  
     268Several fields are available when adding a visual option. Examples for values to use in these fields can be found in the 
     269`service configuration file for irc/bitlbee <https://github.com/pcbsd/pcbsd/blob/master/pbi-modules/irc/bitlbee/service-configfile>`_. A screenshot of 
     270the "Configuration" tab for Bitlbee can be seen in Figure 8.1h. 
     271 
     272**Figure 8.1h: Example Configuration Tab** 
     273 
     274.. image:: images/bitlbee.png 
     275 
     276The following fields are available when adding a visual option: 
    269277 
    270278* **Key:** the option to set. 
     
    300308click the "Save Script" button to save the script. Repeat for each of the three required scripts. 
    301309 
    302 Once you have configured a PBI module, you can create additional modules by clicking the "New" button. To edit an existing module, click the "Load" button and 
     310Once you have finished configuring a PBI module, you can create additional modules by clicking the "New" button. To edit an existing module, click the "Load" button and 
    303311select the module name. 
    304312 
     
    309317------------------- 
    310318 
    311 When creating a custom repository, it can be convenient to quickly create all of the modules for a port category, then customize the modules as needed. 
    312 To do this, click :menuselection:`File --> Bulk Module Creator` which will open the screen shown in Figure 8.1h. 
    313  
    314 **Figure 8.1h: Bulk Module Creator** 
     319When creating a custom package repository, it can be convenient to quickly create all of the modules for a port category, then customize the modules as needed. 
     320To do this, click :menuselection:`File --> Bulk Module Creator` which will open the screen shown in Figure 8.1i. 
     321 
     322**Figure 8.1i: Bulk Module Creator** 
    315323 
    316324.. image:: images/easypbi8.png 
     
    331339which do not install anything and just have a bunch of dependencies. 
    332340 
    333 After making your selections, click the "Start" button. A progress bar will indicate the status, which goes by quickly, and then summarize the number of 
    334 modules built. An example is shown in Figure 8.1i. After reviewing the summary, click the "Close" button to return to the main EasyPBI screen. 
    335  
    336 **Figure 8.1i: Summary of Modules** 
     341After making your selections, click the "Start" button. A progress bar will indicate the status and summarize the number of 
     342modules built. An example is shown in Figure 8.1j. After reviewing the summary, click the "Close" button to return to the main EasyPBI screen. 
     343 
     344**Figure 8.1j: Summary of Modules** 
    337345 
    338346.. image:: images/easypbi9.png 
     
    344352* any package types which were unchecked 
    345353 
    346 * if the package is not found in the repository 
    347  
    348 .. note:: if all modules are skipped, check the Internet connection as Bulk Creator needs Internet access to get the package information. 
     354* any packages not found in the repository 
     355 
     356.. note:: if all modules are skipped, check the Internet connection as Bulk Creator requires Internet access to get the package information it needs. 
    349357 
    350358Repeat for each category that you want to include in the custom repository. 
     
    356364---------------- 
    357365 
    358 To edit EasyPBI's settings, click :menuselection:`Configure --> Settings` to open the screen shown in Figure 8.1j.  
    359  
    360 **Figure 8.1j: EasyPBI Settings**  
     366To edit EasyPBI's settings, click :menuselection:`Configure --> Settings` to open the screen shown in Figure 8.1k.  
     367 
     368**Figure 8.1k: EasyPBI Settings**  
    361369 
    362370.. image:: images/easypbi10.png 
     
    411419 
    412420The :file:`pbi.conf` file is mandatory. It is a simple shell script that contains the information needed to build the PBI. Here is an example of the 
    413 :file:`pbi.conf` file for firefox. When creating your file, modify the text in red to meet the needs of the PBI. 
     421`pbi.conf file for firefox <https://github.com/pcbsd/pcbsd/blob/master/pbi-modules/www/firefox/pbi.conf>`_. When creating your file, modify the PBI-specific 
     422values to meet the needs of the PBI. 
    414423:: 
    415424 
    416425 #!/bin/sh 
    417426 # PBING Module Config 
     427 
    418428 # -- Program Base Information -- 
    419429 PBI_ORIGIN="www/firefox" 
    420430 PBI_PROGNAME="Firefox" 
    421431 PBI_PROGWEB="" 
    422  PBI_PROGAUTHOR="Firefox Team" 
     432 PBI_PROGAUTHOR="Mozilla" 
     433 
    423434 # -- Additional repo information (optional) -- 
    424435 PBI_LICENSE="MPL" 
     
    426437 PBI_PROGTYPE="Graphical" 
    427438 PBI_CATEGORY="Web" 
     439 
    428440 # -- Additional package to install along with ORIGIN 
    429441 PBI_OTHERPKGS="www/linux-c6-flashplugin11 www/nspluginwrapper" 
     442 
    430443 # -- Optional related packages to show user 
    431444 PBI_PLUGINS="www/gecko-mediaplayer www/firefox-i18n java/icedtea-web" 
     445 
    432446 # -- Space delimited list of URLs to screenshots 
    433447 PBI_SCREENSHOTS="http://www.pcbsd.org/appcafe/screenshots/www/firefox/screen1.png http://www.pcbsd.org/appcafe/screenshots/www/firefox/screen2.png" 
     448 
    434449 # -- Other PBIs which are similar to this PBI 
    435450 PBI_RELATED="www/chromium www/opera www/seamonkey" 
     451 
    436452 export PBI_ORIGIN PBI_PROGNAME PBI_PROGWEB PBI_PROGAUTHOR 
    437453 export PBI_LICENSE PBI_TAGS PBI_PROGTYPE PBI_CATEGORY 
     
    446462| Variable         | Description                                                                                                         | 
    447463+==================+=====================================================================================================================+ 
    448 | PBI_ORIGIN=      | mandatory; the category/portname of the FreeBSD package                                                             | 
     464| PBI_ORIGIN=      | mandatory; the "category/portname" of the FreeBSD package                                                           | 
    449465+------------------+---------------------------------------------------------------------------------------------------------------------+ 
    450466| PBI_PROGNAME=    | mandatory; name of the application                                                                                  | 
     
    462478| PBI_CATEGORY=    | the category to place the application into; click "Browse Categories" within AppCafe to see the list of categories  | 
    463479+------------------+---------------------------------------------------------------------------------------------------------------------+ 
    464 | PBI_OTHERPKGS=   | a space separated list in the format *category/portname* of other applications to bundle into the PBI               | 
     480| PBI_OTHERPKGS=   | a space separated list in the format "category/portname" of other applications to bundle into the PBI               | 
    465481+------------------+---------------------------------------------------------------------------------------------------------------------+ 
    466 | PBI_PLUGINS=     | a space separated list in the format *category/portname* of similar packages                                        | 
     482| PBI_PLUGINS=     | a space separated list in the format "category/portname" of similar packages                                        | 
    467483+------------------+---------------------------------------------------------------------------------------------------------------------+ 
    468 | PBI_SCREENSHOTS= | a space separated list of URLs to screenshots in *.png* or *.jpg* format                                            | 
     484| PBI_SCREENSHOTS= | a space separated list of URLs to screenshots in :file:`.png` or :file:`.jpg` format                                | 
    469485+------------------+---------------------------------------------------------------------------------------------------------------------+ 
    470 | PBI_RELATED=     | a space separated list in the format *category/portname* of similar PBIs                                            | 
     486| PBI_RELATED=     | a space separated list in the format "category/portname" of similar PBIs                                            | 
    471487+------------------+---------------------------------------------------------------------------------------------------------------------+ 
    472 | export           | mandatory; followed by a list of all of the variables that will be included when the PBI is built                   | 
     488| export           | mandatory; followed by a list of all of the variables used in the file                                              | 
    473489+------------------+---------------------------------------------------------------------------------------------------------------------+ 
    474490 
     
    503519 Icon=share/pixmaps/FireFox-128.png  
    504520 StartupNotify=true  
     521 Categories=Network; 
    505522 Name=Firefox 
    506523 
     
    512529 
    513530The :file:`xdg-mime/` directory is used to register file associations according to the 
    514 `freedesktop MIME specs <service configuration file for irc/bitlbee>`_. This requires the creation of an XML file. The example shown in Figure 8.1b adds the 
    515 MIME information for gimp, so that it can be available as an application choice in a web browser:  
     531`freedesktop MIME specs <http://standards.freedesktop.org/menu-spec/menu-spec-1.0.html>`_. This requires the creation of an XML file. The example shown in Figure 8.1b adds the 
     532`MIME information for gimp <https://github.com/pcbsd/pcbsd/blob/master/pbi-modules/graphics/gimp/xdg-mime/gimp-xdg.xml>`_, so that it can be available as an application choice 
     533in a web browser:  
    516534 
    517535**Example 8.1b: Gimp MIME Info**:: 
Note: See TracChangeset for help on using the changeset viewer.