summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Wu <lekensteyn@gmail.com>2013-07-09 12:05:47 +0200
committerPeter Wu <lekensteyn@gmail.com>2013-07-09 12:05:47 +0200
commit3f72b80acb9c8b4220ab2775547333fad06755b5 (patch)
treec597881329079f8b538b047366582664fb99eadd
parent806ad2d6967982a91fe52a20b8870836baa5fdfb (diff)
downloadfemtomail-3f72b80acb9c8b4220ab2775547333fad06755b5.tar.gz
README: update with ignore sendmail option feature
-rw-r--r--README.md25
-rw-r--r--femtomail.c2
2 files changed, 16 insertions, 11 deletions
diff --git a/README.md b/README.md
index 379dca7..15afe13 100644
--- a/README.md
+++ b/README.md
@@ -18,6 +18,11 @@ The workflow of femtomail:
4. Pass data from standard input to the file.
5. Exit.
+femtomail can replace the sendmail binary, but note that delivery is only
+possible for a single user. When invoked as `newaliases` or `mailq`, the program
+exits with a zero status code. Most [options of sendmail][3] are ignored except
+for the `-fname` and `address` arguments.
+
Installation
------------
@@ -54,23 +59,23 @@ directory):
Bugs
----
-This program does not parse any sendmail option. All arguments are ignored,
-except the (optional) first address (which is written in the `Received` mail
-header). No validation is performed at this address, the mail headers and its
-body. If femtomail is invoked without specifying mail contents, an empty message
-will be created.
+Not much validation is done for the address specified with the `-f` option or
+the recipient address. The mail headers and its body is passed unprocessed. If
+femtomail is invoked without specifying mail contents, an empty message will be
+created.
-Other bugs can be reported at <lekensteyn@gmail.com>.
+Other bugs can be reported at &lt;lekensteyn@gmail.com&gt;.
Copyright
---------
-Copyright (c) 2013 Peter Wu <lekensteyn@gmail.com>
+Copyright (c) 2013 Peter Wu &lt;lekensteyn@gmail.com&gt;
-License: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>. This is
-free software: you are free to change and redistribute it. There is NO WARRANTY,
-to the extent permitted by law.
+License: GNU GPL version 3 or later &lt;http://gnu.org/licenses/gpl.html&gt;.
+This is free software: you are free to change and redistribute it. There is NO
+WARRANTY, to the extent permitted by law.
[1]: http://unix.stackexchange.com/q/82093/8250
[2]: http://heirloom.sourceforge.net/mailx.html
+ [3]: http://www.sendmail.org/~ca/email/man/sendmail.html
diff --git a/femtomail.c b/femtomail.c
index b91014f..916bf23 100644
--- a/femtomail.c
+++ b/femtomail.c
@@ -1,6 +1,6 @@
/**
* femtomail - Minimal sendmail replacement for forwarding mail to a single
- * Maildir box. Note: this program does not try to implement sendmail.
+ * Maildir box.
*
* Installation commands:
* $ cc -DUSERNAME=\"$USER\" femtomail.c -o femtomail