Howe Park


Home Snooze News Recommended FAQ Manual Download

Manual

Predictably detailing the format of the .ini configuration file used by Snooze, newsrc files, & XNews filter files, & also the GUI elements of Snooze & how to use them.

The main window contains several key areas:

Toolbar - For quick, usually pushbutton access to common functionality, and activity indicators.

Menubar - currently only allows access to the Toolbar button functionality.

Profiles panel - showing available & selected Profiles. The checked Profiles are those that will be processed when they become due. The next Profile to be processed is marked with an *, this can be altered by double-clicking the Profile name, even one that is not checked.

Status panel - showing a scrolling display of current activity.

Groups panel - currently unused, but will show a scrolling display of Newsgroup activity & statistics, and will be capable of allowing the user to backtrack to previously processed NewsGroups.


Matches panel - show the list of threads currently marked as interesting by the search engine.


 
 
Keyboard Actions
ctrl-A Select all entries.
N Show non-binary only, i.e. text threads & articles.
O Show complete binary only.
B Show binary only.
Z Show all articles.
S Toggle Superthreads. See PostList.
V Save Matches to file. See MatchedList.
K Kill articles with the selected subject. Shows a dialog to edit the subject. See SKill.
X Removes selected thread(s) from the Matches Panel. Use this to remove interesting threads that will be read later from your News Reader. Use shift-X to remove incomplete binaries.
DEL Same as X, except that the articles are marked as read in the RC files. Use this to delete threads that are no longer of interest. Use shift-DEL to delete incomplete binaries. Hmm, ListView is catching that, please use ctrl-shift-DEL.

Searching panel - shows the list of threads currently being loaded or searched.


 
 
Keyboard Actions
I Not fully implemented. Adds a search for the selected subject.

Statusbar - shows ...


 

Command-line Options

 
Command-line Options
/Iinifile Path to configuration file, if not present then the current folder must contain snooze.ini.
/Filter Enable Filtering.
/Noload Do not load saved matches at startup.
/Go Start processing the first available host, after loading any matches.

Snooze.ini

Using the standard Windows .ini format, this is easily editable by hand, even when Snooze is running.

Sections:  Tokens  HostsConfig Searches Windows LastUsed
 

Section: [Tokens]

This is a general purpose section used to define replacable tokens (shortcuts, nicknames, aliases), that can be used in other sections in the configuration file, indicated by [token] in the definition. The token list is processed once, and therefore cannot contain forward-references - these will not be recognized.Where tokens are allowed, they are referenced by using %tokenname%, the quoting character (%) can also be defined in the Tokens section by adding a Quote=string entry.

Common uses for tokens are for File & Folder Paths or Drives, lists (of Groups) and to define other reusable values.

Example:

[Tokens]
# replaced inline when %TOKEN% is found
# strings in Tokens are assumed to BE tokens first
# elsewhere they need to be %-quoted
# can prefix with ! to NOT everything (no double !'ing)

Quote=%

NewsDir=c:\News
NewsServersDir=%NewsDir%\Servers
XNewsDir=c:\Xnews
StorageDir=%NewsDir%\Storage

ArticleGroup=alt.test
HeaderFilter=Subject,Date,From,Bytes,Lines

notbinar=!binar
ms=microsoft
window=
ole=
vb=vb,visual,basic
texttech=ms,window,ole,vb,notbinar

Sections: [Host-abc]

(Possibly to be renamed Profile).
 
Host-name
The section name must start with Host- to be recognized as a Host section. The name is user defined, but will probably be a shortcut derived from the actual Host server name.
Host hostname [:port] 
[,user [,password] ]
Name of host, optionally followed by port and user details. 
Auth user [,password] User details. At present only UserID and Password are supported.
Welcome
Saves the Host server Welcome message.
Quit
Saves the Host server Exit message.
***
The Host-sections can also override the settings of the following [Config] entries:
Port, MaxTime, MaxLines, MaxArticles, MaxGroups, MaxChunk, MORE
SuperHost off If set to "on" then this is a SuperHost, and the following entries control which servers are used for specific groups.
NoFilter off If "on" then this host will not perform any filtering (search pattern matching).
HideNoMatches off If "on" then groups that do not match the group patterns will be returned to the client for the LIST command. Note that this could mean a group is returned from the wrong server.
RChost RC file Used to control which host is used to access specified groups. 

The entry name specifies the host (as found elsewhere in this .ini file), and the value is the name of the RC file that contains the list of (subscribed) groups that are available. Further RChost entries will specify other hosts, and the groups that they allow.

