wmbiff: Fix memory leaks pointed out by valgrind.
[dockapps.git] / wmbiff / FAQ
blob288cc70df4f1aadef5d047fcfce9764883836d45
1 * Does WMBiff have a mailing list?
3 Subscribe to wmbiff-devel@lists.sourceforge.net.
5 echo "subscribe wmbiff-devel" | mail majordomo@lists.sourceforge.net
7 * Why doesn't WMBiff update immediately after I read my mail?
9 WMBiff looks only at the flags associated with mail messages
10 to decide if they've been read.  If your mail reader doesn't
11 bother to update those flags immediately after you read a
12 message, WMBiff has (essentially) no way of knowing that
13 you've read the message.
15 There are some workarounds:  In mutt, you can ask it to sync
16 the mailbox using the sync-mailbox command: it will write
17 the mailbox file to disk (or back to the IMAP server) so
18 that WMBiff can update its counters.  Mutt's sync-mailbox
19 command is bound to the $ key by default.  In Mac OS X mail,
20 changing to a different mailbox usually flushes changes,
21 so I often hit Command-4 to switch to the sent mailbox
22 for a few seconds.
24 No workarounds are known for Kmail, which updates the status
25 flags of all mail as if it were read, then adds its own
26 status field to note that some are unread.  (sourceforge
27 tracker #706995).
29 * WMBiff doesn't work.  How do I submit a bug?
31 See the Troubleshooting section of the wmbiffrc man
32 page.  
34 If that doesn't work, run 'wmbiff -debug > wmbiff.log' and
35 remove any passwords left in wmbiff.log.  Submit this log
36 and your wmbiffrc (sanitized of passwords of course) using
37 'reportbug' under Debian, or by sending mail to
38 wmbiff-devel.
40 * WMBiff doesn't do something I want. How do I suggest a feature?
42 If using Debian, use 'reportbug wmbiff' and submit a
43 wishlist bug.  Or, send mail with your suggestion to
44 wmbiff-devel@lists.sourceforge.net.  Feature requests on
45 sourceforge don't get the same attention.
47 Some previously requested features can't be done:
48  - Count IMAP deleted messages separately (the protocol
49     doesn't support it without locking the mailbox).
50  - Reset the count of new messages to zero when spawning
51     a mailer (it would just jump back again the next time 
52     wmbiff looked).
54 Previously suggested features that are really hard:
55  - Support dock sizes other than 64x64
56  - Inverse video on new mail (or do more visually to grab attention)
58 * I'm about to start writing a patch. How do I make sure it will 
59 get incorporated in WMBiff?
61 Start a conversation on wmbiff-devel, and you'll probably
62 get some help. 
64 Tidbits: 
65  Avoid creating new Clients.  
66   - If you want an existing client to do something differently, 
67     find a way to parameterize its behavior. 
68   - If you want to use a shell command to get some
69     information, make a recipe for ShellClient (open wmbiff.c 
70     and search for 'gicu').
71  If you must create a new client, Avoid Duplicating Code.
72  Document your patch.  Add entries as appropriate to:
73   - sample.wmbiffrc
74   - wmbiffrc.5.in
75   - wmbiff.1
77 * How do I get the very latest WMBiff from SourceForge CVS?
79 See http://sourceforge.net/cvs/?group_id=26389, or 
80 http://sourceforge.net/projects/wmbiff then click on CVS.
82 cvs -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/wmbiff login 
83 cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/wmbiff co wmbiff 
85 * I added a feature to WMBiff. How do I submit a patch?
86 ** If you've modified code from a .tar.gz
87  If you've modified a version of WMBiff downloaded from the web:
88   (in the wmbiff-x.x.x/wmbiff directory)
89   make indent
90   cd ..
91   make distclean 
92   cd ..
93   mv wmbiff-x.x.x wmbiff-changed
94   tar xvfz wmbiff-x.x.x.tar.gz
95   diff --unified --recursive --new-file wmbiff-x.x.x wmbiff-changed > my-patch
96 ** If you've modified code from CVS
97   (in the wmbiff/wmbiff directory)
98   make indent
99   cd ..
100   [ optionally 'make distcheck' ]
101   make maintainer-clean 
102   cvs update -d
103   [ resolve any conflicts ]
104   cvs diff -u | less     [ make sure the differences are roughly correct ]
105   cd ..
106   mv wmbiff wmbiff-changed
107   [ now checkout a new copy of wmbiff ] 
108   diff --unified --recursive --new-file --exclude CVS wmbiff wmbiff-changed > my-patch
109     
110 ** Sending the patch
111 Submit my-patch as an attachment to mail sent to
112 wmbiff-devel. Don't forget to subscribe to the mailing list
113 so that we can discuss your patch.  This is roughly the same
114 procedure you'll use to submit patches to any code, although
115 others may not have the 'make indent' step.
118 * This FAQ is wrong.  
120 Send mail to wmbiff-devel@lists.sourceforge.net.
122 ;;; Local Variables: ***
123 ;;; mode: outline ***
124 ;;; End: ***