Platform Team/Guide/Sweets Usage: Difference between revisions

This guide describes how to use Sugar Labs' Packaging Management System. See also [[Platform_Team/Sweets|introduction page]] and [[Platform_Team/Guide/Sweets_Packaging|Packaging guide]].

== Installation ==

=== Required packages ===

{{Note/important|Important notes for XO users:|Some XO images might mount {{Code|/var/cache/yum}} to the tmpfs. With this limited cache capacity, it will be mostly impossible to install anything of large size from the Fedora repositories. To work around this limitation, become a {{Code|root}} user and enter the {{Code|umount /var/cache/yum}} command in the Terminal activity or a console. To persist this change for subsequent boots, remove the corresponding line from the {{Code|/etc/fstab}} file.}}

  sudo yum install gnome-packagekit

Debian and Ubuntu (starting from 11.10) based distributions specific instructions:

Enter in the Terminal activity, or any other terminal:

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

Alternatively, {{Code|sweets}} might be run from the [[Platform_Team/Guide/Sweets_Packaging#Run_Sweets_from_sources|sources]].

Enter in the Terminal activity, or any other terminal:

sweets upgrade

== Usage ==

* {{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|''VERSION''}}, ''sweet'''s version

See the [[Platform_Team/Guide/Sugar_via_Sweets|Sugar via Sweets]] guide for real examples of how to use ''Sweets'' to run Sugar Shell.

sweets ''<SWEET>'':''<COMMAND>''

sweets ''<SWEET>'' ''=''|''>=''|''<='' ''<VERSION>''

 

  sweets status ''<SWEET>'' -v

 

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

 

 

 

 

 

''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 status ''<SWEET>'' -vdd

 

 

 

=== 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 the [http://xapian.org/ Xapian] search engine. Thus, it is possible to use Xapian's [http://xapian.org/docs/queryparser.html query language].

 

 

  sweets search ''<QUERY>''

 

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 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 the implementations list, e.g., {{Code|http://sweets.sugarlabs.org/sdk/sugar}};

 

 

{{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.

* For now, {{Code|sweets}} knows only enough about the glucose dependencies to install them from native packages in Debian, Ubuntu, Fedora, Mandriva, openSUSE.