TITLE

Provides enhancements to the built-in routine 'copy'.


SUBTITLE

data

=begin data
{"type":"page","file":"work_mods/zef/File::Copy/File-Copy-0.1.0/README.md","sources":[],"node":{"type":"block","id":"iwISHZIjgvvFHz5XX_pdg","margin":"","name":"root","content":[{"type":"para","id":"NXMCqr0IBQlySEgsvTvfy","margin":"","location":{"start":{"line":1,"column":1,"offset":0},"end":{"line":1,"column":434,"offset":433}},"text":"text","content":[{"meta":"https://github.com/tbrowder/File-Copy/actions","type":"fcode","name":"L","content":[{"type":"block","id":"rWkWslkRlM-TQPmKU9EIw","margin":"","name":"Image","config":[],"location":{"start":{"line":1,"column":2,"offset":1},"end":{"line":1,"column":96,"offset":95}},"content":[{"type":"image","src":"https://github.com/tbrowder/File-Copy/actions/workflows/linux.yml/badge.svg","alt":"Actions Status"}]}]}," ",{"meta":"https://github.com/tbrowder/File-Copy/actions","type":"fcode","name":"L","content":[{"type":"block","id":"VdvLND_668noRvFfaZhLP","margin":"","name":"Image","config":[],"location":{"start":{"line":1,"column":146,"offset":145},"end":{"line":1,"column":240,"offset":239}},"content":[{"type":"image","src":"https://github.com/tbrowder/File-Copy/actions/workflows/macos.yml/badge.svg","alt":"Actions Status"}]}]}," ",{"meta":"https://github.com/tbrowder/File-Copy/actions","type":"fcode","name":"L","content":[{"type":"block","id":"o0tyhJHDK4E0vO4sre5ur","margin":"","name":"Image","config":[],"location":{"start":{"line":1,"column":290,"offset":289},"end":{"line":1,"column":386,"offset":385}},"content":[{"type":"image","src":"https://github.com/tbrowder/File-Copy/actions/workflows/windows.yml/badge.svg","alt":"Actions Status"}]}]}]},{"type":"block","id":"L6QE7z0P5twlvaT8tvave","margin":"","level":1,"name":"head","location":{"start":{"line":3,"column":1,"offset":435},"end":{"line":3,"column":8,"offset":442}},"content":["TITLE"]},{"type":"para","id":"XfDNVT2ZJywnuAgFJxaMv","margin":"","location":{"start":{"line":5,"column":1,"offset":444},"end":{"line":5,"column":76,"offset":519}},"text":"text","content":[{"type":"fcode","name":"B","content":["File::Copy"]}," - Provides the essential functions of the POSIX ",{"type":"fcode","name":"C","content":["cp"]}," command"]},{"type":"block","id":"BSsQa_3AgZHroeeMW1UII","margin":"","level":1,"name":"head","location":{"start":{"line":7,"column":1,"offset":521},"end":{"line":7,"column":11,"offset":531}},"content":["SYNOPSIS"]},{"type":"block","id":"v2upep2Jxmrbn_CABYjvS","margin":"","name":"code","config":[],"location":{"start":{"line":9,"column":1,"offset":533},"end":{"line":10,"column":80,"offset":655}},"content":[{"type":"verbatim","value":"use File::Copy; # exports routine 'cp'\ncp \"/usr/share/fonts/\", \"/home/fonts\"; # the trailing slash is not required"}]},{"type":"block","id":"J7TxU5lpZKc98L58xPiea","margin":"","level":1,"name":"head","location":{"start":{"line":12,"column":1,"offset":657},"end":{"line":12,"column":14,"offset":670}},"content":["DESCRIPTION"]},{"type":"para","id":"heaNUmju_TuPNS0tVsAcN","margin":"","location":{"start":{"line":14,"column":1,"offset":672},"end":{"line":14,"column":161,"offset":832}},"text":"text","content":["Exported function ",{"type":"fcode","name":"C","content":["cp"]}," copies files and directories from one location to another. Its behavior is intended to be very similar to the POSIX ",{"type":"fcode","name":"C","content":["cp"]}," utility program."]},{"type":"para","id":"IBpL_XdGL27Tt6hVVV0KD","margin":"","location":{"start":{"line":16,"column":1,"offset":834},"end":{"line":16,"column":264,"offset":1097}},"text":"text","content":["If the ",{"type":"fcode","name":"C","content":["$from"]}," location is a directory, it and all its top-level files will copied to the ",{"type":"fcode","name":"C","content":["$to"]}," location. A fatal error will be thrown if ",{"type":"fcode","name":"C","content":["$from"]}," is a directory and ",{"type":"fcode","name":"C","content":["$to"]}," is a file. If the recursive option (",{"type":"fcode","name":"C","content":[":r"]},") is used, all below the ",{"type":"fcode","name":"C","content":["from"]}," path will be copied."]},{"type":"para","id":"LEf2VeV8TmKf6Bt_r7KHH","margin":"","location":{"start":{"line":18,"column":1,"offset":1099},"end":{"line":18,"column":113,"offset":1211}},"text":"text","content":["Errors will also be thrown if the permissions in either location are not appropriate for the selected operation."]},{"type":"para","id":"xC4EDvi17afsx0L4-O33W","margin":"","location":{"start":{"line":20,"column":1,"offset":1213},"end":{"line":20,"column":84,"offset":1296}},"text":"text","content":["Existing files ",{"type":"fcode","name":"B","content":["will"]}," be overwritten unless the ",{"type":"fcode","name":"C","content":[":createonly"]}," option is selected."]},{"type":"para","id":"9PLzS7aDdIGBTvf59tVWu","margin":"","location":{"start":{"line":22,"column":1,"offset":1298},"end":{"line":22,"column":23,"offset":1320}},"text":"text","content":["Current named options:"]},{"type":"list","id":"tWrkEq8R9BlX-6zTL6JIE","margin":"","level":1,"list":"itemized","content":[{"type":"block","id":"n50EyedQujg0F0kgfWe-4","margin":"","name":"item","level":1,"location":{"start":{"line":24,"column":1,"offset":1322},"end":{"line":24,"column":76,"offset":1397}},"content":[{"type":"para","id":"Zcd6bvtlobpAcREkl8ZiM","margin":"","location":{"start":{"line":24,"column":3,"offset":1324},"end":{"line":24,"column":76,"offset":1397}},"text":"text","content":[{"type":"fcode","name":"C","content":[":i"]}," (or ",{"type":"fcode","name":"C","content":[":interactive"]},") - Asks permission to overwrite an existing file."]}]},{"type":"block","id":"SndrOf8-7YKVmqAlQA-dD","margin":"","name":"item","level":1,"location":{"start":{"line":26,"column":1,"offset":1399},"end":{"line":26,"column":87,"offset":1485}},"content":[{"type":"para","id":"_Cpnx-qiE7qvpSEwmpoxE","margin":"","location":{"start":{"line":26,"column":3,"offset":1401},"end":{"line":26,"column":87,"offset":1485}},"text":"text","content":[{"type":"fcode","name":"C","content":[":r"]}," (or ",{"type":"fcode","name":"C","content":[":recursive"]},") - When the source (",{"type":"fcode","name":"C","content":["$from"]},") is a directory, copy recursively."]}]},{"type":"block","id":"SaOwo10fkyc5c59bXZEfZ","margin":"","name":"item","level":1,"location":{"start":{"line":28,"column":1,"offset":1487},"end":{"line":28,"column":96,"offset":1582}},"content":[{"type":"para","id":"ojdM8d6SPonPVBoGfpci1","margin":"","location":{"start":{"line":28,"column":3,"offset":1489},"end":{"line":28,"column":96,"offset":1582}},"text":"text","content":[{"type":"fcode","name":"C","content":[":c"]}," (or ",{"type":"fcode","name":"C","content":[":createonly"]},") - Existing files will ",{"type":"block","id":"5tf3SGwcV4iY0ek8UKv2k","margin":"","name":"Html","location":{"start":{"line":28,"column":49,"offset":1535},"end":{"line":28,"column":54,"offset":1540}},"content":[{"type":"verbatim","value":"<not>"}]}," be overwritten, but notice will be given."]}]},{"type":"block","id":"ItYiNnrn7sFixGtHfqOr4","margin":"","name":"item","level":1,"location":{"start":{"line":30,"column":1,"offset":1584},"end":{"line":30,"column":65,"offset":1648}},"content":[{"type":"para","id":"Mfkum3JoDkyIq7FTARt5e","margin":"","location":{"start":{"line":30,"column":3,"offset":1586},"end":{"line":30,"column":65,"offset":1648}},"text":"text","content":[{"type":"fcode","name":"C","content":[":v"]}," (or ",{"type":"fcode","name":"C","content":[":verbose"]},") - Informs the user about copying details."]}]}]},{"type":"para","id":"njiKMoKVu3F7VKcKX0KAx","margin":"","location":{"start":{"line":32,"column":1,"offset":1650},"end":{"line":32,"column":104,"offset":1753}},"text":"text","content":["See an example Raku program using this module in the module package repository at ",{"meta":"examples","type":"fcode","name":"L","content":["examples"]},"."]},{"type":"block","id":"b2ywOlmE8QWVyyDc8NaDN","margin":"","level":1,"name":"head","location":{"start":{"line":34,"column":1,"offset":1755},"end":{"line":34,"column":9,"offset":1763}},"content":["AUTHOR"]},{"type":"para","id":"vc4DHYS-915I5rar1mB-9","margin":"","location":{"start":{"line":36,"column":1,"offset":1765},"end":{"line":36,"column":31,"offset":1795}},"text":"text","content":["Tom Browder ",{"meta":"mailto:tbrowder@acm.org","type":"fcode","name":"L","content":["tbrowder@acm.org"]}]},{"type":"block","id":"e1a2qRM3FksvxwV850u0k","margin":"","level":1,"name":"head","location":{"start":{"line":38,"column":1,"offset":1797},"end":{"line":38,"column":24,"offset":1820}},"content":["COPYRIGHT AND LICENSE"]},{"type":"para","id":"7vH4tmgFEb1Kz0VLYv7Rc","margin":"","location":{"start":{"line":40,"column":1,"offset":1822},"end":{"line":40,"column":19,"offset":1840}},"text":"text","content":["© 2023 Tom Browder"]},{"type":"para","id":"UdqHt5PwEKFWkr1XXrUj-","margin":"","location":{"start":{"line":42,"column":1,"offset":1842},"end":{"line":42,"column":100,"offset":1941}},"text":"text","content":["This library is free software; you may redistribute it or modify it under the Artistic License 2.0."]}]},"publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/README.md","pluginsData":{"moduleInfo":{"meta":{"api":"","auth":"zef:tbrowder","author":"zef:tbrowder","authors":["Tom Browder <tom.browder@gmail.com>"],"build-depends":[],"depends":["Proc::Easier","File::Find:ver<0.2.0>"],"description":"Provides enhancements to the built-in routine 'copy'.","dist":"File::Copy:ver<0.1.0>:auth<zef:tbrowder>","license":"Artistic-2.0","name":"File::Copy","path":"F/IL/FILE_COPY/4c066da64ffe7c2aebdb8c6e33584189f1a58b38.tar.gz","perl":"6.*","provides":{"File::Copy":"lib/File/Copy.rakumod","File::Copy::Utils":"lib/File/Copy/Utils.rakumod"},"resources":[],"source-type":"git","source-url":"git://github.com/tbrowder/File-Copy.git","support":{"bugtracker":"https://github.com/tbrowder/File-Copy/issues"},"tags":["file","copy"],"test-depends":[],"version":"0.1.0"},"files":[{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/README.md","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/README.md"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/LICENSE.md","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/LICENSE.md"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/docs/README.rakudoc","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/docs/README.rakudoc"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/lib/File/Copy.rakumod","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/lib/File/Copy.rakumod"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/404.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/404.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/HomePage.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/HomePage.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Language/operators.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Language/operators.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Language/terms.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Language/terms.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Native/int.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Native/int.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Native/multi-class.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Native/multi-class.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Programs/01-debugging.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Programs/01-debugging.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Programs/02-reading-docs.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Programs/02-reading-docs.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/Any.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/Any.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/Array.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/Array.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/Associative.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/Associative.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/Cancellation.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/Cancellation.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/Cool.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/Cool.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/Hash.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/Hash.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/independent-routines.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/independent-routines.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/Map.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/Map.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/X/IO.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/X/IO.pod6"}],"src":"zef","url":"/mods/zef/File::Copy"}}}
=end data


React

    =begin React :component<RenderItem>
    =begin data
    {"type":"page","file":"work_mods/zef/File::Copy/File-Copy-0.1.0/README.md","sources":[],"node":{"type":"block","id":"iwISHZIjgvvFHz5XX_pdg","margin":"","name":"root","content":[{"type":"para","id":"NXMCqr0IBQlySEgsvTvfy","margin":"","location":{"start":{"line":1,"column":1,"offset":0},"end":{"line":1,"column":434,"offset":433}},"text":"text","content":[{"meta":"https://github.com/tbrowder/File-Copy/actions","type":"fcode","name":"L","content":[{"type":"block","id":"rWkWslkRlM-TQPmKU9EIw","margin":"","name":"Image","config":[],"location":{"start":{"line":1,"column":2,"offset":1},"end":{"line":1,"column":96,"offset":95}},"content":[{"type":"image","src":"https://github.com/tbrowder/File-Copy/actions/workflows/linux.yml/badge.svg","alt":"Actions Status"}]}]}," ",{"meta":"https://github.com/tbrowder/File-Copy/actions","type":"fcode","name":"L","content":[{"type":"block","id":"VdvLND_668noRvFfaZhLP","margin":"","name":"Image","config":[],"location":{"start":{"line":1,"column":146,"offset":145},"end":{"line":1,"column":240,"offset":239}},"content":[{"type":"image","src":"https://github.com/tbrowder/File-Copy/actions/workflows/macos.yml/badge.svg","alt":"Actions Status"}]}]}," ",{"meta":"https://github.com/tbrowder/File-Copy/actions","type":"fcode","name":"L","content":[{"type":"block","id":"o0tyhJHDK4E0vO4sre5ur","margin":"","name":"Image","config":[],"location":{"start":{"line":1,"column":290,"offset":289},"end":{"line":1,"column":386,"offset":385}},"content":[{"type":"image","src":"https://github.com/tbrowder/File-Copy/actions/workflows/windows.yml/badge.svg","alt":"Actions Status"}]}]}]},{"type":"block","id":"L6QE7z0P5twlvaT8tvave","margin":"","level":1,"name":"head","location":{"start":{"line":3,"column":1,"offset":435},"end":{"line":3,"column":8,"offset":442}},"content":["TITLE"]},{"type":"para","id":"XfDNVT2ZJywnuAgFJxaMv","margin":"","location":{"start":{"line":5,"column":1,"offset":444},"end":{"line":5,"column":76,"offset":519}},"text":"text","content":[{"type":"fcode","name":"B","content":["File::Copy"]}," - Provides the essential functions of the POSIX ",{"type":"fcode","name":"C","content":["cp"]}," command"]},{"type":"block","id":"BSsQa_3AgZHroeeMW1UII","margin":"","level":1,"name":"head","location":{"start":{"line":7,"column":1,"offset":521},"end":{"line":7,"column":11,"offset":531}},"content":["SYNOPSIS"]},{"type":"block","id":"v2upep2Jxmrbn_CABYjvS","margin":"","name":"code","config":[],"location":{"start":{"line":9,"column":1,"offset":533},"end":{"line":10,"column":80,"offset":655}},"content":[{"type":"verbatim","value":"use File::Copy; # exports routine 'cp'\ncp \"/usr/share/fonts/\", \"/home/fonts\"; # the trailing slash is not required"}]},{"type":"block","id":"J7TxU5lpZKc98L58xPiea","margin":"","level":1,"name":"head","location":{"start":{"line":12,"column":1,"offset":657},"end":{"line":12,"column":14,"offset":670}},"content":["DESCRIPTION"]},{"type":"para","id":"heaNUmju_TuPNS0tVsAcN","margin":"","location":{"start":{"line":14,"column":1,"offset":672},"end":{"line":14,"column":161,"offset":832}},"text":"text","content":["Exported function ",{"type":"fcode","name":"C","content":["cp"]}," copies files and directories from one location to another. Its behavior is intended to be very similar to the POSIX ",{"type":"fcode","name":"C","content":["cp"]}," utility program."]},{"type":"para","id":"IBpL_XdGL27Tt6hVVV0KD","margin":"","location":{"start":{"line":16,"column":1,"offset":834},"end":{"line":16,"column":264,"offset":1097}},"text":"text","content":["If the ",{"type":"fcode","name":"C","content":["$from"]}," location is a directory, it and all its top-level files will copied to the ",{"type":"fcode","name":"C","content":["$to"]}," location. A fatal error will be thrown if ",{"type":"fcode","name":"C","content":["$from"]}," is a directory and ",{"type":"fcode","name":"C","content":["$to"]}," is a file. If the recursive option (",{"type":"fcode","name":"C","content":[":r"]},") is used, all below the ",{"type":"fcode","name":"C","content":["from"]}," path will be copied."]},{"type":"para","id":"LEf2VeV8TmKf6Bt_r7KHH","margin":"","location":{"start":{"line":18,"column":1,"offset":1099},"end":{"line":18,"column":113,"offset":1211}},"text":"text","content":["Errors will also be thrown if the permissions in either location are not appropriate for the selected operation."]},{"type":"para","id":"xC4EDvi17afsx0L4-O33W","margin":"","location":{"start":{"line":20,"column":1,"offset":1213},"end":{"line":20,"column":84,"offset":1296}},"text":"text","content":["Existing files ",{"type":"fcode","name":"B","content":["will"]}," be overwritten unless the ",{"type":"fcode","name":"C","content":[":createonly"]}," option is selected."]},{"type":"para","id":"9PLzS7aDdIGBTvf59tVWu","margin":"","location":{"start":{"line":22,"column":1,"offset":1298},"end":{"line":22,"column":23,"offset":1320}},"text":"text","content":["Current named options:"]},{"type":"list","id":"tWrkEq8R9BlX-6zTL6JIE","margin":"","level":1,"list":"itemized","content":[{"type":"block","id":"n50EyedQujg0F0kgfWe-4","margin":"","name":"item","level":1,"location":{"start":{"line":24,"column":1,"offset":1322},"end":{"line":24,"column":76,"offset":1397}},"content":[{"type":"para","id":"Zcd6bvtlobpAcREkl8ZiM","margin":"","location":{"start":{"line":24,"column":3,"offset":1324},"end":{"line":24,"column":76,"offset":1397}},"text":"text","content":[{"type":"fcode","name":"C","content":[":i"]}," (or ",{"type":"fcode","name":"C","content":[":interactive"]},") - Asks permission to overwrite an existing file."]}]},{"type":"block","id":"SndrOf8-7YKVmqAlQA-dD","margin":"","name":"item","level":1,"location":{"start":{"line":26,"column":1,"offset":1399},"end":{"line":26,"column":87,"offset":1485}},"content":[{"type":"para","id":"_Cpnx-qiE7qvpSEwmpoxE","margin":"","location":{"start":{"line":26,"column":3,"offset":1401},"end":{"line":26,"column":87,"offset":1485}},"text":"text","content":[{"type":"fcode","name":"C","content":[":r"]}," (or ",{"type":"fcode","name":"C","content":[":recursive"]},") - When the source (",{"type":"fcode","name":"C","content":["$from"]},") is a directory, copy recursively."]}]},{"type":"block","id":"SaOwo10fkyc5c59bXZEfZ","margin":"","name":"item","level":1,"location":{"start":{"line":28,"column":1,"offset":1487},"end":{"line":28,"column":96,"offset":1582}},"content":[{"type":"para","id":"ojdM8d6SPonPVBoGfpci1","margin":"","location":{"start":{"line":28,"column":3,"offset":1489},"end":{"line":28,"column":96,"offset":1582}},"text":"text","content":[{"type":"fcode","name":"C","content":[":c"]}," (or ",{"type":"fcode","name":"C","content":[":createonly"]},") - Existing files will ",{"type":"block","id":"5tf3SGwcV4iY0ek8UKv2k","margin":"","name":"Html","location":{"start":{"line":28,"column":49,"offset":1535},"end":{"line":28,"column":54,"offset":1540}},"content":[{"type":"verbatim","value":"<not>"}]}," be overwritten, but notice will be given."]}]},{"type":"block","id":"ItYiNnrn7sFixGtHfqOr4","margin":"","name":"item","level":1,"location":{"start":{"line":30,"column":1,"offset":1584},"end":{"line":30,"column":65,"offset":1648}},"content":[{"type":"para","id":"Mfkum3JoDkyIq7FTARt5e","margin":"","location":{"start":{"line":30,"column":3,"offset":1586},"end":{"line":30,"column":65,"offset":1648}},"text":"text","content":[{"type":"fcode","name":"C","content":[":v"]}," (or ",{"type":"fcode","name":"C","content":[":verbose"]},") - Informs the user about copying details."]}]}]},{"type":"para","id":"njiKMoKVu3F7VKcKX0KAx","margin":"","location":{"start":{"line":32,"column":1,"offset":1650},"end":{"line":32,"column":104,"offset":1753}},"text":"text","content":["See an example Raku program using this module in the module package repository at ",{"meta":"examples","type":"fcode","name":"L","content":["examples"]},"."]},{"type":"block","id":"b2ywOlmE8QWVyyDc8NaDN","margin":"","level":1,"name":"head","location":{"start":{"line":34,"column":1,"offset":1755},"end":{"line":34,"column":9,"offset":1763}},"content":["AUTHOR"]},{"type":"para","id":"vc4DHYS-915I5rar1mB-9","margin":"","location":{"start":{"line":36,"column":1,"offset":1765},"end":{"line":36,"column":31,"offset":1795}},"text":"text","content":["Tom Browder ",{"meta":"mailto:tbrowder@acm.org","type":"fcode","name":"L","content":["tbrowder@acm.org"]}]},{"type":"block","id":"e1a2qRM3FksvxwV850u0k","margin":"","level":1,"name":"head","location":{"start":{"line":38,"column":1,"offset":1797},"end":{"line":38,"column":24,"offset":1820}},"content":["COPYRIGHT AND LICENSE"]},{"type":"para","id":"7vH4tmgFEb1Kz0VLYv7Rc","margin":"","location":{"start":{"line":40,"column":1,"offset":1822},"end":{"line":40,"column":19,"offset":1840}},"text":"text","content":["© 2023 Tom Browder"]},{"type":"para","id":"UdqHt5PwEKFWkr1XXrUj-","margin":"","location":{"start":{"line":42,"column":1,"offset":1842},"end":{"line":42,"column":100,"offset":1941}},"text":"text","content":["This library is free software; you may redistribute it or modify it under the Artistic License 2.0."]}]},"publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/README.md","pluginsData":{"moduleInfo":{"meta":{"api":"","auth":"zef:tbrowder","author":"zef:tbrowder","authors":["Tom Browder <tom.browder@gmail.com>"],"build-depends":[],"depends":["Proc::Easier","File::Find:ver<0.2.0>"],"description":"Provides enhancements to the built-in routine 'copy'.","dist":"File::Copy:ver<0.1.0>:auth<zef:tbrowder>","license":"Artistic-2.0","name":"File::Copy","path":"F/IL/FILE_COPY/4c066da64ffe7c2aebdb8c6e33584189f1a58b38.tar.gz","perl":"6.*","provides":{"File::Copy":"lib/File/Copy.rakumod","File::Copy::Utils":"lib/File/Copy/Utils.rakumod"},"resources":[],"source-type":"git","source-url":"git://github.com/tbrowder/File-Copy.git","support":{"bugtracker":"https://github.com/tbrowder/File-Copy/issues"},"tags":["file","copy"],"test-depends":[],"version":"0.1.0"},"files":[{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/README.md","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/README.md"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/LICENSE.md","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/LICENSE.md"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/docs/README.rakudoc","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/docs/README.rakudoc"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/lib/File/Copy.rakumod","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/lib/File/Copy.rakumod"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/404.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/404.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/HomePage.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/HomePage.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Language/operators.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Language/operators.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Language/terms.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Language/terms.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Native/int.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Native/int.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Native/multi-class.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Native/multi-class.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Programs/01-debugging.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Programs/01-debugging.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Programs/02-reading-docs.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Programs/02-reading-docs.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/Any.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/Any.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/Array.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/Array.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/Associative.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/Associative.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/Cancellation.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/Cancellation.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/Cool.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/Cool.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/Hash.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/Hash.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/independent-routines.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/independent-routines.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/Map.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/Map.pod6"},{"file":"work_mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/X/IO.pod6","publishUrl":"/mods/zef/File::Copy/File-Copy-0.1.0/t/test-doc/Type/X/IO.pod6"}],"src":"zef","url":"/mods/zef/File::Copy"}}}
    =end data
    =end React


root

para

L<Examples| file:../examples/index.podlite>


L<Download |file:../download/index.podlite>


=begin React :component<HeaderCol> :id<menu> 
=para L<Documentation|/doc/introduction>
=para L<Modules| /mods>
=para L<Examples| file:../examples/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


HEADER

FOOTER

File::Copy


remove files recursively, up or down the directory tree


File::Directory::Bubble


=begin data
{"type":"page","file":"work_mods/zef/File-TreeBuilder/README.md","sources":[],"node":{"type":"block","id":"ttojbZTm_3UewrviNXP_p","margin":"","name":"root","content":[{"type":"para","id":"7cdnFDF1tpPMDWcqRPnGC","margin":"","location":{"start":{"line":1,"column":1,"offset":0},"end":{"line":1,"column":157,"offset":156}},"text":"text","content":[{"meta":"https://github.com/lucs/File-TreeBuilder.git/actions","type":"fcode","name":"L","content":[{"type":"block","id":"C9cyceOoZsiio7ENCP-sR","margin":"","name":"Image","config":[],"location":{"start":{"line":1,"column":2,"offset":1},"end":{"line":1,"column":102,"offset":101}},"content":[{"type":"image","src":"https://github.com/lucs/File-TreeBuilder.git/actions/workflows/test.yml/badge.svg","alt":"Actions Status"}]}]}]},{"type":"block","id":"TUza4pEp6jzuupWJ08yVR","margin":"","level":1,"name":"head","location":{"start":{"line":3,"column":1,"offset":158},"end":{"line":3,"column":7,"offset":164}},"content":["NAME"]},{"type":"block","id":"Thi4SFRGt4dFxp-ZP02gB","margin":"","name":"code","config":[],"location":{"start":{"line":5,"column":1,"offset":166},"end":{"line":5,"column":59,"offset":224}},"content":[{"type":"verbatim","value":"File::TreeBuilder - Build text-scripted trees of files"}]},{"type":"block","id":"_VXgMB6XITCXT1PsNoJRk","margin":"","level":2,"name":"head","location":{"start":{"line":7,"column":1,"offset":226},"end":{"line":7,"column":12,"offset":237}},"content":["SYNOPSIS"]},{"type":"block","id":"cdLwPx7QcTs8w391yCj-x","margin":"","name":"code","config":[],"location":{"start":{"line":9,"column":1,"offset":239},"end":{"line":56,"column":11,"offset":1836}},"content":[{"type":"verbatim","value":"    use File::TreeBuilder;\n\n    my $tree-desc = Q:to/EoDesc/;\n            # Note that this heredoc string is literal ('Q'), so no\n            # interpolation occurs at all. The program will replace\n            # the literal '\\n', '\\t', '\\s' (representing a space), and\n            # '\\\\' by the correct characters.\n\n            # Also, empty lines and lines starting with '#'\n            # will be discarded and ignored.\n\n            # It is invalid for any real tab characters to appear in\n            # this string, so indentation must be accomplished with\n            # spaces only. And the indentation must be coherent (bad\n            # examples are shown later).\n\n            # What follows is an example of an actual tree of files\n            # and directories that one might want to build. It has\n            # examples of pretty much all the features the program\n            # supports, described in detail later.\n\n        / D1\n            . F1\n\n        . F2 . File\\n\\twith tab, newlines and 2 trailing space.\\n\\s\\s\n\n        /_ D_2\n            .x  Fx3\n            /600 D3\n                . F4 % f4-key\n\n            .755é Fé5\n\n        . F6 . \\sLine continued, \\\n            and backslash and 't': \\\\t.\n    EoDesc\n\n    my %file-contents = (\n        f4-key => \"File contents from hash.\".uc,\n    );\n\n    my $parent-dir = '/home/lucs/File-TreeBuilder.demo'.IO;\n\n    build-tree(\n        $parent-dir,\n        $tree-desc,\n        %file-contents,\n    );"}]},{"type":"para","id":"nlocQ22XkkcBMQK1D3YYt","margin":"","location":{"start":{"line":58,"column":1,"offset":1838},"end":{"line":58,"column":120,"offset":1957}},"text":"text","content":["The example code would create the following directories and files under the parent directory, which must already exist:"]},{"type":"block","id":"VMDOW6gIyWufaMcqA8-ln","margin":"","name":"code","config":[],"location":{"start":{"line":60,"column":1,"offset":1959},"end":{"line":90,"column":82,"offset":2728}},"content":[{"type":"verbatim","value":"    D1/\n        F1\n    F2\n    D 2/\n        F 3\n        D3/\n            F4\n        F 5\n    F6\n\nNote that:\n\n    The 'D1' directory will have default permissions.\n\n    The 'F1' file will be empty and have default permissions.\n\n    The 'F2' file will contain :\n    \"File\\n\\twith tab, newlines and 2 trailing spaces.\\n  \".\n\n    The 'D 2' directory has a space in its name.\n\n    The 'F 3' file has a space in its name.\n\n    The 'D3' directory will have permissions 0o600.\n\n    The 'F4' file will contain \"FILE CONTENTS FROM HASH.\".\n\n    The 'F 5' file has a space in its name and will have permissions\n    0o755.\n\n    The 'F6' file will contain \" Line continued, and backslash and 't': \\\\t.\""}]},{"type":"block","id":"UPueMDBZIp8eTUeVBY60C","margin":"","level":2,"name":"head","location":{"start":{"line":92,"column":1,"offset":2730},"end":{"line":92,"column":15,"offset":2744}},"content":["DESCRIPTION"]},{"type":"para","id":"w_o1iq_xQ7p-3dF2GmQIi","margin":"","location":{"start":{"line":94,"column":1,"offset":2746},"end":{"line":94,"column":230,"offset":2975}},"text":"text","content":["This module exports the ",{"type":"fcode","name":"C","content":["build-tree"]}," function, used for building and populating simple trees of files and directories. I have found this useful to build test data for programs that need such things. Invoke the function like this:"]},{"type":"block","id":"b9fDfZRac_Ss20iUn8AbG","margin":"","name":"code","config":[],"location":{"start":{"line":96,"column":1,"offset":2977},"end":{"line":100,"column":10,"offset":3097}},"content":[{"type":"verbatim","value":"    build-tree(\n        IO::Path $parent-dir,\n        Str $tree-desc,\n        %file-contents?,\n    )"}]},{"type":"para","id":"_g-IVfg1reKT98XhQxWNH","margin":"","location":{"start":{"line":102,"column":1,"offset":3099},"end":{"line":102,"column":142,"offset":3240}},"text":"text","content":[{"type":"fcode","name":"C","content":["$parent-dir"]}," is the directory under which the needed files and directories will be created. It must already exist and have write permission."]},{"type":"para","id":"-K4vgkDBuNEo4Xj7rFNru","margin":"","location":{"start":{"line":104,"column":1,"offset":3242},"end":{"line":104,"column":110,"offset":3351}},"text":"text","content":[{"type":"fcode","name":"C","content":["$tree-desc"]}," is a multiline string describing a hierarchy of needed directories and files and their contents."]},{"type":"para","id":"_18TqdZ4grh8NIyFb8Mq4","margin":"","location":{"start":{"line":106,"column":1,"offset":3353},"end":{"line":106,"column":115,"offset":3467}},"text":"text","content":["The optional ",{"type":"fcode","name":"C","content":["%file-contents"]}," argument can be used to specify arbitrary file contents, as will be explained below."]},{"type":"block","id":"ztKoz0RIHzUDs0gPgpB7y","margin":"","level":3,"name":"head","location":{"start":{"line":108,"column":1,"offset":3469},"end":{"line":108,"column":25,"offset":3493}},"content":["The tree description"]},{"type":"para","id":"rZO0qZmfXE1XBgtL_jiuv","margin":"","location":{"start":{"line":110,"column":1,"offset":3495},"end":{"line":110,"column":202,"offset":3696}},"text":"text","content":["Within the ",{"type":"fcode","name":"C","content":["$tree-desc"]}," string, blank or empty lines are discarded and ignored. The string must also not contain any tab characters. The first non-blank character of each remaining line must be one of:"]},{"type":"block","id":"wYicmgJqCs-sKZjQdombO","margin":"","name":"code","config":[],"location":{"start":{"line":112,"column":1,"offset":3698},"end":{"line":114,"column":46,"offset":3851}},"content":[{"type":"verbatim","value":"    # : Comment line, will be discarded and ignored.\n    / : The line describes a wanted directory.\n    . : The line describes a wanted file."}]},{"type":"para","id":"3nnduOQ3vheU__UmbxwGr","margin":"","location":{"start":{"line":116,"column":1,"offset":3853},"end":{"line":116,"column":38,"offset":3890}},"text":"text","content":["Any other first non-blank is invalid."]},{"type":"block","id":"aABInABtBCOcmnMbWujYo","margin":"","level":4,"name":"head","location":{"start":{"line":118,"column":1,"offset":3892},"end":{"line":118,"column":28,"offset":3919}},"content":["Directory descriptions"]},{"type":"para","id":"kvQNPsjzWNxhVR0aj_GMX","margin":"","location":{"start":{"line":120,"column":1,"offset":3921},"end":{"line":120,"column":365,"offset":4285}},"text":"text","content":["Directory descriptions must mention a directory name. The leading ‹/› can optionally be immmediately followed by a three-digit octal representation of the desired permissions of the directory and/or by a space-representing character to be used if the directory name is to contain spaces, and must then be followed by whitespace and the directory name. For example:"]},{"type":"block","id":"PswBkD0UFKeHpLnZFJnzh","margin":"","name":"code","config":[],"location":{"start":{"line":122,"column":1,"offset":4287},"end":{"line":129,"column":57,"offset":4682}},"content":[{"type":"verbatim","value":"    / d       : Directory 'd'.\n    /X dXc    : Directory 'd c'; spaces in its name are represented by 'X'.\n    /600 e    : Directory 'e', permissions 600 (octal always).\n    /755_ a_b : Directory 'a b', permissions 755.\n\n    /         : Error: Missing directory name.\n    /644      : Error: Missing directory name.\n    / abc de  : Error: unexpected data (here, 'de')."}]},{"type":"block","id":"I7lRVpv3zcqmBARny5GEg","margin":"","level":4,"name":"head","location":{"start":{"line":131,"column":1,"offset":4684},"end":{"line":131,"column":23,"offset":4706}},"content":["File descriptions"]},{"type":"para","id":"gxRbSs_SKsdSgf9hsNUXD","margin":"","location":{"start":{"line":133,"column":1,"offset":4708},"end":{"line":133,"column":440,"offset":5147}},"text":"text","content":["File descriptions must mention a file name. The leading ‹.› can optionally be immmediately followed by a three-digit octal representation of the desired permissions of the file and/or by a space-representing character to be used if the file name is to contain spaces, and must then be followed by whitespace and the file name, and then optionally be followed by whitespace and by a specification of their wanted contents, as one of either:"]},{"type":"block","id":"B4YVKhyMP3JYO8eeCEKlm","margin":"","name":"code","config":[],"location":{"start":{"line":135,"column":1,"offset":5149},"end":{"line":136,"column":77,"offset":5254}},"content":[{"type":"verbatim","value":"    . ‹literal contents›\n    % ‹key of contents to be retrieved from the %file-contents argument›"}]},{"type":"para","id":"8FqWDxbpe_0G4by7VTtlz","margin":"","location":{"start":{"line":138,"column":1,"offset":5256},"end":{"line":138,"column":329,"offset":5584}},"text":"text","content":["A ‹.› means to place the trimmed rest of the line into the created file. The program will replace ",{"type":"fcode","name":"C","content":["\\t"]},", ",{"type":"fcode","name":"C","content":["\\n"]},", ",{"type":"fcode","name":"C","content":["\\s"]},", and ",{"type":"fcode","name":"C","content":["\\\\"]}," with actual tabs, newlines, spaces, and backslashes in the file inserted content. If a line ends with a single ‹\\›, the line that follows it will be concatenated to it, having its leading spaces removed."]},{"type":"para","id":"8dAbB_5hI4KeZ5hHd4D-_","margin":"","location":{"start":{"line":140,"column":1,"offset":5586},"end":{"line":140,"column":158,"offset":5743}},"text":"text","content":["A ‹%› means to take the trimmed rest of the line as a key into the instance's ",{"type":"fcode","name":"C","content":["%file-contents"]}," and to use the corresponding found value as the file contents."]},{"type":"para","id":"7WhnT3TlkiqLsKSQsmOU1","margin":"","location":{"start":{"line":142,"column":1,"offset":5745},"end":{"line":142,"column":13,"offset":5757}},"text":"text","content":["For example:"]},{"type":"block","id":"bbJU4onUmabHEUanI15Yb","margin":"","name":"code","config":[],"location":{"start":{"line":144,"column":1,"offset":5759},"end":{"line":157,"column":47,"offset":6484}},"content":[{"type":"verbatim","value":"    . f         : File \"f\", contents empty (default), default permissions.\n    ._ f_a      : File \"f a\": spaces in its name are represented by '_'.\n    .444Z fZb   : File \"f b\", permission 444.\n    . f . me ow : File \"f\", literal contents: \"me ow\".\n    . f % k9    : File \"f\", contents retrieved from %file-contents<k9>.\n    . f . This line \\\n        continues.\\n\n                : File \"f\", contents are \"This line continues.\\n\".\n\n    .           : Error: missing filename.\n    . f x       : Error: unrecognized ‹x›.\n    . f % baz   : Error if %file-contents wasn't specified\n                  or if key ‹baz› is missing from it.\n    . f %       : Error: No key specified."}]},{"type":"block","id":"Eb3t0HYyIGEQQ6JqQ7aH6","margin":"","level":4,"name":"head","location":{"start":{"line":159,"column":1,"offset":6486},"end":{"line":159,"column":15,"offset":6500}},"content":["Hierarchy"]},{"type":"para","id":"Yw9ajg-MuO7RtiWP2-eEJ","margin":"","location":{"start":{"line":161,"column":1,"offset":6502},"end":{"line":161,"column":171,"offset":6672}},"text":"text","content":["Directories are created hierarchically, according to the indentation. Files are created in the directory hierarchically above them. In the hierarchy then, these are okay:"]},{"type":"block","id":"a3-YwCGvVPGEcCqWQF6d8","margin":"","name":"code","config":[],"location":{"start":{"line":163,"column":1,"offset":6674},"end":{"line":180,"column":17,"offset":7079}},"content":[{"type":"verbatim","value":"        Directories and files intermixed on the same level.\n    / d1\n    / d2\n    . f1\n    . f2\n    / d3\n\n        A directory holding a subdirectory or a file.\n    / d1\n        / d2\n            . f1\n\n        Returning to a previously established level, here at ‹. f2›.\n    / d1\n        / d2\n            / d3\n                . f1\n        . f2"}]},{"type":"para","id":"gQKFPOJaSqvi4xj3WMs-s","margin":"","location":{"start":{"line":182,"column":1,"offset":7081},"end":{"line":182,"column":19,"offset":7099}},"text":"text","content":["But these are not:"]},{"type":"block","id":"32jLs8TBzLhfKkFr9Syoo","margin":"","name":"code","config":[],"location":{"start":{"line":184,"column":1,"offset":7101},"end":{"line":202,"column":19,"offset":7523}},"content":[{"type":"verbatim","value":"        A file cannot hold a file.\n    . f1\n        . f2\n\n        Nor can it hold a directory.\n    . f1\n        / d1\n\n        ‹/ d3›'s indentation conflicts with those of ‹/ d1› and ‹/ d2›.\n    / d1\n        / d2\n      / d3\n\n        ‹/ d5›'s indentation conflicts with those of ‹/ d2› and ‹/ d3›.\n    / d1\n        / d2\n            / d3\n    / d4\n          / d5"}]},{"type":"block","id":"0qz63s9Ejhdd8QcLk_4h7","margin":"","level":2,"name":"head","location":{"start":{"line":204,"column":1,"offset":7525},"end":{"line":204,"column":10,"offset":7534}},"content":["AUTHOR"]},{"type":"para","id":"3d5s0bOx48MOwNeCwCKIe","margin":"","location":{"start":{"line":206,"column":1,"offset":7536},"end":{"line":206,"column":30,"offset":7565}},"text":"text","content":["Luc St-Louis ",{"meta":"mailto:lucs@pobox.com","type":"fcode","name":"L","content":["lucs@pobox.com"]}]},{"type":"block","id":"vLKbPXIW36TlsWgypyHqf","margin":"","level":2,"name":"head","location":{"start":{"line":208,"column":1,"offset":7567},"end":{"line":208,"column":25,"offset":7591}},"content":["COPYRIGHT AND LICENSE"]},{"type":"para","id":"R55Fl7QUNlmEIj55HmETl","margin":"","location":{"start":{"line":210,"column":1,"offset":7593},"end":{"line":210,"column":15,"offset":7607}},"text":"text","content":["Copyright 2023"]},{"type":"para","id":"kaEiod-nZMnFPycnNHbPK","margin":"","location":{"start":{"line":212,"column":1,"offset":7609},"end":{"line":212,"column":104,"offset":7712}},"text":"text","content":["This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0."]}]},"publishUrl":"/mods/zef/File-TreeBuilder/README.md","pluginsData":{"moduleInfo":{"meta":{"api":"","auth":"zef:lucs","authors":["Luc St-Louis <lucs@pobox.com>"],"build-depends":[],"depends":[],"description":"Build text-scripted trees of files","dist":"File-TreeBuilder:ver<0.1.0>:auth<zef:lucs>","name":"File-TreeBuilder","path":"F/IL/FILETREEBUILDER/9e18382a947e84ebd7a49ee6e6da09b4a8cedbb7.tar.gz","provides":{"File::TreeBuilder":"lib/File/TreeBuilder.rakumod"},"resources":[],"source-url":"git://github.com/lucs/File-TreeBuilder.git","test-depends":["Test::Selector"],"version":"0.1.0"},"files":[{"file":"work_mods/zef/File-TreeBuilder/README.md","publishUrl":"/mods/zef/File-TreeBuilder/README.md"},{"file":"work_mods/zef/File-TreeBuilder/lib/File/TreeBuilder.rakumod","publishUrl":"/mods/zef/File-TreeBuilder/lib/File/TreeBuilder.rakumod"}],"src":"zef","url":"/mods/zef/File-TreeBuilder"}}}
=end data


    =begin React :component<RenderItem>
    =begin data
    {"type":"page","file":"work_mods/zef/File-TreeBuilder/README.md","sources":[],"node":{"type":"block","id":"ttojbZTm_3UewrviNXP_p","margin":"","name":"root","content":[{"type":"para","id":"7cdnFDF1tpPMDWcqRPnGC","margin":"","location":{"start":{"line":1,"column":1,"offset":0},"end":{"line":1,"column":157,"offset":156}},"text":"text","content":[{"meta":"https://github.com/lucs/File-TreeBuilder.git/actions","type":"fcode","name":"L","content":[{"type":"block","id":"C9cyceOoZsiio7ENCP-sR","margin":"","name":"Image","config":[],"location":{"start":{"line":1,"column":2,"offset":1},"end":{"line":1,"column":102,"offset":101}},"content":[{"type":"image","src":"https://github.com/lucs/File-TreeBuilder.git/actions/workflows/test.yml/badge.svg","alt":"Actions Status"}]}]}]},{"type":"block","id":"TUza4pEp6jzuupWJ08yVR","margin":"","level":1,"name":"head","location":{"start":{"line":3,"column":1,"offset":158},"end":{"line":3,"column":7,"offset":164}},"content":["NAME"]},{"type":"block","id":"Thi4SFRGt4dFxp-ZP02gB","margin":"","name":"code","config":[],"location":{"start":{"line":5,"column":1,"offset":166},"end":{"line":5,"column":59,"offset":224}},"content":[{"type":"verbatim","value":"File::TreeBuilder - Build text-scripted trees of files"}]},{"type":"block","id":"_VXgMB6XITCXT1PsNoJRk","margin":"","level":2,"name":"head","location":{"start":{"line":7,"column":1,"offset":226},"end":{"line":7,"column":12,"offset":237}},"content":["SYNOPSIS"]},{"type":"block","id":"cdLwPx7QcTs8w391yCj-x","margin":"","name":"code","config":[],"location":{"start":{"line":9,"column":1,"offset":239},"end":{"line":56,"column":11,"offset":1836}},"content":[{"type":"verbatim","value":"    use File::TreeBuilder;\n\n    my $tree-desc = Q:to/EoDesc/;\n            # Note that this heredoc string is literal ('Q'), so no\n            # interpolation occurs at all. The program will replace\n            # the literal '\\n', '\\t', '\\s' (representing a space), and\n            # '\\\\' by the correct characters.\n\n            # Also, empty lines and lines starting with '#'\n            # will be discarded and ignored.\n\n            # It is invalid for any real tab characters to appear in\n            # this string, so indentation must be accomplished with\n            # spaces only. And the indentation must be coherent (bad\n            # examples are shown later).\n\n            # What follows is an example of an actual tree of files\n            # and directories that one might want to build. It has\n            # examples of pretty much all the features the program\n            # supports, described in detail later.\n\n        / D1\n            . F1\n\n        . F2 . File\\n\\twith tab, newlines and 2 trailing space.\\n\\s\\s\n\n        /_ D_2\n            .x  Fx3\n            /600 D3\n                . F4 % f4-key\n\n            .755é Fé5\n\n        . F6 . \\sLine continued, \\\n            and backslash and 't': \\\\t.\n    EoDesc\n\n    my %file-contents = (\n        f4-key => \"File contents from hash.\".uc,\n    );\n\n    my $parent-dir = '/home/lucs/File-TreeBuilder.demo'.IO;\n\n    build-tree(\n        $parent-dir,\n        $tree-desc,\n        %file-contents,\n    );"}]},{"type":"para","id":"nlocQ22XkkcBMQK1D3YYt","margin":"","location":{"start":{"line":58,"column":1,"offset":1838},"end":{"line":58,"column":120,"offset":1957}},"text":"text","content":["The example code would create the following directories and files under the parent directory, which must already exist:"]},{"type":"block","id":"VMDOW6gIyWufaMcqA8-ln","margin":"","name":"code","config":[],"location":{"start":{"line":60,"column":1,"offset":1959},"end":{"line":90,"column":82,"offset":2728}},"content":[{"type":"verbatim","value":"    D1/\n        F1\n    F2\n    D 2/\n        F 3\n        D3/\n            F4\n        F 5\n    F6\n\nNote that:\n\n    The 'D1' directory will have default permissions.\n\n    The 'F1' file will be empty and have default permissions.\n\n    The 'F2' file will contain :\n    \"File\\n\\twith tab, newlines and 2 trailing spaces.\\n  \".\n\n    The 'D 2' directory has a space in its name.\n\n    The 'F 3' file has a space in its name.\n\n    The 'D3' directory will have permissions 0o600.\n\n    The 'F4' file will contain \"FILE CONTENTS FROM HASH.\".\n\n    The 'F 5' file has a space in its name and will have permissions\n    0o755.\n\n    The 'F6' file will contain \" Line continued, and backslash and 't': \\\\t.\""}]},{"type":"block","id":"UPueMDBZIp8eTUeVBY60C","margin":"","level":2,"name":"head","location":{"start":{"line":92,"column":1,"offset":2730},"end":{"line":92,"column":15,"offset":2744}},"content":["DESCRIPTION"]},{"type":"para","id":"w_o1iq_xQ7p-3dF2GmQIi","margin":"","location":{"start":{"line":94,"column":1,"offset":2746},"end":{"line":94,"column":230,"offset":2975}},"text":"text","content":["This module exports the ",{"type":"fcode","name":"C","content":["build-tree"]}," function, used for building and populating simple trees of files and directories. I have found this useful to build test data for programs that need such things. Invoke the function like this:"]},{"type":"block","id":"b9fDfZRac_Ss20iUn8AbG","margin":"","name":"code","config":[],"location":{"start":{"line":96,"column":1,"offset":2977},"end":{"line":100,"column":10,"offset":3097}},"content":[{"type":"verbatim","value":"    build-tree(\n        IO::Path $parent-dir,\n        Str $tree-desc,\n        %file-contents?,\n    )"}]},{"type":"para","id":"_g-IVfg1reKT98XhQxWNH","margin":"","location":{"start":{"line":102,"column":1,"offset":3099},"end":{"line":102,"column":142,"offset":3240}},"text":"text","content":[{"type":"fcode","name":"C","content":["$parent-dir"]}," is the directory under which the needed files and directories will be created. It must already exist and have write permission."]},{"type":"para","id":"-K4vgkDBuNEo4Xj7rFNru","margin":"","location":{"start":{"line":104,"column":1,"offset":3242},"end":{"line":104,"column":110,"offset":3351}},"text":"text","content":[{"type":"fcode","name":"C","content":["$tree-desc"]}," is a multiline string describing a hierarchy of needed directories and files and their contents."]},{"type":"para","id":"_18TqdZ4grh8NIyFb8Mq4","margin":"","location":{"start":{"line":106,"column":1,"offset":3353},"end":{"line":106,"column":115,"offset":3467}},"text":"text","content":["The optional ",{"type":"fcode","name":"C","content":["%file-contents"]}," argument can be used to specify arbitrary file contents, as will be explained below."]},{"type":"block","id":"ztKoz0RIHzUDs0gPgpB7y","margin":"","level":3,"name":"head","location":{"start":{"line":108,"column":1,"offset":3469},"end":{"line":108,"column":25,"offset":3493}},"content":["The tree description"]},{"type":"para","id":"rZO0qZmfXE1XBgtL_jiuv","margin":"","location":{"start":{"line":110,"column":1,"offset":3495},"end":{"line":110,"column":202,"offset":3696}},"text":"text","content":["Within the ",{"type":"fcode","name":"C","content":["$tree-desc"]}," string, blank or empty lines are discarded and ignored. The string must also not contain any tab characters. The first non-blank character of each remaining line must be one of:"]},{"type":"block","id":"wYicmgJqCs-sKZjQdombO","margin":"","name":"code","config":[],"location":{"start":{"line":112,"column":1,"offset":3698},"end":{"line":114,"column":46,"offset":3851}},"content":[{"type":"verbatim","value":"    # : Comment line, will be discarded and ignored.\n    / : The line describes a wanted directory.\n    . : The line describes a wanted file."}]},{"type":"para","id":"3nnduOQ3vheU__UmbxwGr","margin":"","location":{"start":{"line":116,"column":1,"offset":3853},"end":{"line":116,"column":38,"offset":3890}},"text":"text","content":["Any other first non-blank is invalid."]},{"type":"block","id":"aABInABtBCOcmnMbWujYo","margin":"","level":4,"name":"head","location":{"start":{"line":118,"column":1,"offset":3892},"end":{"line":118,"column":28,"offset":3919}},"content":["Directory descriptions"]},{"type":"para","id":"kvQNPsjzWNxhVR0aj_GMX","margin":"","location":{"start":{"line":120,"column":1,"offset":3921},"end":{"line":120,"column":365,"offset":4285}},"text":"text","content":["Directory descriptions must mention a directory name. The leading ‹/› can optionally be immmediately followed by a three-digit octal representation of the desired permissions of the directory and/or by a space-representing character to be used if the directory name is to contain spaces, and must then be followed by whitespace and the directory name. For example:"]},{"type":"block","id":"PswBkD0UFKeHpLnZFJnzh","margin":"","name":"code","config":[],"location":{"start":{"line":122,"column":1,"offset":4287},"end":{"line":129,"column":57,"offset":4682}},"content":[{"type":"verbatim","value":"    / d       : Directory 'd'.\n    /X dXc    : Directory 'd c'; spaces in its name are represented by 'X'.\n    /600 e    : Directory 'e', permissions 600 (octal always).\n    /755_ a_b : Directory 'a b', permissions 755.\n\n    /         : Error: Missing directory name.\n    /644      : Error: Missing directory name.\n    / abc de  : Error: unexpected data (here, 'de')."}]},{"type":"block","id":"I7lRVpv3zcqmBARny5GEg","margin":"","level":4,"name":"head","location":{"start":{"line":131,"column":1,"offset":4684},"end":{"line":131,"column":23,"offset":4706}},"content":["File descriptions"]},{"type":"para","id":"gxRbSs_SKsdSgf9hsNUXD","margin":"","location":{"start":{"line":133,"column":1,"offset":4708},"end":{"line":133,"column":440,"offset":5147}},"text":"text","content":["File descriptions must mention a file name. The leading ‹.› can optionally be immmediately followed by a three-digit octal representation of the desired permissions of the file and/or by a space-representing character to be used if the file name is to contain spaces, and must then be followed by whitespace and the file name, and then optionally be followed by whitespace and by a specification of their wanted contents, as one of either:"]},{"type":"block","id":"B4YVKhyMP3JYO8eeCEKlm","margin":"","name":"code","config":[],"location":{"start":{"line":135,"column":1,"offset":5149},"end":{"line":136,"column":77,"offset":5254}},"content":[{"type":"verbatim","value":"    . ‹literal contents›\n    % ‹key of contents to be retrieved from the %file-contents argument›"}]},{"type":"para","id":"8FqWDxbpe_0G4by7VTtlz","margin":"","location":{"start":{"line":138,"column":1,"offset":5256},"end":{"line":138,"column":329,"offset":5584}},"text":"text","content":["A ‹.› means to place the trimmed rest of the line into the created file. The program will replace ",{"type":"fcode","name":"C","content":["\\t"]},", ",{"type":"fcode","name":"C","content":["\\n"]},", ",{"type":"fcode","name":"C","content":["\\s"]},", and ",{"type":"fcode","name":"C","content":["\\\\"]}," with actual tabs, newlines, spaces, and backslashes in the file inserted content. If a line ends with a single ‹\\›, the line that follows it will be concatenated to it, having its leading spaces removed."]},{"type":"para","id":"8dAbB_5hI4KeZ5hHd4D-_","margin":"","location":{"start":{"line":140,"column":1,"offset":5586},"end":{"line":140,"column":158,"offset":5743}},"text":"text","content":["A ‹%› means to take the trimmed rest of the line as a key into the instance's ",{"type":"fcode","name":"C","content":["%file-contents"]}," and to use the corresponding found value as the file contents."]},{"type":"para","id":"7WhnT3TlkiqLsKSQsmOU1","margin":"","location":{"start":{"line":142,"column":1,"offset":5745},"end":{"line":142,"column":13,"offset":5757}},"text":"text","content":["For example:"]},{"type":"block","id":"bbJU4onUmabHEUanI15Yb","margin":"","name":"code","config":[],"location":{"start":{"line":144,"column":1,"offset":5759},"end":{"line":157,"column":47,"offset":6484}},"content":[{"type":"verbatim","value":"    . f         : File \"f\", contents empty (default), default permissions.\n    ._ f_a      : File \"f a\": spaces in its name are represented by '_'.\n    .444Z fZb   : File \"f b\", permission 444.\n    . f . me ow : File \"f\", literal contents: \"me ow\".\n    . f % k9    : File \"f\", contents retrieved from %file-contents<k9>.\n    . f . This line \\\n        continues.\\n\n                : File \"f\", contents are \"This line continues.\\n\".\n\n    .           : Error: missing filename.\n    . f x       : Error: unrecognized ‹x›.\n    . f % baz   : Error if %file-contents wasn't specified\n                  or if key ‹baz› is missing from it.\n    . f %       : Error: No key specified."}]},{"type":"block","id":"Eb3t0HYyIGEQQ6JqQ7aH6","margin":"","level":4,"name":"head","location":{"start":{"line":159,"column":1,"offset":6486},"end":{"line":159,"column":15,"offset":6500}},"content":["Hierarchy"]},{"type":"para","id":"Yw9ajg-MuO7RtiWP2-eEJ","margin":"","location":{"start":{"line":161,"column":1,"offset":6502},"end":{"line":161,"column":171,"offset":6672}},"text":"text","content":["Directories are created hierarchically, according to the indentation. Files are created in the directory hierarchically above them. In the hierarchy then, these are okay:"]},{"type":"block","id":"a3-YwCGvVPGEcCqWQF6d8","margin":"","name":"code","config":[],"location":{"start":{"line":163,"column":1,"offset":6674},"end":{"line":180,"column":17,"offset":7079}},"content":[{"type":"verbatim","value":"        Directories and files intermixed on the same level.\n    / d1\n    / d2\n    . f1\n    . f2\n    / d3\n\n        A directory holding a subdirectory or a file.\n    / d1\n        / d2\n            . f1\n\n        Returning to a previously established level, here at ‹. f2›.\n    / d1\n        / d2\n            / d3\n                . f1\n        . f2"}]},{"type":"para","id":"gQKFPOJaSqvi4xj3WMs-s","margin":"","location":{"start":{"line":182,"column":1,"offset":7081},"end":{"line":182,"column":19,"offset":7099}},"text":"text","content":["But these are not:"]},{"type":"block","id":"32jLs8TBzLhfKkFr9Syoo","margin":"","name":"code","config":[],"location":{"start":{"line":184,"column":1,"offset":7101},"end":{"line":202,"column":19,"offset":7523}},"content":[{"type":"verbatim","value":"        A file cannot hold a file.\n    . f1\n        . f2\n\n        Nor can it hold a directory.\n    . f1\n        / d1\n\n        ‹/ d3›'s indentation conflicts with those of ‹/ d1› and ‹/ d2›.\n    / d1\n        / d2\n      / d3\n\n        ‹/ d5›'s indentation conflicts with those of ‹/ d2› and ‹/ d3›.\n    / d1\n        / d2\n            / d3\n    / d4\n          / d5"}]},{"type":"block","id":"0qz63s9Ejhdd8QcLk_4h7","margin":"","level":2,"name":"head","location":{"start":{"line":204,"column":1,"offset":7525},"end":{"line":204,"column":10,"offset":7534}},"content":["AUTHOR"]},{"type":"para","id":"3d5s0bOx48MOwNeCwCKIe","margin":"","location":{"start":{"line":206,"column":1,"offset":7536},"end":{"line":206,"column":30,"offset":7565}},"text":"text","content":["Luc St-Louis ",{"meta":"mailto:lucs@pobox.com","type":"fcode","name":"L","content":["lucs@pobox.com"]}]},{"type":"block","id":"vLKbPXIW36TlsWgypyHqf","margin":"","level":2,"name":"head","location":{"start":{"line":208,"column":1,"offset":7567},"end":{"line":208,"column":25,"offset":7591}},"content":["COPYRIGHT AND LICENSE"]},{"type":"para","id":"R55Fl7QUNlmEIj55HmETl","margin":"","location":{"start":{"line":210,"column":1,"offset":7593},"end":{"line":210,"column":15,"offset":7607}},"text":"text","content":["Copyright 2023"]},{"type":"para","id":"kaEiod-nZMnFPycnNHbPK","margin":"","location":{"start":{"line":212,"column":1,"offset":7609},"end":{"line":212,"column":104,"offset":7712}},"text":"text","content":["This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0."]}]},"publishUrl":"/mods/zef/File-TreeBuilder/README.md","pluginsData":{"moduleInfo":{"meta":{"api":"","auth":"zef:lucs","authors":["Luc St-Louis <lucs@pobox.com>"],"build-depends":[],"depends":[],"description":"Build text-scripted trees of files","dist":"File-TreeBuilder:ver<0.1.0>:auth<zef:lucs>","name":"File-TreeBuilder","path":"F/IL/FILETREEBUILDER/9e18382a947e84ebd7a49ee6e6da09b4a8cedbb7.tar.gz","provides":{"File::TreeBuilder":"lib/File/TreeBuilder.rakumod"},"resources":[],"source-url":"git://github.com/lucs/File-TreeBuilder.git","test-depends":["Test::Selector"],"version":"0.1.0"},"files":[{"file":"work_mods/zef/File-TreeBuilder/README.md","publishUrl":"/mods/zef/File-TreeBuilder/README.md"},{"file":"work_mods/zef/File-TreeBuilder/lib/File/TreeBuilder.rakumod","publishUrl":"/mods/zef/File-TreeBuilder/lib/File/TreeBuilder.rakumod"}],"src":"zef","url":"/mods/zef/File-TreeBuilder"}}}
    =end data
    =end React


Build text-scripted trees of files


File-TreeBuilder


The Raku Knowledge Base


=begin React :component<HeaderCol> :id<footer>  
=begin nested :!nested
=item1 B<Language>
    =item2 L<Get started|file:../getting-started/getting-started.podlite>
    =item2 L<Why Raku?|/doc/language/faq#Why-should-I-learn-Raku-What's-so-great-about-it>
    =item2 L<Try Raku|https://glot.io/new/raku>
    =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=begin nested :!nested

=item1 B<L<Documentation|/doc>>
    =item2 L<Getting started, Migration guides from other languages, & Tutorials | file:../doc/introduction.podlite>
    =item2 L<Language References|file:../doc/reference.podlite>
    =item2 L<Type Reference| file:../doc/types.podlite>
    =item2 L<Miscellaneous| file:../doc/miscellaneous.podlite>
    =item2 L<FAQs (Frequently Asked Questions)|/doc/language/faq>
    =item2 L<Community|/doc/language/community>
    =item2 L<The list of all documents|file:../doc/index.podlite>

=item1 B<Resources>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>

=end nested
=begin nested :!nested

=item1 B<Resoures>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=item1 B<Learning>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Wikibook |https://en.wikibooks.org/wiki/Raku_Programming>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>
    =item2 L<Learn Raku in Y minutes|https://learnxinyminutes.com/docs/raku/>
    =item2 L<Golfing |https://github.com/AlexDaniel/raku-golf-cheatsheet>
=end nested
=begin nested :!nested

=item1 B<Explore>
    =item2 L<Raku Blog Aggregator|https://planet.raku.org/>
    =item2 L<Rakudo Weekly|https://rakudoweekly.blog/>
    =item2 L<The Weekly Challenge |https://perlweeklychallenge.org/>
    =item2 L<Raku Advent Calendar|https://raku-advent.blog/>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=end React


=begin React :component<CookieConsent> :id<CookieConsent> :buttonCaption("Got it!")
=para
This website uses cookies for analytics.
=end React


File::Copy

TITLE

SYNOPSIS

DESCRIPTION

AUTHOR

COPYRIGHT AND LICENSE

File::Copy v0.1.0

Authors

License

Dependencies

Test Dependencies

Provides

Documentation