Variable: mh-scan-format-file

mh-scan-format-file is a customizable variable defined in mh-e.el.gz.

Value

t

Documentation

Specifies the format file to pass to the scan program.

The default setting for this option is "Use MH-E scan Format". This means that the format string will be taken from the either mh-scan-format-mh or mh-scan-format-nmh depending on whether MH or nmh (or GNU mailutils MH) is in use. This setting also enables you to turn on the mh-adaptive-cmd-note-flag option.

You can also set this option to "Use Default scan Format" to get the same output as you would get if you ran "scan" from the shell. If you have a format file that you want MH-E to use but not MH, you can set this option to "Specify a scan Format File" and enter the name of your format file.

If you change the format of the scan lines you'll need to tell MH-E how to parse the new format. As you will see, quite a lot of variables are involved to do that. Use "\\[apropos] RET mh-scan.*regexp" to obtain a list of these variables. You will also have to call mh-set-cmd-note if your notations are not in column 4 (columns in Emacs start with 0).

This variable was added, or its default value changed, in MH-E version
6.0.

Source Code

;; Defined in /usr/src/emacs/lisp/mh-e/mh-e.el.gz
(defcustom mh-scan-format-file t
  "Specifies the format file to pass to the scan program.

The default setting for this option is \"Use MH-E scan Format\". This
means that the format string will be taken from the either
`mh-scan-format-mh' or `mh-scan-format-nmh' depending on whether MH or
nmh (or GNU mailutils MH) is in use. This setting also enables you to
turn on the `mh-adaptive-cmd-note-flag' option.

You can also set this option to \"Use Default scan Format\" to get the
same output as you would get if you ran \"scan\" from the shell. If
you have a format file that you want MH-E to use but not MH, you can
set this option to \"Specify a scan Format File\" and enter the name
of your format file.

If you change the format of the scan lines you'll need to tell MH-E
how to parse the new format. As you will see, quite a lot of variables
are involved to do that. Use \"\\[apropos] RET mh-scan.*regexp\" to
obtain a list of these variables. You will also have to call
`mh-set-cmd-note' if your notations are not in column 4 (columns in
Emacs start with 0)."
  :type '(choice (const :tag "Use MH-E scan Format" t)
                 (const :tag "Use Default scan Format" nil)
                 (file  :tag "Specify a scan Format File"))
  :group 'mh-scan-line-formats
  :set #'mh-scan-format-file-check
  :package-version '(MH-E . "6.0"))