1
Package component provides naming
2
=================================
3
This document describes how the "provides"-strings for packages should
4
be formatted for the given PK_PROVIDES types.
5
This is needed to ensure cross-distro compatibility on package provides
6
naming (the naming of components packages provide), which is used for
7
example in pk_client_what_provides_async().
8
Valid types of provided components are defined in PkProvidesEnum.
9
10
In general, the component naming should be "type(component-name)".
11
12
Component naming
13
----------------
14
15
MODALIAS:               A string with the modalias, for example
16
                        "pci:v00008086d00003B64sv000017AAsd0000215Fbc07sc80i00"
17
                        or "usb:v09DAp000Ad0014dc00dsc00dp00ic03isc01ip02".
18
                        Returns packages which provide a driver for this
19
                        device.
20
21
CODEC:                  A string in the format of gstreamer<version>(type-format)
22
                        where <version> is the GStreamer API version (e. g.
23
                        0.10), "type" is a GStreamer element type ("encoder",
24
                        "decoder", "urisource", ""urisink", "element"), and
25
                        "format" is the type specific search string.
26
                        Example: "gstreamer0.10(decoder-audio/ac3)"
27
28
MIMETYPE:               Mimetypes are (valid) mimetypes strings,
29
                        for example "application/x-catalog" or "text/plain".
30
31
FONT:                   A font name, e.g. "Cantarell".
32
33
HARDWARE_DRIVER:
34
35
POSTSCRIPT_DRIVER:
36
                        A string in the format of "postscriptdriver(mfg;mdl;)"
37
                        where mfg and mdl are the corresponding
38
                        IEEE 1284 Device ID keys for the printer model,
39
                        converted to lower-case and with spaces converted
40
                        to underscores.
41
                        Example: "postscriptdriver(epson;stylus_d92;)"
42
43
PLASMA_SERVICE:         A string in the format of
44
                        "plasma<version>(servicetype-name)" (where <version> is
45
                        currently expected to be 4 or 5), e.g.
46
                        "plasma4(dataengine-weather)". For backwards
47
                        compatibility, "servicetype-name" will be treated the
48
                        same as "plasma4(servicetype-name)".
49
50
SHARED_LIB:             Name of a shared library
51
                        Example: "libpackagekit-glib2.so.14"
52
53
PYTHON:                 A string in the format of "python<version>(module-name)",
54
                        or just the name of the Python module.
55
                        If the Python-Version is omitted, the backend will
56
                        choose the current default Python version.
57
                        Example: "python2(packagekit)"
58
59
LANGUAGE_SUPPORT:       A string in the format of language(ll_CC) or
60
                        language(ll), which should correspond to a
61
                        language/country pair or just a language, as in
62
                        /usr/share/i18n/SUPPORTED. Returns all packages
63
                        which provide language support (dictionaries,
64
                        translated help, ibus modules, etc.) for all packages
65
                        that are currently installed in the system.
66
                        Example: "language(zh_CN)" might suggest ibus-pinyin and
67
                        libreoffice-l10n-zh-cn if you have ibus and LibreOffice
68
                        installed.