RFC 1111

Request for comments on Request for Comments: Instructions to RFC authors

๐Ÿ“… published August 1989, from ietf

Request for Comments on Request for Comments ๐Ÿ’–

okay bestie, RFC 1111 is the one that teaches everyone how to write RFCs ๐ŸŒธ It was written by Jon Postel at ISI (USC Information Sciences Institute) in August 1989, and it's basically the style guide for the whole Internet ๐Ÿ’… It's a standard for the Internet community. It obsoletes RFC 825 ๐Ÿงš, and the header doesn't list any RFC it updates. Title's Instructions to RFC Authors โœจ


Status of this Memo ๐ŸŒˆ

this RFC is a standard for the Internet community, and authors of RFCs are expected to adopt and implement it ๐Ÿซถ Distribution of this memo is unlimited. ๐Ÿ’œ

1. Introduction โœจ

so RFCs get shared online as public access files, and a short message goes out to the distribution list saying the memo is ready ๐Ÿ“ฌ

people copy those files and print or display them on their own equipment ๐Ÿ–จ๏ธ an RFC can also be sent by email if someone asks for it that way. the big takeaway is that the online format has to work with a huge range of printing and display gear, so it's kind of a big deal ๐Ÿ˜ญ

2. Format Rules ๐ŸŽ€

okay, to keep distribution working, there are only two allowed formats for RFCs: ASCII and PostScript ๐Ÿ’–

the RFC Editor tries to keep the style consistent, so they might reformat your submission. honestly it's way easier if yours already matches the most recent RFCs, so go look at some and copy that vibe ๐Ÿ‘€

you have to send an editable online document to the RFC Editor. they might ask for small format or style changes, and they'll put in the actual RFC number ๐Ÿ”ข

2a. ASCII Format Rules ๐Ÿ’…

  • The character codes are ASCII ๐Ÿ”ค
  • Each page is limited to 58 lines, followed by a form feed on a line by itself ๐Ÿ“„
  • Each line is limited to 72 characters, followed by carriage return and line feed โ†ฉ๏ธ
  • No overstriking (or underlining) ๐Ÿ™…โ€โ™€๏ธ
  • These "height" and "width" constraints include headers, footers, page numbers, and left side indenting, so count everything ๐Ÿงฎ
  • Don't pad the text with extra spaces to make a straight right margin ๐Ÿ™ˆ
  • No hyphenating words at the right margin โœ‚๏ธ
  • No footnotes! ๐Ÿ’€ If you need notes, put them at the end of a section or at the end of the document ๐Ÿ“
  • Single spacing inside a paragraph, and one blank line between paragraphs ๐ŸŒธ

ASCII RFCs can be emailed to the RFC Editor (or sent as online files) either in their finished publication format or in NROFF. if you're planning to send NROFF, check with the RFC Editor first ๐Ÿ’Œ

2b. PostScript Format Rules ๐Ÿฆ‹

the standard page size is 8 1/2 by 11 inches ๐Ÿ“ the margin is 1 inch on all sides (top, bottom, left, and right) ๐Ÿ–ผ๏ธ

the main text should be at least 10 points with a line spacing of 12 points ๐Ÿ”  footnotes and graph notations can be no smaller than 8 points, with a line spacing of 9.6 points ๐Ÿ”

only three fonts are okay: Helvetica, Times Roman, and Courier, plus their bold and italic versions. those are the three standard fonts on most PostScript printers ๐Ÿ–จ๏ธ

prepare your diagrams and images using the lowest common denominator PostScript. think about what common PostScript printers can do, and how much memory they've got ๐Ÿง 

these PostScript commands should not be used: initgraphics, erasepage, copypage, grestoreall, initmatrix, initclip, banddevice, framedevice, nulldevice and renderbands ๐Ÿšซ

heads up: these PostScript rules will probably change and grow as people learn more ๐Ÿ”ฎ

PostScript RFCs can be emailed to the RFC Editor (or sent as online files). since PostScript isn't editable, you also have to send an editable source version of the document ๐Ÿ’• if you're planning to submit in PostScript, check with the RFC Editor first ๐Ÿ’œ


3. Status Statement ๐Ÿ’ซ

every RFC has to include the "Status of this Memo" section on its first page, and it needs a paragraph describing what the RFC is for ๐Ÿ“– this section shows the status granted by the RFC Editor and the Internet Activities Board (IAB) ๐Ÿ… people publish RFCs for lots of reasons: to share info, to kick off or keep a discussion going about a cool idea, or to share the spec for a protocol ๐Ÿงš

you can use these sample paragraphs to meet this requirement:

Proposed Protocol ๐ŸŒท

This RFC suggests a proposed protocol for the Internet community, and asks for discussion and suggestions for improvements.

Specification ๐ŸŽ€

This RFC specifies a standard for the Internet community. Hosts on the Internet are expected to adopt and implement this standard.

