summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTodd C. Miller <millert@cvs.openbsd.org>2001-09-12 16:40:02 +0000
committerTodd C. Miller <millert@cvs.openbsd.org>2001-09-12 16:40:02 +0000
commit0bc30b036f32a3b9f521f50b1227427f480b75cf (patch)
treea5afd103d5bd931802296ba94927ecb0a336677a
parent5ef12c75e8a888e9df0b53386a47af892e243dde (diff)
convert to mdoc
-rw-r--r--gnu/usr.sbin/sendmail/editmap/editmap.8125
1 files changed, 65 insertions, 60 deletions
diff --git a/gnu/usr.sbin/sendmail/editmap/editmap.8 b/gnu/usr.sbin/sendmail/editmap/editmap.8
index 816893b65d3..3f5f7cc117d 100644
--- a/gnu/usr.sbin/sendmail/editmap/editmap.8
+++ b/gnu/usr.sbin/sendmail/editmap/editmap.8
@@ -8,99 +8,104 @@
.\"
.\" $Sendmail: editmap.8,v 1.8 2001/06/15 21:33:19 ca Exp $
.\"
-.TH EDITMAP 8 "$Date: 2001/09/11 18:55:52 $"
-.SH NAME
-.B editmap
-\- query and edit single records in database maps for sendmail
-.SH SYNOPSIS
-.B editmap
-.RB [ \-C
-.IR file ]
-.RB [ \-N ]
-.RB [ \-f ]
-.RB [ \-q|\-u|\-x ]
-maptype mapname
-key [ "value ..." ]
-.SH DESCRIPTION
-.B Editmap
+.Dd June 15, 2001
+.Dt EDITMAP 8
+.Os
+.Sh NAME
+.Nm editmap
+.Nd query and edit single records in database maps for sendmail
+.Sh SYNOPSIS
+.Nm editmap
+.Op Fl C Ar file
+.Op Fl N
+.Op Fl f
+.Op Fl q | Fl u | Fl x
+maptype mapname key
+.Op Dq value ...
+.Sh DESCRIPTION
+.Nm editmap
queries or edits one record in a database maps used by the keyed map lookups in
-sendmail(8).
+.Xr sendmail 8 .
Arguments are passed on the command line and output (for queries) is
directed to standard output.
-.PP
+.Pp
Depending on how it is compiled,
-.B editmap
+.Nm
handles up to three different database formats,
selected using the
-.I maptype
+.Ar maptype
parameter.
They may be
-.TP
-dbm
+.Bl -tag -width Fl
+.It Li dbm
DBM format maps.
This requires the
-ndbm(3)
+.Xr ndbm 3
library.
-.TP
-btree
+.It Li btree
B-Tree format maps.
This requires the new Berkeley DB
library.
-.TP
-hash
+.It Li hash
Hash format maps.
This also requires the Berkeley DB
library.
-.PP
+.El
+.Pp
If the
-.I TrustedUser
+.Li TrustedUser
option is set in the sendmail configuration file and
-.B editmap
+.Nm
is invoked as root, the generated files will be owned by
the specified
-.IR TrustedUser.
-.SS Flags
-.TP
-.B \-C
+.Li TrustedUser .
+.Ss Flags
+.Bl -tag -width Fl
+.It Fl C Ar file
Use the specified
-.B sendmail
-configuration file for looking up the TrustedUser option.
-.TP
-.B \-N
+.Xr sendmail 8
+configuration
+.Ar file
+for looking up the
+.Li TrustedUser
+option.
+.It Fl N
Include the null byte that terminates strings
in the map (for alias maps).
-.TP
-.B \-f
+.It Fl f
Normally all upper case letters in the key
are folded to lower case.
This flag disables that behaviour.
This is intended to mesh with the
-\-f flag in the
-.B K
+.Fl f
+flag in the
+.Dq K
line in sendmail.cf.
The value is never case folded.
-.TP
-.B \-q
+.It Fl q
Query the map for the specified key. If found, print value to standard
output and exit with 0. If not found then print an error
-message to stdout and exit with EX_UNAVAILABLE.
-.TP
-.B \-u
-Update the record for
-.I key
+message to stdout and exit with
+.Dv EX_UNAVAILABLE .
+.It Fl u
+Updates the record for
+.Ar key
with
-.I value
+.Ar value
or inserts a new record if one doesn't exist. Exits with 0 on success
-or EX_IOERR on failure.
-.TP
-.B \-x
+or
+.Dv EX_IOERR
+on failure.
+.It Fl x
Deletes the specific key from the map. Exits with 0 on success or
-EX_IOERR on failure.
-.TP
-.SH SEE ALSO
-sendmail(8),
-makemap(8)
-.SH HISTORY
+.Dv EX_IOERR
+on failure.
+.El
+.Sh SEE ALSO
+.Xr sendmail 8 ,
+.Xr makemap 8
+.Sh HISTORY
The
-.B editmap
-command has no history.
+.Nm
+command appeared in
+.Ox 3.0 .