Mercurial > addons > slrn-macros > slrn-persistent-tags-macro

annotate README @ 0:8eeb70d3d1ce

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:43:52 +0100
parents
children 49f639bc9bd9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
1 slrn Persistent Tags Macro
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
2 ==========================
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
3
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
4 The slrn persistent tags macro keeps tags persitent across sessions.
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
5
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
6 Usage
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
7 -----
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
8
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
9 The slrn persistent tags macro can be used by including it in the .slrnrc user
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
10 initialization file via the `interpret` command, e.g. provided that the file
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
11 persistent-tags.sl is located in one of the directories specified by the
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
12 macro_directory configuration variable:
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
13
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
14 interpret "persistent-tags.sl"
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
15
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
16 The persistent tags macro can be configured through the following slang
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
17 variables:
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
18
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
19 PersistentTags->tag_path
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
20 : Specified the path where tag files are stored.
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
21
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
22 PersistentTags->autosave
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
23 : Determines whether tags are saved automatically.
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
24
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
25 Contact
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
26 -------
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
27
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
28 Please send any feedback, translations or bug reports via email to
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
29 <guido+weechat@berhoerster.name>.
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
30
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
31 Bug Reports
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
32 -----------
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
33
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
34 When sending bug reports, please always mention the exact version of the
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
35 macro with which the issue occurs as well as the version of slrn, slang and
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
36 the operating system you are using and make sure that you provide sufficient
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
37 information to reproduce the issue and include any input, output, any error
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
38 messages and slang stack traces.
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
39
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
40 License
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
41 -------
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
42
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
43 Except otherwise noted, all files are Copyright (C) 2009 Guido Berhoerster and
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
44 distributed under the following license terms:
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
45
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
46 Copyright (C) 2009 Guido Berhoerster <guido+slrn@berhoerster.name>
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
47
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
48 Permission is hereby granted, free of charge, to any person obtaining
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
49 a copy of this software and associated documentation files (the
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
50 "Software"), to deal in the Software without restriction, including
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
51 without limitation the rights to use, copy, modify, merge, publish,
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
52 distribute, sublicense, and/or sell copies of the Software, and to
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
53 permit persons to whom the Software is furnished to do so, subject to
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
54 the following conditions:
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
55
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
56 The above copyright notice and this permission notice shall be included
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
57 in all copies or substantial portions of the Software.
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
58
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
59 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
60 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
61 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
62 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
63 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
64 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
8eeb70d3d1ce Initial revision
Guido Berhoerster <guido+slrn@berhoerster.name>
parents:
diff changeset
65 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.