#@(#)$Id: elmrc-info,v 2.9 2011-11-22 16:55:18 hurtta Exp $
# Elm Version ME+ 2.5
#
#$HDR - magic line to mark comments to put at top of user's elmrc file.
#
# For yes/no settings, ON means yes, OFF means no.
#
# Lines beginning with "#" (like this one!) are comments.
#
#
# Some of the option settings are commented out with "###".  This means
# that you do NOT have a value set for the option, and the system default
# will be used.  (The value shown is the default at the time this file
# was created.)  If you wish to enable one of these options, you MUST
# delete the "###" to de-comment the entry.
#
# For the yes/no settings, say ON for yes and OFF for no.

$user
#
# --- Table of Contents ---
#
#       1. General Program Configuration Options
#       2. Main Message Selection Screen Options
#       3. Message Display/Pager Options
#       4. Editor Options
#       5. Message Composition Options
#       6. Signature Options
#       7. Program Termination/Folder Cleanup Options
#       8. Folder Handling Options
#       9. MIME and Character Set Options
#

$usersection
#-----------------------------------------------------------------------
#
# Section 1:  General Program Configuration Options
#

userlevel
# Are we good at it?  0=beginner, 1=intermediate, 2 and above=expert.
# Lower levels give more verbose prompts.  Higher levels make advanced
# options available.

sleepmsg
# After displaying a transient message, Elm will pause this many seconds
# before erasing it.  Can be 0 or a positive integer.

timeout
# After this many seconds of inactivity, Elm will re-check the mailbox
# for new messages.

usetite
# Would you like to use termcap/terminfo ti/te (screen switch) entries?

readmsginc
# When initially reading in a mail folder, the status display is updated
# whenever this many more messages are processed.  A large number helps
# avoid lots of output on slow terminal connecitons.

readdatapercentinc
# Value by which percent count is incremented while reading a new mailbox.
# Actual increments depends both of readdatapercentinc and readmsginc
# See also: readmsginc

print
# Command to print a message ('%s' is the filename)

printhdrs
# List of headers to select and weed when printing messages.
#
# NOTE: This is used with p)rint -command
#       and not with P)rint text command

shell
# The shell to use for shell escapes. If not set value from passwd is used.

readmsg
# path to readmsg program

tmpdir
# Directory to use for temporary files. 
#
# See also: local-sessionlock-dir

calendar
# Pathname to the saved calendar entries file.

alias-group-phrase
# if this variable is ON, it is possible to give phrase
# for group aliases, which is included to address list

aliassortby
# How to sort the alias list, "Name" by default
# Possible values: alias, reverse-alias
#                  name, reverse-name
#                  text, reverse-text

alternatives
# alternative addresses that I could receive mail from (usually a
# forwarding mailbox) and don't want to have listed...
#
# See also: showto

showto
# if this variable is ON, Elm will show who the message is to rather than
# who it is from in the headers display if the message is not
# addressed to user.
#
# See also: alternatives

configoptions
# list of options that can be configured at the "o)ptions" screen

set-window-title
# Enables automatic updating of window's tile and incon name when
# folder is changed. File ~/.elm/terminal.info or global elm.terminalinfo 
# must specify chnaging method used for given terminal.

browser-tabcomplete-prompt
# if this variable is ON, TABulator on folder and file browser completes
# filename on prompt agaist current listing of file or folder browser
#
# If
#   - filename prefix does not match current directory of folder or
#     file broser, or
#   - filename matches without completion to some entry on folder or
#     file broser, or
#   - this variable is OFF
# TABulator changes current directory of folder and file browser.

browser-wildcard-matching
# If '*' or '?' are used on filename prompts, should these interprete
# as wildcards?   Values are:
#   off	                Disables wildcard feature and therefore 
#                       allows selecting filenames that include '?' 
#                       or '*' characters.
#   on	                Enables wildcard feature. Characters '*' 
#                       and '?' are treated as wildcards. Pressing 
#                       ENTER gives directory listing limited with 
#                       that wildcard specification on Elm ME+ style 
#                       file and folder browser.
#   file browser        Enables wildcard feature. Characters '*' 
#                       and '?' are treated as wildcards. Pressing
#                       ENTER invokes Elm 2.5 style file browser
#                       with files (not directories) limited with 
#                       that wildcard specification.
#
#   With values "on" or "file browser" pressing TAB gives directory 
#   listing limited with that wildcard specification on Elm ME+ style 
#   file and folder browser.

convert-comment-to-fullname
# Elm 2.4ME+ PL55 parses addresses like:
#    fullname <address>
#    fullname <address> (comment)
#    address (comment)
# When convert-comment-to-fullname is set, addresses are parsed like
#    address (fullname)
# instead. That convert-comment-to-fullname is set by default for
# compatibilty of older versions of Elm.

