diff options
| -rw-r--r-- | NEWS | 4 | ||||
| -rw-r--r-- | fetchmail.man | 117 |
2 files changed, 78 insertions, 43 deletions
@@ -102,6 +102,10 @@ fetchmail-6.4.31 (not yet release): previously it would always log to stderr. * Add error checking to .netrc parser. +# CHANGES: +* manpage: use .UR/.UE macros instead of .URL for URIs. +* manpage: fix contractions. Found with FreeBSD's igor tool. + -------------------------------------------------------------------------------- fetchmail-6.4.30 (released 2022-04-26, 31666 LoC): diff --git a/fetchmail.man b/fetchmail.man index c152c436..fca39238 100644 --- a/fetchmail.man +++ b/fetchmail.man @@ -61,7 +61,9 @@ env LC_ALL=C fetchmail \-vvv \-\-nodetach \-\-nosyslog (This command line actually runs fetchmail with verbose English output.) .PP Also see -.URL "https://fetchmail.sourceforge.io/fetchmail-FAQ.html#G3" "item #G3 in fetchmail's FAQ" +.UR "https://fetchmail.sourceforge.io/fetchmail-FAQ.html#G3" +item #G3 in fetchmail's FAQ +.UE . .PP You can omit the LC_ALL=C part above if you want output in the local language (if supported). However if you are posting to mailing lists, @@ -193,9 +195,9 @@ Displays option help. Displays the version information for your copy of \fBfetchmail\fP. No mail fetch is performed. Instead, for each server specified, all the option information that would be computed if \fBfetchmail\fP were connecting to that -server is displayed. Any non-printable characters in passwords or other string names -are shown as back-slashed C-like escape sequences. This option is useful for -verifying that your options are set the way you want them. +server is displayed. Any non-printable characters in passwords or other string +names are shown as back-slashed C-like escape sequences. This option is useful +for verifying that your options are set the way you want them. .TP .B \-c | \-\-check Return a status code to indicate whether there is mail waiting, @@ -309,7 +311,8 @@ Use POP3 with Kerberos V4 authentication on port 1109. .IP SDPS Use POP3 with Demon Internet's SDPS extensions. .IP IMAP -IMAP2bis, IMAP4, or IMAP4rev1 (\fBfetchmail\fP automatically detects their capabilities). +IMAP2bis, IMAP4, or IMAP4rev1 (\fBfetchmail\fP automatically detects their +capabilities). .IP ETRN Use the ESMTP ETRN option. .IP ODMR @@ -514,7 +517,7 @@ upgrade to TLSv1 or newer. .IP Recognized values for \-\-sslproto are given below. You should normally choose one of the auto-negotiating options, i. e. '\fBtls1.2+\fP' or -\'\fBauto\fP' or one of the other options ending in a plus (\fB+\fP) character. +\&'\fBauto\fP' or one of the other options ending in a plus (\fB+\fP) character. Note that depending on OpenSSL library version and configuration, some options cause run-time errors because the requested SSL or TLS versions are not supported by the particular installed OpenSSL library. @@ -1024,7 +1027,10 @@ TLS with client authentication and specify \fBgssapi\fP or GSSAPI or K4. Choosing KPOP protocol automatically selects Kerberos authentication. This option does not work with ETRN. GSSAPI service names are in line with RFC-2743 and IANA registrations, see -.URL https://www.iana.org/assignments/gssapi-service-names/ "Generic Security Service Application Program Interface (GSSAPI)/Kerberos/Simple Authentication and Security Layer (SASL) Service Names" . +.UR https://www.iana.org/assignments/gssapi-service-names/ +Generic Security Service Application Program Interface (GSSAPI)/Kerberos/Simple +Authentication and Security Layer (SASL) Service Names +.UE . .SS Miscellaneous Options .TP .B \-f <pathname> | \-\-fetchmailrc <pathname> @@ -1258,8 +1264,10 @@ can protect you from a passive eavesdropper, it does not help against an active attacker. It is clearly an improvement over sending the passwords in clear, but you should be aware that a man-in-the-middle attack is trivially possible (in particular with tools such as -.URL "https://monkey.org/~dugsong/dsniff/" "dsniff" , -). Use of strict certificate checking with a certification authority +.UR "https://monkey.org/~dugsong/dsniff/" +dsniff +.UE ). +Use of strict certificate checking with a certification authority recognized by server and client, or perhaps of an SSH tunnel (see below for some examples) is preferable if you care seriously about the security of your mailbox and passwords. @@ -1476,7 +1484,7 @@ cycle. This is a robustness feature. It means that if a message is fetched (and thus marked seen by the mail server) but not delivered locally due to some transient error, it will be re-fetched during the next poll cycle. (The IMAP logic does not delete messages until -they're delivered, so this problem does not arise.) +they are delivered, so this problem does not arise.) .PP If you touch or change the \fI~/.fetchmailrc\fP file while fetchmail is running in daemon mode, this will be detected at the beginning of the @@ -1680,7 +1688,8 @@ When there is a conflict between the command-line arguments and the arguments in this file, the command-line arguments take precedence. .PP To protect the security of your passwords, -your \fI~/.fetchmailrc\fP may not normally have more than 0700 (u=rwx,g=,o=) permissions; +your \fI~/.fetchmailrc\fP may not normally have more than 0700 (u=rwx,g=,o=) +permissions; \fBfetchmail\fP will complain and exit otherwise (this check is suppressed when \-\-version is on). @@ -2166,7 +2175,7 @@ the list of local recipients. The 'checkalias' option (normally off) extends the lookups performed by the 'dns' keyword in multidrop mode, providing a way to cope with remote MTAs that identify themselves using their canonical name, while -they're polled using an alias. +they are polled using an alias. When such a server is polled, checks to extract the envelope address fail, and \fBfetchmail\fP reverts to delivery using the To/Cc/Bcc headers (See below \&'Header versus Envelope addresses'). @@ -2352,7 +2361,9 @@ in random locations even if you use the software the same way. For solving hardware-induced segfaults, find the faulty component and repair or replace it. -.URL https://www.bitwizard.nl/sig11/ "The Sig11 FAQ" +.UR https://www.bitwizard.nl/sig11/ +The Sig11 FAQ +.UE may help you with details. For solving software-induced segfaults, the developers may need a "stack @@ -2481,7 +2492,7 @@ poll other.provider.net proto pop2 user "John.Smith" pass "My^Hat" .fi .PP -Here's the same version with more whitespace and some noise words: +Here is the same version with more whitespace and some noise words: .IP .nf @@ -2521,7 +2532,7 @@ poll mail.provider.net .PP It is possible to specify more than one user per server. The 'user' keyword leads off a user description, and every user specification -in a multi-user entry must include it. Here's an example: +in a multi-user entry must include it. Here is an example: .IP .nf @@ -2537,7 +2548,7 @@ pop.provider.net username 'jones'. Mail for 'jones' is kept on the server after download. .PP -Here's what a simple retrieval configuration for a multidrop mailbox +Here is what a simple retrieval configuration for a multidrop mailbox looks like: .IP @@ -2561,7 +2572,7 @@ user@domain specifications here, these would never match. the left-hand side of a user mapping. .PP -Here's an example of another kind of multidrop connection: +Here is an example of another kind of multidrop connection: .IP .nf @@ -2578,7 +2589,7 @@ loonytoons.org or toons.org domains (including sub-domain addresses like listener without modification. Be careful of mail loops if you do this! .PP -Here's an example configuration using ssh and the plugin option. The +Here is an example configuration using ssh and the plugin option. The queries are made directly on the stdin and stdout of imapd via ssh. Note that in this setup, IMAP authentication can be skipped. @@ -2699,12 +2710,12 @@ Then, when mail including 'fetchmail\-friends' as a local address gets fetched, the list name will be appended to the list of recipients your SMTP listener sees. Therefore it will undergo alias expansion locally. Be sure to include 'esr' in the local alias -expansion of fetchmail\-friends, or you'll never see mail sent only to +expansion of fetchmail\-friends, or you will never see mail sent only to the list. Also be sure that your listener has the "me-too" option set (sendmail's \-oXm command-line option or OXm declaration) so your name is not removed from alias expansions in messages you send. .PP -This trick is not without its problems, however. You'll begin to see +This trick is not without its problems, however. You will begin to see this when a message comes in that is addressed only to a mailing list you do \fInot\fP have declared as a local name. Each such message will feature an 'X\-Fetchmail\-Warning' header which is generated @@ -2864,14 +2875,16 @@ that of the last host queried. .SH FILES .TP 5 -~/.fetchmailrc, $HOME/.fetchmailrc, $HOME_ETC/.fetchmailrc, $FETCHMAILHOME/fetchmailrc +~/.fetchmailrc, $HOME/.fetchmailrc, $HOME_ETC/.fetchmailrc, \ +$FETCHMAILHOME/fetchmailrc default run control file (location can be overridden with environment variables) .TP 5 ~/.fetchids, $HOME/.fetchids, $HOME_ETC/.fetchids, $FETCHMAILHOME/.fetchids default location of file recording last message UIDs seen per host. (location can be overridden with environment variables) .TP 5 -~/.fetchmail.pid, $HOME/.fetchmail.pid, $HOME_ETC/.fetchmail.pid, $FETCHMAILHOME/fetchmail.pid +~/.fetchmail.pid, $HOME/.fetchmail.pid, $HOME_ETC/.fetchmail.pid, \ +$FETCHMAILHOME/fetchmail.pid default location of lock file (sometimes called pidfile or PID file, see option pidfile) to help prevent concurrent runs (non-root mode). (location can be overridden with environment variables) @@ -2885,19 +2898,21 @@ passwords as a last resort before prompting for one interactively. lock file (pidfile) to help prevent concurrent runs (root mode, Linux systems). .TP 5 /etc/fetchmail.pid -lock file (pidfile) to help prevent concurrent runs (root mode, systems without /var/run). +lock file (pidfile) to help prevent concurrent runs (root mode, systems without +/var/run). .SH ENVIRONMENT -Fetchmail's behavior can be altered by providing it with environment variables. Some may -alter the operation of libraries that fetchmail links against, for instance, OpenSSL. +Fetchmail's behavior can be altered by providing it with environment variables. +Some may alter the operation of libraries that fetchmail links against, for +instance, OpenSSL. Note that in daemon mode, you will need to quit the background daemon process and start a new fetchmail daemon for environment changes to take effect. .IP \fBFETCHMAILHOME\fP If this environment variable is set to a valid and existing directory name, fetchmail will read $FETCHMAILHOME/fetchmailrc -(the dot is missing in this case), $FETCHMAILHOME/.fetchids (keeping its dot) and -$FETCHMAILHOME/fetchmail.pid (without dot) rather than from the user's home -directory. The .netrc file is always looked for in the invoking +(the dot is missing in this case), $FETCHMAILHOME/.fetchids (keeping its dot) +and $FETCHMAILHOME/fetchmail.pid (without dot) rather than from the user's +home directory. The .netrc file is always looked for in the invoking user's home directory (or $HOME_ETC) regardless of FETCHMAILHOME's setting. .IP \fBFETCHMAILUSER\fP @@ -3079,11 +3094,15 @@ The BSMTP error handling is virtually nonexistent and may leave broken messages behind. .PP Send comments, bug reports, gripes, and the like to the -.MTO "fetchmail-devel@lists.sourceforge.net" "fetchmail-devel list" +.UR "mailto:fetchmail-devel@lists.sourceforge.net" +fetchmail-devel list +.UE .PP An -.URL "https://fetchmail.sourceforge.io/fetchmail-FAQ.html" "HTML FAQ" +.UR "https://fetchmail.sourceforge.io/fetchmail-FAQ.html" +fetchmail FAQ (in HTML form) +.UE is available at the fetchmail home page, it should also accompany your installation. @@ -3093,14 +3112,18 @@ major assistance from Sunil Shetye (for code) and Rob MacGregor (for the mailing lists). .PP Most of the code is from -.MTO esr@snark.thyrsus.com "Eric S. Raymond" -\&. Too many other people to name here have contributed code and patches. +.UR "mailto:esr@snark.thyrsus.com" +Eric S. Raymond +.UE . +Too many other people to name here have contributed code and patches. .PP This program is descended from and replaces .BR popclient , by -.MTO "ceharris@mal.com" "Carl Harris" -\&; the internals have become quite different, but some of its interface +.UR "mailto:ceharris@mal.com" +Carl Harris +.UE ; +the internals have become quite different, but some of its interface design is directly traceable to that ancestral program. .PP This manual page has been improved by Matthias Andree, R.\ Hannes @@ -3110,20 +3133,25 @@ Beinert, and H\['e]ctor Garc\['i]a. .BR README , .BR README.SSL , .BR README.SSL-SERVER , -.URL "https://www.fetchmail.info/fetchmail-FAQ.html" "The Fetchmail FAQ" , +.UR "https://www.fetchmail.info/fetchmail-FAQ.html" +The Fetchmail FAQ +.UE , .BR mutt (1), .BR elm (1), .BR mail (1), .BR sendmail (8), .BR popd (8), .BR imapd (8), -.BR netrc (5). -.PP -.URL "https://www.fetchmail.info/" "The fetchmail home page." -.PP -.URL "https://fetchmail.sourceforge.io/" "The fetchmail home page (alternative URI)." -.PP -.URL "https://www.courier-mta.org/maildrop/" "The maildrop home page." +.BR netrc (5), +.UR "https://www.fetchmail.info/" +the fetchmail home page +.UE , +.UR "https://fetchmail.sourceforge.io/" +(alternative URI) +.UE ; +.UR "https://www.courier-mta.org/maildrop/" +the maildrop home page. +.UE .SH APPLICABLE STANDARDS Note that this list is just a collection of references and not a statement as to the actual protocol conformance or requirements in @@ -3170,7 +3198,10 @@ RFC 2033. .TP 5 GSSAPI: RFC 1508, RFC 1734, -.URL https://www.iana.org/assignments/gssapi-service-names/ "Generic Security Service Application Program Interface (GSSAPI)/Kerberos/Simple Authentication and Security Layer (SASL) Service Names" . +.UR https://www.iana.org/assignments/gssapi-service-names/ +Generic Security Service Application Program Interface (GSSAPI)/Kerberos/Simple +Authentication and Security Layer (SASL) Service Names +.UE . .TP 5 TLS: RFC 2595. |