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

view README @ 1:b5ca94cc74ae

Change license to GPL-2.0+
author Guido Berhoerster <guido+slrn@berhoerster.name>
date Sat Jul 25 17:12:50 2015 +0200 (2015-07-25)
parents 1964c513723a
children
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 This program is free software; you can redistribute it and/or
67 modify it under the terms of the GNU General Public License
68 as published by the Free Software Foundation; either version 2
69 of the License, or (at your option) any later version.
71 This program is distributed in the hope that it will be useful,
72 but WITHOUT ANY WARRANTY; without even the implied warranty of
73 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
74 GNU General Public License for more details.
76 You should have received a copy of the GNU General Public License
77 along with this program; if not, write to the Free Software
78 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.