verify-domain
# If set mail domains are verified by gethostbyname(). 
# Error HOST_NOT_FOUND is treated as nonexisting domain and error NO_ADDRESS
# is treated as valid mail domain.

verify-local-address
# If set usernames of local addresses are verified. Using this option
# requires that on global elm.rc have "verify=yes" on mailer -option.

$usersection
#-----------------------------------------------------------------------
#
# Section 2:  Main Message Selection Screen Options
#

arrow
# Mark selected message with "->" rather than the inverse video bar?

menu
# Display the three-line "mini-menu" of commands?

menu-display-host
# Should we display host on mailbox menu?

sortby
# how to sort messages of folders, "Reverse Sent" by default
# Possible values: sent, reverse-sent
#                  thread, reverse-thread
#                  received, reverse-thread
#                  sender, reverse-sender
#                  size, reverse-size
#                  subject, reverse-subject
#                  mailbox, reverse-mailbox
#                  status, reverse-status
#
# See also: unstable-reverse-thread, sort-thread-max-time

thread-sortby
# how to sort threads, "Reverse Sent" by default
# Possible values: sent, reverse-sent
#                  subject, reverse-subject
#
# See also: unstable-reverse-thread, sort-thread-max-time

showmlists
# Should mailing list info be displayed for messages at startup?
# The "M" command toggles this on and off.


tochars
# When "showmlists" is off, a single-character mark is displayed
# to indicate who the message is to.  This five-character string
# defines the values to use for the mark.  The five characters are:
#   - Mark for mail to you and nobody else.
#   - Mark for mail to you and other recipients.
#   - Mark for mail to multiple recipients, and you are on the CC list.
#   - Mark for mail not addressed directly to you (e.g. mailing lists)
#   - Mark for mail which have List-Id header (ie. mailing list identification)
# An underscore "_" in this list will display as a blank.
# the default value is  _TC*L

showreply
# Should messages to which you've replied be shown with an "r" mark?

pointnew
# Start up by pointing to the first new message received, if possible?

movepage
# When moving to next or previous page of messages, should the current
# message pointer also move onto that page?

resolve
# Increment the message pointer only after the message has been fully
# disposed (saved or deleted)?  If OFF, then the message pointer is
# incremented after you do anything that touches the message.


$usersection
#-----------------------------------------------------------------------
#
# Section 3:  Message Display/Pager Options
#

pager
# program to use for displaying messages ('builtin' is recommended)

titles
# display message title when displaying pages of message?

builtinlines
# This determines whether the builtin pager should be used instead of
# an external pager (if you defined one above).  If the value is greater
# than zero, then the builtin pager is used for any message shorter than
# that number of lines.  If the value is less than zero, the builtin
# pager is used if the message is that many lines shorter than the size
# of the screen.  If zero, the external pager always is used.

prompt-after-metamail
# prompt after the metamail exits?

prompt-after-pager
# prompt for a command after the external pager exits?

prompt-metamail
# Ask from user, should metamail be called?

weed
# Enable the weedout list to be read?

weedout
# What headers I DON'T want to see, ever.
#
# If first element on list is "*clear-weed-list*" then builtin
# weedout list is not used.

header-phrase-display-mode
# plain:  Show phrases as is (without quotation)
# quoted: Show phrases on quoted form

$usersection
#-----------------------------------------------------------------------
#
# Section 4:  Editor Options
#

editor
# Name of editor to use for composing messages.  "none" or "builtin"
# uses the simple built-in editor.

alteditor
# name of editor to use for replies that have text
# Value EDITOR means that use value of "editor" 
# See also: editor


easyeditor
# Name of editor for ~e command (when editor="builtin")

visualeditor
# Name of editor for ~v command (when editor="builtin")


escape
# The character to use in the builtin editor for entering commands

editflush
# Flush the input buffer after returning from an external editor?

$usersection
#-----------------------------------------------------------------------
#
# Section 5:  Message Composition Options
#

fullname
# The full user name for outbound mail.  NOTE:  Many mail systems add
# From: lines on their own and this setting has no effect!!!  If your
# system is one of those, you might want to try things such as the
# "chfn" command or setting the NAME environment parameter.

askcc
# would you like to be asked for Carbon-Copies information each msg?

metoo
# When you send a message to an alias that contains you, would you
# like to receive a copy of the message?

askreplycopy
# When replying to a message, ask "Copy message?" into editing buffer?
# If OFF, then the "replycopy" action is taken without asking.

replycopy
# Should the default for the "Copy message?" question be "yes"?

long-encoded-headers
# Produce longer than 80 character mime encoded headers (mainly
# Subject), before wrapping them? 

