Corrected some mistakes in the man pages (#251)

* Fixed some double spaces and misspelling.

* July 21, 2022 1:49 PM

* Corrected som misspelling, comata and errors

* Corrected some misspelling, comata and errors

* July 21, 2022 2:30 PM

* July 21, 2022 2:37 PM

* July 21, 2022 3:08 PM

* July 21, 2022 3:29 PM

* July 21, 2022 3:30 PM

* July 21, 2022 3:38 PM

doc/imapfilter.1

@@ -14,11 +14,11 @@
 .Op Fl t Ar truststore
 .Sh DESCRIPTION
 .Nm
-is a mail filtering utility.  It connects to remote mail servers using the
+is a mail filtering utility. It connects to remote mail servers using the
 Internet Message Access Protocol (IMAP), sends searching queries to the server
-and processes mailboxes based on the results.  It can be used to delete, copy,
-move, flag, etc.  messages residing in mailboxes at the same or different mail
-servers.  The 4rev1 and 4 versions of the IMAP protocol are supported.
+and processes mailboxes based on the results. It can be used to delete, copy,
+move, flag, etc. messages residing in mailboxes at the same or different mail
+servers. The 4rev1 and 4 versions of the IMAP protocol are supported.
 .Pp
 The command line options of
 .Xr imapfilter 1
@@ -45,19 +45,19 @@ Enters interactive mode after executing the configuration file.
 File that contains logs of error messages produced.
 .It Fl n
 This option enables the so called dry-run mode, and any actions that would
-result in changes to the server do not actually take place.  So the requests
+result in changes to the server do not actually take place. So the requests
 that would modify any data are not sent to the server, even though
 informational messages about these actions are still printed.
 
 Any other methods, that only receive data from the server, are performed as
-normal, such as for example the searching methods.  Note, that the number of
+normal, such as for example the searching methods. Note, that the number of
 messages an action is reported to be applied upon, might differ between dry-run
 mode and the normal execution, and this is expected as in the latter case the
-data on the server are continuesly altered by subsequent actions.
+data on the server are continuously altered by subsequent actions.
 .It Fl t Ar truststore
 The path to the system's SSL CA TrustStore directory or file. SSL connections
 will be validated using the CA certificates found in this directory or file,
-and when this is not possible the local
+and when this is not possible, the local
 .Pa $HOME/.imapfilter/certificates
 file will be used.  The default CA directory is
 .Pa /etc/ssl/certs/ ,
@@ -79,7 +79,7 @@ Program's configuration directory, which overrides the default
 .Sh FILES
 .Bl -tag -width Ds
 .It Pa $HOME/.imapfilter/config.lua
-Default configuration file.  Because this file may contain sensitive data such
+Default configuration file. Because this file may contain sensitive data such
 as user passwords, the recommended permissions are read/write for the user, and
 not accessible by others.
 .It Pa $HOME/.imapfilter/certificates

doc/imapfilter_config.5

@@ -9,11 +9,11 @@
 .Sh DESCRIPTION
 .Xr imapfilter 1
 uses the Lua programming language as a configuration and extension language,
-therefore the configuration file is a Lua script.
+therefore, the configuration file is a Lua script.
 .Pp
 Although knowledge of Lua is not required to use
 .Xr imapfilter 1 ,
-it is nonetheless recommended, especially if one wants to extend it.  For more
+it is nonetheless recommended, especially if one wants to extend it. For more
 information on Lua see
 .Ad http://www.lua.org/docs.html .
 .Sh CONVENTIONS
@@ -83,7 +83,7 @@ as a value. Default is
 .Dq true .
 .It Va certificates
 When this option is enabled, the server certificate can be accepted and stored,
-in order to validate the authenticity of the server in future connections. This
+to validate the authenticity of the server in future connections. This
 variable takes a
 .Vt boolean
 as a value. Default is
@@ -92,12 +92,12 @@ as a value. Default is
 Indicates to the server the character set of the strings for the searching
 methods.  This variable takes a
 .Vt string
-as a value.  By default no character set is set, and thus plain ASCII should be
+as a value.  By default, no character set is set, and thus plain ASCII should be
 assumed by the server.
 .It Va create
 According to the IMAP specification, when trying to write a message to a
 non-existent mailbox, the server must send a hint to the client, whether it
-should create the mailbox and try again or not. However some IMAP servers don't
+should create the mailbox and try again or not. However, some IMAP servers don't
 follow the specification and don't send the correct response code to the
 client. By enabling this option the client tries to create the mailbox, despite
 of the server's response. This variable takes a
@@ -126,7 +126,7 @@ takes a
 as a value. Default is
 .Dq true .
 .It Va info
-When this options is enabled, a summary of the program's actions is printed,
+When this options are enabled, a summary of the program's actions is printed,
 while processing mailboxes.  This variable takes a
 .Vt boolean
 as a value.  Default is
@@ -135,7 +135,7 @@ as a value.  Default is
 The time in minutes before terminating and re-issuing the IDLE command, in
 order to keep alive the connection, by resetting the inactivity timeout of the
 server.  A standards compliant server must have an inactivity timeout of at
-least 30 minutes.  But it may happen that some IMAP servers don't respect that,
+least 30 minutes.  But some IMAP servers might not respect that,
 or some intermediary network device has a shorter timeout.  By setting this
 option the above problem can be worked around. This variable takes a
 .Vt number
@@ -144,7 +144,7 @@ as a value. Default is
 minutes.
 .It Va limit
 Some servers have problems handling very long requests, but some of the
-requests that need to be sent can become quite long, because they apply an
+requests that need to be sent can become quite long because they apply an
 action for many messages at once.  When this option is set, the client will try
 to break up these requests into smaller requests, that each operates on fewer
 messages at a time.  A good value for this would be
@@ -163,9 +163,9 @@ residing on the mail server; the user must use the
 .Sq /
 character as the delimiter and
 .Dq
-(ie.  nothing) as the prefix, regardless of the folder
+(i.e.  nothing) as the prefix, regardless of the folder
 format of the mail server.  This must be disabled, if the user wants to
-manually specify mailbox names (eg. because they are not part of the user's
+manually specify mailbox names (e.g. because they are not part of the user's
 personal namespace mailboxes).  This variable takes a
 .Vt boolean
 as a value.  Default is
@@ -174,14 +174,14 @@ as a value.  Default is
 When the
 .Va recover
 option is enabled, the recovery function tries to restore the lost session, but
-if it fails to do so it gives up with an error.  In some cases a temporary
+if it fails to do so, it gives up with an error.  In some cases, a temporary
 network problem might cause the recovery function to fail, but the connection
 could be reestablished when trying a bit later.  By enabling this option, the
 recovery function will be called repeatedly after a timeout, thus it will
-persist when trying to restore the session.  Note, that this will case the
+persist when trying to restore the session.  Note, that this will cause the
 execution of the configuration file to be halted at the point of failure until
 the session is restored, which can have side effects to other established
-sessions, for example they might get dropped by the server after a while.  This
+sessions, for example, they might get dropped by the server after a while.  This
 variable
 takes a
 .Vt boolean
@@ -194,13 +194,13 @@ good value for this would be
 .Dq 50 .
 This variable takes a
 .Vt number
-as a value.  By default no such limit is imposed.  See also the
+as a value.  By default, no such limit is imposed.  See also the
 .Va limit
 option which is related.
 .It Va recover
-With this option it is possible to control the recovery functionality, which
+With this option, it is possible to control the recovery functionality, which
 restores a session (the connection to the server and the IMAP state at the
-time), after some unexpected event takes place.  Currently there are two types
+time), after some unexpected event takes place.  Currently, there are two types
 of events that can end abnormally a session, and finally cause the program to
 terminate: network errors, and the IMAP BYE response which a server can send
 anytime.  When this option is set to
@@ -218,7 +218,7 @@ unexpected event while in IDLE mode (see also the
 option), the client will re-enter IDLE mode.  But when this option is disabled,
 and after the connection is recovered, the client will not re-enter IDLE mode,
 and instead will continue to execute the next line in the configuration file,
-ie. the one after
+i.e. the one after
 .Fn enter_idle .
 Default is
 .Dq true .
@@ -244,15 +244,15 @@ as a value.  Default is
 .Dq 60
 seconds.
 .It Va wakeonany
-By enabling this option the IDLE command will return on any event that is
+By enabling this option, the IDLE command will return on any event that is
 received from the server, and not just on the
 .Dq RECENT
 and
 .Dq EXISTS
 events, that normally indicate the arrival of a new message.  Examples of other
 events are
 .Dq FETCH ,
-which indicates that the details of a message (eg. its flags) have been
+which indicates that the details of a message (e.g. its flags) have been
 modified, or
 .Dq EXPUNGE ,
 which indicates that a message has been deleted.  This variable takes a
@@ -293,14 +293,14 @@ An account
 can also have the following optional elements:
 .Bl -tag -width Ds
 .It Va password
-User's secret keyword.  If a password wasn't supplied the user will be asked to
+User's secret keyword.  If a password wasn't supplied, the user will be asked to
 enter one interactively the first time it will be needed (unless
 .Vt oauth2
 has been set).  It takes a
 .Vt string
 as a value.
 .Pp
-Passwords can be also extracted during execution time from an encrypted
+Passwords can also be extracted during execution time from an encrypted
 password vault.  The
 .Pa samples/extend.lua
 file contains such an example.
@@ -314,7 +314,7 @@ character inside a password might require four backslashes.
 The OAuth2 string to use to authenticate if the server supports the XOAUTH2
 authentication mechanism.  If the server does not support it and a
 .Vt password
-has been also set, authentication will be attempted using the
+has also been set, authentication will be attempted using the
 .Vt password .
 It takes a
 .Vt string
@@ -325,7 +325,7 @@ obtained, an OAuth2 token has been generated and authorized, a new access token
 has been generated using the refresh token if the last access token has
 expired, and an OAuth2 string has been generated from the access token.  The
 aforementioned OAuth2 string is a Base64 encoded string that should be set
-here.  For more information see
+here.  For more information, see
 .Ad https://developers.google.com/gmail/xoauth2_protocol .
 .Pp
 The
@@ -351,7 +351,7 @@ as a value, specifically one of:
 .Dq ssl3 .
 .Pp
 Note that the latest versions of the OpenSSL library have deprecated
-version specific methods, and the actual protocol version used will be
+version specific methods, and the actual protocol version used, will be
 negotiated to be the highest version mutually supported by the client
 and the server.  This is also what the
 .Dq auto
@@ -399,7 +399,7 @@ wildcards, in a folder of an account.  The
 .Sq *
 wildcard, matches any character and the
 .Sq %
-matches any character except the folder delimiter, ie.  non-recursively:
+matches any character except the folder delimiter, i.e.  non-recursively:
 .Pp
 .Bl -tag -width Ds -compact
 .It Fn list_all folder mailbox
@@ -511,7 +511,7 @@ A mailbox inside a folder can be only accessed by using the alternative form:
 myaccount['myfolder/mymailbox']
 .Ed
 .Pp
-The methods that are available for an account (eg.
+The methods that are available for an account (e.g.
 .Fn list_all ,
 .Fn create_mailbox ,
 etc.) , are considered keywords and must not be used as mailbox names, and the
@@ -535,11 +535,11 @@ new message in the mailbox.
 The
 .Fn enter_idle
 method implements the IMAP IDLE (RFC 2177) extension.  By using this extension
-it's not necessary to poll the server for changes to the selected mailbox (ie.
+it's not necessary to poll the server for changes to the selected mailbox (i.e.
 using the
 .Fn check_status
 method), but instead the server sends an update when there is a change
-in the mailbox (eg. in case of new mail).  When the
+in the mailbox (e.g. in case of new mail).  When the
 .Fn enter_idle
 method has been called no more commands in the configuration file are executed
 until an update is received, at which point the
@@ -553,7 +553,7 @@ The
 method returns a value of type
 .Vt boolean :
 .Dq true
-if the IDLE extension is supported and there was a update in the mailbox, and
+if the IDLE extension is supported and there was an update in the mailbox, and
 .Dq false
 if the IDLE extension is not supported, in which case the method returns
 immediately.  When the aforementioned return value was
@@ -569,7 +569,7 @@ Apart from an event received by the server, the SIGUSR1 or SIGUSR2 signals can
 also interrupt the IDLE mode at any time, and the execution of the
 configuration file will then continue from the next line after the
 .Fn enter_idle .
-In this case only the value
+In this case, only the value
 .Dq true
 is returned.
 .El
@@ -650,7 +650,7 @@ The returned
 of the searching methods can also be stored in variables and then further
 processed:
 .Bd -literal -offset 4n
-unseen = myaccount.myaccount:is_unseen()
+unseen = myaccount.mymailbox:is_unseen()
 larger = myaccount.mymailbox:is_larger(100000)
 subject = myaccount.mymailbox:contain_subject('test')
 results = unseen + larger * subject
@@ -827,7 +827,7 @@ the abbreviated month (
 .Dq Oct ,
 .Dq Nov ,
 .Dq Dec )
-and year is the year as decimal number including the century (eg. 2007):
+and year is the year as decimal number including the century (e.g. 2007):
 .Pp
 .Bl -tag -width Ds -compact
 .It Fn arrived_before date
@@ -1160,7 +1160,7 @@ system flags are
 .Dq \eDraft ,
 .Dq \eFlagged ,
 .Dq \eSeen ,
-while if the server supports it, new user keywords may be defined:
+while, if the server supports it, new user keywords may be defined:
 .Pp
 .Bl -tag -width Ds -compact
 .It Fn add_flags flags
@@ -1207,7 +1207,7 @@ results:remove_flags({ '\e\eSeen' })
 results:move_messages(myotheraccount['myfolder/mymailbox'])
 .Ed
 .Sh MESSAGES
-The messages that are residing in any mailbox can be also accessed, as a whole
+The messages that are residing in any mailbox can also be accessed, as a whole
 or in parts.  Messages can be accessed using their unique identifier (UID):
 .Bd -literal -offset 4n
 myaccount.mymailbox[22]
@@ -1443,7 +1443,7 @@ success, capture = regex_search('^(?i)pcre: (\e\ew)$', 'mystring')
 sleep(300)
 .Pp
 .Ed
-For more examples see the
+For more examples, see the
 .Pa samples/extend.lua
 file.
 .Sh EXAMPLES