← Back to branch summary

~ubuntu-branches/ubuntu/utopic/desktop-profiles/utopic-proposed

« back to all changes in this revision

Viewing changes to desktop-profiles.7

  • Committer: Bazaar Package Importer
  • Author(s): Bart Cornelis (cobaco)
  • Date: 2006-10-06 11:28:11 UTC
  • mfrom: (1.1.3 edgy)
  • Revision ID: james.westby@ubuntu.com-20061006112811-jdx0y44bv2kz07pb
Tags: 1.4.13
http://bugs.debian.org/387015
http://bugs.debian.org/388884
* fixed small mistake in for_each_requirement function of listingmodule
  (triggered for profiles multiple shell-command requirements)
* Updated French translation by Jean-Luc Coulon (Closes: #387015)
* Adapted man page to unclude reference to /usr/sbin/path2listing for gconf
* Removed medium priority note pointing gconf users to the path2listing
  script, that info is now in the man-page and the README (Closes: #388884)

Show diffs side-by-side

added added

removed removed

Lines of Context:
desktop-profiles.7
16
16
Specifically each profile is associated with a set of requirements, and a precedence value. On X startup the Xsession.d script will check for each profile whether the requirements are met, and then activate all those profiles whose requirements are met in order of precedence.
17
17
.PP
18
18
Exactly how a profile is activated depends on the profile kind (you don't need to know this in order to use this package):
19
 
.IP \(bu 4
 
19
.IP \(bu 3
20
20
For KDE, Freedesktop, XFCE (>= 4.2), ROX, GNUSTEP and UDE activating profiles is done by setting environment variables: KDEDIRS for KDE, XDG_CONFIG_DIRS and XDG_DATA_DIRS for both Freedesktop and XFCE, CHOICESPATH for ROX, GNUSTEP_PATHLIST for GNUSTEP (usually initialized from the various GNUSTEP_*_ROOT variables) and UDEdir for UDE. With the exception of UDEdir, which takes a single directory, each of these variables takes a precedence ordered list of root-directories (of activated profiles).
21
 
.IP \(bu 4
22
 
For GConf profiles two user-specific path files are generated. One containing the activated mandatory "configuration sources", one containing the default "configuration sources" that are activated. 
23
 
.IP 
24
 
As the default system-wide path file (/etc/gconf/<gconf-version>/path) currently doesn't include the generated path files you'll need to replace it with one that does (/usr/share/doc/desktop-profiles/examples/path is a path file which will give the same behaviour as the default gconf setup as long as no additional profiles are present).
 
21
.IP \(bu 3
 
22
For GConf profiles two user-specific path files are generated. One containing the activated mandatory "configuration sources", one containing the default "configuration sources" that are activated. At the moment the default system-wide path file doesn't include these automatically, this package provides a script (/usr/sbin/path2listing) that looks at your current configuration and adapts so your configuration sources are controlled by desktop-profiles (see the man page for path2listing or the /usr/share/doc/destkop-profiles/README for more information on this).
25
23
.IP NOTE:
26
24
Environment variables will only be set if their value is different from the default value, and user-specific path files are only generated if the systemwide gconf path file will include them. This to avoid unnecessary clutter.
27
25
.IP NOTE:
38
36
Comment lines start with \'#\' and are purely for human consumption, like empty lines they are ingored completely by the Xsession.d script.
39
37
.PP
40
38
Lines containing profile metadata are made up of 6 fields separated by a semi-colon (\';\'). Where the meaning of the fields is as follows:
41
 
.IP \(bu 4
 
39
.IP \(bu 3
42
40
.B 1st field
43
41
: Name of the profile, arbitrary, must be unique within each file, and may (but probably should not) be empty.
44
 
.IP \(bu 4
 
42
.IP \(bu 3
45
43
.B 2nd field
46
44
: The kind of profile, must be set, must be one of: KDE, XDG_CONFIG, XDG_DATA, GCONF, ROX, GNUSTEP, or UDE.
47
 
.IP \(bu 4
 
45
.IP \(bu 3
48
46
.B 3th field: 
49
47
.IP 
50
48
Location of the root of the profile directory tree, may contain more then 2 directory (in which case directies should be separated with spaces). Environment variables may be used when specifying root directories (e.g. $HOME/.extra_config).
51
49
.IP
52
50
Except for Gconf profiles, which use the this field to contain exactly one directive to be included in the generated path file (directives are either \'xml:(readonly|readwrite):<profile-root>\', or \'include <some-path-file>' ).
53
 
.IP \(bu 4
 
51
.IP \(bu 3
54
52
.B 4th field
55
53
: A Numeric precedence value for the profile, may be empty (which is treated as lowest possible precedence).
56
54
.IP
57
55
When 2 (or more) active profiles define a setup for the same thing, the value specified by the profile with the highest precedence value is used (UDE will onlyuse values from the highest ranked profile).
58
 
.IP \(bu 4
 
56
.IP \(bu 3
59
57
.B 5th field
60
58
: Space separated list of conditions that need to be met to activate the profiles (if more then 1 condition is specified all conditions need to be met to activate the profile).
61
59
.IP
70
68
3) $(<command>) = <command> needs to exit succesfully ($?=0)
71
69
.IP
72
70
   (Where <command> is an arbitrary shell command)
73
 
.IP \(bu 4
 
71
.IP \(bu 3
74
72
.B 6th field
75
73
: A description of what the profile is/does, may be empty.
76
74
.IP
77
75
Note that this basically boils down to a CSV-file using \';\' as separator and allowing shell-style comments.
78
76
 
79
77
.SH CREATING PROFILES
80
 
.IP \(bu 4
 
78
.IP \(bu 3
81
79
.B KDE 
82
80
(through KDEDIRS):
83
81
.IP
86
84
Config files in the different profiles are merged (in case of conflicting keys, the value of the highest precedence profile is used). For other files the highest precedence profile that contains the file supplies it.
87
85
.IP    
88
86
Starting with kde 3.3. the kiosk framework can be used to lock settings down in the profiles, for all unlocked settings user-specified values are always used when available. (see http://www.kde.org/areas/sysadmin for more info on the kiosk-framework, and the format of the kde config files).
89
 
.IP \(bu 4
 
87
.IP \(bu 3
90
88
.B Freedesktop 
91
89
(using XDG_CONFIG_DIRS and XDG_DATA_DIRS)
92
90
.IP
95
93
The actual contents of the profiles is filled in by things conforming to other freedesktop standards (e.g. the 'menu specification'). A list of freedesktop standards (that are being worked on) can be found at http://freedesktop.org/Standards. Most of these standards are still under development and not (yet) widely supported. Eventually you can probably suspect support of at least KDE, GNOME, ROX, and XFCE.
96
94
.IP
97
95
XFCE (>=4.2) specific settings can also be found in Freedesktop profile dirs (see the next section for details).
98
 
.IP \(bu 4
 
96
.IP \(bu 3
99
97
.B XFCE
100
98
(using XDG_CONFIG_DIRS and XDG_DATA_DIRS)
101
99
.IP
104
102
If two profiles contain the same config file, the one from the profile with the highest precedence is used.
105
103
.IP
106
104
XFCE versions prior to 4.2. don't support multiple config sets.
107
 
.IP \(bu 4
 
105
.IP \(bu 3
108
106
.B ROX 
109
107
(through CHOICESPATH):
110
108
.IP
111
 
Each profile directory has one subdirectory for each app for which it provides settings. When a configuration value is needed the profile directorys are searched in order, first profile that contains the file supplies it.
 
109
Each profile directory has one subdirectory for each app for which it provides settings. When a configuration value is needed the profile directories are searched in order, first profile that contains the file supplies it.
112
110
.IP NOTE:
113
111
Programs _may_ merge the files the different profiles. If the merging encounters conflicting values the one from the highest order profile is used. 
114
112
.IP   
115
113
See http://rox.sourceforge.net/choices.html for a more detailed description.
116
 
.IP \(bu 4
 
114
.IP \(bu 3
117
115
.B GNUSTEP (through GNUSTEP_PATHLIST)
118
116
.IP
119
117
Profiles in GNUSTEP parlance are called domains, and by default GNUSTEP will look in 4 domains (the location of which is indicated by the GNUSTEP_USER_ROOT, GNUSTEP_LOCAL_ROOT, GNUSTEP_NETWORK_ROOT, and GNUSTEP_SYSTEM_ROOT variables). Though it is possible to specify extra domains to use through the GNUSTEP_PATHLIST variable, it isn't often done as configuration files are currently only searched for in the user domain.
120
118
.IP
121
 
For more information on GNUSTEP domains see http://www.gnustep.org/resources/documentation/User/GNUstep/filesystem.html
122
 
.IP \(bu 4
 
119
For more information on GNUSTEP domains see 
 
120
www.gnustep.org/resources/documentation/User/GNUstep/filesystem.html
 
121
.IP \(bu 3
123
122
.B UDE
124
123
(through UDEdir):
125
124
.IP
130
129
2. $UDEdir/config  (or in absence of $UDEdir in the install dir which is /usr/share/ude on debian)
131
130
.IP
132
131
3. If the configuration file is still not found, UWM takes the filename as it is (usually dereferencing any environment variables first)
133
 
.IP \(bu 4
 
132
.IP \(bu 3
134
133
.B GNOME 
135
134
(using GConf 'Configuration Sources'):
136
135
.IP
159
158
This manual page was written by Bart Cornelis <cobaco@skolelinux.no>.
160
159
 
161
160
.SH SEE ALSO
162
 
list-desktop-profiles(1), profile-manager(1), dh_installlisting(1)
 
161
list-desktop-profiles(1), profile-manager(1), dh_installlisting(1), path2listing(1)