~ubuntu-dev/ubuntu/lucid/mutt/lucid-201002110857 : revision 1.1.10

1

/*

2

3

4

*

5

* This program is free software; you can redistribute it and/or modify

102

{ "alias_file", DT_PATH, R_NONE, UL &AliasFile, UL "~/.muttrc" },

103

/*

104

** .pp

105

** The default file in which to save aliases created by the

106

** ``$create-alias'' function.

105

** The default file in which to save aliases created by the

106

** \fC$<create-alias>\fP function. Entries added to this file are

107

** encoded in the character set specified by $$config_charset if it

108

** is \fIset\fP or the current character set otherwise.

107

109

** .pp

108

110

** \fBNote:\fP Mutt will not automatically source this file; you must

109

** explicitly use the ``$source'' command for it to be executed.

111

** explicitly use the ``$source'' command for it to be executed in case

112

** this option points to a dedicated alias file.

110

113

** .pp

111

114

** The default for this option is the currently used muttrc file, or

112

115

** ``~/.muttrc'' if no user muttrc was found.

114

117

{ "alias_format", DT_STR, R_NONE, UL &AliasFmt, UL "%4n %2f %t %-10a %r" },

115

118

/*

116

119

** .pp

117

** Specifies the format of the data displayed for the `alias' menu. The

118

** following printf(3)-style sequences are available:

119

** .pp

120

** Specifies the format of the data displayed for the ``$alias'' menu. The

121

** following \fCprintf(3)\fP-style sequences are available:

120

122

** .dl

121

123

** .dt %a .dd alias name

122

** .dt %f .dd flags - currently, a "d" for an alias marked for deletion

124

** .dt %f .dd flags - currently, a ``d'' for an alias marked for deletion

123

125

** .dt %n .dd index number

124

126

** .dt %r .dd address which alias expands to

125

127

** .dt %t .dd character which indicates if the alias is tagged for inclusion

134

136

{ "allow_ansi", DT_BOOL, R_NONE, OPTALLOWANSI, 0 },

135

137

/*

136

138

** .pp

137

** Controls whether ANSI color codes in messages (and color tags in

139

** Controls whether ANSI color codes in messages (and color tags in

138

140

** rich text messages) are to be interpreted.

139

** Messages containing these codes are rare, but if this option is set,

141

** Messages containing these codes are rare, but if this option is \fIset\fP,

140

142

** their text will be colored accordingly. Note that this may override

141

143

** your color choices, and even present a security problem, since a

142

** message could include a line like "[-- PGP output follows ..." and

143

** give it the same color as your attachment color.

144

** message could include a line like

145

** .ts

146

** [-- PGP output follows ...

147

** .te

148

** .pp

149

** and give it the same color as your attachment color (see also

150

** $$crypt_timestamp).

144

151

*/

145

152

{ "arrow_cursor", DT_BOOL, R_BOTH, OPTARROWCURSOR, 0 },

146

153

/*

147

154

** .pp

148

** When set, an arrow (``->'') will be used to indicate the current entry

155

** When \fIset\fP, an arrow (``->'') will be used to indicate the current entry

149

156

** in menus instead of highlighting the whole line. On slow network or modem

150

157

** links this will make response faster because there is less that has to

151

158

** be redrawn on the screen when moving to the next or previous entries

154

161

{ "ascii_chars", DT_BOOL, R_BOTH, OPTASCIICHARS, 0 },

155

162

/*

156

163

** .pp

157

** If set, Mutt will use plain ASCII characters when displaying thread

164

** If \fIset\fP, Mutt will use plain ASCII characters when displaying thread

158

165

** and attachment trees, instead of the default \fIACS\fP characters.

159

166

*/

160

167

{ "askbcc", DT_BOOL, R_NONE, OPTASKBCC, 0 },

161

168

/*

162

169

** .pp

163

** If set, Mutt will prompt you for blind-carbon-copy (Bcc) recipients

170

** If \fIset\fP, Mutt will prompt you for blind-carbon-copy (Bcc) recipients

164

171

** before editing an outgoing message.

165

172

*/

166

173

{ "askcc", DT_BOOL, R_NONE, OPTASKCC, 0 },

167

174

/*

168

175

** .pp

169

** If set, Mutt will prompt you for carbon-copy (Cc) recipients before

176

** If \fIset\fP, Mutt will prompt you for carbon-copy (Cc) recipients before

170

177

** editing the body of an outgoing message.

171

*/

178

*/

172

179

{ "assumed_charset", DT_STR, R_NONE, UL &AssumedCharset, UL 0},

173

180

/*

174

181

** .pp

177

184

** Header field values and message body content without character encoding

178

185

** indication would be assumed that they are written in one of this list.

179

186

** By default, all the header fields and message body without any charset

180

** indication are assumed to be in "us-ascii".

187

** indication are assumed to be in ``us-ascii''.

181

188

** .pp

182

189

** For example, Japanese users might prefer this:

183

** .pp

184

** set assumed_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"

190

** .ts

191

** set assumed_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"

192

** .te

185

193

** .pp

186

194

** However, only the first content is valid for the message body.

187

195

*/

190

198

** .pp

191

199

** This variable is a colon-separated list of character encoding

192

200

** schemes for text file attachments.

193

** If unset, $$charset value will be used instead.

201

** If \fIunset\fP, the value of $$charset will be used instead.

194

202

** For example, the following configuration would work for Japanese

195

203

** text handling:

196

** .pp

197

** set attach_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"

198

** .pp

199

** Note: "iso-2022-*" must be put at the head of the value as shown above

200

** if included.

204

** .ts

205

** set attach_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"

206

** .te

207

** .pp

208

** Note: for Japanese users, ``iso-2022-*'' must be put at the head

209

** of the value as shown above if included.

201

210

*/

202

211

{ "attach_format", DT_STR, R_NONE, UL &AttachFormat, UL "%u%D%I %t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] " },

203

212

/*

204

213

** .pp

205

** This variable describes the format of the `attachment' menu. The

206

** following printf-style sequences are understood:

207

** .pp

214

** This variable describes the format of the ``attachment'' menu. The

215

** following \fCprintf(3)\fP-style sequences are understood:

208

216

** .dl

209

217

** .dt %C .dd charset

210

** .dt %c .dd requires charset conversion (n or c)

218

** .dt %c .dd requires charset conversion (``n'' or ``c'')

211

219

** .dt %D .dd deleted flag

212

220

** .dt %d .dd description

213

221

** .dt %e .dd MIME content-transfer-encoding

214

222

** .dt %f .dd filename

215

** .dt %I .dd disposition (I=inline, A=attachment)

223

** .dt %I .dd disposition (``I'' for inline, ``A'' for attachment)

216

224

** .dt %m .dd major MIME type

217

225

** .dt %M .dd MIME subtype

218

226

** .dt %n .dd attachment number

219

** .dt %Q .dd "Q", if MIME part qualifies for attachment counting

227

** .dt %Q .dd ``Q'', if MIME part qualifies for attachment counting

220

228

** .dt %s .dd size

221

229

** .dt %t .dd tagged flag

222

230

** .dt %T .dd graphic tree characters

223

231

** .dt %u .dd unlink (=to delete) flag

224

232

** .dt %X .dd number of qualifying MIME parts in this part and its children

225

233

** (please see the ``$attachments'' section for possible speed effects)

226

** .dt %>X .dd right justify the rest of the string and pad with character "X"

227

** .dt %|X .dd pad to the end of the line with character "X"

228

** .dt %*X .dd soft-fill with character "X" as pad

234

** .dt %>X .dd right justify the rest of the string and pad with character ``X''

235

** .dt %|X .dd pad to the end of the line with character ``X''

236

** .dt %*X .dd soft-fill with character ``X'' as pad

229

237

** .de

230

238

** .pp

231

** For an explanation of `soft-fill', see the ``$$index_format'' documentation.

239

** For an explanation of ``soft-fill'', see the $$index_format documentation.

232

240

*/

233

241

{ "attach_sep", DT_STR, R_NONE, UL &AttachSep, UL "\n" },

234

242

/*

239

247

{ "attach_split", DT_BOOL, R_NONE, OPTATTACHSPLIT, 1 },

240

248

/*

241

249

** .pp

242

** If this variable is unset, when operating (saving, printing, piping,

250

** If this variable is \fIunset\fP, when operating (saving, printing, piping,

243

251

** etc) on a list of tagged attachments, Mutt will concatenate the

244

252

** attachments and will operate on them as a single attachment. The

245

** ``$$attach_sep'' separator is added after each attachment. When set,

253

** $$attach_sep separator is added after each attachment. When \fIset\fP,

246

254

** Mutt will operate on the attachments one by one.

247

255

*/

248

256

{ "attribution", DT_STR, R_NONE, UL &Attribution, UL "On %d, %n wrote:" },

249

257

/*

250

258

** .pp

251

259

** This is the string that will precede a message which has been included

252

** in a reply. For a full listing of defined printf()-like sequences see

253

** the section on ``$$index_format''.

260

** in a reply. For a full listing of defined \fCprintf(3)\fP-like sequences see

261

** the section on $$index_format.

254

262

*/

255

263

{ "autoedit", DT_BOOL, R_NONE, OPTAUTOEDIT, 0 },

256

264

/*

257

265

** .pp

258

** When set along with ``$$edit_headers'', Mutt will skip the initial

259

** send-menu and allow you to immediately begin editing the body of your

266

** When \fIset\fP along with $$edit_headers, Mutt will skip the initial

267

** send-menu (prompting for subject and recipients) and allow you to

268

** immediately begin editing the body of your

260

269

** message. The send-menu may still be accessed once you have finished

261

270

** editing the body of your message.

262

271

** .pp

263

** Also see ``$$fast_reply''.

272

** Also see $$fast_reply.

264

273

*/

265

274

{ "auto_tag", DT_BOOL, R_NONE, OPTAUTOTAG, 0 },

266

275

/*

267

276

** .pp

268

** When set, functions in the \fIindex\fP menu which affect a message

277

** When \fIset\fP, functions in the \fIindex\fP menu which affect a message

269

278

** will be applied to all tagged messages (if there are any). When

270

** unset, you must first use the tag-prefix function (default: ";") to

271

** make the next function apply to all tagged messages.

279

** unset, you must first use the \fC<tag-prefix>\fP function (bound to ``;''

280

** by default) to make the next function apply to all tagged messages.

272

281

*/

273

282

{ "beep", DT_BOOL, R_NONE, OPTBEEP, 1 },

274

283

/*

275

284

** .pp

276

** When this variable is set, mutt will beep when an error occurs.

285

** When this variable is \fIset\fP, mutt will beep when an error occurs.

277

286

*/

278

287

{ "beep_new", DT_BOOL, R_NONE, OPTBEEPNEW, 0 },

279

288

/*

280

289

** .pp

281

** When this variable is set, mutt will beep whenever it prints a message

290

** When this variable is \fIset\fP, mutt will beep whenever it prints a message

282

291

** notifying you of new mail. This is independent of the setting of the

283

** ``$$beep'' variable.

292

** $$beep variable.

284

293

*/

285

294

{ "bounce", DT_QUAD, R_NONE, OPT_BOUNCE, M_ASKYES },

286

295

/*

293

302

{ "bounce_delivered", DT_BOOL, R_NONE, OPTBOUNCEDELIVERED, 1 },

294

303

/*

295

304

** .pp

296

** When this variable is set, mutt will include Delivered-To headers when

297

** bouncing messages. Postfix users may wish to unset this variable.

305

** When this variable is \fIset\fP, mutt will include Delivered-To headers when

306

** bouncing messages. Postfix users may wish to \fIunset\fP this variable.

298

307

*/

299

308

{ "braille_friendly", DT_BOOL, R_NONE, OPTBRAILLEFRIENDLY, 0 },

300

309

/*

301

310

** .pp

302

** When this variable is set, mutt will place the cursor at the beginning

303

** of the current line in menus, even when the arrow_cursor variable

304

** is unset, making it easier for blind persons using Braille displays to

305

** follow these menus. The option is disabled by default because many

311

** When this variable is \fIset\fP, mutt will place the cursor at the beginning

312

** of the current line in menus, even when the $$arrow_cursor variable

313

** is \fIunset\fP, making it easier for blind persons using Braille displays to

314

** follow these menus. The option is \fIunset\fP by default because many

306

315

** visual terminals don't permit making the cursor invisible.

307

316

*/

308

317

{ "check_mbox_size", DT_BOOL, R_NONE, OPTCHECKMBOXSIZE, 0 },

309

318

/*

310

319

** .pp

311

** When this variable is set, mutt will use file size attribute instead of

312

** access time when checking for new mail.

320

** When this variable is \fIset\fP, mutt will use file size attribute instead of

321

** access time when checking for new mail in mbox and mmdf folders.

322

** .pp

323

** This variable is \fIunset\fP by default and should only be enabled when

324

** new mail detection for these folder types is unreliable or doesn't work.

325

** .pp

326

** Note that enabling this variable should happen before any ``$mailboxes''

327

** directives occur in configuration files regarding mbox or mmdf folders

328

** because mutt needs to determine the initial new mail status of such a

329

** mailbox by performing a fast mailbox scan when it is defined.

330

** Afterwards the new mail status is tracked by file size changes.

313

331

*/

314

332

{ "charset", DT_STR, R_NONE, UL &Charset, UL 0 },

315

333

/*

316

334

** .pp

317

335

** Character set your terminal uses to display and enter textual data.

318

336

** It is also the fallback for $$send_charset.

337

** .pp

338

** Upon startup Mutt tries to derive this value from environment variables

339

** such as \fC$$$LC_CTYPE\fP or \fC$$$LANG\fP.

340

** .pp

341

** \fBNote:\fP It should only be set in case Mutt isn't abled to determine the

342

** character set used correctly.

319

343

*/

320

344

{ "check_new", DT_BOOL, R_NONE, OPTCHECKNEW, 1 },

321

345

/*

327

351

** mailbox is open. Especially with MH mailboxes, this operation can

328

352

** take quite some time since it involves scanning the directory and

329

353

** checking each file to see if it has already been looked at. If

330

** \fIcheck_new\fP is \fIunset\fP, no check for new mail is performed

354

** this variable is \fIunset\fP, no check for new mail is performed

331

355

** while the mailbox is open.

332

356

*/

333

357

{ "collapse_unread", DT_BOOL, R_NONE, OPTCOLLAPSEUNREAD, 1 },

345

369

{ "compose_format", DT_STR, R_BOTH, UL &ComposeFormat, UL "-- Mutt: Compose [Approx. msg size: %l Atts: %a]%>-" },

346

370

/*

347

371

** .pp

348

** Controls the format of the status line displayed in the \fICompose\fP

349

** menu. This string is similar to ``$$status_format'', but has its own

350

** set of printf()-like sequences:

351

** .pp

372

** Controls the format of the status line displayed in the ``compose''

373

** menu. This string is similar to $$status_format, but has its own

374

** set of \fCprintf(3)\fP-like sequences:

352

375

** .dl

353

** .dt %a .dd total number of attachments

376

** .dt %a .dd total number of attachments

354

377

** .dt %h .dd local hostname

355

378

** .dt %l .dd approximate size (in bytes) of the current message

356

379

** .dt %v .dd Mutt version string

357

380

** .de

358

381

** .pp

359

** See the text describing the ``$$status_format'' option for more

360

** information on how to set ``$$compose_format''.

382

** See the text describing the $$status_format option for more

383

** information on how to set $$compose_format.

361

384

*/

362

385

{ "config_charset", DT_STR, R_NONE, UL &ConfigCharset, UL 0 },

363

386

/*

364

387

** .pp

365

388

** When defined, Mutt will recode commands in rc files from this

366

** encoding.

389

** encoding to the current character set as specified by $$charset

390

** and aliases written to $$alias_file from the current character set.

391

** .pp

392

** Please note that if setting $$charset it must be done before

393

** setting $$config_charset.

394

** .pp

395

** Recoding should be avoided as it may render unconvertable

396

** characters as question marks which can lead to undesired

397

** side effects (for example in regular expressions).

367

398

*/

368

399

{ "confirmappend", DT_BOOL, R_NONE, OPTCONFIRMAPPEND, 1 },

369

400

/*

370

401

** .pp

371

** When set, Mutt will prompt for confirmation when appending messages to

402

** When \fIset\fP, Mutt will prompt for confirmation when appending messages to

372

403

** an existing mailbox.

373

404

*/

374

405

{ "confirmcreate", DT_BOOL, R_NONE, OPTCONFIRMCREATE, 1 },

375

406

/*

376

407

** .pp

377

** When set, Mutt will prompt for confirmation when saving messages to a

408

** When \fIset\fP, Mutt will prompt for confirmation when saving messages to a

378

409

** mailbox which does not yet exist before creating it.

379

410

*/

380

411

{ "connect_timeout", DT_NUM, R_NONE, UL &ConnectTimeout, 30 },

381

412

/*

382

413

** .pp

383

** Causes Mutt to timeout a network connection (for IMAP or POP) after this

414

** Causes Mutt to timeout a network connection (for IMAP, POP or SMTP) after this

384

415

** many seconds if the connection is not able to be established. A negative

385

** value causes Mutt to wait indefinitely for the connection to succeed.

416

** value causes Mutt to wait indefinitely for the connection attempt to succeed.

386

417

*/

387

418

{ "content_type", DT_STR, R_NONE, UL &ContentType, UL "text/plain" },

388

419

/*

393

424

/*

394

425

** .pp

395

426

** This variable controls whether or not copies of your outgoing messages

396

** will be saved for later references. Also see ``$$record'',

397

** ``$$save_name'', ``$$force_name'' and ``$fcc-hook''.

427

** will be saved for later references. Also see $$record,

428

** $$save_name, $$force_name and ``$fcc-hook''.

398

429

*/

399

400

430

{ "crypt_use_gpgme", DT_BOOL, R_NONE, OPTCRYPTUSEGPGME, 0 },

401

431

/*

402

432

** .pp

403

433

** This variable controls the use of the GPGME-enabled crypto backends.

404

** If it is set and Mutt was built with gpgme support, the gpgme code for

434

** If it is \fIset\fP and Mutt was built with gpgme support, the gpgme code for

405

435

** S/MIME and PGP will be used instead of the classic code. Note that

406

** you need to set this option in .muttrc; it won't have any effect when

436

** you need to set this option in .muttrc; it won't have any effect when

407

437

** used interactively.

408

438

*/

409

439

{ "crypt_use_pka", DT_BOOL, R_NONE, OPTCRYPTUSEPKA, 0 },

410

440

/*

411

** .pp Controls whether mutt uses PKA

412

** (http://www.g10code.de/docs/pka-intro.de.pdf) during signature

441

** .pp

442

** Controls whether mutt uses PKA

443

** (see http://www.g10code.de/docs/pka-intro.de.pdf) during signature

413

444

** verification (only supported by the GPGME backend).

414

445

*/

415

416

446

{ "crypt_autopgp", DT_BOOL, R_NONE, OPTCRYPTAUTOPGP, 1 },

417

447

/*

418

448

** .pp

419

449

** This variable controls whether or not mutt may automatically enable

420

** PGP encryption/signing for messages. See also ``$$crypt_autoencrypt'',

421

** ``$$crypt_replyencrypt'',

422

** ``$$crypt_autosign'', ``$$crypt_replysign'' and ``$$smime_is_default''.

450

** PGP encryption/signing for messages. See also $$crypt_autoencrypt,

451

** $$crypt_replyencrypt,

452

** $$crypt_autosign, $$crypt_replysign and $$smime_is_default.

423

453

*/

424

454

{ "crypt_autosmime", DT_BOOL, R_NONE, OPTCRYPTAUTOSMIME, 1 },

425

455

/*

426

456

** .pp

427

457

** This variable controls whether or not mutt may automatically enable

428

** S/MIME encryption/signing for messages. See also ``$$crypt_autoencrypt'',

429

** ``$$crypt_replyencrypt'',

430

** ``$$crypt_autosign'', ``$$crypt_replysign'' and ``$$smime_is_default''.

458

** S/MIME encryption/signing for messages. See also $$crypt_autoencrypt,

459

** $$crypt_replyencrypt,

460

** $$crypt_autosign, $$crypt_replysign and $$smime_is_default.

431

461

*/

432

462

{ "date_format", DT_STR, R_BOTH, UL &DateFmt, UL "!%a, %b %d, %Y at %I:%M:%S%p %Z" },

433

463

/*

434

464

** .pp

435

465

** This variable controls the format of the date printed by the ``%d''

436

** sequence in ``$$index_format''. This is passed to the \fIstrftime\fP

437

** call to process the date. See the man page for \fIstrftime(3)\fP for

438

** the proper syntax.

466

** sequence in $$index_format. This is passed to the \fCstrftime(3)\fP

467

** function to process the date, see the man page for the proper syntax.

439

468

** .pp

440

469

** Unless the first character in the string is a bang (``!''), the month

441

470

** and week day names are expanded according to the locale specified in

442

** the variable ``$$locale''. If the first character in the string is a

471

** the variable $$locale. If the first character in the string is a

443

472

** bang, the bang is discarded, and the month and week day names in the

444

473

** rest of the string are expanded in the \fIC\fP locale (that is in US

445

474

** English).

446

*/

475

*/

447

476

{ "default_hook", DT_STR, R_NONE, UL &DefaultHook, UL "~f %s !~P | (~P ~C %s)" },

448

477

/*

449

478

** .pp

450

** This variable controls how message-hooks, reply-hooks, send-hooks,

451

** send2-hooks, save-hooks, and fcc-hooks will

479

** This variable controls how ``$message-hook'', ``$reply-hook'', ``$send-hook'',

480

** ``$send2-hook'', ``$save-hook'', and ``$fcc-hook'' will

452

481

** be interpreted if they are specified with only a simple regexp,

453

482

** instead of a matching pattern. The hooks are expanded when they are

454

483

** declared, so a hook will be interpreted according to the value of this

455

** variable at the time the hook is declared. The default value matches

484

** variable at the time the hook is declared.

485

** .pp

486

** The default value matches

456

487

** if the message is either from a user matching the regular expression

457

488

** given, or if it is from you (if the from address matches

458

** ``alternates'') and is to or cc'ed to a user matching the given

489

** ``$alternates'') and is to or cc'ed to a user matching the given

459

490

** regular expression.

460

491

*/

461

492

{ "delete", DT_QUAD, R_NONE, OPT_DELETE, M_ASKYES },

477

508

