Index: third_party/xdg-utils/scripts/desc/xdg-terminal.xml |
=================================================================== |
--- third_party/xdg-utils/scripts/desc/xdg-terminal.xml (revision 0) |
+++ third_party/xdg-utils/scripts/desc/xdg-terminal.xml (revision 0) |
@@ -0,0 +1,137 @@ |
+<?xml version="1.0"?> |
+<?xml-stylesheet type="text/xsl" |
+ href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?> |
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" |
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ |
+]> |
+<refentry id="xdg-terminal"> |
+ <refentryinfo> |
+ <title>xdg-terminal Manual</title> |
+ <copyright> |
+ <year>2006</year> |
+ </copyright> |
+ <author> |
+ <firstname>Kevin</firstname> |
+ <surname>Krammer</surname> |
+ </author> |
+ <address><email>kevin.krammer@gmx.at</email></address> |
+ <releaseinfo>xdg-terminal Technology Preview</releaseinfo> |
+ </refentryinfo> |
+ |
+ <refmeta> |
+ <refentrytitle>xdg-terminal</refentrytitle> |
+ <manvolnum>1</manvolnum> |
+ </refmeta> |
+ |
+ <refnamediv> |
+ <refname>xdg-terminal</refname> |
+ <refpurpose>opens the user's preferred terminal emulator application</refpurpose> |
+ </refnamediv> |
+ |
+ <refsynopsisdiv> |
+ <cmdsynopsis> |
+ <command>xdg-terminal</command> |
+ <arg choice="opt"><option><replaceable>command</replaceable></option></arg> |
+ </cmdsynopsis> |
+ <cmdsynopsis> |
+ <command>xdg-terminal</command> |
+ <group choice="req"> |
+ <arg choice="plain"><option>--help</option></arg> |
+ <arg choice="plain"><option>--manual</option></arg> |
+ <arg choice="plain"><option>--version</option></arg> |
+ </group> |
+ </cmdsynopsis> |
+ </refsynopsisdiv> |
+ |
+ <refsect1 id="description"> |
+ <title>Description</title> |
+ <para> |
+ xdg-terminal opens the user's preferred terminal emulator application. |
+ If a command is provided the command will be executed by the shell within |
+ the newly opened terminal window. |
+ </para> |
+ <para> |
+ xdg-terminal is for use inside a desktop session only. |
+ It is not recommended to use xdg-terminal as root. |
+ </para> |
+ </refsect1> |
+ <refsect1 id="options"> |
+ <title>Options</title> |
+ <variablelist> |
+ <varlistentry> |
+ <term><option>--help</option></term> |
+ <listitem> |
+ <simpara> |
+ Show command synopsis. |
+ </simpara> |
+ </listitem> |
+ </varlistentry> |
+ |
+ <varlistentry> |
+ <term><option>--manual</option></term> |
+ <listitem> |
+ <simpara> |
+ Show this manualpage. |
+ </simpara> |
+ </listitem> |
+ </varlistentry> |
+ |
+ <varlistentry> |
+ <term><option>--version</option></term> |
+ <listitem> |
+ <simpara> |
+ Show the xdg-utils version information. |
+ </simpara> |
+ </listitem> |
+ </varlistentry> |
+ </variablelist> |
+ </refsect1> |
+ <refsect1 id="exitcodes"> |
+ <title>Exit Codes</title> |
+ <para> |
+ An exit code of 0 indicates success while a non-zero exit code |
+ indicates failure. The following failure codes can be returned: |
+ </para> |
+ <variablelist> |
+ <varlistentry> |
+ <term><option>1</option></term> |
+ <listitem> |
+ <simpara> |
+ Error in command line syntax. |
+ </simpara> |
+ </listitem> |
+ </varlistentry> |
+ <varlistentry> |
+ <term><option>3</option></term> |
+ <listitem> |
+ <simpara> |
+ A required tool could not be found. |
+ </simpara> |
+ </listitem> |
+ </varlistentry> |
+ <varlistentry> |
+ <term><option>4</option></term> |
+ <listitem> |
+ <simpara> |
+ The action failed. |
+ </simpara> |
+ </listitem> |
+ </varlistentry> |
+ </variablelist> |
+ </refsect1> |
+ <refsect1 id="examples"> |
+ <title>Examples</title> |
+ <para> |
+<programlisting> |
+xdg-terminal |
+</programlisting> |
+ Opens the user's default terminal emulator, just starting an interactive shell. |
+ </para> |
+ <para> |
+<programlisting> |
+xdg-terminal top |
+</programlisting> |
+ Opens the user's default terminal emulator and lets it run the top executable. |
+ </para> |
+ </refsect1> |
+</refentry> |