Difference between revisions of "Platform Team/Guide/Sweets Usage"

From Sugar Labs
Jump to navigation Jump to search
Line 5: Line 5:
 
=== Required packages ===
 
=== Required packages ===
  
−
First, install PackageKit related packages. The following command will install two Polkit authentication agents, one for Gnome session (if you start sugar emulator from Gnome Desktop Environment) and LXPolkit that will be used from Sugar session.
+
First, install PackageKit related packages. The following command will install two Polkit authentication agents, one for Gnome session (if you start sugar emulator from Gnome Desktop Environment) and LXPolkit, which will be used from Sugar session.
  
 
Fedora specific instructions:
 
Fedora specific instructions:
Line 13: Line 13:
 
  sudo apt-get install packagekit-gnome
 
  sudo apt-get install packagekit-gnome
  
−
Relogin from X session to let Gnome or Sugar start Polkit authentication agent.
+
Relogin from X session to let Gnome or Sugar start the Polkit authentication agent.
  
 
=== Install ===
 
=== Install ===
Line 34: Line 34:
 
Read the [[Platform_Team/Sweets/Glossary|Sweets Glossary]] to understand the basic concept (and [[Platform_Team/Infrastructure|overview]] of the bigger picture). The rest of the text will operate with the following terms:
 
Read the [[Platform_Team/Sweets/Glossary|Sweets Glossary]] to understand the basic concept (and [[Platform_Team/Infrastructure|overview]] of the bigger picture). The rest of the text will operate with the following terms:
  
