View | Details | Raw Unified
Collapse All | Expand All

(-) hb-guide-metadata.xml (-3 / +79 lines)
 Lines 10-17    Link Here  
-->
-->

        
<sections>
<sections>

            

              
<version>1.0.5</version>

              
<version>1.0.6</version>

            

            

              
<date>2008-03-31</date>

              
<date>2008-07-10</date>

            

        

        
<section>
<section>

        
<title>Why the need for metadata.xml?</title>
<title>Why the need for metadata.xml?</title>

  

    

    

       Lines 115-123
       
    
  Link Here 
    

  

        
  <ti><brite>&lt;longdescription&gt;</brite></ti>
  <ti><brite>&lt;longdescription&gt;</brite></ti>

        
  <ti>
  <ti>

        
    This tag contains a description of the package. This is to augment the 
    This tag contains a description of the package. This is to augment the 

            

              
    DESCRIPTION field in the ebuilds themselves.

              
    DESCRIPTION field in the ebuilds themselves. This tag has two optional

            

            

              

              
    subtags: <brite>&lt;pkg&gt;</brite> and <brite>&lt;cat&gt;</brite>.

            

        
  </ti>
  </ti>

        
</tr>
</tr>

            

              
              
<tr>

            

            

              
              
  <ti><brite>&lt;use&gt;</brite></ti>

            

            

              
              
  <ti>

            

            

              
              
    This tag contains descriptions of <uri

            

            

              
              
    link="/doc/en/handbook/handbook-x86.xml?part=2&amp;chap=2">USE flags</uri>.

            

            

              
              
    This tag is optional and, if specified, has one required subtag:

            

            

              
              
    <brite>&lt;flag&gt;</brite>.

            

            

              
              
  </ti>

            

            

              
              
</tr>

            

            

              
              
<tr>

            

            

              
              
  <ti><brite>&lt;flag&gt;</brite></ti>

            

            

              
              
  <ti>

            

            

              
              
    This tag contains a description of how the named USE flag affects this

            

            

              
              
    package. It is required if the <brite>&lt;use&gt;</brite> tag is specified.

            

            

              
              
    It alos requires the USE flag to be named in the <c>name</c> attribute.

            

            

              
              
    This tag has two optional subtags: <brite>&lt;pkg&gt;</brite> and

            

            

              
              
    <brite>&lt;cat&gt;</brite>.

            

            

              
              
  </ti>

            

            

              
              
</tr>

            

            

              
              
<tr>

            

            

              
              
  <ti><brite>&lt;pkg&gt;</brite></ti>

            

        
</table>
</table>

        

        
<p>
<p>

  

    

    

       Lines 256-260
       
    
  Link Here 
    

  

        

        
</body>
</body>

        
</subsection>
</subsection>

            

              
              
<subsection>

            

            

              
              
<title>Third Example</title>

            

            

              
              
<body>

            

            

              
              

            

            

              
              
<p>

            

            

              
              
For the third example, we will describe the <path>metadata.xml</path> of

            

            

              
              
<c>sys-apps/hal</c>. This ebuild is maintained by the <c>gentopia</c> herd

            

            

              
              
and contains USE flag descriptions.

            

            

              
              
</p>

            

            

              
              

            

            

              
              
<pre caption="USE flag descriptions">

            

            

              
              
&lt;?xml version="1.0" encoding="UTF-8"&gt;

            

            

              
              
&lt;!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd"&gt;

            

            

              
              
&lt;pkgmetadata&gt;

            

            

              
              
&lt;herd&gt;gentopia&lt;/herd&gt;

            

            

              
              
&lt;maintainer&gt;

            

            

              
              
	&lt;email&gt;compnerd@gentoo.org&lt;/email&gt;

            

            

              
              
&lt;/maintainer&gt;

            

            

              
              
&lt;maintainer&gt;

            

            

              
              
	&lt;email&gt;steev@gentoo.org&lt;/email&gt;

            

            

              
              
&lt;/maintainer&gt;

            

            

              
              
&lt;use&gt;

            

            

              
              
	&lt;flag name='acpi'&gt;Enables HAL to attempt to read from

            

            

              
              
	/proc/acpi/event, if unavailable, HAL will read events from

            

            

              
              
	&lt;pkg&gt;sys-power/acpid&lt;/pkg&gt;. If you need multiple acpi

            

            

              
              
	readers, ensure acpid is in your default runlevel along with HAL. This

            

            

              
              
	will also enable HAL to read Toshia and IBM acpi events which do not

            

            

              
              
	get sent via /proc/acpi/event&lt;/flag&gt;

            

            

              
              
	&lt;flag name='crypt'&gt;Allows HAL to mount volumes that are encrypted using

            

            

              
              
	LUKS. &lt;pkg&gt;sys-fs/cryptsetup-luks&lt;/pkg&gt; which has recently been renamed

            

            

              
              
	to &lt;pkg&gt;sys-fs/cryptsetup&lt;/pkg&gt; allows you to create such encrypted

            

            

              
              
	volumes. HAL will be able to handle volumes that are removable or

            

            

              
              
	fixed.&lt;/flag&gt;

            

            

              
              
	&lt;flag name='dell'&gt;Builds an installs the Dell addon, which reads data from

            

            

              
              
	the Dell SM BIOS via &lt;pkg&gt;sys-libs/libsmbios&lt;/pkg&gt;. It will read your

            

            

              
              
	service tag information and your hardware backlight data as well as

            

            

              
              
	allow you to modify the backlight settings on a Dell laptop.&lt;/flag&gt;

            

            

              
              
	&lt;flag name='disk-partition'&gt;Allows HAL to use libparted from

            

            

              
              
	&lt;pkg&gt;sys-apps/parted&lt;/pkg&gt; to read raw partition data from your disks

            

            

              
              
	and process that data. Future versions of HAL (possibly 0.5.11 and

            

            

              
              
	higher) will allow you to create, modify, delete and format partitions

            

            

              
              
	from a GUI interface agnostic of your desktop environment.&lt;/flag&gt;

            

            

              
              
	&lt;flag name='doc'&gt;Generates documentation that describes HAL's fdi

            

            

              
              
	format.&lt;/flag&gt;

            

            

              
              
	&lt;flag name='pcmcia'&gt;Allows HAL to process PCMCIA/CardBus slot data which

            

            

              
              
	includes inserts and removals and act on these events.&lt;/flag&gt;

            

            

              
              
	&lt;flag name='selinux'&gt;Installs SELinux policies and links HAL to the SELinux

            

            

              
              
	libraries.&lt;/flag&gt;

            

            

              
              
&lt;/use&gt;

            

            

              
              
&lt;/pkgmetadata&gt;

            

            

              
              
</pre>

            

            

              
              

            

            

              
              
</body>

            

            

              
              
</subsection>

            

        
</section>
</section>

        
</sections>
</sections>