2 unstable releases
0.2.0 | Jan 31, 2021 |
---|---|
0.1.0 | Jan 27, 2021 |
#1181 in Filesystem
62KB
1K
SLoC
rfz
An indexer and metadata viewer for repositories of IETF documents synced to the local file system.
Installation
Install via cargo:
$ cargo install rfz
rsync
is required in order to use rfz sync
.
Usage
See rfz --help
for basic command-line usage.
rfz
expects to find a directory containing a local mirror of the
rsync.tools.ietf.org::tools.html
rsync
target.
The path to this directory can be set with --dir
and defaults to
${XDG_DATA_DIR:-${HOME}/.local/share}/rfz
.
rfz sync
will create the directory if it does not already exist, and call
rsync
to retrieve the contents.
Example systemd
units to run rfz sync
every hour are included in extras/
.
rfz
can be used standalone, but is designed to be used along side fzf
and a
text-mode browser (e.g. lynx
or w3m
):
#!/usr/bin/env bash
rfz index | fzf \
# trim the path from the 'fzf' display
--with-nth=2.. \
# show coloured output
--ansi \
# show the document metadata in the preview
--preview 'rfz summary {1}' \
| cut -d' ' -f1 \
| lynx -
Dependencies
~5–11MB
~118K SLoC