remove unneeded file
[claws.git] / README.claws
index 30db04b..63314d9 100644 (file)
@@ -4,17 +4,25 @@ README.claws
 Summary:
 
 1. What is Sylpheed Claws?
-2. Switching to Claws
+2. Switching between Sylpheed Claws and Sylpheed
+   * From Sylpheed to Sylpheed Claws
+   * From Sylpheed Claws to Sylpheed
 3. Things Claws does different
    * auto address replacement in summary view
    * manual selection of MIME types for attachments
    * sharing mail folders
    * default to address for folders
    * threading mode per folder
-   * quotation wrapping
+   * simplify subject string
+   * pixmap themes
+   * user definable actions
    * spell checking (with installation instructions)
 4. How to contribute
 5. How to request features
+6. Installing Claws from CVS
+7. History
+
+
 
 1. What is Sylpheed Claws?
 --------------------------
@@ -31,43 +39,55 @@ For brevity Sylpheed Claws is referred to as Claws, and Sylpheed as either
 Sylpheed or Main.
 
 
-2. Switching to Claws
----------------------
-
-From the user perspective Claws is just a fancy Sylpheed, so it uses the
-same sylpheed setting files located in ~/.sylpheed.
 
-It's always a good idea to back up all files in ~/.sylpheed in case
-you want to switch back to Sylpheed. (You don't have to backup the
-directories.)
+2. Switching between Sylpheed Claws and Sylpheed
+------------------------------------------------
 
-There are some things that frequently come up when switching to Claws:
+  From Sylpheed to Sylpheed Claws      
+  -------------------------------
 
+  From the user perspective Claws is just a fancy Sylpheed, so it uses the
+  same sylpheed setting files located in ~/.sylpheed.
 
-* When replying, the original sender's text is not quoted anymore.
+  It's always a good idea to back up all files in ~/.sylpheed in case
+  you want to switch back to Sylpheed. (You don't have to backup the
+  directories.)
 
-  Claws has a different quote format handler. Add either %Q or %q to the
-  quote format text. Also click the button "Description of symbols"
-  for more quotation symbols.
+  There are some things that frequently come up when switching to Claws:
 
 
-* Why does the advanced filtering system not work?
+  * Why does the advanced filtering system not work?
 
-  Claws uses the new filtering system as soon as you define a new rule for it.
-  Your old sylpheed filter rules will not be used. In subdirectory tools/ of
-  the distribution there is a Perl script called filter_conv.pl which convers
-  old filter rules to the claws filtering system.
+    Claws uses the new filtering system as soon as you define a new rule for it.
+    Your old sylpheed filter rules will not be used. In subdirectory tools/ of
+    the distribution there is a Perl script called filter_conv.pl which convers
+    old filter rules to the claws filtering system.
   
 
-* What happened to the compose email and compose news buttons? 
+  * What happened to the compose email and compose news buttons? 
+
+    There's a composite button for both composing mail and news. You can toggle
+    between composing mail and news by clicking on the button with the triangle.
+
 
-  There's a composite button for both composing mail and news. You can toggle
-  between composing mail and news by clicking on the button with the triangle.
+  * And to the Preferences and Execute buttons?
 
+    Sorry, they're not there.
 
-* And to the Preferences and Execute buttons?
 
-  Sorry, they're not there.
+  From Sylpheed Claws to Sylpheed
+  -------------------------------
+
+  Moving from Claws to Sylpheed is also simple. Sylpheed should neglect the things
+  Claws put in the settings files. This also means that the old rules will work
+  again. 
+
+  If you want to switch back to Claws at a later time, make sure you back up at least
+  ~/.sylpheed/filteringrc (the Claws filtering rules), and ~/.sylpheed/sylpheedrc 
+  (which may have some claws specific settings).
+
+  When switching back to Sylpheed you will not lose messages or message flags (color
+  labels, read / unread status of messages). 
 
 
 
@@ -102,16 +122,17 @@ are hardly noticable, but deserve mentioning:
    to send a private mail, don't have a folder selected with this setting
    set.)
 
-* threading mode per folder
-  Folders can have their own threading and sorting mode. Just select a 
-  folder, and set their threading and sorting mode.
-
+* pixmap themes
+  To use different icon sets you need to create a directory: 
+       mkdir ~/.sylpheed/themes
+  Icon sets should be placed in this directory in their own sub-directory. 
+  They are then selectable from Pixmap Theme on the Interface tab of Commmon
+  Preferences. 
 
-* quotation wrapping
-  Quotation is wrapped like VIM would wrap it (at least that was the
-  goal). To enable this feature go to Common preferences->Compose and
-  make sure Wrap quotation is enabled. The text is automatically
-  wrapped when you reply to an e-mail if this feature is enabled.
+* user definable actions
+  Actions can be executed on message text view, or on the message's file.
+  To configure new actions use Configuartion->Actions. Your actions are
+  then available from Edit->Actions in the main window and compose window.
 
 * Spell checker for Sylpheed-Claws
   
