]> Sergey Matveev's repositories - public-inbox.git/blob - Documentation/standards.perl
public-inbox 1.6.1 - minor bugfix release
[public-inbox.git] / Documentation / standards.perl
1 #!/usr/bin/perl -w
2 use strict;
3 # Copyright 2019-2020 all contributors <meta@public-inbox.org>
4 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
5
6 print <<EOF;
7 Relevant standards for public-inbox users and hackers
8 -----------------------------------------------------
9
10 Non-exhaustive list of standards public-inbox software attempts or
11 intends to implement.  This list is intended to be a quick reference
12 for hackers and users.
13
14 Given the goals of interoperability and accessibility; strict
15 conformance to standards is not always possible, but rather
16 best-effort taking into account real-world cases.  In particular,
17 "obsolete" standards remain relevant as long as clients and
18 data exists.
19
20 IETF RFCs
21 ---------
22
23 EOF
24
25 my $rfcs = [
26         3977 => 'NNTP',
27         977 => 'NNTP (old)',
28         1036 => 'Standard for Interchange of USENET Messages',
29         5536 => 'Netnews Article Format',
30         5537 => 'Netnews Architecture and Protocols',
31         6048 => 'NNTP additions to LIST command (TODO)',
32         8054 => 'NNTP compression',
33         4642 => 'NNTP TLS',
34         8143 => 'NNTP TLS',
35         2980 => 'NNTP extensions (obsolete, but NOT irrelevant)',
36         4287 => 'Atom syndication',
37         4685 => 'Atom threading extensions',
38         2919 => 'List-Id mail header',
39         5064 => 'Archived-At mail header',
40         3986 => 'URI escaping',
41         1521 => 'MIME extensions',
42         2616 => 'HTTP/1.1 (newer updates should apply, too)',
43         7230 => 'HTTP/1.1 message syntax and routing',
44         7231 => 'HTTP/1.1 semantics and content',
45         822 => 'Internet message format (1982)',
46         2822 => 'Internet message format (2001)',
47         5322 => 'Internet message format (2008)',
48         3501 => 'IMAP4rev1',
49         2177 => 'IMAP IDLE',
50         2683 => 'IMAP4 Implementation Recommendations',
51         # 5032 = 'WITHIN search extension for IMAP',
52         4978 => 'IMAP COMPRESS Extension',
53         # 5182 = 'IMAP Extension for Referencing the Last SEARCH Result',
54         # 5256 => 'IMAP SORT and THREAD extensions',
55         # 5738 =>  'IMAP Support for UTF-8',
56         # 8474 => 'IMAP Extension for Object Identifiers',
57
58         # 8620 => JSON Meta Application Protocol (JMAP)
59         # 8621 => JSON Meta Application Protocol (JMAP) for Mail
60         # ...
61
62         # TODO: flesh this out
63
64 ];
65
66 my @rfc_urls = qw(tools.ietf.org/html/rfc%d
67                   www.rfc-editor.org/errata_search.php?rfc=%d);
68
69 for (my $i = 0; $i < $#$rfcs;) {
70         my $num = $rfcs->[$i++];
71         my $txt = $rfcs->[$i++];
72         print "rfc$num\t- $txt\n";
73
74         printf "\thttps://$_\n", $num foreach @rfc_urls;
75         print "\n";
76 }
77
78 print <<'EOF'
79 Other relevant documentation
80 ----------------------------
81
82 * IMAP capabilities registry and response codes:
83   https://www.iana.org/assignments/imap-capabilities
84   https://www.iana.org/assignments/imap-response-codes
85
86 * Documentation/technical/http-protocol.txt in git source code:
87   https://public-inbox.org/git/9c5b6f0fac/s
88
89 * Various mbox formats (we currently emit and parse mboxrd)
90   https://en.wikipedia.org/wiki/Mbox
91
92 * PSGI/Plack specifications (as long as our web frontend uses Perl5)
93   git clone https://github.com/plack/psgi-specs.git
94
95 Copyright
96 ---------
97
98 Copyright (C) 2019-2020 all contributors <meta@public-inbox.org>
99 License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
100 EOF