{ "content": [ { "type": "text", "text": "# File::Remove (info)\n\n## NAME\n\nFile::Remove - Remove files and directories\n\n## SYNOPSIS\n\nuse File::Remove 'remove';\n# removes (without recursion) several files\nremove( '*.c', '*.pl' );\n# removes (with recursion) several directories\nremove( \\1, qw{directory1 directory2} );\n# removes (with recursion) several files and directories\nremove( \\1, qw{file1 file2 directory1 *~} );\n# removes without globbing:\nremove( \\1, {glob => 0}, '*');\n# trashes (with support for undeleting later) several files\ntrash( '*~' );\n\n## DESCRIPTION\n\nFile::Remove::remove removes files and directories. It acts like\n/bin/rm, for the most part. Although \"unlink\" can be given a list of\nfiles, it will not remove directories; this module remedies that. It\nalso accepts wildcards, * and ?, as arguments for filenames.\n\n## Sections\n\n- **NAME**\n- **VERSION**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **SUBROUTINES**\n- **SUPPORT**\n- **AUTHOR**\n- **COPYRIGHT**\n- **BUGS**\n- **COPYRIGHT AND LICENSE**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "File::Remove", "section": "", "mode": "info", "summary": "File::Remove - Remove files and directories", "synopsis": "use File::Remove 'remove';\n# removes (without recursion) several files\nremove( '*.c', '*.pl' );\n# removes (with recursion) several directories\nremove( \\1, qw{directory1 directory2} );\n# removes (with recursion) several files and directories\nremove( \\1, qw{file1 file2 directory1 *~} );\n# removes without globbing:\nremove( \\1, {glob => 0}, '*');\n# trashes (with support for undeleting later) several files\ntrash( '*~' );", "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": 8, "subsections": [] }, { "name": "SUBROUTINES", "lines": 55, "subsections": [] }, { "name": "SUPPORT", "lines": 65, "subsections": [] }, { "name": "AUTHOR", "lines": 2, "subsections": [] }, { "name": "COPYRIGHT", "lines": 19, "subsections": [] }, { "name": "BUGS", "lines": 7, "subsections": [] }, { "name": "COPYRIGHT AND LICENSE", "lines": 6, "subsections": [] } ], "sections": { "NAME": { "content": "File::Remove - Remove files and directories\n", "subsections": [] }, "VERSION": { "content": "version 1.60\n", "subsections": [] }, "SYNOPSIS": { "content": "use File::Remove 'remove';\n\n# removes (without recursion) several files\nremove( '*.c', '*.pl' );\n\n# removes (with recursion) several directories\nremove( \\1, qw{directory1 directory2} );\n\n# removes (with recursion) several files and directories\nremove( \\1, qw{file1 file2 directory1 *~} );\n\n# removes without globbing:\nremove( \\1, {glob => 0}, '*');\n\n# trashes (with support for undeleting later) several files\ntrash( '*~' );\n", "subsections": [] }, "DESCRIPTION": { "content": "File::Remove::remove removes files and directories. It acts like\n/bin/rm, for the most part. Although \"unlink\" can be given a list of\nfiles, it will not remove directories; this module remedies that. It\nalso accepts wildcards, * and ?, as arguments for filenames.\n\nFile::Remove::trash accepts the same arguments as remove, with the\naddition of an optional, infrequently used \"other platforms\" hashref.\n", "subsections": [] }, "SUBROUTINES": { "content": "remove\nRemoves files and directories. Directories are removed recursively\nlike in rm -rf if the first argument is a reference to a scalar that\nevaluates to true. If the first argument is a reference to a scalar,\nthen it is used as the value of the recursive flag. By default it's\nfalse so only pass \\1 to it.\n\nIf the next argument is a hash reference then it is a key/values of\noptions. Currently, there is one supported option of \"'glob' => 0\"\nwhich prevents globbing. E.g:\n\nremove(\\1, {glob => 0}, '*');\n\nWill not remove files globbed by '*' and will only remove the file\ncalled asterisk if it exists.\n\nIn list context it returns a list of files/directories removed, in\nscalar context it returns the number of files/directories removed. The\nlist/number should match what was passed in if everything went well.\n\nrm\nJust calls remove. It's there for people who get tired of typing\nremove.\n\nclear\nThe \"clear\" function is a version of \"remove\" designed for use in test\nscripts. It takes a list of paths that it will both initially delete\nduring the current test run, and then further flag for deletion at END-\ntime as a convenience for the next test run.\n\ntrash\nRemoves files and directories, with support for undeleting later.\nAccepts an optional \"other platforms\" hashref, passing the remaining\narguments to remove.\n\nWin32\nRequires Win32::FileOp.\n\nInstallation not actually enforced on Win32 yet, since\nWin32::FileOp has badly failing dependencies at time of writing.\n\nOS X\nRequires Mac::Glue.\n\nOther platforms\nThe first argument to trash() must be a hashref with two keys,\n'rmdir' and 'unlink', each referencing a coderef. The coderefs\nwill be called with the filenames that are to be deleted.\n\nexpand\nDO NOT USE. Kept for legacy.\n\nundelete\nDO NOT USE. Kept for legacy.\n", "subsections": [] }, "SUPPORT": { "content": "Websites\nThe following websites have more information about this module, and may\nbe of help to you. As always, in addition to those websites please use\nyour favorite search engine to discover more resources.\n\no MetaCPAN\n\nA modern, open-source CPAN search engine, useful to view POD in\nHTML format.\n\n\n\no RT: CPAN's Bug Tracker\n\nThe RT ( Request Tracker ) website is the default bug/issue\ntracking system for CPAN.\n\n\n\no CPANTS\n\nThe CPANTS is a website that analyzes the Kwalitee ( code metrics )\nof a distribution.\n\n\n\no CPAN Testers\n\nThe CPAN Testers is a network of smoke testers who run automated\ntests on uploaded CPAN distributions.\n\n\n\no CPAN Testers Matrix\n\nThe CPAN Testers Matrix is a website that provides a visual\noverview of the test results for a distribution on various\nPerls/platforms.\n\n\n\no CPAN Testers Dependencies\n\nThe CPAN Testers Dependencies is a website that shows a chart of\nthe test results of all dependencies for a distribution.\n\n\n\nBugs / Feature Requests\nPlease report any bugs or feature requests by email to \"bug-file-remove\nat rt.cpan.org\", or through the web interface at\n. You\nwill be automatically notified of any progress on the request by the\nsystem.\n\nSource Code\nThe code is open to the world, and available for you to hack on. Please\nfeel free to browse it and play with it, or whatever. If you want to\ncontribute patches, please send me a diff or prod me to pull from your\nrepository :)\n\n\n\ngit clone git://github.com/shlomif/File-Remove.git\n", "subsections": [] }, "AUTHOR": { "content": "Shlomi Fish \n", "subsections": [] }, "COPYRIGHT": { "content": "Taken over by Shlomi Fish () while\ndisclaiming all rights and placing his modifications under\nCC0/public-domain/MIT/any-other-licence.\n\nSome parts copyright 2006 - 2012 Adam Kennedy.\n\nTaken over by Adam Kennedy to fix the \"deep readonly\nfiles\" bug, and do some package cleaning.\n\nSome parts copyright 2004 - 2005 Richard Soderberg.\n\nTaken over by Richard Soderberg to port it to\nFile::Spec and add tests.\n\nOriginal copyright: 1998 by Gabor Egressy, .\n\nThis program is free software; you can redistribute and/or modify it\nunder the same terms as Perl itself.\n", "subsections": [] }, "BUGS": { "content": "Please report any bugs or feature requests on the bugtracker website\n or by email to\nbug-file-remove@rt.cpan.org .\n\nWhen submitting a bug or request, please include a test-file or a patch\nto an existing test-file that illustrates the bug or desired feature.\n", "subsections": [] }, "COPYRIGHT AND LICENSE": { "content": "This software is copyright (c) 1998 by Gabor Egressy.\n\nThis is free software; you can redistribute it and/or modify it under\nthe same terms as the Perl 5 programming language system itself.\n\nperl v5.30.3 2020-10-25 File::Remove(3pm)", "subsections": [] } } } }