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-file-dialog"> |
| 8 <refentryinfo> |
| 9 <title>xdg-file-dialog 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>This is release 0.5 of the xdg-mime Manual.</releaseinfo> |
| 19 </refentryinfo> |
| 20 |
| 21 <refmeta> |
| 22 <refentrytitle>xdg-file-dialog</refentrytitle> |
| 23 <manvolnum>1</manvolnum> |
| 24 </refmeta> |
| 25 |
| 26 <refnamediv> |
| 27 <refname>xdg-file-dialog</refname> |
| 28 <refpurpose>command line tool for providing file and directory selection dia
logs</refpurpose> |
| 29 </refnamediv> |
| 30 |
| 31 <refsynopsisdiv> |
| 32 <cmdsynopsis> |
| 33 <command>xdg-file-dialog</command> |
| 34 <arg choice="plain">openfilename</arg> |
| 35 <arg><option>--title <replaceable>TITLE</replaceable></option></arg> |
| 36 <arg><replaceable>FILENAME</replaceable></arg> |
| 37 </cmdsynopsis> |
| 38 <cmdsynopsis> |
| 39 <command>xdg-file-dialog</command> |
| 40 <arg choice="plain">openfilenamelist</arg> |
| 41 <arg><option>--title <replaceable>TITLE</replaceable></option></arg> |
| 42 <arg><replaceable>FILENAME</replaceable></arg> |
| 43 </cmdsynopsis> |
| 44 <cmdsynopsis> |
| 45 <command>xdg-file-dialog</command> |
| 46 <arg choice="plain">savefilename</arg> |
| 47 <arg><option>--title <replaceable>TITLE</replaceable></option></arg> |
| 48 <arg><replaceable>FILENAME</replaceable></arg> |
| 49 </cmdsynopsis> |
| 50 <cmdsynopsis> |
| 51 <command>xdg-file-dialog</command> |
| 52 <arg choice="plain">directory</arg> |
| 53 <arg><option>--title <replaceable>TITLE</replaceable></option></arg> |
| 54 <arg><replaceable>DIRNAME</replaceable></arg> |
| 55 </cmdsynopsis> |
| 56 <cmdsynopsis> |
| 57 <command>xdg-file-dialog</command> |
| 58 <group choice="req"> |
| 59 <arg choice="plain"><option>--help</option></arg> |
| 60 <arg choice="plain"><option>--manual</option></arg> |
| 61 <arg choice="plain"><option>--version</option></arg> |
| 62 </group> |
| 63 </cmdsynopsis> |
| 64 </refsynopsisdiv> |
| 65 |
| 66 <refsect1 id="description"> |
| 67 <title>Description</title> |
| 68 <para> |
| 69 The xdg-file-dialog program can be used to let the native file selection d
ialog |
| 70 handle file and directory input. |
| 71 </para> |
| 72 <para> |
| 73 xdg-file-dialog is for use inside a desktop session only. |
| 74 It is not recommended to use xdg-file-dialog as root. |
| 75 </para> |
| 76 </refsect1> |
| 77 <refsect1 id="commands"> |
| 78 <title>Commands</title> |
| 79 <variablelist> |
| 80 <varlistentry> |
| 81 <term>openfilename</term> |
| 82 <listitem> |
| 83 <simpara> |
| 84 Returns the filename with path for a file to read from. |
| 85 <replaceable>FILENAME</replaceable> can optionally be used to |
| 86 specify path and filename of a preselection. |
| 87 </simpara> |
| 88 </listitem> |
| 89 </varlistentry> |
| 90 |
| 91 <varlistentry> |
| 92 <term>openfilenamelist</term> |
| 93 <listitem> |
| 94 <simpara> |
| 95 Returns one or more filenames with path for files to read from, |
| 96 each on a new line. <replaceable>FILENAME</replaceable> can optional
ly |
| 97 be used to specify path and filename of a preselection. |
| 98 </simpara> |
| 99 </listitem> |
| 100 </varlistentry> |
| 101 |
| 102 <varlistentry> |
| 103 <term>savefilename</term> |
| 104 <listitem> |
| 105 <simpara> |
| 106 Returns the filename with path for file to write to. |
| 107 <replaceable>FILENAME</replaceable> can optionally be used to |
| 108 specify path and filename of a preselection. |
| 109 </simpara> |
| 110 </listitem> |
| 111 </varlistentry> |
| 112 |
| 113 <varlistentry> |
| 114 <term>directory</term> |
| 115 <listitem> |
| 116 <simpara> |
| 117 Returns the path for an exsiting directory. |
| 118 <replaceable>DIRNAME</replaceable> can optionally be used to |
| 119 specify a path of a preselection. |
| 120 </simpara> |
| 121 </listitem> |
| 122 </varlistentry> |
| 123 </variablelist> |
| 124 </refsect1> |
| 125 <refsect1 id="options"> |
| 126 <title>Options</title> |
| 127 <variablelist> |
| 128 <varlistentry> |
| 129 <term><option>--title</option> <replaceable>TITLE</replaceable></term> |
| 130 <listitem> |
| 131 <simpara> |
| 132 Sets the dialog's title (caption) to the specified text. |
| 133 </simpara> |
| 134 </listitem> |
| 135 </varlistentry> |
| 136 |
| 137 <varlistentry> |
| 138 <term><option>--help</option></term> |
| 139 <listitem> |
| 140 <simpara> |
| 141 Show command synopsis. |
| 142 </simpara> |
| 143 </listitem> |
| 144 </varlistentry> |
| 145 |
| 146 <varlistentry> |
| 147 <term><option>--manual</option></term> |
| 148 <listitem> |
| 149 <simpara> |
| 150 Show this manualpage. |
| 151 </simpara> |
| 152 </listitem> |
| 153 </varlistentry> |
| 154 |
| 155 <varlistentry> |
| 156 <term><option>--version</option></term> |
| 157 <listitem> |
| 158 <simpara> |
| 159 Show the xdg-utils version information. |
| 160 </simpara> |
| 161 </listitem> |
| 162 </varlistentry> |
| 163 |
| 164 </variablelist> |
| 165 </refsect1> |
| 166 <refsect1 id="exitcodes"> |
| 167 <title>Exit Codes</title> |
| 168 <para> |
| 169 An exit code of 0 indicates success while a non-zero exit code |
| 170 indicates failure. The following failure codes can be returned: |
| 171 </para> |
| 172 <variablelist> |
| 173 <varlistentry> |
| 174 <term><option>1</option></term> |
| 175 <listitem> |
| 176 <simpara> |
| 177 Error in command line syntax. |
| 178 </simpara> |
| 179 </listitem> |
| 180 </varlistentry> |
| 181 <varlistentry> |
| 182 <term><option>2</option></term> |
| 183 <listitem> |
| 184 <simpara> |
| 185 One of the files passed on the command line did not exist. |
| 186 </simpara> |
| 187 </listitem> |
| 188 </varlistentry> |
| 189 <varlistentry> |
| 190 <term><option>3</option></term> |
| 191 <listitem> |
| 192 <simpara> |
| 193 A required tool could not be found. |
| 194 </simpara> |
| 195 </listitem> |
| 196 </varlistentry> |
| 197 <varlistentry> |
| 198 <term><option>4</option></term> |
| 199 <listitem> |
| 200 <simpara> |
| 201 The action failed. |
| 202 </simpara> |
| 203 </listitem> |
| 204 </varlistentry> |
| 205 </variablelist> |
| 206 </refsect1> |
| 207 <refsect1 id="examples"> |
| 208 <title>Examples</title> |
| 209 <para> |
| 210 <programlisting> |
| 211 xdg-file-dialog savefilename /tmp/foobar.png |
| 212 </programlisting> |
| 213 Asks for a save file name starting in directory /tmp and suggesting foobar
.png as the filename |
| 214 </para> |
| 215 <para> |
| 216 <programlisting> |
| 217 xdg-file-dialog directory --title "Select a target folder" /tmp |
| 218 </programlisting> |
| 219 Asks for a directory name starting in directory /tmp using the text "Selec
t a target folder" as the dialog's title/caption. |
| 220 </para> |
| 221 </refsect1> |
| 222 </refentry> |
OLD | NEW |