#@(#)$Id: elmrc-info,v 1.47 2002/06/05 10:06:28 hurtta Exp $
# Elm Version 2.4ME+
#
#$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.
#
# The "###" lines mean that you do not have a value set and the system
# default will be used.  The value shown was the default at the time
# this file was created.  Yes...the default could have changed between
# then and now.
#

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)

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

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

auto-attachment
# Possible values are: none, application, non-text
# This affect how mime-parts, which have not 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 
#            of metamail, 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
#            of metamail, missing Content-Disposition
#            is treated as "Content-Disposition: attachment". 
#
# See also: charset-convert-ok, page-known-charsets, pagealternative,
#           pagemultipart

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

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

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

fullname
# The full user name for outbound mail

maildir
# where to save my mail to, default directory is "Mail"

mailpermissions
# permissions to be given to newly-created saved mail files, default rw-------
  
tmpdir
# where to place temporary files, default directory is "/tmp"

receivedmail
# where to save received messages to, default file is "=received"

editor
# what editor to use ("none" means simulate Berkeley Mail)
# See also: alteditor

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

extra-mailbox-dir
# Folders on that directory is considered to be 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).

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

sentmail
# where to save copies of outgoing mail to, default file is "=sent"

calendar
# where to save calendar entries

sortby
# how to sort folders, "Reverse Sent" by default

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)

aliassortby
# how to sort the alias list, "Name" by default

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

attribution
# attribution string for replies ('%s' is the author of original message)

prefix
# prefix sequence for indenting included message text in outgoing messages...

weedout
# what headers I DON'T want to see, ever.

bounceback
# threshold for bouncing copies of remote uucp messages...
# zero = disable function.

timeout
# Set the main prompt timeout for resynching...

autocopy
# automatically copy message being replied to into buffer?

copy
# save a copy of all outbound messages?

resolve
# emulate the mailx message increment mode (only increment after
# something has been 'done' to a message, either saved or deleted,
# as opposed to simply each time something is touched)?

weed
# enable the weedout list to be read?

mailer
# This tells type of mailer, value can be one of
#             unknown, sendmail, submitmail, execmail
# After thse parameters 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
# See also: add-sender

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

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

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)


titles
# display message title when displaying pages of message?

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?

movepage
# when using the page commands (+ - <NEXT> <PREV>) change the current
# message pointer...?

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

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

signature
# ".signature" file to append to outbound messages...

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

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

sigdashes
# do we want dashes above signatures? (News 2.11 compatibility and convention)

alwayskeep
# should the default be to keep unread messages in the incoming mailbox?

alwaysstore
# should the default be to store read messages to the "received" folder?

alwaysdelete
# should the default be to delete messages we've marked for deletion?

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

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

browser-wildcard-matching
# If '*' or '?' are used on filename prompts, should these interprete
# as wildcards?

builtinlines
# This is used to determine if the builtin pager should be used on some
# messages even if you would usually use an external pager program.
# There are two ways of determining whether the builtin pager should be
# used. If you want any message that is shorter than "n" lines to use the
# internal pager, set the parameter to "n".  If you want the builtin
# pager to be used if the message is "m" lines shorter than the number of
# lines on your screen set the parameter to be "-m".  Setting the
# parameter to zero will result in the message always being sent through
# your external pager.

keepempty
# should we keep folders from which all messages are deleted?

keypad
# are we running on an HP terminal and want HOME, PREV, NEXT, etc...?

softkeys
# are we running on an HP terminal and want softkeys available too?
# (this implies "keypad=ON" too)

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

forms
# do we want to be able to mail out AT&T Mail Forms?

userlevel
# are we good at it?  beginner (0), intermediate (1), expert (2)

names
# just show the names when expanding aliases?

arrow
# should we use the "->" rather than the inverse video bar?

menu
# should we display the three-line 'mini' menu?

menu-display-host
# Should we display host on mailbox menu?
metoo
# would you like a copy of a message you send to an alias you are on?

ask
# should the message disposition questions be displayed(ON) or
# auto-answered(OFF) with the default answers when we resync or
# change folders?

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

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

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 usefull 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

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)

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

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

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). 
#
# 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 several encoding for same character),
# set local-fast-lookup also.
# Normally local-fs-charset have value SYSTEM, but sometime it is usefull
# set to fixed value.
#
# See also: allow-charset-switching, local-fast-lookup, displaycharset, 
#           text-charset, page-known-charsets

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

compatcharsets
# List of (8-bit) Character Sets, which are byte-to-byte supsersets of 
# US-ASCII so we know that we can display messages with charset=US-ASCII 
# without help of metamail. 
#
# 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

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

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.

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.

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

usetite
# would you like to use termcap/terminfo ti/te entries?

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

readmsginc
# Value by which message count is incremented while reading a new mailbox.
# Setting this value to a number larger than one will speed up the time it
# takes to read a large mailbox when using a slow terminal.
# Actual increments depends both of readdatapercentinc and readmsginc
# See also: readdatapercentinc

sleepmsg
# time in seconds which Elm will wait after displaying a transient message
# and before erasing it.  Can be 0 or positive integer.

textencoding
# Type of encoding to be put into the MIME Content-Transfer-Encoding header.
# Usual values are 7bit or 8bit.
#
# -- NOT Used in this version of elm (2.4 PL24 ME7) or ELM 2.4ME+ PLxx (25)
# Now elm analyzes mail when sending and does that encoding of quoted-printable
# when necessary.

show-header-errors
# if this variable is ON, show certain header errors

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

showto
# if this variable is ON, Elm will show who the message is to rather than
# who it is from in the headers display.

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

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
#        [[                     (incidate line starting with [ )
# Unknown keywords gives error

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.

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

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

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)

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-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

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: To locked folder is not possible to deliver mail. 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.

incoming-mailbox
# Name of incoming-mailbox, usefull 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 that all messages are 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-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.

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

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

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, map-text-dir

unidata
# Binary unidata file, filename can be
#                filename                File is readed 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

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