[debian-edu-commits] debian-edu/ 28/183: Add man page for list-desktop-profiles sript, which finishes up 1.1

[Alexander Alemayhu]

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 f8349dcde3427e3f3475c3b1135c898ef92fe38b
Author: Bart Cornelis <cobaco at linux.be>
Date:   Thu Nov 11 21:51:36 2004 +0000

    Add man page for list-desktop-profiles sript, which finishes up 1.1
---
 debian/changelog        |   6 ++-
 debian/rules            |   2 +-
 desktop-profiles.7      |   7 ++-
 list-desktop-profiles   |   8 +--
 list-desktop-profiles.1 | 127 ++++++++++++++++++++++++++++++++++++++++++++++++
 5 files changed, 143 insertions(+), 7 deletions(-)

diff --git a/debian/changelog b/debian/changelog
index 861d66f..2492ef2 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,9 +1,11 @@
-desktop-profiles (1.0-3) UNRELEASED; urgency=low
+desktop-profiles (1.1-1) unstable; urgency=low
 
   * Add script for listing profiles (that answer to certain criteria), so
     the admin doesn't need to search through all the .listing files himself
+  * Allow admin to never activate profile kinds, gives small on x-startup to 
+    disable profile kinds you'll never use.
 
- -- Bart Cornelis (cobaco) <cobaco at linux.be>  Thu,  4 Nov 2004 21:22:14 +0100
+ -- Bart Cornelis (cobaco) <cobaco at linux.be>  Thu,  11 Nov 2004 22:39:14 +0100
 
 desktop-profiles (1.0-2) unstable; urgency=low
 
diff --git a/debian/rules b/debian/rules
index 3f24673..4b37913 100755
--- a/debian/rules
+++ b/debian/rules
@@ -32,7 +32,7 @@ binary-indep: build install
 	dh_installchangelogs
 	dh_installdocs
 	dh_installexamples path
-	dh_installman desktop-profiles.7
+	dh_installman desktop-profiles.7 list-desktop-profiles.1
 	dh_install listingmodule usr/share/desktop-profiles/
 	dh_install list-desktop-profiles usr/bin/
 	dh_install desktop-profiles etc/default
diff --git a/desktop-profiles.7 b/desktop-profiles.7
index 8c62fa2..14b250e 100644
--- a/desktop-profiles.7
+++ b/desktop-profiles.7
@@ -1,4 +1,4 @@
-.TH DESKTOP-PROFILES 7 "October 19, 2004"
+.TH DESKTOP-PROFILES 7 "October 19, 2004" "desktop-profiles"
 
 .SH NAME
 desktop-profiles \- introduction and overview
@@ -131,6 +131,11 @@ Each configuration source is structured like a simple hierarchical file system a
 /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
+.PP
+/etc/default/desktop-profiles - File containing default settings for the scripts in this package.
 
 .SH AUTHOR
 This manual page was written by Bart Cornelis <cobaco at skolelinux.no>.
