diff options
author | Fathi Boudra <fabo@debian.org> | 2010-12-31 11:37:13 +0200 |
---|---|---|
committer | Fathi Boudra <fabo@debian.org> | 2010-12-31 11:37:13 +0200 |
commit | c3229b87c6ef7fa2a8137c85218b3892d368e49f (patch) | |
tree | 6e1001dbf28e186d4467de6cfb5d6052f3e55c5d /scripts/man | |
parent | 2ece03ecb5cd662b35219b9e701ef68a1eb217e5 (diff) |
Re-generate all files and include xdg-settings documentation
Diffstat (limited to 'scripts/man')
-rw-r--r-- | scripts/man/xdg-copy.1 | 103 | ||||
-rw-r--r-- | scripts/man/xdg-desktop-icon.1 | 229 | ||||
-rw-r--r-- | scripts/man/xdg-desktop-menu.1 | 411 | ||||
-rw-r--r-- | scripts/man/xdg-email.1 | 211 | ||||
-rw-r--r-- | scripts/man/xdg-file-dialog.1 | 143 | ||||
-rw-r--r-- | scripts/man/xdg-icon-resource.1 | 240 | ||||
-rw-r--r-- | scripts/man/xdg-mime.1 | 252 | ||||
-rw-r--r-- | scripts/man/xdg-open.1 | 131 | ||||
-rw-r--r-- | scripts/man/xdg-screensaver.1 | 150 | ||||
-rw-r--r-- | scripts/man/xdg-settings.1 | 136 | ||||
-rw-r--r-- | scripts/man/xdg-su.1 | 75 | ||||
-rw-r--r-- | scripts/man/xdg-terminal.1 | 60 |
12 files changed, 1236 insertions, 905 deletions
diff --git a/scripts/man/xdg-copy.1 b/scripts/man/xdg-copy.1 deleted file mode 100644 index a0ea24f..0000000 --- a/scripts/man/xdg-copy.1 +++ /dev/null @@ -1,103 +0,0 @@ -.\"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-COPY" 1 "" "" "xdg-copy Manual" -.SH NAME -xdg-copy \- command line tool for copying files between desktop URIs -.SH "SYNOPSIS" -.ad l -.hy 0 -.HP 9 -\fBxdg\-copy\fR \fB\fIsource\fR\fR \fB\fIdestination\fR\fR -.ad -.hy -.ad l -.hy 0 -.HP 9 -\fBxdg\-copy\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} -.ad -.hy - -.SH "DESCRIPTION" - -.PP -xdg\-copy copies \fIsource\fR to \fIdestination\fR and provides visual feedback to the user during the operation\&. Both \fIsource\fR and \fIdestination\fR can either be a file or URL\&. Supported URL types are file, ftp, http and https\&. Additional URL types may be supported depending on the desktop environment\&. - -.PP -xdg\-copy is for use inside a desktop session only\&. It is not recommended to use xdg\-copy as root\&. - -.SH "OPTIONS" - -.TP -\fB\-\-help\fR -Show command synopsis\&. - -.TP -\fB\-\-manual\fR -Show this manualpage\&. - -.TP -\fB\-\-version\fR -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: - -.TP -\fB1\fR -Error in command line syntax\&. - -.TP -\fB2\fR -One of the files passed on the command line did not exist\&. - -.TP -\fB3\fR -A required tool could not be found\&. - -.TP -\fB4\fR -The action failed\&. - -.SH "EXAMPLES" - -.PP - - -.nf - -xdg\-copy "http://portland\&.freedesktop\&.org/png/freedesktop\-logo\&.png" \&. - -.fi - - -.PP - - -.nf - -xdg\-copy "/tmp/foobar\&.png" "/home/user/foobar\-copy\&.png" - -.fi - - -.SH AUTHORS -Kevin Krammer, Jeremy White. diff --git a/scripts/man/xdg-desktop-icon.1 b/scripts/man/xdg-desktop-icon.1 index 20af5e0..0b062d2 100644 --- a/scripts/man/xdg-desktop-icon.1 +++ b/scripts/man/xdg-desktop-icon.1 @@ -1,129 +1,190 @@ -.\" ** 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" "06/24/2007" "xdg\-utils 1.0" "" +'\" t +.\" Title: xdg-desktop-icon +.\" Author: Kevin Krammer +.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> +.\" Date: 12/31/2010 +.\" Manual: xdg-desktop-icon Manual +.\" Source: xdg-utils 1.0 +.\" Language: English +.\" +.TH "XDG\-DESKTOP\-ICON" "1" "12/31/2010" "xdg-utils 1.0" "xdg-desktop-icon Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -xdg\-desktop\-icon \- command line tool for (un)installing icons to the desktop +xdg-desktop-icon \- command line tool for (un)installing icons to the desktop .SH "SYNOPSIS" -.HP 17 +.HP \w'\fBxdg\-desktop\-icon\fR\ 'u \fBxdg\-desktop\-icon\fR install [\fB\-\-novendor\fR] \fIFILE\fR -.HP 17 +.HP \w'\fBxdg\-desktop\-icon\fR\ 'u \fBxdg\-desktop\-icon\fR uninstall \fIFILE\fR -.HP 17 -\fBxdg\-desktop\-icon\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} +.HP \w'\fBxdg\-desktop\-icon\fR\ 'u +\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 +.PP install +.RS 4 Installs \fIFILE\fR -to the desktop of the current user. +to the desktop of the current user\&. \fIFILE\fR -can be a *.desktop file or any other type of file. -.TP +can be a *\&.desktop file or any other type of file\&. +.RE +.PP uninstall +.RS 4 Removes \fIFILE\fR -from the desktop of the current user. +from the desktop of the current user\&. +.RE .SH "OPTIONS" -.TP +.PP \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. +.RS 4 +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 +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\&. +.RE +.PP \fB\-\-help\fR -Show command synopsis. -.TP +.RS 4 +Show command synopsis\&. +.RE +.PP \fB\-\-manual\fR -Show this manualpage. -.TP +.RS 4 +Show this manualpage\&. +.RE +.PP \fB\-\-version\fR -Show the xdg\-utils version information. +.RS 4 +Show the xdg\-utils version information\&. +.RE .SH "DESKTOP FILES" .PP -An application launcher can be added to the desktop by installing a *.desktop file. A *.desktop file consists of a +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. +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 +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. +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. -.TP +.PP +Value=1\&.0 +.RS 4 +This is a mandatory field to indicate that the *\&.desktop file follows the 1\&.0 version of the specification\&. +.RE +.PP Type=Application -This is a mandatory field that indicates that the *.desktop file describes an application launcher. -.TP +.RS 4 +This is a mandatory field that indicates that the *\&.desktop file describes an application launcher\&. +.RE +.PP Name=\fIApplication Name\fR -The name of the application. For example +.RS 4 +The name of the application\&. For example \fIMozilla\fR -.TP +.RE +.PP GenericName=\fIGeneric Name\fR -A generic description of the application. For example +.RS 4 +A generic description of the application\&. For example \fIWeb Browser\fR -.TP +.RE +.PP Comment=\fIComment\fR -Optional field to specify a tooltip for the application. For example +.RS 4 +Optional field to specify a tooltip for the application\&. For example \fIVisit websites on the Internet\fR -.TP +.RE +.PP 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 +.RS 4 +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\*(Aqs 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 +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\&. +.RE +.PP 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. +.RS 4 +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\&. +.RE .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 +.PP 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. +.RS 4 +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\&. +.RE .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: -.TP +An exit code of 0 indicates success while a non\-zero exit code indicates failure\&. The following failure codes can be returned: +.PP \fB1\fR -Error in command line syntax. -.TP +.RS 4 +Error in command line syntax\&. +.RE +.PP \fB2\fR -One of the files passed on the command line did not exist. -.TP +.RS 4 +One of the files passed on the command line did not exist\&. +.RE +.PP \fB3\fR -A required tool could not be found. -.TP +.RS 4 +A required tool could not be found\&. +.RE +.PP \fB4\fR -The action failed. -.TP +.RS 4 +The action failed\&. +.RE +.PP \fB5\fR -No permission to read one of the files passed on the command line. +.RS 4 +No permission to read one of the files passed on the command line\&. +.RE .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 +.if n \{\ +.RS 4 +.\} .nf -shinythings\-webmirror.desktop: +shinythings\-webmirror\&.desktop: [Desktop Entry] Encoding=UTF\-8 @@ -135,24 +196,46 @@ shinythings\-webmirror.desktop: Name=WebMirror Name[nl]=WebSpiegel .fi -.sp +.if n \{\ +.RE +.\} .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 +.if n \{\ +.RS 4 +.\} .nf -xdg\-desktop\-icon install ./shinythings\-webmirror.desktop +xdg\-desktop\-icon install \&./shinythings\-webmirror\&.desktop .fi -.sp +.if n \{\ +.RE +.\} .PP To add a README file to the desktop as well, the following command can be used: .sp +.if n \{\ +.RS 4 +.\} .nf -xdg\-desktop\-icon install ./shinythings\-README +xdg\-desktop\-icon install \&./shinythings\-README .fi +.if n \{\ +.RE +.\} .sp -.SH "AUTHOR" -Kevin Krammer, Jeremy White. +.SH "AUTHORS" +.PP +\fBKevin Krammer\fR +.RS 4 +Author. +.RE +.PP +\fBJeremy White\fR +.RS 4 +Author. +.RE +.SH "COPYRIGHT" .br -<kevin.krammer@gmx.at> +Copyright \(co 2006 .br -<jwhite@codeweavers.com> diff --git a/scripts/man/xdg-desktop-menu.1 b/scripts/man/xdg-desktop-menu.1 index e3bd51b..b5ca38a 100644 --- a/scripts/man/xdg-desktop-menu.1 +++ b/scripts/man/xdg-desktop-menu.1 @@ -1,217 +1,300 @@ -.\" ** 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" "06/24/2007" "xdg\-utils 1.0" "" +'\" t +.\" Title: xdg-desktop-menu +.\" Author: Kevin Krammer +.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> +.\" Date: 12/31/2010 +.\" Manual: xdg-desktop-menu Manual +.\" Source: xdg-utils 1.0 +.\" Language: English +.\" +.TH "XDG\-DESKTOP\-MENU" "1" "12/31/2010" "xdg-utils 1.0" "xdg-desktop-menu Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -xdg\-desktop\-menu \- command line tool for (un)installing desktop menu items +xdg-desktop-menu \- command line tool for (un)installing desktop menu items .SH "SYNOPSIS" -.HP 17 +.HP \w'\fBxdg\-desktop\-menu\fR\ 'u \fBxdg\-desktop\-menu\fR install [\fB\-\-noupdate\fR] [\fB\-\-novendor\fR] [\fB\-\-mode\ \fR\fB\fImode\fR\fR] \fIdirectory\-file(s)\fR \fIdesktop\-file(s)\fR -.HP 17 +.HP \w'\fBxdg\-desktop\-menu\fR\ 'u \fBxdg\-desktop\-menu\fR uninstall [\fB\-\-noupdate\fR] [\fB\-\-mode\ \fR\fB\fImode\fR\fR] \fIdirectory\-file(s)\fR \fIdesktop\-file(s)\fR -.HP 17 +.HP \w'\fBxdg\-desktop\-menu\fR\ 'u \fBxdg\-desktop\-menu\fR forceupdate [\fB\-\-mode\ \fR\fB\fImode\fR\fR] -.HP 17 -\fBxdg\-desktop\-menu\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} +.HP \w'\fBxdg\-desktop\-menu\fR\ 'u +\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 menu entries to the desktop's application menu. +The xdg\-desktop\-menu program can be used to install new menu entries to the desktop\*(Aqs 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 +.PP install -Install one or more applications in a submenu of the desktop menu system. +.RS 4 +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. +\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. +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. +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 +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. +the entries will be installed in addition to any already existing entries\&. .sp -\fIdirectory\-file\fR: The *.directory file indicated by +\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. +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\&. .sp -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. +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. -.TP +Directory files follow the syntax defined by the freedesktop\&.org Desktop Entry Specification\&. +.RE +.PP uninstall +.RS 4 Remove applications or submenus from the desktop menu system previously installed with -\fBxdg\-desktop\-menu install\fR. +\fBxdg\-desktop\-menu install\fR\&. .sp -A submenu and the associated directory file is only removed when the submenu no longer contains any menu entries. -.TP +A submenu and the associated directory file is only removed when the submenu no longer contains any menu entries\&. +.RE +.PP forceupdate -Force an update of the menu system. +.RS 4 +Force an update of the menu system\&. .sp This command is only useful if the last call to xdg\-desktop\-menu included the \fB\-\-noupdate\fR -option. +option\&. +.RE .SH "OPTIONS" -.TP +.PP \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. -.TP +.RS 4 +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\&. +.RE +.PP \fB\-\-novendor\fR -Normally, xdg\-desktop\-menu checks to ensure that any *.directory and *.desktop files to be installed has a vendor prefix. This option can be used to disable that check. +.RS 4 +Normally, xdg\-desktop\-menu checks to ensure that any *\&.directory and *\&.desktop 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 +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\&. +.RE +.PP \fB\-\-mode\fR \fImode\fR +.RS 4 \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. +\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 +The default is to use system mode when called by root and to use user mode when called by a non\-root user\&. +.RE +.PP \fB\-\-help\fR -Show command synopsis. -.TP +.RS 4 +Show command synopsis\&. +.RE +.PP \fB\-\-manual\fR -Show this manualpage. -.TP +.RS 4 +Show this manualpage\&. +.RE +.PP \fB\-\-version\fR -Show the xdg\-utils version information. +.RS 4 +Show the xdg\-utils version information\&. +.RE .SH "DESKTOP FILES" .PP -An application item in the application menu is represented by a *.desktop file. A *.desktop file consists of a +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. +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 +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. +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. -.TP +.PP +Value=1\&.0 +.RS 4 +This is a mandatory field to indicate that the *\&.desktop file follows the 1\&.0 version of the specification\&. +.RE +.PP Type=Application -This is a mandatory field that indicates that the *.desktop file describes an application launcher. -.TP +.RS 4 +This is a mandatory field that indicates that the *\&.desktop file describes an application launcher\&. +.RE +.PP Name=\fIApplication Name\fR -The name of the application. For example +.RS 4 +The name of the application\&. For example \fIMozilla\fR -.TP +.RE +.PP GenericName=\fIGeneric Name\fR -A generic description of the application. For example +.RS 4 +A generic description of the application\&. For example \fIWeb Browser\fR -.TP +.RE +.PP Comment=\fIComment\fR -Optional field to specify a tooltip for the application. For example +.RS 4 +Optional field to specify a tooltip for the application\&. For example \fIVisit websites on the Internet\fR -.TP +.RE +.PP 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 +.RS 4 +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\*(Aqs 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 +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\&. +.RE +.PP 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 +.RS 4 +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\&. +.RE +.PP 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. +.RS 4 +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. +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 +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 +.RE +.PP 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. +.RS 4 +A list of mimetypes separated by semi\-colons\&. This field is used to indicate which file types the application is able to open\&. +.RE .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 "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 +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. +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 +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. +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 +.PP +Value=1\&.0 +.RS 4 +This is a mandatory field to indicate that the *\&.directory file follows the 1\&.0 version of the Desktop Entry specification\&. +.RE +.PP Type=Directory -This is a mandatory field that indicates that the *.directory file describes a submenu. -.TP +.RS 4 +This is a mandatory field that indicates that the *\&.directory file describes a submenu\&. +.RE +.PP Name=\fIMenu Name\fR -The title of submenu. For example +.RS 4 +The title of submenu\&. For example \fIMozilla\fR -.TP +.RE +.PP Comment=\fIComment\fR -Optional field to specify a tooltip for the submenu. -.TP +.RS 4 +Optional field to specify a tooltip for the submenu\&. +.RE +.PP 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 +.RS 4 +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\*(Aqs 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. +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\&. +.RE .SH "ENVIRONMENT VARIABLES" .PP xdg\-desktop\-menu honours the following environment variables: -.TP +.PP 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. -.TP +.RS 4 +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\&. +.RE +.PP XDG_UTILS_INSTALL_MODE -This environment variable can be used by the user or administrator to override the installation mode. Valid values are +.RS 4 +This environment variable can be used by the user or administrator to override the installation mode\&. Valid values are \fIuser\fR and -\fIsystem\fR. +\fIsystem\fR\&. +.RE .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: -.TP +An exit code of 0 indicates success while a non\-zero exit code indicates failure\&. The following failure codes can be returned: +.PP \fB1\fR -Error in command line syntax. -.TP +.RS 4 +Error in command line syntax\&. +.RE +.PP \fB2\fR -One of the files passed on the command line did not exist. -.TP +.RS 4 +One of the files passed on the command line did not exist\&. +.RE +.PP \fB3\fR -A required tool could not be found. -.TP +.RS 4 +A required tool could not be found\&. +.RE +.PP \fB4\fR -The action failed. -.TP +.RS 4 +The action failed\&. +.RE +.PP \fB5\fR -No permission to read one of the files passed on the command line. +.RS 4 +No permission to read one of the files passed on the command line\&. +.RE .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 +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 +.if n \{\ +.RS 4 +.\} .nf -shinythings\-webmirror.desktop: +shinythings\-webmirror\&.desktop: [Desktop Entry] Encoding=UTF\-8 @@ -225,23 +308,33 @@ shinythings\-webmirror.desktop: Categories=Network;WebDevelopment; .fi -.sp +.if n \{\ +.RE +.\} .PP -Now the xdg\-desktop\-menu tool can be used to add the shinythings\-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 +.if n \{\ +.RS 4 +.\} .nf -xdg\-desktop\-menu install ./shinythings\-webmirror.desktop +xdg\-desktop\-menu install \&./shinythings\-webmirror\&.desktop .fi -.sp +.if n \{\ +.RE +.\} .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. will 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\&. 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. Since the items are to be added to a new submenu it is not necassery to include a Categories= line: +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 +.if n \{\ +.RS 4 +.\} .nf -shinythings\-webmirror.desktop: +shinythings\-webmirror\&.desktop: [Desktop Entry] Encoding=UTF\-8 @@ -254,7 +347,7 @@ shinythings\-webmirror.desktop: Name[nl]=WebSpiegel -shinythings\-webmirror\-admin.desktop: +shinythings\-webmirror\-admin\&.desktop: [Desktop Entry] Encoding=UTF\-8 @@ -266,12 +359,17 @@ shinythings\-webmirror\-admin.desktop: Name=WebMirror Admin Tool Name[nl]=WebSpiegel Administratie Tool .fi -.sp +.if n \{\ +.RE +.\} .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 +.if n \{\ +.RS 4 +.\} .nf -shinythings\-webmirror.directory: +shinythings\-webmirror\&.directory: [Desktop Entry] Encoding=UTF\-8 @@ -281,43 +379,70 @@ shinythings\-webmirror.directory: Name=WebMirror Name[nl]=WebSpiegel .fi -.sp +.if n \{\ +.RE +.\} .PP These file can now be installed with: .sp +.if n \{\ +.RS 4 +.\} .nf -xdg\-desktop\-menu install ./shinythings\-webmirror.directory \\ - ./shinythings\-webmirror.desktop ./shinythings\-webmirror\-admin.desktop +xdg\-desktop\-menu install \&./shinythings\-webmirror\&.directory \e + \&./shinythings\-webmirror\&.desktop \&./shinythings\-webmirror\-admin\&.desktop .fi -.sp +.if n \{\ +.RE +.\} .PP The menu entries could also be installed one by one: .sp +.if n \{\ +.RS 4 +.\} .nf -xdg\-desktop\-menu install \-\-noupdate ./shinythings\-webmirror.directory \\ - ./shinythings\-webmirror.desktop -xdg\-desktop\-menu install \-\-noupdate ./shinythings\-webmirror.directory \\ - ./shinythings\-webmirror\-admin.desktop +xdg\-desktop\-menu install \-\-noupdate \&./shinythings\-webmirror\&.directory \e + \&./shinythings\-webmirror\&.desktop +xdg\-desktop\-menu install \-\-noupdate \&./shinythings\-webmirror\&.directory \e + \&./shinythings\-webmirror\-admin\&.desktop xdg\-desktop\-menu forceupdate .fi -.sp +.if n \{\ +.RE +.\} .PP -Although the result is the same it is slightly more efficient to install all files at the same time. +Although the result is the same it is slightly more efficient to install all files at the same time\&. .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 +.if n \{\ +.RS 4 +.\} .nf -xdg\-icon\-resource install \-\-size 22 ./wmicon\-22.png shinythings\-webmirror -xdg\-icon\-resource install \-\-size 22 ./wmicon\-menu\-22.png shinythings\-webmirror\-menu -xdg\-icon\-resource install \-\-size 22 ./wmicon\-admin\-22.png shinythings\-webmirror\-admin -xdg\-icon\-resource install \-\-size 64 ./wmicon\-64.png shinythings\-webmirror -xdg\-icon\-resource install \-\-size 64 ./wmicon\-menu\-64.png shinythings\-webmirror\-menu -xdg\-icon\-resource install \-\-size 64 ./wmicon\-admin\-64.png shinythings\-webmirror\-admin +xdg\-icon\-resource install \-\-size 22 \&./wmicon\-22\&.png shinythings\-webmirror +xdg\-icon\-resource install \-\-size 22 \&./wmicon\-menu\-22\&.png shinythings\-webmirror\-menu +xdg\-icon\-resource install \-\-size 22 \&./wmicon\-admin\-22\&.png shinythings\-webmirror\-admin +xdg\-icon\-resource install \-\-size 64 \&./wmicon\-64\&.png shinythings\-webmirror +xdg\-icon\-resource install \-\-size 64 \&./wmicon\-menu\-64\&.png shinythings\-webmirror\-menu +xdg\-icon\-resource install \-\-size 64 \&./wmicon\-admin\-64\&.png shinythings\-webmirror\-admin .fi +.if n \{\ +.RE +.\} .sp -.SH "AUTHOR" -Kevin Krammer, Jeremy White. +.SH "AUTHORS" +.PP +\fBKevin Krammer\fR +.RS 4 +Author. +.RE +.PP +\fBJeremy White\fR +.RS 4 +Author. +.RE +.SH "COPYRIGHT" .br -<kevin.krammer@gmx.at> +Copyright \(co 2006 .br -<jwhite@codeweavers.com> diff --git a/scripts/man/xdg-email.1 b/scripts/man/xdg-email.1 index 60e4e1f..09d1709 100644 --- a/scripts/man/xdg-email.1 +++ b/scripts/man/xdg-email.1 @@ -1,118 +1,199 @@ -.\" ** 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" "06/24/2007" "xdg\-utils 1.0" "" +'\" t +.\" Title: xdg-email +.\" Author: Kevin Krammer +.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> +.\" Date: 12/31/2010 +.\" Manual: xdg-email Manual +.\" Source: xdg-utils 1.0 +.\" Language: English +.\" +.TH "XDG\-EMAIL" "1" "12/31/2010" "xdg-utils 1.0" "xdg-email Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -xdg\-email \- command line tool for sending mail using the user's preferred e\-mail composer +xdg-email \- command line tool for sending mail using the user\*(Aqs 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] [\fImailto\-uri\fR \fIaddress(es)\fR] -.HP 10 -\fBxdg\-email\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} +.HP \w'\fBxdg\-email\fR\ 'u +\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 \w'\fBxdg\-email\fR\ 'u +\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 +xdg\-email opens the user\*(Aqs 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. +\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. +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\*(Aqs 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 +.PP \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. -.TP +.RS 4 +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\&. +.RE +.PP \fB\-\-cc\fR \fIaddress\fR -Specify a recipient to be copied on the e\-mail. -.TP +.RS 4 +Specify a recipient to be copied on the e\-mail\&. +.RE +.PP \fB\-\-bcc\fR \fIaddress\fR -Specify a recipient to be blindly copied on the e\-mail. -.TP +.RS 4 +Specify a recipient to be blindly copied on the e\-mail\&. +.RE +.PP \fB\-\-subject\fR \fItext\fR -Specify a subject for the e\-mail. -.TP +.RS 4 +Specify a subject for the e\-mail\&. +.RE +.PP \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. +.RS 4 +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 +may contain linebreaks\&. +.RE +.PP \fB\-\-attach\fR \fIfile\fR -Specify an attachment for the e\-mail. +.RS 4 +Specify an attachment for the e\-mail\&. \fIfile\fR -must point to an existing file. +must point to an existing file\&. .sp -Some e\-mail applications require the file to remain present after xdg\-email returns. -.TP +Some e\-mail applications require the file to remain present after xdg\-email returns\&. +.RE +.PP \fB\-\-help\fR -Show command synopsis. -.TP +.RS 4 +Show command synopsis\&. +.RE +.PP \fB\-\-manual\fR -Show this manualpage. -.TP +.RS 4 +Show this manualpage\&. +.RE +.PP \fB\-\-version\fR -Show the xdg\-utils version information. +.RS 4 +Show the xdg\-utils version information\&. +.RE .SH "ENVIRONMENT VARIABLES" .PP xdg\-email honours the following environment variables: -.TP +.PP 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. +.RS 4 +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\&. +.RE .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: -.TP +An exit code of 0 indicates success while a non\-zero exit code indicates failure\&. The following failure codes can be returned: +.PP \fB1\fR -Error in command line syntax. -.TP +.RS 4 +Error in command line syntax\&. +.RE +.PP \fB2\fR -One of the files passed on the command line did not exist. -.TP +.RS 4 +One of the files passed on the command line did not exist\&. +.RE +.PP \fB3\fR -A required tool could not be found. -.TP +.RS 4 +A required tool could not be found\&. +.RE +.PP \fB4\fR -The action failed. -.TP +.RS 4 +The action failed\&. +.RE +.PP \fB5\fR -No permission to read one of the files passed on the command line. +.RS 4 +No permission to read one of the files passed on the command line\&. +.RE .SH "CONFIGURATION" .PP -Visit http://portland.freedesktop.org/EmailConfig for information how to configure xdg\-email to use the email client of your choice. +Visit http://portland\&.freedesktop\&.org/EmailConfig for information how to configure xdg\-email to use the email client of your choice\&. .SH "EXAMPLES" .PP + +.sp +.if n \{\ +.RS 4 +.\} .nf -xdg\-email 'Jeremy White <jwhite@example.com>' +xdg\-email \*(AqJeremy White <jwhite@example\&.com>\*(Aq .fi -.sp +.if n \{\ +.RE +.\} .PP + +.sp +.if n \{\ +.RS 4 +.\} .nf -xdg\-email \-\-attach /tmp/logo.png \\ - \-\-subject 'Logo contest' \\ - \-\-body 'Attached you find the logo for the contest.' \\ - 'jwhite@example.com' +xdg\-email \-\-attach /tmp/logo\&.png \e + \-\-subject \*(AqLogo contest\*(Aq \e + \-\-body \*(AqAttached you find the logo for the contest\&.\*(Aq \e + \*(Aqjwhite@example\&.com\*(Aq .fi -.sp +.if n \{\ +.RE +.\} .PP + +.sp +.if n \{\ +.RS 4 +.\} .nf -xdg\-email \-\-subject 'Your password is about to expire' \\ - 'jwhite@example.com' 'bastian@example.com' 'whipple@example.com' +xdg\-email \-\-subject \*(AqYour password is about to expire\*(Aq \e + \*(Aqjwhite@example\&.com\*(Aq \*(Aqbastian@example\&.com\*(Aq \*(Aqwhipple@example\&.com\*(Aq .fi +.if n \{\ +.RE +.\} .sp -.SH "AUTHOR" -Kevin Krammer, Jeremy White. +.SH "AUTHORS" +.PP +\fBKevin Krammer\fR +.RS 4 +Author. +.RE +.PP +\fBJeremy White\fR +.RS 4 +Author. +.RE +.SH "COPYRIGHT" .br -<kevin.krammer@gmx.at> +Copyright \(co 2006 .br -<jwhite@codeweavers.com> diff --git a/scripts/man/xdg-file-dialog.1 b/scripts/man/xdg-file-dialog.1 deleted file mode 100644 index 50d759b..0000000 --- a/scripts/man/xdg-file-dialog.1 +++ /dev/null @@ -1,143 +0,0 @@ -.\"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-FILE-DIALOG" 1 "" "" "xdg-file-dialog Manual" -.SH NAME -xdg-file-dialog \- command line tool for providing file and directory selection dialogs -.SH "SYNOPSIS" -.ad l -.hy 0 -.HP 16 -\fBxdg\-file\-dialog\fR openfilename [\fB\-\-title\ \fITITLE\fR\fR] [\fIFILENAME\fR] -.ad -.hy -.ad l -.hy 0 -.HP 16 -\fBxdg\-file\-dialog\fR openfilenamelist [\fB\-\-title\ \fITITLE\fR\fR] [\fIFILENAME\fR] -.ad -.hy -.ad l -.hy 0 -.HP 16 -\fBxdg\-file\-dialog\fR savefilename [\fB\-\-title\ \fITITLE\fR\fR] [\fIFILENAME\fR] -.ad -.hy -.ad l -.hy 0 -.HP 16 -\fBxdg\-file\-dialog\fR directory [\fB\-\-title\ \fITITLE\fR\fR] [\fIDIRNAME\fR] -.ad -.hy -.ad l -.hy 0 -.HP 16 -\fBxdg\-file\-dialog\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} -.ad -.hy - -.SH "DESCRIPTION" - -.PP -The xdg\-file\-dialog program can be used to let the native file selection dialog handle file and directory input\&. - -.PP -xdg\-file\-dialog is for use inside a desktop session only\&. It is not recommended to use xdg\-file\-dialog as root\&. - -.SH "COMMANDS" - -.TP -openfilename -Returns the filename with path for a file to read from\&. \fIFILENAME\fR can optionally be used to specify path and filename of a preselection\&. - -.TP -openfilenamelist -Returns one or more filenames with path for files to read from, each on a new line\&. \fIFILENAME\fR can optionally be used to specify path and filename of a preselection\&. - -.TP -savefilename -Returns the filename with path for file to write to\&. \fIFILENAME\fR can optionally be used to specify path and filename of a preselection\&. - -.TP -directory -Returns the path for an exsiting directory\&. \fIDIRNAME\fR can optionally be used to specify a path of a preselection\&. - -.SH "OPTIONS" - -.TP -\fB\-\-title\fR \fITITLE\fR -Sets the dialog's title (caption) to the specified text\&. - -.TP -\fB\-\-help\fR -Show command synopsis\&. - -.TP -\fB\-\-manual\fR -Show this manualpage\&. - -.TP -\fB\-\-version\fR -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: - -.TP -\fB1\fR -Error in command line syntax\&. - -.TP -\fB2\fR -One of the files passed on the command line did not exist\&. - -.TP -\fB3\fR -A required tool could not be found\&. - -.TP -\fB4\fR -The action failed\&. - -.SH "EXAMPLES" - -.PP - - -.nf - -xdg\-file\-dialog savefilename /tmp/foobar\&.png - -.fi - Asks for a save file name starting in directory /tmp and suggesting foobar\&.png as the filename - -.PP - - -.nf - -xdg\-file\-dialog directory \-\-title "Select a target folder" /tmp - -.fi - Asks for a directory name starting in directory /tmp using the text "Select a target folder" as the dialog's title/caption\&. - -.SH AUTHOR -Kevin Krammer. diff --git a/scripts/man/xdg-icon-resource.1 b/scripts/man/xdg-icon-resource.1 index 6e38545..283b903 100644 --- a/scripts/man/xdg-icon-resource.1 +++ b/scripts/man/xdg-icon-resource.1 @@ -1,166 +1,244 @@ -.\" ** 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" "06/24/2007" "xdg\-utils 1.0" "" +'\" t +.\" Title: xdg-icon-resource +.\" Author: Kevin Krammer +.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> +.\" Date: 12/31/2010 +.\" Manual: xdg-icon-resource Manual +.\" Source: xdg-utils 1.0 +.\" Language: English +.\" +.TH "XDG\-ICON\-RESOURCE" "1" "12/31/2010" "xdg-utils 1.0" "xdg-icon-resource Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -xdg\-icon\-resource \- command line tool for (un)installing icon resources +xdg-icon-resource \- command line tool for (un)installing icon resources .SH "SYNOPSIS" -.HP 18 +.HP \w'\fBxdg\-icon\-resource\fR\ 'u \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\-\-mode\ \fR\fB\fImode\fR\fR] \fB\-\-size\ \fR\fB\fIsize\fR\fR \fIicon\-file\fR [\fIicon\-name\fR] -.HP 18 +.HP \w'\fBxdg\-icon\-resource\fR\ 'u \fBxdg\-icon\-resource\fR uninstall [\fB\-\-noupdate\fR] [\fB\-\-theme\ \fR\fB\fItheme\fR\fR] [\fB\-\-context\ \fR\fB\fIcontext\fR\fR] [\fB\-\-mode\ \fR\fB\fImode\fR\fR] \fB\-\-size\ \fR\fB\fIsize\fR\fR \fIicon\-name\fR -.HP 18 +.HP \w'\fBxdg\-icon\-resource\fR\ 'u \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\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} +.HP \w'\fBxdg\-icon\-resource\fR\ 'u +\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 or PNG 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 or PNG 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 +.PP install +.RS 4 Installs the icon file indicated by \fIicon\-file\fR to the desktop icon system under the name -\fIicon\-name\fR. Icon names do not have an extension. If +\fIicon\-name\fR\&. Icon names do not have an extension\&. If \fIicon\-name\fR is not provided the name is derived from -\fIicon\-file\fR. The icon file must have -\fI.png\fR +\fIicon\-file\fR\&. The icon file must have +\fI\&.png\fR or -\fI.xpm\fR -as extension. If a corresponding -\fI.icon\fR +\fI\&.xpm\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 +it will be installed as well\&. +.RE +.PP uninstall +.RS 4 Removes the icon indicated by \fIicon\-name\fR -from the desktop icon system. Note that icon names do not have an extension. -.TP +from the desktop icon system\&. Note that icon names do not have an extension\&. +.RE +.PP forceupdate -Force an update of the desktop icon system. This is only useful if the last call to xdg\-icon\-resource included the +.RS 4 +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. +option\&. +.RE .SH "OPTIONS" -.TP +.PP \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 necessary to update the desktop icon system right away. -.TP +.RS 4 +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\&. +.RE +.PP \fB\-\-novendor\fR +.RS 4 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. +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 +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\&. +.RE +.PP \fB\-\-theme\fR \fItheme\fR +.RS 4 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 +\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 +theme\&. Applications may install icons under multiple themes but should at least install icons for the default \fIhicolor\fR -theme. -.TP +theme\&. +.RE +.PP \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 +.RS 4 +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 +as context which is the default context\&. Icons to be used as file icons should use \fImimetypes\fR -as context. Other common contexts are +as context\&. Other common contexts are \fIactions\fR, \fIdevices\fR, \fIemblems\fR, \fIfilesystems\fR and -\fIstock\fR. -.TP +\fIstock\fR\&. +.RE +.PP \fB\-\-size\fR \fIsize\fR -Specifies the size of the icon. 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 +.RS 4 +Specifies the size of the icon\&. 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 +.RE +.PP \fB\-\-mode\fR \fImode\fR +.RS 4 \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. +\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 +The default is to use system mode when called by root and to use user mode when called by a non\-root user\&. +.RE +.PP \fB\-\-help\fR -Show command synopsis. -.TP +.RS 4 +Show command synopsis\&. +.RE +.PP \fB\-\-manual\fR -Show this manualpage. -.TP +.RS 4 +Show this manualpage\&. +.RE +.PP \fB\-\-version\fR -Show the xdg\-utils version information. +.RS 4 +Show the xdg\-utils version information\&. +.RE .SH "ENVIRONMENT VARIABLES" .PP xdg\-icon\-resource honours the following environment variables: -.TP +.PP 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. -.TP +.RS 4 +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\&. +.RE +.PP XDG_UTILS_INSTALL_MODE -This environment variable can be used by the user or administrator to override the installation mode. Valid values are +.RS 4 +This environment variable can be used by the user or administrator to override the installation mode\&. Valid values are \fIuser\fR and -\fIsystem\fR. +\fIsystem\fR\&. +.RE .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: -.TP +An exit code of 0 indicates success while a non\-zero exit code indicates failure\&. The following failure codes can be returned: +.PP \fB1\fR -Error in command line syntax. -.TP +.RS 4 +Error in command line syntax\&. +.RE +.PP \fB2\fR -One of the files passed on the command line did not exist. -.TP +.RS 4 +One of the files passed on the command line did not exist\&. +.RE +.PP \fB3\fR -A required tool could not be found. -.TP +.RS 4 +A required tool could not be found\&. +.RE +.PP \fB4\fR -The action failed. -.TP +.RS 4 +The action failed\&. +.RE +.PP \fB5\fR -No permission to read one of the files passed on the command line. +.RS 4 +No permission to read one of the files passed on the command line\&. +.RE .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, the company ShinyThings Inc. can use: +To install an icon resource to depict a launcher for the application myfoobar, the company ShinyThings Inc\&. can use: .sp +.if n \{\ +.RS 4 +.\} .nf -xdg\-icon\-resource install \-\-size 64 shinythings\-myfoobar.png +xdg\-icon\-resource install \-\-size 64 shinythings\-myfoobar\&.png .fi -.sp +.if n \{\ +.RE +.\} .PP To install an icon for a new application/x\-foobar file type one can use: .sp +.if n \{\ +.RS 4 +.\} .nf -xdg\-icon\-resource install \-\-context mimetypes \-\-size 48 ./mime\-foobar\-48.png application\-x\-foobar -xdg\-icon\-resource install \-\-context mimetypes \-\-size 64 ./mime\-foobar\-64.png application\-x\-foobar +xdg\-icon\-resource install \-\-context mimetypes \-\-size 48 \&./mime\-foobar\-48\&.png application\-x\-foobar +xdg\-icon\-resource install \-\-context mimetypes \-\-size 64 \&./mime\-foobar\-64\&.png application\-x\-foobar .fi +.if n \{\ +.RE +.\} .sp -This will install two icons with the name application\-x\-foobar but with different sizes. -.SH "AUTHOR" -Kevin Krammer, Jeremy White. +This will install two icons with the name application\-x\-foobar but with different sizes\&. +.SH "AUTHORS" +.PP +\fBKevin Krammer\fR +.RS 4 +Author. +.RE +.PP +\fBJeremy White\fR +.RS 4 +Author. +.RE +.SH "COPYRIGHT" .br -<kevin.krammer@gmx.at> +Copyright \(co 2006 .br -<jwhite@codeweavers.com> diff --git a/scripts/man/xdg-mime.1 b/scripts/man/xdg-mime.1 index f7c1d16..cb06c26 100644 --- a/scripts/man/xdg-mime.1 +++ b/scripts/man/xdg-mime.1 @@ -1,188 +1,286 @@ -.\" ** 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" "06/24/2007" "xdg\-utils 1.0" "" +'\" t +.\" Title: xdg-mime +.\" Author: Kevin Krammer +.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> +.\" Date: 12/31/2010 +.\" Manual: xdg-mime Manual +.\" Source: xdg-utils 1.0 +.\" Language: English +.\" +.TH "XDG\-MIME" "1" "12/31/2010" "xdg-utils 1.0" "xdg-mime Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -xdg\-mime \- command line tool for querying information about file type handling and adding descriptions for new file types +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 {filetype default} ... -.HP 9 +.HP \w'\fBxdg\-mime\fR\ 'u +\fBxdg\-mime\fR query {filetype | default} \&.\&.\&. +.HP \w'\fBxdg\-mime\fR\ 'u \fBxdg\-mime\fR default \fIapplication\fR \fImimetype(s)\fR -.HP 9 +.HP \w'\fBxdg\-mime\fR\ 'u \fBxdg\-mime\fR install [\fB\-\-mode\ \fR\fB\fImode\fR\fR] [\fB\-\-novendor\fR] \fImimetypes\-file\fR -.HP 9 +.HP \w'\fBxdg\-mime\fR\ 'u \fBxdg\-mime\fR uninstall [\fB\-\-mode\ \fR\fB\fImode\fR\fR] \fImimetypes\-file\fR -.HP 9 -\fBxdg\-mime\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} +.HP \w'\fBxdg\-mime\fR\ 'u +\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 +.PP query -Returns information related to file types. +.RS 4 +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. +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: .sp query filetype \fIFILE\fR: Returns the file type of \fIFILE\fR -in the form of a MIME type. +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 +\fImimetype\fR\&. The default application is identified by its *\&.desktop file\&. +.RE +.PP default +.RS 4 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. +\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 +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 application's desktop file must list support for all the MIME types that it wishes to be the default handler for. +must already be installed in the desktop menu before it can be made the default handler\&. The aplication\*(Aqs 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. +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 +option is for use inside a desktop session only\&. It is not recommended to use xdg\-mime default as root\&. +.RE +.PP install +.RS 4 Adds the file type descriptions provided in \fImimetypes\-file\fR -to the desktop environment. +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 +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 +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\&. +.RE +.PP uninstall +.RS 4 Removes the file type descriptions provided in \fImimetypes\-file\fR and previously added with \fBxdg\-mime install\fR -from the desktop environment. +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. +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\&. +.RE .SH "OPTIONS" -.TP +.PP \fB\-\-mode\fR \fImode\fR +.RS 4 \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. +\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 +The default is to use system mode when called by root and to use user mode when called by a non\-root user\&. +.RE +.PP \fB\-\-novendor\fR +.RS 4 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. +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 +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\&. +.RE +.PP \fB\-\-help\fR -Show command synopsis. -.TP +.RS 4 +Show command synopsis\&. +.RE +.PP \fB\-\-manual\fR -Show this manualpage. -.TP +.RS 4 +Show this manualpage\&. +.RE +.PP \fB\-\-version\fR -Show the xdg\-utils version information. +.RS 4 +Show the xdg\-utils version information\&. +.RE .SH "ENVIRONMENT VARIABLES" .PP xdg\-mime honours the following environment variables: -.TP +.PP 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. -.TP +.RS 4 +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\&. +.RE +.PP XDG_UTILS_INSTALL_MODE -This environment variable can be used by the user or administrator to override the installation mode. Valid values are +.RS 4 +This environment variable can be used by the user or administrator to override the installation mode\&. Valid values are \fIuser\fR and -\fIsystem\fR. +\fIsystem\fR\&. +.RE .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: -.TP +An exit code of 0 indicates success while a non\-zero exit code indicates failure\&. The following failure codes can be returned: +.PP \fB1\fR -Error in command line syntax. -.TP +.RS 4 +Error in command line syntax\&. +.RE +.PP \fB2\fR -One of the files passed on the command line did not exist. -.TP +.RS 4 +One of the files passed on the command line did not exist\&. +.RE +.PP \fB3\fR -A required tool could not be found. -.TP +.RS 4 +A required tool could not be found\&. +.RE +.PP \fB4\fR -The action failed. -.TP +.RS 4 +The action failed\&. +.RE +.PP \fB5\fR -No permission to read one of the files passed on the command line. +.RS 4 +No permission to read one of the files passed on the command line\&. +.RE .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 + +.sp +.if n \{\ +.RS 4 +.\} .nf -xdg\-mime query filetype /tmp/foobar.png +xdg\-mime query filetype /tmp/foobar\&.png .fi +.if n \{\ +.RE +.\} .sp -Prints the MIME type of the file /tmp/foobar.png, in this case image/png +Prints the MIME type of the file /tmp/foobar\&.png, in this case image/png .PP + +.sp +.if n \{\ +.RS 4 +.\} .nf xdg\-mime query default image/png .fi +.if n \{\ +.RE +.\} .sp -Prints the .desktop filename of the application which is registered to open PNG files. +Prints the \&.desktop filename of the application which is registered to open PNG files\&. .PP + +.sp +.if n \{\ +.RS 4 +.\} .nf -xdg\-mime install shinythings\-shiny.xml +xdg\-mime install shinythings\-shiny\&.xml .fi +.if n \{\ +.RE +.\} .sp -Adds a file type description for "shiny"\-files. "shinythings\-" is used as the vendor prefix. The file type description could look as folows. +Adds a file type description for "shiny"\-files\&. "shinythings\-" is used as the vendor prefix\&. The file type description could look as folows\&. .sp +.if n \{\ +.RS 4 +.\} .nf -shinythings\-shiny.xml: +shinythings\-shiny\&.xml: -<?xml version="1.0"?> -<mime\-info xmlns='http://www.freedesktop.org/standards/shared\-mime\-info'> +<?xml version="1\&.0"?> +<mime\-info xmlns=\*(Aqhttp://www\&.freedesktop\&.org/standards/shared\-mime\-info\*(Aq> <mime\-type type="text/x\-shiny"> <comment>Shiny new file type</comment> - <glob pattern="*.shiny"/> - <glob pattern="*.shi"/> + <glob pattern="*\&.shiny"/> + <glob pattern="*\&.shi"/> </mime\-type> </mime\-info> .fi +.if n \{\ +.RE +.\} .sp An icon for this new file type must also be installed, for example with: .sp +.if n \{\ +.RS 4 +.\} .nf -xdg\-icon\-resource install \-\-context mimetypes \-\-size 64 shiny\-file\-icon.png text\-x\-shiny +xdg\-icon\-resource install \-\-context mimetypes \-\-size 64 shiny\-file\-icon\&.png text\-x\-shiny .fi +.if n \{\ +.RE +.\} .sp -.SH "AUTHOR" -Kevin Krammer, Jeremy White. +.SH "AUTHORS" +.PP +\fBKevin Krammer\fR +.RS 4 +Author. +.RE +.PP +\fBJeremy White\fR +.RS 4 +Author. +.RE +.SH "COPYRIGHT" .br -<kevin.krammer@gmx.at> +Copyright \(co 2006 .br -<jwhite@codeweavers.com> diff --git a/scripts/man/xdg-open.1 b/scripts/man/xdg-open.1 index 2cad9bd..984c58c 100644 --- a/scripts/man/xdg-open.1 +++ b/scripts/man/xdg-open.1 @@ -1,71 +1,124 @@ -.\" ** 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" "06/24/2007" "xdg\-utils 1.0" "" +'\" t +.\" Title: xdg-open +.\" Author: Kevin Krammer +.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> +.\" Date: 12/31/2010 +.\" Manual: xdg-open Manual +.\" Source: xdg-utils 1.0 +.\" Language: English +.\" +.TH "XDG\-OPEN" "1" "12/31/2010" "xdg-utils 1.0" "xdg-open Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -xdg\-open \- opens a file or URL in the user's preferred application +xdg-open \- opens a file or URL in the user\*(Aqs preferred application .SH "SYNOPSIS" -.HP 9 -\fBxdg\-open\fR {\fB\fIfile\fR\fR \fB\fIURL\fR\fR} -.HP 9 -\fBxdg\-open\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} +.HP \w'\fBxdg\-open\fR\ 'u +\fBxdg\-open\fR {\fB\fIfile\fR\fR | \fB\fIURL\fR\fR} +.HP \w'\fBxdg\-open\fR\ 'u +\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\*(Aqs preferred application\&. If a URL is provided the URL will be opened in the user\*(Aqs 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 +.PP \fB\-\-help\fR -Show command synopsis. -.TP +.RS 4 +Show command synopsis\&. +.RE +.PP \fB\-\-manual\fR -Show this manualpage. -.TP +.RS 4 +Show this manualpage\&. +.RE +.PP \fB\-\-version\fR -Show the xdg\-utils version information. +.RS 4 +Show the xdg\-utils version information\&. +.RE .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: -.TP +An exit code of 0 indicates success while a non\-zero exit code indicates failure\&. The following failure codes can be returned: +.PP \fB1\fR -Error in command line syntax. -.TP +.RS 4 +Error in command line syntax\&. +.RE +.PP \fB2\fR -One of the files passed on the command line did not exist. -.TP +.RS 4 +One of the files passed on the command line did not exist\&. +.RE +.PP \fB3\fR -A required tool could not be found. -.TP +.RS 4 +A required tool could not be found\&. +.RE +.PP \fB4\fR -The action failed. +.RS 4 +The action failed\&. +.RE .SH "EXAMPLES" .PP + +.sp +.if n \{\ +.RS 4 +.\} .nf -xdg\-open 'http://www.freedesktop.org/' +xdg\-open \*(Aqhttp://www\&.freedesktop\&.org/\*(Aq .fi +.if n \{\ +.RE +.\} .sp -Opens the Freedesktop.org website in the user's default browser +Opens the Freedesktop\&.org website in the user\*(Aqs default browser .PP + +.sp +.if n \{\ +.RS 4 +.\} .nf -xdg\-open /tmp/foobar.png +xdg\-open /tmp/foobar\&.png .fi +.if n \{\ +.RE +.\} .sp -Opens the PNG image file /tmp/foobar.png in the user's default image viewing application. -.SH "FILES" +Opens the PNG image file /tmp/foobar\&.png in the user\*(Aqs default image viewing application\&. +.SH "AUTHORS" .PP -\fI/usr/share/applications/defaults.list ~/.local/share/applications\fR -.SH "SEE ALSO" +\fBKevin Krammer\fR +.RS 4 +Author. +.RE .PP -\fBxdg-mime\fR(1), -.SH "AUTHOR" -Kevin Krammer, Jeremy White. +\fBJeremy White\fR +.RS 4 +Author. +.RE +.SH "COPYRIGHT" .br -<kevin.krammer@gmx.at> +Copyright \(co 2006 .br -<jwhite@codeweavers.com> diff --git a/scripts/man/xdg-screensaver.1 b/scripts/man/xdg-screensaver.1 index 719e92f..dc68409 100644 --- a/scripts/man/xdg-screensaver.1 +++ b/scripts/man/xdg-screensaver.1 @@ -1,96 +1,154 @@ -.\" ** 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" "06/24/2007" "xdg\-utils 1.0" "" +'\" t +.\" Title: xdg-screensaver +.\" Author: Bryce Harrington +.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> +.\" Date: 12/31/2010 +.\" Manual: xdg-screensaver Manual +.\" Source: xdg-utils 1.0 +.\" Language: English +.\" +.TH "XDG\-SCREENSAVER" "1" "12/31/2010" "xdg-utils 1.0" "xdg-screensaver Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -xdg\-screensaver \- command line tool for controlling the screensaver +xdg-screensaver \- command line tool for controlling the screensaver .SH "SYNOPSIS" -.HP 16 +.HP \w'\fBxdg\-screensaver\fR\ 'u \fBxdg\-screensaver\fR \fBsuspend\ \fR\fB\fIWindowID\fR\fR -.HP 16 +.HP \w'\fBxdg\-screensaver\fR\ 'u \fBxdg\-screensaver\fR \fBresume\ \fR\fB\fIWindowID\fR\fR -.HP 16 -\fBxdg\-screensaver\fR {\fBactivate\fR \fBlock\fR \fBreset\fR \fBstatus\fR} -.HP 16 -\fBxdg\-screensaver\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} +.HP \w'\fBxdg\-screensaver\fR\ 'u +\fBxdg\-screensaver\fR {\fBactivate\fR | \fBlock\fR | \fBreset\fR | \fBstatus\fR} +.HP \w'\fBxdg\-screensaver\fR\ 'u +\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 +.PP \fBsuspend \fR\fB\fIWindowID\fR\fR -Suspends the screensaver and monitor power management. +.RS 4 +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. +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. +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 +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 +.RE +.PP \fBresume \fR\fB\fIWindowID\fR\fR -Resume the screensaver and monitor power management after being suspended. +.RS 4 +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 +.RE +.PP \fBactivate\fR -Turns the screensaver on immediately. This may result in the screen getting locked, depending on existing system policies. -.TP +.RS 4 +Turns the screensaver on immediately\&. This may result in the screen getting locked, depending on existing system policies\&. +.RE +.PP \fBlock\fR -Lock the screen immediately. -.TP +.RS 4 +Lock the screen immediately\&. +.RE +.PP \fBreset\fR -Turns the screensaver off immediately. If the screen was locked the user may be asked to authenticate first. -.TP +.RS 4 +Turns the screensaver off immediately\&. If the screen was locked the user may be asked to authenticate first\&. +.RE +.PP \fBstatus\fR +.RS 4 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. +if the screensaver is not enabled\&. +.RE .SH "OPTIONS" -.TP +.PP \fB\-\-help\fR -Show command synopsis. -.TP +.RS 4 +Show command synopsis\&. +.RE +.PP \fB\-\-manual\fR -Show this manualpage. -.TP +.RS 4 +Show this manualpage\&. +.RE +.PP \fB\-\-version\fR -Show the xdg\-utils version information. +.RS 4 +Show the xdg\-utils version information\&. +.RE .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: -.TP +An exit code of 0 indicates success while a non\-zero exit code indicates failure\&. The following failure codes can be returned: +.PP \fB1\fR -Error in command line syntax. -.TP +.RS 4 +Error in command line syntax\&. +.RE +.PP \fB3\fR -A required tool could not be found. -.TP +.RS 4 +A required tool could not be found\&. +.RE +.PP \fB4\fR -The action failed. +.RS 4 +The action failed\&. +.RE .SH "EXAMPLES" .PP + +.sp +.if n \{\ +.RS 4 +.\} .nf xdg\-screensaver suspend 0x1c00007 .fi +.if n \{\ +.RE +.\} .sp Causes the screensaver to be disabled till \fBxdg\-screensaver resume 0x1c00007\fR -is called. +is called\&. \fI0x1c00007\fR -must be the X Window ID of an existing window. +must be the X Window ID of an existing window\&. .SH "AUTHOR" -Bryce Harrington. +.PP +\fBBryce Harrington\fR +.RS 4 +Author. +.RE +.SH "COPYRIGHT" +.br +Copyright \(co 2006 .br -<bryce@osdl.org> diff --git a/scripts/man/xdg-settings.1 b/scripts/man/xdg-settings.1 new file mode 100644 index 0000000..ddc0113 --- /dev/null +++ b/scripts/man/xdg-settings.1 @@ -0,0 +1,136 @@ +'\" t +.\" Title: xdg-settings +.\" Author: Mike Mammarella +.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> +.\" Date: 12/31/2010 +.\" Manual: xdg-settings Manual +.\" Source: [FIXME: source] +.\" Language: English +.\" +.TH "XDG\-SETTINGS" "1" "12/31/2010" "[FIXME: source]" "xdg-settings Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +xdg-settings \- get various settings from the desktop environment +.SH "SYNOPSIS" +.HP \w'\fBxdg\-settings\fR\ 'u +\fBxdg\-settings\fR {\fB\fIget\fR\fR | \fB\fIcheck\fR\fR | \fB\fIset\fR\fR} {\fBproperty\fR} [\fBvalue\fR] +.HP \w'\fBxdg\-settings\fR\ 'u +\fBxdg\-settings\fR {\fB\-\-help\fR | \fB\-\-list\fR | \fB\-\-manual\fR | \fB\-\-version\fR} +.SH "DESCRIPTION" +.PP +xdg\-settings gets various settings from the desktop environment\&. For instance, desktop environments often provide proxy configuration and default web browser settings\&. Using xdg\-settings these parameters can be extracted for use by applications that do not use the desktop environment\*(Aqs libraries (which would use the settings natively)\&. +.PP +xdg\-settings is for use inside a desktop session only\&. It is not recommended to use xdg\-settings as root\&. +.SH "OPTIONS" +.PP +\fB\-\-help\fR +.RS 4 +Show command synopsis\&. +.RE +.PP +\fB\-\-list\fR +.RS 4 +List all properties xdg\-settings knows about\&. +.RE +.PP +\fB\-\-manual\fR +.RS 4 +Show this manualpage\&. +.RE +.PP +\fB\-\-version\fR +.RS 4 +Show the xdg\-utils version information\&. +.RE +.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: +.PP +\fB1\fR +.RS 4 +Error in command line syntax\&. +.RE +.PP +\fB2\fR +.RS 4 +One of the files passed on the command line did not exist\&. +.RE +.PP +\fB3\fR +.RS 4 +A required tool could not be found\&. +.RE +.PP +\fB4\fR +.RS 4 +The action failed\&. +.RE +.SH "EXAMPLES" +.PP +Get the desktop file name of the current default web browser +.sp +.if n \{\ +.RS 4 +.\} +.nf + xdg\-settings get default\-web\-browser + +.fi +.if n \{\ +.RE +.\} +.PP +Check whether the default web browser is firefox\&.desktop, which can be false even if "get default\-web\-browser" says that is the current value (if only some of the underlying settings actually reflect that value) +.sp +.if n \{\ +.RS 4 +.\} +.nf + xdg\-settings check default\-web\-browser firefox\&.desktop + +.fi +.if n \{\ +.RE +.\} +.PP +Set the default web browser to google\-chrome\&.desktop +.sp +.if n \{\ +.RS 4 +.\} +.nf + xdg\-settings set default\-web\-browser google\-chrome\&.desktop + +.fi +.if n \{\ +.RE +.\} +.sp +.SH "AUTHOR" +.PP +\fBMike Mammarella\fR +.RS 4 +Author. +.RE +.SH "COPYRIGHT" +.br +Copyright \(co 2009 +.br diff --git a/scripts/man/xdg-su.1 b/scripts/man/xdg-su.1 deleted file mode 100644 index 6ed4b36..0000000 --- a/scripts/man/xdg-su.1 +++ /dev/null @@ -1,75 +0,0 @@ -.\" ** 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\-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) -.ad l -.SH "NAME" -xdg\-su \- run a GUI program as root after prompting for the root password -.SH "SYNOPSIS" -.HP 7 -\fBxdg\-su\fR [\fB\-u\ \fR\fB\fIuser\fR\fR] \fB\-c\ \fR\fB\fIcommand\fR\fR -.HP 7 -\fBxdg\-su\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} -.SH "DESCRIPTION" -.PP -xdg\-su provides a graphical dialog that prompts the user for a password to run -\fIcommand\fR -as -\fIuser\fR -or as root if no user was specified. -.PP -xdg\-su is for use inside a desktop session only. -.PP -xdg\-su discards any stdout and stderr output from -\fIcommand\fR. -.SH "OPTIONS" -.TP -\fB\-u \fR\fB\fIuser\fR\fR -run -\fIcommand\fR -as -\fIuser\fR. The default is to run as root. -.TP -\fB\-\-help\fR -Show command synopsis. -.TP -\fB\-\-manual\fR -Show this manualpage. -.TP -\fB\-\-version\fR -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: -.TP -\fB1\fR -Error in command line syntax. -.TP -\fB2\fR -One of the files passed on the command line did not exist. -.TP -\fB3\fR -A required tool could not be found. -.TP -\fB4\fR -The action failed. -.SH "SEE ALSO" -.PP -\fBsu\fR(1) -.SH "EXAMPLES" -.PP -.nf -xdg\-su \-u root \-c "/opt/shinythings/bin/install\-GUI \-\-install fast" -.fi -.sp -Runs the /opt/shinythings/bin/install\-GUI command with root permissions. -.SH "AUTHOR" -Kevin Krammer, Jeremy White. -.br -<kevin.krammer@gmx.at> -.br -<jwhite@codeweavers.com> diff --git a/scripts/man/xdg-terminal.1 b/scripts/man/xdg-terminal.1 deleted file mode 100644 index 595158d..0000000 --- a/scripts/man/xdg-terminal.1 +++ /dev/null @@ -1,60 +0,0 @@ -.\" ** 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\-TERMINAL" "1" "12/07/2006" "xdg\-utils 1.0" "" -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.SH "NAME" -xdg\-terminal \- opens the user's preferred terminal emulator application -.SH "SYNOPSIS" -.HP 13 -\fBxdg\-terminal\fR [\fB\fIcommand\fR\fR] -.HP 13 -\fBxdg\-terminal\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} -.SH "DESCRIPTION" -.PP -xdg\-terminal opens the user's preferred terminal emulator application. If a command is provided the command will be executed by the shell within the newly opened terminal window. -.PP -xdg\-terminal is for use inside a desktop session only. It is not recommended to use xdg\-terminal as root. -.SH "OPTIONS" -.TP -\fB\-\-help\fR -Show command synopsis. -.TP -\fB\-\-manual\fR -Show this manualpage. -.TP -\fB\-\-version\fR -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: -.TP -\fB1\fR -Error in command line syntax. -.TP -\fB3\fR -A required tool could not be found. -.TP -\fB4\fR -The action failed. -.SH "EXAMPLES" -.PP -.nf -xdg\-terminal -.fi -.sp -Opens the user's default terminal emulator, just starting an interactive shell. -.PP -.nf -xdg\-terminal top -.fi -.sp -Opens the user's default terminal emulator and lets it run the top executable. -.SH "AUTHOR" -Kevin Krammer. -.br -<kevin.krammer@gmx.at> |