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-open"> |
| 8 <refentryinfo> |
| 9 <title>xdg-open 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 <author> |
| 19 <firstname>Jeremy</firstname> |
| 20 <surname>White</surname> |
| 21 </author> |
| 22 <address><email>jwhite@codeweavers.com</email></address> |
| 23 <releaseinfo>xdg-utils 1.0</releaseinfo> |
| 24 </refentryinfo> |
| 25 |
| 26 <refmeta> |
| 27 <refentrytitle>xdg-open</refentrytitle> |
| 28 <manvolnum>1</manvolnum> |
| 29 </refmeta> |
| 30 |
| 31 <refnamediv> |
| 32 <refname>xdg-open</refname> |
| 33 <refpurpose>opens a file or URL in the user's preferred application</refpurp
ose> |
| 34 </refnamediv> |
| 35 |
| 36 <refsynopsisdiv> |
| 37 <cmdsynopsis> |
| 38 <command>xdg-open</command> |
| 39 <group choice="req"> |
| 40 <arg choice="plain"><option><replaceable>file</replaceable></option></ar
g> |
| 41 <arg choice="plain"><option><replaceable>URL</replaceable></option></arg
> |
| 42 </group> |
| 43 </cmdsynopsis> |
| 44 <cmdsynopsis> |
| 45 <command>xdg-open</command> |
| 46 <group choice="req"> |
| 47 <arg choice="plain"><option>--help</option></arg> |
| 48 <arg choice="plain"><option>--manual</option></arg> |
| 49 <arg choice="plain"><option>--version</option></arg> |
| 50 </group> |
| 51 </cmdsynopsis> |
| 52 </refsynopsisdiv> |
| 53 |
| 54 <refsect1 id="description"> |
| 55 <title>Description</title> |
| 56 <para> |
| 57 xdg-open opens a file or URL in the user's preferred application. |
| 58 If a URL is provided the URL will be opened in the user's preferred |
| 59 web browser. If a file is provided the file will be opened in the |
| 60 preferred application for files of that type. xdg-open supports |
| 61 file, ftp, http and https URLs. |
| 62 </para> |
| 63 <para> |
| 64 xdg-open is for use inside a desktop session only. |
| 65 It is not recommended to use xdg-open as root. |
| 66 </para> |
| 67 </refsect1> |
| 68 <refsect1 id="options"> |
| 69 <title>Options</title> |
| 70 <variablelist> |
| 71 <varlistentry> |
| 72 <term><option>--help</option></term> |
| 73 <listitem> |
| 74 <simpara> |
| 75 Show command synopsis. |
| 76 </simpara> |
| 77 </listitem> |
| 78 </varlistentry> |
| 79 |
| 80 <varlistentry> |
| 81 <term><option>--manual</option></term> |
| 82 <listitem> |
| 83 <simpara> |
| 84 Show this manualpage. |
| 85 </simpara> |
| 86 </listitem> |
| 87 </varlistentry> |
| 88 |
| 89 <varlistentry> |
| 90 <term><option>--version</option></term> |
| 91 <listitem> |
| 92 <simpara> |
| 93 Show the xdg-utils version information. |
| 94 </simpara> |
| 95 </listitem> |
| 96 </varlistentry> |
| 97 </variablelist> |
| 98 </refsect1> |
| 99 <refsect1 id="exitcodes"> |
| 100 <title>Exit Codes</title> |
| 101 <para> |
| 102 An exit code of 0 indicates success while a non-zero exit code |
| 103 indicates failure. The following failure codes can be returned: |
| 104 </para> |
| 105 <variablelist> |
| 106 <varlistentry> |
| 107 <term><option>1</option></term> |
| 108 <listitem> |
| 109 <simpara> |
| 110 Error in command line syntax. |
| 111 </simpara> |
| 112 </listitem> |
| 113 </varlistentry> |
| 114 <varlistentry> |
| 115 <term><option>2</option></term> |
| 116 <listitem> |
| 117 <simpara> |
| 118 One of the files passed on the command line did not exist. |
| 119 </simpara> |
| 120 </listitem> |
| 121 </varlistentry> |
| 122 <varlistentry> |
| 123 <term><option>3</option></term> |
| 124 <listitem> |
| 125 <simpara> |
| 126 A required tool could not be found. |
| 127 </simpara> |
| 128 </listitem> |
| 129 </varlistentry> |
| 130 <varlistentry> |
| 131 <term><option>4</option></term> |
| 132 <listitem> |
| 133 <simpara> |
| 134 The action failed. |
| 135 </simpara> |
| 136 </listitem> |
| 137 </varlistentry> |
| 138 </variablelist> |
| 139 </refsect1> |
| 140 <refsect1 id="examples"> |
| 141 <title>Examples</title> |
| 142 <para> |
| 143 <programlisting> |
| 144 xdg-open 'http://www.freedesktop.org/' |
| 145 </programlisting> |
| 146 Opens the Freedesktop.org website in the user's default browser |
| 147 </para> |
| 148 <para> |
| 149 <programlisting> |
| 150 xdg-open /tmp/foobar.png |
| 151 </programlisting> |
| 152 Opens the PNG image file /tmp/foobar.png in the user's default image |
| 153 viewing application. |
| 154 </para> |
| 155 </refsect1> |
| 156 </refentry> |
OLD | NEW |