├── tool
    ├── rfc2629xslt.zip
    ├── xml2rfc-win.png
    ├── contrib
    │   ├── rob.austein
    │   │   ├── concat.pl
    │   │   └── fast-sync.sh
    │   ├── fred.baker
    │   │   └── new-draft.xml
    │   ├── alex.rousskov
    │   │   └── xml2rfcpp.pl
    │   └── pekka.savola
    │   │   ├── template.xml
    │   │   ├── template0.xml
    │   │   └── template1b.xml
    ├── sample.xml
    ├── LICENSE
    ├── test.xml
    ├── test.txt
    ├── rfc2629-other.ent
    ├── sample.txt
    ├── rfc2629.dtd
    ├── rfc2629.rnc
    ├── sample.html
    ├── rfc2629-xhtml.ent
    ├── rfc2629.xsd
    └── README.xml
├── README
├── Makefile
├── fix.pl
├── 9p2000.u.xml
└── 9p2000.L.xml


/tool/rfc2629xslt.zip:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ericvh/9p-rfc/HEAD/tool/rfc2629xslt.zip


--------------------------------------------------------------------------------
/tool/xml2rfc-win.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ericvh/9p-rfc/HEAD/tool/xml2rfc-win.png


--------------------------------------------------------------------------------
/README:
--------------------------------------------------------------------------------
 1 | This is for development of standards-track RFCs for 9P.  At the present 
 2 | 3 RFC drafts are planned:
 3 | 
 4 | 	9P1 		- documenting classic 9P (TODO)
 5 | 	9P2000 		- current 9P2000 standard
 6 | 	9P2000.u 	- unix extensions to 9P2000
 7 | 	9P2010		- proposed 9P2010 standard with extensions
 8 | 
 9 | People interested in helping write these suckers should look at
10 | RFC2223 (Instructions to RFC Authors) and RFC2360 (Best Current Practices).
11 | 


--------------------------------------------------------------------------------
/tool/contrib/rob.austein/concat.pl:
--------------------------------------------------------------------------------
 1 | # $Id: concat.pl,v 1.3 2004/06/27 18:07:11 sra Exp $
 2 | 
 3 | # Process all the <?rfc include="xyz" ?> directives to produce a
 4 | # single XML file, to make things easier for the RFC Editor.
 5 | 
 6 | sub concat {
 7 |     my $fn = shift;
 8 |     local *FH;
 9 |     open(FH, $fn) or die("Couldn't open \"$fn\": $!");
10 |     while (<FH>) {
11 | 	if (my ($h,$q,$f,$t) = /\A(.*[^ \t])?[ \t]*<\?rfc[ \t]+include=(.)(.+)\2[ \t]*\?>[ \t]*([^ \t].*)?\z/s) {
12 | 	    print($h);
13 | 	    concat($f . '.xml');
14 | 	    print($t);
15 | 	} else {
16 | 	    print;
17 | 	}
18 |     }
19 |     close(FH) or warn("Couldn't close \"$fn\": $!");
20 | }
21 | 
22 | concat(shift(@ARGV))
23 |     while (@ARGV);
24 | 


--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
 1 | default: rfc9p2000.txt rfc9p2000.u.txt rfc9p2000.L.txt
 2 | web: rfc9p2000.html rfc9p2000.u.html rfc9p2000.L.html
 3 | print: rfc9p2000.pdf rfc9p2000.u.pdf rfc9p2000.L.pdf
 4 | 
 5 | rfc9p2000.txt: 9p2000.xml
 6 | 	tool/xml2rfc.tcl 9p2000.xml rfc9p2000.txt
 7 | 
 8 | rfc9p2000.u.txt: 9p2000.u.xml
 9 | 	tool/xml2rfc.tcl 9p2000.u.xml rfc9p2000.u.txt
10 | 
11 | rfc9p2000.L.txt: 9p2000.L.xml
12 | 	tool/xml2rfc.tcl 9p2000.L.xml rfc9p2000.L.txt
13 | 
14 | rfc9p2000.html: 9p2000.xml
15 | 	tool/xml2rfc.tcl 9p2000.xml rfc9p2000.html
16 | 
17 | rfc9p2000.u.html: 9p2000.u.xml
18 | 	tool/xml2rfc.tcl 9p2000.u.xml rfc9p2000.u.html
19 | 
20 | rfc9p2000.L.html: 9p2000.L.xml
21 | 	tool/xml2rfc.tcl 9p2000.L.xml rfc9p2000.L.html
22 | 
23 | rfc9p2000.nr: 9p2000.xml
24 | 	tool/xml2rfc.tcl 9p2000.xml rfc9p2000.nr
25 | 
26 | rfc9p2000.L.nr: 9p2000.L.xml
27 | 	tool/xml2rfc.tcl 9p2000.L.xml rfc9p2000.L.nr
28 | 
29 | rfc9p2000.u.nr: 9p2000.u.xml
30 | 	tool/xml2rfc.tcl 9p2000.u.xml rfc9p2000.u.nr
31 | 
32 | rfc9p2000.pdf: rfc9p2000.nr
33 | 	groff -Tps rfc9p2000.nr > rfc9p2000.ps
34 | 	ps2pdf rfc9p2000.ps
35 | 
36 | rfc9p2000.u.pdf: rfc9p2000.u.nr
37 | 	groff -Tps rfc9p2000.u.nr > rfc9p2000.u.ps
38 | 	ps2pdf rfc9p2000.u.ps
39 | 
40 | rfc9p2000.L.pdf: rfc9p2000.L.nr
41 | 	groff -Tps rfc9p2000.L.nr > rfc9p2000.L.ps
42 | 	ps2pdf rfc9p2000.L.ps	
43 | 
44 | clean:
45 | 	rm -f *.txt *.html *.nr	*.ps *.pdf
46 | 


--------------------------------------------------------------------------------
/tool/sample.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <!-- edited with XMLSPY v5 rel. 3 U (http://www.xmlspy.com)
 3 |      by Daniel M Kohn (private) -->
 4 | 
 5 | <!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
 6 |     <!ENTITY rfc2119 PUBLIC '' 
 7 |       'http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml'>
 8 | ]>
 9 | 
10 | <rfc category="std" ipr="full3978" docName="sample.txt">
11 | 
12 | <?xml-stylesheet type='text/xsl' href='rfc2629.xslt' ?>
13 | 
14 | <?rfc toc="yes" ?>
15 | <?rfc symrefs="yes" ?>
16 | <?rfc sortrefs="yes"?>
17 | <?rfc iprnotified="no" ?>
18 | <?rfc strict="yes" ?>
19 | 
20 |     <front>
21 |         <title>An Example</title>
22 |         <author initials='A.Y' surname="Mous" fullname='Anon Y. Mous'>
23 |             <organization/>
24 |         </author>
25 |         <date/>
26 |         <abstract><t>An example.</t></abstract>
27 |     </front>
28 | 
29 |     <middle>
30 |         <section title="Requirements notation">
31 |             <t>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL",
32 |             "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",
33 |             and "OPTIONAL" in this document are to be interpreted as
34 |             described in <xref target="RFC2119"/>.</t>
35 |         </section>
36 | 
37 |         <section title="Security Considerations">
38 |         <t>None.</t>
39 |         </section>
40 |     </middle>
41 | 
42 |     <back>
43 |         <references title='Normative References'>&rfc2119;</references>
44 |     </back>
45 | 
46 | </rfc>
47 | 


--------------------------------------------------------------------------------
/tool/LICENSE:
--------------------------------------------------------------------------------
 1 | (c) 2003 Marshall T. Rose
 2 | All rights reserved.
 3 | 
 4 | Redistribution and use in source and binary forms, with or without
 5 | modification, are permitted provided that the following conditions
 6 | are met:
 7 | 1. Redistributions of source code must retain the above copyright
 8 |    notice, this list of conditions and the following disclaimer.
 9 | 2. Redistributions in binary form must reproduce the above copyright
10 |    notice, this list of conditions and the following disclaimer in the
11 |    documentation and/or other materials provided with the distribution.
12 | 3. Neither the name of the author nor the names of the contributors
13 |    may be used to endorse or promote products derived from this software
14 |    without specific prior written permission.
15 | 
16 | THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 | ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 | ARE DISCLAIMED.  IN NO EVENT SHALL THE AUHTORS OR CONTRIBUTORS BE LIABLE
20 | FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 | OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 | HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 | LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 | OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 | SUCH DAMAGE.
27 | 


--------------------------------------------------------------------------------
/tool/contrib/rob.austein/fast-sync.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/sh -
 2 | # Fast synchronization of xml2rfc bibliographic database.
 3 | #
 4 | # Rob Austein <sra@hactrn.net>
 5 | #
 6 | # This is the approved "easy" way:
 7 | #
 8 | #wget -q -P rfc   -r -l 1 -A .xml -nd -N
 9 | http://xml.resource.org/public/rfc/bibxml/
10 | #wget -q -P draft -r -l 1 -A .xml -nd -N
11 | http://xml.resource.org/public/rfc/bibxml3/
12 | #
13 | # ...but it's incredibly painful to watch, because it spends an insane
14 | # amount of time and bandwidth sucking down stuff which it then
15 | # immediately discards.  So here's a script that tries to be a little
16 | # smarter about what it does.  The implementation below is icky, one
17 | # could no doubt do better with some relatively trivial Perl code, but
18 | # this will do as a proof of concept.
19 | #
20 | # The idea here is to suck down just the basic HTML index, extract the
21 | # URLs of the files we actually want from that, then suck down those
22 | # files.   We use wget options which should (in theory) prevent us from
23 | # actually sucking down anything of which we have an up-to-date copy.
24 | # The definition of "interesting files" is all in the sed filter,
25 | # which is looking for filenames of the form reference.*.xml.  The sed
26 | # code knows far too much about what a generic Apache directory
27 | # listing looks like after it's been run through "lynx -dump"; if that
28 | # bothers you, feel free to fix it and send me the code.
29 | 
30 | fetch_dir() {
31 |   prefix="$1"
32 |   url="$2"
33 |   wget -q -nd -N -P "$prefix" "$url"
34 |   echo "<BASE HREF=\"$url\">" |
35 |   cat - "$prefix/index.html" |
36 |   lynx -force_html -dump /dev/stdin |
37 |   sed -n '/^References/,${; /reference\..*\.xml$/s/^ *[0-9]*\. *//p; }' |
38 |   wget -q -nd -N -P "$prefix" -i -
39 | }
40 | 
41 | cd $HOME/ietf/xml
42 | fetch_dir rfc   http://xml.resource.org/public/rfc/bibxml/
43 | fetch_dir draft http://xml.resource.org/public/rfc/bibxml3/
44 | 


--------------------------------------------------------------------------------
/tool/test.xml:
--------------------------------------------------------------------------------
 1 | <?xml version='1.0'?>
 2 | <!DOCTYPE rfc SYSTEM 'rfc2629.dtd'>
 3 | 
 4 | <?rfc comments='yes'?>
 5 | <?rfc docmapping='yes'?>
 6 | <?rfc inline='no'?>
 7 | <?rfc compact='no'?>
 8 | <?rfc editing='no'?>
 9 | <?rfc header='README'?>
10 | <?rfc private='The README file'?>
11 | <?rfc subcompact='no'?>
12 | <?rfc symrefs='no'?>
13 | <?rfc toc='yes'?>
14 | <?rfc tocappendix='no'?>
15 | <?rfc tocindent='no'?>
16 | 
17 | <rfc>
18 | <front>
19 | <title>xml2rfc v1.33</title>
20 | 
21 | <author initials='M.T.' surname='Rose' fullname='Marshall T. Rose'>
22 | <organization>Dover Beach Consulting, Inc.</organization>
23 | 
24 | <address>
25 | <postal>
26 | <street>POB 255268</street>
27 | <city>Sacramento</city> <region>CA</region> <code>95865-5268</code>
28 | <country>US</country>
29 | </postal>
30 | 
31 | <phone>+1 916 483 8878</phone>
32 | <email>mrose@dbc.mtview.ca.us</email>
33 | </address>
34 | </author>
35 | 
36 | <author fullname="Bill Fenner" initials="B." surname="Fenner">
37 | <organization>AT&amp;T Labs - Research</organization>
38 | <address>
39 | <postal>
40 | <street>1 River Oaks Place</street>
41 | <city>San Jose</city>
42 | <region>CA</region>
43 | <code>95134-1918</code>
44 | <country>US</country>
45 | </postal>
46 | <phone>+1 408 493-8505</phone>
47 | <email>fenner@research.att.com</email>
48 | </address>
49 | </author>
50 | 
51 | <author initials='C.' surname='Levert' fullname='Charles Levert'>
52 | <organization/>
53 | <address>
54 | <postal>
55 | <street/>
56 | <city>Montr&eacute;al</city>
57 | <region>QC</region>
58 | <country>Canada</country>
59 | </postal>
60 | <email>charles.levert@gmail.com</email>
61 | </address>
62 | </author>
63 | 
64 | <date month='February' year='2008' />
65 | </front>
66 | 
67 | <middle>
68 | <section title='Introduction'>
69 | <t>This is a paragraph before</t>
70 | <figure>
71 | <preamble>For example, the header field:</preamble>
72 | <artwork>Subject: This is a test</artwork>
73 | <postamble>Is a nice header field.</postamble>
74 | </figure>
75 | <t>This is another paragraph</t>
76 | </section>
77 | </middle>
78 | </rfc>
79 | 


--------------------------------------------------------------------------------
/fix.pl:
--------------------------------------------------------------------------------
 1 | #! /usr/bin/perl
 2 | 
 3 | # fix.pl  17-Nov-93  Craig Milo Rogers at USC/ISI
 4 | #
 5 | #       The style guide for RFCs calls for pages to be delimited by the
 6 | # sequence <last-non-blank-line><formfeed-line><first-non-blank-line>.
 7 | # Unfortunately, NROFF is reluctant to produce output that conforms to
 8 | # this convention.  This script fixes RFC-style documents by searching
 9 | # for the token "FORMFEED[Page", replacing "FORMFEED" with spaces,
10 | # appending a formfeed line, and deleting white space up to the next
11 | # non-white space character.
12 | #
13 | #       There is one difference between this script's output and that of
14 | # the "fix.sh" and "pg" programs it replaces:  this script includes a
15 | # newline after the formfeed after the last page in a file, whereas the
16 | # earlier programs left a bare formfeed as the last character in the
17 | # file.  To obtain bare formfeeds, uncomment the second substitution
18 | # command below.  To strip the final formfeed, uncomment the third
19 | # substitution command below.
20 | #
21 | #       This script is intended to run as a filter, as in:
22 | #
23 | # nroff -ms input-file | fix.pl > output-file
24 | #
25 | #       When porting this script, please observe the following points:
26 | #
27 | # 1)    ISI keeps perl in "/local/bin/perl";  your system may keep it
28 | 
29 | #       elsewhere.
30 | # 2)    On systems with a CRLF end-of-line convention, the "\n"s below
31 | #       may have to be replaced with "\r\n"s.
32 | 
33 | $* = 1;                                 # Enable multiline patterns.
34 | undef $/;                               # Read whole files in a single
35 |                                         # gulp.
36 | 
37 | while (<>) {                            # Read the entire input file.
38 |     s/FORMFEED(\[Page\s+\d+\])\s+/        \1\n\f\n/g;
39 |                                         # Rewrite the end-of-pages.
40 | #    s/\f\n$/\f/;                       # Want bare formfeed at end?
41 | #    s/\f\n$//;                         # Want no formfeed at end?
42 |     print;                              # Print the resultant file.
43 | }
44 | 


--------------------------------------------------------------------------------
/tool/test.txt:
--------------------------------------------------------------------------------
  1 | 
  2 | 
  3 | 
  4 | The README file                                                  M. Rose
  5 |                                             Dover Beach Consulting, Inc.
  6 |                                                                B. Fenner
  7 |                                                     AT&T Labs - Research
  8 |                                                                C. Levert
  9 |                                                        February 28, 2008
 10 | 
 11 | 
 12 |                              xml2rfc v1.33
 13 | 
 14 | 
 15 | Table of Contents
 16 | 
 17 |    1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . . . 2
 18 |        Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . 3
 19 | 
 20 | 
 21 | 
 22 | 
 23 | 
 24 | 
 25 | 
 26 | 
 27 | 
 28 | 
 29 | 
 30 | 
 31 | 
 32 | 
 33 | 
 34 | 
 35 | 
 36 | 
 37 | 
 38 | 
 39 | 
 40 | 
 41 | 
 42 | 
 43 | 
 44 | 
 45 | 
 46 | 
 47 | 
 48 | 
 49 | 
 50 | 
 51 | 
 52 | 
 53 | 
 54 | 
 55 | Rose, et al.                                                    [Page 1]
 56 | 
 57 | README                        xml2rfc v1.33                February 2008
 58 | 
 59 | 
 60 | 1.  Introduction
 61 | 
 62 |    This is a paragraph before
 63 | 
 64 |    For example, the header field:
 65 |    Subject: This is a test
 66 |    Is a nice header field.
 67 | 
 68 |    This is another paragraph
 69 | 
 70 | 
 71 | 
 72 | 
 73 | 
 74 | 
 75 | 
 76 | 
 77 | 
 78 | 
 79 | 
 80 | 
 81 | 
 82 | 
 83 | 
 84 | 
 85 | 
 86 | 
 87 | 
 88 | 
 89 | 
 90 | 
 91 | 
 92 | 
 93 | 
 94 | 
 95 | 
 96 | 
 97 | 
 98 | 
 99 | 
100 | 
101 | 
102 | 
103 | 
104 | 
105 | 
106 | 
107 | 
108 | 
109 | 
110 | 
111 | Rose, et al.                                                    [Page 2]
112 | 
113 | README                        xml2rfc v1.33                February 2008
114 | 
115 | 
116 | Authors' Addresses
117 | 
118 |    Marshall T. Rose
119 |    Dover Beach Consulting, Inc.
120 |    POB 255268
121 |    Sacramento, CA  95865-5268
122 |    US
123 | 
124 |    Phone: +1 916 483 8878
125 |    Email: mrose@dbc.mtview.ca.us
126 | 
127 | 
128 |    Bill Fenner
129 |    AT&T Labs - Research
130 |    1 River Oaks Place
131 |    San Jose, CA  95134-1918
132 |    US
133 | 
134 |    Phone: +1 408 493-8505
135 |    Email: fenner@research.att.com
136 | 
137 | 
138 |    Charles Levert
139 |    Montreal, QC
140 |    Canada
141 | 
142 |    Email: charles.levert@gmail.com
143 | 
144 | 
145 | 
146 | 
147 | 
148 | 
149 | 
150 | 
151 | 
152 | 
153 | 
154 | 
155 | 
156 | 
157 | 
158 | 
159 | 
160 | 
161 | 
162 | 
163 | 
164 | 
165 | 
166 | 
167 | Rose, et al.                                                    [Page 3]
168 | 
169 | 


