Sugar Labs

Platform Team/Guide/Sweets Usage: Difference between revisions

← Older editNewer edit →
No edit summary
→Usage: Make command-line arguments more exposed
Line 36: Line 36:
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


See the [[#Sugar_via_Sweets|Sugar via Sweets]] section for real examples of how to use ''Sweets'' to run Sugar Shell.
See the [[#Sugar_via_Sweets|Sugar via Sweets]] section for real examples of how to use ''Sweets'' to run Sugar Shell.
Line 46: Line 46:
To launch a ''sweet'' with verbatim passing of optional {{Code|ARGUMENTS}}:
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:
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:
To run a particular, but not the latest, version:


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


To get the full list of available versions:
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'':
To get information, e.g., a list of supported commands, about a ''sweet'':


  sweets show SWEET
  sweets show ''<SWEET>''


=== Troubleshooting ===
=== Troubleshooting ===
Line 72: Line 72:
''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):
''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'''
'''Analyze dependencies tree'''
Line 78: Line 78:
If {{Code|sweets}} can't find a proper ''implementation'', see the {{Code|e}} lines in the output of:
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'''
'''Keep the system in consistent state'''
Line 90: Line 90:
For command format is:
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}}.
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}}.
Retrieved from "https://wiki.sugarlabs.org/go/Platform_Team/Guide/Sweets_Usage"