.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "GETLIST 1" .TH GETLIST 1 2024-04-01 "INN 2.7.2" "InterNetNews Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME getlist \- Get a list from an NNTP server .SH SYNOPSIS .IX Header "SYNOPSIS" \&\fBgetlist\fR [\fB\-AR\fR] [\fB\-h\fR \fIhost\fR] [\fB\-p\fR \fIport\fR] [\fIlist\fR [\fIpattern\fR [\fItypes\fR]]] .SH DESCRIPTION .IX Header "DESCRIPTION" \&\fBgetlist\fR obtains a list from an NNTP server and sends it to standard output. \fIlist\fR may be one of \f(CW\*(C`active\*(C'\fR (which is the default value), \&\f(CW\*(C`active.times\*(C'\fR, \f(CW\*(C`distrib.pats\*(C'\fR, or \f(CW\*(C`newsgroups\*(C'\fR. \f(CW\*(C`active\*(C'\fR contains a list of all newsgroups carried by the server with the high and low article numbers in the group, and the group status field. \f(CW\*(C`active.times\*(C'\fR is a list of newsgroups, their creation times (in seconds since epoch), and the creator of the group. \f(CW\*(C`distrib.pats\*(C'\fR is a list of relevant distributions and the newsgroups they apply to. \f(CW\*(C`newsgroups\*(C'\fR is a list of newsgroups along with their short descriptions. .PP For more information on the formats of these files, see active(5), active.times(5), distrib.pats(5) and newsgroups(5). .PP The listing files other than the \fIactive\fR file are common extensions to the NNTP protocol and may not be available on all servers. For instance, \f(CW\*(C`counts\*(C'\fR \&\f(CW\*(C`distributions\*(C'\fR, \f(CW\*(C`headers\*(C'\fR, \f(CW\*(C`moderators\*(C'\fR, \f(CW\*(C`motd\*(C'\fR, \f(CW\*(C`overview.fmt\*(C'\fR and \&\f(CW\*(C`subscriptions\*(C'\fR, amongst other, may be available. Moreover, a \fIuwildmat\fR pattern \fIpattern\fR may also be usable for some of these listing files. .PP For more information on the formats of these files, see distributions(5), moderators(5), motd.news(5) and subscriptions(5). The overview fields obtained with \f(CW\*(C`overview.fmt\*(C'\fR are the ones for which the overview database is consistent (see \fIextraoverviewadvertised\fR in \fIinn.conf\fR for more information). The list obtained with \f(CW\*(C`headers\*(C'\fR contains the fields that can be retrieved using the HDR command (\fIpattern\fR can then be either \f(CW\*(C`msgid\*(C'\fR or \f(CW\*(C`range\*(C'\fR). The list obtained with \f(CW\*(C`counts\*(C'\fR is like the \f(CW\*(C`active\*(C'\fR one except that the number of articles in a newsgroup is mentioned just before the flag of this newsgroup. .PP The \fIpattern\fR parameter may be used with a \fIlist\fR value of \f(CW\*(C`active\*(C'\fR, \&\f(CW\*(C`active.times\*(C'\fR or \f(CW\*(C`newsgroups\*(C'\fR to limit the output. If given, only entries corresponding to newsgroups that match the \fIuwildmat\fR pattern \&\fIpattern\fR will be printed. .PP If the \fIlist\fR parameter is \f(CW\*(C`active\*(C'\fR, a third parameter, \fItypes\fR, may also be used to restrict the list. If given, only entries corresponding to newsgroups with a newsgroup mode found in \fItypes\fR will be printed. For example, a \fItypes\fR value of \f(CW\*(C`y\*(C'\fR would only show unmoderated groups, and a \fItypes\fR value of \f(CW\*(C`ym\*(C'\fR would show all unmoderated and moderated groups but not aliased groups or groups that disallow postings. .SH OPTIONS .IX Header "OPTIONS" .IP \fB\-A\fR 4 .IX Item "-A" Try to authenticate using the username and password information in passwd.nntp(5) before issuing the LIST command. .IP "\fB\-h\fR \fIhost\fR" 4 .IX Item "-h host" Connect to the server \fIhost\fR rather than to the value of \fIserver\fR in \&\fIinn.conf\fR or the value of the NNTPSERVER environment variable. .IP "\fB\-p\fR \fIport\fR" 4 .IX Item "-p port" Connect to the port \fIport\fR, which is by default \f(CW\*(C`119\*(C'\fR. .IP \fB\-R\fR 4 .IX Item "-R" Try to switch to \fBnnrpd\fR with a MODE READER command before issuing the LIST request. It can be useful in case a feeding access exists for the news server: more information can be retrieved from \fBnnrpd\fR, compared with \fBinnd\fR. .SH EXAMPLES .IX Header "EXAMPLES" The following command will obtain the one-line descriptions of all newsgroups found on UUNET: .PP .Vb 1 \& getlist \-h news.uu.net newsgroups .Ve .PP The following command will show the active file entries for all moderated comp.* groups on the default server: .PP .Vb 1 \& getlist active \*(Aqcomp.*\*(Aq m .Ve .PP The following command lists all groups where local postings are permitted, are moderated or aliased: .PP .Vb 1 \& getlist active \*(Aq*\*(Aq ym= .Ve .PP Note that the wildcard character \f(CW\*(C`*\*(C'\fR has to be quoted by simple quotes to protect it from the shell. .SH HISTORY .IX Header "HISTORY" Written by Landon Curt Noll for InterNetNews. Rewritten in POD by Russ Allbery . .SH "SEE ALSO" .IX Header "SEE ALSO" active(5), active.times(5), distrib.pats(5), distributions(5), inn.conf(5), libinn_uwildmat(3), moderators(5), motd.news(5), newsgroups(5), nnrpd(8), passwd.nntp(5), subscriptions(5).