<?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.3. Console Applications</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-Application.html" title="2.2. Desktop Applications" /><link rel="next" href="sect-Metadata-WebApplication.html" title="2.4. Web Applications" /></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-Application.html"><strong>Prev</strong></a></li><li class="home">AppStream</li><li class="next"><a accesskey="n" href="sect-Metadata-WebApplication.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-ConsoleApplication">
</a>2.3. Console Applications</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="spec-consoleapp-introduction">
</a>2.3.1. Introduction</h3></div></div></div><div class="para">
A console application is any application that has a command-line or text-based interface and is designed to be used by a human user on the command line. Applications need to be present in the standard <code class="envar">PATH</code>.
</div><div class="para">
The file described in this document is built upon the generic component metadata with fields specific for applications (see <a class="xref" href="chap-Metadata.html#sect-Metadata-GenericComponent">Section 2.1, “Generic Component”</a>). All tags valid for a generic component are valid for a <code class="literal">console-application</code> component as well.
</div><div class="para">
In order to enhance the available metadata about their application, projects shipping a console application can ship one or more metainfo 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-consoleapp-filespec">
</a>2.3.2. File specification</h3></div></div></div><div class="para">
The basic structure for a generic component as described at <a class="xref" href="chap-Metadata.html#spec-component-filespec">Section 2.1.3, “XML Specification”</a> applies. Note that the XML root must have the <code class="literal">type</code> property set to <code class="code">console-application</code>, while in a generic component this property can be omitted. This clearly identified this metainfo document as describing an application.
</div><div class="para">
The following list describes tags for <code class="literal">console-application</code> upstream metadata and provides some additional information about the values the tags are expected to have. If no information is given about a tag, refer to the respective tag in <a class="xref" href="chap-Metadata.html#sect-Metadata-GenericComponent">Section 2.1, “Generic Component”</a>.
</div><div class="variablelist"><dl class="variablelist"><dt><a id="tag-id-console-app">
</a><span class="term"><id/></span></dt><dd><div class="para">
For console applications, the <code class="code"><id/></code> tag value must follow the AppStream ID naming conventions (it should be a reverse-DNS name).
</div></dd><dt><span class="term"><metadata_license/></span></dt><dd><div class="para">
The <code class="code"><metadata_license/></code> tag as described in <a class="xref" href="chap-Metadata.html#tag-metadata_license"><metadata_license/></a> must be present.
</div></dd><dt><span class="term"><name/></span></dt><dd><div class="para">
A <code class="literal">name</code> must be present for console applications. See <a class="xref" href="chap-Metadata.html#tag-name"><name/></a> for a detailed description of this tag.
</div></dd><dt><span class="term"><summary/></span></dt><dd><div class="para">
A <code class="literal">summary</code> must be present for console applications. See <a class="xref" href="chap-Metadata.html#tag-summary"><summary/></a> for a detailed description of this tag.
</div></dd><dt><a id="tag-consoleapp-provides">
</a><span class="term"><provides/> ↪ <binary/></span></dt><dd><div class="para">
This tag is described in detail for generic components at <a class="xref" href="chap-Metadata.html#tag-provides"><provides/></a>.
</div><div class="para">
For console applications, at least one provided <code class="code"><binary/></code> must be listed in this tag.
</div></dd></dl></div><div class="para">
For a component of type <code class="literal">console-application</code>, the following tags are required and must always be present: <a class="xref" href="sect-Metadata-ConsoleApplication.html#tag-id-console-app"><id/></a>, <a class="xref" href="chap-Metadata.html#tag-metadata_license"><metadata_license/></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="sect-Metadata-ConsoleApplication.html#tag-consoleapp-provides"><provides/> ↪ <binary/></a>.
</div></div></div><ul class="docnav"><li class="previous"><a accesskey="p" href="sect-Metadata-Application.html"><strong>Prev</strong>2.2. Desktop Applications</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-WebApplication.html"><strong>Next</strong>2.4. Web Applications</a></li></ul></body></html>
