Wrote all the future features I could think of into the manpage.
This commit is contained in:
parent
5e41f19cd3
commit
fe69ec34ab
|
@ -14,26 +14,46 @@ remwharead - Remember what you read, and when
|
||||||
|
|
||||||
== SYNOPSIS
|
== SYNOPSIS
|
||||||
|
|
||||||
*remwharead* [_url_|_--version_] [_arguments_]
|
*remwharead* [*-t* _tags_] _URL_
|
||||||
|
|
||||||
|
*remwhared* *-e* _format_ [*-f* _file_] [*-s* _start_,_end_]
|
||||||
|
|
||||||
////
|
|
||||||
== DESCRIPTION
|
== DESCRIPTION
|
||||||
////
|
|
||||||
|
*remwhared* saves URLs of things you read in a database along with the current
|
||||||
|
date and time, title, description, the full text of the page and optional tags.
|
||||||
|
|
||||||
== OPTIONS
|
== OPTIONS
|
||||||
|
|
||||||
|
*-t* _tags_, *--tags*=_tags_::
|
||||||
|
Add tags to _URL_, delimited by commas.
|
||||||
|
|
||||||
|
*-e* _format_, *--export*=_format_::
|
||||||
|
Export to _format_. Possible values are _csv_ and _asciidoc_.
|
||||||
|
|
||||||
|
*-f* _file_, *--file*=_file_::
|
||||||
|
Save output to _file_. Default is stdout.
|
||||||
|
|
||||||
|
*-s* _start_,_end_, *--span*=_start_,_end_::
|
||||||
|
Only export entries between _start_ and _end_. _start_ and _end_ are date and
|
||||||
|
time representations according to ISO 8601.
|
||||||
|
|
||||||
*--version*::
|
*--version*::
|
||||||
Print version, copyright and license.
|
Print version, copyright and license.
|
||||||
|
|
||||||
////
|
|
||||||
== EXAMPLES
|
== EXAMPLES
|
||||||
|
|
||||||
|
`remwhared -t tag1,tag2 https://example.com/article.html`
|
||||||
|
|
||||||
|
`remwhared -e asciidoc -f out.adoc -s 2019-04-01,2019-05-31`
|
||||||
|
|
||||||
|
`remwhared -e asciidoc | asciidoctor --backend=html5 --out-file=out.html -`
|
||||||
|
|
||||||
== FILES
|
== FILES
|
||||||
|
|
||||||
* *Configuration file*: `${XDG_CONFIG_HOME}/remwharead.cfg`
|
* *Database*: `${XDG_DATA_HOME}/remwharead.sqlite`
|
||||||
|
|
||||||
`${XDG_CONFIG_HOME}` is usually `~/.config`.
|
`${XDG_DATA_HOME}` is usually `~/.local/share`.
|
||||||
////
|
|
||||||
|
|
||||||
== REPORTING BUGS
|
== REPORTING BUGS
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue