Debian Codegraph @

rfc2223.html

raw
1 <pre>Network Working Group J. Postel
2 Request for Comments: 2223 J. Reynolds
3 Obsoletes: <a href="./rfc1543">1543</a>, <a href="./rfc1111">1111</a>, <a href="./rfc825">825</a> ISI
4 Category: Informational October 1997
5
6
7 <span class="h1">Instructions to RFC Authors</span>
8
9 Status of this Memo
10
11 This memo provides information for the Internet community. This memo
12 does not specify an Internet standard of any kind. Distribution of
13 this memo is unlimited.
14
15 Copyright Notice
16
17 Copyright (C) The Internet Society (1997). All Rights Reserved.
18
19 Table of Contents
20
21 <a href="#section-1">1</a>. Introduction . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-2">2</a>
22 <a href="#section-2">2</a>. Editorial Policy . . . . . . . . . . . . . . . . . . . . . . <a href="#page-3">3</a>
23 <a href="#section-3">3</a>. Format Rules . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-4">4</a>
24 3a. ASCII Format Rules . . . . . . . . . . . . . . . . . . . . <a href="#page-5">5</a>
25 3b. PostScript Format Rules . . . . . . . . . . . . . . . . . . <a href="#page-6">6</a>
26 <a href="#section-4">4</a>. Header . . . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-7">7</a>
27 4a. First Page Heading . . . . . . . . . . . . . . . . . . . . <a href="#page-7">7</a>
28 4b. Running Header . . . . . . . . . . . . . . . . . . . . . . <a href="#page-8">8</a>
29 4c. Running Footer . . . . . . . . . . . . . . . . . . . . . . <a href="#page-8">8</a>
30 <a href="#section-5">5</a>. Status Section . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-8">8</a>
31 <a href="#section-6">6</a>. Copyright Notice . . . . . . . . . . . . . . . . . . . . . . <a href="#page-9">9</a>
32 <a href="#section-7">7</a>. Introduction Section . . . . . . . . . . . . . . . . . . . . <a href="#page-9">9</a>
33 <a href="#section-8">8</a>. References Section . . . . . . . . . . . . . . . . . . . . <a href="#page-11">11</a>
34 <a href="#section-9">9</a>. Security Considerations Section . . . . . . . . . . . . . <a href="#page-11">11</a>
35 <a href="#section-10">10</a>. Author's Address Section . . . . . . . . . . . . . . . . . <a href="#page-11">11</a>
36 <a href="#section-11">11</a>. Copyright Section . . . . . . . . . . . . . . . . . . . . <a href="#page-11">11</a>
37 <a href="#section-12">12</a>. Relation to other RFCs . . . . . . . . . . . . . . . . . . <a href="#page-12">12</a>
38 <a href="#section-13">13</a>. Protocol Standards Process . . . . . . . . . . . . . . . . <a href="#page-13">13</a>
39 <a href="#section-14">14</a>. Contact . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-13">13</a>
40 <a href="#section-15">15</a>. Distribution Lists . . . . . . . . . . . . . . . . . . . . <a href="#page-14">14</a>
41 <a href="#section-16">16</a>. RFC Index . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-14">14</a>
42 <a href="#section-17">17</a>. Security Considerations . . . . . . . . . . . . . . . . . <a href="#page-14">14</a>
43 <a href="#section-18">18</a>. References . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-14">14</a>
44 <a href="#section-19">19</a>. Authors' Addresses . . . . . . . . . . . . . . . . . . . . <a href="#page-15">15</a>
45 <a href="#section-20">20</a>. Appendix - RFC "nroff macros" . . . . . . . . . . . . . . <a href="#page-16">16</a>
46 <a href="#section-21">21</a>. Full Copyright Statement . . . . . . . . . . . . . . . . . <a href="#page-20">20</a>
47
48
49
50
51
52 <span class="grey">Postel &amp; Reynolds Informational [Page 1]</span></pre>
53 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
54 <span class="grey"><a href="./rfc2223">RFC 2223</a> Instructions to RFC Authors October 1997</span>
55
56
57 <span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
58
59 This Request for Comments (RFC) provides information about the
60 preparation of RFCs, and certain policies relating to the publication
61 of RFCs.
62
63 The RFC series of notes covers a broad range of interests. The core
64 topics are the Internet and the TCP/IP protocol suite. However, any
65 topic related to computer communication may be acceptable at the
66 discretion of the RFC Editor.
67
68 Memos proposed to be RFCs may be submitted by anyone. One large
69 source of memos that become RFCs is the Internet Engineering Task
70 Force (IETF). The IETF working groups (WGs) evolve their working
71 memos (known as Internet Drafts or I-Ds) until they feel they are
72 ready for publication, then the memos are reviewed by the Internet
73 Engineering Steering Group (IESG), and if approved sent by the IESG
74 to the RFC Editor.
75
76 Most of the memos submitted to the RFC Editor from independent
77 sources will be reviewed by the IESG for possible relationship to
78 work in progress in the IETF Working Groups.
79
80 RFCs are distributed online by being stored as public access files,
81 and a short message is sent to the distribution list indicating the
82 availability of the memo.
83
84 The online files are copied by the interested people and printed or
85 displayed at their site on their equipment. This means that the
86 format of the online files must meet the constraints of a wide
87 variety of printing and display equipment. (RFCs may also be
88 returned via e-mail in response to an e-mail query, or RFCs may be
89 found using information and database searching tools such as Gopher,
90 Wais, or the World Wide Web (WWW).
91
92 RFCs have been traditionally published and continue to be published
93 in ASCII text.
94
95 While the primary RFCs is always an ASCII text file, secondary or
96 alternative versions of RFC may be provided in PostScript. This
97 decision is motivated by the desire to include diagrams, drawings,
98 and such in RFCs. PostScript documents (on paper only, so far) are
99 visually more appealing and have better readability.
100
101 PostScript was chosen for the fancy form of RFC publication over
102 other possible systems (e.g., impress, interpress, oda) because of
103 the perceived wide spread availability of PostScript capable
104 printers.
105
106
107
108 <span class="grey">Postel &amp; Reynolds Informational [Page 2]</span></pre>
109 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
110 <span class="grey"><a href="./rfc2223">RFC 2223</a> Instructions to RFC Authors October 1997</span>
111
112
113 However, many RFC users read the documents online and use various
114 text oriented tools (e.g., emacs, grep) to search them. Often, brief
115 excerpts from RFCs are included in e-mail. These practices are not
116 yet practical with PostScript files.
117
118 PostScript producing systems are less standard than is desirable and
119 that several of the document production systems that claim to produce
120 PostScript actually produce nonstandard results.
121
122 In the future, it may be necessary to identify a set of document
123 production systems authorized for use in production of PostScript
124 RFCs, based on the reasonableness of the output files they generate.
125
126 <span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Editorial Policy</span>
127
128 Documents proposed to be RFCs are reviewed by the RFC Editor and
129 possibly by other reviewers he selects.
130
131 The result of the review may be to suggest to the author some
132 improvements to the document before publication.
133
134 Occasionally, it may be apparent that the topic of a proposed RFC is
135 also the subject of an IETF Working Group, and that the author could
136 coordinate with the working group to the advantage of both. The
137 usual result of this is that a revised memo is produced as a working
138 group Internet Draft and eventually emerges from the IETF process as
139 a recommendation from the IESG to the RFC Editor.
140
141 In some cases it may be determined that the submitted document is not
142 appropriate material to be published as an RFC.
143
144 In some cases it may be necessary to include in the document a
145 statement based on the reviews about the ideas in the document. This
146 may be done in the case that the document suggests relevant but
147 inappropriate or unsafe ideas, and other situations.
148
149 The RFC Editor may make minor changes to the document, especially in
150 the areas of style and format, but on some occasions also to the
151 text. Sometimes the RFC Editor will undertake to make more
152 significant changes, especially when the format rules (see below) are
153 not followed. However, more often the memo will be returned to the
154 author for the additional work.
155
156 Documents intended to become RFCs specifying standards track
157 protocols must be approved by the IESG before being sent to the RFC
158 Editor. The established procedure is that when the IESG completes
159 work on a document that is to become a standards track RFC the
160 communication will be from the Secretary of the IESG to the RFC
161
162
163
164 <span class="grey">Postel &amp; Reynolds Informational [Page 3]</span></pre>
165 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
166 <span class="grey"><a href="./rfc2223">RFC 2223</a> Instructions to RFC Authors October 1997</span>
167
168
169 Editor. Generally, the documents in question are Internet Drafts.
170 The communication usually cites the exact Internet Draft in question
171 (by file name). The RFC Editor must assume that only that file is to
172 be processed to become the RFC. If the authors have small
173 corrections to the text, they should be sent to the RFC Editor
174 separately (or as a "diff"), authors should not send a new version of
175 the document.
176
177 In some cases, authors prepare alternate secondary versions of RFCs
178 in fancy format using PostScript. Since the ASCII text version of
179 the RFC is the primary version, the PostScript version must match the
180 text version. The RFC Editor must decide if the PostScript version
181 is "the same as" the ASCII version before the PostScript version can
182 be published.
183
184 The effect of this is that the RFC Editor first processes the ASCII
185 version of the memo through to publication as an RFC. If the author
186 wishes to submit a PostScript version at that point that matches the
187 ASCII version (and the RFC Editor agrees that it does), then the
188 PostScript version will be installed in the RFC repositories and
189 announced to the community.
190
191 Due to various time pressures on the RFC Editorial staff, the time
192 elapsed between submission and publication can vary greatly. It is
193 always acceptable to query (ping) the RFC Editor about the status of
194 an RFC during this time (but not more than once a week). The two
195 weeks preceding an IETF meeting are generally very busy, so RFCs
196 submitted shortly before an IETF meeting are most likely to be
197 published after the meeting.
198
199 <span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Format Rules</span>
200
201 To meet the distribution constraints, the following rules are
202 established for the two allowed formats for RFCs: ASCII and
203 PostScript.
204
205 The RFC Editor attempts to ensure a consistent RFC style. To do this
206 the RFC Editor may choose to reformat the RFC submitted. It is much
207 easier to do this if the submission matches the style of the most
208 recent RFCs. Please do look at some recent RFCs and prepare yours in
209 the same style.
210
211 You must submit an editable online document to the RFC Editor. The
212 RFC Editor may require or make minor changes in format or style and
213 will insert the actual RFC number.
214
215
216
217
218
219
220 <span class="grey">Postel &amp; Reynolds Informational [Page 4]</span></pre>
221 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
222 <span class="grey"><a href="./rfc2223">RFC 2223</a> Instructions to RFC Authors October 1997</span>
223
224
225 Most of the RFCs are processed by the RFC Editor with the unix
226 "nroff" program using a very simple set of the formatting commands
227 (or "requests") from the "ms" macro package (see the Appendix). If a
228 memo submitted to be an RFC has been prepared by the author using
229 nroff, it is very helpful to let the RFC Editor know that when it is
230 submitted.
231
232 3a. ASCII Format Rules
233
234 The character codes are ASCII.
235
236 Each page must be limited to 58 lines followed by a form feed on a
237 line by itself.
238
239 Each line must be limited to 72 characters followed by carriage
240 return and line feed.
241
242 No overstriking (or underlining) is allowed.
243
244 These "height" and "width" constraints include any headers,
245 footers, page numbers, or left side indenting.
246
247 Do not fill the text with extra spaces to provide a straight right
248 margin.
249
250 Do not do hyphenation of words at the right margin.
251
252 Do not use footnotes. If such notes are necessary, put them at
253 the end of a section, or at the end of the document.
254
255 Use single spaced text within a paragraph, and one blank line
256 between paragraphs.
257
258 Note that the number of pages in a document and the page numbers
259 on which various sections fall will likely change with
260 reformatting. Thus cross references in the text by section number
261 usually are easier to keep consistent than cross references by
262 page number.
263
264 RFCs in ASCII Format may be submitted to the RFC Editor in e-mail
265 messages (or as online files) in either the finished publication
266 format or in nroff. If you plan to submit a document in nroff
267 please consult the RFC Editor first.
268
269
270
271
272
273
274
275
276 <span class="grey">Postel &amp; Reynolds Informational [Page 5]</span></pre>
277 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
278 <span class="grey"><a href="./rfc2223">RFC 2223</a> Instructions to RFC Authors October 1997</span>
279
280
281 3b. PostScript Format Rules
282
283 Standard page size is 8 1/2 by 11 inches.
284
285 Margin of 1 inch on all sides (top, bottom, left, and right).
286
287 Main text should have a point size of no less than 10 points with
288 a line spacing of 12 points.
289
290 Footnotes and graph notations no smaller than 8 points with a line
291 spacing of 9.6 points.
292
293 Three fonts are acceptable: Helvetica, Times Roman, and Courier.
294 Plus their bold-face and italic versions. These are the three
295 standard fonts on most PostScript printers.
296
297 Prepare diagrams and images based on lowest common denominator
298 PostScript. Consider common PostScript printer functionality and
299 memory requirements.
300
301 The following PostScript commands should not be used:
302 initgraphics, erasepage, copypage, grestoreall, initmatrix,
303 initclip, banddevice, framedevice, nulldevice and renderbands.
304
305 Note that the number of pages in a document and the page numbers
306 on which various sections fall will likely differ in the ASCII and
307 the PostScript versions. Thus cross references in the text by
308 section number usually are easier to keep consistent than cross
309 references by page number.
310
311 These PostScript rules are likely to changed and expanded as
312 experience is gained.
313
314 RFCs in PostScript Format may be submitted to the RFC Editor in
315 e-mail messages (or as online files). If you plan to submit a
316 document in PostScript please consult the RFC Editor first.
317
318 Note that since the ASCII text version of the RFC is the primary
319 version, the PostScript version must match the text version. The
320 RFC Editor must decide if the PostScript version is "the same as"
321 the ASCII version before the PostScript version can be published.
322
323
324
325
326
327
328
329
330
331
332 <span class="grey">Postel &amp; Reynolds Informational [Page 6]</span></pre>
333 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
334 <span class="grey"><a href="./rfc2223">RFC 2223</a> Instructions to RFC Authors October 1997</span>
335
336
337 <span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Headers and Footers</span>
338
339 There is the first page heading, the running headers, and the running
340 footers.
341
342 4a. First Page
343
344 Please see the front page of this memo for an example of the front
345 page heading. On the first page there is no running header. The
346 top of the first page has the following items:
347
348 Network Working Group
349
350 The traditional heading for the group that founded the RFC
351 series. This appears on the first line on the left hand side
352 of the heading.
353
354 Request for Comments: nnnn
355
356 Identifies this as a request for comments and specifies the
357 number. Indicated on the second line on the left side. The
358 actual number is filled in at the last moment before
359 publication by the RFC Editor.
360
361 Author
362
363 The author's name (first initial and last name only) indicated
364 on the first line on the right side of the heading.
365
366 Organization
367
368 The author's organization, indicated on the second line on the
369 right side.
370
371 Date
372
373 This is the Month and Year of the RFC Publication. Indicated on
374 the third line on the right side.
375
376 Updates or Obsoletes
377
378 If this RFC Updates or Obsoletes another RFC, this is indicated
379 as third line on the left side of the heading.
380
381
382
383
384
385
386
387
388 <span class="grey">Postel &amp; Reynolds Informational [Page 7]</span></pre>
389 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
390 <span class="grey"><a href="./rfc2223">RFC 2223</a> Instructions to RFC Authors October 1997</span>
391
392
393 Category
394
395 The category of this RFC, one of: Standards Track, Best Current
396 Practice, Informational, or Experimental. This is indicated on
397 the third (if there is no Updates or Obsoletes indication) or
398 fourth line of the left side.
399
400 Other Numbers
401
402 Other numbers in the RFC series of notes include the subseries
403 of FYI (For Your Information) [<a href="#ref-4" title="&quot;F.Y.I. on F.Y.I Introduction to the F.Y.I. Notes&quot;">4</a>], BCP (Best Current Practice)
404 [<a href="#ref-5" title="&quot;Best Current Practices&quot;">5</a>], and STD (Standard) [<a href="#ref-6" title="&quot;Introduction to the STD Notes&quot;">6</a>]. These are placed on the left
405 side.
406
407 Title
408
409 The title appears, centered, below the rest of the heading.
410 Periods or "dots" in the titles are not allowed.
411
412 If there are multiple authors and if the multiple authors are from
413 multiple organizations the right side heading may have additional
414 lines to accommodate them and to associate the authors with the
415 organizations properly.
416
417 4b. Running Headers
418
419 The running header in one line (on page 2 and all subsequent
420 pages) has the RFC number on the left (RFC NNNN), the (possibly
421 nshortened form) title centered, and the date (Month Year) on the
422 right.
423
424 4c. Running Footers
425
426 The running footer in one line (on all pages) has the author's
427 last name on the left, category centered, and the page number on
428 the right ([Page N]).
429
430 <span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Status Section</span>
431
432 Each RFC must include on its first page the "Status of this Memo"
433 section which contains two elements: (1) a paragraph describing the
434 type of the RFC, and (2) the distribution statement.
435
436 The content of this section will be one of the four following
437 statements.
438
439
440
441
442
443
444 <span class="grey">Postel &amp; Reynolds Informational [Page 8]</span></pre>
445 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
446 <span class="grey"><a href="./rfc2223">RFC 2223</a> Instructions to RFC Authors October 1997</span>
447
448
449 Standards Track
450
451 "This document specifies an Internet standards track protocol for
452 the Internet community, and requests discussion and suggestions
453 for improvements. Please refer to the current edition of the
454 "Internet Official Protocol Standards" (STD 1) for the
455 standardization state and status of this protocol. Distribution
456 of this memo is unlimited."
457
458 Best Current Practice
459
460 "This document specifies an Internet Best Current Practices for
461 the Internet Community, and requests discussion and suggestions
462 for improvements. Distribution of this memo is unlimited."
463
464 Experimental
465
466 "This memo defines an Experimental Protocol for the Internet
467 community. This memo does not specify an Internet standard of any
468 kind. Discussion and suggestions for improvement are requested.
469 Distribution of this memo is unlimited."
470
471 Informational
472
473 "This memo provides information for the Internet community. This
474 memo does not specify an Internet standard of any kind.
475 Distribution of this memo is unlimited."
476
477 <span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. Copyright Notice</span>
478
479 Immediately following the Status section the statement, "Copyright
480 (C) The Internet Society (date). All Rights Reserved." is placed.
481 Also, see <a href="#section-11">Section 11</a> for the full statement that must appear at the
482 end of the document.
483
484 <span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. Introduction Section</span>
485
486 Each RFC should have an Introduction section that (among other
487 things) explains the motivation for the RFC and (if appropriate)
488 describes the applicability of the protocol described.
489
490 Normally, this will be the "abstract" section from the Internet
491 Draft. If the RFC is not based on an I-D, other possibilities
492 are:
493
494
495
496
497
498
499
500 <span class="grey">Postel &amp; Reynolds Informational [Page 9]</span></pre>
501 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
502 <span class="grey"><a href="./rfc2223">RFC 2223</a> Instructions to RFC Authors October 1997</span>
503
504
505 Protocol
506
507 This protocol is intended to provide the bla-bla service,
508 and be used between clients and servers on host computers.
509 Typically the clients are on workstation hosts and the
510 servers on mainframe hosts.
511
512 or
513
514 This protocol is intended to provide the bla-bla service,
515 and be used between special purpose units such as terminal
516 servers or routers and a monitoring host.
517
518 Discussion
519
520 The purpose of this RFC is to focus discussion on particular
521 problems in the Internet and possible methods of solution.
522 No proposed solutions in this document are intended as
523 standards for the Internet. Rather, it is hoped that a
524 general consensus will emerge as to the appropriate solution
525 to such problems, leading eventually to the adoption of
526 standards.
527
528 Interest
529
530 This RFC is being distributed to members of the Internet
531 community in order to solicit their reactions to the
532 proposals contained in it. While the issues discussed may
533 not be directly relevant to the research problems of the
534 Internet, they may be interesting to a number of researchers
535 and implementers.
536
537 Status Report
538
539 In response to the need for maintenance of current
540 information about the status and progress of various
541 projects in the Internet community, this RFC is issued for
542 the benefit of community members. The information contained
543 in this document is accurate as of the date of publication,
544 but is subject to change. Subsequent RFCs will reflect such
545 changes.
546
547 These paragraphs need not be followed word for word, but the
548 general intent of the RFC must be made clear.
549
550
551
552
553
554
555
556 <span class="grey">Postel &amp; Reynolds Informational [Page 10]</span></pre>
557 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
558 <span class="grey"><a href="./rfc2223">RFC 2223</a> Instructions to RFC Authors October 1997</span>
559
560
561 <span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. References Section</span>
562
563 Nearly all RFCs contain citations to other documents, and these are
564 listed in a References section near the end of the RFC. There are
565 many styles for references, and the RFCs have one of their own.
566 Please follow the reference style used in recent RFCs. See the
567 reference section of this RFC for an example. Please note that for
568 protocols that have been assigned STD numbers, the STD number must be
569 included in the reference.
570
571 In many standards track documents several words are used to signify
572 the requirements in the specification. These words are often
573 capitalized. <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a> [<a href="#ref-3" title="&quot;Key words for use in RFCs to Indicate Requirement Levels&quot;">3</a>], defines these words as they
574 should be interpreted in IETF documents.
575
576 <span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>. Security Considerations Section</span>
577
578 All RFCs must contain a section near the end of the document that
579 discusses the security considerations of the protocol or procedures
580 that are the main topic of the RFC.
581
582 <span class="h2"><a class="selflink" id="section-10" href="#section-10">10</a>. Author's Address Section</span>
583
584 Each RFC must have at the very end a section giving the author's
585 address, including the name and postal address, the telephone number,
586 (optional: a FAX number) and the Internet email address.
587
588 <span class="h2"><a class="selflink" id="section-11" href="#section-11">11</a>. Copyright Section</span>
589
590 Per <a href="https://www.rfc-editor.org/bcp/bcp9">BCP 9</a>, <a href="./rfc2026">RFC 2026</a> [<a href="#ref-2" title="&quot;The Internet Standards Process -- Revision 3&quot;">2</a>], "The following copyright notice and
591 disclaimer shall be included in all ISOC standards-related
592 documentation." The following statement should be placed on the last
593 page of the RFC, as the "Full Copyright Statement".
594
595 "Copyright (C) The Internet Society (date). All Rights Reserved.
596
597 This document and translations of it may be copied and furnished
598 to others, and derivative works that comment on or otherwise
599 explain it or assist in its implementation may be prepared, copied,
600 published and distributed, in whole or in part, without
601 restriction of any kind, provided that the above copyright notice
602 and this paragraph are included on all such copies and derivative
603 works. However, this document itself may not be modified in any
604 way, such as by removing the copyright notice or references to the
605 Internet Society or other Internet organizations, except as needed
606 for the purpose of developing Internet standards in which case the
607 procedures for copyrights defined in the Internet Standards
608 process must be followed, or as required to translate it into
609
610
611
612 <span class="grey">Postel &amp; Reynolds Informational [Page 11]</span></pre>
613 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
614 <span class="grey"><a href="./rfc2223">RFC 2223</a> Instructions to RFC Authors October 1997</span>
615
616
617 languages other than English.
618
619 The limited permissions granted above are perpetual and will not
620 be revoked by the Internet Society or its successors or assigns.
621
622 This document and the information contained herein is provided on
623 an "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET
624 ENGINEERING TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR
625 IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF
626 THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
627 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
628
629 <span class="h2"><a class="selflink" id="section-12" href="#section-12">12</a>. Relation to other RFCs</span>
630
631 Sometimes an RFC adds information on a topic discussed in a previous
632 RFC or completely replaces an earlier RFC. There are two terms used
633 for these cases respectively, Updates and Obsoletes. A document that
634 obsoletes an earlier document can stand on its own. A document that
635 merely updates an earlier document cannot stand on its own; it is
636 something that must be added to or inserted into the previously
637 existing document, and has limited usefulness independently. The
638 terms Supercedes and Replaces are no longer used.
639
640 Updates
641
642 To be used as a reference from a new item that cannot be used
643 alone (i.e., one that supplements a previous document), to refer
644 to the previous document. The newer publication is a part that
645 will supplement or be added on to the existing document; e.g., an
646 addendum, or separate, extra information that is to be added to
647 the original document.
648
649 Obsoletes
650
651 To be used to refer to an earlier document that is replaced by
652 this document. This document contains either revised information,
653 or else all of the same information plus some new information,
654 however extensive or brief that new information is; i.e., this
655 document can be used alone, without reference to the older
656 document.
657
658
659
660
661
662
663
664
665
666
667
668 <span class="grey">Postel &amp; Reynolds Informational [Page 12]</span></pre>
669 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
670 <span class="grey"><a href="./rfc2223">RFC 2223</a> Instructions to RFC Authors October 1997</span>
671
672
673 For example:
674
675 On the Assigned Numbers RFCs the term Obsoletes should be used
676 since the new document actually incorporate new information
677 (however brief) into the text of existing information and is
678 more up-to-date than the older document, and hence, replaces it
679 and makes it Obsoletes.
680
681 In lists of RFCs or the RFC-Index (but not on the RFCs themselves)
682 the following may be used with early documents to point to later
683 documents.
684
685 Obsoleted-by
686
687 To be used to refer to the newer document(s) that replaces the
688 older document.
689
690 Updated-by
691
692 To be used to refer to the newer section(s) which are to be added
693 to the existing, still used, document.
694
695 <span class="h2"><a class="selflink" id="section-13" href="#section-13">13</a>. Protocol Standards Process</span>
696
697 See the current "Internet Official Protocol Standards" (STD 1) memo
698 for the definitive statement on protocol standards and their
699 publication [<a href="#ref-1" title="&quot;Internet Official Protocol Standards&quot;">1</a>].
700
701 The established procedure is that when the IESG completes work on a
702 document that is to become a standards track RFC the communication
703 will be from the Secretary of the IESG to the RFC Editor. Generally,
704 the documents in question are Internet Drafts. The communication
705 usually cites the exact Internet Draft (by file name) in question.
706 The RFC Editor must assume that only that file is to be processed to
707 become the RFC. If the authors have small corrections to the text,
708 they should be sent to the RFC Editor separately (or as a "diff"), do
709 not send a new version of the document.
710
711 <span class="h2"><a class="selflink" id="section-14" href="#section-14">14</a>. Contact</span>
712
713 To contact the RFC Editor send an email message to:
714
715 "[email protected]".
716
717
718
719
720
721
722
723
724 <span class="grey">Postel &amp; Reynolds Informational [Page 13]</span></pre>
725 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
726 <span class="grey"><a href="./rfc2223">RFC 2223</a> Instructions to RFC Authors October 1997</span>
727
728
729 <span class="h2"><a class="selflink" id="section-15" href="#section-15">15</a>. Distribution Lists</span>
730
731 The RFC announcements are distributed via two mailing lists: the
732 "IETF-Announce" list, and the "RFC-DIST" list. You don't want to be
733 on both lists.
734
735 To join (or quit) the IETF-Announce list send a message to ietf-
736 [email protected].
737
738 To join (or quit) the RFC-DIST list send a message to rfc-dist-
739 [email protected].
740
741 <span class="h2"><a class="selflink" id="section-16" href="#section-16">16</a>. RFC Index</span>
742
743 Several organizations maintain RFC Index files, generally using the
744 file name "rfc-index.txt". The contents of such a file copied from
745 one site may not be identical to that copied from another site.
746
747 <span class="h2"><a class="selflink" id="section-17" href="#section-17">17</a>. Security Considerations</span>
748
749 This RFC raises no security issues (however, see <a href="#section-9">Section 9</a>).
750
751 <span class="h2"><a class="selflink" id="section-18" href="#section-18">18</a>. References</span>
752
753 [<a id="ref-1">1</a>] Postel, J., Editor, "Internet Official Protocol Standards", STD
754 1, <a href="./rfc2200">RFC 2200</a>, June 1997.
755
756 [<a id="ref-2">2</a>] Bradner, S., "The Internet Standards Process -- Revision 3", <a href="https://www.rfc-editor.org/bcp/bcp9">BCP</a>
757 <a href="https://www.rfc-editor.org/bcp/bcp9">9</a>, <a href="./rfc2026">RFC 2026</a>, October 1996.
758
759 [<a id="ref-3">3</a>] Bradner, S., "Key words for use in RFCs to Indicate Requirement
760 Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>, March 1997.
761
762 [<a id="ref-4">4</a>] Malkin, G., and J. Reynolds, "F.Y.I. on F.Y.I Introduction to
763 the F.Y.I. Notes", FYI 1, <a href="./rfc1150">RFC 1150</a>, March 1990.
764
765 [<a id="ref-5">5</a>] Postel, J., Li, T., and Y. Rekhter, "Best Current Practices",
766 <a href="https://www.rfc-editor.org/bcp/bcp1">BCP 1</a>, <a href="./rfc1818">RFC 1818</a>, August 1995.
767
768 [<a id="ref-6">6</a>] Postel, J., Editor, "Introduction to the STD Notes", <a href="./rfc1311">RFC 1311</a>,
769 March 1992.
770
771
772
773
774
775
776
777
778
779
780 <span class="grey">Postel &amp; Reynolds Informational [Page 14]</span></pre>
781 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
782 <span class="grey"><a href="./rfc2223">RFC 2223</a> Instructions to RFC Authors October 1997</span>
783
784
785 <span class="h2"><a class="selflink" id="section-19" href="#section-19">19</a>. Authors' Addresses</span>
786
787 Jon Postel
788 USC/Information Sciences Institute
789 4676 Admiralty Way
790 Marina del Rey, CA 90292
791
792 Phone: +1 310-822-1511
793 Fax: +1 310-823-6714
794 EMail: [email protected]
795
796
797 Joyce K. Reynolds
798 USC/Information Sciences Institute
799 4676 Admiralty Way
800 Marina del Rey, CA 90292
801
802 Phone: +1 310-822-1511
803 Fax: +1 310-823-6714
804 EMail: [email protected]
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836 <span class="grey">Postel &amp; Reynolds Informational [Page 15]</span></pre>
837 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
838 <span class="grey"><a href="./rfc2223">RFC 2223</a> Instructions to RFC Authors October 1997</span>
839
840
841 <span class="h2"><a class="selflink" id="section-20" href="#section-20">20</a>. Appendix - RFC "nroff macros"</span>
842
843 Generally, we use the very simplest nroff features. We use the "ms"
844 macros. So, "nroff -ms input-file &gt; output-file". However, we could
845 not get nroff to do the right thing about putting a form feed after
846 the last visible line on a page and no extra line feeds before the
847 first visible line of the next page. We want:
848
849 last visible line on page i
850 ^L
851 first visible line on page i+1
852
853 So, we invented a hack to fix this. We use a perl script called
854 "fix.pl". So the command to process the file becomes:
855
856 nroff -ms input-file | fix.pl &gt; output-file
857
858 The actual perl script is:
859
860
861 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
862 #! /local/bin/perl
863
864 # fix.pl 17-Nov-93 Craig Milo Rogers at USC/ISI
865 #
866 # The style guide for RFCs calls for pages to be delimited by the
867 # sequence &lt;last-non-blank-line&gt;&lt;formfeed-line&gt;&lt;first-non-blank-line&gt;.
868 # Unfortunately, NROFF is reluctant to produce output that conforms to
869 # this convention. This script fixes RFC-style documents by searching
870 # for the token "FORMFEED[Page", replacing "FORMFEED" with spaces,
871 # appending a formfeed line, and deleting white space up to the next
872 # non-white space character.
873 #
874 # There is one difference between this script's output and that of
875 # the "fix.sh" and "pg" programs it replaces: this script includes a
876 # newline after the formfeed after the last page in a file, whereas the
877 # earlier programs left a bare formfeed as the last character in the
878 # file. To obtain bare formfeeds, uncomment the second substitution
879 # command below. To strip the final formfeed, uncomment the third
880 # substitution command below.
881 #
882 # This script is intended to run as a filter, as in:
883 #
884 # nroff -ms input-file | fix.pl &gt; output-file
885 #
886 # When porting this script, please observe the following points:
887 #
888 # 1) ISI keeps perl in "/local/bin/perl"; your system may keep it
889
890
891
892 <span class="grey">Postel &amp; Reynolds Informational [Page 16]</span></pre>
893 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
894 <span class="grey"><a href="./rfc2223">RFC 2223</a> Instructions to RFC Authors October 1997</span>
895
896
897 # elsewhere.
898 # 2) On systems with a CRLF end-of-line convention, the "\n"s below
899 # may have to be replaced with "\r\n"s.
900
901 $* = 1; # Enable multiline patterns.
902 undef $/; # Read whole files in a single
903 # gulp.
904
905 while (&lt;&gt;) { # Read the entire input file.
906 s/FORMFEED(\[Page\s+\d+\])\s+/ \1\n\f\n/g;
907 # Rewrite the end-of-pages.
908 # s/\f\n$/\f/; # Want bare formfeed at end?
909 # s/\f\n$//; # Want no formfeed at end?
910 print; # Print the resultant file.
911 }
912 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
913
914
915
916
917
918
919 This script can also be copied from: <a href="ftp://ftp.isi.edu/in-notes/rfc-editor/fix.pl">ftp://ftp.isi.edu/in-notes/rfc-</a>
920 <a href="ftp://ftp.isi.edu/in-notes/rfc-editor/fix.pl">editor/fix.pl</a>
921
922 Now as to the nroff features we actually use, following is a sample
923 memo, prepared in RFC style.
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948 <span class="grey">Postel &amp; Reynolds Informational [Page 17]</span></pre>
949 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
950 <span class="grey"><a href="./rfc2223">RFC 2223</a> Instructions to RFC Authors October 1997</span>
951
952
953 .pl 10.0i
954 .po 0
955 .ll 7.2i
956 .lt 7.2i
957 .nr LL 7.2i
958 .nr LT 7.2i
959 .ds LF Waitzman
960 .ds RF PUTFFHERE[Page %]
961 .ds CF
962 .ds LH <a href="./rfc1149">RFC 1149</a>
963 .ds RH 1 April 1990
964 .ds CH IP Datagrams on Avian Carriers
965 .hy 0
966 .ad l
967 .in 0
968 Network Working Group D. Waitzman
969 Request for Comments: 1149 BBN STC
970 1 April 1990
971
972
973 .ce
974 A Standard for the Transmission of IP Datagrams on Avian Carriers
975
976 .ti 0
977 Status of this Memo
978
979 .fi
980 .in 3
981 This memo describes an experimental method for the encapsulation of IP
982 datagrams in avian carriers. This specification is primarily useful
983 in Metropolitan Area Networks. This is an experimental, not recommended
984 standard. Distribution of this memo is unlimited.
985
986 .ti 0
987 Overview and Rational
988
989 Avian carriers can provide high delay, low throughput, and low
990 altitude service. The connection topology is limited to a single
991 point-to-point path for each carrier, used with standard carriers, but
992 many carriers can be used without significant interference with each
993 other, outside of early spring. This is because of the 3D ether space
994 available to the carriers, in contrast to the 1D ether used by
995 IEEE802.3. The carriers have an intrinsic collision avoidance system,
996 which increases availability. Unlike some network technologies, such
997 as packet radio, communication is not limited to line-of-sight
998 distance. Connection oriented service is available in some cities,
999 usually based upon a central hub topology.
1000
1001
1002
1003
1004 <span class="grey">Postel &amp; Reynolds Informational [Page 18]</span></pre>
1005 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
1006 <span class="grey"><a href="./rfc2223">RFC 2223</a> Instructions to RFC Authors October 1997</span>
1007
1008
1009 .ti 0
1010 Frame Format
1011
1012 The IP datagram is printed, on a small scroll of paper, in
1013 hexadecimal, with each octet separated by whitestuff and blackstuff.
1014 The scroll of paper is wrapped around one leg of the avian carrier.
1015 A band of duct tape is used to secure the datagram's edges. The
1016 bandwidth is limited to the leg length. The MTU is variable, and
1017 paradoxically, generally increases with increased carrier age. A
1018 typical MTU is 256 milligrams. Some datagram padding may be needed.
1019
1020 Upon receipt, the duct tape is removed and the paper copy of the
1021 datagram is optically scanned into a electronically transmittable
1022 form.
1023
1024 .ti 0
1025 Discussion
1026
1027 Multiple types of service can be provided with a prioritized pecking
1028 order. An additional property is built-in worm detection and
1029 eradication. Because IP only guarantees best effort delivery, loss of
1030 a carrier can be tolerated. With time, the carriers are
1031 self-regenerating. While broadcasting is not specified, storms can
1032 cause data loss. There is persistent delivery retry, until the
1033 carrier drops. Audit trails are automatically generated, and can
1034 often be found on logs and cable trays.
1035
1036 .ti 0
1037 Security Considerations
1038
1039 .in 3
1040 Security is not generally a problem in normal operation, but special
1041 measures must be taken (such as data encryption) when avian carriers
1042 are used in a tactical environment.
1043
1044 .ti 0
1045 Author's Address
1046
1047 .nf
1048 David Waitzman
1049 BBN Systems and Technologies Corporation
1050 BBN Labs Division
1051 <span class="h2"><a class="selflink" id="section-10" href="#section-10">10</a> Moulton Street</span>
1052 Cambridge, MA 02238
1053
1054 Phone: (617) 873-4323
1055
1056 EMail: [email protected]
1057
1058
1059
1060 <span class="grey">Postel &amp; Reynolds Informational [Page 19]</span></pre>
1061 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
1062 <span class="grey"><a href="./rfc2223">RFC 2223</a> Instructions to RFC Authors October 1997</span>
1063
1064
1065 <span class="h2"><a class="selflink" id="section-21" href="#section-21">21</a>. Full Copyright Statement</span>
1066
1067 Copyright (C) The Internet Society (1997). All Rights Reserved.
1068
1069 This document and translations of it may be copied and furnished to
1070 others, and derivative works that comment on or otherwise explain it
1071 or assist in its implmentation may be prepared, copied, published and
1072 distributed, in whole or in part, without restriction of any kind,
1073 provided that the above copyright notice and this paragraph are
1074 included on all such copies and derivative works. However, this
1075 document itself may not be modified in any way, such as by removing
1076 the copyright notice or references to the Internet Society or other
1077 Internet organizations, except as needed for the purpose of
1078 developing Internet standards in which case the procedures for
1079 copyrights defined in the Internet Standards process must be
1080 followed, or as required to translate it into languages other than
1081 English.
1082
1083 The limited permissions granted above are perpetual and will not be
1084 revoked by the Internet Society or its successors or assigns.
1085
1086 This document and the information contained herein is provided on an
1087 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
1088 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
1089 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
1090 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
1091 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE."
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116 Postel &amp; Reynolds Informational [Page 20]
1117 </pre>