https://github.com/galdor/rfc-mode

An Emacs major mode to read and browse RFC documents.
https://github.com/galdor/rfc-mode

emacs emacs-lisp rfc

Last synced: about 1 month ago
JSON representation

An Emacs major mode to read and browse RFC documents.

• Host: GitHub
• URL: https://github.com/galdor/rfc-mode
• Owner: galdor
• License: isc
• Created: 2019-05-08T13:31:58.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-10-13T13:54:03.000Z (over 1 year ago)
• Last Synced: 2024-11-22T21:46:03.237Z (2 months ago)
• Topics: emacs, emacs-lisp, rfc
• Language: Emacs Lisp
• Homepage:
• Size: 604 KB
• Stars: 106
• Watchers: 4
• Forks: 10
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.org
  • License: LICENSE

Awesome Lists containing this project

README

        

[![MELPA Stable](https://stable.melpa.org/packages/rfc-mode-badge.svg)](https://stable.melpa.org/#/rfc-mode)

[![MELPA](https://melpa.org/packages/rfc-mode-badge.svg)](https://melpa.org/#/rfc-mode)

# rfc-mode

## Introduction

The rfc-mode Emacs major mode is a browser and reader for RFC documents.

## Installation

The package should be installed from MELPA.

Start by loading the mode:

```elisp

(require 'rfc-mode)

```

Then set the location containing all RFC documents (the default value is the

`rfc` directory in the home directory):

```elisp

(setq rfc-mode-directory (expand-file-name "~/rfc/"))

```

RFC documents and their index will be directly downloaded from

https://www.rfc-editor.org when required. Alternatively, the entire RFC

collection can be downloadeded from https://www.rfc-editor.org/retrieve/bulk

to ensure full access without the need for an internet connection.

Call `rfc-mode-browse` to choose a RFC document to read, or `rfc-mode-read` to

enter the reference of the RFC document yourself.

## Screenshots

### Browser

![Helm-based browser](img/browser.png)

### Reader

![Reader](img/reader.png)

## Contact

If you have an idea or a question, email me at .