Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
..
Failed to load latest commit information.
docker
ffconfig
jenkins
randoop
vagrant
CMakeLists.txt
README.md
backup.in
benchmark-createtree
benchmark_augeas_hosts.sh
benchmark_libsplit.sh
build-debian-package
build-homepage
cbmc
change-resolver-symlink.in
change-storage-symlink.in
check-env-dep
complexity.rb
configure-common
configure-debian
configure-debian-debug
configure-debian-log
configure-debian-musl
configure-debian-optimizations
configure-debian-wheezy
configure-firefox.in
configure-home
configure-ini
configure-mingw-w64
configure-xdg
convert-fstab
convert-hosts
convert-inittab
convert-users
copy-template
draw-all-plugins
elektra-merge
elektra-mount
elektra-umount
elektrify-getenv.in
elektrify-open.in
example-xorg
filter-coverage.awk.in
find-tools
fix-spelling
generate-hashsums
generate-haskell-dependencies
generate-haskell-dependencies.hs
generate-news-entry
generate-seeds
git-checkout-ronn-files
git-release-stats
include-common
install-sh-completion.in
kdb-bash-completion
kdb-zsh-noglob
kdb.fish
kdb_zsh_completion
link-checker
list-tools.in
make-source-package.in
metaini-to-c
mount-augeas
mount-info
mount-kde
mount-list-all-files
mount-openicc
mountpoint-info
output-all-plugins
realpath
reformat-cmake
reformat-shfmt
reformat-source
restore
run_all
run_asan
run_check_release_notes
run_dev_env
run_icheck
run_memcheck
run_nokdbtests
sed
start-ssh-agent
stash
umount-all
untidy-source
update-infos-status
update-snippet-repository
upgrade-bootstrap
zsh

README.md

kdb-find-tools(1) -- The tool for finding tools

SYNOPSIS

kdb find-tools [-h] [--warnings] [--good] [--alltags] [-n NAME] [-a AUTHOR] [-d DATE] [-t TAGS [TAGS ...]] [-b BRIEF] [-e EXECUTE]

DESCRIPTION

If you are looking for a tool, then you have found the right tool to find tools! kdb find-tools provides search and list functionality for tools.

Just enter 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:

  1. Tag Search: Type kdb find-tools --alltags to get a list of all Tags in use. Then you can search with kdb -t [TAGS [TAGS ...]]

  2. Full Text Search:

    • kdb find-tools -n NAME to search for a script name.
    • kdb find-tools -b BRIEF to search for a short text.
    • kdb find-tools -a AUTHOR to search for a author.
    • kdb find-tools -d DATE to search for a creation date.
    • kdb find-tools -e EXECUTE to search for a type.

All methods can be combined. For example if you search all bash scripts which do some configuration work. You can type kdb find-tools -t configuration -e bash.

The right Way to add your script to the find tools

Meta Tags as comments in the beginning of a script are parsed. Mate Tags start with an @, here is a list of all Meta Tags:

MetaTag Meaning
@author Names and Emails (in <>) of the Authors as comma separated list
@brief A Short Description (One Line!)
@tags Comma Separated List of Tags, there is a list of common tags below
@date Date when the script was created, use DD.MM.YYYY as format

Do not mind the '' 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)!

Tags

List of Common Tags:

@tags Description
configure This script is used for the build configuration
convert This script is used convert things
generator This script is a generator
creator This script creates things
env This script does some env stuff
mount This script mounts things
reformat This script reformats things
debian Special script for debian system

If you choose to add a tag to the @tags then do not forget to add it in the tags map of the find-tools script and in the table here.

Example

\verbatim

    <Start of File>
    #!/usr/bin/bash
    #
    # @author Kurt Micheli <kurt.micheli@libelektra.org>
    # @brief This is a example
    # @date 01.06.2016
    # @tags configure, creator, arch

\endverbatim

Notes

The Metatag System of Epydoc is used (http://epydoc.sourceforge.net/manual-fields.html#module-metadata-variables) and extended with special tags.