Raggle Help

Introduction

Welcome to Raggle!

Raggle is a console RSSaggregator, written in Ruby. Raggle is free software; please see the file COPYING for licensing and warranty information.

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies of the Software, its documentation and marketing & publicity materials, and acknowledgment shall be given in the documentation, materials and software packages that this Software was used.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Keyboard

- Tab, <-, -> : Window navigation
- Up, Down : Item navigation
- Page Up, Page Down : Move up, down a page.
- u, d : Move the current feed up or down.
- s : Sort the feed list alphabetically.
- Del: Delete the highlighted feed.
- o : Open the currently selected feed item.
- m : Mark all items as read.
- n : Move to next unread item.
- ! : Escape to a shell.
- Enter, Space : Select active item
- q, F12 : Exit Raggle.

Reading Feeds

To read a given feed, highlight it in the Feed window and press Enter or Space. The list of items available from that feed will be displayed in the Item window. Unread feed items are highlighted in cyan. To view the full story linked from a feed item, navigate to the Description window (using Tab or the Left and Right arrow keys) and press Enter.

If Raggle is running in a screen session, it will invoke your browser of choice in a separate screen window (this behavior is configurable; see the 'use_screen' option for additional information). There are also several different window navigation modes available, see the 'focus' option for additional information.

Adding Feeds

To add a new RSS feed to Raggle, quit out of Raggle and run the following command:


        raggle --add -t "title" -u "url" -r "refresh"

Where "title" is the title of the feed, "url" is the URL of the feed, and "refresh" is the refresh interval (in minutes) of the feed.

Note: The title will be overwritten by the feed unless you lock the title using the --lock-title command-line option.

Configuration Files

$HOME/.raggle/config.rb : main configuration file
$HOME/.raggle/feeds.yaml : feed list
$HOME/.raggle/feed_cache.store : cached feed items
$HOME/.raggle/theme.yaml : colors, window layout

Note: Raggle will fall back to internal defaults if any of these files are deleted, or if they don't exist.

Reporting Bugs

Please make sure you are using the latest version of Raggle before reporting bugs. That said, you can submit bug reports via email to raggle-dev@raggle.org (the old address, i_hate_raggle@pablotron.org, will forward to raggle-dev). Please make sure the phrase "RAGGLE BUG" is in the subject of the message.