From 3af8eeca3be36c7dfb52a816f5e9cf57c3be1bd5 Mon Sep 17 00:00:00 2001 From: Rex Dieter Date: Fri, 7 Feb 2014 12:23:34 -0600 Subject: [PATCH 04/22] remove generated html files --- scripts/html/.gitignore | 9 + scripts/html/index.html | 19 -- scripts/html/xdg-desktop-icon.html | 133 -------------- scripts/html/xdg-desktop-menu.html | 334 ------------------------------------ scripts/html/xdg-email.html | 89 ---------- scripts/html/xdg-icon-resource.html | 128 -------------- scripts/html/xdg-mime.html | 145 ---------------- scripts/html/xdg-open.html | 38 ---- scripts/html/xdg-screensaver.html | 63 ------- scripts/html/xdg-settings.html | 59 ------- 10 files changed, 9 insertions(+), 1008 deletions(-) delete mode 100644 scripts/html/index.html delete mode 100644 scripts/html/xdg-desktop-icon.html delete mode 100644 scripts/html/xdg-desktop-menu.html delete mode 100644 scripts/html/xdg-email.html delete mode 100644 scripts/html/xdg-icon-resource.html delete mode 100644 scripts/html/xdg-mime.html delete mode 100644 scripts/html/xdg-open.html delete mode 100644 scripts/html/xdg-screensaver.html delete mode 100644 scripts/html/xdg-settings.html diff --git a/scripts/html/.gitignore b/scripts/html/.gitignore index e69de29..0be5f9a 100644 --- a/scripts/html/.gitignore +++ b/scripts/html/.gitignore @@ -0,0 +1,9 @@ +index.html +xdg-desktop-icon.html +xdg-desktop-menu.html +xdg-email.html +xdg-icon-resource.html +xdg-mime.html +xdg-open.html +xdg-screensaver.html +xdg-settings.html diff --git a/scripts/html/index.html b/scripts/html/index.html deleted file mode 100644 index 64b0c53..0000000 --- a/scripts/html/index.html +++ /dev/null @@ -1,19 +0,0 @@ - - -

xdg-utils

-

-This version of xdg-utils contains the following commands: -

- - - - - - - - - -
xdg-desktop-menu:command line tool for (un)installing desktop menu items
xdg-desktop-icon:command line tool for (un)installing icons to the desktop
xdg-mime:command line tool for querying information about file type handling -and adding descriptions for new file types
xdg-icon-resource:command line tool for (un)installing icon resources
xdg-open:opens a file or URL in the user's preferred application
xdg-email:command line tool for sending mail using the user's preferred e-mail composer
xdg-screensaver:command line tool for controlling the screensaver
xdg-settings:get various settings from the desktop environment
- - \ No newline at end of file diff --git a/scripts/html/xdg-desktop-icon.html b/scripts/html/xdg-desktop-icon.html deleted file mode 100644 index f9683ba..0000000 --- a/scripts/html/xdg-desktop-icon.html +++ /dev/null @@ -1,133 +0,0 @@ -xdg-desktop-icon

Name

xdg-desktop-icon — command line tool for (un)installing icons to the desktop

Synopsis

xdg-desktop-icon install [--novendor] FILE

xdg-desktop-icon uninstall FILE

xdg-desktop-icon { --help | --manual | --version }

Description

- The xdg-desktop-icon program can be used to install an application launcher - or other file on the desktop of the current user. -

- 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. -

Commands

install
- Installs FILE to the desktop of the current user. - FILE can be a *.desktop file or any - other type of file. -
uninstall
- Removes FILE from the desktop - of the current user. -

Options

--novendor

- 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. -

- 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. -

--help
- Show command synopsis. -
--manual
- Show this manualpage. -
--version
- Show the xdg-utils version information. -

Desktop Files

- An application launcher can be added to the desktop by installing a - *.desktop file. A *.desktop file consists of a - [Desktop Entry] header followed by several - Key=Value lines. -

- 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 - Key. This way one can specify different - values for the same Key depending on the - currently selected language. -

- The following keys are often used: -

