chiark / gitweb /
Commit 2.4.5-5 as unpacked
[innduct.git] / doc / pod / subscriptions.pod
1 =head1 NAME
2
3 subscriptions - Default recommended subscriptions
4
5 =head1 DESCRIPTION
6
7 The I<pathetc>/F<subscriptions> file contains a list of newsgroups that is
8 returned by the NNTP command LIST SUBSCRIPTIONS.
9
10 Clients that support this command and send it the first time they connect
11 to a new news server use the returned list to initialize the list of
12 subscribed newsgroups.  The F<subscriptions> file therefore should contain
13 groups intented for new users, for testing, or that contain FAQs and other
14 useful information for first-time Usenet users.
15
16 The syntax of the F<subscriptions> file is trivial; it is a simple list of
17 newsgroup names, one per line.  The order of newsgroups may be
18 significant; the news reading client may present the groups in that order
19 to the user.
20
21 =head1 EXAMPLE
22
23 A typical F<subscriptions> file may look like:
24
25     news.announce.newusers
26     news.newusers.questions
27     local.test
28     local.general
29     local.talk
30     misc.test
31     misc.test.moderated
32     news.answers
33     news.announce.newgroups
34
35 This gives the client the FAQs and question newsgroup for new users first,
36 then a local newsgroup for testing and various commonly-read local
37 discussion groups, followed by the world-wide test groups, all the FAQs,
38 and announcements of new world-wide newsgroups.  If there is a local new
39 users group, one might want to list it first.
40
41 =head1 HISTORY
42
43 Written by Bettina Fink <laura@hydrophil.de> for InterNetNews.
44
45 =head1 SEE ALSO
46
47 nnrpd(8).
48
49 =cut