C Python Makefile CSS C++ M4 Other
Permalink
Failed to load latest commit information.
css Fixes #49: incorrect path in help Sep 23, 2014
doc Update cookie usage hint in FAQ Jun 20, 2018
dtd *** empty log message *** Jan 16, 2005
glade Merge pull request #634 from Leiaz/enclosure-download-choice-575 May 1, 2018
man Update manpage Dec 26, 2015
opml #651: Fixes FMA link in default OPMLs (reported by benjbrandall) Jun 5, 2018
pixmaps Automatic update of themed icons #251 Nov 17, 2016
plugins Fixes #627: GnomeKeyring plugin fails to activate when keyring does … Apr 11, 2018
po Adds mark all read confirmation dialog May 1, 2018
src Merge pull request #652 from Leiaz/fixes-557 Jun 20, 2018
xslt Fix comment grammar Dec 26, 2017
.gitignore Exclude desktop entry and D-BUS service targets Nov 19, 2016
.travis.yml Update .travis.yml Sep 19, 2017
AUTHORS Update to match contributions Jan 7, 2018
COPYING Fixes SF #1041: Some GPLv2 license headers were outdated (reported by… Dec 25, 2012
ChangeLog Adding missing Changelog for #634,#614,#591,#630,#619,#600 May 1, 2018
Dockerfile Fix make test invocation. Sep 20, 2017
INSTALL Include git compile instructions in INSTALL Nov 19, 2016
Makefile.am Headerbar support via plugin (discussion in #276) Apr 10, 2018
README.md Update deps Apr 11, 2018
autogen.sh Fixes #331: wrong permission of autogen.sh Apr 4, 2016
configure.ac Version bump. May 1, 2018
liferea.appdata.xml.in appdata: Set the component type to desktop-application Mar 2, 2018
liferea.convert Removes unused setting keys from schema Feb 25, 2018
net.sf.liferea.gschema.xml.in Merge pull request #634 from Leiaz/enclosure-download-choice-575 May 1, 2018
net.sourceforge.liferea.desktop.in Add keywords: syndication; rss; atom May 4, 2018

README.md

Build Status Coverity Scan Build Status

Introduction

Liferea is a desktop feed reader/news aggregator that brings together all of the content from your favorite subscriptions into a simple interface that makes it easy to organize and browse feeds. Its GUI is similar to a desktop mail/newsclient, with an embedded graphical browser.

screenshot

Installation from Package

For distro specific package installation check out https://lzone.de/liferea/install.htm

Building Liferea Yourself

This section describes how to compile Liferea yourself. If you have any problems compiling the source file an issue at Github and we will help you asap.

Mandatory Dependencies

gtk3 libxml2 libxslt sqlite3 libwebkit4 libjson-glib libgirepository1.0 libpeas gsettings-desktop-schemas python3

Compiling from Tarball

Download a tarball from https://github.com/lwindolf/liferea/releases and extract and compile with

tar jxvf liferea-1.12.0.tar.bz2 
./configure
make
make install
Compiling from Git

Check out the code:

git clone https://github.com/lwindolf/liferea.git

Then build it with:

./autogen.sh
make
make install

If you compile with a --prefix directory which does not match $XDG_DATA_DIRS you will get a runtime error about the schema not being found. To workaround set $XDG_DATA_DIRS before starting Liferea. For example:

my_dir=$HOME/tmp/liferea
./autogen.sh --prefix=$my_dir
make
make install
env XDG_DATA_DIRS="$my_dir/share:$XDG_DATA_DIRS" $my_dir/bin/liferea

Contributing

As the project is hosted at Github pull requests and tickets via Github are the best way to contribute to Liferea.

Translating

Before starting to translate you need a translation editor. We suggest to use poedit or gtranslator. Please edit the translation using such a translation editor and send us the resulting file. Once you have finished your work please send us the resulting file.

Please do not send translation patches. Those are a lot of work to merge and the bandwidth saving is not that huge!

New Translations

To create a new translation you must load the translation template, which you can find in the release tarball as "po/liferea.pot", into the translation editor. After editing it save it under a new name (usually your locales name with the extension ".po").

Updating Translations

When updating an existing translation please ensure to respect earlier translators work. If the latest translation is only a few months old please contact the latest translator first asking him to review your changes especially if you change already translated literals.

Localizing Feed Lists

When Liferea starts for the first time it installs a localized feed list if available. If this is not the case for your locale you might want to provide one. To check if there is one for your country have a look into the "opml" subdirectory in the latest release tarball or GIT.

If you want to provide/update a localized feed list please follow these rules:

  • Keep the English part of the default feed list
  • Only add neutral content feeds (no sex, no ideologic politics, no illegal stuff)
  • Provide good and short feed titles
  • Provide HTML URLs for each feed.

Once finished post the result OPML file in the mailing list or the SF patch tracker.

Creating Plugins

Liferea 1.10+ support GObject Introspection based plugins using libpeas. The Liferea distribution comes with a set of Python plugin e.g. the media player, GNOME keyring support, a tray icon plugin and maybe others.

Why We Use Plugins?

The idea behind plugins is to extend Liferea without changing compile time requirements. With the plugin only activating if all its bindings are available Liferea uses plugins to automatically enable features where possible.

How Plugins Interact With Liferea

You can develop plugins for your private use or contribute them upstream. In any case it makes sense to start by cloning one of the existing plugins and to think about how to hook into Liferea. There are two common ways:

  • using interfaces,
  • or by listening to events on Liferea objects,
  • or not at all by just controlling Liferea from the outside.

The media player is an example for 1.) while the tray icon is an example for 3.) If you find you need a new plugin interface (called Activatables) in the code feel free to contact us on the mailing list. In general such a tight coupling should be avoided.

