~ubuntu-branches/ubuntu/vivid/tin/vivid

« back to all changes in this revision

Viewing changes to doc/tin.5

• browse files at revision 19
• compare with another revision
• download diff
• download tarball
• view history from revision 19

Show diffs side-by-side

added

removed

doc/tin.5

2

2

.\" Module    : tin.5

3

3

.\" Author    : U. Janssen

4

4

.\" Created   : 2000-07-10

5

 

.\" Updated   : 2011-08-23

 

5

.\" Updated   : 2011-12-24

6

6

.\" Notes     : needs a some work

7

7

.\"

8

8

.\"

9

 

.TH tin 5 "August 23rd, 2011" "2.0.0" "A Usenet newsreader"

 

9

.TH tin 5 "December 24th, 2011" "2.1.0" "A Usenet newsreader"

10

10

 

11

11

.SH NAME

12

12

tin, rtin \- related files

15

15

This manpage describes the various (config) files and their formats used by

16

16

the

17

17

.BR tin (1)

18

 

newsreader. All files are expected to have unix style ('\\n' aka LF) line endings.

 

18

newsreader. All files are expected to have unix style ('\\n' aka LF) line

 

19

endings.

19

20

 

20

21

.SH FILES

21

22

.\" TODO: mention

50

51

.IR /etc/mail/mailcap

51

52

.sp

52

53

.RS

53

 

.BR mailcap (4)

 

54

.BR mailcap (5)

54

55

files as defined in \fBRFC1524\fP. The Mailcap files are read by

55

56

.BR tin (1)

56

57

to determine how to display non-text messages at the local site. Any line

62

63

command to execute, and (possibly) a set of optional "flag" values.

63

64

.sp

64

65

The "type" field is simply any legal content type name. It is the string

65

 

that will be matched against the ''Content\-Type:'' header to decide if this is

66

 

the mailcap entry that matches the current message. Additionally, the type

67

 

field may specify a subtype or a wildcard to match all subtypes.

 

66

that will be matched against the ''Content\-Type:'' header to decide if this

 

67

is the mailcap entry that matches the current message. Additionally, the

 

68

type field may specify a subtype or a wildcard to match all subtypes.

68

69

.sp

69

70

The "command" field is any UNIX command and is used to specify the

70

71

interpreter for the given type of message. It will be passed to the shell

764

765

.B from

765

766

Match against ''From:''.

766

767

.BR tin (1)

767

 

converts the contents of the ''From:'' header to an old style e-mail address,

768

 

e.g. ''some@body.example (John Doe)'' instead

 

768

converts the contents of the ''From:'' header to an old style e-mail

 

769

address, e.g. ''some@body.example (John Doe)'' instead

769

770

of ''John Doe <some@body.example>'', before trying to match the patterns in

770

771

the filter rule.

771

772

.TP

1173

1174

.BR tin (1)

1174

1175

works. If it exists, the global configuration file,

1175

1176

\fI${TIN_LIBDIR:\-NEWSLIBDIR}/tinrc\fR is read first. After that, the

1176

 

user's own configuration file \fI${TIN_HOMEDIR:\-"$HOME"}/.tin/tinrc\fR is read.

1177

 

The global file is useful for distributing system-wide defaults to new

 

1177

user's own configuration file \fI${TIN_HOMEDIR:\-"$HOME"}/.tin/tinrc\fR is

 

1178

read. The global file is useful for distributing system-wide defaults to new

1178

1179

users who have no private tinrc yet (see also \fB/etc/tin/tin.defaults\fP).

1179

1180

.TP

1180

1181

.B abbreviate_groupname

1523

1524

.B inews_prog

1524

1525

Path, name and options of external

1525

1526

.BR inews (1).

1526

 

If you are reading via NNTP the default value is "\-\-internal" (use built-in

1527

 

NNTP inews), else it is "inews \-h". The article is passed to

 

1527

If you are reading via NNTP the default value is "\-\-internal" (use

 

1528

built-in NNTP inews), else it is "inews \-h". The article is passed to

1528

1529

\fBinews_prog\fP on STDIN via '< article'.

1529

1530

.TP

1530

1531

.B info_in_last_line

1534

1535

available to display long subjects. Default is OFF.

1535

1536

.TP

1536

1537

.B interactive_mailer

1537

 

If greater than 0 your mailreader will be invoked earlier for reply so you can

1538

 

use more of its features (e.g. MIME, pgp, ...). 1 means include headers, 2

1539

 

means don't include headers (old use_mailreader_i=ON option). 0 turns off

 

1538

If greater than 0 your mailreader will be invoked earlier for reply so you

 

1539

can use more of its features (e.g. MIME, pgp, ...). 1 means include headers,

 

1540

