{
    "content": [
        {
            "type": "text",
            "text": "# File::DirList (perldoc)\n\n## NAME\n\nFile::DirList - provide a sorted list of directory content  *Version 0.04*\n\n## SYNOPSIS\n\nuse File::DirList;\n#\nmy @list = File::DirList::list('.', 'dn', 1, 0);\n\n## DESCRIPTION\n\nThis module is used to get a list of directory content. It is a simple wrapper around DirHandle\nand sort()\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **SEE ALSO**\n- **AUTHOR**\n- **COPYRIGHT AND LICENSE**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "File::DirList",
        "section": "",
        "mode": "perldoc",
        "summary": "File::DirList - provide a sorted list of directory content  *Version 0.04*",
        "synopsis": "use File::DirList;\n#\nmy @list = File::DirList::list('.', 'dn', 1, 0);",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 4,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 4,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 95,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "AUTHOR",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "COPYRIGHT AND LICENSE",
                "lines": 6,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "File::DirList - provide a sorted list of directory content\n\n*Version 0.04*\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "use File::DirList;\n#\nmy @list = File::DirList::list('.', 'dn', 1, 0);\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "This module is used to get a list of directory content. It is a simple wrapper around DirHandle\nand sort()\n\nThe module has two methods:\n\n\"list($dirName, $sortMode, $noLinks, $hideDotFiles, $showSelf)\"\nProduces a list, accepting 5 parameters:\n\n$dirName\nName of the directory to list\n\n$sortMode\nDescribes how list should be sorted.\n\nThis is a string containing the following symbols, with uppercase representing the\nreverse sort:\n\n\"d\" or \"D\"\n\"Directory\" sort. 'd' means all the directories will precede files, 'D' means\nreverse.\n\n\"n\" or \"N\"\nSort by file (or subdirectory) name.\n\n\"i\" or \"I\"\nSame as 'n' but case insensitive.\n\n\"m\" or \"M\"\nSort by modification time.\n\n\"c\" or \"C\"\nSort by creation time.\n\n\"a\" or \"A\"\nSort by access time.\n\n\"s\" or \"S\"\nSort by size.\n\n$sortMode is interpreted from left to right. If the first comparison produces an equal\nresult next one is used. For example, string \"*'din'*\" produces a list with all the\ndirectories preceding files, directories and files are sorted by name case\ninsensitively, with lowercase letters preceding upper case.\n\n$noLinks\nIf \"true\" symbolic links will not be examined. Set it on platforms without symlink\nsupport.\n\n$hideDotFiles\nIf \"true\" *'dot'* files will not be reported.\n\n$showSelf\nIf \"true\" *'.'* directory entry will be reported.\n\nReturned value is an array reference, sorted as described by $sortMode.\n\nArray elements are array references representing an item.\n\nThe individual item's array contains 17 elements:\n\n\"[0..12]\"\nResult of stat() for this item. For valid symbolic links, the stat of the target item is\nreturned.\n\n\"[13]\"\nName of the item.\n\n\"[14]\"\nIs item a directory? Contains 0 for non-directory items, 1 for directories, 2 for '..',\n3 for '.'. Used by \"d or D\" sorting.\n\n\"[15]\"\nIs item a link? 0 for non-links, 1 for valid links, -1 for invalid links.\n\n\"[16]\"\nLink target. \"*undef*\" for non-links, target path for links.\n\n[15] and [16] are set to non-link if $examineLinks is \"false\".\n\n\"sortList($list, $sortMode)\"\nUsed to re-sort a list produced by \"list()\"\n\nParameters are\n\n$lis\nReference to a list produced by \"list()\"\n\n$sortMode\nSorting rules.\n\nReturn value is similar to \"list()\"\n\nEXPORT\nNone by default\n",
                "subsections": []
            },
            "SEE ALSO": {
                "content": "DirHandle, stat, lstat, sort\n",
                "subsections": []
            },
            "AUTHOR": {
                "content": "Daniel Podolsky, <tpaba@cpan.org>\n",
                "subsections": []
            },
            "COPYRIGHT AND LICENSE": {
                "content": "Copyright (C) 2006 by Daniel Podolsky, <tpaba@cpan.org>\n\nThis library is free software; you can redistribute it and/or modify it under the same terms as\nPerl itself, either Perl version 5.8.4 or, at your option, any later version of Perl 5 you may\nhave available.\n",
                "subsections": []
            }
        }
    }
}