\label{doc_help_kdb-find-tools_md_md_doc_help_kdb_find_tools}%
\Hypertarget{doc_help_kdb-find-tools_md_md_doc_help_kdb_find_tools}%
 \hypertarget{doc_help_kdb-find-tools_md_autotoc_md2917}{}\doxysection{SYNOPSIS}\label{doc_help_kdb-find-tools_md_autotoc_md2917}

\begin{DoxyCode}{0}
\DoxyCodeLine{kdb find-\/tools [-\/h] [-\/-\/warnings] [-\/-\/good] [-\/-\/alltags] [-\/n NAME] [-\/a AUTHOR] [-\/d DATE]}
\DoxyCodeLine{               [-\/t TAGS [TAGS ...]] [-\/b BRIEF] [-\/e EXECUTE]}

\end{DoxyCode}
\hypertarget{doc_help_kdb-find-tools_md_autotoc_md2918}{}\doxysection{DESCRIPTION}\label{doc_help_kdb-find-tools_md_autotoc_md2918}
If you are looking for a tool, then you have found the right tool to find tools! {\ttfamily kdb find-\/tools} provides search and list functionality for tools.

Just enter {\ttfamily kdb find-\/tools} to get a list of names, type and short description of all available tools.

If you are looking for something special, then there are two ways\+:


\begin{DoxyEnumerate}
\item Tag Search\+: Type {\ttfamily kdb find-\/tools -\/-\/alltags} to get a list of all Tags in use. Then you can search with {\ttfamily kdb -\/t \mbox{[}TAGS \mbox{[}TAGS ...\mbox{]}\mbox{]}}
\item Full Text Search\+:
\begin{DoxyItemize}
\item {\ttfamily kdb find-\/tools -\/n NAME} to search for a script name.
\item {\ttfamily kdb find-\/tools -\/b BRIEF} to search for a short text.
\item {\ttfamily kdb find-\/tools -\/a AUTHOR} to search for an author.
\item {\ttfamily kdb find-\/tools -\/d DATE} to search for a creation date.
\item {\ttfamily kdb find-\/tools -\/e EXECUTE} to search for a type.
\end{DoxyItemize}
\end{DoxyEnumerate}

All methods can be combined. For example if you search all bash scripts which do some configuration work. You can type {\ttfamily kdb find-\/tools -\/t configuration -\/e bash}.\hypertarget{doc_help_kdb-find-tools_md_autotoc_md2919}{}\doxysection{The Right Way to Add Your Script to the Find Tools}\label{doc_help_kdb-find-tools_md_autotoc_md2919}
Meta Tags as comments in the beginning of a script are parsed. Mate Tags start with an {\ttfamily @}, here is a list of all Meta Tags\+:

\tabulinesep=1mm
\begin{longtabu}spread 0pt [c]{*{2}{|X[-1]}|}
\hline
\PBS\centering \cellcolor{\tableheadbgcolor}\textbf{ Meta\+Tag   }&\PBS\centering \cellcolor{\tableheadbgcolor}\textbf{ Meaning    }\\\cline{1-2}
\endfirsthead
\hline
\endfoot
\hline
\PBS\centering \cellcolor{\tableheadbgcolor}\textbf{ Meta\+Tag   }&\PBS\centering \cellcolor{\tableheadbgcolor}\textbf{ Meaning    }\\\cline{1-2}
\endhead
@author   &Names and Emails (in $<$$>$) of the Authors as comma separated list    \\\cline{1-2}
@brief   &A Short Description (One Line!)    \\\cline{1-2}
@tags   &Comma Separated List of Tags    \\\cline{1-2}
@date   &Date when the script was created, use DD.\+MM.\+YYYY as format   \\\cline{1-2}
\end{longtabu}


Do not mind the \textquotesingle{}\textbackslash{}\textquotesingle{} at the beginning it is a doxygen escaping.

Beware, that these metatags should be applied at the beginning of the file (in the first 10 rows)!\hypertarget{doc_help_kdb-find-tools_md_autotoc_md2920}{}\doxysection{Example}\label{doc_help_kdb-find-tools_md_autotoc_md2920}

\begin{DoxyCode}{0}
\DoxyCodeLine{\#!/bin/sh}
\DoxyCodeLine{\#}
\DoxyCodeLine{\# @author Kurt Micheli <kurt.micheli@libelektra.org>}
\DoxyCodeLine{\# @brief This is an example of a build script}
\DoxyCodeLine{\# @date 31.10.2018}
\DoxyCodeLine{\# @tags configure, build}

\end{DoxyCode}
\hypertarget{doc_help_kdb-find-tools_md_autotoc_md2921}{}\doxysection{Notes}\label{doc_help_kdb-find-tools_md_autotoc_md2921}
The Metatag System of Epydoc is used (\href{http://epydoc.sourceforge.net/manual-fields.html\#module-metadata-variables}{\texttt{ http\+://epydoc.\+sourceforge.\+net/manual-\/fields.\+html\#module-\/metadata-\/variables}}) and extended with special tags. 