{ "content": [ { "type": "text", "text": "# File::Remove (perldoc)\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 /bin/rm, for the most part.\nAlthough \"unlink\" can be given a list of files, it will not remove directories; this module\nremedies that. It also accepts wildcards, * and ?, as arguments for filenames.\n\n## Sections\n\n- **NAME**\n- **VERSION**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **SUBROUTINES**\n- **SUPPORT** (2 subsections)\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": "perldoc", "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": 7, "subsections": [] }, { "name": "SUBROUTINES", "lines": 49, "subsections": [] }, { "name": "SUPPORT", "lines": 1, "subsections": [ { "name": "Websites", "lines": 48 }, { "name": "Source Code", "lines": 8 } ] }, { "name": "AUTHOR", "lines": 2, "subsections": [] }, { "name": "COPYRIGHT", "lines": 17, "subsections": [] }, { "name": "BUGS", "lines": 7, "subsections": [] }, { "name": "COPYRIGHT AND LICENSE", "lines": 5, "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 /bin/rm, for the most part.\nAlthough \"unlink\" can be given a list of files, it will not remove directories; this module\nremedies that. It also accepts wildcards, * and ?, as arguments for filenames.\n\nFile::Remove::trash accepts the same arguments as remove, with the addition of an optional,\ninfrequently used \"other platforms\" hashref.\n", "subsections": [] }, "SUBROUTINES": { "content": "remove\nRemoves files and directories. Directories are removed recursively like in rm -rf if the first\nargument is a reference to a scalar that evaluates to true. If the first argument is a reference\nto a scalar, then it is used as the value of the recursive flag. By default it's false so only\npass \\1 to it.\n\nIf the next argument is a hash reference then it is a key/values of options. Currently, there is\none supported option of \"'glob' => 0\" which prevents globbing. E.g:\n\nremove(\\1, {glob => 0}, '*');\n\nWill not remove files globbed by '*' and will only remove the file called asterisk if it exists.\n\nIn list context it returns a list of files/directories removed, in scalar context it returns the\nnumber of files/directories removed. The list/number should match what was passed in if\neverything went well.\n\nrm\nJust calls remove. It's there for people who get tired of typing remove.\n\nclear\nThe \"clear\" function is a version of \"remove\" designed for use in test scripts. It takes a list\nof paths that it will both initially delete during the current test run, and then further flag\nfor deletion at END-time as a convenience for the next test run.\n\ntrash\nRemoves files and directories, with support for undeleting later. Accepts an optional \"other\nplatforms\" hashref, passing the remaining arguments to remove.\n\nWin32\nRequires Win32::FileOp.\n\nInstallation not actually enforced on Win32 yet, since Win32::FileOp has badly failing\ndependencies 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, 'rmdir' and 'unlink', each\nreferencing a coderef. The coderefs will be called with the filenames that are to be\ndeleted.\n\nexpand\nDO NOT USE. Kept for legacy.\n\nundelete\nDO NOT USE. Kept for legacy.\n", "subsections": [] }, "SUPPORT": { "content": "", "subsections": [ { "name": "Websites", "content": "The following websites have more information about this module, and may be of help to you. As\nalways, in addition to those websites please use your favorite search engine to discover more\nresources.\n\n* MetaCPAN\n\nA modern, open-source CPAN search engine, useful to view POD in HTML format.\n\n\n\n* RT: CPAN's Bug Tracker\n\nThe RT ( Request Tracker ) website is the default bug/issue tracking system for CPAN.\n\n\n\n* CPANTS\n\nThe CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.\n\n\n\n* CPAN Testers\n\nThe CPAN Testers is a network of smoke testers who run automated tests on uploaded CPAN\ndistributions.\n\n\n\n* CPAN Testers Matrix\n\nThe CPAN Testers Matrix is a website that provides a visual overview of the test results for\na distribution on various Perls/platforms.\n\n\n\n* CPAN Testers Dependencies\n\nThe CPAN Testers Dependencies is a website that shows a chart of the test results of all\ndependencies for a distribution.\n\n\n\nBugs / Feature Requests\nPlease report any bugs or feature requests by email to \"bug-file-remove at rt.cpan.org\", or\nthrough the web interface at . You\nwill be automatically notified of any progress on the request by the system.\n" }, { "name": "Source Code", "content": "The code is open to the world, and available for you to hack on. Please feel free to browse it\nand play with it, or whatever. If you want to contribute patches, please send me a diff or prod\nme to pull from your repository :)\n\n\n\ngit clone git://github.com/shlomif/File-Remove.git\n" } ] }, "AUTHOR": { "content": "Shlomi Fish \n", "subsections": [] }, "COPYRIGHT": { "content": "Taken over by Shlomi Fish () while disclaiming all rights and\nplacing his modifications under CC0/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 files\" bug, and do some\npackage cleaning.\n\nSome parts copyright 2004 - 2005 Richard Soderberg.\n\nTaken over by Richard Soderberg to port it to File::Spec and add tests.\n\nOriginal copyright: 1998 by Gabor Egressy, .\n\nThis program is free software; you can redistribute and/or modify it under the same terms as\nPerl 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 to an existing test-file\nthat 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 the same terms as the Perl\n5 programming language system itself.\n", "subsections": [] } } } }