1neomutt(1) User Manuals neomutt(1)
2
6 neomutt - The NeoMutt Mail User Agent (MUA)
7
9 neomutt [-Enx] [-e command] [-F config] [-H draft] [-i include]
10 [-b address] [-c address] [-s subject] [-a file [...] --]
11 address [...]
12 neomutt [-nx] [-e command] [-F config] [-b address] [-c address]
14 [-s subject] [-a file [...] --] address [...] < message
15 neomutt [-nRy] [-e command] [-F config] [-f mailbox] [-m type]
17 neomutt [-n] [-e command] [-F config] -A alias
19 neomutt [-n] [-e command] [-F config] -B
21 neomutt [-n] [-e command] [-F config] -D [-S] [-O]
23 neomutt [-n] [-e command] [-F config] -d level -l file
25 neomutt [-n] [-e command] [-F config] -G
27 neomutt [-n] [-e command] [-F config] -g server
29 neomutt [-n] [-e command] [-F config] -p
31 neomutt [-n] [-e command] [-F config] -Q variable [-O]
33 neomutt [-n] [-e command] [-F config] -Z
35 neomutt [-n] [-e command] [-F config] -z [-f mailbox]
37 neomutt -v[v]
39
41 NeoMutt is a small but very powerful text based program for reading and
42 sending electronic mail under Unix operating systems, including support
43 for color terminals, MIME, OpenPGP, and a threaded sorting mode.
44 Note: This manual page gives a brief overview of NeoMutt's command line
46 options. You should find a copy of the full manual in
47 /usr/share/doc/neomutt, in plain text, HTML, and/or PDF format.
48
50 -- Special argument forces NeoMutt to stop option parsing and treat
51 remaining arguments as addresses even if they start with a dash
52 -A alias
54 Print an expanded version of the given alias to stdout and exit
55 -a file
57 Attach one or more files to a message (must be the last option).
58 Add any addresses after the '--' argument, e.g.:
59 neomutt -a image.jpg -- address1
61 neomutt -a image.jpg *.png -- address1 address2
62 -B Run in batch mode (do not start the ncurses UI)
64 -b address
66 Specify a blind carbon copy (Bcc) recipient
67 -c address
69 Specify a carbon copy (Cc) recipient
70 -D Dump all configuration variables as 'name=value' pairs to stdout
72 -D -O Like -D, but show one-liner documentation
74 -D -S Like -D, but hide the value of sensitive variables
76 -d level
78 Log debugging output to a file (default is "~/.neomuttdebug0").
79 The level can range from 1–5 and affects verbosity (a value of 2
80 is recommended)
81 Using this option along with -l is useful to log the early
83 startup process (before reading any configuration and hence $de‐
84 bug_level and $debug_file)
85 -E Edit draft (-H) or include (-i) file during message composition
87 -e command
89 Specify a command to be run after reading the config files
90 -F config
92 Specify an alternative initialization file to read, see FILES
93 section below for a list of regular configuration files
94 -f mailbox
96 Specify a mailbox (as defined with mailboxes command) to load
97 -G Start NeoMutt with a listing of subscribed newsgroups
99 -g server
101 Like -G, but start at specified news server
102 -H draft
104 Specify a draft file which contains header and body to use to
105 send a message. If draft is “-”, then data is read from stdin.
106 The draft file is expected to contain just an RFC822 email —
107 headers and a body. Although it is not an mbox file, if an mbox
108 "From " line is present, it will be silently discarded.
109 -h Print this help message and exit
111 -i include
113 Specify an include file to be embedded in the body of a message
114 -l file
116 Specify a file for debugging output (default "~/.neomuttdebug0")
117 This overrules $debug_file setting and NeoMutt keeps up to five
119 debug logs ({ file | $debug_file | ~/.neomuttdebug }[0-4]) be‐
120 fore override the oldest file
121 -m type
123 Specify a default mailbox format type for newly created folders
124 The type is either MH, MMDF, Maildir or mbox (case-insensitive)
126 -n Do not read the system-wide configuration file
128 -p Resume a prior postponed message, if any
130 -Q variable
132 Query a configuration variable and print its value to stdout
133 (after the config has been read and any commands executed). Add
134 -O for one-liner documentation.
135 -R Open mailbox in read-only mode
137 -s subject
139 Specify a subject (must be enclosed in quotes if it has spaces)
140 -v Print the NeoMutt version and compile-time definitions and exit
142 -vv Print the NeoMutt license and copyright information and exit
144 -y Start NeoMutt with a listing of all defined mailboxes
146 -Z Open the first mailbox with new message or exit immediately with
148 exit code 1 if none is found in all defined mailboxes
149 -z Open the first or specified (-f) mailbox if it holds any message
151 or exit immediately with exit code 1 otherwise
152
154 EDITOR Specifies the editor to use if VISUAL is unset. Defaults to the
155 Vi editor if unset.
156 EGDSOCKET
158 For OpenSSL since version 0.9.5, files, mentioned at RANDFILE
159 below, can be Entropy Gathering Daemon (EGD) sockets. Also, and
160 if exists, ~/.entropy and /tmp/entropy will be used to initial‐
161 ize SSL library functions. Specified sockets must be owned by
162 the user and have permission of 600 (octal number representing).
163 EMAIL The user's email address.
165 HOME Full path of the user's home directory.
167 MAIL Full path of the user's spool mailbox.
169 MAILCAPS
171 Path to search for mailcap files. If unset, a RFC1524 compliant
172 search path that is extended with NeoMutt related paths (at po‐
173 sition two and three): "$HOME/.mailcap:/usr/share/neomutt/mail‐
174 cap:/etc/mailcap:/etc/mailcap:/usr/etc/mailcap:/usr/local/etc/
175 mailcap" will be used instead.
176 MAILDIR
178 Full path of the user's spool mailbox if MAIL is unset. Commonly
179 used when the spool mailbox is a maildir(5) folder.
180 MM_NOASK
182 If this variable is set, mailcap are always used without prompt‐
183 ing first.
184 NNTPSERVER
186 Similar to configuration variable $news_server, specifies the
187 domain name or address of the default NNTP server to connect. If
188 unset, /etc/nntpserver is used but can be overridden by command
189 line option -g.
190 RANDFILE
192 Like configuration variable $entropy_file, defines a path to a
193 file which includes random data that is used to initialize SSL
194 library functions. If unset, ~/.rnd is used. DO NOT store impor‐
195 tant data in the specified file.
196 REPLYTO
198 When set, specifies the default Reply-To address.
199 TEXTDOMAINDIR
201 Defines an absolute path corresponding to /usr/share/locale that
202 will be recognised by GNU gettext(1) and used for Native Lan‐
203 guage Support (NLS) if enabled.
204 TMPDIR Directory in which temporary files are created. Defaults to /tmp
206 if unset. Configuration variable $tmp_dir takes precedence over
207 this one.
208 VISUAL Specifies the editor to use when composing messages.
210 XDG_CONFIG_DIRS
212 Specifies a X Desktop Group (XDG) compliant location for the
213 system-wide configuration file, as described in FILES section
214 below. This variable defaults to /etc/xdg. Bypass loading with
215 command line option -n.
216 XDG_CONFIG_HOME
218 Specifies a XDG compliant location for the user-specific config‐
219 uration file, as described in FILES section below. This variable
220 defaults to $HOME/.config. Can be overridden by command line op‐
221 tion -F.
222
224 Configuration files
225 NeoMutt will read just the first found configuration file of system-
226 wide and user-specific category, from the list below and in that order.
227 But it allows building of a recursive configuration by using the source
229 command.
230 ┌────┬────────────────────────────────┬────────────────────────────────┐
232 │ #N │ system-wide │ user-specific │
233 ├────┼────────────────────────────────┼────────────────────────────────┤
234 │ 1 │ $XDG_CONFIG_DIRS/neomutt/ │ $XDG_CONFIG_HOME/neomutt/ │
235 │ │ neomuttrc │ neomuttrc │
236 ├────┼────────────────────────────────┼────────────────────────────────┤
237 │ 2 │ $XDG_CONFIG_DIRS/neomutt/ │ $XDG_CONFIG_HOME/neomutt/ │
238 │ │ Muttrc *) │ muttrc │
239 ├────┼────────────────────────────────┼────────────────────────────────┤
240 │ 3 │ /etc/neomuttrc │ $XDG_CONFIG_HOME/mutt/ │
241 │ │ │ neomuttrc │
242 ├────┼────────────────────────────────┼────────────────────────────────┤
243 │ 4 │ /etc/Muttrc *) │ $XDG_CONFIG_HOME/mutt/muttrc │
244 ├────┼────────────────────────────────┼────────────────────────────────┤
245 │ 5 │ /usr/share/neomutt/neomuttrc │ ~/.neomutt/neomuttrc │
246 ├────┼────────────────────────────────┼────────────────────────────────┤
247 │ 6 │ /usr/share/neomutt/Muttrc *) │ ~/.neomutt/muttrc │
248 ├────┼────────────────────────────────┼────────────────────────────────┤
249 │ 7 │ — │ ~/.mutt/neomuttrc │
250 ├────┼────────────────────────────────┼────────────────────────────────┤
251 │ 8 │ — │ ~/.mutt/muttrc │
252 ├────┼────────────────────────────────┼────────────────────────────────┤
253 │ 9 │ — │ ~/.neomuttrc │
254 ├────┼────────────────────────────────┼────────────────────────────────┤
255 │ 10 │ — │ ~/.muttrc │
256 ├────┴────────────────────────────────┴────────────────────────────────┤
257 │ *) Note the case of the filename │
258 └──────────────────────────────────────────────────────────────────────┘
259 Other relevant files
260 Unless otherwise stated, NeoMutt will process all grouped files in the
261 order (from top to bottom) as they are specified in that listing.
262 ~/.mailcap
264 /etc/mailcap
265 User-specific and system-wide definitions for handling non-text
266 MIME types, look at environment variable MAILCAPS above for ad‐
267 ditional search locations.
268 ~/.neomuttdebug0
270 User's default debug log file. For further details or customis‐
271 ing file path see command line options -d and -l above.
272 /etc/mime.types
274 /etc/mime.types
275 /usr/share/neomutt/mime.types
276 ~/.mime.types
277 Description files for simple plain text mapping between MIME
278 types and filename extensions. NeoMutt parses these files in the
279 stated order while processing attachments to determine their
280 MIME type.
281 /usr/share/doc/neomutt/manual.{html,pdf,txt}
283 The full NeoMutt manual in HTML, PDF or plain text format.
284 /tmp/neomutt-XXXX-XXXX-XXXX
286 Temporary files created by NeoMutt. For custom locations look at
287 description of the environment variable TMPDIR above. Notice
288 that the suffix -XXXX-XXXX-XXXX is just a placeholder for, e.g.
289 hostname, user name/ID, process ID and/or other random data.
290
292 See issue tracker at <https://github.com/neomutt/neomutt/issues>.
293
295 This program is distributed in the hope that it will be useful, but
296 WITHOUT ANY WARRANTY; without even the implied warranty of MER‐
297 CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
298 Public License for more details.
299
301 gettext(1), msmtp(1), notmuch(1), sendmail(1), smail(1), RAND_egd(3),
302 curses(3), ncurses(3), mailcap(5), maildir(5), mbox(5), neomuttrc(5).
303 For further NeoMutt information:
305 • the full manual, see FILES section above
307 • the home page, <https://neomutt.org>
308
310 Michael Elkins, and others. Use <neomutt-devel@neomutt.org> to contact
311 the developers.
312Unix 2023-11-03 neomutt(1)