OLD | NEW |
(Empty) | |
| 1 <?xml version="1.0"?> |
| 2 <?xml-stylesheet type="text/xsl" |
| 3 href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl
"?> |
| 4 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" |
| 5 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ |
| 6 ]> |
| 7 <refentry id="xdg-terminal"> |
| 8 <refentryinfo> |
| 9 <title>xdg-terminal Manual</title> |
| 10 <copyright> |
| 11 <year>2006</year> |
| 12 </copyright> |
| 13 <author> |
| 14 <firstname>Kevin</firstname> |
| 15 <surname>Krammer</surname> |
| 16 </author> |
| 17 <address><email>kevin.krammer@gmx.at</email></address> |
| 18 <releaseinfo>xdg-terminal Technology Preview</releaseinfo> |
| 19 </refentryinfo> |
| 20 |
| 21 <refmeta> |
| 22 <refentrytitle>xdg-terminal</refentrytitle> |
| 23 <manvolnum>1</manvolnum> |
| 24 </refmeta> |
| 25 |
| 26 <refnamediv> |
| 27 <refname>xdg-terminal</refname> |
| 28 <refpurpose>opens the user's preferred terminal emulator application</refpur
pose> |
| 29 </refnamediv> |
| 30 |
| 31 <refsynopsisdiv> |
| 32 <cmdsynopsis> |
| 33 <command>xdg-terminal</command> |
| 34 <arg choice="opt"><option><replaceable>command</replaceable></option></a
rg> |
| 35 </cmdsynopsis> |
| 36 <cmdsynopsis> |
| 37 <command>xdg-terminal</command> |
| 38 <group choice="req"> |
| 39 <arg choice="plain"><option>--help</option></arg> |
| 40 <arg choice="plain"><option>--manual</option></arg> |
| 41 <arg choice="plain"><option>--version</option></arg> |
| 42 </group> |
| 43 </cmdsynopsis> |
| 44 </refsynopsisdiv> |
| 45 |
| 46 <refsect1 id="description"> |
| 47 <title>Description</title> |
| 48 <para> |
| 49 xdg-terminal opens the user's preferred terminal emulator application. |
| 50 If a command is provided the command will be executed by the shell within |
| 51 the newly opened terminal window. |
| 52 </para> |
| 53 <para> |
| 54 xdg-terminal is for use inside a desktop session only. |
| 55 It is not recommended to use xdg-terminal as root. |
| 56 </para> |
| 57 </refsect1> |
| 58 <refsect1 id="options"> |
| 59 <title>Options</title> |
| 60 <variablelist> |
| 61 <varlistentry> |
| 62 <term><option>--help</option></term> |
| 63 <listitem> |
| 64 <simpara> |
| 65 Show command synopsis. |
| 66 </simpara> |
| 67 </listitem> |
| 68 </varlistentry> |
| 69 |
| 70 <varlistentry> |
| 71 <term><option>--manual</option></term> |
| 72 <listitem> |
| 73 <simpara> |
| 74 Show this manualpage. |
| 75 </simpara> |
| 76 </listitem> |
| 77 </varlistentry> |
| 78 |
| 79 <varlistentry> |
| 80 <term><option>--version</option></term> |
| 81 <listitem> |
| 82 <simpara> |
| 83 Show the xdg-utils version information. |
| 84 </simpara> |
| 85 </listitem> |
| 86 </varlistentry> |
| 87 </variablelist> |
| 88 </refsect1> |
| 89 <refsect1 id="exitcodes"> |
| 90 <title>Exit Codes</title> |
| 91 <para> |
| 92 An exit code of 0 indicates success while a non-zero exit code |
| 93 indicates failure. The following failure codes can be returned: |
| 94 </para> |
| 95 <variablelist> |
| 96 <varlistentry> |
| 97 <term><option>1</option></term> |
| 98 <listitem> |
| 99 <simpara> |
| 100 Error in command line syntax. |
| 101 </simpara> |
| 102 </listitem> |
| 103 </varlistentry> |
| 104 <varlistentry> |
| 105 <term><option>3</option></term> |
| 106 <listitem> |
| 107 <simpara> |
| 108 A required tool could not be found. |
| 109 </simpara> |
| 110 </listitem> |
| 111 </varlistentry> |
| 112 <varlistentry> |
| 113 <term><option>4</option></term> |
| 114 <listitem> |
| 115 <simpara> |
| 116 The action failed. |
| 117 </simpara> |
| 118 </listitem> |
| 119 </varlistentry> |
| 120 </variablelist> |
| 121 </refsect1> |
| 122 <refsect1 id="examples"> |
| 123 <title>Examples</title> |
| 124 <para> |
| 125 <programlisting> |
| 126 xdg-terminal |
| 127 </programlisting> |
| 128 Opens the user's default terminal emulator, just starting an interactive s
hell. |
| 129 </para> |
| 130 <para> |
| 131 <programlisting> |
| 132 xdg-terminal top |
| 133 </programlisting> |
| 134 Opens the user's default terminal emulator and lets it run the top executa
ble. |
| 135 </para> |
| 136 </refsect1> |
| 137 </refentry> |
OLD | NEW |