Skip to content

Latest commit

 

History

History
169 lines (95 loc) · 5.18 KB

README.pod

File metadata and controls

169 lines (95 loc) · 5.18 KB

NAME

tagit - program to maintain non-hierarchical (tag-oriented) information collection

SYNOPSIS

tagit tag file1 [file2...] --tags tag1 [tag2...] [--name name1 [name2...]] [--source source1 [source2...]] [--hash hash1 [hash2...]] [--file file1 [file2...]] [--ignore] [--copy]

tagit show [hash1 hash2...] [--tags tag1 [tag2...]] [--name name1 [name2...]] [--source source1 [source2...]] [--hash hash1 [hash2...]] [--file file1 [file2...]] [--ignore]

tagit list [tag1 tag2...] [--tags tag1 [tag2...]]

tagit taglist

tagit get [hash1 hash2...] [--tags tag1 [tag2...]] [--name name1 [name2...]] [--source source1 [source2...]] [--hash hash1 [hash2...]] [--file file1 [file2...]] [--ignore]

tagit export [hash1 hash2...] [--tags tag1 [tag2...]] [--name name1 [name2...]] [--source source1 [source2...]] [--hash hash1 [hash2...]] [--file file1 [file2...]] [--ignore]

tagit modify [hash1 hash2...] [--tags tag1 [tag2...]] [--name name1 [name2...]] [--source source1 [source2...]] [--hash hash1 [hash2...]] [--file file1 [file2...]] [--ignore] --set key1=[value1] [key2=[value2]...]

DESCRIPTION

Tagit created to organize any information pieces that you have - documents, bookmarks, saved web pages etc. All these objects are tagged, and you can easily select contect with needed tags. Also, this program saves not only meta-informaiton, but objects themselves. At tagging, all content is saved inside tagit data directory, from where can by easily retrieved. This allows you to use this program with minimal effort - you don't need to manage files by hands, just seed tagit with your content, and it will keep all information.

COMMANDS

tag

Imports given objects and tags them with given tags. You can add tags to already imported objects if you set --ignore flag. When importing files, tagit tries to create hardlink. This can be overridden by using --copy flag.

show

Shows different information about saved objects - their names, descriptions, tags, original source etc. Use appropriate flags to point what objects you need to show.

list

Lists objects that tagged with given tags. Tags are merged by "OR" rule (set union).

taglist

Shows all known tags

get

Creates symlinks to requested objects in current directory. If you given any tags, symlinks to all content of these tags will be created.

export

Identical to "get", but copies objects as files instead of symlink creation.

modify

Changes object's attributes. As usual, you have different way to select object to modify: by hash, name, source etc. Changed attributes must be given after --set switch, as key=value pairs. If object already have such attribute, value will be replaced to new. You cannot set attribute with empty value. If empty value wag given (for example, --set author=), suh attribute will be deleted.

OPTIONS

--tags (-t) tag [tag...]

Specifies one or several tags

--hash (-h) hash [hash...]

Every object internally identified by it's content hash (currently md5). This is only way to unambiguously point to objects. This switch allows you to give such hashes to point to objects you deal with. command "show" cah show you these hashes.

--name (-n) name [name...] Every object has a name. Several object can have identical names. It is set to some resonable default on initial import and can be modified with 'set' command (UNIMPLEMENTED). You can use this switch to point to ALL objects with given name.
--source (-s) source [source...]

For every object it's initial source is saved for file it is a full path in filesystem, for web content - URL. With this switch you can select objects with given source and do something with them. As with "--name", There can be several objects with some source!

--file (-f) file [file...]

Many commands can accept files. There are two main uses for the. First is obvious - 'tag' imports given file and saves information about it. If command operates with objects that are already imported, files used to compute hash and do semething with INTERNAL objects with this hash.

--copy (-c)

Requires to always copy imported file and do not try to create a hardlink to it

--set (-S)

Attributes to change or delete, given as key=value pairs. To delete attribute, set his value to empty string.

--ignore (-i)

Allows to ignore non-fatal errors like non-existent tags or hashes (program will just skip them) and allows to add tags to already imported files.

--output (-o) field [filed...]

Sets output format for 'show' and 'list' commands. Possible field values:

name

Object name

hash

Object hash

source

Object source - local path for file (where it was grabbed from), URL for web page

description

Object descrption. This field can be large (and, possible, in multiple lines)

attributes

Object's extended attributes

addtime

Time when object was addded to database