mblaze/man/mblaze-profile.5
Larry Hynes 72ab002374 Changes to mblaze-profile.5
- SYNOPSIS: Delete 'and customization', change 'for' to 'of'
- Tidy up first few lines of DESCRIPTION
- Change wording for 'Outbox:'
- Change wording for 'Sendmail: and 'Sendmail-Args:'
- Add 'files' to 'configuration' in ENVIRONMENT

Closes: #45 [via git-merge-pr]
2017-06-30 19:45:25 +02:00

92 lines
1.8 KiB
Groff

.Dd February 20, 2017
.Dt MBLAZE-PROFILE 5
.Os
.Sh NAME
.Nm mblaze-profile
.Nd configuration of the mblaze message system
.Sh DESCRIPTION
The
.Xr mblaze 7
message system can be configured with a
.Pa profile
file,
which is located in the directory
.Pa ~/.mblaze
(or
.Ev MBLAZE
if set.)
.Pp
.Pa profile
consists of lines, similar to RFC 2822 headers, in the form
.Dl Ar key Ns \&: Ar value
.Pp
The key
.Sq Cm \&#
may be used to precede a comment:
.Dl Li "#:" Ar comment
.Pp
Please note that empty lines will halt parsing.
.Pp
The following
.Ar key Ns s
are used by
.Xr mblaze 7 :
.Bl -tag -width Ds
.It Li "Alternate-Mailboxes:"
A comma-separated list of mail addresses that belong to you, for
.Xr mscan 1
to recognize messages sent by or directly to you.
.It Li "FQDN:"
The fully qualified domain name used for
.Li "Message-Id:"
generation in
.Xr mgenmid 1 .
.It Li "Local-Mailbox:"
Your primary mail address, used as the default value for
.Li "From:"
in
.Xr mcom 1 ,
and in
.Xr mscan 1
to recognize messages sent to you.
.It Li "Outbox:"
If set,
.Xr mcom 1
will create draft messages in this Maildir,
and save messages there after sending.
.It Li "Scan-Format:"
The default format string for
.Xr mscan 1 .
.It Li "Sendmail:"
The program that
.Xr mcom 1
will call to send mail.
(Default:
.Sq Li sendmail ) .
.It Li "Sendmail-Args:"
Flags to be passed to the
.Li "Sendmail:"
program.
(Default:
.Sq Fl t ) .
.El
.Sh ENVIRONMENT
.Bl -tag -width Ds
.It Ev MBLAZE
Directory containing mblaze configuration files.
(Default:
.Pa $HOME/.mblaze )
.El
.Sh AUTHORS
.An Leah Neukirchen Aq Mt leah@vuxu.org
.Sh LICENSE
.Nm mblaze
is in the public domain.
.Pp
To the extent possible under law,
the creator of this work
has waived all copyright and related or
neighboring rights to this work.
.Pp
.Lk http://creativecommons.org/publicdomain/zero/1.0/