Mercurial > addons > slrn-macros > slrn-terminal-title-macro

annotate README @ 0:1964c513723a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial revision
author Guido Berhoerster <guido+slrn@berhoerster.name>
date Sat, 14 Mar 2015 11:44:11 +0100
parents
children b5ca94cc74ae
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
1 slrn Terminal Title Macro
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
2 =========================
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
3
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
4 The slrn terminal title macro displays user-defined information in the
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
5 terminal title if supported by the terminal.
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
6
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
7 Usage
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
8 -----
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
9
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
10 The slrn terminal title macro can be used by including it in the .slrnrc user
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
11 initialization file via the `interpret` command, e.g. provided that the file
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
12 terminal-title.sl is located in one of the directories specified by the
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
13 macro_directory configuration variable:
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
14
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
15 interpret "terminal-title.sl"
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
16
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
17 The terminal title macro can be configured through the following slang
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
18 variables:
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
19
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
20 TerminalTitle->article_title_format
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
21 : The string displayed in the terminal title in article mode. The string
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
22 may contain certain substitution identifiers in order to insert
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
23 information from slrn at runtime.
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
24
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
25 TerminalTitle->group_title_format
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
26 : The string displayed in the terminal title in group mode. The string
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
27 may contain certain substitution identifiers in order to insert
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
28 information from slrn at runtime.
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
29
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
30 Substitution identifiers always start with a "%" sign. The following
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
31 substitution identifiers can be referenced from
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
32 TerminalTitle->article_title_format and TerminalTitle->group_title_format:
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
33
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
34 v
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
35 : The slrn version.
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
36
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
37 s
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
38 : The name of the current news server.
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
39
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
40 n
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
41 : The name of the current newsgroup.
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
42
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
43 Contact
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
44 -------
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
45
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
46 Please send any feedback, translations or bug reports via email to
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
47 <guido+weechat@berhoerster.name>.
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
48
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
49 Bug Reports
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
50 -----------
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
51
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
52 When sending bug reports, please always mention the exact version of the
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
53 macro with which the issue occurs as well as the version of slrn, slang and
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
54 the operating system you are using and make sure that you provide sufficient
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
55 information to reproduce the issue and include any input, output, any error
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
56 messages and slang stack traces.
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
57
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
58 License
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
59 -------
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
60
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
61 Except otherwise noted, all files are Copyright (C) 2009 Guido Berhoerster and
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
62 distributed under the following license terms:
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
63
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
64 Copyright (C) 2009 Guido Berhoerster <guido+slrn@berhoerster.name>
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
65
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
66 Permission is hereby granted, free of charge, to any person obtaining
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
67 a copy of this software and associated documentation files (the
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
68 "Software"), to deal in the Software without restriction, including
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
69 without limitation the rights to use, copy, modify, merge, publish,
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
70 distribute, sublicense, and/or sell copies of the Software, and to
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
71 permit persons to whom the Software is furnished to do so, subject to
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
72 the following conditions:
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
73
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
74 The above copyright notice and this permission notice shall be included
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
75 in all copies or substantial portions of the Software.
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
76
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
77 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
78 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
79 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
80 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
81 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
82 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
1964c513723a Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
83 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.