/*

478

509

** .pp

479

510

** If this option is \fIset\fP, mutt's received-attachments menu will not show the subparts of

480

** individual messages in a multipart/digest. To see these subparts, press 'v' on that menu.

511

** individual messages in a multipart/digest. To see these subparts, press ``v'' on that menu.

481

512

*/

482

513

{ "display_filter", DT_PATH, R_PAGER, UL &DisplayFilter, UL "" },

483

514

/*

490

521

{ "dotlock_program", DT_PATH, R_NONE, UL &MuttDotlock, UL BINDIR "/mutt_dotlock" },

491

522

/*

492

523

** .pp

493

** Contains the path of the mutt_dotlock (8) binary to be used by

524

** Contains the path of the \fCmutt_dotlock(8)\fP binary to be used by

494

525

** mutt.

495

526

*/

496

527

#endif

504

535

** \fIdelay\fP, to be notified of message delays, \fIsuccess\fP, to be

505

536

** notified of successful transmission.

506

537

** .pp

507

** Example: set dsn_notify="failure,delay"

538

** Example:

539

** .ts

540

** set dsn_notify="failure,delay"

541

** .te

508

542

** .pp

509

543

** \fBNote:\fP when using $$sendmail for delivery, you should not enable

510

544

** this unless you are either using Sendmail 8.8.x or greater or a MTA

511

** providing a sendmail(1)-compatible interface supporting the -N option

512

** for DSN. For SMTP delivery, it depends on the server whether DSN is

513

** supported or not.

545

** providing a \fCsendmail(1)\fP-compatible interface supporting the \fC-N\fP option

546

** for DSN. For SMTP delivery, DSN support is autodetected so that it

547

** depends on the server whether DSN will be used or not.

514

548

*/

515

549

{ "dsn_return", DT_STR, R_NONE, UL &DsnReturn, UL "" },

516

550

/*

519

553

** messages. It may be set to either \fIhdrs\fP to return just the

520

554

** message header, or \fIfull\fP to return the full message.

521

555

** .pp

522

** Example: set dsn_return=hdrs

556

** Example:

557

** .ts

558

** set dsn_return=hdrs

559

** .te

523

560

** .pp

524

561

** \fBNote:\fP when using $$sendmail for delivery, you should not enable

525

562

** this unless you are either using Sendmail 8.8.x or greater or a MTA

526

** providing a sendmail(1)-compatible interface supporting the -R option

527

** for DSN. For SMTP delivery, it depends on the server whether DSN is

528

** supported or not.

563

** providing a \fCsendmail(1)\fP-compatible interface supporting the \fC-R\fP option

564

** for DSN. For SMTP delivery, DSN support is autodetected so that it

565

** depends on the server whether DSN will be used or not.

529

566

*/

530

567

{ "duplicate_threads", DT_BOOL, R_RESORT|R_RESORT_INIT|R_INDEX, OPTDUPTHREADS, 1 },

531

568

/*

532

569

** .pp

533

** This variable controls whether mutt, when sorting by threads, threads

534

** messages with the same message-id together. If it is set, it will indicate

570

** This variable controls whether mutt, when $$sort is set to \fIthreads\fP, threads

571

** messages with the same Message-Id together. If it is \fIset\fP, it will indicate

535

572

** that it thinks they are duplicates of each other with an equals sign

536

** in the thread diagram.

573

** in the thread tree.

537

574

*/

538

575

{ "edit_headers", DT_BOOL, R_NONE, OPTEDITHDRS, 0 },

539

576

/*

546

583

*/

547

584

{ "edit_hdrs", DT_SYN, R_NONE, UL "edit_headers", 0 },

548

585

/*

549

*/

586

*/

550

587

{ "editor", DT_PATH, R_NONE, UL &Editor, 0 },

551

588

/*

552

589

** .pp

553

590

** This variable specifies which editor is used by mutt.

554

** It defaults to the value of the VISUAL, or EDITOR, environment

555

** variable, or to the string "vi" if neither of those are set.

591

** It defaults to the value of the \fC$$$VISUAL\fP, or \fC$$$EDITOR\fP, environment

592

** variable, or to the string ``vi'' if neither of those are set.

556

593

*/

557

594

{ "encode_from", DT_BOOL, R_NONE, OPTENCODEFROM, 0 },

558

595

/*

559

596

** .pp

560

597

** When \fIset\fP, mutt will quoted-printable encode messages when

561

** they contain the string "From " in the beginning of a line.

562

** Useful to avoid the tampering certain mail delivery and transport

563

** agents tend to do with messages.

598

** they contain the string ``From '' (note the trailing space) in the beginning of a line.

599

** This is useful to avoid the tampering certain mail delivery and transport

600

** agents tend to do with messages (in order to prevent tools from

601

** misinterpreting the line as a mbox message separator).

564

602

*/

565

603

{ "envelope_from_address", DT_ADDR, R_NONE, UL &EnvFrom, 0 },

566

604

/*

567

605

** .pp

568

606

** Manually sets the \fIenvelope\fP sender for outgoing messages.

569

** This value is ignored if ``$$use_envelope_from'' is unset.

607

** This value is ignored if $$use_envelope_from is \fIunset\fP.

570

608

*/

571

609

{ "escape", DT_STR, R_NONE, UL &EscChar, UL "~" },

572

610

/*

576

614

{ "fast_reply", DT_BOOL, R_NONE, OPTFASTREPLY, 0 },

577

615

/*

578

616

** .pp

579

** When set, the initial prompt for recipients and subject are skipped

617

** When \fIset\fP, the initial prompt for recipients and subject are skipped

580

618

** when replying to messages, and the initial prompt for subject is

581

619

** skipped when forwarding messages.

582

620

** .pp

583

** \fBNote:\fP this variable has no effect when the ``$$autoedit''

584

** variable is set.

621

** \fBNote:\fP this variable has no effect when the $$autoedit

622

** variable is \fIset\fP.

585

623

*/

586

624

{ "fcc_attach", DT_BOOL, R_NONE, OPTFCCATTACH, 1 },

587

625

/*

592

630

{ "fcc_clear", DT_BOOL, R_NONE, OPTFCCCLEAR, 0 },

593

631

/*

594

632

** .pp

595

** When this variable is set, FCCs will be stored unencrypted and

633

** When this variable is \fIset\fP, FCCs will be stored unencrypted and

596

634

** unsigned, even when the actual message is encrypted and/or

597

635

** signed.

598

636

** (PGP only)

600

638

{ "folder", DT_PATH, R_NONE, UL &Maildir, UL "~/Mail" },

601

639

/*

602

640

** .pp

603

** Specifies the default location of your mailboxes. A `+' or `=' at the

641

** Specifies the default location of your mailboxes. A ``+'' or ``='' at the

604

642

** beginning of a pathname will be expanded to the value of this

605

** variable. Note that if you change this variable from the default

643

** variable. Note that if you change this variable (from the default)

606

644

** value you need to make sure that the assignment occurs \fIbefore\fP

607

** you use `+' or `=' for any other variables since expansion takes place

608

** during the `set' command.

645

** you use ``+'' or ``='' for any other variables since expansion takes place

646

** when handling the ``$mailboxes'' command.

609

647

*/

610

648

{ "folder_format", DT_STR, R_INDEX, UL &FolderFormat, UL "%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %f" },

611

649

/*

612

650

** .pp

613

651

** This variable allows you to customize the file browser display to your

614

** personal taste. This string is similar to ``$$index_format'', but has

615

** its own set of printf()-like sequences:

616

** .pp

652

** personal taste. This string is similar to $$index_format, but has

653

** its own set of \fCprintf(3)\fP-like sequences:

617

654

** .dl

618

655

** .dt %C .dd current file number

619

656

** .dt %d .dd date/time folder was last modified

623

660

** .dt %l .dd number of hard links

624

661

** .dt %N .dd N if folder has new mail, blank otherwise

625

662

** .dt %s .dd size in bytes

626

** .dt %t .dd * if the file is tagged, blank otherwise

663

** .dt %t .dd ``*'' if the file is tagged, blank otherwise

627

664

** .dt %u .dd owner name (or numeric uid, if missing)

628

** .dt %>X .dd right justify the rest of the string and pad with character "X"

629

** .dt %|X .dd pad to the end of the line with character "X"

630

** .dt %*X .dd soft-fill with character "X" as pad

665

** .dt %>X .dd right justify the rest of the string and pad with character ``X''

666

** .dt %|X .dd pad to the end of the line with character ``X''

667

** .dt %*X .dd soft-fill with character ``X'' as pad

631

668

** .de

632

669

** .pp

633

** For an explanation of `soft-fill', see the ``$$index_format'' documentation.

670

** For an explanation of ``soft-fill'', see the $$index_format documentation.

634

671

*/

635

672

{ "followup_to", DT_BOOL, R_NONE, OPTFOLLOWUPTO, 1 },

636

673

/*

637

674

** .pp

638

** Controls whether or not the \fIMail-Followup-To\fP header field is

675

** Controls whether or not the ``Mail-Followup-To:'' header field is

639

676

** generated when sending mail. When \fIset\fP, Mutt will generate this

640

677

** field when you are replying to a known mailing list, specified with

641

** the ``subscribe'' or ``$lists'' commands.

678

** the ``$subscribe'' or ``$lists'' commands.

642

679

** .pp

643

680

** This field has two purposes. First, preventing you from

644

681

** receiving duplicate copies of replies to messages which you send

645

682

** to mailing lists, and second, ensuring that you do get a reply

646

683

** separately for any messages sent to known lists to which you are

647

** not subscribed. The header will contain only the list's address

684

** not subscribed.

685

** .pp

686

** The header will contain only the list's address

648

687

** for subscribed lists, and both the list address and your own

649

688

** email address for unsubscribed lists. Without this header, a

650

689

** group reply to your message sent to a subscribed list will be

654

693

{ "force_name", DT_BOOL, R_NONE, OPTFORCENAME, 0 },

655

694

/*

656

695

** .pp

657

** This variable is similar to ``$$save_name'', except that Mutt will

696

** This variable is similar to $$save_name, except that Mutt will

658

697

** store a copy of your outgoing message by the username of the address

659

698

** you are sending to even if that mailbox does not exist.

660

699

** .pp

661

** Also see the ``$$record'' variable.

700

** Also see the $$record variable.

662

701

*/

663

702

{ "forward_decode", DT_BOOL, R_NONE, OPTFORWDECODE, 1 },

664

703

/*

665

704

** .pp

666

** Controls the decoding of complex MIME messages into text/plain when

705

** Controls the decoding of complex MIME messages into \fCtext/plain\fP when

667

706

** forwarding a message. The message header is also RFC2047 decoded.

668

** This variable is only used, if ``$$mime_forward'' is \fIunset\fP,

669

** otherwise ``$$mime_forward_decode'' is used instead.

707

** This variable is only used, if $$mime_forward is \fIunset\fP,

708

** otherwise $$mime_forward_decode is used instead.

670

709

*/

671

710

{ "forw_decode", DT_SYN, R_NONE, UL "forward_decode", 0 },

672

711

/*

682

721

/*

683

722

** .pp

684

723

** This variable controls the default subject when forwarding a message.

685

** It uses the same format sequences as the ``$$index_format'' variable.

724

** It uses the same format sequences as the $$index_format variable.

686

725

*/

687

{ "forw_format", DT_SYN, R_NONE, UL "forward_format", 0 },

726

{ "forw_format", DT_SYN, R_NONE, UL "forward_format", 0 },

688

727

/*

689

728

*/

690

729

{ "forward_quote", DT_BOOL, R_NONE, OPTFORWQUOTE, 0 },

691

730

/*

692

731

** .pp

693

** When \fIset\fP forwarded messages included in the main body of the

694

** message (when ``$$mime_forward'' is \fIunset\fP) will be quoted using

695

** ``$$indent_string''.

732

** When \fIset\fP, forwarded messages included in the main body of the

733

** message (when $$mime_forward is \fIunset\fP) will be quoted using

734

** $$indent_string.

696

735

*/

697

736

{ "forw_quote", DT_SYN, R_NONE, UL "forward_quote", 0 },

698

737

/*

700

739

{ "from", DT_ADDR, R_NONE, UL &From, UL 0 },

701

740

/*

702

741

** .pp

703

** When set, this variable contains a default from address. It

704

** can be overridden using my_hdr (including from send-hooks) and

705

** ``$$reverse_name''. This variable is ignored if ``$$use_from''

706

** is unset.

742

** When \fIset\fP, this variable contains a default from address. It

743

** can be overridden using ``$my_hdr'' (including from a ``$send-hook'') and

744

** $$reverse_name. This variable is ignored if $$use_from is \fIunset\fP.

707

745

** .pp

708

** Defaults to the contents of the environment variable EMAIL.

746

** This setting defaults to the contents of the environment variable \fC$$$EMAIL\fP.

709

747

*/

710

748

{ "gecos_mask", DT_RX, R_NONE, UL &GecosMask, UL "^[^,]*" },

711

749

/*

712

750

** .pp

713

751

** A regular expression used by mutt to parse the GECOS field of a password

714

** entry when expanding the alias. By default the regular expression is set

715

** to "^[^,]*" which will return the string up to the first "," encountered.

716

** If the GECOS field contains a string like "lastname, firstname" then you

717

** should set the gecos_mask=".*".

752

** entry when expanding the alias. The default value

753

** will return the string up to the first ``,'' encountered.

754

** If the GECOS field contains a string like ``lastname, firstname'' then you

755

** should set it to ``\fC.*\fP''.

718

756

** .pp

719

757

** This can be useful if you see the following behavior: you address a e-mail

720

** to user ID stevef whose full name is Steve Franklin. If mutt expands

721

** stevef to "Franklin" stevef@foo.bar then you should set the gecos_mask to

758

** to user ID ``stevef'' whose full name is ``Steve Franklin''. If mutt expands

759

** ``stevef'' to ``"Franklin" stevef@foo.bar'' then you should set the $$gecos_mask to

722

760

** a regular expression that will match the whole name so mutt will expand

723

** "Franklin" to "Franklin, Steve".

761

** ``Franklin'' to ``Franklin, Steve''.

724

762

*/

725

763

{ "hdr_format", DT_SYN, R_NONE, UL "index_format", 0 },

726

764

/*

728

766

{ "hdrs", DT_BOOL, R_NONE, OPTHDRS, 1 },

729

767

/*

730

768

** .pp

731

** When unset, the header fields normally added by the ``$my_hdr''

769

** When \fIunset\fP, the header fields normally added by the ``$my_hdr''

732

770

** command are not created. This variable \fImust\fP be unset before

733

** composing a new message or replying in order to take effect. If set,

771

** composing a new message or replying in order to take effect. If \fIset\fP,

734

772

** the user defined header fields are added to every new message.

735

773

*/

736

774

{ "header", DT_BOOL, R_NONE, OPTHEADER, 0 },

737

775

/*

738

776

** .pp

739

** When set, this variable causes Mutt to include the header

777

** When \fIset\fP, this variable causes Mutt to include the header

740

778

** of the message you are replying to into the edit buffer.

741

** The ``$$weed'' setting applies.

742

*/

779

** The $$weed setting applies.

780

*/

743

781

{ "help", DT_BOOL, R_BOTH, OPTHELP, 1 },

744

782

/*

745

783

** .pp

746

** When set, help lines describing the bindings for the major functions

784

** When \fIset\fP, help lines describing the bindings for the major functions

747

785

** provided by each menu are displayed on the first line of the screen.

748

786

** .pp

749

787

** \fBNote:\fP The binding will not be displayed correctly if the

755

793

{ "hidden_host", DT_BOOL, R_NONE, OPTHIDDENHOST, 0 },

756

794

/*

757

795

** .pp

758

** When set, mutt will skip the host name part of ``$$hostname'' variable

796

** When \fIset\fP, mutt will skip the host name part of $$hostname variable

759

797

** when adding the domain part to addresses. This variable does not

760

** affect the generation of Message-IDs, and it will not lead to the

798

** affect the generation of Message-IDs, and it will not lead to the

761

799

** cut-off of first-level domains.

762

800

*/

763

801

{ "hide_limited", DT_BOOL, R_TREE|R_INDEX, OPTHIDELIMITED, 0 },

764

802

/*

765

803

** .pp

766

** When set, mutt will not show the presence of messages that are hidden

804

** When \fIset\fP, mutt will not show the presence of messages that are hidden

767

805

** by limiting, in the thread tree.

768

806

*/

769

807

{ "hide_missing", DT_BOOL, R_TREE|R_INDEX, OPTHIDEMISSING, 1 },

770

808

/*

771

809

** .pp

772

** When set, mutt will not show the presence of missing messages in the

810

** When \fIset\fP, mutt will not show the presence of missing messages in the

773

811

** thread tree.

774

812

*/

775

813

{ "hide_thread_subject", DT_BOOL, R_TREE|R_INDEX, OPTHIDETHREADSUBJECT, 1 },

776

814

/*

777

815

** .pp

778

** When set, mutt will not show the subject of messages in the thread

816

** When \fIset\fP, mutt will not show the subject of messages in the thread

779

817

** tree that have the same subject as their parent or closest previously

780

818

** displayed sibling.

781

819

*/

782

820

{ "hide_top_limited", DT_BOOL, R_TREE|R_INDEX, OPTHIDETOPLIMITED, 0 },

783

821

/*

784

822

** .pp

785

** When set, mutt will not show the presence of messages that are hidden

823

** When \fIset\fP, mutt will not show the presence of messages that are hidden

786

824

** by limiting, at the top of threads in the thread tree. Note that when

787

** $$hide_limited is set, this option will have no effect.

825

** $$hide_limited is \fIset\fP, this option will have no effect.

788

826

*/

789

827

{ "hide_top_missing", DT_BOOL, R_TREE|R_INDEX, OPTHIDETOPMISSING, 1 },

790

828

/*

791

829

** .pp

792

** When set, mutt will not show the presence of missing messages at the

830

** When \fIset\fP, mutt will not show the presence of missing messages at the

793

831

** top of threads in the thread tree. Note that when $$hide_missing is

794

** set, this option will have no effect.

832

** \fIset\fP, this option will have no effect.

795

833

*/

796

834

{ "history", DT_NUM, R_NONE, UL &HistSize, 10 },

797

835

/*

798

836

** .pp

799

837

** This variable controls the size (in number of strings remembered) of

800

** the string history buffer. The buffer is cleared each time the

838

** the string history buffer per category. The buffer is cleared each time the

801

839

** variable is set.

802

840

*/

803

841

{ "history_file", DT_PATH, R_NONE, UL &HistFile, UL "~/.mutthistory" },

820

858

** Message-Id headers.

821

859

** .pp

822

860

** Its value is determined at startup as follows: If the node's name

823

** as returned by the uname(3) function contains the hostname and the

861

** as returned by the \fCuname(3)\fP function contains the hostname and the

824

862

** domain, these are used to construct $$hostname. If there is no

825

863

** domain part returned, Mutt will look for a ``domain'' or ``search''

826

** line in /etc/resolv.conf to determine the domain. Optionally, Mutt

864

** line in \fC/etc/resolv.conf\fP to determine the domain. Optionally, Mutt

827

865

** can be compiled with a fixed domain name in which case a detected

828

866

** one is not used.

829

867

** .pp

830

** Also see ``$$use_domain'' and ``$$hidden_host''.

868

** Also see $$use_domain and $$hidden_host.

831

869

*/

832

870

{ "ignore_linear_white_space", DT_BOOL, R_NONE, OPTIGNORELWS, 0 },

833

871

/*

834

872

** .pp

835

873

** This option replaces linear-white-space between encoded-word

836

** and *text to a single space to prevent the display of MIME-encoded

837

** ``Subject'' field from being divided into multiple lines.

874

** and text to a single space to prevent the display of MIME-encoded

875

** ``Subject:'' field from being divided into multiple lines.

838

876

*/

839

877

{ "ignore_list_reply_to", DT_BOOL, R_NONE, OPTIGNORELISTREPLYTO, 0 },

840

878

/*

841

879

** .pp

842

** Affects the behaviour of the \fIreply\fP function when replying to

843

** messages from mailing lists (as defined by the ``subscribe'' or

844

** ``$lists'' commands). When set, if the ``Reply-To:'' field is

880

** Affects the behaviour of the \fC<reply>\fP function when replying to

881

** messages from mailing lists (as defined by the ``$subscribe'' or

882

** ``$lists'' commands). When \fIset\fP, if the ``Reply-To:'' field is

845

883

** set to the same value as the ``To:'' field, Mutt assumes that the

846

884

** ``Reply-To:'' field was set by the mailing list to automate responses

847

885

** to the list, and will ignore this field. To direct a response to the

848

** mailing list when this option is set, use the \fIlist-reply\fP

849

** function; \fIgroup-reply\fP will reply to both the sender and the

886

** mailing list when this option is \fIset\fP, use the \fC$<list-reply>\fP

887

** function; \fC<group-reply>\fP will reply to both the sender and the

850

888

** list.

851

889

*/

852

890

#ifdef USE_IMAP

855

893

** .pp

856

894

** This is a colon-delimited list of authentication methods mutt may

857

895

** attempt to use to log in to an IMAP server, in the order mutt should

858

** try them. Authentication methods are either 'login' or the right

859

** side of an IMAP 'AUTH=xxx' capability string, eg 'digest-md5', 'gssapi'

860

** or 'cram-md5'. This parameter is case-insensitive. If this

861

** parameter is \fIunset\fP (the default) mutt will try all available methods,

896

** try them. Authentication methods are either ``login'' or the right

897

** side of an IMAP ``AUTH=xxx'' capability string, eg ``digest-md5'', ``gssapi''

898

** or ``cram-md5''. This option is case-insensitive. If it's

899

** \fIunset\fP (the default) mutt will try all available methods,

862

900

** in order from most-secure to least-secure.

863

901

** .pp

864

** Example: set imap_authenticators="gssapi:cram-md5:login"

902

** Example:

903

** .ts

904

** set imap_authenticators="gssapi:cram-md5:login"

905

** .te

865

906

** .pp

866

907

** \fBNote:\fP Mutt will only fall back to other authentication methods if

867

908

** the previous methods are unavailable. If a method is available but

872

913

** .pp

873

914

** When \fIset\fP, mutt will fetch the set of subscribed folders from

874

915

** your server on connection, and add them to the set of mailboxes

875

** it polls for new mail. See also the ``$mailboxes'' command.

916

** it polls for new mail just as if you had issued individual ``$mailboxes''

917

** commands.

876

918

*/

877

919

