xref: /freebsd/usr.bin/hesinfo/hesinfo.1 (revision 7899f917b1c0ea178f1d2be0cfb452086d079d23)
1.\"	$NetBSD: hesinfo.1,v 1.1 1999/01/25 22:45:55 lukem 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.\"
19.Dd June 27, 2022
20.Dt HESINFO 1
21.Os
22.Sh NAME
23.Nm hesinfo
24.Nd "find out what is stored in the Hesiod database"
25.Sh SYNOPSIS
26.Nm
27.Op Fl bl
28.Ar HesiodName HesiodNameType
29.Sh DESCRIPTION
30The
31.Nm
32utility takes two arguments, a name to be resolved and a string, known
33as a
34.Ar HesiodNameType .
35It then prints the information returned by
36the Hesiod nameserver.
37.Pp
38The value returned by
39.Nm
40is of the type
41.Ar HesiodNameType .
42.Pp
43The following options are available:
44.Bl -tag -width indent
45.It Fl l
46Selects long format.
47.It Fl b
48Prints the fully\-qualified string passed to the nameserver.
49.El
50.Ss VALID Hesiod_Names
51The following types of identifiers may be used in the
52.Ar HesiodName
53argument to
54.Nm .
55These values will be resolved by accessing the
56.Xr hesiod 3
57database.
58.Bl -tag -width indent
59.It Aq Ar username
60the 8\-character\-or\-less string used to identify users or classes
61(e.g.\& joeuser, root, 1.00, etc).
62Used with the
63.Ar Hesiod_Name_Types
64.Cm passwd ,
65.Cm pobox ,
66and
67.Cm filsys .
68.It Aq Ar uid
69the id number assigned to a user.
70.It Aq Ar groupid
71the id number assigned to a group.
72.It Aq Ar groupname
73a name identifying a unique group.
74.It Aq Ar file\-system\-name
75the name of an Athena file system.
76.It Xo
77.Ao Ar "rvd\-server" Ac : Ns Aq Ar pack
78.Xc
79the name of an rvd's server and pack separated by a colon.
80.It Xo
81.Ao Ar "nfs\-server" Ac : Ns Aq Ar partition
82.Xc
83the name of an
84.Tn NFS
85server and its partition separated by a colon.
86.It Aq Ar workstation\-name
87the machine name of an Athena workstation (e.g.\& E40\-343\-3).
88.It Aq Ar service\-name
89name of an Athena service (e.g.\& Zephyr).
90.It Aq Ar service\-type
91name of
92.Ux
93service (valid entries are defined in
94.Pa /etc/services ) .
95.It Aq Ar printer\-name
96name of a printer.
97.It Aq Ar printer\-cluster\-name
98name of an Athena print cluster.
99.It Aq Ar foo
100some
101.Nm
102calls (e.g.\&
103.Cm prclusterlist )
104do not require a specific
105.Ar HesiodName
106argument.
107However, you must include a dummy string (e.g.\&
108.Ql foo )
109for
110.Nm
111to work properly.
112.El
113.Ss VALID Hesiod_Name_Types
114The following symbols are valid substitutions for the
115.Ar HesiodNameType
116argument to
117.Nm .
118.Bl -tag -width indent
119.It Cm passwd
120returns string suitable for inclusion in
121.Pa /etc/passwd ,
122searching with
123.Aq Ar username .
124.It Cm pobox
125returns information on the pobox assigned to the user specified by
126.Ar HesiodName ,
127searching with
128.Aq Ar username .
129.It Cm uid
130returns string suitable for inclusion in
131.Pa /etc/passwd ,
132searching with
133.Aq Ar uid .
134.It Cm gid
135returns string suitable for inclusion in
136.Pa /etc/group ,
137searching with
138.Aq Ar groupid .
139.It Cm group
140returns string suitable for inclusion in
141.Pa /etc/group ,
142searching with
143.Aq Ar groupname .
144.It Cm grplist
145returns subgroups included in superset
146defined by
147.Aq Ar groupname .
148.It Cm filsys
149returns file system type, export point, server, mount mode, and import point
150for the following valid
151.Ar HesiodNames
152(see above) -
153.Aq Ar "file\-system\-name" ,
154.Aq Ar username ,
155.Ao Ar "rvd\-server" Ac : Ns Aq Ar pack ,
156and
157.Ao Ar "nfs\-server" Ac : Ns Aq Ar partition .
158.It Cm cluster
159returns information about the local cluster the workstation, specified by
160.Aq Ar "workstation\-name" .
161Included is information about the local file and print servers.
162This information is accesses by
163.Sy clusterinfo
164at boot time.
165.It Cm sloc
166returns network name of service host for
167.Aq Ar service\-name .
168.It Cm service
169returns Internet protocol type and protocol service port for
170.Aq Ar service\-type .
171.It Cm pcap
172returns a valid entry for
173.Pa /etc/printcap
174for
175.Aq Ar printer\-name .
176.It Cm prcluserlist
177returns a list of print clusters.
178.It Cm prcluster
179returns a list of printers in a cluster specified by
180.Aq Ar printer\-cluster\-name .
181.El
182.Sh FILES
183.Bl -tag -width /etc/hesiod.conf
184.It Pa /etc/hesiod.conf
185.El
186.Sh SEE ALSO
187.Xr hesiod 3
188.Rs
189.%T "Hesiod - Project Athena Technical Plan -- Name Service"
190.Re
191.Sh AUTHORS
192.An Steve Dyer ,
193IBM/Project Athena
194.Pp
195Copyright 1987, 1988, 1996 by the Massachusetts Institute of Technology.
196