Saves URIs of things you want to remember in a database.
Iet uz failu
tastytea 6123c7fbb3
continuous-integration/drone/push Build is passing Papildu informācija
Use sub-project curl_wrapper instead of custom implementation.
Via git subtree from <https://schlomp.space/tastytea/curl_wrapper>.
2020-11-13 22:41:56 +01:00
browser-plugins/webextension Reformat remwharead_wrapper.cpp. 2020-10-31 13:30:04 +01:00
cmake Squashed 'src/curl_wrapper/' content from commit 5af456a 2020-11-13 21:27:54 +01:00
include Use sub-project curl_wrapper instead of custom implementation. 2020-11-13 22:41:56 +01:00
man Use libcurl to download URIs. 2020-10-31 18:26:05 +01:00
pkg-config Remove dependency on libxdg-basedir and pkg-config. 2019-10-27 05:05:51 +01:00
scripts Fix path in rofi script. 2019-11-28 09:33:27 +01:00
src Use sub-project curl_wrapper instead of custom implementation. 2020-11-13 22:41:56 +01:00
tests Squashed 'src/curl_wrapper/' content from commit 5af456a 2020-11-13 21:27:54 +01:00
.clang-format Squashed 'src/curl_wrapper/' content from commit 5af456a 2020-11-13 21:27:54 +01:00
.clang-tidy Update .clang-tidy. 2020-01-27 06:18:58 +01:00
.drone.yml Add libcurl dependency to CI and RPM. 2020-10-31 18:35:23 +01:00
.editorconfig Squashed 'src/curl_wrapper/' content from commit 5af456a 2020-11-13 21:27:54 +01:00
.gitignore Squashed 'src/curl_wrapper/' content from commit 5af456a 2020-11-13 21:27:54 +01:00
CMakeLists.txt Use sub-project curl_wrapper instead of custom implementation. 2020-11-13 22:41:56 +01:00
CODE_OF_CONDUCT.adoc Fix contact-variable in COC. 2019-09-27 03:30:22 +02:00
CONTRIBUTING.adoc use more variables in contribution guidelines. 2019-09-27 03:30:15 +02:00
Doxyfile Display right include paths in Doxygen output. 2019-08-05 23:35:49 +02:00
LICENSE Squashed 'src/curl_wrapper/' content from commit 5af456a 2020-11-13 21:27:54 +01:00
README.adoc Squashed 'src/curl_wrapper/' content from commit 5af456a 2020-11-13 21:27:54 +01:00
build_doc.sh Added Doxygen config and script. 2019-07-27 22:55:43 +02:00

README.adoc

remwharead

remwharead saves URIs of things you want to remember in a database along with an URI to the archived version, the current date and time, title, description, the full text of the page and optional tags.

The database can be filtered by time, tags and full text and exported to CSV, AsciiDoc, JSON or RSS.

Archiving is done using the Wayback machine from the Internet Archive.

Example 1. AsciiDoc export formatted with Asciidoctor.
Dates view
Tags view

Usage

See manpage and/or read the blogpost.

With rofi

The rofi export makes integration with rofi simple. See scripts/remwharead-rofi for an example.

In your programs

The complete functionality is implemented in a C++ library, libremwharead. Take a look at the reference for more info.

Install

Gentoo

Add my repository and install it from there.

eselect repository enable tastytea
echo "www-misc/remwharead ~amd64" >> /etc/portage/package.accept_keywords/remwharead
emaint sync -r tastytea
emerge -a www-misc/remwharead

Debian and Debian based

Download the .deb-package from schlomp.space and install with apt install ./rewharead_*.deb. The package works for 64 bit installations only.

From source

Dependencies

  • Tested OS: Linux

  • C++ compiler (gcc 6+, clang 6+)

  • cmake (at least: 3.9)

  • POCO (tested: 1.9 / 1.7)

  • Boost (tested: 1.71 / 1.67)

  • libcurl (at least: 7.52)

  • Optional:

    • Manpage: asciidoc (tested: 8.6)

    • Tests: catch (tested: 2.5 / 1.2)

    • DEB package: dpkg (tested: 1.18)

    • RPM package: rpm-build (tested: 4.11)

Example 2. Install dependencies in Debian buster.
apt-get install g++ cmake libpoco-dev libboost-dev asciidoc dpkg

Get sourcecode

Releases

Download the current release at schlomp.space.

Development version
git clone https://schlomp.space/tastytea/remwharead.git

Compile

mkdir build
cd build/
cmake ..
cmake --build .
cmake options:
  • -DCMAKE_BUILD_TYPE=Debug for a debug build.

  • -DWITH_MAN=NO to not compile the manpage.

  • -DWITH_TESTS=YES to compile the tests.

  • -DWITH_MOZILLA=YES to install the wrapper for the Mozilla extension.

  • -DMOZILLA_NMH_DIR lets you set the directory for the Mozilla extension wrapper. The complete path is ${CMAKE_INSTALL_PREFIX}/${MOZILLA_NMH_DIR}.

  • -DWITH_CLANG-TIDY=YES to check the sourcecode with clang-tidy while compiling.

  • One of:

    • -DWITH_DEB=YES if you want to be able to generate a deb-package.

    • -DWITH_RPM=YES if you want to be able to generate an rpm-package.

You can run the tests with cd tests && ctest. Install with make install, generate binary packages with make package.

Browser plugins

WebExtension

The WebExtension works in Firefox and possibly other browsers with WebExtension support. You can install it from addons.mozilla.org or build it yourself with build_xpi.sh.

The icons of the plugins are from the Papirus icon theme with the license GPLv3.

Copyright © 2019 tastytea <tastytea@tastytea.de>.
License GPLv3: GNU GPL version 3 <https://www.gnu.org/licenses/gpl-3.0.html>.
This program comes with ABSOLUTELY NO WARRANTY. This is free software,
and you are welcome to redistribute it under certain conditions.