{ "imap_delim_chars", DT_STR, R_NONE, UL &ImapDelimChars, UL "/." },

878

920

/*

879

921

** .pp

880

922

** This contains the list of characters which you would like to treat

881

923

** as folder separators for displaying IMAP paths. In particular it

882

** helps in using the '=' shortcut for your \fIfolder\fP variable.

924

** helps in using the ``='' shortcut for your \fIfolder\fP variable.

883

925

*/

884

926

{ "imap_headers", DT_STR, R_INDEX, UL &ImapHeaders, UL 0},

885

927

/*

886

928

** .pp

887

929

** Mutt requests these header fields in addition to the default headers

888

** ("DATE FROM SUBJECT TO CC MESSAGE-ID REFERENCES CONTENT-TYPE

889

** CONTENT-DESCRIPTION IN-REPLY-TO REPLY-TO LINES X-LABEL") from IMAP

930

** (``Date:'', ``From:'', ``Subject:'', ``To:'', ``Cc:'', ``Message-Id:'',

931

** ``References:'', ``Content-Type:'', ``Content-Description:'', ``In-Reply-To:'',

932

** ``Reply-To:'', ``Lines:'', ``List-Post:'', ``X-Label:'') from IMAP

890

933

** servers before displaying the index menu. You may want to add more

891

** headers for spam detection. \fBNote:\fP This is a space separated list.

934

** headers for spam detection.

935

** .pp

936

** \fBNote:\fP This is a space separated list, items should be uppercase

937

** and not contain the colon, e.g. ``X-BOGOSITY X-SPAM-STATUS'' for the

938

** ``X-Bogosity:'' and ``X-Spam-Status:'' header fields.

892

939

*/

893

940

{ "imap_idle", DT_BOOL, R_NONE, OPTIMAPIDLE, 0 },

894

941

/*

895

** .pp

896

** When \fIset\fP, mutt will attempt to use the IMAP IDLE extension

897

** to check for new mail in the current mailbox. Some servers

898

** (dovecot was the inspiration for this option) react badly

899

** to mutt's implementation. If your connection seems to freeze

900

** up periodically, try unsetting this.

901

*/

942

** .pp

943

** When \fIset\fP, mutt will attempt to use the IMAP IDLE extension

944

** to check for new mail in the current mailbox. Some servers

945

** (dovecot was the inspiration for this option) react badly

946

** to mutt's implementation. If your connection seems to freeze

947

** up periodically, try unsetting this.

948

*/

902

949

{ "imap_keepalive", DT_NUM, R_NONE, UL &ImapKeepalive, 900 },

903

950

/*

904

951

** .pp

915

962

** .pp

916

963

** This variable configures whether IMAP folder browsing will look for

917

964

** only subscribed folders or all folders. This can be toggled in the

918

** IMAP browser with the \fItoggle-subscribed\fP function.

965

** IMAP browser with the \fC<toggle-subscribed>\fP function.

919

966

*/

920

967

{ "imap_login", DT_STR, R_NONE, UL &ImapLogin, UL 0 },

921

968

/*

922

969

** .pp

923

970

** Your login name on the IMAP server.

924

971

** .pp

925

** This variable defaults to the value of \fIimap_user\fP.

972

** This variable defaults to the value of $$imap_user.

926

973

*/

927

974

{ "imap_pass", DT_STR, R_NONE, UL &ImapPass, UL 0 },

928

975

/*

929

976

** .pp

930

977

** Specifies the password for your IMAP account. If \fIunset\fP, Mutt will

931

** prompt you for your password when you invoke the fetch-mail function.

978

** prompt you for your password when you invoke the \fC$<fetch-mail>\fP function

979

** or try to open an IMAP folder.

980

** .pp

932

981

** \fBWarning\fP: you should only use this option when you are on a

933

982

** fairly secure machine, because the superuser can read your muttrc even

934

983

** if you are the only one who can read the file.

950

999

** but can make closing an IMAP folder somewhat slower. This option

951

1000

** exists to appease speed freaks.

952

1001

*/

1002

{ "imap_pipeline_depth", DT_NUM, R_NONE, UL &ImapPipelineDepth, 15 },

1003

/*

1004

** .pp

1005

** Controls the number of IMAP commands that may be queued up before they

1006

** are sent to the server. A deeper pipeline reduces the amount of time

1007

** mutt must wait for the server, and can make IMAP servers feel much

1008

** more responsive. But not all servers correctly handle pipelined commands,

1009

** so if you have problems you might want to try setting this variable to 0.

1010

** .pp

1011

** \fBNote:\fP Changes to this variable have no effect on open connections.

1012

*/

953

1013

{ "imap_servernoise", DT_BOOL, R_NONE, OPTIMAPSERVERNOISE, 1 },

954

1014

/*

955

1015

** .pp

972

1032

/*

973

1033

** .pp

974

1034

** If set to ``yes'', mutt will look for a mailcap entry with the

975

** copiousoutput flag set for \fIevery\fP MIME attachment it doesn't have

1035

** ``\fCcopiousoutput\fP'' flag set for \fIevery\fP MIME attachment it doesn't have

976

1036

** an internal viewer defined for. If such an entry is found, mutt will

977

1037

** use the viewer defined in that entry to convert the body part to text

978

1038

** form.

997

1057

** change this value, as it tends to agitate the more fanatical netizens.

998

1058

** .pp

999

1059

** This option is a format string, please see the description of

1000

** ``$$index_format'' for supported printf()-style sequences.

1060

** $$index_format for supported \fCprintf(3)\fP-style sequences.

1061

** .pp

1062

** Because for \fCformat=lowed\fP style messages the quoting mechanism

1063

** is strictly defined, this setting is ignored if $$text_flowed is

1064

** \fIset\fP.

1001

1065

*/

1002

1066

{ "indent_str", DT_SYN, R_NONE, UL "indent_string", 0 },

1003

1067

/*

1008

1072

** This variable allows you to customize the message index display to

1009

1073

** your personal taste.

1010

1074

** .pp

1011

** ``Format strings'' are similar to the strings used in the ``C''

1012

** function printf to format output (see the man page for more detail).

1075

** ``Format strings'' are similar to the strings used in the C

1076

** function \fCprintf(3)\fP to format output (see the man page for more details).

1013

1077

** The following sequences are defined in Mutt:

1014

** .pp

1015

1078

** .dl

1016

1079

** .dt %a .dd address of the author

1017

1080

** .dt %A .dd reply-to address (if present; otherwise: address of author)

1018

** .dt %b .dd filename of the original message folder (think mailBox)

1081

** .dt %b .dd filename of the original message folder (think mailbox)

1019

1082

** .dt %B .dd the list to which the letter was sent, or else the folder name (%b).

1020

1083

** .dt %c .dd number of characters (bytes) in the message

1021

1084

** .dt %C .dd current message number

1022

1085

** .dt %d .dd date and time of the message in the format specified by

1023

** ``date_format'' converted to sender's time zone

1086

** $$date_format converted to sender's time zone

1024

1087

** .dt %D .dd date and time of the message in the format specified by

1025

** ``date_format'' converted to the local time zone

1088

** $$date_format converted to the local time zone

1026

1089

** .dt %e .dd current message number in thread

1027

1090

** .dt %E .dd number of messages in current thread

1028

1091

** .dt %f .dd sender (address + real name), either From: or Return-Path:

1031

1094

** .dt %i .dd message-id of the current message

1032

1095

** .dt %l .dd number of lines in the message (does not work with maildir,

1033

1096

** mh, and possibly IMAP folders)

1034

** .dt %L .dd If an address in the To or CC header field matches an address

1035

** defined by the users ``subscribe'' command, this displays

1097

** .dt %L .dd If an address in the ``To:'' or ``Cc:'' header field matches an address

1098

** defined by the users ``$subscribe'' command, this displays

1036

1099

** "To <list-name>", otherwise the same as %F.

1037

1100

** .dt %m .dd total number of message in the mailbox

1038

1101

** .dt %M .dd number of hidden messages if the thread is collapsed.

1039

1102

** .dt %N .dd message score

1040

1103

** .dt %n .dd author's real name (or address if missing)

1041

** .dt %O .dd (_O_riginal save folder) Where mutt would formerly have

1042

** stashed the message: list name or recipient name if no list

1104

** .dt %O .dd original save folder where mutt would formerly have

1105

** stashed the message: list name or recipient name

1106

** if not sent to a list

1043

1107

** .dt %P .dd progress indicator for the builtin pager (how much of the file has been displayed)

1044

1108

** .dt %s .dd subject of the message

1045

** .dt %S .dd status of the message (N/D/d/!/r/\(as)

1046

** .dt %t .dd `to:' field (recipients)

1109

** .dt %S .dd status of the message (``N''/``D''/``d''/``!''/``r''/\(as)

1110

** .dt %t .dd ``To:'' field (recipients)

1047

1111

** .dt %T .dd the appropriate character from the $$to_chars string

1048

1112

** .dt %u .dd user (login) name of the author

1049

1113

** .dt %v .dd first name of the author, or the recipient if the message is from you

1050

1114

** .dt %X .dd number of attachments

1051

1115

** (please see the ``$attachments'' section for possible speed effects)

1052

** .dt %y .dd `x-label:' field, if present

1053

** .dt %Y .dd `x-label' field, if present, and (1) not at part of a thread tree,

1054

** (2) at the top of a thread, or (3) `x-label' is different from

1055

** preceding message's `x-label'.

1116

** .dt %y .dd ``X-Label:'' field, if present

1117

** .dt %Y .dd ``X-Label:'' field, if present, and \fI(1)\fP not at part of a thread tree,

1118

** \fI(2)\fP at the top of a thread, or \fI(3)\fP ``X-Label:'' is different from

1119

** preceding message's ``X-Label:''.

1056

1120

** .dt %Z .dd message status flags

1057

1121

** .dt %{fmt} .dd the date and time of the message is converted to sender's

1058

1122

** time zone, and ``fmt'' is expanded by the library function

1059

** ``strftime''; a leading bang disables locales

1123

** \fCstrftime(3)\fP; a leading bang disables locales

1060

1124

** .dt %[fmt] .dd the date and time of the message is converted to the local

1061

1125

** time zone, and ``fmt'' is expanded by the library function

1062

** ``strftime''; a leading bang disables locales

1126

** \fCstrftime(3)\fP; a leading bang disables locales

1063

1127

** .dt %(fmt) .dd the local date and time when the message was received.

1064

** ``fmt'' is expanded by the library function ``strftime'';

1128

** ``fmt'' is expanded by the library function \fCstrftime(3)\fP;

1065

1129

** a leading bang disables locales

1066

1130

** .dt %<fmt> .dd the current local time. ``fmt'' is expanded by the library

1067

** function ``strftime''; a leading bang disables locales.

1068

** .dt %>X .dd right justify the rest of the string and pad with character "X"

1069

** .dt %|X .dd pad to the end of the line with character "X"

1070

** .dt %*X .dd soft-fill with character "X" as pad

1131

** function \fCstrftime(3)\fP; a leading bang disables locales.

1132

** .dt %>X .dd right justify the rest of the string and pad with character ``X''

1133

** .dt %|X .dd pad to the end of the line with character ``X''

1134

** .dt %*X .dd soft-fill with character ``X'' as pad

1071

1135

** .de

1072

1136

** .pp

1073

** `Soft-fill' deserves some explanation. Normal right-justification

1074

** will print everything to the left of the %>, displaying padding and

1075

** the whatever lies to the right only if there's room. By contrast,

1137

** ``Soft-fill'' deserves some explanation: Normal right-justification

1138

** will print everything to the left of the ``%>'', displaying padding and

1139

** whatever lies to the right only if there's room. By contrast,

1076

1140

** soft-fill gives priority to the right-hand side, guaranteeing space

1077

1141

** to display it and showing padding only if there's still room. If

1078

1142

** necessary, soft-fill will eat text leftwards to make room for

1079

1143

** rightward text.

1080

1144

** .pp

1081

** Note that these expandos are supported in

1145

** Note that these expandos are supported in

1082

1146

** ``$save-hook'', ``$fcc-hook'' and ``$fcc-save-hook'', too.

1083

** .pp

1084

** See also: ``$$to_chars''.

1085

1147

*/

1086

1148

{ "ispell", DT_PATH, R_NONE, UL &Ispell, UL ISPELL },

1087

1149

/*

1091

1153

{ "keep_flagged", DT_BOOL, R_NONE, OPTKEEPFLAGGED, 0 },

1092

1154

/*

1093

1155

** .pp

1094

** If set, read messages marked as flagged will not be moved

1095

** from your spool mailbox to your ``$$mbox'' mailbox, or as a result of

1156

** If \fIset\fP, read messages marked as flagged will not be moved

1157

** from your spool mailbox to your $$mbox mailbox, or as a result of

1096

1158

** a ``$mbox-hook'' command.

1097

1159

*/

1098

1160

{ "locale", DT_STR, R_BOTH, UL &Locale, UL "C" },

1099

1161

/*

1100

1162

** .pp

1101

** The locale used by \fIstrftime(3)\fP to format dates. Legal values are

1102

** the strings your system accepts for the locale variable \fILC_TIME\fP.

1163

** The locale used by \fCstrftime(3)\fP to format dates. Legal values are

1164

** the strings your system accepts for the locale environment variable \fC$$$LC_TIME\fP.

1103

1165

*/

1104

1166

{ "mail_check", DT_NUM, R_NONE, UL &BuffyTimeout, 5 },

1105

1167

/*

1106

1168

** .pp

1107

1169

** This variable configures how often (in seconds) mutt should look for

1108

** new mail. Also see the ``$$timeout'' variable.

1170

** new mail. Also see the $$timeout variable.

1109

1171

*/

1110

1172

{ "mailcap_path", DT_STR, R_NONE, UL &MailcapPath, 0 },

1111

1173

/*

1116

1178

{ "mailcap_sanitize", DT_BOOL, R_NONE, OPTMAILCAPSANITIZE, 1 },

1117

1179

/*

1118

1180

** .pp

1119

** If set, mutt will restrict possible characters in mailcap % expandos

1181

** If \fIset\fP, mutt will restrict possible characters in mailcap % expandos

1120

1182

** to a well-defined set of safe characters. This is the safe setting,

1121

1183

** but we are not sure it doesn't break some more advanced MIME stuff.

1122

1184

** .pp

1127

1189

{ "header_cache", DT_PATH, R_NONE, UL &HeaderCache, 0 },

1128

1190

/*

1129

1191

** .pp

1130

** The header_cache variable points to the header cache database.

1131

** If header_cache points to a directory it will contain a header cache

1132

** database per folder. If header_cache points to a file that file will

1133

** be a single global header cache. By default it is unset so no header

1192

** This variable points to the header cache database.

1193

** If pointing to a directory Mutt will contain a header cache

1194

** database file per folder, if pointing to a file that file will

1195

** be a single global header cache. By default it is \fIunset\fP so no header

1134

1196

** caching will be used.

1197

** .pp

1198

** Header caching can greatly improve speed when opening POP, IMAP

1199

** MH or Maildir folders, see ``$caching'' for details.

1135

1200

*/

1136

1201

{ "maildir_header_cache_verify", DT_BOOL, R_NONE, OPTHCACHEVERIFY, 1 },

1137

1202

/*

1138

1203

** .pp

1139

1204

** Check for Maildir unaware programs other than mutt having modified maildir

1140

** files when the header cache is in use. This incurs one stat(2) per

1141

** message every time the folder is opened.

1205

** files when the header cache is in use. This incurs one \fCstat(2)\fP per

1206

** message every time the folder is opened (which can be very slow for NFS

1207

** folders).

1142

1208

*/

1143

1209

#if defined(HAVE_GDBM) || defined(HAVE_DB4)

1144

1210

{ "header_cache_pagesize", DT_STR, R_NONE, UL &HeaderCachePageSize, UL "16384" },

1150

1216

** or less optimal for most use cases.

1151

1217

*/

1152

1218

#endif /* HAVE_GDBM || HAVE_DB4 */

1153

#if defined(HAVE_QDBM)

1219

#if defined(HAVE_QDBM) || defined(HAVE_TC)

1154

1220

{ "header_cache_compress", DT_BOOL, R_NONE, OPTHCACHECOMPRESS, 1 },

1155

1221

/*

1156

1222

** .pp

1157

** When mutt is compiled with qdbm as header cache backend,

1223

** When mutt is compiled with qdbm or tokyocabinet as header cache backend,

1158

1224

** this option determines whether the database will be compressed.

1159

1225

** Compression results in database files roughly being one fifth

1160

1226

** of the usual diskspace, but the uncompression can result in a

1161

** slower opening of cached folder(s).

1227

** slower opening of cached folder(s) which in general is still

1228

** much faster than opening non header cached folders.

1162

1229

*/

1163

1230

#endif /* HAVE_QDBM */

1164

1231

#endif /* USE_HCACHE */

1165

1232

{ "maildir_trash", DT_BOOL, R_NONE, OPTMAILDIRTRASH, 0 },

1166

1233

/*

1167

1234

** .pp

1168

** If set, messages marked as deleted will be saved with the maildir

1169

** (T)rashed flag instead of unlinked. \fBNOTE:\fP this only applies

1235

** If \fIset\fP, messages marked as deleted will be saved with the maildir

1236

** trashed flag instead of unlinked. \fBNote:\fP this only applies

1170

1237

** to maildir-style mailboxes. Setting it will have no effect on other

1171

1238

** mailbox types.

1172

1239

*/

1175

1242

** .pp

1176

1243

** Controls whether or not mutt marks \fInew\fP \fBunread\fP

1177

1244

** messages as \fIold\fP if you exit a mailbox without reading them.

1178

** With this option set, the next time you start mutt, the messages

1179

** will show up with an "O" next to them in the index menu,

1245

** With this option \fIset\fP, the next time you start mutt, the messages

1246

** will show up with an ``O'' next to them in the index menu,

1180

1247

** indicating that they are old.

1181

1248

*/

1182

1249

{ "markers", DT_BOOL, R_PAGER, OPTMARKERS, 1 },

1183

1250

/*

1184

1251

** .pp

1185

1252

** Controls the display of wrapped lines in the internal pager. If set, a

1186

** ``+'' marker is displayed at the beginning of wrapped lines. Also see

1187

** the ``$$smart_wrap'' variable.

1253

** ``+'' marker is displayed at the beginning of wrapped lines.

1254

** .pp

1255

** Also see the $$smart_wrap variable.

1188

1256

*/

1189

1257

{ "mask", DT_RX, R_NONE, UL &Mask, UL "!^\\.[^.]" },

1190

1258

/*

1196

1264

{ "mbox", DT_PATH, R_BOTH, UL &Inbox, UL "~/mbox" },

1197

1265

/*

1198

1266

** .pp

1199

** This specifies the folder into which read mail in your ``$$spoolfile''

1267

** This specifies the folder into which read mail in your $$spoolfile

1200

1268

** folder will be appended.

1269

** .pp

1270

** Also see the $$move variable.

1201

1271

*/

1202

1272

{ "mbox_type", DT_MAGIC,R_NONE, UL &DefaultMagic, M_MBOX },

1203

1273

/*

1204

1274

** .pp

1205

1275

** The default mailbox type used when creating new folders. May be any of

1206

** mbox, MMDF, MH and Maildir.

1276

** ``mbox'', ``MMDF'', ``MH'' and ``Maildir''.

1207

1277

*/

1208

1278

{ "metoo", DT_BOOL, R_NONE, OPTMETOO, 0 },

1209

1279

/*

1210

1280

** .pp

1211

** If unset, Mutt will remove your address (see the ``alternates''

1281

** If \fIunset\fP, Mutt will remove your address (see the ``$alternates''

1212

1282

** command) from the list of recipients when replying to a message.

1213

1283

*/

1214

1284

{ "menu_context", DT_NUM, R_NONE, UL &MenuContext, 0 },

1215

1285

/*

1216

1286

** .pp

1217

1287

** This variable controls the number of lines of context that are given

1218

** when scrolling through menus. (Similar to ``$$pager_context''.)

1288

** when scrolling through menus. (Similar to $$pager_context.)

1219

1289

*/

1220

1290

{ "menu_move_off", DT_BOOL, R_NONE, OPTMENUMOVEOFF, 1 },

1221

1291

/*

1235

1305

{ "meta_key", DT_BOOL, R_NONE, OPTMETAKEY, 0 },

1236

1306

/*

1237

1307

** .pp

1238

** If set, forces Mutt to interpret keystrokes with the high bit (bit 8)

1239

** set as if the user had pressed the ESC key and whatever key remains

1308

** If \fIset\fP, forces Mutt to interpret keystrokes with the high bit (bit 8)

1309

** set as if the user had pressed the Esc key and whatever key remains

1240

1310

** after having the high bit removed. For example, if the key pressed

1241

** has an ASCII value of 0xf8, then this is treated as if the user had

1242

** pressed ESC then ``x''. This is because the result of removing the

1243

** high bit from ``0xf8'' is ``0x78'', which is the ASCII character

1311

** has an ASCII value of \fC0xf8\fP, then this is treated as if the user had

1312

** pressed Esc then ``x''. This is because the result of removing the

1313

** high bit from \fC0xf8\fP is \fC0x78\fP, which is the ASCII character

1244

1314

** ``x''.

1245

1315

*/

1246

1316

{ "mh_purge", DT_BOOL, R_NONE, OPTMHPURGE, 0 },

1247

1317

/*

1248

1318

** .pp

1249

** When unset, mutt will mimic mh's behaviour and rename deleted messages

1319

** When \fIunset\fP, mutt will mimic mh's behaviour and rename deleted messages

1250

1320

** to \fI,<old file name>\fP in mh folders instead of really deleting

1251

** them. If the variable is set, the message files will simply be

1321

** them. This leaves the message on disk but makes programs reading the folder

1322

** ignore it. If the variable is \fIset\fP, the message files will simply be

1252

1323

** deleted.

1324

** .pp

1325

** This option is similar to $$maildir_trash for Maildir folders.

1253

1326

*/

1254

1327

{ "mh_seq_flagged", DT_STR, R_NONE, UL &MhFlagged, UL "flagged" },

1255

1328