+
+.SH SEE ALSO
+list-desktop-profiles(1)
diff --git a/list-desktop-profiles b/list-desktop-profiles
index 5b72953..332ba7a 100644
--- a/list-desktop-profiles
+++ b/list-desktop-profiles
@@ -12,9 +12,11 @@
 
 print_help () {
 cat <<EOF
-Usage: manage-desktop-profiles [OPTIONS]
- Debconf interface for managing the contents of the .listing files used by the
- desktop-profiles package.
+Usage: list-desktop-profiles [OPTIONS]
+  As the number of .listing files grows, trying to find out which profiles are
+  present/meet certain criteria becomes increasingly unpleasant. This script
+  remedies that, allowing you to just list your criteria, and outputting all
+  profiles meeting those criteria.
 
 Options controlling the used .listing files:
   -d | --directory: directory where to look for .listing files
diff --git a/list-desktop-profiles.1 b/list-desktop-profiles.1
new file mode 100644
index 0000000..d3d676a
--- /dev/null
+++ b/list-desktop-profiles.1
@@ -0,0 +1,127 @@
+.TH LIST-DESKTOP-PROFILES 7 "November 11, 2004" "desktop-profiles"
+
+.SH NAME
+list-desktop-profiles \- list profiles meeting specific criteria
+
+.SH SYNOPSIS
+list-desktop-profiles [OPTION]
+
+.SH DESCRIPTION
+As the number of .listing files grows, trying to find out which profiles are present/meet certain criteria becomes increasingly unpleasant. This script remedies that allowing you to just list your criteria, and outputting all profiles meeting those criteria.
+.PP
+By default it will just output the lines from the .listing files for each (matching) profile, but you can specifying a formatstring to fancy up the output.
+.PP
+
+.SH OPTIONS
+.PP
+-n <regexp>, --name <regexp>
+.IP
+Limit shown profiles to those for which the name (1st) field of the profile description needs matches the given regular expression.
+
+.PP
+-l <regexp>, --location <regexp> 
+.IP
+Limit shown profiles to those for which the location (2nd) field of the profile description needs matches the given regular expression.
+
+.PP
+-p <comparison>,- -precedence <comparison>
+.IP
+Limit shown profiles to those for which the precedence (3th) field of the profile description succeeds the given comparison. In the comparison you can Use 'gt' for 'greater then', 'lt' for 'less then', 'ge' for 'greater then or equal to', 'le' for 'less then or equal to', 'eq' for 'equal to', and 'ne' for 'not equal to'. (NOTE: empty precedence-field, is lowest possible precedence)
+
+.PP
+-r <regexp>, --requirement <regexp>
+.IP
+Limit shown profiles to those for which the requirements (4th) field of the profile description needs matches the given regular expression.
+
+.PP
+-k <regexp>, --kind <regexp> 
+.IP
+Limit shown profiles to those for which the kind (5th) field of the profile description needs matches the given regular expression.
+
+.PP
+-c <regexp>, --comment <regexp>,- -description <regexp>
+.IP
+Limit shown profiles to those for which the comment (6th) field of the profile description needs matches the given regular expression.
+
+.PP
+-u <username>, --user <username> 
+.IP
+Limit shown profiles to those for which the given user meets the requirements. (NOTE: might not work when using shell command requirements that depend on the users environment).
+
+.PP
+-d <dir>, --directory <dir>
+.IP
+Also use .listing files found in the given directory
+
+.PP
+-f <path>, --file <path> 
+.IP
+Also use the specified .listing file
+
+.PP
+-e <formatstring>, --entry-format <formatstring>
+.IP
+Show profile information according to the specified format spring (instead of just echoing the profile-line). The format string may use the following variables: NAME, LOCATION, PRECEDENCE, REQUIREMENTS, KIND, DESCRIPTION, FILE; the first 6 of these refer to the corresponding field, the last refers to the .listing file the profile is in. (e.g. '$FILE_$NAME - $DESCRIPTION'). Any characters that are interpreted specially by the shell should be escaped.
+
+.PP
+-s <fieldname>, --sort-key <fieldname>
+.IP
+Sort output on the requested field (fieldname is one of name, location, precedence, requirements, kind, or description.
+
+.SH EXAMPLES
+.PP
+list-desktop-profiles -k KDE -s precedence -u user1
+.IP
+List all kde-profiles that will be activated for user1 in order of precedence.
+
+.PP
+list-desktop-profiles -k 'KDE\|GCONF'
+.IP
+List all kde and gnome profiles.
+.PP
+list-desktop-profiles -p 'gt 50'
+.IP
+List all profiles with a precedence value greater then 50.
+
+.SH ENVIRONMENT
+.PP
+NAME_FILTER, LOCATION_FILTER, PRECEDENCE_FILTER, REQUIREMENT_FILTER, KIND_FILTER, DESCRIPTION_FILTER
+.IP 
+Can be used to specify the default regular expressions and comparisons. Default to empty.
+
+.PP
+OUR_USER
+.IP
+Set the user for which the requirements need to be met. Defaults to unset.
+
+.PP
+EXTRA_LISTINGS
+.IP
+Can be used to specify a (space separated) list of extra .listing files to include. Defaults to empty
+
+.PP
+FORMAT
+.IP
+Can be used to specify the default format string. By default it will output the profile-line from the .listing file.
+
+.PP
+SORT_KEY
+.IP
+Can be used to specify the default sort-key (= field number). Defaults to 1
+
+.SH FILES
+/etc/desktop-profiles/*.listing - Files containing the data about installed profiles
+.PP
+/etc/default/desktop-profiles - File containing default settings for this script (by way of the environment variables above)
+
+.SH BUGS
+The '-u <username>' is not guaranteed to work correctly for shell command requirements. Particulary this will give incorrect results if the shell command depends on some state of the user environment.
+.PP
+
+.SH AUTHOR
+This manual page was written by Bart Cornelis <cobaco at skolelinux.no>.
+.PP
+
+.SH SEE ALSO
+desktop-profiles(7)
+

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