Update podlators to version 4.03
[perl.git] / cpan / podlators / t / data / snippets / README
1 The files in this directory are used by the test suite to exercise various
2 behavior of Pod::Man or Pod::Text.  They use a pseudo-ini-file syntax with
3 free-form sections, normally an input and an output section and possibly
4 others.
5
6 Sections start with the section type in [].  The contents are normally
7 just free-form.  The exception is an [options] section, where the contents
8 are key/value pairs, where the key is separated from the value with
9 whitespace.
10
11 Valid sections are:
12
13     [name]
14     The name of this test for status reporting
15     
16     [options]
17     key value
18     key value
19     
20     [input]
21     POD input source.
22     
23     [output]
24     The results of running some formatter on the input.
25     
26     [errors]
27     Errors reported to standard error when running some formatter on the
28     input.
29     
30     [exception]
31     The text of an exception (with the file and line number information
32     stripped) thrown by running some formatter on the input.
33
34 Files are organized into subdirectories named after the formatter, namely
35 man (Pod::Man), text (Pod::Text), color (Pod::Text::Color), overstrike
36 (Pod::Text::Overstrike), and termcap (Pod::Text::Termcap).
37
38 -----
39
40 Copyright 2015 Russ Allbery <rra@cpan.org>
41
42 Copying and distribution of this file, with or without modification, are
43 permitted in any medium without royalty provided the copyright notice and
44 this notice are preserved.  This file is offered as-is, without any
45 warranty.