Platform Team/Guide/Sweets Usage: Difference between revisions

(17 intermediate revisions by 2 users not shown)

Line 6:

First, install PackageKit related packages. The following command will also install Polkit authentication agent for Gnome sessions (if you start sugar emulator from Gnome Desktop Environment).

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

Fedora specific instructions:

sudo yum install gnome-packagekit

Debian and Ubuntu specific ~~instructons~~:

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

sudo apt-get install gnome-packagekit

Ubuntu (before 11.10) based distributions specific instructions:

sudo apt-get install packagekit-gnome

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

After installing PackageKit, you need to restart the DBus system bus. The easiest way is to just restart the machine.

=== Install ===

Enter in the Terminal activity, or any other terminal:

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

Line 22:

Line 31:

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

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

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

=== Upgrade ===

~~If sweets was installed from a bundle~~:

Enter in the Terminal activity, or any other terminal:

sweets upgrade

Line 34:

Line 43:

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

See the [[#Sugar_via_Sweets|Sugar via Sweets]] ~~section~~ for real examples of how to use ''Sweets'' to run Sugar Shell.

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

=== Launch ===

Line 44:

Line 53:

To launch a ''sweet'' with verbatim passing of optional {{Code|ARGUMENTS}}:

sweets SWEET [ARGUMENTS]

sweets ''<SWEET>'' [''<ARGUMENTS>'']

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

sweets SWEET:COMMAND

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

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

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

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

To get the full list of available versions:

sweets status SWEET -v

sweets status ''<SWEET>'' -v

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

sweets show SWEET

sweets show ''<SWEET>''

=== Troubleshooting ===

After getting any unpredictable Sweets behaviour, read the following notes.

'''Keep feeds up-to-date'''

''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>''

'''Analyze dependencies tree'''

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

sweets status SWEET -vdd

sweets status ''<SWEET>'' -vdd

'''Keep the system in consistent state'''

Asking Sweets to launch a sweets might mean installing new packages via PackageKit. In most cases, PackageKit can handle possible issues with native packages and, at worst, will fail as well, in order to stop any further Sweets operations. Nevertheless, it can be useful to keep unbroken native packages.

Line 80:

Line 97:

For command format is:

sweets search QUERY

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

Line 103:

Line 120:

{{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 ==~~

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 (or launch authentication agent manually).~~

~~There are two sweets for Glucose:~~

* {{Code|sdk/sugar}}, for pristine Glucose;

* {{Code|dextrose/sugar}}, for Glucose with [[Dextrose]] patches applied.

~~To see what Glucose versions these sweets provide, type in a terminal:~~

~~sweets status sdk/sugar -v~~

~~To launch a recent stable Sugar version in emulator mode, type in a terminal:~~

~~sweets sdk/sugar:emulator~~

~~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, Glucose sweets contain Fructose and Sugar Platform dependencies as suggested ones. To run Sugar with injection of all suggested dependencies, use the {{Code|-S<nowiki>|</nowiki>--force-suggested}} command-line argument:

~~sweets -S sdk/sugar:emulator~~

~~If you need to develop Sugar, see [[Platform_Team/Guide/Sweets_Packaging#Sugar_sweets|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 {{Code|sweets}} invocation into your {{Code|~/.xsession}} file:~~

~~PATH=$HOME/.local/bin:$PATH~~

~~sweets sdk/sugar~~

~~and create a {{Code|/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, {{Code|sweets}} knows only enough 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.

* Activities can't reuse sweets benefits.

@@ Line 6: / Line 6: @@
 First, install PackageKit related packages. The following command will also install Polkit authentication agent for Gnome sessions (if you start sugar emulator from Gnome Desktop Environment).
+{{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.}}
 Fedora specific instructions:
   sudo yum install gnome-packagekit
-Debian and Ubuntu specific instructons:
+Debian and Ubuntu (starting from 11.10) based distributions specific instructions:
+ sudo apt-get install gnome-packagekit
+Ubuntu (before 11.10) based distributions specific instructions:
   sudo apt-get install packagekit-gnome
-Relogin from X session to let Gnome start the Polkit authentication agent.
+After installing PackageKit, you need to restart the DBus system bus. The easiest way is to just restart the machine.
 === Install ===
+Enter in the Terminal activity, or any other terminal:
   wget http://download.sugarlabs.org/sweets/sweets/installer.sh
@@ Line 22: / Line 31: @@
 Relogin from X session to take into account the new PATH environment variable value.
-Besides, {{Code|sweets}} might be run from the [[Platform_Team/Guide/Sweets_Packaging#Run_Sweets_from_sources|sources]].
+Alternatively, {{Code|sweets}} might be run from the [[Platform_Team/Guide/Sweets_Packaging#Run_Sweets_from_sources|sources]].
 === Upgrade ===
-If sweets was installed from a bundle:
+Enter in the Terminal activity, or any other terminal:
   sweets upgrade
@@ Line 34: / Line 43: @@
 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
-See the [[#Sugar_via_Sweets|Sugar via Sweets]] section for real examples of how to use ''Sweets'' to run Sugar Shell.
+See the [[Platform_Team/Guide/Sugar_via_Sweets|Sugar via Sweets]] guide for real examples of how to use ''Sweets'' to run Sugar Shell.
 === Launch ===
@@ Line 44: / Line 53: @@
 To launch a ''sweet'' with verbatim passing of optional {{Code|ARGUMENTS}}:
-  sweets SWEET [ARGUMENTS]
+  sweets ''<SWEET>'' [''<ARGUMENTS>'']
 Sometimes ''sweet''s support several launching commands; it is possible to specify one during the launch:
-  sweets SWEET:COMMAND
+  sweets ''<SWEET>'':''<COMMAND>''
 To run a particular, but not the latest, version:
-  sweets SWEET ''=''|''>=''|''<='' VERSION
+  sweets ''<SWEET>'' ''=''|''>=''|''<='' ''<VERSION>''
 To get the full list of available versions:
-  sweets status SWEET -v
+  sweets status ''<SWEET>'' -v
 To get information, e.g., a list of supported commands, about a ''sweet'':
-  sweets show SWEET
+  sweets show ''<SWEET>''
 === Troubleshooting ===
+After getting any unpredictable Sweets behaviour, read the following notes.
+'''Keep feeds up-to-date'''
 ''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>''
+'''Analyze dependencies tree'''
 If {{Code|sweets}} can't find a proper ''implementation'', see the {{Code|e}} lines in the output of:
-  sweets status SWEET -vdd
+  sweets status ''<SWEET>'' -vdd
+'''Keep the system in consistent state'''
 Asking Sweets to launch a sweets might mean installing new packages via PackageKit. In most cases, PackageKit can handle possible issues with native packages and, at worst, will fail as well, in order to stop any further Sweets operations. Nevertheless, it can be useful to keep unbroken native packages.
@@ Line 80: / Line 97: @@
 For command format is:
-  sweets search QUERY
+  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}}.
@@ Line 103: / Line 120: @@
 {{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 ==
-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 (or launch authentication agent manually).
-There are two sweets for Glucose:
-* {{Code|sdk/sugar}}, for pristine Glucose;
-* {{Code|dextrose/sugar}}, for Glucose with [[Dextrose]] patches applied.
-To see what Glucose versions these sweets provide, type in a terminal:
-  sweets status sdk/sugar -v
-To launch a recent stable Sugar version in emulator mode, type in a terminal:
- sweets sdk/sugar:emulator
-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, Glucose sweets contain Fructose and Sugar Platform dependencies as suggested ones. To run Sugar with injection of all suggested dependencies, use the {{Code|-S<nowiki>|</nowiki>--force-suggested}} command-line argument:
- sweets -S sdk/sugar:emulator
-If you need to develop Sugar, see [[Platform_Team/Guide/Sweets_Packaging#Sugar_sweets|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 {{Code|sweets}} invocation into your {{Code|~/.xsession}} file:
- PATH=$HOME/.local/bin:$PATH
- sweets sdk/sugar
-and create a {{Code|/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, {{Code|sweets}} knows only enough 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.
 * Activities can't reuse sweets benefits.