/*

1269

1342

{ "mime_forward", DT_QUAD, R_NONE, OPT_MIMEFWD, M_NO },

1270

1343

/*

1271

1344

** .pp

1272

** When set, the message you are forwarding will be attached as a

1273

** separate MIME part instead of included in the main body of the

1345

** When \fIset\fP, the message you are forwarding will be attached as a

1346

** separate \fCmessage/rfc822\fP MIME part instead of included in the main body of the

1274

1347

** message. This is useful for forwarding MIME messages so the receiver

1275

1348

** can properly view the message as it was delivered to you. If you like

1276

1349

** to switch between MIME and not MIME from mail to mail, set this

1277

** variable to ask-no or ask-yes.

1350

** variable to ``ask-no'' or ``ask-yes''.

1278

1351

** .pp

1279

** Also see ``$$forward_decode'' and ``$$mime_forward_decode''.

1352

** Also see $$forward_decode and $$mime_forward_decode.

1280

1353

*/

1281

1354

{ "mime_forward_decode", DT_BOOL, R_NONE, OPTMIMEFORWDECODE, 0 },

1282

1355

/*

1283

1356

** .pp

1284

** Controls the decoding of complex MIME messages into text/plain when

1285

** forwarding a message while ``$$mime_forward'' is \fIset\fP. Otherwise

1286

** ``$$forward_decode'' is used instead.

1357

** Controls the decoding of complex MIME messages into \fCtext/plain\fP when

1358

** forwarding a message while $$mime_forward is \fIset\fP. Otherwise

1359

** $$forward_decode is used instead.

1287

1360

*/

1288

1361

{ "mime_fwd", DT_SYN, R_NONE, UL "mime_forward", 0 },

1289

1362

/*

1290

1363

*/

1291

1292

1364

{ "mime_forward_rest", DT_QUAD, R_NONE, OPT_MIMEFWDREST, M_YES },

1293

1365

/*

1294

1366

** .pp

1295

** When forwarding multiple attachments of a MIME message from the recvattach

1367

** When forwarding multiple attachments of a MIME message from the attachment

1296

1368

** menu, attachments which cannot be decoded in a reasonable manner will

1297

** be attached to the newly composed message if this option is set.

1369

** be attached to the newly composed message if this option is \fIset\fP.

1298

1370

*/

1299

1300

1371

#ifdef MIXMASTER

1301

1372

{ "mix_entry_format", DT_STR, R_NONE, UL &MixEntryFormat, UL "%4n %c %-16s %a" },

1302

1373

/*

1303

1374

** .pp

1304

1375

** This variable describes the format of a remailer line on the mixmaster

1305

** chain selection screen. The following printf-like sequences are

1376

** chain selection screen. The following \fCprintf(3)\fP-like sequences are

1306

1377

** supported:

1307

** .pp

1308

1378

** .dl

1309

1379

** .dt %n .dd The running number on the menu.

1310

1380

** .dt %c .dd Remailer capabilities.

1321

1391

** mixmaster chain.

1322

1392

*/

1323

1393

#endif

1324

1325

1326

{ "move", DT_QUAD, R_NONE, OPT_MOVE, M_ASKNO },

1394

{ "move", DT_QUAD, R_NONE, OPT_MOVE, M_NO },

1327

1395

/*

1328

1396

** .pp

1329

1397

** Controls whether or not Mutt will move read messages

1330

** from your spool mailbox to your ``$$mbox'' mailbox, or as a result of

1398

** from your spool mailbox to your $$mbox mailbox, or as a result of

1331

1399

** a ``$mbox-hook'' command.

1332

1400

*/

1333

1401

#if defined(USE_IMAP) || defined(USE_POP)

1336

1404

** .pp

1337

1405

** Set this to a directory and mutt will cache copies of messages from

1338

1406

** your IMAP and POP servers here. You are free to remove entries at any

1339

** time, for instance if stale entries accumulate because you have

1340

** deleted messages with another mail client.

1407

** time.

1408

** .pp

1409

** When setting this variable to a directory, mutt needs to fetch every

1410

** remote message only once and can perform regular expression searches

1411

** as fast as for local folders.

1412

** .pp

1413

** Also see the $$message_cache_clean variable.

1341

1414

*/

1342

1415

{ "message_cache_clean", DT_BOOL, R_NONE, OPTMESSAGECACHECLEAN, 0 },

1343

1416

/*

1344

1417

** .pp

1345

** If set, mutt will clean out obsolete entries from the cache when

1418

** If \fIset\fP, mutt will clean out obsolete entries from the message cache when

1346

1419

** the mailbox is synchronized. You probably only want to set it

1347

** every once in a while, since it can be a little slow.

1420

** every once in a while, since it can be a little slow

1421

** (especially for large folders).

1348

1422

*/

1349

1423

#endif

1350

1424

{ "message_format", DT_STR, R_NONE, UL &MsgFmt, UL "%s" },

1351

1425

/*

1352

1426

** .pp

1353

1427

** This is the string displayed in the ``attachment'' menu for

1354

** attachments of type message/rfc822. For a full listing of defined

1355

** printf()-like sequences see the section on ``$$index_format''.

1428

** attachments of type \fCmessage/rfc822\fP. For a full listing of defined

1429

** \fCprintf(3)\fP-like sequences see the section on $$index_format.

1356

1430

*/

1357

1431

{ "msg_format", DT_SYN, R_NONE, UL "message_format", 0 },

1358

1432

/*

1360

1434

{ "narrow_tree", DT_BOOL, R_TREE|R_INDEX, OPTNARROWTREE, 0 },

1361

1435

/*

1362

1436

** .pp

1363

** This variable, when set, makes the thread tree narrower, allowing

1437

** This variable, when \fIset\fP, makes the thread tree narrower, allowing

1364

1438

** deeper threads to fit on the screen.

1365

1439

*/

1366

1440

#ifdef USE_SOCKET

1368

1442

/*

1369

1443

** .pp

1370

1444

** Operations that expect to transfer a large amount of data over the

1371

** network will update their progress every \fInet_inc\fP kilobytes.

1445

** network will update their progress every $$net_inc kilobytes.

1372

1446

** If set to 0, no progress messages will be displayed.

1373

1447

** .pp

1374

** See also ``$$read_inc'' and ``$$write_inc''.

1448

** See also $$read_inc, $$write_inc and $$net_inc.

1375

1449

*/

1376

#endif

1450

#endif

1377

1451

{ "pager", DT_PATH, R_NONE, UL &Pager, UL "builtin" },

1378

1452

/*

1379

1453

** .pp

1380

1454

** This variable specifies which pager you would like to use to view

1381

** messages. builtin means to use the builtin pager, otherwise this

1455

** messages. The value ``builtin'' means to use the builtin pager, otherwise this

1382

1456

** variable should specify the pathname of the external pager you would

1383

1457

** like to use.

1384

1458

** .pp

1400

1474

** .pp

1401

1475

** This variable controls the format of the one-line message ``status''

1402

1476

** displayed before each message in either the internal or an external

1403

** pager. The valid sequences are listed in the ``$$index_format''

1477

** pager. The valid sequences are listed in the $$index_format

1404

1478

** section.

1405

1479

*/

1406

1480

{ "pager_index_lines",DT_NUM, R_PAGER, UL &PagerIndexLines, 0 },

1412

1486

** giving the reader the context of a few messages before and after the

1413

1487

** message. This is useful, for example, to determine how many messages

1414

1488

** remain to be read in the current thread. One of the lines is reserved

1415

** for the status bar from the index, so a \fIpager_index_lines\fP of 6

1489

** for the status bar from the index, so a setting of 6

1416

1490

** will only show 5 lines of the actual index. A value of 0 results in

1417

1491

** no index being shown. If the number of messages in the current folder

1418

** is less than \fIpager_index_lines\fP, then the index will only use as

1492

** is less than $$pager_index_lines, then the index will only use as

1419

1493

** many lines as it needs.

1420

1494

*/

1421

1495

{ "pager_stop", DT_BOOL, R_NONE, OPTPAGERSTOP, 0 },

1422

1496

/*

1423

1497

** .pp

1424

** When set, the internal-pager will \fBnot\fP move to the next message

1425

** when you are at the end of a message and invoke the \fInext-page\fP

1498

** When \fIset\fP, the internal-pager will \fBnot\fP move to the next message

1499

** when you are at the end of a message and invoke the \fC<next-page>\fP

1426

1500

** function.

1427

1501

*/

1428

1502

{ "pgp_autosign", DT_SYN, R_NONE, UL "crypt_autosign", 0 },

1431

1505

** .pp

1432

1506

** Setting this variable will cause Mutt to always attempt to

1433

1507

** cryptographically sign outgoing messages. This can be overridden

1434

** by use of the \fIpgp-menu\fP, when signing is not required or

1435

** encryption is requested as well. If ``$$smime_is_default'' is set,

1508

** by use of the pgp menu, when signing is not required or

1509

** encryption is requested as well. If $$smime_is_default is \fIset\fP,

1436

1510

** then OpenSSL is used instead to create S/MIME messages and settings can

1437

** be overridden by use of the \fIsmime-menu\fP.

1511

** be overridden by use of the smime menu instead of the pgp menu.

1438

1512

** (Crypto only)

1439

1513

*/

1440

1514

{ "pgp_autoencrypt", DT_SYN, R_NONE, UL "crypt_autoencrypt", 0 },

1443

1517

** .pp

1444

1518

** Setting this variable will cause Mutt to always attempt to PGP

1445

1519

** encrypt outgoing messages. This is probably only useful in

1446

** connection to the \fIsend-hook\fP command. It can be overridden

1447

** by use of the \fIpgp-menu\fP, when encryption is not required or

1448

** signing is requested as well. IF ``$$smime_is_default'' is set,

1520

** connection to the ``$send-hook'' command. It can be overridden

1521

** by use of the pgp menu, when encryption is not required or

1522

** signing is requested as well. If $$smime_is_default is \fIset\fP,

1449

1523

** then OpenSSL is used instead to create S/MIME messages and

1450

** settings can be overridden by use of the \fIsmime-menu\fP.

1524

** settings can be overridden by use of the smime menu instead.

1451

1525

** (Crypto only)

1452

1526

*/

1453

1527

{ "pgp_ignore_subkeys", DT_BOOL, R_NONE, OPTPGPIGNORESUB, 1},

1454

1528

/*

1455

1529

** .pp

1456

1530

** Setting this variable will cause Mutt to ignore OpenPGP subkeys. Instead,

1457

** the principal key will inherit the subkeys' capabilities. Unset this

1531

** the principal key will inherit the subkeys' capabilities. \fIUnset\fP this

1458

1532

** if you want to play interesting key selection games.

1459

1533

** (PGP only)

1460

1534

*/

1462

1536

{ "crypt_replyencrypt", DT_BOOL, R_NONE, OPTCRYPTREPLYENCRYPT, 1 },

1463

1537

/*

1464

1538

** .pp

1465

** If set, automatically PGP or OpenSSL encrypt replies to messages which are

1539

** If \fIset\fP, automatically PGP or OpenSSL encrypt replies to messages which are

1466

1540

** encrypted.

1467

1541

** (Crypto only)

1468

1542

*/

1470

1544

{ "crypt_replysign", DT_BOOL, R_NONE, OPTCRYPTREPLYSIGN, 0 },

1471

1545

/*

1472

1546

** .pp

1473

** If set, automatically PGP or OpenSSL sign replies to messages which are

1547

** If \fIset\fP, automatically PGP or OpenSSL sign replies to messages which are

1474

1548

** signed.

1475

1549

** .pp

1476

1550

** \fBNote:\fP this does not work on messages that are encrypted

1477

** \fBand\fP signed!

1551

** \fIand\fP signed!

1478

1552

** (Crypto only)

1479

1553

*/

1480

1554

{ "pgp_replysignencrypted", DT_SYN, R_NONE, UL "crypt_replysignencrypted", 0},

1481

1555

{ "crypt_replysignencrypted", DT_BOOL, R_NONE, OPTCRYPTREPLYSIGNENCRYPTED, 0 },

1482

1556

/*

1483

1557

** .pp

1484

** If set, automatically PGP or OpenSSL sign replies to messages

1558

** If \fIset\fP, automatically PGP or OpenSSL sign replies to messages

1485

1559

** which are encrypted. This makes sense in combination with

1486

** ``$$crypt_replyencrypt'', because it allows you to sign all

1560

** $$crypt_replyencrypt, because it allows you to sign all

1487

1561

** messages which are automatically encrypted. This works around

1488

** the problem noted in ``$$crypt_replysign'', that mutt is not able

1562

** the problem noted in $$crypt_replysign, that mutt is not able

1489

1563

** to find out whether an encrypted message is also signed.

1490

1564

** (Crypto only)

1491

1565

*/

1492

1566

{ "crypt_timestamp", DT_BOOL, R_NONE, OPTCRYPTTIMESTAMP, 1 },

1493

1567

/*

1494

1568

** .pp

1495

** If set, mutt will include a time stamp in the lines surrounding

1569

** If \fIset\fP, mutt will include a time stamp in the lines surrounding

1496

1570

** PGP or S/MIME output, so spoofing such lines is more difficult.

1497

1571

** If you are using colors to mark these lines, and rely on these,

1498

** you may unset this setting.

1572

** you may \fIunset\fP this setting.

1499

1573

** (Crypto only)

1500

1574

*/

1501

1575

{ "pgp_use_gpg_agent", DT_BOOL, R_NONE, OPTUSEGPGAGENT, 0},

1502

1576

/*

1503

1577

** .pp

1504

** If set, mutt will use a possibly-running gpg-agent process.

1578

** If \fIset\fP, mutt will use a possibly-running \fCgpg-agent(1)\fP process.

1505

1579

** (PGP only)

1506

1580

*/

1507

1581

{ "pgp_verify_sig", DT_SYN, R_NONE, UL "crypt_verify_sig", 0},

1508

1582

{ "crypt_verify_sig", DT_QUAD, R_NONE, OPT_VERIFYSIG, M_YES },

1509

1583

/*

1510

1584

** .pp

1511

** If ``yes'', always attempt to verify PGP or S/MIME signatures.

1512

** If ``ask'', ask whether or not to verify the signature.

1513

** If ``no'', never attempt to verify cryptographic signatures.

1585

** If \fI``yes''\fP, always attempt to verify PGP or S/MIME signatures.

1586

** If \fI``ask-*''\fP, ask whether or not to verify the signature.

1587

** If \Fi``no''\fP, never attempt to verify cryptographic signatures.

1514

1588

** (Crypto only)

1515

1589

*/

1516

1590

{ "smime_is_default", DT_BOOL, R_NONE, OPTSMIMEISDEFAULT, 0},

1517

1591

/*

1518

1592

** .pp

1519

1593

** The default behaviour of mutt is to use PGP on all auto-sign/encryption

1520

** operations. To override and to use OpenSSL instead this must be set.

1521

** However, this has no effect while replying, since mutt will automatically

1594

** operations. To override and to use OpenSSL instead this must be \fIset\fP.

1595

** However, this has no effect while replying, since mutt will automatically

1522

1596

** select the same application that was used to sign/encrypt the original

1523

1597

** message. (Note that this variable can be overridden by unsetting $$crypt_autosmime.)

1524

1598

** (S/MIME only)

1528

1602

** .pp

1529

1603

** This flag controls whether you want to be asked to enter a label

1530

1604

** for a certificate about to be added to the database or not. It is

1531

** set by default.

1605

** \fIset\fP by default.

1532

1606

** (S/MIME only)

1533

1607

*/

1534

1608

{ "smime_decrypt_use_default_key", DT_BOOL, R_NONE, OPTSDEFAULTDECRYPTKEY, 1 },

1535

1609

/*

1536

1610

** .pp

1537

** If set (default) this tells mutt to use the default key for decryption. Otherwise,

1538

** if manage multiple certificate-key-pairs, mutt will try to use the mailbox-address

1611

** If \fIset\fP (default) this tells mutt to use the default key for decryption. Otherwise,

1612

** if managing multiple certificate-key-pairs, mutt will try to use the mailbox-address

1539

1613

** to determine the key to use. It will ask you to supply a key, if it can't find one.

1540

1614

** (S/MIME only)

1541

1615

*/

1543

1617

/*

1544

1618

** .pp

1545

1619

** This variable allows you to customize the PGP key selection menu to

1546

** your personal taste. This string is similar to ``$$index_format'', but

1547

** has its own set of printf()-like sequences:

1548

** .pp

1620

** your personal taste. This string is similar to $$index_format, but

1621

** has its own set of \fCprintf(3)\fP-like sequences:

1549

1622

** .dl

1550

1623

** .dt %n .dd number

1551

1624

** .dt %k .dd key id

1555

1628

** .dt %f .dd flags

1556

1629

** .dt %c .dd capabilities

1557

1630

** .dt %t .dd trust/validity of the key-uid association

1558

** .dt %[<s>] .dd date of the key where <s> is an strftime(3) expression

1631

** .dt %[<s>] .dd date of the key where <s> is an \fCstrftime(3)\fP expression

1559

1632

** .de

1560

1633

** .pp

1561

1634

** (PGP only)

1568

1641

** the text. Use this variable if the exit code from the command is 0

1569

1642

** even for bad signatures.

1570

1643

** (PGP only)

1571

*/

1644

*/

1572

1645

{ "pgp_check_exit", DT_BOOL, R_NONE, OPTPGPCHECKEXIT, 1 },

1573

1646

/*

1574

1647

** .pp

1575

** If set, mutt will check the exit code of the PGP subprocess when

1648

** If \fIset\fP, mutt will check the exit code of the PGP subprocess when

1576

1649

** signing or encrypting. A non-zero exit code means that the

1577

1650

** subprocess failed.

1578

1651

** (PGP only)

1580

1653

{ "pgp_long_ids", DT_BOOL, R_NONE, OPTPGPLONGIDS, 0 },

1581

1654

/*

1582

1655

** .pp

1583

** If set, use 64 bit PGP key IDs. Unset uses the normal 32 bit Key IDs.

1656

** If \fIset\fP, use 64 bit PGP key IDs, if \fIunset\fP use the normal 32 bit key IDs.

1584

1657

** (PGP only)

1585

1658

*/

1586

1659

{ "pgp_retainable_sigs", DT_BOOL, R_NONE, OPTPGPRETAINABLESIG, 0 },

1587

1660

/*

1588

1661

** .pp

1589

** If set, signed and encrypted messages will consist of nested

1590

** multipart/signed and multipart/encrypted body parts.

1662

** If \fIset\fP, signed and encrypted messages will consist of nested

1663

** \fCmultipart/signed\fP and \fCmultipart/encrypted\fP body parts.

1591

1664

** .pp

1592

1665

** This is useful for applications like encrypted and signed mailing

1593

** lists, where the outer layer (multipart/encrypted) can be easily

1594

** removed, while the inner multipart/signed part is retained.

1666

** lists, where the outer layer (\fCmultipart/encrypted\fP) can be easily

1667

** removed, while the inner \fCmultipart/signed\fP part is retained.

1595

1668

** (PGP only)

1596

1669

*/

1597

1670

{ "pgp_create_traditional", DT_SYN, R_NONE, UL "pgp_autoinline", 0 },

1600

1673

** .pp

1601

1674

** This option controls whether Mutt generates old-style inline

1602

1675

** (traditional) PGP encrypted or signed messages under certain

1603

** circumstances. This can be overridden by use of the \fIpgp-menu\fP,

1676

** circumstances. This can be overridden by use of the pgp menu,

1604

1677

** when inline is not required.

1605

1678

** .pp

1606

1679

** Note that Mutt might automatically use PGP/MIME for messages

1607

1680

** which consist of more than a single MIME part. Mutt can be

1608

1681

** configured to ask before sending PGP/MIME messages when inline

1609

1682

** (traditional) would not work.

1610

** See also: ``$$pgp_mime_auto''.

1683

** .pp

1684

** Also see the $$pgp_mime_auto variable.

1611

1685

** .pp

1612

1686

** Also note that using the old-style PGP message format is \fBstrongly\fP

1613

1687

** \fBdeprecated\fP.

1620

1694

** Setting this variable will cause Mutt to always attempt to

1621

1695

** create an inline (traditional) message when replying to a

1622

1696

** message which is PGP encrypted/signed inline. This can be

1623

** overridden by use of the \fIpgp-menu\fP, when inline is not

1697

** overridden by use of the pgp menu, when inline is not

1624

1698

** required. This option does not automatically detect if the

1625

1699

** (replied-to) message is inline; instead it relies on Mutt

1626

1700

** internals for previously checked/flagged messages.

1629

1703

** which consist of more than a single MIME part. Mutt can be

1630

1704

** configured to ask before sending PGP/MIME messages when inline

1631

1705

** (traditional) would not work.

1632

** See also: ``$$pgp_mime_auto''.

1706

** .pp

1707

** Also see the $$pgp_mime_auto variable.

1633

1708

** .pp

1634

1709

** Also note that using the old-style PGP message format is \fBstrongly\fP

1635

1710

** \fBdeprecated\fP.

1636

1711

** (PGP only)

1637

**

1712

**

1638

1713

*/

1639

1714

{ "pgp_show_unusable", DT_BOOL, R_NONE, OPTPGPSHOWUNUSABLE, 1 },

1640

1715

/*

1641

1716

** .pp

1642

** If set, mutt will display non-usable keys on the PGP key selection

1717

** If \fIset\fP, mutt will display non-usable keys on the PGP key selection

1643

1718

** menu. This includes keys which have been revoked, have expired, or

1644

1719

** have been marked as ``disabled'' by the user.

1645

1720

** (PGP only)

1649

1724

** .pp

1650

1725

** If you have more than one key pair, this option allows you to specify

1651

1726

** which of your private keys to use. It is recommended that you use the

1652

** keyid form to specify your key (e.g., ``0x00112233'').

1727

** keyid form to specify your key (e.g. \fC0x00112233\fP).

1653

1728

** (PGP only)

1654

1729

*/

1655

1730

{ "pgp_strict_enc", DT_BOOL, R_NONE, OPTPGPSTRICTENC, 1 },

1656

1731

/*

1657

1732

** .pp

1658

** If set, Mutt will automatically encode PGP/MIME signed messages as

1659

** \fIquoted-printable\fP. Please note that unsetting this variable may

1733

** If \fIset\fP, Mutt will automatically encode PGP/MIME signed messages as

1734

** quoted-printable. Please note that unsetting this variable may

1660

1735

** lead to problems with non-verifyable PGP signatures, so only change

1661

1736

** this if you know what you are doing.

1662

1737

** (PGP only)

1671

1746

{ "pgp_sort_keys", DT_SORT|DT_SORT_KEYS, R_NONE, UL &PgpSortKeys, SORT_ADDRESS },

1672

1747

/*

1673

1748

** .pp

1674

** Specifies how the entries in the `pgp keys' menu are sorted. The

1749

** Specifies how the entries in the pgp menu are sorted. The

1675

1750

** following are legal values:

1676

** .pp

1677

1751

** .dl

1678

1752

** .dt address .dd sort alphabetically by user id

1679

1753

** .dt keyid .dd sort alphabetically by key id

1682

1756

** .de

1683

1757

** .pp

1684

1758

** If you prefer reverse order of the above values, prefix it with

1685

** `reverse-'.

1759

** ``reverse-''.

1686

1760

** (PGP only)

1687

1761

*/

