Archives
/
mblaze
mirror of https://github.com/leahneukirchen/mblaze
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

rename project to mblaze

Browse Source
pull/2/head
Christian Neukirchen 8 years ago
parent 2a9c1668eb
commit 60f4618e2b
5 changed files with 34 additions and 37 deletions
Show Stats Download Patch File Download Diff File

2
COPYING
Unescape Escape View File

@ -1,4 +1,4 @@
Santoku is in the public domain. mblaze is in the public domain.
To the extent possible under law, To the extent possible under law,
Christian Neukirchen <chneukirchen@gmail.com> Christian Neukirchen <chneukirchen@gmail.com>

2
Makefile
Unescape Escape View File

@ -21,7 +21,7 @@ mshow: mshow.o blaze822.o seq.o rfc2045.o rfc2047.c mymemmem.o filter.o
msort: msort.o blaze822.o seq.o mystrverscmp.o mymemmem.o msort: msort.o blaze822.o seq.o mystrverscmp.o mymemmem.o
mthread: mthread.o blaze822.o seq.o mymemmem.o mthread: mthread.o blaze822.o seq.o mymemmem.o
README: man/mintro.7 README: man/mblaze.7
mandoc -Tutf8 $< | col -bx >$@ mandoc -Tutf8 $< | col -bx >$@
clean: FRC clean: FRC

34
README
Unescape Escape View File

@ -1,16 +1,16 @@
MINTRO(7) Miscellaneous Information Manual MINTRO(7) MBLAZE(7) Miscellaneous Information Manual MBLAZE(7)
NAME NAME
mintro – Santoku introduction mblaze – introduction to mblaze
DESCRIPTION DESCRIPTION
The Santoku message system is a set of Unix utilities to deal with mail The mblaze message system is a set of Unix utilities to deal with mail
kept in Maildir folders. kept in Maildir folders.
Its design is roughly inspired by MH, the RAND Message Handling System, Its design is roughly inspired by MH, the RAND Message Handling System,
but its is a complete implementation from scratch. but its is a complete implementation from scratch.
Santoku consists of a set of Unix tools that each do one job: mblaze consists of a set of Unix tools that each do one job:
maddr(1) to extract addresses from mail maddr(1) to extract addresses from mail
mcomp(1) to write and send mail mcomp(1) to write and send mail
mdeliver(1) to deliver messages or import mailboxes mdeliver(1) to deliver messages or import mailboxes
@ -32,13 +32,13 @@ DESCRIPTION
mthread(1) to arrange mail into discussions mthread(1) to arrange mail into discussions
PRINCIPLES PRINCIPLES
Santoku is a classic command line MUA with no features related to mblaze is a classic command line MUA with no features related to
receiving and transferring mail. You are expected to fetch your mail receiving and transferring mail. You are expected to fetch your mail
using offlineimap(1), fdm(1), procmail(1), getmail(1) or similar and send using offlineimap(1), fdm(1), procmail(1), getmail(1) or similar and send
it using sendmail(8), as provided by OpenSMTPD, Postfix, msmtp(1), dma(8) it using sendmail(8), as provided by OpenSMTPD, Postfix, msmtp(1), dma(8)
or similar. Santoku expects your mail to reside in Maildir folders. or similar. mblaze expects your mail to reside in Maildir folders.
Santoku operates directly on Maildir and doesn't use caches or database. mblaze operates directly on Maildir and doesn't use caches or database.
There is no setup needed for many uses. All tools have been written with There is no setup needed for many uses. All tools have been written with
performance in mind. Enumeration of all mails in a Maildir is avoided performance in mind. Enumeration of all mails in a Maildir is avoided
unless necessary, and then optimized to use few syscalls. Parsing mail unless necessary, and then optimized to use few syscalls. Parsing mail
@ -48,20 +48,20 @@ PRINCIPLES
wasteful), but whole messages are assumed to fit into RAM easily (at a wasteful), but whole messages are assumed to fit into RAM easily (at a
time). time).
Santoku has been written from scratch and tested on a big pile of mblaze has been written from scratch and tested on a big pile of personal
personal mail, but is not actually 100% RFC conforming (which is neither mail, but is not actually 100% RFC conforming (which is neither worth it
worth it nor desirable). There may be issues with very old, nor desirable). There may be issues with very old, nonconforming,
nonconforming, messages. messages.
Santoku is written in portable C, using only POSIX functions (apart from mblaze is written in portable C, using only POSIX functions (apart from a
a tiny Linux-only optimization), and has no external dependencies. It tiny Linux-only optimization), and has no external dependencies. It
supports MIME and more than 7-bit messages (everything the host iconv(3) supports MIME and more than 7-bit messages (everything the host iconv(3)
can decode). It assumes you work in a UTF-8 environment. Santoku works can decode). It assumes you work in a UTF-8 environment. mblaze works
well together with other Unix mail tools such as offlineimap(1), well together with other Unix mail tools such as offlineimap(1),
mairix(1), or mu(1). mairix(1), or mu(1).
EXAMPLES EXAMPLES
Santoku tools are designed to be composed together into a pipe. It is mblaze tools are designed to be composed together into a pipe. It is
suitable for interactive use and for scripting. It integrates well into suitable for interactive use and for scripting. It integrates well into
a Unix workflow. a Unix workflow.
@ -85,7 +85,7 @@ EXAMPLES
As usual with pipes, the sky is the limit. As usual with pipes, the sky is the limit.
CONCEPTS CONCEPTS
Santoku deals with messages (which are files), folders (which are Maildir mblaze deals with messages (which are files), folders (which are Maildir
folders), sequences (which are newline-separated lists of messages, folders), sequences (which are newline-separated lists of messages,
possibly persisted on disk in ~/.santoku/seq), and the current message possibly persisted on disk in ~/.santoku/seq), and the current message
(kept as a symlink in ~/.santoku/cur). (kept as a symlink in ~/.santoku/cur).
@ -104,7 +104,7 @@ AUTHORS
Christian Neukirchen <chneukirchen@gmail.com> Christian Neukirchen <chneukirchen@gmail.com>
LICENSE LICENSE
Santoku is in the public domain. mblaze is in the public domain.
To the extent possible under law, the creator of this work has waived all To the extent possible under law, the creator of this work has waived all
copyright and related or neighboring rights to this work. copyright and related or neighboring rights to this work.

31
man/mintro.7 → man/mblaze.7
Unescape Escape View File

@ -1,22 +1,19 @@
.Dd July 22, 2016 .Dd July 22, 2016
.Dt MINTRO 7 .Dt MBLAZE 7
.Os .Os
.Sh NAME .Sh NAME
.Nm mintro .Nm mblaze
.Nd Santoku introduction .Nd introduction to mblaze
.de N2
.Nm Santoku
..
.Sh DESCRIPTION .Sh DESCRIPTION
The The
.N2 .Nm
message system is a set of Unix utilities to deal with message system is a set of Unix utilities to deal with
mail kept in Maildir folders. mail kept in Maildir folders.
.Pp .Pp
Its design is roughly inspired by MH, the RAND Message Handling Its design is roughly inspired by MH, the RAND Message Handling
System, but its is a complete implementation from scratch. System, but its is a complete implementation from scratch.
.Pp .Pp
.N2 .Nm
consists of a set of Unix tools that each do one job: consists of a set of Unix tools that each do one job:
.Bl -tag -width 11n -compact .Bl -tag -width 11n -compact
.It Xr maddr 1 .It Xr maddr 1
@ -60,7 +57,7 @@ to sort mail
to arrange mail into discussions to arrange mail into discussions
.El .El
.Sh PRINCIPLES .Sh PRINCIPLES
.N2 .Nm
is a classic command line MUA with no features related to receiving is a classic command line MUA with no features related to receiving
and transferring mail. and transferring mail.
You are expected to fetch your mail using You are expected to fetch your mail using
@ -77,10 +74,10 @@ Postfix,
.Xr msmtp 1 , .Xr msmtp 1 ,
.Xr dma 8 .Xr dma 8
or similar. or similar.
.N2 .Nm
expects your mail to reside in Maildir folders. expects your mail to reside in Maildir folders.
.Pp .Pp
.N2 .Nm
operates directly on Maildir and doesn't use caches or database. operates directly on Maildir and doesn't use caches or database.
There is no setup needed for many uses. There is no setup needed for many uses.
All tools have been written with performance in mind. All tools have been written with performance in mind.
@ -92,13 +89,13 @@ are in cache, everything is blazing fast.
The tools are written to be memory efficient (i.e. not wasteful), but The tools are written to be memory efficient (i.e. not wasteful), but
whole messages are assumed to fit into RAM easily (at a time). whole messages are assumed to fit into RAM easily (at a time).
.Pp .Pp
.N2 .Nm
has been written from scratch and tested on a big pile of personal mail, has been written from scratch and tested on a big pile of personal mail,
but is not actually 100% RFC conforming but is not actually 100% RFC conforming
(which is neither worth it nor desirable). (which is neither worth it nor desirable).
There may be issues with very old, nonconforming, messages. There may be issues with very old, nonconforming, messages.
.Pp .Pp
.N2 .Nm
is written in portable C, using only POSIX functions (apart from a tiny is written in portable C, using only POSIX functions (apart from a tiny
Linux-only optimization), Linux-only optimization),
and has no external dependencies. and has no external dependencies.
@ -106,14 +103,14 @@ It supports MIME and more than 7-bit messages (everything the host
.Xr iconv 3 .Xr iconv 3
can decode). can decode).
It assumes you work in a UTF-8 environment. It assumes you work in a UTF-8 environment.
.N2 .Nm
works well together with other Unix mail tools such as works well together with other Unix mail tools such as
.Xr offlineimap 1 , .Xr offlineimap 1 ,
.Xr mairix 1 , .Xr mairix 1 ,
or or
.Xr mu 1 . .Xr mu 1 .
.Sh EXAMPLES .Sh EXAMPLES
.N2 .Nm
tools are designed to be composed together into a pipe. tools are designed to be composed together into a pipe.
It is suitable for interactive use and for scripting. It is suitable for interactive use and for scripting.
It integrates well into a Unix workflow. It integrates well into a Unix workflow.
@ -139,7 +136,7 @@ Or apply the patches from the current mail:
.Dl mshow -O . '*.diff' | patch .Dl mshow -O . '*.diff' | patch
As usual with pipes, the sky is the limit. As usual with pipes, the sky is the limit.
.Sh CONCEPTS .Sh CONCEPTS
.N2 .Nm
deals with messages (which are files), deals with messages (which are files),
folders (which are Maildir folders), folders (which are Maildir folders),
sequences (which are newline-separated lists of messages, possibly persisted on disk in sequences (which are newline-separated lists of messages, possibly persisted on disk in
@ -160,7 +157,7 @@ For scripting, you must make these arguments explicit.
.Sh AUTHORS .Sh AUTHORS
.An Christian Neukirchen Aq Mt chneukirchen@gmail.com .An Christian Neukirchen Aq Mt chneukirchen@gmail.com
.Sh LICENSE .Sh LICENSE
.N2 .Nm
is in the public domain. is in the public domain.
.Pp .Pp
To the extent possible under law, To the extent possible under law,

2
man/mmsg.7
Unescape Escape View File

@ -3,7 +3,7 @@
.Os .Os
.Sh NAME .Sh NAME
.Nm mmsg .Nm mmsg
.Nd Santoku message argument syntax .Nd mblaze message argument syntax
.Sh DESCRIPTION .Sh DESCRIPTION
This manpage documents the message syntax used This manpage documents the message syntax used
by the tools by the tools

Write Preview
Loading…
Cancel
Save