rfcdash icon indicating copy to clipboard operation
rfcdash copied to clipboard

A Dash.app docset containing all published RFCs.

rfcdash

rfcdash is a docset for Dash.app containing all published RFCs from the IETF.

Dash screenshot showing RFC 2324

Installing

Install by opening Dash.app preferences, switch to Downloads, open User Contributed, and search for "RFCs".

If you prefer, you can also subscribe to the docset feed URL at:

https://raw.githubusercontent.com/willnorris/rfcdash/master/RFCs.xml

The unpacked docset will take a little over 500 MB on disk.

Updating the Docset

Most people generally shouldn't need to update the docset on their own. It's generally easier for me to do it, so these notes are mainly for myself. If you notice that the docset is missing an RFC that you need, just open an issue and I'm happy to update it.

Updating requires:

To grab the latest RFCs, run the sync script. This will use httrack to download all published RFCs from the IETF website. This typically takes about half an hour because it downloads everything every time. This is necessary because new RFCs sometimes update or obsolete older RFCs, so we grab everything to make sure we have the latest.

Once everything is downloaded, run rebuild.py to build the index file, rebuild the search index, and add tables of contents to each RFC.

License

The RFCs themselves contained in this repo are subject to the IETF IPR policy. The scripts used to construct the docset are released under an Apache 2.0 license.