source: trunk/ReleaseTool.cfg@ 1605

Last change on this file since 1605 was 1588, checked in by John Small, 14 years ago

1) Fix bug causing crash during NNTP send.
2) Changed version format to use x.yy.x format consistently
3) Added support for SMTP ports other than 25
4) Improved internal documentation for ReleaseTool.cfg

File size: 6.8 KB
Line 
1
2; $Id$
3
4; This file is used by ReleaseTool to provide information used to provide
5; various configuration data to ReleaseTool.cmd
6
7; ReleaseTool expects each line to be one of four types:
8; 1) Blank/empty lines (which are ignored)
9
10; 2) Comment lines. All text following a semicolon, ";", will be ignored.
11; Any line whose first non-blank is a semicolon, like this line, is
12; a comment line and will be ignored by ReleaseTool.
13
14; Section and data lines (below) can have end-of-line comments
15; (like C++'s // comments). This means key-values (see Data lines below)
16; may not have semicolons.
17
18; 3) Section lines. Section lines are of the form:
19; [section-name]
20; Section lines mark the start of a new set of data. The section
21; name (within the brackets) defines which type of data follows.
22; ReleaseTool currently supports section names: FTP, NNTP and SMTP.
23
24; FTP sections are used to define data for uploading one or more files
25; to a single site.
26
27; NNTP sections are used to define data for uploading messages to one
28; or more newsgroups on a single newsgroup server.
29
30; SMTP sections are used to define data for sending email messages
31; through a single email server. SMTP sections can be set up to use
32; an external program, like PMMail/2 or REXXMAIL, by defining an
33; appropriate command. If no command is defined then email is sent
34; using Releasetool's internal REXX code for opeing a socket to an
35; SMTP server, loggin in and sending the message.
36
37; 4) Data lines. These lines provide the actual data to ReleaseTool.
38; The format of these lines is:
39; key-name = key-value
40; Whitespace is ignored. If a key-value has whitespace, then
41; enclose it with double quotes.
42
43; Key-name's are case-insensitive. Key-values are case sensitive.
44
45; The following table lists the key-names recognized by ReleaseTool, the
46; sections to which they apply, a code (explained below) and a short description:
47
48; Key-name Sections Code Description
49
50; HOST FTP 1 The host name of the server
51; NNTP 2
52; SMTP 1
53; USERID FTP 2 The userid used to log in
54; NNTP 2
55; SMTP 2
56; PASSWORD FTP 2 The password used to log in.
57; NNTP 2
58; SMTP 2
59; FROM NNTP 2 "From" email address
60; SMTP 2
61; SIGNATURE NNTP 4 Zero or more lines of "signature"
62; SMTP 4
63; DESCRIPTIVE_HOSTNAME FTP 1 Text used by ReleaseTool to identify
64; an FTP site in messages to its users.
65; DIRECTORY FTP 4 If a change directory command is needed
66; before uploading a file, then this key-value
67; should be provided. If more than one file
68; is to be uploaded and they are to be uploaded
69; into different directories, precede each set
70; of FILE lines by an appropriate Directory line.
71; FILE FTP 3 The local name of a file to be uploaded. This
72; should include path info if the file is not
73; in the same directory as ReleaseTool.
74; NEWSGROUPS NNTP 1 A comma-separated list of newsgroups for this host.
75; PORT SMTP 5 Port number. Default: port 25
76
77; Codes:
78; 1: Required, one per section.
79; 2: Optional, but ReleaseTool will prompt for its value as needed.
80; 3: Required, one or more per section
81; 4: Optional, one or more per section
82; 5: Optional, one per section
83
84; "Special" key-values:
85; Userid
86; [Not-needed] : Userid not needed. (ReleaseTool will prompt for an absent userid.)
87; Password
88; [Hobbes-email] : ReleaseTool automatically replaces this with the email address from the Hobbes text file.
89; [Not-needed] : Password not needed. (ReleaseTool will prompt for an absent password.)
90; File
91; [Release-Zip] : ReleaseTool automatically replaces this with FM/2 release zip filename.
92; [Hobbes-text] : ReleaseTool automatically replaces this with Hobbes text filename.
93
94; Password note: Instead of recording passwords in this file, it may be best to omit them and have
95; ReleaseTool prompt you for them, as needed.
96
97; "From" notes:
98; - For newsgroups you may want to use a disguised email address to avoid spam.
99; - Accepted formats:
100; "Full name" <user@domain.net>
101; <user@domain.net>
102; user@domain.net
103
104; Within a section, data lines can be in any order except DIRECTORY lines, if any, must precede
105; the FILE lines to which they apply.
106
107
108[FTP] ; Hobbes upload definition
109Descriptive_hostname = Hobbes
110Host = hobbes.nmsu.edu
111Userid = anonymous
112Password = [Hobbes-email]
113Directory = /pub/incoming
114File = [Hobbes-text]
115File = [Release-zip]
116
117[FTP] ; Netlabs upload definition
118Descriptive_hostname = Netlabs
119Host = ftp.netlabs.org
120Userid =
121Password =
122Directory = /fm2
123File = [Release-zip]
124
125;[NNTP] ; eComstation news server/groups definition
126;Host = news.ecomstation.nl
127;Newsgroups = ecomstation.apps
128;Userid = [Not-needed]
129;Password = [Not-needed]
130
131[NNTP] ; ReleaseTool user's news server/groups definition
132;Newsgroups = comp.os.os2.apps,comp.os.os2.utilities
133Newsgroups = alt.test
134Host =
135Userid =
136Password =
137From = zjsmallz@osworld.net
138Signature = John Small
139Signature = (Remove z's for address)
140
141[SMTP]
142;Command = g:\pmmail\bin\pmmsend -a G:\PMMail\Accounts\ygk_us0.act -t "%%TO%%" -s "%%SUBJECT%%" -m %%MESSAGE_BODY_FILE%%
143;Command = call d:\utils\internet\rexxmail\rexxmail /NewMessageSend "%%TO%% ?subject=%%SUBJECT%% &body=%%MESSAGE_BODY_FILE%%" /Address=%%FROM%% /SMTPServer=%%SERVER%% /SMTPUSER=%%USERID%% /SMTPPASSWORD=%%PASSWORD%% /TimeZone=%%UTCOFFSET%%
144Host = smtp.toast.net
145Port = 587
146Userid = jsmall@toast.net
147From = "John Small" <jsmall@os2world.net>
148;Signature = John Small
149Signature = FM/2 Development Team
150UTCOffset = -0500
Note: See TracBrowser for help on using the repository browser.