Value=1.0
- This is a mandatory field to indicate that the *.desktop file - follows the 1.0 version of the specification. -
Type=Application
- This is a mandatory field that indicates that the *.desktop file - describes an application launcher. -
Name=Application Name
- The name of the application. - For example Mozilla -
GenericName=Generic Name
- A generic description of the application. - For example Web Browser -
Comment=Comment
- Optional field to specify a tooltip for the application. - For example Visit websites on the Internet -
Icon=Icon File
- 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 xdg-icon-resource - 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. -
Exec=Command Line
- 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. -

- For a complete oveview of the *.desktop file format please - visit http://www.freedesktop.org/wiki/Standards/desktop-entry-spec -

Environment Variables

- xdg-desktop-icon honours the following environment variables: -

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. -

Exit Codes

- An exit code of 0 indicates success while a non-zero exit code - indicates failure. The following failure codes can be returned: -

1
- Error in command line syntax. -
2
- One of the files passed on the command line did not exist. -
3
- A required tool could not be found. -
4
- The action failed. -
5
- No permission to read one of the files passed on the command - line. -

See Also

xdg-icon-resource(1) -

Examples

- 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: -

-shinythings-webmirror.desktop:
-
-  [Desktop Entry]
-  Encoding=UTF-8
-  Type=Application
-
-  Exec=webmirror
-  Icon=shinythings-webmirror
-
-  Name=WebMirror
-  Name[nl]=WebSpiegel
-

-

Now the xdg-desktop-icon tool can be used to add the webmirror.desktop file - to the desktop: -

-xdg-desktop-icon install ./shinythings-webmirror.desktop
-

-

To add a README file to the desktop as well, the following command can be used: -

-xdg-desktop-icon install ./shinythings-README
-

-

diff --git a/scripts/html/xdg-desktop-menu.html b/scripts/html/xdg-desktop-menu.html deleted file mode 100644 index 71b7e04..0000000 --- a/scripts/html/xdg-desktop-menu.html +++ /dev/null @@ -1,334 +0,0 @@ -xdg-desktop-menu

Name

xdg-desktop-menu — command line tool for (un)installing desktop menu items

Synopsis

xdg-desktop-menu install [--noupdate] [--novendor] [--mode mode] directory-file(s) desktop-file(s)

xdg-desktop-menu uninstall [--noupdate] [--mode mode] directory-file(s) desktop-file(s)

xdg-desktop-menu forceupdate [--mode mode]

xdg-desktop-menu { --help | --manual | --version }

Description

- The xdg-desktop-menu program can be used to install new menu entries - to the desktop's application menu. -

- The application menu works according to the - XDG Desktop Menu Specification at - http://www.freedesktop.org/Standards/menu-spec -

Commands

install

- Install one or more applications in a submenu of - the desktop menu system. -

desktop-file: - 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. -

- 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. -

- 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 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 - xdg-desktop-menu the entries will be - installed in addition to any already existing entries. -

directory-file: - The *.directory file indicated by - directory-file 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. -

- 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. -

- Directory files follow the syntax defined by the freedesktop.org - Desktop Entry Specification. -

uninstall

- Remove applications or submenus from the desktop menu system - previously installed with xdg-desktop-menu install. -

- A submenu and the associated directory file is only removed - when the submenu no longer contains any menu entries. -

forceupdate

- Force an update of the menu system. -

- This command is only useful if the last call to - xdg-desktop-menu included the --noupdate option. -

Options

--noupdate
- 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. -
--novendor

- 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. -

- 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. -

--mode mode

mode can be - user or system. - In user mode the file is (un)installed for the current user - only. In system mode the file is (un)installed for all users - on the system. Usually only root is allowed to install in - system mode. -

- The default is to use system mode when called by root - and to use user mode when called by a non-root user. -

--help
- Show command synopsis. -
--manual
- Show this manualpage. -
--version
- Show the xdg-utils version information. -

Desktop Files

- An application item in the application menu is represented by a - *.desktop file. A *.desktop file consists of a - [Desktop Entry] header followed by several - Key=Value lines. -

- 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 - Key. This way one can specify different - values for the same Key depending on the - currently selected language. -

