TITLE

Implementation of the freedesktop.org XDG BaseDirectory specifications


SUBTITLE

data

=begin data
{"type":"page","file":"work_mods/zef/XDG::BaseDirectory/XDG-BaseDirectory-0.0.13/README.md","sources":[],"node":{"type":"block","id":"_Bpn0ojg3BYcbNrJ4UDju","margin":"","name":"root","content":[{"type":"block","id":"J6qrOcqeROsy8KC9Q_BJw","margin":"","level":1,"name":"head","location":{"start":{"line":1,"column":1,"offset":0},"end":{"line":1,"column":21,"offset":20}},"content":["XDG::BaseDirectory"]},{"type":"para","id":"EJqDcp_jGDqXXI8n6s3ne","margin":"","location":{"start":{"line":3,"column":1,"offset":22},"end":{"line":3,"column":141,"offset":162}},"text":"text","content":["Raku access to path information provided by the xdg base directory specfication ",{"meta":"http://www.freedesktop.org/wiki/Specifications/basedir-spec/","type":"fcode","name":"L","content":["http://www.freedesktop.org/wiki/Specifications/basedir-spec/"]}]},{"type":"para","id":"Hg7XznkHlSb5iH1urMVLN","margin":"","location":{"start":{"line":5,"column":1,"offset":164},"end":{"line":5,"column":91,"offset":254}},"text":"text","content":[{"type":"block","id":"QbH7NfeJcPqXkhuwlhmjA","margin":"","name":"Image","config":[],"location":{"start":{"line":5,"column":1,"offset":164},"end":{"line":5,"column":91,"offset":254}},"content":[{"type":"image","src":"https://github.com/jonathanstowe/XDG-BaseDirectory/workflows/CI/badge.svg","alt":"Build Status"}]}]},{"type":"block","id":"GrrxO4MxBjcKIfAgvmjjL","margin":"","level":2,"name":"head","location":{"start":{"line":7,"column":1,"offset":256},"end":{"line":7,"column":12,"offset":267}},"content":["Synopsis"]},{"type":"block","id":"o16DpF9zmjZO1n5rvKsXN","margin":"","name":"code","config":[{"name":"lang","value":"raku","type":"string"}],"location":{"start":{"line":9,"column":1,"offset":269},"end":{"line":24,"column":4,"offset":560}},"content":[{"type":"verbatim","value":"\n    use XDG::BaseDirectory;\n\n    my $bd = XDG::BaseDirectory.new\n\n    for $bd.load-config-paths('mydomain.org', 'MyProg', 'Options') -> $d {\n        say $d;\n    }\n\n    # Directories can be made available as terms as well\n    use XDG::BaseDirectory :terms;\n\n    say config-home;\n"}]},{"type":"block","id":"3ka3d_YRUJhhodyBaEghl","margin":"","level":2,"name":"head","location":{"start":{"line":26,"column":1,"offset":562},"end":{"line":26,"column":15,"offset":576}},"content":["Description"]},{"type":"para","id":"BjYnQ3ODRWwfrAOXr7y6y","margin":"","location":{"start":{"line":28,"column":1,"offset":578},"end":{"line":30,"column":13,"offset":726}},"text":"text","content":["This is loosely based on the interface of python module pyxdg. But\ndue to the differences between Python and Raku it may do some things\ndifferently."]},{"type":"para","id":"m8K121qklhZtTFWRD8r9H","margin":"","location":{"start":{"line":32,"column":1,"offset":728},"end":{"line":33,"column":40,"offset":835}},"text":"text","content":["It provides a set of facilities for discovering the location of the\nconfiguration and data of applications."]},{"type":"para","id":"dSGQzO5EzB-d5p0UsWZi4","margin":"","location":{"start":{"line":35,"column":1,"offset":837},"end":{"line":36,"column":30,"offset":937}},"text":"text","content":["I split this out from the XDG module as it has more general usefulness\nand no external dependencies."]},{"type":"block","id":"IReyFBkFQEmfENBta3Wf5","margin":"","level":2,"name":"head","location":{"start":{"line":38,"column":1,"offset":939},"end":{"line":38,"column":16,"offset":954}},"content":["Installation"]},{"type":"para","id":"HseAhumCYacdY7vdAcoBZ","margin":"","location":{"start":{"line":40,"column":1,"offset":956},"end":{"line":40,"column":122,"offset":1077}},"text":"text","content":["Assuming you have a working Rakudo installation with ",{"type":"fcode","name":"I","content":["zef"]}," installed you can install from a copy of the source directory:"]},{"type":"block","id":"YRO_PcpbFCYtv0PmZpcXO","margin":"","name":"code","config":[],"location":{"start":{"line":42,"column":1,"offset":1079},"end":{"line":42,"column":19,"offset":1097}},"content":[{"type":"verbatim","value":" zef install ."}]},{"type":"para","id":"-Ga4M1evX9I0dGpWEpdoM","margin":"","location":{"start":{"line":44,"column":1,"offset":1099},"end":{"line":44,"column":13,"offset":1111}},"text":"text","content":["or remotely:"]},{"type":"block","id":"z_YGwM8-lZD5eTvqBwAYv","margin":"","name":"code","config":[],"location":{"start":{"line":46,"column":1,"offset":1113},"end":{"line":46,"column":37,"offset":1149}},"content":[{"type":"verbatim","value":" zef install XDG::BaseDirectory "}]},{"type":"block","id":"bfXW7TL_kiTW2Powuh8sG","margin":"","level":2,"name":"head","location":{"start":{"line":48,"column":1,"offset":1151},"end":{"line":48,"column":11,"offset":1161}},"content":["Support"]},{"type":"para","id":"3poALR4EO0QS0omw4M3yN","margin":"","location":{"start":{"line":50,"column":1,"offset":1163},"end":{"line":50,"column":48,"offset":1210}},"text":"text","content":["Suggestions/patches are welcomed via github at:"]},{"type":"para","id":"TDw3ALOOJCvlDszLMF0ov","margin":"","location":{"start":{"line":52,"column":1,"offset":1212},"end":{"line":52,"column":58,"offset":1269}},"text":"text","content":[{"meta":"https://github.com/jonathanstowe/XDG-BaseDirectory/issues","type":"fcode","name":"L","content":["https://github.com/jonathanstowe/XDG-BaseDirectory/issues"]}]},{"type":"para","id":"ZruwCx-q6p6TDbEBBrKnv","margin":"","location":{"start":{"line":54,"column":1,"offset":1271},"end":{"line":54,"column":92,"offset":1362}},"text":"text","content":["I'm not able to test on a wide variety of platforms so any help there would be appreciated."]},{"type":"block","id":"jEp0PfMsl6wUOw_5auLMs","margin":"","level":2,"name":"head","location":{"start":{"line":56,"column":1,"offset":1364},"end":{"line":56,"column":11,"offset":1374}},"content":["Licence"]},{"type":"para","id":"Hffyg74WrA41ojb_vPJya","margin":"","location":{"start":{"line":58,"column":1,"offset":1376},"end":{"line":58,"column":109,"offset":1484}},"text":"text","content":["This module is Free Software please see the ",{"meta":"LICENCE","type":"fcode","name":"L","content":["LICENCE"]}," file in the distribution for the exact terms."]},{"type":"para","id":"Ib0grmQSQz_mJwBwAlHVr","margin":"","location":{"start":{"line":60,"column":1,"offset":1486},"end":{"line":60,"column":27,"offset":1512}},"text":"text","content":["© Jonathan Stowe 2015-2021"]}]},"publishUrl":"/mods/zef/XDG::BaseDirectory/XDG-BaseDirectory-0.0.13/README.md","pluginsData":{"moduleInfo":{"meta":{"api":"1.0","auth":"zef:jonathanstowe","author":"Jonathan Stowe <jns+git@gellyfish.co.uk","authors":["Jonathan Stowe <jns+git@gellyfish.co.uk"],"build-depends":[],"depends":[],"description":"Implementation of the freedesktop.org XDG BaseDirectory specifications","dist":"XDG::BaseDirectory:ver<0.0.13>:auth<zef:jonathanstowe>","license":"Artistic-2.0","meta-version":"1","name":"XDG::BaseDirectory","path":"X/DG/XDG_BASEDIRECTORY/9e0385364984b662ba827f40cb2b7f3d3e46f4eb.tar.gz","provides":{"XDG::BaseDirectory":"lib/XDG/BaseDirectory.pm"},"raku":"6.*","resources":[],"source-url":"https://github.com/jonathanstowe/XDG-BaseDirectory.git","support":{"bugtracker":"https://github.com/jonathanstowe/XDG-BaseDirectory/issues","source":"https://github.com/jonathanstowe/XDG-BaseDirectory.git"},"tags":["xdg","desktop","utils"],"test-depends":["File::Find","Shell::Command"],"version":"0.0.13"},"files":[{"file":"work_mods/zef/XDG::BaseDirectory/XDG-BaseDirectory-0.0.13/README.md","publishUrl":"/mods/zef/XDG::BaseDirectory/XDG-BaseDirectory-0.0.13/README.md"},{"file":"work_mods/zef/XDG::BaseDirectory/XDG-BaseDirectory-0.0.13/lib/XDG/BaseDirectory.pm","publishUrl":"/mods/zef/XDG::BaseDirectory/XDG-BaseDirectory-0.0.13/lib/XDG/BaseDirectory.pm"}],"src":"zef","url":"/mods/zef/XDG::BaseDirectory"}}}
=end data