1688

1762

{ "pgp_mime_auto", DT_QUAD, R_NONE, OPT_PGPMIMEAUTO, M_ASKYES },

1699

1773

{ "pgp_auto_decode", DT_BOOL, R_NONE, OPTPGPAUTODEC, 0 },

1700

1774

/*

1701

1775

** .pp

1702

** If set, mutt will automatically attempt to decrypt traditional PGP

1776

** If \fIset\fP, mutt will automatically attempt to decrypt traditional PGP

1703

1777

** messages whenever the user performs an operation which ordinarily would

1704

1778

** result in the contents of the message being operated on. For example,

1705

1779

** if the user displays a pgp-traditional message which has not been manually

1706

** checked with the check-traditional-pgp function, mutt will automatically

1780

** checked with the \fC$<check-traditional-pgp>\fP function, mutt will automatically

1707

1781

** check the message for traditional pgp.

1708

1782

*/

1709

1783

1710

1711

1784

/* XXX Default values! */

1712

1785

1713

1786

{ "pgp_decode_command", DT_STR, R_NONE, UL &PgpDecodeCommand, 0},

1714

1787

/*

1715

1788

** .pp

1716

** This format strings specifies a command which is used to decode

1789

** This format strings specifies a command which is used to decode

1717

1790

** application/pgp attachments.

1718

1791

** .pp

1719

** The PGP command formats have their own set of printf-like sequences:

1720

** .pp

1792

** The PGP command formats have their own set of \fCprintf(3)\fP-like sequences:

1721

1793

** .dl

1722

1794

** .dt %p .dd Expands to PGPPASSFD=0 when a pass phrase is needed, to an empty

1723

1795

** string otherwise. Note: This may be used with a %? construct.

1724

1796

** .dt %f .dd Expands to the name of a file containing a message.

1725

1797

** .dt %s .dd Expands to the name of a file containing the signature part

1726

** . of a multipart/signed attachment when verifying it.

1798

** . of a \fCmultipart/signed\fP attachment when verifying it.

1727

1799

** .dt %a .dd The value of $$pgp_sign_as.

1728

1800

** .dt %r .dd One or more key IDs.

1729

1801

** .de

1730

1802

** .pp

1731

1803

** For examples on how to configure these formats for the various versions

1732

** of PGP which are floating around, see the pgp*.rc and gpg.rc files in

1733

** the samples/ subdirectory which has been installed on your system

1804

** of PGP which are floating around, see the pgp and gpg sample configuration files in

1805

** the \fCsamples/\fP subdirectory which has been installed on your system

1734

1806

** alongside the documentation.

1735

1807

** (PGP only)

1736

1808

*/

1738

1810

/*

1739

1811

** .pp

1740

1812

** This command is invoked whenever mutt will need public key information.

1741

** %r is the only printf-like sequence used with this format.

1813

** Of the sequences supported by $$pgp_decode_command, %r is the only

1814

** \fCprintf(3)\fP-like sequence used with this format.

1742

1815

** (PGP only)

1743

1816

*/

1744

1817

{ "pgp_verify_command", DT_STR, R_NONE, UL &PgpVerifyCommand, 0},

1745

1818

/*

1746

1819

** .pp

1747

1820

** This command is used to verify PGP signatures.

1821

** .pp

1822

** This is a format string, see the $$pgp_decode_command command for

1823

** possible \fCprintf(3)\fP-like sequences.

1748

1824

** (PGP only)

1749

1825

*/

1750

1826

{ "pgp_decrypt_command", DT_STR, R_NONE, UL &PgpDecryptCommand, 0},

1751

1827

/*

1752

1828

** .pp

1753

1829

** This command is used to decrypt a PGP encrypted message.

1830

** .pp

1831

** This is a format string, see the $$pgp_decode_command command for

1832

** possible \fCprintf(3)\fP-like sequences.

1754

1833

** (PGP only)

1755

*/

1834

*/

1756

1835

{ "pgp_clearsign_command", DT_STR, R_NONE, UL &PgpClearSignCommand, 0 },

1757

1836

/*

1758

1837

** .pp

1759

** This format is used to create a old-style "clearsigned" PGP

1838

** This format is used to create a old-style ``clearsigned'' PGP

1760

1839

** message. Note that the use of this format is \fBstrongly\fP

1761

1840

** \fBdeprecated\fP.

1841

** .pp

1842

** This is a format string, see the $$pgp_decode_command command for

1843

** possible \fCprintf(3)\fP-like sequences.

1762

1844

** (PGP only)

1763

1845

*/

1764

1846

{ "pgp_sign_command", DT_STR, R_NONE, UL &PgpSignCommand, 0},

1765

1847

/*

1766

1848

** .pp

1767

** This command is used to create the detached PGP signature for a

1768

** multipart/signed PGP/MIME body part.

1849

** This command is used to create the detached PGP signature for a

1850

** \fCmultipart/signed\fP PGP/MIME body part.

1851

** .pp

1852

** This is a format string, see the $$pgp_decode_command command for

1853

** possible \fCprintf(3)\fP-like sequences.

1769

1854

** (PGP only)

1770

*/

1855

*/

1771

1856

{ "pgp_encrypt_sign_command", DT_STR, R_NONE, UL &PgpEncryptSignCommand, 0},

1772

1857

/*

1773

1858

** .pp

1774

1859

** This command is used to both sign and encrypt a body part.

1860

** .pp

1861

** This is a format string, see the $$pgp_decode_command command for

1862

** possible \fCprintf(3)\fP-like sequences.

1775

1863

** (PGP only)

1776

*/

1864

*/

1777

1865

{ "pgp_encrypt_only_command", DT_STR, R_NONE, UL &PgpEncryptOnlyCommand, 0},

1778

1866

/*

1779

1867

** .pp

1780

1868

** This command is used to encrypt a body part without signing it.

1869

** .pp

1870

** This is a format string, see the $$pgp_decode_command command for

1871

** possible \fCprintf(3)\fP-like sequences.

1781

1872

** (PGP only)

1782

*/

1873

*/

1783

1874

{ "pgp_import_command", DT_STR, R_NONE, UL &PgpImportCommand, 0},

1784

1875

/*

1785

1876

** .pp

1786

** This command is used to import a key from a message into

1877

** This command is used to import a key from a message into

1787

1878

** the user's public key ring.

1879

** .pp

1880

** This is a format string, see the $$pgp_decode_command command for

1881

** possible \fCprintf(3)\fP-like sequences.

1788

1882

** (PGP only)

1789

*/

1883

*/

1790

1884

{ "pgp_export_command", DT_STR, R_NONE, UL &PgpExportCommand, 0},

1791

1885

/*

1792

1886

** .pp

1793

1887

** This command is used to export a public key from the user's

1794

1888

** key ring.

1889

** .pp

1890

** This is a format string, see the $$pgp_decode_command command for

1891

** possible \fCprintf(3)\fP-like sequences.

1795

1892

** (PGP only)

1796

*/

1893

*/

1797

1894

{ "pgp_verify_key_command", DT_STR, R_NONE, UL &PgpVerifyKeyCommand, 0},

1798

1895

/*

1799

1896

** .pp

1800

1897

** This command is used to verify key information from the key selection

1801

1898

** menu.

1899

** .pp

1900

** This is a format string, see the $$pgp_decode_command command for

1901

** possible \fCprintf(3)\fP-like sequences.

1802

1902

** (PGP only)

1803

*/

1903

*/

1804

1904

{ "pgp_list_secring_command", DT_STR, R_NONE, UL &PgpListSecringCommand, 0},

1805

1905

/*

1806

1906

** .pp

1807

1907

** This command is used to list the secret key ring's contents. The

1808

** output format must be analogous to the one used by

1908

** output format must be analogous to the one used by:

1909

** .ts

1809

1910

** gpg --list-keys --with-colons.

1911

** .te

1810

1912

** .pp

1811

** This format is also generated by the pgpring utility which comes

1913

** This format is also generated by the \fCpgpring\fP utility which comes

1812

1914

** with mutt.

1915

** .pp

1916

** This is a format string, see the $$pgp_decode_command command for

1917

** possible \fCprintf(3)\fP-like sequences.

1813

1918

** (PGP only)

1814

*/

1919

*/

1815

1920

{ "pgp_list_pubring_command", DT_STR, R_NONE, UL &PgpListPubringCommand, 0},

1816

1921

/*

1817

1922

** .pp

1818

1923

** This command is used to list the public key ring's contents. The

1819

** output format must be analogous to the one used by

1924

** output format must be analogous to the one used by

1925

** .ts

1820

1926

** gpg --list-keys --with-colons.

1927

** .te

1821

1928

** .pp

1822

** This format is also generated by the pgpring utility which comes

1929

** This format is also generated by the \fCpgpring\fP utility which comes

1823

1930

** with mutt.

1931

** .pp

1932

** This is a format string, see the $$pgp_decode_command command for

1933

** possible \fCprintf(3)\fP-like sequences.

1824

1934

** (PGP only)

1825

*/

1935

*/

1826

1936

{ "forward_decrypt", DT_BOOL, R_NONE, OPTFORWDECRYPT, 1 },

1827

1937

/*

1828

1938

** .pp

1829

1939

** Controls the handling of encrypted messages when forwarding a message.

1830

** When set, the outer layer of encryption is stripped off. This

1831

** variable is only used if ``$$mime_forward'' is \fIset\fP and

1832

** ``$$mime_forward_decode'' is \fIunset\fP.

1940

** When \fIset\fP, the outer layer of encryption is stripped off. This

1941

** variable is only used if $$mime_forward is \fIset\fP and

1942

** $$mime_forward_decode is \fIunset\fP.

1833

1943

** (PGP only)

1834

1944

*/

1835

1945

{ "forw_decrypt", DT_SYN, R_NONE, UL "forward_decrypt", 0 },

1836

1946

/*

1837

1947

*/

1838

1839

1948

{ "smime_timeout", DT_NUM, R_NONE, UL &SmimeTimeout, 300 },

1840

1949

/*

1841

1950

** .pp

1847

1956

/*

1848

1957

** .pp

1849

1958

** This sets the algorithm that should be used for encryption.

1850

** Valid choices are "des", "des3", "rc2-40", "rc2-64", "rc2-128".

1851

** If unset "3des" (TripleDES) is used.

1959

** Valid choices are ``des'', ``des3'', ``rc2-40'', ``rc2-64'', ``rc2-128''.

1960

** If \fIunset\fP, ``3des'' (TripleDES) is used.

1852

1961

** (S/MIME only)

1853

1962

*/

1854

1963

{ "smime_keys", DT_PATH, R_NONE, UL &SmimeKeys, 0 },

1855

1964

/*

1856

1965

** .pp

1857

** Since there is no pubring/secring as with PGP, mutt has to handle

1858

** storage ad retrieval of keys/certs by itself. This is very basic right now,

1966

** Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle

1967

** storage and retrieval of keys/certs by itself. This is very basic right now,

1859

1968

** and stores keys and certificates in two different directories, both

1860

1969

** named as the hash-value retrieved from OpenSSL. There is an index file

1861

1970

** which contains mailbox-address keyid pair, and which can be manually

1862

** edited. This one points to the location of the private keys.

1971

** edited. This option points to the location of the private keys.

1863

1972

** (S/MIME only)

1864

1973

*/

1865

1974

{ "smime_ca_location", DT_PATH, R_NONE, UL &SmimeCALocation, 0 },

1872

1981

{ "smime_certificates", DT_PATH, R_NONE, UL &SmimeCertificates, 0 },

1873

1982

/*

1874

1983

** .pp

1875

** Since there is no pubring/secring as with PGP, mutt has to handle

1984

** Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle

1876

1985

** storage and retrieval of keys by itself. This is very basic right

1877

1986

** now, and keys and certificates are stored in two different

1878

1987

** directories, both named as the hash-value retrieved from

1879

1988

** OpenSSL. There is an index file which contains mailbox-address

1880

** keyid pairs, and which can be manually edited. This one points to

1989

** keyid pairs, and which can be manually edited. This option points to

1881

1990

** the location of the certificates.

1882

1991

** (S/MIME only)

1883

1992

*/

1885

1994

/*

1886

1995

** .pp

1887

1996

** This format string specifies a command which is used to decrypt

1888

** application/x-pkcs7-mime attachments.

1997

** \fCapplication/x-pkcs7-mime\fP attachments.

1889

1998

** .pp

1890

** The OpenSSL command formats have their own set of printf-like sequences

1999

** The OpenSSL command formats have their own set of \fCprintf(3)\fP-like sequences

1891

2000

** similar to PGP's:

1892

** .pp

1893

2001

** .dl

1894

2002

** .dt %f .dd Expands to the name of a file containing a message.

1895

2003

** .dt %s .dd Expands to the name of a file containing the signature part

1896

** . of a multipart/signed attachment when verifying it.

2004

** . of a \fCmultipart/signed\fP attachment when verifying it.

1897

2005

** .dt %k .dd The key-pair specified with $$smime_default_key

1898

2006

** .dt %c .dd One or more certificate IDs.

1899

2007

** .dt %a .dd The algorithm used for encryption.

1900

2008

** .dt %C .dd CA location: Depending on whether $$smime_ca_location

1901

** . points to a directory or file, this expands to

1902

** . "-CApath $$smime_ca_location" or "-CAfile $$smime_ca_location".

2009

** . points to a directory or file, this expands to

2010

** . ``-CApath $$smime_ca_location'' or ``-CAfile $$smime_ca_location''.

1903

2011

** .de

1904

2012

** .pp

1905

** For examples on how to configure these formats, see the smime.rc in

1906

** the samples/ subdirectory which has been installed on your system

2013

** For examples on how to configure these formats, see the \fCsmime.rc\fP in

2014

** the \fCsamples/\fP subdirectory which has been installed on your system

1907

2015

** alongside the documentation.

1908

2016

** (S/MIME only)

1909

2017

*/

1910

2018

{ "smime_verify_command", DT_STR, R_NONE, UL &SmimeVerifyCommand, 0},

1911

2019

/*

1912

2020

** .pp

1913

** This command is used to verify S/MIME signatures of type multipart/signed.

2021

** This command is used to verify S/MIME signatures of type \fCmultipart/signed\fP.

2022

** .pp

2023

** This is a format string, see the $$smime_decrypt_command command for

2024

** possible \fCprintf(3)\fP-like sequences.

1914

2025

** (S/MIME only)

1915

2026

*/

1916

2027

{ "smime_verify_opaque_command", DT_STR, R_NONE, UL &SmimeVerifyOpaqueCommand, 0},

1917

2028

/*

1918

2029

** .pp

1919

2030

** This command is used to verify S/MIME signatures of type

1920

** application/x-pkcs7-mime.

2031

** \fCapplication/x-pkcs7-mime\fP.

2032

** .pp

2033

** This is a format string, see the $$smime_decrypt_command command for

2034

** possible \fCprintf(3)\fP-like sequences.

1921

2035

** (S/MIME only)

1922

2036

*/

1923

2037

{ "smime_sign_command", DT_STR, R_NONE, UL &SmimeSignCommand, 0},

1924

2038

/*

1925

2039

** .pp

1926

2040

** This command is used to created S/MIME signatures of type

1927

** multipart/signed, which can be read by all mail clients.

2041

** \fCmultipart/signed\fP, which can be read by all mail clients.

2042

** .pp

2043

** This is a format string, see the $$smime_decrypt_command command for

2044

** possible \fCprintf(3)\fP-like sequences.

1928

2045

** (S/MIME only)

1929

2046

*/

1930

2047

{ "smime_sign_opaque_command", DT_STR, R_NONE, UL &SmimeSignOpaqueCommand, 0},

1931

2048

/*

1932

2049

** .pp

1933

2050

** This command is used to created S/MIME signatures of type

1934

** application/x-pkcs7-signature, which can only be handled by mail

2051

** \fCapplication/x-pkcs7-signature\fP, which can only be handled by mail

1935

2052

** clients supporting the S/MIME extension.

2053

** .pp

2054

** This is a format string, see the $$smime_decrypt_command command for

2055

** possible \fCprintf(3)\fP-like sequences.

1936

2056

** (S/MIME only)

1937

2057

*/

1938

2058

{ "smime_encrypt_command", DT_STR, R_NONE, UL &SmimeEncryptCommand, 0},

1939

2059

/*

1940

2060

** .pp

1941

2061

** This command is used to create encrypted S/MIME messages.

2062

** .pp

2063

** This is a format string, see the $$smime_decrypt_command command for

2064

** possible \fCprintf(3)\fP-like sequences.

1942

2065

** (S/MIME only)

1943

2066

*/

1944

2067

{ "smime_pk7out_command", DT_STR, R_NONE, UL &SmimePk7outCommand, 0},

1946

2069

** .pp

1947

2070

** This command is used to extract PKCS7 structures of S/MIME signatures,

1948

2071

** in order to extract the public X509 certificate(s).

2072

** .pp

2073

** This is a format string, see the $$smime_decrypt_command command for

2074

** possible \fCprintf(3)\fP-like sequences.

1949

2075

** (S/MIME only)

1950

2076

*/

1951

2077

{ "smime_get_cert_command", DT_STR, R_NONE, UL &SmimeGetCertCommand, 0},

1952

2078

/*

1953

2079

** .pp

1954

2080

** This command is used to extract X509 certificates from a PKCS7 structure.

2081

** .pp

2082

** This is a format string, see the $$smime_decrypt_command command for

2083

** possible \fCprintf(3)\fP-like sequences.

1955

2084

** (S/MIME only)

1956

2085

*/

1957

2086

{ "smime_get_signer_cert_command", DT_STR, R_NONE, UL &SmimeGetSignerCertCommand, 0},

1959

2088

** .pp

1960

2089

** This command is used to extract only the signers X509 certificate from a S/MIME

1961

2090

** signature, so that the certificate's owner may get compared to the

1962

** email's 'From'-field.

2091

** email's ``From:'' field.

2092

** .pp

2093

** This is a format string, see the $$smime_decrypt_command command for

2094

** possible \fCprintf(3)\fP-like sequences.

1963

2095

** (S/MIME only)

1964

2096

*/

1965

2097

{ "smime_import_cert_command", DT_STR, R_NONE, UL &SmimeImportCertCommand, 0},

1966

2098

/*

1967

2099

** .pp

1968

2100

** This command is used to import a certificate via smime_keys.

2101

** .pp

2102

** This is a format string, see the $$smime_decrypt_command command for

2103

** possible \fCprintf(3)\fP-like sequences.

1969

2104

** (S/MIME only)

1970

2105

*/

1971

2106

{ "smime_get_cert_email_command", DT_STR, R_NONE, UL &SmimeGetCertEmailCommand, 0},

1974

2109

** This command is used to extract the mail address(es) used for storing

1975

2110

