diff options
| author | 2017-08-25 12:07:04 +0200 | |
|---|---|---|
| committer | 2017-08-25 12:07:04 +0200 | |
| commit | bff6c4d1d3b34e5c4c3fb83f9439b4427f75a363 (patch) | |
| tree | d8ebbabf69b237556205b9d3f62ae50a1ce51652 /src/kvilib/ext/KviRegisteredUserDataBase.cpp | |
| parent | Fix the text of all links in the documentation being lowercase. (diff) | |
| download | KVIrc-bff6c4d1d3b34e5c4c3fb83f9439b4427f75a363.tar.gz KVIrc-bff6c4d1d3b34e5c4c3fb83f9439b4427f75a363.tar.bz2 KVIrc-bff6c4d1d3b34e5c4c3fb83f9439b4427f75a363.zip | |
Remove lots of redundant line feeds around block elements in the docs.
Diffstat (limited to 'src/kvilib/ext/KviRegisteredUserDataBase.cpp')
| -rw-r--r-- | src/kvilib/ext/KviRegisteredUserDataBase.cpp | 21 |
1 files changed, 9 insertions, 12 deletions
diff --git a/src/kvilib/ext/KviRegisteredUserDataBase.cpp b/src/kvilib/ext/KviRegisteredUserDataBase.cpp index 8469bd2c9..cabe06fde 100644 --- a/src/kvilib/ext/KviRegisteredUserDataBase.cpp +++ b/src/kvilib/ext/KviRegisteredUserDataBase.cpp @@ -44,20 +44,19 @@ registered users, registration mask, registered user properties, user properties, notify property, avatar property @body: - [big]Introduction[/big][br] + [big]Introduction[/big] The registered user database is basically a set of users with associated [doc:irc_masks]irc-masks[/doc] and properties.[br] It is used to recognize users on IRC and associate properties to them.[br] - This works more or less like the IRC ban list, K-Line list, or invite list.[br] - [big]User entry[/big][br] + This works more or less like the IRC ban list, K-Line list, or invite list. + [big]User entry[/big] A registered user database entry is identified by a [b]unique[/b] name.[br] It may be the nickname of the user that you want to match, or the real name (if you know it) or any other string (even with spaces). The name is an [i]internal identifier[/i] for the user entry: each name maps to a single entry and each entry has a single name.[br] Each entry has a set of registration [doc:irc_masks]irc-masks[/doc]: these masks - are used to recognize the user on IRC.[br] - [br] - [big]Registration masks[/big][br] + are used to recognize the user on IRC. + [big]Registration masks[/big] The masks have the common IRC mask format: [b]<nick>!<user>@<host>[/b][br] The masks may contain [b]*[/b] and [b]?[/b] wildcards that match any portion of text.[br] [b]*!*@*[/b][br] @@ -78,7 +77,7 @@ [b]<nick>!*<username>@*.<host>.<top>[/b][br] or[br] [b]<nick>!*<username>@<number>.<number>.<number>.*[/b][br] - In this way you can be 95% sure that the mask will really match the correct user.[br] + In this way you can be 95% sure that the mask will really match the correct user. [big]Example of registration and lookups[/big] Assume that you want to register a friend of yours: Derek Riggs.[br] Derek often uses [i]Eddie[/i] as his nickname @@ -100,8 +99,7 @@ If you have two masks registered: [b]Pragma!*xor@*.myisp.it[/b] and [b]*!*@*.myisp.it[/b], KVIrc will match [b]Pragma!~xor@233-dyn.myisp.it[/b] with the first one even if the second one also matches; the first one however, is a best match. - [br][br] - [big]Properties[/big][br] + [big]Properties[/big] A registered user has an (eventually empty) set of properties defined by name/value pairs. (In versions prior to 3.0.0 flags were used instead, but revealed to be insufficient).[br] @@ -112,9 +110,8 @@ KVIrc will attempt to track the user presence on IRC. Another one is the [doc:avatar]avatar[/doc] property. Its value should be the name of the [i]default[/i] [doc:avatar]avatar image file[/doc] for the specified user.[br] - The [i]ignore[/i] property should be set to [i]1[/i] (or [i]true[/i]) for users that have to be ignored (:D).[br] - [br] - [big]The interface to the database[/big][br] + The [i]ignore[/i] property should be set to [i]1[/i] (or [i]true[/i]) for users that have to be ignored (:D). + [big]The interface to the database[/big] The [module:reguser]reguser module[/module] is the interface to the [i]registered users database[/i].[br] It provides a set of commands for adding and removing masks and manipulating properties.[br] */ |
