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

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