flnews manual page

Table of Contents


NAME

flnews - Fast and lightweight USENET client with GUI

SYNOPSIS

flnews [-display [host]:display] [-geometry WxH[+X+Y]]

flnews [-h|-v]

DESCRIPTION

If you don't know what USENET is, you probably want to read this article first:

https://en.wikipedia.org/wiki/Usenet

This client with graphical user interface uses the NNTP protocol defined in RFC3977 to get USENET news articles defined in RFC5536 from a server via IP network.

flnews provides full Unicode support, including NFC normalization for posting and search/compare operations. Article content is converted to ISO8859-1 before posting (if possible) to be more friendly to old clients. The ability to display Unicode content depends on the GUI toolkit fltk(3).

If compiled with support for ssl(3), the NNTPS protocol (NNTP over encrypted TLS connection) is supported. For NNTPS connections the server to client authentication via X509 certificate is always performed. Optionally the client can authenticate to the server via the AUTHINFO USER/PASS extension defined in RFC4643.

If compiled with support for compression and zlib(3), the NNTP COMPRESS extension is supported. Compression negotiation is disabled by default and can be enabled on the 'Edit->Configuration->Misc' tab in the user interface. Because compression in general can weaken the underlaying encryption, the optional authentication is always done before compression is negotiated. For the same reason compression negotiation should be disabled for reading groups that contain articles with confidential information.

flnews has MIME support according to RFC2045, RFC2046, RFC2047 and RFC2231. Posted articles should be fully RFC5536 and MIME compliant. For the receiving direction, the following MIME conformance requirements from RFC2049 chapter 2 are not implemented yet:

* Part 6 (Media types)
Support for "message/rfc822" and "multipart/digest" is missing
* Part 6 (Media types)
Data with media type "application" can not be stored into a file yet

Additional checks are implemented that create warnings if an article violates common USENET conventions. Conformance to mandatory GNKSA 2.0 rules was reached with exception of part 4 (the "Reply-To" header field can only be modified before the article composer is started):

http://www.gnksa.org

Currently flnews 0.14 provides no support for the following features:

* Multiple servers
* Offline mode
* UUCP

If you need one of these features, use leafnode(8) or another proxy server (consider Hamster or CodoSoft NNTPd for machines with Windows operating system).

OPTIONS

The following options are supported:
-display [host]:display
X display to use. More information about X can be found in X(7).
-geometry WxH[+X+Y]
Window size and position.
-iconic
Starts with minimized window.
-h
Print help message.
-v
Print version and build date.

EXIT STATUS

Zero on regular exit. All other values indicate an error.

ENVIRONMENT


DISPLAY
X display to use. More information about X can be found in X(7).
FLTK_SCHEME
Selects the FLTK scheme to use. FLTK 1.3.0 accepts the following options:
TMPDIR
Directory used for temporary files (as recommended by POSIX). This value will override the default "/tmp".
TZ
The timezone that is used by localtime(3). flnews internally uses this function to convert POSIX timestamps to local time and for creating 'date-time' tokens according to RFC5322.

In addition, flnews honours the following locale related variables:

LANG
Used as fallback if LC_* variables are not set.
LC_ALL
Overdrives all other LC_* variables.
LC_CTYPE
Character classification to use. Only locales with US-ASCII, ISO8859-1 and UTF-8 codesets are allowed here. Setting this to a locale with UTF-8 codeset is very expensive on some operating systems (e.g. more than an order of magnitude slower on NetBSD 5). Note that setting this to POSIX or an ISO8859-1 locale will not completely disable Unicode support! You can at least use Unicode for your name in the identity configuration and you can correctly quote Unicode content for follow-up articles in any case.
LC_MESSAGES
Locale for user interface language. The codeset is ignored because FLTK internally always use UTF-8 (regardless of the locale settings). If flnews is compiled without National Language Support (NLS), this variable is ignored.

As a general rule, POSIX.2 define that all locale sections must use the same codeset. More information about NLS can be found in nls(7) or locale(7) depending on the operating system.

X RESOURCES

Information about X resources and how to set them can be found in X(7).
fltk.scheme
(String) See the environment variable FLTK_SCHEME for possible values. The environment variable takes precedence over this ressource.
Text.selectBackground
(String) The value of this ressource is taken as the background color for selected text. Set it to something like "gray" for a more decent selection color.
Xft.antialias
(Boolean) If FLTK uses the X11 backend and is compiled to use Xft (the default), then the value "true" will enable and "false" will disable font anti-aliasing. The recommended setting is "true".
Xft.hinting
(Boolean) If FLTK uses the X11 backend and is compiled to use Xft (the default), then the value "true" will enable and "false" will disable font hinting. The recommended setting is "true".
Xft.autohint
(Boolean) If FLTK uses the X11 backend, is compiled to use Xft (the default) and Xft is configured with enabled font hinting (resource Xft.hinting set to "true") then this resource controls the hinting algorithm. With setting "false" the BCI algorithm is used, "true" enables the builtin autohinter of Freetype2. The recommended setting is "false".
Xft.hintstyle
(Integer) If FLTK uses the X11 backend, is compiled to use Xft (the default) and Xft is configured with enabled font hinting (resource Xft.hinting set to "true") then this resource controls the hinting mode. Possible values are "hintnone" (0), "hintslight" (1), "hintmedium" (2) and "hintfull" (3). The recommended setting is "hintfull" (3).

