1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 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 56 57 58 59 60 61 62 63 64 65 66 67 68 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 112 113 114 115 116 117 118 119 120 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 168 169 170 171 172 173 174 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 224 225 226 227 228 229 230 231 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 280 281 282 283 284 285 286 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 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397
|
<pre>Internet Engineering Task Force (IETF) J. Elie
Request for Comments: 6048 November 2010
Updates: <a href="./rfc2980">2980</a>, <a href="./rfc3977">3977</a>
Category: Standards Track
ISSN: 2070-1721
<span class="h1">Network News Transfer Protocol (NNTP) Additions to LIST Command</span>
Abstract
This document defines a set of enhancements to the Network News
Transfer Protocol (NNTP) that allow a client to request extended
information from NNTP servers regarding server status, policy, and
other aspects of local configuration. These enhancements are made as
new keywords to the existing LIST capability described in <a href="./rfc3977">RFC 3977</a>.
This memo updates and formalizes the LIST DISTRIBUTIONS and LIST
SUBSCRIPTIONS commands defined in <a href="./rfc2980">RFC 2980</a>. It also adds the LIST
COUNTS, LIST MODERATORS, and LIST MOTD commands, and specifies
additional values returned by the existing LIST ACTIVE command for
the status of a newsgroup.
Status of This Memo
This is an Internet Standards Track document.
This document is a product of the Internet Engineering Task Force
(IETF). It represents the consensus of the IETF community. It has
received public review and has been approved for publication by the
Internet Engineering Steering Group (IESG). Further information on
Internet Standards is available in <a href="./rfc5741#section-2">Section 2 of RFC 5741</a>.
Information about the current status of this document, any errata,
and how to provide feedback on it may be obtained at
<a href="http://www.rfc-editor.org/info/rfc6048">http://www.rfc-editor.org/info/rfc6048</a>.
Copyright Notice
Copyright (c) 2010 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and the IETF Trust's Legal
Provisions Relating to IETF Documents
(<a href="http://trustee.ietf.org/license-info">http://trustee.ietf.org/license-info</a>) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
<span class="grey">Elie Standards Track [Page 1]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
<span class="grey"><a href="./rfc6048">RFC 6048</a> NNTP Additions to LIST Command November 2010</span>
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Table of Contents
<a href="#section-1">1</a>. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-3">3</a>
<a href="#section-1.1">1.1</a>. Conventions Used in This Document . . . . . . . . . . . . <a href="#page-4">4</a>
<a href="#section-1.2">1.2</a>. Author's Note . . . . . . . . . . . . . . . . . . . . . . <a href="#page-4">4</a>
<a href="#section-2">2</a>. New LIST Variants . . . . . . . . . . . . . . . . . . . . . . <a href="#page-4">4</a>
<a href="#section-2.1">2.1</a>. Advertising the New LIST Variants . . . . . . . . . . . . <a href="#page-4">4</a>
<a href="#section-2.2">2.2</a>. LIST COUNTS . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-5">5</a>
<a href="#section-2.2.1">2.2.1</a>. Usage . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-5">5</a>
<a href="#section-2.2.2">2.2.2</a>. Description . . . . . . . . . . . . . . . . . . . . . <a href="#page-6">6</a>
<a href="#section-2.2.3">2.2.3</a>. Examples . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-7">7</a>
<a href="#section-2.3">2.3</a>. LIST DISTRIBUTIONS . . . . . . . . . . . . . . . . . . . . <a href="#page-8">8</a>
<a href="#section-2.3.1">2.3.1</a>. Usage . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-8">8</a>
<a href="#section-2.3.2">2.3.2</a>. Description . . . . . . . . . . . . . . . . . . . . . <a href="#page-8">8</a>
<a href="#section-2.3.3">2.3.3</a>. Example . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-10">10</a>
<a href="#section-2.4">2.4</a>. LIST MODERATORS . . . . . . . . . . . . . . . . . . . . . <a href="#page-10">10</a>
<a href="#section-2.4.1">2.4.1</a>. Usage . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-10">10</a>
<a href="#section-2.4.2">2.4.2</a>. Description . . . . . . . . . . . . . . . . . . . . . <a href="#page-10">10</a>
<a href="#section-2.4.3">2.4.3</a>. Example . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-12">12</a>
<a href="#section-2.5">2.5</a>. LIST MOTD . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-13">13</a>
<a href="#section-2.5.1">2.5.1</a>. Usage . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-13">13</a>
<a href="#section-2.5.2">2.5.2</a>. Description . . . . . . . . . . . . . . . . . . . . . <a href="#page-13">13</a>
<a href="#section-2.5.3">2.5.3</a>. Example . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-14">14</a>
<a href="#section-2.6">2.6</a>. LIST SUBSCRIPTIONS . . . . . . . . . . . . . . . . . . . . <a href="#page-14">14</a>
<a href="#section-2.6.1">2.6.1</a>. Usage . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-14">14</a>
<a href="#section-2.6.2">2.6.2</a>. Description . . . . . . . . . . . . . . . . . . . . . <a href="#page-15">15</a>
<a href="#section-2.6.3">2.6.3</a>. Examples . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-16">16</a>
<a href="#section-3">3</a>. Additions to LIST ACTIVE . . . . . . . . . . . . . . . . . . . <a href="#page-16">16</a>
<a href="#section-3.1">3.1</a>. New Status Field Values . . . . . . . . . . . . . . . . . <a href="#page-16">16</a>
<a href="#section-3.2">3.2</a>. Examples . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-20">20</a>
4. Augmented BNF Syntax for These Additions to the LIST
Command . . . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-21">21</a>
<a href="#section-4.1">4.1</a>. Commands . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-21">21</a>
<a href="#section-4.2">4.2</a>. Responses . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-21">21</a>
<a href="#section-5">5</a>. Internationalization Considerations . . . . . . . . . . . . . <a href="#page-22">22</a>
<a href="#section-6">6</a>. Security Considerations . . . . . . . . . . . . . . . . . . . <a href="#page-23">23</a>
<a href="#section-7">7</a>. IANA Considerations . . . . . . . . . . . . . . . . . . . . . <a href="#page-23">23</a>
<a href="#section-8">8</a>. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-24">24</a>
<a href="#section-9">9</a>. References . . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-24">24</a>
<a href="#section-9.1">9.1</a>. Normative References . . . . . . . . . . . . . . . . . . . <a href="#page-24">24</a>
<a href="#section-9.2">9.2</a>. Informative References . . . . . . . . . . . . . . . . . . <a href="#page-25">25</a>
<span class="grey">Elie Standards Track [Page 2]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
<span class="grey"><a href="./rfc6048">RFC 6048</a> NNTP Additions to LIST Command November 2010</span>
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
The NNTP specification [<a href="./rfc3977" title=""Network News Transfer Protocol (NNTP)"">RFC3977</a>] defines the LIST capability and a
few keywords that can be used with that command: ACTIVE,
ACTIVE.TIMES, DISTRIB.PATS, HEADERS, NEWSGROUPS, and OVERVIEW.FMT.
Other variants of the LIST command are in use, but with limited or
absent documentation. These variants are formalized in this
document.
The DISTRIBUTIONS and SUBSCRIPTIONS variants were originally
documented in [<a href="./rfc2980" title=""Common NNTP Extensions"">RFC2980</a>]. The LIST DISTRIBUTIONS command is sent by a
news client to obtain a list of relevant distributions known by a
news server along with their descriptions. The LIST SUBSCRIPTIONS
command is sent by a news client when first connecting to a news
server so as to obtain a list of recommended newsgroups available on
it. Both of these commands are intended to be used in place of hard-
coding news clients to use specific distributions or look for
specific default newsgroups.
The MOTD variant was originally documented in [<a href="#ref-NNTP_LIST" title=""NNTP LIST Additions"">NNTP_LIST</a>] (which also
describes the SUBSCRIPTIONS variant). The LIST MOTD command is sent
by a news client to obtain a "message of the day" from the server
administrator regarding the current state of a news server.
The COUNTS and MODERATORS variants have not been documented before.
The LIST COUNTS command is similar to LIST ACTIVE, except that it
also returns an estimated number of articles in each newsgroup. The
LIST MODERATORS command is sent by a news client to obtain a list of
associations between a moderated newsgroup and its submission address
template.
The ACTIVE variant was formalized in [<a href="./rfc3977" title=""Network News Transfer Protocol (NNTP)"">RFC3977</a>], but the meanings of
only three status field values in LIST ACTIVE responses have been
specified: "y", "n", and "m". These statuses are particularly useful
for readers, since they describe local posting rights. However,
several other statuses are in use that are primarily useful for peers
as they mainly describe how remote articles coming from peers are
locally handled by a given news server. This memo defines three
other values for the status field in LIST ACTIVE responses: "x", "j",
and "=" followed by the name of a newsgroup.
This specification should be read in conjunction with the NNTP base
specification [<a href="./rfc3977" title=""Network News Transfer Protocol (NNTP)"">RFC3977</a>]. In the case of a conflict between these two
documents, [<a href="./rfc3977" title=""Network News Transfer Protocol (NNTP)"">RFC3977</a>] takes precedence.
<span class="grey">Elie Standards Track [Page 3]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
<span class="grey"><a href="./rfc6048">RFC 6048</a> NNTP Additions to LIST Command November 2010</span>
<span class="h3"><a class="selflink" id="section-1.1" href="#section-1.1">1.1</a>. Conventions Used in This Document</span>
The notational conventions used in this document are the same as
those in [<a href="./rfc3977" title=""Network News Transfer Protocol (NNTP)"">RFC3977</a>], and any term not defined in this document has the
same meaning as it does in that one.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in [<a href="./rfc2119" title=""Key words for use in RFCs to Indicate Requirement Levels"">RFC2119</a>].
When a hexadecimal correspondence is given to an octet in this
document, the value is in US-ASCII [<a href="#ref-ASCII" title=""Coded Character Sets - 7-Bit American Standard Code for Information Interchange (7-Bit ASCII), ANSI X3.4"">ASCII</a>] (for instance, ".", noted
%x2E).
In the examples, commands from the client are indicated with [<a href="#ref-C">C</a>], and
responses from the server are indicated with [S]. The client is the
initiator of the NNTP connection; the server is the other endpoint.
<span class="h3"><a class="selflink" id="section-1.2" href="#section-1.2">1.2</a>. Author's Note</span>
Please write the first letter of "Elie" with an acute accent wherever
possible -- it is U+00C9, that is to say "&#201;" in XML.
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. New LIST Variants</span>
The LIST capability is defined in <a href="./rfc3977#section-7.6">Section 7.6 of [RFC3977]</a>. It
allows the server to provide useful information to the client in
multi-line blocks.
This document provides five new keywords to the LIST capability:
COUNTS, DISTRIBUTIONS, MODERATORS, MOTD, and SUBSCRIPTIONS.
Each keyword is OPTIONAL and corresponds to the same-named variant of
the LIST command.
<span class="h3"><a class="selflink" id="section-2.1" href="#section-2.1">2.1</a>. Advertising the New LIST Variants</span>
When a news server implements a variant of the LIST command as
described in this specification, it advertises the corresponding
feature in the LIST capability. Where one of these new LIST keywords
is advertised, it MUST have the meaning given in this specification.
For instance, if a news server implements the SUBSCRIPTIONS variant,
it will add the SUBSCRIPTIONS keyword to the LIST capability in
response to the CAPABILITIES command (see <a href="./rfc3977#section-5.2">Section 5.2 of [RFC3977]</a>):
<span class="grey">Elie Standards Track [Page 4]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
<span class="grey"><a href="./rfc6048">RFC 6048</a> NNTP Additions to LIST Command November 2010</span>
[<a id="ref-C">C</a>] CAPABILITIES
[S] 101 Capability list:
[S] VERSION 2
[S] READER
[S] LIST ACTIVE NEWSGROUPS SUBSCRIPTIONS
[S] .
[<a href="#ref-C">C</a>] LIST SUBSCRIPTIONS
[S] 215 List of recommended newsgroups follows
[S] local.welcome
[S] local.test
[S] news.newusers.questions
[S] news.announce.newusers
[S] .
For each of the new LIST variants described in this specification, an
empty response can be sent to the client:
[<a id="ref-C">C</a>] LIST SUBSCRIPTIONS
[S] 215 List of recommended newsgroups follows
[S] .
This means that the information is maintained by the news server but
that it is voluntarily empty. Frequently, the news server maintains
the information in a configuration file. This file can be empty or
contain only commented or blank lines, indicating a voluntary absence
of information.
When the news server software implements one of these LIST variants
but a particular server does not maintain the information (for
instance, when the configuration file does not exist), the 503
response code MUST be returned:
[<a id="ref-C">C</a>] LIST SUBSCRIPTIONS
[S] 503 No list of recommended newsgroups available
<span class="h3"><a class="selflink" id="section-2.2" href="#section-2.2">2.2</a>. LIST COUNTS</span>
<span class="h4"><a class="selflink" id="section-2.2.1" href="#section-2.2.1">2.2.1</a>. Usage</span>
Syntax
LIST COUNTS [wildmat]
Responses
215 List of newsgroups follows (multi-line)
Parameters
wildmat Groups of interest
<span class="grey">Elie Standards Track [Page 5]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
<span class="grey"><a href="./rfc6048">RFC 6048</a> NNTP Additions to LIST Command November 2010</span>
<span class="h4"><a class="selflink" id="section-2.2.2" href="#section-2.2.2">2.2.2</a>. Description</span>
See <a href="./rfc3977#section-7.6.1">Section 7.6.1 of [RFC3977]</a> for general requirements of the LIST
command.
The LIST COUNTS command returns a list of valid newsgroups carried by
the news server along with associated information, the "counts list",
and is similar to LIST ACTIVE.
The information is returned as a multi-line data block following the
215 response code and contains one line per newsgroup. Each line of
this list MUST consist of five fields separated from each other by
one or more spaces (the usual practice is a single space) in the
following order:
o The name of the newsgroup.
o The reported high water mark for the group.
o The reported low water mark for the group.
o The estimated number of articles in the group.
o The current status of the group on this server.
The reported high and low water marks, and the estimated number of
articles, are as described in the GROUP command (see <a href="./rfc3977#section-6.1.1">Section 6.1.1 of
[RFC3977]</a>), but note that they are in the opposite order to the 211
response (that is, number low high group) to the GROUP command. The
current status of the group is as described in the LIST ACTIVE
command (see <a href="./rfc3977#section-7.6.3">Section 7.6.3 of [RFC3977]</a>, as well as <a href="#section-3">Section 3</a> of this
document). Also note that, similarly to the LIST ACTIVE command, TAB
characters are not valid separators for the LIST COUNTS command.
The order of newsgroups in the counts list is not significant. The
server need not consistently return the same order or the same
results if this command is used more than once in a session.
The same newsgroup SHOULD NOT appear twice in the output of this
command.
The counts list is newsgroup-based, and a wildmat MAY be specified,
in which case the response is limited to only the groups, if any,
whose names match the wildmat. If no wildmat is specified, the
server MUST include every newsgroup that the client is permitted to
select with the GROUP command (see <a href="./rfc3977#section-6.1.1">Section 6.1.1 of [RFC3977]</a>).
<span class="grey">Elie Standards Track [Page 6]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
<span class="grey"><a href="./rfc6048">RFC 6048</a> NNTP Additions to LIST Command November 2010</span>
The counts list MAY be empty. If the server does not maintain the
information, a 503 response code MUST be returned. (However, note
that a news server that supports this command usually maintains the
information.)
The client MAY use LIST COUNTS in order to obtain an estimate of the
number of articles in every newsgroup the server carries, which
enables it to provide the end user with this information. This
provides a simpler mechanism for a client to obtain the estimated
number of articles in newsgroups, compared with a sequence of
individual GROUP commands.
<span class="h4"><a class="selflink" id="section-2.2.3" href="#section-2.2.3">2.2.3</a>. Examples</span>
Example of output with no argument:
[<a id="ref-C">C</a>] CAPABILITIES
[S] 101 Capability list:
[S] VERSION 2
[S] READER
[S] LIST ACTIVE COUNTS NEWSGROUPS
[S] .
[<a href="#ref-C">C</a>] LIST COUNTS
[S] 215 List of newsgroups follows
[S] misc.test 3002322 3000234 1234 y
[S] comp.risks 442001 441099 742 m
[S] rec.food.drink.tea 100 51 3 y
[S] local.empty 7 8 0 y
[S] local.tea 2004 1504 301 y
[S] .
Example of output with a wildmat:
[<a id="ref-C">C</a>] LIST COUNTS *.tea,misc.*,!local.*
[S] 215 List of newsgroups follows
[S] misc.test 3002322 3000234 1234 y
[S] rec.food.drink.tea 100 51 3 y
[S] .
<span class="grey">Elie Standards Track [Page 7]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
<span class="grey"><a href="./rfc6048">RFC 6048</a> NNTP Additions to LIST Command November 2010</span>
Example of output on an implementation that includes leading zeroes:
[<a id="ref-C">C</a>] LIST COUNTS
[S] 215 List of newsgroups follows
[S] misc.test 0003002322 0003000234 1234 y
[S] comp.risks 0000442001 0000441099 742 m
[S] rec.food.drink.tea 0000000100 0000000051 3 y
[S] local.empty 0000000007 0000000008 0 y
[S] local.tea 0000002004 0000001504 301 y
[S] .
The estimated number of articles usually does not start with leading
zeroes, but MAY start with such zeroes.
<span class="h3"><a class="selflink" id="section-2.3" href="#section-2.3">2.3</a>. LIST DISTRIBUTIONS</span>
<span class="h4"><a class="selflink" id="section-2.3.1" href="#section-2.3.1">2.3.1</a>. Usage</span>
Syntax
LIST DISTRIBUTIONS
Responses
215 Distributions list follows (multi-line)
<span class="h4"><a class="selflink" id="section-2.3.2" href="#section-2.3.2">2.3.2</a>. Description</span>
See <a href="./rfc3977#section-7.6.1">Section 7.6.1 of [RFC3977]</a> for general requirements of the LIST
command.
A "distributions list" is maintained by some NNTP servers to contain
the name of each distribution that is known by the news server and a
short description about the meaning of the distribution.
Distributions are used by clients as potential values for the
Distribution header field body of a news article being posted (see
<a href="./rfc5536#section-3.2.4">Section 3.2.4 of [RFC5536]</a> for the definition of this header field).
The information is returned as a multi-line data block following the
215 response code and contains one line per distribution. Each line
of this list MUST consist of two fields separated from each other by
one or more space or TAB characters (the usual practice is a single
TAB). The first field is the name of the distribution, and the
second field is a short description of the distribution. There are
no leading or trailing whitespaces in a line. The description MAY
contain whitespaces.
<span class="grey">Elie Standards Track [Page 8]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
<span class="grey"><a href="./rfc6048">RFC 6048</a> NNTP Additions to LIST Command November 2010</span>
The order of distributions in the distributions list is not
significant; the server need not consistently return the same order
or the same results if this command is used more than once in a
session.
The same distribution SHOULD NOT appear twice in the output of this
command.
The description MUST be in UTF-8 [<a href="./rfc3629" title=""UTF-8, a transformation format of ISO 10646"">RFC3629</a>].
The distributions list is not newsgroup-based, and an argument MUST
NOT be specified. Otherwise, a 501 response code MUST be returned.
The distributions list MAY be empty. If the server does not maintain
the information, a 503 response code MUST be returned.
The client MAY use this information to generate or supplement a list
of known distributions provided to the user. If the news server
implements the LIST DISTRIBUTIONS command, it SHOULD also implement
the LIST DISTRIB.PATS command (defined in <a href="./rfc3977#section-7.6.5">Section 7.6.5 of [RFC3977]</a>)
and describe in the distributions list all the distributions present
in the distrib.pats list so that the client can use both of these
commands jointly (naturally, the distributions list can also describe
distributions that are not present in the distrib.pats list). Note
that the two commands need not return distributions in the same
order.
<span class="grey">Elie Standards Track [Page 9]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
<span class="grey"><a href="./rfc6048">RFC 6048</a> NNTP Additions to LIST Command November 2010</span>
<span class="h4"><a class="selflink" id="section-2.3.3" href="#section-2.3.3">2.3.3</a>. Example</span>
Example of a joint use of LIST DISTRIB.PATS and LIST DISTRIBUTIONS:
[<a id="ref-C">C</a>] CAPABILITIES
[S] 101 Capability list:
[S] VERSION 2
[S] READER
[S] LIST ACTIVE DISTRIB.PATS DISTRIBUTIONS NEWSGROUPS
[S] .
[<a href="#ref-C">C</a>] LIST DISTRIB.PATS
[S] 215 Information follows
[S] 10:local.*:local
[S] 5:france.*:fr
[S] 20:local.here.*:thissite
[S] .
[<a href="#ref-C">C</a>] LIST DISTRIBUTIONS
[S] 215 List of distributions follows
[S] fr Local to France.
[S] local Local to this news server.
[S] thissite Local to this site.
[S] usa Local to the United States of America.
[S] .
<span class="h3"><a class="selflink" id="section-2.4" href="#section-2.4">2.4</a>. LIST MODERATORS</span>
<span class="h4"><a class="selflink" id="section-2.4.1" href="#section-2.4.1">2.4.1</a>. Usage</span>
Syntax
LIST MODERATORS
Responses
215 Moderators list follows (multi-line)
<span class="h4"><a class="selflink" id="section-2.4.2" href="#section-2.4.2">2.4.2</a>. Description</span>
See <a href="./rfc3977#section-7.6.1">Section 7.6.1 of [RFC3977]</a> for general requirements of the LIST
command.
The "moderators list" is maintained by some NNTP servers to make
clients aware of how the news server will generate a submission
e-mail address when an article is locally posted to a moderated
newsgroup.
The information is returned as a multi-line data block following the
215 response code. Each line of this list MUST consist of two fields
separated from each other by a colon (":" or %x3A). The first field
is a wildmat (which may be a simple newsgroup name), and the second
<span class="grey">Elie Standards Track [Page 10]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
<span class="grey"><a href="./rfc6048">RFC 6048</a> NNTP Additions to LIST Command November 2010</span>
field is the submission address template for newsgroups matching that
wildmat. There are no leading or trailing whitespaces in a line.
The submission template MAY contain colons (":").
The submission template is essentially an e-mail address (see the
definition of "addr-spec" in <a href="./rfc5322#section-3.4.1">Section 3.4.1 of [RFC5322]</a>), except with
certain modifications. The case-sensitive string "%s" (%x25.73) MUST
occur either zero or one time in the template. If there is to be a
literal "%" in the submission address, it MUST be written as "%%" in
the template, even if not followed by an "s". The character "%" MUST
NOT occur in the submission template, except as part of "%s" or "%%".
The order of lines in the moderators list is significant: the first
matching line is used. Consequently, specific patterns should be
listed before general patterns. Every moderated newsgroup name
SHOULD be matched by at least one line in the list; often this is
achieved by having a default pattern at the bottom, but other
approaches are acceptable, and news server software MAY leave this up
to the server administrator rather than enforcing it
programmatically.
When an article without an Approved header field is locally posted to
a moderated newsgroup, the server generates a submission address from
the corresponding submission template (that is, the second field of
the first matching line in the moderators list) by replacing the
"%s", if present, with the name of the matching newsgroup after each
period ("." or %x2E) in the name has been changed to a dash ("-" or
%x2D). In addition, any "%%" is changed back to "%". The server
then forwards the submitted article to the moderator at the resulting
submission address (see <a href="./rfc5537#section-3.5.1">Section 3.5.1 of [RFC5537]</a>).
NOTE: The creation and maintenance of submission addresses is
outside the scope of this specification.
The moderators list is not newsgroup-based, and an argument MUST NOT
be specified. Otherwise, a 501 response code MUST be returned.
The moderators list MAY be empty. If the server does not maintain
the information, a 503 response code MUST be returned, although these
situations should not occur if the news server is an injecting agent
that carries moderated newsgroups.
<span class="grey">Elie Standards Track [Page 11]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
<span class="grey"><a href="./rfc6048">RFC 6048</a> NNTP Additions to LIST Command November 2010</span>
<span class="h4"><a class="selflink" id="section-2.4.3" href="#section-2.4.3">2.4.3</a>. Example</span>
Example of output:
[<a id="ref-C">C</a>] CAPABILITIES
[S] 101 Capability list:
[S] VERSION 2
[S] READER
[S] POST
[S] LIST ACTIVE MODERATORS NEWSGROUPS
[S] .
[<a href="#ref-C">C</a>] LIST MODERATORS
[S] 215 List of submission address templates follows
[S] foo.bar:announce@example.com
[S] local.*:%s@localhost
[S] *:%s@moderators.example.com
[S] .
The following table describes a few examples associating a moderated
newsgroup and its submission address on a news server whose
moderators list is the one in the previous example:
+-----------------------------+-------------------------------------+
| Name of the moderated | Submission address |
| newsgroup | |
+-----------------------------+-------------------------------------+
| foo.bar | announce@example.com |
| local.test | local-test@localhost |
| alt.dev.null | alt-dev-null@moderators.example.com |
| alt.test-me | alt-test-me@moderators.example.com |
+-----------------------------+-------------------------------------+
NOTE: When "%s" is used, periods are changed to dashes, and dashes
are left alone. This implies that two moderated newsgroups whose
names differ only by changing a period to a dash would have the
same submission address. Therefore, if a server carries such
moderated newsgroup pairs but posts should go to different
submission addresses, a "%s" pattern template cannot be used for
the moderation submission addresses for those groups, and explicit
entries without a pattern will be required.
Similarly, it is not recommended to use a "%s" pattern rule for
the moderation submission template for two moderated newsgroups
whose names differ only by the case of their characters, because
e-mail systems frequently treat the left-hand side of e-mail
addresses as case-sensitive. See also <a href="./rfc5536#section-3.1.4">Section 3.1.4 of [RFC5536]</a>
and Section 7.2 of [<a href="#ref-USEAGE" title=""Usenet Best Practice"">USEAGE</a>] for the syntax of a newsgroup name.
<span class="grey">Elie Standards Track [Page 12]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
<span class="grey"><a href="./rfc6048">RFC 6048</a> NNTP Additions to LIST Command November 2010</span>
<span class="h3"><a class="selflink" id="section-2.5" href="#section-2.5">2.5</a>. LIST MOTD</span>
<span class="h4"><a class="selflink" id="section-2.5.1" href="#section-2.5.1">2.5.1</a>. Usage</span>
Syntax
LIST MOTD
Responses
215 Information follows (multi-line)
<span class="h4"><a class="selflink" id="section-2.5.2" href="#section-2.5.2">2.5.2</a>. Description</span>
See <a href="./rfc3977#section-7.6.1">Section 7.6.1 of [RFC3977]</a> for general requirements of the LIST
command.
The "motd" contains a "message of the day" relevant to the news
server. It is intended to provide notification and communication
between the news administrator and the news user. For instance,
notification of upcoming downtime or information about new facilities
available on the news server can be communicated via the LIST MOTD
command.
The information is returned as a multi-line data block following the
215 response code. This text is not guaranteed to be in any
particular format although, like all multi-line data blocks, it is
"dot-stuffed".
The server need not return the same information if this command is
used more than once in a session. It MAY indeed send a different
message of the day depending on the state of the session. For
instance, on a mode-switching news server, the information can be
different between its transit mode and its reader mode, or between an
authenticated session and an unauthenticated session.
The information MUST be in UTF-8 [<a href="./rfc3629" title=""UTF-8, a transformation format of ISO 10646"">RFC3629</a>].
The motd is not newsgroup-based, and an argument MUST NOT be
specified. Otherwise, a 501 response code MUST be returned.
The motd MAY be empty. If the server does not maintain the
information, a 503 response code MUST be returned.
It is up to the client to decide when and how to display this message
to the user. No timestamp or date of last modification is provided
programmatically, although the news administrator may include one in
the text of the motd. The client MAY cache a local copy or
fingerprint of the motd so that it can display the message to the
user only upon modification. If the client caches the information,
<span class="grey">Elie Standards Track [Page 13]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
<span class="grey"><a href="./rfc6048">RFC 6048</a> NNTP Additions to LIST Command November 2010</span>
it MAY take into account only the motd obtained after reaching the
intended state of the session. Nonetheless, in case a privacy
extension is used, the client MUST NOT cache any motd obtained before
that extension took effect.
NOTE: Though the client MAY cache the results of this command, it
MUST NOT rely on the correctness of any cached results, whether
from earlier in the session or from a previous session. If the
motd is cached, the client SHOULD provide a way to force the
cached information to be refreshed.
<span class="h4"><a class="selflink" id="section-2.5.3" href="#section-2.5.3">2.5.3</a>. Example</span>
Example of output:
[<a id="ref-C">C</a>] CAPABILITIES
[S] 101 Capability list:
[S] VERSION 2
[S] READER
[S] LIST ACTIVE MOTD NEWSGROUPS
[S] .
[<a href="#ref-C">C</a>] LIST MOTD
[S] 215 Message of the day follows
[S] Attention all users,
[S]
[S] This server will be down for scheduled upgrades on February 1st.
[S] It should be back up by 8:00 a.m. February 2nd.
[S] Any questions should be e-mailed to <newsmaster@example.com>.
[S]
[S] Apologies for the disturbance.
[S] .
<span class="h3"><a class="selflink" id="section-2.6" href="#section-2.6">2.6</a>. LIST SUBSCRIPTIONS</span>
<span class="h4"><a class="selflink" id="section-2.6.1" href="#section-2.6.1">2.6.1</a>. Usage</span>
Syntax
LIST SUBSCRIPTIONS [wildmat]
Responses
215 Subscriptions list follows (multi-line)
Parameters
wildmat Groups of interest
<span class="grey">Elie Standards Track [Page 14]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
<span class="grey"><a href="./rfc6048">RFC 6048</a> NNTP Additions to LIST Command November 2010</span>
<span class="h4"><a class="selflink" id="section-2.6.2" href="#section-2.6.2">2.6.2</a>. Description</span>
See <a href="./rfc3977#section-7.6.1">Section 7.6.1 of [RFC3977]</a> for general requirements of the LIST
command.
The "subscriptions list" is maintained by some NNTP servers to
provide the client with a list of recommended newsgroups.
The information is returned as a multi-line data block following the
215 response code. Each line of this list MUST consist of a
newsgroup name. There are no leading or trailing whitespaces in a
line.
The order of newsgroups in the subscriptions list is significant:
they are listed by order of importance, the first newsgroup being the
most important to subscribe to.
The same newsgroup name SHOULD NOT appear twice in the output of this
command. The subscriptions list SHOULD contain only newsgroups the
news server carries.
The subscriptions list is newsgroup-based, and a wildmat MAY be
specified, in which case the response is limited to only the groups,
if any, whose names match the wildmat. Note that the wildmat
argument is a new feature in this specification, and servers that do
not support CAPABILITIES or do not advertise the SUBSCRIPTIONS
keyword in the LIST capability (and therefore do not conform to this
specification) are unlikely to support it.
The subscriptions list MAY be empty. If the server does not maintain
the information, a 503 response code MUST be returned.
The client MAY use this information the first time it connects to the
news server so as to initialize the list of default subscribed
newsgroups. This list should therefore contain groups intended for
new users on the news server or Usenet in general (for instance,
newsgroups dedicated to testing, support, announcement, or FAQs).
The client MAY present the groups in the order of appearance in the
list to the user. When the subscriptions list is maintained and
non-empty, the news client SHOULD use it, instead of a hard-coded
default list, if any.
<span class="grey">Elie Standards Track [Page 15]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
<span class="grey"><a href="./rfc6048">RFC 6048</a> NNTP Additions to LIST Command November 2010</span>
<span class="h4"><a class="selflink" id="section-2.6.3" href="#section-2.6.3">2.6.3</a>. Examples</span>
Example of output with no argument:
[<a id="ref-C">C</a>] CAPABILITIES
[S] 101 Capability list:
[S] VERSION 2
[S] READER
[S] LIST ACTIVE NEWSGROUPS SUBSCRIPTIONS
[S] .
[<a href="#ref-C">C</a>] LIST SUBSCRIPTIONS
[S] 215 List of recommended newsgroups follows
[S] local.welcome
[S] local.test
[S] news.newusers.questions
[S] news.announce.newusers
[S] .
Example of output with a wildmat:
[<a id="ref-C">C</a>] LIST SUBSCRIPTIONS local.*
[S] 215 List of recommended newsgroups follows
[S] local.welcome
[S] local.test
[S] .
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Additions to LIST ACTIVE</span>
This document specifies three new status field values that can be
used in the answers to LIST ACTIVE: "x", "j", and "=" followed by the
name of a newsgroup.
<span class="h3"><a class="selflink" id="section-3.1" href="#section-3.1">3.1</a>. New Status Field Values</span>
The LIST ACTIVE command is defined in <a href="./rfc3977#section-7.6.3">Section 7.6.3 of [RFC3977]</a>.
The fourth field of each line of this list indicates the current
status of the newsgroup whose name is specified in the first field.
Three status field values are defined in [<a href="./rfc3977" title=""Network News Transfer Protocol (NNTP)"">RFC3977</a>]:
"y" Posting is permitted.
"n" Posting is not permitted.
"m" Postings will be forwarded to the newsgroup moderator.
<span class="grey">Elie Standards Track [Page 16]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
<span class="grey"><a href="./rfc6048">RFC 6048</a> NNTP Additions to LIST Command November 2010</span>
This document defines three other case-sensitive status field values
that can also be used:
"x" Postings and articles from peers are not permitted.
"j" Only articles from peers are permitted; no articles are locally
filed.
"=other.group" Only articles from peers are permitted, and are filed
under the newsgroup named "other.group".
The server SHOULD use these values when these meanings are required
and MUST NOT use them with any other meaning.
A newsgroup with status "x" is a newsgroup with status "n", except
that articles from peers are not accepted. A newsgroup with status
"x" is considered as closed: no new articles will arrive in such a
group. On the contrary, articles from peers will arrive in a
newsgroup with status "n". Local postings are not allowed in a
newsgroup with either of these two status field values.
A newsgroup with status "j" is a newsgroup with status "y", except
that (1) local postings are not accepted, (2) articles received from
a peer that are crossposted to one or more valid groups are filed
only into those valid groups, and (3) articles received from a peer
that are not crossposted to any valid groups are not filed into any
newsgroup, but are still propagated to other peers, if appropriate.
NOTE: Instead of not filing at all an article posted to a
newsgroup with status "j", a news server MAY file it under a
catch-all group if no valid group is applicable. When a news
server uses a catch-all group to file the articles posted to
newsgroups with status "j", this catch-all group SHOULD be named
"junk". (The first letter of the "junk" newsgroup explains why
this status has been called "j".)
Consequently, when a news server carries the "junk" newsgroup and
uses it for the purpose of the "j" status, the "junk" newsgroup
contains all postings not filed under another newsgroup,
regardless of the status of the "junk" newsgroup. (However, an
article posted explicitly to "junk" is treated according to the
status of the "junk" newsgroup.)
The "junk" newsgroup may be available to news readers and is often
used by a news server as a way to locally store an article that
will be transmitted to peers (which may carry some of the
newsgroups the article was posted to even if the local server does
not). In addition, instead of rejecting an article that contains
<span class="grey">Elie Standards Track [Page 17]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
<span class="grey"><a href="./rfc6048">RFC 6048</a> NNTP Additions to LIST Command November 2010</span>
an invalid Newsgroups header field or that is posted to newsgroups
it does not carry, a news server may accept such an article and
file it under the catch-all newsgroup.
Depending on the configuration of the news server, mentioning a
newsgroup with status "j" is different than simply not listing the
group, since articles arriving for unknown newsgroups may be
rejected.
When the status field value begins with an equal sign ("=" or %x3D),
a newsgroup name on the news server MUST immediately follow the sign.
If the status of "foo.bar" is "=other.group", it means that "foo.bar"
is an alias for "other.group". These two newsgroups are distinct;
they do not share their articles or their article numbers. Local
postings to "foo.bar" are not allowed, but articles from peers are
accepted for "foo.bar" and filed into "other.group", regardless of
the status of "other.group". The contents of their Newsgroups header
fields MUST NOT be altered.
Alias groups are typically used during a transition between two
newsgroups, including but not limited to a renaming of a group, or a
correction of a misspelled group name.
The status of the newsgroup an alias points to MUST NOT be taken into
account when an article arrives in an alias newsgroup. In
particular, it means that unapproved articles arriving from peers in
an alias pointing to a moderated newsgroup are accepted and filed
into this moderated newsgroup. Therefore, an alias SHOULD NOT point
to a moderated newsgroup, since it allows bypassing of the
moderation.
An alias SHOULD NOT point to itself or another alias group. The
newsgroup an alias points to SHOULD exist on the news server, and be
visible to any client that can see the original group. However, when
a client issues a LIST ACTIVE command with a wildmat including the
original group, the newsgroup it points to is not listed in the
response (unless of course the second newsgroup also matches the
wildmat).
NOTE: If a server files newsgroups with status "j" into "junk", a
newsgroup with status "j" and a newsgroup with status "=junk" are
different. An article fed by a peer, and crossposted to a group
with status "j", will result in the article being filed only in
"junk" if there are no other groups with which to file it, or
otherwise only in other valid newsgroups it is crossposted to. On
the other hand, an article fed by a peer, and crossposted to a
group with status "=junk", will result in the article being filed
in "junk" and in other valid newsgroups it is crossposted to.
<span class="grey">Elie Standards Track [Page 18]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
<span class="grey"><a href="./rfc6048">RFC 6048</a> NNTP Additions to LIST Command November 2010</span>
The following table summarizes what usually happens to an article
posted to only the newsgroup "foo.bar", depending on its status field
value on the news server:
+---------------+------------+-----------+------------+-------------+
| Status field | Accepted | Accepted | Moderation | Destination |
| value of | if local | from | needed? | if accepted |
| "foo.bar" | posting? | peers? | | |
+---------------+------------+-----------+------------+-------------+
| y | Yes | Yes | No | foo.bar |
| n | No | Yes | No | foo.bar |
| m | Yes | Yes | Yes | foo.bar |
| x | No | No | No | |
| j | No | Yes | No | junk (if |
| | | | | filed) |
| =other.group | No | Yes | No | other.group |
+---------------+------------+-----------+------------+-------------+
The following table summarizes what usually happens to an article
crossposted to the newsgroup "foo.bar" and a valid newsgroup
"misc.test" (whose status field is "y") known by the news server,
depending on the status field value of "foo.bar" on the news server:
+---------------+-----------+-----------+------------+--------------+
| Status field | Accepted | Accepted | Moderation | Destination |
| value of | if local | from | needed? | if accepted |
| "foo.bar" | posting? | peers? | | |
+---------------+-----------+-----------+------------+--------------+
| y | Yes | Yes | No | foo.bar, |
| | | | | misc.test |
| n | No | Yes | No | foo.bar, |
| | | | | misc.test |
| m | Yes | Yes | Yes | foo.bar, |
| | | | | misc.test |
| x | No | Yes | No | misc.test |
| j | No | Yes | No | misc.test |
| =other.group | No | Yes | No | other.group, |
| | | | | misc.test |
+---------------+-----------+-----------+------------+--------------+
NOTE: The status of a newsgroup only indicates how articles
arriving for that newsgroup are normally processed; news servers
MAY provide clients with special privileges to allow or disallow
some rights in these newsgroups. This specification defines
neither these rights nor whether or not articles posted to these
groups should be propagated to other peers.
<span class="grey">Elie Standards Track [Page 19]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
<span class="grey"><a href="./rfc6048">RFC 6048</a> NNTP Additions to LIST Command November 2010</span>
<span class="h3"><a class="selflink" id="section-3.2" href="#section-3.2">3.2</a>. Examples</span>
Example of an article posted to an alias group by a peer:
[<a id="ref-C">C</a>] LIST ACTIVE
[S] 215 List of newsgroups follows
[S] foo.bar 21 12 y
[S] misc.test 3002322 3000234 =foo.bar
[S] .
[<a href="#ref-C">C</a>] IHAVE <for.misc.test@example.com>
[S] 335 Send it; end with <CR-LF>.<CR-LF>
[<a href="#ref-C">C</a>] Path: demo!.POSTED.somewhere!not-for-mail
[<a href="#ref-C">C</a>] From: "Demo User" <nobody@example.com>
[<a href="#ref-C">C</a>] Newsgroups: misc.test
[<a href="#ref-C">C</a>] Subject: I am just a test article
[<a href="#ref-C">C</a>] Date: 18 Oct 2008 16:02:45 +0200
[<a href="#ref-C">C</a>] Organization: An example, Paris, FR.
[<a href="#ref-C">C</a>] Message-ID: <for.misc.test@example.com>
[<a href="#ref-C">C</a>] MIME-Version: 1.0
[<a href="#ref-C">C</a>]
[<a href="#ref-C">C</a>] This is just a test article.
[<a href="#ref-C">C</a>] .
[S] 235 Article transferred OK
[<a href="#ref-C">C</a>] LIST ACTIVE
[S] 215 List of newsgroups follows
[S] foo.bar 22 12 y
[S] misc.test 3002322 3000234 =foo.bar
[S] .
[<a href="#ref-C">C</a>] HDR Xref <for.misc.test@example.com>
[S] 225 Header information follows
[S] 0 news.example.com foo.bar:22
[S] .
[<a href="#ref-C">C</a>] HDR Newsgroups <for.misc.test@example.com>
[S] 225 Header information follows
[S] 0 misc.test
[S] .
The Newsgroups header field of this article is kept untouched. This
article is filed under "foo.bar" even though it has originally been
posted to the newsgroup "misc.test". Yet, it still propagates to
peers that have been configured to receive articles posted to
"misc.text".
<span class="grey">Elie Standards Track [Page 20]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span>
<span class="grey"><a href="./rfc6048">RFC 6048</a> NNTP Additions to LIST Command November 2010</span>
Example of an article locally posted to an alias group:
[<a id="ref-C">C</a>] LIST ACTIVE
[S] 215 List of newsgroups follows
[S] foo.bar 22 12 y
[S] misc.test 3002322 3000234 =foo.bar
[S] .
[<a href="#ref-C">C</a>] POST
[S] 340 Input article; end with <CR-LF>.<CR-LF>
[<a href="#ref-C">C</a>] From: "Demo User" <nobody@example.com>
[<a href="#ref-C">C</a>] Newsgroups: misc.test
[<a href="#ref-C">C</a>] Subject: I am just a test article
[<a href="#ref-C">C</a>] MIME-Version: 1.0
[<a href="#ref-C">C</a>]
[<a href="#ref-C">C</a>] This is just a test article.
[<a href="#ref-C">C</a>] .
[S] 441 Newsgroup "misc.test" has been renamed to "foo.bar"
The article is rejected, with a detailed error.
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Augmented BNF Syntax for These Additions to the LIST Command</span>
This section describes the formal syntax of the new LIST variants
defined in this document using [<a href="./rfc5234" title=""Augmented BNF for Syntax Specifications: ABNF"">RFC5234</a>]. It extends the syntax in
<a href="./rfc3977#section-9">Section 9 of [RFC3977]</a>, and non-terminals not defined in this
document are defined there. The [<a href="./rfc3977" title=""Network News Transfer Protocol (NNTP)"">RFC3977</a>] ABNF should be imported
first, before attempting to validate these rules.
<span class="h3"><a class="selflink" id="section-4.1" href="#section-4.1">4.1</a>. Commands</span>
This syntax extends the non-terminal <list-arguments>, which
represents the variants of the LIST command.
; counts
list-arguments =/ "COUNTS" [WS wildmat]
; distributions, moderators, motd
list-arguments =/ "DISTRIBUTIONS" / "MODERATORS" / "MOTD"
; subscriptions
list-arguments =/ "SUBSCRIPTIONS" [WS wildmat]
<span class="h3"><a class="selflink" id="section-4.2" href="#section-4.2">4.2</a>. Responses</span>
This syntax extends the non-terminals <newsgroup-status> and
<list-content>, which represent the status field value returned by
the LIST ACTIVE command and the response contents for the LIST
command, respectively.
<span class="grey">Elie Standards Track [Page 21]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span>
<span class="grey"><a href="./rfc6048">RFC 6048</a> NNTP Additions to LIST Command November 2010</span>
; active
newsgroup-status =/ newsgroup-alias /
%x78 / %x6a ; case-sensitive "x" and "j"
newsgroup-alias = "=" newsgroup-name
; counts
list-content =/ list-counts-content
list-counts-content =
*(newsgroup-name 3(SPA article-number)
SPA newsgroup-status CRLF)
; distributions
list-content =/ list-distributions-content
list-distributions-content =
*(distribution WS distribution-description CRLF)
distribution-description = U-TEXT
; moderators
list-content =/ list-moderators-content
list-moderators-content =
*(wildmat ":" moderators-address CRLF)
moderators-address = S-TEXT
; motd
list-content =/ list-motd-content
list-motd-content = *(*U-CHAR CRLF)
; subscriptions
list-content =/ list-subscriptions-content
list-subscriptions-content = *(newsgroup-name CRLF)
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Internationalization Considerations</span>
No new internationalization considerations are introduced by this
extension, beyond those already described in the core specification
[<a href="./rfc3977" title=""Network News Transfer Protocol (NNTP)"">RFC3977</a>].
In particular, newsgroup names SHOULD be restricted to US-ASCII
[<a href="#ref-ASCII" title=""Coded Character Sets - 7-Bit American Standard Code for Information Interchange (7-Bit ASCII), ANSI X3.4"">ASCII</a>] until a successor to [<a href="./rfc5536" title=""Netnews Article Format"">RFC5536</a>] standardizes another approach.
Distribution descriptions and the message of the day MUST be in UTF-8
[<a href="./rfc3629" title=""UTF-8, a transformation format of ISO 10646"">RFC3629</a>].
<span class="grey">Elie Standards Track [Page 22]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span>
<span class="grey"><a href="./rfc6048">RFC 6048</a> NNTP Additions to LIST Command November 2010</span>
<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. Security Considerations</span>
No new security considerations are introduced by this extension,
beyond those already described in the core specification [<a href="./rfc3977" title=""Network News Transfer Protocol (NNTP)"">RFC3977</a>]
and the Netnews Architecture and Protocols specification [<a href="./rfc5537" title=""Netnews Architecture and Protocols"">RFC5537</a>]
(especially distribution leakage and e-mail Denial of Service during
the moderation process).
<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. IANA Considerations</span>
This section gives a formal definition of this extension as required
by <a href="./rfc3977#section-3.3.3">Section 3.3.3 of [RFC3977]</a> for the IANA registry. It extends the
LIST capability label defined in <a href="./rfc3977#section-7.6">Section 7.6 of [RFC3977]</a>.
o This extension provides additional keywords to the pre-existing
LIST capability defined in <a href="./rfc3977#section-7.6">Section 7.6 of [RFC3977]</a>. New status
field values are also added to the ACTIVE variant of the LIST
command.
o The capability label that this extension extends is "LIST".
o This extension adds five optional arguments to the "LIST"
capability label: "COUNTS", "DISTRIBUTIONS", "MODERATORS", "MOTD",
and "SUBSCRIPTIONS", indicating which new variants of the LIST
command are supported. Consequently, this extension associates
these new arguments with the pre-existing "LIST" NNTP command.
o This extension defines five new commands, LIST COUNTS, LIST
DISTRIBUTIONS, LIST MODERATORS, LIST MOTD, and LIST SUBSCRIPTIONS,
whose behavior, arguments, and responses are defined in
Sections <a href="#section-2.2">2.2</a>, <a href="#section-2.3">2.3</a>, <a href="#section-2.4">2.4</a>, <a href="#section-2.5">2.5</a>, and <a href="#section-2.6">2.6</a>, respectively.
o This extension does not associate any new responses with pre-
existing NNTP commands.
o This extension does not affect the maximum length of commands or
initial response lines.
o This extension does not alter pipelining. The LIST COUNTS, LIST
DISTRIBUTIONS, LIST MODERATORS, LIST MOTD, and LIST SUBSCRIPTIONS
commands can be pipelined.
o Use of this extension does not alter the capabilities list.
o This extension does not cause any pre-existing command to produce
a 401, 480, or 483 response.
<span class="grey">Elie Standards Track [Page 23]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span>
<span class="grey"><a href="./rfc6048">RFC 6048</a> NNTP Additions to LIST Command November 2010</span>
o This extension is unaffected by any use of the MODE READER
command.
o This extension does not affect the overall behavior of a server or
client other than via the new commands.
o Published Specification: This document.
o Contact for Further Information: Author of this document.
o Change Controller: IESG <iesg@ietf.org>.
<span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. Acknowledgements</span>
The author gratefully acknowledges the comments and additional
information provided by Russ Allbery, Urs Janssen, Antti-Juhani
Kaijanaho, Alexey Melnikov, Peter Saint-Andre, Dieter Stussy, and
Sean Turner on this document.
The author would particularly like to thank Jeffrey M. Vinocur for
having reread, improved, and patiently fixed the English wording and
the quality of this document.
Special thanks are due to:
Stan Barber, whose text in [<a href="./rfc2980" title=""Common NNTP Extensions"">RFC2980</a>] served as the initial basis
for the DISTRIBUTIONS and SUBSCRIPTIONS variants of the LIST
command.
Brian Hernacki, whose text in [<a href="#ref-NNTP_LIST" title=""NNTP LIST Additions"">NNTP_LIST</a>] served as the initial
basis for the MOTD and also the SUBSCRIPTIONS variants of the LIST
command.
The authors of the documentation of a few sample files of the
InterNetNews news server ("active", "distributions", "moderators",
"motd.news", and "subscriptions"): Russ Allbery, Bettina Fink,
Rich Salz, and a few other people to whom I am also grateful.
<span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>. References</span>
<span class="h3"><a class="selflink" id="section-9.1" href="#section-9.1">9.1</a>. Normative References</span>
[<a id="ref-RFC2119">RFC2119</a>] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>, March 1997.
[<a id="ref-RFC3629">RFC3629</a>] Yergeau, F., "UTF-8, a transformation format of ISO
10646", STD 63, <a href="./rfc3629">RFC 3629</a>, November 2003.
<span class="grey">Elie Standards Track [Page 24]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span>
<span class="grey"><a href="./rfc6048">RFC 6048</a> NNTP Additions to LIST Command November 2010</span>
[<a id="ref-RFC3977">RFC3977</a>] Feather, C., "Network News Transfer Protocol (NNTP)",
<a href="./rfc3977">RFC 3977</a>, October 2006.
[<a id="ref-RFC5234">RFC5234</a>] Crocker, D. and P. Overell, "Augmented BNF for Syntax
Specifications: ABNF", STD 68, <a href="./rfc5234">RFC 5234</a>, January 2008.
[<a id="ref-RFC5322">RFC5322</a>] Resnick, P., Ed., "Internet Message Format", <a href="./rfc5322">RFC 5322</a>,
October 2008.
<span class="h3"><a class="selflink" id="section-9.2" href="#section-9.2">9.2</a>. Informative References</span>
[<a id="ref-ASCII">ASCII</a>] American National Standards Institute, "Coded Character
Sets - 7-Bit American Standard Code for Information
Interchange (7-Bit ASCII), ANSI X3.4", 1986.
[<a id="ref-NNTP_LIST">NNTP_LIST</a>] Hernacki, B., <a style="text-decoration: none" href='https://www.google.com/search?sitesearch=datatracker.ietf.org%2Fdoc%2Fhtml%2F&q=inurl:draft-+%22NNTP+LIST+Additions%22'>"NNTP LIST Additions"</a>, Work in Progress,
July 1997.
[<a id="ref-RFC2980">RFC2980</a>] Barber, S., "Common NNTP Extensions", <a href="./rfc2980">RFC 2980</a>,
October 2000.
[<a id="ref-RFC5536">RFC5536</a>] Murchison, K., Lindsey, C., and D. Kohn, "Netnews
Article Format", <a href="./rfc5536">RFC 5536</a>, November 2009.
[<a id="ref-RFC5537">RFC5537</a>] Allbery, R. and C. Lindsey, "Netnews Architecture and
Protocols", <a href="./rfc5537">RFC 5537</a>, November 2009.
[<a id="ref-USEAGE">USEAGE</a>] Lindsey, C., <a style="text-decoration: none" href='https://www.google.com/search?sitesearch=datatracker.ietf.org%2Fdoc%2Fhtml%2F&q=inurl:draft-+%22Usenet+Best+Practice%22'>"Usenet Best Practice"</a>, Work in Progress,
March 2005.
Author's Address
Julien Elie
13 rue Marx Dormoy
Noisy-le-Grand 93160
France
EMail: julien@trigofacile.com
URI: <a href="http://www.trigofacile.com/">http://www.trigofacile.com/</a>
Elie Standards Track [Page 25]
</pre>
|