@@ -176,12 +197,15 @@ are hardly noticable, but deserve mentioning:
   c. Usage
   --------
 
+  NOTE: if you upgraded from 0.7.0claws, please reselect your default
+  dictionary in the preferences.
+
   After successful compiling, you need to tell sylpheed where your
   dictionaries reside.  First run 'pspell-config pkgdatadir' on the
   shell to get their path.
 
   Then run sylpheed and go to Configuration -> Common preferences ->
-  Compose.  Check the box 'Enable spell checker (EXPERIMENTAL)' and
+  Spell Checker.  Check the box 'Enable spell checker (EXPERIMENTAL)' and
   use the file selector ('...' button) to select the path where the
   dictionaries reside.  Within the file selector, go to that directory
   and select *any* file in the file lists.  Click ok. You should then
@@ -189,16 +213,41 @@ are hardly noticable, but deserve mentioning:
 
   When composing, misspelled words are highlighted.  Click on any
   highlighted word with the right mouse button to get a list of
-  suggestions.  You can also accept the highlighted word to the
-  session dictionary (equivalent to an 'ignore' option of other spell
-  checker), or you can add it to you personal dictionary.
+  suggestions.  The first entry of the menu just displays the unknown
+  word.  Selecting "Accept in this session" (or hitting MOD1-Space, 
+  where MOD1 is usually the ALT key), will ignore this word and accept
+  it in this message.  Selecting the next entry "Add to dictionary", which
+  is bound to MOD1-Enter combination will add the unknown word to the
+  dictionary to learn it.  The next entries are the suggested words. 
+  The first 15 suggestions can be accessed typing one of the first letters
+  of latin alphabet (if this does not suit your language, please send
+  a mail to melvin.hadasht@free.fr).  If you are using an aspell 
+  dictionary, you can use its 'learn from mistake' feature, by pressing
+  the MOD1 key and selecting the suggestion (with the keyboard or with
+  the mouse).  See pspell manual ยง4.7.1 for an explanation of this 
+  feature. 
 
   If you click with the right mouse button everywhere else, or if you
   shift-right-click even on a misspelled word, you get the
   configuration  menu.  'Check all' highlights all misspelled words.
   With this menu, you can also change the dictionary while editing.
-  You can change the suggestion mode and toggle the learn from
-  misktakes 'feature' (useful only with aspell).
+  FInally, you can change the suggestion mode misktakes 'feature' 
+  (useful only with aspell).
+
+  Spell checking can also be done using keyboard shortcuts.  In the
+  "Edit" menu of the compose window, there are two menus "Check backwards
+  misspelled word" and "Forward to next misspelled word".  Add to them 
+  appropriate keyboard shortcuts.  "Check backwards misspelled word" 
+  checks backwards from cursor position for the first misspelled word.
+  If it finds one, it displays the suggestions lists which can be handled
+  with the keyboard as described before. When the suggestion menu is 
+  closed, the cursor returns to its original position to be able to 
+  continue editing.  The "Forward to next misspelled word" do the same 
+  thing in the other direction but moves the cursor at the end of the
+  misspelled word.  This way, you can spell check easily a whole message
+  starting from its beginning and using the "Forward to next misspelled
+  word" keyboard short cut.
+  
 
   d. Known problems
   -----------------
@@ -231,11 +280,21 @@ are hardly noticable, but deserve mentioning:
     to the 'pkgdatadir' and run 'make-ispell-pwli'.  You may need to
     su root.
 
+* simplify subject string
+    It is possible to remove parts of string from the subject line.
+    Example: [Sylpheed-claws-users] This is a test
+    becomes: This is a test
+    This is a per folder property. Right click on a folder and select
+    property, enable Simplify Subject RegExp check box. Example
+    regexp for the above is: \[Sylpheed-claws-(devel|users)\]
+    Another example for the Sylpheed mailing list (not claws!) is:
+    \[sylpheed:[0-9]{5}\]
 
 There are a lot more options. If you find one, don't hesitate to
 mention it.
 
 
+
 4. How to contribute
 --------------------
 
@@ -265,6 +324,7 @@ a long time to stabilize, send a mail to Paul Mangan. We can probably
 arrange access to the Claws branch.
 
 
+
 5. How to request features
 --------------------------
 
@@ -275,3 +335,11 @@ and rejected for whatever reason.  You might want to go ahead and
 hack a patch for it. (That would be very cool!) Another
 possibility is to use the Feature Request Tracker at the
 sourceforge project page.
+
+
+
+6. History
+----------
+
+TODO
+