cut down README.md

This commit is contained in:
Jeremy Baxter 2024-06-17 07:58:30 +12:00
parent deb1226bfe
commit c4e68581da

View file

@ -1,45 +1,13 @@
mal sends an email to one or more recipients, through information passed
mal sends 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.
Install ldc and libcurl, and run `make`.
To install, run `make install` after compiling.
## usage
## documentation
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
CC john@example.org:
mal -m 'hello!' -t joe@example.org -H 'Cc: <john@example.org>' -P password123 \
you@example.org
Read a quick usage example:
mal
Man pages hopefully coming soon.
All documentation is provided in the man page. With mal installed, run
`man mal`, or in this source tree run `man ./mal.1`. Usage examples are
in the **EXAMPLES** section near the end.