Initial import
[samba] / docs / manpages / wbinfo.1
diff --git a/docs/manpages/wbinfo.1 b/docs/manpages/wbinfo.1
new file mode 100644 (file)
index 0000000..a4d76b8
--- /dev/null
@@ -0,0 +1,183 @@
+.\"Generated by db2man.xsl. Don't modify this, modify the source.
+.de Sh \" Subsection
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Ip \" List item
+.br
+.ie \\n(.$>=3 .ne \\$3
+.el .ne 3
+.IP "\\$1" \\$2
+..
+.TH "WBINFO" 1 "" "" ""
+.SH NAME
+wbinfo \- Query information from winbind daemon
+.SH "SYNOPSIS"
+.ad l
+.hy 0
+.HP 7
+\fBwbinfo\fR [\-a\ user%password] [\-c\ username] [\-C\ groupname] [\-\-domain\ domain] [\-I\ ip] [\-s\ sid] [\-u] [\-U\ uid] [\-g] [\-\-get\-auth\-user] [\-G\ gid] [\-m] [\-n\ name] [\-N\ netbios\-name] [\-o\ user:group] [\-O\ user:group] [\-p] [\-r\ user] [\-\-set\-auth\-user\ user%password] [\-\-sequence] [\-S\ sid] [\-t] [\-x\ username] [\-X\ groupname] [\-Y\ sid]
+.ad
+.hy
+
+.SH "DESCRIPTION"
+
+.PP
+This tool is part of the \fBsamba\fR(7) suite\&.
+
+.PP
+The \fBwbinfo\fR program queries and returns information created and used by the \fBwinbindd\fR(8) daemon\&.
+
+.PP
+The \fBwinbindd\fR(8) daemon must be configured and running for the \fBwbinfo\fR program to be able to return information\&.
+
+.SH "OPTIONS"
+
+.TP
+\-a username%password
+Attempt to authenticate a user via winbindd\&. This checks both authenticaion methods and reports its results\&.
+
+.RS
+.Sh "Note"
+Do not be tempted to use this functionality for authentication in third\-party applications\&. Instead use \fBntlm_auth\fR(1)\&.
+
+.RE
+
+.TP
+\-c user
+Create a local winbind user\&.
+
+.TP
+\-C group
+Create a local winbindd group\&.
+
+.TP
+\-\-domain name
+This parameter sets the domain on which any specified operations will performed\&. If special domain name '\&.' is used to represent the current domain to which winbindd belongs\&. Currently only the\fB\-\-sequence\fR,\fB\-u\fR, and \fB\-g\fR options honor this parameter\&.
+
+.TP
+\-g
+This option will list all groups available in the Windows NT domain for which the \fBsamba\fR(7) daemon is operating in\&. Groups in all trusted domains will also be listed\&. Note that this operation does not assign group ids to any groups that have not already been seen by \fBwinbindd\fR(8)\&.
+
+.TP
+\-\-get\-auth\-user
+Print username and password used by winbindd during session setup to a domain controller\&. Username and password can be set using '\-A'\&. Only available for root\&.
+
+.TP
+\-G gid
+Try to convert a UNIX group id to a Windows NT SID\&. If the gid specified does not refer to one within the idmap gid range then the operation will fail\&.
+
+.TP
+\-I ip
+The \fI\-I\fR option queries \fBwinbindd\fR(8) to send a node status request to get the NetBIOS name associated with the IP address specified by the \fIip\fR parameter\&.
+
+.TP
+\-m
+Produce a list of domains trusted by the Windows NT server \fBwinbindd\fR(8) contacts when resolving names\&. This list does not include the Windows NT domain the server is a Primary Domain Controller for\&.
+
+.TP
+\-n name
+The \fI\-n\fR option queries \fBwinbindd\fR(8) for the SID associated with the name specified\&. Domain names can be specified before the user name by using the winbind separator character\&. For example CWDOM1/Administrator refers to the Administrator user in the domain CWDOM1\&. If no domain is specified then the domain used is the one specified in the \fBsmb\&.conf\fR(5)\fIworkgroup \fR parameter\&.
+
+.TP
+\-N name
+The \fI\-N\fR option queries \fBwinbindd\fR(8) to query the WINS server for the IP address associated with the NetBIOS name specified by the \fIname\fR parameter\&.
+
+.TP
+\-o user:group
+Add a winbindd local group as a secondary group for the specified winbindd local user\&.
+
+.TP
+\-O user:group
+Remove a winbindd local group as a secondary group for the specified winbindd local user\&.
+
+.TP
+\-p
+Check whether winbindd is still alive\&. Prints out either 'succeeded' or 'failed'\&.
+
+.TP
+\-r username
+Try to obtain the list of UNIX group ids to which the user belongs\&. This only works for users defined on a Domain Controller\&.
+
+.TP
+\-s sid
+Use \fI\-s\fR to resolve a SID to a name\&. This is the inverse of the \fI\-n \fR option above\&. SIDs must be specified as ASCII strings in the traditional Microsoft format\&. For example, S\-1\-5\-21\-1455342024\-3071081365\-2475485837\-500\&.
+
+.TP
+\-\-set\-auth\-user username%password
+Store username and password used by winbindd during session setup to a domain controller\&. This enables winbindd to operate in a Windows 2000 domain with Restrict Anonymous turned on (a\&.k\&.a\&. Permissions compatiable with Windows 2000 servers only)\&.
+
+.TP
+\-\-sequence
+Show sequence numbers of all known domains
+
+.TP
+\-S sid
+Convert a SID to a UNIX user id\&. If the SID does not correspond to a UNIX user mapped by \fBwinbindd\fR(8) then the operation will fail\&.
+
+.TP
+\-t
+Verify that the workstation trust account created when the Samba server is added to the Windows NT domain is working\&.
+
+.TP
+\-u
+This option will list all users available in the Windows NT domain for which the \fBwinbindd\fR(8) daemon is operating in\&. Users in all trusted domains will also be listed\&. Note that this operation does not assign user ids to any users that have not already been seen by \fBwinbindd\fR(8) \&.
+
+.TP
+\-U uid
+Try to convert a UNIX user id to a Windows NT SID\&. If the uid specified does not refer to one within the idmap uid range then the operation will fail\&.
+
+.TP
+\-x user
+Delete an existing local winbind user\&.
+
+.TP
+\-X group
+Delete an existing local winbindd group\&.
+
+.TP
+\-Y sid
+Convert a SID to a UNIX group id\&. If the SID does not correspond to a UNIX group mapped by \fBwinbindd\fR(8) then the operation will fail\&.
+
+.TP
+\-V
+Prints the program version number\&.
+
+.TP
+\-h|\-\-help
+Print a summary of command line options\&.
+
+.SH "EXIT STATUS"
+
+.PP
+The wbinfo program returns 0 if the operation succeeded, or 1 if the operation failed\&. If the \fBwinbindd\fR(8) daemon is not working \fBwbinfo\fR will always return failure\&.
+
+.SH "VERSION"
+
+.PP
+This man page is correct for version 3\&.0 of the Samba suite\&.
+
+.SH "SEE ALSO"
+
+.PP
+\fBwinbindd\fR(8) and \fBntlm_auth\fR(1)
+
+.SH "AUTHOR"
+
+.PP
+The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&.
+
+.PP
+\fBwbinfo\fR and \fBwinbindd\fR were written by Tim Potter\&.
+
+.PP
+The conversion to DocBook for Samba 2\&.2 was done by Gerald Carter\&. The conversion to DocBook XML 4\&.2 for Samba 3\&.0 was done by Alexander Bokovoy\&.
+