
\begin{DoxyItemize}
\item infos = Information about the template plugin is in keys below
\item infos/author = Author Name \href{mailto:elektra@libelektra.org}{\texttt{ elektra@libelektra.\+org}}
\item infos/licence = BSD
\item infos/needs =
\item infos/provides =
\item infos/recommends =
\item infos/placements = prerollback rollback postrollback getresolver pregetstorage getstorage procgetstorage postgetstorage setresolver presetstorage setstorage precommit commit postcommit
\item infos/status = recommended productive maintained reviewed conformant compatible coverage specific unittest shelltest tested nodep libc configurable final preview memleak experimental difficult unfinished old nodoc concept orphan obsolete discouraged -\/1000000
\item infos/metadata =
\item infos/description = one-\/line description of template
\end{DoxyItemize}\hypertarget{md_src_plugins_template_README_src_plugins_template_README_md}{}\doxysection{Introduction}\label{md_src_plugins_template_README_src_plugins_template_README_md}
Copy this template if you want to start a new plugin written in C.\hypertarget{md_src_plugins_template_README_autotoc_md564}{}\doxysection{Installation}\label{md_src_plugins_template_README_autotoc_md564}
See \mbox{\hyperlink{doc_INSTALL_md}{installation}}. The package is called {\ttfamily libelektra5-\/experimental}.\hypertarget{md_src_plugins_template_README_autotoc_md565}{}\doxysection{Usage}\label{md_src_plugins_template_README_autotoc_md565}
You can use {\ttfamily scripts/copy-\/template} to automatically rename everything to your plugin name\+:


\begin{DoxyCode}{0}
\DoxyCodeLine{cd src/plugins}
\DoxyCodeLine{../../scripts/copy-\/template yourplugin}

\end{DoxyCode}


Then update the {\ttfamily README.\+md} of your newly created plugin\+:


\begin{DoxyItemize}
\item enter your full name+email in {\ttfamily infos/author}
\item make sure {\ttfamily status}, {\ttfamily placements}, and other clauses conform to descriptions in {\ttfamily doc/\+CONTRACT.\+ini}
\item update the one-\/line description above
\item write an introduction what your plugin does
\item add your plugin in {\ttfamily src/plugins/\+README.\+md}
\item and rewrite the rest of this {\ttfamily README.\+md} to give a great explanation of what your plugin does
\end{DoxyItemize}\hypertarget{md_src_plugins_template_README_autotoc_md566}{}\doxysection{Plugin Configuration}\label{md_src_plugins_template_README_autotoc_md566}
None.\hypertarget{md_src_plugins_template_README_autotoc_md567}{}\doxysection{Dependencies}\label{md_src_plugins_template_README_autotoc_md567}
None.\hypertarget{md_src_plugins_template_README_autotoc_md568}{}\doxysection{Examples}\label{md_src_plugins_template_README_autotoc_md568}

\begin{DoxyCode}{0}
\DoxyCodeLine{\# Backup-\/and-\/Restore: user:/tests/template}
\DoxyCodeLine{}
\DoxyCodeLine{kdb set user:/tests/template/key value}
\DoxyCodeLine{\#> Create a new key user:/tests/template/key with string "{}value"{}}
\DoxyCodeLine{}
\DoxyCodeLine{kdb get /tests/template/key}
\DoxyCodeLine{\#> value}

\end{DoxyCode}
\hypertarget{md_src_plugins_template_README_autotoc_md569}{}\doxysection{Limitations}\label{md_src_plugins_template_README_autotoc_md569}
None. 