- The following keys are often used: -

Value=1.0
- This is a mandatory field to indicate that the *.desktop file - follows the 1.0 version of the specification. -
Type=Application
- This is a mandatory field that indicates that the *.desktop file - describes an application launcher. -
Name=Application Name
- The name of the application. - For example Mozilla -
GenericName=Generic Name
- A generic description of the application. - For example Web Browser -
Comment=Comment
- Optional field to specify a tooltip for the application. - For example Visit websites on the Internet -
Icon=Icon File
- 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 xdg-icon-resource - 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. -
Exec=Command Line
- 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. -
Categories=Categories

- A list of categories separated by semi-colons. A category is - a keyword that describes and classifies the application. - By default applications are organized in the application menu - based on category. When menu entries are explicitly assigned - to a new submenu it is not necassery to list any categories. -

- When using categories it is recommended to include - one of the following categories: - AudioVideo, Development, Education, Game, Graphics, Network, - Office, Settings, System, Utility. -

- 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 -

MimeType=Mimetypes
- A list of mimetypes separated by semi-colons. This field is - used to indicate which file types the application is able to - open. -

- For a complete oveview of the *.desktop file format please - visit http://www.freedesktop.org/wiki/Standards/desktop-entry-spec -

Directory Files

- 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 - [Desktop Entry] header followed by several - Key=Value lines. -

- 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 - Key. This way one can specify different - values for the same Key depending on the - currently selected language. -

- The following keys are relevqnt for submenus: -

Value=1.0
- This is a mandatory field to indicate that the *.directory file - follows the 1.0 version of the Desktop Entry specification. -
Type=Directory
- This is a mandatory field that indicates that the *.directory file - describes a submenu. -
Name=Menu Name
- The title of submenu. - For example Mozilla -
Comment=Comment
- Optional field to specify a tooltip for the submenu. -
Icon=Icon File
- 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 xdg-icon-resource - 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. -

Environment Variables

- xdg-desktop-menu honours the following environment variables: -

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. -
XDG_UTILS_INSTALL_MODE
- This environment variable can be used by the user or - administrator to override the installation mode. - Valid values are user and - system. -

Exit Codes

- An exit code of 0 indicates success while a non-zero exit code - indicates failure. The following failure codes can be returned: -

1
- Error in command line syntax. -
2
- One of the files passed on the command line did not exist. -
3
- A required tool could not be found. -
4
- The action failed. -
5
- No permission to read one of the files passed on the command - line. -

See Also

xdg-desktop-icon(1), - xdg-icon-resource(1), - xdg-mime(1) -

Examples

- 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 Categories entry: -

-shinythings-webmirror.desktop:
-
-  [Desktop Entry]
-  Encoding=UTF-8
-  Type=Application
-
-  Exec=webmirror
-  Icon=webmirror
-
-  Name=WebMirror
-  Name[nl]=WebSpiegel
-
-  Categories=Network;WebDevelopment;
-

-

Now the xdg-desktop-menu tool can be used to add the - shinythings-webmirror.desktop file to the desktop application menu: -

-xdg-desktop-menu install ./shinythings-webmirror.desktop
-

-

- 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. -

- 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. -

- 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: -

-shinythings-webmirror.desktop:
-
-  [Desktop Entry]
-  Encoding=UTF-8
-  Type=Application
-
-  Exec=webmirror
-  Icon=shinythings-webmirror
-
-  Name=WebMirror
-  Name[nl]=WebSpiegel
-
-
-shinythings-webmirror-admin.desktop:
-
-  [Desktop Entry]
-  Encoding=UTF-8
-  Type=Application
-
-  Exec=webmirror-admintool
-  Icon=shinythings-webmirror-admintool
-
-  Name=WebMirror Admin Tool
-  Name[nl]=WebSpiegel Administratie Tool
-

-

- In addition a .directory file needs to be created to provide a title and icon - for the sub-menu itself: -

-shinythings-webmirror.directory:
-
-  [Desktop Entry]
-  Encoding=UTF-8
-
-  Icon=shinythings-webmirror-menu
-
-  Name=WebMirror
-  Name[nl]=WebSpiegel
-

