EditPageHistoryDiffInfoLikePages

Annotated edit history of muttrc(5) version 2, including all changes. View license author blame.

Rev	Author	#	Line
1	perry	1	muttrc
		2	!!!muttrc
		3	NAME
		4	DESCRIPTION
		5	COMMANDS
		6	PATTERNS
		7	CONFIGURATION VARIABLES
		8	SEE ALSO
		9	AUTHOR
		10	----
		11	!!NAME
		12
		13
		14	muttrc - Configuration file for the Mutt Mail User Agent
		15	!!DESCRIPTION
		16
		17
		18	A mutt configuration file consists of a series of
		19	``commands''. Each line of the file may contain one or more
		20	commands. When multiple commands are used, they must be
		21	separated by a semicolon (``__;__'').
		22
		23
		24	The hash mark, or pound sign (``__#__''), is used as a
		25	``comment'' character. You can use it to annotate your
		26	initialization file. All text after the comment character to
		27	the end of the line is ignored.
		28
		29
		30	Single quotes (``__'__'') and double quotes
		31	(``____'') can be used to quote strings which
		32	contain spaces or other special characters. The difference
		33	between the two types of quotes is similar to that of many
		34	popular shell programs, namely that a single quote is used
		35	to specify a literal string (one that is not interpreted for
		36	shell variables or quoting with a backslash [[see next
		37	paragraph]), while double quotes indicate a string for which
		38	should be evaluated. For example, backtics are evaluated
		39	inside of double quotes, but not for single
		40	quotes.
		41
		42
		43	__\__ quotes the next character, just as in shells such
		44	as bash and zsh. For example, if want to put quotes
		45	(``____'') inside of a string, you can use
		46	``__\__'' to force the next character to be a literal
		47	instead of interpreted character.
		48
		49
		50	``__\__'' means to insert a literal ``__\__'' into the
		51	line. ``__n__'' and ``__r__'' have their usual C
		52	meanings of linefeed and carriage-return,
		53	respectively.
		54
		55
		56	A ``__\__'' at the end of a line can be used to split
		57	commands over multiple lines, provided that the split points
		58	don't appear in the middle of command names.
		59
		60
		61	It is also possible to substitute the output of a Unix
		62	command in an initialization file. This is accomplished by
		63	enclosing the command in backquotes
		64	(__`__''command''__`__).
		65
		66
		67	UNIX environments can be accessed like the way it is done in
		68	shells like sh and bash: Prepend the name of the environment
		69	by a dollar (``__$__'') sign.
		70	!!COMMANDS
		71
		72
		73	__alias__ ''key address'' [[__,__ ''address'' [[ ... ]]
		74	__unalias__ [[ __*__ | ''key'' ]
		75
		76
		77	__alias__ defines an alias ''key'' for the given
		78	addresses. __unalias__ removes the alias corresponding to
		79	the given ''key'' or all aliases when ``__*__'' is
		80	used as an argument.
		81
		82
		83	__alternative_order__ ''type''[[__/__''subtype'']
		84	[[ ... ]
		85
		86
		87	This command permits you to define an order of preference
		88	which is used by mutt to determine which part of a
		89	__multipart/alternative__ body to display. A subtype of
		90	``__*__'' matches any subtype, as does an empty
		91	subtype.
		92
		93
		94	__auto_view__ ''type''[[__/__''subtype''] [[ ...
		95	]
		96
		97
		98	This commands permits you to specify that mutt should
		99	automatically convert the given MIME types to text/plain
		100	when displaying messages. For this to work, there must be a
		101	mailcap(5) entry for the given MIME type with the
		102	__copiousoutput__ flag set. A subtype of ``__*__''
		103	matches any subtype, as does an empty subtype.
		104
		105
		106	__bind__ ''map key function''
		107
		108
		109	This command binds the given ''key'' for the given
		110	''map'' to the given ''function''.
		111
		112
		113	Valid maps are: __generic__, __alias__, __attach__,
		114	__browser__, __editor__, __index__, __compose__,
		115	__pager__, __pgp__, __postpone__,
		116	__mix__.
		117
		118
		119	For more information on keys and functions, please consult
		120	the Mutt Manual.
		121
		122
		123	__account-hook__ [[__!__]''regexp
		124	command''
		125
		126
		127	This hook is executed whenever you access a remote mailbox.
		128	Useful to adjust configuration settings to different IMAP or
		129	POP servers.
		130
		131
		132	__charset-hook__ ''alias charset''
		133
		134
		135	This command defines an alias for a character set. This is
		136	useful to properly display messages which are tagged with a
		137	character set name not known to mutt.
		138
		139
		140	__iconv-hook__ ''charset local-charset''
		141
		142
		143	This command defines a system-specific name for a character
		144	set. This is useful when your system's iconv(3)
		145	implementation does not understand MIME character set names
		146	(such as __iso-8859-1__), but instead insists on being
		147	fed with implementation-specific character set names (such
		148	as __8859-1__). In this specific case, you'd put this
		149	into your configuration file:
		150
		151
		152	__iconv-hook iso-8859-1 8859-1__
		153
		154
		155	__message-hook__ [[__!__]''pattern
		156	command''
		157
		158
		159	Before mutt displays (or formats for replying or forwarding)
		160	a message which matches the given ''pattern'' (or, when
		161	it is preceded by an exclamation mark, does not match the
		162	''pattern''), the given ''command'' is executed. When
		163	multiple __message-hook__s match, they are executed in
		164	the order in which they occur in the configuration
		165	file.
		166
		167
		168	__folder-hook__ [[__!__]''regexp
		169	command''
		170
		171
		172	When mutt enters a folder which matches ''regexp'' (or,
		173	when ''regexp'' is preceded by an exclamation mark, does
		174	not match ''regexp''), the given ''command'' is
		175	executed.
		176
		177
		178	When several __folder-hook__s match a given mail folder,
		179	they are executed in the order given in the configuration
		180	file.
		181
		182
		183	__macro__ ''map key sequence'' [[ ''description''
		184	]
		185
		186
		187	This command binds the given ''sequence'' of keys to the
		188	given ''key'' in the given ''map''. For valid maps,
		189	see __bind__.
		190
		191
		192	__color__ ''object foreground background'' [[ '' regexp'' ]
		193	__color__ index ''foreground background'' [[ '' pattern'' ]
		194	__uncolor__ index ''pattern'' [[ ''pattern'' ... ]
		195
		196
		197	If your terminal supports color, these commands can be used
		198	to assign ''foreground''/''backgound'' combinations to
		199	certain objects. Valid objects are: __attachment__,
		200	__body__, __bold__, __header__, __hdrdefault__,
		201	__index__, __indicator__, __markers__,
		202	__message__, __normal__, __quoted__,
		203	__quoted__''N'', __search__, __signature__,
		204	__status__, __tilde__, __tree__, __underline__.
		205	The __body__ and __header__ objects allow you to
		206	restrict the colorization to a regular expression. The
		207	__index__ object permits you to select colored messages
		208	by pattern.
		209
		210
		211	Valid colors include: __white__, __black__,
		212	__green__, __magenta__, __blue__, __cyan__,
		213	__yellow__, __red__, __default__,
		214	__color__''N''.
		215
		216
		217	__mono__ ''object attribute'' [[ ''regexp'' ]
		218	__mono__ index ''attribute'' [[ ''pattern'' ]
		219
		220
		221	For terminals which don't support color, you can still
		222	assign attributes to objects. Valid attributes include:
		223	__none__, __bold__, __underline__, __reverse__,
		224	and __standout__.
		225
		226
		227	[[__un__]__ignore__ ''pattern'' [[ ''pattern'' ...
		228	]
		229
		230
		231	The __ignore__ command permits you to specify header
		232	fields which you usually don't wish to see. Any header field
		233	whose tag ''begins'' with an ``ignored'' pattern will be
		234	ignored.
		235
		236
		237	The __unignore__ command permits you to define exceptions
		238	from the above mentioned list of ignored
		239	headers.
		240
		241
		242	__lists__ ''address'' [[ ''address'' ... ]
		243	__unlists__ ''address'' [[ ''address'' ... ]
		244	__subscribe__ ''address'' [[ ''address'' ... ]
		245	__unsubscribe__ ''address'' [[ ''address'' ... ]
		246
		247
		248	Mutt maintains two lists of mailing list addresses, a list
		249	of subscribed mailing lists, and a list of known mailing
		250	lists. All subscribed mailing lists are known. A mail
		251	address matches a mailing list if it begins with the given
		252	address. For example, the lists pattern ``mutt-'' will match
		253	mutt-dev@mutt.org and mutt-users@mutt.org.
		254
		255
		256	The __lists__ command adds a mailing list address to the
		257	list of known mailing lists. The __unlists__ command
		258	removes a mailing list from the lists of known and
		259	subscribed mailing lists. The __subscribe__ command adds
		260	a mailing list to the lists of known and subscribed mailing
		261	lists. The __unsubscribe__ command removes it from the
		262	list of subscribed mailing lists.
		263
		264
		265	__mbox-hook__ [[__!__]''pattern
		266	mailbox''
		267
		268
		269	When mutt changes to a mail folder which matches
		270	''pattern'', ''mailbox'' will be used as the ``mbox''
		271	folder, i.e., read messages will be moved to that folder
		272	when the mail folder is left.
		273
		274
		275	The first matchig __mbox-hook__ applies.
		276
		277
		278	__mailboxes__ ''filename'' [[ ''filename'' ...
		279	]
		280
		281
		282	This command specifies folders which can receive mail and
		283	which will be checked for new messages. When changing
		284	folders, pressing space will cycle through folders with new
		285	mail.
		286
		287
		288	__my_hdr__ ''string
		289	''__unmy_hdr__ ''field
		290	''
		291
		292
		293	Using __my_hdr__, you can define headers which will be
		294	added to the messages you compose. __unmy_hdr__ will
		295	remove the given user-defined headers.
		296
		297
		298	__hdr_order__ ''header1 header2'' [[ ... ]
		299
		300
		301	With this command, you can specify an order in which mutt
		302	will attempt to present headers to you when viewing
		303	messages.
		304
		305
		306	__save-hook__ [[__!__]''pattern
		307	filename''
		308
		309
		310	When a message matches ''pattern'', the default file name
		311	when saving it will be the given
		312	''filename''.
		313
		314
		315	__fcc-hook__ [[__!__]''pattern
		316	filename''
		317
		318
		319	When an outgoing message matches ''pattern'', the default
		320	file name for storing a copy (fcc) will be the given
		321	''filename''.
		322
		323
		324	__fcc-save-hook__ [[__!__]''pattern
		325	filename''
		326
		327
		328	This command is an abbreviation for identical
		329	__fcc-hook__ and __save-hook__ commands.
		330
		331
		332	__send-hook__ [[__!__]''pattern
		333	command''
		334
		335
		336	When composing a message matching ''pattern'',
		337	''command'' is executed. When multiple __send-hook__s
		338	match, they are executed in the order in which they occur in
		339	the configuration file.
		340
		341
		342	__pgp-hook__ ''pattern key-id''
		343
		344
		345	The pgp-hook command provides a method by which you can
		346	specify the ID of the public key to be used when encrypting
		347	messages to a certain recipient.
		348
		349
		350	__open-hook__ ''regexp'' ''command''
		351	''close-hook__ ''regexp'' ''command''
		352	''append-hook__ ''regexp'' ''command''
		353	''
		354
		355
		356	These commands provide a way to handle compressed folders.
		357	The given __regexp__ specifies which folders are taken as
		358	compressed (e.g. __\.gz$''
		359	''open-hook__),
		360	compress a folder (__close-hook__) or append a compressed
		361	mail to a compressed folder (__append-hook__). The
		362	''command'' string is the printf(3) like format
		363	string, and it should accept two parameters: __%f__,
		364	which is replaced with the (compressed) folder name, and
		365	__%t__ which is replaced with the name of the temporary
		366	folder to which to write.
		367
		368
		369	__push__ ''string''
		370
		371
		372	This command adds the named ''string'' to the keyboard
		373	buffer.
		374
		375
		376	__set__ [[__no__|__inv__]''variable''[[=''value''] [[ ... ]
		377	__toggle__ ''variable'' [[ ... ]
		378	__unset__ ''variable'' [[ ... ]
		379	__reset__ ''variable'' [[ ... ]
		380
		381
		382	These commands are used to set and manipulate configuration
		383	varibles.
		384
		385
		386	Mutt knows four basic types of variables: boolean, number,
		387	string and quadoption. Boolean variables can be __set__
		388	(true), __unset__ (false), or __toggle__d. Number
		389	variables can be assigned a positive integer
		390	value.
		391
		392
		393	String variables consist of any number of printable
		394	characters. Strings must be enclosed in quotes if they
		395	contain spaces or tabs. You may also use the ``C'' escape
		396	sequences __n__ and __t__ for newline and tab,
		397	respectively.
		398
		399
		400	Quadoption variables are used to control whether or not to
		401	be prompted for certain actions, or to specify a default
		402	action. A value of __yes__ will cause the action to be
		403	carried out automatically as if you had answered yes to the
		404	question. Similarly, a value of __no__ will cause the the
		405	action to be carried out as if you had answered ``no.'' A
		406	value of __ask-yes__ will cause a prompt with a default
		407	answer of ``yes'' and __ask-no__ will provide a default
		408	answer of ``no.''
		409
		410
		411	The __reset__ command resets all given variables to the
		412	compile time defaults. If you reset the special variabe
		413	__all__, all variables will reset to their system
		414	defaults.
		415
		416
		417	__source__ ''filename''
		418
		419
		420	The given file will be evaluated as a configuration
		421	file.
		422
		423
		424	__unhook__ [[ __*__ | ''hook-type'' ]
		425
		426
		427	This command will remove all hooks of a given type, or all
		428	hooks when ``__*__'' is used as an argument.
		429	''hook-type'' can be any of the __-hook__ commands
		430	documented above.
		431	!!PATTERNS
		432
		433
		434	In various places with mutt, including some of the
		435	abovementioned __hook__ commands, you can specify
		436	patterns to match messages.
		437
		438
		439	__Constructing Patterns__
		440
		441
		442	A simple pattern consists of an operator of the form
		443	``__~__''character'''', possibly followed by a
		444	parameter against which mutt is supposed to match the
		445	obeject specified by this operator. (For a list of
		446	operators, see below.)
		447
		448
		449	With some of these operators, the object to be matched
		450	consists of several e-mail addresses. In these cases, the
		451	object is matched if at least one of these e-mail addresses
		452	matches. You can prepend a hat (``__^__'') character to
		453	such a pattern to indicate that ''all'' addresses must
		454	match in order to match the object.
		455
		456
		457	You can construct complex patterns by combining simple
		458	patterns with logical operators. Logical AND is specified by
		459	simply concatenating two simple patterns, for instance ``~C
		460	mutt-dev ~s bug''. Logical OR is specified by inserting a
		461	vertical bar (``__|__'') between two patterns, for
		462	instance ``~C mutt-dev | ~s bug''. Additionally, you can
		463	negate a pattern by prepending a bang (``__!__'')
		464	character. For logical grouping, use braces (``()'').
		465	Example: ``!(~t mutt|~c mutt) ~f elkins''.
		466
		467
		468	__Simple Patterns__
		469
		470
		471	Mutt understands the following simple patterns:
		472
		473
		474	In the above, ''EXPR'' is a regular expression.
		475
		476
		477	With the __~m__, __~n__, and __~z__ operators, you
		478	can also specify ranges in the forms ____''MAX'',
		479	____''MIN'', ''MIN''__-__, and
		480	__-__''MAX''.
		481
		482
		483	__Matching dates__
		484
		485
		486	The __~d__ and __~r__ operators are used to match date
		487	ranges, which are interpreted to be given in your local time
		488	zone.
		489
		490
		491	A date is of the form
		492	''DD''[[__/__''MM''[[__/__[[''cc'']''YY'']],
		493	that is, a two-digit date, optionally followed by a
		494	two-digit month, optionally followed by a year
		495	specifications. Omitted fields default to the current month
		496	and year.
		497
		498
		499	Mutt understands either two or four digit year
		500	specifications. When given a two-digit year, mutt will
		501	interpret values less than 70 as lying in the 21st century
		502	(i.e., ``38'' means 2038 and not 1938, and ``00'' is
		503	interpreted as 2000), and values greater than or equal to 70
		504	as lying in the 20th century.
		505
		506
		507	Note that this behaviour ''is'' Y2K compliant, but that
		508	mutt ''does'' have a Y2.07K problem.
		509
		510
		511	If a date range consists of a single date, the operator in
		512	question will match that precise date. If the date range
		513	consists of a dash (``__-__''), followed by a date, this
		514	range will match any date before and up to the date given.
		515	Similarly, a date followed by a dash matches the date given
		516	and any later point of time. Two dates, separated by a dash,
		517	match any date which lies in the given range of
		518	time.
		519
		520
		521	You can also modify any absolute date by giving an error
		522	range. An error range consists of one of the characters
		523	__+__, __-__, __*__, followed by a positive number,
		524	followed by one of the unit characters __y__, __m__,
		525	__w__, or __d__, specifying a unit of years, months,
		526	weeks, or days. __+__ increases the maximum date matched
		527	by the given interval of time, __-__ decreases the
		528	minimum date matched by the given interval of time, and
		529	__*__ increases the maximum date and decreases the
		530	minimum date matched by the given interval of time. It is
		531	possible to give multiple error margins, which cumulate.
		532	Example: __1/1/2001-1w+2w*3d__
		533
		534
		535	You can also specify offsets relative to the current date.
		536	An offset is specified as one of the characters ____,
		537	____, __=__, followed by a positive number,
		538	followed by one of the unit characters __y__, __m__,
		539	__w__, or __d__. ____ matches dates which are
		540	older than the specified amount of time, an offset which
		541	begins with the character ____ matches dates which
		542	are more recent than the specified amount of time, and an
		543	offset which begins with the character __=__ matches
		544	points of time which are precisely the given amount of time
		545	ago.
		546	!!CONFIGURATION VARIABLES
		547
		548
		549	__abort_nosubject__
		550
		551
		552	Type: quadoption
		553	Default: ask-yes
		554	If set to ''yes'', when composing messages and no subject is given at the subject prompt, composition will be aborted. If set to ''no'', composing messages with no subject given at the subject prompt will never be aborted.
		555
		556
		557	__abort_unmodified__
		558
		559
		560	Type: quadoption
		561	Default: yes
		562	If set to ''yes'', composition will automatically abort after editing the message body if no changes are made to the file (this check only happens after the ''first'' edit of the file). When set to ''no'', composition will never be aborted.
		563
		564
		565	__alias_file__
		566
		567
		568	Type: path
		569	Default: ``~/.muttrc''
		570	The default file in which to save aliases created by the ``create-alias'' function.
		571
		572
		573	__Note:__ Mutt will not automatically source this file;
		574	you must explicitly use the ``source'' command for it to be
		575	executed.
		576
		577
		578	__alias_format__
		579
		580
		581	Type: string
		582	Default: ``%4n %2f %t %-10a %r''
		583	Specifies the format of the data displayed for the `alias' menu. The following printf(3)-style sequences are available:
		584
		585
		586	%a
		587
		588
		589	alias name
		590
		591
		592	%f
		593
		594
		595	flags - currently, a ''d'' for an alias marked for
		596	deletion
		597
		598
		599	%n
		600
		601
		602	index number
		603
		604
		605	%r
		606
		607
		608	address which alias expands to
		609
		610
		611	%t
		612
		613
		614	character which indicates if the alias is tagged for
		615	inclusion
		616
		617
		618	__allow_8bit__
		619
		620
		621	Type: boolean
		622	Default: yes
		623	Controls whether 8-bit data is converted to 7-bit using either Quoted- Printable or Base64 encoding when sending mail.
		624
		625
		626	__allow_ansi__
		627
		628
		629	Type: boolean
		630	Default: no
		631	Controls whether ANSI color codes in messages (and color tags in rich text messages) are to be interpreted. Messages containing these codes are rare, but if this option is set, their text will be colored accordingly. Note that this may override your color choices, and even present a security problem, since a message could include a line like ''[[-- PGP output follows ...'' and give it the same color as your attachment color.
		632
		633
		634	__alternates__
		635
		636
		637	Type: regular expression
		638	Default: ``''
		639	A regexp that allows you to specify ''alternate'' addresses where you receive mail. This affects Mutt's idea about messages from you and addressed to you.
		640
		641
		642	__arrow_cursor__
		643
		644
		645	Type: boolean
		646	Default: no
		647	When set, an arrow (``-
		648
		649
		650	__ascii_chars__
		651
		652
		653	Type: boolean
		654	Default: no
		655	If set, Mutt will use plain ASCII characters when displaying thread and attachment trees, instead of the default ''ACS'' characters.
		656
		657
		658	__askbcc__
		659
		660
		661	Type: boolean
		662	Default: no
		663	If set, Mutt will prompt you for blind-carbon-copy (Bcc) recipients before editing an outgoing message.
		664
		665
		666	__askcc__
		667
		668
		669	Type: boolean
		670	Default: no
		671	If set, Mutt will prompt you for carbon-copy (Cc) recipients before editing the body of an outgoing message.
		672
		673
		674	__attach_format__
		675
		676
		677	Type: string
		678	Default: ``%u%D%I %t%4n %T%.40d%
		679	This variable describes the format of the `attachment' menu. The following printf-style sequences are understood:
		680
		681
		682	%D
		683
		684
		685	deleted flag
		686
		687
		688	%d
		689
		690
		691	description
		692
		693
		694	%e
		695
		696
		697	MIME content-transfer-encoding
		698
		699
		700	%f
		701
		702
		703	filename
		704
		705
		706	%I
		707
		708
		709	disposition (I=inline, A=attachment)
		710
		711
		712	%m
		713
		714
		715	major MIME type
		716
		717
		718	%M
		719
		720
		721	MIME subtype
		722
		723
		724	%n
		725
		726
		727	attachment number
		728
		729
		730	%s
		731
		732
		733	size
		734
		735
		736	%t
		737
		738
		739	tagged flag
		740
		741
		742	%u
		743
		744
		745	unlink (=to delete) flag
		746
		747
		748	%
		749
		750
		751	right justify the rest of the string and pad with character
		752	''X''
		753
		754
		755	%|X
		756
		757
		758	pad to the end of the line with character ''X''
		759
		760
		761	__attach_sep__
		762
		763
		764	Type: string
		765	Default: ``n''
		766	The separator to add between attachments when operating (saving, printing, piping, etc) on a list of tagged attachments.
		767
		768
		769	__attach_split__
		770
		771
		772	Type: boolean
		773	Default: yes
		774	If this variable is unset, when operating (saving, printing, piping, etc) on a list of tagged attachments, Mutt will concatenate the attachments and will operate on them as a single attachment. The ``$attach_sep'' separator is added after each attachment. When set, Mutt will operate on the attachments one by one.
		775
		776
		777	__attribution__
		778
		779
		780	Type: string
		781	Default: ``On %d, %n wrote:''
		782	This is the string that will precede a message which has been included in a reply. For a full listing of defined escape sequences see the section on ``$index_format''.
		783
		784
		785	__autoedit__
		786
		787
		788	Type: boolean
		789	Default: no
		790	When set along with ``$edit_headers'', Mutt will skip the initial send-menu and allow you to immediately begin editing the body of your message. The send-menu may still be accessed once you have finished editing the body of your message.
		791
		792
		793	Also see ``$fast_reply''.
		794
		795
		796	__auto_tag__
		797
		798
		799	Type: boolean
		800	Default: no
		801	When set, functions in the ''index'' menu which affect a message will be applied to all tagged messages (if there are any). When unset, you must first use the tag-prefix function (default: '';'') to make the next function apply to all tagged messages.
		802
		803
		804	__beep__
		805
		806
		807	Type: boolean
		808	Default: yes
		809	When this variable is set, mutt will beep when an error occurs.
		810
		811
		812	__beep_new__
		813
		814
		815	Type: boolean
		816	Default: no
		817	When this variable is set, mutt will beep whenever it prints a message notifying you of new mail. This is independent of the setting of the ``$beep'' variable.
		818
		819
		820	__bounce_delivered__
		821
		822
		823	Type: boolean
		824	Default: yes
		825	When this variable is set, mutt will include Delivered-To headers when bouncing messages. Postfix users may wish to unset this variable.
		826
		827
		828	__charset__
		829
		830
		831	Type: string
		832	Default: ``''
		833	Character set your terminal uses to display and enter textual data.
		834
		835
		836	__check_new__
		837
		838
		839	Type: boolean
		840	Default: yes
		841	__Note:__ this option only affects ''maildir'' and ''MH'' style mailboxes.
		842
		843
		844	When ''set'', Mutt will check for new mail delivered
		845	while the mailbox is open. Especially with MH mailboxes,
		846	this operation can take quite some time since it involves
		847	scanning the directory and checking each file to see if it
		848	has already been looked at. If ''check_new'' is
		849	''unset'', no check for new mail is performed while the
		850	mailbox is open.
		851
		852
		853	__collapse_unread__
		854
		855
		856	Type: boolean
		857	Default: yes
		858	When ''unset'', Mutt will not collapse a thread if it contains any unread messages.
		859
		860
		861	__uncollapse_jump__
		862
		863
		864	Type: boolean
		865	Default: no
		866	When ''set'', Mutt will jump to the next unread message, if any, when the current thread is ''un''collapsed.
		867
		868
		869	__compose_format__
		870
		871
		872	Type: string
		873	Default: ``-- Mutt: Compose [[Approx. msg size: %l Atts: %a]%
		874	Controls the format of the status line displayed in the fCompose menu. This string is similar to ``$status_format'', but has its own set of printf()-like sequences:
		875
		876
		877	%a
		878
		879
		880	total number of attachments
		881
		882
		883	%h
		884
		885
		886	local hostname
		887
		888
		889	%l
		890
		891
		892	approximate size (in bytes) of the current
		893	message
		894
		895
		896	%v
		897
		898
		899	Mutt version string
		900
		901
		902	See the text describing the ``$status_format'' option for
		903	more information on how to set
		904	``$compose_format''.
		905
		906
		907	__confirmappend__
		908
		909
		910	Type: boolean
		911	Default: yes
		912	When set, Mutt will prompt for confirmation when appending messages to an existing mailbox.
		913
		914
		915	__confirmcreate__
		916
		917
		918	Type: boolean
		919	Default: yes
		920	When set, Mutt will prompt for confirmation when saving messages to a mailbox which does not yet exist before creating it.
		921
		922
		923	__connect_timeout__
		924
		925
		926	Type: number
		927	Default: 30
		928	Causes Mutt to timeout a network connection (for IMAP or POP) after this many seconds if the connection is not able to be established. A negative value causes Mutt to wait indefinitely for the connection to succeed.
		929
		930
		931	__copy__
		932
		933
		934	Type: quadoption
		935	Default: yes
		936	This variable controls whether or not copies of your outgoing messages will be saved for later references. Also see ``$record'', ``$save_name'', ``$force_name'' and ``fcc-hook''.
		937
		938
		939	__date_format__
		940
		941
		942	Type: string
		943	Default: ``!%a, %b %d, %Y at %I:%M:%S%p %Z''
		944	This variable controls the format of the date printed by the ``%d'' sequence in ``$index_format''. This is passed to the ''strftime'' call to process the date. See the man page for ''strftime(3)'' for the proper syntax.
		945
		946
		947	Unless the first character in the string is a bang (``!''),
		948	the month and week day names are expanded according to the
		949	locale specified in the variable ``$locale''. If the first
		950	character in the string is a bang, the bang is discarded,
		951	and the month and week day names in the rest of the string
		952	are expanded in the ''C'' locale (that is in US
		953	English).
		954
		955
		956	__default_hook__
		957
		958
		959	Type: string
		960	Default: ``~f %s !~P | (~P ~C %s)''
		961	This variable controls how send-hooks, message-hooks, save-hooks, and fcc-hooks will be interpreted if they are specified with only a simple regexp, instead of a matching pattern. The hooks are expanded when they are declared, so a hook will be interpreted according to the value of this variable at the time the hook is declared. The default value matches if the message is either from a user matching the regular expression given, or if it is from you (if the from address matches ``$alternates'') and is to or cc'ed to a user matching the given regular expression.
		962
		963
		964	__delete__
		965
		966
		967	Type: quadoption
		968	Default: ask-yes
		969	Controls whether or not messages are really deleted when closing or synchronizing a mailbox. If set to ''yes'', messages marked for deleting will automatically be purged without prompting. If set to ''no'', messages marked for deletion will be kept in the mailbox.
		970
		971
		972	__delete_untag__
		973
		974
		975	Type: boolean
		976	Default: yes
		977	If this option is ''set'', mutt will untag messages when marking them for deletion. This applies when you either explicitly delete a message, or when you save it to another folder.
		978
		979
		980	__digest_collapse__
		981
		982
		983	Type: boolean
		984	Default: yes
		985	If this option is ''set'', mutt's revattach menu will not show the subparts of individual messages in a digest. To see these subparts, press 'v' on that menu.
		986
		987
		988	__display_filter__
		989
		990
		991	Type: path
		992	Default: ``''
		993	When set, specifies a command used to filter messages. When a message is viewed it is passed as standard input to $display_filter, and the filtered message is read from the standard output.
		994
		995
		996	__dotlock_program__
		997
		998
		999	Type: path
		1000	Default: ``/usr/bin/mutt_dotlock''
		1001	Contains the path of the mutt_dotlock (8) binary to be used by mutt.
		1002
		1003
		1004	__dsn_notify__
		1005
		1006
		1007	Type: string
		1008	Default: ``''
		1009	__Note:__ you should not enable this unless you are using Sendmail 8.8.x or greater.
		1010
		1011
		1012	This variable sets the request for when notification is
		1013	returned. The string consists of a comma separated list (no
		1014	spaces!) of one or more of the following: ''never'', to
		1015	never request notification, ''failure'', to request
		1016	notification on transmission failure, ''delay'', to be
		1017	notified of message delays, ''success'', to be notified
		1018	of successful transmission.
		1019
		1020
		1021	Example: set dsn_notify=''failure,delay''
		1022
		1023
		1024	__dsn_return__
		1025
		1026
		1027	Type: string
		1028	Default: ``''
		1029	__Note:__ you should not enable this unless you are using Sendmail 8.8.x or greater.
		1030
		1031
		1032	This variable controls how much of your message is returned
		1033	in DSN messages. It may be set to either ''hdrs'' to
		1034	return just the message header, or ''full'' to return the
		1035	full message.
		1036
		1037
		1038	Example: set dsn_return=hdrs
		1039
		1040
		1041	__duplicate_threads__
		1042
		1043
		1044	Type: boolean
		1045	Default: yes
		1046	This variable controls whether mutt, when sorting by threads, threads messages with the same message-id together. If it is set, it will indicate that it thinks they are duplicates of each other with an equals sign in the thread diagram.
		1047
		1048
		1049	__edit_headers__
		1050
		1051
		1052	Type: boolean
		1053	Default: no
		1054	This option allows you to edit the header of your outgoing messages along with the body of your message.
		1055
		1056
		1057	__editor__
		1058
		1059
		1060	Type: path
		1061	Default: ``''
		1062	This variable specifies which editor is used by mutt. It defaults to the value of the EDITOR or VISUAL environment variable, or to the string ''/usr/bin/editor''.
		1063
		1064
		1065	__encode_from__
		1066
		1067
		1068	Type: boolean
		1069	Default: no
		1070	When ''set'', mutt will quoted-printable encode messages when they contain the string ''From '' in the beginning of a line. Useful to avoid the tampering certain mail delivery and transport agents tend to do with messages.
		1071
		1072
		1073	__envelope_from__
		1074
		1075
		1076	Type: boolean
		1077	Default: no
		1078	When ''set'', mutt will try to derive the message's ''envelope'' sender from the ''From:'' header. Note that this information is passed to sendmail command using the ''-f'' command line switch, so don't set this option if you are using that switch in $sendmail yourself, or if the sendmail on your machine doesn't support that command line switch.
		1079
		1080
		1081	__escape__
		1082
		1083
		1084	Type: string
		1085	Default: ``~''
		1086	Escape character to use for functions in the builtin editor.
		1087
		1088
		1089	__fast_reply__
		1090
		1091
		1092	Type: boolean
		1093	Default: no
		1094	When set, the initial prompt for recipients and subject are skipped when replying to messages, and the initial prompt for subject is skipped when forwarding messages.
		1095
		1096
		1097	__Note:__ this variable has no effect when the
		1098	``$autoedit'' variable is set.
		1099
		1100
		1101	__fcc_attach__
		1102
		1103
		1104	Type: boolean
		1105	Default: yes
		1106	This variable controls whether or not attachments on outgoing messages are saved along with the main body of your message.
		1107
		1108
		1109	__fcc_clear__
		1110
		1111
		1112	Type: boolean
		1113	Default: no
		1114	When this variable is ''set'', FCCs will be stored unencrypted and unsigned, even when the actual message is encrypted and/or signed.
		1115
		1116
		1117	__folder__
		1118
		1119
		1120	Type: path
		1121	Default: ``~/Mail''
		1122	Specifies the default location of your mailboxes. A `+' or `=' at the beginning of a pathname will be expanded to the value of this variable. Note that if you change this variable from the default value you need to make sure that the assignment occurs ''before'' you use `+' or `=' for any other variables since expansion takes place during the `set' command.
		1123
		1124
		1125	__folder_format__
		1126
		1127
		1128	Type: string
		1129	Default: ``%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %f''
		1130	This variable allows you to customize the file browser display to your personal taste. This string is similar to ``$index_format'', but has its own set of printf()-like sequences:
		1131
		1132
		1133	%C
		1134
		1135
		1136	current file number
		1137
		1138
		1139	%d
		1140
		1141
		1142	date/time folder was last modified
		1143
		1144
		1145	%f
		1146
		1147
		1148	filename
		1149
		1150
		1151	%F
		1152
		1153
		1154	file permissions
		1155
		1156
		1157	%g
		1158
		1159
		1160	group name (or numeric gid, if missing)
		1161
		1162
		1163	%l
		1164
		1165
		1166	number of hard links
		1167
		1168
		1169	%N
		1170
		1171
		1172	N if folder has new mail, blank otherwise
		1173
		1174
		1175	%s
		1176
		1177
		1178	size in bytes
		1179
		1180
		1181	%t
		1182
		1183
		1184	* if the file is tagged, blank otherwise
		1185
		1186
		1187	%u
		1188
		1189
		1190	owner name (or numeric uid, if missing)
		1191
		1192
		1193	%
		1194
		1195
		1196	right justify the rest of the string and pad with character
		1197	''X''
		1198
		1199
		1200	%|X
		1201
		1202
		1203	pad to the end of the line with character ''X''
		1204
		1205
		1206	__followup_to__
		1207
		1208
		1209	Type: boolean
		1210	Default: yes
		1211	Controls whether or not the ''Mail-Followup-To'' header field is generated when sending mail. When ''set'', Mutt will generate this field when you are replying to a known mailing list, specified with the ``subscribe'' or ``lists'' commands.
		1212
		1213
		1214	This field has two purposes. First, preventing you from
		1215	receiving duplicate copies of replies to messages which you
		1216	send to mailing lists. Second, ensuring that you do get a
		1217	reply separately for any messages sent to known lists to
		1218	which you are not subscribed. The header will contain only
		1219	the list's address for subscribed lists, and both the list
		1220	address and your own email address for unsubscribed lists.
		1221	Without this header, a group reply to your message sent to a
		1222	subscribed list will be sent to both the list and your
		1223	address, resulting in two copies of the same email for
		1224	you.
		1225
		1226
		1227	__force_name__
		1228
		1229
		1230	Type: boolean
		1231	Default: no
		1232	This variable is similar to ``$save_name'', except that Mutt will store a copy of your outgoing message by the username of the address you are sending to even if that mailbox does not exist.
		1233
		1234
		1235	Also see the ``$record'' variable.
		1236
		1237
		1238	__forward_decode__
		1239
		1240
		1241	Type: boolean
		1242	Default: yes
		1243	Controls the decoding of complex MIME messages into text/plain when forwarding a message. The message header is also RFC2047 decoded. This variable is only used, if ``$mime_forward'' is ''unset'', otherwise ``$mime_forward_decode'' is used instead.
		1244
		1245
		1246	__forward_format__
		1247
		1248
		1249	Type: string
		1250	Default: ``[[%a: %s]''
		1251	This variable controls the default subject when forwarding a message. It uses the same format sequences as the ``$index_format'' variable.
		1252
		1253
		1254	__forward_quote__
		1255
		1256
		1257	Type: boolean
		1258	Default: no
		1259	When ''set'' forwarded messages included in the main body of the message (when ``$mime_forward'' is ''unset'') will be quoted using ``$indent_string''.
		1260
		1261
		1262	__from__
		1263
		1264
		1265	Type: e-mail address
		1266	Default: ``''
		1267	When set, this variable contains a default from address. It can be overridden using my_hdr (including from send-hooks) and ``$reverse_name''.
		1268
		1269
		1270	Defaults to the EMAIL environment variable's
		1271	content.
		1272
		1273
		1274	__gecos_mask__
		1275
		1276
		1277	Type: regular expression
		1278	Default: ``^[[^,]*''
		1279	A regular expression used by mutt to parse the GECOS field of a password entry when expanding the alias. By default the regular expression is set to ''^[[^,]*'' which will return the string up to the first '','' encountered. If the GECOS field contains a string like ''lastname, firstname'' then you should set the gecos_mask=''.*''.
		1280
		1281
		1282	This can be useful if you see the following behavior: you
		1283	address a e-mail to user ID stevef whose full name is Steve
		1284	Franklin. If mutt expands stevef to ''Franklin''
		1285	stevef@foo.bar then you should set the gecos_mask to a
		1286	regular expression that will match the whole name so mutt
		1287	will expand ''Franklin'' to ''Franklin,
		1288	Steve''.
		1289
		1290
		1291	__hdrs__
		1292
		1293
		1294	Type: boolean
		1295	Default: yes
		1296	When unset, the header fields normally added by the ``my_hdr'' command are not created. This variable ''must'' be unset before composing a new message or replying in order to take effect. If set, the user defined header fields are added to every new message.
		1297
		1298
		1299	__header__
		1300
		1301
		1302	Type: boolean
		1303	Default: no
		1304	When set, this variable causes Mutt to include the header of the message you are replying to into the edit buffer. The ``$weed'' setting applies.
		1305
		1306
		1307	__help__
		1308
		1309
		1310	Type: boolean
		1311	Default: yes
		1312	When set, help lines describing the bindings for the major functions provided by each menu are displayed on the first line of the screen.
		1313
		1314
		1315	__Note:__ The binding will not be displayed correctly if
		1316	the function is bound to a sequence rather than a single
		1317	keystroke. Also, the help line may not be updated if a
		1318	binding is changed while Mutt is running. Since this
		1319	variable is primarily aimed at new users, neither of these
		1320	should present a major problem.
		1321
		1322
		1323	__hidden_host__
		1324
		1325
		1326	Type: boolean
		1327	Default: no
		1328	When set, mutt will skip the host name part of ``$hostname'' variable when adding the domain part to addresses. This variable does not affect the generation of Message-IDs, and it will not lead to the cut-off of first-level domains.
		1329
		1330
		1331	__hide_limited__
		1332
		1333
		1334	Type: boolean
		1335	Default: no
		1336	When set, mutt will not show the presence of missing messages in the thread tree.
		1337
		1338
		1339	__hide_missing__
		1340
		1341
		1342	Type: boolean
		1343	Default: yes
		1344	When set, mutt will not show the presence of messages that are hidden by limiting, in the thread tree.
		1345
		1346
		1347	__hide_top_limited__
		1348
		1349
		1350	Type: boolean
		1351	Default: no
		1352	When set, mutt will not show the presence of missing messages at the top of threads in the thread tree. Note that when $hide_limited is set, this option will have no effect.
		1353
		1354
		1355	__hide_top_missing__
		1356
		1357
		1358	Type: boolean
		1359	Default: yes
		1360	When set, mutt will not show the presence of messages that are hidden by limiting, at the top of threads in the thread tree.Note that when $hide_missing is set, this option will have no effect.
		1361
		1362
		1363	__history__
		1364
		1365
		1366	Type: number
		1367	Default: 10
		1368	This variable controls the size (in number of strings remembered) of the string history buffer. The buffer is cleared each time the variable is set.
		1369
		1370
		1371	__honor_followup_to__
		1372
		1373
		1374	Type: quadoption
		1375	Default: yes
		1376	This variable controls whether or not a Mail-Followup-To header is honored when group-replying to a message.
		1377
		1378
		1379	__hostname__
		1380
		1381
		1382	Type: string
		1383	Default: ``''
		1384	Specifies the hostname to use after the ``@'' in local e-mail addresses. This overrides the compile time definition obtained from /etc/resolv.conf.
		1385
		1386
		1387	__ignore_list_reply_to__
		1388
		1389
		1390	Type: boolean
		1391	Default: no
		1392	Affects the behaviour of the ''reply'' function when replying to messages from mailing lists. When set, if the ``Reply-To:'' field is set to the same value as the ``To:'' field, Mutt assumes that the ``Reply-To:'' field was set by the mailing list to automate responses to the list, and will ignore this field. To direct a response to the mailing list when this option is set, use the ''list-reply'' function; ''group-reply'' will reply to both the sender and the list.
		1393
		1394
		1395	__imap_authenticators__
		1396
		1397
		1398	Type: string
		1399	Default: ``''
		1400	This is a colon-delimited list of authentication methods mutt may attempt to use to log in to an IMAP server, in the order mutt should try them. Authentication methods are either 'login' or the right side of an IMAP 'AUTH=xxx' capability string, eg 'digest-md5', parameter is unset (the default) mutt will try all available methods, in order from most-secure to least-secure.
		1401
		1402
		1403	Example: set
		1404	imap_authenticators=''gssapi:cram-md5:login''
		1405
		1406
		1407	__Note:__ Mutt will only fall back to other
		1408	authentication methods if the previous methods are
		1409	unavailable. If a method is available but authentication
		1410	fails, mutt will not connect to the IMAP
		1411	server.
		1412
		1413
		1414	__imap_delim_chars__
		1415
		1416
		1417	Type: string
		1418	Default: ``/.''
		1419	This contains the list of characters which you would like to treat as folder separators for displaying IMAP paths. In particular it helps in using the '=' shortcut for your ''folder'' variable.
		1420
		1421
		1422	__imap_force_ssl__
		1423
		1424
		1425	Type: boolean
		1426	Default: no
		1427	If this variable is set, Mutt will always use SSL when connecting to IMAP servers.
		1428
		1429
		1430	__imap_home_namespace__
		1431
		1432
		1433	Type: string
		1434	Default: ``''
		1435	You normally want to see your personal folders alongside your INBOX in the IMAP browser. If you see something else, you may set this variable to the IMAP path to your folders.
		1436
		1437
		1438	__imap_keepalive__
		1439
		1440
		1441	Type: number
		1442	Default: 900
		1443	This variable specifies the maximum amount of time in seconds that mutt will wait before polling open IMAP connections, to prevent the server from closing them before mutt has finished with them. The default is well within the RFC-specified minimum amount of time (30 minutes) before a server is allowed to do this, but in practice the RFC does get violated every now and then. Reduce this number if you find yourself getting disconnected from your IMAP server due to inactivity.
		1444
		1445
		1446	__imap_list_subscribed__
		1447
		1448
		1449	Type: boolean
		1450	Default: no
		1451	This variable configures whether IMAP folder browsing will look for only subscribed folders or all folders. This can be toggled in the IMAP browser with the ''toggle-subscribed'' command.
		1452
		1453
		1454	__imap_pass__
		1455
		1456
		1457	Type: string
		1458	Default: ``''
		1459	Specifies the password for your IMAP account. If unset, Mutt will prompt you for your password when you invoke the fetch-mail function. __Warning__: you should only use this option when you are on a fairly secure machine, because the superuser can read your muttrc even if you are the only one who can read the file.
		1460
		1461
		1462	__imap_passive__
		1463
		1464
		1465	Type: boolean
		1466	Default: yes
		1467	When set, mutt will not open new IMAP connections to check for new mail. Mutt will only check for new mail over existing IMAP connections. This is useful if you don't want to be prompted to user/password pairs on mutt invocation, or if opening the connection is slow.
		1468
		1469
		1470	__imap_peek__
		1471
		1472
		1473	Type: boolean
		1474	Default: yes
		1475	If set, mutt will avoid implicitly marking your mail as read whenever you fetch a message from the server. This is generally a good thing, but can make closing an IMAP folder somewhat slower. This option exists to appease spead freaks.
		1476
		1477
		1478	__imap_servernoise__
		1479
		1480
		1481	Type: boolean
		1482	Default: yes
		1483	When set, mutt will display warning messages from the IMAP server as error messages. Since these messages are often harmless, or generated due to configuration problems on the server which are out of the users' hands, you may wish to suppress them at some point.
		1484
		1485
		1486	__imap_user__
		1487
		1488
		1489	Type: string
		1490	Default: ``''
		1491	Your login name on the IMAP server.
		1492
		1493
		1494	This variable defaults to your user name on the local
		1495	machine.
		1496
		1497
		1498	__implicit_autoview__
		1499
		1500
		1501	Type: boolean
		1502	Default: no
		1503	If set to ``yes'', mutt will look for a mailcap entry with the copiousoutput flag set for ''every'' MIME attachment it doesn't have an internal viewer defined for. If such an entry is found, mutt will use the viewer defined in that entry to convert the body part to text form.
		1504
		1505
		1506	__include__
		1507
		1508
		1509	Type: quadoption
		1510	Default: ask-yes
		1511	Controls whether or not a copy of the message(s) you are replying to is included in your reply.
		1512
		1513
		1514	__indent_string__
		1515
		1516
		1517	Type: string
		1518	Default: ``
		1519	Specifies the string to prepend to each line of text quoted in a message to which you are replying. You are strongly encouraged not to change this value, as it tends to agitate the more fanatical netizens.
		1520
		1521
		1522	__index_format__
		1523
		1524
		1525	Type: string
		1526	Default: ``%4C %Z %{%b %d} %-15.15L (%4l) %s''
		1527	This variable allows you to customize the message index display to your personal taste.
		1528
		1529
		1530	``Format strings'' are similar to the strings used in the
		1531	``C'' function printf to format output (see the man page for
		1532	more detail). The following sequences are defined in
		1533	Mutt:
		1534
		1535
		1536	%a
		1537
		1538
		1539	address of the author
		1540
		1541
		1542	%b
		1543
		1544
		1545	filename of the original message folder (think
		1546	mailBox)
		1547
		1548
		1549	%B
		1550
		1551
		1552	the list to which the letter was sent, or else the folder
		1553	name (%b).
		1554
		1555
		1556	%c
		1557
		1558
		1559	number of characters (bytes) in the message
		1560
		1561
		1562	%C
		1563
		1564
		1565	current message number
		1566
		1567
		1568	%d
		1569
		1570
		1571	date and time of the message in the format specified by
		1572	``date_format'' converted to sender's time zone
		1573
		1574
		1575	%D
		1576
		1577
		1578	date and time of the message in the format specified by
		1579	``date_format'' converted to the local time
		1580	zone
		1581
		1582
		1583	%e
		1584
		1585
		1586	current message number in thread
		1587
		1588
		1589	%E
		1590
		1591
		1592	number of messages in current thread
		1593
		1594
		1595	%f
		1596
		1597
		1598	entire From: line (address + real name)
		1599
		1600
		1601	%F
		1602
		1603
		1604	author name, or recipient name if the message is from
		1605	you
		1606
		1607
		1608	%i
		1609
		1610
		1611	message-id of the current message
		1612
		1613
		1614	%l
		1615
		1616
		1617	number of lines in the message
		1618
		1619
		1620	%L
		1621
		1622
		1623	If an address in the To or CC header field matches an
		1624	address defined by the users ``lists'' command, this
		1625	displays ''To
		1626
		1627
		1628	%m
		1629
		1630
		1631	total number of message in the mailbox
		1632
		1633
		1634	%M
		1635
		1636
		1637	number of hidden messages if the thread is
		1638	collapsed.
		1639
		1640
		1641	%N
		1642
		1643
		1644	message score
		1645
		1646
		1647	%n
		1648
		1649
		1650	author's real name (or address if missing)
		1651
		1652
		1653	%O
		1654
		1655
		1656	(_O_riginal save folder) Where mutt would formerly have
		1657	stashed the message: list name or recipient name if no
		1658	list
		1659
		1660
		1661	%s
		1662
		1663
		1664	subject of the message
		1665
		1666
		1667	%S
		1668
		1669
		1670	status of the message (N/D/d/!/r/*)
		1671
		1672
		1673	%t
		1674
		1675
		1676	`to:' field (recipients)
		1677
		1678
		1679	%T
		1680
		1681
		1682	the appropriate character from the $to_chars
		1683	string
		1684
		1685
		1686	%u
		1687
		1688
		1689	user (login) name of the author
		1690
		1691
		1692	%v
		1693
		1694
		1695	first name of the author, or the recipient if the message is
		1696	from you
		1697
		1698
		1699	%y
		1700
		1701
		1702	`x-label:' field, if present
		1703
		1704
		1705	%Y
		1706
		1707
		1708	`x-label' field, if present, and (1) not at part of a thread
		1709	tree, (2) at the top of a thread, or (3) `x-label' is
		1710	different from preceding message's `x-label'.
		1711
		1712
		1713	%Z
		1714
		1715
		1716	message status flags
		1717
		1718
		1719	%{fmt}
		1720
		1721
		1722	the date and time of the message is converted to sender's
		1723	time zone, and ``fmt'' is expanded by the library function
		1724	``strftime''; a leading bang disables locales
		1725
		1726
		1727	%[[fmt]
		1728
		1729
		1730	the date and time of the message is converted to the local
		1731	time zone, and ``fmt'' is expanded by the library function
		1732	``strftime''; a leading bang disables locales
		1733
		1734
		1735	%(fmt)
		1736
		1737
		1738	the local date and time when the message was received.
		1739	``fmt'' is expanded by the library function ``strftime''; a
		1740	leading bang disables locales
		1741
		1742
		1743	%
		1744
		1745
		1746	the current local time. ``fmt'' is expanded by the library
		1747	function ``strftime''; a leading bang disables
		1748	locales.
		1749
		1750
		1751	%
		1752
		1753
		1754	right justify the rest of the string and pad with character
		1755	''X''
		1756
		1757
		1758	%|X
		1759
		1760
		1761	pad to the end of the line with character ''X''
		1762
		1763
		1764	See also: ``$to_chars''.
		1765
		1766
		1767	__ispell__
		1768
		1769
		1770	Type: path
		1771	Default: ``/usr/bin/ispell''
		1772	How to invoke ispell (GNU's spell-checking software).
		1773
		1774
		1775	__keep_flagged__
		1776
		1777
		1778	Type: boolean
		1779	Default: no
		1780	If set, read messages marked as flagged will not be moved from your spool mailbox to your ``$mbox'' mailbox, or as a result of a ``mbox-hook'' command.
		1781
		1782
		1783	__locale__
		1784
		1785
		1786	Type: string
		1787	Default: ``C''
		1788	The locale used by ''strftime(3)'' to format dates. Legal values are the strings your system accepts for the locale variable ''LC_TIME''.
		1789
		1790
		1791	__lookup_octetstream__
		1792
		1793
		1794	Type: boolean
		1795	Default: no
		1796	This variable controls whether ''application/octet-stream'' attachments should be dealt with especially. If set, Mutt will search the attempt to find a more suitable content type before viewing.
		1797
		1798
		1799	__mail_check__
		1800
		1801
		1802	Type: number
		1803	Default: 5
		1804	This variable configures how often (in seconds) mutt should look for new mail.
		1805
		1806
		1807	__mailcap_path__
		1808
		1809
		1810	Type: string
		1811	Default: ``''
		1812	This variable specifies which files to consult when attempting to display MIME bodies not directly supported by Mutt.
		1813
		1814
		1815	__mailcap_sanitize__
		1816
		1817
		1818	Type: boolean
		1819	Default: yes
		1820	If set, mutt will restrict possible characters in mailcap % expandos to a well-defined set of safe characters. This is the safe setting, but we are not sure it doesn't break some more advanced MIME stuff.
		1821
		1822
		1823	__DON'T CHANGE THIS SETTING UNLESS YOU ARE REALLY SURE WHAT
		1824	YOU ARE DOING!__
		1825
		1826
		1827	__maildir_trash__
		1828
		1829
		1830	Type: boolean
		1831	Default: no
		1832	If set, messages marked as deleted will be saved with the maildir (T)rashed flag instead of unlinked. __NOTE:__ this only applies to maildir-style mailboxes. Setting it will have no effect on other mailbox types.
		1833
		1834
		1835	__mark_old__
		1836
		1837
		1838	Type: boolean
		1839	Default: yes
		1840	Controls whether or not Mutt makes the distinction between ''new'' messages and ''old'' __unread__ messages. By default, Mutt will mark new messages as old if you exit a mailbox without reading them. The next time you start Mutt, the messages will show up with an ''O'' next to them in the index menu, indicating that they are old. In order to make Mutt treat all unread messages as new only, you can unset this variable.
		1841
		1842
		1843	__markers__
		1844
		1845
		1846	Type: boolean
		1847	Default: yes
		1848	Controls the display of wrapped lines in the internal pager. If set, a ``+'' marker is displayed at the beginning of wrapped lines. Also see the ``$smart_wrap'' variable.
		1849
		1850
		1851	__mask__
		1852
		1853
		1854	Type: regular expression
		1855	Default: ``!^.[[^.]''
		1856	A regular expression used in the file browser, optionally preceded by the ''not'' operator ``!''. Only files whose names match this mask will be shown. The match is always case-sensitive.
		1857
		1858
		1859	__mbox__
		1860
		1861
		1862	Type: path
		1863	Default: ``~/mbox''
		1864	This specifies the folder into which read mail in your ``$spoolfile'' folder will be appended.
		1865
		1866
		1867	__mbox_type__
		1868
		1869
		1870	Type: folder magic
		1871	Default: mbox
		1872	The default mailbox type used when creating new folders. May be any of mbox, MMDF, MH and Maildir.
		1873
		1874
		1875	__metoo__
		1876
		1877
		1878	Type: boolean
		1879	Default: no
		1880	If unset, Mutt will remove your address from the list of recipients when replying to a message.
		1881
		1882
		1883	__menu_scroll__
		1884
		1885
		1886	Type: boolean
		1887	Default: no
		1888	When ''set'', menus will be scrolled up or down one line when you attempt to move across a screen boundary. If ''unset'', the screen is cleared and the next or previous page of the menu is displayed (useful for slow links to avoid many redraws).
		1889
		1890
		1891	__meta_key__
		1892
		1893
		1894	Type: boolean
		1895	Default: no
		1896	If set, forces Mutt to interpret keystrokes with the high bit (bit 8) set as if the user had pressed the ESC key and whatever key remains after having the high bit removed. For example, if the key pressed has an ASCII value of 0xf4, then this is treated as if the user had pressed ESC then ``x''. This is because the result of removing the high bit from ``0xf4'' is ``0x74'', which is the ASCII character ``x''.
		1897
		1898
		1899	__mh_purge__
		1900
		1901
		1902	Type: boolean
		1903	Default: no
		1904	When unset, mutt will mimic mh's behaviour and rename deleted messages to '','' in mh folders instead of really deleting them. If the variable is set, the message files will simply be deleted.
		1905
		1906
		1907	__mh_seq_flagged__
		1908
		1909
		1910	Type: string
		1911	Default: ``flagged''
		1912	The name of the MH sequence used for flagged messages.
		1913
		1914
		1915	__mh_seq_replied__
		1916
		1917
		1918	Type: string
		1919	Default: ``replied''
		1920	The name of the MH sequence used to tag replied messages.
		1921
		1922
		1923	__mh_seq_unseen__
		1924
		1925
		1926	Type: string
		1927	Default: ``unseen''
		1928	The name of the MH sequence used for unseen messages.
		1929
		1930
		1931	__mime_forward__
		1932
		1933
		1934	Type: quadoption
		1935	Default: no
		1936	When set, the message you are forwarding will be attached as a separate MIME part instead of included in the main body of the message. This is useful for forwarding MIME messages so the receiver can properly view the message as it was delivered to you. If you like to switch between MIME and not MIME from mail to mail, set this variable to ask-no or ask-yes.
		1937
		1938
		1939	Also see ``$forward_decode'' and
		1940	``$mime_forward_decode''.
		1941
		1942
		1943	__mime_forward_decode__
		1944
		1945
		1946	Type: boolean
		1947	Default: no
		1948	Controls the decoding of complex MIME messages into text/plain when forwarding a message while ``$mime_forward'' is ''set''. Otherwise ``$forward_decode'' is used instead.
		1949
		1950
		1951	__mime_forward_rest__
		1952
		1953
		1954	Type: quadoption
		1955	Default: yes
		1956	When forwarding multiple attachments of a MIME message from the recvattach menu, attachments which cannot be decoded in a reasonable manner will be attached to the newly composed message if this option is set.
		1957
		1958
		1959	__mix_entry_format__
		1960
		1961
		1962	Type: string
		1963	Default: ``%4n %c %-16s %a''
		1964	This variable describes the format of a remailer line on the mixmaster chain selection screen. The following printf-like sequences are supported:
		1965
		1966
		1967	%n
		1968
		1969
		1970	The running number on the menu.
		1971
		1972
		1973	%c
		1974
		1975
		1976	Remailer capabilities.
		1977
		1978
		1979	%s
		1980
		1981
		1982	The remailer's short name.
		1983
		1984
		1985	%a
		1986
		1987
		1988	The remailer's e-mail address.
		1989
		1990
		1991	__mixmaster__
		1992
		1993
		1994	Type: path
		1995	Default: ``mixmaster''
		1996	This variable contains the path to the Mixmaster binary on your system. It is used with various sets of parameters to gather the list of known remailers, and to finally send a message through the mixmaster chain.
		1997
		1998
		1999	__move__
		2000
		2001
		2002	Type: quadoption
		2003	Default: ask-no
		2004	Controls whether you will be asked to confirm moving read messages from your spool mailbox to your ``$mbox'' mailbox, or as a result of a ``mbox-hook'' command.
		2005
		2006
		2007	__message_format__
		2008
		2009
		2010	Type: string
		2011	Default: ``%s''
		2012	This is the string displayed in the ``attachment'' menu for attachments of type message/rfc822. For a full listing of defined escape sequences see the section on ``$index_format''.
		2013
		2014
		2015	__pager__
		2016
		2017
		2018	Type: path
		2019	Default: ``builtin''
		2020	This variable specifies which pager you would like to use to view messages. builtin means to use the builtin pager, otherwise this variable should specify the pathname of the external pager you would like to use.
		2021
		2022
		2023	Using an external pager may have some disadvantages:
		2024	Additional keystrokes are necessary because you can't call
		2025	mutt functions directly from the pager, and screen resizes
		2026	cause lines longer than the screen width to be badly
		2027	formatted in the help menu.
		2028
		2029
		2030	__pager_context__
		2031
		2032
		2033	Type: number
		2034	Default: 0
		2035	This variable controls the number of lines of context that are given when displaying the next or previous page in the internal pager. By default, Mutt will display the line after the last one on the screen at the top of the next page (0 lines of context).
		2036
		2037
		2038	__pager_format__
		2039
		2040
		2041	Type: string
		2042	Default: ``-%Z- %C/%m: %-20.20n %s''
		2043	This variable controls the format of the one-line message ``status'' displayed before each message in either the internal or an external pager. The valid sequences are listed in the ``$index_format'' section.
		2044
		2045
		2046	__pager_index_lines__
		2047
		2048
		2049	Type: number
		2050	Default: 0
		2051	Determines the number of lines of a mini-index which is shown when in the pager. The current message, unless near the top or bottom of the folder, will be roughly one third of the way down this mini-index, giving the reader the context of a few messages before and after the message. This is useful, for example, to determine how many messages remain to be read in the current thread. One of the lines is reserved for the status bar from the index, so a ''pager_index_lines'' of 6 will only show 5 lines of the actual index. A value of 0 results in no index being shown. If the number of messages in the current folder is less than ''pager_index_lines'', then the index will only use as many lines as it needs.
		2052
		2053
		2054	__pager_stop__
		2055
		2056
		2057	Type: boolean
		2058	Default: no
		2059	When set, the internal-pager will __not__ move to the next message when you are at the end of a message and invoke the ''next-page'' function.
		2060
		2061
		2062	__pgp_autosign__
		2063
		2064
		2065	Type: boolean
		2066	Default: no
		2067	Setting this variable will cause Mutt to always attempt to PGP/MIME sign outgoing messages. This can be overridden by use of the ''pgp- menu'', when signing is not required or encryption is requested as well.
		2068
		2069
		2070	__pgp_autoencrypt__
		2071
		2072
		2073	Type: boolean
		2074	Default: no
		2075	Setting this variable will cause Mutt to always attempt to PGP/MIME encrypt outgoing messages. This is probably only useful in connection to the ''send-hook'' command. It can be overridden by use of the ''pgp-menu'', when encryption is not required or signing is requested as well.
		2076
		2077
		2078	__pgp_ignore_subkeys__
		2079
		2080
		2081	Type: boolean
		2082	Default: yes
		2083	Setting this variable will cause Mutt to ignore OpenPGP subkeys. Instead, the principal key will inherit the subkeys' capabilities. Unset this if you want to play interesting key selection games.
		2084
		2085
		2086	__pgp_entry_format__
		2087
		2088
		2089	Type: string
		2090	Default: ``%4n %t%f %4l/0x%k %-4a %2c %u''
		2091	This variable allows you to customize the PGP key selection menu to your personal taste. This string is similar to ``$index_format'', but has its own set of printf()-like sequences:
		2092
		2093
		2094	%n
		2095
		2096
		2097	number
		2098
		2099
		2100	%k
		2101
		2102
		2103	key id
		2104
		2105
		2106	%u
		2107
		2108
		2109	user id
		2110
		2111
		2112	%a
		2113
		2114
		2115	algorithm
		2116
		2117
		2118	%l
		2119
		2120
		2121	key length
		2122
		2123
		2124	%f
		2125
		2126
		2127	flags
		2128
		2129
		2130	%c
		2131
		2132
		2133	capabilities
		2134
		2135
		2136	%t
		2137
		2138
		2139	trust/validity of the key-uid association
		2140
		2141
		2142	%[[
		2143
		2144
		2145	date of the key where
		2146
		2147
		2148	__pgp_good_sign__
		2149
		2150
		2151	Type: regular expression
		2152	Default: ``''
		2153	If you assign a text to this variable, then a PGP signature is only considered verified if the output from $pgp_verify_command contains the text. Use this variable if the exit code from the command is 0 even for bad signatures.
		2154
		2155
		2156	__pgp_long_ids__
		2157
		2158
		2159	Type: boolean
		2160	Default: no
		2161	If set, use 64 bit PGP key IDs. Unset uses the normal 32 bit Key IDs.
		2162
		2163
		2164	__pgp_replyencrypt__
		2165
		2166
		2167	Type: boolean
		2168	Default: yes
		2169	If set, automatically PGP encrypt replies to messages which are encrypted.
		2170
		2171
		2172	__pgp_replysign__
		2173
		2174
		2175	Type: boolean
		2176	Default: no
		2177	If set, automatically PGP sign replies to messages which are signed.
		2178
		2179
		2180	__Note:__ this does not work on messages that are
		2181	encrypted __and__ signed!
		2182
		2183
		2184	__pgp_replysignencrypted__
		2185
		2186
		2187	Type: boolean
		2188	Default: no
		2189	If set, automatically PGP sign replies to messages which are encrypted. This makes sense in combination with ``$pgp_replyencrypt'', because it allows you to sign all messages which are automatically encrypted. This works around the problem noted in ``$pgp_replysign'', that mutt is not able to find out whether an encrypted message is also signed.
		2190
		2191
		2192	__pgp_retainable_sigs__
		2193
		2194
		2195	Type: boolean
		2196	Default: no
		2197	If set, signed and encrypted messages will consist of nested multipart/signed and multipart/encrypted body parts.
		2198
		2199
		2200	This is useful for applications like encrypted and signed
		2201	mailing lists, where the outer layer (multipart/encrypted)
		2202	can be easily removed, while the inner multipart/signed part
		2203	is retained.
		2204
		2205
		2206	__pgp_show_unusable__
		2207
		2208
		2209	Type: boolean
		2210	Default: yes
		2211	If set, mutt will display non-usable keys on the PGP key selection menu. This includes keys which have been revoked, have expired, or have been marked as ``disabled'' by the user.
		2212
		2213
		2214	__pgp_sign_as__
		2215
		2216
		2217	Type: string
		2218	Default: ``''
		2219	If you have more than one key pair, this option allows you to specify which of your private keys to use. It is recommended that you use the keyid form to specify your key (e.g., ``0x00112233'').
		2220
		2221
		2222	__pgp_strict_enc__
		2223
		2224
		2225	Type: boolean
		2226	Default: yes
		2227	If set, Mutt will automatically encode PGP/MIME signed messages as ''quoted-printable''. Please note that unsetting this variable may lead to problems with non-verifyable PGP signatures, so only change this if you know what you are doing.
		2228
		2229
		2230	__pgp_timeout__
		2231
		2232
		2233	Type: number
		2234	Default: 300
		2235	The number of seconds after which a cached passphrase will expire if not used.
		2236
		2237
		2238	__pgp_verify_sig__
		2239
		2240
		2241	Type: quadoption
		2242	Default: yes
		2243	If ``yes'', always attempt to verify PGP/MIME signatures. If ``ask-yes'' or ``ask-no'', ask whether or not to verify the signature. If ``no'', never attempt to verify PGP/MIME signatures.
		2244
		2245
		2246	__pgp_sort_keys__
		2247
		2248
		2249	Type: sort order
		2250	Default: address
		2251	Specifies how the entries in the `pgp keys' menu are sorted. The following are legal values:
		2252
		2253
		2254	address
		2255
		2256
		2257	sort alphabetically by user id
		2258
		2259
		2260	keyid
		2261
		2262
		2263	sort alphabetically by key id
		2264
		2265
		2266	date
		2267
		2268
		2269	sort by key creation date
		2270
		2271
		2272	trust
		2273
		2274
		2275	sort by the trust of the key
		2276
		2277
		2278	If you prefer reverse order of the above values, prefix it
		2279	with `reverse-'.
		2280
		2281
		2282	__pgp_create_traditional__
		2283
		2284
		2285	Type: quadoption
		2286	Default: no
		2287	This option controls whether Mutt generates old-style PGP encrypted or signed messages under certain circumstances.
		2288
		2289
		2290	Note that PGP/MIME will be used automatically for messages
		2291	which have a character set different from us-ascii, or which
		2292	consist of more than a single MIME part.
		2293
		2294
		2295	Also note that using the old-style PGP message format is
		2296	__strongly deprecated__.
		2297
		2298
		2299	__pgp_outlook_compat__
		2300
		2301
		2302	Type: quadoption
		2303	Default: no
		2304	If pgp_create_traditional is defined above, this option causes mutt to generate messages readable by users of MS Outlook using PGP.
		2305
		2306
		2307	__pgp_decode_command__
		2308
		2309
		2310	Type: string
		2311	Default: ``''
		2312	This format strings specifies a command which is used to decode application/pgp attachments.
		2313
		2314
		2315	The PGP command formats have their own set of printf-like
		2316	sequences:
		2317
		2318
		2319	%p
		2320
		2321
		2322	Expands to PGPPASSFD=0 when a pass phrase is needed, to an
		2323	empty string otherwise. Note: This may be used with a %?
		2324	construct.
		2325
		2326
		2327	%f
		2328
		2329
		2330	Expands to the name of a file containing a
		2331	message.
		2332
		2333
		2334	%s
		2335
		2336
		2337	Expands to the name of a file containing the signature part
		2338	of a multipart/signed attachment when verifying
		2339	it.
		2340
		2341
		2342	%a
		2343
		2344
		2345	The value of $pgp_sign_as.
		2346
		2347
		2348	%r
		2349
		2350
		2351	One or more key IDs.
		2352
		2353
		2354	For examples on how to configure these formats for the
		2355	various versions of PGP which are floating around, see the
		2356	pgp*.rc and gpg.rc files in the samples/ subdirectory which
		2357	has been installed on your system alongside the
		2358	documentation.
		2359
		2360
		2361	__pgp_getkeys_command__
		2362
		2363
		2364	Type: string
		2365	Default: ``''
		2366	This command is invoked whenever mutt will need public key information. %r is the only printf-like sequence used with this format.
		2367
		2368
		2369	__pgp_verify_command__
		2370
		2371
		2372	Type: string
		2373	Default: ``''
		2374	This command is used to verify PGP/MIME signatures.
		2375
		2376
		2377	__pgp_decrypt_command__
		2378
		2379
		2380	Type: string
		2381	Default: ``''
		2382	This command is used to decrypt a PGP/MIME encrypted message.
		2383
		2384
		2385	__pgp_clearsign_command__
		2386
		2387
		2388	Type: string
		2389	Default: ``''
		2390	This format is used to create a ''clearsigned'' old-style PGP attachment. Note that the use of this format is __strongly deprecated__.
		2391
		2392
		2393	__pgp_sign_command__
		2394
		2395
		2396	Type: string
		2397	Default: ``''
		2398	This command is used to create the detached PGP signature for a multipart/signed PGP/MIME body part.
		2399
		2400
		2401	__pgp_encrypt_sign_command__
		2402
		2403
		2404	Type: string
		2405	Default: ``''
		2406	This command is used to combinedly sign/encrypt a body part.
		2407
		2408
		2409	__pgp_encrypt_only_command__
		2410
		2411
		2412	Type: string
		2413	Default: ``''
		2414	This command is used to encrypt a body part without signing it.
		2415
		2416
		2417	__pgp_import_command__
		2418
		2419
		2420	Type: string
		2421	Default: ``''
		2422	This command is used to import a key from a message into the user's public key ring.
		2423
		2424
		2425	__pgp_export_command__
		2426
		2427
		2428	Type: string
		2429	Default: ``''
		2430	This command is used to export a public key from the user's key ring.
		2431
		2432
		2433	__pgp_verify_key_command__
		2434
		2435
		2436	Type: string
		2437	Default: ``''
		2438	This command is used to verify key information from the key selection menu.
		2439
		2440
		2441	__pgp_list_secring_command__
		2442
		2443
		2444	Type: string
		2445	Default: ``''
		2446	This command is used to list the secret key ring's contents. The output format must be analogous to the one used by gpg --list-keys --with-colons.
		2447
		2448
		2449	This format is also generated by the pgpring utility which
		2450	comes with mutt.
		2451
		2452
		2453	__pgp_list_pubring_command__
		2454
		2455
		2456	Type: string
		2457	Default: ``''
		2458	This command is used to list the public key ring's contents. The output format must be analogous to the one used by gpg --list-keys --with-colons.
		2459
		2460
		2461	This format is also generated by the pgpring utility which
		2462	comes with mutt.
		2463
		2464
		2465	__forward_decrypt__
		2466
		2467
		2468	Type: boolean
		2469	Default: yes
		2470	Controls the handling of encrypted messages when forwarding a message. When set, the outer layer of encryption is stripped off. This variable is only used if ``$mime_forward'' is ''set'' and ``$mime_forward_decode'' is ''unset''.
		2471
		2472
		2473	__ssl_starttls__
		2474
		2475
		2476	Type: quadoption
		2477	Default: yes
		2478	If set (the default), mutt will attempt to use STARTTLS on servers advertising the capability. When unset, mutt will not attempt to use STARTTLS regardless of the server's capabilities.
		2479
		2480
		2481	__certificate_file__
		2482
		2483
		2484	Type: path
		2485	Default: ``~/.mutt_certificates''
		2486	This variable specifies the file where the certificates you trust are saved. When an unknown certificate is encountered, you are asked if you accept it or not. If you accept it, the certificate can also be saved in this file and further connections are automatically accepted.
		2487
		2488
		2489	You can also manually add CA certificates in this file. Any
		2490	server certificate that is signed with one of these CA
		2491	certificates are also automatically accepted.
		2492
		2493
		2494	Example: set
		2495	certificate_file=~/.mutt/certificates
		2496
		2497
		2498	__ssl_usesystemcerts__
		2499
		2500
		2501	Type: boolean
		2502	Default: yes
		2503	If set to ''yes'', mutt will use CA certificates in the system-wide certificate store when checking if server certificate is signed by a trusted CA.
		2504
		2505
		2506	__entropy_file__
		2507
		2508
		2509	Type: path
		2510	Default: ``''
		2511	The file which includes random data that is used to initalize SSL library functions.
		2512
		2513
		2514	__ssl_use_sslv2__
		2515
		2516
		2517	Type: boolean
		2518	Default: yes
		2519	This variables specifies whether to attempt to use SSLv2 in the SSL authentication process.
		2520
		2521
		2522	__ssl_use_sslv3__
		2523
		2524
		2525	Type: boolean
		2526	Default: yes
		2527	This variables specifies whether to attempt to use SSLv3 in the SSL authentication process.
		2528
		2529
		2530	__ssl_use_tlsv1__
		2531
		2532
		2533	Type: boolean
		2534	Default: yes
		2535	This variables specifies whether to attempt to use TLSv1 in the SSL authentication process.
		2536
		2537
		2538	__pipe_split__
		2539
		2540
		2541	Type: boolean
		2542	Default: no
		2543	Used in connection with the ''pipe-message'' command and the ``tag- prefix'' operator. If this variable is unset, when piping a list of tagged messages Mutt will concatenate the messages and will pipe them as a single folder. When set, Mutt will pipe the messages one by one. In both cases the messages are piped in the current sorted order, and the ``$pipe_sep'' separator is added after each message.
		2544
		2545
		2546	__pipe_decode__
		2547
		2548
		2549	Type: boolean
		2550	Default: no
		2551	Used in connection with the ''pipe-message'' command. When unset, Mutt will pipe the messages without any preprocessing. When set, Mutt will weed headers and will attempt to PGP/MIME decode the messages first.
		2552
		2553
		2554	__pipe_sep__
		2555
		2556
		2557	Type: string
		2558	Default: ``n''
		2559	The separator to add between messages when piping a list of tagged messages to an external Unix command.
		2560
		2561
		2562	__pop_authenticators__
		2563
		2564
		2565	Type: string
		2566	Default: ``''
		2567	This is a colon-delimited list of authentication methods mutt may attempt to use to log in to an POP server, in the order mutt should try them. Authentication methods are either 'user', 'apop' or any SASL mechanism, eg 'digest-md5', 'gssapi' or 'cram-md5'. This parameter is case-insensitive. If this parameter is unset (the default) mutt will try all available methods, in order from most-secure to least-secure.
		2568
		2569
		2570	Example: set
		2571	pop_authenticators=''digest-md5:apop:user''
		2572
		2573
		2574	__pop_auth_try_all__
		2575
		2576
		2577	Type: boolean
		2578	Default: yes
		2579	If set, Mutt will try all available methods. When unset, Mutt will only fall back to other authentication methods if the previous methods are unavailable. If a method is available but authentication fails, Mutt will not connect to the POP server.
		2580
		2581
		2582	__pop_checkinterval__
		2583
		2584
		2585	Type: number
		2586	Default: 60
		2587	This variable configures how often (in seconds) POP should look for new mail.
		2588
		2589
		2590	__pop_delete__
		2591
		2592
		2593	Type: quadoption
		2594	Default: ask-no
		2595	If set, Mutt will delete successfully downloaded messages from the POP server when using the fetch-mail function. When unset, Mutt will download messages but also leave them on the POP server.
		2596
		2597
		2598	__pop_host__
		2599
		2600
		2601	Type: string
		2602	Default: ``''
		2603	The name of your POP server for the fetch-mail function. You can also specify an alternative port, username and password, ie:
		2604
		2605
		2606	[[pop[[s]://][[username[[:password]@]popserver[[:port]
		2607
		2608
		2609	__pop_last__
		2610
		2611
		2612	Type: boolean
		2613	Default: no
		2614	If this variable is set, mutt will try to use the ''LAST'' POP command for retrieving only unread messages from the POP server when using the fetch-mail function.
		2615
		2616
		2617	__pop_reconnect__
		2618
		2619
		2620	Type: quadoption
		2621	Default: ask-yes
		2622	Controls whether or not Mutt will try to reconnect to POP server when connection lost.
		2623
		2624
		2625	__pop_user__
		2626
		2627
		2628	Type: string
		2629	Default: ``''
		2630	Your login name on the POP server.
		2631
		2632
		2633	This variable defaults to your user name on the local
		2634	machine.
		2635
		2636
		2637	__pop_pass__
		2638
		2639
		2640	Type: string
		2641	Default: ``''
		2642	Specifies the password for your POP account. If unset, Mutt will prompt you for your password when you open POP mailbox. __Warning__: you should only use this option when you are on a fairly secure machine, because the superuser can read your muttrc even if you are the only one who can read the file.
		2643
		2644
		2645	__post_indent_string__
		2646
		2647
		2648	Type: string
		2649	Default: ``''
		2650	Similar to the ``$attribution'' variable, Mutt will append this string after the inclusion of a message which is being replied to.
		2651
		2652
		2653	__postpone__
		2654
		2655
		2656	Type: quadoption
		2657	Default: ask-yes
		2658	Controls whether or not messages are saved in the ``$postponed'' mailbox when you elect not to send immediately.
		2659
		2660
		2661	__postponed__
		2662
		2663
		2664	Type: path
		2665	Default: ``~/postponed''
		2666	Mutt allows you to indefinitely ``postpone sending a message'' which you are editing. When you choose to postpone a message, Mutt saves it in the mailbox specified by this variable. Also see the ``$postpone'' variable.
		2667
		2668
		2669	__preconnect__
		2670
		2671
		2672	Type: string
		2673	Default: ``''
		2674	If set, a shell command to be executed if mutt fails to establish a connection to the server. This is useful for setting up secure connections, e.g. with ssh(1). If the command returns a nonzero status, mutt gives up opening the server. Example:
		2675
		2676
		2677	preconnect=''ssh -f -q -L 1234:mailhost.net:143 mailhost.net
		2678	sleep 20
		2679
		2680
		2681	Mailbox 'foo' on mailhost.net can now be reached as
		2682	'{localhost:1234}foo'.
		2683
		2684
		2685	NOTE: For this example to work, you must be able to log in
		2686	to the remote machine without having to enter a
		2687	password.
		2688
		2689
		2690	__print__
		2691
		2692
		2693	Type: quadoption
		2694	Default: ask-no
		2695	Controls whether or not Mutt asks for confirmation before printing. This is useful for people (like me) who accidentally hit ``p'' often.
		2696
		2697
		2698	__print_command__
		2699
		2700
		2701	Type: path
		2702	Default: ``lpr''
		2703	This specifies the command pipe that should be used to print messages.
		2704
		2705
		2706	__print_decode__
		2707
		2708
		2709	Type: boolean
		2710	Default: yes
		2711	Used in connection with the print-message command. If this option is set, the message is decoded before it is passed to the external command specified by $print_command. If this option is unset, no processing will be applied to the message when printing it. The latter setting may be useful if you are using some advanced printer filter which is able to properly format e-mail messages for printing.
		2712
		2713
		2714	__print_split__
		2715
		2716
		2717	Type: boolean
		2718	Default: no
		2719	Used in connection with the print-message command. If this option is set, the command sepcified by $print_command is executed once for each message which is to be printed. If this option is unset, the command specified by $print_command is executed only once, and all the messages are concatenated, with a form feed as the message separator.
		2720
		2721
		2722	Those who use the enscript(1) program's mail-printing
		2723	mode will most likely want to set this option.
		2724
		2725
		2726	__prompt_after__
		2727
		2728
		2729	Type: boolean
		2730	Default: yes
		2731	If you use an ''external'' ``$pager'', setting this variable will cause Mutt to prompt you for a command when the pager exits rather than returning to the index menu. If unset, Mutt will return to the index menu when the external pager exits.
		2732
		2733
		2734	__query_command__
		2735
		2736
		2737	Type: path
		2738	Default: ``''
		2739	This specifies the command that mutt will use to make external address queries. The string should contain a %s, which will be substituted with the query string the user types. See ``query'' for more information.
		2740
		2741
		2742	__quit__
		2743
		2744
		2745	Type: quadoption
		2746	Default: yes
		2747	This variable controls whether ``quit'' and ``exit'' actually quit from mutt. If it set to yes, they do quit, if it is set to no, they have no effect, and if it is set to ask-yes or ask-no, you are prompted for confirmation when you try to quit.
		2748
		2749
		2750	__quote_regexp__
		2751
		2752
		2753	Type: regular expression
		2754	Default: ``^([[ t]*[[|
		2755	A regular expression used in the internal-pager to determine quoted sections of text in the body of a message.
		2756
		2757
		2758	__Note:__ In order to use the ''quoted''__x__
		2759	patterns in the internal pager, you need to set this to a
		2760	regular expression that matches ''exactly'' the quote
		2761	characters at the beginning of quoted lines.
		2762
		2763
		2764	__read_inc__
		2765
		2766
		2767	Type: number
		2768	Default: 10
		2769	If set to a value greater than 0, Mutt will display which message it is currently on when reading a mailbox. The message is printed after ''read_inc'' messages have been read (e.g., if set to 25, Mutt will print a message when it reads message 25, and then again when it gets to message 50). This variable is meant to indicate progress when reading large mailboxes which may take some time. When set to 0, only a single message will appear before the reading the mailbox.
		2770
		2771
		2772	Also see the ``$write_inc'' variable.
		2773
		2774
		2775	__read_only__
		2776
		2777
		2778	Type: boolean
		2779	Default: no
		2780	If set, all folders are opened in read-only mode.
		2781
		2782
		2783	__realname__
		2784
		2785
		2786	Type: string
		2787	Default: ``''
		2788	This variable specifies what ''real'' or ''personal'' name should be used when sending messages.
		2789
		2790
		2791	By default, this is the GCOS field from /etc/passwd. Note
		2792	that this variable will ''not'' be used when the user has
		2793	set a real name in the $from variable.
		2794
		2795
		2796	__recall__
		2797
		2798
		2799	Type: quadoption
		2800	Default: ask-yes
		2801	Controls whether or not you are prompted to recall postponed messages when composing a new message. Also see ``$postponed''.
		2802
		2803
		2804	Setting this variable to ``yes'' is not generally useful,
		2805	and thus not recommended.
		2806
		2807
		2808	__record__
		2809
		2810
		2811	Type: path
		2812	Default: ``''
		2813	This specifies the file into which your outgoing messages should be appended. (This is meant as the primary method for saving a copy of your messages, but another way to do this is using the ``my_hdr'' command to create a ''Bcc:'' field with your email address in it.)
		2814
		2815
		2816	The value of ''$record'' is overridden by the
		2817	``$force_name'' and ``$save_name'' variables, and the
		2818	``fcc-hook'' command.
		2819
		2820
		2821	__reply_regexp__
		2822
		2823
		2824	Type: regular expression
		2825	Default: ``^(re([[[[0-9]+])*|aw):[[ t]*''
		2826	A regular expression used to recognize reply messages when threading and replying. The default value corresponds to the English ''Re:'' and the German ''Aw:''.
		2827
		2828
		2829	__reply_self__
		2830
		2831
		2832	Type: boolean
		2833	Default: no
		2834	If unset and you are replying to a message sent by you, Mutt will assume that you want to reply to the recipients of that message rather than to yourself.
		2835
		2836
		2837	__reply_to__
		2838
		2839
		2840	Type: quadoption
		2841	Default: ask-yes
		2842	If set, Mutt will ask you if you want to use the address listed in the Reply-To: header field when replying to a message. If you answer no, it will use the address in the From: header field instead. This option is useful for reading a mailing list that sets the Reply-To: header field to the list address and you want to send a private message to the author of a message.
		2843
		2844
		2845	__resolve__
		2846
		2847
		2848	Type: boolean
		2849	Default: yes
		2850	When set, the cursor will be automatically advanced to the next (possibly undeleted) message whenever a command that modifies the current message is executed.
		2851
		2852
		2853	__reverse_alias__
		2854
		2855
		2856	Type: boolean
		2857	Default: no
		2858	This variable controls whether or not Mutt will display the ''personal'' name from your aliases in the index menu if it finds an alias that matches the message's sender. For example, if you have the following alias:
		2859
		2860
		2861	alias juser abd30425@somewhere.net (Joe User)
		2862
		2863
		2864	and then you receive mail which contains the following
		2865	header:
		2866
		2867
		2868	From: abd30425@somewhere.net
		2869
		2870
		2871	It would be displayed in the index menu as ``Joe User''
		2872	instead of ``abd30425@somewhere.net.'' This is useful when
		2873	the person's e-mail address is not human friendly (like
2	perry	2874	!CompuServe addresses).
1	perry	2875
		2876
		2877	__reverse_name__
		2878
		2879
		2880	Type: boolean
		2881	Default: no
		2882	It may sometimes arrive that you receive mail to a certain machine, move the messages to another machine, and reply to some the messages from there. If this variable is set, the default ''From:'' line of the reply messages is built using the address where you received the messages you are replying to. If the variable is unset, the ''From:'' line will use your address on the current machine.
		2883
		2884
		2885	__reverse_realname__
		2886
		2887
		2888	Type: boolean
		2889	Default: yes
		2890	This variable fine-tunes the behaviour of the reverse_name feature. When it is set, mutt will use the address from incoming messages as-is, possibly including eventual real names. When it is unset, mutt will override any such realnames with the setting of the realname variable.
		2891
		2892
		2893	__rfc2047_parameters__
		2894
		2895
		2896	Type: boolean
		2897	Default: no
		2898	When this variable is set, Mutt will decode RFC-2047-encoded MIME parameters. You want to set this variable when mutt suggests you to save attachments to files named like this: =?iso-8859-1?Q?file=5F=E4=5F991116=2Ezip?=
		2899
		2900
		2901	When this variable is set interactively, the change doesn't
		2902	have the desired effect before you have changed
		2903	folders.
		2904
		2905
		2906	Note that this use of RFC 2047's encoding is explicitly,
		2907	prohibited by the standard, but nevertheless encountered in
		2908	the wild. Also note that setting this parameter will
		2909	''not'' have the effect that mutt ''generates'' this
		2910	kind of encoding. Instead, mutt will unconditionally use the
		2911	encoding specified in RFC 2231.
		2912
		2913
		2914	__save_address__
		2915
		2916
		2917	Type: boolean
		2918	Default: no
		2919	If set, mutt will take the sender's full address when choosing a default folder for saving a mail. If ``$save_name'' or ``$force_name'' is set too, the selection of the fcc folder will be changed as well.
		2920
		2921
		2922	__save_empty__
		2923
		2924
		2925	Type: boolean
		2926	Default: yes
		2927	When unset, mailboxes which contain no saved messages will be removed when closed (the exception is ``$spoolfile'' which is never removed). If set, mailboxes are never removed.
		2928
		2929
		2930	__Note:__ This only applies to mbox and MMDF folders,
		2931	Mutt does not delete MH and Maildir
		2932	directories.
		2933
		2934
		2935	__save_name__
		2936
		2937
		2938	Type: boolean
		2939	Default: no
		2940	This variable controls how copies of outgoing messages are saved. When set, a check is made to see if a mailbox specified by the recipient address exists (this is done by searching for a mailbox in the ``$folder'' directory with the ''username'' part of the recipient address). If the mailbox exists, the outgoing message will be saved to that mailbox, otherwise the message is saved to the ``$record'' mailbox.
		2941
		2942
		2943	Also see the ``$force_name'' variable.
		2944
		2945
		2946	__score__
		2947
		2948
		2949	Type: boolean
		2950	Default: yes
		2951	When this variable is ''unset'', scoring is turned off. This can be useful to selectively disable scoring for certain folders when the ``$score_threshold_delete'' variable and friends are used.
		2952
		2953
		2954	__score_threshold_delete__
		2955
		2956
		2957	Type: number
		2958	Default: -1
		2959	Messages which have been assigned a score equal to or lower than the value of this variable are automatically marked for deletion by mutt. Since mutt scores are always greater than or equal to zero, the default setting of this variable will never mark a message for deletion.
		2960
		2961
		2962	__score_threshold_flag__
		2963
		2964
		2965	Type: number
		2966	Default: 9999
		2967	Messages wich have been assigned a score greater than or equal to this variable's value are automatically marked ''flagged''.
		2968
		2969
		2970	__score_threshold_read__
		2971
		2972
		2973	Type: number
		2974	Default: -1
		2975	Messages which have been assigned a score equal to or lower than the value of this variable are automatically marked as read by mutt. Since mutt scores are always greater than or equal to zero, the default setting of this variable will never mark a message read.
		2976
		2977
		2978	__send_charset__
		2979
		2980
		2981	Type: string
		2982	Default: ``us-ascii:iso-8859-1:utf-8''
		2983	A list of character sets for outgoing messages. Mutt will use the first character set into which the text can be converted exactly. If your ``$charset'' is not iso-8859-1 and recipients may not understand UTF-8, it is advisable to include in the list an appropriate widely used standard character set (such as iso-8859-2, koi8-r or iso-2022-jp) either instead of or after ''iso-8859-1''.
		2984
		2985
		2986	__sendmail__
		2987
		2988
		2989	Type: path
		2990	Default: ``/usr/sbin/sendmail -oem -oi''
		2991	Specifies the program and arguments used to deliver mail sent by Mutt. Mutt expects that the specified program interprets additional arguments as recipient addresses.
		2992
		2993
		2994	__sendmail_wait__
		2995
		2996
		2997	Type: number
		2998	Default: 0
		2999	Specifies the number of seconds to wait for the ``$sendmail'' process to finish before giving up and putting delivery in the background.
		3000
		3001
		3002	Mutt interprets the value of this variable as
		3003	follows:
		3004
		3005
		3006
		3007
		3008	number of seconds to wait for sendmail to finish before
		3009	continuing
		3010
		3011
		3012	0
		3013
		3014
		3015	wait forever for sendmail to finish
		3016
		3017
		3018
		3019
		3020	always put sendmail in the background without
		3021	waiting
		3022
		3023
		3024	Note that if you specify a value other than 0, the output of
		3025	the child process will be put in a temporary file. If there
		3026	is some error, you will be informed as to where to find the
		3027	output.
		3028
		3029
		3030	__shell__
		3031
		3032
		3033	Type: path
		3034	Default: ``''
		3035	Command to use when spawning a subshell. By default, the user's login shell from /etc/passwd is used.
		3036
		3037
		3038	__sig_dashes__
		3039
		3040
		3041	Type: boolean
		3042	Default: yes
		3043	If set, a line containing ``-- '' will be inserted before your ``$signature''. It is __strongly__ recommended that you not unset this variable unless your ``signature'' contains just your name. The reason for this is because many software packages use ``-- n'' to detect your signature. For example, Mutt has the ability to highlight the signature in a different color in the builtin pager.
		3044
		3045
		3046	__sig_on_top__
		3047
		3048
		3049	Type: boolean
		3050	Default: no
		3051	If set, the signature will be included before any quoted or forwarded text. It is __strongly__ recommended that you do not set this variable unless you really know what you are doing, and are prepared to take some heat from netiquette guardians.
		3052
		3053
		3054	__signature__
		3055
		3056
		3057	Type: path
		3058	Default: ``~/.signature''
		3059	Specifies the filename of your signature, which is appended to all outgoing messages. If the filename ends with a pipe (``|''), it is assumed that filename is a shell command and input should be read from its stdout.
		3060
		3061
		3062	__simple_search__
		3063
		3064
		3065	Type: string
		3066	Default: ``~f %s | ~s %s''
		3067	Specifies how Mutt should expand a simple search into a real search pattern. A simple search is one that does not contain any of the ~ operators. See ``patterns'' for more information on search patterns.
		3068
		3069
		3070	For example, if you simply type joe at a search or limit
		3071	prompt, Mutt will automatically expand it to the value
		3072	specified by this variable. For the default value it would
		3073	be:
		3074
		3075
		3076	~f joe | ~s joe
		3077
		3078
		3079	__smart_wrap__
		3080
		3081
		3082	Type: boolean
		3083	Default: yes
		3084	Controls the display of lines longer then the screen width in the internal pager. If set, long lines are wrapped at a word boundary. If unset, lines are simply wrapped at the screen edge. Also see the ``$markers'' variable.
		3085
		3086
		3087	__smileys__
		3088
		3089
		3090	Type: regular expression
		3091	Default: ``(
		3092	The ''pager'' uses this variable to catch some common false positives of ``$quote_regexp'', most notably smileys in the beginning of a line
		3093
		3094
		3095	__sleep_time__
		3096
		3097
		3098	Type: number
		3099	Default: 1
		3100	Specifies time, in seconds, to pause while displaying certain informational messages, while moving from folder to folder and after expunging messages from the current folder. The default is to pause one second, so a value of zero for this option suppresses the pause.
		3101
		3102
		3103	__sort__
		3104
		3105
		3106	Type: sort order
		3107	Default: date
		3108	Specifies how to sort messages in the ''index'' menu. Valid values are:
		3109
		3110
		3111	date or date-sent
		3112	date-received
		3113	from
		3114	mailbox-order (unsorted)
		3115	score
		3116	size
		3117	subject
		3118	threads
		3119	to
		3120
		3121
		3122	You may optionally use the reverse- prefix to specify
		3123	reverse sorting order (example: set
		3124	sort=reverse-date-sent).
		3125
		3126
		3127	__sort_alias__
		3128
		3129
		3130	Type: sort order
		3131	Default: alias
		3132	Specifies how the entries in the `alias' menu are sorted. The following are legal values:
		3133
		3134
		3135	address (sort alphabetically by email address)
		3136	alias (sort alphabetically by alias name)
		3137	unsorted (leave in order specified in .muttrc)
		3138
		3139
		3140	__sort_aux__
		3141
		3142
		3143	Type: sort order
		3144	Default: date
		3145	When sorting by threads, this variable controls how threads are sorted in relation to other threads, and how the branches of the thread trees are sorted. This can be set to any value that ``$sort'' can, except threads (in that case, mutt will just use date-sent). You can also specify the last- prefix in addition to the reverse- prefix, but last- must come after reverse-. The last- prefix causes messages to be sorted against its siblings by which has the last descendant, using the rest of sort_aux as an ordering. For instance, set sort_aux=last- date-received would mean that if a new message is received in a thread, that thread becomes the last one displayed (or the first, if you have set sort=reverse-threads.) Note: For reversed ``$sort'' order $sort_aux is reversed again (which is not the right thing to do, but kept to not break any existing configuration setting).
		3146
		3147
		3148	__sort_browser__
		3149
		3150
		3151	Type: sort order
		3152	Default: subject
		3153	Specifies how to sort entries in the file browser. By default, the entries are sorted alphabetically. Valid values:
		3154
		3155
		3156	alpha (alphabetically)
		3157	date
		3158	size
		3159	unsorted
		3160
		3161
		3162	You may optionally use the reverse- prefix to specify
		3163	reverse sorting order (example: set
		3164	sort_browser=reverse-date).
		3165
		3166
		3167	__sort_re__
		3168
		3169
		3170	Type: boolean
		3171	Default: yes
		3172	This variable is only useful when sorting by threads with ``$strict_threads'' unset. In that case, it changes the heuristic mutt uses to thread messages by subject. With sort_re set, mutt will only attach a message as the child of another message by subject if the subject of the child message starts with a substring matching the setting of ``$reply_regexp''. With sort_re unset, mutt will attach the message whether or not this is the case, as long as the non-``$reply_regexp'' parts of both messages are identical.
		3173
		3174
		3175	__spoolfile__
		3176
		3177
		3178	Type: path
		3179	Default: ``''
		3180	If your spool mailbox is in a non-default place where Mutt cannot find it, you can specify its location with this variable. Mutt will automatically set this variable to the value of the environment variable $MAIL if it is not set.
		3181
		3182
		3183	__status_chars__
		3184
		3185
		3186	Type: string
		3187	Default: ``-*%A''
		3188	Controls the characters used by the ''%r'' indicator in ``$status_format''. The first character is used when the mailbox is unchanged. The second is used when the mailbox has been changed, and it needs to be resynchronized. The third is used if the mailbox is in read-only mode, or if the mailbox will not be written when exiting that mailbox (You can toggle whether to write changes to a mailbox with the toggle-write operation, bound by default to ''%''). The fourth is used to indicate that the current folder has been opened in attach- message mode (Certain operations like composing a new mail, replying, forwarding, etc. are not permitted in this mode).
		3189
		3190
		3191	__status_format__
		3192
		3193
		3194	Type: string
		3195	Default: ``-%r-Mutt: %f [[Msgs:%?M?%M/?%m%?n? New:%n?%?o? Old:%o?%?d? Del:%d?%?F? Flag:%F?%?t? Tag:%t?%?p? Post:%p?%?b? Inc:%b?%?l? %l?]---(%s/%S)-%
		3196	Controls the format of the status line displayed in the ''index'' menu. This string is similar to ``$index_format'', but has its own set of printf()-like sequences:
		3197
		3198
		3199	%b
		3200
		3201
		3202	number of mailboxes with new mail *
		3203
		3204
		3205	%d
		3206
		3207
		3208	number of deleted messages *
		3209
		3210
		3211	%h
		3212
		3213
		3214	local hostname
		3215
		3216
		3217	%f
		3218
		3219
		3220	the full pathname of the current mailbox
		3221
		3222
		3223	%F
		3224
		3225
		3226	number of flagged messages *
		3227
		3228
		3229	%l
		3230
		3231
		3232	size (in bytes) of the current mailbox *
		3233
		3234
		3235	%L
		3236
		3237
		3238	size (in bytes) of the messages shown (i.e., which match the
		3239	current limit) *
		3240
		3241
		3242	%m
		3243
		3244
		3245	the number of messages in the mailbox *
		3246
		3247
		3248	%M
		3249
		3250
		3251	the number of messages shown (i.e., which match the current
		3252	limit) *
		3253
		3254
		3255	%n
		3256
		3257
		3258	number of new messages in the mailbox *
		3259
		3260
		3261	%o
		3262
		3263
		3264	number of old unread messages
		3265
		3266
		3267	%p
		3268
		3269
		3270	number of postponed messages *
		3271
		3272
		3273	%P
		3274
		3275
		3276	percentage of the way through the index
		3277
		3278
		3279	%r
		3280
		3281
		3282	modified/read-only/won't-write/attach-message indicator,
		3283	according to $status_chars
		3284
		3285
		3286	%s
		3287
		3288
		3289	current sorting mode ($sort)
		3290
		3291
		3292	%S
		3293
		3294
		3295	current aux sorting method ($sort_aux)
		3296
		3297
		3298	%t
		3299
		3300
		3301	number of tagged messages *
		3302
		3303
		3304	%u
		3305
		3306
		3307	number of unread messages *
		3308
		3309
		3310	%v
		3311
		3312
		3313	Mutt version string
		3314
		3315
		3316	%V
		3317
		3318
		3319	currently active limit pattern, if any *
		3320
		3321
		3322	%
		3323
		3324
		3325	right justify the rest of the string and pad with
		3326	''X''
		3327
		3328
		3329	%|X
		3330
		3331
		3332	pad to the end of the line with ''X''
		3333
		3334
		3335	* = can be optionally printed if nonzero
		3336
		3337
		3338	Some of the above sequences can be used to optionally print
		3339	a string if their value is nonzero. For example, you may
		3340	only want to see the number of flagged messages if such
		3341	messages exist, since zero is not particularly meaningful.
		3342	To optionally print a string based upon one of the above
		3343	sequences, the following construct is used
		3344
		3345
		3346	%?
		3347
		3348
		3349	where ''sequence_char'' is a character from the table
		3350	above, and ''optional_string'' is the string you would
		3351	like printed if ''status_char'' is nonzero.
		3352	''optional_string'' __may__ contain other sequence as
		3353	well as normal text, but you may __not__ nest optional
		3354	strings.
		3355
		3356
		3357	Here is an example illustrating how to optionally print the
		3358	number of new messages in a mailbox: %?n?%n new
		3359	messages.?
		3360
		3361
		3362	Additionally you can switch between two strings, the first
		3363	one, if a value is zero, the second one, if the value is
		3364	nonzero, by using the following construct:
		3365	%?
		3366
		3367
		3368	You can additionally force the result of any printf-like
		3369	sequence to be lowercase by prefixing the sequence character
		3370	with an underscore (_) sign. For example, if you want to
		3371	display the local hostname in lowercase, you would use:
		3372	%_h
		3373
		3374
		3375	__status_on_top__
		3376
		3377
		3378	Type: boolean
		3379	Default: no
		3380	Setting this variable causes the ``status bar'' to be displayed on the first line of the screen rather than near the bottom.
		3381
		3382
		3383	__strict_threads__
		3384
		3385
		3386	Type: boolean
		3387	Default: no
		3388	If set, threading will only make use of the ``In-Reply-To'' and ``References'' fields when you ``$sort'' by message threads. By default, messages with the same subject are grouped together in ``pseudo threads.'' This may not always be desirable, such as in a personal mailbox where you might have several unrelated messages with the subject ``hi'' which will get grouped together.
		3389
		3390
		3391	__suspend__
		3392
		3393
		3394	Type: boolean
		3395	Default: yes
		3396	When ''unset'', mutt won't stop when the user presses the terminal's ''susp'' key, usually ``control-Z''. This is useful if you run mutt inside an xterm using a command like xterm -e mutt.
		3397
		3398
		3399	__text_flowed__
		3400
		3401
		3402	Type: boolean
		3403	Default: no
		3404	When set, mutt will generate text/plain; format=flowed attachments. This format is easier to handle for some mailing software, and generally just looks like ordinary text. To actually make use of this format's features, you'll need support in your editor.
		3405
		3406
		3407	Note that $indent_string is ignored when this option is
		3408	set.
		3409
		3410
		3411	__thread_received__
		3412
		3413
		3414	Type: boolean
		3415	Default: no
		3416	When set, mutt uses the date received rather than the date sent to thread messages by subject.
		3417
		3418
		3419	__thorough_search__
		3420
		3421
		3422	Type: boolean
		3423	Default: no
		3424	Affects the ''~b'' and ''~h'' search operations described in section ``patterns'' above. If set, the headers and attachments of messages to be searched are decoded before searching. If unset, messages are searched as they appear in the folder.
		3425
		3426
		3427	__tilde__
		3428
		3429
		3430	Type: boolean
		3431	Default: no
		3432	When set, the internal-pager will pad blank lines to the bottom of the screen with a tilde (~).
		3433
		3434
		3435	__timeout__
		3436
		3437
		3438	Type: number
		3439	Default: 600
		3440	This variable controls the ''number of seconds'' Mutt will wait for a key to be pressed in the main menu before timing out and checking for new mail. A value of zero or less will cause Mutt not to ever time out.
		3441
		3442
		3443	__tmpdir__
		3444
		3445
		3446	Type: path
		3447	Default: ``''
		3448	This variable allows you to specify where Mutt will place its temporary files needed for displaying and composing messages.
		3449
		3450
		3451	__to_chars__
		3452
		3453
		3454	Type: string
		3455	Default: `` +TCFL''
		3456	Controls the character used to indicate mail addressed to you. The first character is the one used when the mail is NOT addressed to your address (default: space). The second is used when you are the only recipient of the message (default: +). The third is when your address appears in the TO header field, but you are not the only recipient of the message (default: T). The fourth character is used when your address is specified in the CC header field, but you are not the only recipient. The fifth character is used to indicate mail that was sent by ''you''. The sixth character is used to indicate when a mail was sent to a mailing-list you subscribe to (default: L).
		3457
		3458
		3459	__tunnel__
		3460
		3461
		3462	Type: string
		3463	Default: ``''
		3464	Setting this variable will cause mutt to open a pipe to a command instead of a raw socket. You may be able to use this to set up preauthenticated connections to your IMAP/POP3 server. Example:
		3465
		3466
		3467	tunnel=''ssh -q mailhost.net
		3468	/usr/local/libexec/imapd''
		3469
		3470
		3471	NOTE: For this example to work you must be able to log in to
		3472	the remote machine without having to enter a
		3473	password.
		3474
		3475
		3476	__use_8bitmime__
		3477
		3478
		3479	Type: boolean
		3480	Default: no
		3481	__Warning:__ do not set this variable unless you are using a version of sendmail which supports the -B8BITMIME flag (such as sendmail 8.8.x) or you may not be able to send mail.
		3482
		3483
		3484	When ''set'', Mutt will invoke ``$sendmail'' with the
		3485	-B8BITMIME flag when sending 8-bit messages to enable ESMTP
		3486	negotiation.
		3487
		3488
		3489	__use_domain__
		3490
		3491
		3492	Type: boolean
		3493	Default: yes
		3494	When set, Mutt will qualify all local addresses (ones without the @host portion) with the value of ``$hostname''. If ''unset'', no addresses will be qualified.
		3495
		3496
		3497	__use_from__
		3498
		3499
		3500	Type: boolean
		3501	Default: yes
		3502	When ''set'', Mutt will generate the `From:' header field when sending messages. If ''unset'', no `From:' header field will be generated unless the user explicitly sets one using the ``my_hdr'' command.
		3503
		3504
		3505	__use_ipv6__
		3506
		3507
		3508	Type: boolean
		3509	Default: yes
		3510	When ''set'', Mutt will look for IPv6 addresses of hosts it tries to contact. If this option is unset, Mutt will restrict itself to IPv4 addresses. Normally, the default should work.
		3511
		3512
		3513	__user_agent__
		3514
		3515
		3516	Type: boolean
		3517	Default: yes
		3518	When ''set'', mutt will add a ''User-Agent'' header to outgoing messages, indicating which version of mutt was used for composing them.
		3519
		3520
		3521	__visual__
		3522
		3523
		3524	Type: path
		3525	Default: ``''
		3526	Specifies the visual editor to invoke when the ''~v'' command is given in the builtin editor.
		3527
		3528
		3529	__wait_key__
		3530
		3531
		3532	Type: boolean
		3533	Default: yes
		3534	Controls whether Mutt will ask you to press a key after ''shell- escape'', ''pipe-message'', ''pipe-entry'', ''print-message'', and ''print-entry'' commands.
		3535
		3536
		3537	It is also used when viewing attachments with ``auto_view'',
		3538	provided that the corresponding mailcap entry has a
		3539	''needsterminal'' flag, and the external program is
		3540	interactive.
		3541
		3542
		3543	When set, Mutt will always ask for a key. When unset, Mutt
		3544	will wait for a key only if the external command returned a
		3545	non-zero status.
		3546
		3547
		3548	__weed__
		3549
		3550
		3551	Type: boolean
		3552	Default: yes
		3553	When set, mutt will weed headers when when displaying, forwarding, printing, or replying to messages.
		3554
		3555
		3556	__wrap_search__
		3557
		3558
		3559	Type: boolean
		3560	Default: yes
		3561	Controls whether searches wrap around the end of the mailbox.
		3562
		3563
		3564	When set, searches will wrap around the first (or last)
		3565	message. When unset, searches will not wrap.
		3566
		3567
		3568	__wrapmargin__
		3569
		3570
		3571	Type: number
		3572	Default: 0
		3573	Controls the margin left at the right side of the terminal when mutt's pager does smart wrapping.
		3574
		3575
		3576	__write_inc__
		3577
		3578
		3579	Type: number
		3580	Default: 10
		3581	When writing a mailbox, a message will be printed every ''write_inc'' messages to indicate progress. If set to 0, only a single message will be displayed before writing a mailbox.
		3582
		3583
		3584	Also see the ``$read_inc'' variable.
		3585
		3586
		3587	__write_bcc__
		3588
		3589
		3590	Type: boolean
		3591	Default: yes
		3592	Controls whether mutt writes out the Bcc header when preparing messages to be sent. Exim users may wish to use this.
		3593
		3594
		3595	__xterm_icon__
		3596
		3597
		3598	Type: string
		3599	Default: ``M%?n?AIL
		3600	Controls the format of the icon title, as long as xterm_set_titles is enabled. This string is identical in formatting to the one used by ``$status_format''.
		3601
		3602
		3603	__xterm_set_titles__
		3604
		3605
		3606	Type: boolean
		3607	Default: no
		3608	Controls whether mutt sets the xterm title bar and icon name (as long as you're in an appropriate terminal). The default must be off to force in the validity checking.
		3609
		3610
		3611	__xterm_title__
		3612
		3613
		3614	Type: string
		3615	Default: ``Mutt with %?m?%m messages
		3616	Controls the format of the title bar of the xterm provided that xterm_set_titles has been set. This string is identical in formatting to the one used by ``$status_format''.
		3617	!!SEE ALSO
		3618
		3619
		3620	iconv(1), iconv(3), mailcap(5),
		3621	maildir(5), mbox(5), mutt(1),
		3622	printf(3), regex(7),
		3623	strftime(3)
		3624
		3625
		3626	The Mutt Manual
		3627
		3628
		3629	The Mutt home page: http://www.mutt.org/
		3630	!!AUTHOR
		3631
		3632
		3633	Michael Elkins, and others. Use
		3634	----