File: manual.html

package info (click to toggle)
nglister 1.0.1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k, lenny, sarge
  • size: 540 kB
  • ctags: 13
  • sloc: makefile: 79; python: 57
file content (438 lines) | stat: -rw-r--r-- 6,977 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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML
><HEAD
><TITLE
>NGLister Manual</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.77+"></HEAD
><BODY
CLASS="REFERENCE"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="REFERENCE"
><A
NAME="AEN1"
></A
><DIV
CLASS="TITLEPAGE"
><H1
CLASS="TITLE"
>I. NGLister Manual</H1
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="#AEN3"
>nglister</A
>&nbsp;--&nbsp;Tool to download newsgroup information from news servers
      </DT
></DL
></DIV
></DIV
><H1
><A
NAME="AEN3"
></A
>nglister</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN15"
></A
><H2
>Name</H2
>NGLister&nbsp;--&nbsp;Tool to download newsgroup information from news servers
      </DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN18"
></A
><H2
>Synopsis</H2
><P
><B
CLASS="COMMAND"
>nglister</B
>  [-u <TT
CLASS="REPLACEABLE"
><I
>username</I
></TT
>] [-p <TT
CLASS="REPLACEABLE"
><I
>password</I
></TT
>] [-P <TT
CLASS="REPLACEABLE"
><I
>port</I
></TT
>]  <TT
CLASS="REPLACEABLE"
><I
>hostname</I
></TT
>   <TT
CLASS="REPLACEABLE"
><I
>filename</I
></TT
> </P
><P
><B
CLASS="COMMAND"
>nglister</B
>   -h | --help </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN36"
></A
><H2
>Description</H2
><P
><SPAN
CLASS="APPLICATION"
>NGLister</SPAN
> 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 <SPAN
CLASS="APPLICATION"
>NGLister</SPAN
> will send it to standard output.
      </P
><P
>You can write the information to a file by appending:</P
><P
><B
CLASS="COMMAND"
>&gt; <TT
CLASS="REPLACEABLE"
><I
>filename</I
></TT
></B
>
      </P
><P
>to the end of your command-line.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN46"
></A
><H2
>Installation</H2
><P
>To install <SPAN
CLASS="APPLICATION"
>NGLister</SPAN
>, you will need a current version of
	<A
HREF="http://www.python.org/"
TARGET="_top"
>Python</A
>.
	  <SPAN
CLASS="APPLICATION"
>NGLister</SPAN
> requires only one other piece of software:
	Optik.  You can find it at
	<A
HREF="http://prdownloads.sourceforge.net/optik/Optik-1.3.tar.gz"
TARGET="_top"
>http://prdownloads.sourceforge.net/optik/Optik-1.3.tar.gz</A
>.
      </P
><P
>	To install, run this command as root: <B
CLASS="COMMAND"
>python setup.py install</B
>
      </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN55"
></A
><H2
>Options</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>-u <TT
CLASS="REPLACEABLE"
><I
>username</I
></TT
></DT
><DD
><P
>Specifies the user name to use for logging into
	    the server.  Use this only if your server requires authentication.
	  </P
></DD
><DT
>-p <TT
CLASS="REPLACEABLE"
><I
>password</I
></TT
></DT
><DD
><P
>Specifies the password to use for logging into
	    the server.  Use this only if your server requires a password.
	  </P
></DD
><DT
>-P <TT
CLASS="REPLACEABLE"
><I
>port</I
></TT
></DT
><DD
><P
>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.
	  </P
></DD
><DT
><TT
CLASS="REPLACEABLE"
><I
>hostname</I
></TT
></DT
><DD
><P
>Specifies the name of the NNTP server.
	  </P
></DD
><DT
><TT
CLASS="REPLACEABLE"
><I
>filename</I
></TT
></DT
><DD
><P
>Specifies the name of the data to retrieve
	    from the remote NNTP server.  Most people will use
	    <TT
CLASS="FILENAME"
>active</TT
> or
	    <TT
CLASS="FILENAME"
>newsgroups</TT
> here.  The set of files
	    supported varies from one server to the next.  Please
	    note that this parameter does <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>not</I
></SPAN
>
	    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
	    <A
HREF="http://www.ietf.org/rfc/rfc2980.txt"
TARGET="_top"
>RFC2980</A
>
	    with the LIST command.

	    </P
><P
></P
><UL
><LI
><P
><TT
CLASS="FILENAME"
>active</TT
> lists
		all newsgroups and describes their numbering.</P
></LI
><LI
><P
><TT
CLASS="FILENAME"
>newsgroups</TT
> 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.
	      </P
></LI
><LI
><P
><TT
CLASS="FILENAME"
>active.times</TT
> describes
		how recently each newsgroup has seen activity.
	      </P
></LI
><LI
><P
><TT
CLASS="FILENAME"
>motd</TT
> shows the server's
		"Message Of The Day" -- that is, current news about the
		server.
	      </P
></LI
></UL
></DD
><DT
>-h, --help</DT
><DD
><P
>Displays brief usage help.</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN105"
></A
><H2
>Conforming To</H2
><P
></P
><UL
><LI
><P
>Network News Transport Protocol as specified in RFC 977</P
></LI
><LI
><P
>Common NNTP Extensions as specified in RFC 2980</P
></LI
><LI
><P
>Standard Python 2.2.1 as implemented on POSIX-compliant systems.</P
></LI
></UL
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN114"
></A
><H2
>Copyright</H2
><P
><SPAN
CLASS="APPLICATION"
>NGLister</SPAN
> and this manual, are Copyright &copy; 2003 John Goerzen.</P
><P
>	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.
      </P
><P
>	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.
      </P
><P
>	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</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN121"
></A
><H2
>Author</H2
><P
><SPAN
CLASS="APPLICATION"
>NGLister</SPAN
> its libraries, documentation, and all included files,
	was written by John Goerzen <TT
CLASS="EMAIL"
>&#60;<A
HREF="mailto:jgoerzen@complete.org"
>jgoerzen@complete.org</A
>&#62;</TT
> and
	copyright is held as stated in the COPYRIGHT section.
      </P
><P
>	<SPAN
CLASS="APPLICATION"
>NGLister</SPAN
> may be downloaded from the
	<A
HREF="http://svn.complete.org/"
TARGET="_top"
>Subversion repository</A
>
	or from the <A
HREF="http://packages.debian.org/unstable/news/nglister.html"
TARGET="_top"
>Debian package page</A
>.
      </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN130"
></A
><H2
>See Also</H2
><P
><SPAN
CLASS="APPLICATION"
>slrn</SPAN
>(1),
	<SPAN
CLASS="APPLICATION"
>python</SPAN
>(1)
      </P
></DIV
></DIV
></BODY
></HTML
>