King_DuckZ/dindexer
1
0
Fork 0
mirror of https://github.com/KingDuckZ/dindexer.git synced 2025-08-06 13:19:47 +00:00
Code Issues Releases Wiki Activity

List of libraries and commands

King_DuckZ 2016-07-08 12:42:44 +01:00
parent 2364a377fa
commit 8b1a701b28
1 changed files with 17 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

17
Program-structure.md Normal file

@ -0,0 +1,17 @@
# Components
## Overview
This is the list of libraries in alphabetical order that make up dinder:
* **common** common functionalities shared among the CLI programs and specific to them
* **machinery** the core functionalities of dindexer, which are needed if you are implementing a different frontend
* **main** the main command line program that is used by the end user - it simply execs the requested command
* **pq** wrapper around PostgreSQL C library, providing access to the features used by dindexer
* **helpers** header-only library with generic code and no dependencies on other components
Commands are listed separately for clarity:
* **delete** deletes content from the database
* **locate** perform searches into the database
* **navigate** navigate through the database similarly to how you would in bash
* **scan** scan and store a directory into the database
* **tag** tag or untag content in the database