2019-05-11 02:52:33 +02:00
|
|
|
= remwharead
|
2019-07-27 23:26:39 +02:00
|
|
|
:toc: preamble
|
2019-05-11 02:52:33 +02:00
|
|
|
|
2019-05-16 13:18:16 +02:00
|
|
|
*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.
|
2019-05-11 02:52:33 +02:00
|
|
|
|
2019-09-06 00:53:58 +02:00
|
|
|
The database can be filtered by time, tags and full text and exported to CSV,
|
|
|
|
|
AsciiDoc, JSON or RSS.
|
2019-05-22 09:28:12 +02:00
|
|
|
|
2019-05-20 09:04:06 +02:00
|
|
|
Archiving is done using the Wayback machine from the
|
2019-05-27 23:33:44 +02:00
|
|
|
https://archive.org/[Internet Archive].
|
2019-05-20 09:04:06 +02:00
|
|
|
|
2019-05-18 05:09:56 +02:00
|
|
|
.AsciiDoc export formatted with Asciidoctor.
|
2019-05-18 03:28:40 +02:00
|
|
|
====
|
2019-07-28 02:52:54 +02:00
|
|
|
image::https://doc.schlomp.space/.remwharead/example_dates.png[Dates view, height=250, link="https://doc.schlomp.space/.remwharead/example_dates.png", role=left]
|
|
|
|
|
image::https://doc.schlomp.space/.remwharead/example_tags.png[Tags view, height=250, link="https://doc.schlomp.space/.remwharead/example_tags.png"]
|
2019-05-18 03:28:40 +02:00
|
|
|
====
|
|
|
|
|
|
2019-05-11 02:52:33 +02:00
|
|
|
== Usage
|
|
|
|
|
|
2019-07-27 23:26:39 +02:00
|
|
|
See
|
2019-08-03 20:10:20 +02:00
|
|
|
https://schlomp.space/tastytea/remwharead/src/branch/main/man/remwharead.1.adoc[manpage].
|
2019-07-27 23:26:39 +02:00
|
|
|
|
|
|
|
|
=== In your programs
|
|
|
|
|
|
|
|
|
|
The complete functionality is implemented in a C++ library, libremwharead. Take
|
|
|
|
|
a look at the https://doc.schlomp.space/remwharead/[reference] for more info.
|
2019-05-11 02:52:33 +02:00
|
|
|
|
|
|
|
|
== Install
|
|
|
|
|
|
|
|
|
|
=== Gentoo
|
|
|
|
|
|
|
|
|
|
Add my https://schlomp.space/tastytea/overlay[repository] and install it from
|
|
|
|
|
there.
|
|
|
|
|
|
2019-05-13 03:44:47 +02:00
|
|
|
[source,zsh]
|
2019-05-11 02:52:33 +02:00
|
|
|
----
|
|
|
|
|
eselect repository enable tastytea
|
|
|
|
|
echo "www-misc/remwharead ~amd64" >> /etc/portage/package.accept_keywords/remwharead
|
|
|
|
|
emaint sync -r tastytea
|
|
|
|
|
emerge -a www-misc/remwharead
|
|
|
|
|
----
|
|
|
|
|
|
2019-05-26 16:51:39 +02:00
|
|
|
=== Debian and Debian based
|
|
|
|
|
|
|
|
|
|
Download the `.deb`-package from
|
|
|
|
|
https://schlomp.space/tastytea/remwharead/releases[schlomp.space] and install
|
|
|
|
|
with `apt install ./rewharead_*.deb`. The package works for 64 bit installations
|
|
|
|
|
only.
|
|
|
|
|
|
2019-05-11 02:52:33 +02:00
|
|
|
=== From source
|
|
|
|
|
|
|
|
|
|
==== Dependencies
|
|
|
|
|
|
|
|
|
|
* Tested OS: Linux
|
2019-09-03 20:53:38 +02:00
|
|
|
* C++ compiler (tested: https://gcc.gnu.org/[gcc] 8/9,
|
2019-09-03 20:43:18 +02:00
|
|
|
https://llvm.org/[clang] 6/7)
|
2019-05-12 21:39:01 +02:00
|
|
|
* https://cmake.org/[cmake] (at least: 3.2)
|
2019-08-05 19:11:37 +02:00
|
|
|
* https://pkgconfig.freedesktop.org/wiki/[pkgconfig] (tested: 0.29)
|
|
|
|
|
* http://repo.or.cz/w/libxdg-basedir.git[libxdg-basedir] (tested: 1.2)
|
2019-08-04 18:46:53 +02:00
|
|
|
* https://pocoproject.org/[POCO] (tested: 1.9 / 1.7)
|
2019-05-11 02:52:33 +02:00
|
|
|
* Optional:
|
|
|
|
|
** Manpage: http://asciidoc.org/[asciidoc] (tested: 8.6)
|
2019-05-16 13:18:16 +02:00
|
|
|
** Tests: https://github.com/catchorg/Catch2[catch] (tested: 2.5 / 1.2)
|
2019-05-18 08:27:03 +02:00
|
|
|
** DEB package: https://packages.qa.debian.org/dpkg[dpkg] (tested: 1.18)
|
|
|
|
|
** RPM package: http://www.rpm.org[rpm-build] (tested: 4.11)
|
2019-05-11 02:52:33 +02:00
|
|
|
|
2019-09-03 20:53:38 +02:00
|
|
|
.Install dependencies in Debian buster.
|
2019-05-17 00:39:09 +02:00
|
|
|
====
|
2019-05-17 00:22:16 +02:00
|
|
|
[source,zsh]
|
|
|
|
|
----
|
2019-09-03 20:53:38 +02:00
|
|
|
apt-get install g++ cmake pkg-config libpoco-dev libxdg-basedir-dev asciidoc dpkg
|
2019-05-17 00:22:16 +02:00
|
|
|
----
|
2019-05-17 00:39:09 +02:00
|
|
|
====
|
2019-05-17 00:22:16 +02:00
|
|
|
|
2019-05-11 02:52:33 +02:00
|
|
|
==== Get sourcecode
|
|
|
|
|
|
|
|
|
|
===== Releases
|
|
|
|
|
|
|
|
|
|
Download the current release at
|
|
|
|
|
https://schlomp.space/tastytea/remwharead/releases[schlomp.space].
|
|
|
|
|
|
|
|
|
|
===== Development version
|
|
|
|
|
|
2019-05-13 03:44:47 +02:00
|
|
|
[source,zsh]
|
2019-05-11 02:52:33 +02:00
|
|
|
----
|
|
|
|
|
git clone https://schlomp.space/tastytea/remwharead.git
|
|
|
|
|
----
|
|
|
|
|
|
|
|
|
|
==== Compile
|
|
|
|
|
|
2019-05-13 03:44:47 +02:00
|
|
|
[source,zsh]
|
2019-05-11 02:52:33 +02:00
|
|
|
----
|
|
|
|
|
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.
|
2019-05-21 15:59:35 +02:00
|
|
|
* `-DWITH_TESTS=YES` to compile the tests.
|
2019-05-21 22:39:50 +02:00
|
|
|
* `-DWITH_MOZILLA=YES` to install the wrapper for the Mozilla extension.
|
2019-05-21 23:12:02 +02:00
|
|
|
* `-DMOZILLA_NMH_DIR` lets you set the directory for the Mozilla
|
2019-08-03 20:10:20 +02:00
|
|
|
extension wrapper. The complete path is
|
|
|
|
|
`${CMAKE_INSTALL_PREFIX}/${MOZILLA_NMH_DIR}`.
|
2019-05-18 08:27:03 +02:00
|
|
|
* 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.
|
2019-05-11 02:52:33 +02:00
|
|
|
|
2019-05-26 16:44:53 +02:00
|
|
|
You can run the tests with `cd tests && ctest`. Install with `make install`,
|
|
|
|
|
generate binary packages with `make package`.
|
2019-05-11 02:52:33 +02:00
|
|
|
|
2019-05-21 15:23:08 +02:00
|
|
|
== Browser plugins
|
|
|
|
|
|
2019-05-22 10:46:30 +02:00
|
|
|
=== WebExtension
|
|
|
|
|
|
2019-05-21 15:23:08 +02:00
|
|
|
The
|
|
|
|
|
https://schlomp.space/tastytea/remwharead/src/branch/main/browser-plugins/webextension[WebExtension]
|
|
|
|
|
works in Firefox and possibly other browsers with WebExtension support. You
|
2019-05-22 10:46:30 +02:00
|
|
|
can install it from
|
|
|
|
|
https://addons.mozilla.org/en-US/firefox/addon/remwharead/[addons.mozilla.org]
|
|
|
|
|
or build it yourself with `build_xpi.sh`.
|
2019-05-21 15:23:08 +02:00
|
|
|
|
2019-05-11 02:52:33 +02:00
|
|
|
== Copyright
|
|
|
|
|
|
2019-05-21 13:59:35 +02:00
|
|
|
The icons of the plugins are from the
|
|
|
|
|
https://github.com/PapirusDevelopmentTeam/papirus-icon-theme[Papirus icon
|
|
|
|
|
theme] with the license GPLv3.
|
|
|
|
|
|
2019-05-11 02:52:33 +02:00
|
|
|
----
|
|
|
|
|
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.
|
|
|
|
|
----
|