About the exposed GIR API: At the moment there is no stable API. Its just some header files fed into g-ir-scanner. Despite this method names of the core functionality in Liferea has proven to be stable during release branches. And if you contribute your plugin upstream it will be updated to match renamed functionality.

Testing Plugins

To test your new plugin you can use ~/.local/share/liferea/plugins. Create the directory and put the plugin script and the .plugin file there and restart Liferea.

Watch out for initialization exceptions on the command line as they will permanently disable the plugin. Each time this happens you need to reenable the plugin from within the plugin tab in the preferences dialog!

How to Help With Testing
Bug Reports

If you want to help with testing grab the latest tarball or follow GIT master and write bug reports for any functional problem you experience. If you have time help with bug triaging the SF tracker. Check if you see any of the open bugs on your setup.

Debugging Crashes

In case of crashes create gdb backtraces and post them in the bug tracker. To create a backtrace start Liferea using "gdb liferea". At the gdb prompt type "run" to start the execution and "bt" after the crash. Send us the "bt" output!

Note: Often people confuses assertions with crashes. Assertions do halt the program because of a totally unexpected situation. Creating a backtrace in this situation will only point to the assertion line, which doesn't help much. In case of an assertion simply post a bug report with the assertion message.

Debugging Memory Leaks

If you see memory leakage please take the time to do a run

valgrind --leak-check=full liferea

to identify leaks and send in the output.

Browser Integration

Liferea allows subscribing directly from Firefox and browser with similar mechanism

Firefox

If you want to subscribe from within Firefox you can configure it to add subscriptions to Liferea directly. To do so click the feed icon in the location entry. Firefox will then present a menu where you can configure a manual command instead of the Live Bookmarks to add subscriptions.

There enter

liferea-add-feed

How to Get Support

When using distribution packages:

Do not post bug reports in the Liferea bug tracker, use the bug reporting system of your distribution instead. We (upstream) cannot fix distribution packages!

Before getting support for stable releases:

Install the latest stable release and check if the problem is solved already. Please do not ask for help for older releases!

At the moment there are two major support channels:

Hopefully we can help with your problem.