Newsboat is an RSS/Atom feed reader for the text console. It's an actively maintained fork of Newsbeuter.

Logo by noobilanderi, licensed under CC BY 4.0.

You can download the latest version of Newsboat from the official site: https://newsboat.org/

Alternatively, you can check out the latest version from the Git repository:

$ git clone git://github.com/newsboat/newsboat.git

Newsboat depends on a number of libraries, which need to be installed before Newsboat can be compiled.

• GCC 4.9 or newer, or Clang 3.6 or newer
• Stable Rust and Cargo (Rust's package manager) (1.26.0 or newer)
• STFL (version 0.21 or newer)
• SQLite3 (version 3.5 or newer)
• libcurl (version 7.21.6 or newer)
• Header files for the SSL library that libcurl uses. You can find out which library that is from the output of curl --version; most often that's OpenSSL, sometimes GnuTLS, or maybe something else.
• GNU gettext (on systems that don't provide gettext in the libc): ftp://ftp.gnu.org/gnu/gettext/
• pkg-config
• libxml2
• json-c (version 0.11 or newer)
• Asciidoctor

Developers will also need:

• xtr (can be installed with cargo install xtr)
• Coco/R for C++, needed to re-generate
• filter language parser using regenerate-parser target.

First, you'll have to get the dependencies. Make sure to install the header files for the libraries (on Debian and derivatives, headers are in -dev packages, e.g. libsqlite3-dev.) After that, compiling and installing newsboat is as simple as:

$ make
$ sudo make install

And if you ever need to uninstall it, use make uninstall.

Cross-compilers need to set CARGO_BUILD_TARGET; see cargo documentation.

• Check out our documentation and FAQ
• Bugs and whatnot should be reported to the issue tracker
• Drop us a line at newsboat mailing list ([email protected])
• Chat with developers and fellow users on #newsboat at Freenode (webchat available!)

Decided to work on an issue, fix a bug or add a feature? Great! Be sure to check out our style guide.

You'll probably want to run the tests; here's how:

$ make -j5 PROFILE=1 all test  # 5 is CPU cores + 1, to parallelize the build
$ (cd test && TMPDIR=/dev/shm ./test --order rand) && cargo test

Note the use of ramdisk as TMPDIR: some tests create temporary files, which slows them down if TMPDIR is on HDD or even SSD.

Newsboat can also be built in Docker.

Newsboat is licensed under the MIT license; see the LICENSE file.