<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title xmlns:d="http://docbook.org/ns/docbook">2.11. Driver</title><link rel="stylesheet" type="text/css" href="Common_Content/css/default.css" /><link rel="stylesheet" media="print" href="Common_Content/css/print.css" type="text/css" /><meta xmlns:d="http://docbook.org/ns/docbook" name="generator" content="publican v4.3.2" /><meta xmlns:d="http://docbook.org/ns/docbook" name="package" content="AppStream-AppStream-0.11-en-US-0.0-0" /><link rel="home" href="index.html" title="AppStream" /><link rel="up" href="chap-Metadata.html" title="Chapter 2. Upstream Metadata" /><link rel="prev" href="sect-Metadata-Firmware.html" title="2.10. Firmware" /><link rel="next" href="sect-Metadata-Localization.html" title="2.12. Localization" /></head><body><p id="title"><a class="left" href="http://www.freedesktop.org/wiki/Distributions/AppStream/"><img alt="Product Site" src="Common_Content/images//image_left.png" /></a><a class="right" href="http://www.freedesktop.org/software/appstream/docs/"><img alt="Documentation Site" src="Common_Content/images//image_right.png" /></a></p><ul class="docnav top"><li class="previous"><a accesskey="p" href="sect-Metadata-Firmware.html"><strong>Prev</strong></a></li><li class="home">AppStream</li><li class="next"><a accesskey="n" href="sect-Metadata-Localization.html"><strong>Next</strong></a></li></ul><div xml:lang="en-US" class="section" lang="en-US"><div class="titlepage"><div><div><h2 class="title"><a id="sect-Metadata-Driver">
</a>2.11. Driver</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="spec-driver-introduction">
</a>2.11.1. Driver</h3></div></div></div><div class="para">
The <code class="literal">driver</code> component type describes drivers for hardware devices as well as other Linux kernel drivers for e.g. virtualization support. It usually <code class="literal">provides</code> one or multiple modaliases.
</div><div class="para">
Drivers can ship one or more files in <code class="filename">/usr/share/metainfo/%{id}.metainfo.xml</code>.
</div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="spec-driver-example">
</a>2.11.2. Example file</h3></div></div></div><div class="para">
A driver metainfo file can look like this:
</div><pre class="programlisting"><span xmlns="" class="line"></span>
<span xmlns="" class="line"></span><span xmlns="" class="perl_Keyword"><?xml</span> version="1.0" encoding="UTF-8"<span xmlns="" class="perl_Keyword">?></span>
<span xmlns="" class="line"></span><span xmlns="" class="perl_Keyword"><component</span><span xmlns="" class="perl_Others"> type=</span><span xmlns="" class="perl_String">"driver"</span><span xmlns="" class="perl_Keyword">></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><id></span>com.nvidia.GeForce<span xmlns="" class="perl_Keyword"></id></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><name></span>NVIDIA GeForce<span xmlns="" class="perl_Keyword"></name></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><summary></span>NVIDIA Graphics Driver<span xmlns="" class="perl_Keyword"></summary></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><description></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><p></span>
<span xmlns="" class="line"></span> The NVIDIA Accelerated Linux Graphics Driver brings accelerated 2D
<span xmlns="" class="line"></span> functionality and high-performance OpenGL support to Linux x86 with the
<span xmlns="" class="line"></span> use of NVIDIA graphics processing units.
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"></p></span>
<span xmlns="" class="line"></span> ...
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"></description></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><url</span><span xmlns="" class="perl_Others"> type=</span><span xmlns="" class="perl_String">"homepage"</span><span xmlns="" class="perl_Keyword">></span>http://www.nvidia.com/Download/index.aspx<span xmlns="" class="perl_Keyword"></url></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><metadata_license></span>CC0-1.0<span xmlns="" class="perl_Keyword"></metadata_license></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><project_license></span>LicenseRef-proprietary:NVIDIA<span xmlns="" class="perl_Keyword"></project_license></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><developer_name></span>NVIDIA Corporation<span xmlns="" class="perl_Keyword"></developer_name></span>
<span xmlns="" class="line"></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><provides></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><modalias></span>pci:v000010DEd*sv*sd*bc03sc00i00*<span xmlns="" class="perl_Keyword"></modalias></span>
<span xmlns="" class="line"></span> ...
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"></provides></span>
<span xmlns="" class="line"></span><span xmlns="" class="perl_Keyword"></component></span></pre></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="spec-driver-filespec">
</a>2.11.3. File specification</h3></div></div></div><div class="para">
Note that the XML root must have the <code class="literal">type</code> property set to <code class="code">driver</code>. This clearly identifies this metainfo document as describing a driver.
</div><div class="variablelist"><dl class="variablelist"><dt><a id="tag-id-driver">
</a><span class="term"><id/></span></dt><dd><div class="para">
For drivers, the value of the <code class="code"><id/></code> tag must follow the reverse-DNS scheme as described for generic components. It is sometimes useful to suffix the ID with <code class="literal">.driver</code> to make it more unique.
</div></dd><dt><a id="tag-driver-provides">
</a><span class="term"><provides/> ↪ <modalias/></span></dt><dd><div class="para">
The <code class="literal">provides/modalias</code> tags contain all the modaliases the described driver supports and allow to automatically offer installation of the described driver on systems where hardware matching the modalias has been detected.
</div><div class="para">
Using wildcards for modaliases is permitted.
</div><div class="para">
Example:
</div><pre class="programlisting"><span xmlns="" class="line"></span><span xmlns="" class="perl_Keyword"><provides></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><modalias></span>pci:v000010DEd00001194sv*sd*bc03sc*i*<span xmlns="" class="perl_Keyword"></modalias></span>
<span xmlns="" class="line"></span> <span xmlns="" class="perl_Keyword"><modalias></span>pci:v000010DEd00001199sv*sd*bc03sc*i*<span xmlns="" class="perl_Keyword"></modalias></span>
<span xmlns="" class="line"></span><span xmlns="" class="perl_Keyword"></provides></span></pre></dd></dl></div><div class="para">
For a component of type <code class="literal">driver</code>, the following tags are required and must be present for a valid document: <a class="xref" href="sect-Metadata-Driver.html#tag-id-driver"><id/></a>, <a class="xref" href="chap-Metadata.html#tag-name"><name/></a>, <a class="xref" href="chap-Metadata.html#tag-summary"><summary/></a>, <a class="xref" href="chap-Metadata.html#tag-metadata_license"><metadata_license/></a>, <a class="xref" href="sect-Metadata-Driver.html#tag-driver-provides"><provides/> ↪ <modalias/></a>.
</div></div></div><ul class="docnav"><li class="previous"><a accesskey="p" href="sect-Metadata-Firmware.html"><strong>Prev</strong>2.10. Firmware</a></li><li class="up"><a accesskey="u" href="#"><strong>Up</strong></a></li><li class="home"><a accesskey="h" href="index.html"><strong>Home</strong></a></li><li class="next"><a accesskey="n" href="sect-Metadata-Localization.html"><strong>Next</strong>2.12. Localization</a></li></ul></body></html>
