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