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
  • OPML File Import
  • Queries
  • Scraping Websites
    • Supported Feed Types
    • Source Types
      • URL
      • Local file
      • Script
    • Post-Processing Script
    • Data Flow
    • Command Syntax Tips
    • Advanced Feed Options
    • Warnings
    • Example Uses
    • Example Scrapers
    • 3rd-party Tools
  • 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
  • XMPP Plugin
    • Account Setup
    • Discovery
    • Extra nodes
    • Fetching Behavior
      • Single-user chats and multi-user chats
      • PubSub services and PubSub PEPs
    • Connection Behavior
    • Current Limitations

For Contributors

  • Reporting Bugs or Feature Requests
  • 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
  • OPML File Import
  • Queries
  • Scraping Websites
  • Skins
  • User Data
  • XMPP Plugin

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.