** X509 certificates, and for verification purposes (to check whether the

1976

2111

** certificate was issued for the sender's mailbox).

2112

** .pp

2113

** This is a format string, see the $$smime_decrypt_command command for

2114

** possible \fCprintf(3)\fP-like sequences.

1977

2115

** (S/MIME only)

1978

2116

*/

1979

2117

{ "smime_sign_as", DT_SYN, R_NONE, UL "smime_default_key", 0 },

1984

2122

** keyid (the hash-value that OpenSSL generates) to work properly

1985

2123

** (S/MIME only)

1986

2124

*/

1987

1988

2125

#if defined(USE_SSL)

1989

#ifdef USE_SSL_OPENSSL

1990

2126

{ "ssl_client_cert", DT_PATH, R_NONE, UL &SslClientCert, 0 },

1991

2127

/*

1992

2128

** .pp

1993

2129

** The file containing a client certificate and its associated private

1994

2130

** key.

1995

2131

*/

1996

#endif /* USE_SSL_OPENSSL */

1997

2132

{ "ssl_force_tls", DT_BOOL, R_NONE, OPTSSLFORCETLS, 0 },

1998

2133

/*

1999

2134

** .pp

2000

** If this variable is set, Mutt will require that all connections

2135

** If this variable is \fIset\fP, Mutt will require that all connections

2001

2136

** to remote servers be encrypted. Furthermore it will attempt to

2002

2137

** negotiate TLS even if the server does not advertise the capability,

2003

2138

** since it would otherwise have to abort the connection anyway. This

2004

** option supersedes ``$$ssl_starttls''.

2139

** option supersedes $$ssl_starttls.

2005

2140

*/

2006

2141

{ "ssl_starttls", DT_QUAD, R_NONE, OPT_SSLSTARTTLS, M_YES },

2007

2142

/*

2008

2143

** .pp

2009

** If set (the default), mutt will attempt to use STARTTLS on servers

2010

** advertising the capability. When unset, mutt will not attempt to

2011

** use STARTTLS regardless of the server's capabilities.

2144

** If \fIset\fP (the default), mutt will attempt to use \fCSTARTTLS\fP on servers

2145

** advertising the capability. When \fIunset\fP, mutt will not attempt to

2146

** use \fCSTARTTLS\fP regardless of the server's capabilities.

2012

2147

*/

2013

2148

{ "certificate_file", DT_PATH, R_NONE, UL &SslCertFile, UL "~/.mutt_certificates" },

2014

2149

/*

2015

2150

** .pp

2016

2151

** This variable specifies the file where the certificates you trust

2017

2152

** are saved. When an unknown certificate is encountered, you are asked

2018

** if you accept it or not. If you accept it, the certificate can also

2019

** be saved in this file and further connections are automatically

2153

** if you accept it or not. If you accept it, the certificate can also

2154

** be saved in this file and further connections are automatically

2020

2155

** accepted.

2021

2156

** .pp

2022

2157

** You can also manually add CA certificates in this file. Any server

2023

** certificate that is signed with one of these CA certificates are

2158

** certificate that is signed with one of these CA certificates is

2024

2159

** also automatically accepted.

2025

2160

** .pp

2026

** Example: set certificate_file=~/.mutt/certificates

2161

** Example:

2162

** .ts

2163

** set certificate_file=~/.mutt/certificates

2164

** .te

2027

2165

*/

2028

2166

# ifdef USE_SSL_OPENSSL

2029

2167

{ "ssl_usesystemcerts", DT_BOOL, R_NONE, OPTSSLSYSTEMCERTS, 1 },

2030

2168

/*

2031

2169

** .pp

2032

2170

** If set to \fIyes\fP, mutt will use CA certificates in the

2033

** system-wide certificate store when checking if server certificate

2171

** system-wide certificate store when checking if a server certificate

2034

2172

** is signed by a trusted CA.

2035

2173

*/

2036

2174

{ "entropy_file", DT_PATH, R_NONE, UL &SslEntropyFile, 0 },

2071

2209

** .pp

2072

2210

** This variable specifies a file containing trusted CA certificates.

2073

2211

** Any server certificate that is signed with one of these CA

2074

** certificates are also automatically accepted.

2212

** certificates is also automatically accepted.

2075

2213

** .pp

2076

** Example: set ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt

2214

** Example:

2215

** .ts

2216

** set ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt

2217

** .te

2077

2218

*/

2078

2219

# endif /* USE_SSL_GNUTLS */

2079

2220

#endif /* defined(USE_SSL) */

2080

2081

2221

{ "pipe_split", DT_BOOL, R_NONE, OPTPIPESPLIT, 0 },

2082

2222

/*

2083

2223

** .pp

2084

** Used in connection with the \fIpipe-message\fP command and the ``tag-

2085

** prefix'' operator. If this variable is unset, when piping a list of

2224

** Used in connection with the \fC<pipe-message>\fP function following

2225

** \fC<tag-prefix>\fP. If this variable is \fIunset\fP, when piping a list of

2086

2226

** tagged messages Mutt will concatenate the messages and will pipe them

2087

** as a single folder. When set, Mutt will pipe the messages one by one.

2227

** all concatenated. When \fIset\fP, Mutt will pipe the messages one by one.

2088

2228

** In both cases the messages are piped in the current sorted order,

2089

** and the ``$$pipe_sep'' separator is added after each message.

2229

** and the $$pipe_sep separator is added after each message.

2090

2230

*/

2091

2231

{ "pipe_decode", DT_BOOL, R_NONE, OPTPIPEDECODE, 0 },

2092

2232

/*

2093

2233

** .pp

2094

** Used in connection with the \fIpipe-message\fP command. When unset,

2095

** Mutt will pipe the messages without any preprocessing. When set, Mutt

2096

** will weed headers and will attempt to PGP/MIME decode the messages

2234

** Used in connection with the \fC<pipe-message>\fP command. When \fIunset\fP,

2235

** Mutt will pipe the messages without any preprocessing. When \fIset\fP, Mutt

2236

** will weed headers and will attempt to decode the messages

2097

2237

** first.

2098

2238

*/

2099

2239

{ "pipe_sep", DT_STR, R_NONE, UL &PipeSep, UL "\n" },

2108

2248

** .pp

2109

2249

** This is a colon-delimited list of authentication methods mutt may

2110

2250

** attempt to use to log in to an POP server, in the order mutt should

2111

** try them. Authentication methods are either 'user', 'apop' or any

2112

** SASL mechanism, eg 'digest-md5', 'gssapi' or 'cram-md5'.

2113

** This parameter is case-insensitive. If this parameter is unset

2251

** try them. Authentication methods are either ``user'', ``apop'' or any

2252

** SASL mechanism, eg ``digest-md5'', ``gssapi'' or ``cram-md5''.

2253

** This option is case-insensitive. If this option is \fIunset\fP

2114

2254

** (the default) mutt will try all available methods, in order from

2115

2255

** most-secure to least-secure.

2116

2256

** .pp

2117

** Example: set pop_authenticators="digest-md5:apop:user"

2257

** Example:

2258

** .ts

2259

** set pop_authenticators="digest-md5:apop:user"

2260

** .te

2118

2261

*/

2119

2262

{ "pop_auth_try_all", DT_BOOL, R_NONE, OPTPOPAUTHTRYALL, 1 },

2120

2263

/*

2121

2264

** .pp

2122

** If set, Mutt will try all available methods. When unset, Mutt will

2123

** only fall back to other authentication methods if the previous

2124

** methods are unavailable. If a method is available but authentication

2125

** fails, Mutt will not connect to the POP server.

2265

** If \fIset\fP, Mutt will try all available authentication methods.

2266

** When \fIunset\fP, Mutt will only fall back to other authentication

2267

** methods if the previous methods are unavailable. If a method is

2268

** available but authentication fails, Mutt will not connect to the POP server.

2126

2269

*/

2127

2270

{ "pop_checkinterval", DT_NUM, R_NONE, UL &PopCheckTimeout, 60 },

2128

2271

/*

2133

2276

{ "pop_delete", DT_QUAD, R_NONE, OPT_POPDELETE, M_ASKNO },

2134

2277

/*

2135

2278

** .pp

2136

** If set, Mutt will delete successfully downloaded messages from the POP

2137

** server when using the fetch-mail function. When unset, Mutt will

2279

** If \fIset\fP, Mutt will delete successfully downloaded messages from the POP

2280

** server when using the \fC$<fetch-mail>\fP function. When \fIunset\fP, Mutt will

2138

2281

** download messages but also leave them on the POP server.

2139

2282

*/

2140

2283

{ "pop_host", DT_STR, R_NONE, UL &PopHost, UL "" },

2141

2284

/*

2142

2285

** .pp

2143

** The name of your POP server for the fetch-mail function. You

2286

** The name of your POP server for the \fC$<fetch-mail>\fP function. You

2144

2287

** can also specify an alternative port, username and password, ie:

2145

** .pp

2288

** .ts

2146

2289

** [pop[s]://][username[:password]@]popserver[:port]

2290

** .te

2291

** .pp

2292

** where ``[...]'' denotes an optional part.

2147

2293

*/

2148

2294

{ "pop_last", DT_BOOL, R_NONE, OPTPOPLAST, 0 },

2149

2295

/*

2150

2296

** .pp

2151

** If this variable is set, mutt will try to use the "LAST" POP command

2297

** If this variable is \fIset\fP, mutt will try to use the ``\fCLAST\fP'' POP command

2152

2298

** for retrieving only unread messages from the POP server when using

2153

** the fetch-mail function.

2299

** the \fC$<fetch-mail>\fP function.

2154

2300

*/

2155

2301

{ "pop_reconnect", DT_QUAD, R_NONE, OPT_POPRECONNECT, M_ASKYES },

2156

2302

/*

2157

2303

** .pp

2158

** Controls whether or not Mutt will try to reconnect to POP server if

2304

** Controls whether or not Mutt will try to reconnect to the POP server if

2159

2305

** the connection is lost.

2160

2306

*/

2161

2307

{ "pop_user", DT_STR, R_NONE, UL &PopUser, 0 },

2168

2314

{ "pop_pass", DT_STR, R_NONE, UL &PopPass, UL "" },

2169

2315

/*

2170

2316

** .pp

2171

** Specifies the password for your POP account. If unset, Mutt will

2172

** prompt you for your password when you open POP mailbox.

2317

** Specifies the password for your POP account. If \fIunset\fP, Mutt will

2318

** prompt you for your password when you open a POP mailbox.

2319

** .pp

2173

2320

** \fBWarning\fP: you should only use this option when you are on a

2174

2321

** fairly secure machine, because the superuser can read your muttrc

2175

2322

** even if you are the only one who can read the file.

2178

2325

{ "post_indent_string",DT_STR, R_NONE, UL &PostIndentString, UL "" },

2179

2326

/*

2180

2327

** .pp

2181

** Similar to the ``$$attribution'' variable, Mutt will append this

2328

** Similar to the $$attribution variable, Mutt will append this

2182

2329

** string after the inclusion of a message which is being replied to.

2183

2330

*/

2184

2331

{ "post_indent_str", DT_SYN, R_NONE, UL "post_indent_string", 0 },

2187

2334

{ "postpone", DT_QUAD, R_NONE, OPT_POSTPONE, M_ASKYES },

2188

2335

/*

2189

2336

** .pp

2190

** Controls whether or not messages are saved in the ``$$postponed''

2191

** mailbox when you elect not to send immediately. Also see the

2192

** ``$$recall'' variable.

2337

** Controls whether or not messages are saved in the $$postponed

2338

** mailbox when you elect not to send immediately.

2339

** .pp

2340

** Also see the $$recall variable.

2193

2341

*/

2194

2342

{ "postponed", DT_PATH, R_NONE, UL &Postponed, UL "~/postponed" },

2195

2343

/*

2196

2344

** .pp

2197

2345

** Mutt allows you to indefinitely ``$postpone sending a message'' which

2198

2346

** you are editing. When you choose to postpone a message, Mutt saves it

2199

** in the mailbox specified by this variable. Also see the ``$$postpone''

2200

** variable.

2347

** in the mailbox specified by this variable.

2348

** .pp

2349

** Also see the $$postpone variable.

2201

2350

*/

2202

2351

#ifdef USE_SOCKET

2203

2352

{ "preconnect", DT_STR, R_NONE, UL &Preconnect, UL 0},

2204

2353

/*

2205

2354

** .pp

2206

** If set, a shell command to be executed if mutt fails to establish

2355

** If \fIset\fP, a shell command to be executed if mutt fails to establish

2207

2356

** a connection to the server. This is useful for setting up secure

2208

** connections, e.g. with ssh(1). If the command returns a nonzero

2357

** connections, e.g. with \fCssh(1)\fP. If the command returns a nonzero

2209

2358

** status, mutt gives up opening the server. Example:

2210

** .pp

2211

** preconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net

2212

** sleep 20 < /dev/null > /dev/null"

2213

** .pp

2214

** Mailbox 'foo' on mailhost.net can now be reached

2215

** as '{localhost:1234}foo'.

2216

** .pp

2217

** NOTE: For this example to work, you must be able to log in to the

2359

** .ts

2360

** set preconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net \(rs

2361

** sleep 20 < /dev/null > /dev/null"

2362

** .te

2363

** .pp

2364

** Mailbox ``foo'' on ``mailhost.net'' can now be reached

2365

** as ``{localhost:1234}foo''.

2366

** .pp

2367

** Note: For this example to work, you must be able to log in to the

2218

2368

** remote machine without having to enter a password.

2219

2369

*/

2220

2370

#endif /* USE_SOCKET */

2222

2372

/*

2223

2373

** .pp

2224

2374

** Controls whether or not Mutt really prints messages.

2225

** This is set to \fIask-no\fP by default, because some people

2226

** accidentally hit ``p'' often (like me).

2375

** This is set to ``ask-no'' by default, because some people

2376

** accidentally hit ``p'' often.

2227

2377

*/

2228

2378

{ "print_command", DT_PATH, R_NONE, UL &PrintCmd, UL "lpr" },

2229

2379

/*

2236

2386

{ "print_decode", DT_BOOL, R_NONE, OPTPRINTDECODE, 1 },

2237

2387

/*

2238

2388

** .pp

2239

** Used in connection with the print-message command. If this

2240

** option is set, the message is decoded before it is passed to the

2389

** Used in connection with the \fC<print-message>\fP command. If this

2390

** option is \fIset\fP, the message is decoded before it is passed to the

2241

2391

** external command specified by $$print_command. If this option

2242

** is unset, no processing will be applied to the message when

2392

** is \fIunset\fP, no processing will be applied to the message when

2243

2393

** printing it. The latter setting may be useful if you are using

2244

2394

** some advanced printer filter which is able to properly format

2245

2395

** e-mail messages for printing.

2247

2397

{ "print_split", DT_BOOL, R_NONE, OPTPRINTSPLIT, 0 },

2248

2398

/*

2249

2399

** .pp

2250

** Used in connection with the print-message command. If this option

2251

** is set, the command specified by $$print_command is executed once for

2252

** each message which is to be printed. If this option is unset,

2400

** Used in connection with the \fC<print-message>\fP command. If this option

2401

** is \fIset\fP, the command specified by $$print_command is executed once for

2402

** each message which is to be printed. If this option is \fIunset\fP,

2253

2403

** the command specified by $$print_command is executed only once, and

2254

2404

** all the messages are concatenated, with a form feed as the message

2255

2405

** separator.

2256

2406

** .pp

2257

** Those who use the \fBenscript\fP(1) program's mail-printing mode will

2258

** most likely want to set this option.

2407

** Those who use the \fCenscript\fP(1) program's mail-printing mode will

2408

** most likely want to \fIset\fP this option.

2259

2409

*/

2260

2410

{ "prompt_after", DT_BOOL, R_NONE, OPTPROMPTAFTER, 1 },

2261

2411

/*

2262

2412

** .pp

2263

** If you use an \fIexternal\fP ``$$pager'', setting this variable will

2413

** If you use an \fIexternal\fP $$pager, setting this variable will

2264

2414

** cause Mutt to prompt you for a command when the pager exits rather

2265

** than returning to the index menu. If unset, Mutt will return to the

2415

** than returning to the index menu. If \fIunset\fP, Mutt will return to the

2266

2416

** index menu when the external pager exits.

2267

2417

*/

2268

2418

{ "query_command", DT_PATH, R_NONE, UL &QueryCmd, UL "" },

2269

2419

/*

2270

2420

** .pp

2271

2421

** This specifies the command that mutt will use to make external address

2272

** queries. The string should contain a %s, which will be substituted

2422

** queries. The string should contain a ``%s'', which will be substituted

2273

2423

** with the query string the user types. See ``$query'' for more

2274

2424

** information.

2275

2425

*/

2276

2426

{ "query_format", DT_STR, R_NONE, UL &QueryFormat, UL "%4c %t %-25.25a %-25.25n %?e?(%e)?" },

2277

2427

/*

2278

2428

** .pp

2279

** This variable describes the format of the `query' menu. The

2280

** following printf-style sequences are understood:

2281

** .pp

2429

** This variable describes the format of the ``query'' menu. The

2430

** following \fCprintf(3)\fP-style sequences are understood:

2282

2431

** .dl

2283

2432

** .dt %a .dd destination address

2284

2433

** .dt %c .dd current entry number

2285

2434

** .dt %e .dd extra information *

2286

2435

** .dt %n .dd destination name

2287

2436

** .dt %t .dd ``*'' if current entry is tagged, a space otherwise

2288

** .dt %>X .dd right justify the rest of the string and pad with "X"

2289

** .dt %|X .dd pad to the end of the line with "X"

2290

** .dt %*X .dd soft-fill with character "X" as pad

2437

** .dt %>X .dd right justify the rest of the string and pad with ``X''

2438

** .dt %|X .dd pad to the end of the line with ``X''

2439

** .dt %*X .dd soft-fill with character ``X'' as pad

2291

2440

** .de

2292

2441

** .pp

2293

** For an explanation of `soft-fill', see the ``$$index_format'' documentation.

2442

** For an explanation of ``soft-fill'', see the $$index_format documentation.

2294

2443

** .pp

2295

** * = can be optionally printed if nonzero, see the ``$$status_format'' documentation.

2444

** * = can be optionally printed if nonzero, see the $$status_format documentation.

2296

2445

*/

2297

2446

{ "quit", DT_QUAD, R_NONE, OPT_QUIT, M_YES },

2298

2447

/*

2299

2448

** .pp

2300

2449

** This variable controls whether ``quit'' and ``exit'' actually quit

2301

** from mutt. If it set to yes, they do quit, if it is set to no, they

2302

** have no effect, and if it is set to ask-yes or ask-no, you are

2450

** from mutt. If this option is \fIset\fP, they do quit, if it is \fIunset\fP, they

2451

** have no effect, and if it is set to \fIask-yes\fP or \fIask-no\fP, you are

2303

2452

** prompted for confirmation when you try to quit.

2304

2453

*/

2305

2454

{ "quote_regexp", DT_RX, R_PAGER, UL &QuoteRegexp, UL "^([ \t]*[|>:}#])+" },

2306

2455

/*

2307

2456

** .pp

2308

** A regular expression used in the internal-pager to determine quoted

2309

** sections of text in the body of a message.

2310

** .pp

2311

** \fBNote:\fP In order to use the \fIquoted\fP\fBx\fP patterns in the

2312

** internal pager, you need to set this to a regular expression that

2313

** matches \fIexactly\fP the quote characters at the beginning of quoted

2314

** lines.

2457

** A regular expression used in the internal pager to determine quoted

2458

** sections of text in the body of a message. Quoted text may be filtered

2459

** out using the \fC<toggle-quoted>\fP command, or colored according to the

2460

** ``color quoted'' family of directives.

2461

** .pp

2462

** Higher levels of quoting may be colored differently (``color quoted1'',

2463

** ``color quoted2'', etc.). The quoting level is determined by removing

2464

** the last character from the matched text and recursively reapplying

2465

** the regular expression until it fails to produce a match.

2466

** .pp

2467

** Match detection may be overridden by the $$smileys regular expression.

2315

2468

*/

2316

2469

{ "read_inc", DT_NUM, R_NONE, UL &ReadInc, 10 },

2317

2470

/*

2319

2472

** If set to a value greater than 0, Mutt will display which message it

2320

2473

** is currently on when reading a mailbox or when performing search actions

2321

2474

** such as search and limit. The message is printed after

2322

** \fIread_inc\fP messages have been read or searched (e.g., if set to 25, Mutt will

2475

** this many messages have been read or searched (e.g., if set to 25, Mutt will

2323

2476

** print a message when it is at message 25, and then again when it gets

2324

2477

** to message 50). This variable is meant to indicate progress when

2325

2478

** reading or searching large mailboxes which may take some time.

2326

2479

** When set to 0, only a single message will appear before the reading

2327

2480

** the mailbox.

2328

2481

** .pp

2329

** Also see the ``$$write_inc'' variable and the ``Tuning'' section of the

2330

** manual for performance considerations.

2482

** Also see the $$write_inc, $$net_inc and $$time_inc variables and the

2483

** ``$tuning'' section of the manual for performance considerations.

2331

2484

*/

2332

2485

{ "read_only", DT_BOOL, R_NONE, OPTREADONLY, 0 },

2333

2486

/*

2334

2487

** .pp

2335

** If set, all folders are opened in read-only mode.

2488

** If \fIset\fP, all folders are opened in read-only mode.

2336

2489

*/

2337

2490

{ "realname", DT_STR, R_BOTH, UL &Realname, 0 },

2338

2491

/*

2339

2492

** .pp

2340

** This variable specifies what "real" or "personal" name should be used

2493

** This variable specifies what ``real'' or ``personal'' name should be used

2341

2494

** when sending messages.

2342

2495

** .pp

2343

** By default, this is the GECOS field from /etc/passwd. Note that this

2496

** By default, this is the GECOS field from \fC/etc/passwd\fP. Note that this

2344

2497

** variable will \fInot\fP be used when the user has set a real name

2345

2498

** in the $$from variable.

2346

2499

*/

2348

2501

/*

2349

2502

** .pp

2350

2503

** Controls whether or not Mutt recalls postponed messages

2351

** when composing a new message. Also see ``$$postponed''.

2504

** when composing a new message.

2352

2505

** .pp

2353

** Setting this variable to ``yes'' is not generally useful, and thus not

2506

** \fISetting\fP this variable to is not generally useful, and thus not

2354

2507

** recommended.

2508

** .pp

2509

** Also see $$postponed variable.

2355

2510

*/

2356

2511

{ "record", DT_PATH, R_NONE, UL &Outbox, UL "~/sent" },

2357

2512

/*

2359

2514

** This specifies the file into which your outgoing messages should be

2360

2515

** appended. (This is meant as the primary method for saving a copy of

2361

2516

** your messages, but another way to do this is using the ``$my_hdr''

2362

** command to create a \fIBcc:\fP field with your email address in it.)

2517

** command to create a ``Bcc:'' field with your email address in it.)

2363

2518

** .pp

2364

** The value of \fI$$record\fP is overridden by the ``$$force_name'' and

2365

** ``$$save_name'' variables, and the ``$fcc-hook'' command.

2519

** The value of \fI$$record\fP is overridden by the $$force_name and

2520

** $$save_name variables, and the ``$fcc-hook'' command.

2366

2521

*/

2367

2522

{ "reply_regexp", DT_RX, R_INDEX|R_RESORT, UL &ReplyRegexp, UL "^(re([\\[0-9\\]+])*|aw):[ \t]*" },

2368

2523

/*

2374

2529

{ "reply_self", DT_BOOL, R_NONE, OPTREPLYSELF, 0 },

2375

2530

/*

2376

2531

** .pp

2377

** If unset and you are replying to a message sent by you, Mutt will

2532

** If \fIunset\fP and you are replying to a message sent by you, Mutt will

2378

2533

** assume that you want to reply to the recipients of that message rather

2379

2534

** than to yourself.

2535

** .pp

2536

** Also see the ``$alternates'' command.

2380

2537

*/

2381

2538

{ "reply_to", DT_QUAD, R_NONE, OPT_REPLYTO, M_ASKYES },

2382

2539

/*

2383

2540

** .pp

2384

** If set, when replying to a message, Mutt will use the address listed

2385

** in the Reply-to: header as the recipient of the reply. If unset,

2541

** If \fIset\fP, when replying to a message, Mutt will use the address listed

2542

** in the Reply-to: header as the recipient of the reply. If \fIunset\fP,

2386

2543

** it will use the address in the From: header field instead. This

2387

2544

** option is useful for reading a mailing list that sets the Reply-To:

2388

2545

** header field to the list address and you want to send a private

2391

2548

{ "resolve", DT_BOOL, R_NONE, OPTRESOLVE, 1 },

2392

2549

/*

2393

2550

** .pp

2394

** When set, the cursor will be automatically advanced to the next

2551

** When \fIset\fP, the cursor will be automatically advanced to the next

2395

2552

** (possibly undeleted) message whenever a command that modifies the

2396

2553

** current message is executed.

2397

2554

*/

2398

2555

{ "reverse_alias", DT_BOOL, R_BOTH, OPTREVALIAS, 0 },

2399

2556

/*

2400

2557

** .pp

2401

** This variable controls whether or not Mutt will display the "personal"

2558

** This variable controls whether or not Mutt will display the ``personal''

2402

2559

** name from your aliases in the index menu if it finds an alias that

2403

2560

** matches the message's sender. For example, if you have the following

2404

2561

** alias:

2405

** .pp

2406

2562

** .ts

2407

** alias juser abd30425@somewhere.net (Joe User)

2563

** alias juser abd30425@somewhere.net (Joe User)

2408

2564

** .te

2409

2565

** .pp

2410

2566

** and then you receive mail which contains the following header:

2411

** .pp

2412

2567

** .ts

2413

** From: abd30425@somewhere.net

2568

** From: abd30425@somewhere.net

2414

2569

** .te

2415

2570

** .pp

2416

2571

** It would be displayed in the index menu as ``Joe User'' instead of

2417

2572

** ``abd30425@somewhere.net.'' This is useful when the person's e-mail

2418

** address is not human friendly (like CompuServe addresses).

2573

** address is not human friendly.

2419

2574

*/

2420

2575

{ "reverse_name", DT_BOOL, R_BOTH, OPTREVNAME, 0 },

2421

2576

/*

2422

2577

** .pp

2423

2578

** It may sometimes arrive that you receive mail to a certain machine,

2424

2579

** move the messages to another machine, and reply to some the messages

2425

** from there. If this variable is set, the default \fIFrom:\fP line of

2580

** from there. If this variable is \fIset\fP, the default \fIFrom:\fP line of

2426

2581

** the reply messages is built using the address where you received the

2427

2582

** messages you are replying to \fBif\fP that address matches your

2428

** alternates. If the variable is unset, or the address that would be

2429

** used doesn't match your alternates, the \fIFrom:\fP line will use

2583

** ``$alternates''. If the variable is \fIunset\fP, or the address that would be

2584

** used doesn't match your ``$alternates'', the \fIFrom:\fP line will use

2430

2585

** your address on the current machine.

2586

** .pp

2587

** Also see the ``$alternates'' command.

2431

2588

*/

2432

2589

{ "reverse_realname", DT_BOOL, R_BOTH, OPTREVREAL, 1 },

2433

2590

/*

2434

2591

** .pp

2435

** This variable fine-tunes the behaviour of the $reverse_name feature.

2436

** When it is set, mutt will use the address from incoming messages as-is,

2437

** possibly including eventual real names. When it is unset, mutt will

2438

** override any such real names with the setting of the $realname variable.

2592

** This variable fine-tunes the behaviour of the $$reverse_name feature.

2593

** When it is \fIset\fP, mutt will use the address from incoming messages as-is,

2594

** possibly including eventual real names. When it is \fIunset\fP, mutt will

2595

** override any such real names with the setting of the $$realname variable.

2439

2596

*/

2440

2597

{ "rfc2047_parameters", DT_BOOL, R_NONE, OPTRFC2047PARAMS, 0 },

2441

2598

/*

2442

2599

** .pp

2443

** When this variable is set, Mutt will decode RFC-2047-encoded MIME

2600

** When this variable is \fIset\fP, Mutt will decode RFC2047-encoded MIME

2444

2601

** parameters. You want to set this variable when mutt suggests you

2445

** to save attachments to files named like this:

2602

** to save attachments to files named like:

2603

** .ts

2446

2604

** =?iso-8859-1?Q?file=5F=E4=5F991116=2Ezip?=

2447

** .pp

2448

** When this variable is set interactively, the change doesn't have

2449

** the desired effect before you have changed folders.

2450

** .pp

2451

** Note that this use of RFC 2047's encoding is explicitly,

2605

** .te

2606

** .pp

2607

** When this variable is \fIset\fP interactively, the change won't be

2608

** active until you change folders.

2609

** .pp

2610

** Note that this use of RFC2047's encoding is explicitly

2452

2611

** prohibited by the standard, but nevertheless encountered in the

2453

2612

** wild.

2454

** Also note that setting this parameter will \fInot\fP have the effect

2613

** .pp

2614

** Also note that setting this parameter will \fInot\fP have the effect

2455

2615

** that mutt \fIgenerates\fP this kind of encoding. Instead, mutt will

2456

** unconditionally use the encoding specified in RFC 2231.

2616

** unconditionally use the encoding specified in RFC2231.

2457

2617

*/

2458

2618

{ "save_address", DT_BOOL, R_NONE, OPTSAVEADDRESS, 0 },

2459

2619

/*

2460

2620

** .pp

2461

** If set, mutt will take the sender's full address when choosing a

2462

** default folder for saving a mail. If ``$$save_name'' or ``$$force_name''

2463

** is set too, the selection of the fcc folder will be changed as well.

2621

** If \fIset\fP, mutt will take the sender's full address when choosing a

2622

** default folder for saving a mail. If $$save_name or $$force_name

2623

** is \fIset\fP too, the selection of the Fcc folder will be changed as well.

2464

2624

*/

2465

2625

{ "save_empty", DT_BOOL, R_NONE, OPTSAVEEMPTY, 1 },

2466

2626

/*

2467

2627

** .pp

2468

** When unset, mailboxes which contain no saved messages will be removed

2469

** when closed (the exception is ``$$spoolfile'' which is never removed).

2470

** If set, mailboxes are never removed.

2628

** When \fIunset\fP, mailboxes which contain no saved messages will be removed

2629

** when closed (the exception is $$spoolfile which is never removed).

2630

** If \fIset\fP, mailboxes are never removed.

2471

2631

** .pp

2472

2632

** \fBNote:\fP This only applies to mbox and MMDF folders, Mutt does not

2473

2633

** delete MH and Maildir directories.

2475

2635

{ "save_history", DT_NUM, R_NONE, UL &SaveHist, 0 },

2476

2636

/*

2477

2637

** .pp

2478

** This variable controls the size of the history saved in the

2479

** ``$$history_file'' file.

2638

** This variable controls the size of the history (per category) saved in the

2639

** $$history_file file.

2480

2640

*/

2481

2641

{ "save_name", DT_BOOL, R_NONE, OPTSAVENAME, 0 },

2482

2642

/*

2483

2643

** .pp

2484

2644

** This variable controls how copies of outgoing messages are saved.

2485

** When set, a check is made to see if a mailbox specified by the

2645

** When \fIset\fP, a check is made to see if a mailbox specified by the

2486

2646

** recipient address exists (this is done by searching for a mailbox in

2487

** the ``$$folder'' directory with the \fIusername\fP part of the

2647

** the $$folder directory with the \fIusername\fP part of the

2488

2648

** recipient address). If the mailbox exists, the outgoing message will

2489

2649

** be saved to that mailbox, otherwise the message is saved to the

2490

** ``$$record'' mailbox.

2650

** $$record mailbox.

2491

2651

** .pp

2492

** Also see the ``$$force_name'' variable.

2652

** Also see the $$force_name variable.

2493

2653

*/

2494

2654

{ "score", DT_BOOL, R_NONE, OPTSCORE, 1 },

2495

2655

/*

2496

2656

** .pp

2497

2657

** When this variable is \fIunset\fP, scoring is turned off. This can

2498

2658

** be useful to selectively disable scoring for certain folders when the

2499

** ``$$score_threshold_delete'' variable and friends are used.

2659

** $$score_threshold_delete variable and related are used.

2500

2660

**

2501

2661

*/

2502

2662

{ "score_threshold_delete", DT_NUM, R_NONE, UL &ScoreThresholdDelete, UL -1 },

2508

2668

** of this variable will never mark a message for deletion.

2509

2669

*/

2510

2670

{ "score_threshold_flag", DT_NUM, R_NONE, UL &ScoreThresholdFlag, 9999 },

2511

/*

2671

/*

2512

2672

** .pp

2513

** Messages which have been assigned a score greater than or equal to this

2673

** Messages which have been assigned a score greater than or equal to this

2514

2674

** variable's value are automatically marked "flagged".

2515

2675

*/

2516

2676

{ "score_threshold_read", DT_NUM, R_NONE, UL &ScoreThresholdRead, UL -1 },

2526

2686

** .pp

2527

2687

** A colon-delimited list of character sets for outgoing messages. Mutt will use the

2528

2688

** first character set into which the text can be converted exactly.

2529

** If your ``$$charset'' is not iso-8859-1 and recipients may not

2530

** understand UTF-8, it is advisable to include in the list an

2689

** If your $$charset is not ``iso-8859-1'' and recipients may not

2690

** understand ``UTF-8'', it is advisable to include in the list an

2531

2691

** appropriate widely used standard character set (such as

2532

** iso-8859-2, koi8-r or iso-2022-jp) either instead of or after

2533

** "iso-8859-1".

2692

** ``iso-8859-2'', ``koi8-r'' or ``iso-2022-jp'') either instead of or after

