<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >

<appendix id='ref-features'>
    <title>Reference: Features</title>

    <para>
        Features provide a mechanism for working out which packages
        should be included in the generated images. 
        Distributions can select which features they want to support through the
        <filename><link linkend='var-DISTRO_FEATURES'>DISTRO_FEATURES</link></filename>
        variable, which is set in the <filename>poky.conf</filename> distribution configuration file.
        Machine features are set in the
        <filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></filename>
        variable, which is set in the machine configuration file and
        specifies the hardware features for a given machine.
    </para>

    <para>
        These two variables combine to work out which kernel modules,
        utilities, and other packages to include. 
        A given distribution can support a selected subset of features so some machine features might not
        be included if the distribution itself does not support them.
    </para>

    <section id='ref-features-distro'>
        <title>Distro</title>

        <para>
            The items below are valid options for 
            <filename><link linkend='var-DISTRO_FEATURES'>DISTRO_FEATURES</link></filename>:
            <itemizedlist>
                <listitem><para><emphasis>alsa:</emphasis> ALSA support will be included (OSS compatibility 
                    kernel modules will be installed if available).</para></listitem>
                <listitem><para><emphasis>bluetooth:</emphasis> Include bluetooth support (integrated BT only)
                    </para></listitem>
                <listitem><para><emphasis>ext2:</emphasis> Include tools for supporting for devices with internal
                    HDD/Microdrive for storing files (instead of Flash only devices)
                    </para></listitem>
                <listitem><para><emphasis>irda:</emphasis> Include Irda support
                    </para></listitem>
                <listitem><para><emphasis>keyboard:</emphasis> Include keyboard support (e.g. keymaps will be 
                    loaded during boot).
                    </para></listitem>
                <listitem><para><emphasis>pci:</emphasis> Include PCI bus support
                    </para></listitem>
                <listitem><para><emphasis>pcmcia:</emphasis> Include PCMCIA/CompactFlash support
                    </para></listitem>
                <listitem><para><emphasis>usbgadget:</emphasis> USB Gadget Device support (for USB
                    networking/serial/storage)
                    </para></listitem>
                <listitem><para><emphasis>usbhost:</emphasis> USB Host support (allows to connect external
                    keyboard, mouse, storage, network etc)
                    </para></listitem>
                <listitem><para><emphasis>wifi:</emphasis> WiFi support (integrated only)
                    </para></listitem>
                <listitem><para><emphasis>cramfs:</emphasis> CramFS support
                    </para></listitem>
                <listitem><para><emphasis>ipsec:</emphasis> IPSec support
                    </para></listitem>
                <listitem><para><emphasis>ipv6:</emphasis> IPv6 support
                    </para></listitem>
                <listitem><para><emphasis>nfs:</emphasis> NFS client support (for mounting NFS exports on
                    device)</para></listitem>
                <listitem><para><emphasis>ppp:</emphasis> PPP dialup support</para></listitem>
                <listitem><para><emphasis>smbfs:</emphasis> SMB networks client support (for mounting
                    Samba/Microsoft Windows shares on device)</para></listitem>
            </itemizedlist>
        </para>
    </section>

    <section id='ref-features-machine'>
        <title>Machine</title>

        <para>
            The items below are valid options for 
            <filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></filename>:
            <itemizedlist>
                <listitem><para><emphasis>acpi:</emphasis> Hardware has ACPI (x86/x86_64 only)
                    </para></listitem>
                <listitem><para><emphasis>alsa:</emphasis> Hardware has ALSA audio drivers
                    </para></listitem>
                <listitem><para><emphasis>apm:</emphasis> Hardware uses APM (or APM emulation)
                    </para></listitem>
                <listitem><para><emphasis>bluetooth:</emphasis> Hardware has integrated BT
                    </para></listitem>
                <listitem><para><emphasis>ext2:</emphasis> Hardware HDD or Microdrive
                    </para></listitem>
                <listitem><para><emphasis>irda:</emphasis> Hardware has Irda support
                    </para></listitem>
                <listitem><para><emphasis>keyboard:</emphasis> Hardware has a keyboard
                    </para></listitem>
                <listitem><para><emphasis>pci:</emphasis> Hardware has a PCI bus
                    </para></listitem>
                <listitem><para><emphasis>pcmcia:</emphasis> Hardware has PCMCIA or CompactFlash sockets
                    </para></listitem>
                <listitem><para><emphasis>screen:</emphasis> Hardware has a screen
                    </para></listitem>
                <listitem><para><emphasis>serial:</emphasis> Hardware has serial support (usually RS232)
                    </para></listitem>
                <listitem><para><emphasis>touchscreen:</emphasis> Hardware has a touchscreen
                    </para></listitem>
                <listitem><para><emphasis>usbgadget:</emphasis> Hardware is USB gadget device capable
                    </para></listitem>
                <listitem><para><emphasis>usbhost:</emphasis> Hardware is USB Host capable
                    </para></listitem>
                <listitem><para><emphasis>wifi:</emphasis> Hardware has integrated WiFi
                    </para></listitem>
            </itemizedlist>
        </para>
    </section>

    <section id='ref-features-image'>
        <title>Reference: Images</title>

        <para>
            The contents of images generated by the OpenEmbedded build system can be controlled by the 
            <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename>
            and <filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename>
            variables that you typically configure in your image recipes.
            Through these variables you can add several different
            predefined packages such as development utilities or packages with debug
            information needed to investigate application problems or profile applications.
        </para>

        <para>
            Current list of 
            <filename>IMAGE_FEATURES</filename> contains the following:
            <itemizedlist>
                <listitem><para><emphasis>apps-console-core:</emphasis> Core console applications such as 
                    <filename>ssh</filename>, <filename>daemon</filename>, <filename>avahi daemon</filename>,
                    <filename>portmap</filename> (for mounting NFS shares)</para></listitem>
                <listitem><para><emphasis>x11-base:</emphasis> X11 server + minimal desktop</para></listitem>
                <listitem><para><emphasis>x11-sato:</emphasis> OpenedHand Sato environment</para></listitem>
                <listitem><para><emphasis>apps-x11-core:</emphasis> Core X11 applications such as an 
                    X Terminal, file manager, and file editor</para></listitem>
                <listitem><para><emphasis>apps-x11-games:</emphasis> A set of X11 games</para></listitem>
                <listitem><para><emphasis>apps-x11-pimlico:</emphasis> OpenedHand Pimlico application suite
                    </para></listitem>
                <listitem><para><emphasis>tools-sdk:</emphasis> A full SDK that runs on the device
                    </para></listitem>
                <listitem><para><emphasis>tools-debug:</emphasis> Debugging tools such as 
                    <filename>strace</filename> and <filename>gdb</filename>
                    </para></listitem>
                <listitem><para><emphasis>tools-profile:</emphasis> Profiling tools such as 
                    <filename>oprofile</filename>, <filename>exmap</filename>, and 
                    <filename>LTTng</filename></para></listitem>
                <listitem><para><emphasis>tools-testapps:</emphasis> Device testing tools (e.g.
                    touchscreen debugging)</para></listitem>
                <listitem><para><emphasis>nfs-server:</emphasis> NFS server (exports / over NFS 
                    to everybody)</para></listitem>
                <listitem><para><emphasis>dev-pkgs:</emphasis> Development packages (headers and 
                    extra library links) for all packages installed in a given image</para></listitem>
                <listitem><para><emphasis>dbg-pkgs:</emphasis> Debug packages for all packages 
                    installed in a given image</para></listitem>
            </itemizedlist>
        </para>
    </section>
</appendix>

<!-- 
vim: expandtab tw=80 ts=4 spell spelllang=en_gb
-->
