slrn Terminal Title Macro
=========================

The slrn terminal title macro displays user-defined information in the
terminal title if supported by the terminal.

Usage
-----

The slrn terminal title macro can be used by including it in the .slrnrc user
initialization file via the `interpret` command, e.g. provided that the file
terminal-title.sl is located in one of the directories specified by the
macro_directory configuration variable:

    interpret "terminal-title.sl"

The terminal title macro can be configured through the following slang
variables:

TerminalTitle->article_title_format
:   The string displayed in the terminal title in article mode.  The string
    may contain certain substitution identifiers in order to insert
    information from slrn at runtime.

TerminalTitle->group_title_format
:   The string displayed in the terminal title in group mode.  The string
    may contain certain substitution identifiers in order to insert
    information from slrn at runtime.

Substitution identifiers always start with a "%" sign.  The following
substitution identifiers can be referenced from
TerminalTitle->article_title_format and TerminalTitle->group_title_format:

v
:   The slrn version.

s
:   The name of the current news server.

n
:   The name of the current newsgroup.

Contact
-------

Please send any feedback, translations or bug reports via email to
<guido+weechat@berhoerster.name>.

Bug Reports
-----------

When sending bug reports, please always mention the exact version of the
macro with which the issue occurs as well as the version of slrn, slang and
the operating system you are using and make sure that you provide sufficient
information to reproduce the issue and include any input, output, any error
messages and slang stack traces.

License
-------

Except otherwise noted, all files are Copyright (C) 2009 Guido Berhoerster and
distributed under the following license terms:

Copyright (C) 2009 Guido Berhoerster <guido+slrn@berhoerster.name>

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.