React

    =begin React :component<RenderItem>
    =begin data
    {"type":"page","file":"work_mods/zef/XDG::BaseDirectory/XDG-BaseDirectory-0.0.13/README.md","sources":[],"node":{"type":"block","id":"_Bpn0ojg3BYcbNrJ4UDju","margin":"","name":"root","content":[{"type":"block","id":"J6qrOcqeROsy8KC9Q_BJw","margin":"","level":1,"name":"head","location":{"start":{"line":1,"column":1,"offset":0},"end":{"line":1,"column":21,"offset":20}},"content":["XDG::BaseDirectory"]},{"type":"para","id":"EJqDcp_jGDqXXI8n6s3ne","margin":"","location":{"start":{"line":3,"column":1,"offset":22},"end":{"line":3,"column":141,"offset":162}},"text":"text","content":["Raku access to path information provided by the xdg base directory specfication ",{"meta":"http://www.freedesktop.org/wiki/Specifications/basedir-spec/","type":"fcode","name":"L","content":["http://www.freedesktop.org/wiki/Specifications/basedir-spec/"]}]},{"type":"para","id":"Hg7XznkHlSb5iH1urMVLN","margin":"","location":{"start":{"line":5,"column":1,"offset":164},"end":{"line":5,"column":91,"offset":254}},"text":"text","content":[{"type":"block","id":"QbH7NfeJcPqXkhuwlhmjA","margin":"","name":"Image","config":[],"location":{"start":{"line":5,"column":1,"offset":164},"end":{"line":5,"column":91,"offset":254}},"content":[{"type":"image","src":"https://github.com/jonathanstowe/XDG-BaseDirectory/workflows/CI/badge.svg","alt":"Build Status"}]}]},{"type":"block","id":"GrrxO4MxBjcKIfAgvmjjL","margin":"","level":2,"name":"head","location":{"start":{"line":7,"column":1,"offset":256},"end":{"line":7,"column":12,"offset":267}},"content":["Synopsis"]},{"type":"block","id":"o16DpF9zmjZO1n5rvKsXN","margin":"","name":"code","config":[{"name":"lang","value":"raku","type":"string"}],"location":{"start":{"line":9,"column":1,"offset":269},"end":{"line":24,"column":4,"offset":560}},"content":[{"type":"verbatim","value":"\n    use XDG::BaseDirectory;\n\n    my $bd = XDG::BaseDirectory.new\n\n    for $bd.load-config-paths('mydomain.org', 'MyProg', 'Options') -> $d {\n        say $d;\n    }\n\n    # Directories can be made available as terms as well\n    use XDG::BaseDirectory :terms;\n\n    say config-home;\n"}]},{"type":"block","id":"3ka3d_YRUJhhodyBaEghl","margin":"","level":2,"name":"head","location":{"start":{"line":26,"column":1,"offset":562},"end":{"line":26,"column":15,"offset":576}},"content":["Description"]},{"type":"para","id":"BjYnQ3ODRWwfrAOXr7y6y","margin":"","location":{"start":{"line":28,"column":1,"offset":578},"end":{"line":30,"column":13,"offset":726}},"text":"text","content":["This is loosely based on the interface of python module pyxdg. But\ndue to the differences between Python and Raku it may do some things\ndifferently."]},{"type":"para","id":"m8K121qklhZtTFWRD8r9H","margin":"","location":{"start":{"line":32,"column":1,"offset":728},"end":{"line":33,"column":40,"offset":835}},"text":"text","content":["It provides a set of facilities for discovering the location of the\nconfiguration and data of applications."]},{"type":"para","id":"dSGQzO5EzB-d5p0UsWZi4","margin":"","location":{"start":{"line":35,"column":1,"offset":837},"end":{"line":36,"column":30,"offset":937}},"text":"text","content":["I split this out from the XDG module as it has more general usefulness\nand no external dependencies."]},{"type":"block","id":"IReyFBkFQEmfENBta3Wf5","margin":"","level":2,"name":"head","location":{"start":{"line":38,"column":1,"offset":939},"end":{"line":38,"column":16,"offset":954}},"content":["Installation"]},{"type":"para","id":"HseAhumCYacdY7vdAcoBZ","margin":"","location":{"start":{"line":40,"column":1,"offset":956},"end":{"line":40,"column":122,"offset":1077}},"text":"text","content":["Assuming you have a working Rakudo installation with ",{"type":"fcode","name":"I","content":["zef"]}," installed you can install from a copy of the source directory:"]},{"type":"block","id":"YRO_PcpbFCYtv0PmZpcXO","margin":"","name":"code","config":[],"location":{"start":{"line":42,"column":1,"offset":1079},"end":{"line":42,"column":19,"offset":1097}},"content":[{"type":"verbatim","value":" zef install ."}]},{"type":"para","id":"-Ga4M1evX9I0dGpWEpdoM","margin":"","location":{"start":{"line":44,"column":1,"offset":1099},"end":{"line":44,"column":13,"offset":1111}},"text":"text","content":["or remotely:"]},{"type":"block","id":"z_YGwM8-lZD5eTvqBwAYv","margin":"","name":"code","config":[],"location":{"start":{"line":46,"column":1,"offset":1113},"end":{"line":46,"column":37,"offset":1149}},"content":[{"type":"verbatim","value":" zef install XDG::BaseDirectory "}]},{"type":"block","id":"bfXW7TL_kiTW2Powuh8sG","margin":"","level":2,"name":"head","location":{"start":{"line":48,"column":1,"offset":1151},"end":{"line":48,"column":11,"offset":1161}},"content":["Support"]},{"type":"para","id":"3poALR4EO0QS0omw4M3yN","margin":"","location":{"start":{"line":50,"column":1,"offset":1163},"end":{"line":50,"column":48,"offset":1210}},"text":"text","content":["Suggestions/patches are welcomed via github at:"]},{"type":"para","id":"TDw3ALOOJCvlDszLMF0ov","margin":"","location":{"start":{"line":52,"column":1,"offset":1212},"end":{"line":52,"column":58,"offset":1269}},"text":"text","content":[{"meta":"https://github.com/jonathanstowe/XDG-BaseDirectory/issues","type":"fcode","name":"L","content":["https://github.com/jonathanstowe/XDG-BaseDirectory/issues"]}]},{"type":"para","id":"ZruwCx-q6p6TDbEBBrKnv","margin":"","location":{"start":{"line":54,"column":1,"offset":1271},"end":{"line":54,"column":92,"offset":1362}},"text":"text","content":["I'm not able to test on a wide variety of platforms so any help there would be appreciated."]},{"type":"block","id":"jEp0PfMsl6wUOw_5auLMs","margin":"","level":2,"name":"head","location":{"start":{"line":56,"column":1,"offset":1364},"end":{"line":56,"column":11,"offset":1374}},"content":["Licence"]},{"type":"para","id":"Hffyg74WrA41ojb_vPJya","margin":"","location":{"start":{"line":58,"column":1,"offset":1376},"end":{"line":58,"column":109,"offset":1484}},"text":"text","content":["This module is Free Software please see the ",{"meta":"LICENCE","type":"fcode","name":"L","content":["LICENCE"]}," file in the distribution for the exact terms."]},{"type":"para","id":"Ib0grmQSQz_mJwBwAlHVr","margin":"","location":{"start":{"line":60,"column":1,"offset":1486},"end":{"line":60,"column":27,"offset":1512}},"text":"text","content":["© Jonathan Stowe 2015-2021"]}]},"publishUrl":"/mods/zef/XDG::BaseDirectory/XDG-BaseDirectory-0.0.13/README.md","pluginsData":{"moduleInfo":{"meta":{"api":"1.0","auth":"zef:jonathanstowe","author":"Jonathan Stowe <jns+git@gellyfish.co.uk","authors":["Jonathan Stowe <jns+git@gellyfish.co.uk"],"build-depends":[],"depends":[],"description":"Implementation of the freedesktop.org XDG BaseDirectory specifications","dist":"XDG::BaseDirectory:ver<0.0.13>:auth<zef:jonathanstowe>","license":"Artistic-2.0","meta-version":"1","name":"XDG::BaseDirectory","path":"X/DG/XDG_BASEDIRECTORY/9e0385364984b662ba827f40cb2b7f3d3e46f4eb.tar.gz","provides":{"XDG::BaseDirectory":"lib/XDG/BaseDirectory.pm"},"raku":"6.*","resources":[],"source-url":"https://github.com/jonathanstowe/XDG-BaseDirectory.git","support":{"bugtracker":"https://github.com/jonathanstowe/XDG-BaseDirectory/issues","source":"https://github.com/jonathanstowe/XDG-BaseDirectory.git"},"tags":["xdg","desktop","utils"],"test-depends":["File::Find","Shell::Command"],"version":"0.0.13"},"files":[{"file":"work_mods/zef/XDG::BaseDirectory/XDG-BaseDirectory-0.0.13/README.md","publishUrl":"/mods/zef/XDG::BaseDirectory/XDG-BaseDirectory-0.0.13/README.md"},{"file":"work_mods/zef/XDG::BaseDirectory/XDG-BaseDirectory-0.0.13/lib/XDG/BaseDirectory.pm","publishUrl":"/mods/zef/XDG::BaseDirectory/XDG-BaseDirectory-0.0.13/lib/XDG/BaseDirectory.pm"}],"src":"zef","url":"/mods/zef/XDG::BaseDirectory"}}}
    =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

