/usr/share/perl5/User/Identity/Archive/Plain.pod is in libuser-identity-perl 0.93-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 | =head1 NAME
User::Identity::Archive::Plain - simple, plain text archiver
=head1 INHERITANCE
User::Identity::Archive::Plain
is a User::Identity::Archive
is a User::Identity::Item
=head1 SYNOPSIS
use User::Identity::Archive::Plain;
my $friends = User::Identity::Archive::Plain->new('friends');
$friends->from(\*FH);
$friends->from('.friends');
=head1 DESCRIPTION
This archiver, which extends L<User::Identity::Archive|User::Identity::Archive>, uses a very
simple plain text file to store the information of users. The syntax
is described in the DETAILS section, below.
=head1 OVERLOADED
=head1 METHODS
=head2 Constructors
User::Identity::Archive::Plain-E<gt>B<new>([NAME], OPTIONS)
=over 4
Option --Defined in --Default
abbreviations []
description User::Identity::Item undef
from User::Identity::Archive undef
name User::Identity::Item <required>
only []
parent User::Identity::Item undef
tabstop 8
. abbreviations => HASH|ARRAY
=over 4
Adds a set of abbreviations for collections to the syntax of the
plain text archiver. See section L</Simplified class names> for
a list of predefined names.
=back
. description => STRING
. from => FILEHANDLE|FILENAME
. name => STRING
. only => ARRAY|ABBREV
=over 4
Lists the only information (as (list of) abbreviations) which should be
read. Other information is removed before even checking whether it is
a valid abbreviation or not.
=back
. parent => OBJECT
. tabstop => INTEGER
=over 4
Sets the default tab-stop width.
=back
=back
=head2 Attributes
$obj-E<gt>B<abbreviation>(NAME, [CLASS])
=over 4
Returns the class which is capable of storing information which is
grouped as NAME. With CLASS argument, you add (or overrule) the
definitions of an abbreviation. The CLASS is automatically loaded.
If CLASS is C<undef>, then the abbreviation is deleted. The class
name which is deleted is returned.
=back
$obj-E<gt>B<abbreviations>
=over 4
Returns a sorted list of all names which are known as abbreviations.
=back
$obj-E<gt>B<defaultTabStop>([INTEGER])
=over 4
Returns the width of a tab, optionally after setting it. This must be
the same as set in your editor.
=back
$obj-E<gt>B<description>
=over 4
See L<User::Identity::Item/"Attributes">
=back
$obj-E<gt>B<name>([NEWNAME])
=over 4
See L<User::Identity::Item/"Attributes">
=back
=head2 Collections
$obj-E<gt>B<add>(COLLECTION, ROLE)
=over 4
See L<User::Identity::Item/"Collections">
=back
$obj-E<gt>B<addCollection>(OBJECT | ([TYPE], OPTIONS))
=over 4
See L<User::Identity::Item/"Collections">
=back
$obj-E<gt>B<collection>(NAME)
=over 4
See L<User::Identity::Item/"Collections">
=back
$obj-E<gt>B<find>(COLLECTION, ROLE)
=over 4
See L<User::Identity::Item/"Collections">
=back
$obj-E<gt>B<parent>([PARENT])
=over 4
See L<User::Identity::Item/"Collections">
=back
$obj-E<gt>B<removeCollection>(OBJECT|NAME)
=over 4
See L<User::Identity::Item/"Collections">
=back
$obj-E<gt>B<type>
User::Identity::Archive::Plain-E<gt>B<type>
=over 4
See L<User::Identity::Item/"Collections">
=back
$obj-E<gt>B<user>
=over 4
See L<User::Identity::Item/"Collections">
=back
=head2 Access to the archive
$obj-E<gt>B<from>(FILEHANDLE|FILENAME|ARRAY, OPTIONS)
=over 4
Read the plain text information from the specified FILEHANDLE, FILENAME,
STRING, or ARRAY of lines.
Option --Default
tabstop <default from object>
verbose 0
. tabstop => INTEGER
. verbose => INTEGER
=back
=head1 DETAILS
=head2 The Plain Archiver Format
=head3 Simplified class names
It is too much work to specify full class named on each spot where you
want to create a new object with data. Therefore, abbreviations are
introduced. Use L<new(abbreviations)|User::Identity::Archive::Plain/"METHODS"> or L<abbreviations()|User::Identity::Archive::Plain/"Attributes"> to add extra
abbreviations or to overrule some predefined.
Predefined names:
user User::Identity
email Mail::Identity
location User::Identity::Location
system User::Identity::System
list User::Identity::Collection::Emails
It would have been nicer to refer to a I<person> in stead of a I<user>,
however that would add to the confusion with the name-space.
=head3 Indentation says all
The syntax is as simple as possible. An extra indentation on a line
means that the variable or class is a collection within the class on
the line before.
user markov
location home
country NL
email home
address mark@overmeer.net
location home
email work
address solutions@overmeer.bet
email tux
address tux@fish.net
The above defines two items: one L<User::Identity|User::Identity> named C<markov>, and
an e-mail address C<tux>. The user has two collections: one contains
a single location, and one stores two e-mail addresses.
To add to the confusion: the C<location> is defined as field in C<email>
and as collection. The difference is easily detected: if there are
indented fields following the line it is a collection. Mistakes will
in most cases result in an error message.
=head3 Long lines
If you want to continue on the next line, because your content is too
large, then add a backslash to the end, like this:
email home
description This is my home address, \
But I sometimes use this for \
work as well
address tux@fish.aq
Continuations do not play the game of indentation, so what you also
can do is:
email home
description \
This is my home address, \
But I sometimes use this for \
work as well
address tux@fish.aq
The fields C<comment> and C<address> must be correctly indented.
The line terminations are lost, which is useful for most fields. However,
if you need them, you have to check the description of the applicable field.
=head3 Comments
You may add comments and white spaces. Comments start with a C<'#'> as
first non-blank character on the line. Comments are B<not allowed> on
the same line as real data, as some languages (like Perl) permit.
You can insert comments and blank lines on all places where you need
them:
user markov
# my home address
email home
# useless comment statement
address tux@fish.aq
location #mind_the_hash
is equivalent to:
user markov
email home
address tux@fish.aq
location #mind_the_hash
=head3 References
Often you will have the need to add the same information to two items,
for instance, multiple people share the same address. In this case,
you can create a reference. However, this is only permitted for
whole items: you can refer to someone's location, but not to the person's
street.
To create a reference to an item of someone else, use
user markov
location home = user(cleo).location(home)
location work
organization MARKOV Solutions
=head3 Configuration parameters
You can add some configuration lines as well. On the moment, the only
one defined is
tabstop = 4
which can be used to change the meaning of tabs in the file. The default
setting is 8, but some people prefer 4 (or other values).
=head1 DIAGNOSTICS
Error: $object is not a collection.
=over 4
The first argument is an object, but not of a class which extends
L<User::Identity::Collection|User::Identity::Collection>.
=back
Error: Cannot load collection module for $type ($class).
=over 4
Either the specified $type does not exist, or that module named $class returns
compilation errors. If the type as specified in the warning is not
the name of a package, you specified a nickname which was not defined.
Maybe you forgot the 'require' the package which defines the nickname.
=back
Warning: Cannot read archive from $source
=over 4
=back
Error: Creation of a collection via $class failed.
=over 4
The $class did compile, but it was not possible to create an object
of that class using the options you specified.
=back
Error: Don't know what type of collection you want to add.
=over 4
If you add a collection, it must either by a collection object or a
list of options which can be used to create a collection object. In
the latter case, the type of collection must be specified.
=back
Warning: No collection $name
=over 4
The collection with $name does not exist and can not be created.
=back
=head1 SEE ALSO
This module is part of User-Identity distribution version 0.93,
built on December 24, 2009. Website: F<http://perl.overmeer.net/userid/>
=head1 LICENSE
Copyrights 2003,2004,2007-2009 by Mark Overmeer <perl@overmeer.net>. For other contributors see Changes.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See F<http://www.perl.com/perl/misc/Artistic.html>
|