[ Main Table Of Contents | Table Of Contents | Keyword Index ]

famfamfam_install_guide(n) 1 doc "FamFamFam Icon Sets For Tcl"


famfamfam_install_guide - FamFamFam - The Installer's Guide

Table Of Contents


  • package require Tk 8.5
  • package require Tcl 8.5
  • package require img::png
  • package require famfamfam ?1.1?


Welcome to famfamfam, a set of packages providing access to the same-named icon sets created by Mark James, at http://www.famfamfam.com/lab/icons/

The audience of this document is anyone wishing to build the packages, for either themselves, or others.

For a developer intending to extend or modify the packages we additionally provide

  1. FamFamFam - The Developer's Guide.

Please read FamFamFam - How To Get The Sources first, if that was not done already. Here we assume that the sources are already available in a directory of your choice.



A working Tcl installation is needed, however as we are building a Tcl package that should be pretty much obvious, and I will not belabor the point.

Use whatever you are comfortable with, as long as it provides Tcl 8.5, or higher, Tk 8.5 or higher, and the img::png package, a part of TkImg.

An easy way to get an installation of a recent Tcl 8.5 and the mentioned packages, which I recommend, is to download and install ActiveState's ActiveTcl for your platform. Follow the link for ActiveTcl to find it.

After the installation of ActiveTcl 8.5 in a directory of your choice run the command

    teacup update

This will install a lot more packages than found in the distribution alone. (Disclosure: I, Andreas Kupries, work for ActiveState, maintaining ActiveTcl and TclDevKit).

For those wishing to build either Tcl/Tk and/or TkImg on their own, these can found at







Build & Installation

To install FamFamFam simply run

    /path/to/tclsh8.5 /path/to/famfamfam/build.tcl install

where "/path/to/tclsh8.5" is the tclsh of your Tcl installation, and "/path/to/famfamfam" the location of the FamFamFam sources on your system.

This builds all packages and then places them in a directory where the tclsh8.5 will find them.

On Windows you can invoke the file "build.tcl" with a double-click. This will pop up a small graphical interface for entering the destination and performing the installation. This handling of a double-click is restricted to Windows only however.

On unix the same GUI is acessible by invoking "build.tcl" without any arguments.

To get help about the methods of "build.tcl", and their complete syntax, invoke "build.tcl" with argument help, i.e., like

    /path/to/tclsh8.5 /path/to/famfamfam/build.tcl help

Bugs, Ideas, Feedback

This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such at the FamFamFam Tcl Tracker. Please also report any ideas for enhancements you may have for either package and/or documentation.


famfamfam, icons, images


Icon sets