RChost1=newsrc1
RChost2=newsrc2

Gpattern host;pattern Also used to control which host is used to access specified groups, but in this case the groups are specified using (partial match) patterns.

Gbinmp3=ON;%binmp3%
Gtech=DFN;%texttech%
Gocta=ON;octanews
#G.=Visi

Gpattern entries are processed after RChost entries, which are more specific.

Section: [Config]

Counters  RC files  Scoring  FilteringStorage

Used to define common settings, some of which can be overridden by using the same entry in specific [Host] sections.
 

Counters, Maximums, Folders, Lists

Port 119 Port used to connect to host. Usual NNTP default is 119, but see Filtering.
MaxTime 37 Maximum number of minutes to search a Host. 
MaxLines ? Maximum number of lines to search in an article. rest of article will be skipped.
MaxArticles ? Maximum number of Articles to search per Group.
MaxGroups ? Maximum number of Groups to search per Host.
MaxChunk ? Maximum number of Articles to retrieve per XOVER command.
Restart ? Time in minutes to wait before searching next Host. Will be divided by the number of Hosts in HostList if it is used.
FilterXPAT
If present, then if an XPAT command is found when filtering a host, a dialog will appear to allow the user to change the XPAT data. This is useful when a server has limited XPAT support, but your News Client generates complicated XPAT commands. Can be overridden per-host.
Reconnect ? Used instead of Restart when a Host fails to connect.
ConnectRetryAttempts ? Maximum number of attempts made tp connect to a Host of it fails. Also see ConnectFailLock.
ConnectFailLock ? List of error codes and number of minutes to lock the Host if these errors occur. [errcode:mins]...
DataExceeded ? List of strings to check when a Host fails to connect. The Host will be locked if any string is found in the Host error message. [string]...
DataExceededLock ? Number of minutes to lock a Host if the DataExceeded pattern is found.
ServerTimeout ? Number of seconds to wait for a server reply when sending a message. If the server times out then the connection will be closed.
ServerReuseTimeout ? Number of seconds to keep a connected server in the Connection Cache.
MatchedArticles ? Fully-qualified name of the file used to save/load Matched Article information.
IconsDir ? Fully-qualified name of the folder containing icons.
Icons ? List of icon file names (relative to IconsDir), in the order: article, thread, binary, complete binary.
UUList \([0-9]*/[0-9]*\),
\[[0-9]*/[0-9]*\]
Used to define a multi-part binary thread. These usually contain a (nn/mm) or [nn/mm] string, but you may redefine this.
ReList re:,sv:,antw:,aw:,rv:,ri: Defines the Subject prefixes to ignore when threading by Subject. RE: is the usual English prefix, some other langauge variants are in the standard list.
PreList fa:,fs:,request:,
request ,repost:
Defines a list of strings to ignore at the start of a Subject when threading. Useful to ignore non-alphabetic or common junk like "Request:".
PostList ... Defines a list of patterns to remove from a Subject when threading. This provides the SuperThreading facility.
ReplaceNames cdb:comp.databases,
ms:microsoft,
msp:ms.public,
msw:ms-windows,
cos:comp.os,col:cos.linux
List of Group name replacements. Will be processed in order. Each entry in the list specifies the replacement string and the string it is to replace. Once a name has been replaced further replacements can occur, so any string supersets should be defined earlier.
HostList
Defines the set of Hosts to search, written when selecting Hosts in the Hosts Panel.
Mark " <-" Defines the prefix used to mark lines in the body of an Article when a search pattern is found.
PostMark "" Defines the suffix used to mark lines in the body of an Article when a search pattern is found.
SigMark --  Defines the point after which an Article will not be searched for patterns.
SnzMark ? Not used.
Beeps 0 Number of times to sound the system beep when an interesting Article is found.
MailBoxBase
Fully-qualified folder name to use as the root folder when specifying that articles are to be saved into MailBoxes. See MailBox.

 

RC files

NewsDir ? Fully-qualified folder containing RC files.
InRC ? name of RC file for Groups/Articles to be searched.
OutRC ? name of RC file for Groups/Articles that have been searched.
MasterRC ? name of RC file to use as a Master copy. All Groups from the specified MasterRC will be copied into the InRC before processing begins. May become a list in the future.
GroupFilter ? Filter used to control which groups are processed. May become a list in the future.
XRefRC ? name of an RC file that contains Groups specified in the XRef header of interesting Articles.
KilledRC ? not used.
NogroupRC ? name of an RC file that contains the names of Groups that were not found on a server.
RangeGap ? specifies the limit below which unread ranges of Articles are merged, to reduce calls to a server (increases traffic from the server, previously read articles will be ignored). See MaxChunk.
MarkXRef ? internal use only at present.

