RSS Guard Logo
  • What is RSS Guard?
  • RSS Guard 5 versus RSS Guard 4
  • Donations
  • Downloads & Installation
    • Downloads
    • Installation
      • Windows
      • Linux
      • macOS
      • KOBO Book Reader
  • Supported Operating Systems
  • Supported Feed Readers

Features

  • General GUI Concepts & Manipulating Accounts & Adding Feeds
  • Displaying Articles And Web Pages
    • web Viewer
    • text Viewer
    • External Images And Privacy
    • Directly Opened Files
    • Cookies
    • Proxy Use
    • Which Variant Should I Use?
    • Notes
  • Command Line Interface (CLI)
    • Logging
  • Database Backends
  • Cleaning Your Database
    • Cleaning the DB file manually
    • Cleaning the DB file automatically
  • Article Extractor
    • Where to Find It
    • Basic Usage
    • Options
    • Optional JSON Input
      • headers
      • html
      • proxy
    • Examples
      • Extract HTML From a URL
      • Extract Plain Text
      • Extract HTML and Embed Images
      • Pass Custom Headers
      • Use Existing HTML Instead of Downloading the URL
      • Use an HTTP Proxy
      • Use a SOCKS5 Proxy With Authentication
    • Errors
    • Calling From Article Filters
  • Article Filtering
    • Article filters dialog
    • How filters are applied
    • Writing an article filter
    • Power-user tips
    • Global variables
    • Reference Documentation
      • msg
        • Properties
        • Functions
      • app
        • Functions
      • run
        • Properties
      • acc
        • Properties
        • Functions
      • feed
        • Properties
      • utils
        • Properties
        • Functions
      • fs
        • Functions
      • Shared Data Types
        • FilteringAction enum
        • DuplicityCheck enum
        • MessageEnclosure
          • Properties
        • MessageCategory
          • Properties
        • Label
          • Properties
    • Examples
  • Labels
  • Media Player
    • Usage
    • Configuration
    • libmpv Backend
  • Notifications
  • Queries
  • Skins
    • What A Skin Can Change
    • Where Skins Are Loaded From
    • Skin Structure
    • Base Skins And Inheritance
    • metadata.xml
    • Use Skin Colors
    • Custom Skin Colors
    • Article Viewer Templates
    • Useful Placeholders
    • Practical Advice For Skin Authors
    • Limitations And Notes
  • User Data
    • %data% placeholder

Supported Services

  • Standard RSS, Atom, JSON and Other Feeds
    • Add the Account
    • Supported Sources
    • Add and Discover Feeds
    • Folders and Local Storage
    • OPML Import and Export
    • Feed Sources and Processing
    • Full Articles and Comments
    • Per-Feed Network Settings
    • Useful Features
    • Notes
      • Scripts, Local Files and Post-Processing
        • Source Types
          • URL
          • Local File
          • Script
        • Post-Processing
        • Command Examples
        • Related Feed Options
        • Examples and Tools
  • Feedly
    • Before You Begin
    • Setup with an Official Build
    • Setup with a Developer Token
    • What Is Synchronized
    • Synchronization Options
      • Download Unread Articles Only
      • Intelligent Synchronization
      • Article Limit
    • Proxy Settings
    • Everyday Use
    • Supported Features
    • Limitations
  • Gmail
    • What the Account Contains
    • Permissions
    • Setup with Preconfigured Credentials
    • Setup with Your Own OAuth Client
    • Download Options
      • Download Unread Messages Only
      • Message Limit
    • Reading Mail
    • Sending Mail
    • Synchronized Changes
    • Proxy Settings
    • Supported Features
    • Limitations
  • Google Reader API
    • Before You Begin
    • Setup with a Username and Password
    • Setup with Inoreader
      • Preconfigured OAuth
      • Your Own Inoreader Application
    • What Is Synchronized
    • Managing Feeds
    • Synchronization Options
      • Download Unread Articles Only
      • Intelligent Synchronization
      • Fetch Articles Newer Than
      • Article Limit
    • Proxy Settings
    • Supported Features
    • Service Notes and Limitations
  • Nextcloud News
    • Before You Begin
    • Passwords and Two-Factor Authentication
    • Add the Account
    • What Is Synchronized
    • Managing Feeds and Folders
    • Download Options
      • Download Unread Articles Only
      • Article Limit
    • Server-Side Feed Updates
    • Proxy Settings
    • Supported Features
    • Limitations
  • Tiny Tiny RSS
    • Enable API Access
    • Add the Account
    • HTTP Authentication
    • What Is Synchronized
    • Managing Feeds and Folders
    • Synchronization Methods
      • Standard Synchronization
      • Intelligent Synchronization
    • Download Unread Articles Only
    • Force Server-Side Feed Updates
    • Published Articles and Notes
    • Proxy Settings
    • Supported Features
    • Limitations
  • XMPP
    • Supported XMPP Sources
    • Add the Account
    • Extra Nodes
    • Discovery
    • Receiving Articles
      • Single-User Chats
      • Multi-User Chats
      • PubSub Services and PEP
      • Manual Asynchronous Fetch
    • How the Integration Works
      • Service Classification
      • Archived Chat Retrieval
      • PubSub Retrieval
      • Real-Time Chat Routing
    • Local Article State
    • Removing Discovered Items
    • Connection and Proxy Behavior
    • Supported Features
    • Limitations

For Contributors

  • Reporting Bugs or Feature Requests
    • What to Include in a Bug Report
    • Debug Log
      • Create a Debug Log File
        • Examples
        • Command-Line Logging Notes
      • Display the Debug Log Directly
    • Crash Dump on Windows
      • Download ProcDump
      • Prepare a Folder for Dump Files
      • Start ProcDump
      • Reproduce the Crash
      • If No Dump File Is Created
  • Compiling RSS Guard
    • Article And Web Viewer Backend
  • Localization
  • Migrating User Data
    • Migrate 4.x -> 5.x
    • Migrate 3.9.2 -> 4.x
      • Converting *Accounts tables
      • Converting Feeds table
      • Converting Messages table
      • Other tables
  • Plugin API

Troubleshooting

  • Flatpak package
    • Launching at system startup
    • Using an external web browser
    • Adding external tools
    • Using CSS2RSS
RSS Guard
  • RSS Guard Documentation!
  • View page source

RSS Guard Documentation!

  • What is RSS Guard?
  • RSS Guard 5 versus RSS Guard 4
  • Donations
  • Downloads & Installation
  • Supported Operating Systems
  • Supported Feed Readers

Features

  • General GUI Concepts & Manipulating Accounts & Adding Feeds
  • Displaying Articles And Web Pages
  • Command Line Interface (CLI)
  • Database Backends
  • Cleaning Your Database
  • Article Extractor
  • Article Filtering
  • Labels
  • Media Player
  • Notifications
  • Queries
  • Skins
  • User Data

Supported Services

  • Standard RSS, Atom, JSON and Other Feeds
  • Feedly
  • Gmail
  • Google Reader API
  • Nextcloud News
  • Tiny Tiny RSS
  • XMPP

For Contributors

  • Reporting Bugs or Feature Requests
  • Compiling RSS Guard
  • Localization
  • Migrating User Data
  • Plugin API

Troubleshooting

  • Flatpak package

Indices and tables

  • Index

  • Module Index

  • Search Page

Next

© Copyright 2026, Martin Rotter.

Built with Sphinx using a theme provided by Read the Docs.