continuous-integration/drone/push Build is passing

Details

and added -S as short option for --search-all.

2019-05-22 09:54:56 +02:00

3.9 KiB

Raw Blame History

remwharead(1) Manual Page

NAME

remwharead - Saves URIs of things you want to remember in a database

SYNOPSIS

remwharead [-t tags] [-N] URI

remwharead -e format [-f file] [-T start,end] [[-s|-S] expression]

DESCRIPTION

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 or AsciiDoc.

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

OPTIONS

-t tags, --tags tags: Add tags to URI, delimited by commas.
-e format, --export format: Export to format. Possible values are csv and asciidoc. See FORMATS.
-f file, --file file: Save output to file. Default is stdout.
-T start,end, --time-span start,end: Only export entries between and including start and end. start and end 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.
-s expression, --search-tags expression: Search in tags. Format: tag1 AND tag2 OR tag3. See SEARCH EXPRESSIONS.
-S expression, --search-all expression: Search in tags, title, description and full text.
-N, --no-archive: Do not archive URI.
-h, --help: Show help message.
-V, --version: Print version, copyright and license.

EXAMPLES

Example 1. Save a thing into the database, with tags.

remwharead -t tag1,tag2 https://example.com/article.html

Example 2. Export all things between and including 2019-04-01 and 2019-05-31 to a file.

remwharead -e asciidoc -f out.adoc -T 2019-04-01,2019-05-31

Example 3. Export all things to an HTML file.

remwharead -e asciidoc | asciidoctor --backend=html5 --out-file=out.html -

Example 4. Export all things about GRUB the boot-loader, but nothing about caterpillars.

remwharead -e csv -s "grub AND boot"

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.

asciidoc

AsciiDoc is a markup language that can be read as plain text or converted to HTML, PDF and many other formats.

SEARCH EXPRESSIONS

A search expression is either a single term, or several terms separated by AND or OR. AND takes precedence. The expression Mountain AND Big OR Vegetable finds all things that have either Mountain and Big, or Vegetable in them. You can use || instead of OR and && instead of AND. Note that --search-tags only matches whole tags, Pill does not match Pillow.

PROTOCOL SUPPORT

Since remwharead is built on libcurl, it supports the same protocols. See curl(1), section DESCRIPTION. Titles and descriptions are currently only extracted when using HTTP(S).

ENVIRONMENT

You can use proxy servers with the same environment variables as curl. See curl(1), section ENVIRONMENT.

FILES

Database: ${XDG_DATA_HOME}/remwharead/database.sqlite

${XDG_DATA_HOME} is usually ~/.local/share.

ERROR CODES

Code	Explanation
1	Missing options / Argument not understood.
2	Database connection failed.
3	File could not be opened.
4	Could not fetch URI.

REPORTING BUGS

Bugtracker: https://schlomp.space/tastytea/remwharead/issues

E-mail: tastytea@tastytea.de

3.9 KiB Raw Blame History