add readme

This commit is contained in:
Jeremy Baxter 2024-02-27 20:59:59 +13:00
parent 39f66b6f88
commit 321b594d2c

38
README.md Normal file
View file

@ -0,0 +1,38 @@
mal sends an email to one or more recipients, through information passed
on its command line. Read COPYING for information on redistribution.
## compilation
Install ldc and curl, and run make. To install the binary systemwide,
run make install after compiling.
## usage
Send an email from you@example.org to joe@example.org
with the message body "hello!":
mal -m 'hello!' -t joe@example.org -P password123 you@example.org
Read the message body from a file instead:
mal -M mesgfile -t joe@example.org -P password123 you@example.org
Send the message to multiple recipients:
mal -M mesgfile -t joe@example.org -t jane@example.org \
-P password123 you@example.org
If SSL is not working properly, use an insecure connection with -k:
mal -k -m 'hello!' -t joe@example.org -P password123 you@example.org
To send a message from an address with a plus in it, manually specify
the username with -u:
mal -m 'hello!' -t joe@example.org -u you -P password123 you+malbot@example.org
Read a quick usage example:
mal
Man pages hopefully coming soon.