xref: /freebsd/contrib/sendmail/makemap/makemap.8 (revision 11afcc8f9f96d657b8e6f7547c02c1957331fc96)
1.\" Copyright (c) 1998 Sendmail, Inc.  All rights reserved.
2.\" Copyright (c) 1988, 1991, 1993
3.\"	The Regents of the University of California.  All rights reserved.
4.\"
5.\" By using this file, you agree to the terms and conditions set
6.\" forth in the LICENSE file which can be found at the top level of
7.\" the sendmail distribution.
8.\"
9.\"
10.\"     @(#)makemap.8	8.10 (Berkeley) 5/19/98
11.\"
12.Dd November 16, 1992
13.Dt MAKEMAP 8
14.Os BSD 4.4
15.Sh NAME
16.Nm makemap
17.Nd create database maps for sendmail
18.Sh SYNOPSIS
19.Nm
20.Op Fl N
21.Op Fl d
22.Op Fl f
23.Op Fl o
24.Op Fl r
25.Op Fl s
26.Op Fl v
27.Ar maptype
28.Ar mapname
29.Sh DESCRIPTION
30.Nm
31creates the database maps used by the keyed map lookups in
32.Xr sendmail 8 .
33It reads input from the standard input
34and outputs them to the indicated
35.Ar mapname .
36.Pp
37Depending on how it is compiled,
38.Nm
39handles up to three different database formats,
40selected using the
41.Ar maptype
42parameter.
43They may be
44.Bl -tag -width Fl
45.It Li dbm
46DBM format maps.
47This requires the
48.Xr ndbm 3
49library.
50.It Li btree
51B-Tree format maps.
52This requires the new Berkeley DB
53library.
54.It Li hash
55Hash format maps.
56This also requires the Berkeley DB
57library.
58.El
59.Pp
60In all cases,
61.Nm
62reads lines from the standard input consisting of two
63words separated by white space.
64The first is the database key,
65the second is the value.
66The value may contain
67``%\fIn\fP''
68strings to indicated parameter substitution.
69Literal percents should be doubled
70(``%%'').
71Blank lines and lines beginning with ``#'' are ignored.
72.Ss Flags
73.Bl -tag -width Fl
74.It Fl N
75Include the null byte that terminates strings
76in the map.
77This must match the \-N flag in the sendmail.cf
78``K'' line.
79.It Fl d
80Allow duplicate keys in the map.
81This is only allowed on B-Tree format maps.
82If two identical keys are read,
83they will both be inserted into the map.
84.It Fl f
85Normally all upper case letters in the key
86are folded to lower case.
87This flag disables that behaviour.
88This is intended to mesh with the
89\-f flag in the
90\fBK\fP
91line in sendmail.cf.
92The value is never case folded.
93.It Fl o
94Append to an old file.
95This allows you to augment an existing file.
96.It Fl r
97Allow replacement of existing keys.
98Normally
99.Nm
100complains if you repeat a key,
101and does not do the insert.
102.It Fl s
103Ignore safety checks on maps being created.
104This includes checking for hard or symbolic
105links in world writable directories.
106.It Fl v
107Verbosely print what it is doing.
108.El
109.Sh SEE ALSO
110.Xr sendmail 8
111.Sh HISTORY
112The
113.Nm
114command appeared in
115.Bx 4.4 .
116