aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLeah Neukirchen <leah@vuxu.org>2017-02-20 15:39:21 +0100
committerLeah Neukirchen <leah@vuxu.org>2017-02-20 15:40:07 +0100
commit1b78a55dfeb00846f1d074c6d8460d2bc33ea694 (patch)
tree340f3567b10fb8cdbe52c67023f69b1f0e586be2
parente61b972f364c42c3f555617b9e59891aa7e3802c (diff)
downloadmblaze-1b78a55dfeb00846f1d074c6d8460d2bc33ea694.tar.gz
add mblaze-profile.5
-rw-r--r--Makefile1
-rw-r--r--man/mblaze-profile.589
-rw-r--r--man/mblaze.74
-rw-r--r--man/mcom.11
-rw-r--r--man/mgenmid.11
-rw-r--r--man/mscan.11
6 files changed, 97 insertions, 0 deletions
diff --git a/Makefile b/Makefile
index df705cc..8953d3d 100644
--- a/Makefile
+++ b/Makefile
@@ -43,6 +43,7 @@ install: FRC all
ln -sf mless $(DESTDIR)$(BINDIR)/mprev
ln -sf mcom $(DESTDIR)$(BINDIR)/mrep
install -m0644 man/*.1 $(DESTDIR)$(MANDIR)/man1
+ install -m0644 man/*.5 $(DESTDIR)$(MANDIR)/man5
install -m0644 man/*.7 $(DESTDIR)$(MANDIR)/man7
FRC:
diff --git a/man/mblaze-profile.5 b/man/mblaze-profile.5
new file mode 100644
index 0000000..d1881b6
--- /dev/null
+++ b/man/mblaze-profile.5
@@ -0,0 +1,89 @@
+.Dd February 20, 2017
+.Dt MBLAZE-PROFILE 5
+.Os
+.Sh NAME
+.Nm mblaze-profile
+.Nd configuration and customization for mblaze message system
+.Sh DESCRIPTION
+The
+.Xr mblaze 7
+message system can be configured with a
+.Pa profile
+configuration file,
+which usually resides in
+.Pa ~/.mblaze
+(or
+.Ev MBLAZE
+if set.)
+.Pp
+This file consists of a RFC 2822 style header message with lines like
+.Dl Li Ar key Li Ns ":" Ar value
+.Pp
+You can use a key
+.Sq Li "#"
+for comments:
+.Dl Li "#:" Ar comment
+.Pp
+Please bear in mind that empty lines will stop parsing.
+.Pp
+The following
+.Ar key
+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 them as sent 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 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 the draft message in this Maildir,
+and not delete it after it has been sent.
+.It Li "Scan-Format:"
+The default format string for
+.Xr mscan 1 .
+.It Li "Sendmail:"
+The binary path used to send mail for
+.Xr mcom 1
+(default:
+.Li Sq sendmail ) .
+.It Li "Sendmail-Args:"
+The flags used to send mail with
+.Li "Sendmail:"
+for
+.Xr mcom 1
+(default
+.Sq Fl t ) .
+.El
+.Sh ENVIRONMENT
+.Bl -tag -width Ds
+.It Ev MBLAZE
+Directory containing mblaze configuration.
+(Default:
+.Pa $HOME/.mblaze )
+.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/
diff --git a/man/mblaze.7 b/man/mblaze.7
index 7a860b1..ee8b3e5 100644
--- a/man/mblaze.7
+++ b/man/mblaze.7
@@ -155,8 +155,12 @@ syntax as explained in
Many utilities have a default behavior when used interactively from a terminal
(e.g. operate on the current message or the current sequence).
For scripting, you must make these arguments explicit.
+.Pp
+For configuration, see
+.Xr mblaze-profile 5 .
.Sh SEE ALSO
.Xr mailx 1 ,
+.Xr mblaze-profile 5 ,
.Xr nmh 7
.Sh AUTHORS
.An Leah Neukirchen Aq Mt leah@vuxu.org
diff --git a/man/mcom.1 b/man/mcom.1
index 17fc240..83f012a 100644
--- a/man/mcom.1
+++ b/man/mcom.1
@@ -68,6 +68,7 @@ Default signature.
.Ex -std
.Sh SEE ALSO
.Xr mmime 1 ,
+.Xr mblaze-profile 5 ,
.Xr mmsg 7
.Sh AUTHORS
.An Leah Neukirchen Aq Mt leah@vuxu.org
diff --git a/man/mgenmid.1 b/man/mgenmid.1
index c0eff76..a7290fa 100644
--- a/man/mgenmid.1
+++ b/man/mgenmid.1
@@ -37,6 +37,7 @@ fails.
.Sh EXIT STATUS
.Ex -std
.Sh SEE ALSO
+.Xr mblaze-profile 5
.Rs
.%A M. Curtin
.%A J. Zawinski
diff --git a/man/mscan.1 b/man/mscan.1
index 47f26b6..5450760 100644
--- a/man/mscan.1
+++ b/man/mscan.1
@@ -168,6 +168,7 @@ You are in
.Sh EXIT STATUS
.Ex -std
.Sh SEE ALSO
+.Xr mblaze-profile 5
.Xr mmsg 7
.Sh AUTHORS
.An Leah Neukirchen Aq Mt leah@vuxu.org