Return to getent.1 CVS log

Up to [local] / src / usr.bin / getent

Annotation of src/usr.bin/getent/getent.1, Revision 1.1

1.1     ! otto        1: .\"    $NetBSD: getent.1,v 1.13 2005/09/11 23:16:15 wiz Exp $
        !             2: .\"
        !             3: .\" Copyright (c) 2004 The NetBSD Foundation, Inc.
        !             4: .\" All rights reserved.
        !             5: .\"
        !             6: .\" This code is derived from software contributed to The NetBSD Foundation
        !             7: .\" by Luke Mewburn.
        !             8: .\"
        !             9: .\" Redistribution and use in source and binary forms, with or without
        !            10: .\" modification, are permitted provided that the following conditions
        !            11: .\" are met:
        !            12: .\" 1. Redistributions of source code must retain the above copyright
        !            13: .\"    notice, this list of conditions and the following disclaimer.
        !            14: .\" 2. Redistributions in binary form must reproduce the above copyright
        !            15: .\"    notice, this list of conditions and the following disclaimer in the
        !            16: .\"    documentation and/or other materials provided with the distribution.
        !            17: .\" 3. All advertising materials mentioning features or use of this software
        !            18: .\"    must display the following acknowledgement:
        !            19: .\"    This product includes software developed by the NetBSD
        !            20: .\"    Foundation, Inc. and its contributors.
        !            21: .\" 4. Neither the name of The NetBSD Foundation nor the names of its
        !            22: .\"    contributors may be used to endorse or promote products derived
        !            23: .\"    from this software without specific prior written permission.
        !            24: .\"
        !            25: .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
        !            26: .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
        !            27: .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
        !            28: .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
        !            29: .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
        !            30: .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
        !            31: .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
        !            32: .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
        !            33: .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
        !            34: .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
        !            35: .\" POSSIBILITY OF SUCH DAMAGE.
        !            36: .\"
        !            37: .Dd August 24, 2005
        !            38: .Dt GETENT 1
        !            39: .Os
        !            40: .Sh NAME
        !            41: .Nm getent
        !            42: .Nd get entries from administrative database
        !            43: .Sh SYNOPSIS
        !            44: .Nm
        !            45: .Ar database
        !            46: .Op Ar key ...
        !            47: .Sh DESCRIPTION
        !            48: The
        !            49: .Nm
        !            50: program retrieves and displays entries from the administrative
        !            51: database specified by
        !            52: .Ar database ,
        !            53: using the lookup order specified in
        !            54: .Xr nsswitch.conf 5 .
        !            55: The display format for a given
        !            56: .Ar database
        !            57: is as per the
        !            58: .Dq traditional
        !            59: file format for that database.
        !            60: .Pp
        !            61: .Ar database
        !            62: may be one of:
        !            63: .Bl -column "netgroup" -offset indent -compact
        !            64: .Sy Database Ta Sy Display format
        !            65: .It ethers Ta address name
        !            66: .It group Ta group:passwd:gid:[member[,member]...]
        !            67: .It hosts Ta address name [alias ...]
        !            68: .It networks Ta name network [alias ...]
        !            69: .It passwd Ta user:passwd:uid:gid:gecos:home_dir:shell
        !            70: .It protocols Ta name protocol [alias ...]
        !            71: .It rpc Ta name number [alias ...]
        !            72: .It services Ta name port/protocol [alias ...]
        !            73: .It shells Ta /path/to/shell
        !            74: .El
        !            75: .Pp
        !            76: If one or more
        !            77: .Ar key
        !            78: arguments are provided, they will be looked up in
        !            79: .Ar database
        !            80: using the appropriate function.
        !            81: For example,
        !            82: .Sy passwd
        !            83: supports a numeric UID or user name;
        !            84: .Sy hosts
        !            85: supports an IPv4 address, IPv6 address, or host name;
        !            86: and
        !            87: .Sy services
        !            88: supports a service name, service name/protocol name, numeric port, or
        !            89: numeric port/protocol name.
        !            90: .Pp
        !            91: If no
        !            92: .Ar key
        !            93: is provided and
        !            94: .Ar database
        !            95: supports enumeration, all entries for
        !            96: .Ar database
        !            97: will be retrieved using the appropriate enumeration function and printed.
        !            98: .Sh DIAGNOSTICS
        !            99: .Nm
        !           100: exits 0 on success,
        !           101: 1 if there was an error in the command syntax,
        !           102: 2 if one of the specified key names was not found in
        !           103: .Ar database ,
        !           104: or 3 if there is no support for enumeration on
        !           105: .Ar database .
        !           106: .Sh SEE ALSO
        !           107: .Xr ethers 5 ,
        !           108: .Xr group 5 ,
        !           109: .Xr hosts 5 ,
        !           110: .Xr networks 5 ,
        !           111: .Xr nsswitch.conf 5 ,
        !           112: .Xr passwd 5 ,
        !           113: .Xr protocols 5 ,
        !           114: .Xr rpc 5 ,
        !           115: .Xr services 5 ,
        !           116: .Xr shells 5
        !           117: .Sh HISTORY
        !           118: A
        !           119: .Nm
        !           120: command appeared in
        !           121: .Nx 3.0 .
        !           122: It was based on the command of the same name in
        !           123: .Tn Solaris
        !           124: and
        !           125: .Tn Linux .