--------------------------------------------------------------------------------
/tool/contrib/fred.baker/new-draft.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <!-- edited with XMLSPY v5 rel. 4 U (http://www.xmlspy.com) by Fred Baker (private) -->
 3 | <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
 4 | <?rfc toc="yes"?>
 5 | <?rfc tocompact="no"?>
 6 | <?rfc tocdepth="6"?>
 7 | <?rfc symrefs="yes"?>
 8 | <?rfc sortrefs="yes"?>
 9 | <rfc ipr="full2026" category="exp" docName="draft-baker-document-00">
10 | 	<front>
11 | 		<title abbrev="Abbreviated-Title"> Full Title </title>
12 | 		<author fullname="Fred Baker" initials="F.J." surname="Baker">
13 | 			<organization> Cisco Systems </organization>
14 | 			<address>
15 | 				<postal>
16 | 					<street>1121 Via Del Rey</street>
17 | 					<city>Santa Barbara</city>
18 | 					<code>93117</code>
19 | 					<region>California</region>
20 | 					<country>USA</country>
21 | 				</postal>
22 | 				<phone>+1-408-526-4257</phone>
23 | 				<facsimile>+1-413-473-2403</facsimile>
24 | 				<email> fred@cisco.com </email>
25 | 			</address>
26 | 		</author>
27 | 		<date month="August" year="2003"/>
28 | 		<area> Routing Area </area>
29 | 		<workgroup> Interdomain Routing Working Group </workgroup>
30 | 		<abstract>
31 | 			<t/>
32 | 		</abstract>
33 | 		<!--
34 | 		<note title="Requirements Language">
35 | 			<t>The key words &quot;MUST&quot;, &quot;MUST NOT&quot;,
36 | &quot;REQUIRED&quot;, &quot;SHALL&quot;, &quot;SHALL NOT&quot;,
37 | &quot;SHOULD&quot;, &quot;SHOULD NOT&quot;, &quot;RECOMMENDED&quot;,
38 | &quot;MAY&quot;, and &quot;OPTIONAL&quot; in this document are to be
39 | interpreted as described in  <xref target="RFC2119">RFC 2119</xref>.
40 | </t>
41 | 		</note>
42 | 		-->
43 | 	</front>
44 | 	<middle>
45 | 		<!--
46 | <figure>
47 | <preamble> preamble to Figure N.  </preamble>
48 | <artwork>
49 | <![CDATA[
50 | 	ASCII artwork goes here... 
51 | ]]>
52 | </artwork>
53 | <postamble> Figure N: Title </postamble>
54 | </figure> -->
55 | 		<!--
56 |   <t> <list style="symbols">
57 |   <t/>
58 | </list></t>
59 |  -->
60 | 		<section title="Problem Statement">
61 | 			<t/>
62 | 			<section title="Level2">
63 | 				<t/>
64 | 			</section>
65 | 			<section title="Level2">
66 | 				<t/>
67 | 			</section>
68 | 		</section>
69 | 		<section anchor="IANA" title="IANA Considerations">
70 | 			<t>This document makes no request of IANA.</t>
71 | 			<t>Note to RFC Editor: this section may be removed on publication as an RFC.</t>
72 | 		</section>
73 | 		<section anchor="Security" title="Security Considerations">
74 | 			<t/>
75 | 		</section>
76 | 		<section anchor="Acknowledgements" title="Acknowledgements">
77 | 			<t/>
78 | 		</section>
79 | 	</middle>
80 | 	<back>
81 | 		<references title="Normative References">
82 | 			<?rfc include="reference.RFC.2119" ?>
83 | 		</references>
84 | 		<references title="Informative References">		
85 | 		</references>
86 | 	</back>
87 | </rfc>
88 | 


--------------------------------------------------------------------------------
/tool/rfc2629-other.ent:
--------------------------------------------------------------------------------
 1 | <!-- rfc2629-other.ent
 2 | 
 3 |      Character entity set for RFC-2629 source xml documents.
 4 |      There is no need to invoke this directly from
 5 |      the source document itself; just invoke the DTD.
 6 | 
 7 |      These are unknown to (X)HTML, so any converter to these
 8 |      formats must either substitute these entities
 9 |      or invoke this file from the output file.
10 | 
11 |      Conversion to txt or nroff format will replace
12 |      these entities by the parenthesized text.
13 | 
14 |      Typical invocation:
15 |        <!ENTITY % rfc2629-other
16 |                 PUBLIC "-//IETF//ENTITIES Other for RFC 2629//EN"
17 |                        "http://xml.resource.org/authoring/rfc2629-other.ent">
18 |        %rfc2629-other;
19 | -->
20 | 
21 | <!-- Magical -->
22 | <!--     rfc.number            (automatically expanded to content
23 |                                 of number="..." attribute
24 |                                 of <rfc> element, or to "XXXX")                       -->
25 | 
26 | <!-- ASCII -->
27 | <!ENTITY excl     "&#33;"><!-- U+0021 EXCLAMATION MARK                  ("!")         -->
28 | <!ENTITY num      "&#35;"><!-- U+0023 NUMBER SIGN                       ("#")         -->
29 | <!ENTITY dollar   "&#36;"><!-- U+0024 DOLLAR SIGN                       ("$")         -->
30 | <!ENTITY percnt   "&#37;"><!-- U+0025 PERCENT SIGN                      ("%")         -->
31 | <!ENTITY lpar     "&#40;"><!-- U+0028 LEFT PARENTHESIS                  ("(")         -->
32 | <!ENTITY rpar     "&#41;"><!-- U+0029 RIGHT PARENTHESIS                 (")")         -->
33 | <!ENTITY ast      "&#42;"><!-- U+002A ASTERISK                          ("*")         -->
34 | <!ENTITY plus     "&#43;"><!-- U+002B PLUS SIGN                         ("+")         -->
35 | <!ENTITY comma    "&#44;"><!-- U+002C COMMA                             (",")         -->
36 | <!ENTITY hyphen   "&#45;"><!-- U+002D HYPHEN-MINUS                      ("-")         -->
37 | <!ENTITY period   "&#46;"><!-- U+002E FULL STOP                         (".")         -->
38 | <!ENTITY sol      "&#47;"><!-- U+002F SOLIDUS                           ("/")         -->
39 | <!ENTITY colon    "&#58;"><!-- U+003A COLON                             (":")         -->
40 | <!ENTITY semi     "&#59;"><!-- U+003B SEMICOLON                         (";")         -->
41 | <!ENTITY equals   "&#61;"><!-- U+003D EQUALS SIGN                       ("=")         -->
42 | <!ENTITY quest    "&#63;"><!-- U+003F QUESTION MARK                     ("?")         -->
43 | <!ENTITY commat   "&#64;"><!-- U+0040 COMMERCIAL AT                     ("@")         -->
44 | <!ENTITY lsqb     "&#91;"><!-- U+005B LEFT SQUARE BRACKET               ("[")         -->
45 | <!ENTITY bsol     "&#92;"><!-- U+005C REVERSE SOLIDUS                   ("\\")        -->
46 | <!ENTITY rsqb     "&#93;"><!-- U+005D RIGHT SQUARE BRACKET              ("]")         -->
47 | <!ENTITY circ     "&#94;"><!-- U+005E CIRCUMFLEX ACCENT                 ("^")         -->
48 | <!ENTITY lowbar   "&#95;"><!-- U+005F LOW LINE                          ("_")         -->
49 | <!ENTITY grave    "&#96;"><!-- U+0060 GRAVE ACCENT                      ("`")         -->
50 | <!ENTITY lcub    "&#123;"><!-- U+007B LEFT CURLY BRACKET                ("{")         -->
51 | <!ENTITY verbar  "&#124;"><!-- U+007C VERTICAL LINE                     ("|")         -->
52 | <!ENTITY rcub    "&#125;"><!-- U+007D RIGHT CURLY BRACKET               ("}")         -->
53 | 
54 | <!-- Useful Unicode -->
55 | <!ENTITY Zcaron  "&#381;"><!-- U+017D LATIN CAPITAL LETTER Z WITH CARON ("Z")         -->
56 | <!ENTITY zcaron  "&#382;"><!-- U+017E LATIN SMALL LETTER Z WITH CARON   ("z")         -->
57 | <!ENTITY dash   "&#8208;"><!-- U+2010 HYPHEN                            ("-")         -->
58 | <!ENTITY nbhy   "&#8209;"><!-- U+2011 NON-BREAKING HYPHEN               (special "-") -->
59 | <!ENTITY wj     "&#8288;"><!-- U+2060 WORD JOINER                       (special "")  -->
60 | 
61 | <!-- EOF -->
62 | 


--------------------------------------------------------------------------------
/tool/contrib/alex.rousskov/xml2rfcpp.pl:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/perl -w
  2 | use strict;
  3 | 
  4 | #
  5 | # About:
  6 | #       This script intends to do the following,
  7 | #       in the specified order: 
  8 | #           - read standard input
  9 | #           - find various xml2rfc-include statements
 10 | #           - substitute those statements with included files
 11 | #           - find declarations of XML internal entities
 12 | #           - delete those declarations
 13 | #           - substitute declared internal entity names with their definitions
 14 | #           - trim space in artwork element that has trimspace=yes
 15 | #           - write the result to standard output.
 16 | #       The only recognized XML internal entity declaration 
 17 | #       pattern is:  <!ENTITY name "definition">
 18 | #       XML_LIBRARY environment variable is used as a path for includes.
 19 | #
 20 | # Bugs:
 21 | #        This script is not XML-aware.
 22 | #        Self-referencing entities or include statements 
 23 | #        result in an infinite loop.
 24 | #
 25 | # Legal: 
 26 | #        This script has been placed in public domain by
 27 | #        the good folks at The Measurement Factory.
 28 | # 
 29 | # $Id: xmlpp.pl,v 1.8 2004/05/05 08:12:06 rousskov Exp $
 30 | 
 31 | # read everything in
 32 | my $xml = '';
 33 | while (<STDIN>) {
 34 | 	$xml .= $_;
 35 | }
 36 | 
 37 | # handle includes
 38 | $xml =~ s/<\?rfc\s+include=['"]([^'"]+)['"]\s*\?>/&loadFile($1)/esg;
 39 | 
 40 | # find entity declarations
 41 | my %Entities = ();
 42 | while ($xml =~ s/<!ENTITY\s+([\w-]+)\s+"([^"]*)"\s*>//s) {
 43 | 	my $name = $1;
 44 | 	my $value = $2;
 45 | 	if (exists $Entities{$name}) {
 46 | 		die("entity $name redefined from ".
 47 | 			"'$Entities{$name}' to '$name' near '$&', stopped");
 48 | 	} else {
 49 | 		$Entities{$name} = $value;
 50 | 	}
 51 | }
 52 | 
 53 | # substitute entities recursively
 54 | my $stable;
 55 | do {
 56 | 	$stable = 1;
 57 | 	while (my ($name, $value) = each %Entities) {
 58 | 		$stable = 0 if $xml =~ s/\&$name\;/$value/g;
 59 | 	}
 60 | } until $stable;
 61 | 
 62 | 
 63 | # check that all entries are resolved
 64 | 
 65 | my $xml_nocd = $xml;
 66 | $xml_nocd =~ s|\Q<![CDATA[\E.*?\Q]]>\E||sg; # remove CDATA
 67 | my %reported = map { $_ => 0 } qw(lt amp quot apos rfc);
 68 | my @remaining = ($xml_nocd =~ /\&([\w-]+)/g);
 69 | my $errCount = 0;
 70 | foreach my $e (@remaining) {
 71 | 	next if exists $reported{$e};
 72 | 	warn(sprintf("error: unresolved or malformed XML entity '%s'\n", $e));
 73 | 	$reported{$e} = 1;
 74 | 	$errCount++;
 75 | }
 76 | die(sprintf("error: %d unresolved or malformed XML entity(ies)\n", $errCount))
 77 | 	if $errCount > 0;
 78 | 
 79 | # handle trimspace
 80 | $xml =~ s|<artwork\s+trimspace=['"]([^'"]+)['"]\s*>(.*?)</artwork>|&trimSpace($1,$2)|esg;
 81 | 
 82 | print $xml;
 83 | 
 84 | exit 0;
 85 | 
 86 | 
 87 | 
 88 | sub loadFile {
 89 | 	my $name = $_[0];
 90 | 
 91 | 	my $dirs = $ENV{'XML_LIBRARY'};
 92 | 	$dirs = '.' unless defined $dirs;
 93 | 	foreach my $dir (split (/:+/, $dirs)) {
 94 | 		my $fname = "$dir/$name";
 95 | 		next unless -e $fname;
 96 | 
 97 | 		my $content = '';
 98 | 		open(IF, "<$fname") or die("cannot read included file: $fname, stopped");
 99 | 		while (<IF>) {
100 | 			$content .= $_;
101 | 		}
102 | 		close(IF);
103 | 		return $content;
104 | 	}
105 | 
106 | 	if (defined $ENV{'XML_LIBRARY'}) {
107 | 		warn("search path derived from the XML_LIBRARY environment variable;\n");
108 | 	} else {
109 | 		warn("XML_LIBRARY environment variable is not set;\n");
110 | 	}
111 | 	die("cannot find included '$name' in '$dirs' path, stopped");
112 | }
113 | 
114 | sub trimSpace {
115 | 	my ($trim, $artwork) = @_;
116 | 
117 | 	my @lines = split(/\n/s, $artwork);
118 | 	my $indent = ($trim eq 'indent') ? '    ' : '';
119 | 
120 | 	if (($trim eq 'yes' || $trim eq 'indent') && @lines) {
121 | 		$lines[0] =~ s/^\s+//g;
122 | 		$lines[$#lines] =~ s/\s+$//g;
123 | 
124 | 		if (@lines > 2) {
125 | 			my ($tabs) = ($lines[1] =~ /^(\t*)/);
126 | 			if (length($tabs) > 0) {
127 | 				foreach my $line (@lines) {
128 | 					$line =~ s/^$tabs|\s+$/$indent/;
129 | 				} 
130 | 			}
131 | 		}
132 | 
133 | 		shift @lines unless length($lines[0]);
134 | 		pop @lines unless length($lines[$#lines]);
135 | 	}
136 | 
137 | 	return '<artwork>' . join("\n", @lines) . '</artwork>';
138 | }
139 | 	
140 | 


--------------------------------------------------------------------------------
/tool/contrib/pekka.savola/template.xml:
--------------------------------------------------------------------------------
  1 | la <?xml version="1.0" encoding="UTF-8"?>
  2 | <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
  3 | <!-- may be omitted for very short documents --> 
  4 | <?rfc toc="yes"?>
  5 | <?rfc sortrefs="yes"?>
  6 | 
  7 | <!-- these two save paper: start new sections from the same page etc. -->
  8 | <?rfc compact="yes"?> <?rfc subcompact="no"?>
  9 | 
 10 | <!-- other categories: bcp, exp, historic, std -->
 11 | <rfc ipr="full3667" category="info" docName="draft-savola-xml2rfc-template-00.txt" updates="1,2" obsoletes="3">
 12 | 
 13 | <front>
 14 | <title abbrev="Template Shortname for Headers">An XML2RFC Template</title>
 15 | 
 16 | <!-- add 'role="editor"' below for the editors if requiring designation -->
 17 | <author fullname="Pekka Savola" initials="P." surname="Savola">
 18 | 
 19 | 	<!-- abbrev not needed but can be used for the header if full company name is too long -->
 20 | 	<organization abbrev="CSC/FUNET">CSC - Scientific Computing Ltd.</organization>
 21 | 	<address>
 22 | 		<!-- 
 23 | 		     if you want to omit the postal information, just use a <postal/>
 24 | 		     .. / at the end also acts as a closing tag
 25 | 		-->
 26 | 	<postal>
 27 | 		<street/>
 28 | 		<city>Espoo</city>
 29 | 		<!--
 30 | 			<region>MN</region>
 31 | 			<code>11111</code>
 32 | 		-->
 33 | 		<country>Finland</country>
 34 | 	</postal>
 35 | 	<email> psavola@funet.fi </email>
 36 | 	<!--
 37 | 		<tel>+1-555-911-9112</tel>
 38 | 		<facsimile>+1-555-911-9111</facsimile>
 39 | 		<uri>http://127.0.0.1/</uri>
 40 | 	-->
 41 | 	</address>
 42 | </author>
 43 | <date year="2004"/> 			<!-- month="May" is no longer necessary -->
 44 | 
 45 | <!-- not used for anything ? -->
 46 | <area>Operations &amp; Management</area>
 47 | 
 48 | <!-- WG name at the upperleft corner of the doc, IETF fine for individual submissions -->
 49 | <workgroup>Internet Engineering Task Force</workgroup>
 50 | 
 51 | <abstract>
 52 | 	<t>This is an abstract abstract.  Remember, don't add references here.</t>
 53 | </abstract>
 54 | </front>
 55 | <middle>
 56 | 
 57 | 
 58 | <note title="Foreword">
 59 | 	<t>SEE RFC2629(bis) FOR MORE INFORMATION:
 60 | http://xml.resource.org/public/rfc/html/rfc2629.html and "bis":
 61 | http://xml.resource.org/authoring/draft-mrose-writing-rfcs.html.  Also see
 62 | http://xml.resource.org/authoring/README.html for for 'rfc' option
 63 | strings.</t>
 64 | 	<t>Please also remember to check out
 65 | http://www.ietf.org/ID-Checklist.html for issues to note when writing
 66 | drafts.</t>
 67 | 	<t>Remember, you don't need to have any other tools than a 'notepad'
 68 | or your favourite editor to write xml2rfc drafts.  You can use the web
 69 | interface at http://xml.resource.org for processing.  The benefit of using
 70 | xml editors is mostly catching those missing tags which the processor will
 71 | warn you about, but you don't need to worry about the editors when getting
 72 | started.</t>
 73 | 	<t>This template is not meant to be a conclusive list of everything,
 74 | but summarize the often-needed basic features to get one started.</t>
 75 | </note>
 76 | 
 77 | 
 78 | 
 79 | <section title="Introduction">
 80 | 	<t>Now you can have a bit more lengthier text here.</t>
 81 | 	<t>Let's refer to a couple of documents: <xref
 82 | target="I-D.ietf-v6ops-3gpp-analysis"/> and <xref
 83 | target="RFC2661">L2TP</xref>.  For text generation, these look equivalent,
 84 | but the latter looks a bit neater in the HTML representation.</t>
 85 | 	<t>You might also add a note about the usage of RFC2119 keywords here..</t>
 86 | 	<t>You can cross-reference the sections in a stable manner; <xref
 87 | target="sect2"/></t>.
 88 | </section>
 89 | 
 90 | 
 91 | 
 92 | <section anchor="sect2" title="Sections go under here..">
 93 | 	<t>There are multiple list styles: 'symbols', 'letters', 'numbers',
 94 | 'hanging', 'format', etc.</t>
 95 | 	<list style="symbols">
 96 | 		<t>First bullet</t>
 97 | 		<t>Second bullet</t>
 98 | 	</list>
 99 | 	<t>One can draw fancy diagrams as well; remember to ensure that they
100 | don't exceed 72 chars/line.</t>
101 | 	<!-- you can specify how many contiguous lines you need (w/o linebreak you need -->
102 | 	<?rfc needLines="5" ?>
103 | 	<figure anchor="xml_happy">
104 | 	<artwork>
105 | <![CDATA[
106 | +-----------------------+
107 | | Use XML, be Happy :-) |
108 | |_______________________|
109 | ]]>
110 | 	</artwork>
111 | 	</figure>
112 | 	<t>Note that including a CDATA you don't need to escape most special characters
113 | you might otherwise have to.</t>
114 | 	<section title="A Subsection">
115 | 		<t>There can be a lot of subsections.  By default 3 levels of
116 | nesting show in ToC but that can be adjusted.</t>
117 | 	</section>
118 | </section>
119 | 
120 | 
121 | 
122 | 
123 | 
124 | 
125 | <section title="Decrypting XML2RFC Parsing errors">
126 | 	<t>The most common form of xml2rfc parsing erros are those where a
127 | closing tag has been expected to be present before a new kind of tag is
128 | specified.  In the example below, Introduction section's last paragraph was
129 | missing the closing t-element.  The rest of the error messages can be rather
130 | easily understood as well by reading it carefully and examining the context. 
131 | The reason is typically a missing tag somewhere.</t>
132 |         <figure>
133 |         <artwork>
134 | <![CDATA[
135 | ======8<=========
136 | end tag "section" does not match open element "t" around line 65
137 | 
138 | Context: 
139 |     <rfc ipr="full3667" category="info" docName="draft-savola-xml2rfc-template-00.txt" updates="1,2" obsoletes="3">
140 |     <middle>
141 |     <section title="Introduction">
142 |     <t>
143 | =======8<========
144 | ]]>
145 | 	</artwork>
146 | 	</figure>
147 | </section>
148 | 
149 | 
150 | 
151 | <section title="Acknowledgements">
152 | 	<t>Remember, it's important to acknowledge people who have
153 | contributed to the work.</t>
154 | </section>
155 | 
156 | <!-- possibly a 'Contributors' section ... -->
157 | 
158 | <section title="IANA Considerations">
159 | 	<t>This memo includes no request to IANA.</t>
160 | 	<t>(It's good to have an explicit note because otherwise IANA wastes
161 | cycles trying to figure out if something is needed..)</t>
162 | </section>
163 | 
164 | 
165 | 
166 | <section title="Security Considerations">
167 | 	<t>Remember to consider security from the start..</t>
168 | </section>
169 | </middle>
170 | <back>
171 | 
172 | 
173 | 
174 | <!-- references split to informative and normative -->
175 | <references title="Normative References">
176 |         <?rfc include="reference.RFC.2661" ?>
177 | </references>
178 | <references title="Informative References">
179 | 	<?rfc include="reference.I-D.ietf-v6ops-3gpp-analysis" ?>
180 | </references>
181 | 
182 | 
183 | <section anchor="appendix" title="Redundant stuff">
184 | 	<t>You can add appendices just as regular sections, the only
185 | difference is that they go under "back" element..</t>
186 | </section>
187 | </back>
188 | 
189 | </rfc>
190 | 


--------------------------------------------------------------------------------
/tool/contrib/pekka.savola/template0.xml:
--------------------------------------------------------------------------------
  1 | la <?xml version="1.0" encoding="UTF-8"?>
  2 | <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
  3 | <!-- may be omitted for very short documents --> 
  4 | <?rfc toc="yes"?>
  5 | <?rfc sortrefs="yes"?>
  6 | 
  7 | <!-- these two save paper: start new sections from the same page etc. -->
  8 | <?rfc compact="yes"?> <?rfc subcompact="no"?>
  9 | 
 10 | <!-- other categories: bcp, exp, historic, std -->
 11 | <rfc ipr="full3667" category="info" docName="draft-savola-xml2rfc-template-00.txt" updates="1,2" obsoletes="3">
 12 | 
 13 | <front>
 14 | <title abbrev="Template Shortname for Headers">An XML2RFC Template</title>
 15 | 
 16 | <!-- add 'role="editor"' below for the editors if requiring designation -->
 17 | <author fullname="Pekka Savola" initials="P." surname="Savola">
 18 | 
 19 | 	<!-- abbrev not needed but can be used for the header if full company name is too long -->
 20 | 	<organization abbrev="CSC/FUNET">CSC - Scientific Computing Ltd.</organization>
 21 | 	<address>
 22 | 		<!-- 
 23 | 		     if you want to omit the postal information, just use a <postal/>
 24 | 		     .. / at the end also acts as a closing tag
 25 | 		-->
 26 | 	<postal>
 27 | 		<street/>
 28 | 		<city>Espoo</city>
 29 | 		<!--
 30 | 			<region>MN</region>
 31 | 			<code>11111</code>
 32 | 		-->
 33 | 		<country>Finland</country>
 34 | 	</postal>
 35 | 	<email> psavola@funet.fi </email>
 36 | 	<!--
 37 | 		<tel>+1-555-911-9112</tel>
 38 | 		<facsimile>+1-555-911-9111</facsimile>
 39 | 		<uri>http://127.0.0.1/</uri>
 40 | 	-->
 41 | 	</address>
 42 | </author>
 43 | <date year="2004"/> 			<!-- month="May" is no longer necessary -->
 44 | 
 45 | <!-- not used for anything ? -->
 46 | <area>Operations &amp; Management</area>
 47 | 
 48 | <!-- WG name at the upperleft corner of the doc, IETF fine for individual submissions -->
 49 | <workgroup>Internet Engineering Task Force</workgroup>
 50 | 
 51 | <abstract>
 52 | 	<t>This is an abstract abstract.  Remember, don't add references here.</t>
 53 | </abstract>
 54 | </front>
 55 | <middle>
 56 | 
 57 | 
 58 | <note title="Foreword">
 59 | 	<t>SEE RFC2629(bis) FOR MORE INFORMATION:
 60 | http://xml.resource.org/public/rfc/html/rfc2629.html and "bis":
 61 | http://xml.resource.org/authoring/draft-mrose-writing-rfcs.html.  Also see
 62 | http://xml.resource.org/authoring/README.html for for 'rfc' option
 63 | strings.</t>
 64 | 	<t>Please also remember to check out
 65 | http://www.ietf.org/ID-Checklist.html for issues to note when writing
 66 | drafts.</t>
 67 | 	<t>Remember, you don't need to have any other tools than a 'notepad'
 68 | or your favourite editor to write xml2rfc drafts.  You can use the web
 69 | interface at http://xml.resource.org for processing.  The benefit of using
 70 | xml editors is mostly catching those missing tags which the processor will
 71 | warn you about, but you don't need to worry about the editors when getting
 72 | started.</t>
 73 | 	<t>This template is not meant to be a conclusive list of everything,
 74 | but summarize the often-needed basic features to get one started.</t>
 75 | </note>
 76 | 
 77 | 
 78 | 
 79 | <section title="Introduction">
 80 | 	<t>Now you can have a bit more lengthier text here.</t>
 81 | 	<t>Let's refer to a couple of documents: <xref
 82 | target="I-D.ietf-v6ops-3gpp-analysis"/> and <xref
 83 | target="RFC2661">L2TP</xref>.  For text generation, these look equivalent,
 84 | but the latter looks a bit neater in the HTML representation.</t>
 85 | 	<t>You might also add a note about the usage of RFC2119 keywords here..</t>
 86 | 	<t>You can cross-reference the sections in a stable manner; <xref
 87 | target="sect2"/></t>.
 88 | </section>
 89 | 
 90 | 
 91 | 
 92 | <section anchor="sect2" title="Sections go under here..">
 93 | 	<t>There are multiple list styles: 'symbols', 'letters', 'numbers',
 94 | 'hanging', 'format', etc.</t>
 95 | 	<list style="symbols">
 96 | 		<t>First bullet</t>
 97 | 		<t>Second bullet</t>
 98 | 	</list>
 99 | 	<t>One can draw fancy diagrams as well; remember to ensure that they
100 | don't exceed 72 chars/line.</t>
101 | 	<!-- you can specify how many contiguous lines you need (w/o linebreak you need -->
102 | 	<?rfc needLines="5" ?>
103 | 	<figure anchor="xml_happy">
104 | 	<artwork>
105 | <![CDATA[
106 | +-----------------------+
107 | | Use XML, be Happy :-) |
108 | |_______________________|
109 | ]]>
110 | 	</artwork>
111 | 	</figure>
112 | 	<t>Note that including a CDATA you don't need to escape most special characters
113 | you might otherwise have to.</t>
114 | 	<section title="A Subsection">
115 | 		<t>There can be a lot of subsections.  By default 3 levels of
116 | nesting show in ToC but that can be adjusted.</t>
117 | 	</section>
118 | </section>
119 | 
120 | 
121 | 
122 | 
123 | 
124 | 
125 | <section title="Decrypting XML2RFC Parsing errors">
126 | 	<t>The most common form of xml2rfc parsing erros are those where a
127 | closing tag has been expected to be present before a new kind of tag is
128 | specified.  In the example below, Introduction section's last paragraph was
129 | missing the closing t-element.  The rest of the error messages can be rather
130 | easily understood as well by reading it carefully and examining the context. 
131 | The reason is typically a missing tag somewhere.</t>
132 |         <figure>
133 |         <artwork>
134 | <![CDATA[
135 | ======8<=========
136 | end tag "section" does not match open element "t" around line 65
137 | 
138 | Context: 
139 |     <rfc ipr="full3667" category="info" docName="draft-savola-xml2rfc-template-00.txt" updates="1,2" obsoletes="3">
140 |     <middle>
141 |     <section title="Introduction">
142 |     <t>
143 | =======8<========
144 | ]]>
145 | 	</artwork>
146 | 	</figure>
147 | </section>
148 | 
149 | 
150 | 
151 | <section title="Acknowledgements">
152 | 	<t>Remember, it's important to acknowledge people who have
153 | contributed to the work.</t>
154 | </section>
155 | 
156 | <!-- possibly a 'Contributors' section ... -->
157 | 
158 | <section title="IANA Considerations">
159 | 	<t>This memo includes no request to IANA.</t>
160 | 	<t>(It's good to have an explicit note because otherwise IANA wastes
161 | cycles trying to figure out if something is needed..)</t>
162 | </section>
163 | 
164 | 
165 | 
166 | <section title="Security Considerations">
167 | 	<t>Remember to consider security from the start..</t>
168 | </section>
169 | </middle>
170 | <back>
171 | 
172 | 
173 | 
174 | <!-- references split to informative and normative -->
175 | <references title="Normative References">
176 |         <?rfc include="reference.RFC.2661" ?>
177 | </references>
178 | <references title="Informative References">
179 | 	<?rfc include="reference.I-D.ietf-v6ops-3gpp-analysis" ?>
180 | </references>
181 | 
182 | 
183 | <section anchor="appendix" title="Redundant stuff">
184 | 	<t>You can add appendices just as regular sections, the only
185 | difference is that they go under "back" element..</t>
186 | </section>
187 | </back>
188 | 
189 | </rfc>
190 | 


--------------------------------------------------------------------------------
/tool/sample.txt:
--------------------------------------------------------------------------------
  1 | 
  2 | 
  3 | 
  4 | Network Working Group                                            A. Mous
  5 | Internet-Draft                                         February 28, 2008
  6 | Intended status: Standards Track
  7 | Expires: August 31, 2008
  8 | 
  9 | 
 10 |                                An Example
 11 |                                sample.txt
 12 | 
 13 | Status of this Memo
 14 | 
 15 |    By submitting this Internet-Draft, each author represents that any
 16 |    applicable patent or other IPR claims of which he or she is aware
 17 |    have been or will be disclosed, and any of which he or she becomes
 18 |    aware will be disclosed, in accordance with Section 6 of BCP 79.
 19 | 
 20 |    Internet-Drafts are working documents of the Internet Engineering
 21 |    Task Force (IETF), its areas, and its working groups.  Note that
 22 |    other groups may also distribute working documents as Internet-
 23 |    Drafts.
 24 | 
 25 |    Internet-Drafts are draft documents valid for a maximum of six months
 26 |    and may be updated, replaced, or obsoleted by other documents at any
 27 |    time.  It is inappropriate to use Internet-Drafts as reference
 28 |    material or to cite them other than as "work in progress."
 29 | 
 30 |    The list of current Internet-Drafts can be accessed at
 31 |    http://www.ietf.org/ietf/1id-abstracts.txt.
 32 | 
 33 |    The list of Internet-Draft Shadow Directories can be accessed at
 34 |    http://www.ietf.org/shadow.html.
 35 | 
 36 |    This Internet-Draft will expire on August 31, 2008.
 37 | 
 38 | 
 39 | 
 40 | 
 41 | 
 42 | 
 43 | 
 44 | 
 45 | 
 46 | 
 47 | 
 48 | 
 49 | 
 50 | 
 51 | 
 52 | 
 53 | 
 54 | 
 55 | Mous                     Expires August 31, 2008                [Page 1]
 56 | 
 57 | Internet-Draft                 An Example                  February 2008
 58 | 
 59 | 
 60 | Abstract
 61 | 
 62 |    An example.
 63 | 
 64 | 
 65 | Table of Contents
 66 | 
 67 |    1.  Requirements notation . . . . . . . . . . . . . . . . . . . . . 3
 68 |    2.  Security Considerations . . . . . . . . . . . . . . . . . . . . 4
 69 |    3.  Normative References  . . . . . . . . . . . . . . . . . . . . . 5
 70 |    Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . . 6
 71 |    Intellectual Property and Copyright Statements  . . . . . . . . . . 7
 72 | 
 73 | 
 74 | 
 75 | 
 76 | 
 77 | 
 78 | 
 79 | 
 80 | 
 81 | 
 82 | 
 83 | 
 84 | 
 85 | 
 86 | 
 87 | 
 88 | 
 89 | 
 90 | 
 91 | 
 92 | 
 93 | 
 94 | 
 95 | 
 96 | 
 97 | 
 98 | 
 99 | 
100 | 
101 | 
102 | 
103 | 
104 | 
105 | 
106 | 
107 | 
108 | 
109 | 
110 | 
111 | Mous                     Expires August 31, 2008                [Page 2]
112 | 
113 | Internet-Draft                 An Example                  February 2008
114 | 
115 | 
116 | 1.  Requirements notation
117 | 
118 |    The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
119 |    "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
120 |    document are to be interpreted as described in [RFC2119].
121 | 
122 | 
123 | 
124 | 
125 | 
126 | 
127 | 
128 | 
129 | 
130 | 
131 | 
132 | 
133 | 
134 | 
135 | 
136 | 
137 | 
138 | 
139 | 
140 | 
141 | 
142 | 
143 | 
144 | 
145 | 
146 | 
147 | 
148 | 
149 | 
150 | 
151 | 
152 | 
153 | 
154 | 
155 | 
156 | 
157 | 
158 | 
159 | 
160 | 
161 | 
162 | 
163 | 
164 | 
165 | 
166 | 
167 | Mous                     Expires August 31, 2008                [Page 3]
168 | 
169 | Internet-Draft                 An Example                  February 2008
170 | 
171 | 
172 | 2.  Security Considerations
173 | 
174 |    None.
175 | 
176 | 
177 | 
178 | 
179 | 
180 | 
181 | 
182 | 
183 | 
184 | 
185 | 
186 | 
187 | 
188 | 
189 | 
190 | 
191 | 
192 | 
193 | 
194 | 
195 | 
196 | 
197 | 
198 | 
199 | 
200 | 
201 | 
202 | 
203 | 
204 | 
205 | 
206 | 
207 | 
208 | 
209 | 
210 | 
211 | 
212 | 
213 | 
214 | 
215 | 
216 | 
217 | 
218 | 
219 | 
220 | 
221 | 
222 | 
223 | Mous                     Expires August 31, 2008                [Page 4]
224 | 
225 | Internet-Draft                 An Example                  February 2008
226 | 
227 | 
228 | 3.  Normative References
229 | 
230 |    [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
231 |               Requirement Levels", BCP 14, RFC 2119, March 1997.
232 | 
233 | 
234 | 
235 | 
236 | 
237 | 
238 | 
239 | 
240 | 
241 | 
242 | 
243 | 
244 | 
245 | 
246 | 
247 | 
248 | 
249 | 
250 | 
251 | 
252 | 
253 | 
254 | 
255 | 
256 | 
257 | 
258 | 
259 | 
260 | 
261 | 
262 | 
263 | 
264 | 
265 | 
266 | 
267 | 
268 | 
269 | 
270 | 
271 | 
272 | 
273 | 
274 | 
275 | 
276 | 
277 | 
278 | 
279 | Mous                     Expires August 31, 2008                [Page 5]
280 | 
281 | Internet-Draft                 An Example                  February 2008
282 | 
283 | 
284 | Author's Address
285 | 
286 |    Anon Y. Mous
287 | 
288 | 
289 | 
290 | 
291 | 
292 | 
293 | 
294 | 
295 | 
296 | 
297 | 
298 | 
299 | 
300 | 
301 | 
302 | 
303 | 
304 | 
305 | 
306 | 
307 | 
308 | 
309 | 
310 | 
311 | 
312 | 
313 | 
314 | 
315 | 
316 | 
317 | 
318 | 
319 | 
320 | 
321 | 
322 | 
323 | 
324 | 
325 | 
326 | 
327 | 
328 | 
329 | 
330 | 
331 | 
332 | 
333 | 
334 | 
335 | Mous                     Expires August 31, 2008                [Page 6]
336 | 
337 | Internet-Draft                 An Example                  February 2008
338 | 
339 | 
340 | Full Copyright Statement
341 | 
342 |    Copyright (C) The IETF Trust (2008).
343 | 
344 |    This document is subject to the rights, licenses and restrictions
345 |    contained in BCP 78, and except as set forth therein, the authors
346 |    retain all their rights.
347 | 
348 |    This document and the information contained herein are provided on an
349 |    "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
350 |    OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND
351 |    THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS
352 |    OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF
353 |    THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
354 |    WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
355 | 
356 | 
357 | Intellectual Property
358 | 
359 |    The IETF takes no position regarding the validity or scope of any
360 |    Intellectual Property Rights or other rights that might be claimed to
361 |    pertain to the implementation or use of the technology described in
362 |    this document or the extent to which any license under such rights
363 |    might or might not be available; nor does it represent that it has
364 |    made any independent effort to identify any such rights.  Information
365 |    on the procedures with respect to rights in RFC documents can be
366 |    found in BCP 78 and BCP 79.
367 | 
368 |    Copies of IPR disclosures made to the IETF Secretariat and any
369 |    assurances of licenses to be made available, or the result of an
370 |    attempt made to obtain a general license or permission for the use of
371 |    such proprietary rights by implementers or users of this
372 |    specification can be obtained from the IETF on-line IPR repository at
373 |    http://www.ietf.org/ipr.
374 | 
375 |    The IETF invites any interested party to bring to its attention any
376 |    copyrights, patents or patent applications, or other proprietary
377 |    rights that may cover technology that may be required to implement
378 |    this standard.  Please address the information to the IETF at
379 |    ietf-ipr@ietf.org.
380 | 
381 | 
382 | 
383 | 
384 | 
385 | 
386 | 
387 | 
388 | 
389 | 
390 | 
391 | Mous                     Expires August 31, 2008                [Page 7]
392 | 
393 | 


--------------------------------------------------------------------------------
/tool/rfc2629.dtd:
--------------------------------------------------------------------------------
  1 | <!--
  2 |   revised DTD for the RFC document series, draft of 2008-02-01
  3 |   -->
  4 | 
  5 | 
  6 | <!--
  7 |   Typical invocation:
  8 |       <!DOCTYPE rfc PUBLIC "-//IETF//DTD RFC 2629//EN"
  9 |                            "http://xml.resource.org/authoring/rfc2629.dtd" [
 10 |         ... dtd subset ...
 11 |       ]>
 12 |     or
 13 |       <!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
 14 |         ... dtd subset ...
 15 |       ]>
 16 |   -->
 17 | 
 18 | 
 19 | <!--
 20 |   Contents
 21 | 
 22 |     Character entities
 23 | 
 24 |     DTD data types
 25 | 
 26 |     The top-level
 27 | 
 28 |     Front matter
 29 | 
 30 |     The Body
 31 | 
 32 |     Back matter
 33 |   -->
 34 | 
 35 | 
 36 | <!--
 37 |   Character entities
 38 |   -->
 39 | 
 40 | 
 41 | <!ENTITY % rfc2629-xhtml
 42 |          PUBLIC "-//IETF//ENTITIES XHTML subset for RFC 2629//EN"
 43 |                 "rfc2629-xhtml.ent">
 44 | %rfc2629-xhtml;
 45 | 
 46 | <!ENTITY % rfc2629-other
 47 |          PUBLIC "-//IETF//ENTITIES Other for RFC 2629//EN"
 48 |                 "rfc2629-other.ent">
 49 | %rfc2629-other;
 50 | 
 51 | 
 52 | <!--
 53 |   DTD data types:
 54 | 
 55 |         entity        description
 56 |         ======        ===============================================
 57 |         NUMBER        [0-9]+
 58 |         NUMBERS       a comma-separated list of NUMBER
 59 | 
 60 |         DAY           the day of the month, e.g., "1"
 61 |         MONTH         the month of the year, e.g., "January"
 62 |         YEAR          a four-digit year, e.g., "1999"
 63 | 
 64 |         URI           e.g., "http://invisible.net/"
 65 | 
 66 |         ATEXT/CTEXT   printable ASCII text (no line-terminators)
 67 | 
 68 |         TEXT          character data
 69 |   -->
 70 | 
 71 | 
 72 | <!ENTITY % NUMBER     "CDATA">
 73 | <!ENTITY % NUMBERS    "CDATA">
 74 | 
 75 | <!ENTITY % DAY        "CDATA">
 76 | <!ENTITY % MONTH      "CDATA">
 77 | <!ENTITY % YEAR       "CDATA">
 78 | 
 79 | <!ENTITY % URI        "CDATA">
 80 | 
 81 | <!ENTITY % ATEXT      "CDATA">
 82 | <!ENTITY % CTEXT      "#PCDATA">
 83 | 
 84 | <!ENTITY % TEXT       "#PCDATA">
 85 | 
 86 | <!ENTITY   rfc.number "XXXX">
 87 | 
 88 | 
 89 | <!--
 90 |   The top-level
 91 |   -->
 92 | 
 93 | 
 94 | <!--
 95 |   attributes for the "rfc" element are supplied by the RFC
 96 |   editor. when preparing drafts, authors should leave them blank.
 97 | 
 98 |   the "seriesNo" attribute is used if the category is, e.g., BCP.
 99 |   -->
100 | <!ELEMENT rfc         (front,middle,back?)>
101 | <!ATTLIST rfc
102 |           number      %NUMBER;           #IMPLIED
103 |           obsoletes   %NUMBERS;          ""
104 |           updates     %NUMBERS;          ""
105 |           category    (std|bcp|info|exp|historic)
106 |                                          #IMPLIED
107 |           seriesNo    %NUMBER;           #IMPLIED
108 |           ipr         (full2026|noDerivativeWorks2026|none
109 |                       |full3667|noModification3667|noDerivatives3667
110 |                       |full3978|noModification3978|noDerivatives3978)
111 |                                          #IMPLIED
112 |           iprExtract  IDREF              #IMPLIED
113 |           submissionType
114 |                       (IETF|independent) "IETF"
115 |           docName     %ATEXT;            #IMPLIED
116 |           xml:lang    %ATEXT;            "en">
117 | 
118 | 
119 | <!--
120 |   Front matter
121 |   -->
122 | 
123 | 
124 | <!ELEMENT front       (title,author+,date,area*,workgroup*,keyword*,
125 |                        abstract?,note*)>
126 | 
127 | <!-- the "abbrev" attribute is used for headers, etc. -->
128 | <!ELEMENT title       (%CTEXT;)>
129 | <!ATTLIST title
130 |           abbrev      %ATEXT;            #IMPLIED> 
131 | 
132 | <!ELEMENT author      (organization,address?)>
133 | <!ATTLIST author
134 |           initials    %ATEXT;            #IMPLIED
135 |           surname     %ATEXT;            #IMPLIED
136 |           fullname    %ATEXT;            #IMPLIED
137 |           role        (editor)           #IMPLIED>
138 | 
139 | <!ELEMENT organization
140 |                       (%CTEXT;)>
141 | <!ATTLIST organization
142 |           abbrev      %ATEXT;            #IMPLIED> 
143 |  
144 | <!ELEMENT address     (postal?,phone?,facsimile?,email?,uri?)>
145 | 
146 | <!-- this content model should be more strict:
147 |      at most one of each the city, region, code, and country
148 |      elements may be present -->
149 | <!ELEMENT postal      (street+,(city|region|code|country)*)>
150 | <!ELEMENT street      (%CTEXT;)>
151 | <!ELEMENT city        (%CTEXT;)>
152 | <!ELEMENT region      (%CTEXT;)>
153 | <!ELEMENT code        (%CTEXT;)>
154 | <!ELEMENT country     (%CTEXT;)>
155 | <!ELEMENT phone       (%CTEXT;)>
156 | <!ELEMENT facsimile   (%CTEXT;)>
157 | <!ELEMENT email       (%CTEXT;)>
158 | <!ELEMENT uri         (%CTEXT;)>
159 | 
160 | <!ELEMENT date        EMPTY>
161 | <!ATTLIST date
162 |           day         %DAY;              #IMPLIED
163 |           month       %MONTH;            #IMPLIED
164 |           year        %YEAR;             #IMPLIED>
165 | 
166 | <!-- meta-data... -->
167 | <!ELEMENT area        (%CTEXT;)>
168 | <!ELEMENT workgroup   (%CTEXT;)>
169 | <!ELEMENT keyword     (%CTEXT;)>
170 | 
171 | <!ELEMENT abstract    (t)+>
172 | <!ELEMENT note        (t)+>
173 | <!ATTLIST note
174 |           title       %ATEXT;            #REQUIRED>
175 | 
176 | 
177 | <!--
178 |   The body
179 |   -->
180 | 
181 | 
182 | <!-- later on, may be (section+,appendix*,section*) -->
183 | <!ELEMENT middle      (section+)>
184 | 
185 | <!ELEMENT section     ((t|figure|texttable|iref)*,section*)>
186 | <!ATTLIST section
187 |           anchor      ID                 #IMPLIED
188 |           title       %ATEXT;            #REQUIRED
189 |           toc         (include|exclude|default)
190 |                                          "default">
191 | 
192 | <!--
193 | <!ELEMENT appendix    ((t|figure|texttable|iref)*,appendix*)>
194 | <!ATTLIST appendix
195 |           anchor      ID                 #IMPLIED
196 |           title       %ATEXT;            #REQUIRED
197 |           toc         (include|exclude|default)
198 |                                          "default">
199 |   -->
200 | 
201 | <!-- use of <figure/> is deprecated... -->
202 | <!ELEMENT t           (%TEXT;|list|figure|xref|eref|iref|cref|spanx|vspace)*>
203 | <!ATTLIST t
204 |           anchor      ID                 #IMPLIED
205 |           hangText    %ATEXT;            #IMPLIED>
206 | 
207 | <!-- the value of the style attribute is inherited from the closest 
208 |      parent -->
209 | <!ELEMENT list        (t+)>
210 | <!ATTLIST list
211 |           style       %ATEXT;            #IMPLIED
212 |           hangIndent  %NUMBER;           #IMPLIED
213 |           counter     %ATEXT;            #IMPLIED>
214 | 
215 | <!ELEMENT xref        (%CTEXT;)>
216 | <!ATTLIST xref
217 |           target      IDREF              #REQUIRED
218 |           pageno      (true|false)       "false"
219 |           format      (counter|title|none|default)
220 |                                          "default">
221 | 
222 | <!ELEMENT eref        (%CTEXT;)>
223 | <!ATTLIST eref
224 |           target      %URI;              #REQUIRED>
225 | 
226 | <!ELEMENT iref        EMPTY>
227 | <!ATTLIST iref
228 |           item        %ATEXT;            #REQUIRED
229 |           subitem     %ATEXT;            ""
230 |           primary    (true|false)       "false">
231 | 
232 | <!ELEMENT cref        (%CTEXT;)>
233 | <!ATTLIST cref
234 |           anchor      ID                 #IMPLIED
235 |           source      %ATEXT;            #IMPLIED>
236 | 
237 | <!ELEMENT spanx       (%CTEXT;)>
238 | <!ATTLIST spanx
239 |           xml:space   (default|preserve) "preserve"
240 |           style       %ATEXT;            "emph">
241 | 
242 | <!ELEMENT vspace      EMPTY>
243 | <!ATTLIST vspace
244 |           blankLines  %NUMBER;           "0">
245 | 
246 | <!ELEMENT figure      (iref*,preamble?,artwork,postamble?)>
247 | <!ATTLIST figure
248 |           anchor      ID                 #IMPLIED
249 |           title       %ATEXT;            ""
250 |           suppress-title (true|false)    "false"
251 |           src         %URI;              #IMPLIED
252 |           align       (left|center|right) "left"
253 |           alt         %ATEXT;            ""
254 |           width       %ATEXT;            ""
255 |           height      %ATEXT;            "">
256 | 
257 | <!ELEMENT preamble    (%TEXT;|xref|eref|iref|cref|spanx)*>
258 | <!ELEMENT artwork     (%TEXT;)*>
259 | <!ATTLIST artwork
260 |           xml:space   (default|preserve) "preserve"
261 |           name        %ATEXT;            ""
262 |           type        %ATEXT;            ""
263 |           src         %URI;              #IMPLIED
264 |           align       (left|center|right) "left"
265 |           alt         %ATEXT;            ""
266 |           width       %ATEXT;            ""
267 |           height      %ATEXT;            "">
268 | 
269 | <!ELEMENT postamble   (%TEXT;|xref|eref|iref|cref|spanx)*>
270 |     
271 | <!ELEMENT texttable   (preamble?,ttcol+,c*,postamble?)>
272 | <!ATTLIST texttable
273 |           anchor      ID                 #IMPLIED
274 |           title       %ATEXT;            ""
275 |           suppress-title (true|false)    "false"
276 |           align       (left|center|right) "center"
277 |           style       (all|none|headers|full) "full">
278 | <!ELEMENT ttcol       (%CTEXT;)>
279 | <!ATTLIST ttcol
280 |           width       %ATEXT;            #IMPLIED
281 |           align       (left|center|right) "left">
282 | <!ELEMENT c           (%TEXT;|xref|eref|iref|cref|spanx)*>
283 | 
284 | 
285 | <!--
286 |   Back matter
287 |   -->
288 | 
289 | 
290 | <!-- sections, if present, are appendices -->
291 | <!ELEMENT back        (references*,section*)>
292 | 
293 | <!ELEMENT references  (reference+)>
294 | <!ATTLIST references
295 |           title       %ATEXT;            "References">
296 | <!ELEMENT reference   (front,seriesInfo*,format*,annotation*)>
297 | <!ATTLIST reference
298 |           anchor      ID                 #IMPLIED
299 |           target      %URI;              #IMPLIED>
300 | <!ELEMENT seriesInfo  EMPTY>
301 | <!ATTLIST seriesInfo
302 |           name        %ATEXT;            #REQUIRED
303 |           value       %ATEXT;            #REQUIRED>
304 | <!ELEMENT format      EMPTY>
305 | <!ATTLIST format
306 |           target      %URI;              #IMPLIED
307 |           type        %ATEXT;            #REQUIRED
308 |           octets      %NUMBER;           #IMPLIED>
309 | <!ELEMENT annotation  (%TEXT;|xref|eref|iref|cref|spanx)*>
310 | 


--------------------------------------------------------------------------------
/tool/rfc2629.rnc:
--------------------------------------------------------------------------------
  1 | # revised DTD for the RFC document series, draft of 2008-02-01
  2 | 
  3 | # Contents
  4 | # 
  5 | #   DTD data types
  6 | # 
  7 | #   The top-level
  8 | # 
  9 | #   Front matter
 10 | # 
 11 | #   The Body
 12 | # 
 13 | #   Back matter
 14 | 
 15 | # DTD data types:
 16 | # 
 17 | #       entity        description
 18 | #       ======        ===============================================
 19 | #       NUMBER        [0-9]+
 20 | #       NUMBERS       a comma-separated list of NUMBER
 21 | # 
 22 | #       DAY           the day of the month, e.g., "1"
 23 | #       MONTH         the month of the year, e.g., "January"
 24 | #       YEAR          a four-digit year, e.g., "1999"
 25 | # 
 26 | #       URI           e.g., "http://invisible.net/"
 27 | # 
 28 | #       ATEXT/CTEXT   printable ASCII text (no line-terminators)
 29 | # 
 30 | #       TEXT          character data
 31 | 
 32 | namespace a = "http://relaxng.org/ns/compatibility/annotations/1.0"
 33 | 
 34 | NUMBER = string
 35 | NUMBERS = string
 36 | DAY = string
 37 | MONTH = string
 38 | YEAR = string
 39 | URI = string
 40 | ATEXT = string
 41 | CTEXT = text
 42 | TEXT = text
 43 | # The top-level
 44 | 
 45 | # attributes for the "rfc" element are supplied by the RFC
 46 | # editor. when preparing drafts, authors should leave them blank.
 47 | # 
 48 | # the "seriesNo" attribute is used if the category is, e.g., BCP.
 49 | rfc = element rfc { attlist.rfc, front, middle, back? }
 50 | attlist.rfc &=
 51 |   attribute number { NUMBER }?,
 52 |   [ a:defaultValue = "" ] attribute obsoletes { NUMBERS }?,
 53 |   [ a:defaultValue = "" ] attribute updates { NUMBERS }?,
 54 |   [ a:defaultValue = "info" ] attribute category { "std" | "bcp" | "info" | "exp" | "historic" }?,
 55 |   attribute seriesNo { NUMBER }?,
 56 |   attribute ipr {
 57 |     "full2026"
 58 |     | "noDerivativeWorks2026"
 59 |     | "none"
 60 |     | "full3667"
 61 |     | "noModification3667"
 62 |     | "noDerivatives3667"
 63 |     | "full3978"
 64 |     | "noModification3978"
 65 |     | "noDerivatives3978"
 66 |   }?,
 67 |   attribute iprExtract { xsd:IDREF }?,
 68 |   attribute submissionType { "IETF" | "independent" }?,
 69 |   attribute docName { ATEXT }?,
 70 |   [ a:defaultValue = "en" ] attribute xml:lang { ATEXT }?
 71 | # Front matter
 72 | front =
 73 |   element front {
 74 |     attlist.front,
 75 |     title,
 76 |     author+,
 77 |     date,
 78 |     area*,
 79 |     workgroup*,
 80 |     keyword*,
 81 |     abstract?,
 82 |     note*
 83 |   }
 84 | attlist.front &= empty
 85 | # the "abbrev" attribute is used for headers, etc.
 86 | title = element title { attlist.title, CTEXT }
 87 | attlist.title &= attribute abbrev { ATEXT }?
 88 | author = element author { attlist.author, organization, address? }
 89 | attlist.author &=
 90 |   attribute initials { ATEXT }?,
 91 |   attribute surname { ATEXT }?,
 92 |   attribute fullname { ATEXT }?,
 93 |   attribute role { "editor" }?
 94 | organization = element organization { attlist.organization, CTEXT }
 95 | attlist.organization &= attribute abbrev { ATEXT }?
 96 | address =
 97 |   element address {
 98 |     attlist.address, postal?, phone?, facsimile?, email?, uri?
 99 |   }
100 | attlist.address &= empty
101 | # this content model should be more strict:
102 | # at most one of each the city, region, code, and country
103 | # elements may be present
104 | postal =
105 |   element postal {
106 |     attlist.postal, street+, (city | region | code | country)*
107 |   }
108 | attlist.postal &= empty
109 | street = element street { attlist.street, CTEXT }
110 | attlist.street &= empty
111 | city = element city { attlist.city, CTEXT }
112 | attlist.city &= empty
113 | region = element region { attlist.region, CTEXT }
114 | attlist.region &= empty
115 | code = element code { attlist.code, CTEXT }
116 | attlist.code &= empty
117 | country = element country { attlist.country, CTEXT }
118 | attlist.country &= empty
119 | phone = element phone { attlist.phone, CTEXT }
120 | attlist.phone &= empty
121 | facsimile = element facsimile { attlist.facsimile, CTEXT }
122 | attlist.facsimile &= empty
123 | email = element email { attlist.email, CTEXT }
124 | attlist.email &= empty
125 | uri = element uri { attlist.uri, CTEXT }
126 | attlist.uri &= empty
127 | date = element date { attlist.date, empty }
128 | attlist.date &=
129 |   attribute day { DAY }?,
130 |   attribute month { MONTH }?,
131 |   attribute year { YEAR }?
132 | # meta-data...
133 | area = element area { attlist.area, CTEXT }
134 | attlist.area &= empty
135 | workgroup = element workgroup { attlist.workgroup, CTEXT }
136 | attlist.workgroup &= empty
137 | keyword = element keyword { attlist.keyword, CTEXT }
138 | attlist.keyword &= empty
139 | abstract = element abstract { attlist.abstract, t+ }
140 | attlist.abstract &= empty
141 | note = element note { attlist.note, t+ }
142 | attlist.note &= attribute title { ATEXT }
143 | # The body
144 | 
145 | # later on, may be (section+,appendix*,section*)
146 | middle = element middle { attlist.middle, section+ }
147 | attlist.middle &= empty
148 | section =
149 |   element section {
150 |     attlist.section, ((t | figure | texttable | iref)* , section*)
151 |   }
152 | attlist.section &=
153 |   attribute anchor { xsd:ID }?,
154 |   attribute title { ATEXT },
155 |   [ a:defaultValue = "default" ] attribute toc { "include" | "exclude" | "default" }?
156 | # <!ELEMENT appendix    ((t|figure|texttable|iref)*,appendix*)>
157 | # <!ATTLIST appendix
158 | #           anchor      ID                 #IMPLIED
159 | #           title       %ATEXT;            #REQUIRED
160 | #           toc         (include|exclude|default)
161 | #                                          "default">
162 | 
163 | # use of <figure/> is deprecated...
164 | t =
165 |   element t {
166 |     attlist.t,
167 |     (TEXT
168 |      | \list
169 |      | figure
170 |      | xref
171 |      | eref
172 |      | iref
173 |      | cref
174 |      | spanx
175 |      | vspace)*
176 |   }
177 | attlist.t &= attribute anchor { xsd:ID }?, attribute hangText { ATEXT }?
178 | # the value of the style attribute is inherited from the closest 
179 | # parent
180 | \list = element list { attlist.list, t+ }
181 | attlist.list &=
182 |   attribute style { ATEXT }?,
183 |   attribute hangIndent { NUMBER }?,
184 |   attribute counter { ATEXT }?
185 | xref = element xref { attlist.xref, CTEXT }
186 | attlist.xref &=
187 |   attribute target { xsd:IDREF },
188 |   [ a:defaultValue = "false" ] attribute pageno { "true" | "false" }?,
189 |   [ a:defaultValue = "default" ] attribute format { "counter" | "title" | "none" | "default" }?
190 | eref = element eref { attlist.eref, CTEXT }
191 | attlist.eref &= attribute target { URI }
192 | iref = element iref { attlist.iref, empty }
193 | attlist.iref &=
194 |   attribute item { ATEXT },
195 |   [ a:defaultValue = "" ] attribute subitem { ATEXT }?,
196 |   [ a:defaultValue = "false" ] attribute primary { "true" | "false" }?
197 | cref = element cref { attlist.cref, CTEXT }
198 | attlist.cref &=
199 |   attribute anchor { xsd:ID }?,
200 |   attribute source { ATEXT }?
201 | spanx = element spanx { attlist.spanx, CTEXT }
202 | attlist.spanx &=
203 |   [ a:defaultValue = "preserve" ] attribute xml:space { "default" | "preserve" }?,
204 |   [ a:defaultValue = "emph" ] attribute style { ATEXT }?
205 | vspace = element vspace { attlist.vspace, empty }
206 | attlist.vspace &=
207 |   [ a:defaultValue = "0" ] attribute blankLines { NUMBER }?
208 | figure =
209 |   element figure { attlist.figure, iref*, preamble?, artwork, postamble? }
210 | attlist.figure &=
211 |   attribute anchor { xsd:ID }?,
212 |   [ a:defaultValue = "" ] attribute title { ATEXT }?,
213 |   [ a:defaultValue = "false" ] attribute suppress-title { "true" | "false" }?,
214 |   [ a:defaultValue = "" ] attribute src { ATEXT }?,
215 |   [ a:defaultValue = "left" ] attribute align { "left" | "center" | "right" }?,
216 |   [ a:defaultValue = "" ] attribute alt { ATEXT }?,
217 |   [ a:defaultValue = "" ] attribute width { NUMBER }?,
218 |   [ a:defaultValue = "" ] attribute height { NUMBER }?
219 | preamble =
220 |   element preamble {
221 |     attlist.preamble, (TEXT | xref | eref | iref | cref | spanx)*
222 |   }
223 | attlist.preamble &= empty
224 | artwork = element artwork { attlist.artwork, TEXT* }
225 | attlist.artwork &=
226 |   [ a:defaultValue = "preserve" ] attribute xml:space { "default" | "preserve" }?,
227 |   [ a:defaultValue = "" ] attribute name { ATEXT }?,
228 |   [ a:defaultValue = "" ] attribute type { ATEXT }?,
229 |   attribute src { URI }?,
230 |   [ a:defaultValue = "left" ] attribute align { "left" | "center" | "right" }?,
231 |   [ a:defaultValue = "" ] attribute alt { ATEXT }?,
232 |   [ a:defaultValue = "" ] attribute width { ATEXT }?,
233 |   [ a:defaultValue = "" ] attribute height { ATEXT }?
234 | postamble =
235 |   element postamble {
236 |     attlist.postamble, (TEXT | xref | eref | iref | cref | spanx)*
237 |   }
238 | attlist.postamble &= empty
239 | texttable =
240 |   element texttable {
241 |     attlist.texttable, preamble?, ttcol+, c*, postamble?
242 |   }
243 | attlist.texttable &=
244 |   attribute anchor { xsd:ID }?,
245 |   [ a:defaultValue = "" ] attribute title { ATEXT }?,
246 |   [ a:defaultValue = "false" ] attribute suppress-title { "true" | "false" }?,
247 |   [ a:defaultValue = "center" ] attribute align { "left" | "center" | "right" }?,
248 |   [ a:defaultValue = "full" ] attribute style { "all" | "none" | "headers" | "full" }?
249 | ttcol = element ttcol { attlist.ttcol, CTEXT }
250 | attlist.ttcol &=
251 |   attribute width { ATEXT }?,
252 |   [ a:defaultValue = "left" ] attribute align { "left" | "center" | "right" }?
253 | c = element c { attlist.c, (TEXT | xref | eref | iref | cref | spanx)* }
254 | attlist.c &= empty
255 | # Back matter
256 | 
257 | # sections, if present, are appendices
258 | back = element back { attlist.back, references*, section* }
259 | attlist.back &= empty
260 | references = element references { attlist.references, reference+ }
261 | attlist.references &=
262 |   [ a:defaultValue = "References" ] attribute title { ATEXT }?
263 | reference =
264 |   element reference {
265 |     attlist.reference, front, seriesInfo*, format*, annotation*
266 |   }
267 | attlist.reference &=
268 |   attribute anchor { xsd:ID }?,
269 |   attribute target { URI }?
270 | seriesInfo = element seriesInfo { attlist.seriesInfo, empty }
271 | attlist.seriesInfo &=
272 |   attribute name { ATEXT },
273 |   attribute value { ATEXT }
274 | format = element format { attlist.format, empty }
275 | attlist.format &=
276 |   attribute target { URI }?,
277 |   attribute type { ATEXT },
278 |   attribute octets { NUMBER }?
279 | annotation =
280 |   element annotation {
281 |     attlist.annotation, (TEXT | xref | eref | iref | cref | spanx)*
282 |   }
283 | attlist.annotation &= empty
284 | start = rfc
285 | 


--------------------------------------------------------------------------------
/tool/contrib/pekka.savola/template1b.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
  3 | <?xml-stylesheet type='text/xsl' href='rfc2629.xslt' ?>
  4 | 
  5 | <!-- processing instructions (for a complete list and description,
  6 |      see file http://xml.resource.org/authoring/README.html -->
  7 | 
  8 |     <!-- try to enforce the ID-nits conventions and DTD validity -->
  9 | <?rfc strict="yes" ?>
 10 | 
 11 |     <!-- items used when reviewing the document -->
 12 | <?rfc comments="no" ?>  <!-- controls display of <cref> elements -->
 13 | <?rfc inline="no" ?>    <!-- when no, put comments at end in comments section,
 14 |                                 otherwise, put inline -->
 15 | <?rfc editing="no" ?>   <!-- when yes, insert editing marks -->
 16 | 
 17 |     <!-- create table of contents (set it options).  
 18 |          Note the table of contents may be omitted
 19 |          for very short documents --> 
 20 | <?rfc toc="yes"?>
 21 | <?rfc tocompact="yes"?>
 22 | <?rfc tocdepth="3"?>
 23 | 
 24 |     <!-- choose the options for the references. Some like
 25 |          symbolic tags in the references (and citations)
 26 |          and others prefer numbers. --> 
 27 | <?rfc symrefs="no"?>
 28 | <?rfc sortrefs="yes" ?>
 29 | 
 30 |     <!-- these two save paper: start new paragraphs from the same page etc. -->
 31 | <?rfc compact="yes" ?>
 32 | <?rfc subcompact="no" ?>
 33 | <!-- end of list of processing instructions -->
 34 | 
 35 |     <!-- Information about the document.
 36 |          categories values: std, bcp, info, exp, and historic
 37 |          For Internet-Drafts, specify attribute "ipr".
 38 |          (ipr values are: full3667, noModification3667, noDerivatives3667),
 39 |          Also for Internet-Drafts, can specify values for
 40 |          attributes "iprExtract", and "docName".  Note
 41 |          that the value for iprExtract is the anchor attribute
 42 |          value of a section that can be extracted, and is only
 43 |          useful when the value of "ipr" is not "full3667". -->
 44 |     <!-- TODO: verify which attributes are specified only
 45 |             by the RFC editor.  It appears that attributes
 46 |             "number", "obsoletes", "updates", and "seriesNo"
 47 |             are specified by the RFC editor (and not by
 48 |             the document author). -->
 49 | <rfc
 50 |     category="info"
 51 |     ipr="noModification3667"
 52 |     iprExtract="codeExample"
 53 |     docName="draft-savola-xml2rfc-template-00.txt" >
 54 | 
 55 | <front>
 56 |     <title abbrev="Abbreviated-Title">Full Title</title>
 57 | 
 58 |     <!-- add 'role="editor"' below for the editors if appropriate -->
 59 |     <author
 60 |         fullname="Pekka Savola" 
 61 |         initials="P." 
 62 |         surname="Savola">
 63 | 
 64 |     <!-- abbrev not needed but can be used for the header
 65 |          if the full organization name is too long -->
 66 |         <organization abbrev="Abbreviated OrgName">Full Organization name</organization>
 67 |         <address>
 68 |             <postal>
 69 |                 <!-- I've omitted my street address here -->
 70 |                 <street/>
 71 |                 <city>Espoo</city>
 72 |                 <!--
 73 |                     The IETF seems to meet once a year in Minneapolis,
 74 |                     so that's practically my US address. If so, I would
 75 |                     add the following elements:
 76 |                 <region>MN</region>
 77 |                 <code>55403</code>
 78 |                 -->
 79 |                 <country>Finland</country>
 80 |             </postal>
 81 |         <email> psavola@funet.fi </email>
 82 |         <!--
 83 |             If I had a phone, fax machine, and a URI, I could add the following:
 84 |                 <phone>+1-408-555-1234</phone>
 85 |                 <facsimile>+1-555-911-9111</facsimile>
 86 |                 <uri>http://127.0.0.1/</uri>
 87 |     -->
 88 |         </address>
 89 |     </author>
 90 | 
 91 |     <date year="2004" month="May"/> <!-- month="May" is no longer necessary
 92 |                                           note also, day="30" is optional -->
 93 | 
 94 |     <area>Operations &amp; Management</area>
 95 | 
 96 |     <!-- WG name at the upperleft corner of the doc,
 97 |          IETF fine for individual submissions -->
 98 |     <workgroup>Internet Engineering Task Force</workgroup>
 99 |     <abstract>
100 |     <t>This is an abstract abstract.  Remember, don't add references here.</t>
101 |     </abstract>
102 | 
103 |     <note title="Foreword">
104 | <t>This "forward" section is an unnumbered section that is not included
105 | in the table of contents.  It is primarily used for the IESG to
106 | make comments about the document.  It can also be used for
107 |  ...TODO: list uses...</t>
108 | <t>In this example, it is used as a handy place to specify URLs to
109 | documents and tools to author RFC-style documents using XML.</t>
110 | <t>RFC2629 is the original published document on authoring RFC-style
111 | documents in XML (http://xml.resource.org/public/rfc/html/rfc2629.html).
112 | It is being updated (and called RFC2629(bis) and is
113 | http://xml.resource.org/authoring/draft-mrose-writing-rfcs.html.
114 | The tool to convert XML documents to RFC-style text (and HTML) files
115 | is described in document http://xml.resource.org/authoring/README.html.</t>
116 | <t>Please also remember to check out
117 | http://www.ietf.org/ID-Checklist.html for issues to note when writing
118 | drafts.</t>
119 | <t>Remember, you don't need to have any other tools than a 'notepad'
120 | or your favorite editor to write xml2rfc drafts.  You can use the web
121 | interface at http://xml.resource.org for processing.  The benefit of using
122 | XML editors is mostly catching those missing tags which the processor will
123 | warn you about, but you don't need to worry about the editors when getting
124 | started.</t>
125 | <t>This template is not meant to be a conclusive list of everything,
126 | but summarize the often-needed basic features to get one started.</t>
127 |     </note>
128 | 
129 | 
130 |     <note title="Requirements Language">
131 | <t>The key words &quot;MUST&quot;, &quot;MUST NOT&quot;,
132 | &quot;REQUIRED&quot;, &quot;SHALL&quot;, &quot;SHALL NOT&quot;,
133 | &quot;SHOULD&quot;, &quot;SHOULD NOT&quot;, &quot;RECOMMENDED&quot;,
134 | &quot;MAY&quot;, and &quot;OPTIONAL&quot; in this document are to be
135 | interpreted as described in <xref target="RFC2119">RFC 2119</xref>.
136 | </t>
137 |     </note>
138 | 
139 | 
140 | </front>
141 | 
142 | <middle>
143 | <section title="Introduction">
144 |     <t>Now you can have a bit more lengthier text here.</t>
145 |     <t>Let's refer to a couple of documents:  
146 |     <xref target="I-D.ietf-v6ops-3gpp-analysis"/> and
147 |     <xref target="RFC2661">L2TP</xref>. For text generation, these look equivalent,
148 | but the latter looks a bit neater in the HTML representation.</t>
149 |     <t>You might also add a note about the usage of RFC2119 keywords here..</t>
150 |     <t>You can cross-reference the sections in a stable manner; 
151 |        <xref target="sect2"/>.</t>
152 | </section>
153 | 
154 | <section anchor="sect2" title="An example section">
155 |     <t>There are multiple list styles: 'symbols', 'letters', 'numbers',
156 | 'hanging', 'format', etc.</t>
157 |     <t>
158 |     <list style="symbols">
159 |         <t>First bullet</t>
160 |         <t>Second bullet</t>
161 |     </list>
162 |     </t>
163 |     <t>One can draw fancy diagrams as well; remember to ensure that they
164 | don't exceed 72 chars/line.</t>
165 |     <figure anchor="xml_happy">
166 |     <artwork>
167 | <![CDATA[
168 | +-----------------------+
169 | | Use XML, be Happy :-) |
170 | |_______________________|
171 | 
172 | ]]>
173 |     </artwork>
174 |     </figure>
175 |     <t>Note that including a CDATA you don't need to escape most special characters
176 | you might otherwise have to.</t>
177 |     <section title="A Subsection">
178 |         <t>There can be a lot of subsections.  By default 3 levels of
179 | nesting show in table of contents but that can be adjusted with the
180 | value of the "tocdepth" processing instruction.</t>
181 |     </section>
182 | </section>
183 | <section title="Decrypting XML2RFC Parsing errors">
184 |     <t>The most common form of xml2rfc parsing erros are those where a
185 | closing tag has been expected to be present before a new kind of tag is
186 | specified.  In the example below, Introduction section's last paragraph was
187 | missing the closing t-element.  The rest of the error messages can be rather
188 | easily understood as well by reading it carefully and examining the context. 
189 | The reason is typically a missing tag somewhere.</t>
190 |         <figure>
191 |         <artwork>
192 | <![CDATA[
193 | ======8<=========
194 | end tag "section" does not match open element "t" around line 65
195 | 
196 | Context: 
197 |     <rfc ipr="full3667" category="info" 
198 |          docName="draft-savola-xml2rfc-template-00.txt" 
199 |          updates="1,2"
200 |          obsoletes="3">
201 |     <middle>
202 |     <section title="Introduction">
203 |     <t>
204 | =======8<========
205 | ]]>
206 |     </artwork>
207 |     </figure>
208 | </section>
209 | <section title="Example of code or MIB module to be extracted"
210 |          anchor="codeExample">
211 | <figure>
212 | <artwork>
213 | <![CDATA[
214 | /**** an example C program */
215 | 
216 | #include <stdio.h>
217 | 
218 | void
219 | main(int argc, char *argv[])
220 | {
221 |     int i;
222 | 
223 |     printf("program arguments are:\n");
224 |     for (i = 0; i < argc; i++) {
225 |         printf("%d: \"%s\"\n", i, argv[i]);
226 |     }
227 | 
228 |     exit(0);
229 | } /* main */
230 | 
231 | /* end of file */
232 | ]]>
233 | </artwork>
234 | </figure>
235 | </section>
236 | <section anchor="Acknowledgements" title="Acknowledgements">
237 |     <t>Remember, it's important to acknowledge people who have
238 | contributed to the work.</t>
239 | </section>
240 | 
241 | <!-- possibly a 'Contributors' section ... -->
242 | 
243 | <section anchor="IANA" title="IANA Considerations">
244 |     <t>This memo includes no request to IANA.</t>
245 |     <t>(It's good to have an explicit note because otherwise IANA wastes
246 | cycles trying to figure out if something is needed..)</t>
247 | </section>
248 | 
249 | <section anchor="Security" title="Security Considerations">
250 |     <t>Remember to consider security from the start..</t>
251 | </section>
252 | </middle>
253 | <back>
254 | <!-- references split to informative and normative -->
255 | <references title="Normative References">
256 |     <reference
257 |         anchor="RFC2661">
258 | <!-- proposal to add attribute copy-reference-from="reference.RFC.2661.xml"> -->
259 | <!-- the following is the minimum to make xml2rfc happy -->
260 |         <front>
261 |             <title>RFC2661</title>
262 |             <author initials="authInitials" surname="authSurName">
263 |                 <organization>orgName</organization>
264 |             </author>
265 |             <date year="year" />
266 |         </front>
267 |     </reference>
268 | 
269 |     <reference anchor='RFC2119'>
270 |     <front>
271 |     <title abbrev='RFC Key Words'>Key words for use in RFCs to Indicate Requirement Levels</title>
272 |     <author initials='S.' surname='Bradner' fullname='Scott Bradner'>
273 |     <organization>Harvard University</organization>
274 |     <address>
275 |     <postal>
276 |     <street>1350 Mass. Ave.</street>
277 |     <street>Cambridge</street>
278 |     <street>MA 02138</street></postal>
279 |     <phone>- +1 617 495 3864</phone>
280 |     <email>sob@harvard.edu</email></address></author>
281 |     <date year='1997' month='March' />
282 |     <area>General</area>
283 |     <keyword>keyword</keyword>
284 |     <abstract>
285 |     <t>
286 | In many standards track documents several words are used to signify
287 | the requirements in the specification.  These words are often
288 | capitalized.  This document defines these words as they should be
289 | interpreted in IETF documents.  Authors who follow these guidelines
290 | should incorporate this phrase near the beginning of their document:
291 | 
292 |     <list>
293 |     <t>
294 | The key words &quot;MUST&quot;, &quot;MUST NOT&quot;, &quot;REQUIRED&quot;, &quot;SHALL&quot;, &quot;SHALL
295 | NOT&quot;, &quot;SHOULD&quot;, &quot;SHOULD NOT&quot;, &quot;RECOMMENDED&quot;,  &quot;MAY&quot;, and
296 | &quot;OPTIONAL&quot; in this document are to be interpreted as described in
297 | RFC 2119.
298 |     </t></list></t>
299 |     <t> 
300 | Note that the force of these words is modified by the requirement
301 | level of the document in which they are used.
302 |     </t></abstract></front>
303 | 
304 |     <seriesInfo name='BCP' value='14' />
305 |     <seriesInfo name='RFC' value='2119' />
306 |     <format type='TXT' octets='4723' target='ftp://ftp.isi.edu/in-notes/rfc2119.txt' />
307 |     <format type='HTML' octets='14486' target='http://xml.resource.org/public/rfc/html/rfc2119.html' />
308 |     <format type='XML' octets='5661' target='http://xml.resource.org/public/rfc/xml/rfc2119.xml' />
309 |     </reference>
310 | 
311 | </references>
312 | 
313 | <references title="Informative References">
314 |     <reference
315 |         anchor="I-D.ietf-v6ops-3gpp-analysis" >
316 |         <front>
317 |             <title>I-D.ietf-v6ops-3gpp-analysis</title>
318 |             <author initials="authInitials" surname="authSurName">
319 |                 <organization>orgName</organization>
320 |             </author>
321 |             <date year="year" />
322 |         </front>
323 |     </reference>
324 | </references>
325 | 
326 | <section anchor="app-additional" title="Additional stuff">
327 |     <t>You can add appendices just as regular sections, the only
328 | difference is that they go within the "back" element, and not
329 | within the "middle" element. And they follow the "reference"
330 | elements.</t>
331 | </section>
332 | </back>
333 | 
334 | </rfc>
335 | 


--------------------------------------------------------------------------------
/tool/sample.html:
--------------------------------------------------------------------------------
  1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2 | <html lang="en"><head><title>An Example</title>
  3 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  4 | <meta name="description" content="An Example">
  5 | <meta name="generator" content="xml2rfc v1.33 (http://xml.resource.org/)">
  6 | <style type='text/css'><!--
  7 |         body {
  8 |                 font-family: verdana, charcoal, helvetica, arial, sans-serif;
  9 |                 font-size: small; color: #000; background-color: #FFF;
 10 |                 margin: 2em;
 11 |         }
 12 |         h1, h2, h3, h4, h5, h6 {
 13 |                 font-family: helvetica, monaco, "MS Sans Serif", arial, sans-serif;
 14 |                 font-weight: bold; font-style: normal;
 15 |         }
 16 |         h1 { color: #900; background-color: transparent; text-align: right; }
 17 |         h3 { color: #333; background-color: transparent; }
 18 | 
 19 |         td.RFCbug {
 20 |                 font-size: x-small; text-decoration: none;
 21 |                 width: 30px; height: 30px; padding-top: 2px;
 22 |                 text-align: justify; vertical-align: middle;
 23 |                 background-color: #000;
 24 |         }
 25 |         td.RFCbug span.RFC {
 26 |                 font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;
 27 |                 font-weight: bold; color: #666;
 28 |         }
 29 |         td.RFCbug span.hotText {
 30 |                 font-family: charcoal, monaco, geneva, "MS Sans Serif", helvetica, verdana, sans-serif;
 31 |                 font-weight: normal; text-align: center; color: #FFF;
 32 |         }
 33 | 
 34 |         table.TOCbug { width: 30px; height: 15px; }
 35 |         td.TOCbug {
 36 |                 text-align: center; width: 30px; height: 15px;
 37 |                 color: #FFF; background-color: #900;
 38 |         }
 39 |         td.TOCbug a {
 40 |                 font-family: monaco, charcoal, geneva, "MS Sans Serif", helvetica, sans-serif;
 41 |                 font-weight: bold; font-size: x-small; text-decoration: none;
 42 |                 color: #FFF; background-color: transparent;
 43 |         }
 44 | 
 45 |         td.header {
 46 |                 font-family: arial, helvetica, sans-serif; font-size: x-small;
 47 |                 vertical-align: top; width: 33%;
 48 |                 color: #FFF; background-color: #666;
 49 |         }
 50 |         td.author { font-weight: bold; font-size: x-small; margin-left: 4em; }
 51 |         td.author-text { font-size: x-small; }
 52 | 
 53 |         /* info code from SantaKlauss at http://www.madaboutstyle.com/tooltip2.html */
 54 |         a.info {
 55 |                 /* This is the key. */
 56 |                 position: relative;
 57 |                 z-index: 24;
 58 |                 text-decoration: none;
 59 |         }
 60 |         a.info:hover {
 61 |                 z-index: 25;
 62 |                 color: #FFF; background-color: #900;
 63 |         }
 64 |         a.info span { display: none; }
 65 |         a.info:hover span.info {
 66 |                 /* The span will display just on :hover state. */
 67 |                 display: block;
 68 |                 position: absolute;
 69 |                 font-size: smaller;
 70 |                 top: 2em; left: -5em; width: 15em;
 71 |                 padding: 2px; border: 1px solid #333;
 72 |                 color: #900; background-color: #EEE;
 73 |                 text-align: left;
 74 |         }
 75 | 
 76 |         a { font-weight: bold; }
 77 |         a:link    { color: #900; background-color: transparent; }
 78 |         a:visited { color: #633; background-color: transparent; }
 79 |         a:active  { color: #633; background-color: transparent; }
 80 | 
 81 |         p { margin-left: 2em; margin-right: 2em; }
 82 |         p.copyright { font-size: x-small; }
 83 |         p.toc { font-size: small; font-weight: bold; margin-left: 3em; }
 84 |         table.toc { margin: 0 0 0 3em; padding: 0; border: 0; vertical-align: text-top; }
 85 |         td.toc { font-size: small; font-weight: bold; vertical-align: text-top; }
 86 | 
 87 |         ol.text { margin-left: 2em; margin-right: 2em; }
 88 |         ul.text { margin-left: 2em; margin-right: 2em; }
 89 |         li      { margin-left: 3em; }
 90 | 
 91 |         /* RFC-2629 <spanx>s and <artwork>s. */
 92 |         em     { font-style: italic; }
 93 |         strong { font-weight: bold; }
 94 |         dfn    { font-weight: bold; font-style: normal; }
 95 |         cite   { font-weight: normal; font-style: normal; }
 96 |         tt     { color: #036; }
 97 |         tt, pre, pre dfn, pre em, pre cite, pre span {
 98 |                 font-family: "Courier New", Courier, monospace; font-size: small;
 99 |         }
100 |         pre {
101 |                 text-align: left; padding: 4px;
102 |                 color: #000; background-color: #CCC;
103 |         }
104 |         pre dfn  { color: #900; }
105 |         pre em   { color: #66F; background-color: #FFC; font-weight: normal; }
106 |         pre .key { color: #33C; font-weight: bold; }
107 |         pre .id  { color: #900; }
108 |         pre .str { color: #000; background-color: #CFF; }
109 |         pre .val { color: #066; }
110 |         pre .rep { color: #909; }
111 |         pre .oth { color: #000; background-color: #FCF; }
112 |         pre .err { background-color: #FCC; }
113 | 
114 |         /* RFC-2629 <texttable>s. */
115 |         table.all, table.full, table.headers, table.none {
116 |                 font-size: small; text-align: center; border-width: 2px;
117 |                 vertical-align: top; border-collapse: collapse;
118 |         }
119 |         table.all, table.full { border-style: solid; border-color: black; }
120 |         table.headers, table.none { border-style: none; }
121 |         th {
122 |                 font-weight: bold; border-color: black;
123 |                 border-width: 2px 2px 3px 2px;
124 |         }
125 |         table.all th, table.full th { border-style: solid; }
126 |         table.headers th { border-style: none none solid none; }
127 |         table.none th { border-style: none; }
128 |         table.all td {
129 |                 border-style: solid; border-color: #333;
130 |                 border-width: 1px 2px;
131 |         }
132 |         table.full td, table.headers td, table.none td { border-style: none; }
133 | 
134 |         hr { height: 1px; }
135 |         hr.insert {
136 |                 width: 80%; border-style: none; border-width: 0;
137 |                 color: #CCC; background-color: #CCC;
138 |         }
139 | --></style>
140 | </head>
141 | <body>
142 | <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
143 | <table summary="layout" width="66%" border="0" cellpadding="0" cellspacing="0"><tr><td><table summary="layout" width="100%" border="0" cellpadding="2" cellspacing="1">
144 | <tr><td class="header">Network Working Group</td><td class="header">A. Mous</td></tr>
145 | <tr><td class="header">Internet-Draft</td><td class="header">February 28, 2008</td></tr>
146 | <tr><td class="header">Intended status: Standards Track</td><td class="header">&nbsp;</td></tr>
147 | <tr><td class="header">Expires: August 31, 2008</td><td class="header">&nbsp;</td></tr>
148 | </table></td></tr></table>
149 | <h1><br />An Example<br />sample.txt</h1>
150 | 
151 | <h3>Status of this Memo</h3>
152 | <p>
153 | By submitting this Internet-Draft,
154 | each author represents that any applicable patent or other IPR claims of which
155 | he or she is aware have been or will be disclosed,
156 | and any of which he or she becomes aware will be disclosed,
157 | in accordance with Section&nbsp;6 of BCP&nbsp;79.</p>
158 | <p>
159 | Internet-Drafts are working documents of the Internet Engineering
160 | Task Force (IETF), its areas, and its working groups.
161 | Note that other groups may also distribute working documents as
162 | Internet-Drafts.</p>
163 | <p>
164 | Internet-Drafts are draft documents valid for a maximum of six months
165 | and may be updated, replaced, or obsoleted by other documents at any time.
166 | It is inappropriate to use Internet-Drafts as reference material or to cite
167 | them other than as &ldquo;work in progress.&rdquo;</p>
168 | <p>
169 | The list of current Internet-Drafts can be accessed at
170 | <a href='http://www.ietf.org/ietf/1id-abstracts.txt'>http://www.ietf.org/ietf/1id-abstracts.txt</a>.</p>
171 | <p>
172 | The list of Internet-Draft Shadow Directories can be accessed at
173 | <a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p>
174 | <p>
175 | This Internet-Draft will expire on August 31, 2008.</p>
176 | 
177 | <h3>Abstract</h3>
178 | 
179 | <p>An example.
180 | </p><a name="toc"></a><br /><hr />
181 | <h3>Table of Contents</h3>
182 | <p class="toc">
183 | <a href="#anchor1">1.</a>&nbsp;
184 | Requirements notation<br />
185 | <a href="#anchor2">2.</a>&nbsp;
186 | Security Considerations<br />
187 | <a href="#rfc.references1">3.</a>&nbsp;
188 | Normative References<br />
189 | <a href="#rfc.authors">&#167;</a>&nbsp;
190 | Author's Address<br />
191 | <a href="#rfc.copyright">&#167;</a>&nbsp;
192 | Intellectual Property and Copyright Statements<br />
193 | </p>
194 | <br clear="all" />
195 | 
196 | <a name="anchor1"></a><br /><hr />
197 | <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
198 | <a name="rfc.section.1"></a><h3>1.&nbsp;
199 | Requirements notation</h3>
200 | 
201 | <p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL",
202 |             "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",
203 |             and "OPTIONAL" in this document are to be interpreted as
204 |             described in <a class='info' href='#RFC2119'>[RFC2119]<span> (</span><span class='info'>Bradner, S., &ldquo;Key words for use in RFCs to Indicate Requirement Levels,&rdquo; March&nbsp;1997.</span><span>)</span></a>.
205 | </p>
206 | <a name="anchor2"></a><br /><hr />
207 | <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
208 | <a name="rfc.section.2"></a><h3>2.&nbsp;
209 | Security Considerations</h3>
210 | 
211 | <p>None.
212 | </p>
213 | <a name="rfc.references1"></a><br /><hr />
214 | <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
215 | <h3>3.&nbsp;Normative References</h3>
216 | <table width="99%" border="0">
217 | <tr><td class="author-text" valign="top"><a name="RFC2119">[RFC2119]</a></td>
218 | <td class="author-text"><a href="mailto:sob@harvard.edu">Bradner, S.</a>, &ldquo;<a href="http://tools.ietf.org/html/rfc2119">Key words for use in RFCs to Indicate Requirement Levels</a>,&rdquo; BCP&nbsp;14, RFC&nbsp;2119, March&nbsp;1997 (<a href="ftp://ftp.isi.edu/in-notes/rfc2119.txt">TXT</a>, <a href="http://xml.resource.org/public/rfc/html/rfc2119.html">HTML</a>, <a href="http://xml.resource.org/public/rfc/xml/rfc2119.xml">XML</a>).</td></tr>
219 | </table>
220 | 
221 | <a name="rfc.authors"></a><br /><hr />
222 | <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
223 | <h3>Author's Address</h3>
224 | <table width="99%" border="0" cellpadding="0" cellspacing="0">
225 | <tr><td class="author-text">&nbsp;</td>
226 | <td class="author-text">Anon Y. Mous</td></tr>
227 | </table>
228 | <a name="rfc.copyright"></a><br /><hr />
229 | <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
230 | <h3>Full Copyright Statement</h3>
231 | <p class='copyright'>
232 | Copyright &copy; The IETF Trust (2008).</p>
233 | <p class='copyright'>
234 | This document is subject to the rights,
235 | licenses and restrictions contained in BCP&nbsp;78,
236 | and except as set forth therein,
237 | the authors retain all their rights.</p>
238 | <p class='copyright'>
239 | This document and the information contained herein are provided
240 | on an &ldquo;AS IS&rdquo; basis and THE CONTRIBUTOR,
241 | THE ORGANIZATION HE/SHE REPRESENTS
242 | OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST
243 | AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES,
244 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT
245 | THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY
246 | IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR
247 | PURPOSE.</p>
248 | <h3>Intellectual Property</h3>
249 | <p class='copyright'>
250 | The IETF takes no position regarding the validity or scope of any
251 | Intellectual Property Rights or other rights that might be claimed
252 | to pertain to the implementation or use of the technology
253 | described in this document or the extent to which any license
254 | under such rights might or might not be available; nor does it
255 | represent that it has made any independent effort to identify any
256 | such rights.
257 | Information on the procedures with respect to
258 | rights in RFC documents can be found in BCP&nbsp;78 and BCP&nbsp;79.</p>
259 | <p class='copyright'>
260 | Copies of IPR disclosures made to the IETF Secretariat and any
261 | assurances of licenses to be made available,
262 | or the result of an attempt made to obtain a general license or
263 | permission for the use of such proprietary rights by implementers or
264 | users of this specification can be obtained from the IETF on-line IPR
265 | repository at <a href='http://www.ietf.org/ipr'>http://www.ietf.org/ipr</a>.</p>
266 | <p class='copyright'>
267 | The IETF invites any interested party to bring to its attention
268 | any copyrights,
269 | patents or patent applications,
270 | or other
271 | proprietary rights that may cover technology that may be required
272 | to implement this standard.
273 | Please address the information to the IETF at <a href='mailto:ietf-ipr@ietf.org'>ietf-ipr@ietf.org</a>.</p>
274 | </body></html>
275 | 


--------------------------------------------------------------------------------
/tool/rfc2629-xhtml.ent:
--------------------------------------------------------------------------------
  1 | <!-- rfc2629-xhtml.ent
  2 | 
  3 |      Character entity set for RFC-2629 source xml documents.
  4 |      There is no need to invoke this directly from
  5 |      the source document itself; just invoke the DTD.
  6 | 
  7 |      These are known to (X)HTML, so any converter to these
  8 |      formats can just leave them as is without having
  9 |      to invoke this file from the output file.
 10 | 
 11 |      Conversion to txt or nroff format will replace
 12 |      these entities by the parenthesized text.
 13 | 
 14 |      Typical invocation:
 15 |        <!ENTITY % rfc2629-xhtml
 16 |                 PUBLIC "-//IETF//ENTITIES XHTML subset for RFC 2629//EN"
 17 |                        "http://xml.resource.org/authoring/rfc2629-xhtml.ent">
 18 |        %rfc2629-xhtml;
 19 | -->
 20 | 
 21 | <!-- All of ISO Latin 1 -->
 22 | <!ENTITY nbsp    "&#160;"><!-- U+00A0 NO-BREAK SPACE                             (special " ")        -->
 23 | <!ENTITY iexcl   "&#161;"><!-- U+00A1 INVERTED EXCLAMATION MARK                  ("!")                -->
 24 | <!ENTITY cent    "&#162;"><!-- U+00A2 CENT SIGN                                  ("[cents]")          -->
 25 | <!ENTITY pound   "&#163;"><!-- U+00A3 POUND SIGN                                 ("GBP")              -->
 26 | <!ENTITY curren  "&#164;"><!-- U+00A4 CURRENCY SIGN                              ("[currency units]") -->
 27 | <!ENTITY yen     "&#165;"><!-- U+00A5 YEN SIGN                                   ("JPY")              -->
 28 | <!ENTITY brvbar  "&#166;"><!-- U+00A6 BROKEN BAR                                 ("|")                -->
 29 | <!ENTITY sect    "&#167;"><!-- U+00A7 SECTION SIGN                               ("S.")               -->
 30 | <!ENTITY uml     "&#168;"><!-- U+00A8 DIAERESIS                                  ('"')                -->
 31 | <!ENTITY copy    "&#169;"><!-- U+00A9 COPYRIGHT SIGN                             ("(C)")              -->
 32 | <!ENTITY ordf    "&#170;"><!-- U+00AA FEMININE ORDINAL INDICATOR                 ("a")                -->
 33 | <!ENTITY laquo   "&#171;"><!-- U+00AB LEFT-POINTING DOUBLE ANGLE QUOTATION MARK  ("<<")               -->
 34 | <!ENTITY not     "&#172;"><!-- U+00AC NOT SIGN                                   ("[not]")            -->
 35 | <!ENTITY shy     "&#173;"><!-- U+00AD SOFT HYPHEN                                (ignored "")         -->
 36 | <!ENTITY reg     "&#174;"><!-- U+00AE REGISTERED SIGN                            ("(R)")              -->
 37 | <!ENTITY macr    "&#175;"><!-- U+00AF MACRON                                     ("_")                -->
 38 | <!ENTITY deg     "&#176;"><!-- U+00B0 DEGREE SIGN                                ("o")                -->
 39 | <!ENTITY plusmn  "&#177;"><!-- U+00B1 PLUS-MINUS SIGN                            ("+/-")              -->
 40 | <!ENTITY sup2    "&#178;"><!-- U+00B2 SUPERSCRIPT TWO                            ("^2")               -->
 41 | <!ENTITY sup3    "&#179;"><!-- U+00B3 SUPERSCRIPT THREE                          ("^3")               -->
 42 | <!ENTITY acute   "&#180;"><!-- U+00B4 ACUTE ACCENT                               ("'")                -->
 43 | <!ENTITY micro   "&#181;"><!-- U+00B5 MICRO SIGN                                 ("[micro]")          -->
 44 | <!ENTITY para    "&#182;"><!-- U+00B6 PILCROW SIGN                               ("P.")               -->
 45 | <!ENTITY middot  "&#183;"><!-- U+00B7 MIDDLE DOT                                 (".")                -->
 46 | <!ENTITY cedil   "&#184;"><!-- U+00B8 CEDILLA                                    (",")                -->
 47 | <!ENTITY sup1    "&#185;"><!-- U+00B9 SUPERSCRIPT ONE                            ("^1")               -->
 48 | <!ENTITY ordm    "&#186;"><!-- U+00BA MASCULINE ORDINAL INDICATOR                ("o")                -->
 49 | <!ENTITY raquo   "&#187;"><!-- U+00BB RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK (">>")               -->
 50 | <!ENTITY frac14  "&#188;"><!-- U+00BC VULGAR FRACTION ONE QUARTER                ("1/4")              -->
 51 | <!ENTITY frac12  "&#189;"><!-- U+00BD VULGAR FRACTION ONE HALF                   ("1/2")              -->
 52 | <!ENTITY frac34  "&#190;"><!-- U+00BE VULGAR FRACTION THREE QUARTERS             ("3/4")              -->
 53 | <!ENTITY iquest  "&#191;"><!-- U+00BF INVERTED QUESTION MARK                     ("?")                -->
 54 | <!ENTITY Agrave  "&#192;"><!-- U+00C0 LATIN CAPITAL LETTER A WITH GRAVE          ("A")                -->
 55 | <!ENTITY Aacute  "&#193;"><!-- U+00C1 LATIN CAPITAL LETTER A WITH ACUTE          ("A")                -->
 56 | <!ENTITY Acirc   "&#194;"><!-- U+00C2 LATIN CAPITAL LETTER A WITH CIRCUMFLEX     ("A")                -->
 57 | <!ENTITY Atilde  "&#195;"><!-- U+00C3 LATIN CAPITAL LETTER A WITH TILDE          ("A")                -->
 58 | <!ENTITY Auml    "&#196;"><!-- U+00C4 LATIN CAPITAL LETTER A WITH DIAERESIS      ("Ae")               -->
 59 | <!ENTITY Aring   "&#197;"><!-- U+00C5 LATIN CAPITAL LETTER A WITH RING ABOVE     ("Ae")               -->
 60 | <!ENTITY AElig   "&#198;"><!-- U+00C6 LATIN CAPITAL LETTER AE                    ("AE")               -->
 61 | <!ENTITY Ccedil  "&#199;"><!-- U+00C7 LATIN CAPITAL LETTER C WITH CEDILLA        ("C")                -->
 62 | <!ENTITY Egrave  "&#200;"><!-- U+00C8 LATIN CAPITAL LETTER E WITH GRAVE          ("E")                -->
 63 | <!ENTITY Eacute  "&#201;"><!-- U+00C9 LATIN CAPITAL LETTER E WITH ACUTE          ("E")                -->
 64 | <!ENTITY Ecirc   "&#202;"><!-- U+00CA LATIN CAPITAL LETTER E WITH CIRCUMFLEX     ("E")                -->
 65 | <!ENTITY Euml    "&#203;"><!-- U+00CB LATIN CAPITAL LETTER E WITH DIAERESIS      ("E")                -->
 66 | <!ENTITY Igrave  "&#204;"><!-- U+00CC LATIN CAPITAL LETTER I WITH GRAVE          ("I")                -->
 67 | <!ENTITY Iacute  "&#205;"><!-- U+00CD LATIN CAPITAL LETTER I WITH ACUTE          ("I")                -->
 68 | <!ENTITY Icirc   "&#206;"><!-- U+00CE LATIN CAPITAL LETTER I WITH CIRCUMFLEX     ("I")                -->
 69 | <!ENTITY Iuml    "&#207;"><!-- U+00CF LATIN CAPITAL LETTER I WITH DIAERESIS      ("I")                -->
 70 | <!ENTITY ETH     "&#208;"><!-- U+00D0 LATIN CAPITAL LETTER ETH                   ("[ETH]")            -->
 71 | <!ENTITY Ntilde  "&#209;"><!-- U+00D1 LATIN CAPITAL LETTER N WITH TILDE          ("N")                -->
 72 | <!ENTITY Ograve  "&#210;"><!-- U+00D2 LATIN CAPITAL LETTER O WITH GRAVE          ("O")                -->
 73 | <!ENTITY Oacute  "&#211;"><!-- U+00D3 LATIN CAPITAL LETTER O WITH ACUTE          ("O")                -->
 74 | <!ENTITY Ocirc   "&#212;"><!-- U+00D4 LATIN CAPITAL LETTER O WITH CIRCUMFLEX     ("O")                -->
 75 | <!ENTITY Otilde  "&#213;"><!-- U+00D5 LATIN CAPITAL LETTER O WITH TILDE          ("O")                -->
 76 | <!ENTITY Ouml    "&#214;"><!-- U+00D6 LATIN CAPITAL LETTER O WITH DIAERESIS      ("Oe")               -->
 77 | <!ENTITY times   "&#215;"><!-- U+00D7 MULTIPLICATION SIGN                        ("x")                -->
 78 | <!ENTITY Oslash  "&#216;"><!-- U+00D8 LATIN CAPITAL LETTER O WITH STROKE         ("Oe")               -->
 79 | <!ENTITY Ugrave  "&#217;"><!-- U+00D9 LATIN CAPITAL LETTER U WITH GRAVE          ("U")                -->
 80 | <!ENTITY Uacute  "&#218;"><!-- U+00DA LATIN CAPITAL LETTER U WITH ACUTE          ("U")                -->
 81 | <!ENTITY Ucirc   "&#219;"><!-- U+00DB LATIN CAPITAL LETTER U WITH CIRCUMFLEX     ("U")                -->
 82 | <!ENTITY Uuml    "&#220;"><!-- U+00DC LATIN CAPITAL LETTER U WITH DIAERESIS      ("Ue")               -->
 83 | <!ENTITY Yacute  "&#221;"><!-- U+00DD LATIN CAPITAL LETTER Y WITH ACUTE          ("Y")                -->
 84 | <!ENTITY THORN   "&#222;"><!-- U+00DE LATIN CAPITAL LETTER THORN                 ("[THORN]")          -->
 85 | <!ENTITY szlig   "&#223;"><!-- U+00DF LATIN SMALL LETTER SHARP S                 ("ss")               -->
 86 | <!ENTITY agrave  "&#224;"><!-- U+00E0 LATIN SMALL LETTER A WITH GRAVE            ("a")                -->
 87 | <!ENTITY aacute  "&#225;"><!-- U+00E1 LATIN SMALL LETTER A WITH ACUTE            ("a")                -->
 88 | <!ENTITY acirc   "&#226;"><!-- U+00E2 LATIN SMALL LETTER A WITH CIRCUMFLEX       ("a")                -->
 89 | <!ENTITY atilde  "&#227;"><!-- U+00E3 LATIN SMALL LETTER A WITH TILDE            ("a")                -->
 90 | <!ENTITY auml    "&#228;"><!-- U+00E4 LATIN SMALL LETTER A WITH DIAERESIS        ("ae")               -->
 91 | <!ENTITY aring   "&#229;"><!-- U+00E5 LATIN SMALL LETTER A WITH RING ABOVE       ("ae")               -->
 92 | <!ENTITY aelig   "&#230;"><!-- U+00E6 LATIN SMALL LETTER AE                      ("ae")               -->
 93 | <!ENTITY ccedil  "&#231;"><!-- U+00E7 LATIN SMALL LETTER C WITH CEDILLA          ("c")                -->
 94 | <!ENTITY egrave  "&#232;"><!-- U+00E8 LATIN SMALL LETTER E WITH GRAVE            ("e")                -->
 95 | <!ENTITY eacute  "&#233;"><!-- U+00E9 LATIN SMALL LETTER E WITH ACUTE            ("e")                -->
 96 | <!ENTITY ecirc   "&#234;"><!-- U+00EA LATIN SMALL LETTER E WITH CIRCUMFLEX       ("e")                -->
 97 | <!ENTITY euml    "&#235;"><!-- U+00EB LATIN SMALL LETTER E WITH DIAERESIS        ("e")                -->
 98 | <!ENTITY igrave  "&#236;"><!-- U+00EC LATIN SMALL LETTER I WITH GRAVE            ("i")                -->
 99 | <!ENTITY iacute  "&#237;"><!-- U+00ED LATIN SMALL LETTER I WITH ACUTE            ("i")                -->
100 | <!ENTITY icirc   "&#238;"><!-- U+00EE LATIN SMALL LETTER I WITH CIRCUMFLEX       ("i")                -->
101 | <!ENTITY iuml    "&#239;"><!-- U+00EF LATIN SMALL LETTER I WITH DIAERESIS        ("i")                -->
102 | <!ENTITY eth     "&#240;"><!-- U+00F0 LATIN SMALL LETTER ETH                     ("[eth]")            -->
103 | <!ENTITY ntilde  "&#241;"><!-- U+00F1 LATIN SMALL LETTER N WITH TILDE            ("n")                -->
104 | <!ENTITY ograve  "&#242;"><!-- U+00F2 LATIN SMALL LETTER O WITH GRAVE            ("o")                -->
105 | <!ENTITY oacute  "&#243;"><!-- U+00F3 LATIN SMALL LETTER O WITH ACUTE            ("o")                -->
106 | <!ENTITY ocirc   "&#244;"><!-- U+00F4 LATIN SMALL LETTER O WITH CIRCUMFLEX       ("o")                -->
107 | <!ENTITY otilde  "&#245;"><!-- U+00F5 LATIN SMALL LETTER O WITH TILDE            ("o")                -->
108 | <!ENTITY ouml    "&#246;"><!-- U+00F6 LATIN SMALL LETTER O WITH DIAERESIS        ("oe")               -->
109 | <!ENTITY divide  "&#247;"><!-- U+00F7 DIVISION SIGN                              ("/")                -->
110 | <!ENTITY oslash  "&#248;"><!-- U+00F8 LATIN SMALL LETTER O WITH STROKE           ("oe")               -->
111 | <!ENTITY ugrave  "&#249;"><!-- U+00F9 LATIN SMALL LETTER U WITH GRAVE            ("u")                -->
112 | <!ENTITY uacute  "&#250;"><!-- U+00FA LATIN SMALL LETTER U WITH ACUTE            ("u")                -->
113 | <!ENTITY ucirc   "&#251;"><!-- U+00FB LATIN SMALL LETTER U WITH CIRCUMFLEX       ("u")                -->
114 | <!ENTITY uuml    "&#252;"><!-- U+00FC LATIN SMALL LETTER U WITH DIAERESIS        ("ue")               -->
115 | <!ENTITY yacute  "&#253;"><!-- U+00FD LATIN SMALL LETTER Y WITH ACUTE            ("y")                -->
116 | <!ENTITY thorn   "&#254;"><!-- U+00FE LATIN SMALL LETTER THORN                   ("[thorn]")          -->
117 | <!ENTITY yuml    "&#255;"><!-- U+00FF LATIN SMALL LETTER Y WITH DIAERESIS        ("y")                -->
118 | 
119 | <!-- Some of ISO Latin 9 and 10 -->
120 | <!ENTITY OElig   "&#338;"><!-- U+0152 LATIN CAPITAL LIGATURE OE                  ("OE")               -->
121 | <!ENTITY oelig   "&#339;"><!-- U+0153 LATIN SMALL LIGATURE OE                    ("oe")               -->
122 | <!ENTITY Scaron  "&#352;"><!-- U+0160 LATIN CAPITAL LETTER S WITH CARON          ("S")                -->
123 | <!ENTITY scaron  "&#353;"><!-- U+0161 LATIN SMALL LETTER S WITH CARON            ("s")                -->
124 | <!ENTITY Yuml    "&#376;"><!-- U+0178 LATIN CAPITAL LETTER Y WITH DIAERESIS      ("Y")                -->
125 | 
126 | <!-- Other Unicode (including some characters from the windows-1252 repertoire) -->
127 | <!ENTITY fnof    "&#402;"><!-- U+0192 LATIN SMALL LETTER F WITH HOOK             ("f")                -->
128 | <!ENTITY tilde   "&#732;"><!-- U+02DC SMALL TILDE                                ("~")                -->
129 | <!ENTITY ensp   "&#8194;"><!-- U+2002 EN SPACE                                   (" ")                -->
130 | <!ENTITY emsp   "&#8195;"><!-- U+2003 EM SPACE                                   (" ")                -->
131 | <!ENTITY thinsp "&#8201;"><!-- U+2009 THIN SPACE                                 (" ")                -->
132 | <!ENTITY ndash  "&#8211;"><!-- U+2013 EN DASH                                    ("-")                -->
133 | <!ENTITY mdash  "&#8212;"><!-- U+2014 EM DASH                                    ("-\u002D")          -->
134 | <!ENTITY lsquo  "&#8216;"><!-- U+2018 LEFT SINGLE QUOTATION MARK                 ("'")                -->
135 | <!ENTITY rsquo  "&#8217;"><!-- U+2019 RIGHT SINGLE QUOTATION MARK                ("'")                -->
136 | <!ENTITY sbquo  "&#8218;"><!-- U+201A SINGLE LOW-9 QUOTATION MARK                ("'")                -->
137 | <!ENTITY ldquo  "&#8220;"><!-- U+201C LEFT DOUBLE QUOTATION MARK                 ('"')                -->
138 | <!ENTITY rdquo  "&#8221;"><!-- U+201D RIGHT DOUBLE QUOTATION MARK                ('"')                -->
139 | <!ENTITY bdquo  "&#8222;"><!-- U+201E DOUBLE LOW-9 QUOTATION MARK                ('"')                -->
140 | <!ENTITY dagger "&#8224;"><!-- U+2020 DAGGER                                     ("*!*")              -->
141 | <!ENTITY Dagger "&#8225;"><!-- U+2021 DOUBLE DAGGER                              ("*!!*")             -->
142 | <!ENTITY bull   "&#8226;"><!-- U+2022 BULLET                                     ("o")                -->
143 | <!ENTITY hellip "&#8230;"><!-- U+2026 HORIZONTAL ELLIPSIS                        ("...")              -->
144 | <!ENTITY permil "&#8242;"><!-- U+2030 PER MILLE SIGN                             ("[/1000]")          -->
145 | <!ENTITY prime  "&#8242;"><!-- U+2032 PRIME                                      ("'")                -->
146 | <!ENTITY Prime  "&#8243;"><!-- U+2033 DOUBLE PRIME                               ('"')                -->
147 | <!ENTITY lsaquo "&#8249;"><!-- U+2039 SINGLE LEFT-POINTING ANGLE QUOTATION MARK  ("<")                -->
148 | <!ENTITY rsaquo "&#8250;"><!-- U+203A SINGLE RIGHT-POINTING ANGLE QUOTATION MARK (">")                -->
149 | <!ENTITY frasl  "&#8260;"><!-- U+2044 FRACTION SLASH                             ("/")                -->
150 | <!ENTITY euro   "&#8364;"><!-- U+20AC EURO SIGN                                  ("EUR")              -->
151 | <!ENTITY trade  "&#8482;"><!-- U+2122 TRADE MARK SIGN                            ("[TM]")             -->
152 | <!ENTITY larr   "&#8592;"><!-- U+2190 LEFTWARDS ARROW                            ("<-\u002D")         -->
153 | <!ENTITY rarr   "&#8594;"><!-- U+2192 RIGHTWARDS ARROW                           ("\u002D->")         -->
154 | <!ENTITY harr   "&#8596;"><!-- U+2194 LEFT RIGHT ARROW                           ("<->")              -->
155 | <!ENTITY lArr   "&#8656;"><!-- U+21D0 LEFTWARDS DOUBLE ARROW                     ("<==")              -->
156 | <!ENTITY rArr   "&#8658;"><!-- U+21D2 RIGHTWARDS DOUBLE ARROW                    ("==>")              -->
157 | <!ENTITY hArr   "&#8660;"><!-- U+21D4 LEFT RIGHT DOUBLE ARROW                    ("<=>")              -->
158 | <!ENTITY minus  "&#8722;"><!-- U+2212 MINUS SIGN                                 ("-")                -->
159 | <!ENTITY lowast "&#8727;"><!-- U+2217 ASTERISK OPERATOR                          ("*")                -->
160 | <!ENTITY le     "&#8804;"><!-- U+2264 LESS-THAN OR EQUAL TO                      ("<=")               -->
161 | <!ENTITY ge     "&#8805;"><!-- U+2265 GREATER-THAN OR EQUAL TO                   (">=")               -->
162 | <!ENTITY lang   "&#9001;"><!-- U+2329 LEFT-POINTING ANGLE BRACKET                ("<")                -->
163 | <!ENTITY rang   "&#9002;"><!-- U+232A RIGHT-POINTING ANGLE BRACKET               (">")                -->
164 | 
165 | <!-- EOF -->
166 | 


--------------------------------------------------------------------------------
/tool/rfc2629.xsd:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <!-- revised DTD for the RFC document series, draft of 2008-02-01 -->
  3 | <!--
  4 |   Contents
  5 |   
  6 |     DTD data types
  7 |   
  8 |     The top-level
  9 |   
 10 |     Front matter
 11 |   
 12 |     The Body
 13 |   
 14 |     Back matter
 15 | -->
 16 | <!--
 17 |   DTD data types:
 18 |   
 19 |         entity        description
 20 |         ======        ===============================================
 21 |         NUMBER        [0-9]+
 22 |         NUMBERS       a comma-separated list of NUMBER
 23 |   
 24 |         DAY           the day of the month, e.g., "1"
 25 |         MONTH         the month of the year, e.g., "January"
 26 |         YEAR          a four-digit year, e.g., "1999"
 27 |   
 28 |         URI           e.g., "http://invisible.net/"
 29 |   
 30 |         ATEXT/CTEXT   printable ASCII text (no line-terminators)
 31 |   
 32 |         TEXT          character data
 33 | -->
 34 | <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
 35 |   <xs:import namespace="http://www.w3.org/XML/1998/namespace" schemaLocation="xml.xsd"/>
 36 |   <xs:simpleType name="NUMBER">
 37 |     <xs:restriction base="xs:string"/>
 38 |   </xs:simpleType>
 39 |   <xs:simpleType name="NUMBERS">
 40 |     <xs:restriction base="xs:string"/>
 41 |   </xs:simpleType>
 42 |   <xs:simpleType name="DAY">
 43 |     <xs:restriction base="xs:string"/>
 44 |   </xs:simpleType>
 45 |   <xs:simpleType name="MONTH">
 46 |     <xs:restriction base="xs:string"/>
 47 |   </xs:simpleType>
 48 |   <xs:simpleType name="YEAR">
 49 |     <xs:restriction base="xs:string"/>
 50 |   </xs:simpleType>
 51 |   <xs:simpleType name="URI">
 52 |     <xs:restriction base="xs:string"/>
 53 |   </xs:simpleType>
 54 |   <xs:simpleType name="ATEXT">
 55 |     <xs:restriction base="xs:string"/>
 56 |   </xs:simpleType>
 57 |   <!-- The top-level -->
 58 |   <!--
 59 |     attributes for the "rfc" element are supplied by the RFC
 60 |     editor. when preparing drafts, authors should leave them blank.
 61 |     
 62 |     the "seriesNo" attribute is used if the category is, e.g., BCP.
 63 |   -->
 64 |   <xs:element name="rfc">
 65 |     <xs:complexType>
 66 |       <xs:sequence>
 67 |         <xs:element ref="front"/>
 68 |         <xs:element ref="middle"/>
 69 |         <xs:element minOccurs="0" ref="back"/>
 70 |       </xs:sequence>
 71 |       <xs:attribute name="number" type="NUMBER"/>
 72 |       <xs:attribute name="obsoletes" default="" type="NUMBERS"/>
 73 |       <xs:attribute name="updates" default="" type="NUMBERS"/>
 74 |       <xs:attribute name="category">
 75 |         <xs:simpleType>
 76 |           <xs:restriction base="xs:token">
 77 |             <xs:enumeration value="std"/>
 78 |             <xs:enumeration value="bcp"/>
 79 |             <xs:enumeration value="info"/>
 80 |             <xs:enumeration value="exp"/>
 81 |             <xs:enumeration value="historic"/>
 82 |           </xs:restriction>
 83 |         </xs:simpleType>
 84 |       </xs:attribute>
 85 |       <xs:attribute name="seriesNo" type="NUMBER"/>
 86 |       <xs:attribute name="ipr">
 87 |         <xs:simpleType>
 88 |           <xs:restriction base="xs:token">
 89 |             <xs:enumeration value="full2026"/>
 90 |             <xs:enumeration value="noDerivativeWorks2026"/>
 91 |             <xs:enumeration value="none"/>
 92 |             <xs:enumeration value="full3667"/>
 93 |             <xs:enumeration value="noModification3667"/>
 94 |             <xs:enumeration value="noDerivatives3667"/>
 95 |             <xs:enumeration value="full3978"/>
 96 |             <xs:enumeration value="noModification3978"/>
 97 |             <xs:enumeration value="noDerivatives3978"/>
 98 |           </xs:restriction>
 99 |         </xs:simpleType>
100 |       </xs:attribute>
101 |       <xs:attribute name="iprExtract" type="xs:IDREF"/>
102 |       <xs:attribute name="submissionType" default="IETF">
103 |         <xs:simpleType>
104 |           <xs:restriction base="xs:token">
105 |             <xs:enumeration value="IETF"/>
106 |             <xs:enumeration value="independent"/>
107 |           </xs:restriction>
108 |         </xs:simpleType>
109 |       </xs:attribute>
110 |       <xs:attribute name="docName" type="ATEXT"/>
111 |       <xs:attribute ref="xml:lang" default="en"/>
112 |     </xs:complexType>
113 |   </xs:element>
114 |   <!-- Front matter -->
115 |   <xs:element name="front">
116 |     <xs:complexType>
117 |       <xs:sequence>
118 |         <xs:element ref="title"/>
119 |         <xs:element maxOccurs="unbounded" ref="author"/>
120 |         <xs:element ref="date"/>
121 |         <xs:element minOccurs="0" maxOccurs="unbounded" ref="area"/>
122 |         <xs:element minOccurs="0" maxOccurs="unbounded" ref="workgroup"/>
123 |         <xs:element minOccurs="0" maxOccurs="unbounded" ref="keyword"/>
124 |         <xs:element minOccurs="0" ref="abstract"/>
125 |         <xs:element minOccurs="0" maxOccurs="unbounded" ref="note"/>
126 |       </xs:sequence>
127 |     </xs:complexType>
128 |   </xs:element>
129 |   <!-- the "abbrev" attribute is used for headers, etc. -->
130 |   <xs:element name="title">
131 |     <xs:complexType mixed="true">
132 |       <xs:attribute name="abbrev" type="ATEXT"/>
133 |     </xs:complexType>
134 |   </xs:element>
135 |   <xs:element name="author">
136 |     <xs:complexType>
137 |       <xs:sequence>
138 |         <xs:element ref="organization"/>
139 |         <xs:element minOccurs="0" ref="address"/>
140 |       </xs:sequence>
141 |       <xs:attribute name="initials" type="ATEXT"/>
142 |       <xs:attribute name="surname" type="ATEXT"/>
143 |       <xs:attribute name="fullname" type="ATEXT"/>
144 |       <xs:attribute name="role">
145 |         <xs:simpleType>
146 |           <xs:restriction base="xs:token">
147 |             <xs:enumeration value="editor"/>
148 |           </xs:restriction>
149 |         </xs:simpleType>
150 |       </xs:attribute>
151 |     </xs:complexType>
152 |   </xs:element>
153 |   <xs:element name="organization">
154 |     <xs:complexType mixed="true">
155 |       <xs:attribute name="abbrev" type="ATEXT"/>
156 |     </xs:complexType>
157 |   </xs:element>
158 |   <xs:element name="address">
159 |     <xs:complexType>
160 |       <xs:sequence>
161 |         <xs:element minOccurs="0" ref="postal"/>
162 |         <xs:element minOccurs="0" ref="phone"/>
163 |         <xs:element minOccurs="0" ref="facsimile"/>
164 |         <xs:element minOccurs="0" ref="email"/>
165 |         <xs:element minOccurs="0" ref="uri"/>
166 |       </xs:sequence>
167 |     </xs:complexType>
168 |   </xs:element>
169 |   <!--
170 |     this content model should be more strict: 
171 |     at most one of each the city, region, code, and country
172 |     elements may be present
173 |   -->
174 |   <xs:element name="postal">
175 |     <xs:complexType>
176 |       <xs:sequence>
177 |         <xs:element maxOccurs="unbounded" ref="street"/>
178 |         <xs:choice minOccurs="0" maxOccurs="unbounded">
179 |           <xs:element ref="city"/>
180 |           <xs:element ref="region"/>
181 |           <xs:element ref="code"/>
182 |           <xs:element ref="country"/>
183 |         </xs:choice>
184 |       </xs:sequence>
185 |     </xs:complexType>
186 |   </xs:element>
187 |   <xs:element name="street" type="xs:string"/>
188 |   <xs:element name="city" type="xs:string"/>
189 |   <xs:element name="region" type="xs:string"/>
190 |   <xs:element name="code" type="xs:string"/>
191 |   <xs:element name="country" type="xs:string"/>
192 |   <xs:element name="phone" type="xs:string"/>
193 |   <xs:element name="facsimile" type="xs:string"/>
194 |   <xs:element name="email" type="xs:string"/>
195 |   <xs:element name="uri" type="xs:string"/>
196 |   <xs:element name="date">
197 |     <xs:complexType>
198 |       <xs:attribute name="day" type="DAY"/>
199 |       <xs:attribute name="month" type="MONTH"/>
200 |       <xs:attribute name="year" type="YEAR"/>
201 |     </xs:complexType>
202 |   </xs:element>
203 |   <!-- meta-data... -->
204 |   <xs:element name="area" type="xs:string"/>
205 |   <xs:element name="workgroup" type="xs:string"/>
206 |   <xs:element name="keyword" type="xs:string"/>
207 |   <xs:element name="abstract">
208 |     <xs:complexType>
209 |       <xs:sequence>
210 |         <xs:element maxOccurs="unbounded" ref="t"/>
211 |       </xs:sequence>
212 |     </xs:complexType>
213 |   </xs:element>
214 |   <xs:element name="note">
215 |     <xs:complexType>
216 |       <xs:sequence>
217 |         <xs:element maxOccurs="unbounded" ref="t"/>
218 |       </xs:sequence>
219 |       <xs:attribute name="title" use="required" type="ATEXT"/>
220 |     </xs:complexType>
221 |   </xs:element>
222 |   <!-- The body -->
223 |   <!-- later on, may be (section+,appendix*,section*) -->
224 |   <xs:element name="middle">
225 |     <xs:complexType>
226 |       <xs:sequence>
227 |         <xs:element maxOccurs="unbounded" ref="section"/>
228 |       </xs:sequence>
229 |     </xs:complexType>
230 |   </xs:element>
231 |   <xs:element name="section">
232 |     <xs:complexType>
233 |       <xs:sequence>
234 |         <xs:choice minOccurs="0" maxOccurs="unbounded">
235 |           <xs:element ref="t"/>
236 |           <xs:element ref="figure"/>
237 |           <xs:element ref="texttable"/>
238 |           <xs:element ref="iref"/>
239 |           <xs:element ref="section"/>
240 |         </xs:choice>
241 |         <xs:choice minOccurs="0" maxOccurs="unbounded">
242 |           <xs:element ref="section"/>
243 |         </xs:choice>
244 |       </xs:sequence>
245 |       <xs:attribute name="anchor" type="xs:ID"/>
246 |       <xs:attribute name="title" use="required" type="ATEXT"/>
247 |       <xs:attribute name="toc" default="default">
248 |         <xs:simpleType>
249 |           <xs:restriction base="xs:token">
250 |             <xs:enumeration value="include"/>
251 |             <xs:enumeration value="exclude"/>
252 |             <xs:enumeration value="default"/>
253 |           </xs:restriction>
254 |         </xs:simpleType>
255 |       </xs:attribute>
256 |     </xs:complexType>
257 |   </xs:element>
258 |   <!--
259 |     <!ELEMENT appendix    ((t|figure|texttable|iref)*,appendix)*>
260 |     <!ATTLIST appendix
261 |               anchor      ID                 #IMPLIED
262 |               title       %ATEXT;            #REQUIRED
263 |               toc         (include|exclude|default)
264 |                                              "default">
265 |   -->
266 |   <!-- use of <figure/> is deprecated... -->
267 |   <xs:element name="t">
268 |     <xs:complexType mixed="true">
269 |       <xs:choice minOccurs="0" maxOccurs="unbounded">
270 |         <xs:element ref="list"/>
271 |         <xs:element ref="figure"/>
272 |         <xs:element ref="xref"/>
273 |         <xs:element ref="eref"/>
274 |         <xs:element ref="iref"/>
275 |         <xs:element ref="cref"/>
276 |         <xs:element ref="spanx"/>
277 |         <xs:element ref="vspace"/>
278 |       </xs:choice>
279 |       <xs:attribute name="anchor" type="xs:ID"/>
280 |       <xs:attribute name="hangText" type="ATEXT"/>
281 |     </xs:complexType>
282 |   </xs:element>
283 |   <!--
284 |     the value of the style attribute is inherited from the closest 
285 |     parent
286 |   -->
287 |   <xs:element name="list">
288 |     <xs:complexType>
289 |       <xs:sequence>
290 |         <xs:element maxOccurs="unbounded" ref="t"/>
291 |       </xs:sequence>
292 |       <xs:attribute name="style" type="ATEXT"/>
293 |       <xs:attribute name="hangIndent" type="NUMBER"/>
294 |       <xs:attribute name="counter" type="ATEXT"/>
295 |     </xs:complexType>
296 |   </xs:element>
297 |   <xs:element name="xref">
298 |     <xs:complexType mixed="true">
299 |       <xs:attribute name="target" use="required" type="xs:IDREF"/>
300 |       <xs:attribute name="pageno" default="false">
301 |         <xs:simpleType>
302 |           <xs:restriction base="xs:token">
303 |             <xs:enumeration value="true"/>
304 |             <xs:enumeration value="false"/>
305 |           </xs:restriction>
306 |         </xs:simpleType>
307 |       </xs:attribute>
308 |       <xs:attribute name="format" default="default">
309 |         <xs:simpleType>
310 |           <xs:restriction base="xs:token">
311 |             <xs:enumeration value="counter"/>
312 |             <xs:enumeration value="title"/>
313 |             <xs:enumeration value="none"/>
314 |             <xs:enumeration value="default"/>
315 |           </xs:restriction>
316 |         </xs:simpleType>
317 |       </xs:attribute>
318 |     </xs:complexType>
319 |   </xs:element>
320 |   <xs:element name="eref">
321 |     <xs:complexType mixed="true">
322 |       <xs:attribute name="target" use="required" type="URI"/>
323 |     </xs:complexType>
324 |   </xs:element>
325 |   <xs:element name="iref">
326 |     <xs:complexType>
327 |       <xs:attribute name="item" use="required" type="ATEXT"/>
328 |       <xs:attribute name="subitem" default="" type="ATEXT"/>
329 |       <xs:attribute name="primary" default="false">
330 |         <xs:simpleType>
331 |           <xs:restriction base="xs:token">
332 |             <xs:enumeration value="true"/>
333 |             <xs:enumeration value="false"/>
334 |           </xs:restriction>
335 |         </xs:simpleType>
336 |       </xs:attribute>
337 |     </xs:complexType>
338 |   </xs:element>
339 |   <xs:element name="cref">
340 |     <xs:complexType mixed="true">
341 |       <xs:attribute name="anchor" type="xs:ID"/>
342 |       <xs:attribute name="source" default="" type="ATEXT"/>
343 |     </xs:complexType>
344 |   </xs:element>
345 |   <xs:element name="spanx">
346 |     <xs:complexType mixed="true">
347 |       <xs:attribute ref="xml:space" default="preserve"/>
348 |       <xs:attribute name="style" default="emph" type="ATEXT"/>
349 |     </xs:complexType>
350 |   </xs:element>
351 |   <xs:element name="vspace">
352 |     <xs:complexType>
353 |       <xs:attribute name="blankLines" default="0" type="NUMBER"/>
354 |     </xs:complexType>
355 |   </xs:element>
356 |   <xs:element name="figure">
357 |     <xs:complexType>
358 |       <xs:sequence>
359 |         <xs:element minOccurs="0" maxOccurs="unbounded" ref="iref"/>
360 |         <xs:element minOccurs="0" ref="preamble"/>
361 |         <xs:element ref="artwork"/>
362 |         <xs:element minOccurs="0" ref="postamble"/>
363 |       </xs:sequence>
364 |       <xs:attribute name="anchor" type="xs:ID"/>
365 |       <xs:attribute name="title" default="" type="ATEXT"/>
366 |       <xs:attribute name="suppress-title" default="false">
367 |         <xs:simpleType>
368 |           <xs:restriction base="xs:token">
369 |             <xs:enumeration value="true"/>
370 |             <xs:enumeration value="false"/>
371 |           </xs:restriction>
372 |         </xs:simpleType>
373 |       </xs:attribute>
374 |       <xs:attribute name="src" type="URI"/>
375 |       <xs:attribute name="align" default="left">
376 |         <xs:simpleType>
377 |           <xs:restriction base="xs:token">
378 |             <xs:enumeration value="left"/>
379 |             <xs:enumeration value="center"/>
380 |             <xs:enumeration value="right"/>
381 |           </xs:restriction>
382 |         </xs:simpleType>
383 |       </xs:attribute>
384 |       <xs:attribute name="alt" type="ATEXT"/>
385 |       <xs:attribute name="width" type="ATEXT"/>
386 |       <xs:attribute name="height" type="ATEXT"/>
387 |     </xs:complexType>
388 |   </xs:element>
389 |   <xs:element name="preamble">
390 |     <xs:complexType mixed="true">
391 |       <xs:choice minOccurs="0" maxOccurs="unbounded">
392 |         <xs:element ref="xref"/>
393 |         <xs:element ref="eref"/>
394 |         <xs:element ref="iref"/>
395 |         <xs:element ref="cref"/>
396 |         <xs:element ref="spanx"/>
397 |       </xs:choice>
398 |     </xs:complexType>
399 |   </xs:element>
400 |   <xs:element name="artwork">
401 |     <xs:complexType mixed="true">
402 |       <xs:attribute ref="xml:space" default="preserve"/>
403 |       <xs:attribute name="name" default="" type="ATEXT"/>
404 |       <xs:attribute name="type" type="ATEXT"/>
405 |       <xs:attribute name="src" type="URI"/>
406 |       <xs:attribute name="align" default="left">
407 |         <xs:simpleType>
408 |           <xs:restriction base="xs:token">
409 |             <xs:enumeration value="left"/>
410 |             <xs:enumeration value="center"/>
411 |             <xs:enumeration value="right"/>
412 |           </xs:restriction>
413 |         </xs:simpleType>
414 |       </xs:attribute>
415 |       <xs:attribute name="alt" type="ATEXT"/>
416 |       <xs:attribute name="width" type="ATEXT"/>
417 |       <xs:attribute name="height" type="ATEXT"/>
418 |     </xs:complexType>
419 |   </xs:element>
420 |   <xs:element name="postamble">
421 |     <xs:complexType mixed="true">
422 |       <xs:choice minOccurs="0" maxOccurs="unbounded">
423 |         <xs:element ref="xref"/>
424 |         <xs:element ref="eref"/>
425 |         <xs:element ref="iref"/>
426 |         <xs:element ref="cref"/>
427 |         <xs:element ref="spanx"/>
428 |       </xs:choice>
429 |     </xs:complexType>
430 |   </xs:element>
431 |   <xs:element name="texttable">
432 |     <xs:complexType>
433 |       <xs:sequence>
434 |         <xs:element minOccurs="0" ref="preamble"/>
435 |         <xs:element maxOccurs="unbounded" ref="ttcol"/>
436 |         <xs:element minOccurs="0" maxOccurs="unbounded" ref="c"/>
437 |         <xs:element minOccurs="0" ref="postamble"/>
438 |       </xs:sequence>
439 |       <xs:attribute name="anchor" type="xs:ID"/>
440 |       <xs:attribute name="title" default="" type="ATEXT"/>
441 |       <xs:attribute name="suppress-title" default="false">
442 |         <xs:simpleType>
443 |           <xs:restriction base="xs:token">
444 |             <xs:enumeration value="true"/>
445 |             <xs:enumeration value="false"/>
446 |           </xs:restriction>
447 |         </xs:simpleType>
448 |       </xs:attribute>
449 |       <xs:attribute name="align" default="center">
450 |         <xs:simpleType>
451 |           <xs:restriction base="xs:token">
452 |             <xs:enumeration value="left"/>
453 |             <xs:enumeration value="center"/>
454 |             <xs:enumeration value="right"/>
455 |           </xs:restriction>
456 |         </xs:simpleType>
457 |       </xs:attribute>
458 |       <xs:attribute name="style" default="full">
459 |         <xs:simpleType>
460 |           <xs:restriction base="xs:token">
461 |             <xs:enumeration value="all"/>
462 |             <xs:enumeration value="non"/>
463 |             <xs:enumeration value="headers"/>
464 |             <xs:enumeration value="full"/>
465 |           </xs:restriction>
466 |         </xs:simpleType>
467 |       </xs:attribute>
468 |     </xs:complexType>
469 |   </xs:element>
470 |   <xs:element name="ttcol">
471 |     <xs:complexType mixed="true">
472 |       <xs:attribute name="width" type="ATEXT"/>
473 |       <xs:attribute name="align" default="left">
474 |         <xs:simpleType>
475 |           <xs:restriction base="xs:token">
476 |             <xs:enumeration value="left"/>
477 |             <xs:enumeration value="center"/>
478 |             <xs:enumeration value="right"/>
479 |           </xs:restriction>
480 |         </xs:simpleType>
481 |       </xs:attribute>
482 |     </xs:complexType>
483 |   </xs:element>
484 |   <xs:element name="c">
485 |     <xs:complexType mixed="true">
486 |       <xs:choice minOccurs="0" maxOccurs="unbounded">
487 |         <xs:element ref="xref"/>
488 |         <xs:element ref="eref"/>
489 |         <xs:element ref="iref"/>
490 |         <xs:element ref="cref"/>
491 |         <xs:element ref="spanx"/>
492 |       </xs:choice>
493 |     </xs:complexType>
494 |   </xs:element>
495 |   <!-- Back matter -->
496 |   <!-- sections, if present, are appendices -->
497 |   <xs:element name="back">
498 |     <xs:complexType>
499 |       <xs:sequence>
500 |         <xs:element minOccurs="0" maxOccurs="unbounded" ref="references"/>
501 |         <xs:element minOccurs="0" maxOccurs="unbounded" ref="section"/>
502 |       </xs:sequence>
503 |     </xs:complexType>
504 |   </xs:element>
505 |   <xs:element name="references">
506 |     <xs:complexType>
507 |       <xs:sequence>
508 |         <xs:element maxOccurs="unbounded" ref="reference"/>
509 |       </xs:sequence>
510 |       <xs:attribute name="title" default="References" type="ATEXT"/>
511 |     </xs:complexType>
512 |   </xs:element>
513 |   <xs:element name="reference">
514 |     <xs:complexType>
515 |       <xs:sequence>
516 |         <xs:element ref="front"/>
517 |         <xs:element minOccurs="0" maxOccurs="unbounded" ref="seriesInfo"/>
518 |         <xs:element minOccurs="0" maxOccurs="unbounded" ref="format"/>
519 |         <xs:element minOccurs="0" maxOccurs="unbounded" ref="annotation"/>
520 |       </xs:sequence>
521 |       <xs:attribute name="anchor" type="xs:ID"/>
522 |       <xs:attribute name="target" type="URI"/>
523 |     </xs:complexType>
524 |   </xs:element>
525 |   <xs:element name="seriesInfo">
526 |     <xs:complexType>
527 |       <xs:attribute name="name" use="required" type="ATEXT"/>
528 |       <xs:attribute name="value" use="required" type="ATEXT"/>
529 |     </xs:complexType>
530 |   </xs:element>
531 |   <xs:element name="format">
532 |     <xs:complexType>
533 |       <xs:attribute name="target" type="URI"/>
534 |       <xs:attribute name="type" use="required" type="ATEXT"/>
535 |       <xs:attribute name="octets" type="NUMBER"/>
536 |     </xs:complexType>
537 |   </xs:element>
538 |   <xs:element name="annotation">
539 |     <xs:complexType mixed="true">
540 |       <xs:choice minOccurs="0" maxOccurs="unbounded">
541 |         <xs:element ref="xref"/>
542 |         <xs:element ref="eref"/>
543 |         <xs:element ref="iref"/>
544 |         <xs:element ref="cref"/>
545 |         <xs:element ref="spanx"/>
546 |       </xs:choice>
547 |     </xs:complexType>
548 |   </xs:element>
549 | </xs:schema>
550 | 
551 | 


--------------------------------------------------------------------------------
/9p2000.u.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <!-- edited with XMLSPY v5 rel. 3 U (http://www.xmlspy.com)
  3 |      by Daniel M Kohn (private) -->
  4 | <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
  5 | <rfc category="exp" ipr="none" 
  6 | docName="experimental-draft-9P2000-unix-extension"
  7 | updates="experimental-draft-9P2000-protocol">
  8 | <?xml-stylesheet type='text/xsl' href='rfc2629.xslt' ?>
  9 | <?rfc toc="yes" ?>
 10 | <?rfc symrefs="yes" ?>
 11 | <?rfc sortrefs="yes"?>
 12 | <?rfc iprnotified="no" ?>
 13 |  <front>
 14 |   <title abbrev="9P2000.u">Plan 9 Remote Resource Protocol Unix Extension</title>
 15 |   <author initials='E.V.H.' surname="Van Hensbergen" fullname='Eric Van Hensbergen'>
 16 |    <organization>
 17 | 		Plan 9 Fans
 18 | 	    </organization>
 19 |    <address>
 20 |     <email>9fans@cse.psu.edu</email>
 21 |     <uri>http://plan9.bell-labs.com/plan9</uri>
 22 |    </address>
 23 |   </author>
 24 |   <date month="August" year="2009"/>
 25 |   <area>General</area>
 26 |   <keyword>Plan 9</keyword>
 27 |   <keyword>9P2000</keyword>
 28 |   <keyword>9P2000.u</keyword>
 29 |   <keyword>v9fs</keyword>
 30 |   <keyword>9P</keyword>
 31 |   <abstract>
 32 |    <t>
 33 | 	9P is a distributed resource sharing protocol developed as
 34 | 	part of the Plan 9 research operating system at AT&T Bell
 35 | 	Laboratories (now a part of Lucent Technologies) by the Computer
 36 | 	Science Research Center.  It can be used to distributed file
 37 | 	systems, devices, and application services.  It was designed as
 38 | 	an interface to both local and remote resources, making the
 39 | 	transition from local to cluster to grid resources transparent.
 40 | 	</t>
 41 |    <t>
 42 |    	9P2000.u is a set of extensions to the 9P protocol to better
 43 | 	support UNIX environments connecting to Plan 9 file servers and
 44 | 	UNIX environments connecting to other UNIX environments.  The
 45 | 	extensions include support for symbolic links, additional modes,
 46 | 	and special files (such as pipes and devices).  Also included
 47 | 	are hints to better support mapping of numeric user-ids, group-ids, 
 48 | 	and error codes.
 49 | 	</t>
 50 |   </abstract>
 51 |  </front>
 52 |  <middle>
 53 |   <section title="Requirements notation">
 54 |    <t>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL",
 55 | 	    "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",
 56 | 	    and "OPTIONAL" in this document are to be interpreted as
 57 | 	    described in RFC2119.</t>
 58 |   </section>
 59 |   <section anchor="intro" title="Introduction">
 60 | <t>
 61 | Many modern UNIX systems, including Linux use a virtual file system (VFS) 
 62 | layer as a basic level of abstraction for accessing underlying 
 63 | implementations. Implementing 9P2000 under Linux is a matter of mapping VFS 
 64 | operations to their associated 9P operations. The problem, however, is that 
 65 | 9P2000 was designed for a non-UNIX system so there are several fundamental 
 66 | differences in the functional semantics provided by 9P.
 67 | </t>
 68 | <t>
 69 | To preserve compatibility with these pre-existing features we propose 
 70 | a transparent extension to the file system semantics which minimally effects 
 71 | the protocol syntax.  9P2000.u is a dialect of 9P2000 negotiated in the 
 72 | Tversion/Rversion exchange.  If the server agrees to 9P2000.u, then the wire 
 73 | protocol that follows is 9P2000 with these changes.
 74 | </t>
 75 | <section title="Overview of Differences">
 76 | <section title="Numeric Versus String IDs">
 77 | <t>
 78 | Under Plan 9 <xref target="PLAN9" />, user names as well as groups are represented by strings, while 
 79 | on Unix they are represented by unique numbers. This is complicated by Linux 
 80 | making it exceedingly difficult to map these numeric identifiers to their 
 81 | string values in the kernel. Many of the available UNIX network file systems 
 82 | avoid this issue and simply use numeric identifiers over the wire, hoping they 
 83 | map to the remote system. NFSv4 has provisions for sending string group 
 84 | and user info over the wire and then contacting a user-space daemon which 
 85 | attempts to provide a valid mapping.
 86 | </t>
 87 | <t>
 88 | 9P2000.u provides a dual approach to this problem, changes have been made
 89 | to the protocol to allow for numeric identifiers to be used along-side
 90 | strings.  Servers should make every attempt to provide valid information
 91 | for both the numeric and string form of identifiers.  Clients can then use
 92 | the available information to best map the identifiers to their local
 93 | environment.  Use of extended form string user names (e.g. user@domain)
 94 | as specified in the NFSv4 environment is also valid.
 95 | </t>
 96 | </section>
 97 | <section title="Error Strings Versus Error Codes">
 98 | <t>
 99 | A similar problem exists for error numbers, by default VFS operations 
100 | return error numbers, whereas Plan 9 (and 9P) use error strings to 
101 | describe failure conditions.  This problem is further exacerbated by 
102 | the potential for Plan 9 synthetic file servers to return custom error
103 | strings which may not match any pre-defined set (or pattern) of 
104 | standard error messages.
105 | </t>
106 | <t>
107 | Again, our approach is to provide as much information as possible in
108 | order to help clients properly convey error conditions to end-applications
109 | and end-users.  As such both error strings and error codes are conveyed in
110 | the 9P2000.u version of the protocol.  A suggested implementation is that
111 | non-standard/unrecognized error strings/codes be made available to
112 | applications via some mechanism in order to communicate application
113 | synthetic file system events (via sysfs or procfs in Linux, or perhaps
114 | via a special extended attribute).
115 | </t>
116 | </section>
117 | <section title="Permission Modes">
118 | <t>
119 | Plan 9 has a different user security model <xref target="P9SEC"/>, so there 
120 | is no such concept as set-uid or set-gid permissions.  There is also no 
121 | equivalent for the sticky bit.  Luckily, Plan 9 has plenty of space in 
122 | higher permission mode bit space for such extensions.
123 | </t>
124 | </section>
125 | <section title="Special Files and Links">
126 | <t>
127 | One of the unique aspects of the Plan 9 name space is that it is dynamic. 
128 | Users are able to bind files and directories over each other in stackable 
129 | layers similar to union file systems. This aspect of Plan 9 name spaces has 
130 | obviated the need for symbolic or hard links. Symlinks on a remote UNIX file 
131 | server will be traversed transparently as part of a walk - there is no native 
132 | ability within Plan 9 to create symlinks. This breaks many assumptions for 
133 | Linux file-systems and many existing applications (for example the kernel 
134 | build creates a symlink in the include directory as part of the make process).
135 | </t>
136 | <t>
137 | Another unique aspect is that named pipes and devices look just like other
138 | files in Plan 9, there are no special mode bits and no concept of major
139 | and minor block numbers.
140 | </t>
141 | <t>
142 | To solve both of these problems special mode bits are introduced to mark
143 | special file types and a variable-length string field is added to the
144 | file attribute structure which is used to store the additional information
145 | associated with these special files.  In the case of symlinks, for instance,
146 | the variable length string contains the full path target of the symbolic
147 | link.
148 | </t>
149 | </section>
150 | <section title="ioctl">
151 | <t>
152 | A VFS function not accounted for in the 9P infrastructure is the ioctl
153 | command.  No attempt has been made at this time to accomodate its
154 | functionality.  Plan 9 has traditionally used elements within a synthetic
155 | file system to provide for similar functionality, with the added benefit of
156 | getting transparent network distribution of the control path.  For such
157 | devices/files that still require the use of ioctl, gateway synthetic file
158 | systems are suggested to provide analogous functionality.
159 | </t>
160 | </section>
161 | <section title="Extended Attributes">
162 | <t>
163 | A relatively recent addition to VFS interfaces is the ability to have
164 | arbitrary key/value pairs added to file meta-data.  9P2000.u doesn't
165 | have provisions to accomodate this feature, but it may be added in the
166 | future as more file systems adopt extended attributes.
167 | </t>
168 | </section>
169 | </section>
170 |    <section anchor="msgs" title="Changed Messages">
171 |     <t>
172 |      <list style="empty">
173 |       <t>
174 |       size[4] Tversion tag[2] msize[4] version[s]
175 |    </t>
176 |       <t>
177 |       size[4] Rversion tag[2] msize[4] version[s]
178 |    </t>
179 |       <t>
180 |        <vspace/>
181 |       size[4] Rerror tag[2] ename[s] errno[4]
182 |    </t>
183 | <t>
184 | <vspace/>
185 | size[4] Tauth tag[2] afid[4] uname[s] aname[s]
186 | </t>
187 | <t>
188 | size[4] Rauth tag[2] aqid[13]
189 | </t>
190 | <t>
191 | <vspace/>
192 | size[4] Tattach tag[2] fid[4] afid[4] uname[s] aname[s]
193 | </t>
194 | <t>
195 | size[4] Rattach tag[2] qid[13]
196 | </t>
197 | <t>
198 | <vspace/>
199 | size[4] Tcreate tag[2] fid[4] name[s] perm[4] mode[1] extension[s]
200 | </t>
201 | <t>
202 | size[4] Rcreate tag[2] qid[13] iounit[4]
203 | </t>
204 |       <t>
205 |        <vspace/>
206 |       size[4] Tstat tag[2] fid[4]
207 |    </t>
208 |       <t>
209 |       size[4] Rstat tag[2] stat[n]
210 |    </t>
211 |       <t>
212 |        <vspace/>
213 |       size[4] Twstat tag[2] fid[4] stat[n]
214 |    </t>
215 |       <t>
216 |       size[4] Rwstat tag[2]
217 |    </t>
218 |      </list>
219 |     </t>
220 |    </section>
221 |   </section>
222 |   <section title="Protocol Data Types">
223 |    <section title="Changed Basic Data Types">
224 |     <t> TODO: cover changed data types in our protocol synopsis</t>
225 |    </section>
226 |    <section title="Changed Structured Data Types">
227 |     <t> TODO: cover changed structs (like stat) that the protocol uses</t>
228 |    </section>
229 |   </section>
230 |   <section title = "Changed File Attributes">
231 |    <t>TODO: discuss changes</t>
232 |   </section>
233 |   <section title = "Versioning">
234 |    <t>TODO: describe protocol versioning in detail (steal from Protocol section)</t>
235 |   </section>
236 |   <section title = "Error Definitions">
237 |    <t>TODO: enumerate new standard file system error strings and describe 
238 |    possibility of application error strings</t>
239 |   </section>
240 |   <section anchor="protocol" title="Changed Protocol Operations">
241 |    <section anchor="version" title="version - negotiate protocol version">
242 |     <t>
243 | SYNOPSIS
244 | </t>
245 |     <t>
246 |      <list style="empty">
247 |       <t>size[4] Tversion tag[2] msize[4] version[s]</t>
248 |       <t>size[4] Rversion tag[2] msize[4] version[s]</t>
249 |      </list>
250 |     </t>
251 |     <t>
252 | DESCRIPTION
253 | </t>
254 |     <t>
255 |      <list style="empty">
256 |       <t>
257 | 	Support for 9P2000.u is an optional extension which isn't
258 | 	quite covered in the existing version semantics for 9P2000.
259 | 	The original protocol specification describes discarding
260 | 	anything after an initial period in the version string.  We
261 | 	use the information following the period as a method for
262 | 	negotiating optional protocol extensions.
263 |      </t>
264 |      <t><vspace/>
265 | 	If a client desires support for the UNIX extensions, it will
266 | 	send the add a .u to the end of the version string (e.g. 9P2000.u).
267 | 	If a server is capable of supporting the extension, it will
268 | 	return 9P2000.u back to the client.  If the server is incapable
269 | 	or unwilling to support the extensions, it will return the
270 | 	version string without the extension specification (e.g. 9P2000).
271 |      </t>
272 |      <t><vspace/>
273 | 	Clients should be implemented in such a way to be able to operate
274 | 	without the extensions in some degraded form of operation.  
275 | 	Specifics for how to gracefully degrade operation without 
276 | 	specific extensions are suggested by this document.
277 |      </t>
278 |      </list>
279 |     </t>
280 |    </section>
281 | 
282 | <section title="error - return an error">
283 |     <t>
284 | SYNOPSIS
285 | </t>
286 |     <t>
287 |      <list>
288 |       <t>
289 |        size[4] Rerror tag[2] ename[s] errno[4]
290 | </t>
291 |      </list>
292 |     </t>
293 |     <t>
294 | DESCRIPTION
295 | </t>
296 |     <t>
297 |      <list>
298 |       <t>
299 | 	An errno field has been added to the message in order to provide
300 | 	a hint of the underlying UNIX error number which caused the error
301 | 	on the server.  Due to consistency problems of mapping error
302 | 	numbers betweeen different versions of UNIX, clients should give
303 | 	preference to the error string in attempting to report the error,
304 | 	however, in the event that they are unable to map an error string,
305 | 	they may return the errno to the application.
306 |       </t>
307 |       <t><vspace/>
308 | 	A special errno (ERRUNDEF) is returned by servers who do not wish
309 | 	to return raw error numbers.  In the event that clients can not 
310 | 	interpret the error string, they should somehow make the error
311 | 	string available to end-application/end-user via dynamic custom
312 | 	error codes.
313 |       </t>
314 |      </list>
315 |     </t>
316 |    </section>
317 | 
318 | <section title="auth/attach - messages to establish a connection">
319 |     <t>
320 | SYNOPSIS
321 | </t>
322 |     <t>
323 |      <list>
324 |        <t>size[4] Tattach tag[2] fid[4] afid[4] uname[s] aname[s] n_uname[4]</t>
325 |        <t>size[4] Rattach tag[2] qid[13]</t>
326 |        <t>size[4] Tauth tag[2] afid[4] uname[s] aname[s] n_uname[4]</t>
327 |        <t>size[4] Rauth tag[2] aqid[13]</t>
328 |      </list>
329 |     </t>
330 |     <t>
331 | DESCRIPTION
332 | </t>
333 |     <t>
334 |      <list>
335 |       <t>
336 | 	A numeric uname field has been added to the attach and auth messages
337 | 	in order to provide hints to map a string to a numeric id if such
338 | 	a facility is not available.
339 | 	
340 | 	The numeric uname should be given preference over the uname string
341 | 	unless n_uname is unspecified (~0).
342 |       </t>
343 |      </list>
344 |     </t>
345 |    </section>
346 |    
347 | <section title="open, create - prepare a fid for I/O on an existing or new file">
348 |     <t>
349 |      SYNOPSIS
350 | </t>
351 |     <t>
352 |      <list>
353 |       <t>
354 |           size[4] Tcreate tag[2] fid[4] name[s] perm[4] mode[1] extension[s]
355 |    </t>
356 |       <t>
357 |         size[4] Rcreate tag[2] qid[13] iounit[4]
358 | </t>
359 |      </list>
360 |     </t>
361 |     <t>
362 |      DESCRIPTION
363 | </t>
364 |     <t>
365 |      <list>
366 |       <t>
367 |       The most signifigant change to the create operation is the new
368 |       permission modes which allow for creation of special files.
369 |       In addition to creating directories with DMDIR, 9P2000.u allows
370 |       the creation of symlinks (DMSYMLINK), devices (DMDEVICE), 
371 |       named pipes (DMNAMEPIPE), and sockets (DMSOCKET). extension[s] 
372 |       is a string describing special files, depending on the mode bit. 
373 |       For DSYMLINK files, the string is the target of the link. For 
374 |       DMDEVICE files, the string is "b 1 2" for a block device with 
375 |       major 1, minor 2. For normal files, this string is empty.
376 |      </t>
377 |      </list>
378 |     </t>
379 |    </section>
380 | 
381 | <section title="stat, wstat - inquire or change file attributes">
382 |     <t>
383 |      SYNOPSIS
384 | </t>
385 |     <t>
386 |      <list>
387 |       <t>
388 |           size[4] Tstat tag[2] fid[4]
389 | </t>
390 |       <t>
391 |           size[4] Rstat tag[2] stat[n]
392 | </t>
393 |       <t>
394 |           size[4] Twstat tag[2] fid[4] stat[n]
395 | </t>
396 |       <t>
397 |           size[4] Rwstat tag[2]
398 | </t>
399 |      </list>
400 |     </t>
401 |     <t>
402 |      DESCRIPTION
403 | </t>
404 |     <t>
405 |      <list>
406 |       <t>
407 | 	There are four new fields in the stat structure supporting
408 | 	9P2000 extensions - as well as new qid.type
409 | 	bits and mode bits.
410 | </t>
411 |       <t>
412 |        <list>
413 |         <t>
414 |          <list style="hanging">
415 |           <t hangText="size[2]">
416 |            <vspace/>
417 |                total byte count of the following data
418 | </t>
419 |           <t hangText="type[2]">
420 |            <vspace/>
421 |                for kernel use
422 | </t>
423 |           <t hangText="dev[4]">
424 |            <vspace/>
425 |                for kernel use
426 | </t>
427 |           <t hangText="qid.type[1]">
428 |            <vspace/>
429 |                the type of the file (directory, etc.), represented as
430 |                a bit vector corresponding to the high 8 bits of the
431 |                file's mode word.
432 | </t>
433 |           <t hangText="qid.vers[4]">
434 |            <vspace/>
435 |                version number for given path
436 | </t>
437 |           <t hangText="qid.path[8]">
438 |            <vspace/>
439 |                the file server's unique identification for the file
440 | </t>
441 |           <t hangText="mode[4]">
442 |            <vspace/>
443 |                permissions and flags
444 | </t>
445 |           <t hangText="atime[4]">
446 |            <vspace/>
447 |                last access time
448 | </t>
449 |           <t hangText="mtime[4]">
450 |            <vspace/>
451 |                last modification time
452 | </t>
453 |           <t hangText="length[8]">
454 |            <vspace/>
455 |                length of file in bytes
456 | </t>
457 |           <t hangText="name[ s ]">
458 |            <vspace/>
459 |                file name; must be / if the file is the root directory
460 |                of the server
461 | </t>
462 |           <t hangText="uid[ s ]">
463 |            <vspace/>
464 |                owner name
465 | </t>
466 |           <t hangText="gid[ s ]">
467 |            <vspace/>
468 |                group name
469 | </t>
470 |           <t hangText="muid[ s ]">
471 |            <vspace/>
472 |                name of the user who last modified the file
473 | </t>
474 |           <t hangText="extension[ s ]">
475 |            <vspace/>
476 |                For use by the UNIX extension to store data about
477 | 	       special files (links, devices, pipes, etc.)
478 | </t>
479 |           <t hangText="n_uid[4]">
480 |            <vspace/>
481 |                numeric id of the user who owns the file
482 | </t>
483 |           <t hangText="n_gid[4]">
484 |            <vspace/>
485 |                numeric id of the group associated with the file
486 | </t>
487 |           <t hangText="n_muid[4]">
488 |            <vspace/>
489 |                numeric id of the user who last modified the file
490 | </t>
491 | 
492 |          </list>
493 |         </t>
494 |        </list>
495 |       </t>
496 |       <t><vspace/>
497 | 	The n_uid, n_gid, and n_muid are numeric hints that clients
498 | 	may use to map numeric ids when a string to numeric id mapping
499 | 	facility is not available.
500 |       </t>
501 |       <t><vspace/>
502 | 	extension[s] is a string describing special files, depending on the
503 | 	mode bit.  For DSYMLINK files, the string is the target of the link.
504 | 	For DMDEVICE files, the string is "b 1 2" for a block device with 
505 | 	major 1, minor 2.   For normal files, this string is empty.
506 |       </t>
507 |       </list>
508 |       </t>
509 |    </section>
510 | </section>
511 | 
512 |   <section title="Security Considerations">
513 |    <t>TODO: Talk about specific security considerations of 9P under
514 |    UNIX, specifically about the different auth models <xref target="P9SEC" /></t>
515 |   </section>
516 |   <section title="Protocol Definition Differences">
517 | <figure>
518 | <artwork>
519 | /* permissions */
520 | enum {
521 |         DMDIR =            0x80000000,
522 |         DMAPPEND =         0x40000000,
523 |         DMEXCL =           0x20000000,
524 |         DMMOUNT =          0x10000000,
525 |         DMAUTH =           0x08000000,
526 |         DMTMP =            0x04000000,
527 |         DMSYMLINK =        0x02000000,
528 |         /* 9P2000.u extensions */
529 |         DMDEVICE =         0x00800000,
530 |         DMNAMEDPIPE =      0x00200000,
531 |         DMSOCKET =         0x00100000,
532 |         DMSETUID =         0x00080000,
533 |         DMSETGID =         0x00040000,
534 | };
535 | 
536 | /* qid.types */
537 | enum {
538 |         QTDIR =            0x80,
539 |         QTAPPEND =         0x40,
540 |         QTEXCL =           0x20,
541 |         QTMOUNT =          0x10,
542 |         QTAUTH =           0x08,
543 |         QTTMP =	           0x04,
544 |         QTLINK =           0x02,
545 |         QTFILE =           0x00,
546 | };
547 | struct v9fs_stat {
548 |         uint16_t size;
549 |         uint16_t type;
550 |         uint32_t dev;
551 |         struct v9fs_qid qid;
552 |         uint32_t mode;
553 |         uint32_t atime;
554 |         uint32_t mtime;
555 |         uint64_t length;
556 |         char *name;
557 |         char *uid;
558 |         char *gid;
559 |         char *muid;
560 | /* 9p2000.u extensions */
561 |         char *extension;
562 |         uint32_t n_uid;
563 |         uint32_t n_gid;
564 |         uint32_t n_muid;
565 |      
566 |         char data[0];
567 | };
568 | 
569 | struct Rerror {
570 |         char *error;
571 |         uint32_t errno;         /* 9p2000.u extension */
572 | };
573 | </artwork>
574 | </figure>
575 |   </section>
576 |  </middle>
577 |  <back>
578 |   <references title="Normative References">
579 | 		<reference anchor="PLAN9" target="http://plan9.bell-labs.com/plan9">
580 |     <front>
581 |      <title>Plan 9 Home Page</title>
582 |      <author initials="" surname="Lucent Technologies" fullname="Lucent Technolgoies">
583 |       <organization/>
584 |      </author>
585 |     </front>
586 |    </reference>
587 |    <reference anchor="P9SEC" target="http://plan9.bell-labs.com/sys/doc/auth.html">
588 |     <front>
589 |      <title>Security in Plan 9</title>
590 |      <author initials="R.C." surname="Cox" fullname="Russ Cox">
591 |       <organization>
592 | 				MIT LCS
593 | 			 </organization>
594 |      </author>
595 |      <author initials="E.G." surname="Grosse" fullname="Eric Grosse">
596 |       <organization>
597 | 				Bell Labs
598 | 			 </organization>
599 |      </author>
600 |      <author initials="R.P." surname="Pike" fullname="Rob Pike">
601 |       <organization>
602 | 				Bell Labs
603 | 			 </organization>
604 |      </author>
605 |      <author initials="D.P." surname="Presotto" fullname="Dave Presotto">
606 |       <organization>
607 | 				Avaya Labs and Bell Labs
608 | 			 </organization>
609 |      </author>
610 |      <author initials="S.Q." surname="Quinlan" fullname="Sean Quinlan">
611 |       <organization>
612 | 				Bell Labs
613 | 			 </organization>
614 |      </author>
615 |      <date year="2002" />
616 |     </front>
617 |     <seriesInfo name="Proceedings" value="of the Usenix Security Symposium" />
618 |    </reference>
619 |   </references>
620 |   <section title="Acknowledgements">
621 | <t>
622 | The 9P2000.u protocol extensions evolved out of contributions from a
623 | number of people including:
624 | <list>
625 | 	<t>Abhishek Kilkarni</t>
626 | 	<t>Russ Cox</t>
627 | 	<t>Lachester Ionkov</t>
628 | 	<t>Ron Minnich</t>
629 | 	<t>Andrey Mirtchoviski</t>
630 | 	<t>Rob Pike</t>
631 | 	<t>Eric Van Hensbergen</t>
632 | 	<t>Uriel (Contentious Objector)</t>
633 | </list>
634 | </t>
635 | <t>
636 | The 9P protocol was the result of work done by the Computing Science
637 | Research Center of AT&T Bell Labs (now a part of Lucent Technologies) and in
638 | particular:
639 | <list>
640 |      <t>
641 | Rob Pike</t>
642 |      <t>
643 | Dave Presotto</t>
644 |      <t>
645 | Sape Mullender</t>
646 |      <t>
647 | Ken Thompson</t>
648 |     <t>
649 | Russ Cox
650 | </t>
651 |     </list>
652 |    </t>
653 |   </section>
654 |   <section title="Copyright">
655 |    <t>
656 |   This specification is derrived from the Plan 9 Documentation and Manual Pages.
657 |   The source material is
658 |   Copyright (C) 2003, Lucent Technologies Inc.  and others.  All Rights Reserved.
659 |   </t>
660 |    <t>
661 |   Extensions to the original source material are Copyright (C) 2005, the authors
662 |   of this document (as specified in Authors List in the References section).
663 |   </t>
664 |   </section>
665 |  </back>
666 | </rfc>
667 | 


--------------------------------------------------------------------------------
/9p2000.L.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
  3 | <rfc category="exp" ipr="none" 
  4 | docName="experimental-draft-9p2000.L-protocol"
  5 | updates="experimental-draft-9P2000-protocol">
  6 | <?xml-stylesheet type='text/xsl' href='rfc2629.xslt' ?>
  7 | <?rfc toc="yes" ?>
  8 | <?rfc symrefs="yes" ?>
  9 | <?rfc sortrefs="yes"?>
 10 | <?rfc iprnotified="no" ?>
 11 |  <front>
 12 |   <title abbrev="9p2000.L">Plan 9 Remote Resource Protocol</title>
 13 |   <author initials='E.V.H.' surname="Van Hensbergen" fullname='Eric Van Hensbergen'>
 14 |    <organization>
 15 | 		IBM Research
 16 |    </organization>
 17 |    <address>
 18 |     <email>ericvh@gmail.com</email>
 19 |     <uri>http://www.research.ibm.com/people/b/bergevan</uri>
 20 |    </address>
 21 |   </author>
 22 |   <date month="January" year="2010"/>
 23 |   <area>General</area>
 24 |   <keyword>Plan 9</keyword>
 25 |   <keyword>9P2000</keyword>
 26 |   <keyword>9p2000.L</keyword>
 27 |   <keyword>v9fs</keyword>
 28 |   <keyword>9P</keyword>
 29 |   <abstract>
 30 |    <t>
 31 | 	9P is a distributed resource sharing protocol developed as
 32 | 	part of the Plan 9 research operating system at AT&T Bell
 33 | 	Laboratories (now a part of Lucent Technologies) by the Computer
 34 | 	Science Research Center.  It can be used to distributed file
 35 | 	systems, devices, and application services.  It was designed as
 36 | 	an interface to both local and remote resources, making the
 37 | 	transition from local to cluster to grid resources transparent.
 38 | 	</t>
 39 |    <t>
 40 | 	In my use of 9P within the Linux and IBM communities there have 
 41 | 	been several requests for extensions to better support Linux 
 42 | 	environments or features not currently a part of the protocol 
 43 | 	(locking, caching, batch operations, storage networking, etc.) 
 44 | 	As such, I'd like to work towards a specification of the protocol 
 45 | 	which can accomodate these extensions in as non-intrusive a way as 
 46 | 	possible (the counter-example being 9P2000.u which while negotiated 
 47 | 	ends up complicating clients and servers who wish to use it).
 48 | 	</t>
 49 | 	<t>
 50 |    	9p2000.L is an expanded version of the original protocol with 9P2000
 51 | 	as its core.  Extended operations representing either support for
 52 | 	UNIX environments, or even alternate approaches to the protocol
 53 | 	(such as Op from the Octopus project) exist in complimentary
 54 | 	operand spaces.  It briefly was referenced as the 9p2010 protocol,
 55 |     but this was retracted in form of referencing it as an extension
 56 |     (.L)
 57 | 	</t>
 58 |   </abstract>
 59 |  </front>
 60 |  <middle>
 61 |   <section title="Requirements notation">
 62 |    <t>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL",
 63 | 	    "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",
 64 | 	    and "OPTIONAL" in this document are to be interpreted as
 65 | 	    described in RFC2119.</t>
 66 |   </section>
 67 |   <section anchor="intro" title="Introduction">
 68 | <t>
 69 | Many modern UNIX systems, including Linux use a virtual file system (VFS) 
 70 | layer as a basic level of abstraction for accessing underlying 
 71 | implementations. Implementing 9p2000.L under Linux is a matter of mapping VFS 
 72 | operations to their associated 9P operations. The problem, however, is that 
 73 | 9P2000 was designed for a non-UNIX system so there are several fundamental 
 74 | differences in the functional semantics provided by 9P.
 75 | </t>
 76 | <t>
 77 | To preserve compatibility with these pre-existing features we propose 
 78 | a transparent extension to the file system semantics which minimally effects 
 79 | the protocol syntax.  9p2000.L is a dialect of 9P2000 negotiated in the 
 80 | Tversion/Rversion exchange.  If the server agrees to 9p2000.L, then the wire 
 81 | protocol that follows is 9P2000 with these changes.
 82 | </t>
 83 | <section title="Overview of Differences">
 84 | <section title="Numeric Versus String IDs">
 85 | <t>
 86 | Under Plan 9 <xref target="PLAN9" />, user names as well as groups are represented by strings, while 
 87 | on Unix they are represented by unique numbers. This is complicated by Linux 
 88 | making it exceedingly difficult to map these numeric identifiers to their 
 89 | string values in the kernel. Many of the available UNIX network file systems 
 90 | avoid this issue and simply use numeric identifiers over the wire, hoping they 
 91 | map to the remote system. NFSv4 has provisions for sending string group 
 92 | and user info over the wire and then contacting a user-space daemon which 
 93 | attempts to provide a valid mapping.
 94 | </t>
 95 | <t>
 96 | 9p2000.L provides a dual approach to this problem, changes have been made
 97 | to the protocol to allow for numeric identifiers to be used along-side
 98 | strings.  Servers should make every attempt to provide valid information
 99 | for both the numeric and string form of identifiers.  Clients can then use
100 | the available information to best map the identifiers to their local
101 | environment.  Use of extended form string user names (e.g. user@domain)
102 | as specified in the NFSv4 environment is also valid.
103 | </t>
104 | </section>
105 | <section title="Error Strings Versus Error Codes">
106 | <t>
107 | A similar problem exists for error numbers, by default VFS operations 
108 | return error numbers, whereas Plan 9 (and 9P) use error strings to 
109 | describe failure conditions.  This problem is further exacerbated by 
110 | the potential for Plan 9 synthetic file servers to return custom error
111 | strings which may not match any pre-defined set (or pattern) of 
112 | standard error messages.
113 | </t>
114 | <t>
115 | Again, our approach is to provide as much information as possible in
116 | order to help clients properly convey error conditions to end-applications
117 | and end-users.  As such both error strings and error codes are conveyed in
118 | the 9p2000.L version of the protocol.  A suggested implementation is that
119 | non-standard/unrecognized error strings/codes be made available to
120 | applications via some mechanism in order to communicate application
121 | synthetic file system events (via sysfs or procfs in Linux, or perhaps
122 | via a special extended attribute).
123 | </t>
124 | </section>
125 | <section title="Permission Modes">
126 | <t>
127 | Plan 9 has a different user security model <xref target="P9SEC"/>, so there 
128 | is no such concept as set-uid or set-gid permissions.  There is also no 
129 | equivalent for the sticky bit.  Luckily, Plan 9 has plenty of space in 
130 | higher permission mode bit space for such extensions.
131 | </t>
132 | </section>
133 | <section title="Special Files and Links">
134 | <t>
135 | One of the unique aspects of the Plan 9 name space is that it is dynamic. 
136 | Users are able to bind files and directories over each other in stackable 
137 | layers similar to union file systems. This aspect of Plan 9 name spaces has 
138 | obviated the need for symbolic or hard links. Symlinks on a remote UNIX file 
139 | server will be traversed transparently as part of a walk - there is no native 
140 | ability within Plan 9 to create symlinks. This breaks many assumptions for 
141 | Linux file-systems and many existing applications (for example the kernel 
142 | build creates a symlink in the include directory as part of the make process).
143 | </t>
144 | <t>
145 | Another unique aspect is that named pipes and devices look just like other
146 | files in Plan 9, there are no special mode bits and no concept of major
147 | and minor block numbers.
148 | </t>
149 | <t>
150 | To solve both of these problems special mode bits are introduced to mark
151 | special file types and a variable-length string field is added to the
152 | file attribute structure which is used to store the additional information
153 | associated with these special files.  In the case of symlinks, for instance,
154 | the variable length string contains the full path target of the symbolic
155 | link.
156 | </t>
157 | </section>
158 | <section title="ioctl">
159 | <t>
160 | A VFS function not accounted for in the 9P infrastructure is the ioctl
161 | command.  No attempt has been made at this time to accomodate its
162 | functionality.  Plan 9 has traditionally used elements within a synthetic
163 | file system to provide for similar functionality, with the added benefit of
164 | getting transparent network distribution of the control path.  For such
165 | devices/files that still require the use of ioctl, gateway synthetic file
166 | systems are suggested to provide analogous functionality.
167 | </t>
168 | </section>
169 | <section title="Extended Attributes">
170 | <t>
171 | A relatively recent addition to VFS interfaces is the ability to have
172 | arbitrary key/value pairs added to file meta-data.  9p2000.L doesn't
173 | have provisions to accomodate this feature, but it may be added in the
174 | future as more file systems adopt extended attributes.
175 | </t>
176 | </section>
177 | </section>
178 |    <section anchor="msgs" title="Changed Messages">
179 |     <t>
180 |      <list style="empty">
181 |       <t>
182 |       size[4] Tversion tag[2] msize[4] version[s]
183 |    </t>
184 |       <t>
185 |       size[4] Rversion tag[2] msize[4] version[s]
186 |    </t>
187 |       <t>
188 |        <vspace/>
189 |       size[4] Rerror tag[2] ename[s] errno[4]
190 |    </t>
191 | <t>
192 | <vspace/>
193 | size[4] Tauth tag[2] afid[4] uname[s] aname[s]
194 | </t>
195 | <t>
196 | size[4] Rauth tag[2] aqid[13]
197 | </t>
198 | <t>
199 | <vspace/>
200 | size[4] Tattach tag[2] fid[4] afid[4] uname[s] aname[s]
201 | </t>
202 | <t>
203 | size[4] Rattach tag[2] qid[13]
204 | </t>
205 | <t>
206 | <vspace/>
207 | size[4] Tcreate tag[2] fid[4] name[s] perm[4] mode[1] extension[s]
208 | </t>
209 | <t>
210 | size[4] Rcreate tag[2] qid[13] iounit[4]
211 | </t>
212 |       <t>
213 |        <vspace/>
214 |       size[4] Tstat tag[2] fid[4]
215 |    </t>
216 |       <t>
217 |       size[4] Rstat tag[2] stat[n]
218 |    </t>
219 |       <t>
220 |        <vspace/>
221 |       size[4] Twstat tag[2] fid[4] stat[n]
222 |    </t>
223 |       <t>
224 |       size[4] Rwstat tag[2]
225 |    </t>
226 |      </list>
227 |     </t>
228 |    </section>
229 |   </section>
230 |   <section title="Protocol Data Types">
231 |    <section title="Changed Basic Data Types">
232 |     <t> TODO: cover changed data types in our protocol synopsis</t>
233 |    </section>
234 |    <section title="Changed Structured Data Types">
235 |     <t> TODO: cover changed structs (like stat) that the protocol uses</t>
236 |    </section>
237 |   </section>
238 |   <section title = "Changed File Attributes">
239 |    <t>TODO: discuss changes</t>
240 |   </section>
241 |   <section title = "Versioning">
242 |    <t>TODO: describe protocol versioning in detail (steal from Protocol section)</t>
243 |   </section>
244 |   <section title = "Error Definitions">
245 |    <t>TODO: enumerate new standard file system error strings and describe 
246 |    possibility of application error strings</t>
247 |   </section>
248 |   <section anchor="protocol" title="Changed Protocol Operations">
249 |    <section anchor="version" title="version - negotiate protocol version">
250 |     <t>
251 | SYNOPSIS
252 | </t>
253 |     <t>
254 |      <list style="empty">
255 |       <t>size[4] Tversion tag[2] msize[4] version[s]</t>
256 |       <t>size[4] Rversion tag[2] msize[4] version[s]</t>
257 |      </list>
258 |     </t>
259 |     <t>
260 | DESCRIPTION
261 | </t>
262 |     <t>
263 |      <list style="empty">
264 |       <t>
265 | 	Support for 9p2000.L is an optional extension which isn't
266 | 	quite covered in the existing version semantics for 9P2000.
267 | 	The original protocol specification describes discarding
268 | 	anything after an initial period in the version string.  We
269 | 	use the information following the period as a method for
270 | 	negotiating optional protocol extensions.
271 |      </t>
272 |      <t><vspace/>
273 | 	If a client desires support for the UNIX extensions, it will
274 | 	send the add a .u to the end of the version string (e.g. 9p2000.L).
275 | 	If a server is capable of supporting the extension, it will
276 | 	return 9p2000.L back to the client.  If the server is incapable
277 | 	or unwilling to support the extensions, it will return the
278 | 	version string without the extension specification (e.g. 9P2000).
279 |      </t>
280 |      <t><vspace/>
281 | 	Clients should be implemented in such a way to be able to operate
282 | 	without the extensions in some degraded form of operation.  
283 | 	Specifics for how to gracefully degrade operation without 
284 | 	specific extensions are suggested by this document.
285 |      </t>
286 |      </list>
287 |     </t>
288 |    </section>
289 | 
290 | <section title="error - return an error">
291 |     <t>
292 | SYNOPSIS
293 | </t>
294 |     <t>
295 |      <list>
296 |       <t>
297 |        size[4] Rerror tag[2] ename[s] errno[4]
298 | </t>
299 |      </list>
300 |     </t>
301 |     <t>
302 | DESCRIPTION
303 | </t>
304 |     <t>
305 |      <list>
306 |       <t>
307 | 	An errno field has been added to the message in order to provide
308 | 	a hint of the underlying UNIX error number which caused the error
309 | 	on the server.  Due to consistency problems of mapping error
310 | 	numbers betweeen different versions of UNIX, clients should give
311 | 	preference to the error string in attempting to report the error,
312 | 	however, in the event that they are unable to map an error string,
313 | 	they may return the errno to the application.
314 |       </t>
315 |       <t><vspace/>
316 | 	A special errno (ERRUNDEF) is returned by servers who do not wish
317 | 	to return raw error numbers.  In the event that clients can not 
318 | 	interpret the error string, they should somehow make the error
319 | 	string available to end-application/end-user via dynamic custom
320 | 	error codes.
321 |       </t>
322 |      </list>
323 |     </t>
324 |    </section>
325 | 
326 | <section title="auth/attach - messages to establish a connection">
327 |     <t>
328 | SYNOPSIS
329 | </t>
330 |     <t>
331 |      <list>
332 |        <t>size[4] Tattach tag[2] fid[4] afid[4] uname[s] aname[s] n_uname[4]</t>
333 |        <t>size[4] Rattach tag[2] qid[13]</t>
334 |        <t>size[4] Tauth tag[2] afid[4] uname[s] aname[s] n_uname[4]</t>
335 |        <t>size[4] Rauth tag[2] aqid[13]</t>
336 |      </list>
337 |     </t>
338 |     <t>
339 | DESCRIPTION
340 | </t>
341 |     <t>
342 |      <list>
343 |       <t>
344 | 	A numeric uname field has been added to the attach and auth messages
345 | 	in order to provide hints to map a string to a numeric id if such
346 | 	a facility is not available.
347 | 	
348 | 	The numeric uname should be given preference over the uname string
349 | 	unless n_uname is unspecified (~0).
350 |       </t>
351 |      </list>
352 |     </t>
353 |    </section>
354 |    
355 | <section title="open, create - prepare a fid for I/O on an existing or new file">
356 |     <t>
357 |      SYNOPSIS
358 | </t>
359 |     <t>
360 |      <list>
361 |       <t>
362 |           size[4] Tcreate tag[2] fid[4] name[s] perm[4] mode[1] extension[s]
363 |    </t>
364 |       <t>
365 |         size[4] Rcreate tag[2] qid[13] iounit[4]
366 | </t>
367 |      </list>
368 |     </t>
369 |     <t>
370 |      DESCRIPTION
371 | </t>
372 |     <t>
373 |      <list>
374 |       <t>
375 |       The most signifigant change to the create operation is the new
376 |       permission modes which allow for creation of special files.
377 |       In addition to creating directories with DMDIR, 9p2000.L allows
378 |       the creation of symlinks (DMSYMLINK), devices (DMDEVICE), 
379 |       named pipes (DMNAMEPIPE), and sockets (DMSOCKET). extension[s] 
380 |       is a string describing special files, depending on the mode bit. 
381 |       For DSYMLINK files, the string is the target of the link. For 
382 |       DMDEVICE files, the string is "b 1 2" for a block device with 
383 |       major 1, minor 2. For normal files, this string is empty.
384 |      </t>
385 |      </list>
386 |     </t>
387 |    </section>
388 | 
389 | <section title="stat, wstat - inquire or change file attributes">
390 |     <t>
391 |      SYNOPSIS
392 | </t>
393 |     <t>
394 |      <list>
395 |       <t>
396 |           size[4] Tstat tag[2] fid[4]
397 | </t>
398 |       <t>
399 |           size[4] Rstat tag[2] stat[n]
400 | </t>
401 |       <t>
402 |           size[4] Twstat tag[2] fid[4] stat[n]
403 | </t>
404 |       <t>
405 |           size[4] Rwstat tag[2]
406 | </t>
407 |      </list>
408 |     </t>
409 |     <t>
410 |      DESCRIPTION
411 | </t>
412 |     <t>
413 |      <list>
414 |       <t>
415 | 	There are four new fields in the stat structure supporting
416 | 	9P2000 extensions - as well as new qid.type
417 | 	bits and mode bits.
418 | </t>
419 |       <t>
420 |        <list>
421 |         <t>
422 |          <list style="hanging">
423 |           <t hangText="size[2]">
424 |            <vspace/>
425 |                total byte count of the following data
426 | </t>
427 |           <t hangText="type[2]">
428 |            <vspace/>
429 |                for kernel use
430 | </t>
431 |           <t hangText="dev[4]">
432 |            <vspace/>
433 |                for kernel use
434 | </t>
435 |           <t hangText="qid.type[1]">
436 |            <vspace/>
437 |                the type of the file (directory, etc.), represented as
438 |                a bit vector corresponding to the high 8 bits of the
439 |                file's mode word.
440 | </t>
441 |           <t hangText="qid.vers[4]">
442 |            <vspace/>
443 |                version number for given path
444 | </t>
445 |           <t hangText="qid.path[8]">
446 |            <vspace/>
447 |                the file server's unique identification for the file
448 | </t>
449 |           <t hangText="mode[4]">
450 |            <vspace/>
451 |                permissions and flags
452 | </t>
453 |           <t hangText="atime[4]">
454 |            <vspace/>
455 |                last access time
456 | </t>
457 |           <t hangText="mtime[4]">
458 |            <vspace/>
459 |                last modification time
460 | </t>
461 |           <t hangText="length[8]">
462 |            <vspace/>
463 |                length of file in bytes
464 | </t>
465 |           <t hangText="name[ s ]">
466 |            <vspace/>
467 |                file name; must be / if the file is the root directory
468 |                of the server
469 | </t>
470 |           <t hangText="uid[ s ]">
471 |            <vspace/>
472 |                owner name
473 | </t>
474 |           <t hangText="gid[ s ]">
475 |            <vspace/>
476 |                group name
477 | </t>
478 |           <t hangText="muid[ s ]">
479 |            <vspace/>
480 |                name of the user who last modified the file
481 | </t>
482 |           <t hangText="extension[ s ]">
483 |            <vspace/>
484 |                For use by the UNIX extension to store data about
485 | 	       special files (links, devices, pipes, etc.)
486 | </t>
487 |           <t hangText="n_uid[4]">
488 |            <vspace/>
489 |                numeric id of the user who owns the file
490 | </t>
491 |           <t hangText="n_gid[4]">
492 |            <vspace/>
493 |                numeric id of the group associated with the file
494 | </t>
495 |           <t hangText="n_muid[4]">
496 |            <vspace/>
497 |                numeric id of the user who last modified the file
498 | </t>
499 | 
500 |          </list>
501 |         </t>
502 |        </list>
503 |       </t>
504 |       <t><vspace/>
505 | 	The n_uid, n_gid, and n_muid are numeric hints that clients
506 | 	may use to map numeric ids when a string to numeric id mapping
507 | 	facility is not available.
508 |       </t>
509 |       <t><vspace/>
510 | 	extension[s] is a string describing special files, depending on the
511 | 	mode bit.  For DSYMLINK files, the string is the target of the link.
512 | 	For DMDEVICE files, the string is "b 1 2" for a block device with 
513 | 	major 1, minor 2.   For normal files, this string is empty.
514 |       </t>
515 |       </list>
516 |       </t>
517 |    </section>
518 | </section>
519 | 
520 |   <section title="Security Considerations">
521 |    <t>TODO: Talk about specific security considerations of 9P under
522 |    UNIX, specifically about the different auth models <xref target="P9SEC" /></t>
523 |   </section>
524 |   <section title="Protocol Definition Differences">
525 | <figure>
526 | <artwork>
527 | /* permissions */
528 | enum {
529 |         DMDIR =            0x80000000,
530 |         DMAPPEND =         0x40000000,
531 |         DMEXCL =           0x20000000,
532 |         DMMOUNT =          0x10000000,
533 |         DMAUTH =           0x08000000,
534 |         DMTMP =            0x04000000,
535 |         DMSYMLINK =        0x02000000,
536 |         /* 9p2000.L extensions */
537 |         DMDEVICE =         0x00800000,
538 |         DMNAMEDPIPE =      0x00200000,
539 |         DMSOCKET =         0x00100000,
540 |         DMSETUID =         0x00080000,
541 |         DMSETGID =         0x00040000,
542 | };
543 | 
544 | /* qid.types */
545 | enum {
546 |         QTDIR =            0x80,
547 |         QTAPPEND =         0x40,
548 |         QTEXCL =           0x20,
549 |         QTMOUNT =          0x10,
550 |         QTAUTH =           0x08,
551 |         QTTMP =	           0x04,
552 |         QTLINK =           0x02,
553 |         QTFILE =           0x00,
554 | };
555 | struct v9fs_stat {
556 |         uint16_t size;
557 |         uint16_t type;
558 |         uint32_t dev;
559 |         struct v9fs_qid qid;
560 |         uint32_t mode;
561 |         uint32_t atime;
562 |         uint32_t mtime;
563 |         uint64_t length;
564 |         char *name;
565 |         char *uid;
566 |         char *gid;
567 |         char *muid;
568 | /* 9p2000.u extensions */
569 |         char *extension;
570 |         uint32_t n_uid;
571 |         uint32_t n_gid;
572 |         uint32_t n_muid;
573 |      
574 |         char data[0];
575 | };
576 | 
577 | struct Rerror {
578 |         char *error;
579 |         uint32_t errno;         /* 9p2000.u extension */
580 | };
581 | </artwork>
582 | </figure>
583 |   </section>
584 |  </middle>
585 |  <back>
586 |   <references title="Normative References">
587 | 		<reference anchor="PLAN9" target="http://plan9.bell-labs.com/plan9">
588 |     <front>
589 |      <title>Plan 9 Home Page</title>
590 |      <author initials="" surname="Lucent Technologies" fullname="Lucent Technolgoies">
591 |       <organization/>
592 |      </author>
593 |     </front>
594 |    </reference>
595 |    <reference anchor="P9SEC" target="http://plan9.bell-labs.com/sys/doc/auth.html">
596 |     <front>
597 |      <title>Security in Plan 9</title>
598 |      <author initials="R.C." surname="Cox" fullname="Russ Cox">
599 |       <organization>
600 | 				MIT LCS
601 | 			 </organization>
602 |      </author>
603 |      <author initials="E.G." surname="Grosse" fullname="Eric Grosse">
604 |       <organization>
605 | 				Bell Labs
606 | 			 </organization>
607 |      </author>
608 |      <author initials="R.P." surname="Pike" fullname="Rob Pike">
609 |       <organization>
610 | 				Bell Labs
611 | 			 </organization>
612 |      </author>
613 |      <author initials="D.P." surname="Presotto" fullname="Dave Presotto">
614 |       <organization>
615 | 				Avaya Labs and Bell Labs
616 | 			 </organization>
617 |      </author>
618 |      <author initials="S.Q." surname="Quinlan" fullname="Sean Quinlan">
619 |       <organization>
620 | 				Bell Labs
621 | 			 </organization>
622 |      </author>
623 |      <date year="2002" />
624 |     </front>
625 |     <seriesInfo name="Proceedings" value="of the Usenix Security Symposium" />
626 |    </reference>
627 |   </references>
628 |   <section title="Acknowledgements">
629 | <t>
630 | The 9p2000.L protocol extensions evolved out of contributions from a
631 | number of people including:
632 | <list>
633 | 	<t>Abhishek Kilkarni</t>
634 | 	<t>Russ Cox</t>
635 | 	<t>Lachester Ionkov</t>
636 | 	<t>Ron Minnich</t>
637 | 	<t>Andrey Mirtchoviski</t>
638 | 	<t>Rob Pike</t>
639 | 	<t>Eric Van Hensbergen</t>
640 | 	<t>Uriel (Contentious Objector)</t>
641 | </list>
642 | </t>
643 | <t>
644 | The 9P protocol was the result of work done by the Computing Science
645 | Research Center of AT&T Bell Labs (now a part of Lucent Technologies) and in
646 | particular:
647 | <list>
648 |      <t>
649 | Rob Pike</t>
650 |      <t>
651 | Dave Presotto</t>
652 |      <t>
653 | Sape Mullender</t>
654 |      <t>
655 | Ken Thompson</t>
656 |     <t>
657 | Russ Cox
658 | </t>
659 |     </list>
660 |    </t>
661 |   </section>
662 |   <section title="Copyright">
663 |    <t>
664 |   This specification is derrived from the Plan 9 Documentation and Manual Pages.
665 |   The source material is
666 |   Copyright (C) 2003, Lucent Technologies Inc.  and others.  All Rights Reserved.
667 |   </t>
668 |    <t>
669 |   Extensions to the original source material are Copyright (C) 2010, the authors
670 |   of this document (as specified in Authors List in the References section).
671 |   </t>
672 |   </section>
673 |  </back>
674 | </rfc>
675 | 


--------------------------------------------------------------------------------
/tool/README.xml:
--------------------------------------------------------------------------------
  1 | <?xml version='1.0'?>
  2 | <!DOCTYPE rfc SYSTEM 'rfc2629.dtd'>
  3 | 
  4 | <?rfc comments='yes'?>
  5 | <?rfc docmapping='yes'?>
  6 | <?rfc inline='no'?>
  7 | <?rfc compact='no'?>
  8 | <?rfc editing='no'?>
  9 | <?rfc header='README'?>
 10 | <?rfc private='The README file'?>
 11 | <?rfc subcompact='no'?>
 12 | <?rfc symrefs='no'?>
 13 | <?rfc toc='yes'?>
 14 | <?rfc tocappendix='no'?>
 15 | <?rfc tocindent='no'?>
 16 | 
 17 | <rfc>
 18 | <front>
 19 | <title>xml2rfc v1.33</title>
 20 | 
 21 | <author initials='M.T.' surname='Rose' fullname='Marshall T. Rose'>
 22 | <organization>Dover Beach Consulting, Inc.</organization>
 23 | 
 24 | <address>
 25 | <postal>
 26 | <street>POB 255268</street>
 27 | <city>Sacramento</city> <region>CA</region> <code>95865-5268</code>
 28 | <country>US</country>
 29 | </postal>
 30 | 
 31 | <phone>+1 916 483 8878</phone>
 32 | <email>mrose@dbc.mtview.ca.us</email>
 33 | </address>
 34 | </author>
 35 | 
 36 | <author fullname="Bill Fenner" initials="B." surname="Fenner">
 37 | <organization>AT&amp;T Labs - Research</organization>
 38 | <address>
 39 | <postal>
 40 | <street>1 River Oaks Place</street>
 41 | <city>San Jose</city>
 42 | <region>CA</region>
 43 | <code>95134-1918</code>
 44 | <country>US</country>
 45 | </postal>
 46 | <phone>+1 408 493-8505</phone>
 47 | <email>fenner@research.att.com</email>
 48 | </address>
 49 | </author>
 50 | 
 51 | <author initials='C.' surname='Levert' fullname='Charles Levert'>
 52 | <organization/>
 53 | <address>
 54 | <postal>
 55 | <street/>
 56 | <city>Montr&eacute;al</city>
 57 | <region>QC</region>
 58 | <country>Canada</country>
 59 | </postal>
 60 | <email>charles.levert@gmail.com</email>
 61 | </address>
 62 | </author>
 63 | 
 64 | <date month='February' year='2008' />
 65 | </front>
 66 | 
 67 | <middle>
 68 | <section title='Introduction'>
 69 | <t>This is a package to convert memos written in XML to the RFC format.</t>
 70 | 
 71 | <t>If you don't want to install any software,
 72 | you can use the
 73 | <eref target='http://xml.resource.org/'>web-based service</eref>.</t>
 74 | </section>
 75 | 
 76 | <section title='Requirements'>
 77 | <t>You need to have Tcl/Tk version&nbsp;8 running on your system.
 78 | Tcl is a scripting language,
 79 | Tk is Tcl with support for your windowing system.</t>
 80 | 
 81 | <t>To get a source or binary distribution for your system,
 82 | go to the
 83 | <eref target='http://www.tcl.tk/software/tcltk/8.4.html'>Tcl Developer Xchange website</eref>
 84 | and install it.
 85 | If you get the binary distribution,
 86 | this is pretty simple.</t>
 87 | 
 88 | <figure>
 89 | <preamble>Of course,
 90 | you may already have Tcl version&nbsp;8.
 91 | To find out,
 92 | try typing this command from the shell
 93 | (or the &ldquo;MS-DOS Prompt&rdquo;):</preamble>
 94 | <artwork>
 95 |     % tclsh
 96 | </artwork>
 97 | <postamble>If the program launches,
 98 | you're good to go with Tcl version&nbsp;8.</postamble>
 99 | </figure>
100 | 
101 | <figure>
102 | <preamble>If you are running under a windowing system (e.g., X or MS-Windows),
103 | you can also try:</preamble>
104 | <artwork>
105 |     % wish
106 | </artwork>
107 | <postamble>If a new window comes up along with a &ldquo;Console&rdquo; window,
108 | then you're good to go with Tk version&nbsp;8.</postamble>
109 | </figure>
110 | 
111 | <t>Finally,
112 | you may notice a file called <spanx style='verb'>xml2sgml.tcl</spanx>
113 | in the distribution.
114 | It contains some extra functionality for a few special users &mdash;
115 | so, if you don't know what it is, don't worry about it...</t>
116 | </section>
117 | 
118 | <section title='Testing'>
119 | <t>Now test your installation.</t>
120 | 
121 | <section title='Testing under a windowing system'>
122 | <figure>
123 | <preamble>Type this command from the shell:</preamble>
124 | <artwork>
125 |     % xml2rfc.tcl
126 | </artwork>
127 | </figure>
128 | 
129 | <figure>
130 | <preamble>A new window should come up that looks like this:</preamble>
131 | <artwork align='center' src='xml2rfc-win.png'
132 |                         alt='[&ldquo;Convert XML to RFC&rdquo; window]'
133 |                         width='486' height='174'>
134 | +------------------------------------------------------------+
135 | |                     Convert XML to RFC                     |
136 | |                                                            |
137 | |  Select input file: ____________________________  [Browse] |
138 | |                                                            |
139 | | Select output file: ____________________________  [Browse] |
140 | |                                                            |
141 | |               [Convert]               [Quit]               |
142 | |                                                            |
143 | +------------------------------------------------------------+
144 | </artwork>
145 | <postamble>Fill-in the blanks and click on [Convert].</postamble>
146 | </figure>
147 | </section>
148 | 
149 | <section title='Testing without a windowing system'>
150 | <figure>
151 | <preamble>Type this command from the shell:</preamble>
152 | <artwork>
153 |     % tclsh
154 | </artwork>
155 | </figure>
156 | 
157 | <figure>
158 | <preamble>If the program launches, type this command to it:</preamble>
159 | <artwork>
160 |     % source xml2rfc.tcl
161 | </artwork>
162 | </figure>
163 | 
164 | <figure>
165 | <preamble>and you should see these five lines:</preamble>
166 | <artwork>
167 |     invoke as "xml2rfc   input-file output-file"
168 |            or "xml2txt   input-file"
169 |            or "xml2html  input-file"
170 |            or "xml2nroff input-file"
171 |            or "xml2unpg  input-file"
172 | </artwork>
173 | </figure>
174 | </section>
175 | </section>
176 | 
177 | <section title='Next steps'>
178 | <t>Read the <eref target='draft-mrose-writing-rfcs.html'>2629bis</eref>
179 | document.
180 | In particular,
181 | <eref target='draft-mrose-writing-rfcs.html#anchor13'>Section&nbsp;3</eref>
182 | has some good information.</t>
183 | 
184 | <section anchor='processing.instructions' title='Processing Instructions'>
185 | <figure>
186 | <preamble>A <spanx style='emph'>processing instruction</spanx> contains
187 | directives to an XML application.
188 | If you want to give directives to <spanx style='strong'>xml2rfc</spanx>,
189 | the processing instructions (PIs) look like this:</preamble>
190 | <artwork>
191 |     &lt;?rfc keyword='value'?&gt;
192 | </artwork>
193 | <postamble>Of course,
194 | if you like the default behavior,
195 | you don't need any behavior-modifying directives in your input file!
196 | Although <spanx style='strong'>xml2rfc</spanx>
197 | supports putting several attribute-like directives in one PI,
198 | be warned that
199 | <xref target='rfc2629.xslt'>rfc2629.xslt</xref>
200 | does not support it and that there are issues in
201 | doing this for a non-include-file directive following an
202 | <xref target='include.file.facility'>include-file directive</xref>.
203 | It is good practice to always surround the value with either
204 | single or double quotes.</postamble>
205 | </figure>
206 | 
207 | <section title='Option Settings'>
208 | <texttable align='left'>
209 | <preamble>The list of valid keywords are:</preamble>
210 | 
211 | <ttcol align='right'>keyword</ttcol>
212 | <ttcol align='center'>default</ttcol>
213 | <ttcol align='left'>meaning</ttcol>
214 | 
215 | <c>artworkdelimiter</c>
216 | <c>""</c>
217 | <c>when producing txt or nroff files, use this string to delimit artwork</c>
218 | 
219 | <c>artworklines</c>
220 | <c>0</c>
221 | <c>when producing txt or nroff files, add this many blank lines around artwork</c>
222 | 
223 | <c>authorship</c>
224 | <c>yes</c>
225 | <c>render author information</c>
226 | 
227 | <c>autobreaks</c>
228 | <c>yes</c>
229 | <c>automatically force page breaks to avoid widows and orphans (not perfect)</c>
230 | 
231 | <c>background</c>
232 | <c>""</c>
233 | <c>when producing a html file, use this image</c>
234 | 
235 | <c>colonspace</c>
236 | <c>no</c>
237 | <c>put two spaces instead of one after each colon (&ldquo;:&rdquo;) in txt or nroff files</c>
238 | 
239 | <c>comments</c>
240 | <c>no</c>
241 | <c>render &lt;cref&gt; information</c>
242 | 
243 | <c>compact</c>
244 | <c>(rfcedstyle)</c>
245 | <c>when producing a txt/nroff file, try to conserve vertical whitespace
246 | (the default value is the current value of the rfcedstyle PI)</c>
247 | 
248 | <c>docmapping</c>
249 | <c>no</c>
250 | <c>use hierarchical tags (e.g., &lt;h1>, &lt;h2>, etc.)
251 | for (sub)section titles</c>
252 | 
253 | <c>editing</c>
254 | <c>no</c>
255 | <c>insert editing marks for ease of discussing draft versions</c>
256 | 
257 | <c>emoticonic</c>
258 | <c>no</c>
259 | <c>automatically replaces input sequences such as
260 | <spanx style='verb'>|*text|</spanx> by, e.g.,
261 | <spanx style='verb'>&lt;strong&gt;text&lt;/strong&gt;</spanx>
262 | in html output</c>
263 | 
264 | <c>footer</c>
265 | <c>""</c>
266 | <c>override the center footer string</c>
267 | 
268 | <c>header</c>
269 | <c>""</c>
270 | <c>override the leftmost header string</c>
271 | 
272 | <c>include</c>
273 | <c>n/a</c>
274 | <c>see <xref target='include.file.facility' /></c>
275 | 
276 | <c>inline</c>
277 | <c>no</c>
278 | <c>if comments is "yes",
279 | then render comments inline;
280 | otherwise render them in an &ldquo;Editorial Comments&rdquo; section</c>
281 | 
282 | <c>iprnotified</c>
283 | <c>no</c>
284 | <c>include boilerplate from Section&nbsp;10.4(d) of <xref target='RFC2026' /></c>
285 | 
286 | <c>linkmailto</c>
287 | <c>yes</c>
288 | <c>generate mailto: URL, as appropriate</c>
289 | 
290 | <c>notedraftinprogress</c>
291 | <c>yes</c>
292 | <c>generates "(work in progress)", as appropriate</c>
293 | 
294 | <c>linefile</c>
295 | <c>n/a</c>
296 | <c>a string like "35:file.xml" or just "35"
297 | (file name then defaults to the containing file's real name
298 | or to the latest linefile specification that changed it)
299 | that will be used to override <spanx style='strong'>xml2rfc</spanx>'s
300 | reckoning of the current input position (right after this PI)
301 | for warning and error reporting purposes (line numbers are 1-based)</c>
302 | 
303 | <c>needLines</c>
304 | <c>n/a</c>
305 | <c>an integer hint indicating how many contiguous lines are needed at this point in the output</c>
306 | 
307 | <c>private</c>
308 | <c>""</c>
309 | <c>produce a private memo rather than an RFC or Internet-Draft</c>
310 | 
311 | <c>refparent</c>
312 | <c>"References"</c>
313 | <c>title of the top-level section containing all references</c>
314 | 
315 | <c>rfcedstyle</c>
316 | <c>no</c>
317 | <c>attempt to closely follow finer details
318 | from the latest observable RFC-Editor style
319 | so as to minimize the probability of
320 | being sent back corrections after submission;
321 | this directive is a kludge whose exact behavior
322 | is likely to change on a regular basis
323 | to match the current flavor of the month;
324 | presently,
325 | it will capitalize the adjective &ldquo;This&rdquo;
326 | in automatically generated headings,
327 | use the variant &ldquo;acknowledgement&rdquo; spelling instead of
328 | Merriam Webster's main &ldquo;acknowledgment&rdquo; dictionary entry,
329 | use the &ldquo;eMail&rdquo; spelling instead of
330 | Knuth's more modern &ldquo;email&rdquo; spelling,
331 | only put one blank line instead of two before top sections,
332 | omit &ldquo;Intellectual Property and Copyright Statements&rdquo;
333 | and &ldquo;Author's Address&rdquo; from the table of content,
334 | and not limit the indentation to a maximum tag length
335 | in &lt;references&gt; sections.
336 | </c>
337 | 
338 | <c>rfcprocack</c>
339 | <c>no</c>
340 | <c>if there already is an automatically generated Acknowledg(e)ment section,
341 | pluralize its title and add a short sentence acknowledging that
342 | <spanx style='strong'>xml2rfc</spanx> was used in the document's production
343 | to process an input XML source file in RFC-2629 format</c>
344 | 
345 | <c>slides</c>
346 | <c>no</c>
347 | <c>when producing a html file, produce multiple files for a slide show</c>
348 | 
349 | <c>sortrefs</c>
350 | <c>no</c>
351 | <c>sort references</c>
352 | 
353 | <c>strict</c>
354 | <c>no</c>
355 | <c>try to enforce the ID-nits conventions and DTD validity</c>
356 | 
357 | <c>subcompact</c>
358 | <c>(compact)</c>
359 | <c>if compact is "yes",
360 | then you can make things a little less compact by setting this to "no"
361 | (the default value is the current value of the compact PI)</c>
362 | 
363 | <c>symrefs</c>
364 | <c>yes</c>
365 | <c>use anchors rather than numbers for references</c>
366 | 
367 | <c>toc</c>
368 | <c>no</c>
369 | <c>generate a table-of-contents</c>
370 | 
371 | <c>tocappendix</c>
372 | <c>yes</c>
373 | <c>control whether the word &ldquo;Appendix&rdquo; appears in the table-of-content</c>
374 | 
375 | <c>tocdepth</c>
376 | <c>3</c>
377 | <c>if toc is "yes", then this determines the depth of the table-of-contents</c>
378 | 
379 | <c>tocindent</c>
380 | <c>yes</c>
381 | <c>if toc is "yes", then setting this to "yes" will indent subsections
382 | in the table-of-contents</c>
383 | 
384 | <c>tocnarrow</c>
385 | <c>yes</c>
386 | <c>affects horizontal spacing in the table-of-content</c>
387 | 
388 | <c>tocompact</c>
389 | <c>yes</c>
390 | <c>if toc is "yes", then setting this to "no" will make it a little less compact</c>
391 | 
392 | <c>topblock</c>
393 | <c>yes</c>
394 | <c>put the famous header block on the first page</c>
395 | 
396 | <c>typeout</c>
397 | <c>n/a</c>
398 | <c>during processing pass&nbsp;2, print the value to standard output
399 | at that point in processing</c>
400 | 
401 | <c>useobject</c>
402 | <c>no</c>
403 | <c>when producing a html file,
404 | use the <spanx style='verb'>&lt;object&gt;</spanx> html element with inner replacement content
405 | instead of the <spanx style='verb'>&lt;img&gt;</spanx> html element,
406 | when a source xml element includes an <spanx style='verb'>src</spanx> attribute</c>
407 | 
408 | <postamble>Remember that,
409 | as with everything else in XML,
410 | keywords and values are case-sensitive.</postamble>
411 | </texttable>
412 | 
413 | <t>With the exception of the <spanx style='verb'>needLines</spanx>,
414 | <spanx style='verb'>typeout</spanx>, and
415 | <spanx style='verb'>include</spanx> directives,
416 | you normally put all of these processing instructions at the beginning
417 | of the document
418 | (right after the XML declaration).</t>
419 | </section>
420 | 
421 | <section title='Include Files' anchor='include.file.facility'>
422 | <figure>
423 | <preamble><spanx style='strong'>xml2rfc</spanx> has an include-file facility,
424 | e.g.,</preamble>
425 | <artwork>
426 |     &lt;?rfc include='file'?&gt;
427 | </artwork>
428 | <postamble><spanx style='strong'>xml2rfc</spanx> will consult the
429 | <spanx style='verb'>XML_LIBRARY</spanx> environment variable for a
430 | search path of where to look for files.
431 | (If this environment variable isn't set,
432 | the directory containing the file that contains the include-file
433 | directive is used.)
434 | The file's contents are inserted right after the PI.
435 | Putting non-include-file directives (especially needLines ones)
436 | after an include-file one in the same PI
437 | may not work as expected because of this.
438 | Remember that file names are generally case-sensitive and that
439 | an input file that is distributed to the outside world may be
440 | processed on a different operating system than that used by
441 | its author.</postamble>
442 | </figure>
443 | 
444 | <figure>
445 | <preamble>You can also have <spanx style='strong'>xml2rfc</spanx> set
446 | the <spanx style='verb'>XML_LIBRARY</spanx> environment variable directly,
447 | by creating a file called <spanx style='verb'>.xml2rfc.rc</spanx> in
448 | the directory where your
449 | main file is,
450 | e.g.,</preamble>
451 | <artwork><![CDATA[
452 | global env tcl_platform
453 | 
454 | if {![string compare $tcl_platform(platform) windows]} {
455 |     set sep ";"
456 | } else {
457 |     set sep ":"
458 | }
459 | 
460 | if {[catch { set env(XML_LIBRARY) } library]} {
461 |     set library ""
462 |     foreach bibxmlD [lsort -dictionary \
463 |                            [glob -nocomplain $HOME/rfcs/bibxml/*]] {
464 |         append library $sep$bibxmlD
465 |     }
466 | }
467 | 
468 | set nativeD [file nativename $inputD]
469 | if {[lsearch [split $library $sep] $nativeD] < 0} {
470 |     set library "$nativeD$sep$library"
471 | }
472 | 
473 | set env(XML_LIBRARY) $library
474 | ]]></artwork>
475 | </figure>
476 | 
477 | <t>There are links to various bibliographic databases (RFCs, I-Ds, and so on)
478 | on the <spanx style='strong'>xml2rfc</spanx>
479 | <eref target='http://xml.resource.org/'>homepage</eref>.</t>
480 | </section>
481 | </section>
482 | </section>
483 | 
484 | <section title='The Page Model'>
485 | <t>The <spanx style='strong'>html</spanx>
486 | rendering engine does not need to
487 | have a tightly defined page model.</t>
488 | 
489 | <t>The <spanx style='strong'>txt</spanx> and
490 | <spanx style='strong'>nr</spanx> rendering engines
491 | assume the following page model.</t>
492 | 
493 | <t>Each line has at most 72 columns from the left edge,
494 | including any left margin, but excluding the line terminator.
495 | Every output character is from the ASCII repertoire
496 | and the only control character used is the line-feed (LF);
497 | the character-tabulation (HT) character is never used.</t>
498 | 
499 | <t>Each page has the following lines
500 | (in 1-based numbering, as reported to the user, but contrary to
501 | <spanx style='strong'>xml2rfc</spanx>'s
502 | internal 0-based numbering):<list>
503 |   <t>&nbsp;1:  header line (blank line on first page)</t>
504 |   <t>&nbsp;2:  blank line</t>
505 |   <t>&nbsp;3:  blank line</t>
506 |   <t>&nbsp;4:  1st line of content</t>
507 |   <t>...</t>
508 |   <t>51:  48th line of content</t>
509 |   <t>52:  blank line</t>
510 |   <t>53:  blank line</t>
511 |   <t>54:  blank line</t>
512 |   <t>55:  footer line</t>
513 |   <t>56:  form-feed character (followed by line terminator)</t>
514 | </list>
515 | Once processed through <spanx style='strong'>nroff</spanx>
516 | and the <spanx style='verb'>fix.sh</spanx> script (from
517 | <eref target='ftp://ftp.rfc-editor.org/in-notes/rfc-editor/2-nroff.template'
518 | >2-nroff.template</eref>), the <spanx style='strong'>nr</spanx>
519 | output differs from this in two ways.
520 | It has three extra blank lines
521 | (that could be numbered -2, -1, and 0, for a total of six)
522 | at the very beginning of the document
523 | (so the first page is that much longer).
524 | It also has no line terminator following the
525 | very last form-feed character of the file.
526 | These differences originate in the design of
527 | the <spanx style='verb'>fix.sh</spanx> script.</t>
528 | 
529 | <t>Header and footer lines each have three parts:
530 | left, center, and right.</t>
531 | </section>
532 | 
533 | <section title='Additions to RFC&nbsp;2629'>
534 | <t>A few additions have been made to the format originally defined in
535 | RFC&nbsp;2629.
536 | In particular,
537 | <eref target='draft-mrose-writing-rfcs.html#anchor19'>Appendix&nbsp;C</eref>
538 | of the 2629bis document enumerates the additions.</t>
539 | 
540 | <section title='Extra Attributes'>
541 | <t>In addition,
542 | <spanx style='strong'>xml2rfc</spanx> recognizes the undocumented
543 | <spanx style='verb'>src</spanx>,
544 | <spanx style='verb'>alt</spanx>,
545 | <spanx style='verb'>width</spanx>, and
546 | <spanx style='verb'>height</spanx> attributes in the
547 | <spanx style='verb'>figure</spanx> and
548 | <spanx style='verb'>artwork</spanx> elements,
549 | but only if HTML is being generated.
550 | Here are two examples, one for each case.</t>
551 | <figure>
552 | <preamble>Here, the attributes are added to the
553 | <spanx style='verb'>artwork</spanx> element.</preamble>
554 | <artwork align='center'><![CDATA[
555 | <figure>
556 |     <preamble>This is the preamble.</preamble>
557 |     <artwork src='layers.png'
558 |              alt='[picture of layers only]'>
559 | .-----------.
560 | | ASCII art |
561 | `-----------'
562 | </artwork>
563 |     <postamble>This is the postamble.</postamble>
564 | </figure>
565 | ]]></artwork>
566 | <postamble>In this case, the 
567 | <spanx style='verb'>preamble</spanx> and
568 | <spanx style='verb'>postamble</spanx> elements are kept and
569 | an <spanx style='verb'>img</spanx> tag is placed in the HTML output
570 | to replace the whole <spanx style='verb'>artwork</spanx> element
571 | and its textual drawing, which are ignored.</postamble>
572 | </figure>
573 | <figure>
574 | <preamble>Here, the attributes are added to the
575 | <spanx style='verb'>figure</spanx> element.</preamble>
576 | <artwork align='center'><![CDATA[
577 | <figure src='layers.png'
578 |         alt='[picture of layers and explanation]'>
579 |     <preamble>This is the preamble.</preamble>
580 |     <artwork>
581 | .-----------.
582 | | ASCII art |
583 | `-----------'
584 | </artwork>
585 |     <postamble>This is the postamble.</postamble>
586 | </figure>
587 | ]]></artwork>
588 | <postamble>In this case,
589 | an <spanx style='verb'>img</spanx> tag is placed in the HTML output
590 | to replace the whole contents of the
591 | <spanx style='verb'>figure</spanx> element
592 | (the <spanx style='verb'>preamble</spanx>,
593 |      <spanx style='verb'>artwork</spanx>, and
594 |      <spanx style='verb'>postamble</spanx> inner elements
595 |  and the textual drawing itself)
596 | which are ignored.</postamble>
597 | </figure>
598 | 
599 | <t><spanx style='strong'>xml2rfc</spanx> also recognizes
600 | an undocumented <spanx style='verb'>align</spanx> attribute
601 | (with possible values
602 |  <spanx style='verb'>left</spanx>,
603 |  <spanx style='verb'>center</spanx>, or
604 |  <spanx style='verb'>right</spanx>)
605 | in the
606 | <spanx style='verb'>figure</spanx> and
607 | <spanx style='verb'>artwork</spanx> elements.
608 | It affects the whole content of the targeted element
609 | for all types of generated output.
610 | Its default is inherited from the parent of its element.</t>
611 | </section>
612 | 
613 | <section title='Typed-Artwork Interpretation'>
614 | <t>The <spanx style='verb'>artwork</spanx> element from RFC&nbsp;2629
615 | supports an optional <spanx style='verb'>type</spanx> attribute.
616 | While most possible values are just ignored,
617 | including the special case
618 | where the attribute is unspecified or just empty,
619 | some values are recognized.
620 | In particular, <spanx style='verb'>type='abnf'</spanx>
621 | can be used if the <spanx style='verb'>artwork</spanx>
622 | contains an Augmented Backus-Naur Form (ABNF)
623 | syntax specification&nbsp;<xref target='RFC4234' />.
624 | As a special extension in its <spanx style='emph'>behavior</spanx>,
625 | <spanx style='strong'>xml2rfc</spanx> will attempt
626 | to validate the syntax and colorize the HTML output of ABNF,
627 | since it is so widely used in RFCs.
628 | It does this colorizing by relying
629 | on the full parsing it does right before,
630 | not on a quick and partial (e.g., line-by-line) pattern-based hack.
631 | ABNF is the only artwork type to benefit
632 | from this kind of internal support at this time.
633 | If the <spanx style='verb'>strict</spanx> rfc-PI directive is activated,
634 | invalid ABNF content will cause <spanx style='strong'>xml2rfc</spanx>
635 | to abort with an error message.
636 | Omitting the <spanx style='verb'>type</spanx> attribute altogether
637 | is the obvious way to avoid having
638 | this validation and colorizing performed.</t>
639 | <figure align='left'>
640 | <preamble>For example (to be viewed in HTML):</preamble>
641 | <artwork align='center' type='abnf'><![CDATA[
642 | char-val       =  DQUOTE *(%x20-21 / %x23-7E) DQUOTE
643 |                        ; quoted string of SP and VCHAR
644 |                           without DQUOTE
645 | 
646 | num-val        =  "%" (bin-val / dec-val / hex-val)
647 | 
648 | bin-val        =  "b" 1*BIT
649 |                   [ 1*("." 1*BIT) / ("-" 1*BIT) ]
650 |                        ; series of concatenated bit values
651 |                        ; or single ONEOF range
652 | 
653 | dec-val        =  "d" 1*DIGIT
654 |                   [ 1*("." 1*DIGIT) / ("-" 1*DIGIT) ]
655 | 
656 | hex-val        =  "x" 1*HEXDIG
657 |                   [ 1*("." 1*HEXDIG) / ("-" 1*HEXDIG) ]
658 | 
659 | prose-val      =  "<" *(%x20-3D / %x3F-7E) ">"
660 |                        ; bracketed string of SP and VCHAR
661 |                           without angles
662 |                        ; prose description, to be used as
663 |                           last resort
664 | ]]></artwork>
665 | <postamble>This is from the
666 | original RFC on ABNF&nbsp;<xref target='RFC2234' />,
667 | with its minor mistakes in manually folded comment lines
668 | purposely left intact, for illustration.
669 | Since the result is still valid ABNF
670 | (but incorrect with respect to what was intended),
671 | this showcases how colorizing might give a human author
672 | (or editor or reader)
673 | a better chance to spot the three mistakes
674 | (and correct them, e.g., with extra semicolons,
675 | as has been done in
676 | a more recent version&nbsp;<xref target='RFC4234' />
677 | of the ABNF specification).
678 | Note that it is the white space characters
679 | at the beginning of the subsequent lines
680 | (including the commented ones)
681 | that conspire to extend the reach of those rules
682 | across several lines.</postamble>
683 | </figure>
684 | </section>
685 | </section>
686 | 
687 | <section title='Limitations of xml2rfc'>
688 | <t><list style='symbols'>
689 | <t>The <spanx style='verb'>figure</spanx> element's <spanx style='verb'>title</spanx> attribute is ignored,
690 | except when generating HTML.</t>
691 | 
692 | <t>The <spanx style='verb'>xref</spanx> element's
693 | <spanx style='verb'>pageno</spanx> attribute is ignored.</t>
694 | </list></t>
695 | </section>
696 | </middle>
697 | 
698 | <back>
699 | <references>
700 | <reference anchor='RFC2026'>
701 | 
702 | <front>
703 | <title abbrev='Internet Standards Process'>The Internet Standards Process -- Revision&nbsp;3</title>
704 | <author initials='S.' surname='Bradner' fullname='Scott O. Bradner'>
705 | <organization>Harvard University</organization>
706 | <address>
707 | <postal>
708 | <street>1350 Mass. Ave.</street>
709 | <city>Cambridge</city>
710 | <region>MA</region>
711 | <code>02138</code>
712 | <country>US</country></postal>
713 | <phone>+1 617 495 3864</phone>
714 | <email>sob@harvard.edu</email></address></author>
715 | <date month='October' year='1996' />
716 | <abstract>
717 | <t>This memo documents the process used by the Internet community for the standardization of protocols and procedures.  It defines the stages in the standardization process, the requirements for moving a document between stages and the types of documents used during this process.  It also addresses the intellectual property rights and copyright issues associated with the standards process.</t></abstract></front>
718 | 
719 | <seriesInfo name='BCP' value='9' />
720 | <seriesInfo name='RFC' value='2026' />
721 | <format type='TXT' octets='86731' target='ftp://ftp.isi.edu/in-notes/rfc2026.txt' />
722 | </reference>
723 | 
724 | <reference anchor='RFC2234'>
725 | 
726 | <front>
727 | <title abbrev='ABNF for Syntax Specifications'>Augmented BNF for Syntax Specifications: ABNF</title>
728 | <author initials='D.' surname='Crocker' fullname='David H. Crocker' role='editor'>
729 | <organization>Internet Mail Consortium</organization>
730 | <address>
731 | <postal>
732 | <street>675 Spruce Dr.</street>
733 | <city>Sunnyvale</city>
734 | <region>CA</region>
735 | <code>94086</code>
736 | <country>US</country></postal>
737 | <phone>+1 408 246 8253</phone>
738 | <facsimile>+1 408 249 6205</facsimile>
739 | <email>dcrocker@imc.org</email></address></author>
740 | <author initials='P.' surname='Overell' fullname='Paul Overell'>
741 | <organization>Demon Internet Ltd.</organization>
742 | <address>
743 | <postal>
744 | <street>Dorking Business Park</street>
745 | <street>Dorking</street>
746 | <city>Surrey</city>
747 | <region>England</region>
748 | <code>RH4 1HN</code>
749 | <country>UK</country></postal>
750 | <email>paulo@turnpike.com</email></address></author>
751 | <date year='1997' month='November' />
752 | <keyword>ABNF</keyword>
753 | <keyword>Augmented</keyword>
754 | <keyword>Backus-Naur</keyword>
755 | <keyword>Form</keyword>
756 | <keyword>electronic</keyword>
757 | <keyword>mail</keyword></front>
758 | 
759 | <seriesInfo name='RFC' value='2234' />
760 | <format type='TXT' octets='24265' target='ftp://ftp.isi.edu/in-notes/rfc2234.txt' />
761 | <format type='HTML' octets='36695' target='http://xml.resource.org/public/rfc/html/rfc2234.html' />
762 | <format type='XML' octets='24067' target='http://xml.resource.org/public/rfc/xml/rfc2234.xml' />
763 | </reference>
764 | 
765 | <reference anchor='RFC4234'>
766 | 
767 | <front>
768 | <title>Augmented BNF for Syntax Specifications: ABNF</title>
769 | <author initials='D.' surname='Crocker' fullname='D. Crocker'>
770 | <organization /></author>
771 | <author initials='P.' surname='Overell' fullname='P. Overell'>
772 | <organization /></author>
773 | <date year='2005' month='October' /></front>
774 | 
775 | <seriesInfo name='RFC' value='4234' />
776 | <format type='TXT' octets='26351' target='ftp://ftp.isi.edu/in-notes/rfc4234.txt' />
777 | </reference>
778 | 
779 | </references>
780 | 
781 | <section title="MacOS&nbsp;9 Installation (courtesy of Ned Freed)">
782 | <t><list style='numbers'>
783 | <t>Install Tcl/Tk&nbsp;8.3.4</t>
784 | 
785 | <t>When you performed Step&nbsp;1,
786 | a folder in your <spanx style='verb'>Extensions</spanx> folder
787 | called <spanx style='verb'>Tool Command Language</spanx> was
788 | created.
789 | Create a new folder under <spanx style='verb'>Extensions</spanx>,
790 | with any name you like.</t>
791 | 
792 | <t>Drag the file <spanx style='verb'>xml2rfc.tcl</spanx> onto the
793 | <spanx style='verb'>Drag &amp; Drop Tclets</spanx>
794 | application that was installed in Step&nbsp;1.</t>
795 | 
796 | <t>When asked for an appropriate <spanx style='verb'>wish</spanx> stub,
797 | select <spanx style='verb'>Wish&nbsp;8.3.4</spanx>.</t>
798 | 
799 | <t>The <spanx style='verb'>Drag &amp; Drop Tclets</spanx>
800 | application will write out an executable version of
801 | <spanx style='strong'>xml2rfc</spanx>.</t>
802 | </list></t>
803 | </section>
804 | 
805 | <section title='rfc2629.xslt (courtesy of Julian Reschke)' anchor='rfc2629.xslt'>
806 | <t>The file <spanx style='verb'>rfc2629.xslt</spanx>
807 | can be used with an XSLT-capable formatter
808 | (e.g., Saxon, Xalan, xsltproc, or MSIE6) to produce HTML.
809 | A word of warning though:
810 | the XSLT script only supports a limited subset of
811 | the processing instruction directives discussed
812 | <xref target='processing.instructions'>earlier</xref>
813 | and each attribute-like directive must be in its own PI
814 | (i.e., <spanx style='verb'>&lt;?rfc keyword='value'?&gt;</spanx>).
815 | The
816 | <eref target='http://greenbytes.de/tech/webdav/rfc2629.xslt'>latest version</eref>
817 | (and <eref target='http://greenbytes.de/tech/webdav/rfc2629xslt.zip'>full distribution ZIP file</eref>)
818 | can be downloaded from the
819 | <eref target='http://greenbytes.de/tech/webdav/#rfc2629.xslt'>original site</eref>
820 | which also hosts its
821 | <eref target='http://greenbytes.de/tech/webdav/rfc2629xslt/rfc2629xslt.html'>documentation</eref>.</t>
822 | </section>
823 | 
824 | <section title="MS-Windows&nbsp;XP/Cygwin Installation (courtesy of Joe Touch)">
825 | <t><list style='numbers'>
826 | 
827 | <t>install Cygwin: follow instructions at the
828 | <eref target='http://www.cygwin.com/'>Cygwin website</eref> (also visit the
829 | <eref target='http://wiki.tcl.tk/2?cygwin'>Cygwin pages on the Tcl Wiki</eref>),
830 | make sure to
831 | select <spanx style='verb'>tcltk</spanx> in <spanx style='verb'>Libs</spanx></t>
832 | 
833 | <t>place a copy of xml2rfc files on a local drive,  e.g., in
834 | <spanx style='verb'>C:\xml2rfc</spanx> NOTE: for xml2rfc-1.26 and
835 | earlier, see NOTE below.</t>
836 | 
837 | <t>place a copy of bibxml* files on a local drive, e.g., in
838 | <spanx style='verb'>C:\xmlbib\</spanx> </t>
839 | 
840 | <t>edit <spanx style='verb'>.xml2rfc.rc</spanx> to indicate the <spanx
841 | style='verb'>bibxml*</spanx> library path, e.g., as per Step&nbsp;3,
842 | change <spanx style='verb'>~/rfca/bibxml/*</spanx> to <spanx
843 | style='verb'>/cygdrive/c/xmlbib/*</spanx></t>
844 | 
845 | <t>run xml2rfc as follows: <spanx style='verb'>tclsh
846 | /cygdrive/c/xml2rfc/xml2rfc.tcl</spanx></t>
847 | </list>
848 | </t>
849 | 
850 | <t>NOTE: for xml2rfc-1.26 and earlier ONLY, add an additional modification in Step&nbsp;3:
851 | <list>
852 | <t>
853 | Patch <spanx style='verb'>.xml2rfc.rc</spanx> (xml2rfc-1.26 and earlier).
854 | The purpose of the patch
855 | is to append library names in a format compatible with the OS; on
856 | MS-Windows&nbsp;XP, this replaces the Cygwin's <spanx style='verb'>/</spanx>
857 | with MS-Windows' <spanx style='verb'>\</spanx>.
858 | </t>
859 | </list>
860 | </t>
861 | 
862 | <figure>
863 | <artwork>
864 | --- .xml2rfc.rc.orig    Thu Jul 24 13:58:00 2003
865 | +++ .xml2rfc.rc    Wed Oct 20 10:59:02 2004
866 | @@ -9,7 +9,8 @@
867 |  if {[catch { set env(XML_LIBRARY) } library]} {
868 |      set library ""
869 |      foreach bibxmlD [lsort -dictionary [glob -nocomplain ~/rfcs/bibxml/*]] {
870 | -        append library $sep$bibxmlD
871 | +        set natbibD [file nativename $bibxmlD]
872 | +        append library $sep$natbibD
873 |      }
874 |  }
875 | </artwork>
876 | </figure>
877 | </section>
878 | 
879 | <section title='A Special Thanks'>
880 | <t>A special thanks to Charles Levert for the v1.29 release,
881 | which includes many internal improvements made to the rendering engines.</t>
882 | </section>
883 | 
884 | <section title='Copyrights'>
885 | <t>Copyright &copy; 2003&ndash;2008 Marshall T. Rose</t>
886 | 
887 | <t>Hold harmless the author, and any lawful use is allowed.</t>
888 | </section>
889 | </back>
890 | </rfc>
891 | 


--------------------------------------------------------------------------------