aboutsummaryrefslogtreecommitdiffstats
path: root/fetchmail.man
diff options
context:
space:
mode:
Diffstat (limited to 'fetchmail.man')
-rw-r--r--fetchmail.man44
1 files changed, 29 insertions, 15 deletions
diff --git a/fetchmail.man b/fetchmail.man
index cf6249ef..1face9b4 100644
--- a/fetchmail.man
+++ b/fetchmail.man
@@ -10,7 +10,7 @@
.\" Load www macros to process .URL requests, this requires groff:
.mso www.tmac
.\"
-.TH fetchmail 1 "fetchmail 6.4.0" "fetchmail" "fetchmail reference manual"
+.TH fetchmail 1 "fetchmail 6.4.1" "fetchmail" "fetchmail reference manual"
.SH NAME
fetchmail \- fetch mail from a POP, IMAP, ETRN, or ODMR-capable server
@@ -2828,18 +2828,21 @@ that of the last host queried.
.SH FILES
.TP 5
-~/.fetchmailrc
-default run control file
+~/.fetchmailrc, $HOME/.fetchmailrc, $HOME_ETC/.fetchmailrc, $FETCHMAILHOME/fetchmailrc
+default run control file (location can be overridden with environment variables)
.TP 5
-~/.fetchids
+~/.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
-lock file to help prevent concurrent runs (non-root mode).
+~/.fetchmail.pid, $HOME/.fetchmail.pid, $HOME_ETC/.fetchmail.pid, $FETCHMAILHOME/fetchmail.pid
+default location of lock file to help prevent concurrent runs (non-root mode).
+(location can be overridden with environment variables)
.TP 5
-~/.netrc
+~/.netrc, $HOME/.netrc, $HOME_ETC/.netrc
your FTP run control file, which (if present) will be searched for
passwords as a last resort before prompting for one interactively.
+(location can be overridden with environment variables)
.TP 5
/var/run/fetchmail.pid
lock file to help prevent concurrent runs (root mode, Linux systems).
@@ -2851,10 +2854,10 @@ lock file to help prevent concurrent runs (root mode, systems without /var/run).
.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 and
-$FETCHMAILHOME/.fetchmail.pid rather than from the user's home
+(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 the invoking
-user's home directory regardless of FETCHMAILHOME's setting.
+user's home directory (or $HOME_ETC) regardless of FETCHMAILHOME's setting.
.IP \fBFETCHMAILUSER\fP
If this environment variable is set, it is used as the name of the
@@ -2886,15 +2889,26 @@ used as a workaround when TOP does not work properly.
(since v6.3.17):
If this environment variable is set and not empty, fetchmail will always load
the default X.509 trusted certificate locations for SSL/TLS CA certificates,
-even if \fB\-\-sslcertfile\fP and \fB\-\-sslcertpath\fP are given. The latter locations take precedence over the system default locations.
+even if \fB\-\-sslcertfile\fP and \fB\-\-sslcertpath\fP are given.
+The latter locations take precedence over the system default locations.
This is useful in case there are broken certificates in the system directories
and the user has no administrator privileges to remedy the problem.
-.IP \fBHOME_ETC\fP
-If the HOME_ETC variable is set, fetchmail will read
-$HOME_ETC/.fetchmailrc instead of ~/.fetchmailrc.
+.IP \fBHOME\fP
+(documented since 6.4.1):
+This variable is nomally set to the user's home directory. If it is set
+to a different directory than what is the password database, HOME takes
+prececence.
-If HOME_ETC and FETCHMAILHOME are both set, HOME_ETC will be ignored.
+.IP \fBHOME_ETC\fP
+(documented corrected to match behaviour code since 6.4.1):
+If the HOME_ETC variable is set, it will override fetchmail's idea of $HOME,
+i. e. fetchmail will read .fetchmailrc, .fetchids, .fetchmail.pid and .netrc
+from $HOME_ETC instead of $HOME (or if HOME is also unset,
+from the passwd file's home directory location).
+
+If HOME_ETC and FETCHMAILHOME are both set, FETCHMAILHOME takes prececence
+and HOME_ETC will be ignored.
.IP \fBSOCKS_CONF\fP
(only if SOCKS support is compiled in) this variable is used by the