~ubuntu-branches/debian/squeeze/geany-plugins/squeeze

« back to all changes in this revision

Viewing changes to geanysendmail/README

  • Committer: Bazaar Package Importer
  • Author(s): Chow Loong Jin
  • Date: 2009-07-10 22:56:41 UTC
  • Revision ID: james.westby@ubuntu.com-20090710225641-xc1126t7pq0jmpos
Tags: upstream-0.17.1
ImportĀ upstreamĀ versionĀ 0.17.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
GeanySendMail Plugin
 
2
(0.4.2)
 
3
 
 
4
 
 
5
About
 
6
------
 
7
 
 
8
GeanySendMail is a little plugin to send a document as attachment
 
9
using the preferred mail client from inside Geany. It is similar to
 
10
the envelope symbol of most office tools and requires a mail client
 
11
that is supporting remote calls.
 
12
 
 
13
 
 
14
Requirements
 
15
------------
 
16
 
 
17
For compiling the plugin yourself, you will need the GTK (>= 2.6.0)
 
18
libraries and header files. You will also need its dependency
 
19
libraries and header files, such as Pango, Glib and ATK. All these
 
20
files are available at http://www.gtk.org.
 
21
 
 
22
And obviously, you will need to have Geany installed. If you have Geany
 
23
installed from the sources, you should be ready to go. If you used a
 
24
prepared package e.g. from your distribution you probably need to
 
25
install an additional package, this might be called geany-dev or
 
26
geany-devel. Please note that in order to compile and use this plugin,
 
27
you need Geany 0.16 or later (Geany Plugin API v116 or higher).
 
28
 
 
29
Furthermore you need, of course, a C compiler and the Make tool. The
 
30
GNU versions of these tools are recommended.
 
31
 
 
32
 
 
33
Installation
 
34
------------
 
35
 
 
36
Compiling and installing the code is done by the following three
 
37
commands:
 
38
 
 
39
$ ./configure
 
40
$ make
 
41
$ make install
 
42
 
 
43
For more configuration details run
 
44
$ ./configure --help
 
45
 
 
46
If there are any errors during compilation, check your build environment
 
47
and try to find the error, otherwise contact one of the authors. (See below)
 
48
 
 
49
 
 
50
Usage
 
51
-----
 
52
 
 
53
After installed successfully, load the plugin in Geany's plugin manager
 
54
and a new menu item in the Tools menu will appear. Before you can start
 
55
you need to configure your mail client. This can be done in the
 
56
configuration dialog (details on it later). You can also assign a
 
57
keyboard shortcut in Geany's preferences dialog to send your document.
 
58
 
 
59
 
 
60
Configuration
 
61
-------------
 
62
 
 
63
In the configuration dialog you can set up a command that is called by the
 
64
plugin to communicate with your mail client. Depending on what's
 
65
your favorite mailer, the command will differ. A number of placeholders
 
66
are available for doing this:
 
67
 
 
68
* %s: Will be replaced by the complete path of the file that should be send.
 
69
* %r: Will be replaced by one or more recipient's email address that can
 
70
be entered inside a separate dialog. (Please remember during input,
 
71
what your mail client is expecting here)
 
72
* %b: Will be replace by the file name. For a file /tmp/foo.baa it will
 
73
be replaced by foo.baa.
 
74
 
 
75
Depending on how you like to use, you can combine all of the placeholders
 
76
to build up your command. It is possible to use one placeholder
 
77
several times. Examples could be:
 
78
        sylpheed --attach "%f" --compose "%r"
 
79
        mutt -s "Sending '%b'" -a "%f" "%r"
 
80
        "C:\Program Files\Mozilla Thunderbird\thunderbird.exe" \
 
81
                -compose to="%r",subject="%b",attachment="%f"
 
82
 
 
83
 
 
84
Development
 
85
-----------
 
86
 
 
87
You can checkout the current source code from the Subversion repository at
 
88
Sourceforge.net. Get the code from:
 
89
 
 
90
svn checkout
 
91
http://geany-plugins.svn.sourceforge.net/svnroot/geany-plugins/trunk/geanysendmail
 
92
 
 
93
If you want to create a patch, please respect the license of GeanySendMail
 
94
as well as intellectual property of third. Patches that should be
 
95
included to the default distribution must be licensed under the same conditions
 
96
as GeanySendMail by the copyright owner.
 
97
 
 
98
 
 
99
Known issues
 
100
-----------
 
101
 
 
102
During installation it might happen, that the plugin wants to install the
 
103
files for localization to /usr/local as a prefix. This can be avoided by
 
104
adding --prefix="/new/path" when running configure/autogen.sh.
 
105
 
 
106
In case you are working with white spaces either in your path names,
 
107
file names or at mail addresses (e.g. for separating two addresses) you
 
108
should keep care of proper quoting since %s, %b and %r will be replaced
 
109
without any quotes.
 
110
 
 
111
For more recent information all reported issues will be tracked at
 
112
http://sourceforge.net/tracker/?group_id=222729
 
113
 
 
114
 
 
115
License
 
116
-------
 
117
 
 
118
GeanySendMail and all its parts is distributed under the terms of the
 
119
GNU General Public License as published by the Free Software
 
120
Foundation; either version 2 of the License, or (at your option) any
 
121
later version. A copy of this license can be found in the file COPYING
 
122
included with the source code of this program. If not, you will be
 
123
able to get a copy by contacting the Free Software Foundation, Inc.,
 
124
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 
125
 
 
126
 
 
127
Bugs, questions, bugs, homepage
 
128
---------------------------------
 
129
 
 
130
If you found any bugs or want to provide a patch, please contact Frank
 
131
Lanitz (frank(at)geany(dot)org). Please also do so, if you got any
 
132
questions and visiting http://frank.uvena.de/en/Geany/geanysendmail
 
133
didn't help you to figure out the answer. Visiting the website is also
 
134
a good start if you want to check for any update on this plugin.