noheader
# when messages are copied into the outbound buffer, don't include headers?
# when replying

noheaderfwd
# when messages are copied into the outbound buffer, don't include headers?
# when forwarding       
# (Notice that messages are not copiend to outbound buffer when
#  mimeworward = ON)

mimeforward
# This option controls how Elm will forward messages when MIME is defined.
#       ON: Causes Elm to send the message as a MIME part of type
#               MESSAGE/RFC822.  Highly recommended when forwarding MIME
#               messages so that the receiver can correctly view the message!
#       OFF: Elm will include the forwarded message in your editor instead
#               of making it an separate mime body part.
#
# See also: askmimeforward

askmimeforward
# This option controls is forwarding as message/rfc822 prompted or not
# if set, option mimeforward controls only default value for prompt
#
# See also: mimeforward

quoteforward
# Forwarded messages are quoted like replies, rather than included
# with "Forwarded message" and "End of forwarded message" banners 
# above and below. This has no effect if "mimeforward" is TRUE.

prefix
# Prefix to mark included message text.  Use "_" for a space.

attribution
# Attribution string for replies.  "%F" is the author of original message.

fwdattribution
# Attribution for forwarded messages.  "%F" is original author.
# Something like: "--- %[begin|end] forwarded message from %F ---"

precedences
# list of delivery precedences allowed, or empty to allow anything
# precedence may be followed by optional ":priority" specification

names
# When showing To: addresses, just display the recipient name?
# If OFF, show entire recipient address.

send-mime-plain-text
# When set, Text/Plain with charset US-ASCII is sent with MIME headers.
# When unset, MIME headers are not included to plain US-ASCII text messages
# when content-transfer-encoding is 7bit (identity). Default: True

add-in-reply-to-phrase
# RFC 2822 (obsoletes RFC 822) allows only message-id to be included
# to in-reply-to.
#   When set, adds also phrase to in-reply-to (violates RFC 2822)

dsn-success
# If TRUE, success Delivery-Status-Notifications are asked by default.


$usersection
#-----------------------------------------------------------------------
#
# Section 6:  Signature Options
#

localsignature
# Local ".signature" file to append to appropriate messages.

remotesignature
# Remote ".signature" file to append to appropriate messages.

sigdashes
# Place dashes line above signatures?  (Usenet compatibility and convention)

$usersection
#-----------------------------------------------------------------------
#
# Section 7:  Program Termination/Folder Cleanup Options
#

askdelete
# Should the "Delete messages?" question be asked when you exit, resync,
# or change folders?  If OFF, then the "alwaysdelete" action is taken
# without asking.

askkeep
# Should the "Keep unread messages in incoming mailbox?" question be
# asked when you exit, resync, or change folders?  If OFF, then the
# "alwayskeep" action is taken without asking.

askstore
# Should the "Move read messages to received folder?" question be asked
# when you exit, resync, or change folders?  If OFF, then the "alwaysstore"
# action is taken without asking.

alwaysdelete
# Should the default for the "Delete messages?" question be "yes"?

alwayskeep
# Should the default for the "Keep unread messages in incoming mailbox?"
# question be "yes"?

alwaysstore
# Should the default for the "Move read messages to received folder?"
# question be "yes"?

keepempty
# Should we keep folders from which all messages are deleted?
# If OFF then the empty folder files are deleted.

$section
#-----------------------------------------------------------------------
#
# Section 8:  Folder Handling Options
#

maildir
# Where to save my mail to.

mailpermissions
# permissions to be given to newly-created saved mail files, default rw-------

copy
# save a copy of all outbound messages?

sentmail
# Name of folder in which copies of outgoing messages are saved.

receivedmail
# Name of folder in which received messages are saved.

savebyalias
# Save messages, incoming and outbound, by alias of sender/recipient?

savename
# Save messages, incoming and outbound, by login name of sender/recipient?

forcename
# Save outbound messages by login name of sender/recipient even if the
# associated folder doesn't already exist?

confirmappend
# Should elm always ask the user to confirm before it appends
# messages to any existing file?
# This is used for both folders in the user's mail directory
# and ordinary files.

confirmcreate
# Should elm always ask the user to confirm before it creates
# any new files?
# This is used for both folders in the user's mail directory
# and ordinary files.

confirmfiles
# Should elm ask for confirmation before it appends a message
# to an existing file that is not a folder in the user's Mail
# directory?
# This is used for ordinary files only and does not affect
# folders in the user's mail directory.

confirmfolders
# Should elm ask for confirmation before it creates a new folder
# in the user's Mail directory?
# This is used only for folders in the user's mail directory and
# does not affect ordinary files.

confirmprint
# Should elm ask for confirmation before it print message ?

