Merge from vendor branch CVS:
[dragonfly.git] / usr.bin / ypcat / ypcat.1
1 .\" Copyright (c) 1993 Winning Strategies, Inc.
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"      This product includes software developed by Winning Strategies, Inc.
15 .\" 4. The name of the author may not be used to endorse or promote products
16 .\"    derived from this software without specific prior written permission
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 .\"
29 .\" $FreeBSD: src/usr.bin/ypcat/ypcat.1,v 1.8.2.5 2002/06/21 15:30:33 charnier Exp $
30 .\" $DragonFly: src/usr.bin/ypcat/ypcat.1,v 1.2 2003/06/17 04:29:34 dillon Exp $
31 .\"
32 .Dd December 3, 1993
33 .Dt YPCAT 1
34 .Os
35 .Sh NAME
36 .Nm ypcat
37 .Nd "print the values of all keys in a YP database"
38 .Sh SYNOPSIS
39 .Nm
40 .Op Fl kt
41 .Op Fl d Ar domainname
42 .Ar mapname
43 .Nm
44 .Fl x
45 .Sh DESCRIPTION
46 The
47 .Nm
48 utility prints out the values of all keys from the
49 .Tn YP
50 database specified by
51 .Ar mapname ,
52 which may be a map name or a map nickname.
53 .Pp
54 The options are as follows:
55 .Bl -tag -width indent
56 .It Fl d Ar domainname
57 Specify a domain other than the default domain.
58 .It Fl k
59 Display map keys.
60 This option is useful with maps in which the values are null or the key
61 is not part of the value.
62 .It Fl t
63 Inhibit translation of map nicknames
64 to their corresponding map names.
65 .It Fl x
66 Display the map nickname table.
67 .El
68 .Sh SEE ALSO
69 .Xr domainname 1 ,
70 .Xr ypmatch 1 ,
71 .Xr yp 8 ,
72 .Xr ypbind 8 ,
73 .Xr ypset 8
74 .Sh AUTHORS
75 .An Theo De Raadt Aq deraadt@theos.com .