File: README

package info (click to toggle)
treil 1.8-2.1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 1,552 kB
  • ctags: 206
  • sloc: sh: 8,849; ruby: 695; ansic: 564; makefile: 60
file content (64 lines) | stat: -rw-r--r-- 1,653 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
* What's this?

treil is a utility which produces an image of tiles from a tree
structure.  Each node of the tree is mapped to a rectangle whose
dimension is calculated from the node value.  The primary use of treil
is to display directory trees under version control.

The name "treil" is the result of the following Ruby expression.
("tree" + "tile").split(//).uniq.join

* Requirements

- Ruby 1.8 or later
	http://www.ruby-lang.org

While the libraries listed below are optional, either rcairo or
Ruby/GD is required.

- rcairo (optional)
	http://cairographics.org/rcairo
- Ruby/GD (optional)
	http://raa.ruby-lang.org/project/ruby-gd/
- htree (optional)
	http://cvs.m17n.org/~akr/htree/

- CVS (optional)
	http://ximbiot.com/cvs/
- Subversion (optional)
	http://subversion.tigris.org
- git (optional)
	http://kernel.org/pub/software/scm/git/
- Mercurial (optional)
	http://www.selenic.com/mercurial/

* Installation

 $ sudo apt-get install ruby1.8-dev libgd-ruby1.8 libcairo-ruby1.8 libhtree-ruby1.8
 $ ./configure
 $ make
 $ sudo make install

* Usage

** Input from an ordinary directory

 $ treil /usr/src/linux linux.png

** Input from a Subversion working copy

 $ svn co http://svn.python.org/projects/python/trunk python
 $ treil python python.png # This produces colorful output.

* Copyright

Copyright (C) 2006,2007 Daiki Ueno <ueno@unixuser.org>

* Acknowledgement

The layout algorithm is equivalent to the following paper.

Bederson, B.B., Shneiderman, B., and Wattenberg, M., "Ordered and
Quantum Treemaps: Making Effective Use of 2D Space to Display
Hierarchies", ACM Transactions on Graphics (TOG), 21, (4), October
2002, 833-854.