confirmtagsave
# Should Elm ask for confirmation before saving tagged messages to a
# folder when the cursor is on an untagged message?


extra-mailbox-dir
# Folders on that directory is considered to be spool mailboxes
# (ie. it is prepared that to they is arrived new mail when
#  they are open). This directory must be different than
# folders or maildir directory (ie. ~/Mail).
#
# See also: incomingfolders

incomingfolders
# List of folders which are incoming folders.  Incoming folders are
# handled like your spool mailbox.
#
# See also: extra-mailbox-dir

dead-letter-dir
# Name of Canceled.mail.dir

unstable-reverse-thread
# If set, reverse thread sorting is based on lastest message on thread.
# Therefore thread moves to new location, when new message arrives to
# thread.
#
# This affects   sortby:        reverse-thread
#         and    thread-sortby: reverse-sent
#
# See also: sortby, thread-sortby

sort-thread-max-time
# What is maximum time in days between mails so that
# they can considered to be same thread (when subject is same)


lock-in-copy
# If set, elm will lock a folder when trying to save or copy to it.
# NOTICE: Does not work with dot-locking

lock-folders
# if set, elm will lock a folder, when it is open. 
#
# NOTICE: It is not possible to deliver mail to a locked folder. So
# take care that incoming mail folders are treated as mailboxes.
# This variable does not effect handling of mailboxes. 
#
# NOTICE: Does not work with dot-locking

env-from-source
# Tells which information to use for envelope from address.
# Possible values include:
#    forward-from            (0)  Use:  "From "        separator line
#                                       ">From "       forwarded indicator
#                                       "Return-Path:" header
#    from                    (1)  Use:  "From "        separator line
#                                       "Return-Path:" header
#    return-path             (2)  Use:  "Return-Path:" header
#
# Setting this to value return-path requires that on every mail have
# Return-Path: -header.

message-hide-hack
# Possible values: none
#                  FOLDER INTERNAL DATA
# If set to FOLDER INTERNAL DATA, hides messages which have
# subject DON'T DELETE THIS MESSAGE -- FOLDER INTERNAL DATA
# and X-IMAP: -header.
#
# Hiding of mail do not affect to '-z' option -- that option
# still sees that mailbox is non-zero size. 

default-folder-status
# In folders, should messages without Status header be marked
#   Old   (0)
#   New   (1)
#   Read  (2)

local-dir-sortby
# How to sort local files and folders on folder and file browser?
# Possible values: none
#                  name, reverse-name
#                  mtive, reverse-mtime
#
# See also: imap-dir-sortby, file-browser-sortby

local-sessionlock-use-home
# This variable controls to where put temporary file when local
# mailbox is opened.
#
# Possible values are:
#    never          Temporray file is put according of
#                   local-sessionlock-dir and tempdir
#    spool          Temporary file for mailbox on spool
#                   is put to home directory
#    always         Temporary file for mailbox is put
#                   to home directory
#    non-spool      Temporary file for mailbox on not in spool
#                   is put to home directory

local-sessionlock-dir
# If opened local mailbox is on spool directory, this setting tells
# to where put temporary file mbox.{mailbox}. ( If opened local
# mailbox is not on spool directory, location of temporary file
# mbox.{mailbox}-{username} is given on tmpdir variable )
#
# See also: tmpdir, local-sessionlock-use-home

file-browser-show-dotfiles
# If this is set, .dotfiles are shown on Elm 2.5 style file browser 
# (.dotdirectories are always shown).

file-browser-show-protection
# If this is set, permission and owner columns are shown on 
# Elm 2.5 style file browser 

file-browser-show-title
# If this is set, title of columns is shown  on  Elm 2.5 style file browser 

file-browser-sortby
# How to sort local files and directories on Elm 2.5 style 
# file browser?
# Possible values: none
#                  name, reverse-name
#                  mtive, reverse-mtime
#
# See also: local-dir-sortby

show-header-errors
# Possible values:   OFF       do not show (certain) header errors
#                    ON        show certain header errors
#                    store     store certain  header errors and show
#                              them when viewing message


$usersection
#-----------------------------------------------------------------------
#
# Section 9:  MIME and Character Set Options
#

displaycharset
# When set other that SYSTEM, specifies Character Set to which
# display should be switch if supported by terminal. Character
# Set of terminal is switched back to System Character Set (given
# on elm.mimecharsets or ~/.elm/mime.charsets file) when running
# external programs. This switching is done even when option
# allow-charset-switching is not set.
#
# Needs information from elm.terminalinfo or ~/.elm/terminal.info file.
#
# NOTICE that this (or Character Sets provided by locale) must have
# mapping tables available if "text-charset" value is not DISPLAY
#
#
# See also: page-known-charsets, allow-charset-switching, local-fs-charset,
#           text-charset

