Add rofi export to documentation.
continuous-integration/drone/push Build is passing
Details
continuous-integration/drone/push Build is passing
Details
This commit is contained in:
parent
cce04a60d9
commit
970fb1486a
|
@ -20,6 +20,7 @@
|
||||||
:uri-ff-addon: https://addons.mozilla.org/firefox/addon/remwharead
|
:uri-ff-addon: https://addons.mozilla.org/firefox/addon/remwharead
|
||||||
:uri-papirus: https://github.com/PapirusDevelopmentTeam/papirus-icon-theme
|
:uri-papirus: https://github.com/PapirusDevelopmentTeam/papirus-icon-theme
|
||||||
:uri-hunter: https://github.com/cpp-pm/hunter
|
:uri-hunter: https://github.com/cpp-pm/hunter
|
||||||
|
:uri-rofi: https://github.com/davatorium/rofi
|
||||||
|
|
||||||
*remwharead* saves URIs of things you want to remember in a database along with
|
*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,
|
an URI to the archived version, the current date and time, title, description,
|
||||||
|
@ -45,6 +46,12 @@ image::{uri-images-base}/example_tags.png[]
|
||||||
See {uri-branch-main}/man/remwharead.1.adoc[manpage] and/or read
|
See {uri-branch-main}/man/remwharead.1.adoc[manpage] and/or read
|
||||||
{uri-blogpost}[the blogpost].
|
{uri-blogpost}[the blogpost].
|
||||||
|
|
||||||
|
=== With rofi
|
||||||
|
|
||||||
|
The link:{uri-rofi}[rofi] export makes integration with rofi simple. See
|
||||||
|
link:{uri-branch-main}/scripts/remwharead-rofi[scripts/remwharead-rofi] for an
|
||||||
|
example.
|
||||||
|
|
||||||
=== In your programs
|
=== In your programs
|
||||||
|
|
||||||
The complete functionality is implemented in a C++ library, libremwharead. Take
|
The complete functionality is implemented in a C++ library, libremwharead. Take
|
||||||
|
|
|
@ -26,7 +26,8 @@ remwharead - Saves URIs of things you want to remember in a database
|
||||||
the full text of the page and optional tags.
|
the full text of the page and optional tags.
|
||||||
|
|
||||||
The database can be filtered by time, tags and full text and exported to CSV,
|
The database can be filtered by time, tags and full text and exported to CSV,
|
||||||
AsciiDoc, a bookmarks file, JSON, RSS or a list of hyperlinks.
|
AsciiDoc, a bookmarks file, JSON, RSS, a list of hyperlinks or a rofi-compatible
|
||||||
|
list.
|
||||||
|
|
||||||
Archiving is done using the Wayback machine from the
|
Archiving is done using the Wayback machine from the
|
||||||
https://archive.org/[Internet Archive].
|
https://archive.org/[Internet Archive].
|
||||||
|
@ -38,7 +39,7 @@ Add tags to _URI_, delimited by commas.
|
||||||
|
|
||||||
*-e*=_format_, *--export*=_format_::
|
*-e*=_format_, *--export*=_format_::
|
||||||
Export to _format_. Possible values are _csv_, _asciidoc_, _bookmarks_,
|
Export to _format_. Possible values are _csv_, _asciidoc_, _bookmarks_,
|
||||||
_simple_, _json_, _rss_ or _link_. See _FORMATS_.
|
_simple_, _json_, _rss_, _link_ or _rofi_. See _FORMATS_.
|
||||||
|
|
||||||
*-f*=_file_, *--file*=_file_::
|
*-f*=_file_, *--file*=_file_::
|
||||||
Save output to _file_. Default is stdout.
|
Save output to _file_. Default is stdout.
|
||||||
|
@ -191,6 +192,11 @@ specification (the element _link_ in _channel_ is empty).
|
||||||
|
|
||||||
Export as a plain list of links, separated by newlines.
|
Export as a plain list of links, separated by newlines.
|
||||||
|
|
||||||
|
=== rofi
|
||||||
|
|
||||||
|
Export title, tags and URL for consumption by rofi. See the `scripts/` directory
|
||||||
|
on https://schlomp.space/tastytea/remwharead for an example.
|
||||||
|
|
||||||
== SEARCH EXPRESSIONS
|
== SEARCH EXPRESSIONS
|
||||||
|
|
||||||
A search expression is either a single term, or several terms separated by _AND_
|
A search expression is either a single term, or several terms separated by _AND_
|
||||||
|
|
Loading…
Reference in New Issue