Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Script to mirror and lookup RFCs cache

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.

Configuration

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 http://www.ietf.org/download/rfc-index.txt index_name = RFC index filename, default rfc-index.txt rfc_base_url = Base download URL for RFC downloads, default ttp://www.ietf.org/rfc/ 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.

Commands

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

Release History

Release History

This version
History Node

2.0

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting