blob: 24335002af2fb7422da38b3102beb7d463f2738d [file] [log] [blame]
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xdg-open</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="xdg-open"><a name="xdg-open"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-open &#8212; opens a file or URL in the user's preferred application</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xdg-open</code> { <code class="option"><em class="replaceable"><code>file</code></em></code> | <code class="option"><em class="replaceable"><code>URL</code></em></code> }</p></div><div class="cmdsynopsis"><p><code class="command">xdg-open</code> { <code class="option">--help</code> | <code class="option">--manual</code> | <code class="option">--version</code> }</p></div></div><div class="refsect1" title="Description"><a name="description"></a><h2>Description</h2><p>
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.
</p><p>
xdg-open is for use inside a desktop session only.
It is not recommended to use xdg-open as root.
</p></div><div class="refsect1" title="Options"><a name="options"></a><h2>Options</h2><div class="variablelist"><dl><dt><span class="term"><code class="option">--help</code></span></dt><dd>
Show command synopsis.
</dd><dt><span class="term"><code class="option">--manual</code></span></dt><dd>
Show this manualpage.
</dd><dt><span class="term"><code class="option">--version</code></span></dt><dd>
Show the xdg-utils version information.
</dd></dl></div></div><div class="refsect1" title="Exit Codes"><a name="exitcodes"></a><h2>Exit Codes</h2><p>
An exit code of 0 indicates success while a non-zero exit code
indicates failure. The following failure codes can be returned:
</p><div class="variablelist"><dl><dt><span class="term"><code class="option">1</code></span></dt><dd>
Error in command line syntax.
</dd><dt><span class="term"><code class="option">2</code></span></dt><dd>
One of the files passed on the command line did not exist.
</dd><dt><span class="term"><code class="option">3</code></span></dt><dd>
A required tool could not be found.
</dd><dt><span class="term"><code class="option">4</code></span></dt><dd>
The action failed.
</dd></dl></div></div><div class="refsect1" title="Examples"><a name="examples"></a><h2>Examples</h2><p>
</p><pre class="programlisting">
xdg-open 'http://www.freedesktop.org/'
</pre><p>
Opens the Freedesktop.org website in the user's default browser
</p><p>
</p><pre class="programlisting">
xdg-open /tmp/foobar.png
</pre><p>
Opens the PNG image file /tmp/foobar.png in the user's default image
viewing application.
</p></div></div></body></html>