SF.net SVN: geany-plugins:[979] trunk/geany-plugins/geanysendmail

frlan at users.sourceforge.net frlan at xxxxx
Sun Oct 11 19:58:40 UTC 2009 

Revision: 979
          http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=979&view=rev
Author:   frlan
Date:     2009-10-11 19:58:40 +0000 (Sun, 11 Oct 2009)

Log Message:
-----------
Update of documentation

Modified Paths:
--------------
    trunk/geany-plugins/geanysendmail/INSTALL
    trunk/geany-plugins/geanysendmail/NEWS
    trunk/geany-plugins/geanysendmail/README
    trunk/geany-plugins/geanysendmail/TODO

Modified: trunk/geany-plugins/geanysendmail/INSTALL
===================================================================
--- trunk/geany-plugins/geanysendmail/INSTALL	2009-10-07 21:06:33 UTC (rev 978)
+++ trunk/geany-plugins/geanysendmail/INSTALL	2009-10-11 19:58:40 UTC (rev 979)
@@ -1,16 +1,3 @@
-These installation instructions are written for a Linux system.
-
-At the time of this writing, building the plugin requires a recent SVN checkout
-of the Geany sources (API version 104, Geany v0.16svn+).
-
-To compile and install just follow the typical three steps:
-
- % configure
- % make
- % make install
-
-The plugin will be installed into your $prefix/lib/geany of your Geany
-installation. This should be in most cases /usr/ or /usr/local. So you will
-need in most cases to run make install under root. If you don't want to
-install it global, but on your own home dir, just --prefix option for configure.
-Please check README for more detailed information.
+GeanySendMail as distributed within the geany-plugins package doesn't
+have a own build system for its own. Please check documentation of
+geany-plugins release instead.

