diff options
| author | Richard M. Stallman | 2005-03-06 17:40:40 +0000 |
|---|---|---|
| committer | Richard M. Stallman | 2005-03-06 17:40:40 +0000 |
| commit | 1be48cfa6d9fc3a586c6646d49b886b6bfd58b65 (patch) | |
| tree | 563a6306b40cf18c38d33159daa7a9d0dfadbb20 | |
| parent | 7fb36547557d6f0071fdfccbdd794d3255451826 (diff) | |
| download | emacs-1be48cfa6d9fc3a586c6646d49b886b6bfd58b65.tar.gz emacs-1be48cfa6d9fc3a586c6646d49b886b6bfd58b65.zip | |
(Rmail Inbox): Move text from Remote Mailboxes that really belongs here.
(Remote Mailboxes): Text moved to Rmail Inbox.
(Rmail Display): Mention Mouse-1.
(Movemail): Clarify two movemail versions.
Clarify rmail-movemail-program.
| -rw-r--r-- | man/rmail.texi | 139 |
1 files changed, 69 insertions, 70 deletions
diff --git a/man/rmail.texi b/man/rmail.texi index 3cfa1802a88..ad72b94c3b2 100644 --- a/man/rmail.texi +++ b/man/rmail.texi | |||
| @@ -297,13 +297,14 @@ adding or removing this attribute. @xref{Rmail Attributes}. | |||
| 297 | @section Rmail Files and Inboxes | 297 | @section Rmail Files and Inboxes |
| 298 | @cindex inbox file | 298 | @cindex inbox file |
| 299 | 299 | ||
| 300 | The operating system places incoming mail for you in a file that we | 300 | When you receive mail locally, the operating system places incoming |
| 301 | call your @dfn{inbox}. When you start up Rmail, it runs a C program | 301 | mail for you in a file that we call your @dfn{inbox}. When you start |
| 302 | called @code{movemail} to copy the new messages from your inbox into | 302 | up Rmail, it runs a C program called @code{movemail} to copy the new |
| 303 | your primary Rmail file, which also contains other messages saved from | 303 | messages from your local inbox into your primary Rmail file, which |
| 304 | previous Rmail sessions. It is in this file that you actually read the | 304 | also contains other messages saved from previous Rmail sessions. It |
| 305 | mail with Rmail. This operation is called @dfn{getting new mail}. You | 305 | is in this file that you actually read the mail with Rmail. This |
| 306 | can get new mail at any time in Rmail by typing @kbd{g}. | 306 | operation is called @dfn{getting new mail}. You can get new mail at |
| 307 | any time in Rmail by typing @kbd{g}. | ||
| 307 | 308 | ||
| 308 | @vindex rmail-primary-inbox-list | 309 | @vindex rmail-primary-inbox-list |
| 309 | @cindex @env{MAIL} environment variable | 310 | @cindex @env{MAIL} environment variable |
| @@ -344,6 +345,35 @@ systems is adequate for the job, and we plan to change Rmail to use that | |||
| 344 | as its internal format. However, the Rmail file will still be separate | 345 | as its internal format. However, the Rmail file will still be separate |
| 345 | from the inbox file, even on systems where their format is the same. | 346 | from the inbox file, even on systems where their format is the same. |
| 346 | 347 | ||
| 348 | @vindex rmail-preserve-inbox | ||
| 349 | When getting new mail, Rmail first copies the new mail from the inbox | ||
| 350 | file to the Rmail file; then it saves the Rmail file; then it truncates | ||
| 351 | the inbox file. This way, a system crash may cause duplication of mail | ||
| 352 | between the inbox and the Rmail file, but cannot lose mail. If | ||
| 353 | @code{rmail-preserve-inbox} is non-@code{nil}, then Rmail will copy new | ||
| 354 | mail from the inbox file to the Rmail file without truncating the inbox | ||
| 355 | file. You may wish to set this, for example, on a portable computer you | ||
| 356 | use to check your mail via POP while traveling, so that your mail will | ||
| 357 | remain on the server and you can save it later on your workstation. | ||
| 358 | |||
| 359 | In some cases, Rmail copies the new mail from the inbox file | ||
| 360 | indirectly. First it runs the @code{movemail} program to move the mail | ||
| 361 | from the inbox to an intermediate file called | ||
| 362 | @file{~/.newmail-@var{inboxname}}. Then Rmail merges the new mail from | ||
| 363 | that file, saves the Rmail file, and only then deletes the intermediate | ||
| 364 | file. If there is a crash at the wrong time, this file continues to | ||
| 365 | exist, and Rmail will use it again the next time it gets new mail from | ||
| 366 | that inbox. | ||
| 367 | |||
| 368 | If Rmail is unable to convert the data in | ||
| 369 | @file{~/.newmail-@var{inboxname}} into Babyl format, it renames the file | ||
| 370 | to @file{~/RMAILOSE.@var{n}} (@var{n} is an integer chosen to make the | ||
| 371 | name unique) so that Rmail will not have trouble with the data again. | ||
| 372 | You should look at the file, find whatever message confuses Rmail | ||
| 373 | (probably one that includes the control-underscore character, octal code | ||
| 374 | 037), and delete it. Then you can use @kbd{1 g} to get new mail from | ||
| 375 | the corrected file. | ||
| 376 | |||
| 347 | @node Rmail Files | 377 | @node Rmail Files |
| 348 | @section Multiple Rmail Files | 378 | @section Multiple Rmail Files |
| 349 | 379 | ||
| @@ -1003,8 +1033,9 @@ turn off highlighting entirely in Rmail, set | |||
| 1003 | You can highlight and activate URLs in incoming messages by adding | 1033 | You can highlight and activate URLs in incoming messages by adding |
| 1004 | the function @code{goto-address} to the hook | 1034 | the function @code{goto-address} to the hook |
| 1005 | @code{rmail-show-message-hook}. Then you can browse these URLs by | 1035 | @code{rmail-show-message-hook}. Then you can browse these URLs by |
| 1006 | clicking on them with @kbd{Mouse-2} or by moving to one and typing | 1036 | clicking on them with @kbd{Mouse-2} (or @kbd{Mouse-1} quickly) or by |
| 1007 | @kbd{C-c @key{RET}}. @xref{Goto-address, Activating URLs, Activating URLs}. | 1037 | moving to one and typing @kbd{C-c @key{RET}}. @xref{Goto-address, |
| 1038 | Activating URLs, Activating URLs}. | ||
| 1008 | 1039 | ||
| 1009 | @node Rmail Coding | 1040 | @node Rmail Coding |
| 1010 | @section Rmail and Coding Systems | 1041 | @section Rmail and Coding Systems |
| @@ -1158,30 +1189,27 @@ which applies the code when displaying the text. | |||
| 1158 | @section @code{movemail} program | 1189 | @section @code{movemail} program |
| 1159 | @cindex @code{movemail} program | 1190 | @cindex @code{movemail} program |
| 1160 | 1191 | ||
| 1161 | When invoked for the first time, Rmail attempts to locate | 1192 | When invoked for the first time, Rmail attempts to locate the |
| 1162 | @code{movemail} program and determine its version. There are | 1193 | @code{movemail} program and determine its version. There are two |
| 1163 | two versions of @code{movemail} program: the native one, shipped with | 1194 | versions of @code{movemail} program: the native one, shipped with GNU |
| 1164 | GNU Emacs (we will refer to it as @samp{emacs version}) and the one | 1195 | Emacs (the ``emacs version'') and the one included in GNU mailutils |
| 1165 | coming from GNU mailutils (@xref{movemail,,,mailutils,GNU mailutils}, | 1196 | (the ``mailutils version'', @[xref{movemail,,,mailutils,GNU |
| 1166 | we will refer to it as @samp{mailutils version}). Both versions are | 1197 | mailutils}). They support the same command line syntax and the same |
| 1167 | compatible with each other in the sense that they support the same | 1198 | basic subset of options. However, the @samp{mailutils} version offers |
| 1168 | command line syntax and the same basic subset of options. However, | 1199 | additional features. |
| 1169 | the @samp{mailutils} version offers a much richer set of | ||
| 1170 | features. | ||
| 1171 | |||
| 1172 | The @samp{Emacs version} of @code{movemail} is able to retrieve mail from usual | ||
| 1173 | UNIX mailbox formats and from remote mailboxes using the POP3 protocol. | ||
| 1174 | |||
| 1175 | The @samp{Mailutils version} is able to handle a wide set of mailbox | ||
| 1176 | formats, such as plain UNIX mailboxes, @code{maildir} and @code{MH} | ||
| 1177 | mailboxes, etc. It is able to retrieve remote mail using POP3 or IMAP4 | ||
| 1178 | protocol. In the latter case, @code{mailutils movemail} can be | ||
| 1179 | instructed to retrieve mail using a TLS encrypted channel. | ||
| 1180 | 1200 | ||
| 1181 | The @samp{Mailutils movemail} accepts mailbox argument in the @acronym{URL} | 1201 | The Emacs version of @code{movemail} is able to retrieve mail from |
| 1182 | form. The detailed description of mailbox @acronym{URL}s can be found | 1202 | usual UNIX mailbox formats and from remote mailboxes using the POP3 |
| 1183 | in @ref{URL,,,mailutils,Mailbox URL Formats}. In short, a | 1203 | protocol. |
| 1184 | @acronym{URL} is: | 1204 | |
| 1205 | The Mailutils version is able to handle a wide set of mailbox | ||
| 1206 | formats, such as plain UNIX mailboxes, @code{maildir} and @code{MH} | ||
| 1207 | mailboxes, etc. It is able to retrieve remote mail using POP3 or | ||
| 1208 | IMAP4 protocol, and can retrieve mail from them using a TLS encrypted | ||
| 1209 | channel. It also accepts mailbox argument in the @acronym{URL} form. | ||
| 1210 | The detailed description of mailbox @acronym{URL}s can be found in | ||
| 1211 | @ref{URL,,,mailutils,Mailbox URL Formats}. In short, a @acronym{URL} | ||
| 1212 | is: | ||
| 1185 | 1213 | ||
| 1186 | @smallexample | 1214 | @smallexample |
| 1187 | @var{proto}://[@var{user}[:@var{password}]@@]@var{host-or-file-name} | 1215 | @var{proto}://[@var{user}[:@var{password}]@@]@var{host-or-file-name} |
| @@ -1244,55 +1272,26 @@ address of the remote mail server to connect to; | |||
| 1244 | e.g., @code{imap://smith:guessme@@remote.server.net}. | 1272 | e.g., @code{imap://smith:guessme@@remote.server.net}. |
| 1245 | @end table | 1273 | @end table |
| 1246 | 1274 | ||
| 1247 | Alternatively, the mailbox may be specified as a file name of the | 1275 | Alternatively, you can specify the file name of the mailbox to use. |
| 1248 | mailbox to use. This is equivalent to specifying the @samp{file} protocol: | 1276 | This is equivalent to specifying the @samp{file} protocol: |
| 1249 | 1277 | ||
| 1250 | @smallexample | 1278 | @smallexample |
| 1251 | /var/spool/mail/user @equiv{} file://var/spool/mail/user | 1279 | /var/spool/mail/@var{user} @equiv{} file://var/spool/mail/@var{user} |
| 1252 | @end smallexample | 1280 | @end smallexample |
| 1253 | 1281 | ||
| 1254 | @vindex rmail-movemail-program | 1282 | @vindex rmail-movemail-program |
| 1255 | @vindex rmail-movemail-search-path | 1283 | @vindex rmail-movemail-search-path |
| 1256 | To determine which version of @code{movemail} is being used, Rmail | 1284 | The variable @code{rmail-movemail-program} controls which version of |
| 1257 | examines the value of @code{rmail-movemail-program} variable. If it | 1285 | @code{movemail} to use. If that is a string, it specifies the |
| 1258 | is set, its value is used as a full path to the @code{movemail} binary. | 1286 | absolute file name of the @code{movemail} executable. If it is |
| 1259 | Otherwise, Rmail searches for @code{movemail} in the list of directories | 1287 | @code{nil}, Rmail searches for @code{movemail} in the directories |
| 1260 | constructed by appending the values of @code{rmail-movemail-search-path} and | 1288 | listed in @code{rmail-movemail-search-path} and @code{exec-path}, then |
| 1261 | @code{exec-path} to @code{exec-directory}. | 1289 | in @code{exec-directory}. |
| 1262 | 1290 | ||
| 1263 | @node Remote Mailboxes | 1291 | @node Remote Mailboxes |
| 1264 | @section Retrieving Mail from Remote Mailboxes | 1292 | @section Retrieving Mail from Remote Mailboxes |
| 1265 | @pindex movemail | 1293 | @pindex movemail |
| 1266 | 1294 | ||
| 1267 | @vindex rmail-preserve-inbox | ||
| 1268 | When getting new mail, Rmail first copies the new mail from the inbox | ||
| 1269 | file to the Rmail file; then it saves the Rmail file; then it truncates | ||
| 1270 | the inbox file. This way, a system crash may cause duplication of mail | ||
| 1271 | between the inbox and the Rmail file, but cannot lose mail. If | ||
| 1272 | @code{rmail-preserve-inbox} is non-@code{nil}, then Rmail will copy new | ||
| 1273 | mail from the inbox file to the Rmail file without truncating the inbox | ||
| 1274 | file. You may wish to set this, for example, on a portable computer you | ||
| 1275 | use to check your mail via POP while traveling, so that your mail will | ||
| 1276 | remain on the server and you can save it later on your workstation. | ||
| 1277 | |||
| 1278 | In some cases, Rmail copies the new mail from the inbox file | ||
| 1279 | indirectly. First it runs the @code{movemail} program to move the mail | ||
| 1280 | from the inbox to an intermediate file called | ||
| 1281 | @file{~/.newmail-@var{inboxname}}. Then Rmail merges the new mail from | ||
| 1282 | that file, saves the Rmail file, and only then deletes the intermediate | ||
| 1283 | file. If there is a crash at the wrong time, this file continues to | ||
| 1284 | exist, and Rmail will use it again the next time it gets new mail from | ||
| 1285 | that inbox. | ||
| 1286 | |||
| 1287 | If Rmail is unable to convert the data in | ||
| 1288 | @file{~/.newmail-@var{inboxname}} into Babyl format, it renames the file | ||
| 1289 | to @file{~/RMAILOSE.@var{n}} (@var{n} is an integer chosen to make the | ||
| 1290 | name unique) so that Rmail will not have trouble with the data again. | ||
| 1291 | You should look at the file, find whatever message confuses Rmail | ||
| 1292 | (probably one that includes the control-underscore character, octal code | ||
| 1293 | 037), and delete it. Then you can use @kbd{1 g} to get new mail from | ||
| 1294 | the corrected file. | ||
| 1295 | |||
| 1296 | Some sites use a method called POP for accessing users' inbox data | 1295 | Some sites use a method called POP for accessing users' inbox data |
| 1297 | instead of storing the data in inbox files. The @code{Emacs | 1296 | instead of storing the data in inbox files. The @code{Emacs |
| 1298 | movemail} can work with POP if you compile it with the macro | 1297 | movemail} can work with POP if you compile it with the macro |