Port install/remove functions to new PK 0.8.x API
[appstream:software-center.git] / README
1 = User notes =
2
3 The software-center application aims to make the software handling on
4 the computer easy and consistent.
5
6 = Developer notes =
7
8 All non UI code must come with tests in the test/ subdirectoy.
9
10 To setup your development environment, you'll need to ensure the following
11 extra packages are installed:
12
13 sudo apt-get install xvfb python-coverage python-mock python-aptdaemon.test \
14      python-qt4 python-unittest2 python-lxml pep8
15 sudo apt-get build-dep software-center
16
17 You can then run tests with:
18
19 cd test;make
20
21 You can run a developer instance with:
22
23 python setup.py build
24 ./software-center
25
26 The initial launch of this will take a bit as it will build a private
27 search database but this is only needed once.
28
29 == query parser ==
30
31 The query parser understands :
32  "pkg:2vcard", "mime:text/html", "section:web", "origin:main"
33 prefixes.
34
35 == aptdaemon ==
36  * the dbus limits for the system bus are rather low, this means that
37    adding  <limit name="max_match_rules_per_connection">512</limit>
38    and using something bigger than 512 is a good idea
39
40 == environment ==
41
42 The following environment variables are supported:
43
44 SOFTWARE_CENTER_AGENT_HOST - an alternative host to query for pay software
45 SOFTWARE_CENTER_REVIEWS_HOST - an alternative host for the ratings&reviews
46 SOFTWARE_CENTER_DEBUG_HTTP - enable httplib2 debuging
47 SOFTWARE_CENTER_IPSUM_REVIEWS - generate random reviews
48 SOFTWARE_CENTER_FAKE_REVIEW_API - use a fake server for all review network operations
49 SOFTWARE_CENTER_GWIBBER_MOCK_USERS=2 - use mock gwibber service
50 SOFTWARE_CENTER_AGENT_INCLUDE_QA - show not yet QA apps available from the agent
51 SOFTWARE_CENTER_NET_DISCONNECTED - make software-center's netstatus module believe network manager is in a disconnected state
52 SOFTWARE_CENTER_WEBLIVE_HOST - overwrite default weblive server
53 SOFTWARE_CENTER_DISTRO_CODENAME - overwrite "lsb_release -c -s" output
54 SOFTWARE_CENTER_ARCHITECTURE - overwrite the current architecture
55 SOFTWARE_CENTER_NO_SC_AGENT - disable the software-center-agent
56 SOFTWARE_CENTER_DEBUG_TABS - show notebook tabs for debugging
57 SOFTWARE_CENTER_FORCE_DISABLE_CERTS_CHECK - disables certificates checking in webkit views (for use in test environments)
58 SOFTWARE_CENTER_FORCE_NON_SSL - disable SSL (for use in test environments)
59
60 == applications.menu ==
61
62 The menu file parser understands:
63 Category, And, Or, Not
64
65 The following additional XML filters are definied:
66 SCType - e.g. "Applicatin"
67 SCChannel - e.g. "lucid-partner"
68 SCSection - e.g. "net"
69 SCPkgname - e.g. "gimp"
70
71 Additional .menu files can be added in:
72 /usr/share/app-install/menu.d
73 that software-center will read and parse.
74
75 == XAPIAN ==
76
77 The following special prefixes are used:
78
79 AA - application name (Abiword)
80 AP - package name (abiword)
81 AS - archive pocket (main)
82 AE - archive section (mail, base, ...)
83 AC - category (AudioVideo)
84 AM - MimeType (application/x-ogg)
85 AT - type (Application)
86 AH - channel
87
88
89 The following values are used:
90
91 XAPIAN_VALUE_PKGNAME - pkgname
92 XAPIAN_VALUE_ICON - icon name
93 XAPIAN_VALUE_GETTEXT_DOMAIN - gettext domain
94 XAPIAN_VALUE_ARCHIVE_SECTION - archive section (main, restricted, universe, multiverse)
95 XAPIAN_VALUE_ARCHIVE_ARCH - architectures (seperated with ",", e.g. i386,amd64) - may be empty
96 XAPIAN_VALUE_POPCON - popcon data
97 XAPIAN_VALUE_SUMMARY - summary text
98 XAPIAN_VALUE_DESKTOP_FILE - the desktop file that the information comes from
99 XAPIAN_VALUE_PRICE - the price (if its a for-pay app)
100 XAPIAN_VALUE_ARCHIVE_CHANNEL - channel (third party)
101 XAPIAN_VALUE_ARCHIVE_PPA - the PPA name that the application is in
102 XAPIAN_VALUE_ARCHIVE_DEBLINE - a deb line for the sources.list to access the given app
103 XAPIAN_VALUE_ARCHIVE_SIGNING_KEYID - signing key id for the repository
104 XAPIAN_VALUE_PURCHASED_DATE - the data a for-pay app was purchased (only available after the software-center-agent server was queried)
105 XAPIAN_VALUE_SCREENSHOT_URLS - a (optional) list of "," seperated screenshot urls that overrides the default
106 XAPIAN_VALUE_ICON_NEEDS_DOWNLOAD - icon needs to be fetched
107 XAPIAN_VALUE_THUMBNAIL_URL - thumbnail url
108