You are viewing the documentation for the develop branch. The documentation for the release version is here .

Table of Contents

ietf layer

Table of ContentsClose

ietf-logo.png

1. Description

The IETF layer collects various useful packages for participating in the Internet Engineering Task Force (https://www.ietf.org).

1.1. Features:

  • Fetching and opening IETF documents.
  • Viewing IETF documents.
  • Writing IETF documents.

2. Fetching and Opening IETF Documents

Support for fetching and downloading IETF documents is added through the ietf-docs package. The IETF docs package adds support for fetching and loading IETF documents based on the name of a document (usually under the emacs point). For example if the point is anwhere on the text RFC781 and one invokes the ietf-docs-open-at-point the package will fetch the document to a local cache (if not present) and view it. This works for the 3 standard document names, STDXXX, RFCXXX and draft-xxxx-yyy.

3. Viewing IETF Documents

Support for viewing IETF documents is added through the IRFC minor mode (irfc-mode). The IRFC minor mode improves the display and formatting of IETF documents using the well known IETF document structure. Additionally it creates hyperlink overlays for references within the document.

4. Writing IETF Documents

Support for writing IETF documents using org mode is added using the RFC Org Mode Exporter (ox-rfc) package.

5. Install

To use the ietf layer add it to your ~/.spacemacs

(setq-default dotspacemacs-configuration-layers '(ietf))

By default fetched IETF documents are stored in a subdirectory of the spacemacs-cache-directory. To override this location you can set the ietf-docs-cache variable.

(setq-default dotspacemacs-configuration-layers '(
  (ietf :variables
        ietf-docs-cache "~/Downloads/ietf-docs-cache")))

6. Key bindings

Key binding Description
SPC f I Opens IETF document based on the text at the point.

Author: root

Created: 2021-09-29 Wed 20:46

Validate