2019-05-11 02:52:33 +02:00
|
|
|
= remwharead(1)
|
|
|
|
|
:doctype: manpage
|
|
|
|
|
:Author: tastytea
|
|
|
|
|
:Email: tastytea@tastytea.de
|
2019-05-16 00:26:48 +02:00
|
|
|
:Date: 2019-05-16
|
2019-05-11 02:52:33 +02:00
|
|
|
:Revision: 0.0.0
|
|
|
|
|
:man source: remwharead
|
|
|
|
|
:man manual: General Commands Manual
|
|
|
|
|
|
|
|
|
|
== NAME
|
|
|
|
|
|
|
|
|
|
remwharead - Remember what you read, and when
|
|
|
|
|
|
|
|
|
|
== SYNOPSIS
|
|
|
|
|
|
2019-05-16 08:36:35 +02:00
|
|
|
*remwharead* [*-t* _tags_] _URI_
|
2019-05-11 18:40:50 +02:00
|
|
|
|
2019-05-12 00:02:31 +02:00
|
|
|
*remwharead* *-e* _format_ [*-f* _file_] [*-s* _start_,_end_]
|
2019-05-11 02:52:33 +02:00
|
|
|
|
|
|
|
|
== DESCRIPTION
|
2019-05-11 18:40:50 +02:00
|
|
|
|
2019-05-16 08:36:35 +02:00
|
|
|
*remwharead* saves URIs of things you read in a database along with an URI to
|
2019-05-14 20:45:48 +02:00
|
|
|
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
|
|
|
|
|
|
|
|
== OPTIONS
|
|
|
|
|
|
2019-05-13 02:17:25 +02:00
|
|
|
*-t* _tags_, *--tags* _tags_::
|
2019-05-16 08:36:35 +02:00
|
|
|
Add tags to _URI_, delimited by commas.
|
2019-05-11 18:40:50 +02:00
|
|
|
|
2019-05-13 02:17:25 +02:00
|
|
|
*-e* _format_, *--export* _format_::
|
2019-05-16 03:56:17 +02:00
|
|
|
Export to _format_. Possible values are _csv_ and _asciidoc_. See _FORMATS_.
|
2019-05-11 18:40:50 +02:00
|
|
|
|
2019-05-13 02:17:25 +02:00
|
|
|
*-f* _file_, *--file* _file_::
|
2019-05-11 18:40:50 +02:00
|
|
|
Save output to _file_. Default is stdout.
|
|
|
|
|
|
2019-05-13 02:17:25 +02:00
|
|
|
*-s* _start_,_end_, *--span* _start_,_end_::
|
2019-05-16 00:26:48 +02:00
|
|
|
Only export entries between and including _start_ and _end_. _start_ and _end_
|
2019-05-16 07:54:56 +02:00
|
|
|
are date and time representations according to ISO 8601
|
|
|
|
|
(YYYY-MM-DDThh:mm:ss). Time zones are ignored.
|
|
|
|
|
Example: `--span 2019-01-01,2019-02-10T12:30`.
|
2019-05-11 18:40:50 +02:00
|
|
|
|
2019-05-14 22:56:58 +02:00
|
|
|
*-S* _attribute_, *--sort* _attribute_::
|
|
|
|
|
Sort by _time_, _tag_ or _both_ (default) when exporting to _asciidoc_.
|
|
|
|
|
|
2019-05-12 00:02:31 +02:00
|
|
|
*-h*, *--help*::
|
|
|
|
|
Show help message.
|
|
|
|
|
|
|
|
|
|
*-V*, *--version*::
|
2019-05-11 02:52:33 +02:00
|
|
|
Print version, copyright and license.
|
|
|
|
|
|
|
|
|
|
== EXAMPLES
|
|
|
|
|
|
2019-05-13 02:17:25 +02:00
|
|
|
`remwharead -t tag1,tag2 https://example.com/article.html`
|
2019-05-11 18:40:50 +02:00
|
|
|
|
2019-05-13 02:17:25 +02:00
|
|
|
`remwharead -e asciidoc -f out.adoc -s 2019-04-01,2019-05-31`
|
2019-05-11 18:40:50 +02:00
|
|
|
|
2019-05-13 02:17:25 +02:00
|
|
|
`remwharead -e asciidoc | asciidoctor --backend=html5 --out-file=out.html -`
|
2019-05-11 18:40:50 +02:00
|
|
|
|
2019-05-16 03:56:17 +02:00
|
|
|
== FORMATS
|
|
|
|
|
|
|
|
|
|
=== CSV
|
|
|
|
|
|
|
|
|
|
CSV is short for comma separated values. All fields are quoted and delimited by
|
|
|
|
|
commas. Line breaks in the full text are converted to "\n". Our CSV
|
|
|
|
|
implementation follows RFC 4180 and the full MIME media type is
|
|
|
|
|
`text/csv;charset=utf-8;header=present`.
|
|
|
|
|
|
2019-05-11 02:52:33 +02:00
|
|
|
== FILES
|
|
|
|
|
|
2019-05-14 22:56:58 +02:00
|
|
|
* *Database*: `${XDG_DATA_HOME}/remwharead/database.sqlite`
|
2019-05-11 02:52:33 +02:00
|
|
|
|
2019-05-11 18:40:50 +02:00
|
|
|
`${XDG_DATA_HOME}` is usually `~/.local/share`.
|
2019-05-11 02:52:33 +02:00
|
|
|
|
|
|
|
|
== REPORTING BUGS
|
|
|
|
|
|
|
|
|
|
Bugtracker: https://schlomp.space/tastytea/remwharead/issues
|
|
|
|
|
|
|
|
|
|
E-mail: tastytea@tastytea.de
|
