Docu update

1 files changed, 82 insertions, 41 deletions

diff --git a/scripts/man/xdg-desktop-menu.1 b/scripts/man/xdg-desktop-menu.1
index 485744e..c70e768 100644
--- a/scripts/man/xdg-desktop-menu.1
+++ b/scripts/man/xdg-desktop-menu.1
@@ -2,7 +2,7 @@
 .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
 .\" Instead of manually editing it, you probably should edit the DocBook XML
 .\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "XDG\-DESKTOP\-MENU" "1" "09/11/2006" "xdg\-utils 1.0 beta4" ""
+.TH "XDG\-DESKTOP\-MENU" "1" "09/13/2006" "xdg\-utils 1.0 beta4" ""
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
@@ -28,6 +28,16 @@ The application menu works according to the XDG Desktop Menu Specification at ht
 install
 Install one or more applications in a submenu of the desktop menu system.
 .sp
+\fIdesktop\-file\fR: A desktop file represents a single menu entry in the menu. Desktop files are defined by the freedesktop.org Desktop Entry Specification. The most important aspects of *.desktop files are summarized below.
+.sp
+Menu entries can be added to the menu system in two different ways. They can either be added to a predefined submenu in the menu system based on one or more category keywords, or they can be added to a new submenu.
+.sp
+To add a menu entry to a predefined submenu the desktop file that represents the menu entry must have a Categories= entry that lists one or more keywords. The menu item will be included in an appropriate submenu based on the included keywords.
+.sp
+To add menu items to a new submenu the desktop\-files must be preceded by a directory\-file that describes the submenu. If multiple desktop\-files are specified, all entries will be added to the same menu. If entries are installed to a menu that has been created with a previous call to
+\fBxdg\-desktop\-menu\fR
+the entries will be installed in addition to any already existing entries.
+.sp
 \fIdirectory\-file\fR: The *.directory file indicated by
 \fIdirectory\-file\fR
 represents a submenu. The directory file provides the name and icon for a submenu. The name of the directory file is used to identify the submenu.
@@ -35,12 +45,6 @@ represents a submenu. The directory file provides the name and icon for a submen
 If multiple directory files are provided each file will represent a submenu within the menu that preceeds it, creating a nested menu hierarchy (sub\-sub\-menus). The menu entries themselves will be added to the last submenu.
 .sp
 Directory files follow the syntax defined by the freedesktop.org Desktop Entry Specification.
-.sp
-\fIdesktop\-file\fR: A desktop file represents a single application in the menu. Desktop files are defined by the freedesktop.org Desktop Entry Specification. The most important aspects of *.desktop files are summarized below.
-.sp
-If multiple desktop\-files are specified, multiple entries will be added to the same menu. If entries are installed to a menu that has been created with a previous call to
-\fBxdg\-desktop\-menu\fR
-the entries will be installed in addition to any already existing entries.
 .TP
 uninstall
 Remove applications or submenus from the desktop menu system previously installed with
@@ -81,38 +85,6 @@ Show this manualpage.
 .TP
 \fB\-\-version\fR
 Show the xdg\-utils version information.
-.SH "DIRECTORY FILES"
-.PP
-The appearance of submenu in the application menu is provided by a *.directory file. In particular it provides the title of the submenu and a possible icon. A *.directory file consists of a
-\fI[Desktop Entry]\fR
-header followed by several
-\fIKey\fR=\fIValue\fR
-lines.
-.PP
-A *.directory file can provide a title (name) for the submenu in several different languages. This is done by adding a language code as used by LC_MESSAGES in square brackets behind the
-\fIKey\fR. This way one can specify different values for the same
-\fIKey\fR
-depending on the currently selected language.
-.PP
-The following keys are relevqnt for submenus:
-.TP
-Value=1.0
-This is a mandatory field to indicate that the *.directory file follows the 1.0 version of the Desktop Entry specification.
-.TP
-Type=Directory
-This is a mandatory field that indicates that the *.directory file describes a submenu.
-.TP
-Name=\fIMenu Name\fR
-The title of submenu. For example
-\fIMozilla\fR
-.TP
-Comment=\fIComment\fR
-Optional field to specify a tooltip for the submenu.
-.TP
-Icon=\fIIcon File\fR
-The icon to use for the submenu. This can either be an absolute path to an image file or an icon\-name. If an icon\-name is provided an image lookup by name is done in the user's current icon theme. The
-\fBxdg\-icon\-resource\fR
-command can be used to install image files into icon themes. The advantage of using an icon\-name instead of an absolute path is that with an icon\-name the submenu icon can be provided in several different sizes as well as in several differently themed styles.
 .SH "DESKTOP FILES"
 .PP
 An application item in the application menu is represented by a *.desktop file. A *.desktop file consists of a