2 means don't include headers (old use_mailreader_i=ON option). 0 turns off

1540

1541

usage. This option has to suit \fBmailer_format\fP. Default is 0.

1541

1542

.TP

1542

1543

.B inverse_okay

1737

1738

%D=Date, %F=Fullname+Address, %G=Groupname, %M=Message\-ID, %N=Fullname,

1738

1739

%C=Firstname, %I=Initials). Default is "%F wrote:".

1739

1740

.TP

 

1741

.B nntp_read_timeout_secs

 

1742

Time in seconds to wait for a response from the server. Default is 120.

 

1743

.TP

1740

1744

.B normalization_form

1741

1745

The normalization form which should be used to normalize unicode input.

1742

1746

The possible values are:

1781

1785

If ON, then

1782

1786

.BR tin (1)

1783

1787

will start an appropriate viewer program to display any files that were post

1784

 

processed and uudecoded. The program is determined using the mailcap file.

1785

 

Default is ON.

 

1788

processed and uudecoded. The program is determined using the

 

1789

.BR mailcap (5)

 

1790

file. Default is ON.

1786

1791

.TP

1787

1792

.B post_process_type

1788

1793

This specifies whether to perform post processing on saved articles.

1936

1941

.TP

1937

1942

.B show_description

1938

1943

If ON show a short group description text after newsgroup name at the group

1939

 

selection level. The ''\fB\-d\fP'' command-line flag will override the setting

1940

 

and turn descriptions off. The text used is taken from the

 

1944

selection level. The ''\fB\-d\fP'' command-line flag will override the

 

1945

setting and turn descriptions off. The text used is taken from the

1941

1946

\fI${TIN_LIBDIR:\-NEWSLIBDIR}/newsgroups\fR file and if supported (requires

1942

1947

.BR tin (1)

1943

1948

to be build with mh-mail-handling support) from

2069

2074

server. There are 3 options. 0 means do nothing & always keep bogus groups.

2070

2075

1 means bogus groups will be permanently removed. 2 means that bogus groups

2071

2076

will appear on the Group Selection Menu, prefixed with a 'D'. This allows

2072

 

you to unsubscribe from them as and when you wish. Default is 0 (Always Keep).

 

2077

you to unsubscribe from them as and when you wish. Default is 0 (Always

 

2078

Keep).

2073

2079

.TP

2074

2080

.B strip_newsrc

2075

2081

If ON, then unsubscribed groups will be permanently removed from

2157

2163

uses a built-in default.

2158

2164

.TP

2159

2165

.B unlink_article

2160

 

If ON remove \fI${TIN_HOMEDIR:\-"$HOME"}/.article\fR after posting. Default is

2161

 

ON.

 

2166

If ON remove \fI${TIN_HOMEDIR:\-"$HOME"}/.article\fR after posting. Default

 

2167

is ON.

2162

2168

.TP

2163

2169

.B url_handler

2164

2170

The program that will be run when launching URLs in the article viewer

2185

2191

.B use_slrnface

2186

2192

If enabled

2187

2193

.BR slrnface (1)

2188

 

will be used to interpret the ''X\-Face:'' header. For this option to have any

2189

 

effect,

 

2194

will be used to interpret the ''X\-Face:'' header. For this option to have

 

2195

any effect,

2190

2196

.BR tin (1)

2191

2197

must be running in an

2192

2198

.BR xterm (1x)

2428

2434

only tries to read the file if you read directly from the local spool,

2429

2435

if you read news via NNTP,

2430

2436

.BR tin (1)

2431

 

uses the LIST (\fBRFC3977\fP) command instead.

 

2437

uses the LIST (\fBRFC3977\fP) or LIST COUNTS (\fBRFC6048\fP) command instead.

2432

2438

.RE

2433

2439

.PP

2434

2440

 

2514

2520

.sp

2515

2521

.RS

2516

2522

This file contains a list of newsgroups - one per line - which the client

2517

 

should subscribe to when the user has no ${TIN_HOMEDIR:\-"$HOME"}/.newsrc for

2518

 

the newsserver.

 

2523

should subscribe to when the user has no ${TIN_HOMEDIR:\-"$HOME"}/.newsrc

 

2524

for the newsserver.

2519

2525

.BR tin (1)

2520

2526

only tries to read the file if you read directly from the local spool,

2521

2527

if you read news via NNTP,

2544

2550

.BR pcre (3),

2545

2551

.BR strftime (3),

2546

2552

.BR system (3),

2547

 

.BR mailcap (4),

 

2553

.BR mailcap (5),

2548

2554

.BR active (5),

2549

2555

.BR mbox (5),

2550

2556

.BR mmdf (5),

• Older »

Loggerhead is a web-based interface for Breezy
Version: 2.0.1