Changeset 5278:ad7983699656 for doc

Show
Ignore:
Timestamp:
2007-11-05 05:53:11 (13 months ago)
Author:
Rocco Rutte <pdmef@…>
Branch:
HEAD
Message:

Manual: Improve [un]mailboxes documentation. Closes #2204.

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • doc/manual.xml.head

    r5267 r5278  
    24962496 
    24972497<sect1 id="mailboxes"> 
    2498 <title>Defining mailboxes which receive mail</title> 
    2499  
    2500 <para> 
    2501 Usage: <literal>&lsqb;un&rsqb;mailboxes</literal> &lsqb;!&rsqb;<emphasis>filename</emphasis> &lsqb; <emphasis>filename</emphasis> ... &rsqb; 
     2498<title>Monitoring incomming mail</title> 
     2499 
     2500<para> 
     2501Usage: <literal>&lsqb;un&rsqb;mailboxes</literal> &lsqb;!&rsqb;<emphasis>folder</emphasis> &lsqb; <emphasis>folder</emphasis> ... &rsqb; 
    25022502</para> 
    25032503 
    … …  
    25102510 
    25112511<para> 
     2512<literal>folder</literal> can either be a local file or directory 
     2513(Mbox/Mmdf or Maildir/Mh). If Mutt was built with POP and/or IMAP 
     2514support, <literal>folder</literal> can also be a POP/IMAP folder 
     2515URL. The URL syntax is described in <xref linkend="url-syntax"/>, 
     2516POP and IMAP are described in <xref linkend="pop"/> and <xref linkend="imap"/> 
     2517respectively. 
     2518</para> 
     2519 
     2520<para> 
    25122521When changing folders, pressing <emphasis>space</emphasis> will cycle 
    25132522through folders with new mail. 
    … …  
    25282537 
    25292538<para> 
    2530 <emphasis role="bold">Note:</emphasis> new mail is detected by comparing the last modification time to 
    2531 the last access time.  Utilities like <literal>biff</literal> or <literal>frm</literal> or any other 
    2532 program which accesses the mailbox might cause Mutt to never detect new mail 
    2533 for that mailbox if they do not properly reset the access time.  Backup 
    2534 tools are another common reason for updated access times. 
    2535 </para> 
    2536  
    2537 <para> 
    2538 <emphasis role="bold">Note:</emphasis> the filenames in the <literal>mailboxes</literal> command are resolved when 
     2539<emphasis role="bold">Note:</emphasis> the folders in the <literal>mailboxes</literal> command are resolved when 
    25392540the command is executed, so if these names contain <link linkend="shortcuts">shortcut characters</link> (such as ``='' and ``!''), any variable 
    25402541definition that affect these characters (like <link linkend="folder">&dollar;folder</link> and <link linkend="spoolfile">&dollar;spoolfile</link>) 
    2541 should be executed before the <literal>mailboxes</literal> command. 
     2542should be executed before the <literal>mailboxes</literal> command. If 
     2543none of these shorcuts are used, a local path should be absolute as 
     2544otherwise mutt tries to find it within the current working directory 
     2545from where mutt was started which may not always be desired. 
     2546</para> 
     2547 
     2548<para> 
     2549For local folders, new mail is detected by comparing access and/or 
     2550modification times of files and folders. The interval in which Mutt 
     2551checks for new mail is defined by 
     2552<link linkend="mail-check">&dollar;mail&lowbar;check</link>. 
     2553</para> 
     2554 
     2555<para> 
     2556Special care is required with Mbox and Mmdf 
     2557folders as Mutt assumes such a folder has new mail if it wasn't 
     2558accessed after it was last modified. Utilities like <literal>biff</literal> or 
     2559<literal>frm</literal> or any other program which accesses the mailbox might cause 
     2560Mutt to never detect new mail for that mailbox if they do not properly reset the 
     2561access time.  Backup tools are another common reason for updated access times. 
    25422562</para> 
    25432563