[Pkg-wmaker-commits] [wmbiff] 37/77: a little documentation

[Doug Torrance]

This is an automated email from the git hooks/post-receive script.

dtorrance-guest pushed a commit to tag wmbiff_0_4_0
in repository wmbiff.

commit cadf087974ad4741adfc5a3eaf72657f24c0abb9
Author: bluehal <bluehal>
Date:   Mon Apr 15 08:14:51 2002 +0000

    a little documentation
---
 FAQ | 103 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 103 insertions(+)

diff --git a/FAQ b/FAQ
new file mode 100644
index 0000000..630a077
--- /dev/null
+++ b/FAQ
@@ -0,0 +1,103 @@
+* Does WMBiff have a mailing list?
+
+Subscribe to wmbiff-devel at lists.sourceforge.net.
+
+echo "subscribe wmbiff-devel" | mail majordomo at lists.sourceforge.net
+
+* WMBiff doesn't work.  How do I submit a bug?
+
+See the Troubleshooting section of the wmbiffrc man
+page.  
+
+If that doesn't work, run 'wmbiff -debug > wmbiff.log' and
+remove any passwords left in wmbiff.log.  Submit this log
+and your wmbiffrc (sanitized of passwords of course) using
+'reportbug' under Debian, or by sending mail to
+wmbiff-devel.
+
+* WMBiff doesn't do something I want. How do I suggest a feature?
+
+If using Debian, use 'reportbug wmbiff' and submit a
+wishlist bug.  Or, send mail with your suggestion to
+wmbiff-devel at lists.sourceforge.net.  Feature requests on
+sourceforge don't get the same attention.
+
+Some previously requested features can't be done:
+ - Count IMAP deleted messages separately (the protocol
+    doesn't support it without locking the mailbox).
+ - Reset the count of new messages to zero when spawning
+    a mailer (it would just jump back again the next time 
+    wmbiff looked).
+
+Previously suggested features that are really hard:
+ - Support dock sizes other than 64x64
+ - Inverse video on new mail (or do more visually to grab attention)
+
+* I'm about to start writing a patch. How do I make sure it will 
+get incorporated in WMBiff?
+
+Start a conversation on wmbiff-devel, and you'll probably
+get some help. 
+ 
+Tidbits: 
+ Avoid creating new Clients.  
+  - If you want an existing client to do something differently, 
+    find a way to parameterize its behavior. 
+  - If you want to use a shell command to get some
+    information, make a recipe for ShellClient (open wmbiff.c 
+    and search for 'gicu').
+ If you must create a new client, Avoid Duplicating Code.
+ Document your patch.  Add entries as appropriate to:
+  - sample.wmbiffrc
+  - wmbiffrc.5.in
+  - wmbiff.1
+
+* I added a feature to WMBiff. How do I submit a patch?
+** If you've modified code from a .tar.gz
+ If you've modified a version of WMBiff downloaded from the web:
+  (in the wmbiff-x.x.x/wmbiff directory)
+  make indent
+  cd ..
+  make distclean 
+  cd ..
+  mv wmbiff-x.x.x wmbiff-changed
+  tar xvfz wmbiff-x.x.x.tar.gz
+  diff --unified --recursive --new-file wmbiff-x.x.x wmbiff-changed > my-patch
+** If you've modified code from CVS,
+  (in the wmbiff/wmbiff directory)
+  make indent
+  cd ..
+  [ optionally 'make distcheck' ]
+  make maintainer-clean 
+  cvs update -d
+  [ resolve any conflicts ]
+  cvs diff -u | less     [ make sure the differences are roughly correct ]
+  cd ..
+  mv wmbiff wmbiff-changed
+  [ now checkout a new copy of wmbiff ] 
+  diff --unified --recursive --new-file wmbiff wmbiff-changed > my-patch
+    
+** Sending the patch
+Submit my-patch as an attachment to mail sent to
+wmbiff-devel. Don't forget to subscribe to the mailing list
+so that we can discuss your patch.  This is roughly the same
+procedure you'll use to submit patches to any code, although
+others may not have the 'make indent' step.
+ 
+
+* How do I get the very latest WMBiff from SourceForge CVS?
+
+See http://sourceforge.net/cvs/?group_id=26389, or 
+http://sourceforge.net/projects/wmbiff then click on CVS.
+ 
+cvs -d:pserver:anonymous at cvs.wmbiff.sourceforge.net:/cvsroot/wmbiff login 
+cvs -z3 -d:pserver:anonymous at cvs.wmbiff.sourceforge.net:/cvsroot/wmbiff co wmbiff 
+
+* This FAQ is wrong.  
+
+Send mail to wmbiff-devel at lists.sourceforge.net.
+
+;;; Local Variables: ***
+;;; mode: outline ***
+;;; End: ***
+

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-wmaker/wmbiff.git