| OLD | NEW |
|---|
| (Empty) | |
| 1 .\" ** You probably do not want to edit this file directly ** |
| 2 .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). |
| 3 .\" Instead of manually editing it, you probably should edit the DocBook XML |
| 4 .\" source for it and then use the DocBook XSL Stylesheets to regenerate it. |
| 5 .TH "XDG\-EMAIL" "1" "06/24/2007" "xdg\-utils 1.0" "" |
| 6 .\" disable hyphenation |
| 7 .nh |
| 8 .\" disable justification (adjust text to left margin only) |
| 9 .ad l |
| 10 .SH "NAME" |
| 11 xdg\-email \- command line tool for sending mail using the user's preferred e\-m
ail composer |
| 12 .SH "SYNOPSIS" |
| 13 .HP 10 |
| 14 \fBxdg\-email\fR [\fB\-\-utf8\fR] [\fB\-\-cc\fR\ \fIaddress\fR] [\fB\-\-bcc\fR\
\fIaddress\fR] [\fB\-\-subject\fR\ \fItext\fR] [\fB\-\-body\fR\ \fItext\fR] [\fB
\-\-attach\fR\ \fIfile\fR] [\fImailto\-uri\fR \fIaddress(es)\fR] |
| 15 .HP 10 |
| 16 \fBxdg\-email\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} |
| 17 .SH "DESCRIPTION" |
| 18 .PP |
| 19 xdg\-email opens the user's preferred e\-mail composer in order to send a mail t
o |
| 20 \fIaddress(es)\fR |
| 21 or |
| 22 \fImailto\-uri\fR. RFC2368 defines mailto: URIs. xdg\-email limits support to, c
c, subject and body fields in |
| 23 \fImailto\-uri\fR, all other fields are silently ignored. |
| 24 \fIaddress(es)\fR |
| 25 must follow the syntax of RFC822. Multiple addresses may be provided as separate
arguments. |
| 26 .PP |
| 27 All information provided on the command line is used to prefill corresponding fi
elds in the user's e\-mail composer. The user will have the opportunity to chang
e any of this information before actually sending the e\-mail. |
| 28 .PP |
| 29 xdg\-email is for use inside a desktop session only. It is not recommended to us
e xdg\-email as root. |
| 30 .PP |
| 31 See http://portland.freedesktop.org/EmailConfig for information on how the user
can change the e\-mail composer that is used. |
| 32 .SH "OPTIONS" |
| 33 .TP |
| 34 \fB\-\-utf8\fR |
| 35 Indicates that all command line options that follow are in utf8. Without this op
tion, command line options are expected to be encoded according to locale. If th
e locale already specifies utf8 this option has no effect. This option does not
affect mailto URIs that are passed on the command line. |
| 36 .TP |
| 37 \fB\-\-cc\fR \fIaddress\fR |
| 38 Specify a recipient to be copied on the e\-mail. |
| 39 .TP |
| 40 \fB\-\-bcc\fR \fIaddress\fR |
| 41 Specify a recipient to be blindly copied on the e\-mail. |
| 42 .TP |
| 43 \fB\-\-subject\fR \fItext\fR |
| 44 Specify a subject for the e\-mail. |
| 45 .TP |
| 46 \fB\-\-body\fR \fItext\fR |
| 47 Specify a body for the e\-mail. Since the user will be able to make changes befo
re actually sending the e\-mail, this can be used to provide the user with a tem
plate for the e\-mail. |
| 48 \fItext\fR |
| 49 may contain linebreaks. |
| 50 .TP |
| 51 \fB\-\-attach\fR \fIfile\fR |
| 52 Specify an attachment for the e\-mail. |
| 53 \fIfile\fR |
| 54 must point to an existing file. |
| 55 .sp |
| 56 Some e\-mail applications require the file to remain present after xdg\-email re
turns. |
| 57 .TP |
| 58 \fB\-\-help\fR |
| 59 Show command synopsis. |
| 60 .TP |
| 61 \fB\-\-manual\fR |
| 62 Show this manualpage. |
| 63 .TP |
| 64 \fB\-\-version\fR |
| 65 Show the xdg\-utils version information. |
| 66 .SH "ENVIRONMENT VARIABLES" |
| 67 .PP |
| 68 xdg\-email honours the following environment variables: |
| 69 .TP |
| 70 XDG_UTILS_DEBUG_LEVEL |
| 71 Setting this environment variable to a non\-zero numerical value makes xdg\-emai
l do more verbose reporting on stderr. Setting a higher value increases the verb
osity. |
| 72 .SH "EXIT CODES" |
| 73 .PP |
| 74 An exit code of 0 indicates success while a non\-zero exit code indicates failur
e. The following failure codes can be returned: |
| 75 .TP |
| 76 \fB1\fR |
| 77 Error in command line syntax. |
| 78 .TP |
| 79 \fB2\fR |
| 80 One of the files passed on the command line did not exist. |
| 81 .TP |
| 82 \fB3\fR |
| 83 A required tool could not be found. |
| 84 .TP |
| 85 \fB4\fR |
| 86 The action failed. |
| 87 .TP |
| 88 \fB5\fR |
| 89 No permission to read one of the files passed on the command line. |
| 90 .SH "CONFIGURATION" |
| 91 .PP |
| 92 Visit http://portland.freedesktop.org/EmailConfig for information how to configu
re xdg\-email to use the email client of your choice. |
| 93 .SH "EXAMPLES" |
| 94 .PP |
| 95 .nf |
| 96 xdg\-email 'Jeremy White <jwhite@example.com>' |
| 97 .fi |
| 98 .sp |
| 99 .PP |
| 100 .nf |
| 101 xdg\-email \-\-attach /tmp/logo.png \\ |
| 102 \-\-subject 'Logo contest' \\ |
| 103 \-\-body 'Attached you find the logo for the contest.' \\ |
| 104 'jwhite@example.com' |
| 105 .fi |
| 106 .sp |
| 107 .PP |
| 108 .nf |
| 109 xdg\-email \-\-subject 'Your password is about to expire' \\ |
| 110 'jwhite@example.com' 'bastian@example.com' 'whipple@example.com' |
| 111 .fi |
| 112 .sp |
| 113 .SH "AUTHOR" |
| 114 Kevin Krammer, Jeremy White. |
| 115 .br |
| 116 <kevin.krammer@gmx.at> |
| 117 .br |
| 118 <jwhite@codeweavers.com> |
| OLD | NEW |
|---|
Chromium Code Reviews