2693

** ``iso-8859-1''.

2534

2694

** .pp

2535

2695

** In case the text cannot be converted into one of these exactly,

2536

** mutt uses ``$$charset'' as a fallback.

2696

** mutt uses $$charset as a fallback.

2537

2697

*/

2538

2698

{ "sendmail", DT_PATH, R_NONE, UL &Sendmail, UL SENDMAIL " -oem -oi" },

2539

2699

/*

2545

2705

{ "sendmail_wait", DT_NUM, R_NONE, UL &SendmailWait, 0 },

2546

2706

/*

2547

2707

** .pp

2548

** Specifies the number of seconds to wait for the ``$$sendmail'' process

2708

** Specifies the number of seconds to wait for the $$sendmail process

2549

2709

** to finish before giving up and putting delivery in the background.

2550

2710

** .pp

2551

2711

** Mutt interprets the value of this variable as follows:

2563

2723

/*

2564

2724

** .pp

2565

2725

** Command to use when spawning a subshell. By default, the user's login

2566

** shell from /etc/passwd is used.

2726

** shell from \fC/etc/passwd\fP is used.

2567

2727

*/

2568

2728

{ "sig_dashes", DT_BOOL, R_NONE, OPTSIGDASHES, 1 },

2569

2729

/*

2570

2730

** .pp

2571

** If set, a line containing ``-- '' will be inserted before your

2572

** ``$$signature''. It is \fBstrongly\fP recommended that you not unset

2573

** this variable unless your ``signature'' contains just your name. The

2731

** If \fIset\fP, a line containing ``-- '' (note the trailing space) will be inserted before your

2732

** $$signature. It is \fBstrongly\fP recommended that you not \fIunset\fP

2733

** this variable unless your signature contains just your name. The

2574

2734

** reason for this is because many software packages use ``-- \n'' to

2575

2735

** detect your signature. For example, Mutt has the ability to highlight

2576

2736

** the signature in a different color in the builtin pager.

2578

2738

{ "sig_on_top", DT_BOOL, R_NONE, OPTSIGONTOP, 0},

2579

2739

/*

2580

2740

** .pp

2581

** If set, the signature will be included before any quoted or forwarded

2741

** If \fIset\fP, the signature will be included before any quoted or forwarded

2582

2742

** text. It is \fBstrongly\fP recommended that you do not set this variable

2583

2743

** unless you really know what you are doing, and are prepared to take

2584

2744

** some heat from netiquette guardians.

2589

2749

** Specifies the filename of your signature, which is appended to all

2590

2750

** outgoing messages. If the filename ends with a pipe (``|''), it is

2591

2751

** assumed that filename is a shell command and input should be read from

2592

** its stdout.

2752

** its standard output.

2593

2753

*/

2594

2754

{ "simple_search", DT_STR, R_NONE, UL &SimpleSearch, UL "~f %s | ~s %s" },

2595

2755

/*

2596

2756

** .pp

2597

2757

** Specifies how Mutt should expand a simple search into a real search

2598

** pattern. A simple search is one that does not contain any of the ~

2758

** pattern. A simple search is one that does not contain any of the ``~'' pattern

2599

2759

** operators. See ``$patterns'' for more information on search patterns.

2600

2760

** .pp

2601

** For example, if you simply type joe at a search or limit prompt, Mutt

2602

** will automatically expand it to the value specified by this variable.

2603

** For the default value it would be:

2604

** .pp

2605

** ~f joe | ~s joe

2761

** For example, if you simply type ``joe'' at a search or limit prompt, Mutt

2762

** will automatically expand it to the value specified by this variable by

2763

** replacing ``%s'' with the supplied string.

2764

** For the default value, ``joe'' would be expanded to: ``~f joe | ~s joe''.

2606

2765

*/

2607

2766

{ "smart_wrap", DT_BOOL, R_PAGER, OPTWRAP, 1 },

2608

2767

/*

2609

2768

** .pp

2610

2769

** Controls the display of lines longer than the screen width in the

2611

** internal pager. If set, long lines are wrapped at a word boundary. If

2612

** unset, lines are simply wrapped at the screen edge. Also see the

2613

** ``$$markers'' variable.

2770

** internal pager. If \fIset\fP, long lines are wrapped at a word boundary. If

2771

** \fIunset\fP, lines are simply wrapped at the screen edge. Also see the

2772

** $$markers variable.

2614

2773

*/

2615

2774

{ "smileys", DT_RX, R_PAGER, UL &Smileys, UL "(>From )|(:[-^]?[][)(><}{|/DP])" },

2616

2775

/*

2617

2776

** .pp

2618

2777

** The \fIpager\fP uses this variable to catch some common false

2619

** positives of ``$$quote_regexp'', most notably smileys in the beginning

2620

** of a line

2778

** positives of $$quote_regexp, most notably smileys and not consider

2779

** a line quoted text if it also matches $$smileys. This mostly

2780

** happens at the beginning of a line.

2621

2781

*/

2622

2782

{ "sleep_time", DT_NUM, R_NONE, UL &SleepTime, 1 },

2623

2783

/*

2624

2784

** .pp

2625

2785

** Specifies time, in seconds, to pause while displaying certain informational

2626

2786

** messages, while moving from folder to folder and after expunging

2627

** messages from the current folder. The default is to pause one second, so

2787

** messages from the current folder. The default is to pause one second, so

2628

2788

** a value of zero for this option suppresses the pause.

2629

2789

*/

2630

2790

#ifdef USE_SMTP

2631

2791

# ifdef USE_SASL

2632

2792

{ "smtp_authenticators", DT_STR, R_NONE, UL &SmtpAuthenticators, UL 0 },

2633

2793

/*

2634

** .pp

2635

** This is a colon-delimited list of authentication methods mutt may

2636

** attempt to use to log in to an SMTP server, in the order mutt should

2637

** try them. Authentication methods are any SASL mechanism, eg

2638

** ``digest-md5'', ``gssapi'' or ``cram-md5''.

2639

** This parameter is case-insensitive. If this parameter is unset

2640

** (the default) mutt will try all available methods, in order from

2641

** most-secure to least-secure.

2642

** .pp

2643

** Example: set smtp_authenticators="digest-md5:cram-md5"

2644

*/

2794

** .pp

2795

** This is a colon-delimited list of authentication methods mutt may

2796

** attempt to use to log in to an SMTP server, in the order mutt should

2797

** try them. Authentication methods are any SASL mechanism, eg

2798

** ``digest-md5'', ``gssapi'' or ``cram-md5''.

2799

** This option is case-insensitive. If it is ``unset''

2800

** (the default) mutt will try all available methods, in order from

2801

** most-secure to least-secure.

2802

** .pp

2803

** Example:

2804

** .ts

2805

** set smtp_authenticators="digest-md5:cram-md5"

2806

** .te

2807

*/

2645

2808

# endif /* USE_SASL */

2646

2809

{ "smtp_pass", DT_STR, R_NONE, UL &SmtpPass, UL 0 },

2647

2810

/*

2648

2811

** .pp

2649

2812

** Specifies the password for your SMTP account. If \fIunset\fP, Mutt will

2650

2813

** prompt you for your password when you first send mail via SMTP.

2651

** See ``$smtp_url'' to configure mutt to send mail via SMTP.

2814

** See $$smtp_url to configure mutt to send mail via SMTP.

2815

** .pp

2652

2816

** \fBWarning\fP: you should only use this option when you are on a

2653

2817

** fairly secure machine, because the superuser can read your muttrc even

2654

2818

** if you are the only one who can read the file.

2656

2820

{ "smtp_url", DT_STR, R_NONE, UL &SmtpUrl, UL 0 },

2657

2821

/*

2658

2822

** .pp

2659

** Defines the SMTP ``smart'' host where sent messages should relayed for

2823

** Defines the SMTP smarthost where sent messages should relayed for

2660

2824

** delivery. This should take the form of an SMTP URL, eg:

2661

** .pp

2662

** smtp[s]://[user[:pass]@]host[:port]/

2663

** .pp

2664

** Setting this variable overrides the value of the ``$$sendmail''

2825

** .ts

2826

** smtp[s]://[user[:pass]@]host[:port]/

2827

** .te

2828

** .pp

2829

** ... where ``[...]'' denotes an optional part.

2830

** Setting this variable overrides the value of the $$sendmail

2665

2831

** variable.

2666

2832

*/

2667

2833

#endif /* USE_SMTP */

2668

2834

{ "sort", DT_SORT, R_INDEX|R_RESORT, UL &Sort, SORT_DATE },

2669

2835

/*

2670

2836

** .pp

2671

** Specifies how to sort messages in the \fIindex\fP menu. Valid values

2837

** Specifies how to sort messages in the ``index'' menu. Valid values

2672

2838

** are:

2673

** .pp

2674

** .ts

2675

** . date or date-sent

2676

** . date-received

2677

** . from

2678

** . mailbox-order (unsorted)

2679

** . score

2680

** . size

2681

** . spam

2682

** . subject

2683

** . threads

2684

** . to

2685

** .te

2686

** .pp

2687

** You may optionally use the reverse- prefix to specify reverse sorting

2688

** order (example: set sort=reverse-date-sent).

2839

** .il

2840

** .dd date or date-sent

2841

** .dd date-received

2842

** .dd from

2843

** .dd mailbox-order (unsorted)

2844

** .dd score

2845

** .dd size

2846

** .dd spam

2847

** .dd subject

2848

** .dd threads

2849

** .dd to

2850

** .ie

2851

** .pp

2852

** You may optionally use the ``reverse-'' prefix to specify reverse sorting

2853

** order (example: ``\fCset sort=reverse-date-sent\fP'').

2689

2854

*/

2690

2855

{ "sort_alias", DT_SORT|DT_SORT_ALIAS, R_NONE, UL &SortAlias, SORT_ALIAS },

2691

2856

/*

2692

2857

** .pp

2693

** Specifies how the entries in the `alias' menu are sorted. The

2858

** Specifies how the entries in the ``alias'' menu are sorted. The

2694

2859

** following are legal values:

2695

** .pp

2696

** .ts

2697

** . address (sort alphabetically by email address)

2698

** . alias (sort alphabetically by alias name)

2699

** . unsorted (leave in order specified in .muttrc)

2700

** .te

2860

** .il

2861

** .dd address (sort alphabetically by email address)

2862

** .dd alias (sort alphabetically by alias name)

2863

** .dd unsorted (leave in order specified in .muttrc)

2864

** .ie

2701

2865

*/

2702

2866

{ "sort_aux", DT_SORT|DT_SORT_AUX, R_INDEX|R_RESORT_BOTH, UL &SortAux, SORT_DATE },

2703

2867

/*

2704

2868

** .pp

2705

2869

** When sorting by threads, this variable controls how threads are sorted

2706

2870

** in relation to other threads, and how the branches of the thread trees

2707

** are sorted. This can be set to any value that ``$$sort'' can, except

2708

** threads (in that case, mutt will just use date-sent). You can also

2709

** specify the last- prefix in addition to the reverse- prefix, but last-

2710

** must come after reverse-. The last- prefix causes messages to be

2871

** are sorted. This can be set to any value that $$sort can, except

2872

** ``threads'' (in that case, mutt will just use ``date-sent''). You can also

2873

** specify the ``last-'' prefix in addition to the ``reverse-'' prefix, but ``last-''

2874

** must come after ``reverse-''. The ``last-'' prefix causes messages to be

2711

2875

** sorted against its siblings by which has the last descendant, using

2712

** the rest of sort_aux as an ordering. For instance, set sort_aux=last-

2713

** date-received would mean that if a new message is received in a

2876

** the rest of $$sort_aux as an ordering. For instance,

2877

** .ts

2878

** set sort_aux=last-date-received

2879

** .te

2880

** .pp

2881

** would mean that if a new message is received in a

2714

2882

** thread, that thread becomes the last one displayed (or the first, if

2715

** you have set sort=reverse-threads.) Note: For reversed ``$$sort''

2883

** you have ``\fCset sort=reverse-threads\fP''.)

2884

** .pp

2885

** Note: For reversed $$sort

2716

2886

** order $$sort_aux is reversed again (which is not the right thing to do,

2717

2887

** but kept to not break any existing configuration setting).

2718

2888

*/

2721

2891

** .pp

2722

2892

** Specifies how to sort entries in the file browser. By default, the

2723

2893

** entries are sorted alphabetically. Valid values:

2724

** .pp

2725

** .ts

2726

** . alpha (alphabetically)

2727

** . date

2728

** . size

2729

** . unsorted

2730

** .te

2731

** .pp

2732

** You may optionally use the reverse- prefix to specify reverse sorting

2733

** order (example: set sort_browser=reverse-date).

2894

** .il

2895

** .dd alpha (alphabetically)

2896

** .dd date

2897

** .dd size

2898

** .dd unsorted

2899

** .ie

2900

** .pp

2901

** You may optionally use the ``reverse-'' prefix to specify reverse sorting

2902

** order (example: ``\fCset sort_browser=reverse-date\fP'').

2734

2903

*/

2735

2904

{ "sort_re", DT_BOOL, R_INDEX|R_RESORT|R_RESORT_INIT, OPTSORTRE, 1 },

2736

2905

/*

2737

2906

** .pp

2738

2907

** This variable is only useful when sorting by threads with

2739

** ``$$strict_threads'' unset. In that case, it changes the heuristic

2740

** mutt uses to thread messages by subject. With sort_re set, mutt will

2908

** $$strict_threads \fIunset\fP. In that case, it changes the heuristic

2909

** mutt uses to thread messages by subject. With $$sort_re \fIset\fP, mutt will

2741

2910

** only attach a message as the child of another message by subject if

2742

2911

** the subject of the child message starts with a substring matching the

2743

** setting of ``$$reply_regexp''. With sort_re unset, mutt will attach

2912

** setting of $$reply_regexp. With $$sort_re \fIunset\fP, mutt will attach

2744

2913

** the message whether or not this is the case, as long as the

2745

** non-``$$reply_regexp'' parts of both messages are identical.

2914

** non-$$reply_regexp parts of both messages are identical.

2746

2915

*/

2747

2916

{ "spam_separator", DT_STR, R_NONE, UL &SpamSep, UL "," },

2748

2917

