Code Docs

Libraries

Each library helps to untangle the code by grouping similar functions and reducing dependencies.

The goal is that each library is:

• Self-contained (it may rely on other libraries)
• Independently testable (i.e. without using NeoMutt)
• Fully documented
• Robust

Miscellaneous files

These file form the main body of NeoMutt.

File	Description
editmsg.c	Prepare an email to be edited
external.c	Manage where the email is piped to external commands
flags.c	Manipulate the flags in an email header
globals.c	Global variables
help.c	Generate the help-page and GUI display it
main.c	Command line processing
module.c	Definition of the Main Module
monitor.c	Monitor files for changes
muttlib.c	Some miscellaneous functions
mutt_config.c	Definitions of config variables
mutt_logging.c	NeoMutt Logging
mutt_mailbox.c	Mailbox helper functions
mutt_signal.c	Signal handling
mutt_socket.c	NeoMutt connections
mx.c	Mailbox multiplexor
system.c	Execute external programs
usage.c	Display Usage Information for NeoMutt
version.c	Display version and copyright about NeoMutt

Building these Docs

The config for building the docs is in the main source repo.

Everything possible is turned on in the config file, so you'll need to install a few dependencies like dot from the graphviz package.

Installing the Docs

These docs aren't in the main website repo – they weigh in at 100MB. Instead, they're stored in the code repo