nlohmann / rfc-docset

RFC docset for Dash

RFC Docset

This repository offers the RFC documents as downloadable docset for tools like Dash.

Features

Within Dash, the docset has the following features:

• Offline access to more than 7900 RFC documents.
• Quicksearch for title or RFC number.
• Full-text search inside the current RFC.
• Links to other RFCs (also to sections) work within the docset.
• "Open Online Page" functionality opens RFC at https://tools.ietf.org/html.

Installation

Open the link dash-feed://https%3A%2F%2Fraw.githubusercontent.com%2Fnlohmann%2Frfc-docset%2Fmaster%2Frfc.xml to subscribe to the RFC docset. Dash will oben the "Downloads" dialog with a new entry "RFC". Then press the "Download" button to download the docset. The docset will be updated automatically.

There will be a new entry "RFC" in the documentation list. You can search for an RFC with the prefix rfc:.

To install the file locally, just open folder rfc.docset with Dash.

Update docset

The docset can be built from scratch as follows

# download RFCs
make download -j10
# recreate the docset
make rfc.docset

License

The code to create the docset is licensed under the MIT License:

Copyright © 2016 Niels Lohmann

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Further copyright notices

• This project is not affilated with Dash, which is Copyright © 2016 Kapeli.
• The RFC documents are copyright by the IETF Trust and the persons identified as the document authors. All rights reserved. The RFC documents have been downloaded from https://tools.ietf.org/html and edited as follows:
  • Relative links to ./rfc0000 have been changed to rfc0000.html to work in the context dof Dash.