-

- These file can now be installed with: -

-xdg-desktop-menu install ./shinythings-webmirror.directory \
-      ./shinythings-webmirror.desktop ./shinythings-webmirror-admin.desktop
-

-

- The menu entries could also be installed one by one: -

-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 forceupdate
-

-

- Although the result is the same it is slightly more efficient to - install all files at the same time. -

- 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: -

-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
-

-

diff --git a/scripts/html/xdg-email.html b/scripts/html/xdg-email.html deleted file mode 100644 index a3854af..0000000 --- a/scripts/html/xdg-email.html +++ /dev/null @@ -1,89 +0,0 @@ -xdg-email

Name

xdg-email — command line tool for sending mail using the user's preferred e-mail composer

Synopsis

xdg-email [--utf8] [--cc address] [--bcc address] [--subject text] [--body text] [--attach file] [ mailto-uri | address(es) ]

xdg-email { --help | --manual | --version }

Description

- xdg-email opens the user's preferred e-mail composer in order to send - a mail to address(es) or - mailto-uri. RFC2368 defines mailto: - URIs. xdg-email limits support to, cc, subject and body fields in - mailto-uri, all other fields are silently - ignored. address(es) must follow the - syntax of RFC822. Multiple addresses may be provided as - separate arguments. -

- 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. -

- xdg-email is for use inside a desktop session only. - It is not recommended to use xdg-email as root. -

- See http://portland.freedesktop.org/EmailConfig for information on - how the user can change the e-mail composer that is used. -

Options

--utf8
- 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. -
--cc address
- Specify a recipient to be copied on the e-mail. -
--bcc address
- Specify a recipient to be blindly copied on the e-mail. -
--subject text
- Specify a subject for the e-mail. -
--body text
- 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. - text may contain linebreaks. -
--attach file

- Specify an attachment for the e-mail. file - must point to an existing file. -

- Some e-mail applications require the file to remain present - after xdg-email returns. -

--help
- Show command synopsis. -
--manual
- Show this manualpage. -
--version
- Show the xdg-utils version information. -

Environment Variables

- xdg-email honours the following environment variables: -

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. -

Exit Codes

- An exit code of 0 indicates success while a non-zero exit code - indicates failure. The following failure codes can be returned: -

1
- Error in command line syntax. -
2
- One of the files passed on the command line did not exist. -
3
- A required tool could not be found. -
4
- The action failed. -
5
- No permission to read one of the files passed on the command - line. -

Configuration

Visit http://portland.freedesktop.org/EmailConfig for information - how to configure xdg-email to use the email client of your choice. -

Examples

-

-xdg-email 'Jeremy White <jwhite@example.com>'
-

-

-

-xdg-email --attach /tmp/logo.png \
-          --subject 'Logo contest' \
-          --body 'Attached you find the logo for the contest.' \
-          'jwhite@example.com'
-

-

-

-xdg-email --subject 'Your password is about to expire' \
-          'jwhite@example.com' 'bastian@example.com' 'whipple@example.com'
-

-

diff --git a/scripts/html/xdg-icon-resource.html b/scripts/html/xdg-icon-resource.html deleted file mode 100644 index a734033..0000000 --- a/scripts/html/xdg-icon-resource.html +++ /dev/null @@ -1,128 +0,0 @@ -xdg-icon-resource

Name

xdg-icon-resource — command line tool for (un)installing icon resources

Synopsis

xdg-icon-resource install [--noupdate] [--novendor] [--theme theme] [--context context] [--mode mode] --size size icon-file [icon-name]

xdg-icon-resource uninstall [--noupdate] [--theme theme] [--context context] [--mode mode] --size size icon-name

xdg-icon-resource forceupdate [--theme theme] [--mode mode]

xdg-icon-resource { --help | --manual | --version }

Description

- 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 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 works according to the - XDG Icon Theme Specification at - http://www.freedesktop.org/Standards/icon-theme-spec -

Commands

