{
    "content": [
        {
            "type": "text",
            "text": "# ExtUtils::Manifest (perldoc)\n\n**Summary:** ExtUtils::Manifest - Utilities to write and check a MANIFEST file\n\n**Synopsis:** use ExtUtils::Manifest qw(...funcs to import...);\nmkmanifest();\nmy @missingfiles    = manicheck;\nmy @skipped          = skipcheck;\nmy @extrafiles      = filecheck;\nmy($missing, $extra) = fullcheck;\nmy $found    = manifind();\nmy $manifest = maniread();\nmanicopy($read,$target);\nmaniadd({$file => $comment, ...});\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **VERSION** (2 lines)\n- **SYNOPSIS** (17 lines)\n- **DESCRIPTION** (2 lines)\n- **FUNCTIONS** (67 lines) — 2 subsections\n  - maniread (33 lines)\n  - mkmanifest (53 lines)\n- **DIAGNOSTICS** (18 lines)\n- **ENVIRONMENT** (3 lines)\n- **SEE ALSO** (2 lines)\n- **AUTHOR** (4 lines)\n- **COPYRIGHT AND LICENSE** (5 lines)\n\n## Full Content\n\n### NAME\n\nExtUtils::Manifest - Utilities to write and check a MANIFEST file\n\n### VERSION\n\nversion 1.73\n\n### SYNOPSIS\n\nuse ExtUtils::Manifest qw(...funcs to import...);\n\nmkmanifest();\n\nmy @missingfiles    = manicheck;\nmy @skipped          = skipcheck;\nmy @extrafiles      = filecheck;\nmy($missing, $extra) = fullcheck;\n\nmy $found    = manifind();\n\nmy $manifest = maniread();\n\nmanicopy($read,$target);\n\nmaniadd({$file => $comment, ...});\n\n### DESCRIPTION\n\n...\n\n### FUNCTIONS\n\nExtUtils::Manifest exports no functions by default. The following are exported on request:\n\nmkmanifest\nmkmanifest();\n\nWrites all files in and below the current directory to your MANIFEST. It works similar to the\nresult of the Unix command\n\nfind . > MANIFEST\n\nAll files that match any regular expression in a file MANIFEST.SKIP (if it exists) are ignored.\n\nAny existing MANIFEST file will be saved as MANIFEST.bak.\n\nmanifind\nmy $found = manifind();\n\nreturns a hash reference. The keys of the hash are the files found below the current directory.\n\nmanicheck\nmy @missingfiles = manicheck();\n\nchecks if all the files within a \"MANIFEST\" in the current directory really do exist. If\n\"MANIFEST\" and the tree below the current directory are in sync it silently returns an empty\nlist. Otherwise it returns a list of files which are listed in the \"MANIFEST\" but missing from\nthe directory, and by default also outputs these names to STDERR.\n\nfilecheck\nmy @extrafiles = filecheck();\n\nfinds files below the current directory that are not mentioned in the \"MANIFEST\" file. An\noptional file \"MANIFEST.SKIP\" will be consulted. Any file matching a regular expression in such\na file will not be reported as missing in the \"MANIFEST\" file. The list of any extraneous files\nfound is returned, and by default also reported to STDERR.\n\nfullcheck\nmy($missing, $extra) = fullcheck();\n\ndoes both a manicheck() and a filecheck(), returning then as two array refs.\n\nskipcheck\nmy @skipped = skipcheck();\n\nlists all the files that are skipped due to your \"MANIFEST.SKIP\" file.\n\nmaniread\nmy $manifest = maniread();\nmy $manifest = maniread($manifestfile);\n\nreads a named \"MANIFEST\" file (defaults to \"MANIFEST\" in the current directory) and returns a\nHASH reference with files being the keys and comments being the values of the HASH. Blank lines\nand lines which start with \"#\" in the \"MANIFEST\" file are discarded.\n\nmaniskip\nmy $skipchk = maniskip();\nmy $skipchk = maniskip($manifestskipfile);\n\nif ($skipchk->($file)) { .. }\n\nreads a named \"MANIFEST.SKIP\" file (defaults to \"MANIFEST.SKIP\" in the current directory) and\nreturns a CODE reference that tests whether a given filename should be skipped.\n\nmanicopy\nmanicopy(\\%src, $destdir);\nmanicopy(\\%src, $destdir, $how);\n\nCopies the files that are the keys in %src to the $destdir. %src is typically returned by the\n\n#### maniread\n\nmanicopy( maniread(), $destdir );\n\nThis function is useful for producing a directory tree identical to the intended distribution\ntree.\n\n$how can be used to specify a different methods of \"copying\". Valid values are \"cp\", which\nactually copies the files, \"ln\" which creates hard links, and \"best\" which mostly links the\nfiles but copies any symbolic link to make a tree without any symbolic link. \"cp\" is the\ndefault.\n\nmaniadd\nmaniadd({ $file => $comment, ...});\n\nAdds an entry to an existing MANIFEST unless its already there.\n\n$file will be normalized (ie. Unixified). UNIMPLEMENTED\n\nMANIFEST\nA list of files in the distribution, one file per line. The MANIFEST always uses Unix filepath\nconventions even if you're not on Unix. This means foo/bar style not foo\\bar.\n\nAnything between white space and an end of line within a \"MANIFEST\" file is considered to be a\ncomment. Any line beginning with # is also a comment. Beginning with ExtUtils::Manifest 1.52, a\nfilename may contain whitespace characters if it is enclosed in single quotes; single quotes or\nbackslashes in that filename must be backslash-escaped.\n\n# this a comment\nsome/file\nsome/other/file            comment about some/file\n'some/third file'          comment\n\nMANIFEST.SKIP\nThe file MANIFEST.SKIP may contain regular expressions of files that should be ignored by\n\n#### mkmanifest\n\nlines and lines which start with \"#\" are skipped. Use \"\\#\" if you need a regular expression to\nstart with a \"#\".\n\nFor example:\n\n# Version control files and dirs.\n\\bRCS\\b\n\\bCVS\\b\n,v$\n\\B\\.svn\\b\n\n# Makemaker generated files and dirs.\n^MANIFEST\\.\n^Makefile$\n^blib/\n^MakeMaker-\\d\n\n# Temp, old and emacs backup files.\n~$\n\\.old$\n^#.*#$\n^\\.#\n\nIf no MANIFEST.SKIP file is found, a default set of skips will be used, similar to the example\nabove. If you want nothing skipped, simply make an empty MANIFEST.SKIP file.\n\nIn one's own MANIFEST.SKIP file, certain directives can be used to include the contents of other\nMANIFEST.SKIP files. At present two such directives are recognized.\n\n#!includedefault\nThis inserts the contents of the default MANIFEST.SKIP file\n\n#!include /Path/to/another/manifest.skip\nThis inserts the contents of the specified external file\n\nThe included contents will be inserted into the MANIFEST.SKIP file in between *#!start included\n/path/to/manifest.skip* and *#!end included /path/to/manifest.skip* markers. The original\nMANIFEST.SKIP is saved as MANIFEST.SKIP.bak.\n\nEXPORTOK\n&mkmanifest, &manicheck, &filecheck, &fullcheck, &maniread, and &manicopy are exportable.\n\nGLOBAL VARIABLES\n$ExtUtils::Manifest::MANIFEST defaults to \"MANIFEST\". Changing it results in both a different\n\"MANIFEST\" and a different \"MANIFEST.SKIP\" file. This is useful if you want to maintain\ndifferent distributions for different audiences (say a user version and a developer version\nincluding RCS).\n\n$ExtUtils::Manifest::Quiet defaults to 0. If set to a true value, all functions act silently.\n\n$ExtUtils::Manifest::Debug defaults to 0. If set to a true value, or if PERLMMMANIFESTDEBUG\nis true, debugging output will be produced.\n\n### DIAGNOSTICS\n\nAll diagnostic output is sent to \"STDERR\".\n\n\"Not in MANIFEST:\" *file*\nis reported if a file is found which is not in \"MANIFEST\".\n\n\"Skipping\" *file*\nis reported if a file is skipped due to an entry in \"MANIFEST.SKIP\".\n\n\"No such file:\" *file*\nis reported if a file mentioned in a \"MANIFEST\" file does not exist.\n\n\"MANIFEST:\" *$!*\nis reported if \"MANIFEST\" could not be opened.\n\n\"Added to MANIFEST:\" *file*\nis reported by mkmanifest() if $Verbose is set and a file is added to MANIFEST. $Verbose is\nset to 1 by default.\n\n### ENVIRONMENT\n\nPERLMMMANIFESTDEBUG\nTurns on debugging\n\n### SEE ALSO\n\nExtUtils::MakeMaker which has handy targets for most of the functionality.\n\n### AUTHOR\n\nAndreas Koenig \"andreas.koenig@anima.de\"\n\nCurrently maintained by the Perl Toolchain Gang.\n\n### COPYRIGHT AND LICENSE\n\nThis software is copyright (c) 1996- by Andreas Koenig.\n\nThis is free software; you can redistribute it and/or modify it under the same terms as the Perl\n5 programming language system itself.\n\n"
        }
    ],
    "structuredContent": {
        "command": "ExtUtils::Manifest",
        "section": "",
        "mode": "perldoc",
        "summary": "ExtUtils::Manifest - Utilities to write and check a MANIFEST file",
        "synopsis": "use ExtUtils::Manifest qw(...funcs to import...);\nmkmanifest();\nmy @missingfiles    = manicheck;\nmy @skipped          = skipcheck;\nmy @extrafiles      = filecheck;\nmy($missing, $extra) = fullcheck;\nmy $found    = manifind();\nmy $manifest = maniread();\nmanicopy($read,$target);\nmaniadd({$file => $comment, ...});",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "VERSION",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 17,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "FUNCTIONS",
                "lines": 67,
                "subsections": [
                    {
                        "name": "maniread",
                        "lines": 33
                    },
                    {
                        "name": "mkmanifest",
                        "lines": 53
                    }
                ]
            },
            {
                "name": "DIAGNOSTICS",
                "lines": 18,
                "subsections": []
            },
            {
                "name": "ENVIRONMENT",
                "lines": 3,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "AUTHOR",
                "lines": 4,
                "subsections": []
            },
            {
                "name": "COPYRIGHT AND LICENSE",
                "lines": 5,
                "subsections": []
            }
        ]
    }
}