| 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-email"> |
| 8 <refentryinfo> |
| 9 <title>xdg-email 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-email</refentrytitle> |
| 28 <manvolnum>1</manvolnum> |
| 29 </refmeta> |
| 30 |
| 31 <refnamediv> |
| 32 <refname>xdg-email</refname> |
| 33 <refpurpose>command line tool for sending mail using the user's preferred e-
mail composer</refpurpose> |
| 34 </refnamediv> |
| 35 |
| 36 <refsynopsisdiv> |
| 37 <cmdsynopsis> |
| 38 <command>xdg-email</command> |
| 39 <arg><option>--utf8</option></arg> |
| 40 <arg><option>--cc</option> <replaceable>address</replaceable></arg> |
| 41 <arg><option>--bcc</option> <replaceable>address</replaceable></arg> |
| 42 <arg><option>--subject</option> <replaceable>text</replaceable></arg> |
| 43 <arg><option>--body</option> <replaceable>text</replaceable></arg> |
| 44 <arg><option>--attach</option> <replaceable>file</replaceable></arg> |
| 45 <group choice="opt"> |
| 46 <arg choice="plain"><replaceable>mailto-uri</replaceable></arg> |
| 47 <arg choice="plain"><replaceable>address(es)</replaceable></arg> |
| 48 </group> |
| 49 </cmdsynopsis> |
| 50 <cmdsynopsis> |
| 51 <command>xdg-email</command> |
| 52 <group choice="req"> |
| 53 <arg choice="plain"><option>--help</option></arg> |
| 54 <arg choice="plain"><option>--manual</option></arg> |
| 55 <arg choice="plain"><option>--version</option></arg> |
| 56 </group> |
| 57 </cmdsynopsis> |
| 58 </refsynopsisdiv> |
| 59 |
| 60 <refsect1 id="description"> |
| 61 <title>Description</title> |
| 62 <para> |
| 63 xdg-email opens the user's preferred e-mail composer in order to send |
| 64 a mail to <replaceable>address(es)</replaceable> or |
| 65 <replaceable>mailto-uri</replaceable>. RFC2368 defines mailto: |
| 66 URIs. xdg-email limits support to, cc, subject and body fields in |
| 67 <replaceable>mailto-uri</replaceable>, all other fields are silently |
| 68 ignored. <replaceable>address(es)</replaceable> must follow the |
| 69 syntax of RFC822. Multiple addresses may be provided as |
| 70 separate arguments. |
| 71 </para> |
| 72 <para> |
| 73 All information provided on the command line is used to |
| 74 prefill corresponding fields in the user's e-mail composer. The user |
| 75 will have the opportunity to change any of this information before |
| 76 actually sending the e-mail. |
| 77 </para> |
| 78 <para> |
| 79 xdg-email is for use inside a desktop session only. |
| 80 It is not recommended to use xdg-email as root. |
| 81 </para> |
| 82 <para> |
| 83 See http://portland.freedesktop.org/EmailConfig for information on |
| 84 how the user can change the e-mail composer that is used. |
| 85 </para> |
| 86 </refsect1> |
| 87 <refsect1 id="options"> |
| 88 <title>Options</title> |
| 89 <variablelist> |
| 90 <varlistentry> |
| 91 <term><option>--utf8</option></term> |
| 92 <listitem> |
| 93 <simpara> |
| 94 Indicates that all command line options that follow are in utf8. |
| 95 Without this option, command line options are expected to be |
| 96 encoded according to locale. |
| 97 If the locale already specifies utf8 this option has no effect. |
| 98 This option does not affect mailto URIs that are passed on the |
| 99 command line. |
| 100 </simpara> |
| 101 </listitem> |
| 102 </varlistentry> |
| 103 |
| 104 <varlistentry> |
| 105 <term><option>--cc</option> <replaceable>address</replaceable></term> |
| 106 <listitem> |
| 107 <simpara> |
| 108 Specify a recipient to be copied on the e-mail. |
| 109 </simpara> |
| 110 </listitem> |
| 111 </varlistentry> |
| 112 |
| 113 <varlistentry> |
| 114 <term><option>--bcc</option> <replaceable>address</replaceable></term> |
| 115 <listitem> |
| 116 <simpara> |
| 117 Specify a recipient to be blindly copied on the e-mail. |
| 118 </simpara> |
| 119 </listitem> |
| 120 </varlistentry> |
| 121 |
| 122 <varlistentry> |
| 123 <term><option>--subject</option> <replaceable>text</replaceable></term> |
| 124 <listitem> |
| 125 <simpara> |
| 126 Specify a subject for the e-mail. |
| 127 </simpara> |
| 128 </listitem> |
| 129 </varlistentry> |
| 130 |
| 131 <varlistentry> |
| 132 <term><option>--body</option> <replaceable>text</replaceable></term> |
| 133 <listitem> |
| 134 <simpara> |
| 135 Specify a body for the e-mail. Since the user will be able to |
| 136 make changes before actually sending the e-mail, this can be |
| 137 used to provide the user with a template for the e-mail. |
| 138 <replaceable>text</replaceable> may contain linebreaks. |
| 139 </simpara> |
| 140 </listitem> |
| 141 </varlistentry> |
| 142 |
| 143 <varlistentry> |
| 144 <term><option>--attach</option> <replaceable>file</replaceable></term> |
| 145 <listitem> |
| 146 <simpara> |
| 147 Specify an attachment for the e-mail. <replaceable>file</replaceable
> |
| 148 must point to an existing file. |
| 149 </simpara> |
| 150 <simpara> |
| 151 Some e-mail applications require the file to remain present |
| 152 after xdg-email returns. |
| 153 </simpara> |
| 154 </listitem> |
| 155 </varlistentry> |
| 156 |
| 157 <varlistentry> |
| 158 <term><option>--help</option></term> |
| 159 <listitem> |
| 160 <simpara> |
| 161 Show command synopsis. |
| 162 </simpara> |
| 163 </listitem> |
| 164 </varlistentry> |
| 165 |
| 166 <varlistentry> |
| 167 <term><option>--manual</option></term> |
| 168 <listitem> |
| 169 <simpara> |
| 170 Show this manualpage. |
| 171 </simpara> |
| 172 </listitem> |
| 173 </varlistentry> |
| 174 |
| 175 <varlistentry> |
| 176 <term><option>--version</option></term> |
| 177 <listitem> |
| 178 <simpara> |
| 179 Show the xdg-utils version information. |
| 180 </simpara> |
| 181 </listitem> |
| 182 </varlistentry> |
| 183 </variablelist> |
| 184 </refsect1> |
| 185 <refsect1 id="env_vars"> |
| 186 <title>Environment Variables</title> |
| 187 <para> |
| 188 xdg-email honours the following environment variables: |
| 189 </para> |
| 190 <variablelist> |
| 191 <varlistentry> |
| 192 <term>XDG_UTILS_DEBUG_LEVEL</term> |
| 193 <listitem> |
| 194 <simpara> |
| 195 Setting this environment variable to a non-zero numerical value |
| 196 makes xdg-email do more verbose reporting on stderr. |
| 197 Setting a higher value increases the verbosity. |
| 198 </simpara> |
| 199 </listitem> |
| 200 </varlistentry> |
| 201 </variablelist> |
| 202 </refsect1> |
| 203 <refsect1 id="exitcodes"> |
| 204 <title>Exit Codes</title> |
| 205 <para> |
| 206 An exit code of 0 indicates success while a non-zero exit code |
| 207 indicates failure. The following failure codes can be returned: |
| 208 </para> |
| 209 <variablelist> |
| 210 <varlistentry> |
| 211 <term><option>1</option></term> |
| 212 <listitem> |
| 213 <simpara> |
| 214 Error in command line syntax. |
| 215 </simpara> |
| 216 </listitem> |
| 217 </varlistentry> |
| 218 <varlistentry> |
| 219 <term><option>2</option></term> |
| 220 <listitem> |
| 221 <simpara> |
| 222 One of the files passed on the command line did not exist. |
| 223 </simpara> |
| 224 </listitem> |
| 225 </varlistentry> |
| 226 <varlistentry> |
| 227 <term><option>3</option></term> |
| 228 <listitem> |
| 229 <simpara> |
| 230 A required tool could not be found. |
| 231 </simpara> |
| 232 </listitem> |
| 233 </varlistentry> |
| 234 <varlistentry> |
| 235 <term><option>4</option></term> |
| 236 <listitem> |
| 237 <simpara> |
| 238 The action failed. |
| 239 </simpara> |
| 240 </listitem> |
| 241 </varlistentry> |
| 242 <varlistentry> |
| 243 <term><option>5</option></term> |
| 244 <listitem> |
| 245 <simpara> |
| 246 No permission to read one of the files passed on the command |
| 247 line. |
| 248 </simpara> |
| 249 </listitem> |
| 250 </varlistentry> |
| 251 </variablelist> |
| 252 </refsect1> |
| 253 <refsect1 id="configuration"> |
| 254 <title>Configuration</title> |
| 255 <para>Visit http://portland.freedesktop.org/EmailConfig for information |
| 256 how to configure xdg-email to use the email client of your choice. |
| 257 </para> |
| 258 </refsect1> |
| 259 <refsect1 id="examples"> |
| 260 <title>Examples</title> |
| 261 <para> |
| 262 <programlisting> |
| 263 xdg-email 'Jeremy White <jwhite@example.com>' |
| 264 </programlisting> |
| 265 </para> |
| 266 <para> |
| 267 <programlisting> |
| 268 xdg-email --attach /tmp/logo.png \ |
| 269 --subject 'Logo contest' \ |
| 270 --body 'Attached you find the logo for the contest.' \ |
| 271 'jwhite@example.com' |
| 272 </programlisting> |
| 273 </para> |
| 274 <para> |
| 275 <programlisting> |
| 276 xdg-email --subject 'Your password is about to expire' \ |
| 277 'jwhite@example.com' 'bastian@example.com' 'whipple@example.com' |
| 278 </programlisting> |
| 279 </para> |
| 280 </refsect1> |
| 281 </refentry> |
| OLD | NEW |
|---|
Chromium Code Reviews
