addons/slrn-macros/slrn-terminal-title-macro

view README @ 0:1964c513723a

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