Pumpa v0.8.4

Greetings, fellow pumpkins!

Pumpa is a simple pump.io client written in C++ and Qt, and licensed under the GNU GPL 3.0 (or later).

Please report any bugs or feature requests to the bug tracker. If that doesn’t work for some reason, you can always contact me via e-mail: mats@sjoberg.fi.

The Pumpa source code includes codes and graphics from other people:

Oh, and “pumpa” is a Swedish word that means either “to pump” (as a verb) or “pumpkin” (as a noun) :-)

Pumpa was mentioned on LWN: “Searching for a pump.io client”.

Installing

Pumpa is packaged in Debian jessie and sid and Ubuntu trusty, so if you are using one of those, you can simply install it with your favourite package manager or by typing (as root or using sudo):

apt-get install pumpa

In addition, some third parties have provided packages or installers for other platforms listed below. Please note, that I have no control over these, so please report any problems with them to the respective packagers/authors. Alternatively you can download the source code and compile it yourself, it’s pretty easy (see the following sections).

Fedora

By Matt Molyneaux: http://moggers.co.uk/~moggers87/repo/pumpa/

“Metal Biker” has a Fedora Copr repo for Pumpa and Dianara: http://sylke.altervista.org/repo/

Debian (Spanish)

By Fabián Bonetti configured for Spanish: http://mamalibre.no-ip.org/

openSUSE

By “XRevan86”: http://software.opensuse.org/package/pumpa

Archlinux AUR

By “speps”: https://aur.archlinux.org/packages/?K=pumpa

Microsoft Windows

By Tim Schumacher: http://bandenkrieg.hacked.jp/~tim/pumpa/

Mac OS X

By Al aka chunder@identi.ca: http://juu.st/pumpa/

Build dependencies

Pumpa should build with Qt 4.8 or Qt 5.0 or newer. If you are using Qt 4, you will also need the QJson library.

For example on Debian 7.0 “wheezy” the following command should install everything needed to build the code:

aptitude install qt4-qmake libqt4-dev libqjson-dev

If you want spell checking install the aspell library as well:

aptitude install libaspell-dev

On Fedora this should install what you need (courtesy of Dick Turpin):

yum install gcc-c++ qt-devel qt-config qjson-devel

Building

To download and build, type the following:

git clone git://gitorious.org/pumpa/pumpa.git
cd pumpa
qmake-qt4     # or just "qmake" on some systems
make

The procedure on Mac OS X is the same, but getting the dependencies is a bit different, David Haberthür has made a detailed guide for building on Mac OS X here: https://github.com/e14n/pump.io/wiki/HowTo-for-building-Pumpa-on-OS-X

Axel has a blog post about compiling for Windows here: https://axel668.wordpress.com/2013/07/18/how-to-build-pumpa-qt-based-pump-io-client-for-windows/

Running

On Linux you can start pumpa by running its binary:

./pumpa

On Mac OS X a regular clickable application file (pumpa.app) should be created.

At first launch an OAuth wizard will pop-up, just enter your pump.io account id, and click Next. Then a the authentication page with your pump.io server will be opened in the web browser, just follow the instructions there. Finally a pair of codes (token, verifier) will appear that you need to copy & paste back into pumpa.

Markdown

When you are posting a new note or comment you can use Markdown syntax. Since Pumpa version v0.8.4 inline HTML is also allowed as in standard Markdown.

For example:

Enable the Preview below the text editing window to see what the output will be before posting it to pump.io.

For the full Markdown syntax see John Gruber’s page.

Configuration

Most features and configuration options should be obvious from the graphical user interface, but some are a bit hidden. For example, while Pumpa doesn’t support multiple accounts, you can always start it with a different configuration file (which can specify another pump.io account for example) like this:

./pumpa -c path_to_alternative.conf

If you are setting up a new account you can give the path to a non-existent conf-file and Pumpa will run the setup wizard and create the conf-file for you with the name you specified.

The location of the default configuration file depends on Qt, which tries to pick a location that makes sense for your operating system. E.g. in GNU/Linux systems it is typically in:

~/.config/pumpa/pumpa.conf

Most configuration options are exposed via the preferences dialog in Pumpa, except for setting the link colour. The link colour is supposed to be automatically set by the theme settings of your desktop environment, but several people requested a way to override this.

You can add a line like this under the [%General] section in the configuration file:

link_color=#333

The text after the equals sign can be any text string that Qt can parse as a colour. (Yes I know colour is spelt wrong in the config name :-)

Debug mode

If you experience crashes it may be useful to run Pumpa in debug mode. Right now you’ll need to recompile it for that with the following steps:

cd pumpa
make clean
qmake CONFIG+=debug
make

To run in the debugger (you need to have gdb installed):

gdb ./pumpa

Inside gdb you then start Pumpa with the command run, when it has crashed you’ll be thrown back to the debugger, then type where, which will tell you where it crashed. This information can be very useful (in particular the first 10-20 lines), please include it if you report a bug.

Translations

Pumpa currently has Spanish, French, Na’vi, Italian and German translations. Any new translations are most welcome, but please tell me first (mats@sjoberg.fi) so that people don’t do duplicate work!

If you want to translate Pumpa you need to edit a .ts file. Any TS translation tool is probably OK, but these instructions assume you will use the Linguist tool that comes with Qt. Here are the steps:

License

Copyright 2014 Mats Sjöberg mats@sjoberg.fi.

All of the source code of Pumpa is licensed under the GPLv3.

GPLv3

Pumpa is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Pumpa is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Pumpa. If not, see http://www.gnu.org/licenses/.