[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[mpop-users] [PATCH 1/9] Improve documentation
Most importantly, the account `default' is now mentioned in the texinfo.
---
doc/mpop.1 | 2 +-
doc/mpop.texi | 7 +++++++
src/conf.h | 4 ++--
src/delivery.h | 4 ++--
src/pop3.c | 6 +++---
src/pop3.h | 2 +-
6 files changed, 16 insertions(+), 9 deletions(-)
diff --git a/doc/mpop.1 b/doc/mpop.1
index 2fa1c58..9210a62 100644
--- a/doc/mpop.1
+++ b/doc/mpop.1
@@ -36,7 +36,7 @@ middle of a session.
In server information mode, mpop prints information about one or more POP3
servers.
.br
-If no account names are given on the command line, the one named \fIdefault\fP
+If no account names are given on the command line, one named \fIdefault\fP
will be used.
.SH EXIT STATUS
The standard sendmail exit codes are used, as defined in sysexits.h.
diff --git a/doc/mpop.texi b/doc/mpop.texi
index 6d938c8..31ddf1b 100644
--- a/doc/mpop.texi
+++ b/doc/mpop.texi
@@ -453,6 +453,13 @@ the error, but this is not necessary. @xref{Filtering}.
@code{mpop [@var{option}@dots{}] --serverinfo [@var{account}@dots{}]}@*
@end itemize
+mpop is usually run with one or more accounts as parameters (an account named
+`default' is used if none was provided) or @code{mpop -a} to fetch mail from
+all accounts defined in the configuration file.
+
+In turn, this can be executed from @code{cron(8)} in order to automate
+mail retrieval.
+
@section Exit code
The standard exit codes from @code{sysexits.h} are used.
diff --git a/src/conf.h b/src/conf.h
index d9df1eb..4dc6a34 100644
--- a/src/conf.h
+++ b/src/conf.h
@@ -195,7 +195,7 @@ long long get_size_arg(const char *arg);
* override_account()
*
* Override the settings of 'acc1' with the settings of 'acc2' when the
- * appropriate flag ist set in acc2->mask.
+ * appropriate flag is set in acc2->mask.
* The flags from acc2->mask will also be set in acc1->mask.
*/
void override_account(account_t *acc1, account_t *acc2);
@@ -215,7 +215,7 @@ int check_account(account_t *acc, int retrmail, char **errstr);
* get_password_eval()
*
* Evaluates command in 'arg' and stores result in 'buf' (which is allocated).
- * Returns CONF_EIO if command exectution failed, otherwise CONF_EOK. On error,
+ * Returns CONF_EIO if command execution failed, otherwise CONF_EOK. On error,
* *errstr will contain an error string.
*/
int get_password_eval(const char *arg, char **buf, char **errstr);
diff --git a/src/delivery.h b/src/delivery.h
index 4abe737..2023e50 100644
--- a/src/delivery.h
+++ b/src/delivery.h
@@ -51,10 +51,10 @@
* http://technet.microsoft.com/en-us/library/bb124230.aspx
*
* DELIVERY_METHOD_FILTER:
- * This method is special. It behaves like DELIVERY_METHOD_MDA, with to
+ * This method is special. It behaves like DELIVERY_METHOD_MDA, with two
* exceptions:
* 1. In addition to %F-replacement, every occurence of %S in the data
- * argument will be replaced with the size of the current mail as reporte
+ * argument will be replaced with the size of the current mail as reported
* by the POP3 server.
* 2. The close function does not return a DELIVERY_* exit code, but one of
* the following:
diff --git a/src/pop3.c b/src/pop3.c
index 9ee0115..e29dbbb 100644
--- a/src/pop3.c
+++ b/src/pop3.c
@@ -1763,7 +1763,7 @@ int pop3_write_received_header(pop3_session_t *session, FILE *f, int crlf,
* See pop3_filter() and pop3_retr().
* When 'abort' is externally set, this function will stop processing the
* pipelined commands and return with POP3_EABORTED. The POP3 session is
- * unsuable thereafter.
+ * unusable thereafter.
*/
int pop3_delivery(pop3_session_t *session, volatile sig_atomic_t *abort,
@@ -2523,7 +2523,7 @@ int pop3_auth_cram_md5(pop3_session_t *session,
*
* Do POP3 authentication via AUTH EXTERNAL.
* This means the actual authentication is done via TLS; we just send the user
- * name to ther server.
+ * name to the server.
* The POP3 server must support POP3_CAP_AUTH_EXTERNAL
* Used error codes: POP3_EIO, POP3_EPROTO, POP3_EAUTHFAIL, POP3_EINVAL
*/
@@ -2851,7 +2851,7 @@ int pop3_auth(pop3_session_t *session,
gsasl_property_set(sctx, GSASL_REALM, ntlmdomain);
}
- /* Bigg authentication loop */
+ /* Big authentication loop */
input = NULL;
do
{
diff --git a/src/pop3.h b/src/pop3.h
index 76ed749..1d507dd 100644
--- a/src/pop3.h
+++ b/src/pop3.h
@@ -339,7 +339,7 @@ int pop3_server_supports_authmech(pop3_session_t *session, const char *mech);
* Use pop3_client_supports_authmech() and pop3_server_supports_authmech()
* to find out which authentication mechanisms are available.
* The special value "" for 'auth_mech' causes the function to choose the best
- * authentication method supported by the server, unless TLS is incative and the
+ * authentication method supported by the server, unless TLS is inactive and the
* method sends plain text passwords. In this case, the function fails with
* POP3_EINSECURE.
* The hostname is the name of the POP3 server. It may be needed for
--
2.1.1