File: nglister.sgml

package info (click to toggle)
nglister 1.0.1%2Bnmu1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd, squeeze, wheezy
  • size: 304 kB
  • ctags: 13
  • sloc: makefile: 133; python: 57
file content (201 lines) | stat: -rw-r--r-- 7,200 bytes parent folder | download | duplicates (5)
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
<!-- -*- DocBook -*- -->
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
  <!ENTITY OfflineIMAP "<application>OfflineIMAP</application>">
  <!ENTITY NGLister "<application>NGLister</application>">
]>
<!--      "file:///usr/share/sgml/docbook/dtd/xml/4.2/docbookx.dtd"> -->

<reference>
  <title>NGLister Manual</title>

  <refentry>
    <refentryinfo>
      <address><email>jgoerzen@complete.org</email></address>
      <author><firstname>John</firstname><surname>Goerzen</surname></author>
      <date> $Date: 2003-01-29 14:36:13 -0600 (Wed, 29 Jan 2003) $ </date>
    </refentryinfo>

    <refmeta>
      <refentrytitle>nglister</refentrytitle>
      <manvolnum>1</manvolnum>
      <refmiscinfo>John Goerzen</refmiscinfo>
    </refmeta>

    <refnamediv>
      <refname>NGLister</refname>
      <refpurpose>Tool to download newsgroup information from news servers
      </refpurpose>
    </refnamediv>

    <refsynopsisdiv>
      <cmdsynopsis>
	<command>nglister</command>
	<arg>-u <replaceable>username</replaceable></arg>
	<arg>-p <replaceable>password</replaceable></arg>
	<arg>-P <replaceable>port</replaceable></arg>
	<arg choice="plain"><replaceable>hostname</replaceable></arg>
	<arg choice="plain"><replaceable>filename</replaceable></arg>
      </cmdsynopsis>
      <cmdsynopsis>
	<command>nglister</command>
	<group choice="plain"><arg>-h</arg><arg>--help</arg></group>
      </cmdsynopsis>
    </refsynopsisdiv>

    <refsect1>
      <title>Description</title>

      <para>&NGLister; is a tool to download information about
	groups and other information available on an NNTP (Usenet
	news) server.  It is designed to be fast and simple;
	just specify the server and the information you want,
	and &NGLister; will send it to standard output.
      </para>

      <para>You can write the information to a file by appending:</para>

      <para><command>&gt; <replaceable>filename</replaceable></command>
      </para>

      <para>to the end of your command-line.</para>
    </refsect1>
    <refsect1>
      <title>Installation</title>
      <para>To install &NGLister;, you will need a current version of
	<ulink url="http://www.python.org/">Python</ulink>.
	  &NGLister; requires only one other piece of software:
	Optik.  You can find it at
	<ulink url="http://prdownloads.sourceforge.net/optik/Optik-1.3.tar.gz"></ulink>.
      </para>

      <para>
	To install, run this command as root: <command>python setup.py install</command>
      </para>
    </refsect1>
    
    <refsect1>
      <title>Options</title>
      <variablelist>
	<varlistentry><term>-u <replaceable>username</replaceable></term>
	  <listitem><para>Specifies the user name to use for logging into
	    the server.  Use this only if your server requires authentication.
	  </para></listitem>
	</varlistentry>

	<varlistentry><term>-p <replaceable>password</replaceable></term>
	  <listitem><para>Specifies the password to use for logging into
	    the server.  Use this only if your server requires a password.
	  </para></listitem>
	</varlistentry>

	<varlistentry><term>-P <replaceable>port</replaceable></term>
	  <listitem><para>Specifies the numeric port to use when connecting.
	    Most servers listen on port 119, the default NNTP port,
	    so that value is used by the default.  This option will
	    only be needed rarely.
	  </para></listitem>
	</varlistentry>

	<varlistentry><term><replaceable>hostname</replaceable></term>
	  <listitem><para>Specifies the name of the NNTP server.
	  </para></listitem>
	</varlistentry>

	<varlistentry><term><replaceable>filename</replaceable></term>
	  <listitem><para>Specifies the name of the data to retrieve
	    from the remote NNTP server.  Most people will use
	    <filename>active</filename> or
	    <filename>newsgroups</filename> here.  The set of files
	    supported varies from one server to the next.  Please
	    note that this parameter does <emphasis>not</emphasis>
	    denote an output filename or even a real filename; just
	    the type of information you want from the server.
	    Here is a list of commonly-supported information types.
	    Additional items are specified in
	    <ulink url="http://www.ietf.org/rfc/rfc2980.txt">RFC2980</ulink>
	    with the LIST command.

	    </para>

	    <itemizedlist>
	      <listitem><para><filename>active</filename> lists
		all newsgroups and describes their numbering.</para></listitem>
	      <listitem><para><filename>newsgroups</filename> lists
		the newsgroup descriptions.  Note that most servers
		do not carry descriptions for all groups, and the groups
		that lack a description will not be listed here at all.
	      </para></listitem>
	      <listitem><para><filename>active.times</filename> describes
		how recently each newsgroup has seen activity.
	      </para></listitem>
	      <listitem><para><filename>motd</filename> shows the server's
		"Message Of The Day" -- that is, current news about the
		server.
	      </para></listitem>
	    </itemizedlist>

	  </listitem>
	</varlistentry>

	<varlistentry><term>-h</term> <term>--help</term>
  	  <listitem><para>Displays brief usage help.</para></listitem>
	</varlistentry>
      </variablelist>
    </refsect1>
    <refsect1>
      <title>Conforming To</title>
      <itemizedlist>
	<listitem><para>Network News Transport Protocol as specified in RFC 977</para></listitem>
	<listitem><para>Common NNTP Extensions as specified in RFC 2980</para></listitem>
	<listitem><para>Standard Python 2.2.1 as implemented on POSIX-compliant systems.</para></listitem>
      </itemizedlist>
    </refsect1>

    <refsect1>
      <title>Copyright</title>
      <para>&NGLister; and this manual, are Copyright &copy; 2003 John Goerzen.</para>

      <para>
	This program is free software; you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation; either version 2 of the License, or
	(at your option) any later version.
      </para>

      <para>
	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.
      </para>

      <para>
	You should have received a copy of the GNU General Public License
	along with this program; if not, write to the Free Software
	Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA</para>

    </refsect1>

    <refsect1>
      <title>Author</title>
      <para>&NGLister; its libraries, documentation, and all included files,
	was written by John Goerzen <email>jgoerzen@complete.org</email> and
	copyright is held as stated in the COPYRIGHT section.
      </para>

      <para>
	&NGLister; may be downloaded from the
	<ulink url="http://svn.complete.org/">Subversion repository</ulink>
	or from the <ulink url="http://packages.debian.org/unstable/news/nglister.html">Debian package page</ulink>.
      </para>

    </refsect1>

    <refsect1>
      <title>See Also</title>
      <para><application>slrn</application>(1),
	<application>python</application>(1)
      </para>
    </refsect1>
  </refentry>
</reference>