−
* {{Code|SWEET}}, the full ''interface'' url, like {{Code|http://sweets.sugarlabs.org/sdk/sugar}}, or the short one, like {{Code|sdk/sugar}};
+
* {{Code|SWEET}}, the full ''interface'' URL, like {{Code|http://sweets.sugarlabs.org/sdk/sugar}}, or the short one, like {{Code|sdk/sugar}};
−
* {{Code|COMMAND}}, ''sweet'''s command that indicates how to run a particular ''sweet''; by default, ''sweet''s have only the {{Code|run}} command but it is possible to have several commands;
+
* {{Code|COMMAND}}, ''sweet'''s command that indicates how to run a particular ''sweet''; by default, ''sweet''s have only the {{Code|run}} command, but it is possible to have several commands;
 
* {{Code|VERSION}}, ''sweet'''s version
 
* {{Code|VERSION}}, ''sweet'''s version
  
Line 64: Line 64:
 
=== Troubleshooting ===
 
=== Troubleshooting ===
  
−
''Feeds'' are being updated from time to time. After getting any problems, and for refreshing local ''feeds'' cache, it will be useful to re-download ''feeds''. Use, one time, the {{Code|-R}} command line argument for launch command (make sure that {{Code|-R}} goes before the {{Code|SWEET}}, because using it afterwards will cause passing it as a {{Code|SWEET}}'s argument):
+
''Feeds'' are being updated from time to time. After experiencing any problems, and for refreshing the local ''feeds'' cache, it will be useful to re-download ''feeds''. Use, once, the {{Code|-R}} command line argument for the launch command (make sure that {{Code|-R}} goes before the {{Code|SWEET}}, because using it afterwards will cause passing it as a {{Code|SWEET}}'s argument):
  
 
  sweets -R SWEET
 
  sweets -R SWEET
Line 74: Line 74:
 
=== Search ===
 
=== Search ===
  
−
It is possible to search ''sweet''s among locally known ones and those registered on http://sweets.sugarlabs.org (not yet implemented). The search is based on [http://xapian.org/ Xapian] search engine. Thus, it is possible to use Xapian's [http://xapian.org/docs/queryparser.html query language].
+
It is possible to search ''sweet''s among locally known ones and those registered on http://sweets.sugarlabs.org (not yet implemented). The search is based on the [http://xapian.org/ Xapian] search engine. Thus, it is possible to use Xapian's [http://xapian.org/docs/queryparser.html query language].
  
 
For command format is:
 
For command format is:
Line 82: Line 82:
 
Notice that [http://xapian.org/docs/queryparser.html#partially-entered-query-matching partial] search is enabled. So, the query {{Code|tele}} will be treated as {{Code|tele*}} to search all words that start from {{Code|tele}}.
 
Notice that [http://xapian.org/docs/queryparser.html#partially-entered-query-matching partial] search is enabled. So, the query {{Code|tele}} will be treated as {{Code|tele*}} to search all words that start from {{Code|tele}}.
  
−
{{Code|sweets}} supports following search [http://xapian.org/docs/queryparser.html#searching-within-a-probabilistic-field prefixes] basing of [[Platform_Team/Recipe_Specification|recipe options]]:
+
{{Code|sweets}} supports the following search [http://xapian.org/docs/queryparser.html#searching-within-a-probabilistic-field prefixes] based on [[Platform_Team/Recipe_Specification|recipe options]]:
  
−
* '''interface''' the first interface from implementations list, e.g., {{Code|http://sweets.sugarlabs.org/sdk/sugar}};
+
* '''interface''' the first interface from the implementations list, e.g., {{Code|http://sweets.sugarlabs.org/sdk/sugar}};
−
* '''sweet''' the first interface from implementations list in short Sweets notations, e.g., {{Code|sdk/sugar}};
+
* '''sweet''' the first interface from the implementations list in short Sweets notations, e.g., {{Code|sdk/sugar}};
 
* '''implement''' the list of implemented interfaces;
 
* '''implement''' the list of implemented interfaces;
−
* '''associate''' the list of associated interface;
+
* '''associate''' the list of associated interfaces;
 
* '''name''' the short name of a sweet;
 
* '''name''' the short name of a sweet;
 
* '''summary''' sweet's summary;
 
* '''summary''' sweet's summary;
Line 93: Line 93:
 
* '''category''' list of category names;
 
* '''category''' list of category names;
 
* '''license''' list of licenses;
 
* '''license''' list of licenses;
−
* '''type''' sweet's type, might be {{Code|library}}, {{Code|application}} or {{Code|activity}};
+
* '''type''' sweet's type, which might be {{Code|library}}, {{Code|application}} or {{Code|activity}};
 
* '''keep''' if activity, that a sweet is representing, is favorited;
 
* '''keep''' if activity, that a sweet is representing, is favorited;
 
* '''tags''' the list of sweet's tags;
 
* '''tags''' the list of sweet's tags;
−
* '''mime_types''' the list of MIME types activity, that a sweet is representing, supports.
+
* '''mime_types''' the list of activity MIME types, that a sweet is representing or supports.
  
−
So, it possible to search only among particular sweet attributes, like {{Code|name:telepathy}} to search only among sweet names.
+
So, it is possible to search only among particular sweet attributes, like {{Code|name:telepathy}} to search only among particular sweet names.
  
−
{{Code|sweets}} support additional notation for exact searching in form of {{Code|''prefix''<nowiki>:=</nowiki>''string''}}. For example the query {{Code|name<nowiki>:=</nowiki>sugar}} will find ''sweet''s only with exactly {{Code|sugar}} name and omit names like {{Code|sugar-base}}. If search string contains spaces, wrap it to double quotes, {{Code|name<nowiki>:=</nowiki>"Sugar Commander"}}. Note, wildcards does not work in exact search case and asterisks will be treated literally.
+
{{Code|sweets}} support additional notation for exact searching in the form of {{Code|''prefix''<nowiki>:=</nowiki>''string''}}. For example the query {{Code|name<nowiki>:=</nowiki>sugar}} will find ''sweet''s only with exactly {{Code|sugar}} as a name and omit names like {{Code|sugar-base}}. If the search string contains spaces, wrap it within double quotes, {{Code|name<nowiki>:=</nowiki>"Sugar Commander"}}. Note, wildcards do not work in the exact search case where asterisks will be treated literally.
  
 
== Sugar via Sweets ==
 
== Sugar via Sweets ==
  
−
To try Sweets in practice, run several Sugar versions. On the Sweets level, there are not any restrictions to using Sweets on any GNU/Linux distribution. Successful usage depends only on the presence of PackageKit and the quality of sweet packages (sweets). For now, sugar sweets are well aware of Fedora, Debian/Ubuntu and Gentoo package names and not so well aware of openSUSE and Mandriva. Sugar sweets launchs were tested on some recent Fedora and Ubuntu releases. The quality of other GNU/Linux distribution support depends only on how often Sweets is used on these distributions and the reporting of problems by the community.
+
To try Sweets in practice, run several Sugar versions. On the Sweets level, there are not any restrictions to using Sweets on any GNU/Linux distribution. Successful usage depends only on the presence of PackageKit and the quality of the sweet packages (sweets). For now, sugar sweets are well aware of Fedora, Debian/Ubuntu, and Gentoo package names and not so well aware of openSUSE and Mandriva. Sugar sweets launchs were tested on some recent Fedora and Ubuntu releases. The quality of other GNU/Linux distribution support depends only on how often Sweets is used on these distributions and the reporting of problems by the community.
  
−
Note, Sugar Shell does not start the authentication agent, and preparing sugar start can be processed only in a Desktop Environment, e.g., Gnome. To launch a recent stable Sugar version in emulator mode, type in a terminal:
+
Note, Sugar Shell does not start the authentication agent, and preparing sugar to start can be processed only in a Desktop Environment, e.g., Gnome. To launch a recent stable Sugar version in emulator mode, type in a terminal:
  
 
  sweets sdk/sugar:emulator
 
  sweets sdk/sugar:emulator
Line 112: Line 112:
 
Current sugar sweets support several Sucrose versions:
 
Current sugar sweets support several Sucrose versions:
  
 +
'''Stable'''
 
* ''0.94'', stable 0.94 branch;
 
* ''0.94'', stable 0.94 branch;
 
* ''0.92'', stable 0.92 branch;
 
* ''0.92'', stable 0.92 branch;
 
* ''0.88'', stable 0.88 branch and Dextrose-2 patches;
 
* ''0.88'', stable 0.88 branch and Dextrose-2 patches;
 
* ''0.84'', stable 0.84 branch;
 
* ''0.84'', stable 0.84 branch;
 +
 +
'''Development'''
 
* ''0.95'', development version from the trunk.
 
* ''0.95'', development version from the trunk.
  
−
By default, recent stable version will be used. To run a particular version:
+
By default, the most recent stable version will be used. To run a particular version, execute with additional arguments:
  
 
  sweets sdk/sugar:emulator = 0.88
 
  sweets sdk/sugar:emulator = 0.88
  
−
Since there is no, for now, Sweets support in the Shell to run activities as sweets, ''sdk/sugar'' sweet contains Fructose and Sugar Platform dependencies. To run Sugar Shell without them, use the ''shell'' command:
+
For now, since there is no Sweets support in the Shell to run activities as sweets, ''sdk/sugar'' sweet contains Fructose and Sugar Platform dependencies. To run Sugar Shell without them, use the ''shell'' command:
  
 
  sweets sdk/sugar:shell
 
  sweets sdk/sugar:shell
Line 130: Line 133:
 
=== Sugar sweet from X sessions ===
 
=== Sugar sweet from X sessions ===
  
−
To start Sugar in the session mode, i.e., not from Xephyr, it will be useful to add new X session. Place {{Code|sweets}} invocation into your {{Code|~/.xsession}} file:
+
To start Sugar in the session mode, i.e., not from Xephyr, it will be useful to add a new X session. Place {{Code|sweets}} invocation into your {{Code|~/.xsession}} file:
  
 
  PATH=$HOME/.local/bin:$PATH
 
  PATH=$HOME/.local/bin:$PATH
Line 144: Line 147:
 
  Type=Application
 
  Type=Application
  
−
After getting login screen, Sweets session should present in the sessions list.
+
After getting a login screen, Sweets session should be present in the sessions list.
  
 
== Current limitations ==
 
== Current limitations ==
  
−
* For now, {{Code|sweets}} knowns only about the glucose dependencies to install them from native packages in Debian, Ubuntu, Fedora, Mandriva, openSUSE, and Gentoo.
+
* For now, {{Code|sweets}} knows only enough about the glucose dependencies to install them from native packages in Debian, Ubuntu, Fedora, Mandriva, openSUSE, and Gentoo.
 
* Activities can't reuse sweets benefits.
 
* Activities can't reuse sweets benefits.
  

Revision as of 12:05, 3 October 2011

This guide describes how to use Sugar Labs' Packaging Management System. See also introduction page and Packaging guide.

Installation

Required packages

First, install PackageKit related packages. The following command will install two Polkit authentication agents, one for Gnome session (if you start sugar emulator from Gnome Desktop Environment) and LXPolkit, which will be used from Sugar session.

Fedora specific instructions: 

sudo yum install gnome-packagekit lxpolkit

Debian and Ubuntu specific instructons (there is no official package for LXPolkit?): 

sudo apt-get install packagekit-gnome

Relogin from X session to let Gnome or Sugar start the Polkit authentication agent.

Install

wget http://download.sugarlabs.org/sweets/sweets/installer.sh
sh installer.sh

Relogin from X session to take into account the new PATH environment variable value.

Besides, sweets might be run from the sources.

Upgrade

If sweets was installed from a bundle: 

sweets upgrade

Usage

Read the Sweets Glossary to understand the basic concept (and overview of the bigger picture). The rest of the text will operate with the following terms:

  • SWEET, the full interface URL, like http://sweets.sugarlabs.org/sdk/sugar, or the short one, like sdk/sugar;
  • COMMAND, sweet's command that indicates how to run a particular sweet; by default, sweets have only the run command, but it is possible to have several commands;
  • VERSION, sweet's version

See the Sugar via Sweets section for real examples of how to use Sweets to run Sugar Shell.

Launch

To launch a sweet with verbatim passing of optional ARGUMENTS: 

sweets SWEET [ARGUMENTS]

Sometimes sweets support several launching commands; it is possible to specify one during the launch: 

sweets SWEET:COMMAND

To run a particular, but not the latest, version: 

sweets SWEET =|>=|<= VERSION

To get the full list of available versions: 

sweets status SWEET -v

To get information, e.g., a list of supported commands, about a sweet: 

sweets show SWEET

Troubleshooting

Feeds are being updated from time to time. After experiencing any problems, and for refreshing the local feeds cache, it will be useful to re-download feeds. Use, once, the -R command line argument for the launch command (make sure that -R goes before the SWEET, because using it afterwards will cause passing it as a SWEET's argument): 

sweets -R SWEET

If sweets can't find a proper implementation, see the e lines in the output of: 

sweets status SWEET -vdd

Search

It is possible to search sweets among locally known ones and those registered on http://sweets.sugarlabs.org (not yet implemented). The search is based on the Xapian search engine. Thus, it is possible to use Xapian's query language.

For command format is: 

sweets search QUERY

Notice that partial search is enabled. So, the query tele will be treated as tele* to search all words that start from tele.

sweets supports the following search prefixes based on recipe options:

  • interface the first interface from the implementations list, e.g., http://sweets.sugarlabs.org/sdk/sugar;
  • sweet the first interface from the implementations list in short Sweets notations, e.g., sdk/sugar;
  • implement the list of implemented interfaces;
  • associate the list of associated interfaces;
  • name the short name of a sweet;
  • summary sweet's summary;
  • description long sweet's description;
  • category list of category names;
  • license list of licenses;
  • type sweet's type, which might be library, application or activity;
  • keep if activity, that a sweet is representing, is favorited;
  • tags the list of sweet's tags;
  • mime_types the list of activity MIME types, that a sweet is representing or supports.

So, it is possible to search only among particular sweet attributes, like name:telepathy to search only among particular sweet names.

sweets support additional notation for exact searching in the form of prefix:=string. For example the query name:=sugar will find sweets only with exactly sugar as a name and omit names like sugar-base. If the search string contains spaces, wrap it within double quotes, name:="Sugar Commander". Note, wildcards do not work in the exact search case where asterisks will be treated literally.

Sugar via Sweets

To try Sweets in practice, run several Sugar versions. On the Sweets level, there are not any restrictions to using Sweets on any GNU/Linux distribution. Successful usage depends only on the presence of PackageKit and the quality of the sweet packages (sweets). For now, sugar sweets are well aware of Fedora, Debian/Ubuntu, and Gentoo package names and not so well aware of openSUSE and Mandriva. Sugar sweets launchs were tested on some recent Fedora and Ubuntu releases. The quality of other GNU/Linux distribution support depends only on how often Sweets is used on these distributions and the reporting of problems by the community.

Note, Sugar Shell does not start the authentication agent, and preparing sugar to start can be processed only in a Desktop Environment, e.g., Gnome. To launch a recent stable Sugar version in emulator mode, type in a terminal: 

sweets sdk/sugar:emulator

Current sugar sweets support several Sucrose versions:

Stable

  • 0.94, stable 0.94 branch;
  • 0.92, stable 0.92 branch;
  • 0.88, stable 0.88 branch and Dextrose-2 patches;
  • 0.84, stable 0.84 branch;

Development

  • 0.95, development version from the trunk.

By default, the most recent stable version will be used. To run a particular version, execute with additional arguments: 

sweets sdk/sugar:emulator = 0.88

For now, since there is no Sweets support in the Shell to run activities as sweets, sdk/sugar sweet contains Fructose and Sugar Platform dependencies. To run Sugar Shell without them, use the shell command: 

sweets sdk/sugar:shell

If you need to develop Sugar, see Sweets Packaging guide's instructions.

Sugar sweet from X sessions

To start Sugar in the session mode, i.e., not from Xephyr, it will be useful to add a new X session. Place sweets invocation into your ~/.xsession file: 

PATH=$HOME/.local/bin:$PATH
sweets sdk/sugar

and create a /usr/share/xsessions/sweets.desktop desktop file: 

[Desktop Entry]
Encoding=UTF-8
Name=Sweets
GenericName=Sweets
Exec=/etc/X11/Xsession
Type=Application

After getting a login screen, Sweets session should be present in the sessions list.

Current limitations

  • For now, sweets knows only enough about the glucose dependencies to install them from native packages in Debian, Ubuntu, Fedora, Mandriva, openSUSE, and Gentoo.
  • Activities can't reuse sweets benefits.

Feedback

  • Submit your bug report or feature request.
  • Subscribe to the sugar-devel mailing list and email with the subject prefixed with [SWEETS].
  • Ask your question on IRC channels, #sugar (not logged) or #sugar-newbies (logged).
Retrieved from "https://wiki.sugarlabs.org/index.php?title=Platform_Team/Guide/Sweets_Usage&oldid=69741"