Mercurial > addons > weechat-scripts > weechat-terminal-title-script

comparison README @ 0:c54a46719c46

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial revision
author Guido Berhoerster <guido+weechat@berhoerster.name>
date Tue, 10 Mar 2015 22:40:28 +0100
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:c54a46719c46
1 Weechat Terminal Title Script
2 =============================
3
4 The terminal title script for Weechat displays user-defined information in the
5 terminal title if supported by the terminal.
6
7 Usage
8 -----
9
10 The terminal title script is written in Python 2 and requires Weechat 0.3.3 or
11 later with support for Python scripts.
12
13 The terminal title script can be configured through the following Weechat
14 settings:
15
16 plugins.var.python.terminal-title.title
17 : The string displayed in the terminal title. The string may contain certain
18 substitution identifiers in order to insert information from Weechat at
19 runtime.
20
21 Substitution identifiers always start with a "%" sign, two adjacent "%" act as
22 an escape and are substituted with a literal "%". Substitution identifiers
23 which are followed by alphanumeric characters or an underline character must
24 be sourrounded by braces, e.g. "%{buffer_title}_foo". The following
25 substitution identifiers can be referenced from
26 plugins.var.python.terminal-title.title:
27
28 buffer_title
29 : The title of the current buffer.
30
31 buffer_name
32 : The name of the current buffer.
33
34 buffer_plugin
35 : The plugin name of the current buffer.
36
37 buffer_number
38 : The number of the current buffer.
39
40 buffer_nicklist_count
41 : The number of nicks and groups in the nicklist.
42
43 buffer_count
44 : The number of buffers.
45
46 hotlist
47 : The buffers in the hostlist.
48
49 version
50 : The Weechat version.
51
52 Contact
53 -------
54
55 Please send any feedback, translations or bug reports via email to
56 <guido+weechat@berhoerster.name>.
57
58 Bug Reports
59 -----------
60
61 When sending bug reports, please always mention the exact version of the
62 script with which the issue occurs as well as the version of Weechat and the
63 operating system you are using and make sure that you provide sufficient
64 information to reproduce the issue and include any input, output, any error
65 messages and Python stack traces.
66
67 License
68 -------
69
70 Except otherwise noted, all files are Copyright (C) 2010 Guido Berhoerster and
71 distributed under the following license terms:
72
73 Copyright (C) 2010 Guido Berhoerster <guido+weechat@berhoerster.name>
74
75 Licensed under the GNU General Public License Version 3
76
77 This program is free software: you can redistribute it and/or modify it under
78 the terms of the GNU General Public License as published by the Free Software
79 Foundation, either version 3 of the License, or (at your option) any later
80 version.
81
82 This program is distributed in the hope that it will be useful, but WITHOUT ANY
83 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
84 PARTICULAR PURPOSE. See the GNU General Public License for more details.
85
86 You should have received a copy of the GNU General Public License along with
87 this program. If not, see <http://www.gnu.org/licenses/>.
88