From: gilles <gilles@openbsd.org>
Date: Sat, 17 Oct 2015 19:42:12 +0000 (+0000)
Subject: document handling of comments in makemap
X-Git-Url: http://artulab.com/gitweb/?a=commitdiff_plain;h=d57b79229c1d36010c1540fd5b61c466fd5f8d7a;p=openbsd

document handling of comments in makemap

ok millert@, ok sunil@, ok jung@
---

diff --git a/usr.sbin/smtpd/makemap.8 b/usr.sbin/smtpd/makemap.8
index db6bd003f33..1a015a7f531 100644
--- a/usr.sbin/smtpd/makemap.8
+++ b/usr.sbin/smtpd/makemap.8
@@ -1,4 +1,4 @@
-.\"	$OpenBSD: makemap.8,v 1.24 2015/09/29 13:57:01 millert Exp $
+.\"	$OpenBSD: makemap.8,v 1.25 2015/10/17 19:42:12 gilles Exp $
 .\"
 .\" Copyright (c) 2009 Jacek Masiulaniec <jacekm@openbsd.org>
 .\" Copyright (c) 2008-2009 Gilles Chehade <gilles@poolp.org>
@@ -15,7 +15,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: September 29 2015 $
+.Dd $Mdocdate: October 17 2015 $
 .Dt MAKEMAP 8
 .Os
 .Sh NAME
@@ -41,6 +41,13 @@ and writes data to a file whose name is made by adding a
 .Dq .db
 suffix to
 .Ar file .
+The current line can be extended over multiple lines using a backslash
+.Pq Sq \e .
+Comments can be put anywhere in the file using a hash mark
+.Pq Sq # ,
+and extend to the end of the current line.
+Care should be taken when commenting out multi-line text:
+the comment is effective until the end of the entire block.
 In all cases,
 .Nm
 reads lines consisting of words separated by whitespace.