/*

2749

2918

** .pp

2750

** ``$spam_separator'' controls what happens when multiple spam headers

2751

** are matched: if unset, each successive header will overwrite any

2752

** previous matches value for the spam label. If set, each successive

2753

** match will append to the previous, using ``$spam_separator'' as a

2919

** This variable controls what happens when multiple spam headers

2920

** are matched: if \fIunset\fP, each successive header will overwrite any

2921

** previous matches value for the spam label. If \fIset\fP, each successive

2922

** match will append to the previous, using this variable's value as a

2754

2923

** separator.

2755

2924

*/

2756

2925

{ "spoolfile", DT_PATH, R_NONE, UL &Spoolfile, 0 },

2759

2928

** If your spool mailbox is in a non-default place where Mutt cannot find

2760

2929

** it, you can specify its location with this variable. Mutt will

2761

2930

** automatically set this variable to the value of the environment

2762

** variable $$$MAIL if it is not set.

2931

** variable \fC$$$MAIL\fP if it is not set.

2763

2932

*/

2764

2933

{ "status_chars", DT_STR, R_BOTH, UL &StChars, UL "-*%A" },

2765

2934

/*

2766

2935

** .pp

2767

** Controls the characters used by the "%r" indicator in

2768

** ``$$status_format''. The first character is used when the mailbox is

2936

** Controls the characters used by the ``%r'' indicator in

2937

** $$status_format. The first character is used when the mailbox is

2769

2938

** unchanged. The second is used when the mailbox has been changed, and

2770

2939

** it needs to be resynchronized. The third is used if the mailbox is in

2771

2940

** read-only mode, or if the mailbox will not be written when exiting

2772

2941

** that mailbox (You can toggle whether to write changes to a mailbox

2773

** with the toggle-write operation, bound by default to "%"). The fourth

2942

** with the \fC<toggle-write>\fP operation, bound by default to ``%''). The fourth

2774

2943

** is used to indicate that the current folder has been opened in attach-

2775

2944

** message mode (Certain operations like composing a new mail, replying,

2776

2945

** forwarding, etc. are not permitted in this mode).

2778

2947

{ "status_format", DT_STR, R_BOTH, UL &Status, UL "-%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)-%>-(%P)---" },

2779

2948

/*

2780

2949

** .pp

2781

** Controls the format of the status line displayed in the \fIindex\fP

2782

** menu. This string is similar to ``$$index_format'', but has its own

2783

** set of printf()-like sequences:

2784

** .pp

2950

** Controls the format of the status line displayed in the ``index''

2951

** menu. This string is similar to $$index_format, but has its own

2952

** set of \fCprintf(3)\fP-like sequences:

2785

2953

** .dl

2786

2954

** .dt %b .dd number of mailboxes with new mail *

2787

2955

** .dt %d .dd number of deleted messages *

2789

2957

** .dt %F .dd number of flagged messages *

2790

2958

** .dt %h .dd local hostname

2791

2959

** .dt %l .dd size (in bytes) of the current mailbox *

2792

** .dt %L .dd size (in bytes) of the messages shown

2960

** .dt %L .dd size (in bytes) of the messages shown

2793

2961

** (i.e., which match the current limit) *

2794

2962

** .dt %m .dd the number of messages in the mailbox *

2795

2963

** .dt %M .dd the number of messages shown (i.e., which match the current limit) *

2805

2973

** .dt %u .dd number of unread messages *

2806

2974

** .dt %v .dd Mutt version string

2807

2975

** .dt %V .dd currently active limit pattern, if any *

2808

** .dt %>X .dd right justify the rest of the string and pad with "X"

2809

** .dt %|X .dd pad to the end of the line with "X"

2810

** .dt %*X .dd soft-fill with character "X" as pad

2976

** .dt %>X .dd right justify the rest of the string and pad with ``X''

2977

** .dt %|X .dd pad to the end of the line with ``X''

2978

** .dt %*X .dd soft-fill with character ``X'' as pad

2811

2979

** .de

2812

2980

** .pp

2813

** For an explanation of `soft-fill', see the ``$$index_format'' documentation.

2981

** For an explanation of ``soft-fill'', see the $$index_format documentation.

2814

2982

** .pp

2815

2983

** * = can be optionally printed if nonzero

2816

2984

** .pp

2820

2988

** particularly meaningful. To optionally print a string based upon one

2821

2989

** of the above sequences, the following construct is used:

2822

2990

** .pp

2823

** %?<sequence_char>?<optional_string>?

2991

** \fC%?<sequence_char>?<optional_string>?\fP

2824

2992

** .pp

2825

2993

** where \fIsequence_char\fP is a character from the table above, and

2826

2994

** \fIoptional_string\fP is the string you would like printed if

2830

2998

** .pp

2831

2999

** Here is an example illustrating how to optionally print the number of

2832

3000

** new messages in a mailbox:

2833

** %?n?%n new messages.?

3001

** .pp

3002

** \fC%?n?%n new messages.?\fP

2834

3003

** .pp

2835

3004

** You can also switch between two strings using the following construct:

2836

3005

** .pp

2837

** %?<sequence_char>?<if_string>&<else_string>?

3006

** \fC%?<sequence_char>?<if_string>&<else_string>?\fP

2838

3007

** .pp

2839

3008

** If the value of \fIsequence_char\fP is non-zero, \fIif_string\fP will

2840

3009

** be expanded, otherwise \fIelse_string\fP will be expanded.

2841

3010

** .pp

2842

** You can force the result of any printf-like sequence to be lowercase

2843

** by prefixing the sequence character with an underscore (_) sign.

3011

** You can force the result of any \fCprintf(3)\fP-like sequence to be lowercase

3012

** by prefixing the sequence character with an underscore (``_'') sign.

2844

3013

** For example, if you want to display the local hostname in lowercase,

2845

** you would use:

2846

** %_h

3014

** you would use: ``\fC%_h\fP''.

2847

3015

** .pp

2848

** If you prefix the sequence character with a colon (:) character, mutt

2849

** will replace any dots in the expansion by underscores. This might be helpful

3016

** If you prefix the sequence character with a colon (``:'') character, mutt

3017

** will replace any dots in the expansion by underscores. This might be helpful

2850

3018

** with IMAP folders that don't like dots in folder names.

2851

3019

*/

2852

3020

{ "status_on_top", DT_BOOL, R_BOTH, OPTSTATUSONTOP, 0 },

2853

3021

/*

2854

3022

** .pp

2855

3023

** Setting this variable causes the ``status bar'' to be displayed on

2856

** the first line of the screen rather than near the bottom.

3024

** the first line of the screen rather than near the bottom. If $$help

3025

** is \fIset\fP, too it'll be placed at the bottom.

2857

3026

*/

2858

3027

{ "strict_threads", DT_BOOL, R_RESORT|R_RESORT_INIT|R_INDEX, OPTSTRICTTHREADS, 0 },

2859

3028

/*

2860

3029

** .pp

2861

** If set, threading will only make use of the ``In-Reply-To'' and

2862

** ``References'' fields when you ``$$sort'' by message threads. By

3030

** If \fIset\fP, threading will only make use of the ``In-Reply-To'' and

3031

** ``References:'' fields when you $$sort by message threads. By

2863

3032

** default, messages with the same subject are grouped together in

2864

3033

** ``pseudo threads.''. This may not always be desirable, such as in a

2865

3034

** personal mailbox where you might have several unrelated messages with

2866

** the subject ``hi'' which will get grouped together. See also

2867

** ``$$sort_re'' for a less drastic way of controlling this

3035

** the subjects like ``hi'' which will get grouped together. See also

3036

** $$sort_re for a less drastic way of controlling this

2868

3037

** behaviour.

2869

3038

*/

2870

3039

{ "suspend", DT_BOOL, R_NONE, OPTSUSPEND, 1 },

2871

3040

/*

2872

3041

** .pp

2873

3042

** When \fIunset\fP, mutt won't stop when the user presses the terminal's

2874

** \fIsusp\fP key, usually ``control-Z''. This is useful if you run mutt

2875

** inside an xterm using a command like xterm -e mutt.

3043

** \fIsusp\fP key, usually ``^Z''. This is useful if you run mutt

3044

** inside an xterm using a command like ``\fCxterm -e mutt\fP''.

2876

3045

*/

2877

3046

{ "text_flowed", DT_BOOL, R_NONE, OPTTEXTFLOWED, 0 },

2878

3047

/*

2879

3048

** .pp

2880

** When set, mutt will generate text/plain; format=flowed attachments.

3049

** When \fIset\fP, mutt will generate ``format=flowed'' bodies with a content type

3050

** of ``\fCtext/plain; format=flowed\fP''.

2881

3051

** This format is easier to handle for some mailing software, and generally

2882

** just looks like ordinary text. To actually make use of this format's

3052

** just looks like ordinary text. To actually make use of this format's

2883

3053

** features, you'll need support in your editor.

2884

3054

** .pp

2885

** Note that $$indent_string is ignored when this option is set.

3055

** Note that $$indent_string is ignored when this option is \fIset\fP.

2886

3056

*/

2887

3057

{ "thread_received", DT_BOOL, R_RESORT|R_RESORT_INIT|R_INDEX, OPTTHREADRECEIVED, 0 },

2888

3058

/*

2889

3059

** .pp

2890

** When set, mutt uses the date received rather than the date sent

3060

** When \fIset\fP, mutt uses the date received rather than the date sent

2891

3061

** to thread messages by subject.

2892

3062

*/

2893

3063

{ "thorough_search", DT_BOOL, R_NONE, OPTTHOROUGHSRC, 0 },

2894

3064

/*

2895

3065

** .pp

2896

** Affects the \fI~b\fP and \fI~h\fP search operations described in

2897

** section ``$patterns'' above. If set, the headers and attachments of

2898

** messages to be searched are decoded before searching. If unset,

3066

** Affects the \fC~b\fP and \fC~h\fP search operations described in

3067

** section ``$patterns''. If \fIset\fP, the headers and body/attachments of

3068

** messages to be searched are decoded before searching. If \fIunset\fP,

2899

3069

** messages are searched as they appear in the folder.

3070

** .pp

3071

** Users searching attachments or for non-ASCII characters should \fIset\fP

3072

** this value because decoding also includes MIME parsing/decoding and possible

3073

** character set conversions. Otherwise mutt will attempt to match against the

3074

** raw message received (for example quoted-printable encoded or with encoded

3075

** headers) which may lead to incorrect search results.

2900

3076

*/

2901

3077

{ "tilde", DT_BOOL, R_PAGER, OPTTILDE, 0 },

2902

3078

/*

2903

3079

** .pp

2904

** When set, the internal-pager will pad blank lines to the bottom of the

2905

** screen with a tilde (~).

3080

** When \fIset\fP, the internal-pager will pad blank lines to the bottom of the

3081

** screen with a tilde (``~'').

2906

3082

*/

2907

3083

{ "time_inc", DT_NUM, R_NONE, UL &TimeInc, 0 },

2908

3084

/*

2909

3085

** .pp

2910

** Along with ``$read_inc'', ``$write_inc'', and ``$net_inc'', this

3086

** Along with $$read_inc, $$write_inc, and $$net_inc, this

2911

3087

** variable controls the frequency with which progress updates are

2912

** displayed. It suppresses updates less than ``$time_inc'' milliseconds

3088

** displayed. It suppresses updates less than $$time_inc milliseconds

2913

3089

** apart. This can improve throughput on systems with slow terminals,

2914

3090

** or when running mutt on a remote system.

3091

** .pp

3092

** Also see the ``$tuning'' section of the manual for performance considerations.

2915

3093

*/

2916

3094

{ "timeout", DT_NUM, R_NONE, UL &Timeout, 600 },

2917

3095

/*

2933

3111

** .pp

2934

3112

** This variable allows you to specify where Mutt will place its

2935

3113

** temporary files needed for displaying and composing messages. If

2936

** this variable is not set, the environment variable TMPDIR is

2937

** used. If TMPDIR is not set then "/tmp" is used.

3114

** this variable is not set, the environment variable \fC$$$TMPDIR\fP is

3115

** used. If \fC$$$TMPDIR\fP is not set then ``\fC/tmp\fP'' is used.

2938

3116

*/

2939

3117

{ "to_chars", DT_STR, R_BOTH, UL &Tochars, UL " +TCFL" },

2940

3118

/*

2941

3119

** .pp

2942

3120

** Controls the character used to indicate mail addressed to you. The

2943

** first character is the one used when the mail is NOT addressed to your

2944

** address (default: space). The second is used when you are the only

2945

** recipient of the message (default: +). The third is when your address

2946

** appears in the TO header field, but you are not the only recipient of

2947

** the message (default: T). The fourth character is used when your

2948

** address is specified in the CC header field, but you are not the only

3121

** first character is the one used when the mail is \fInot\fP addressed to your

3122

** address. The second is used when you are the only

3123

** recipient of the message. The third is when your address

3124

** appears in the ``To:'' header field, but you are not the only recipient of

3125

** the message. The fourth character is used when your

3126

** address is specified in the ``Cc:'' header field, but you are not the only

2949

3127

** recipient. The fifth character is used to indicate mail that was sent

2950

3128

** by \fIyou\fP. The sixth character is used to indicate when a mail

2951

** was sent to a mailing-list you subscribe to (default: L).

3129

** was sent to a mailing-list you subscribe to.

2952

3130

*/

2953

3131

#ifdef USE_SOCKET

2954

3132

{ "tunnel", DT_STR, R_NONE, UL &Tunnel, UL 0 },

2956

3134

** .pp

2957

3135

** Setting this variable will cause mutt to open a pipe to a command

2958

3136

** instead of a raw socket. You may be able to use this to set up

2959

** preauthenticated connections to your IMAP/POP3 server. Example:

2960

** .pp

2961

** tunnel="ssh -q mailhost.net /usr/local/libexec/imapd"

2962

** .pp

2963

** NOTE: For this example to work you must be able to log in to the remote

3137

** preauthenticated connections to your IMAP/POP3/SMTP server. Example:

3138

** .ts

3139

** set tunnel="ssh -q mailhost.net /usr/local/libexec/imapd"

3140

** .te

3141

** .pp

3142

** Note: For this example to work you must be able to log in to the remote

2964

3143

** machine without having to enter a password.

2965

3144

*/

2966

3145

#endif

2968

3147

/*

2969

3148

** .pp

2970

3149

** \fBWarning:\fP do not set this variable unless you are using a version

2971

** of sendmail which supports the -B8BITMIME flag (such as sendmail

3150

** of sendmail which supports the \fC-B8BITMIME\fP flag (such as sendmail

2972

3151

** 8.8.x) or you may not be able to send mail.

2973

3152

** .pp

2974

** When \fIset\fP, Mutt will invoke ``$$sendmail'' with the -B8BITMIME

3153

** When \fIset\fP, Mutt will invoke $$sendmail with the \fC-B8BITMIME\fP

2975

3154

** flag when sending 8-bit messages to enable ESMTP negotiation.

2976

3155

*/

2977

3156

{ "use_domain", DT_BOOL, R_NONE, OPTUSEDOMAIN, 1 },

2978

3157

/*

2979

3158

** .pp

2980

** When set, Mutt will qualify all local addresses (ones without the

2981

** @host portion) with the value of ``$$hostname''. If \fIunset\fP, no

3159

** When \fIset\fP, Mutt will qualify all local addresses (ones without the

3160

** ``@host'' portion) with the value of $$hostname. If \fIunset\fP, no

2982

3161

** addresses will be qualified.

2983

3162

*/

2984

3163

{ "use_envelope_from", DT_BOOL, R_NONE, OPTENVFROM, 0 },

2985

3164

/*

2986

3165

** .pp

2987

3166

** When \fIset\fP, mutt will set the \fIenvelope\fP sender of the message.

2988

** If ``$$envelope_from_address'' is set, it will be used as the sender

2989

** address. If not, mutt will attempt to derive the sender from the

2990

** "From:" header.

3167

** If $$envelope_from_address is \fIset\fP, it will be used as the sender

3168

** address. If \fIunset\fP, mutt will attempt to derive the sender from the

3169

** ``From:'' header.

2991

3170

** .pp

2992

3171

** Note that this information is passed to sendmail command using the

2993

** "-f" command line switch. Therefore setting this option is not useful

2994

** if the ``$$sendmail'' variable already contains "-f" or if the

2995

** executable pointed to by $$sendmail doesn't support the "-f" switch.

3172

** \fC-f\fP command line switch. Therefore setting this option is not useful

3173

** if the $$sendmail variable already contains \fC-f\fP or if the

3174

** executable pointed to by $$sendmail doesn't support the \fC-f\fP switch.

2996

3175

*/

2997

3176

{ "envelope_from", DT_SYN, R_NONE, UL "use_envelope_from", 0 },

2998

3177

/*

3000

3179

{ "use_from", DT_BOOL, R_NONE, OPTUSEFROM, 1 },

3001

3180

/*

3002

3181

** .pp

3003

** When \fIset\fP, Mutt will generate the `From:' header field when

3004

** sending messages. If \fIunset\fP, no `From:' header field will be

3182

** When \fIset\fP, Mutt will generate the ``From:'' header field when

3183

** sending messages. If \fIunset\fP, no ``From:'' header field will be

3005

3184

** generated unless the user explicitly sets one using the ``$my_hdr''

3006

3185

** command.

3007

3186

*/

3019

3198

/*

3020

3199

** .pp

3021

3200

** When \fIset\fP, Mutt will look for IPv6 addresses of hosts it tries to

3022

** contact. If this option is unset, Mutt will restrict itself to IPv4 addresses.

3201

** contact. If this option is \fIunset\fP, Mutt will restrict itself to IPv4 addresses.

3023

3202

** Normally, the default should work.

3024

3203

*/

3025

3204

#endif /* HAVE_GETADDRINFO */

3026

3205

{ "user_agent", DT_BOOL, R_NONE, OPTXMAILER, 1},

3027

3206

/*

3028

3207

** .pp

3029

** When \fIset\fP, mutt will add a "User-Agent" header to outgoing

3208

** When \fIset\fP, mutt will add a ``User-Agent:'' header to outgoing

3030

3209

** messages, indicating which version of mutt was used for composing

3031

3210

** them.

3032

3211

*/

3033

3212

{ "visual", DT_PATH, R_NONE, UL &Visual, 0 },

3034

3213

/*

3035

3214

** .pp

3036

** Specifies the visual editor to invoke when the \fI~v\fP command is

3215

** Specifies the visual editor to invoke when the ``\fC~v\fP'' command is

3037

3216

** given in the builtin editor.

3038

3217

*/

3039

3218

{ "wait_key", DT_BOOL, R_NONE, OPTWAITKEY, 1 },

3040

3219

/*

3041

3220

** .pp

3042

** Controls whether Mutt will ask you to press a key after \fIshell-

3043

** escape\fP, \fIpipe-message\fP, \fIpipe-entry\fP, \fIprint-message\fP,

3044

** and \fIprint-entry\fP commands.

3221

** Controls whether Mutt will ask you to press a key after an external command

3222

** has been invoked by these functions: \fC<shell-escape>\fP,

3223

** \fC<pipe-message>\fP, \fC<pipe-entry>\fP, \fC<print-message>\fP,

3224

** and \fC<print-entry>\fP commands.

3045

3225

** .pp

3046

3226

** It is also used when viewing attachments with ``$auto_view'', provided

3047

3227

** that the corresponding mailcap entry has a \fIneedsterminal\fP flag,

3048

3228

** and the external program is interactive.

3049

3229

** .pp

3050

** When set, Mutt will always ask for a key. When unset, Mutt will wait

3230

** When \fIset\fP, Mutt will always ask for a key. When \fIunset\fP, Mutt will wait

3051

3231

** for a key only if the external command returned a non-zero status.

3052

3232

*/

3053

3233

{ "weed", DT_BOOL, R_NONE, OPTWEED, 1 },

3054

3234

/*

3055

3235

** .pp

3056

** When set, mutt will weed headers when displaying, forwarding,

3236

** When \fIset\fP, mutt will weed headers when displaying, forwarding,

3057

3237

** printing, or replying to messages.

3058

3238

*/

3059

3239

{ "wrap", DT_NUM, R_PAGER, UL &Wrap, 0 },

3066

3246

{ "wrap_search", DT_BOOL, R_NONE, OPTWRAPSEARCH, 1 },

3067

3247

/*

3068

3248

** .pp

3069

** Controls whether searches wrap around the end of the mailbox.

3249

** Controls whether searches wrap around the end.

3070

3250

** .pp

3071

** When set, searches will wrap around the first (or last) message. When

3072

** unset, searches will not wrap.

3251

** When \fIset\fP, searches will wrap around the first (or last) item. When

3252

** \fIunset\fP, incremental searches will not wrap.

3073

3253

*/

3074

3254

{ "wrapmargin", DT_NUM, R_PAGER, UL &Wrap, 0 },

3075

3255

/*

3076

3256

** .pp

3077

** (DEPRECATED) Equivalent to setting $wrap with a negative value.

3257

** (DEPRECATED) Equivalent to setting $$wrap with a negative value.

3078

3258

*/

3079

3259

{ "write_inc", DT_NUM, R_NONE, UL &WriteInc, 10 },

3080

3260

/*

3081

3261

** .pp

3082

3262

** When writing a mailbox, a message will be printed every

3083

** \fIwrite_inc\fP messages to indicate progress. If set to 0, only a

3263

** $$write_inc messages to indicate progress. If set to 0, only a

3084

3264

** single message will be displayed before writing a mailbox.

3085

3265

** .pp

3086

** Also see the ``$$read_inc'' variable.

3266

** Also see the $$read_inc, $$net_inc and $$time_inc variables and the

3267

** ``$tuning'' section of the manual for performance considerations.

3087

3268

*/

3088

3269

{ "write_bcc", DT_BOOL, R_NONE, OPTWRITEBCC, 1},

3089

3270

/*

3090

3271

** .pp

3091

** Controls whether mutt writes out the Bcc header when preparing

3272

** Controls whether mutt writes out the ``Bcc:'' header when preparing

3092

3273

** messages to be sent. Exim users may wish to unset this. If mutt

3093

** is set to deliver directly via SMTP (see ``$$smtp_url''), this

3094

** option does nothing: mutt will never write out the BCC header

3274

** is set to deliver directly via SMTP (see $$smtp_url), this

3275

** option does nothing: mutt will never write out the ``Bcc:'' header

3095

3276

** in this case.

3096

3277

*/

3097

3278

/*--*/

3194

3375

char *name;

3195

3376

int (*func) (BUFFER *, BUFFER *, unsigned long, BUFFER *);

3196

3377

unsigned long data;

3197

unsigned long data1;

3198

3378

};

3199

3379

3200

3380

struct command_t Commands[] = {