Penguin
Recent Changes
Annotated edit history of slrn(1) version 1, including all changes. View license author blame.
Rev Author # Line
1 perry 1 slrn
2 !!!slrn
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 OPTIONS
7 ENVIRONMENT
8 FILES
9 SEE ALSO
10 AUTHOR
11 ----
12 !!NAME
13
14
15 slrn - An easy to use NNTP / spool based newsreader.
16 !!SYNOPSIS
17
18
19 __slrn__ [[-aCdknmw] [[-C-] [[-D''name''] [[-f
20 ''newsrc-file''] [[-i ''config-file''] [[-k0] [[--create]
21 [[-create] [[--debug ''file''] [[--help] [[--inews]
22 [[--kill-log ''file''] [[--nntp [[-h ''server''] [[-p
23 ''port'']] [[--spool] [[--version]
24 !!DESCRIPTION
25
26
27 ''slrn'' is an easy to use but powerful NNTP / spool
28 based newsreader.
29
30
31 It is highly customizable, supports scoring, free key
32 bindings and can be extended using the s-lang macro
33 language.
34
35
36 To use slrn, you either need to set the ''NNTPSERVER''
37 environment variable to the server you want to read news
38 from or specify a server on the command line. A
39 ''newsrc'' file is needed, too. In case you do not yet
40 have one, you can create it using ``slrn -f ~/.jnewsrc
41 --create''.
42
43
44 Inside slrn, online help is available via the '?'
45 key.
46 !!OPTIONS
47
48
49 The following options can be used when calling slrn from the
50 command line. They override both environment variables and
51 settings in private and global configuration
52 files.
53
54
55 -a
56
57
58 Read active file when checking for new news.
59
60
61 -C
62
63
64 Use colors without checking if the terminal supports
65 it.
66
67
68 -C-
69
70
71 Don't use colors, even if the terminal supports
72 it.
73
74
75 -d
76
77
78 Get group descriptions (taglines) from the news server.
79 Please note that this may cause a download of several
80 hundred kilobytes and thus can take a long time. The output
81 is saved to a local file, so you only need to do this once.
82 May not be specified in combination with
83 ''--create''.
84
85
86 -D''name''
87
88
89 Add name to the list of predefined preprocessing tokens,
90 which can be used in your slrnrc file to have conditionally
91 interpreted lines. See the slrn reference manual for
92 details.
93
94
95 -f ''newsrc-file''
96
97
98 Use file as the newsrc file for this session. This is
99 permanently set via the ''server'' configuration
100 command.
101
102
103 -h ''host[[:port]''
104
105
106 Connect to the NNTP server on ''host'', overriding the
107 ''$NNTPSERVER'' environment variable. If no ''port''
108 is given, the default NNTP port (119) will be used. This
109 option is only accepted after ''--nntp'' or when NNTP is
110 the default mode.
111
112
113 -i ''config-file''
114
115
116 Read file as the initialization (slrnrc) file. The default
117 is to use .slrnrc (or slrn.rc on VMS, OS/2 and Windows) in
118 your home directory.
119
120
121 -k
122
123
124 Don't read the ''score file''.
125
126
127 -k0
128
129
130 Read the score file, but inhibit ''expensive'' scoring. A
131 scoring rule is ''expensive'' if it contains header lines
132 that are not included in the server's overview files. This
133 makes applying them slow.
134
135
136 -m
137
138
139 Force mouse support (without checking if it works on the
140 current terminal).
141
142
143 -n
144
145
146 Do not check for new groups (usually resulting in a faster
147 startup).
148
149
150 -p ''N''
151
152
153 Use port N to connect to the NNTP server.
154
155
156 -w
157
158
159 Wait for a key before switching to full screen mode,
160 allowing the user to read startup messages.
161
162
163 --create
164
165
166 Read the active file (the list of all groups) from the news
167 server to create an initial newsrc file.
168
169
170 -create
171
172
173 Obsolete version of ''--create''.
174
175
176 --debug ''file''
177
178
179 Write debugging output to ''file''.
180
181
182 --help
183
184
185 Show help for command line switches.
186
187
188 --inews
189
190
191 Use an external ''inews program'' to post
192 articles.
193
194
195 --kill-log ''file''
196
197
198 Keep a log of all articles that were killed by the scorefile
199 in ''file''.
200
201
202 --nntp
203
204
205 Use builtin NNTP support for reading and posting (an
206 external program is used to post if slrn was compiled with
207 --enable-force-inews).
208
209
210 --pull
211
212
213 Spool outgoing articles locally for slrnpull to
214 send.
215
216
217 --spool
218
219
220 Read directly from spool.
221
222
223 --version
224
225
226 Print version and some compile time settings.
227 !!ENVIRONMENT
228
229
230 ''slrn'' uses the following list of environment
231 variables. Note: environment variables can be overridden by
232 configuration files or command line switches.
233
234
235 __COLORTERM__
236
237
238 If this variable is set, slrn will assume that your terminal
239 supports ''ANSI color sequences''. It also enables a
240 workaround for a problem with the ''mouse reporting''
241 when running slrn inside of an rxvt.
242
243
244 __DISPLAY__
245
246
247 If set, slrn assumes that X11 is running.
248
249
250 __EDITOR__
251
252
253 See ''$SLRN_EDITOR''.
254
255
256 __HOME__
257
258
259 See ''$SLRNHOME''.
260
261
262 __HOSTNAME__
263
264
265 If no ''hostname'' is given, the value of this
266 environment variable is used.
267
268
269 __LOGNAME__
270
271
272 See ''$USER''.
273
274
275 __NAME__
276
277
278 Set it to your realname, if slrn can't determine it
279 otherwise.
280
281
282 __NNTPSERVER__
283
284
285 You can use this variable to tell slrn which NNTP server to
286 connect to. It can be overridden by the command line option
287 -h.
288
289
290 __ORGANIZATION__
291
292
293 The name of your organization.
294
295
296 __PRINTER__
297
298
299 On unix systems, slrn pipes the current article to ``lpr -P
300 ''$PRINTER'''' to print it.
301
302
303 __PWD__
304
305
306 This variable is only used on unix systems that don't
307 support getcwd(3). In these cases, it should be set to the
308 current directory at the time slrn is invoked. This is
309 usually done by the shell and nothing the user has to worry
310 about.
311
312
313 __REPLYTO__
314
315
316 The value of this variable is used as the default if you do
317 not set ''replyto'' in your slrnrc file.
318
319
320 __SLANG_EDITOR__
321
322
323 See ''$SLRN_EDITOR''.
324
325
326 __SLRNHELP__
327
328
329 You can set this variable to a file slrn should read its
330 online help from. This is only needed when the default key
331 bindings have been changed and you want the help function to
332 reflect this. If unset, slrn looks for slrn-help.txt in the
333 configuration directory.
334
335
336 __SLRNHOME__
337
338
339 When interpreting filenames as relative to your home
340 directory, slrn uses this variable to find out what your
341 home directory is. If ''$SLRNHOME'' is unset,
342 ''$HOME'' is used instead.
343
344
345 __SLRN_EDITOR__
346
347
348 The editor to start for editing articles. If this variable
349 is unset, slrn subsequently looks at ''$SLANG_EDITOR'',
350 ''$EDITOR'' and ''$VISUAL''.
351
352
353 __TMP__
354
355
356 Indicates the directory in which slrn should save temporary
357 files.
358
359
360 __TMPDIR__
361
362
363 See ''$TMP''.
364
365
366 __USER__
367
368
369 Your username, if slrn can't get it from the system by other
370 means.
371
372
373 __VISUAL__
374
375
376 See ''$SLRN_EDITOR''.
377 !!FILES
378
379
380 $HOME/.slrnrc
381
382
383 User-specific configuration file.
384
385
386 config_dir/slrn.rc
387
388
389 System-wide configuration file. config_dir is set at compile
390 time (/usr/local/etc by default).
391
392
393 $HOME/.jnewsrc
394
395
396 default newsrc file for ''slrn.''
397
398
399 $HOME/.jnewsrc.dsc
400
401
402 Per user newsgroups descriptions.
403
404
405 share_dir/newsgroups.dsc
406
407
408 Global newsgroup descriptions. share_dir is set at compile
409 time (/usr/local/share/slrn by default).
410 !!SEE ALSO
411
412
413 The documentation that comes with ''slrn'', especially
414 manual.txt, FAQ, score.txt and SCORE_FAQ. If you consider
415 writing s-lang macros, also look at README.macros and
416 slrnfuns.txt.
417
418
419 Recent versions of the slrn manual and the FAQ as well as
420 additional information can also be found on slrn's official
421 home page: http://slrn.sourceforge.net/
422
423
424 Questions about ''slrn'' that are not covered by existing
425 documentation may be posted to the newsgroup
426 ''news.software.readers'' where they will be answered by
427 knowledgeable users or the author of the program. In
428 addition, announcements of new versions of ''slrn'' are
429 posted there.
430
431
432 The latest version of ''slrn'' is available from
433 http://prdownloads.sourceforge.net/slrn/
434 !!AUTHOR
435
436
437 John E. Davis
438
439
440 Please send any bug reports to the current maintainer,
441 Thomas Schultz
442 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.