This repository has been archived on 2020-05-16. You can view files and clone it, but cannot push or open issues or pull requests.
xdgcfg/docs/index.html

69 lines
3.1 KiB
HTML
Raw Normal View History

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>
<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
&#160;<span id="projectnumber">0.1.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<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&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<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>
2018-08-10 02:50:42 +02:00
<h3>Dependencies</h3>
<ul>
<li>C++ compiler</li>
<li><a href="https://cmake.org/">cmake</a></li>
<li><a href="https://pkgconfig.freedesktop.org/wiki/">pkgconfig</a></li>
<li><a href="https://github.com/hyperrealm/libconfig">libconfig++</a></li>
<li><a href="http://repo.or.cz/w/libxdg-basedir.git">libxdg-basedir</a></li>
</ul>
<h3>Usage</h3>
<p>You can create dynamic and static libraries:</p>
<div class="fragment"><div class="line">mkdir build</div><div class="line">cd build</div><div class="line">cmake ..</div><div class="line">make</div><div class="line">make install</div></div><!-- fragment --><p>Or just copy <code><a class="el" href="xdgcfg_8hpp_source.html">xdgcfg.hpp</a></code> and <code>xdgcfg.cpp</code> into your project folder.</p>
<h3>Documentation</h3>
2018-08-10 02:55:23 +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="src/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>
2018-08-10 02:50:42 +02:00
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>