diff options
author | Waldo Bastian <waldo.bastian@intel.com> | 2006-07-20 22:43:25 +0000 |
---|---|---|
committer | Waldo Bastian <waldo.bastian@intel.com> | 2006-07-20 22:43:25 +0000 |
commit | 2997f21ec48a6fa5481b1b3479f9dc243552dc4d (patch) | |
tree | 5e766f3377e09dbc8c062fc109472971e5c8c240 /scripts/man | |
parent | 9b155544d4e82961c046ef771046a29b6666c626 (diff) |
Update generated files
Diffstat (limited to 'scripts/man')
-rw-r--r-- | scripts/man/xdg-desktop-icon.1 | 201 | ||||
-rw-r--r-- | scripts/man/xdg-desktop-menu.1 | 8 | ||||
-rw-r--r-- | scripts/man/xdg-email.1 | 150 | ||||
-rw-r--r-- | scripts/man/xdg-icon-resource.1 | 202 | ||||
-rw-r--r-- | scripts/man/xdg-mime.1 | 8 | ||||
-rw-r--r-- | scripts/man/xdg-open.1 | 108 | ||||
-rw-r--r-- | scripts/man/xdg-screensaver.1 | 2 | ||||
-rw-r--r-- | scripts/man/xdg-su.1 | 112 |
8 files changed, 322 insertions, 469 deletions
diff --git a/scripts/man/xdg-desktop-icon.1 b/scripts/man/xdg-desktop-icon.1 index 0f915f9..c752308 100644 --- a/scripts/man/xdg-desktop-icon.1 +++ b/scripts/man/xdg-desktop-icon.1 @@ -1,157 +1,126 @@ -.\"Generated by db2man.xsl. Don't modify this, modify the source. -.de Sh \" Subsection -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp -.. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.TH "XDG-DESKTOP-ICON" 1 "" "" "xdg-desktop-icon Manual" -.SH NAME -xdg-desktop-icon \- command line tool for (un)installing icons to the desktop -.SH "SYNOPSIS" +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "XDG\-DESKTOP\-ICON" "1" "07/17/2006" "This is release 0.5 of the xdg\-desktop\-i" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) .ad l -.hy 0 +.SH "NAME" +xdg\-desktop\-icon \- command line tool for (un)installing icons to the desktop +.SH "SYNOPSIS" .HP 17 -\fBxdg\-desktop\-icon\fR install [\fB\-\-vendor\ \fIvendor\-id\fR\fR] \fIFILE\fR -.ad -.hy -.ad l -.hy 0 +\fBxdg\-desktop\-icon\fR install [\fB\-\-vendor\ \fR\fB\fIvendor\-id\fR\fR] \fIFILE\fR .HP 17 -\fBxdg\-desktop\-icon\fR uninstall [\fB\-\-vendor\ \fIvendor\-id\fR\fR] \fIFILE\fR -.ad -.hy -.ad l -.hy 0 +\fBxdg\-desktop\-icon\fR uninstall [\fB\-\-vendor\ \fR\fB\fIvendor\-id\fR\fR] \fIFILE\fR .HP 17 -\fBxdg\-desktop\-icon\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} -.ad -.hy - +\fBxdg\-desktop\-icon\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} .SH "DESCRIPTION" - .PP -The xdg\-desktop\-icon program can be used to install an application launcher or other file on the desktop of the current user\&. - +The xdg\-desktop\-icon program can be used to install an application launcher or other file on the desktop of the current user. .PP -An application launcher is represented by a *\&.desktop file\&. Desktop files are defined by the freedesktop\&.org Desktop Entry Specification\&. The most important aspects of *\&.desktop files are summarized below\&. - +An application launcher is represented by a *.desktop file. Desktop files are defined by the freedesktop.org Desktop Entry Specification. The most important aspects of *.desktop files are summarized below. .SH "COMMANDS" - .TP install -Installs \fIFILE\fR to the desktop of the current user\&. \fIFILE\fR can be a *\&.desktop file or any other type of file\&. - +Installs +\fIFILE\fR +to the desktop of the current user. +\fIFILE\fR +can be a *.desktop file or any other type of file. .TP uninstall -Removes \fIFILE\fR from the desktop of the current user\&. - +Removes +\fIFILE\fR +from the desktop of the current user. .SH "OPTIONS" - .TP \fB\-\-vendor\fR \fIvendor\-id\fR -Adds \fIvendor\-id\fR as a prefix when installing desktop files\&. - +Adds +\fIvendor\-id\fR +as a prefix when installing desktop files. .TP \fB\-\-help\fR -Show command synopsis\&. - +Show command synopsis. .TP \fB\-\-manual\fR -Show this manualpage\&. - +Show this manualpage. .TP \fB\-\-version\fR -Show the xdg\-utils version information\&. - +Show the xdg\-utils version information. .SH "DESKTOP FILES" - .PP -An application launcher can be added to the desktop by installing a *\&.desktop file\&. A *\&.desktop file consists of a \fI[Desktop Entry]\fR header followed by several \fIKey\fR=\fIValue\fR lines\&. - +An application launcher can be added to the desktop by installing a *.desktop file. A *.desktop file consists of a +\fI[Desktop Entry]\fR +header followed by several +\fIKey\fR=\fIValue\fR +lines. .PP -A *\&.desktop file can provide a name and description for an application in several different languages\&. This is done by adding a language code as used by LC_MESSAGES in square brackets behind the \fIKey\fR\&. This way one can specify different values for the same \fIKey\fR depending on the currently selected language\&. - +A *.desktop file can provide a name and description for an application in several different languages. This is done by adding a language code as used by LC_MESSAGES in square brackets behind the +\fIKey\fR. This way one can specify different values for the same +\fIKey\fR +depending on the currently selected language. .PP The following keys are often used: - .TP -Value=1\&.0 -This is a mandatory field to indicate that the *\&.desktop file follows the 1\&.0 version of the specification\&. - +Value=1.0 +This is a mandatory field to indicate that the *.desktop file follows the 1.0 version of the specification. .TP Type=Application -This is a mandatory field that indicates that the *\&.desktop file describes an application launcher\&. - +This is a mandatory field that indicates that the *.desktop file describes an application launcher. .TP Name=\fIApplication Name\fR -The name of the application\&. For example \fIMozilla\fR - +The name of the application. For example +\fIMozilla\fR .TP GenericName=\fIGeneric Name\fR -A generic description of the application\&. For example \fIWeb Browser\fR - +A generic description of the application. For example +\fIWeb Browser\fR .TP Comment=\fIComment\fR -Optional field to specify a tooltip for the application\&. For example \fIVisit websites on the Internet\fR - +Optional field to specify a tooltip for the application. For example +\fIVisit websites on the Internet\fR .TP Icon=\fIIcon File\fR -The icon to use for the application\&. This can either be an absolute path to an image file or an icon\-name\&. If an icon\-name is provided an image lookup by name is done in the user's current icon theme\&. The \fBxdg\-icon\-resource\fR command can be used to install image files into icon themes\&. The advantage of using an icon\-name instead of an absolute path is that with an icon\-name the application icon can be provided in several different sizes as well as in several differently themed styles\&. - +The icon to use for the application. This can either be an absolute path to an image file or an icon\-name. If an icon\-name is provided an image lookup by name is done in the user's current icon theme. The +\fBxdg\-icon\-resource\fR +command can be used to install image files into icon themes. The advantage of using an icon\-name instead of an absolute path is that with an icon\-name the application icon can be provided in several different sizes as well as in several differently themed styles. .TP Exec=\fICommand Line\fR -The command line to start the application\&. If the application can open files the %f placeholder should be specified\&. When a file is dropped on the application launcher the %f is replaced with the file path of the dropped file\&. If multiple files can be specified on the command line the %F placeholder should be used instead of %f\&. If the application is able to open URLs in addition to local files then %u or %U can be used instead of %f or %F\&. - +The command line to start the application. If the application can open files the %f placeholder should be specified. When a file is dropped on the application launcher the %f is replaced with the file path of the dropped file. If multiple files can be specified on the command line the %F placeholder should be used instead of %f. If the application is able to open URLs in addition to local files then %u or %U can be used instead of %f or %F. .PP -For a complete oveview of the *\&.desktop file format please visit http://www\&.freedesktop\&.org/wiki/Standards/desktop\-entry\-spec - +For a complete oveview of the *.desktop file format please visit http://www.freedesktop.org/wiki/Standards/desktop\-entry\-spec +.SH "ENVIRONMENT VARIABLES" +.PP +xdg\-desktop\-icon honours the following environment variables: +.TP +XDG_UTILS_DEBUG_LEVEL +Setting this environment variable to a non\-zero numerical value makes xdg\-desktop\-icon do more verbose reporting on stderr. Setting a higher value increases the verbosity. .SH "EXIT CODES" - .PP -An exit code of 0 indicates success while a non\-zero exit code indicates failure\&. The following failure codes can be returned: - +An exit code of 0 indicates success while a non\-zero exit code indicates failure. The following failure codes can be returned: .TP \fB1\fR -Error in command line syntax\&. - +Error in command line syntax. .TP \fB2\fR -One of the files passed on the command line did not exist\&. - +One of the files passed on the command line did not exist. .TP \fB3\fR -A required tool could not be found\&. - +A required tool could not be found. .TP \fB4\fR -The action failed\&. - +The action failed. .SH "SEE ALSO" - .PP -\fBxdg\-icon\-resource\fR(1) - +\fBxdg\-icon\-resource\fR(1) .SH "EXAMPLES" - .PP -The company ShinyThings Inc\&. has developed an application named "WebMirror" and would like to add a launcher for for on the desktop\&. The company will use "shinythings" as its vendor id\&. In order to add the application to the desktop there needs to be a \&.desktop file for the application: - +The company ShinyThings Inc. has developed an application named "WebMirror" and would like to add a launcher for for on the desktop. The company will use "shinythings" as its vendor id. In order to add the application to the desktop there needs to be a .desktop file for the application: +.sp .nf - -webmirror\&.desktop: +webmirror.desktop: [Desktop Entry] Encoding=UTF\-8 @@ -162,29 +131,25 @@ webmirror\&.desktop: Name=WebMirror Name[nl]=WebSpiegel - .fi - - +.sp .PP -Now the xdg\-desktop\-icon tool can be used to add the webmirror\&.desktop file to the desktop: - +Now the xdg\-desktop\-icon tool can be used to add the webmirror.desktop file to the desktop: +.sp .nf - -xdg\-desktop\-icon install \-\-vendor shinythings \&./webmirror\&.desktop - +xdg\-desktop\-icon install \-\-vendor shinythings ./webmirror.desktop .fi - - +.sp .PP -To add a README file to the desktop as well, the following command can be used: - +To add a README file to the desktop as well, the following command can be used: +.sp .nf - -xdg\-desktop\-icon install \&./shinythings\-README - +xdg\-desktop\-icon install ./shinythings\-README .fi - - -.SH AUTHORS -Kevin Krammer, Jeremy White. +.sp +.SH "AUTHOR" +Kevin Krammer, Jeremy White. +.br +<kevin.krammer@gmx.at> +.br +<jwhite@codeweavers.com> diff --git a/scripts/man/xdg-desktop-menu.1 b/scripts/man/xdg-desktop-menu.1 index 4821af7..3631291 100644 --- a/scripts/man/xdg-desktop-menu.1 +++ b/scripts/man/xdg-desktop-menu.1 @@ -2,7 +2,7 @@ .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). .\" Instead of manually editing it, you probably should edit the DocBook XML .\" source for it and then use the DocBook XSL Stylesheets to regenerate it. -.TH "XDG\-DESKTOP\-MENU" "1" "07/13/2006" "This is release 0.5 of the xdg\-desktop\-m" "" +.TH "XDG\-DESKTOP\-MENU" "1" "07/17/2006" "This is release 0.5 of the xdg\-desktop\-m" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -120,6 +120,12 @@ MimeType=\fIMimetypes\fR A list of mimetypes separated by semi\-colons. This field is used to indicate which file types the application is able to open. .PP For a complete oveview of the *.desktop file format please visit http://www.freedesktop.org/wiki/Standards/desktop\-entry\-spec +.SH "ENVIRONMENT VARIABLES" +.PP +xdg\-desktop\-menu honours the following environment variables: +.TP +XDG_UTILS_DEBUG_LEVEL +Setting this environment variable to a non\-zero numerical value makes xdg\-desktop\-menu do more verbose reporting on stderr. Setting a higher value increases the verbosity. .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: diff --git a/scripts/man/xdg-email.1 b/scripts/man/xdg-email.1 index 87372f9..af063f7 100644 --- a/scripts/man/xdg-email.1 +++ b/scripts/man/xdg-email.1 @@ -1,144 +1,102 @@ -.\"Generated by db2man.xsl. Don't modify this, modify the source. -.de Sh \" Subsection -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp -.. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.TH "XDG-EMAIL" 1 "" "" "xdg-email Manual" -.SH NAME -xdg-email \- command line tool for sending mail using the user's preferred e-mail composer -.SH "SYNOPSIS" +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "XDG\-EMAIL" "1" "07/17/2006" "This is release 0.5 of the xdg\-email Man" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) .ad l -.hy 0 +.SH "NAME" +xdg\-email \- command line tool for sending mail using the user's preferred e\-mail composer +.SH "SYNOPSIS" .HP 10 -\fBxdg\-email\fR [\fB\-\-utf8\fR] [\fB\-\-cc\fR\ \fIaddress\fR] [\fB\-\-bcc\fR\ \fIaddress\fR] [\fB\-\-subject\fR\ \fItext\fR] [\fB\-\-body\fR\ \fItext\fR] [\fB\-\-attach\fR\ \fIfile\fR] {\fB\fImailto\-uri\fR\fR | \fB\fIaddress(es)\fR\fR} -.ad -.hy -.ad l -.hy 0 +\fBxdg\-email\fR [\fB\-\-utf8\fR] [\fB\-\-cc\fR\ \fIaddress\fR] [\fB\-\-bcc\fR\ \fIaddress\fR] [\fB\-\-subject\fR\ \fItext\fR] [\fB\-\-body\fR\ \fItext\fR] [\fB\-\-attach\fR\ \fIfile\fR] {\fImailto\-uri\fR \fIaddress(es)\fR} .HP 10 -\fBxdg\-email\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} -.ad -.hy - +\fBxdg\-email\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} .SH "DESCRIPTION" - .PP -xdg\-email opens the user's preferred e\-mail composer in order to send a mail to \fIaddress(es)\fR or \fImailto\-uri\fR\&. RFC2368 defines mailto: URIs\&. xdg\-email limits support to, cc, subject and body fields in \fImailto\-uri\fR, all other fields are silently ignored\&. \fIaddress(es)\fR must follow the syntax of RFC822\&. Multiple addresses may be provided as separate arguments\&. - +xdg\-email opens the user's preferred e\-mail composer in order to send a mail to +\fIaddress(es)\fR +or +\fImailto\-uri\fR. RFC2368 defines mailto: URIs. xdg\-email limits support to, cc, subject and body fields in +\fImailto\-uri\fR, all other fields are silently ignored. +\fIaddress(es)\fR +must follow the syntax of RFC822. Multiple addresses may be provided as separate arguments. .PP -All information provided on the command line is used to prefill corresponding fields in the user's e\-mail composer\&. The user will have the opportunity to change any of this information before actually sending the e\-mail\&. - +All information provided on the command line is used to prefill corresponding fields in the user's e\-mail composer. The user will have the opportunity to change any of this information before actually sending the e\-mail. .PP -xdg\-email is for use inside a desktop session only\&. It is not recommended to use xdg\-email as root\&. - +xdg\-email is for use inside a desktop session only. It is not recommended to use xdg\-email as root. .SH "OPTIONS" - .TP \fB\-\-utf8\fR -Indicates that all command line options that follow are in utf8\&. Without this option, command line options are expected to be encoded according to locale\&. If the locale already specifies utf8 this option has no effect\&. This option does not affect mailto URIs that are passed on the command line\&. - +Indicates that all command line options that follow are in utf8. Without this option, command line options are expected to be encoded according to locale. If the locale already specifies utf8 this option has no effect. This option does not affect mailto URIs that are passed on the command line. .TP \fB\-\-cc\fR \fIaddress\fR -Specify a recipient to be copied on the e\-mail\&. - +Specify a recipient to be copied on the e\-mail. .TP \fB\-\-bcc\fR \fIaddress\fR -Specify a recipient to be blindly copied on the e\-mail\&. - +Specify a recipient to be blindly copied on the e\-mail. .TP \fB\-\-subject\fR \fItext\fR -Specify a subject for the e\-mail\&. - +Specify a subject for the e\-mail. .TP \fB\-\-body\fR \fItext\fR -Specify a body for the e\-mail\&. Since the user will be able to make changes before actually sending the e\-mail, this can be used to provide the user with a template for the e\-mail\&. \fItext\fR may contain linebreaks\&. - +Specify a body for the e\-mail. Since the user will be able to make changes before actually sending the e\-mail, this can be used to provide the user with a template for the e\-mail. +\fItext\fR +may contain linebreaks. .TP \fB\-\-attach\fR \fIfile\fR -Specify an attachment for the e\-mail\&. \fIfile\fR must point to an existing file\&. - +Specify an attachment for the e\-mail. +\fIfile\fR +must point to an existing file. .TP \fB\-\-help\fR -Show command synopsis\&. - +Show command synopsis. .TP \fB\-\-manual\fR -Show this manualpage\&. - +Show this manualpage. .TP \fB\-\-version\fR -Show the xdg\-utils version information\&. - +Show the xdg\-utils version information. .SH "EXIT CODES" - .PP -An exit code of 0 indicates success while a non\-zero exit code indicates failure\&. The following failure codes can be returned: - +An exit code of 0 indicates success while a non\-zero exit code indicates failure. The following failure codes can be returned: .TP \fB1\fR -Error in command line syntax\&. - +Error in command line syntax. .TP \fB2\fR -One of the files passed on the command line did not exist\&. - +One of the files passed on the command line did not exist. .TP \fB3\fR -A required tool could not be found\&. - +A required tool could not be found. .TP \fB4\fR -The action failed\&. - +The action failed. .SH "EXAMPLES" - .PP - - .nf - -xdg\-email 'Jeremy White <jwhite@example\&.com>' - +xdg\-email 'Jeremy White <jwhite@example.com>' .fi - - +.sp .PP - - .nf - -xdg\-email \-\-attach /tmp/logo\&.png \\ +xdg\-email \-\-attach /tmp/logo.png \\ \-\-subject 'Logo contest' \\ - \-\-body 'Attached you find the logo for the contest\&.' \\ - 'jwhite@example\&.com' - + \-\-body 'Attached you find the logo for the contest.' \\ + 'jwhite@example.com' .fi - - +.sp .PP - - .nf - xdg\-email \-\-subject 'Your password is about to expire' \\ - 'jwhite@example\&.com' 'bastian@example\&.com' 'whipple@example\&.com' - + 'jwhite@example.com' 'bastian@example.com' 'whipple@example.com' .fi - - -.SH AUTHORS -Kevin Krammer, Jeremy White. +.sp +.SH "AUTHOR" +Kevin Krammer, Jeremy White. +.br +<kevin.krammer@gmx.at> +.br +<jwhite@codeweavers.com> diff --git a/scripts/man/xdg-icon-resource.1 b/scripts/man/xdg-icon-resource.1 index 5c5fa42..ae32c5b 100644 --- a/scripts/man/xdg-icon-resource.1 +++ b/scripts/man/xdg-icon-resource.1 @@ -1,162 +1,148 @@ -.\"Generated by db2man.xsl. Don't modify this, modify the source. -.de Sh \" Subsection -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp -.. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.TH "XDG-ICON-RESOURCE" 1 "" "" "xdg-icon-resource Manual" -.SH NAME -xdg-icon-resource \- command line tool for (un)installing icon resources -.SH "SYNOPSIS" +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "XDG\-ICON\-RESOURCE" "1" "07/17/2006" "This is release 0.5 of the xdg\-icon\-reso" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) .ad l -.hy 0 +.SH "NAME" +xdg\-icon\-resource \- command line tool for (un)installing icon resources +.SH "SYNOPSIS" .HP 18 -\fBxdg\-icon\-resource\fR install [\fB\-\-noupdate\fR] [\fB\-\-theme\ \fItheme\fR\fR] [\fB\-\-context\ \fIcontext\fR\fR] [\fB\-\-size\ \fIsize\fR\fR] {\fB\fB\-\-user\fR\fR | \fB\fB\-\-system\fR\fR} \fIicon\-file\fR [\fIicon\-name\fR] -.ad -.hy -.ad l -.hy 0 +\fBxdg\-icon\-resource\fR install [\fB\-\-noupdate\fR] [\fB\-\-theme\ \fR\fB\fItheme\fR\fR] [\fB\-\-context\ \fR\fB\fIcontext\fR\fR] [\fB\-\-size\ \fR\fB\fIsize\fR\fR] {\fB\-\-user\fR \fB\-\-system\fR} \fIicon\-file\fR [\fIicon\-name\fR] .HP 18 -\fBxdg\-icon\-resource\fR uninstall [\fB\-\-noupdate\fR] [\fB\-\-theme\ \fItheme\fR\fR] [\fB\-\-context\ \fIcontext\fR\fR] [\fB\-\-size\ \fIsize\fR\fR] {\fB\fB\-\-user\fR\fR | \fB\fB\-\-system\fR\fR} \fIicon\-name\fR -.ad -.hy -.ad l -.hy 0 +\fBxdg\-icon\-resource\fR uninstall [\fB\-\-noupdate\fR] [\fB\-\-theme\ \fR\fB\fItheme\fR\fR] [\fB\-\-context\ \fR\fB\fIcontext\fR\fR] [\fB\-\-size\ \fR\fB\fIsize\fR\fR] {\fB\-\-user\fR \fB\-\-system\fR} \fIicon\-name\fR .HP 18 -\fBxdg\-icon\-resource\fR forceupdate [\fB\-\-theme\ \fItheme\fR\fR] {\fB\-\-user\fR | \fB\-\-system\fR} -.ad -.hy -.ad l -.hy 0 +\fBxdg\-icon\-resource\fR forceupdate [\fB\-\-theme\ \fR\fB\fItheme\fR\fR] {\-\-user \-\-system} .HP 18 -\fBxdg\-icon\-resource\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} -.ad -.hy - +\fBxdg\-icon\-resource\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} .SH "DESCRIPTION" - .PP -The xdg\-icon\-resource program can be used to install icon resources into the desktop icon system in order to illustrate menu entries, to depict desktop icons or to graphically represent file types\&. - +The xdg\-icon\-resource program can be used to install icon resources into the desktop icon system in order to illustrate menu entries, to depict desktop icons or to graphically represent file types. .PP -The desktop icon system identifies icons by name\&. Depending on the required size, the choice of icon theme and the context in which the icon is used, the desktop icon system locates an appropriate icon resource to depict an icon\&. Icon resources can be XPM files, PNG files or SVG files\&. - +The desktop icon system identifies icons by name. Depending on the required size, the choice of icon theme and the context in which the icon is used, the desktop icon system locates an appropriate icon resource to depict an icon. Icon resources can be XPM files, PNG files or SVG files. .PP -The desktop icon system works according to the XDG Icon Theme Specification at http://www\&.freedesktop\&.org/Standards/icon\-theme\-spec - +The desktop icon system works according to the XDG Icon Theme Specification at http://www.freedesktop.org/Standards/icon\-theme\-spec .SH "COMMANDS" - .TP install -Installs the icon file indicated by \fIicon\-file\fR to the desktop icon system under the name \fIicon\-name\fR\&. If \fIicon\-name\fR is not provided the name is derived from \fIicon\-file\fR\&. The icon file must have \fI\&.png\fR, \fI\&.xpm\fR or \fI\&.svg\fR as extension\&. If a corresponding \fI\&.icon\fR file exists in the same location as \fIicon\-file\fR it will be installed as well\&. - +Installs the icon file indicated by +\fIicon\-file\fR +to the desktop icon system under the name +\fIicon\-name\fR. If +\fIicon\-name\fR +is not provided the name is derived from +\fIicon\-file\fR. The icon file must have +\fI.png\fR, +\fI.xpm\fR +or +\fI.svg\fR +as extension. If a corresponding +\fI.icon\fR +file exists in the same location as +\fIicon\-file\fR +it will be installed as well. .TP uninstall -Removes the icon file indicated by \fIicon\-name\fR from the desktop icon system\&. - +Removes the icon file indicated by +\fIicon\-name\fR +from the desktop icon system. .TP forceupdate -Force an update of the desktop icon system\&. This is only useful if the last call to xdg\-icon\-resource included the \fB\-\-noupdate\fR option\&. - +Force an update of the desktop icon system. This is only useful if the last call to xdg\-icon\-resource included the +\fB\-\-noupdate\fR +option. .SH "OPTIONS" - .TP \fB\-\-noupdate\fR -Postpone updating the desktop icon system\&. If multiple icons are added in sequence this flag can be used to indicate that additional changes will follow and that it is not necassery to update the desktop icon system right away\&. - +Postpone updating the desktop icon system. If multiple icons are added in sequence this flag can be used to indicate that additional changes will follow and that it is not necassery to update the desktop icon system right away. .TP \fB\-\-theme\fR \fItheme\fR -Installs or removes the icon file as part of \fItheme\fR\&. If no theme is specified the icons will be installed as part of the default \fIhicolor\fR theme\&. Applications may install icons under multiple themes but should at least install icons for the default \fIhicolor\fR theme\&. - +Installs or removes the icon file as part of +\fItheme\fR. If no theme is specified the icons will be installed as part of the default +\fIhicolor\fR +theme. Applications may install icons under multiple themes but should at least install icons for the default +\fIhicolor\fR +theme. .TP \fB\-\-context\fR \fIcontext\fR -Specifies the context for the icon\&. Icons to be used in the application menu and as desktop icon should use \fIapps\fR as context which is the default context\&. Icons to be used as file icons should use \fImimetypes\fR as context\&. Other common contexts are \fIactions\fR, \fIdevices\fR, \fIemblems\fR, \fIfilesystems\fR and \fIstock\fR\&. - +Specifies the context for the icon. Icons to be used in the application menu and as desktop icon should use +\fIapps\fR +as context which is the default context. Icons to be used as file icons should use +\fImimetypes\fR +as context. Other common contexts are +\fIactions\fR, +\fIdevices\fR, +\fIemblems\fR, +\fIfilesystems\fR +and +\fIstock\fR. .TP \fB\-\-size\fR \fIsize\fR -Specifies the size of the icon (required for png and xpm icons)\&. All icons must be square\&. Common sizes for icons in the apps context are: 16, 22, 32, 48, 64 and 128\&. Common sizes for icons in the mimetypes context are: 16, 22, 32, 48, 64 and 128 - +Specifies the size of the icon (required for png and xpm icons). All icons must be square. Common sizes for icons in the apps context are: 16, 22, 32, 48, 64 and 128. Common sizes for icons in the mimetypes context are: 16, 22, 32, 48, 64 and 128 .TP \fB\-\-user\fR -Installs or uninstalls the icon for the current user only\&. - +Installs or uninstalls the icon for the current user only. .TP \fB\-\-system\fR -Installs or uninstalls the icon for all users on the system\&. Usually only root is allowed to do this\&. - +Installs or uninstalls the icon for all users on the system. Usually only root is allowed to do this. .TP \fB\-\-help\fR -Show command synopsis\&. - +Show command synopsis. .TP \fB\-\-manual\fR -Show this manualpage\&. - +Show this manualpage. .TP \fB\-\-version\fR -Show the xdg\-utils version information\&. - +Show the xdg\-utils version information. +.SH "ENVIRONMENT VARIABLES" +.PP +xdg\-icon\-resource honours the following environment variables: +.TP +XDG_UTILS_DEBUG_LEVEL +Setting this environment variable to a non\-zero numerical value makes xdg\-icon\-resource do more verbose reporting on stderr. Setting a higher value increases the verbosity. .SH "EXIT CODES" - .PP -An exit code of 0 indicates success while a non\-zero exit code indicates failure\&. The following failure codes can be returned: - +An exit code of 0 indicates success while a non\-zero exit code indicates failure. The following failure codes can be returned: .TP \fB1\fR -Error in command line syntax\&. - +Error in command line syntax. .TP \fB2\fR -One of the files passed on the command line did not exist\&. - +One of the files passed on the command line did not exist. .TP \fB3\fR -A required tool could not be found\&. - +A required tool could not be found. .TP \fB4\fR -The action failed\&. - +The action failed. .SH "SEE ALSO" - .PP -\fBxdg\-desktop\-icon\fR(1), \fBxdg\-desktop\-menu\fR(1), \fBxdg\-mime\fR(1) - +\fBxdg\-desktop\-icon\fR(1), +\fBxdg\-desktop\-menu\fR(1), +\fBxdg\-mime\fR(1) .SH "EXAMPLES" - .PP -To install an icon resource to depict a launcher for the application myfoobar one can use: - +To install an icon resource to depict a launcher for the application myfoobar one can use: +.sp .nf - -xdg\-icon\-resource install \-\-system \-\-size 64 myfoobar\&.png - +xdg\-icon\-resource install \-\-system \-\-size 64 myfoobar.png .fi - - +.sp .PP -To install an icon for a new application/x\-foobar file type one can use: - +To install an icon for a new application/x\-foobar file type one can use: +.sp .nf - -xdg\-icon\-resource install \-\-system \-\-context mimetypes \-\-size 48 \&./mime\-foobar\-48\&.png application\-x\-foobar\&.png -xdg\-icon\-resource install \-\-system \-\-context mimetypes \-\-size 64 \&./mime\-foobar\-64\&.png application\-x\-foobar\&.png - +xdg\-icon\-resource install \-\-system \-\-context mimetypes \-\-size 48 ./mime\-foobar\-48.png application\-x\-foobar.png +xdg\-icon\-resource install \-\-system \-\-context mimetypes \-\-size 64 ./mime\-foobar\-64.png application\-x\-foobar.png .fi -This will install two icons with the name application\-x\-foobar\&.png but with different sizes\&. The icons will be installed for use by all users\&. - -.SH AUTHORS -Kevin Krammer, Jeremy White. +.sp +This will install two icons with the name application\-x\-foobar.png but with different sizes. The icons will be installed for use by all users. +.SH "AUTHOR" +Kevin Krammer, Jeremy White. +.br +<kevin.krammer@gmx.at> +.br +<jwhite@codeweavers.com> diff --git a/scripts/man/xdg-mime.1 b/scripts/man/xdg-mime.1 index 276aed1..4c1878c 100644 --- a/scripts/man/xdg-mime.1 +++ b/scripts/man/xdg-mime.1 @@ -2,7 +2,7 @@ .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). .\" Instead of manually editing it, you probably should edit the DocBook XML .\" source for it and then use the DocBook XSL Stylesheets to regenerate it. -.TH "XDG\-MIME" "1" "07/13/2006" "This is release 0.5 of the xdg\-mime Manu" "" +.TH "XDG\-MIME" "1" "07/17/2006" "This is release 0.5 of the xdg\-mime Manu" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -96,6 +96,12 @@ Show this manualpage. .TP \fB\-\-version\fR Show the xdg\-utils version information. +.SH "ENVIRONMENT VARIABLES" +.PP +xdg\-mime honours the following environment variables: +.TP +XDG_UTILS_DEBUG_LEVEL +Setting this environment variable to a non\-zero numerical value makes xdg\-mime do more verbose reporting on stderr. Setting a higher value increases the verbosity. .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: diff --git a/scripts/man/xdg-open.1 b/scripts/man/xdg-open.1 index 68ed3d7..a271018 100644 --- a/scripts/man/xdg-open.1 +++ b/scripts/man/xdg-open.1 @@ -1,103 +1,65 @@ -.\"Generated by db2man.xsl. Don't modify this, modify the source. -.de Sh \" Subsection -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp -.. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.TH "XDG-OPEN" 1 "" "" "xdg-open Manual" -.SH NAME -xdg-open \- opens a file or URL in the user's preferred application -.SH "SYNOPSIS" +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "XDG\-OPEN" "1" "07/17/2006" "This is release 0.5 of the xdg\-open Manu" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) .ad l -.hy 0 +.SH "NAME" +xdg\-open \- opens a file or URL in the user's preferred application +.SH "SYNOPSIS" .HP 9 -\fBxdg\-open\fR {\fB\fB\fIfile\fR\fR\fR | \fB\fB\fIURL\fR\fR\fR} -.ad -.hy -.ad l -.hy 0 +\fBxdg\-open\fR {\fB\fIfile\fR\fR \fB\fIURL\fR\fR} .HP 9 -\fBxdg\-open\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} -.ad -.hy - +\fBxdg\-open\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} .SH "DESCRIPTION" - .PP -xdg\-open opens a file or URL in the user's preferred application\&. If a URL is provided the URL will be opened in the user's preferred web browser\&. If a file is provided the file will be opened in the preferred application for files of that type\&. xdg\-open supports file, ftp, http and https URLs\&. - +xdg\-open opens a file or URL in the user's preferred application. If a URL is provided the URL will be opened in the user's preferred web browser. If a file is provided the file will be opened in the preferred application for files of that type. xdg\-open supports file, ftp, http and https URLs. .PP -xdg\-open is for use inside a desktop session only\&. It is not recommended to use xdg\-open as root\&. - +xdg\-open is for use inside a desktop session only. It is not recommended to use xdg\-open as root. .SH "OPTIONS" - .TP \fB\-\-help\fR -Show command synopsis\&. - +Show command synopsis. .TP \fB\-\-manual\fR -Show this manualpage\&. - +Show this manualpage. .TP \fB\-\-version\fR -Show the xdg\-utils version information\&. - +Show the xdg\-utils version information. .SH "EXIT CODES" - .PP -An exit code of 0 indicates success while a non\-zero exit code indicates failure\&. The following failure codes can be returned: - +An exit code of 0 indicates success while a non\-zero exit code indicates failure. The following failure codes can be returned: .TP \fB1\fR -Error in command line syntax\&. - +Error in command line syntax. .TP \fB2\fR -One of the files passed on the command line did not exist\&. - +One of the files passed on the command line did not exist. .TP \fB3\fR -A required tool could not be found\&. - +A required tool could not be found. .TP \fB4\fR -The action failed\&. - +The action failed. .SH "EXAMPLES" - .PP - - .nf - -xdg\-open 'http://www\&.freedesktop\&.org/' - +xdg\-open 'http://www.freedesktop.org/' .fi - Opens the Freedesktop\&.org website in the user's default browser - +.sp +Opens the Freedesktop.org website in the user's default browser .PP - - .nf - -xdg\-open /tmp/foobar\&.png - +xdg\-open /tmp/foobar.png .fi - Opens the PNG image file /tmp/foobar\&.png in the user's default image viewing application\&. - -.SH AUTHORS -Kevin Krammer, Jeremy White. +.sp +Opens the PNG image file /tmp/foobar.png in the user's default image viewing application. +.SH "AUTHOR" +Kevin Krammer, Jeremy White. +.br +<kevin.krammer@gmx.at> +.br +<jwhite@codeweavers.com> diff --git a/scripts/man/xdg-screensaver.1 b/scripts/man/xdg-screensaver.1 index 2f39bb2..c3566da 100644 --- a/scripts/man/xdg-screensaver.1 +++ b/scripts/man/xdg-screensaver.1 @@ -2,7 +2,7 @@ .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). .\" Instead of manually editing it, you probably should edit the DocBook XML .\" source for it and then use the DocBook XSL Stylesheets to regenerate it. -.TH "XDG\-SCREENSAVER" "1" "06/25/2006" "This is release 0.1 of the xdg\-screensav" "" +.TH "XDG\-SCREENSAVER" "1" "07/17/2006" "This is release 0.1 of the xdg\-screensav" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) diff --git a/scripts/man/xdg-su.1 b/scripts/man/xdg-su.1 index f50c8a3..d99409f 100644 --- a/scripts/man/xdg-su.1 +++ b/scripts/man/xdg-su.1 @@ -1,102 +1,72 @@ -.\"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-SU" 1 "" "" "xdg-su Manual" -.SH NAME -xdg-su \- run a program as root after prompting for the root password -.SH "SYNOPSIS" +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "XDG\-SU" "1" "07/17/2006" "This is release 0.5 of the xdg\-su Manual" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) .ad l -.hy 0 +.SH "NAME" +xdg\-su \- run a program as root after prompting for the root password +.SH "SYNOPSIS" .HP 7 -\fBxdg\-su\fR [\fB\-u\ \fIuser\fR\fR] \fB\-c\ \fIcommand\fR\fR -.ad -.hy -.ad l -.hy 0 +\fBxdg\-su\fR [\fB\-u\ \fR\fB\fIuser\fR\fR] \fB\-c\ \fR\fB\fIcommand\fR\fR .HP 7 -\fBxdg\-su\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} -.ad -.hy - +\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\&. - +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\&. - +xdg\-su is for use inside a desktop session only. .SH "OPTIONS" - .TP -\fB\-u \fIuser\fR\fR -run \fIcommand\fR as \fIuser\fR\&. The default is to run as root\&. - +\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\&. - +Show command synopsis. .TP \fB\-\-manual\fR -Show this manualpage\&. - +Show this manualpage. .TP \fB\-\-version\fR -Show the xdg\-utils version information\&. - +Show the xdg\-utils version information. .SH "EXIT CODES" - .PP -An exit code of 0 indicates success while a non\-zero exit code indicates failure\&. The following failure codes can be returned: - +An exit code of 0 indicates success while a non\-zero exit code indicates failure. The following failure codes can be returned: .TP \fB1\fR -Error in command line syntax\&. - +Error in command line syntax. .TP \fB2\fR -One of the files passed on the command line did not exist\&. - +One of the files passed on the command line did not exist. .TP \fB3\fR -A required tool could not be found\&. - +A required tool could not be found. .TP \fB4\fR -The action failed\&. - +The action failed. .SH "SEE ALSO" - .PP -\fBsu\fR(1) - +\fBsu\fR(1) .SH "EXAMPLES" - .PP - - .nf - xdg\-su \-u root \-c "/opt/shinythings/bin/install\-GUI \-\-install fast" - .fi - Runs the /opt/shinythings/bin/install\-GUI command with root permissions\&. - -.SH AUTHORS -Kevin Krammer, Jeremy White. +.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> |