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