install
- Installs the icon file indicated by icon-file - to the desktop icon system under the name - icon-name. - Icon names do not have an extension. - If icon-name is not provided the name is - derived from icon-file. - The icon file must have - .png or .xpm - as extension. If a corresponding .icon - file exists in the same location as icon-file - it will be installed as well. -
uninstall
- Removes the icon indicated by icon-name - from the desktop icon system. Note that icon names do not have - an extension. -
forceupdate
- Force an update of the desktop icon system. This is only useful if - the last call to xdg-icon-resource included the --noupdate option. -

Options

--noupdate
- 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. -
--novendor

- Normally, xdg-icon-resource checks to ensure that an icon file - to be installed in the apps context has - a proper vendor prefix. This option can be used to disable - that check. -

- 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. -

--theme theme
- Installs or removes the icon file as part of - theme. If no theme is specified the - icons will be installed as part of the default hicolor theme. - Applications may install icons under multiple themes but should - at least install icons for the default hicolor theme. -
--context context
- Specifies the context for the icon. Icons to be used in the - application menu and as desktop icon should use - apps as context which is the default - context. Icons to be used as file icons should use - mimetypes as context. - Other common contexts are actions, - devices, emblems, - filesystems and stock. -
--size size
- 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 -
--mode mode

mode can be - user or system. - In user mode the file is (un)installed for the current user - only. In system mode the file is (un)installed for all users - on the system. Usually only root is allowed to install in - system mode. -

- The default is to use system mode when called by root - and to use user mode when called by a non-root user. -

--help
- Show command synopsis. -
--manual
- Show this manualpage. -
--version
- Show the xdg-utils version information. -

Environment Variables

- xdg-icon-resource honours the following environment variables: -

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. -
XDG_UTILS_INSTALL_MODE
- This environment variable can be used by the user or - administrator to override the installation mode. - Valid values are user and - system. -

Exit Codes

- An exit code of 0 indicates success while a non-zero exit code - indicates failure. The following failure codes can be returned: -

1
- Error in command line syntax. -
2
- One of the files passed on the command line did not exist. -
3
- A required tool could not be found. -
4
- The action failed. -
5
- No permission to read one of the files passed on the command - line. -

See Also

xdg-desktop-icon(1), - xdg-desktop-menu(1), - xdg-mime(1) -

Examples

-To install an icon resource to depict a launcher for the application -myfoobar, the company ShinyThings Inc. can use: -

-xdg-icon-resource install --size 64 shinythings-myfoobar.png
-

-

-To install an icon for a new application/x-foobar file type one can use: -

-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
-

This will install two icons with the name application-x-foobar -but with different sizes. -

diff --git a/scripts/html/xdg-mime.html b/scripts/html/xdg-mime.html deleted file mode 100644 index 53bb99c..0000000 --- a/scripts/html/xdg-mime.html +++ /dev/null @@ -1,145 +0,0 @@ -xdg-mime

Name

xdg-mime — command line tool for querying information about file type handling -and adding descriptions for new file types

Synopsis

xdg-mime query { filetype | default } ...

xdg-mime default application mimetype(s)

xdg-mime install [--mode mode] [--novendor] mimetypes-file

xdg-mime uninstall [--mode mode] mimetypes-file

xdg-mime { --help | --manual | --version }

Description

- The xdg-mime program can be used to query information about file types - and to add descriptions for new file types. -

Commands

query

- Returns information related to file types. -

- The query option is for use inside a desktop session only. - It is not recommended to use xdg-mime query as root. -

- The following queries are supported: -

query filetype FILE: - Returns the file type of FILE in the form of a MIME type. -

query default mimetype: - Returns the default application that the desktop environment uses for opening - files of type mimetype. The default application is - identified by its *.desktop file. -

default

- Ask the desktop environment to make application - the default application for opening - files of type mimetype. An - application can be made the default for several file types by - specifying multiple mimetypes. -

- application is the desktop file - id of the application and has the form vendor-name.desktop - application must already be installed - in the desktop menu before it can be made the default handler. - The aplication's desktop file must list support for all the - MIME types that it wishes to be the default handler for. -

- Requests to make an application a default handler may be - subject to system policy or approval by the end-user. xdg-mime - query can be used to verify whether an application is the - actual default handler for a specific file type. -

