File: ypostrc.5

package info (click to toggle)
yencode 0.46-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 1,260 kB
  • ctags: 1,019
  • sloc: ansic: 9,628; sh: 3,516; makefile: 371; yacc: 318
file content (125 lines) | stat: -rw-r--r-- 4,032 bytes parent folder | download | duplicates (2)
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
.\"
.\"	Man page for `ypostrc'
.\"
.\"	$Header: /pub/cvsroot/yencode/doc/ypostrc.5,v 1.5 2002/03/18 17:20:06 bboy Exp $
.\"
.\"	Copyright (c) 2002 Don Moore <bboy@bboy.net>
.\"
.\"	Process this file with `groff -man -Tascii icfw.1'
.\"
.TH YPOSTRC 5 "March 2002" yencode "File Formats"
.SH NAME
~/.ypostrc \- ypost configuration file

.\"
.\"  DESCRIPTION
.\"
.SH DESCRIPTION
This file, located in the user's home directory and called \fB.ypostrc\fP, is read by the \fBypost\fP(1) program at startup.
The options in this file may be overwritten by command line options.
.LP
It might look like this:
.IP
.nf
## ~/.ypostrc
## ypost configuration file

## My login information
user = user1234
pass = IloveUnix
server = news.example.com
.fi
.LP
Each line in the file may contain a configuration option (described in the \fBOPTIONS\fP section of this man page) in
the form of an option name, follwed by an equal sign (`\fB=\fP') followed by the value for that option.  Option lines
with blank values are ignored, as well as all text following a hash mark (`\fB#\fP'), and empty lines.


.\"
.\"  OPTIONS
.\"
.SH OPTIONS
The following options are available to control the behavior of \fBypost\fP at run-time.  Options that take a \fIBOOL\fP
value are enabled with any of `\fBy\fP', `\fByes\fP', `\fBon\fP', or `\fB1\fP' and disabled with any other value.

.IP "\fBauthor\fP=\fIauthor\fP"
When posting messages, use \fIauthor\fP in the Usenet \fBFrom:\fP header.  See \fBypost\fP(1) for permissible syntax.

.IP "\fBdebug\fP=\fIBOOL\fP"
Enable debug output?

.IP "\fBcomment\fP=\fIcomment\fP"
When posting messages, suffix subject lines with \fIcomment\fP, enclosed in square brackets.

.IP "\fBforce\fP=\fIBOOL\fP"
When posting messages, skip confirmation of posting summary?

.IP "\fBgroup\fP=\fInewsgroup\fP"
Post messages to the specified \fInewsgroup\fP.

.IP "\fBline\fP=\fIlength\fP"
Use \fIlength\fP as the line length for encoded data.

.IP "\fBmessageid\fP=\fIBOOL\fP"
Include the \fBMessage-ID:\fP header line when posting?

.IP "\fBmultipart\fP=\fIlines\fP"
Split large files after the number of lines specified by \fIlines\fP instead of 5000, which is the default.

.IP "\fBnosort\fP=\fIBOOL\fP"
Inhibit sorting of input files before posting messages?

.IP "\fBpaths\fP=\fIBOOL\fP"
Store paths in archives as they were specified on the command line?  If \fBon\fP, do not strip paths.

.IP "\fBpass\fP=\fIpassword\fP"
Provide \fIpassword\fP for authentication to the news server when connecting.

.IP "\fBquiet\fP=\fIBOOL\fP"
Operate as quietly as possible?

.IP "\fBretry\fP=\fIretries\fP"
Specify the number of \fIretries\fP that should be attempted if a post fails.

.IP "\fBsubject\fP=\fIsubject\fP"
When posting messages, prefix subject lines with \fIsubject\fP, enclosed in square brackets.

.IP "\fBserver\fP=\fIaddress\fP"
Post all messages through the news server specified by \fIaddress\fP.

.IP "\fBstdout\fP=\fIBOOL\fP"
Output to the standard output, instead of posting messages through a server?

.IP "\fBtimeout\fP=\fIseconds\fP"
Socket operations should time out after this many \fIseconds\fP.  A value of `\fB0\fP' will disable the timeout.

.IP "\fBsortfirst\fP=\fIextensions\fP"
\fIextensions\fP should be a comma-separated list of extensions that will come first when sorting.  The built-in
default value for this field is `\fBnfo,crc,sfv,par,rar,zip,arj,ace\fP'.  This causes files like \fB.nfo\fP and \fB.sfv\fP
files to be posted first, as well as causing \fB.rar\fP files to be posted before \fB.r00\fP files,
instead of at the end, which is annoying.  The extensions listed are \fInot\fP case sensitive.

.IP "\fBuser\fP=\fIusername\fP"
Provide \fIusername\fP for authentication to the news server when connecting.

.IP "\fBsfv\fP=\fIBOOL\fP"
Post an \fB.sfv\fP file for the input files?

.IP "\fBcrc\fP=\fIBOOL\fP"
Post a \fB.crc\fP file for the input files?


.\"
.\"  AUTHOR
.\"
.SH AUTHOR
Don Moore <bboy@bboy.net>


.\"
.\"  SEE ALSO
.\"
.SH "SEE ALSO"
.BR ypost(1),
.BR yencode(1),
.BR ydecode(1)