wmbiff: Update FAQ.
[dockapps.git] / wmbiff / FAQ
blob65832c307eb3db99d9def66a67235776af52640a
1 * Does WMBiff have a mailing list?
3 There is no longer a WMBiff-specific mailing list, but it may be discussed
4 on the Window Maker Developers mailing list, wmaker-dev@lists.windowmaker.org.
6 See http://lists.windowmaker.org/.
8 * Why doesn't WMBiff update immediately after I read my mail?
10 WMBiff looks only at the flags associated with mail messages
11 to decide if they've been read.  If your mail reader doesn't
12 bother to update those flags immediately after you read a
13 message, WMBiff has (essentially) no way of knowing that
14 you've read the message.
16 There are some workarounds:  In mutt, you can ask it to sync
17 the mailbox using the sync-mailbox command: it will write
18 the mailbox file to disk (or back to the IMAP server) so
19 that WMBiff can update its counters.  Mutt's sync-mailbox
20 command is bound to the $ key by default.  In Mac OS X mail,
21 changing to a different mailbox usually flushes changes,
22 so I often hit Command-4 to switch to the sent mailbox
23 for a few seconds.
25 No workarounds are known for Kmail, which updates the status
26 flags of all mail as if it were read, then adds its own
27 status field to note that some are unread.  (sourceforge
28 tracker #706995).
30 * WMBiff doesn't work.  How do I submit a bug?
32 See the Troubleshooting section of the wmbiffrc man
33 page.
35 If that doesn't work, run 'wmbiff -debug > wmbiff.log' and
36 remove any passwords left in wmbiff.log.  Submit this log
37 and your wmbiffrc (sanitized of passwords of course) using
38 'reportbug' under Debian, or by sending mail to
39 wmaker-dev.
41 * WMBiff doesn't do something I want. How do I suggest a feature?
43 If using Debian, use 'reportbug wmbiff' and submit a
44 wishlist bug.  Or, send mail with your suggestion to
45 wmaker-dev@lists.windowmaker.org.
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 wmaker-dev, 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 git?
79 git clone http://repo.or.cz/dockapps.git
80 cd dockapps/wmbiff
82 * I added a feature to WMBiff. How do I submit a patch?
84 Submit patches in the same way as you would patches for Window Maker.  See:
85 http://repo.or.cz/w/wmaker-crm.git/blob/HEAD:/The-perfect-Window-Maker-patch.txt
87 * This FAQ is wrong.
89 Send mail to wmaker-dev@lists.windowmaker.org.