- The default option is for use inside a desktop session only. - It is not recommended to use xdg-mime default as root. -

install
- Adds the file type descriptions provided in mimetypes-file - to the desktop environment. mimetypes-file - 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 - type-subtype - must be installed with the xdg-icon-resource - command in the mimetypes context. For example the - filetype application/vnd.oasis.opendocument.text requires an - icon named application-vnd.oasis.opendocument.text - to be installed (unless the file type recommends another icon name). -
uninstall
- Removes the file type descriptions provided in mimetypes-file - and previously added with xdg-mime install from the - desktop environment. mimetypes-file - 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. -

Options

--mode mode

mode can be - user or system. - In user mode the file is (un)installed for the current user - only. In system mode the file is (un)installed for all users - on the system. Usually only root is allowed to install in - system mode. -

- The default is to use system mode when called by root - and to use user mode when called by a non-root user. -

--novendor

- Normally, xdg-mime checks to ensure that the - mimetypes-file to be installed - has a proper vendor prefix. This option can be - used to disable that check. -

- 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. -

--help
- Show command synopsis. -
--manual
- Show this manualpage. -
--version
- Show the xdg-utils version information. -

Environment Variables

- xdg-mime honours the following environment variables: -

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. -
XDG_UTILS_INSTALL_MODE
- This environment variable can be used by the user or - administrator to override the installation mode. - Valid values are user and - system. -

Exit Codes

- An exit code of 0 indicates success while a non-zero exit code - indicates failure. The following failure codes can be returned: -

1
- Error in command line syntax. -
2
- One of the files passed on the command line did not exist. -
3
- A required tool could not be found. -
4
- The action failed. -
5
- No permission to read one of the files passed on the command - line. -

See Also

xdg-icon-resource(1), - xdg-desktop-menu(1) -

Examples

-

-xdg-mime query filetype /tmp/foobar.png
-

Prints the MIME type of the file /tmp/foobar.png, in this -case image/png -

-

-xdg-mime query default image/png
-

Prints the .desktop filename of the application which is - registered to open PNG files. -

-

-xdg-mime install shinythings-shiny.xml
-

Adds a file type description for "shiny"-files. - "shinythings-" is used as the vendor prefix. - The file type description could look as folows. -

-shinythings-shiny.xml:
-
-<?xml version="1.0"?>
-<mime-info xmlns='http://www.freedesktop.org/standards/shared-mime-info'>
-  <mime-type type="text/x-shiny">
-    <comment>Shiny new file type</comment>
-    <glob pattern="*.shiny"/>
-    <glob pattern="*.shi"/>
-  </mime-type>
-</mime-info>
-

An icon for this new file type must also be installed, for -example with: -

-xdg-icon-resource install --context mimetypes --size 64 shiny-file-icon.png text-x-shiny
-

-

diff --git a/scripts/html/xdg-open.html b/scripts/html/xdg-open.html deleted file mode 100644 index 2433500..0000000 --- a/scripts/html/xdg-open.html +++ /dev/null @@ -1,38 +0,0 @@ -xdg-open

Name

xdg-open — opens a file or URL in the user's preferred application

Synopsis

xdg-open { file | URL }

xdg-open { --help | --manual | --version }

Description

- 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 is for use inside a desktop session only. - It is not recommended to use xdg-open as root. -

Options

--help
- Show command synopsis. -
--manual
- Show this manualpage. -
--version
- Show the xdg-utils version information. -

Exit Codes

- An exit code of 0 indicates success while a non-zero exit code - indicates failure. The following failure codes can be returned: -

1
- Error in command line syntax. -
2
- One of the files passed on the command line did not exist. -
3
- A required tool could not be found. -
4
- The action failed. -

Examples

-

-xdg-open 'http://www.freedesktop.org/'
-

- Opens the Freedesktop.org website in the user's default browser -

-

-xdg-open /tmp/foobar.png
-

- Opens the PNG image file /tmp/foobar.png in the user's default image - viewing application. -

