complete man page - dossier - console collection manager
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) Tags
(DIR) README
(DIR) LICENSE
---
(DIR) commit 8b28edf4c3948bdccc843471c826bfd6da0bd989
(DIR) parent 947da0780fdbb7c087d39fcf7dba25de32b91c50
(HTM) Author: Solene Rapenne <solene@perso.pw>
Date: Sat, 21 Jul 2018 00:38:39 +0200
complete man page
Diffstat:
M cdb.1 | 103 ++++++++++++++++++++++++++++---
1 file changed, 93 insertions(+), 10 deletions(-)
---
(DIR) diff --git a/cdb.1 b/cdb.1
@@ -5,28 +5,111 @@
.Nm cdb
.Nd a console collection manager
.Sh SYNOPSIS
+.Nm
+.Op Cm show | Cm help | Cm export | Cm collections | Cm search | Ar item attribute value
.Sh DESCRIPTION
+.Pp
.Nm
-is a tool to register "items" into collections with metadata.
+is a tool to register "items" into collections with metadata. Allowing to
+keep tracks of collections like wine, tea, video games, movie, music etc...
+.Pp
+Collections are a set of items, attributes and values.
+.Nm
+allows to manage different collections to not mix everything.
.Bl -tag -width Ds
.It Nm Cm help
Show help
.It Nm Cm show Op item-name
-show item
+the command
+.Cm show
+without argument will display the list of items in the current collection.
+.Pp
+With the argument
+.Ar item-name
+it will show all the attributes known for that item.
.It Nm Cm export
-Export as CSV
+Export the data of the current collection as CSV (Comma Separated Values).
.It Nm Cm collections Oo register Pa full-path Ar collection-name Oc | Op use Ar collection
-manage collections
-.It Nm Cm search Oo register Pa full-path Ar collection-name Oc | Op use Ar collection
-make search
+the command
+.Cm collections
+with no argument will show the list of collections that
+.Nm
+is aware of aka the collections that have been registered. The collection currently in use
+will be displayed with a
+.Sy *
+symbol after the name.
+.Pp
+the command
+.Cm collections
+using the parameter
+.Ar register
+will make
+.Nm
+aware of a collection, this requires the full path
+.Ar full-path
+where is stored the collection and a name
+.Ar collection-name
+to identify it. When a collection is registered,
+.Nm
+will initialize a
+.Xr git 1
+repository in it if possible.
+.Pp
+the command
+.Cm collections
+with the parameter
+.Ar use
+will switch the current collection in use to the collection
+.Ar collection.
+.It Nm Cm search Oo attribute Oo value Oc Oc Op attribute value
+the command
+.Cm search
+with no argument will return the list of known attributes in the collections with the
+number of items for which the attribute is set.
+.Pp
+the command
+.Nm search
+with one parameter will return the list of the items for which
+.Ar attribute
+has been recorded and the associated value, using a semi colon as separator.
+.Pp
+The command
+.Nm search
+with two parameters will return the list of the items having the value
+.Ar value
+in the attribute
+.Ar attribute.
+.Pp
+Using more arguments will return the list of the items matching all the conditions of values in attributes.
.It Nm Ar item-name Ar attribute Ar value Op Ar attribute2 Ar value2 Ar ...
-Assign
+Associate the value
.Ar value
-to
+to the attribute
.Ar attribute
-for
+for item
.Ar item-name.
-Multiples sequences of
+Multiples couple of
.Ar attribute value
can be used on the same command line to define multiples values.
.Pp
+This is the way to add and update data inside a collection.
+.Pp
+Every modification is recorded with
+.Xr git 1.
+
+.Sh FILES
+.Bl -tag -width "~/.collections" -compact
+.It Pa ~/.collections
+The directory where
+.Nm
+stores the collections registered as symlinks to their full path.
+.Sh EXIT
+.Ex -std notes
+.Sh SEE ALSO
+.Xr git 1
+.Sh Authors
+.An -nosplit
+The
+.Nm
+program was written by
+.An Solène Rapenne Aq Mt solene@perso.pw