You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Alexander Batischev ff407afe2b
Merge pull request #962 from dennisschagt/bugfix/issue-957
15 hours ago
.github Encourage issue reporters to post their configs 5 months ago
3rd-party EnvVar::on_change(): pass new envvar value to fn 1 month ago
contrib reset daemon to 1 3 months ago
doc Support key "1" - "9" behaviour in tag and filter select forms 1 day ago
docker Docker: suggest running `make distclean` 1 week ago
filter Implement new naming style 1 year ago
git-hooks Neutralize pre-commit hook for now 1 year ago
include Add wrapper around regex_t with similar interface to regex-rs 20 hours ago
mk Add wrapper around regex_t with similar interface to regex-rs 20 hours ago
po Revert "Merge pull request #907 from newsboat/feature/3-doc-dotdir-and-xdg-take-2" 1 month ago
rss Include all authors when parsing an atom entry 1 month ago
rust regex-rs: Add tests cases related to number of results 20 hours ago
snap Replace Asciidoc with Asciidoctor in dependencies 3 months ago
src Implement OP_REDRAW in podboat 18 hours ago
stfl Mark all stfl lists with "richtext=1" attribute and always quote for stfl 1 week ago
test Add wrapper around regex_t with similar interface to regex-rs 20 hours ago
.astylerc Format the code with AStyle 7 months ago
.cirrus.yml CI: use newest compilers for checks 2 weeks ago
.editorconfig Add editorconfig ( http://editorconfig.org/ ) 3 years ago
.gitattributes Drop .clang-format from .gitattributes as well 5 months ago
.gitignore Use proper file extension for Asciidoc 3 months ago
.rustfmt.toml Add rustfmt config 7 months ago
.travis.yml Fix test coverage job on Travis 2 weeks ago
CHANGELOG.md Merge pull request #929 from newsboat/bugfix/926-fileurlsreader-botches-sed 1 week ago
Cargo.lock Rust: upgrade "once_cell" crate to 1.0.0 2 weeks ago
Cargo.toml Add Rust bindings for regex.h 1 month ago
LICENSE Update copyright year 2019->2020 4 months ago
Makefile Disable remote fonts in html documentation 1 day ago
README.md README: update link to Travis page 1 week ago
config.h Change NEWSBEUTER_PATH_SEP into a single char ('/') 4 months ago
config.sh config.sh: do not grep README for deps' URLs 10 months ago
logo.svg Re-draw logo from scratch, increase the hull size slightly 6 months ago
newsboat.cpp Mention optional-lite dependency in -v and CHANGELOG 1 month ago
podboat.cpp Format the code with AStyle 7 months ago
submit-to-coveralls.sh Coveralls: pass it PR number 2 days ago
txt2h Use "NEWSBOAT" in include guards 2 years ago

README.md

Newsboat Travis CI Build Status Cirrus CI Build Status Coverage Status CII Best Practices

<img

src="https://newsboat.org/logo.svg"
alt="Newsboat logo"
align="left"
height="60"
width="60"
vspace="6" /></a>

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.

Downloading

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

Dependencies

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

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.

Installation

There are numerous ways:

  • install from your distribution’s repository (a lot of distros have a package);

  • install via Snap:

    $ sudo snap install newsboat
    
  • build from source with Docker. Note that the resulting binary might not run outside of that same Docker container if your system doesn’t have all the necessary libraries, or if their versions are too old;

  • build from source in a chroot: to avoid polluting your system with developer packages, or to avoid upgrading, you might use a tool like debootstrap to create an isolated environment. Once that’s done, just build from source as outlined in the next item;

  • build from source.

    Install everything that’s listed in the “Dependencies” section above. Make sure to install the header files as well (on Debian and derivatives, headers are in -dev packages, e.g. libsqlite3-dev.)

    Then compile and install with:

    $ make                   #  pass -jN to use N CPU cores, e.g. -j8
    $ sudo make install      #  install everything under /usr/local
    

    To install to a different directory, pass prefix like so: sudo make prefix=/opt/newsboat install.

    To uninstall, run sudo make uninstall.

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

Support

Development

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.

License

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