compatcharsets
# List of (8-bit) Character Sets, which are byte-to-byte supersets of 
# US-ASCII.
#
# NOTE: That same information can be given on .elm/mime.charsets file with 
# ';MIME-subset=US-ASCII' qualifier -- that is preferred method.
#
# In fact this option should never be set explicity.
#
# See also: page-known-charsets, iso646-charsets, auto-iso-8859

iso646-charsets
# List of 7-bit Character Sets, which are byte-to-byte supersets of 
# INVARIANT.
#
# NOTE: That same information can be given on .elm/mime.charsets file with 
# ';MIME-subset=INVARIANT' qualifier -- that is preferred method.
#
# In fact this option should never be set explicity.
#
# See also: page-known-charsets, compatcharsets

locale-charsets
# For these charsets is type type unknown used for system (locale)
# charset, even when Elm ME+ is builtin defination for charset.
#
# Available only if system supports wide characters and 
# __STDC_ISO_10646__ is defined.
#
# This option may cause error message
#       Unknown charsets are unsupported as keyboard input!
# to be printed in that case this option can not be used for given charset.

text-charset
# Name of Character Set used with MIME text/plain Content-type
# - Special value DISPLAY means that Character Set used in content-type 
#   is same than used by terminal
# - Special value SYSTEM means that Character Set used in content-type
#   is same than used by system (locale charset)
# - Text of current used display Character Set is converted to 
#   that Character Set
# NOTICE thar both displaycharset and text-charset must have know,
# and both Character Set must have mapping tables available, otherwise 
# conversion fails (and produces no output) !
#
# So this variable should almost always have value DISPLAY
# Other useful values are UTF-7 and perhaps UTF-8 (however
# UTF-7 is better encoding of Unicode for Mail than UTF-8)
#
# See also: displaycharset, local-fs-charset, allow-charset-switching,
#           utf7-encode-optional

page-known-charsets
# Should Elm use "pager" to display charsets (other than display charset)
# if charset is known (ie. it probably can be converted to display charset).
# This should be set, if mapping information is given to elm and metapager
# can not do better.
#
# See also: allow-charset-switching, displaycharset, charset-convert-ok,
#           auto-attachment

charset-convert-ok
# Inhibit "[ Charset xxx converted... ]" message when charset
# is converted (to unicode ie. without loss). Also use "pager" 
# to display charset (instead of metamail).
#
# See also: allow-charset-switching, displaycharset, page-known-charsets,
#           auto-attachment


allow-charset-switching
# When set, switch display charset between charsets supported by terminal
#
# See also: page-known-charsets, displaycharset, charset-convert-ok

auto-iso-8859
# Autocreate undefined ISO-8859-X charsets as superset of US-ASCII.
# RFC 2046 (MIME Part Two: Media Types) requires this.
#
# See also: compatcharsets, auto-attachment


default-mime-text-charset
# Name of (assumed) charset for text/plain MIME messages (if charset is
# not given):
#    DISPLAY            charset is same than used by terminal
#    SYSTEM             charset is same than used by system (locale charset)
#    TEXT               value of text-charset
#    US-ASCII           charset is US-ASCII (required by standards)


default-nomime-charset
# Name of (assumed) charset of non-MIME messages:
#    DISPLAY            charset is same than used by terminal
#    SYSTEM             charset is same than used by system (locale charset)
#    TEXT               value of text-charset
#    US-ASCII           charset is US-ASCII (required by standards)

local-fast-lookup
# If set indicates that directory listing not needed for lookup.
# Need to be unset, if same character on local-fs-charset has several
# repesentations (or encodings). 
#
# This is implicty set always when ASCII filenames are looked.
#
# See also: local-fs-charset, imap-fast-lookup

local-fs-charset
# Character set used on local filenames
# Special values:     SYSTEM       character set used by system (from locale)
#                     DISPLAY      character set used by terminal
#                     TEXT         value of text-charset
#
# If local-fs-charset is well behaved (no multiple encodings for a
# single character), set local-fast-lookup also.
# Normally local-fs-charset have value SYSTEM, but sometime it is useful to
# set to fixed value.
#
# See also: allow-charset-switching, local-fast-lookup, displaycharset, 
#           text-charset, page-known-charsets

utf7-encode-optional
# Should UTF-7 'optional direct characters' utf-7 encoded?
# Optional direct characters are: 
#                 ! " # $ % & * ; < = > @ [ ] ^ _ ' { | }
# See also: text-charset

unidata
# Binary unidata file, filename can be
#                filename                File is read from directory
#                                        given on map-bin-dir directory
#                                        (normally $lib/elm.map.bin)
#                {rc}/filename           File is readed from .elm subdirectory
#                                        of user's home
#                ~/filename              File is readed from  user's home
#                                        directory
# See also: map-bin-dir


