OLD | NEW |
1 .\" ** You probably do not want to edit this file directly ** | 1 '\" t |
2 .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). | 2 .\" Title: xdg-email |
3 .\" Instead of manually editing it, you probably should edit the DocBook XML | 3 .\" Author: Kevin Krammer |
4 .\" source for it and then use the DocBook XSL Stylesheets to regenerate it. | 4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> |
5 .TH "XDG\-EMAIL" "1" "06/24/2007" "xdg\-utils 1.0" "" | 5 .\" Date: 12/31/2010 |
| 6 .\" Manual: xdg-email Manual |
| 7 .\" Source: xdg-utils 1.0 |
| 8 .\" Language: English |
| 9 .\" |
| 10 .TH "XDG\-EMAIL" "1" "12/31/2010" "xdg-utils 1.0" "xdg-email Manual" |
| 11 .\" ----------------------------------------------------------------- |
| 12 .\" * Define some portability stuff |
| 13 .\" ----------------------------------------------------------------- |
| 14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 15 .\" http://bugs.debian.org/507673 |
| 16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html |
| 17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 18 .ie \n(.g .ds Aq \(aq |
| 19 .el .ds Aq ' |
| 20 .\" ----------------------------------------------------------------- |
| 21 .\" * set default formatting |
| 22 .\" ----------------------------------------------------------------- |
6 .\" disable hyphenation | 23 .\" disable hyphenation |
7 .nh | 24 .nh |
8 .\" disable justification (adjust text to left margin only) | 25 .\" disable justification (adjust text to left margin only) |
9 .ad l | 26 .ad l |
| 27 .\" ----------------------------------------------------------------- |
| 28 .\" * MAIN CONTENT STARTS HERE * |
| 29 .\" ----------------------------------------------------------------- |
10 .SH "NAME" | 30 .SH "NAME" |
11 xdg\-email \- command line tool for sending mail using the user's preferred e\-m
ail composer | 31 xdg-email \- command line tool for sending mail using the user\*(Aqs preferred e
\-mail composer |
12 .SH "SYNOPSIS" | 32 .SH "SYNOPSIS" |
13 .HP 10 | 33 .HP \w'\fBxdg\-email\fR\ 'u |
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] | 34 \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 | 35 .HP \w'\fBxdg\-email\fR\ 'u |
16 \fBxdg\-email\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} | 36 \fBxdg\-email\fR {\fB\-\-help\fR | \fB\-\-manual\fR | \fB\-\-version\fR} |
17 .SH "DESCRIPTION" | 37 .SH "DESCRIPTION" |
18 .PP | 38 .PP |
19 xdg\-email opens the user's preferred e\-mail composer in order to send a mail t
o | 39 xdg\-email opens the user\*(Aqs preferred e\-mail composer in order to send a ma
il to |
20 \fIaddress(es)\fR | 40 \fIaddress(es)\fR |
21 or | 41 or |
22 \fImailto\-uri\fR. RFC2368 defines mailto: URIs. xdg\-email limits support to, c
c, subject and body fields in | 42 \fImailto\-uri\fR\&. RFC2368 defines mailto: URIs\&. xdg\-email limits support t
o, cc, subject and body fields in |
23 \fImailto\-uri\fR, all other fields are silently ignored. | 43 \fImailto\-uri\fR, all other fields are silently ignored\&. |
24 \fIaddress(es)\fR | 44 \fIaddress(es)\fR |
25 must follow the syntax of RFC822. Multiple addresses may be provided as separate
arguments. | 45 must follow the syntax of RFC822\&. Multiple addresses may be provided as separa
te arguments\&. |
26 .PP | 46 .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. | 47 All information provided on the command line is used to prefill corresponding fi
elds in the user\*(Aqs e\-mail composer\&. The user will have the opportunity to
change any of this information before actually sending the e\-mail\&. |
28 .PP | 48 .PP |
29 xdg\-email is for use inside a desktop session only. It is not recommended to us
e xdg\-email as root. | 49 xdg\-email is for use inside a desktop session only\&. It is not recommended to
use xdg\-email as root\&. |
30 .PP | 50 .PP |
31 See http://portland.freedesktop.org/EmailConfig for information on how the user
can change the e\-mail composer that is used. | 51 See http://portland\&.freedesktop\&.org/EmailConfig for information on how the u
ser can change the e\-mail composer that is used\&. |
32 .SH "OPTIONS" | 52 .SH "OPTIONS" |
33 .TP | 53 .PP |
34 \fB\-\-utf8\fR | 54 \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. | 55 .RS 4 |
36 .TP | 56 Indicates that all command line options that follow are in utf8\&. Without this
option, command line options are expected to be encoded according to locale\&. I
f the locale already specifies utf8 this option has no effect\&. This option doe
s not affect mailto URIs that are passed on the command line\&. |
| 57 .RE |
| 58 .PP |
37 \fB\-\-cc\fR \fIaddress\fR | 59 \fB\-\-cc\fR \fIaddress\fR |
38 Specify a recipient to be copied on the e\-mail. | 60 .RS 4 |
39 .TP | 61 Specify a recipient to be copied on the e\-mail\&. |
| 62 .RE |
| 63 .PP |
40 \fB\-\-bcc\fR \fIaddress\fR | 64 \fB\-\-bcc\fR \fIaddress\fR |
41 Specify a recipient to be blindly copied on the e\-mail. | 65 .RS 4 |
42 .TP | 66 Specify a recipient to be blindly copied on the e\-mail\&. |
| 67 .RE |
| 68 .PP |
43 \fB\-\-subject\fR \fItext\fR | 69 \fB\-\-subject\fR \fItext\fR |
44 Specify a subject for the e\-mail. | 70 .RS 4 |
45 .TP | 71 Specify a subject for the e\-mail\&. |
| 72 .RE |
| 73 .PP |
46 \fB\-\-body\fR \fItext\fR | 74 \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. | 75 .RS 4 |
| 76 Specify a body for the e\-mail\&. Since the user will be able to make changes be
fore actually sending the e\-mail, this can be used to provide the user with a t
emplate for the e\-mail\&. |
48 \fItext\fR | 77 \fItext\fR |
49 may contain linebreaks. | 78 may contain linebreaks\&. |
50 .TP | 79 .RE |
| 80 .PP |
51 \fB\-\-attach\fR \fIfile\fR | 81 \fB\-\-attach\fR \fIfile\fR |
52 Specify an attachment for the e\-mail. | 82 .RS 4 |
| 83 Specify an attachment for the e\-mail\&. |
53 \fIfile\fR | 84 \fIfile\fR |
54 must point to an existing file. | 85 must point to an existing file\&. |
55 .sp | 86 .sp |
56 Some e\-mail applications require the file to remain present after xdg\-email re
turns. | 87 Some e\-mail applications require the file to remain present after xdg\-email re
turns\&. |
57 .TP | 88 .RE |
| 89 .PP |
58 \fB\-\-help\fR | 90 \fB\-\-help\fR |
59 Show command synopsis. | 91 .RS 4 |
60 .TP | 92 Show command synopsis\&. |
| 93 .RE |
| 94 .PP |
61 \fB\-\-manual\fR | 95 \fB\-\-manual\fR |
62 Show this manualpage. | 96 .RS 4 |
63 .TP | 97 Show this manualpage\&. |
| 98 .RE |
| 99 .PP |
64 \fB\-\-version\fR | 100 \fB\-\-version\fR |
65 Show the xdg\-utils version information. | 101 .RS 4 |
| 102 Show the xdg\-utils version information\&. |
| 103 .RE |
66 .SH "ENVIRONMENT VARIABLES" | 104 .SH "ENVIRONMENT VARIABLES" |
67 .PP | 105 .PP |
68 xdg\-email honours the following environment variables: | 106 xdg\-email honours the following environment variables: |
69 .TP | 107 .PP |
70 XDG_UTILS_DEBUG_LEVEL | 108 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. | 109 .RS 4 |
| 110 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 ve
rbosity\&. |
| 111 .RE |
72 .SH "EXIT CODES" | 112 .SH "EXIT CODES" |
73 .PP | 113 .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: | 114 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 | 115 .PP |
76 \fB1\fR | 116 \fB1\fR |
77 Error in command line syntax. | 117 .RS 4 |
78 .TP | 118 Error in command line syntax\&. |
| 119 .RE |
| 120 .PP |
79 \fB2\fR | 121 \fB2\fR |
80 One of the files passed on the command line did not exist. | 122 .RS 4 |
81 .TP | 123 One of the files passed on the command line did not exist\&. |
| 124 .RE |
| 125 .PP |
82 \fB3\fR | 126 \fB3\fR |
83 A required tool could not be found. | 127 .RS 4 |
84 .TP | 128 A required tool could not be found\&. |
| 129 .RE |
| 130 .PP |
85 \fB4\fR | 131 \fB4\fR |
86 The action failed. | 132 .RS 4 |
87 .TP | 133 The action failed\&. |
| 134 .RE |
| 135 .PP |
88 \fB5\fR | 136 \fB5\fR |
89 No permission to read one of the files passed on the command line. | 137 .RS 4 |
| 138 No permission to read one of the files passed on the command line\&. |
| 139 .RE |
90 .SH "CONFIGURATION" | 140 .SH "CONFIGURATION" |
91 .PP | 141 .PP |
92 Visit http://portland.freedesktop.org/EmailConfig for information how to configu
re xdg\-email to use the email client of your choice. | 142 Visit http://portland\&.freedesktop\&.org/EmailConfig for information how to con
figure xdg\-email to use the email client of your choice\&. |
93 .SH "EXAMPLES" | 143 .SH "EXAMPLES" |
94 .PP | 144 .PP |
| 145 |
| 146 .sp |
| 147 .if n \{\ |
| 148 .RS 4 |
| 149 .\} |
95 .nf | 150 .nf |
96 xdg\-email 'Jeremy White <jwhite@example.com>' | 151 xdg\-email \*(AqJeremy White <jwhite@example\&.com>\*(Aq |
97 .fi | 152 .fi |
| 153 .if n \{\ |
| 154 .RE |
| 155 .\} |
| 156 .PP |
| 157 |
98 .sp | 158 .sp |
| 159 .if n \{\ |
| 160 .RS 4 |
| 161 .\} |
| 162 .nf |
| 163 xdg\-email \-\-attach /tmp/logo\&.png \e |
| 164 \-\-subject \*(AqLogo contest\*(Aq \e |
| 165 \-\-body \*(AqAttached you find the logo for the contest\&.\*(Aq \e |
| 166 \*(Aqjwhite@example\&.com\*(Aq |
| 167 .fi |
| 168 .if n \{\ |
| 169 .RE |
| 170 .\} |
99 .PP | 171 .PP |
| 172 |
| 173 .sp |
| 174 .if n \{\ |
| 175 .RS 4 |
| 176 .\} |
100 .nf | 177 .nf |
101 xdg\-email \-\-attach /tmp/logo.png \\ | 178 xdg\-email \-\-subject \*(AqYour password is about to expire\*(Aq \e |
102 \-\-subject 'Logo contest' \\ | 179 \*(Aqjwhite@example\&.com\*(Aq \*(Aqbastian@example\&.com\*(Aq \*(Aqwh
ipple@example\&.com\*(Aq |
103 \-\-body 'Attached you find the logo for the contest.' \\ | |
104 'jwhite@example.com' | |
105 .fi | 180 .fi |
| 181 .if n \{\ |
| 182 .RE |
| 183 .\} |
106 .sp | 184 .sp |
| 185 .SH "AUTHORS" |
107 .PP | 186 .PP |
108 .nf | 187 \fBKevin Krammer\fR |
109 xdg\-email \-\-subject 'Your password is about to expire' \\ | 188 .RS 4 |
110 'jwhite@example.com' 'bastian@example.com' 'whipple@example.com' | 189 Author. |
111 .fi | 190 .RE |
112 .sp | 191 .PP |
113 .SH "AUTHOR" | 192 \fBJeremy White\fR |
114 Kevin Krammer, Jeremy White. | 193 .RS 4 |
| 194 Author. |
| 195 .RE |
| 196 .SH "COPYRIGHT" |
115 .br | 197 .br |
116 <kevin.krammer@gmx.at> | 198 Copyright \(co 2006 |
117 .br | 199 .br |
118 <jwhite@codeweavers.com> | |
OLD | NEW |