No empty .Rs/.Re
[netbsd-mini2440.git] / usr.bin / hesinfo / hesinfo.1
blobd7c5943f7b72f9e2bb970a9e90e6d785dfe1ba8b
1 .\"     $NetBSD: hesinfo.1,v 1.8 2003/06/27 08:50:50 wiz Exp $
2 .\"
3 .\" from: #Id: hesinfo.1,v 1.9 1996/11/07 01:57:12 ghudson Exp #
4 .\"
5 .\" Copyright 1987, 1996 by the Massachusetts Institute of Technology.
6 .\"
7 .\" Permission to use, copy, modify, and distribute this
8 .\" software and its documentation for any purpose and without
9 .\" fee is hereby granted, provided that the above copyright
10 .\" notice appear in all copies and that both that copyright
11 .\" notice and this permission notice appear in supporting
12 .\" documentation, and that the name of M.I.T. not be used in
13 .\" advertising or publicity pertaining to distribution of the
14 .\" software without specific, written prior permission.
15 .\" M.I.T. makes no representations about the suitability of
16 .\" this software for any purpose.  It is provided "as is"
17 .\" without express or implied warranty.
18 .Dd October 27, 1996
19 .Dt HESINFO 1
20 .Os
21 .Sh NAME
22 .Nm hesinfo
23 .Nd find out what is stored in the Hesiod database
24 .Sh SYNOPSIS
25 .Nm
26 .Op Fl bl
27 .Ar HesiodName
28 .Ar HesiodNameType
29 .Sh DESCRIPTION
30 .Nm
31 takes two arguments, a name to be resolved and a string, known
32 as a
33 .Ar HesiodNameType .
34 It then prints the information returned by
35 the Hesiod nameserver.
36 .Pp
37 The value returned by
38 .Nm
39 is of the type
40 .Ar HesiodNameType .
41 .Pp
42 .Nm
43 understands the following options:
44 .Bl -tag -width XX -offset indent
45 .It Fl l
46 Selects long format.
47 .It Fl b
48 Prints the fully-qualified string passed to the nameserver.
49 .El
50 .Ss VALID Hesiod_Names
51 The following types of identifiers may be used in the
52 .Ar HesiodName
53 argument to
54 .Nm .
55 These values will be resolved by accessing the
56 .Xr hesiod 3
57 database.
58 .Bl -tag -width XnfsXserverX:XpartitionXX
59 .It Aq username
60 the 8-character-or-less string used to identify users or classes
61 (e.g. joeuser, root, 1.00, etc).
62 Used with the
63 .Ar Hesiod_Name_Types
64 .Dv passwd ,
65 .Dv pobox ,
66 and
67 .Dv filsys .
68 .It Aq uid
69 the id number assigned to a user.
70 .It Aq groupid
71 the id number assigned to a group.
72 .It Aq groupname
73 a name identifying a unique group.
74 .It Aq file-system-name
75 the name of an athena file system.
76 .It Ao rvd server Ac Ns : Ns Aq pack
77 the name of an rvd's server and pack separated by a colon.
78 .It Ao nfs server Ac Ns : Ns Aq partition
79 the name of an nfs server and its partition separated by a colon.
80 .It Aq workstation-name
81 the machine name of an Athena workstation (e.g. E40-343-3).
82 .It Aq service-name
83 name of an Athena service (e.g. Zephyr).
84 .It Aq service-type
85 name of Unix service (valid entries are defined in
86 .Pa /etc/services ) .
87 .It Aq printer-name
88 name of a printer.
89 .It Aq printer-cluster-name
90 name of an Athena print cluster.
91 .It Aq foo
92 some
93 .Nm
94 calls (e.g.,
95 .Dv prclusterlist )
96 do not require a specific
97 .Ar HesiodName
98 argument.
99 However, you must include a dummy string (e.g.,
100 .Dq foo )
103 to work properly.
105 .Ss VALID Hesiod_Name_Types
106 The following symbols are valid substitutions for the
107 .Ar HesiodNameType
108 argument to
109 .Nm .
110 .Bl -tag -width passwdX
111 .It passwd
112 returns string suitable for inclusion in
113 .Pa /etc/passwd ,
114 searching with
115 .Aq username .
116 .It pobox
117 returns information on the pobox assigned to the user specified by
118 .Ar HesiodName ,
119 searching with
120 .Aq username .
121 .It uid
122 returns string suitable for inclusion in
123 .Pa /etc/passwd ,
124 searching with
125 .Aq uid .
126 .It gid
127 returns string suitable for inclusion in
128 .Pa /etc/group ,
129 searching with
130 .Aq groupid .
131 .It group
132 returns string suitable for inclusion in
133 .Pa /etc/group ,
134 searching with
135 .Aq groupname .
136 .It grplist
137 returns subgroups included in superset defined by
138 .Aq groupname .
139 .It filsys
140 returns file system type, export point, server, mount mode, and
141 import point for the following valid
142 .Ar HesiodNames
143 (see above) -
144 .Aq Dv file system name ,
145 .Aq Dv username ,
146 .Ao Dv rvd server Ac Ns : Ns Aq pack ,
148 .Ao Dv nfs server Ac Ns : Ns Aq partition .
149 .It cluster
150 returns information about the local cluster the workstation, specified by
151 .Aq workstation name .
152 Included is information about the local file and print servers.
153 This information is accesses by
154 .Dv clusterinfo
155 at boot time.
156 .It sloc
157 returns network name of service host for
158 .Aq service-name .
159 .It service
160 returns Internet protocol type and protocol service port for
161 .Aq service-type .
162 .It pcap
163 returns a valid entry for
164 .Pa /etc/printcap
166 .Aq printer-name .
167 .It prcluserlist
168 returns a list of print clusters.
169 .It prcluster
170 returns a list of printers in a cluster specified by
171 .Aq printer-cluster-name .
173 .Sh FILES
174 .Pa /etc/hesiod.conf
175 .Sh SEE ALSO
176 .Xr hesiod 3 ,
177 .Xr named 8
179 .%T Hesiod - Project Athena Technical Plan -- Name Service
181 .Sh AUTHORS
182 .An Steve Dyer ,
183 IBM/Project Athena
185 Copyright 1987, 1988, 1996 by the Massachusetts Institute of Technology.