<h1>The f-tools</h1>

The source tree contains a few test/demo apps which are named <tt>f-something</tt> (the "f" is for "fossil", of course).

   *  <tt>[/finfo?name=f-tag.c|f-tag]</tt> can add tags to artifacts.
   *  <tt>[/finfo?name=f-timeline.c|f-timeline]</tt> provides a simple timeline display.

These applications provide demonstrations of using the library and give devs a place to test new features. <tt>[/finfo?name=FossilApp.c|FossilApp.c]</tt> provides a mini-framework which takes care of bootstrapping fossil for these applications, making it pretty simple to create new ones. FossilApp handles the CLI parsing, global flags, opening of a repo/checkout, and other "getting started" bits.

Demos...
<h2>Demos</h2>

<nowiki><pre>
[stephan@host:~/cvs/fossil/f2]$ ./f-tag -a tip -t demo-tag -v "demo for prosperity purposes" --trace-sql 
SQL TRACE #1: SELECT '/home/stephan/cvs/fossil/f2' || '/' || value FROM vvar WHERE name='repository';
SQL TRACE #2: ATTACH DATABASE '/home/stephan/cvs/fossil/f2.fsl' AS repo;
SQL TRACE #3: SELECT julianday('now');
SQL TRACE #4: SELECT objid FROM event WHERE type='ci' ORDER BY event.mtime DESC LIMIT 1;

SQL TRACE #1: SELECT '/home/stephan/cvs/fossil/f2' || '/' || value FROM vvar WHERE name='repository';
SQL TRACE #2: ATTACH DATABASE '/home/stephan/cvs/fossil/f2.fsl' AS repo;
SQL TRACE #3: SELECT substr(uuid,1,12) AS uuid, <...BIG SNIP...> ORDER BY event.mtime DESC LIMIT 1;
g  [daa063582c2c] @ 2013-08-12 16:49:17 by [stephan]
	Edit [2a84ad39]: Add "demo-tag" with value "demo for prosperity purposes".
SQL TRACE #4: DETACH DATABASE repo;
</pre></nowiki>


<h2>f-tag</h2>

f-tag can be used to add and cancel tags on arbitrary repository artifacts. Tags in fossil are actually key/value pairs, but the value is optional. The ability to tag arbitrary artifacts, including other tags, allows (in principal) for applying arbitrary key/value-pair metadata to arbitrary artifacts. This can be used for a great many things above and beyond what fossil currently uses tags for. For example, tags could be used to implement a simple form of comment thread system, by implementing comments as tags, and replies as tags to those comment tags, ad nauseum.

Anyway... this tool is a very basic test/demonstration of this library which allows one to apply tags to artifacts. It allows some things the current fossil UI/CLI cannot make much sense of or do anything useful with (e.g. tags on tags or "cancel" tags with values), but nothing it does is incompatible with how fossil works internally.


<em>Forewarning</em>: changing branch tags, or other "fossil-special" tags (e.g. Wiki pages or tickets) with this tool is as yet untested and not yet really expected to work (it's an ongoing process). Try such things at your own risk. 

Examples of setting and cancelling flags:

<nowiki><pre>
# Change the color of a single commit:
# f-tag -a current -t bgcolor -v '#ffff33'

# Propagate the bg color starting at a commit:
# f-tag -a current -t '*bgcolor' -v '#ffff33'

# Cancel that color:
# f-tag -a current -t -bgcolor -v 'that was uglier than i thought it would be'
</pre></nowiki>

(Note that <tt>-bgcolor</tt> on the last example <em>looks</em> like an option/flag but it is not interpreted as one due to a happy accident of design.)

Values are always optional but Fossil internally treats some tag names specially and may require (or expect) a value. The <tt>bgcolor</tt> tag is one example. When cancelling a tag, the value is always optional, regardless of whether or not it is a special tag.

When adding a tag, the tag name may optionally be prefixed with a <tt>+</tt> sign, for symmetry with the cancel (<tt>-</tt>) and propagate (<tt>*</tt>) markers. When using propagating tags, it is wise to enclose the tag in quotes to prevent any unwanted side-effects of globbing.

Note that the +/-/* prefixes were chosen because they reflect how Fossil internally stores and recognizes the type of a tag: + is an "add tag", - is a "cancel tag" (a.k.a. "antitag"), and * is a propagating tag.