FILES


~/.signature
The signature from this file is automatically appended to all created articles. Note that this file should be US-ASCII encoded. The signature separator "dash dash space" plus LF line break is automatically prepended if not already present in this file.
~/.flnews/configfile
Configuration and user interface state of last session. The file format is forward and backward compatible between all versions with same major number.
~/.flnews/groupfile
Subscribed groups and already viewed articles database. The data is US-ASCII encoded in newsrc format and can be shared with other newsreaders using the entry newsrc in configfile. It is possible to share the group data over machine borders by using a NFS server (advisory file locking support is required).
~/.flnews/headers/*
Cached article header database. The file names correspond to the article watermarks of the current NNTP server. If the server provides the OVER capability defined in RFC3977, this database is not used.
~/.flnews/logfile
Protocol dump of server communication from current/last session. To view this data while the program is running, select 'Tools->Protocol console' in the user interface. This file is overwritten for every new connection.
~/.flnews/scorefile
Scoring rules. The file format is forward and backward compatible between all versions with same major number.

CONFIGURATION

This section describes the format of the configfile.

This file must be a POSIX textfile, this means every line must be terminated with a LF line break.

Any line starting with '#' is treated as a comment (not parsed and ignored). Missing entries are automatically added, unsupported entries are ignored.

The content can have one of two types: Integer or Unicode string. Strings use the UTF-8 representation and NFC normalization of Unicode.

The following entries are supported by version 0.14 but can't be configured from the GUI. Some have no GUI editor by intent. If you don't know what you are doing, consider to not modify them.

* cancelkey (String)
Local secret for the Cancel-Lock mechanism
* crl_upd_c (Integer)
TLS certificate CRL update choice
* crl_upd_iv (Integer)
TLS certificate CRL update interval
* crl_upd_ts (String)
TLS certificate CRL update timestamp
* domain (String)
Optional domain under control of the user or his organization
* editor (String)
Optional external editor for article composition
* immedauth (Integer)
Immediate authentication option
* intro (String)
Introduction line format
* newsrc (String)
Optional pathname of file to share group states in newsrc format
* organization (String)
Optional name of the users organization
* post_proc (String)
Pathname of an optional article postprocessor
* scorerc (String)
Optional pathname of file to share scoring rules
* testgrp_ere (String)
POSIX.2 extended regular expression (Unicode is allowed)
* testgrp_kwords (String)
Comma separated list of words
* nntp_no_over (Integer)
Disable usage of overview (OVER command) for NNTP protocol
* dist_suggestions (Integer)
Use distribution suggestions

SCORING

This section describes the format of the scorefile.

This file must be a POSIX textfile, this means every line must be terminated with a LF line break.

Any line starting with '#' is treated as a comment (not parsed and ignored). All other lines are parsed as rules with 3 colon-separated fields:

* Type
The header field to which the rule is associated. This field is case sensitive.
* Score
The score value that apply if the filter rule matches.
* String
The rules content string.

The default score for every article is zero. If a rule matches, the score value from the second field will be added to the corresponding article. Note that the processing is not stopped after a match, the following rules are applied too.

Articles with nonzero score result are marked with icons in the GUI. Articles with negative score result are additionally marked as read.

NOTES

flnews is based in part on the work of the following projects:
* FLTK project (http://www.fltk.org/)
* Unicode standard (http://www.unicode.org/)
* OpenSSL project (http://www.openssl.org/)
* zlib compression library (http://zlib.net/)

AUTHORS

To view the list of authors and the license terms, select 'Help->License' in the user interface.

BUGS

To report bugs, select 'Help->Bug report' in the user interface.

STANDARDS

flnews tries to comply with the following standards:

ANSI X3.4, ISO2022, ISO8601, ISO8859, ISO10646, RFC822, RFC850, RFC977, RFC1468, RFC1738, RFC2045, RFC2046, RFC2047, RFC2049, RFC2104, RFC2152, RFC2231, RFC2246, RFC2368, RFC2585, RFC2606, RFC2646, RFC2980, RFC3174, RFC3629, RFC3676, RFC3977, RFC3986, RFC4346, RFC4642, RFC4643, RFC5198, RFC5246, RFC5280, RFC5322, RFC5536, RFC5537, RFC5538, RFC6048, RFC6176, RFC6048, RFC6657, RFC7230,RFC7231, RFC7234, RFC7568, POSIX.1-1996, Unicode 9.0.0

SEE ALSO

fltk(3), leafnode(8), locale(7), localtime(3), nls(7), ssl(3), zlib(3), X(7)
http://en.wikipedia.org/wiki/Usenet
http://www.gnksa.org