usr/src/man/man1m/makemap.1m

   1 '\" te
   2 .\" Copyright (c) 1983 Eric P. Allman
   3 .\" Copyright (c) 1988, 1993 The Regents of the University of California.  All rights reserved.
   4 .\" Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright    notice, this list of conditions and the following disclaimer.
   5 .\" 2. Redistributions in binary form must reproduce the above copyright    notice, this list of conditions and the following disclaimer in the    documentation and/or other materials provided with the distribution. 3. All advertising materials mentioning features or use of this software    must display
   6 .\" the following acknowledgement: This product includes software developed by the University of California, Berkeley and its contributors. 4. Neither the name of the University nor the names of its contributors    may be used to endorse or promote products derived from this software    without specific
   7 .\" prior written permission.  THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR
   8 .\" CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
   9 .\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  10 .\" Copyright (c) 1998-2006, 2008 Sendmail, Inc. and its suppliers.  All rights reserved.
  11 .\" The following license terms and conditions apply, unless a different license is obtained from Sendmail, Inc., 6425 Christie Ave, Fourth Floor, Emeryville, CA 94608, USA, or by electronic mail at license@sendmail.com.  License Terms:  Use, Modification and Redistribution
  12 .\" (including distribution of any modified or derived work) in source and binary forms is permitted only if each of the following conditions is met:  1. Redistributions qualify as "freeware" or "Open Source Software" under    one of the following terms:     (a) Redistributions are made at no charge
  13 .\" beyond the reasonable cost of        materials and delivery.     (b) Redistributions are accompanied by a copy of the Source Code or by an        irrevocable offer to provide a copy of the Source Code for up to three       years at the cost of materials and delivery.  Such redistributions
  14 .\"    must allow further use, modification, and redistribution of the Source       Code under substantially the same terms as this license.  For the        purposes of redistribution "Source Code" means the complete compilable       and linkable source code of sendmail including all modifications.
  15 .\"  2. Redistributions of source code must retain the copyright notices as they    appear in each source code file, these license terms, and the    disclaimer/limitation of liability set forth as paragraph 6 below.  3. Redistributions in binary form must reproduce the Copyright Notice,    these license
  16 .\" terms, and the disclaimer/limitation of liability set    forth as paragraph 6 below, in the documentation and/or other materials    provided with the distribution.  For the purposes of binary distribution    the "Copyright Notice" refers to the following language:    "Copyright (c) 1998-2004 Sendmail,
  17 .\" Inc.  All rights reserved."  4. Neither the name of Sendmail, Inc. nor the University of California nor    the names of their contributors may be used to endorse or promote    products derived from this software without specific prior written    permission.  The name "sendmail" is a trademark
  18 .\" of Sendmail, Inc.  5. All redistributions must comply with the conditions imposed by the    University of California on certain embedded code, whose copyright    notice and conditions for redistribution are as follows:     (a) Copyright (c) 1988, 1993 The Regents of the University of        California.
  19 .\"  All rights reserved.     (b) Redistribution and use in source and binary forms, with or without        modification, are permitted provided that the following conditions        are met:        (i)   Redistributions of source code must retain the above copyright             notice, this list of
  20 .\" conditions and the following disclaimer.        (ii)  Redistributions in binary form must reproduce the above             copyright notice, this list of conditions and the following             disclaimer in the documentation and/or other materials provided             with the distribution.
  21 .\"       (iii) Neither the name of the University nor the names of its             contributors may be used to endorse or promote products derived             from this software without specific prior written permission. 6. Disclaimer/Limitation of Liability: THIS SOFTWARE IS PROVIDED BY    SENDMAIL,
  22 .\" INC. AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED    WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF    MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN    NO EVENT SHALL SENDMAIL, INC., THE REGENTS OF THE UNIVERSITY OF    CALIFORNIA OR CONTRIBUTORS
  23 .\" BE LIABLE FOR ANY DIRECT, INDIRECT,    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT    NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF    USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON    ANY THEORY OF LIABILITY, WHETHER
  24 .\" IN CONTRACT, STRICT LIABILITY, OR TORT    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF    THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
  25 .\"  Copyright (c) 2009, Sun Microsystems, Inc.  All Rights Reserved.
  26 .TH MAKEMAP 1M "Apr 22, 2008"
  27 .SH NAME
  28 makemap \- create database maps for sendmail
  29 .SH SYNOPSIS
  30 .LP
  31 .nf
  32 \fBmakemap\fR [\fB-N\fR] [\fB-d\fR] [\fB-f\fR] [\fB-o\fR] [\fB-r\fR] [\fB-s\fR] [\fB-v\fR] [\fB-C\fR \fIfile\fR]
  33      [\fB-c\fR \fIcachesize\fR] [\fB-D\fR \fIcommentchar\fR] [\fB-e\fR] [\fB-l\fR] [\fB-t\fR \fIdelim\fR]
  34      [\fB-u\fR] \fImantype\fR \fImapname\fR
  35 .fi
  36
  37 .SH DESCRIPTION
  38 .sp
  39 .LP
  40 \fBmakemap\fR creates the database maps used by the keyed map lookups in
  41 \fBsendmail\fR(1M). \fBmakemap\fR reads from the standard input and outputs to
  42 the specified \fImapname\fR.
  43 .sp
  44 .LP
  45 In all cases, \fBmakemap\fR reads lines from the standard input consisting of
  46 two words separated by whitespace. The first is the database key, the second is
  47 the value. The value may contain \fB%\fR\fIn\fR strings to indicated parameter
  48 substitution. Literal percents should be doubled (\fB%%\fR). Blank lines and
  49 lines beginning with \fB#\fR are ignored.
  50 .sp
  51 .LP
  52 \fBmakemap\fR handles three different database formats. Database format is
  53 selected using the \fImaptype\fR parameter. See \fBOPERANDS\fR.
  54 .SH OPTIONS
  55 .sp
  56 .LP
  57 The following options are supported:
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fB-c\fR \fIcachesize\fR\fR
  62 .ad
  63 .RS 18n
  64 Use the specified hash and B-Tree cache size (\fIcachesize\fR).
  65 .RE
  66
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fB-C\fR \fIfile\fR\fR
  71 .ad
  72 .RS 18n
  73 Use the specified sendmail configuration file (\fIfile\fR) for looking up the
  74 TrustedUser option.
  75 .RE
  76
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fB-d\fR\fR
  81 .ad
  82 .RS 18n
  83 Allow duplicate keys in the map. This is only allowed on B-Tree format maps. If
  84 two identical keys are read, both be inserted into the map.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fB-D\fR \fIcommentchar\fR\fR
  91 .ad
  92 .RS 18n
  93 Use the specified character to indicate a comment (which is ignored) instead of
  94 the default of '\fB#\fR'.
  95 .RE
  96
  97 .sp
  98 .ne 2
  99 .na
 100 \fB\fB-e\fR\fR
 101 .ad
 102 .RS 18n
 103 Allow empty value (right hand side).
 104 .RE
 105
 106 .sp
 107 .ne 2
 108 .na
 109 \fB\fB-f\fR\fR
 110 .ad
 111 .RS 18n
 112 Normally, all upper case letters in the key are folded to lower case. This flag
 113 disables that behavior. This is intended to mesh with the \fB-f\fR flag in the
 114 \fBK\fR line in \fBsendmail.cf\fR. The value is never case folded.
 115 .RE
 116
 117 .sp
 118 .ne 2
 119 .na
 120 \fB\fB-l\fR\fR
 121 .ad
 122 .RS 18n
 123 List supported map types.
 124 .RE
 125
 126 .sp
 127 .ne 2
 128 .na
 129 \fB\fB-N\fR\fR
 130 .ad
 131 .RS 18n
 132 Include the null byte that terminates strings in the map. This must match the
 133 \fB-N\fR flag in the \fBK\fR line in \fBsendmail.cf\fR
 134 .RE
 135
 136 .sp
 137 .ne 2
 138 .na
 139 \fB\fB-o\fR\fR
 140 .ad
 141 .RS 18n
 142 Append to an old file. This allows you to augment an existing file.
 143 .RE
 144
 145 .sp
 146 .ne 2
 147 .na
 148 \fB\fB-r\fR\fR
 149 .ad
 150 .RS 18n
 151 Allow replacement of existing keys. Normally \fBmakemap\fR complains if you
 152 repeat a key, and does not do the insert.
 153 .RE
 154
 155 .sp
 156 .ne 2
 157 .na
 158 \fB\fB-s\fR\fR
 159 .ad
 160 .RS 18n
 161 Ignore safety checks on maps being created. This includes checking for hard or
 162 symbolic links in world writable directories.
 163 .RE
 164
 165 .sp
 166 .ne 2
 167 .na
 168 \fB\fB-t\fR \fIdelim\fR\fR
 169 .ad
 170 .RS 18n
 171 Use the specified delimiter (\fIdelim\fR) instead of whitespace.
 172 .RE
 173
 174 .sp
 175 .ne 2
 176 .na
 177 \fB\fB-u\fR\fR
 178 .ad
 179 .RS 18n
 180 Dump (unmap) the content of the database to standard output. Note that, if the
 181 \fB-t\fR option is also provided, the specified delimiter is used when the
 182 content is dumped instead of whitespace.
 183 .RE
 184
 185 .sp
 186 .ne 2
 187 .na
 188 \fB\fB-v\fR\fR
 189 .ad
 190 .RS 18n
 191 Verbosely print what it is doing.
 192 .RE
 193
 194 .SH OPERANDS
 195 .sp
 196 .LP
 197 The following operands are supported:
 198 .sp
 199 .ne 2
 200 .na
 201 \fB\fImapname\fR\fR
 202 .ad
 203 .RS 11n
 204 File name of the database map being created.
 205 .RE
 206
 207 .sp
 208 .ne 2
 209 .na
 210 \fB\fImaptype\fR\fR
 211 .ad
 212 .RS 11n
 213 Specifies the database format. The following \fImaptype\fR parameters are
 214 available:
 215 .sp
 216 .ne 2
 217 .na
 218 \fB\fBdbm\fR\fR
 219 .ad
 220 .RS 9n
 221 Specifies \fBDBM\fR format maps.
 222 .RE
 223
 224 .sp
 225 .ne 2
 226 .na
 227 \fB\fBbtree\fR\fR
 228 .ad
 229 .RS 9n
 230 Specifies B-Tree format maps.
 231 .RE
 232
 233 .sp
 234 .ne 2
 235 .na
 236 \fB\fBhash\fR\fR
 237 .ad
 238 .RS 9n
 239 Specifies hash format maps.
 240 .RE
 241
 242 .RE
 243
 244 .SH SEE ALSO
 245 .sp
 246 .LP
 247 \fBeditmap\fR(1M), \fBsendmail\fR(1M), \fBattributes\fR(5)