Modified: trunk/geany-plugins/geanysendmail/NEWS
===================================================================
--- trunk/geany-plugins/geanysendmail/NEWS	2009-10-07 21:06:33 UTC (rev 978)
+++ trunk/geany-plugins/geanysendmail/NEWS	2009-10-11 19:58:40 UTC (rev 979)
@@ -1,4 +1,4 @@
-GeanySendMail 0.4.2 (26. May 2009=:
+GeanySendMail 0.4.2 (26. May 2009):
     * Added cancel button to recipient's address dialog
 	* Some minor code cleanup
 

Modified: trunk/geany-plugins/geanysendmail/README
===================================================================
--- trunk/geany-plugins/geanysendmail/README	2009-10-07 21:06:33 UTC (rev 978)
+++ trunk/geany-plugins/geanysendmail/README	2009-10-11 19:58:40 UTC (rev 979)
@@ -1,5 +1,5 @@
 GeanySendMail Plugin
-(0.4.2)
+(0.4.2 - Geany-plugins 0.19)
 
 
 About
@@ -14,7 +14,7 @@
 Requirements
 ------------
 
-For compiling the plugin yourself, you will need the GTK (>= 2.6.0)
+For compiling the plugin yourself, you will need the GTK (>= 2.8.0)
 libraries and header files. You will also need its dependency
 libraries and header files, such as Pango, Glib and ATK. All these
 files are available at http://www.gtk.org.
@@ -33,80 +33,87 @@
 Installation
 ------------
 
-Compiling and installing the code is done by the following three
-commands:
+This version of the plugin is installed with the combined
+geany-plugins release. Please check README of this package or download
+stand alone version of plugin from
+http://frank.uvena.de/en/Geany/geanysendmail/
 
-$ ./configure
-$ make
-$ make install
 
-For more configuration details run
-$ ./configure --help
-
-If there are any errors during compilation, check your build environment
-and try to find the error, otherwise contact one of the authors. (See below)
-
-
 Usage
 -----
 
-After installed successfully, load the plugin in Geany's plugin manager
-and a new menu item in the Tools menu will appear. Before you can start
-you need to configure your mail client. This can be done in the
-configuration dialog (details on it later). You can also assign a
+After installed successfully, load the plugin in Geany's plugin
+manager and a new menu item in the Tools menu will appear. Before you
+can start you need to configure your mail client. This can be done in
+the configuration dialog (details on it later). You can also assign a
 keyboard shortcut in Geany's preferences dialog to send your document.
 
 
 Configuration
 -------------
 
-In the configuration dialog you can set up a command that is called by the
-plugin to communicate with your mail client. Depending on what's
-your favorite mailer, the command will differ. A number of placeholders
-are available for doing this:
+In the configuration dialog you can set up a command that is called by
+the plugin to communicate with your mail client. Depending on what's
+your favorite mailer, the command will differ. A number of
+placeholders are available for doing this:
 
-* %s: Will be replaced by the complete path of the file that should be send.
-* %r: Will be replaced by one or more recipient's email address that can
-be entered inside a separate dialog. (Please remember during input,
-what your mail client is expecting here)
-* %b: Will be replace by the file name. For a file /tmp/foo.baa it will
-be replaced by foo.baa.
+* %s: Will be replaced by the complete path of the file that should be
+send.
+* %r: Will be replaced by one or more recipient's email address that
+can be entered inside a separate dialog. (Please remember during
+input, what your mail client is expecting here)
+* %b: Will be replace by the file name. For a file /tmp/foo.baa it
+will be replaced by foo.baa.
 
-Depending on how you like to use, you can combine all of the placeholders
-to build up your command. It is possible to use one placeholder
-several times. Examples could be:
+Depending on how you like to use, you can combine all of the
+placeholders to build up your command. It is possible to use one
+placeholder several times. When using keep care, as the placeholders
+are replace step by step, so a filename containing %b might have some
+funny outcome. However, examples could be:
+	
+Sylpheed:
 	sylpheed --attach "%f" --compose "%r"
+mutt:
 	mutt -s "Sending '%b'" -a "%f" "%r"
+Mozilla Thunderbird at Windows:
 	"C:\Program Files\Mozilla Thunderbird\thunderbird.exe" \
 		-compose to="%r",subject="%b",attachment="%f"
 
+In theory it should also work together with tools like Microsoft
+Outlook - Unfortunately the authoer wasn't able to bring it up
+running. Input for the correct commandline is highly welcome.
 
+
 Development
 -----------
 
-You can checkout the current source code from the Subversion repository at
-Sourceforge.net. Get the code from:
+You can checkout the current source code from the Subversion
+repository at Sourceforge.net. Get the code from:
 
 svn checkout
 http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geanysendmail
 
-If you want to create a patch, please respect the license of GeanySendMail
-as well as intellectual property of third. Patches that should be
-included to the default distribution must be licensed under the same conditions
-as GeanySendMail by the copyright owner.
+As this plugin is part of the combined geany-plugins release, you may
+also like to check its Subversion repository by checking ou
 
+svn checkout
+http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geany-plugins/
 
+
+If you want to create a patch, please respect the license of
+GeanySendMail (GPLv2 or above) as well as intellectual property of
+third. Patches that should be included to the default distribution
+must be licensed under the same conditions as GeanySendMail by the
+copyright owner.
+
+
 Known issues
 -----------
 
-During installation it might happen, that the plugin wants to install the
-files for localization to /usr/local as a prefix. This can be avoided by
-adding --prefix="/new/path" when running configure/autogen.sh.
-
 In case you are working with white spaces either in your path names,
-file names or at mail addresses (e.g. for separating two addresses) you
-should keep care of proper quoting since %s, %b and %r will be replaced
-without any quotes.
+file names or at mail addresses (e.g. for separating two addresses)
+you should keep care of proper quoting since %s, %b and %r will be
+replaced without any quotes.
 
 For more recent information all reported issues will be tracked at
 http://sourceforge.net/tracker/?group_id=222729

Modified: trunk/geany-plugins/geanysendmail/TODO
===================================================================
--- trunk/geany-plugins/geanysendmail/TODO	2009-10-07 21:06:33 UTC (rev 978)
+++ trunk/geany-plugins/geanysendmail/TODO	2009-10-11 19:58:40 UTC (rev 979)
@@ -1,6 +1,5 @@
 TODO
 ----
 
- * Buildsupport for Win32 (Needs some testing)
  * Support for Inline-mailing (embedded text inside mail)
  * Send mail directly (only UNIX like systems)


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

More information about the Plugins-Commits mailing list