merging some changes from SAMBA_2_2
[ira/wip.git] / docs / manpages / wbinfo.1
1 .\" This manpage has been automatically generated by docbook2man-spec
2 .\" from a DocBook document.  docbook2man-spec can be found at:
3 .\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> 
4 .\" Please send any bug reports, improvements, comments, patches, 
5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
6 .TH "WBINFO" "1" "08 May 2002" "" ""
7 .SH NAME
8 wbinfo \- Query information from winbind daemon
9 .SH SYNOPSIS
10 .sp
11 \fBwbinfo\fR [ \fB-u\fR ]  [ \fB-g\fR ]  [ \fB-h name\fR ]  [ \fB-i ip\fR ]  [ \fB-n name\fR ]  [ \fB-s sid\fR ]  [ \fB-U uid\fR ]  [ \fB-G gid\fR ]  [ \fB-S sid\fR ]  [ \fB-Y sid\fR ]  [ \fB-t\fR ]  [ \fB-m\fR ]  [ \fB-r user\fR ]  [ \fB-a user%password\fR ]  [ \fB-A user%password\fR ] 
12 .SH "DESCRIPTION"
13 .PP
14 This tool is part of the  Sambasuite.
15 .PP
16 The \fBwbinfo\fR program queries and returns information 
17 created and used by the \fB winbindd(8)\fRdaemon. 
18 .PP
19 The \fBwinbindd(8)\fR daemon must be configured 
20 and running for the \fBwbinfo\fR program to be able 
21 to return information.
22 .SH "OPTIONS"
23 .TP
24 \fB-u\fR
25 This option will list all users available 
26 in the Windows NT domain for which the \fBwinbindd(8)
27 \fRdaemon is operating in. Users in all trusted domains 
28 will also be listed. Note that this operation does not assign 
29 user ids to any users that have not already been seen by 
30 \fBwinbindd(8)\fR.
31 .TP
32 \fB-g\fR
33 This option will list all groups available 
34 in the Windows NT domain for which the \fBwinbindd(8)
35 \fRdaemon is operating in. Groups in all trusted domains
36 will also be listed. Note that this operation does not assign 
37 group ids to any groups that have not already been seen by
38 \fBwinbindd(8)\fR. 
39 .TP
40 \fB-h name\fR
41 The \fI-h\fR option 
42 queries \fBwinbindd(8)\fR to query the WINS
43 server for the IP address associated with the NetBIOS name
44 specified by the \fIname\fR parameter.
45 .TP
46 \fB-i ip\fR
47 The \fI-i\fR option 
48 queries \fBwinbindd(8)\fR to send a node status
49 request to get the NetBIOS name associated with the IP address
50 specified by the \fIip\fR parameter.
51 .TP
52 \fB-n name\fR
53 The \fI-n\fR option 
54 queries \fBwinbindd(8)\fR for the SID 
55 associated with the name specified. Domain names can be specified 
56 before the user name by using the winbind separator character. 
57 For example CWDOM1/Administrator refers to the Administrator
58 user in the domain CWDOM1. If no domain is specified then the 
59 domain used is the one specified in the \fIsmb.conf\fR
60 \fIworkgroup\fR parameter. 
61 .TP
62 \fB-s sid\fR
63 Use \fI-s\fR to resolve
64 a SID to a name. This is the inverse of the \fI-n
65 \fRoption above. SIDs must be specified as ASCII strings 
66 in the traditional Microsoft format. For example,
67 S-1-5-21-1455342024-3071081365-2475485837-500. 
68 .TP
69 \fB-U uid\fR
70 Try to convert a UNIX user id to a Windows NT 
71 SID. If the uid specified does not refer to one within
72 the winbind uid range then the operation will fail. 
73 .TP
74 \fB-G gid\fR
75 Try to convert a UNIX group id to a Windows 
76 NT SID. If the gid specified does not refer to one within 
77 the winbind gid range then the operation will fail. 
78 .TP
79 \fB-S sid\fR
80 Convert a SID to a UNIX user id. If the SID 
81 does not correspond to a UNIX user mapped by \fB winbindd(8)\fR then the operation will fail. 
82 .TP
83 \fB-Y sid\fR
84 Convert a SID to a UNIX group id. If the SID 
85 does not correspond to a UNIX group mapped by \fB winbindd(8)\fR then the operation will fail. 
86 .TP
87 \fB-t\fR
88 Verify that the workstation trust account 
89 created when the Samba server is added to the Windows NT
90 domain is working. 
91 .TP
92 \fB-m\fR
93 Produce a list of domains trusted by the 
94 Windows NT server \fBwinbindd(8)\fR contacts 
95 when resolving names. This list does not include the Windows 
96 NT domain the server is a Primary Domain Controller for.
97 .TP
98 \fB-r username\fR
99 Try to obtain the list of UNIX group ids
100 to which the user belongs. This only works for users
101 defined on a Domain Controller.
102 .TP
103 \fB-a username%password\fR
104 Attempt to authenticate a user via winbindd. 
105 This checks both authenticaion methods and reports its results.
106 .TP
107 \fB-A username%password\fR
108 Store username and password used by winbindd 
109 during session setup to a domain controller. This enables
110 winbindd to operate in a Windows 2000 domain with Restrict
111 Anonymous turned on (a.k.a. Permissions compatiable with
112 Windows 2000 servers only).
113 .SH "EXIT STATUS"
114 .PP
115 The wbinfo program returns 0 if the operation 
116 succeeded, or 1 if the operation failed. If the \fBwinbindd(8)
117 \fRdaemon is not working \fBwbinfo\fR will always return 
118 failure. 
119 .SH "VERSION"
120 .PP
121 This man page is correct for version 2.2 of 
122 the Samba suite.
123 .SH "SEE ALSO"
124 .PP
125 \fBwinbindd(8)\fR
126
127 .SH "AUTHOR"
128 .PP
129 The original Samba software and related utilities 
130 were created by Andrew Tridgell. Samba is now developed
131 by the Samba Team as an Open Source project similar 
132 to the way the Linux kernel is developed.
133 .PP
134 \fBwbinfo\fR and \fBwinbindd\fR
135 were written by Tim Potter.
136 .PP
137 The conversion to DocBook for Samba 2.2 was done 
138 by Gerald Carter