2018-08-10 02:50:42 +02:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=9" / >
< meta name = "generator" content = "Doxygen 1.8.14" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< title > xdgcfg: Main Page< / title >
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "jquery.js" > < / script >
< script type = "text/javascript" src = "dynsections.js" > < / script >
2019-08-02 10:05:27 +02:00
< link href = "search/search.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "search/searchdata.js" > < / script >
< script type = "text/javascript" src = "search/search.js" > < / script >
2018-08-10 02:50:42 +02:00
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< / head >
< body >
< div id = "top" > <!-- do not remove this div, it is closed by doxygen! -->
< div id = "titlearea" >
< table cellspacing = "0" cellpadding = "0" >
< tbody >
< tr style = "height: 56px;" >
< td id = "projectalign" style = "padding-left: 0.5em;" >
< div id = "projectname" > xdgcfg
2019-08-02 13:33:50 +02:00
  < span id = "projectnumber" > 0.4.1< / span >
2018-08-10 02:50:42 +02:00
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
2019-08-02 10:05:27 +02:00
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
< / script >
2018-08-10 02:50:42 +02:00
< script type = "text/javascript" src = "menudata.js" > < / script >
< script type = "text/javascript" src = "menu.js" > < / script >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
$(function() {
2019-08-02 10:05:27 +02:00
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
2018-08-10 02:50:42 +02:00
});
/* @license-end */< / script >
< div id = "main-nav" > < / div >
< / div > <!-- top -->
2019-08-02 10:05:27 +02:00
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
< / div >
<!-- iframe showing the search results (closed by default) -->
< div id = "MSearchResultsWindow" >
< iframe src = "javascript:void(0)" frameborder = "0"
name="MSearchResults" id="MSearchResults">
< / iframe >
< / div >
2018-08-10 02:50:42 +02:00
< div class = "header" >
< div class = "headertitle" >
< div class = "title" > xdgcfg Documentation< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
2018-08-10 03:03:50 +02:00
< div class = "textblock" > < p > < b > xdgcfg< / b > is a very simple wrapper around libconfig written in C++. It reads and writes files in < code > ${XDG_CONFIG_HOME}< / code > . It creates subdirectories if necessary.< / p >
2019-08-02 10:05:27 +02:00
< h2 > Usage< / h2 >
2019-08-02 13:33:50 +02:00
< p > < code > < a class = "el" href = "xdgcfg_8hpp_source.html" > xdgcfg.hpp< / a > < / code > has explanatory comments in it and there is an < a href = "examples/example.cpp" > example< / a > . The reference is also available at < a href = "https://doc.schlomp.space/xdgcfg/classxdgcfg.html" > doc.schlomp.space/xdgcfg/< / a > .< / p >
2019-08-02 10:05:27 +02:00
< p > Use it in your CMake project like this:< / p >
< div class = "fragment" > < div class = "line" > find_package(xdgcfg CONFIG REQUIRED)< / div > < div class = "line" > target_link_libraries(MyProject xdgcfg::xdgcfg)< / div > < / div > <!-- fragment --> < p > If you don't use CMake, you can get the compile-flags with pkg-config:< / p >
< div class = "fragment" > < div class = "line" > pkg-config --libs --cflags xdgcfg< / div > < / div > <!-- fragment --> < h2 > Install< / h2 >
2019-07-22 04:43:15 +02:00
< h3 > Gentoo< / h3 >
< p > Add my < a href = "https://schlomp.space/tastytea/overlay" > repository< / a > and install it from there.< / p >
< div class = "fragment" > < div class = "line" > eselect repository enable tastytea< / div > < div class = "line" > echo " dev-cpp/xdgcfg" > > /etc/portage/package.accept_keywords/xdgcfg< / div > < div class = "line" > emaint sync -r tastytea< / div > < div class = "line" > emerge -a dev-cpp/xdgcfg< / div > < / div > <!-- fragment --> < h3 > From source< / h3 >
2019-08-02 10:05:27 +02:00
< h3 > Dependencies< / h3 >
< ul >
< li > C++ compiler (Tested: g++ 5/8/9)< / li >
< li > < a href = "https://cmake.org/" > cmake< / a > (at least: 3.1)< / li >
< li > < a href = "https://pkgconfig.freedesktop.org/wiki/" > pkgconfig< / a > (tested: 0.29)< / li >
< li > < a href = "https://github.com/hyperrealm/libconfig" > libconfig++< / a > (tested: 1.5)< / li >
< li > < a href = "http://repo.or.cz/w/libxdg-basedir.git" > libxdg-basedir< / a > (tested: 1.2)< / li >
< / ul >
< h3 > Compile< / h3 >
< div class = "fragment" > < div class = "line" > mkdir build< / div > < div class = "line" > cd build< / div > < div class = "line" > cmake ..< / div > < div class = "line" > cmake --build .< / div > < div class = "line" > make install< / div > < / div > <!-- fragment --> < h3 > CMake options< / h3 >
2019-07-22 04:43:15 +02:00
< ul >
< li > < code > -DWITH_TESTS=YES< / code > to compile the tests.< / li >
< li > < code > -DWITH_EXAMPLES=YES< / code > to compile the example.< / li >
2019-08-02 10:05:27 +02:00
< li > < code > -DBUILD_SHARED_LIBS=NO< / code > to build a static library. < / li >
2019-07-22 04:43:15 +02:00
< / ul >
2018-08-10 02:50:42 +02:00
< / div > < / div > <!-- contents -->
<!-- start footer part -->
< hr class = "footer" / > < address class = "footer" > < small >
Generated by   < a href = "http://www.doxygen.org/index.html" >
< img class = "footer" src = "doxygen.png" alt = "doxygen" / >
< / a > 1.8.14
< / small > < / address >
< / body >
< / html >
