diff options
Diffstat (limited to 'autostart')
| -rw-r--r-- | autostart/.cvsignore | 14 | ||||
| -rw-r--r-- | autostart/AUTHORS | 5 | ||||
| -rw-r--r-- | autostart/COPYING | 2 | ||||
| -rw-r--r-- | autostart/ChangeLog | 4 | ||||
| -rw-r--r-- | autostart/INSTALL | 236 | ||||
| -rw-r--r-- | autostart/Makefile.am | 16 | ||||
| -rw-r--r-- | autostart/NEWS | 0 | ||||
| -rw-r--r-- | autostart/README | 6 | ||||
| -rwxr-xr-x | autostart/autogen.sh | 3 | ||||
| -rw-r--r-- | autostart/autostart-spec.xml | 273 | ||||
| -rw-r--r-- | autostart/configure.in | 61 |
11 files changed, 620 insertions, 0 deletions
diff --git a/autostart/.cvsignore b/autostart/.cvsignore new file mode 100644 index 0000000..f5518ef --- /dev/null +++ b/autostart/.cvsignore @@ -0,0 +1,14 @@ +config.log +config.status +config.sub +configure +Makefile +Makefile.in +aclocal.m4 +autom4te.cache +config.guess +config.h +config.h.in +install-sh +missing +autostart-spec.html diff --git a/autostart/AUTHORS b/autostart/AUTHORS new file mode 100644 index 0000000..cc42641 --- /dev/null +++ b/autostart/AUTHORS @@ -0,0 +1,5 @@ +John Palmieri <johnp@redhat.com> +Kévin Ottens <ervin@ipsquad.net> +Renato Caldas <seventhguardian_@hotmail.com> +Rodrigo Moya <rodrigo@gnome-db.org> +Waldo Bastian <waldo.bastian@intel.com> diff --git a/autostart/COPYING b/autostart/COPYING new file mode 100644 index 0000000..73e7995 --- /dev/null +++ b/autostart/COPYING @@ -0,0 +1,2 @@ +FIXME - we need a license for specs + diff --git a/autostart/ChangeLog b/autostart/ChangeLog new file mode 100644 index 0000000..b7b5318 --- /dev/null +++ b/autostart/ChangeLog @@ -0,0 +1,4 @@ +2006-02-13 Waldo Bastian <waldo.bastian@intel.com> + + * Import of autostart spec + diff --git a/autostart/INSTALL b/autostart/INSTALL new file mode 100644 index 0000000..56b077d --- /dev/null +++ b/autostart/INSTALL @@ -0,0 +1,236 @@ +Installation Instructions +************************* + +Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005 Free +Software Foundation, Inc. + +This file is free documentation; the Free Software Foundation gives +unlimited permission to copy, distribute and modify it. + +Basic Installation +================== + +These are generic installation instructions. + + The `configure' shell script attempts to guess correct values for +various system-dependent variables used during compilation. It uses +those values to create a `Makefile' in each directory of the package. +It may also create one or more `.h' files containing system-dependent +definitions. Finally, it creates a shell script `config.status' that +you can run in the future to recreate the current configuration, and a +file `config.log' containing compiler output (useful mainly for +debugging `configure'). + + It can also use an optional file (typically called `config.cache' +and enabled with `--cache-file=config.cache' or simply `-C') that saves +the results of its tests to speed up reconfiguring. (Caching is +disabled by default to prevent problems with accidental use of stale +cache files.) + + If you need to do unusual things to compile the package, please try +to figure out how `configure' could check whether to do them, and mail +diffs or instructions to the address given in the `README' so they can +be considered for the next release. If you are using the cache, and at +some point `config.cache' contains results you don't want to keep, you +may remove or edit it. + + The file `configure.ac' (or `configure.in') is used to create +`configure' by a program called `autoconf'. You only need +`configure.ac' if you want to change it or regenerate `configure' using +a newer version of `autoconf'. + +The simplest way to compile this package is: + + 1. `cd' to the directory containing the package's source code and type + `./configure' to configure the package for your system. If you're + using `csh' on an old version of System V, you might need to type + `sh ./configure' instead to prevent `csh' from trying to execute + `configure' itself. + + Running `configure' takes awhile. While running, it prints some + messages telling which features it is checking for. + + 2. Type `make' to compile the package. + + 3. Optionally, type `make check' to run any self-tests that come with + the package. + + 4. Type `make install' to install the programs and any data files and + documentation. + + 5. You can remove the program binaries and object files from the + source code directory by typing `make clean'. To also remove the + files that `configure' created (so you can compile the package for + a different kind of computer), type `make distclean'. There is + also a `make maintainer-clean' target, but that is intended mainly + for the package's developers. If you use it, you may have to get + all sorts of other programs in order to regenerate files that came + with the distribution. + +Compilers and Options +===================== + +Some systems require unusual options for compilation or linking that the +`configure' script does not know about. Run `./configure --help' for +details on some of the pertinent environment variables. + + You can give `configure' initial values for configuration parameters +by setting variables in the command line or in the environment. Here +is an example: + + ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix + + *Note Defining Variables::, for more details. + +Compiling For Multiple Architectures +==================================== + +You can compile the package for more than one kind of computer at the +same time, by placing the object files for each architecture in their +own directory. To do this, you must use a version of `make' that +supports the `VPATH' variable, such as GNU `make'. `cd' to the +directory where you want the object files and executables to go and run +the `configure' script. `configure' automatically checks for the +source code in the directory that `configure' is in and in `..'. + + If you have to use a `make' that does not support the `VPATH' +variable, you have to compile the package for one architecture at a +time in the source code directory. After you have installed the +package for one architecture, use `make distclean' before reconfiguring +for another architecture. + +Installation Names +================== + +By default, `make install' will install the package's files in +`/usr/local/bin', `/usr/local/man', etc. You can specify an +installation prefix other than `/usr/local' by giving `configure' the +option `--prefix=PREFIX'. + + You can specify separate installation prefixes for +architecture-specific files and architecture-independent files. If you +give `configure' the option `--exec-prefix=PREFIX', the package will +use PREFIX as the prefix for installing programs and libraries. +Documentation and other data files will still use the regular prefix. + + In addition, if you use an unusual directory layout you can give +options like `--bindir=DIR' to specify different values for particular +kinds of files. Run `configure --help' for a list of the directories +you can set and what kinds of files go in them. + + If the package supports it, you can cause programs to be installed +with an extra prefix or suffix on their names by giving `configure' the +option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. + +Optional Features +================= + +Some packages pay attention to `--enable-FEATURE' options to +`configure', where FEATURE indicates an optional part of the package. +They may also pay attention to `--with-PACKAGE' options, where PACKAGE +is something like `gnu-as' or `x' (for the X Window System). The +`README' should mention any `--enable-' and `--with-' options that the +package recognizes. + + For packages that use the X Window System, `configure' can usually +find the X include and library files automatically, but if it doesn't, +you can use the `configure' options `--x-includes=DIR' and +`--x-libraries=DIR' to specify their locations. + +Specifying the System Type +========================== + +There may be some features `configure' cannot figure out automatically, +but needs to determine by the type of machine the package will run on. +Usually, assuming the package is built to be run on the _same_ +architectures, `configure' can figure that out, but if it prints a +message saying it cannot guess the machine type, give it the +`--build=TYPE' option. TYPE can either be a short name for the system +type, such as `sun4', or a canonical name which has the form: + + CPU-COMPANY-SYSTEM + +where SYSTEM can have one of these forms: + + OS KERNEL-OS + + See the file `config.sub' for the possible values of each field. If +`config.sub' isn't included in this package, then this package doesn't +need to know the machine type. + + If you are _building_ compiler tools for cross-compiling, you should +use the `--target=TYPE' option to select the type of system they will +produce code for. + + If you want to _use_ a cross compiler, that generates code for a +platform different from the build platform, you should specify the +"host" platform (i.e., that on which the generated programs will +eventually be run) with `--host=TYPE'. + +Sharing Defaults +================ + +If you want to set default values for `configure' scripts to share, you +can create a site shell script called `config.site' that gives default +values for variables like `CC', `cache_file', and `prefix'. +`configure' looks for `PREFIX/share/config.site' if it exists, then +`PREFIX/etc/config.site' if it exists. Or, you can set the +`CONFIG_SITE' environment variable to the location of the site script. +A warning: not all `configure' scripts look for a site script. + +Defining Variables +================== + +Variables not defined in a site shell script can be set in the +environment passed to `configure'. However, some packages may run +configure again during the build, and the customized values of these +variables may be lost. In order to avoid this problem, you should set +them in the `configure' command line, using `VAR=value'. For example: + + ./configure CC=/usr/local2/bin/gcc + +causes the specified `gcc' to be used as the C compiler (unless it is +overridden in the site shell script). Here is a another example: + + /bin/bash ./configure CONFIG_SHELL=/bin/bash + +Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent +configuration-related scripts to be executed by `/bin/bash'. + +`configure' Invocation +====================== + +`configure' recognizes the following options to control how it operates. + +`--help' +`-h' + Print a summary of the options to `configure', and exit. + +`--version' +`-V' + Print the version of Autoconf used to generate the `configure' + script, and exit. + +`--cache-file=FILE' + Enable the cache: use and save the results of the tests in FILE, + traditionally `config.cache'. FILE defaults to `/dev/null' to + disable caching. + +`--config-cache' +`-C' + Alias for `--cache-file=config.cache'. + +`--quiet' +`--silent' +`-q' + Do not print messages saying which checks are being made. To + suppress all normal output, redirect it to `/dev/null' (any error + messages will still be shown). + +`--srcdir=DIR' + Look for the package's source code in directory DIR. Usually + `configure' can determine that directory automatically. + +`configure' also accepts some other, not widely useful, options. Run +`configure --help' for more details. + diff --git a/autostart/Makefile.am b/autostart/Makefile.am new file mode 100644 index 0000000..f13d2c9 --- /dev/null +++ b/autostart/Makefile.am @@ -0,0 +1,16 @@ +HTML_FILES= autostart-spec.html + +XML_FILES= autostart-spec.xml + +EXTRA_DIST= $(HTML_FILES) $(XML_FILES) + +if XML_DOCS_ENABLED +all-local: $(HTML_FILES) +endif + +%.html: %.xml + $(XMLTO) html-nochunks $< + +maintainer-clean-local: + rm -f $(HTML_FILES) + diff --git a/autostart/NEWS b/autostart/NEWS new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/autostart/NEWS diff --git a/autostart/README b/autostart/README new file mode 100644 index 0000000..7700629 --- /dev/null +++ b/autostart/README @@ -0,0 +1,6 @@ +This is the autostart specification. + +It covers +* automatic launching of applications when the user logs in +* automatic launching of applications when a new media is mounted + diff --git a/autostart/autogen.sh b/autostart/autogen.sh new file mode 100755 index 0000000..b1376df --- /dev/null +++ b/autostart/autogen.sh @@ -0,0 +1,3 @@ +#! /bin/sh +autoreconf -v --install || exit 1 +./configure --enable-maintainer-mode "$@" diff --git a/autostart/autostart-spec.xml b/autostart/autostart-spec.xml new file mode 100644 index 0000000..ba5487e --- /dev/null +++ b/autostart/autostart-spec.xml @@ -0,0 +1,273 @@ +<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ + <!ENTITY version "0.5"> + <!ENTITY dtd-version "0.5"> + ]> + +<article id="index"> + <articleinfo> + <title>Desktop Application Autostart Specification</title> + <releaseinfo>Version &version;</releaseinfo> + <date>13 February 2006</date> + <authorgroup> + <author> + <firstname>John</firstname> + <surname>Palmieri</surname> + <affiliation> + <address> + <email>johnp@redhat.com</email> + </address> + </affiliation> + </author> + <author> + <firstname>Kévin</firstname> + <surname>Ottens</surname> + <affiliation> + <address> + <email>ervin@ipsquad.net</email> + </address> + </affiliation> + </author> + <author> + <firstname>Renato</firstname> + <surname>Caldas</surname> + <affiliation> + <address> + <email>seventhguardian_@hotmail.com</email> + </address> + </affiliation> + </author> + <author> + <firstname>Rodrigo</firstname> + <surname>Moya</surname> + <affiliation> + <address> + <email>rodrigo@gnome-db.org</email> + </address> + </affiliation> + </author> + <author> + <firstname>Waldo</firstname> + <surname>Bastian</surname> + <affiliation> + <address> + <email>bastian@kde.org</email> + </address> + </affiliation> + </author> + </authorgroup> + </articleinfo> + + <sect1 id="introduction"> + <title>Introduction</title> + <para> + This DRAFT document defines a method for automatically starting + applications during the startup of a desktop environment and after + mounting a removable medium. + </para> + <para> + Some of the file locations in this specification are specified based + on the <ulink url="http://standards.freedesktop.org/basedir-spec/"> + "desktop base directory specification"</ulink>. + </para> + <para> + The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL + NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and + "OPTIONAL" in this document are to be interpreted as + described in RFC 2119. + </para> + </sect1> + <sect1 id="startup"> + <title>Autostart Of Applications During Startup</title> + <para> + By placing an application's .desktop file + in one of the Autostart directories the application will be + automatically launched during startup of the user's desktop environment after the user + has logged in. + </para> + <sect2> + <title>Autostart Directories</title> + <para> + The Autostart Directories are $XDG_CONFIG_DIRS/autostart as defined + in accordance with the + <ulink url="http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html#referencing"> + "Referencing this specification"</ulink> section in the + <ulink url="http://standards.freedesktop.org/basedir-spec/"> + "desktop base directory specification"</ulink>. + </para> + <para> + If the same filename is located under multiple Autostart Directories + only the file under the most important directory should be used. + </para> + <informalexample> + <para> + Example: If $XDG_CONFIG_HOME is not set the Autostart Directory + in the user's home directory is ~/.config/autostart/ + </para> + </informalexample> + <informalexample> + <para> + Example: If $XDG_CONFIG_DIRS is not set the system wide Autostart + Directory is /etc/xdg/autostart/ + </para> + </informalexample> + <informalexample> + <para> + Example: If $XDG_CONFIG_HOME and $XDG_CONFIG_DIRS are not set and + the two files /etc/xdg/autostart/foo.desktop and + ~/.config/autostart/foo.desktop exist then only the file + ~/.config/autostart/foo.desktop will be used because + ~/.config/autostart/ is more important than /etc/xdg/autostart/ + </para> + </informalexample> + </sect2> + <sect2> + <title>Application .desktop Files</title> + <para> + An application .desktop file must have the format as defined in + the <ulink url="http://standards.freedesktop.org/desktop-entry-spec/"> + "Desktop Entry Specification"</ulink>. All keys should be + interpreted as defined with the following exceptions in order to + take into account that the .desktop files in an autostart directory + are not shown in a menu. + </para> + <sect3> + <title>Hidden Key</title> + <para> + When the .desktop file has the Hidden key set to true, the .desktop + file MUST be ignored. When multiple .desktop files with the + same name exists in multiple directories then only the Hidden key + in the most important .desktop file must be considered: If it is + set to true all .desktop files with the same name + in the other directories MUST be ignored as well. + </para> + </sect3> + <sect3> + <title>OnlyShowIn and NotShowIn Keys</title> + <para> + The OnlyShownIn entry may contain a list of strings identifying + the desktop environments that MUST autostart this application, + all other desktop environments MUST NOT autostart this application. + </para> + <para> + The NotShownIn entry may contain a list of strings identifying + the desktop environments that MUST NOT autostart this + application, all other desktop environments MUST autostart this + application. + </para> + <para> + Only one of these keys, either OnlyShowIn or NotShowIn, may appear + in a single .desktop file. + </para> + </sect3> + <sect3> + <title>TryExec Key</title> + <para> + A .desktop file with a non-empty TryExec field MUST NOT be + autostarted if the value of the TryExec key does NOT match with + an installed executable program. The value of the TryExec field + may either be an absolute path or the name of an executable + without any path components. If the name of an executable is + specified without any path components then the $PATH environment + is searched to find a matching executable program. + </para> + </sect3> + </sect2> + <sect2> + <title>Implementation Notes</title> + <informalexample> + <para> + If an application autostarts by having a .desktop file installed + in the system wide autostart directory, an individual user can + disable the autotomatic start of this application by placing a + .desktop file of the same name in its personal autostart directory + which contains the key Hidden=true. + </para> + </informalexample> + </sect2> + </sect1> + <sect1 id="mounting"> + <title>Autostart Of Applications After Mount</title> + <para> + When a desktop environment mounts a new medium, the medium may contain + an Autostart file that can suggest to start an application or + an Autoopen file that can suggest to open a specific file located + on the medium. + </para> + <sect2> + <title>Autostart Files</title> + <para> + When a new medium is mounted the root directory of the medium should + be checked for the following Autostart files in order of precendence: + .autorun, autorun, autorun.sh + Only the first file that is present should be considered. + </para> + <para> + The desktop environment MAY ignore Autostart files altogether + based on policy set by the user, system administrator or vendor. + </para> + <para> + The desktop environment MUST prompt the user for confirmation before + automatically starting an application. + </para> + <para> + When an Autostart file has been detected and the user has confirmed + its execution the autostart file MUST be executed with the + current working directory (CWD) set to the root directory of the + medium. + </para> + </sect2> + <sect2> + <title>Autoopen Files</title> + <para> + When a new medium is mounted and a) the medium does not contain an + Autostart file or b) a policy to ignore Autostart files is in effect + then the root directory of the medium should be checked for the + following Autoopen files in order of precedence: + .autoopen, autoopen . + Only the first file that is present should be considered. + </para> + <para> + The desktop environment MAY ignore Autoopen files altogether + based on policy set by the user, system administrator or vendor. + </para> + <para> + An Autoopen file MUST contain a single relative path that points to + a non-executable file contained on the medium. + If the file contains a newline or carriage return character then the + newline or carriage return character itself and all characters that + follow MUST be ignored. + </para> + <para> + The relative path MUST NOT contain path components that refer to a + parent directory (../) + </para> + <para> + The relative path MUST NOT point to an executable file. + </para> + <para> + The desktop environment MUST verify that the relative path points to + a file that is actually located on the medium, taking into account any + symbolic or other links and MUST ignore any relative path that + points to a file location outside the medium itself. + </para> + <para> + If the relative path points to an executable file then the desktop + environment MUST NOT execute the file. + </para> + <para> + The desktop environment MUST prompt the user for confirmation before + opening the file. + </para> + <para> + When an Autoopen file has been detected and the user has confirmed + that the file indicated in the Autoopen file should be opened then + the file indicated in the Autoopen file MUST be opened in the + application normally preferred by the user for files of its kind + UNLESS the user instructed otherwise. + </para> + </sect2> + </sect1> + +</article> + diff --git a/autostart/configure.in b/autostart/configure.in new file mode 100644 index 0000000..7df76ac --- /dev/null +++ b/autostart/configure.in @@ -0,0 +1,61 @@ +dnl -*- mode: m4 -*- +AC_PREREQ(2.52) + +AC_INIT(autostart-spec.xml) + +AM_INIT_AUTOMAKE(autostart-spec, 0.5) + +# Honor aclocal flags +ACLOCAL="$ACLOCAL $ACLOCAL_FLAGS" + + ## must come before we use the $USE_MAINTAINER_MODE variable later +AM_MAINTAINER_MODE + +AC_ARG_ENABLE(xml-docs, [ --enable-xml-docs build XML into HTML (requires xmlto)],enable_xml_docs=$enableval,enable_xml_docs=auto) + +### XML tools + +AC_PATH_PROG(XMLTO, xmlto, no) + +AC_MSG_CHECKING([whether to build XML documentation]) + +if test x$XMLTO = xno ; then + have_xmlto=no +else + have_xmlto=yes +fi + +if test x$enable_xml_docs = xauto ; then + if test x$have_xmlto = xno ; then + enable_xml_docs=no + else + enable_xml_docs=yes + fi +fi + +if test x$enable_xml_docs = xyes; then + if test x$have_xmlto = xno; then + AC_MSG_ERROR([Building XML docs explicitly required, but xmlto not found]) + fi +fi + +AM_CONDITIONAL(XML_DOCS_ENABLED, test x$enable_xml_docs = xyes) +AC_MSG_RESULT(yes) + +AC_OUTPUT([ +Makefile +]) + +dnl ========================================================================== +echo " + Autostart specification $VERSION + ============== + + prefix: ${prefix} + source code location: ${srcdir} + xmlto: ${XMLTO}" + +echo " + Maintainer mode: ${USE_MAINTAINER_MODE} + Building XML docs: ${enable_xml_docs} +" |