bindata
# Binary charset map file. Includes type=ascii and type=one-byte-map maps
#  from map-text-dir (and elsewhere). If that variable is set both
#  on global elm.rc and user's elm.rc then both files may be readed
#  or mmapped.
# Filaname can be
#                filename                File is read from directory
#                                        given on map-bin-dir directory
#                                        (normally $lib/elm.map.bin)
#                {rc}/filename           File is readed from .elm subdirectory
#                                        of user's home
#                ~/filename              File is readed from  user's home
#                                        directory
# See also: map-bin-dir

attachment-dir
# From which or to which directory read/save attachments.
# This is provided as {doc}/ prefix on corresponding filename prompts.

auto-attachment
# Possible values are: none, application, non-text
# This affect how mime-parts with no Content-Disposition header, 
# are treated. 
#          * If auto-attachment is none, missing Content-Disposition is 
#            treated as "Content-Disposition: inline". 
#            That is what MIME requires. 
#          * If auto-attachment is application, type is subtype of
#            application and Elm can not handle type without calling 
#            metamail (or mailcap programs), missing Content-Disposition 
#            is treated as "Content-Disposition: attachment".
#          * If auto-attachment is non-text, type is not subtype
#            of text or multipart, type is not message/rfc822
#            and Elm can not handle type without calling
#            metamail (or mailcap programs), missing Content-Disposition
#            is treated as "Content-Disposition: attachment". 
#
# See also: charset-convert-ok, page-known-charsets, pagealternative,
#           pagemultipart

fragment-handling
# How fragmented (message/partial) should be handled?
#    none               Call metamail (if available) for these
#    manual             Let user give command 'A' to enter message
#                           assembly mode
#    auto               Go automatically message assembly mode

mime-parameters
# Handling of RFC 2231 encoded mime parameters.
# Possible values: plain                just use and generate plain
#                                       non-encoded parameters
#                  encoded              generate RFC 2231 encoded mime
#                                       parameters, if needed
#                  plain-and-encoded    Generate RFC 2231 encoded and
#                                       plain ascii parameter values
#
# This parameter do not effect RFC 2231 language mark on mime encoded
# words!
#
# This is specially used for filename -parameter on content-disposition
  

noencoding
# This control makes it possible to send raw 8bit or binary data when the MTA
# doesn't support 8BITMIME and the -B8BITMIME option or
# BINARYMIME and the -BBINARYMIME option
#
# Possible values:
#    pass-7bit (0)   : Always convert 8BIT and BINARY data to QUOTED-PRINTABLE 
#                      if the MTA doesn't support the -B8BITMIME and 
#                      -BBINARYMIME options.
#    pass-8bit (1)   : Allow 8bit without -B8BITMIME, but binary data is 
#                      encoded
#    pass-binary (2) : Allow binary without -BBINARYMIME and and 8bit without 
#                      -B8BITMIME
#
# It is STRONGLY recommended that it be left set to pass-7bit unless you know 
# what you are doing!!
#
# Elm doesn't yet fully support BINARYMIME: it requires that text lines are
# terminated with \r\n, Unix's \n isn't sufficient!
# That is only partially implemented in this version of Elm.
#
# Quote from RFC 1830 (Experimental Protocol): 
#  SMTP Service Extensions for Transmission of Large and Binary MIME Messages
#
#      It is important to note that when using BINARYMIME, it is
#      especially important to ensure that the MIME message itself is
#      properly formed.  In particular, it is essential that text be
#      canonically encoded with each line properly terminated with <CR>
#      <LF>.  Any transformation of text into non-canonical MIME to
#      observe local storage conventions must be reversed before sending
#      as BINARYMIME.  The usual line-oriented shortcuts will break if
#      used with BINARYMIME.

nohdrencoding
# Don't do MIME part 2 (RFC 1522) encoding for 8-bit headers?
# Because 8-bit data is not allowed in headers, 
# it is STRONGLY recommended that this is left set to OFF

convert-utf-header
# Convert utf-8 mime encoded words to utf-7 when sending?  

pagealternative
# Should Elm use "pager" for display one part of multipart/alternative,
# if there are found one part which can be displayed. If not
# set, Elm uses "pager" for display one part of multipart/alternative,
# if are parts are displayable.

pagemultipart
# Should Elm use "pager" to display MIME multipart messages
# with unknown subparts or with unknown subtype?
#
# See also: auto-attachment

pagesigned
# Should Elm use "pager" to display MIME multipart/signed
# with unknown signing protocol ?

