tags(3erl)

🌸 NAME 🌸

okay bestie, meet tags — from the Erlang module definition page (tags(3erl)), and its whole job is generating an Emacs TAGS file from Erlang source files. it’s giving “definition index but make it cute,” and honestly? iconic. 💅

---

✨ DESCRIPTION ✨

so a TAGS file is what Emacs uses to find function and variable definitions in any source file in large projects. this module can generate a TAGS file from Erlang source files, and it recognises functions, records, and macro definitions. periodt. 💖

---

🛠️ EXPORTS 🛠️

here’s the whole roster, no skips, fr fr:

💅 file(File) -> ok | error / file(File, Options) -> ok | error

file(File) -> ok | error
file(File, Options) -> ok | error

types:

File = file:filename()
Options = [option()]
option() =
    {outfile, NameOfTAGSFile :: file:filename()} |
    {outdir, NameOfDirectory :: file:filename()}

creates a TAGS file for the file File. slay. ✨

🎀 files(FileList) -> ok | error / files(FileList, Options) -> ok | error

files(FileList) -> ok | error
files(FileList, Options) -> ok | error

types:

FileList = [file:filename()]
Options = [option()]
option() =
    {outfile, NameOfTAGSFile :: file:filename()} |
    {outdir, NameOfDirectory :: file:filename()}

creates a TAGS file for the files in the list FileList. very “batch process my beloveds.” 💖

🦋 dir(Dir) -> ok | error / dir(Dir, Options) -> ok | error

dir(Dir) -> ok | error
dir(Dir, Options) -> ok | error

types:

Dir = file:filename()
Options = [option()]
option() =
    {outfile, NameOfTAGSFile :: file:filename()} |
    {outdir, NameOfDirectory :: file:filename()}

creates a TAGS file for all files in directory Dir. yes bestie, the whole directory. no crumbs. 💅

🌈 dirs(DirList) -> ok | error / dirs(DirList, Options) -> ok | error

dirs(DirList) -> ok | error
dirs(DirList, Options) -> ok | error

types:

DirList = [file:filename()]
Options = [option()]
option() =
    {outfile, NameOfTAGSFile :: file:filename()} |
    {outdir, NameOfDirectory :: file:filename()}

creates a TAGS file for all files in any directory in DirList. multi-directory main character energy. 👑

🧚 subdir(Dir) -> ok | error / subdir(Dir, Options) -> ok | error

subdir(Dir) -> ok | error
subdir(Dir, Options) -> ok | error

types:

Dir = file:filename()
Options = [option()]
option() =
    {outfile, NameOfTAGSFile :: file:filename()} |
    {outdir, NameOfDirectory :: file:filename()}

descends recursively down the directory Dir and creates a TAGS file based on all files found. it’s going deep, bestie. 🌀

🍓 subdirs(DirList) -> ok | error / subdirs(DirList, Options) -> ok | error

subdirs(DirList) -> ok | error
subdirs(DirList, Options) -> ok | error

types:

DirList = [file:filename()]
Options = [option()]
option() =
    {outfile, NameOfTAGSFile :: file:filename()} |
    {outdir, NameOfDirectory :: file:filename()}

descends recursively down all the directories in DirList and creates a TAGS file based on all files found. recursive queen behavior. 💖

⭐ root() -> ok | error / root(Options) -> ok | error

root() -> ok | error
root(Options) -> ok | error

types:

Options = [option()]
option() =
    {outfile, NameOfTAGSFile :: file:filename()} |
    {outdir, NameOfDirectory :: file:filename()}

creates a TAGS file covering all files in the Erlang distribution. like, the whole entire Erlang distribution. no cap. 🌍

---

💖 OPTIONS 💖

the functions above have an optional argument, Options. it’s a list, and it can contain these little cuties:

• {outfile, NameOfTAGSFile} — create a TAGS file named NameOfTAGSFile. 🎀
• {outdir, NameOfDirectory} — create a file named TAGS in the directory NameOfDirectory. ✨

the default behaviour is to create a file named TAGS in the current directory. lowkey convenient, highkey iconic. 💅

---

🎉 EXAMPLES 🎉

• tags:root([{outfile, "root.TAGS"}]).

this command will create a file named root.TAGS in the current directory. the file will contain references to all Erlang source files in the Erlang distribution. go off, root. 🌈

• tags:files(["foo.erl", "bar.erl", "baz.erl"], [{outdir, "../projectdir"}]).

here we create a file named TAGS and place it in the directory ../projectdir. the file contains information about the functions, records, and macro definitions of the three files. three-file friend group, slay. 🫶

---

👀 SEE ALSO 👀

• Richard M. Stallman. GNU Emacs Manual, chapter "Editing Programs", section "Tag Tables". Free Software Foundation, 1995.
• Anders Lindgren. The Erlang editing mode for Emacs. Ericsson, 1998.

---

xoxo, sign-off from Ericsson AB 💖 version tools 3.5.3 💖 manual tags(3erl). that’s the whole page, bestie — now go make Emacs proud. 🎀✨