LinuxCommandLibrary

newsboat

Read RSS/Atom feeds in a terminal

TLDR

First import feed URLs from an OPML file

$ newsboat [[-i|--import-from-opml]] [my-feeds.xml]
copy

Alternatively, add feeds manually
$ echo [http://example.com/path/to/feed] >> "${HOME}/.newsboat/urls"
copy

Start Newsboat and refresh all feeds on startup
$ newsboat [[-r|--refresh-on-start]]
copy

Execute one or more commands in non-interactive mode
$ newsboat [[-x|--execute]] [reload print-unread ...]
copy

See keyboard shortcuts (the most relevant are visible in the status line)
$ <?>
copy

SYNOPSIS

newsboat [OPTIONS]

PARAMETERS

-d <DIR>, --data-dir <DIR>
    Specifies an alternative directory for Newsboat to store its data files, such as cache and database.

-c <FILE>, --config-file <FILE>
    Uses a different configuration file than the default one, allowing for multiple configurations.

-r, --refresh-on-start
    Automatically refreshes all configured feeds upon Newsboat's startup, fetching the latest articles.

-e, --export-to-opml
    Exports the list of subscribed feeds to standard output in OPML (Outline Processor Markup Language) format.

-x <CMD>, --execute <CMD>
    Executes a specific Newsboat command. This is particularly useful for scripting and automation of tasks.

-v, --version
    Displays Newsboat's version information and then exits.

-h, --help
    Shows a brief help message with available command-line options and then exits.

DESCRIPTION

Newsboat is a fast and highly configurable text-mode RSS/Atom feed reader for Unix-like operating systems. It enables users to subscribe to various news feeds, browse articles, and manage their subscriptions directly from the command line interface.

Designed for efficiency and keyboard-only navigation, Newsboat offers features such as tagging, powerful searching, filtering capabilities, and seamless integration with external programs for tasks like opening links in a web browser or downloading enclosures. It serves as a continuation of the popular newsbeuter project, maintaining its core philosophy of being a robust, terminal-centric tool for managing news feeds.

CAVEATS

Newsboat is a terminal-based application, which means it requires users to be comfortable with command-line interfaces. Its extensive customization options are primarily managed by editing plain text configuration files, which may present a learning curve for users preferring graphical interfaces. It does not natively display rich media content directly.

CUSTOMIZATION VIA CONFIGURATION FILES

Newsboat's behavior, appearance, and key bindings are highly customizable through several plain text files, typically located in ~/.newsboat/. Key configuration files include:
config (main settings),
urls (list of RSS/Atom feed URLs), and
keymap (custom keyboard shortcuts and commands).

OPML IMPORT/EXPORT

Newsboat provides robust support for importing and exporting feed subscriptions using the OPML (Outline Processor Markup Language) standard. This feature simplifies the process of migrating feed lists to and from other feed readers or for backup purposes.

HISTORY

Newsboat is a direct and active fork of newsbeuter, a popular text-mode RSS/Atom feed reader whose development ceased. Newsboat emerged to continue the project's legacy, providing ongoing maintenance, bug fixes, and introducing new features while strictly adhering to the original application's core design and philosophy of a fast, keyboard-driven feed reader. It has effectively become the spiritual and technical successor to newsbeuter.

SEE ALSO

mutt(1), w3m(1), lynx(1), elinks(1)

Copied to clipboard