@@ -154,10 +126,49 @@ command can be used to install image files into icon themes. The advantage of us
 Exec=\fICommand Line\fR
 The command line to start the application. If the application can open files the %f placeholder should be specified. When a file is dropped on the application launcher the %f is replaced with the file path of the dropped file. If multiple files can be specified on the command line the %F placeholder should be used instead of %f. If the application is able to open URLs in addition to local files then %u or %U can be used instead of %f or %F.
 .TP
+Categories=\fICategories\fR
+A list of categories separated by semi\-colons. A category is a keyword that describes and classifies the application. By default applications are organized in the application menu based on category. When menu entries are explicitly assigned to a new submenu it is not necassery to list any categories.
+.sp
+When using categories it is recommended to include one of the following categories: AudioVideo, Development, Education, Game, Graphics, Network, Office, Settings, System, Utility.
+.sp
+See Appendix A of the XDG Desktop Menu Specification for information about additional categories. http://standards.freedesktop.org/menu\-spec/menu\-spec\-1.0.html
+.TP
 MimeType=\fIMimetypes\fR
 A list of mimetypes separated by semi\-colons. This field is used to indicate which file types the application is able to open.
 .PP
 For a complete oveview of the *.desktop file format please visit http://www.freedesktop.org/wiki/Standards/desktop\-entry\-spec
+.SH "DIRECTORY FILES"
+.PP
+The appearance of submenu in the application menu is provided by a *.directory file. In particular it provides the title of the submenu and a possible icon. A *.directory file consists of a
+\fI[Desktop Entry]\fR
+header followed by several
+\fIKey\fR=\fIValue\fR
+lines.
+.PP
+A *.directory file can provide a title (name) for the submenu in several different languages. This is done by adding a language code as used by LC_MESSAGES in square brackets behind the
+\fIKey\fR. This way one can specify different values for the same
+\fIKey\fR
+depending on the currently selected language.
+.PP
+The following keys are relevqnt for submenus:
+.TP
+Value=1.0
+This is a mandatory field to indicate that the *.directory file follows the 1.0 version of the Desktop Entry specification.
+.TP
+Type=Directory
+This is a mandatory field that indicates that the *.directory file describes a submenu.
+.TP
+Name=\fIMenu Name\fR
+The title of submenu. For example
+\fIMozilla\fR
+.TP
+Comment=\fIComment\fR
+Optional field to specify a tooltip for the submenu.
+.TP
+Icon=\fIIcon File\fR
+The icon to use for the submenu. This can either be an absolute path to an image file or an icon\-name. If an icon\-name is provided an image lookup by name is done in the user's current icon theme. The
+\fBxdg\-icon\-resource\fR
+command can be used to install image files into icon themes. The advantage of using an icon\-name instead of an absolute path is that with an icon\-name the submenu icon can be provided in several different sizes as well as in several differently themed styles.
 .SH "ENVIRONMENT VARIABLES"
 .PP
 xdg\-desktop\-menu honours the following environment variables:
@@ -189,9 +200,39 @@ No permission to read one of the files passed on the command line.
 \fBxdg\-mime\fR(1)
 .SH "EXAMPLES"
 .PP
-The company ShinyThings Inc. has developed an application named "WebMirror" and would like to add it to the application menu. The company will use "shinythings" as its vendor id. In this example the company ShinyThings Inc. will add its own submenu to the desktop application menu consisting of a "WebMirror" menu item and a "WebMirror Admin Tool" menu item.
+The company ShinyThings Inc. has developed an application named "WebMirror" and would like to add it to the application menu. The company will use "shinythings" as its vendor id. In order to add the application to the menu there needs to be a .desktop file with a suitable
+\fICategories\fR
+entry:
+.sp
+.nf
+shinythings\-webmirror.desktop:
+
+  [Desktop Entry]
+  Encoding=UTF\-8
+  Type=Application
+
+  Exec=webmirror
+  Icon=webmirror
+
+  Name=WebMirror
+  Name[nl]=WebSpiegel
+
+  Categories=Network;WebDevelopment;
+.fi
+.sp
+.PP
+Now the xdg\-desktop\-menu tool can be used to add the shinythings\-webmirror.desktop file to the desktop application menu:
+.sp
+.nf
+xdg\-desktop\-menu install ./shinythings\-webmirror.desktop
+.fi
+.sp
+.PP
+Note that for the purpose of this example the menu items are available in two languages, English and Dutch. The language code for Dutch is nl.
+.PP
+In the next example the company ShinyThings Inc. will add its own submenu to the desktop application menu consisting of a "WebMirror" menu item and a "WebMirror Admin Tool" menu item.
 .PP
-First the company needs to create two .desktop files that describe the two menu items:
+First the company needs to create two .desktop files that describe the two menu items. Since the items are to be added to a new submenu it is not necassery to include a Categories= line:
 .sp
 .nf
 shinythings\-webmirror.desktop: