chiark / gitweb /
debugging for thing that crashed
[innduct.git] / doc / man / getlist.1
1 .\" $Revision: 5909 $
2 .TH GETLIST 1
3 .SH NAME
4 getlist \- get a list from an NNTP server
5 .SH SYNOPSIS
6 .I getlist
7 [
8 .B \-A
9 ]
10 [
11 .BI \-h " host"
12 ]
13 [
14 .I list
15 [
16 .I pattern
17 [
18 .I types
19 ]
20 ]
21 ]
22 .SH DESCRIPTION
23 The
24 .I getlist
25 program obtains a list from an NNTP server and sends
26 it to standard output.
27 .PP
28 The
29 .B list
30 may be one of
31 .IR active ,
32 .IR active.times ,
33 .IR distributions ,
34 or
35 .IR newsgroups .
36 These values request the
37 .IR active ,
38 .IR active.times ,
39 .IR <pathetc\ in\ inn.conf>/distributions .
40 or
41 .I <pathdb in inn.conf>/newsgroups
42 files, respectively.
43 .SH OPTIONS
44 .TP
45 .B \-A
46 If the ``\fB\-A\fP'' flag is used, then the program tries to authenticate
47 as per
48 .I passwd.nntp
49 before issuing LIST command.
50 .TP
51 .B \-h
52 If the ``\fB\-h\fP'' flag is used, then the program connects to the server
53 on the specified host.
54 The default is to connect to the server specified in the
55 .I inn.conf
56 file.
57 .PP
58 If the
59 .I list
60 parameter is
61 .IR active ,
62 then the 
63 .I pattern
64 and
65 .I types
66 parameters may be used to limit the output.
67 When
68 .I pattern
69 is used, only active lines with groups that match according to
70 .IR uwildmat (3)
71 are printed.
72 When
73 .I types
74 is also given, only active lines that have a fourth field starting
75 with a character found in
76 .I types
77 are printed.
78 .PP
79 For example, the following command will obtain the one-line descriptions
80 of all newsgroups found on UUNET:
81 .RS
82 getlist -h news.uu.net newsgroups
83 .RE
84 .PP
85 The following line lists all groups where local postings are permitted,
86 are moderated or aliased:
87 .RS
88 getlist active '*' ym=
89 .RE
90 .PP
91 Note that the listing files other than the active file is a common
92 extension to the NNTP protocol and may not be available on all servers.
93 .SH HISTORY
94 Written by Landon Curt Noll <chongo@toad.com> for InterNetNews.
95 .de R$
96 This is revision \\$3, dated \\$4.
97 ..
98 .SH "SEE ALSO"
99 active(5), active.times(5), inn.conf(5), nnrpd(8), uwildmat(3).