/[imapfilter]/imapfilter/imapfilter.1
ViewVC logotype

Annotation of /imapfilter/imapfilter.1

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.14 - (hide annotations)
Tue Jun 18 21:15:33 2002 UTC (21 years, 9 months ago) by lefcha
Branch: MAIN
CVS Tags: release-0_8
Branch point for: release-0_8-patches
Changes since 1.13: +64 -5 lines
Documentation about the password editor and daemon mode.

1 lefcha 1.14 .Dd June 9, 2002
2 lefcha 1.11 .Dt IMAPFILTER 1
3     .Os
4     .Sh NAME
5     .Nm imapfilter
6     .Nd mail filter
7     .Sh SYNOPSIS
8     .Nm
9 lefcha 1.14 .Op Fl hkpqv
10 lefcha 1.11 .Op Fl c Ar configfile
11 lefcha 1.14 .Op Fl d Ar interval
12 lefcha 1.11 .Op Fl l Ar logfile
13     .Sh DESCRIPTION
14     .Nm
15 lefcha 1.1 is a mail filtering utility. It connects to remote mail servers using the
16 lefcha 1.9 Internet Message Access Protocol (IMAP) and processes messages based on
17     the definition of filter rules. It can be used to delete, sort, etc.
18     messages residing in multiple mailboxes at different mail servers.
19 lefcha 1.11 .Pp
20     The options are as follows:
21     .Bl -tag -width Ds
22     .It Fl c Ar configfile
23 lefcha 1.1 Configuration file to read settings and filters from. The default is
24 lefcha 1.11 .Pa $HOME/.imapfilterrc .
25 lefcha 1.14 .It Fl d Ar interval
26     Runs imapfilter at daemon mode and repeatedly polls at the specified interval.
27 lefcha 1.11 .It Fl h
28 lefcha 1.3 Prints a summary of program's options.
29 lefcha 1.14 .It Fl k
30     Kills any other running instances of
31     .Nm
32     and removes the lockfile left from a past session.
33 lefcha 1.11 .It Fl l Ar logfile
34 lefcha 1.3 File that contains logs of error messages
35 lefcha 1.11 .Nm
36 lefcha 1.7 produces and optionally information about the deleted messages.
37 lefcha 1.14 .It Fl p
38     Enters the interactive encrypted passwords editor.
39 lefcha 1.11 .It Fl q
40 lefcha 1.13 Quiet mode; no informational messages at all printed.
41 lefcha 1.11 .It Fl v
42 lefcha 1.8 Verbose mode; prints detailed information about the program's actions.
43 lefcha 1.11 .El
44 lefcha 1.14 .Sh PASSWORD EDITOR
45     .Nm
46     has the capability to encrypt the accounts' passwords and store them
47     separately at
48     .Pa $HOME/.imapfilter/passwords .
49     These passwords are encrypted with a master password, supplied by
50     the user. The Blowfish block cipher with a 128bit key in CBC mode
51     is used to do the encryption. The master password is entered each
52     time
53     .Nm
54     is run, in order to decrypt the password file and retrieve the
55     actual passwords of the user's IMAP mail accounts.
56     .Pp
57     First of all, while defining accounts in the
58     .Nm
59     configuration file, the user must specify only the username and server
60     in those accounts he/she wishes to encrypt the passwords before storage.
61     Then, one can enter the interactive passwords' editor by using the
62     .Fl p
63     option.
64     .Pp
65     After entering the interactive password editor, a command line prompt
66     is used to manage the passwords. The available commands are:
67     .Bl -tag -width Ds
68     .It Cm c
69     Clears a password from an account. It takes as an argument a
70     number, specifying which account's password should be cleared.
71     .It Cm e
72     Edits an account's password entry. It takes as an argument a
73     number, the account's password to be edited.
74     .It Cm h
75     Prints a brief help message of all commands.
76     .It Cm l
77     Lists all accounts. Specifically a number that describes the
78     account, the hostname of the IMAP mail server, the username
79     and the password (if one is already specified).
80     .It Cm p
81     Changes the master password, used to encrypt all other passwords.
82     .It Cm q
83     Quits the password editor without saving changes.
84     .It Cm s
85     Saves changes.
86     .It Cm x
87     Saves changes and exits the password editor.
88     .El
89 lefcha 1.11 .Sh ENVIROMENT
90     .Bl -tag -width Ds
91 lefcha 1.14 .It Ev HOME
92 lefcha 1.11 User's home directory.
93     .El
94     .Sh FILES
95     .Bl -tag -width Ds
96 lefcha 1.14 .It Pa $HOME/.imapfilterrc
97 lefcha 1.1 Default configuration file.
98 lefcha 1.14 .It Pa $HOME/.imapfilter/passwords
99     File where the encrypted passwords are stored.
100     .It Pa $HOME/.imapfilter/lock
101     Lock file containing the PID of
102     .Nm .
103 lefcha 1.11 .El
104     .Sh SEE ALSO
105     .Xr imapfilterrc 5
106     .Sh STANDARDS
107     .Bl -tag -width Ds
108     .It IMAP4rev1:
109 lefcha 1.1 RFC 2060
110 lefcha 1.11 .El
111 lefcha 1.12 .Sh AUTHORS
112 lefcha 1.14 .An Lefteris Chatzibarbas Aq lefcha@hellug.gr

webmaster@linux.gr
ViewVC Help
Powered by ViewVC 1.1.26