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

annotate README @ 1:98c1a683d9c1

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