idossier.1 - dossier - console collection manager Err bitreich.org 70 1Log /scm/dossier/log.gph bitreich.org 70 1Files /scm/dossier/files.gph bitreich.org 70 1Refs /scm/dossier/refs.gph bitreich.org 70 1Tags /scm/dossier/tag bitreich.org 70 1README /scm/dossier/file/README.gph bitreich.org 70 1LICENSE /scm/dossier/file/LICENSE.gph bitreich.org 70 i--- Err bitreich.org 70 idossier.1 (4709B) Err bitreich.org 70 i--- Err bitreich.org 70 i 1 .Dd $Mdocdate: July 18 2018 $ Err bitreich.org 70 i 2 .Dt DOSSIER 1 Err bitreich.org 70 i 3 .Os Err bitreich.org 70 i 4 .Sh NAME Err bitreich.org 70 i 5 .Nm dossier Err bitreich.org 70 i 6 .Nd a console collection manager Err bitreich.org 70 i 7 .Sh SYNOPSIS Err bitreich.org 70 i 8 .Nm Err bitreich.org 70 i 9 .Op Cm show | Cm import Ar file | Cm help | Cm export | Cm collections | Cm rm | Cm search | Ar item Op attribute value Err bitreich.org 70 i 10 .Nm Err bitreich.org 70 i 11 .Ar item Op attribute value Op item attribute value Op item attribute value Err bitreich.org 70 i 12 .Sh DESCRIPTION Err bitreich.org 70 i 13 .Pp Err bitreich.org 70 i 14 .Nm Err bitreich.org 70 i 15 is a tool to register "items" into collections with metadata. Allowing to Err bitreich.org 70 i 16 keep tracks of collections like wine, tea, video games, movie, music etc... Err bitreich.org 70 i 17 .Pp Err bitreich.org 70 i 18 Collections are a set of items, attributes and values. Err bitreich.org 70 i 19 .Nm Err bitreich.org 70 i 20 allows to manage different collections to not mix everything. Err bitreich.org 70 i 21 .Bl -tag -width Ds Err bitreich.org 70 i 22 .It Nm Cm help Err bitreich.org 70 i 23 Show help Err bitreich.org 70 i 24 .It Nm Cm show Oo Cm attributes Oc Op item-name Err bitreich.org 70 i 25 the command Err bitreich.org 70 i 26 .Cm show Err bitreich.org 70 i 27 without argument will display the list of items in the current collection. Err bitreich.org 70 i 28 .Pp Err bitreich.org 70 i 29 With the argument Err bitreich.org 70 i 30 .Cm attributes Err bitreich.org 70 i 31 it will show the list of known attributes and possibles values currently in use. Err bitreich.org 70 i 32 .Pp Err bitreich.org 70 i 33 With the argument Err bitreich.org 70 i 34 .Ar item-name Err bitreich.org 70 i 35 it will show all the attributes known for that item. Err bitreich.org 70 i 36 .It Nm Cm rm Ar item-name Err bitreich.org 70 i 37 Remove item Err bitreich.org 70 i 38 .Ar item-name Err bitreich.org 70 i 39 from the collection. Err bitreich.org 70 i 40 .It Nm Cm export Err bitreich.org 70 i 41 Export the data of the current collection as CSV (Comma Separated Values). Err bitreich.org 70 i 42 Newlines in values are modified into space character, this is so to ease Err bitreich.org 70 i 43 processing the output with line-based tools such as awk or sed. Err bitreich.org 70 i 44 .Pp Err bitreich.org 70 i 45 If you need to write an export tool, see Err bitreich.org 70 i 46 .Sx INTERNALS Err bitreich.org 70 i 47 .It Nm Cm import Ar file Err bitreich.org 70 i 48 Import the data from Err bitreich.org 70 i 49 .Ar file Err bitreich.org 70 i 50 using the exact same format as the export (no newline in a field, fields name in Err bitreich.org 70 i 51 the first line, values with spaces should be quoted). This is very useful for a Err bitreich.org 70 i 52 batch import or if you want to export the data to a spreadsheet tool to Err bitreich.org 70 i 53 manipulate the values and then importing back. Err bitreich.org 70 i 54 .Pp Err bitreich.org 70 i 55 The import functions internally calls Err bitreich.org 70 i 56 .Nm Err bitreich.org 70 i 57 for each line to set each attributes of each identifier, it's a long and verbose process. Err bitreich.org 70 i 58 .Pp Err bitreich.org 70 i 59 A Err bitreich.org 70 i 60 .Xr git 1 Err bitreich.org 70 i 61 tag is created before starting the import to ease the process of undoing changes Err bitreich.org 70 i 62 if the import does not produce the expected result. Err bitreich.org 70 i 63 .It Nm Cm collections Oo collection Oc | Oo register Pa full-path Ar collection-name Oc Err bitreich.org 70 i 64 the command Err bitreich.org 70 i 65 .Cm collections Err bitreich.org 70 i 66 with no argument will show the list of collections that Err bitreich.org 70 i 67 .Nm Err bitreich.org 70 i 68 is aware of aka the collections that have been registered. The collection currently in use Err bitreich.org 70 i 69 will be displayed with a Err bitreich.org 70 i 70 .Sy * Err bitreich.org 70 i 71 symbol after the name. Err bitreich.org 70 i 72 .Pp Err bitreich.org 70 i 73 the command Err bitreich.org 70 i 74 .Cm collections Err bitreich.org 70 i 75 with one parameter Err bitreich.org 70 i 76 will switch the current collection in use to the collection Err bitreich.org 70 i 77 .Ar collection. Err bitreich.org 70 i 78 .Pp Err bitreich.org 70 i 79 the command Err bitreich.org 70 i 80 .Cm collections Err bitreich.org 70 i 81 using the parameter Err bitreich.org 70 i 82 .Ar register Err bitreich.org 70 i 83 will make Err bitreich.org 70 i 84 .Nm Err bitreich.org 70 i 85 aware of a collection, this requires the full path Err bitreich.org 70 i 86 .Ar full-path Err bitreich.org 70 i 87 where is stored the collection and a name Err bitreich.org 70 i 88 .Ar collection-name Err bitreich.org 70 i 89 to identify it. When a collection is registered, Err bitreich.org 70 i 90 .Nm Err bitreich.org 70 i 91 will initialize a Err bitreich.org 70 i 92 .Xr git 1 Err bitreich.org 70 i 93 repository in it if possible. Err bitreich.org 70 i 94 .It Nm Cm search Oo attribute Oo value Oc Oc Op attribute value Err bitreich.org 70 i 95 the command Err bitreich.org 70 i 96 .Cm search Err bitreich.org 70 i 97 with no argument will return the list of known attributes in the collections Err bitreich.org 70 i 98 with the number of items for which the attribute is set. Err bitreich.org 70 i 99 .Pp Err bitreich.org 70 i 100 the command Err bitreich.org 70 i 101 .Nm search Err bitreich.org 70 i 102 with one parameter will return the list of the items for which Err bitreich.org 70 i 103 .Ar attribute Err bitreich.org 70 i 104 has been recorded and the associated value, using a semi colon as separator. Err bitreich.org 70 i 105 .Pp Err bitreich.org 70 i 106 The command Err bitreich.org 70 i 107 .Nm search Err bitreich.org 70 i 108 with two parameters will return the list of the items having the value Err bitreich.org 70 i 109 .Ar value Err bitreich.org 70 i 110 in the attribute Err bitreich.org 70 i 111 .Ar attribute. Err bitreich.org 70 i 112 .Pp Err bitreich.org 70 i 113 Using more arguments will return the list of the items matching all the Err bitreich.org 70 i 114 conditions of values in attributes. Err bitreich.org 70 i 115 .Pp Err bitreich.org 70 i 116 Adding an exclamation mark character at the start of an attribute name like Err bitreich.org 70 i 117 .Ar !attribute Err bitreich.org 70 i 118 will return results not matching Err bitreich.org 70 i 119 .Ar value. Err bitreich.org 70 i 120 .It Nm Ar item-name Err bitreich.org 70 i 121 shows all the attributes known for that item. Err bitreich.org 70 i 122 .Pp Err bitreich.org 70 i 123 In case you need to use an Err bitreich.org 70 i 124 .Ar item-name Err bitreich.org 70 i 125 like "collections" or any other name being a Err bitreich.org 70 i 126 .Nm Err bitreich.org 70 i 127 command, the command Err bitreich.org 70 i 128 .Cm show Ar item-name Err bitreich.org 70 i 129 is required. Err bitreich.org 70 i 130 .It Nm Ar item-name Ar attribute Ar value Op Ar attribute2 Ar value2 Ar ... Err bitreich.org 70 i 131 Associate the value Err bitreich.org 70 i 132 .Ar value Err bitreich.org 70 i 133 to the attribute Err bitreich.org 70 i 134 .Ar attribute Err bitreich.org 70 i 135 for item Err bitreich.org 70 i 136 .Ar item-name. Err bitreich.org 70 i 137 Multiples couple of Err bitreich.org 70 i 138 .Ar attribute value Err bitreich.org 70 i 139 can be used on the same command line to define multiples values. Err bitreich.org 70 i 140 .Pp Err bitreich.org 70 i 141 This is the way to add and update data inside a collection. Err bitreich.org 70 i 142 .Pp Err bitreich.org 70 i 143 Every modification is recorded with Err bitreich.org 70 i 144 .Xr git 1 . Err bitreich.org 70 i 145 Err bitreich.org 70 i 146 .Sh FILES Err bitreich.org 70 i 147 .Bl -tag -width "~/.collections" -compact Err bitreich.org 70 i 148 .It Pa ~/.collections Err bitreich.org 70 i 149 The directory where Err bitreich.org 70 i 150 .Nm Err bitreich.org 70 i 151 stores the collections registered as symlinks to their full path. Err bitreich.org 70 i 152 .Sh EXIT Err bitreich.org 70 i 153 .Ex -std dossier Err bitreich.org 70 i 154 .Sh SEE ALSO Err bitreich.org 70 i 155 .Xr git 1 Err bitreich.org 70 i 156 .Sh Internals Err bitreich.org 70 i 157 Informations are stored using plain text files using a specific hierarchy inside Err bitreich.org 70 i 158 the collection repertory. Each attribute is designed by the folder containing Err bitreich.org 70 i 159 the files. Each file is named after the identifier to store its value. Err bitreich.org 70 i 160 .Sh Authors Err bitreich.org 70 i 161 .An -nosplit Err bitreich.org 70 i 162 The Err bitreich.org 70 i 163 .Nm Err bitreich.org 70 i 164 program was written by Err bitreich.org 70 i 165 .An Solène Rapenne Aq Mt solene@perso.pw Err bitreich.org 70 .