mimebodykeywords
# If TRUE detect following keywords from mail (when sending it):
#        [clear]
#        [encode]
#        [no save]
#        [nosave]
#        [include
#        [attach
#        [[                     (incidate line starting with [ )
# Unknown keywords gives error

require-mime-version-for-hdr-encoding
# If set MIME Part 2 (RFC 1522) decoding is only done when MIME-version
# header is present. Default: False

require-mime-version-for-body-encoding
# If set MIME Part 1 (RFC 1521) decoding is only done when MIME-version
# header is present. Default: True

check-type-pattern
# If set (default), mime types are checked, when paging mail, agaist 
# elm.mimetypes and mime.types. If content do not match to any pattern 
# (magic number) given for type, that causes warning. If on elm.mimetypes or
# mime.types is any entry for type without pattern, warning is NOT
# printed. If warning is printed, confirmation is required. This
# mainly protects routines on mailcap to get bogus types. Notice that this do
# NOT protect metamail (if used).
# See also: attachment-fix-extension

attachment-fix-extension
# If set (default), default file extension is set according of mime 
# type (appending after existing extension of given filename) when
# saving attachment.
#
# If either "attachment-fix-extension" or "check-type-pattern",  
# mime types are checked, when saving mail, agaist elm.mimetypes and 
# mime.types. If content do not match to any pattern (magic number) 
# given for type, that causes warning.
#
# See also: check-type-pattern

$usersection
#-----------------------------------------------------------------------
#
#   Metamail and mailcap options
#

metamail
# This tells path of metamail program
#
# That version (Elm 2.4ME+) does not use Metamail's companion programs 
# (suchs as mmencode) directly, but metamail package supposes that
# companion programs are installed to search path.
#
# Special values:   none                Don't call metamail
#                   metamail            Don't call metamail if environment
#                                               variable $NOMETAMAIL is defined

internal-mailcaps
# List of mailcaps for internal mailcap support  (without metmail).
# List may be space or ':' seperated. Separate values may be quoted. 
# Set value to "none" (without quotes) to disable internal mailcap support.
# See also: metamail-mailcaps, internal-mailcap-trusted-programs,
#           mailcap-blacklist-programs

internal-mailcap-trusted-programs
# List of programs which are executed by default when using internal
# mailcap. Programs given on test= are always executed without
# prompting.
# See also: internal-mailcap-prompt-trusted, internal-mailcaps,
#           mailcap-blacklist-programs

internal-mailcap-prompt-trusted
# If set, Mailcap program selection -screen is shown even when
# all programs asked on screen are executed by default
# See also: internal-mailcap-trusted-programs

metamail-mailcaps
# List of mailcaps for metamail. List may be space or ':' seperated. Separate 
# values may be quoted. When metamail is called values are put to variable 
# $MAILCAPS (as ':' -separated list). metamail-mailcaps may include variables 
# (for example  $MAILCAPS). Value of variables is splitted only from ':' 
# (quotes and spaces are not treated specially.)
# See also: internal-mailcaps, mailcap-blacklist-programs

mailcap-blacklist-programs
# List of programs which are not executed. If mailcaps given on 
# metamail-mailcaps refer these programs and corresponding content-type is
# used on mail, metamail is NOT called. This list also disabled these
# entries  when using internal mailcap. 
# See also: internal-mailcaps, metamail-mailcaps

$usersection
#-----------------------------------------------------------------------
#
#   IMAP and POP options
#

incoming-mailbox
# Name of incoming-mailbox, useful if POP or IMAP is used

pop-max-download-size
# maximum size of message on bytes which is downloaded by POP
# when mailbox is parsed. If POP server does not support TOP
# command, all messages are downloaded.
#
# Value -1 for pop-max-download-size causes all messages to be downloaded.
# ! character as second letter on message status indicates that message
# is not downloaded.
# See also: imap-max-download-size

pop-show-greeting
# Show server greeting?

imap-dir-sortby
# How to sort IMAP folders on folder browser?
# Possible values: none
#                  name, reverse-name
# See also: local-dir-sortby

imap-charset
# Character set used with IMAP
# Special values:     SYSTEM       character set used by system (from locale)
#                     DISPLAY      character set used by terminal
#                     TEXT         value of text-charset
# See also: imap-naming-convention, imap-fast-lookup

imap-connection-cache
# Should IMAP connections to be cached? (to reduce need to re-login to IMAP
# service)

imap-naming-convention
# Should IMAP's Mailbox International Naming Convention to be used?
#
# If path name on folder listing does not match use IMAP's Mailbox 
# International Naming Convention, imap-charset is used instead for
# interprering of name. That requires that imap-fast-lookup is NOT
# set.
# 
# See also: imap-charset, imap-fast-lookup

