# tcltags(3f)

[Home] [Commands] [Variables] [Macro-Dev] [Glossary]

## NAME

tcltags - Generate a Tcl/Tk tags file

## SYNOPSIS

me "@tcltags" <files>

## DESCRIPTION

The start-up file `tcltags.emf` may be invoked from the command line to generate a tags file for Tcl/Tk files.

Given a list of files a tags file `tags` is generated in the current directory, which may be used by the find-tag(2) command. If no files are specified the default file list is "`./`", i.e. process the current directory. If a directory name is given (such as the default "`./`") all Tcl/Tk files within the directory will be processed.

The value of variable %tag-option is used to control the tag generation process, its value <flags> can contain any number of the following flags:

`a`

Append new tags to the existing tag file, note that if also using flag '`m`' multiple 'tags' to the same item may be created.

`m`

Enable multiple tags. This enables the existence of 2 tags with the same tag name, but typically with different locations. See help on find-tag(2) for more information on multiple tag support.

`r`

Enables recursive mode, any sub-directory found within any given directories will also be processed.

## NOTES

This function is invoked from menu

Tools -> Tcl Tools -> Create Tags File

when the user requests a tags file to be generated.

The following variables are set within "`tcltags.emf`" and are used to control the process:-

%tag-option

Tags options flag, default value is "". See above for more information.

%tag-filemask

A list of source file masks to be processed when a directory is given, default value is "`:*.tcl:*.tk:`".

%tag-ignoredir

A list of directories to be ignored when recursive option is used, default value is "`:SCCS/:CVS/:`".

These variables can be changed using the -v command-line option or via the "`mytcltags.emf`" file

## SEE ALSO

find-tag(2), start-up(3), tcl(9).

(c) Copyright JASSPA 2009
Last Modified: 2009/08/29
Generated On: 2009/10/12

</HMTL>