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