5,705
edits
Changes
Deployment Platform/Client Configuration (view source)
Revision as of 10:37, 4 June 2013
, 10:37, 4 June 2013Created page with "== Summary == This page describes the {{Code|sweets.conf}} configuration file, the common way to configure Sugar clients within the Sweets Distribution, thus, [[Deploymen..."
== Summary ==
This page describes the {{Code|sweets.conf}} configuration file, the common way to configure Sugar clients within the [[Sweets Distribution]], thus, [[Deployment Platform]]. Configuration does not intersect with Sugar Shell settings, stored in GConf, and contains parameters related only to new functionality introduced by [[Sweets Distribution]].
== Configuration files ==
The configuration occurs based on several sources (sorted by applied order):
* {{Code|/etc/sweets.conf}}<br>system-wide configuration file,
* {{Code|~/.config/sweets/config}}<br>user-wide configuration file,
* {{Code|~/.sugar/''PROFILE''/sweets.conf}}<br>configuration related to particular Sugar profile.
Configuration files should be formatted as regular [[wikipedia:INI_files|INI]] files.
== Configuration sections ==
This is a list of configuration sections in {{Code|sweets.conf}} files. Each section belongs to particular application and might be optional in the final system.
<div id="client"><big>'''[client]'''</big></div>
Configure [[Platform_Team/Sugar_Network/Implementation#sugar-network-client|sugar-network-client]], a [[Sugar Network]] client application from {{Code|sugar-network}} package. To get the full list of available configure options, call the {{Code|sugar-network-client config}} command.
<div id="shell"><big>'''[shell]'''</big></div>
Configure Sugar Shell extra functionality implemented by version packaged in Sweets Distribution. There are the following settings:
* {{Code|plugins}}<br>Space separated list of [[Deployment_Platform/Sugar_Shell#Plugins|Shell plugins]] to enable.
<div id="blacklist"><big>'''[blacklist]'''</big></div>
[[Deployment_Platform/Sugar_Shell#Blacklist_Shell_components|Blacklist]] Sugar Shell components.
<div id="sugar-plugin"><big>'''[sugar-plugin-*]'''</big></div>
Configure particular [[Deployment_Platform/Sugar_Shell#Plugins|Shell plugin]].
This page describes the {{Code|sweets.conf}} configuration file, the common way to configure Sugar clients within the [[Sweets Distribution]], thus, [[Deployment Platform]]. Configuration does not intersect with Sugar Shell settings, stored in GConf, and contains parameters related only to new functionality introduced by [[Sweets Distribution]].
== Configuration files ==
The configuration occurs based on several sources (sorted by applied order):
* {{Code|/etc/sweets.conf}}<br>system-wide configuration file,
* {{Code|~/.config/sweets/config}}<br>user-wide configuration file,
* {{Code|~/.sugar/''PROFILE''/sweets.conf}}<br>configuration related to particular Sugar profile.
Configuration files should be formatted as regular [[wikipedia:INI_files|INI]] files.
== Configuration sections ==
This is a list of configuration sections in {{Code|sweets.conf}} files. Each section belongs to particular application and might be optional in the final system.
<div id="client"><big>'''[client]'''</big></div>
Configure [[Platform_Team/Sugar_Network/Implementation#sugar-network-client|sugar-network-client]], a [[Sugar Network]] client application from {{Code|sugar-network}} package. To get the full list of available configure options, call the {{Code|sugar-network-client config}} command.
<div id="shell"><big>'''[shell]'''</big></div>
Configure Sugar Shell extra functionality implemented by version packaged in Sweets Distribution. There are the following settings:
* {{Code|plugins}}<br>Space separated list of [[Deployment_Platform/Sugar_Shell#Plugins|Shell plugins]] to enable.
<div id="blacklist"><big>'''[blacklist]'''</big></div>
[[Deployment_Platform/Sugar_Shell#Blacklist_Shell_components|Blacklist]] Sugar Shell components.
<div id="sugar-plugin"><big>'''[sugar-plugin-*]'''</big></div>
Configure particular [[Deployment_Platform/Sugar_Shell#Plugins|Shell plugin]].