XDG::BaseDirectory


Guarantees that a resource is present in the expected XDG Base Directory directory


=begin data
{"type":"page","file":"work_mods/zef/XDG::GuaranteedResources/dist/README.md","sources":[],"node":{"type":"block","id":"onf82Slkg0kslOH73nQ9y","margin":"","name":"root","content":[{"type":"block","id":"aIr2fAHMKpWlUj4yLpC11","margin":"","level":1,"name":"head","location":{"start":{"line":1,"column":1,"offset":0},"end":{"line":2,"column":5,"offset":9}},"content":["NAME"]},{"type":"para","id":"dXGMiZD-khEBbFdb9JFCM","margin":"","location":{"start":{"line":4,"column":1,"offset":11},"end":{"line":4,"column":110,"offset":120}},"text":"text","content":["XDG::GuaranteedResources - Guarantees that a resource is present in the expected XDG Base Directory directory"]},{"type":"block","id":"wwJOgTzfqmQT9APrO9kKs","margin":"","level":1,"name":"head","location":{"start":{"line":6,"column":1,"offset":122},"end":{"line":7,"column":9,"offset":139}},"content":["SYNOPSIS"]},{"type":"block","id":"gqd934PZ_Zw3XOYO-kRfe","margin":"","name":"code","config":[{"name":"lang","value":"raku","type":"string"}],"location":{"start":{"line":9,"column":1,"offset":141},"end":{"line":14,"column":4,"offset":361}},"content":[{"type":"verbatim","value":"use XDG::GuaranteedResources;\n# pass it the relative path to a file under your resources directory\n# path must be listed in the resources array of your META6.json\nguarantee-resource(\"config/app_config.toml\");"}]},{"type":"block","id":"GFIykg2cs6UIfd3DJqyQk","margin":"","level":1,"name":"head","location":{"start":{"line":16,"column":1,"offset":363},"end":{"line":17,"column":12,"offset":386}},"content":["DESCRIPTION"]},{"type":"para","id":"n8RjjPMk8uUoDjcjov9Y0","margin":"","location":{"start":{"line":19,"column":1,"offset":388},"end":{"line":19,"column":207,"offset":594}},"text":"text","content":["Many tools expect a config file, sqlite database, or similar to be present. We store these in the resources listed in ",{"type":"fcode","name":"C","content":["META6.json"]},", and need to test if they exist and copy them over from ",{"type":"fcode","name":"C","content":["resources"]}," if not."]},{"type":"para","id":"-FZUGdVi1HYlk0XG44cPv","margin":"","location":{"start":{"line":21,"column":1,"offset":596},"end":{"line":21,"column":58,"offset":653}},"text":"text","content":[{"type":"fcode","name":"C","content":["XDG::GuaranteedResources"]}," handles this common operation."]},{"type":"para","id":"WJfGvMpct_FjwrwohsrFK","margin":"","location":{"start":{"line":23,"column":1,"offset":655},"end":{"line":23,"column":95,"offset":749}},"text":"text","content":["Resources that should be copied to ",{"type":"fcode","name":"C","content":["XDG_CONFIG_HOME"]}," should be stored under ",{"type":"fcode","name":"C","content":["resources/config"]}]},{"type":"para","id":"hfYg-j_PWJI9J3d2-C-JD","margin":"","location":{"start":{"line":25,"column":1,"offset":751},"end":{"line":25,"column":91,"offset":841}},"text":"text","content":["Resources that should be copied to ",{"type":"fcode","name":"C","content":["XDG_DATA_HOME"]}," should be stored under ",{"type":"fcode","name":"C","content":["resources/data"]}]},{"type":"para","id":"R_P5jQw-bcEZTsTgBn4fa","margin":"","location":{"start":{"line":27,"column":1,"offset":843},"end":{"line":27,"column":63,"offset":905}},"text":"text","content":["Subdirectories are fine. E.g. ",{"type":"fcode","name":"C","content":["resources/data/subdir/my_db.db"]}]},{"type":"para","id":"TWzbUQYu_HIZ9vnpXPobt","margin":"","location":{"start":{"line":29,"column":1,"offset":907},"end":{"line":29,"column":66,"offset":972}},"text":"text","content":["⚠ Currently only works on Unix (Linux, BSD, macOS, etc.) systems."]},{"type":"block","id":"W5BDj3p6NXe6VJ-9ERbpk","margin":"","level":1,"name":"head","location":{"start":{"line":31,"column":1,"offset":974},"end":{"line":32,"column":7,"offset":987}},"content":["AUTHOR"]},{"type":"para","id":"DohNHQJH5gn91bH0Df9rc","margin":"","location":{"start":{"line":34,"column":1,"offset":989},"end":{"line":34,"column":49,"offset":1037}},"text":"text","content":["Kay Rhodes a.k.a masukomi (",{"meta":"mailto:masukom@masukomi.org","type":"fcode","name":"L","content":["masukom@masukomi.org"]},")"]},{"type":"block","id":"sj9ZR5jHft8GC_BqnBQgg","margin":"","level":1,"name":"head","location":{"start":{"line":36,"column":1,"offset":1039},"end":{"line":37,"column":22,"offset":1082}},"content":["COPYRIGHT AND LICENSE"]},{"type":"para","id":"Pm7U6LtNlwRIUg21TSFNt","margin":"","location":{"start":{"line":39,"column":1,"offset":1084},"end":{"line":39,"column":16,"offset":1099}},"text":"text","content":["Copyright 2022"]},{"type":"para","id":"18f9LEcyDjqkDnA8bpKsc","margin":"","location":{"start":{"line":41,"column":1,"offset":1101},"end":{"line":41,"column":95,"offset":1195}},"text":"text","content":["This library is free software; you can redistribute it and/or modify it under the MIT License."]},{"type":"block","id":"xjP6hDY6Qn0cYlP0qP_eJ","margin":"","level":3,"name":"head","location":{"start":{"line":43,"column":1,"offset":1197},"end":{"line":43,"column":27,"offset":1223}},"content":["sub guarantee-resource"]},{"type":"block","id":"llnsrlqiFwy-nNfINrjqz","margin":"","name":"code","config":[{"name":"lang","value":"raku","type":"string"}],"location":{"start":{"line":45,"column":1,"offset":1225},"end":{"line":49,"column":4,"offset":1297}},"content":[{"type":"verbatim","value":"sub guarantee-resource(\n    Str $resource_path\n) returns Str"}]},{"type":"para","id":"2y1Iz6GPK5HRjK5S8dLkw","margin":"","location":{"start":{"line":51,"column":1,"offset":1299},"end":{"line":51,"column":61,"offset":1359}},"text":"text","content":["checks if the resource is present and copies it over if not."]}]},"publishUrl":"/mods/zef/XDG::GuaranteedResources/dist/README.md","pluginsData":{"moduleInfo":{"meta":{"api":"","auth":"zef:masukomi","authors":["masukomi <masukomi@masukomi.org>"],"build-depends":[],"depends":["XDG::BaseDirectory"],"description":"Guarantees that a resource is present in the expected XDG Base Directory directory","dist":"XDG::GuaranteedResources:ver<1.0.0>:auth<zef:masukomi>","license":"MIT","name":"XDG::GuaranteedResources","path":"X/DG/XDG_GUARANTEEDRESOURCES/052b3dfe189982005b0b04ee300c7d8232cecc52.tar.gz","perl":"6.d","provides":{"XDG::GuaranteedResources":"lib/XDG/GuaranteedResources.rakumod","XDG::GuaranteedResources::Resourcer":"lib/XDG/GuaranteedResources/Resourcer.rakumod"},"resources":["config/config_file.test","data/data_file.test","data/data_subdir/data_subdir_file.test"],"source-url":"https://github.com/masukomi/XDG-GuaranteedResources","tags":[],"test-depends":["File::Directory::Tree"],"version":"1.0.0"},"files":[{"file":"work_mods/zef/XDG::GuaranteedResources/dist/README.md","publishUrl":"/mods/zef/XDG::GuaranteedResources/dist/README.md"},{"file":"work_mods/zef/XDG::GuaranteedResources/dist/lib/XDG/GuaranteedResources.rakumod","publishUrl":"/mods/zef/XDG::GuaranteedResources/dist/lib/XDG/GuaranteedResources.rakumod"}],"src":"zef","url":"/mods/zef/XDG::GuaranteedResources"}}}
=end data


    =begin React :component<RenderItem>
    =begin data
    {"type":"page","file":"work_mods/zef/XDG::GuaranteedResources/dist/README.md","sources":[],"node":{"type":"block","id":"onf82Slkg0kslOH73nQ9y","margin":"","name":"root","content":[{"type":"block","id":"aIr2fAHMKpWlUj4yLpC11","margin":"","level":1,"name":"head","location":{"start":{"line":1,"column":1,"offset":0},"end":{"line":2,"column":5,"offset":9}},"content":["NAME"]},{"type":"para","id":"dXGMiZD-khEBbFdb9JFCM","margin":"","location":{"start":{"line":4,"column":1,"offset":11},"end":{"line":4,"column":110,"offset":120}},"text":"text","content":["XDG::GuaranteedResources - Guarantees that a resource is present in the expected XDG Base Directory directory"]},{"type":"block","id":"wwJOgTzfqmQT9APrO9kKs","margin":"","level":1,"name":"head","location":{"start":{"line":6,"column":1,"offset":122},"end":{"line":7,"column":9,"offset":139}},"content":["SYNOPSIS"]},{"type":"block","id":"gqd934PZ_Zw3XOYO-kRfe","margin":"","name":"code","config":[{"name":"lang","value":"raku","type":"string"}],"location":{"start":{"line":9,"column":1,"offset":141},"end":{"line":14,"column":4,"offset":361}},"content":[{"type":"verbatim","value":"use XDG::GuaranteedResources;\n# pass it the relative path to a file under your resources directory\n# path must be listed in the resources array of your META6.json\nguarantee-resource(\"config/app_config.toml\");"}]},{"type":"block","id":"GFIykg2cs6UIfd3DJqyQk","margin":"","level":1,"name":"head","location":{"start":{"line":16,"column":1,"offset":363},"end":{"line":17,"column":12,"offset":386}},"content":["DESCRIPTION"]},{"type":"para","id":"n8RjjPMk8uUoDjcjov9Y0","margin":"","location":{"start":{"line":19,"column":1,"offset":388},"end":{"line":19,"column":207,"offset":594}},"text":"text","content":["Many tools expect a config file, sqlite database, or similar to be present. We store these in the resources listed in ",{"type":"fcode","name":"C","content":["META6.json"]},", and need to test if they exist and copy them over from ",{"type":"fcode","name":"C","content":["resources"]}," if not."]},{"type":"para","id":"-FZUGdVi1HYlk0XG44cPv","margin":"","location":{"start":{"line":21,"column":1,"offset":596},"end":{"line":21,"column":58,"offset":653}},"text":"text","content":[{"type":"fcode","name":"C","content":["XDG::GuaranteedResources"]}," handles this common operation."]},{"type":"para","id":"WJfGvMpct_FjwrwohsrFK","margin":"","location":{"start":{"line":23,"column":1,"offset":655},"end":{"line":23,"column":95,"offset":749}},"text":"text","content":["Resources that should be copied to ",{"type":"fcode","name":"C","content":["XDG_CONFIG_HOME"]}," should be stored under ",{"type":"fcode","name":"C","content":["resources/config"]}]},{"type":"para","id":"hfYg-j_PWJI9J3d2-C-JD","margin":"","location":{"start":{"line":25,"column":1,"offset":751},"end":{"line":25,"column":91,"offset":841}},"text":"text","content":["Resources that should be copied to ",{"type":"fcode","name":"C","content":["XDG_DATA_HOME"]}," should be stored under ",{"type":"fcode","name":"C","content":["resources/data"]}]},{"type":"para","id":"R_P5jQw-bcEZTsTgBn4fa","margin":"","location":{"start":{"line":27,"column":1,"offset":843},"end":{"line":27,"column":63,"offset":905}},"text":"text","content":["Subdirectories are fine. E.g. ",{"type":"fcode","name":"C","content":["resources/data/subdir/my_db.db"]}]},{"type":"para","id":"TWzbUQYu_HIZ9vnpXPobt","margin":"","location":{"start":{"line":29,"column":1,"offset":907},"end":{"line":29,"column":66,"offset":972}},"text":"text","content":["⚠ Currently only works on Unix (Linux, BSD, macOS, etc.) systems."]},{"type":"block","id":"W5BDj3p6NXe6VJ-9ERbpk","margin":"","level":1,"name":"head","location":{"start":{"line":31,"column":1,"offset":974},"end":{"line":32,"column":7,"offset":987}},"content":["AUTHOR"]},{"type":"para","id":"DohNHQJH5gn91bH0Df9rc","margin":"","location":{"start":{"line":34,"column":1,"offset":989},"end":{"line":34,"column":49,"offset":1037}},"text":"text","content":["Kay Rhodes a.k.a masukomi (",{"meta":"mailto:masukom@masukomi.org","type":"fcode","name":"L","content":["masukom@masukomi.org"]},")"]},{"type":"block","id":"sj9ZR5jHft8GC_BqnBQgg","margin":"","level":1,"name":"head","location":{"start":{"line":36,"column":1,"offset":1039},"end":{"line":37,"column":22,"offset":1082}},"content":["COPYRIGHT AND LICENSE"]},{"type":"para","id":"Pm7U6LtNlwRIUg21TSFNt","margin":"","location":{"start":{"line":39,"column":1,"offset":1084},"end":{"line":39,"column":16,"offset":1099}},"text":"text","content":["Copyright 2022"]},{"type":"para","id":"18f9LEcyDjqkDnA8bpKsc","margin":"","location":{"start":{"line":41,"column":1,"offset":1101},"end":{"line":41,"column":95,"offset":1195}},"text":"text","content":["This library is free software; you can redistribute it and/or modify it under the MIT License."]},{"type":"block","id":"xjP6hDY6Qn0cYlP0qP_eJ","margin":"","level":3,"name":"head","location":{"start":{"line":43,"column":1,"offset":1197},"end":{"line":43,"column":27,"offset":1223}},"content":["sub guarantee-resource"]},{"type":"block","id":"llnsrlqiFwy-nNfINrjqz","margin":"","name":"code","config":[{"name":"lang","value":"raku","type":"string"}],"location":{"start":{"line":45,"column":1,"offset":1225},"end":{"line":49,"column":4,"offset":1297}},"content":[{"type":"verbatim","value":"sub guarantee-resource(\n    Str $resource_path\n) returns Str"}]},{"type":"para","id":"2y1Iz6GPK5HRjK5S8dLkw","margin":"","location":{"start":{"line":51,"column":1,"offset":1299},"end":{"line":51,"column":61,"offset":1359}},"text":"text","content":["checks if the resource is present and copies it over if not."]}]},"publishUrl":"/mods/zef/XDG::GuaranteedResources/dist/README.md","pluginsData":{"moduleInfo":{"meta":{"api":"","auth":"zef:masukomi","authors":["masukomi <masukomi@masukomi.org>"],"build-depends":[],"depends":["XDG::BaseDirectory"],"description":"Guarantees that a resource is present in the expected XDG Base Directory directory","dist":"XDG::GuaranteedResources:ver<1.0.0>:auth<zef:masukomi>","license":"MIT","name":"XDG::GuaranteedResources","path":"X/DG/XDG_GUARANTEEDRESOURCES/052b3dfe189982005b0b04ee300c7d8232cecc52.tar.gz","perl":"6.d","provides":{"XDG::GuaranteedResources":"lib/XDG/GuaranteedResources.rakumod","XDG::GuaranteedResources::Resourcer":"lib/XDG/GuaranteedResources/Resourcer.rakumod"},"resources":["config/config_file.test","data/data_file.test","data/data_subdir/data_subdir_file.test"],"source-url":"https://github.com/masukomi/XDG-GuaranteedResources","tags":[],"test-depends":["File::Directory::Tree"],"version":"1.0.0"},"files":[{"file":"work_mods/zef/XDG::GuaranteedResources/dist/README.md","publishUrl":"/mods/zef/XDG::GuaranteedResources/dist/README.md"},{"file":"work_mods/zef/XDG::GuaranteedResources/dist/lib/XDG/GuaranteedResources.rakumod","publishUrl":"/mods/zef/XDG::GuaranteedResources/dist/lib/XDG/GuaranteedResources.rakumod"}],"src":"zef","url":"/mods/zef/XDG::GuaranteedResources"}}}
    =end data
    =end React


XDG::GuaranteedResources


libxdo automation for X11


X11::libxdo


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


XDG::BaseDirectory

XDG::BaseDirectory

image https://github.com/jonathanstowe/XDG-BaseDirectory/workflows/CI/badge.svg not found

Synopsis

Description

Installation

Support

Licence

XDG::BaseDirectory v0.0.13

Authors

License

Dependencies

Test Dependencies

Provides

Documentation