From: Michael Orlitzky <michael@orlitzky.com>
Date: Fri, 8 Mar 2019 22:07:16 +0000 (-0500)
Subject: Update the documentation to eliminate the "--input" and "--output" flags.
X-Git-Tag: 1.0.0~1
X-Git-Url: https://gitweb.michael.orlitzky.com/?a=commitdiff_plain;h=0bc13890f422a2de2393cfe8ffe95044b60b8a1d;p=email-validator.git

Update the documentation to eliminate the "--input" and "--output" flags.
---

diff --git a/doc/man1/email-validator.1 b/doc/man1/email-validator.1
index 232a5f4..1e0e144 100644
--- a/doc/man1/email-validator.1
+++ b/doc/man1/email-validator.1
@@ -5,19 +5,18 @@ email-validator \- Perform basic syntax and deliverability checks on email addre
 
 .SH SYNOPSIS
 
-\fBemail-validator\fR [\fB\-har\fR] [\fB-i \fIFILE\fR] [\fB-o \fIFILE\fR] \fI<input>\fR
+\fBemail-validator\fR [\fB\-har\fR] \fI<input>\fR
 
 .SH INPUT
 
 .P
-The \fIinput\fR (default: stdin) should be a list of email addresses,
+The \fIinput\fR (via 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.
+Valid email addresses will be written to stdout, one per line.
 
 .SH DESCRIPTION
 
@@ -48,7 +47,7 @@ appropriate flag to the GHC runtime.
 This will set the number of threads to 25:
 
 .nf
-.B $ email-validator -i addresses.csv +RTS -N25
+.B $ email-validator +RTS -N25 < addresses.csv
 
 .SH OPTIONS
 
@@ -56,14 +55,6 @@ This will set the number of threads to 25:
 Accept an 'A' record for the domain instead of requiring an MX record
 (the default).
 
-.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).
-
 .IP \fB\-\-rfc5322\fR,\ \fB\-r\fR
 Verify addresses against RFC 5322 rather than a naive regular
 expression. This is much more lenient than the default.
diff --git a/email-validator.cabal b/email-validator.cabal
index 9bdbfef..667c998 100644
--- a/email-validator.cabal
+++ b/email-validator.cabal
@@ -33,18 +33,17 @@ description:
   This will set the number of threads to 25:
   .
   @
-  $ email-validator -i addresses.csv +RTS -N25
+  $ email-validator +RTS -N25 < addresses.csv
   @
   .
   /Input/
   .
-  The @input@ file (default: stdin) should be a list of email addresses,
+  The @input@ (via stdin) should be a list of email addresses,
   one per line. Empty lines will be ignored.
   .
   /Output/
   .
-  Valid email addresses will be written to the output file (default:
-  stdout), one per line.
+  Valid email addresses will be written to stdout, one per line.
 
 
 executable email-validator