Weechat Terminal Title Script
=============================

The terminal title script for Weechat displays user-defined information in the
terminal title if supported by the terminal.

Usage
-----

The terminal title script is written in Python 2 and requires Weechat 0.3.3 or
later with support for Python scripts.

The terminal title script can be configured through the following Weechat
settings:

plugins.var.python.terminal-title.title
:   The string displayed in the terminal title. The string may contain certain
    substitution identifiers in order to insert information from Weechat at
    runtime.

Substitution identifiers always start with a "%" sign, two adjacent "%" act as
an escape and are substituted with a literal "%".  Substitution identifiers
which are followed by alphanumeric characters or an underline character must
be sourrounded by braces, e.g. "%{buffer_title}_foo". The following
substitution identifiers can be referenced from
plugins.var.python.terminal-title.title:

buffer_title
:   The title of the current buffer.

buffer_name
:   The name of the current buffer.

buffer_plugin
:   The plugin name of the current buffer.

buffer_number
:   The number of the current buffer.

buffer_nicklist_count
:   The number of nicks and groups in the nicklist.

buffer_count
:   The number of buffers.

hotlist
:   The buffers in the hostlist.

version
:   The Weechat version.

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
script with which the issue occurs as well as the version of Weechat 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 Python stack traces.

License
-------

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

Copyright (C) 2010 Guido Berhoerster <guido+weechat@berhoerster.name>

Licensed under the GNU General Public License Version 3

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 3 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, see <http://www.gnu.org/licenses/>.