cut down README.md
This commit is contained in:
parent
deb1226bfe
commit
c4e68581da
1 changed files with 7 additions and 39 deletions
46
README.md
46
README.md
|
@ -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.
|
on its command line. Read COPYING for information on redistribution.
|
||||||
|
|
||||||
## compilation
|
## compilation
|
||||||
|
|
||||||
Install ldc and curl, and run make. To install the binary systemwide,
|
Install ldc and libcurl, and run `make`.
|
||||||
run make install after compiling.
|
To install, run `make install` after compiling.
|
||||||
|
|
||||||
## usage
|
## documentation
|
||||||
|
|
||||||
Send an email from you@example.org to joe@example.org
|
All documentation is provided in the man page. With mal installed, run
|
||||||
with the message body "hello!":
|
`man mal`, or in this source tree run `man ./mal.1`. Usage examples are
|
||||||
|
in the **EXAMPLES** section near the end.
|
||||||
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.
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue