OSDN Git Service

Add incremental search functions for summary or preview view.
[mave/mave.git] / README
1 How to use 'Mave' textbase mailer.
2
3 Requirement
4
5   Ruby and curses library.
6
7 1. Get archive and Extract
8   Access http://sourceforge.jp/projects/mave/downloads/44582/mave.tgz/
9   $ tar xvfz mave.tgz
10   $ cd mave
11
12 2. Build your config
13
14   $ cp mave.config.sample mave.config
15   $ vi mave.config
16
17     rewrite setting of 'Main' account to yours.
18
19     configure your editor environment.
20
21     @configs[:EDITOR_TYPE] = ['system'|'forkexec']
22         system: Mave close curses window and wake editor with same console. For CUI.
23       forkexec: Mave fork child process and wake editor another window. For GUI.
24
25     @configs[:EDITOR] = '/usr/bin/editor %s'
26       The command of wake editor. %s is replaced to file name. 
27
28 3. Make directory for store mail files
29
30   $ mkdir ~/mave.mails
31
32   Mave do not create any files without the directory specified here.
33
34 4. Execute Mave
35
36   $ ./mave
37
38 5. Fetch mails
39
40   Press Ctrl + x, p key to fetch mails from server.
41
42   In default, Mave does not remove mails on pop server immediately.
43   The time lag until removing mails was set by ':POP_KEEP_TIME'.
44   It is possible to try use Mave in parallel with your current mailer.
45
46   Status window is scrolled by Pgup, PgDn keys.
47
48 6. Explore mails
49
50   Each h, j, k, and l key were allocated in each Left, Down, Up, and Right like the Vi editor. 
51
52   However, the function to send mail has not been provided to Mave yet...
53
54   How to look summary line.
55
56   x.  22 Amazon.com   <sh Sun, 22 Nov 15:40  579 .. +Amazon.com order confirmation
57   ^^ ^^^ ^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^ ^^^^ ^^ ^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
58   ||  |   Mail from / to   Sent date        size || |  Subject
59   ||  +-Recent 0 <=> 999 Old                     || +-Parent(+) / Child(-) / Folded(#/=)
60   |+-Flag(F) / Notice mark(#)                    |+-Multipart mail(@)(Has attachement)
61   +-Unread mark(x)                               +-To you(w) / Cc you(v)
62
63   You can change summary looking.
64
65   r key: Unread mark ON/OFF           f key: Flag ON/OFF
66   o key: Fold thread / Open           n key: Notice mark ON/OFF
67
68 7. Incremental search
69
70   Press Ctrl + s key to open incremental search dialog at summary or preview view.
71   The search will running that each key was pressed.
72   Press Ctrl + s key to search next when word found.
73   Press Ctrl + g key to abort search or close search dialog.
74   Press Ctrl + r key to search backward.
75
76 8. Create/Edit mail message
77
78   Press Ctrl + x, n key to create new mail message.
79   Press Ctrl + x, r key to create reply mail message.
80   The message will store to 'drafts' folder.
81
82   Press Ctrl + x, e key to edit mail message.
83   The message will overwrite.
84
85 9. Mail Folders
86
87   Press h key on the summary view, change into the folder view.
88   In folder view, select folder with up/down(k, j), and move into the folder with right(l).
89   Or press shortcut key to move into the folder.
90
91   How to look folder list.
92
93   x 0) Inbox (5/52)
94   . a) Community (2/38)
95   x b) Develop (1/8)
96   . d) Drafts (0/23)
97   . o) Outbox (0/0)
98   . s) Sent (0/25)
99   . t) Trash (0/18)
100   ^ ^  ^^^^^  ^^^^
101   | |    |    Number of unread / all mails
102   | |    +-Folder name
103   | +-Shortcut key
104   +-Folder got new mails mark(x) *not provided yet
105
106   In folder view, press Ctrl + x, n key to create new folder.
107   In selecting folder, press Ctrl + x, e key to edit folder configurations.
108   You can change display name, list order and mail distributing by edit folder configurations.
109   See example in 'mave.folderconfig.master'.
110
111   However, the function to move/delete mail has not been provided to Mave yet...
112
113 10. Quit
114
115   Press Ctrl + x, c key to kill mave.
116
117 Enjoy!!
118
119 Note:
120   When multibyte character is troubled.
121   Standard curses library of Ruby doesn't correspond to UTF-8. 
122   Please apply the patch to correspond to ncursesw referring to the following sites. 
123
124   http://www.itline.jp/~svx/diary/?date=20091022
125
126   In experimentally, Mave corresponds terminal environment of EUC-JP now. 
127   In this case, you do not need to apply above patch.
128   Set EUC-JP to ':TERMINAL_CHARSET' in mave.config, and change mave_base.rb a bit.
129   "export LANG=ja_JP.eucjp" might execute from the terminal. 
130
131   117     def enspc
132   118 #       return(self)                                            # comment out without UTF-8
133   119 ^       self.gsub(/[\xC0-\xE2][\x80-\xBF]+/) {|c|               #### for UTF8 temporally
134       +ーremove this '#'
135
136   And in experimentally, Mave is corresponding Windows console environment with SHIFT_JIS.
137   Set SHIFT_JIS to ':TERMINAL_CHARSET' in mave.config, and try and error.
138
139 Mave project official page:
140   http://sourceforge.jp/projects/mave/
141
142 [EOF]