'\" t
.\"     Title: appstream-index
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 26 July,2012
.\"    Manual: appstream-index
.\"    Source: AppStream
.\"  Language: English
.\"
.TH "APPSTREAM\-INDEX" "1" "26 July,2012" "AppStream" "appstream-index"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
appstream-index \- Manage the AppStream component index
.SH "SYNOPSIS"
.HP \w'\fBappstream\-index\fR\ 'u
\fBappstream\-index\fR [\fBCOMMAND\fR]
.SH "DESCRIPTION"
.PP
This manual page documents briefly the
\fBappstream\-index\fR
command\&.
.PP
\fBappstream\-index\fR
manages the AppStream index\&. The AppStream component index contains a list of all available applications for your distribution, matched with their native package names\&. It is generated using either AppStream\-XML, Debian\-DEP\-11 or Ubuntu AppInstall data, which is provided by your distributor\&.
.PP
For more information about the AppStream project and the other components which are part of it, take a look at the AppStream pages at
\m[blue]\fBFreedesktop\&.org\fR\m[]\&\s-2\u[1]\d\s+2\&.
.SH "OPTIONS"
.PP
\fBget \fR\fB\fIID\fR\fR
.RS 4
Get a component by it\*(Aqs identifier\&.
.RE
.PP
\fBs\fR, \fBsearch \fR\fB\fITERM\fR\fR
.RS 4
Search the AppStream component database for a given search term\&.
.RE
.PP
\fBwhat\-provides \fR\fB\fITYPE\fR\fR\fB \fR\fB\fITERM\fR\fR
.RS 4
Return components which provide a given item\&. An item type can be specified using the
\fB\fITYPE\fR\fR
parameter, a value to search for has to be supplied using the
\fB\fITERM\fR\fR
parameter\&.
.sp
Examples:
.sp
Get components which handle the "text/xml" mimetype\&.
.sp
\fBappstream\-index\fR
what\-provides mimetype "text/xml"
.sp
Get component which provides the "libfoo\&.so\&.2" library\&.
.sp
\fBappstream\-index\fR
what\-provides lib libfoo\&.so\&.2
.RE
.PP
\fBrefresh\fR
.RS 4
Trigger a database refresh, if necessary\&. In case you want to force the database to be rebuilt, supply the
\fB\-\-force\fR
flag\&.
.sp
This command must be executed with root permission\&.
.RE
.PP
\fB\-\-details\fR
.RS 4
Print out more information about a found component\&.
.RE
.PP
\fB\-\-no\-color\fR
.RS 4
Don\*(Aqt print colored output\&.
.RE
.PP
\fB\-\-version\fR
.RS 4
Display the version number of appstream\-index
.RE
.SH "SEE ALSO"
.PP
pkcon (1)\&.
.SH "AUTHOR"
.PP
This manual page was written by Matthias Klumpp
<matthias@tenstral\&.net>\&.
.SH "COPYRIGHT"
.br
Copyright \(co 2012-2014 Matthias Klumpp
.br
.SH "NOTES"
.IP " 1." 4
Freedesktop.org
.RS 4
\%http://www.freedesktop.org/wiki/Distributions/AppStream/
.RE