Skip to main content

Script to synchronize and index local mirror of RFCs

Project description

This package contains script to mirror RFC index and full text to local directory, and to create a full text search based on whoosh module to search the contents of RFCs.


The code reads two different configuration paths, home directory configuration overriding the system wide configuration:

/etc/rfcmirror.conf $HOME/.rfcmirror.conf

The configuration file can contain following settings:

pager = Pager program used to read RFC, defaults to more cachedir = Path to local RFC cache, defaults to /var/db/rfc index_url = URL to RFC index, default index_name = RFC index filename, default rfc-index.txt rfc_base_url = Base download URL for RFC downloads, default ttp:// skipped = Defaults to RFCs to skip, default 8,9,51,418,530,598

Usually it’s enough to simply add cachedir if you want to run the program with files in your home directory.


rfc-cache-update -uv - Imports and parses the rfc-index.txt - Downloads any missing and not skipped RFC texts - Updates whoosh cache with the contents of the rfc

rfc <number> - Shows RFC with given number

rfc <text> - Shows RFCs matching the text in rfc description rfc -b <text> - Shows RFCs matching the text in rfc description and body

Project details

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page