From: Michael Orlitzky Date: Sun, 9 Jun 2013 18:02:11 +0000 (-0400) Subject: Add early draft of a man page. X-Git-Tag: 0.0.2~7 X-Git-Url: https://gitweb.michael.orlitzky.com/?a=commitdiff_plain;h=e9f623d8aaf39827a94a44f569e77b7547b5bf93;p=email-validator.git Add early draft of a man page. --- diff --git a/doc/man1/email-validator.1 b/doc/man1/email-validator.1 new file mode 100644 index 0000000..3e56741 --- /dev/null +++ b/doc/man1/email-validator.1 @@ -0,0 +1,51 @@ +.TH email-validator 1 + +.SH NAME +email-validator \- Perform basic syntax and deliverability checks on email addresses. + +.SH SYNOPSIS + +\fBemail-validator\fR [\fB\-h\fR] [\fB-i \fIFILE\fR] [\fB-o \fIFILE\fR] \fI\fR + +.SH INPUT + +.P +The \fIinput\fR (default: stdin) should be a list of email addresses, +one per line. Empty lines will be ignored. + +.SH OUTPUT + +.P +Valid email addresses will be written to the output file (default: +stdout), one per line. + +.SH DESCRIPTION + +.P +We check the validity of an email address using three techniques: + +.IP \[bu] 2 +We ensure that the length of local and domain parts is within the +RFC-specified limits. + +.IP \[bu] +A regular expression is used to check for invalid characters and syntax. + +.IP \[bu] +We confirm the existence of a MX record for the domain part of the +address. + +.SH OPTIONS + +.IP \fB\-\-input\fR,\ \fB\-i\fR +Specify the input file containing a list of email addresses, rather +than using stdin (the default). + +.IP \fB\-\-output\fR,\ \fB\-o\fR +Specify the output file to which the good addresses will be written, +rather than using stdout (the default). + +.SH BUGS + +.P +Send bugs to michael@orlitzky.com.