Discussion ๐Ÿ—ฃ๏ธ

The point of this RFC is to focus discussion on specific problems in the Internet and on possible ways to solve them. Any proposed solutions in this document are not meant to be standards for the Internet. The hope is that a general consensus forms about the right solution to these problems, which eventually leads to standards being adopted.

Information ๐Ÿ“š

This RFC is being shared with the Internet community to gather their reactions to the proposals in it. The issues discussed might not be directly relevant to the Internet's research problems, but they could still be interesting to plenty of researchers and implementers.

Status ๐Ÿ“…

Because the status and progress of various Internet community projects need to be kept up to date, this RFC is issued for the benefit of community members. The information here is accurate as of the publication date but can change, and later RFCs will reflect those changes.

these paragraphs don't have to be copied word for word, but the general intent of the RFC has to be clear ๐Ÿซถ

4. Distribution Statement ๐ŸŒธ

every RFC should also include a "distribution statement" ๐Ÿ“ฎ usually RFCs have unlimited distribution, though there are a few cases where it makes sense to restrict it in some way ๐Ÿ”’

normally the distribution statement is just the sentence "Distribution of this memo is unlimited." tacked onto the "Status of this Memo" section ๐Ÿ’–

5. Author's Address ๐Ÿงš

every RFC must have, right at the very end, a section with the author's address. that includes the name and postal address, the telephone number, and the Internet email address ๐Ÿ“ฌ

6. Relation to other RFCs ๐Ÿ”—

sometimes an RFC adds info about a topic from an earlier RFC, or fully replaces an earlier one ๐Ÿ”„ there are two terms for these cases: UPDATES and OBSOLETES ๐Ÿ’… a document that obsoletes an earlier one can stand on its own. a document that only updates an earlier one can't stand alone. it has to be added to or inserted into the existing document, so it's only useful as a supplement ๐Ÿงฉ SUPERSEDES and REPLACES aren't used anymore ๐Ÿ™…โ€โ™€๏ธ

UPDATES ๐Ÿฉน

use this to point to a previous document from a new item that can't be used alone, meaning one that supplements an older document. the newer publication is a part that gets added to the original, like an addendum or extra info ๐Ÿ“Ž

OBSOLETES ๐Ÿ—‘๏ธ

use this for an earlier document that this document replaces. this document either has revised info, or all of the same info plus some new stuff (however big or small that new stuff is). basically, this document can be used on its own without looking at the older one ๐ŸŒŸ

here's an example:

On the Assigned Numbers RFCs, the term OBSOLETES should be used, since the new document actually adds new information (however small) into the existing text, is more up to date than the older document, and therefore replaces it and makes it OBSOLETE. ๐Ÿ’€

in lists of RFCs or the RFC-Index (but not on the RFCs themselves), these can be used with early documents to point to later ones ๐Ÿ“‘

OBSOLETED-BY ๐Ÿ”œ

use this to point to the newer document that replaces the older one ๐Ÿ”

UPDATED-BY โž•

use this to point to the newer document that adds info to an existing document that's still useful ๐Ÿ’œ

7. The RFC Editor ๐Ÿ‘‘

the RFC Editor is Jon Postel ๐Ÿ’–

8. The RFC Announcement List ๐Ÿ“ฃ

new RFCs get announced to the RFC distribution list maintained by the SRI Network Information Center (NIC) โœจ if you want to be added or removed from that mailing list, contact the SRI-NIC by sending an email to RFC-REQUEST@NIC.DDN.MIL ๐Ÿ’Œ

9. Obtaining RFCs ๐Ÿฆ‹

you can get RFCs over FTP from NIC.DDN.MIL, using the pathname RFC:RFCnnnn.TXT (where "nnnn" is the number of the RFC) ๐Ÿ—‚๏ธ log in with FTP, username ANONYMOUS, and password GUEST ๐Ÿ”‘

sites that can't use FTP can use the NIC's automatic mail service. send the request to SERVICE@NIC.DDN.MIL and put the RFC number in the subject line, like Subject: RFC nnnn ๐Ÿ“จ

for special distribution (like hardcopy), email either the author of the RFC in question or NIC@NIC.DDN.MIL ๐Ÿ–จ๏ธ

unless the RFC itself says otherwise, every RFC has unlimited distribution ๐ŸŒˆ

you can also get RFCs from other information centers, including the CSNET Information Center (INFO@SH.CS.NET) and the NSFNET Information Service (INFO@NIS.NSF.NET) ๐Ÿงš


Author's Address ๐ŸŽ€

Jon Postel
USC Information Sciences Institute
4676 Admiralty Way
Marina del Rey, California  90292-6695

Phone:  213-822-1511

EMail:  POSTEL@ISI.EDU

that's the whole RFC, bestie ๐ŸŒˆ๐Ÿ’–โœจ

๐Ÿ“ฆ where this page comes from