ntags(3f)

NAME

ntags - Generate a nroff tags file

SYNOPSIS

me "@ntags" <files>

DESCRIPTION

The start-up file ntags.emf may be invoked from the command line to generate a tags file for nroff 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 nroff 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 -> Nroff Tools -> Create Tags File

when the user requests a tags file to be generated.

The tags are generated from the nroff macro:-

.XI <name> ...... 

which indicates an index entry, where <name> is the tag name. <name> may be delimited by double quotes if any whitespace is present in the string.

This is the macro definition used in the MicroEmacs documentation system. The ntags.emf file should be edited and shadowed in the user directory if some other search criteria is used for nroff files. This macro file should provide a good starting point for any other search.

The user setup file "myntags.emf" is executed by ntags during start-up, this file can be used to over-ride any of the ntags configuration variables (see below).

The following variables are set within "ntags.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 ":*.nrs:*.[1-9]:*.n:".

%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 "myntags.emf" file

SEE ALSO

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

(c) Copyright JASSPA 1999
Last Modified: 1999/11/09
Generated On: 1999/12/01