diff --git a/scripts/html/xdg-screensaver.html b/scripts/html/xdg-screensaver.html deleted file mode 100644 index 219f48c..0000000 --- a/scripts/html/xdg-screensaver.html +++ /dev/null @@ -1,63 +0,0 @@ -xdg-screensaver

Name

xdg-screensaver — command line tool for controlling the screensaver

Synopsis

xdg-screensaver suspend WindowID

xdg-screensaver resume WindowID

xdg-screensaver { activate | lock | reset | status }

xdg-screensaver { --help | --manual | --version }

Description

- xdg-screensaver provides commands to control the screensaver. -

- xdg-screensaver is for use inside a desktop session only. - It is not recommended to use xdg-screensaver as root. -

Commands

suspend WindowID

- Suspends the screensaver and monitor power management. - WindowID must be the X Window ID - of an existing window of the calling application. The window - must remain in existance for the duration of the suspension. -

- WindowID can be represented as either a decimal number - or as a hexadecimal number consisting of the prefix - 0x followed by one or more hexadecimal - digits. -

- The screensaver can be suspended in relation to multiple - windows at the same time. In that case screensaver - operation is only restored once the screensaver has been - resumed in relation to each of the windows -

resume WindowID
- Resume the screensaver and monitor power management after being - suspended. - WindowID - must be the same X Window ID that was passed to a previous call - of xdg-screensaver suspend -
activate
- Turns the screensaver on immediately. This may result in the - screen getting locked, depending on existing system policies. -
lock
- Lock the screen immediately. -
reset
- Turns the screensaver off immediately. If the screen was locked - the user may be asked to authenticate first. -
status
- Prints enabled to stdout if the - screensaver is enabled to turn on after a period of - inactivity and prints - disabled if the screensaver is - not enabled. -

Options

--help
- Show command synopsis. -
--manual
- Show this manualpage. -
--version
- Show the xdg-utils version information. -

Exit Codes

- An exit code of 0 indicates success while a non-zero exit code - indicates failure. The following failure codes can be returned: -

1
- Error in command line syntax. -
3
- A required tool could not be found. -
4
- The action failed. -

Examples

-

-xdg-screensaver suspend 0x1c00007
-

Causes the screensaver to be disabled till - xdg-screensaver resume 0x1c00007 is called. - 0x1c00007 must be the X Window ID of an - existing window. -

diff --git a/scripts/html/xdg-settings.html b/scripts/html/xdg-settings.html deleted file mode 100644 index 380ad2a..0000000 --- a/scripts/html/xdg-settings.html +++ /dev/null @@ -1,59 +0,0 @@ -xdg-settings

Name

xdg-settings — get various settings from the desktop environment

Synopsis

xdg-settings { get | check | set } {property} [subproperty] [value]

xdg-settings { --help | --list | --manual | --version }

Description

- 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's libraries (which would use the settings natively). -

- xdg-settings is for use inside a desktop session only. - It is not recommended to use xdg-settings as root. -

Options

--help
- Show command synopsis. -
--list
- List all properties xdg-settings knows about. -
--manual
- Show this manualpage. -
--version
- Show the xdg-utils version information. -

Properties

- When using xdg-settings to get, check or set a destkop setting, properties - and possibly sub-properties are used to specify the setting to be changed. -

- Some properties (such as default-web-browser) fully describe the setting - to be changed. Other properties (such as default-url-scheme-handler) require - more information (in this case the actual scheme to set the default handler - for) which must be provided in a sub-property. -

Exit Codes

- An exit code of 0 indicates success while a non-zero exit code - indicates failure. The following failure codes can be returned: -

1
- Error in command line syntax. -
2
- One of the files passed on the command line did not exist. -
3
- A required tool could not be found. -
4
- The action failed. -

Examples

- Get the desktop file name of the current default web browser - 

-        xdg-settings get default-web-browser
-

-

- 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) - 

-        xdg-settings check default-web-browser firefox.desktop
-

-

- Set the default web browser to google-chrome.desktop - 

-        xdg-settings set default-web-browser google-chrome.desktop
-

-

- Set the default mailto URL scheme handler to be evolution.desktop - 

-        xdg-settings set default-url-scheme-handler mailto evolution.desktop
-

-

-- 2.1.0