imap-fast-lookup
# If set indicates that IMAP directory listing not needed for lookup
#
# Need to be unset, if same character on imap-charset is several
# repesentations (or encodings). Also need to be unset, if
# both imap-naming-convention and imap-charset is used.
#
# See also: imap-charset, imap-naming-convention, local-fast-lookup

imap-max-download-size
# maximum size of message on bytes which is downloaded by IMAP
# when mailbox is parsed.
#
# Value -1 for imap-max-download-size causes that all messages are downloaded.
# ! character as second letter on message status indicates that message
# is not downloaded.
# See also: pop-max-download-size

imap-show-greeting
# Show server greeting and other untagged OK messages (without machine
# readable codes) ?

imap-show-warning
# Show untagged NO messages?

imap-show-error
# Show untagged BAD messages?

imap-use-examine
# Should IMAP use EXAMINE when looking mail (ie. when using programs
# like "frm" or "newmail")? If this is set, EXAMINE is used to get
# read-only access (so that \Recent flag if mails is preserved).
# However seems that (some?) IMAP servers does not report new mails
# when mailbox is opened as read-only.

$usersection
#-----------------------------------------------------------------------
#
#   PGP and GPG options
#

showpgppreamble
# if this variable is ON, display text before PGP armor.


usepgppass
# If ON, Elm will prompt you for your PGP passphrase and use it whenever
# necessary to make it more convenient to hand PGP messages.

keeppassfor
# The number of seconds Elm should remember your passphrase.  -1 means never
# expire it.

askpgpsig
# If ON, Elm will prompt you for a username with which to sign the pgp
# message

pgp2
# What is the path for pgp 2?
# Possible values include:
#       none            Don't call pgp
#       /path           Call pgp via that path, if it is executable

pgp5-dir
# What is the directory path for pgp 5 binaries?
# Possible values include:
#       none            Don't call pgp
#       /path           Call pgp binaries from that directiry

gpg
# What is the path for gnupg?
# Possible values include:
#       none            Don't call gpg
#       /path           Call gpg via that path, if it is executable

pgp-encrypt-type
# Specifies content-type for pgp encrypted messages.
# Possible values are: application/pgp, text/plain, text/x-pgp


pgp-interactive
# Run pgp/gpg signing and encryption always on interactive mode

pgp-sign-type
# Specifies content-type for pgp signed messages.
# Possible values are: application/pgp, text/plain, text/x-pgp

pgp-version
# What pgp use on sending of mail: pgp2, pgp5, gpg

$globalsection
#-----------------------------------------------------------------------
#
#   General global options
#

allow-setuid
# If set, running Elm as setuid is not prevented.

hostdomain
# Name of domain we're in

hostfullname
# Name of FQDN we're in

hostname
# Name of machine we're on

map-text-dir
# Default directory for map files (text)        (normally $lib/elm.map.txt)
# See also: map-bin-dir

map-bin-dir
# Default directory for map files (binary)      (normally $lib/elm.map.bin)
# See also: unidata, bindata, map-text-dir

$section
#-----------------------------------------------------------------------
#
#   Mailer options
#

background-wait-time
# If = 0  wait mailer to completion
#    > 0  wait background_wait_time seconds for completion
#         if not completed in this time, let it go to background
#
#         (completion of mailing is still reported if user have
#          not exited in that time when mailer have completed)

mailer
# This tells type of mailer, value can be one of
#             unknown, sendmail, submitmail, execmail
# After that parameter there can be following additional options
#       path=                   gives path of mailer
#       add-from=dont,  add-from=yes,
#       use-domain=no,  use-domain=yes,         
#       supported-bodytype=7bit, supported-bodytype=8bit,
#       supported-bodytype=binary
#       supports-dsn=no, supports-dsn=yes
#       verify=no, verify=yes 
#       allow-set-sender=no, allow-set-sender=yes
#
# With elmrc option 
#          use-mailer-library = smtp 
# type of mailer can also be one of
#       sendmail-bs, submission
# Also with smtp library following additional option is available
#       server=             gives hostname of submission server
#
# See also: add-sender, use-mailer-library

add-sender
# If set (default), Elm adds Sender: -header if user specifies From: -header
#                   or envelope sender address (aka Return-Path).
# If there is more than one address on From: -header, 
#   Sender: -header is always added.
# See also: mailer

$section
#-----------------------------------------------------------------------
#
#   Library options
#

use-library
# Specify tags for shared libraries, which should be loaded.
# These libraries are loaded on startup and relocated to variables
# use-base-library and use-connect-library
#
# See also: use-base-library, use-connect-library, use-mailer-library

use-base-library
# Specify tags for shared libraries, which should be loaded.

use-connect-library
# Specify tags for shared libraries, which should be loaded.

use-mailer-library
# Specify tags for shared libraries, which should be loaded.