Scoring (under evaluation)

Score ? Default score.
ScoreDebug off Boolean. Set to "on" to enable score debugging.
ScoreSeparate ? ?
OutputScoreFile ? Fully-qualified name of the XNews score file to write scoring information to.


Under evaluation - settings may be modified in the future, feel free to analyze  & provide feedback.

Filtering

HeaderFilter
List of header names to display when Filter is retrieving an Article. e.g. Subject, Lines
ServerPort 8119 Port used to accept connections for NNTP Filtering.
ServerTraceServer
(rename this one?) Boolean - set to show Filtering actions in Status panel.
ServerKeepAlive ? Number of seconds to wait for client activity before sending KeepAlive message (DATE) to the server. Keeps the connection alive while client (i.e. user) is thinking.
ClientTimeout ? Number of seconds to wait for client activity before closing the client connection, and returning server to the Connection Cache.
ServerLookup ? Number of milliseconds to wait for spontaneous server messages when filtering.

 

Storage (under evaluation)

Storage ? Set to 1 to enable storage for a Host.
StorageExpiry ? unused
StorageHeaders ? List of headers to store. str [,str]... 
e.g. Subject,From,Date
StorageAllHeaders ? Set to 1 to enable storage of all Articles current headers.
StorageBase ? Name of folder to contain per-Host storage. Will be appended with the Host name.
StorageRCLink ? Set to 1 to enable Storage-RC linking, which will remove articles from storage if they are marked as read in the FoundRC.


Under evaluation - settings may be modified in the future, feel free to analyze & provide feedback.

Host-News is a special Host section that defines the default host.

Sections: [Searches]

Sname ? The section must start with S to be identified as a Search section, the name is arbitrary but must be unique and is user-visible in various places.
Groups ? A set of separate Group entries, identifying which groups are to be used by this search. If the entry does not have a value, then the entry name without the G-prefix is used as the value. The value can be a list of group filters, which has led to the use of a single entry Groups= , whose value is provided by a replace token.

e.g. 
Gsoc=soccer
Gfootball=

has become: Groups=%mygroups%

where the Tokens section has defined mygroups=soccer,football,tv

Score
Default Score of the Search. This can be an absolute value, or a multiple of the default Score.
Patterns ? A set of separate Pattern entries, identifying the pattern to search for, where to search for it, and how to score the pattern if it is found. 

Pname=pattern ; source ; file ; score

All items are optional, if the pattern is not present, the name of the entry is used as the pattern. The pattern is a regular expression. 

The source can be empty meaning search the Subject, or A to search all headers, or BS to search the Subject and Body of the Article, or a specified header, such as From.

The Score is either an absolute value, or a multiple of the current Score, and if specified it overrides the Score of the Search. If no Score is specified, each Pattern increments the current Score by 1.

MailBox
The name of an mbx-format file to save interesting articles to. This file is relative to MailBoxBase. Can be used as an archive, although there is no RC-linking like Storage.

Special Search sections

SKill
    uses Score = -9999 for XNews to hide the matching articles,
    uses G.= to match in all groups,
    can edit this section manually, or add entries by using the K key from the Matches panel (PLocalKill-hh:mm:ss entries).
Sarchive
    all articles marked as interesting (actually searched for a non-empty Date header),
    uses Score = 0 for other searches to stand out for these groups,
    Groups must be fully specified, no patterns as yet.

Section: [abc-Windows] or [abc-LastUsed]

These sections are used to store information between sessions relating to Window positions and recently used selections. They can safely be removed to reset GUI sizes.

XNews Score.ini

Plenty to configure here too, also other XNews .ini files. Nothing that Snooze interferes with too much at present, please see the XNews manuals for details.
 

newsrc files

These are by now a familiar format, which Snooze only extends by the use of marking the RC files of found articles with a notional 'Maximum Last' to hide unprocessed articles. So, if the last processed article in a certain group is 23974, we mark that group as read up to article 39999. We used to use a static 999999, but this proved to hamper Newsreaders when reading groups with low traffic, and was too low for high volume groups.




webmaster Mirrors: None Again