[debian-edu-commits] debian-edu/ 12/183: Added initial attempt at man page

Wed Jun 11 16:48:29 UTC 2014

This is an automated email from the git hooks/post-receive script.

ccscanf-guest pushed a commit to branch master
in repository desktop-profiles.

commit 269100c785c94b315993f5a06e176c4e0d4546b8
Author: Bart Cornelis <cobaco at linux.be>
Date:   Tue Oct 19 21:46:30 2004 +0000

    Added initial attempt at man page
---
 debian/rules       |   1 +
 desktop-profiles.7 | 113 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 114 insertions(+)

diff --git a/debian/rules b/debian/rules
index b65bedb..8684ea5 100755
--- a/debian/rules
+++ b/debian/rules
@@ -32,6 +32,7 @@ binary-indep: build install
 	dh_installchangelogs
 	dh_installdocs
 	dh_installexamples path
+	dh_installman desktop-profiles.7
 	dh_install 20desktop-profiles_activateDesktopProfiles etc/X11/Xsession.d/
 	dh_install default.listing etc/desktop-profiles/
 	dh_compress
diff --git a/desktop-profiles.7 b/desktop-profiles.7
new file mode 100644
index 0000000..1cc58d3
--- /dev/null
+++ b/desktop-profiles.7
@@ -0,0 +1,113 @@
+.TH DESKTOP-PROFILES 7 "October 19, 2004"
+
+.SH NAME
+desktop-profiles \- introduction and overview
+
+.SH DESCRIPTION
+Desktop-profiles is a framework for activating and deactivating profiles (conditional setups) for the various desktop environments in Debian. 
+.PP
+It currently supports KDE, Freedesktop, and ROX out of the box. Support for Gconf (i.e. Gnome) profiles  is present but needs a change to the default gconf configuration to be activated (see 
+.B "HOW IT WORKS"
+below).
+
+.SH HOW IT WORKS
+All available profiles are described in .listing files placed in /etc/desktop-profiles. These files contain basic information about the profiles such as the name of the profile, where to access the profile, and which criteria need to be met to activate the profile (see 
+.B "FORMAT OF .listing FILES"
+below).
+.PP
+On X startup an Xsession.d script is run that activates all profiles for which the criteria are met in order of precedence.
+.PP
+For KDE, Freedesktop, and ROX profiles activating profiles is done by setting, respectively, the KDEDIRS, XDG_CONFIG_DIRS & XDG_DATA_DIRS, and CHOISEPATH environment variables to the correct values 
+.PP
+For GConf profiles a user-specific path file is generated containing all the "configuration sources" needed for the to-be-activated profiles. To actually activate the profiles the system-wide path file (/etc/gconf/<gconf-version>/path) needs to be replaced with one including the generated path file (e.g. /usr/share/doc/desktop-profiles/examples/path ; which will give the same behaviour as the default gconf setup using profiles).
+.PP
+NOTE: Environment variables are only set if they're value is different from the default value, and user-specific path files are only generated if the systemwide gconf path file will include them.
+
+.SH FORMAT OF .listing FILES
+Empty lines and lines starting with \'#\' (i.e. comment lines) are ignored. All other must be made up of the following 6 fields (separated by \';\'):
+.IP \(bu 4
+.B 1st field
+: Name of the profile, arbitrary, may be empty
+.IP \(bu 4
+.B 2nd field: 
+.IP 
+Location of the root of the profile directory tree, may contain more then 1 directory (in which case directies should be separated with spaces).
+.IP
+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>' ).
+.IP \(bu 4
+.B 3th field
+: A Numeric precedence value for the profile, may be empty (which is treated as lowest possible precedence).
+.IP
+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.
+.IP \(bu 4
+.B 4th field
+: 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).
+.IP
+There are 3 different kinds of requirements: 
+.IP  
+1) <group>      = user needs to be a member of <group>
+.IP  
+2) !<group>     = user mustn't be a member of <group>
+.IP
+   (Note: '!' deactivates the profile completely)
+.IP  
+3) $(<command>) = <command> needs to exit succesfully ($?=0)
+.IP
+   (Where <command> is an arbitrary shell command)
+.IP \(bu 4
+.B 5th field
+: The kind of profile, must be set and one of: KDE, ROX, XDG_CONFIG, XDG_DATA, or GCONF.
+.IP \(bu 4
+.B 6th field
+: A description of what the profile is/does, may be empty.
+
+.SH CREATING PROFILES
+.IP \(bu 4
+.B KDE 
+(through KDEDIRS):
+.IP
+Each profile directory is layed out according to the KDE file system hierarchy (see http://www.kde.org/areas/sysadmin/fsh.php)
+.IP    
+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.
+.IP    
+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).
+.IP \(bu 4
+.B Freedesktop 
+(through XDG_*_DIRS):
+.IP
+The 'Desktop base directory specification' defines the basic framework for using profiles (see http://freedesktop.org/Standards/basedir-spec).
+.IP
+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.
+.IP \(bu 4
+.B ROX 
+(through CHOICESPATH):
+.IP
+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.
+.IP     
+NOTE: Programs _may_ merge the files the different profiles. If the merging encounters conflicting values the one from the highest order profile is used. 
+.IP   
+See http://rox.sourceforge.net/choices.html for a more detailed description.
+.IP \(bu 4
+.B GNOME 
+(using GConf 'Configuration Sources'):
+.IP
+Each configuration source is structured like a simple hierarchical file system as follows:
+.IP
+- Directories correspond to applications that use the GConf repository, except for the ' schemas' directory which contains files describing all of the preference keys.
+.IP
+- Subdirectories correspond to categories of preferences.
+.IP
+- Files list the preference keys in the directory, and contain information about the keys. 
+.IP
+- Configuration Sources are searched in order for each value, first source that has the value (or is writeable in case of storing values) is used.
+.IP    
+-> See the GNOME administration manual for a detailed explanation
+
+.SH FILES
+/etc/desktop-profiles/default.listing - Details the default settings for the various environments. These should be used as fallback in most cases.
+.PP
+/etc/X11/Xsession.d/20desktop-profiles_activateDesktopProfiles 
+Xsesssion.d script that activates the profiles
+
+.SH AUTHOR
+This manual page was written by Bart Cornelis <cobaco at skolelinux.no>.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-edu/pkg-team/desktop-profiles.git

