diff options
author | Waldo Bastian <waldo.bastian@intel.com> | 2006-08-01 00:19:12 +0000 |
---|---|---|
committer | Waldo Bastian <waldo.bastian@intel.com> | 2006-08-01 00:19:12 +0000 |
commit | bd75e5b3d539846fcfbed02a0e07dfda43340ea6 (patch) | |
tree | 0eb461f0adcaf0abb06b272e6d01cc2fb22c19f8 /scripts/man | |
parent | c5958cf86b5d795ac9cec7672be00d181ff65345 (diff) |
Replace --vendor with an implicit check for a vendor prefix and --novendor
to override.
Diffstat (limited to 'scripts/man')
-rw-r--r-- | scripts/man/xdg-desktop-icon.1 | 207 | ||||
-rw-r--r-- | scripts/man/xdg-desktop-menu.1 | 371 | ||||
-rw-r--r-- | scripts/man/xdg-email.1 | 169 | ||||
-rw-r--r-- | scripts/man/xdg-icon-resource.1 | 216 | ||||
-rw-r--r-- | scripts/man/xdg-mime.1 | 261 | ||||
-rw-r--r-- | scripts/man/xdg-open.1 | 108 | ||||
-rw-r--r-- | scripts/man/xdg-screensaver.1 | 146 | ||||
-rw-r--r-- | scripts/man/xdg-su.1 | 2 |
8 files changed, 607 insertions, 873 deletions
diff --git a/scripts/man/xdg-desktop-icon.1 b/scripts/man/xdg-desktop-icon.1 index 88d015b..dc9076f 100644 --- a/scripts/man/xdg-desktop-icon.1 +++ b/scripts/man/xdg-desktop-icon.1 @@ -1,203 +1,158 @@ -.\"Generated by db2man.xsl. Don't modify this, modify the source. -.de Sh \" Subsection -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp -.. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.TH "XDG-DESKTOP-ICON" 1 "" "" "xdg-desktop-icon Manual" -.SH NAME -xdg-desktop-icon \- command line tool for (un)installing icons to the desktop -.SH "SYNOPSIS" +.\" ** You probably do not want to edit this file directly ** +.\" 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\-ICON" "1" "07/31/2006" "xdg\-utils 1.0 beta2" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) .ad l -.hy 0 +.SH "NAME" +xdg\-desktop\-icon \- command line tool for (un)installing icons to the desktop +.SH "SYNOPSIS" .HP 17 -\fBxdg\-desktop\-icon\fR install [\fB\-\-vendor\ \fIvendor\-id\fR\fR] \fIFILE\fR -.ad -.hy -.ad l -.hy 0 +\fBxdg\-desktop\-icon\fR install [\fB\-\-novendor\fR] \fIFILE\fR .HP 17 -\fBxdg\-desktop\-icon\fR uninstall [\fB\-\-vendor\ \fIvendor\-id\fR\fR] \fIFILE\fR -.ad -.hy -.ad l -.hy 0 +\fBxdg\-desktop\-icon\fR uninstall \fIFILE\fR .HP 17 -\fBxdg\-desktop\-icon\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} -.ad -.hy - +\fBxdg\-desktop\-icon\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} .SH "DESCRIPTION" - .PP -The xdg\-desktop\-icon program can be used to install an application launcher or other file on the desktop of the current user\&. - +The xdg\-desktop\-icon program can be used to install an application launcher or other file on the desktop of the current user. .PP -An application launcher is represented by a *\&.desktop file\&. Desktop files are defined by the freedesktop\&.org Desktop Entry Specification\&. The most important aspects of *\&.desktop files are summarized below\&. - +An application launcher is represented by a *.desktop file. Desktop files are defined by the freedesktop.org Desktop Entry Specification. The most important aspects of *.desktop files are summarized below. .SH "COMMANDS" - .TP install -Installs \fIFILE\fR to the desktop of the current user\&. \fIFILE\fR can be a *\&.desktop file or any other type of file\&. - +Installs +\fIFILE\fR +to the desktop of the current user. +\fIFILE\fR +can be a *.desktop file or any other type of file. .TP uninstall -Removes \fIFILE\fR from the desktop of the current user\&. - +Removes +\fIFILE\fR +from the desktop of the current user. .SH "OPTIONS" - .TP -\fB\-\-vendor\fR \fIvendor\-id\fR -Adds \fIvendor\-id\fR as a prefix when installing desktop files\&. - +\fB\-\-novendor\fR +Normally, xdg\-desktop\-icon checks to ensure that a *.desktop file to be installed has a vendor prefix. This option can be used to disable that check. +.sp +A vendor prefix consists of alpha characters ([a\-zA\-Z]) and is terminated with a dash ("\-"). Companies and organizations are encouraged to use a word or phrase, preferably the organizations name, for which they hold a trademark as their vendor prefix. The purpose of the vendor prefix is to prevent name conflicts. .TP \fB\-\-help\fR -Show command synopsis\&. - +Show command synopsis. .TP \fB\-\-manual\fR -Show this manualpage\&. - +Show this manualpage. .TP \fB\-\-version\fR -Show the xdg\-utils version information\&. - +Show the xdg\-utils version information. .SH "DESKTOP FILES" - .PP -An application launcher can be added to the desktop by installing a *\&.desktop file\&. A *\&.desktop file consists of a \fI[Desktop Entry]\fR header followed by several \fIKey\fR=\fIValue\fR lines\&. - +An application launcher can be added to the desktop by installing a *.desktop file. A *.desktop file consists of a +\fI[Desktop Entry]\fR +header followed by several +\fIKey\fR=\fIValue\fR +lines. .PP -A *\&.desktop file can provide a name and description for an application 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\&. - +A *.desktop file can provide a name and description for an application 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 often used: - .TP -Value=1\&.0 -This is a mandatory field to indicate that the *\&.desktop file follows the 1\&.0 version of the specification\&. - +Value=1.0 +This is a mandatory field to indicate that the *.desktop file follows the 1.0 version of the specification. .TP Type=Application -This is a mandatory field that indicates that the *\&.desktop file describes an application launcher\&. - +This is a mandatory field that indicates that the *.desktop file describes an application launcher. .TP Name=\fIApplication Name\fR -The name of the application\&. For example \fIMozilla\fR - +The name of the application. For example +\fIMozilla\fR .TP GenericName=\fIGeneric Name\fR -A generic description of the application\&. For example \fIWeb Browser\fR - +A generic description of the application. For example +\fIWeb Browser\fR .TP Comment=\fIComment\fR -Optional field to specify a tooltip for the application\&. For example \fIVisit websites on the Internet\fR - +Optional field to specify a tooltip for the application. For example +\fIVisit websites on the Internet\fR .TP Icon=\fIIcon File\fR -The icon to use for the application\&. 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 application icon can be provided in several different sizes as well as in several differently themed styles\&. - +The icon to use for the application. 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 application icon can be provided in several different sizes as well as in several differently themed styles. .TP 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\&. - +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. .PP -For a complete oveview of the *\&.desktop file format please visit http://www\&.freedesktop\&.org/wiki/Standards/desktop\-entry\-spec - +For a complete oveview of the *.desktop file format please visit http://www.freedesktop.org/wiki/Standards/desktop\-entry\-spec .SH "ENVIRONMENT VARIABLES" - .PP xdg\-desktop\-icon honours the following environment variables: - .TP XDG_UTILS_DEBUG_LEVEL -Setting this environment variable to a non\-zero numerical value makes xdg\-desktop\-icon do more verbose reporting on stderr\&. Setting a higher value increases the verbosity\&. - +Setting this environment variable to a non\-zero numerical value makes xdg\-desktop\-icon do more verbose reporting on stderr. Setting a higher value increases the verbosity. .SH "EXIT CODES" - .PP -An exit code of 0 indicates success while a non\-zero exit code indicates failure\&. The following failure codes can be returned: - +An exit code of 0 indicates success while a non\-zero exit code indicates failure. The following failure codes can be returned: .TP \fB1\fR -Error in command line syntax\&. - +Error in command line syntax. .TP \fB2\fR -One of the files passed on the command line did not exist\&. - +One of the files passed on the command line did not exist. .TP \fB3\fR -A required tool could not be found\&. - +A required tool could not be found. .TP \fB4\fR -The action failed\&. - +The action failed. .TP \fB5\fR -No permission to read one of the files passed on the command line\&. - +No permission to read one of the files passed on the command line. .SH "SEE ALSO" - .PP -\fBxdg\-icon\-resource\fR(1) - +\fBxdg\-icon\-resource\fR(1) .SH "EXAMPLES" - .PP -The company ShinyThings Inc\&. has developed an application named "WebMirror" and would like to add a launcher for for on the desktop\&. The company will use "shinythings" as its vendor id\&. In order to add the application to the desktop there needs to be a \&.desktop file for the application: - +The company ShinyThings Inc. has developed an application named "WebMirror" and would like to add a launcher for for on the desktop. The company will use "shinythings" as its vendor id. In order to add the application to the desktop there needs to be a .desktop file for the application: +.sp .nf - -webmirror\&.desktop: +shinythings\-webmirror.desktop: [Desktop Entry] Encoding=UTF\-8 Type=Application Exec=webmirror - Icon=webmirror + Icon=shinythings\-webmirror Name=WebMirror Name[nl]=WebSpiegel - .fi - - +.sp .PP -Now the xdg\-desktop\-icon tool can be used to add the webmirror\&.desktop file to the desktop: - +Now the xdg\-desktop\-icon tool can be used to add the webmirror.desktop file to the desktop: +.sp .nf - -xdg\-desktop\-icon install \-\-vendor shinythings \&./webmirror\&.desktop - +xdg\-desktop\-icon install ./shinythings\-webmirror.desktop .fi - - +.sp .PP -To add a README file to the desktop as well, the following command can be used: - +To add a README file to the desktop as well, the following command can be used: +.sp .nf - -xdg\-desktop\-icon install \&./shinythings\-README - +xdg\-desktop\-icon install ./shinythings\-README .fi - - -.SH AUTHORS -Kevin Krammer, Jeremy White. +.sp +.SH "AUTHOR" +Kevin Krammer, Jeremy White. +.br +<kevin.krammer@gmx.at> +.br +<jwhite@codeweavers.com> diff --git a/scripts/man/xdg-desktop-menu.1 b/scripts/man/xdg-desktop-menu.1 index fb113b0..be51180 100644 --- a/scripts/man/xdg-desktop-menu.1 +++ b/scripts/man/xdg-desktop-menu.1 @@ -1,204 +1,165 @@ -.\"Generated by db2man.xsl. Don't modify this, modify the source. -.de Sh \" Subsection -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp -.. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.TH "XDG-DESKTOP-MENU" 1 "" "" "xdg-desktop-menu Manual" -.SH NAME -xdg-desktop-menu \- command line tool for (un)installing desktop menu items -.SH "SYNOPSIS" +.\" ** You probably do not want to edit this file directly ** +.\" 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" "07/31/2006" "xdg\-utils 1.0 beta2" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) .ad l -.hy 0 +.SH "NAME" +xdg\-desktop\-menu \- command line tool for (un)installing desktop menu items +.SH "SYNOPSIS" .HP 17 -\fBxdg\-desktop\-menu\fR install [\fB\-\-noupdate\fR] [\fB\-\-vendor\ \fIvendor\-id\fR\fR] [\fB\-\-mode\ \fImode\fR\fR] {\fB\fIdesktop\-file\fR\fR | \fB\fImenu\-file\fR\fR | \fB\fIdirectory\-file\fR\fR} -.ad -.hy -.ad l -.hy 0 +\fBxdg\-desktop\-menu\fR install [\fB\-\-noupdate\fR] [\fB\-\-novendor\fR] [\fB\-\-mode\ \fR\fB\fImode\fR\fR] {\fIdesktop\-file\fR \fImenu\-file\fR \fIdirectory\-file\fR} .HP 17 -\fBxdg\-desktop\-menu\fR uninstall [\fB\-\-noupdate\fR] [\fB\-\-vendor\ \fIvendor\-id\fR\fR] [\fB\-\-mode\ \fImode\fR\fR] {\fB\fIdesktop\-file\fR\fR | \fB\fImenu\-file\fR\fR | \fB\fIdirectory\-file\fR\fR} -.ad -.hy -.ad l -.hy 0 +\fBxdg\-desktop\-menu\fR uninstall [\fB\-\-noupdate\fR] [\fB\-\-mode\ \fR\fB\fImode\fR\fR] {\fIdesktop\-file\fR \fImenu\-file\fR \fIdirectory\-file\fR} .HP 17 -\fBxdg\-desktop\-menu\fR forceupdate [\fB\-\-mode\ \fImode\fR\fR] -.ad -.hy -.ad l -.hy 0 +\fBxdg\-desktop\-menu\fR forceupdate [\fB\-\-mode\ \fR\fB\fImode\fR\fR] .HP 17 -\fBxdg\-desktop\-menu\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} -.ad -.hy - +\fBxdg\-desktop\-menu\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} .SH "DESCRIPTION" - .PP -The xdg\-desktop\-menu program can be used to install new items to the desktop's application menu\&. - +The xdg\-desktop\-menu program can be used to install new items to the desktop's application menu. .PP -The application menu works according to the XDG Desktop Menu Specification at http://www\&.freedesktop\&.org/Standards/menu\-spec - +The application menu works according to the XDG Desktop Menu Specification at http://www.freedesktop.org/Standards/menu\-spec .SH "COMMANDS" - .TP install -Install applications or submenus into the desktop menu system\&. - -\fIdesktop\-file\fR: Installs the *\&.desktop file indicated by \fIdesktop\-file\fR to the menu system\&. 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\&. - -\fImenu\-file\fR: Installs the *\&.menu file indicated by \fImenu\-file\fR to the menu system\&. A menu file describes the location and contents for one or more new submenus\&. Each submenu must reference a *\&.directory file\&. - -\fIdirectory\-file\fR: Installs the *\&.directory file indicated by \fIdirectory\-file\fR to the menu system\&. A directory file provides the name and icon for a submenu\&. - +Install applications or submenus into the desktop menu system. +.sp +\fIdesktop\-file\fR: Installs the *.desktop file indicated by +\fIdesktop\-file\fR +to the menu system. 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 +\fImenu\-file\fR: Installs the *.menu file indicated by +\fImenu\-file\fR +to the menu system. A menu file describes the location and contents for one or more new submenus. Each submenu must reference a *.directory file. +.sp +\fIdirectory\-file\fR: Installs the *.directory file indicated by +\fIdirectory\-file\fR +to the menu system. A directory file provides the name and icon for a submenu. .TP uninstall -Remove applications or submenus from the desktop menu system previously installed with \fBxdg\-desktop\-menu install\fR\&. - +Remove applications or submenus from the desktop menu system previously installed with +\fBxdg\-desktop\-menu install\fR. .TP forceupdate -Force an update of the menu system\&. This is only useful if the last call to xdg\-desktop\-menu included the \fB\-\-noupdate\fR option\&. - +Force an update of the menu system. This is only useful if the last call to xdg\-desktop\-menu included the +\fB\-\-noupdate\fR +option. .SH "OPTIONS" - .TP \fB\-\-noupdate\fR -Postpone updating the menu system\&. If multiple updates to the menu system are made in sequence this flag can be used to indicate that additional changes will follow and that it is not necassery to update the menu system right away\&. - +Postpone updating the menu system. If multiple updates to the menu system are made in sequence this flag can be used to indicate that additional changes will follow and that it is not necassery to update the menu system right away. .TP -\fB\-\-vendor\fR \fIvendor\-id\fR -Adds \fIvendor\-id\fR as a prefix when installing desktop and directory files\&. - +\fB\-\-novendor\fR +Normally, xdg\-desktop\-menu checks to ensure that any *.desktop, *.directory and *.menu files to be installed has a vendor prefix. This option can be used to disable that check. +.sp +A vendor prefix consists of alpha characters ([a\-zA\-Z]) and is terminated with a dash ("\-"). Companies and organizations are encouraged to use a word or phrase, preferably the organizations name, for which they hold a trademark as their vendor prefix. The purpose of the vendor prefix is to prevent name conflicts. .TP \fB\-\-mode\fR \fImode\fR -\fImode\fR can be \fIuser\fR or \fIsystem\fR\&. In user mode the file is (un)installed for the current user only\&. In system mode the file is (un)installed for all users on the system\&. Usually only root is allowed to install in system mode\&. - -The default is to use system mode when called by root and to use user mode when called by a non\-root user\&. - +\fImode\fR +can be +\fIuser\fR +or +\fIsystem\fR. In user mode the file is (un)installed for the current user only. In system mode the file is (un)installed for all users on the system. Usually only root is allowed to install in system mode. +.sp +The default is to use system mode when called by root and to use user mode when called by a non\-root user. .TP \fB\-\-help\fR -Show command synopsis\&. - +Show command synopsis. .TP \fB\-\-manual\fR -Show this manualpage\&. - +Show this manualpage. .TP \fB\-\-version\fR -Show the xdg\-utils version information\&. - +Show the xdg\-utils version information. .SH "DESKTOP FILES" - .PP -An application item in the application menu is represented by a *\&.desktop file\&. A *\&.desktop file consists of a \fI[Desktop Entry]\fR header followed by several \fIKey\fR=\fIValue\fR lines\&. - +An application item in the application menu is represented by a *.desktop file. A *.desktop file consists of a +\fI[Desktop Entry]\fR +header followed by several +\fIKey\fR=\fIValue\fR +lines. .PP -A *\&.desktop file can provide a name and description for an application 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\&. - +A *.desktop file can provide a name and description for an application 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 often used: - .TP -Value=1\&.0 -This is a mandatory field to indicate that the *\&.desktop file follows the 1\&.0 version of the specification\&. - +Value=1.0 +This is a mandatory field to indicate that the *.desktop file follows the 1.0 version of the specification. .TP Type=Application -This is a mandatory field that indicates that the *\&.desktop file describes an application launcher\&. - +This is a mandatory field that indicates that the *.desktop file describes an application launcher. .TP Name=\fIApplication Name\fR -The name of the application\&. For example \fIMozilla\fR - +The name of the application. For example +\fIMozilla\fR .TP GenericName=\fIGeneric Name\fR -A generic description of the application\&. For example \fIWeb Browser\fR - +A generic description of the application. For example +\fIWeb Browser\fR .TP Comment=\fIComment\fR -Optional field to specify a tooltip for the application\&. For example \fIVisit websites on the Internet\fR - +Optional field to specify a tooltip for the application. For example +\fIVisit websites on the Internet\fR .TP Icon=\fIIcon File\fR -The icon to use for the application\&. 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 application icon can be provided in several different sizes as well as in several differently themed styles\&. - +The icon to use for the application. 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 application icon can be provided in several different sizes as well as in several differently themed styles. .TP 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\&. - +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\&. The XDG Desktop Menu Specification defines a large number of predefined categories\&. - +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. The XDG Desktop Menu Specification defines a large number of predefined categories. .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\&. - +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 - +For a complete oveview of the *.desktop file format please visit http://www.freedesktop.org/wiki/Standards/desktop\-entry\-spec .SH "ENVIRONMENT VARIABLES" - .PP xdg\-desktop\-menu honours the following environment variables: - .TP XDG_UTILS_DEBUG_LEVEL -Setting this environment variable to a non\-zero numerical value makes xdg\-desktop\-menu do more verbose reporting on stderr\&. Setting a higher value increases the verbosity\&. - +Setting this environment variable to a non\-zero numerical value makes xdg\-desktop\-menu do more verbose reporting on stderr. Setting a higher value increases the verbosity. .SH "EXIT CODES" - .PP -An exit code of 0 indicates success while a non\-zero exit code indicates failure\&. The following failure codes can be returned: - +An exit code of 0 indicates success while a non\-zero exit code indicates failure. The following failure codes can be returned: .TP \fB1\fR -Error in command line syntax\&. - +Error in command line syntax. .TP \fB2\fR -One of the files passed on the command line did not exist\&. - +One of the files passed on the command line did not exist. .TP \fB3\fR -A required tool could not be found\&. - +A required tool could not be found. .TP \fB4\fR -The action failed\&. - +The action failed. .TP \fB5\fR -No permission to read one of the files passed on the command line\&. - +No permission to read one of the files passed on the command line. .SH "SEE ALSO" - .PP -\fBxdg\-desktop\-icon\fR(1), \fBxdg\-icon\-resource\fR(1), \fBxdg\-mime\fR(1) - +\fBxdg\-desktop\-icon\fR(1), +\fBxdg\-icon\-resource\fR(1), +\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 order to add the application to the menu there needs to be a \&.desktop file with a suitable \fICategories\fR entry: - +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 - -webmirror\&.desktop: +shinythings\-webmirror.desktop: [Desktop Entry] Encoding=UTF\-8 @@ -211,159 +172,135 @@ webmirror\&.desktop: Name[nl]=WebSpiegel Categories=Network;WebDevelopment; - .fi - - +.sp .PP -Now the xdg\-desktop\-menu tool can be used to add the webmirror\&.desktop file to the desktop application menu: - +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 \-\-vendor shinythings \&./webmirror\&.desktop - +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\&. - +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\&. wants to add its own submenu to the desktop application menu consisting of a "WebMirror" menu item and a "WebMirror Admin Tool" menu item\&. - +In the next example the company ShinyThings Inc. wants to 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, this time no Categories item is needed: - +First the company needs to create two .desktop files that describe the two menu items, this time no Categories item is needed: +.sp .nf - -webmirror\&.desktop: +shinythings\-webmirror.desktop: [Desktop Entry] Encoding=UTF\-8 Type=Application Exec=webmirror - Icon=webmirror + Icon=shinythings\-webmirror Name=WebMirror Name[nl]=WebSpiegel -webmirror\-admin\&.desktop: +shinythings\-webmirror\-admin.desktop: [Desktop Entry] Encoding=UTF\-8 Type=Application Exec=webmirror\-admintool - Icon=webmirror\-admintool + Icon=shinythings\-webmirror\-admintool Name=WebMirror Admin Tool Name[nl]=WebSpiegel Administratie Tool - .fi - - +.sp .PP -The files can be installed with: - +The files can be installed with: +.sp .nf - -xdg\-desktop\-menu install \-\-noupdate \-\-vendor shinythings \&./webmirror\&.desktop -xdg\-desktop\-menu install \-\-noupdate \-\-vendor shinythings \&./webmirror\-admin\&.desktop - +xdg\-desktop\-menu install \-\-noupdate ./shinythings\-webmirror.desktop +xdg\-desktop\-menu install \-\-noupdate ./shinythings\-webmirror\-admin.desktop .fi - - +.sp .PP -Because multiple items are added the \fB\-\-noupdate\fR option has been used\&. - +Because multiple items are added the +\fB\-\-noupdate\fR +option has been used. .PP -In addition a \&.directory file needs to be created to provide a title and icon for the sub\-menu itself: - +In addition a .directory file needs to be created to provide a title and icon for the sub\-menu itself: +.sp .nf - -webmirror\&.directory: +shinythings\-webmirror.directory: [Desktop Entry] Encoding=UTF\-8 - Icon=webmirror\-menu + Icon=shinythings\-webmirror\-menu Name=WebMirror Name[nl]=WebSpiegel - .fi - - +.sp .PP -This webmirror\&.directory file can be installed with: - +This webmirror.directory file can be installed with: +.sp .nf - -xdg\-desktop\-menu install \-\-noupdate \-\-vendor shinythings \&./webmirror\&.directory - +xdg\-desktop\-menu install \-\-noupdate ./shinythings\-webmirror.directory .fi - - +.sp .PP -The *\&.desktop and *\&.directory files reference icons with the names webmirror, webmirror\-admin and webmirror\-menu which should also be installed\&. In this example the icons are installed in two different sizes, once with a size of 22x22 pixels and once with a size of 64x64 pixels: - +The *.desktop and *.directory files reference icons with the names webmirror, webmirror\-admin and webmirror\-menu which should also be installed. In this example the icons are installed in two different sizes, once with a size of 22x22 pixels and once with a size of 64x64 pixels: +.sp .nf - -xdg\-icon\-resource install \-\-size 22 \&./wmicon\-22\&.png webmirror\&.png -xdg\-icon\-resource install \-\-size 22 \&./wmicon\-menu\-22\&.png webmirror\-menu\&.png -xdg\-icon\-resource install \-\-size 22 \&./wmicon\-admin\-22\&.png webmirror\-admin\&.png -xdg\-icon\-resource install \-\-size 64 \&./wmicon\-64\&.png webmirror\&.png -xdg\-icon\-resource install \-\-size 64 \&./wmicon\-menu\-64\&.png webmirror\-menu\&.png -xdg\-icon\-resource install \-\-size 64 \&./wmicon\-admin\-64\&.png webmirror\-admin\&.png - +xdg\-icon\-resource install \-\-size 22 ./wmicon\-22.png shinythings\-webmirror.png +xdg\-icon\-resource install \-\-size 22 ./wmicon\-menu\-22.png shinythings\-webmirror\-menu.png +xdg\-icon\-resource install \-\-size 22 ./wmicon\-admin\-22.png shinythings\-webmirror\-admin.png +xdg\-icon\-resource install \-\-size 64 ./wmicon\-64.png shinythings\-webmirror.png +xdg\-icon\-resource install \-\-size 64 ./wmicon\-menu\-64.png shinythings\-webmirror\-menu.png +xdg\-icon\-resource install \-\-size 64 ./wmicon\-admin\-64.png shinythings\-webmirror\-admin.png .fi - - +.sp .PP -The last step is to provide a \&.menu file that links it all togther: - +The last step is to provide a .menu file that links it all togther: +.sp .nf +shinythings\-webmirror.menu: -webmirror\&.menu: - - <!DOCTYPE Menu PUBLIC "\-//freedesktop//DTD Menu 1\&.0//EN" - "http://www\&.freedesktop\&.org/standards/menu\-spec/menu\-1\&.0\&.dtd"> + <!DOCTYPE Menu PUBLIC "\-//freedesktop//DTD Menu 1.0//EN" + "http://www.freedesktop.org/standards/menu\-spec/menu\-1.0.dtd"> <Menu> <Name>Applications</Name> <Menu> <Name>WebMirror</Name> - <Directory>shinythings\-webmirror\&.directory</Directory> + <Directory>shinythings\-webmirror.directory</Directory> <Include> - <Filename>shinythings\-webmirror\&.desktop</Filename> - <Filename>shinythings\-webmirror\-admin\&.desktop</Filename> + <Filename>shinythings\-webmirror.desktop</Filename> + <Filename>shinythings\-webmirror\-admin.desktop</Filename> </Include> </Menu> </Menu> - .fi - - +.sp .PP -The webmirror\&.menu file can be installed with: - +The shinythings\-webmirror.menu file can be installed with: +.sp .nf - -xdg\-desktop\-menu install \-\-noupdate \-\-vendor shinythings \&./webmirror\&.menu - +xdg\-desktop\-menu install \-\-noupdate ./shinythings\-webmirror.menu .fi - - +.sp .PP -After installing multiple files with \fB\-\-noupdate\fR make sure to force an update: - +After installing multiple files with +\fB\-\-noupdate\fR +make sure to force an update: +.sp .nf - xdg\-desktop\-menu forceupdate - .fi - - -.SH AUTHORS -Kevin Krammer, Jeremy White. +.sp +.SH "AUTHOR" +Kevin Krammer, Jeremy White. +.br +<kevin.krammer@gmx.at> +.br +<jwhite@codeweavers.com> diff --git a/scripts/man/xdg-email.1 b/scripts/man/xdg-email.1 index 80fdfb9..f3b92f0 100644 --- a/scripts/man/xdg-email.1 +++ b/scripts/man/xdg-email.1 @@ -1,167 +1,118 @@ -.\"Generated by db2man.xsl. Don't modify this, modify the source. -.de Sh \" Subsection -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp -.. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.TH "XDG-EMAIL" 1 "" "" "xdg-email Manual" -.SH NAME -xdg-email \- command line tool for sending mail using the user's preferred e-mail composer -.SH "SYNOPSIS" +.\" ** You probably do not want to edit this file directly ** +.\" 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\-EMAIL" "1" "07/31/2006" "xdg\-utils 1.0 beta2" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) .ad l -.hy 0 +.SH "NAME" +xdg\-email \- command line tool for sending mail using the user's preferred e\-mail composer +.SH "SYNOPSIS" .HP 10 -\fBxdg\-email\fR [\fB\-\-utf8\fR] [\fB\-\-cc\fR\ \fIaddress\fR] [\fB\-\-bcc\fR\ \fIaddress\fR] [\fB\-\-subject\fR\ \fItext\fR] [\fB\-\-body\fR\ \fItext\fR] [\fB\-\-attach\fR\ \fIfile\fR] {\fB\fImailto\-uri\fR\fR | \fB\fIaddress(es)\fR\fR} -.ad -.hy -.ad l -.hy 0 +\fBxdg\-email\fR [\fB\-\-utf8\fR] [\fB\-\-cc\fR\ \fIaddress\fR] [\fB\-\-bcc\fR\ \fIaddress\fR] [\fB\-\-subject\fR\ \fItext\fR] [\fB\-\-body\fR\ \fItext\fR] [\fB\-\-attach\fR\ \fIfile\fR] {\fImailto\-uri\fR \fIaddress(es)\fR} .HP 10 -\fBxdg\-email\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} -.ad -.hy - +\fBxdg\-email\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} .SH "DESCRIPTION" - .PP -xdg\-email opens the user's preferred e\-mail composer in order to send a mail to \fIaddress(es)\fR or \fImailto\-uri\fR\&. RFC2368 defines mailto: URIs\&. xdg\-email limits support to, cc, subject and body fields in \fImailto\-uri\fR, all other fields are silently ignored\&. \fIaddress(es)\fR must follow the syntax of RFC822\&. Multiple addresses may be provided as separate arguments\&. - +xdg\-email opens the user's preferred e\-mail composer in order to send a mail to +\fIaddress(es)\fR +or +\fImailto\-uri\fR. RFC2368 defines mailto: URIs. xdg\-email limits support to, cc, subject and body fields in +\fImailto\-uri\fR, all other fields are silently ignored. +\fIaddress(es)\fR +must follow the syntax of RFC822. Multiple addresses may be provided as separate arguments. .PP -All information provided on the command line is used to prefill corresponding fields in the user's e\-mail composer\&. The user will have the opportunity to change any of this information before actually sending the e\-mail\&. - +All information provided on the command line is used to prefill corresponding fields in the user's e\-mail composer. The user will have the opportunity to change any of this information before actually sending the e\-mail. .PP -xdg\-email is for use inside a desktop session only\&. It is not recommended to use xdg\-email as root\&. - +xdg\-email is for use inside a desktop session only. It is not recommended to use xdg\-email as root. .PP -See http://portland\&.freedesktop\&.org/EmailConfig for information on how the user can change the e\-mail composer that is used\&. - +See http://portland.freedesktop.org/EmailConfig for information on how the user can change the e\-mail composer that is used. .SH "OPTIONS" - .TP \fB\-\-utf8\fR -Indicates that all command line options that follow are in utf8\&. Without this option, command line options are expected to be encoded according to locale\&. If the locale already specifies utf8 this option has no effect\&. This option does not affect mailto URIs that are passed on the command line\&. - +Indicates that all command line options that follow are in utf8. Without this option, command line options are expected to be encoded according to locale. If the locale already specifies utf8 this option has no effect. This option does not affect mailto URIs that are passed on the command line. .TP \fB\-\-cc\fR \fIaddress\fR -Specify a recipient to be copied on the e\-mail\&. - +Specify a recipient to be copied on the e\-mail. .TP \fB\-\-bcc\fR \fIaddress\fR -Specify a recipient to be blindly copied on the e\-mail\&. - +Specify a recipient to be blindly copied on the e\-mail. .TP \fB\-\-subject\fR \fItext\fR -Specify a subject for the e\-mail\&. - +Specify a subject for the e\-mail. .TP \fB\-\-body\fR \fItext\fR -Specify a body for the e\-mail\&. Since the user will be able to make changes before actually sending the e\-mail, this can be used to provide the user with a template for the e\-mail\&. \fItext\fR may contain linebreaks\&. - +Specify a body for the e\-mail. Since the user will be able to make changes before actually sending the e\-mail, this can be used to provide the user with a template for the e\-mail. +\fItext\fR +may contain linebreaks. .TP \fB\-\-attach\fR \fIfile\fR -Specify an attachment for the e\-mail\&. \fIfile\fR must point to an existing file\&. - -Some e\-mail applications require the file to remain present after xdg\-email returns\&. - +Specify an attachment for the e\-mail. +\fIfile\fR +must point to an existing file. +.sp +Some e\-mail applications require the file to remain present after xdg\-email returns. .TP \fB\-\-help\fR -Show command synopsis\&. - +Show command synopsis. .TP \fB\-\-manual\fR -Show this manualpage\&. - +Show this manualpage. .TP \fB\-\-version\fR -Show the xdg\-utils version information\&. - +Show the xdg\-utils version information. .SH "ENVIRONMENT VARIABLES" - .PP xdg\-email honours the following environment variables: - .TP XDG_UTILS_DEBUG_LEVEL -Setting this environment variable to a non\-zero numerical value makes xdg\-email do more verbose reporting on stderr\&. Setting a higher value increases the verbosity\&. - +Setting this environment variable to a non\-zero numerical value makes xdg\-email do more verbose reporting on stderr. Setting a higher value increases the verbosity. .SH "EXIT CODES" - .PP -An exit code of 0 indicates success while a non\-zero exit code indicates failure\&. The following failure codes can be returned: - +An exit code of 0 indicates success while a non\-zero exit code indicates failure. The following failure codes can be returned: .TP \fB1\fR -Error in command line syntax\&. - +Error in command line syntax. .TP \fB2\fR -One of the files passed on the command line did not exist\&. - +One of the files passed on the command line did not exist. .TP \fB3\fR -A required tool could not be found\&. - +A required tool could not be found. .TP \fB4\fR -The action failed\&. - +The action failed. .TP \fB5\fR -No permission to read one of the files passed on the command line\&. - +No permission to read one of the files passed on the command line. .SH "SEE ALSO" - .PP -http://portland\&.freedesktop\&.org/EmailConfig - +http://portland.freedesktop.org/EmailConfig .SH "EXAMPLES" - .PP - - .nf - -xdg\-email 'Jeremy White <jwhite@example\&.com>' - +xdg\-email 'Jeremy White <jwhite@example.com>' .fi - - +.sp .PP - - .nf - -xdg\-email \-\-attach /tmp/logo\&.png \\ +xdg\-email \-\-attach /tmp/logo.png \\ \-\-subject 'Logo contest' \\ - \-\-body 'Attached you find the logo for the contest\&.' \\ - 'jwhite@example\&.com' - + \-\-body 'Attached you find the logo for the contest.' \\ + 'jwhite@example.com' .fi - - +.sp .PP - - .nf - xdg\-email \-\-subject 'Your password is about to expire' \\ - 'jwhite@example\&.com' 'bastian@example\&.com' 'whipple@example\&.com' - + 'jwhite@example.com' 'bastian@example.com' 'whipple@example.com' .fi - - -.SH AUTHORS -Kevin Krammer, Jeremy White. +.sp +.SH "AUTHOR" +Kevin Krammer, Jeremy White. +.br +<kevin.krammer@gmx.at> +.br +<jwhite@codeweavers.com> diff --git a/scripts/man/xdg-icon-resource.1 b/scripts/man/xdg-icon-resource.1 index ce93b59..2e61256 100644 --- a/scripts/man/xdg-icon-resource.1 +++ b/scripts/man/xdg-icon-resource.1 @@ -1,173 +1,161 @@ -.\"Generated by db2man.xsl. Don't modify this, modify the source. -.de Sh \" Subsection -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp -.. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.TH "XDG-ICON-RESOURCE" 1 "" "" "xdg-icon-resource Manual" -.SH NAME -xdg-icon-resource \- command line tool for (un)installing icon resources -.SH "SYNOPSIS" +.\" ** You probably do not want to edit this file directly ** +.\" 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\-ICON\-RESOURCE" "1" "07/31/2006" "xdg\-utils 1.0 beta2" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) .ad l -.hy 0 +.SH "NAME" +xdg\-icon\-resource \- command line tool for (un)installing icon resources +.SH "SYNOPSIS" .HP 18 -\fBxdg\-icon\-resource\fR install [\fB\-\-noupdate\fR] [\fB\-\-theme\ \fItheme\fR\fR] [\fB\-\-context\ \fIcontext\fR\fR] [\fB\-\-size\ \fIsize\fR\fR] [\fB\-\-mode\ \fImode\fR\fR] \fIicon\-file\fR [\fIicon\-name\fR] -.ad -.hy -.ad l -.hy 0 +\fBxdg\-icon\-resource\fR install [\fB\-\-noupdate\fR] [\fB\-\-novendor\fR] [\fB\-\-theme\ \fR\fB\fItheme\fR\fR] [\fB\-\-context\ \fR\fB\fIcontext\fR\fR] [\fB\-\-size\ \fR\fB\fIsize\fR\fR] [\fB\-\-mode\ \fR\fB\fImode\fR\fR] \fIicon\-file\fR [\fIicon\-name\fR] .HP 18 -\fBxdg\-icon\-resource\fR uninstall [\fB\-\-noupdate\fR] [\fB\-\-theme\ \fItheme\fR\fR] [\fB\-\-context\ \fIcontext\fR\fR] [\fB\-\-size\ \fIsize\fR\fR] [\fB\-\-mode\ \fImode\fR\fR] \fIicon\-name\fR -.ad -.hy -.ad l -.hy 0 +\fBxdg\-icon\-resource\fR uninstall [\fB\-\-noupdate\fR] [\fB\-\-theme\ \fR\fB\fItheme\fR\fR] [\fB\-\-context\ \fR\fB\fIcontext\fR\fR] [\fB\-\-size\ \fR\fB\fIsize\fR\fR] [\fB\-\-mode\ \fR\fB\fImode\fR\fR] \fIicon\-name\fR .HP 18 -\fBxdg\-icon\-resource\fR forceupdate [\fB\-\-theme\ \fItheme\fR\fR] [\fB\-\-mode\ \fImode\fR\fR] -.ad -.hy -.ad l -.hy 0 +\fBxdg\-icon\-resource\fR forceupdate [\fB\-\-theme\ \fR\fB\fItheme\fR\fR] [\fB\-\-mode\ \fR\fB\fImode\fR\fR] .HP 18 -\fBxdg\-icon\-resource\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} -.ad -.hy - +\fBxdg\-icon\-resource\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} .SH "DESCRIPTION" - .PP -The xdg\-icon\-resource program can be used to install icon resources into the desktop icon system in order to illustrate menu entries, to depict desktop icons or to graphically represent file types\&. - +The xdg\-icon\-resource program can be used to install icon resources into the desktop icon system in order to illustrate menu entries, to depict desktop icons or to graphically represent file types. .PP -The desktop icon system identifies icons by name\&. Depending on the required size, the choice of icon theme and the context in which the icon is used, the desktop icon system locates an appropriate icon resource to depict an icon\&. Icon resources can be XPM files, PNG files or SVG files\&. - +The desktop icon system identifies icons by name. Depending on the required size, the choice of icon theme and the context in which the icon is used, the desktop icon system locates an appropriate icon resource to depict an icon. Icon resources can be XPM files, PNG files or SVG files. .PP -The desktop icon system works according to the XDG Icon Theme Specification at http://www\&.freedesktop\&.org/Standards/icon\-theme\-spec - +The desktop icon system works according to the XDG Icon Theme Specification at http://www.freedesktop.org/Standards/icon\-theme\-spec .SH "COMMANDS" - .TP install -Installs the icon file indicated by \fIicon\-file\fR to the desktop icon system under the name \fIicon\-name\fR\&. If \fIicon\-name\fR is not provided the name is derived from \fIicon\-file\fR\&. The icon file must have \fI\&.png\fR, \fI\&.xpm\fR or \fI\&.svg\fR as extension\&. If a corresponding \fI\&.icon\fR file exists in the same location as \fIicon\-file\fR it will be installed as well\&. - +Installs the icon file indicated by +\fIicon\-file\fR +to the desktop icon system under the name +\fIicon\-name\fR. If +\fIicon\-name\fR +is not provided the name is derived from +\fIicon\-file\fR. The icon file must have +\fI.png\fR, +\fI.xpm\fR +or +\fI.svg\fR +as extension. If a corresponding +\fI.icon\fR +file exists in the same location as +\fIicon\-file\fR +it will be installed as well. .TP uninstall -Removes the icon file indicated by \fIicon\-name\fR from the desktop icon system\&. - +Removes the icon file indicated by +\fIicon\-name\fR +from the desktop icon system. .TP forceupdate -Force an update of the desktop icon system\&. This is only useful if the last call to xdg\-icon\-resource included the \fB\-\-noupdate\fR option\&. - +Force an update of the desktop icon system. This is only useful if the last call to xdg\-icon\-resource included the +\fB\-\-noupdate\fR +option. .SH "OPTIONS" - .TP \fB\-\-noupdate\fR -Postpone updating the desktop icon system\&. If multiple icons are added in sequence this flag can be used to indicate that additional changes will follow and that it is not necassery to update the desktop icon system right away\&. - +Postpone updating the desktop icon system. If multiple icons are added in sequence this flag can be used to indicate that additional changes will follow and that it is not necassery to update the desktop icon system right away. +.TP +\fB\-\-novendor\fR +Normally, xdg\-icon\-resource checks to ensure that an icon file to be installed in the +\fIapps\fR +context has a proper vendor prefix. This option can be used to disable that check. +.sp +A vendor prefix consists of alpha characters ([a\-zA\-Z]) and is terminated with a dash ("\-"). Companies and organizations are encouraged to use a word or phrase, preferably the organizations name, for which they hold a trademark as their vendor prefix. The purpose of the vendor prefix is to prevent name conflicts. .TP \fB\-\-theme\fR \fItheme\fR -Installs or removes the icon file as part of \fItheme\fR\&. If no theme is specified the icons will be installed as part of the default \fIhicolor\fR theme\&. Applications may install icons under multiple themes but should at least install icons for the default \fIhicolor\fR theme\&. - +Installs or removes the icon file as part of +\fItheme\fR. If no theme is specified the icons will be installed as part of the default +\fIhicolor\fR +theme. Applications may install icons under multiple themes but should at least install icons for the default +\fIhicolor\fR +theme. .TP \fB\-\-context\fR \fIcontext\fR -Specifies the context for the icon\&. Icons to be used in the application menu and as desktop icon should use \fIapps\fR as context which is the default context\&. Icons to be used as file icons should use \fImimetypes\fR as context\&. Other common contexts are \fIactions\fR, \fIdevices\fR, \fIemblems\fR, \fIfilesystems\fR and \fIstock\fR\&. - +Specifies the context for the icon. Icons to be used in the application menu and as desktop icon should use +\fIapps\fR +as context which is the default context. Icons to be used as file icons should use +\fImimetypes\fR +as context. Other common contexts are +\fIactions\fR, +\fIdevices\fR, +\fIemblems\fR, +\fIfilesystems\fR +and +\fIstock\fR. .TP \fB\-\-size\fR \fIsize\fR -Specifies the size of the icon (required for png and xpm icons)\&. All icons must be square\&. Common sizes for icons in the apps context are: 16, 22, 32, 48, 64 and 128\&. Common sizes for icons in the mimetypes context are: 16, 22, 32, 48, 64 and 128 - +Specifies the size of the icon (required for png and xpm icons). All icons must be square. Common sizes for icons in the apps context are: 16, 22, 32, 48, 64 and 128. Common sizes for icons in the mimetypes context are: 16, 22, 32, 48, 64 and 128 .TP \fB\-\-mode\fR \fImode\fR -\fImode\fR can be \fIuser\fR or \fIsystem\fR\&. In user mode the file is (un)installed for the current user only\&. In system mode the file is (un)installed for all users on the system\&. Usually only root is allowed to install in system mode\&. - -The default is to use system mode when called by root and to use user mode when called by a non\-root user\&. - +\fImode\fR +can be +\fIuser\fR +or +\fIsystem\fR. In user mode the file is (un)installed for the current user only. In system mode the file is (un)installed for all users on the system. Usually only root is allowed to install in system mode. +.sp +The default is to use system mode when called by root and to use user mode when called by a non\-root user. .TP \fB\-\-help\fR -Show command synopsis\&. - +Show command synopsis. .TP \fB\-\-manual\fR -Show this manualpage\&. - +Show this manualpage. .TP \fB\-\-version\fR -Show the xdg\-utils version information\&. - +Show the xdg\-utils version information. .SH "ENVIRONMENT VARIABLES" - .PP xdg\-icon\-resource honours the following environment variables: - .TP XDG_UTILS_DEBUG_LEVEL -Setting this environment variable to a non\-zero numerical value makes xdg\-icon\-resource do more verbose reporting on stderr\&. Setting a higher value increases the verbosity\&. - +Setting this environment variable to a non\-zero numerical value makes xdg\-icon\-resource do more verbose reporting on stderr. Setting a higher value increases the verbosity. .SH "EXIT CODES" - .PP -An exit code of 0 indicates success while a non\-zero exit code indicates failure\&. The following failure codes can be returned: - +An exit code of 0 indicates success while a non\-zero exit code indicates failure. The following failure codes can be returned: .TP \fB1\fR -Error in command line syntax\&. - +Error in command line syntax. .TP \fB2\fR -One of the files passed on the command line did not exist\&. - +One of the files passed on the command line did not exist. .TP \fB3\fR -A required tool could not be found\&. - +A required tool could not be found. .TP \fB4\fR -The action failed\&. - +The action failed. .TP \fB5\fR -No permission to read one of the files passed on the command line\&. - +No permission to read one of the files passed on the command line. .SH "SEE ALSO" - .PP -\fBxdg\-desktop\-icon\fR(1), \fBxdg\-desktop\-menu\fR(1), \fBxdg\-mime\fR(1) - +\fBxdg\-desktop\-icon\fR(1), +\fBxdg\-desktop\-menu\fR(1), +\fBxdg\-mime\fR(1) .SH "EXAMPLES" - .PP -To install an icon resource to depict a launcher for the application myfoobar one can use: - +To install an icon resource to depict a launcher for the application myfoobar, the company ShinyThings Inc. can use: +.sp .nf - -xdg\-icon\-resource install \-\-size 64 myfoobar\&.png - +xdg\-icon\-resource install \-\-size 64 shinythings\-myfoobar.png .fi - - +.sp .PP -To install an icon for a new application/x\-foobar file type one can use: - +To install an icon for a new application/x\-foobar file type one can use: +.sp .nf - -xdg\-icon\-resource install \-\-context mimetypes \-\-size 48 \&./mime\-foobar\-48\&.png application\-x\-foobar\&.png -xdg\-icon\-resource install \-\-context mimetypes \-\-size 64 \&./mime\-foobar\-64\&.png application\-x\-foobar\&.png - +xdg\-icon\-resource install \-\-context mimetypes \-\-size 48 ./mime\-foobar\-48.png application\-x\-foobar.png +xdg\-icon\-resource install \-\-context mimetypes \-\-size 64 ./mime\-foobar\-64.png application\-x\-foobar.png .fi -This will install two icons with the name application\-x\-foobar\&.png but with different sizes\&. - -.SH AUTHORS -Kevin Krammer, Jeremy White. +.sp +This will install two icons with the name application\-x\-foobar.png but with different sizes. +.SH "AUTHOR" +Kevin Krammer, Jeremy White. +.br +<kevin.krammer@gmx.at> +.br +<jwhite@codeweavers.com> diff --git a/scripts/man/xdg-mime.1 b/scripts/man/xdg-mime.1 index f8285a6..f9594ae 100644 --- a/scripts/man/xdg-mime.1 +++ b/scripts/man/xdg-mime.1 @@ -1,207 +1,182 @@ -.\"Generated by db2man.xsl. Don't modify this, modify the source. -.de Sh \" Subsection -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp -.. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.TH "XDG-MIME" 1 "" "" "xdg-mime Manual" -.SH NAME -xdg-mime \- command line tool for querying information about file type handling and adding descriptions for new file types -.SH "SYNOPSIS" +.\" ** You probably do not want to edit this file directly ** +.\" 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\-MIME" "1" "07/31/2006" "xdg\-utils 1.0 beta2" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) .ad l -.hy 0 +.SH "NAME" +xdg\-mime \- command line tool for querying information about file type handling and adding descriptions for new file types +.SH "SYNOPSIS" .HP 9 -\fBxdg\-mime\fR query {\fBfiletype\fR | \fBdefault\fR} \&.\&.\&. -.ad -.hy -.ad l -.hy 0 +\fBxdg\-mime\fR query {filetype default} ... .HP 9 \fBxdg\-mime\fR default \fIapplication\fR \fImimetype(s)\fR -.ad -.hy -.ad l -.hy 0 .HP 9 -\fBxdg\-mime\fR install [\fB\-\-mode\ \fImode\fR\fR] \fImimetypes\-file\fR -.ad -.hy -.ad l -.hy 0 +\fBxdg\-mime\fR install [\fB\-\-mode\ \fR\fB\fImode\fR\fR] [\fB\-\-novendor\fR] \fImimetypes\-file\fR .HP 9 -\fBxdg\-mime\fR uninstall [\fB\-\-mode\ \fImode\fR\fR] \fImimetypes\-file\fR -.ad -.hy -.ad l -.hy 0 +\fBxdg\-mime\fR uninstall [\fB\-\-mode\ \fR\fB\fImode\fR\fR] \fImimetypes\-file\fR .HP 9 -\fBxdg\-mime\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} -.ad -.hy - +\fBxdg\-mime\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} .SH "DESCRIPTION" - .PP -The xdg\-mime program can be used to query information about file types and to add descriptions for new file types\&. - +The xdg\-mime program can be used to query information about file types and to add descriptions for new file types. .SH "COMMANDS" - .TP query -Returns information related to file types\&. - -The \fIquery\fR option is for use inside a desktop session only\&. It is not recommended to use xdg\-mime query as root\&. - +Returns information related to file types. +.sp +The +\fIquery\fR +option is for use inside a desktop session only. It is not recommended to use xdg\-mime query as root. +.sp The following queries are supported: - -query filetype \fIFILE\fR: Returns the file type of \fIFILE\fR in the form of a MIME type\&. - -query default \fImimetype\fR: Returns the default application that the desktop environment uses for opening files of type \fImimetype\fR\&. The default application is identified by its *\&.desktop file\&. - +.sp +query filetype +\fIFILE\fR: Returns the file type of +\fIFILE\fR +in the form of a MIME type. +.sp +query default +\fImimetype\fR: Returns the default application that the desktop environment uses for opening files of type +\fImimetype\fR. The default application is identified by its *.desktop file. .TP default -Ask the desktop environment to make \fIapplication\fR the default application for opening files of type \fImimetype\fR\&. An application can be made the default for several file types by specifying multiple mimetypes\&. - - \fIapplication\fR is the desktop file id of the application and has the form vendor\-name\&.desktop \fIapplication\fR must already be installed in the desktop menu before it can be made the default handler\&. The aplication's desktop file must list support for all the MIME types that it wishes to be the default handler for\&. - -Requests to make an application a default handler may be subject to system policy or approval by the end\-user\&. xdg\-mime query can be used to verify whether an application is the actual default handler for a specific file type\&. - -The \fIdefault\fR option is for use inside a desktop session only\&. It is not recommended to use xdg\-mime default as root\&. - +Ask the desktop environment to make +\fIapplication\fR +the default application for opening files of type +\fImimetype\fR. An application can be made the default for several file types by specifying multiple mimetypes. +.sp +\fIapplication\fR +is the desktop file id of the application and has the form vendor\-name.desktop +\fIapplication\fR +must already be installed in the desktop menu before it can be made the default handler. The aplication's desktop file must list support for all the MIME types that it wishes to be the default handler for. +.sp +Requests to make an application a default handler may be subject to system policy or approval by the end\-user. xdg\-mime query can be used to verify whether an application is the actual default handler for a specific file type. +.sp +The +\fIdefault\fR +option is for use inside a desktop session only. It is not recommended to use xdg\-mime default as root. .TP install -Adds the file type descriptions provided in \fImimetypes\-file\fR to the desktop environment\&. \fImimetypes\-file\fR must be a XML file that follows the freedesktop\&.org Shared MIME\-info Database specification and that has a mime\-info element as its document root\&. For each new file type one or more icons with name \fImajor\fR\-\fIminor\fR must be installed with the \fBxdg\-icon\-resource\fR command in the \fImimetypes\fR context\&. For example the application/vnd\&.oasis\&.opendocument\&.text filetype requires an icon by the name of application\-vnd\&.oasis\&.opendocument\&.text to be installed\&. - +Adds the file type descriptions provided in +\fImimetypes\-file\fR +to the desktop environment. +\fImimetypes\-file\fR +must be a XML file that follows the freedesktop.org Shared MIME\-info Database specification and that has a mime\-info element as its document root. For each new file type one or more icons with name +\fImajor\fR\-\fIminor\fR +must be installed with the +\fBxdg\-icon\-resource\fR +command in the +\fImimetypes\fR +context. For example the application/vnd.oasis.opendocument.text filetype requires an icon by the name of application\-vnd.oasis.opendocument.text to be installed. .TP uninstall -Removes the file type descriptions provided in \fImimetypes\-file\fR and previously added with \fBxdg\-mime install\fR from the desktop environment\&. \fImimetypes\-file\fR must be a XML file that follows the freedesktop\&.org Shared MIME\-info Database specification and that has a mime\-info element as its document root\&. - +Removes the file type descriptions provided in +\fImimetypes\-file\fR +and previously added with +\fBxdg\-mime install\fR +from the desktop environment. +\fImimetypes\-file\fR +must be a XML file that follows the freedesktop.org Shared MIME\-info Database specification and that has a mime\-info element as its document root. .SH "OPTIONS" - .TP \fB\-\-mode\fR \fImode\fR -\fImode\fR can be \fIuser\fR or \fIsystem\fR\&. In user mode the file is (un)installed for the current user only\&. In system mode the file is (un)installed for all users on the system\&. Usually only root is allowed to install in system mode\&. - -The default is to use system mode when called by root and to use user mode when called by a non\-root user\&. - +\fImode\fR +can be +\fIuser\fR +or +\fIsystem\fR. In user mode the file is (un)installed for the current user only. In system mode the file is (un)installed for all users on the system. Usually only root is allowed to install in system mode. +.sp +The default is to use system mode when called by root and to use user mode when called by a non\-root user. +.TP +\fB\-\-novendor\fR +Normally, xdg\-mime checks to ensure that the +\fImimetypes\-file\fR +to be installed has a proper vendor prefix. This option can be used to disable that check. +.sp +A vendor prefix consists of alpha characters ([a\-zA\-Z]) and is terminated with a dash ("\-"). Companies and organizations are encouraged to use a word or phrase, preferably the organizations name, for which they hold a trademark as their vendor prefix. The purpose of the vendor prefix is to prevent name conflicts. .TP \fB\-\-help\fR -Show command synopsis\&. - +Show command synopsis. .TP \fB\-\-manual\fR -Show this manualpage\&. - +Show this manualpage. .TP \fB\-\-version\fR -Show the xdg\-utils version information\&. - +Show the xdg\-utils version information. .SH "ENVIRONMENT VARIABLES" - .PP xdg\-mime honours the following environment variables: - .TP XDG_UTILS_DEBUG_LEVEL -Setting this environment variable to a non\-zero numerical value makes xdg\-mime do more verbose reporting on stderr\&. Setting a higher value increases the verbosity\&. - +Setting this environment variable to a non\-zero numerical value makes xdg\-mime do more verbose reporting on stderr. Setting a higher value increases the verbosity. .SH "EXIT CODES" - .PP -An exit code of 0 indicates success while a non\-zero exit code indicates failure\&. The following failure codes can be returned: - +An exit code of 0 indicates success while a non\-zero exit code indicates failure. The following failure codes can be returned: .TP \fB1\fR -Error in command line syntax\&. - +Error in command line syntax. .TP \fB2\fR -One of the files passed on the command line did not exist\&. - +One of the files passed on the command line did not exist. .TP \fB3\fR -A required tool could not be found\&. - +A required tool could not be found. .TP \fB4\fR -The action failed\&. - +The action failed. .TP \fB5\fR -No permission to read one of the files passed on the command line\&. - +No permission to read one of the files passed on the command line. .SH "SEE ALSO" - .PP -\fBxdg\-icon\-resource\fR(1), \fBxdg\-desktop\-menu\fR(1) - +\fBxdg\-icon\-resource\fR(1), +\fBxdg\-desktop\-menu\fR(1) .SH "EXAMPLES" - .PP - - .nf - -xdg\-mime query filetype /tmp/foobar\&.png - +xdg\-mime query filetype /tmp/foobar.png .fi -Prints the MIME type of the file /tmp/foobar\&.png, in this case image/png - +.sp +Prints the MIME type of the file /tmp/foobar.png, in this case image/png .PP - - .nf - xdg\-mime query default image/png - .fi -Prints the \&.desktop filename of the application which is registered to open PNG files\&. - +.sp +Prints the .desktop filename of the application which is registered to open PNG files. .PP - - .nf - -xdg\-mime install diff\&.xml - +xdg\-mime install shinythings\-shiny.xml .fi -Adds a file type description for "diff"\-files\&. The file type description could look as folows\&. - +.sp +Adds a file type description for "shiny"\-files. "shinythings\-" is used as the vendor prefix. The file type description could look as folows. +.sp .nf - -diff\&.xml: - -<?xml version="1\&.0"?> -<mime\-info xmlns='http://www\&.freedesktop\&.org/standards/shared\-mime\-info'> - <mime\-type type="text/x\-diff"> - <comment>Differences between files</comment> - <glob pattern="*\&.diff"/> - <glob pattern="*\&.patch"/> +shinythings\-shiny.xml: + +<?xml version="1.0"?> +<mime\-info xmlns='http://www.freedesktop.org/standards/shared\-mime\-info'> + <mime\-type type="text/x\-shiny"> + <comment>Shiny new file type</comment> + <glob pattern="*.shiny"/> + <glob pattern="*.shi"/> </mime\-type> </mime\-info> - .fi -An icon for this new file type must alsobe installed, for example with: - +.sp +An icon for this new file type must also be installed, for example with: +.sp .nf - -xdg\-icon\-resource install \-\-context mimetypes \-\-size 64 text\-x\-diff\&.png - +xdg\-icon\-resource install \-\-context mimetypes \-\-size 64 text\-x\-shiny.png .fi - - -.SH AUTHORS -Kevin Krammer, Jeremy White. +.sp +.SH "AUTHOR" +Kevin Krammer, Jeremy White. +.br +<kevin.krammer@gmx.at> +.br +<jwhite@codeweavers.com> diff --git a/scripts/man/xdg-open.1 b/scripts/man/xdg-open.1 index 68ed3d7..bc7f51b 100644 --- a/scripts/man/xdg-open.1 +++ b/scripts/man/xdg-open.1 @@ -1,103 +1,65 @@ -.\"Generated by db2man.xsl. Don't modify this, modify the source. -.de Sh \" Subsection -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp -.. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.TH "XDG-OPEN" 1 "" "" "xdg-open Manual" -.SH NAME -xdg-open \- opens a file or URL in the user's preferred application -.SH "SYNOPSIS" +.\" ** You probably do not want to edit this file directly ** +.\" 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\-OPEN" "1" "07/31/2006" "xdg\-utils 1.0 beta2" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) .ad l -.hy 0 +.SH "NAME" +xdg\-open \- opens a file or URL in the user's preferred application +.SH "SYNOPSIS" .HP 9 -\fBxdg\-open\fR {\fB\fB\fIfile\fR\fR\fR | \fB\fB\fIURL\fR\fR\fR} -.ad -.hy -.ad l -.hy 0 +\fBxdg\-open\fR {\fB\fIfile\fR\fR \fB\fIURL\fR\fR} .HP 9 -\fBxdg\-open\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} -.ad -.hy - +\fBxdg\-open\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} .SH "DESCRIPTION" - .PP -xdg\-open opens a file or URL in the user's preferred application\&. If a URL is provided the URL will be opened in the user's preferred web browser\&. If a file is provided the file will be opened in the preferred application for files of that type\&. xdg\-open supports file, ftp, http and https URLs\&. - +xdg\-open opens a file or URL in the user's preferred application. If a URL is provided the URL will be opened in the user's preferred web browser. If a file is provided the file will be opened in the preferred application for files of that type. xdg\-open supports file, ftp, http and https URLs. .PP -xdg\-open is for use inside a desktop session only\&. It is not recommended to use xdg\-open as root\&. - +xdg\-open is for use inside a desktop session only. It is not recommended to use xdg\-open as root. .SH "OPTIONS" - .TP \fB\-\-help\fR -Show command synopsis\&. - +Show command synopsis. .TP \fB\-\-manual\fR -Show this manualpage\&. - +Show this manualpage. .TP \fB\-\-version\fR -Show the xdg\-utils version information\&. - +Show the xdg\-utils version information. .SH "EXIT CODES" - .PP -An exit code of 0 indicates success while a non\-zero exit code indicates failure\&. The following failure codes can be returned: - +An exit code of 0 indicates success while a non\-zero exit code indicates failure. The following failure codes can be returned: .TP \fB1\fR -Error in command line syntax\&. - +Error in command line syntax. .TP \fB2\fR -One of the files passed on the command line did not exist\&. - +One of the files passed on the command line did not exist. .TP \fB3\fR -A required tool could not be found\&. - +A required tool could not be found. .TP \fB4\fR -The action failed\&. - +The action failed. .SH "EXAMPLES" - .PP - - .nf - -xdg\-open 'http://www\&.freedesktop\&.org/' - +xdg\-open 'http://www.freedesktop.org/' .fi - Opens the Freedesktop\&.org website in the user's default browser - +.sp +Opens the Freedesktop.org website in the user's default browser .PP - - .nf - -xdg\-open /tmp/foobar\&.png - +xdg\-open /tmp/foobar.png .fi - Opens the PNG image file /tmp/foobar\&.png in the user's default image viewing application\&. - -.SH AUTHORS -Kevin Krammer, Jeremy White. +.sp +Opens the PNG image file /tmp/foobar.png in the user's default image viewing application. +.SH "AUTHOR" +Kevin Krammer, Jeremy White. +.br +<kevin.krammer@gmx.at> +.br +<jwhite@codeweavers.com> diff --git a/scripts/man/xdg-screensaver.1 b/scripts/man/xdg-screensaver.1 index c0cf741..d4f35b9 100644 --- a/scripts/man/xdg-screensaver.1 +++ b/scripts/man/xdg-screensaver.1 @@ -1,127 +1,93 @@ -.\"Generated by db2man.xsl. Don't modify this, modify the source. -.de Sh \" Subsection -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp -.. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.TH "XDG-SCREENSAVER" 1 "" "" "xdg-screensaver Manual" -.SH NAME -xdg-screensaver \- command line tool for controlling the screensaver -.SH "SYNOPSIS" +.\" ** You probably do not want to edit this file directly ** +.\" 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\-SCREENSAVER" "1" "07/31/2006" "xdg\-utils 1.0 beta2" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) .ad l -.hy 0 +.SH "NAME" +xdg\-screensaver \- command line tool for controlling the screensaver +.SH "SYNOPSIS" .HP 16 -\fBxdg\-screensaver\fR \fBsuspend\ \fIWindowID\fR\fR -.ad -.hy -.ad l -.hy 0 +\fBxdg\-screensaver\fR \fBsuspend\ \fR\fB\fIWindowID\fR\fR .HP 16 -\fBxdg\-screensaver\fR \fBresume\ \fIWindowID\fR\fR -.ad -.hy -.ad l -.hy 0 +\fBxdg\-screensaver\fR \fBresume\ \fR\fB\fIWindowID\fR\fR .HP 16 -\fBxdg\-screensaver\fR {\fB\fBactivate\fR\fR | \fB\fBreset\fR\fR | \fB\fBstatus\fR\fR} -.ad -.hy -.ad l -.hy 0 +\fBxdg\-screensaver\fR {\fBactivate\fR \fBreset\fR \fBstatus\fR} .HP 16 -\fBxdg\-screensaver\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} -.ad -.hy - +\fBxdg\-screensaver\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} .SH "DESCRIPTION" - .PP -xdg\-screensaver provides commands to control the screensaver\&. - +xdg\-screensaver provides commands to control the screensaver. .PP -xdg\-screensaver is for use inside a desktop session only\&. It is not recommended to use xdg\-screensaver as root\&. - +xdg\-screensaver is for use inside a desktop session only. It is not recommended to use xdg\-screensaver as root. .SH "COMMANDS" - .TP -\fBsuspend \fIWindowID\fR\fR -Suspends the screensaver and monitor power management\&. \fIWindowID\fR must be the X Window ID of an existing window of the calling application\&. The window must remain in existance for the duration of the suspension\&. - -WindowID can be represented as either a decimal number or as a hexadecimal number consisting of the prefix \fI0x\fR followed by one or more hexadecimal digits\&. - -The screensaver can be suspended in relation to multiple windows at the same time\&. In that case screensaver operation is only restored once the screensaver has been resumed in relation to each of the windows - +\fBsuspend \fR\fB\fIWindowID\fR\fR +Suspends the screensaver and monitor power management. +\fIWindowID\fR +must be the X Window ID of an existing window of the calling application. The window must remain in existance for the duration of the suspension. +.sp +WindowID can be represented as either a decimal number or as a hexadecimal number consisting of the prefix +\fI0x\fR +followed by one or more hexadecimal digits. +.sp +The screensaver can be suspended in relation to multiple windows at the same time. In that case screensaver operation is only restored once the screensaver has been resumed in relation to each of the windows .TP -\fBresume \fIWindowID\fR\fR -Resume the screensaver and monitor power management after being suspended\&. \fIWindowID\fR must be the same X Window ID that was passed to a previous call of \fBxdg\-screensaver suspend\fR - +\fBresume \fR\fB\fIWindowID\fR\fR +Resume the screensaver and monitor power management after being suspended. +\fIWindowID\fR +must be the same X Window ID that was passed to a previous call of +\fBxdg\-screensaver suspend\fR .TP \fBactivate\fR -Turns the screensaver on immediately\&. This may result in the screen getting locked, depending on existing system policies\&. - +Turns the screensaver on immediately. This may result in the screen getting locked, depending on existing system policies. .TP \fBreset\fR -Turns the screensaver off immediately\&. On some systems the user may be asked to authenticate first before the screen is unlocked\&. - +Turns the screensaver off immediately. On some systems the user may be asked to authenticate first before the screen is unlocked. .TP \fBstatus\fR -Prints \fIenabled\fR to stdout if the screensaver is enabled to turn on after a period of inactivity and prints \fIdisabled\fR if the screensaver is not enabled\&. - +Prints +\fIenabled\fR +to stdout if the screensaver is enabled to turn on after a period of inactivity and prints +\fIdisabled\fR +if the screensaver is not enabled. .SH "OPTIONS" - .TP \fB\-\-help\fR -Show command synopsis\&. - +Show command synopsis. .TP \fB\-\-manual\fR -Show this manualpage\&. - +Show this manualpage. .TP \fB\-\-version\fR -Show the xdg\-utils version information\&. - +Show the xdg\-utils version information. .SH "EXIT CODES" - .PP -An exit code of 0 indicates success while a non\-zero exit code indicates failure\&. The following failure codes can be returned: - +An exit code of 0 indicates success while a non\-zero exit code indicates failure. The following failure codes can be returned: .TP \fB1\fR -Error in command line syntax\&. - +Error in command line syntax. .TP \fB3\fR -A required tool could not be found\&. - +A required tool could not be found. .TP \fB4\fR -The action failed\&. - +The action failed. .SH "EXAMPLES" - .PP - - .nf - xdg\-screensaver suspend 0x1c00007 - .fi -Causes the screensaver to be disabled till \fBxdg\-screensaver resume 0x1c00007\fR is called\&. \fI0x1c00007\fR must be the X Window ID of an existing window\&. - -.SH AUTHOR -Bryce Harrington. +.sp +Causes the screensaver to be disabled till +\fBxdg\-screensaver resume 0x1c00007\fR +is called. +\fI0x1c00007\fR +must be the X Window ID of an existing window. +.SH "AUTHOR" +Bryce Harrington. +.br +<bryce@osdl.org> diff --git a/scripts/man/xdg-su.1 b/scripts/man/xdg-su.1 index 11bf29c..6ed4b36 100644 --- a/scripts/man/xdg-su.1 +++ b/scripts/man/xdg-su.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\-SU" "1" "07/24/2006" "This is release 0.5 of the xdg\-su Manual" "" +.TH "XDG\-SU" "1" "07/31/2006" "This is release 0.5 of the xdg\-su Manual" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) |