.\" Automatically generated by Pod::Man 4.14 (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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "GETLIST 1"
.TH GETLIST 1 "2022-07-10" "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 \s-1NNTP\s0 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 \fBactive\fR\|(5),
\&\fBactive.times\fR\|(5), \fBdistrib.pats\fR\|(5) and \fBnewsgroups\fR\|(5).
.PP
The listing files other than the \fIactive\fR file are common extensions to the
\&\s-1NNTP\s0 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 \fBdistributions\fR\|(5),
\&\fBmoderators\fR\|(5), \fBmotd.news\fR\|(5) and \fBsubscriptions\fR\|(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 \s-1HDR\s0 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
\&\fBpasswd.nntp\fR\|(5) before issuing the \s-1LIST\s0 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 \s-1NNTPSERVER\s0 environment variable.
.IP "\fB\-p\fR \fIport\fR" 4
.IX Item "-p port"
Connect to the port \fIport\fR, which is by default \f(CW119\fR.
.IP "\fB\-R\fR" 4
.IX Item "-R"
Try to switch to \fBnnrpd\fR with a \s-1MODE READER\s0 command before issuing the
\&\s-1LIST\s0 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 \s-1UUNET:\s0
.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 <chongo@toad.com> for InterNetNews.  Rewritten
in \s-1POD\s0 by Russ Allbery <eagle@eyrie.org>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBactive\fR\|(5), \fBactive.times\fR\|(5), \fBdistrib.pats\fR\|(5), \fBdistributions\fR\|(5), \fBinn.conf\fR\|(5),
\&\fBlibinn_uwildmat\fR\|(3), \fBmoderators\fR\|(5), \fBmotd.news\fR\|(5), \fBnewsgroups\fR\|(5), \fBnnrpd\fR\|(8),
\&\fBpasswd.nntp\fR\|(5), \fBsubscriptions\fR\|(5).