document handling of comments in makemap
authorgilles <gilles@openbsd.org>
Sat, 17 Oct 2015 19:42:12 +0000 (19:42 +0000)
committergilles <gilles@openbsd.org>
Sat, 17 Oct 2015 19:42:12 +0000 (19:42 +0000)
ok millert@, ok sunil@, ok jung@

usr.sbin/smtpd/makemap.8

index db6bd00..1a015a7 100644 (file)
@@ -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.