Ignore:
Timestamp:
May 27, 2009, 9:08:03 AM (16 years ago)
Author:
Herwig Bauernfeind
Message:

Update 3.2 branch to 3.2.8 docs

File:
1 edited

Legend:

Unmodified
Added
Removed
  • branches/samba-3.2.x/docs/manpages/wbinfo.1

    r229 r231  
    11.\"     Title: wbinfo
    2 .\"    Author:
    3 .\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
    4 .\"      Date: 12/19/2008
     2.\"    Author: [see the "AUTHOR" section]
     3.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
     4.\"      Date: 02/03/2009
    55.\"    Manual: User Commands
    66.\"    Source: Samba 3.2
     7.\"  Language: English
    78.\"
    8 .TH "WBINFO" "1" "12/19/2008" "Samba 3\.2" "User Commands"
     9.TH "WBINFO" "1" "02/03/2009" "Samba 3\&.2" "User Commands"
     10.\" -----------------------------------------------------------------
     11.\" * (re)Define some macros
     12.\" -----------------------------------------------------------------
     13.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     14.\" toupper - uppercase a string (locale-aware)
     15.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     16.de toupper
     17.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
     18\\$*
     19.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
     20..
     21.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     22.\" SH-xref - format a cross-reference to an SH section
     23.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     24.de SH-xref
     25.ie n \{\
     26.\}
     27.toupper \\$*
     28.el \{\
     29\\$*
     30.\}
     31..
     32.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     33.\" SH - level-one heading that works better for non-TTY output
     34.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     35.de1 SH
     36.\" put an extra blank line of space above the head in non-TTY output
     37.if t \{\
     38.sp 1
     39.\}
     40.sp \\n[PD]u
     41.nr an-level 1
     42.set-an-margin
     43.nr an-prevailing-indent \\n[IN]
     44.fi
     45.in \\n[an-margin]u
     46.ti 0
     47.HTML-TAG ".NH \\n[an-level]"
     48.it 1 an-trap
     49.nr an-no-space-flag 1
     50.nr an-break-flag 1
     51\." make the size of the head bigger
     52.ps +3
     53.ft B
     54.ne (2v + 1u)
     55.ie n \{\
     56.\" if n (TTY output), use uppercase
     57.toupper \\$*
     58.\}
     59.el \{\
     60.nr an-break-flag 0
     61.\" if not n (not TTY), use normal case (not uppercase)
     62\\$1
     63.in \\n[an-margin]u
     64.ti 0
     65.\" if not n (not TTY), put a border/line under subheading
     66.sp -.6
     67\l'\n(.lu'
     68.\}
     69..
     70.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     71.\" SS - level-two heading that works better for non-TTY output
     72.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     73.de1 SS
     74.sp \\n[PD]u
     75.nr an-level 1
     76.set-an-margin
     77.nr an-prevailing-indent \\n[IN]
     78.fi
     79.in \\n[IN]u
     80.ti \\n[SN]u
     81.it 1 an-trap
     82.nr an-no-space-flag 1
     83.nr an-break-flag 1
     84.ps \\n[PS-SS]u
     85\." make the size of the head bigger
     86.ps +2
     87.ft B
     88.ne (2v + 1u)
     89.if \\n[.$] \&\\$*
     90..
     91.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     92.\" BB/BE - put background/screen (filled box) around block of text
     93.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     94.de BB
     95.if t \{\
     96.sp -.5
     97.br
     98.in +2n
     99.ll -2n
     100.gcolor red
     101.di BX
     102.\}
     103..
     104.de EB
     105.if t \{\
     106.if "\\$2"adjust-for-leading-newline" \{\
     107.sp -1
     108.\}
     109.br
     110.di
     111.in
     112.ll
     113.gcolor
     114.nr BW \\n(.lu-\\n(.i
     115.nr BH \\n(dn+.5v
     116.ne \\n(BHu+.5v
     117.ie "\\$2"adjust-for-leading-newline" \{\
     118\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
     119.\}
     120.el \{\
     121\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
     122.\}
     123.in 0
     124.sp -.5v
     125.nf
     126.BX
     127.in
     128.sp .5v
     129.fi
     130.\}
     131..
     132.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     133.\" BM/EM - put colored marker in margin next to block of text
     134.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     135.de BM
     136.if t \{\
     137.br
     138.ll -2n
     139.gcolor red
     140.di BX
     141.\}
     142..
     143.de EM
     144.if t \{\
     145.br
     146.di
     147.ll
     148.gcolor
     149.nr BH \\n(dn
     150.ne \\n(BHu
     151\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
     152.in 0
     153.nf
     154.BX
     155.in
     156.fi
     157.\}
     158..
     159.\" -----------------------------------------------------------------
     160.\" * set default formatting
     161.\" -----------------------------------------------------------------
    9162.\" disable hyphenation
    10163.nh
    11164.\" disable justification (adjust text to left margin only)
    12165.ad l
    13 .SH "NAME"
    14 wbinfo - Query information from winbind daemon
    15 .SH "SYNOPSIS"
    16 .HP 1
    17 wbinfo [\-a\ user%password] [\-\-all\-domains] [\-\-allocate\-gid] [\-\-allocate\-uid] [\-D\ domain] [\-\-domain\ domain] [\-g] [\-\-getdcname\ domain] [\-\-get\-auth\-user] [\-G\ gid] [\-h] [\-i\ user] [\-I\ ip] [\-K\ user%password] [\-m] [\-n\ name] [\-N\ netbios\-name] [\-\-own\-domain] [\-p] [\-r\ user] [\-s\ sid] [\-\-separator] [\-\-sequence] [\-\-set\-auth\-user\ user%password] [\-S\ sid] [\-t] [\-u] [\-\-uid\-info\ uid] [\-\-user\-domgroups\ sid] [\-\-user\-sids\ sid] [\-U\ uid] [\-V] [\-Y\ sid] [\-\-verbose]
     166.\" -----------------------------------------------------------------
     167.\" * MAIN CONTENT STARTS HERE *
     168.\" -----------------------------------------------------------------
     169.SH "Name"
     170wbinfo \- Query information from winbind daemon
     171.SH "Synopsis"
     172.fam C
     173.HP \w'\ 'u
     174\FCwbinfo\F[] [\-a\ user%password] [\-\-all\-domains] [\-\-allocate\-gid] [\-\-allocate\-uid] [\-D\ domain] [\-\-domain\ domain] [\-g] [\-\-getdcname\ domain] [\-\-get\-auth\-user] [\-G\ gid] [\-h] [\-i\ user] [\-I\ ip] [\-K\ user%password] [\-m] [\-n\ name] [\-N\ netbios\-name] [\-\-own\-domain] [\-p] [\-r\ user] [\-s\ sid] [\-\-separator] [\-\-sequence] [\-\-set\-auth\-user\ user%password] [\-S\ sid] [\-t] [\-u] [\-\-uid\-info\ uid] [\-\-user\-domgroups\ sid] [\-\-user\-sids\ sid] [\-U\ uid] [\-V] [\-Y\ sid] [\-\-verbose]
     175.fam
    18176.SH "DESCRIPTION"
    19177.PP
    20178This tool is part of the
    21179\fBsamba\fR(7)
    22 suite\.
     180suite\&.
    23181.PP
    24182The
    25 wbinfo
     183\FCwbinfo\F[]
    26184program queries and returns information created and used by the
    27185\fBwinbindd\fR(8)
    28 daemon\.
     186daemon\&.
    29187.PP
    30188The
    31189\fBwinbindd\fR(8)
    32190daemon must be configured and running for the
    33 wbinfo
    34 program to be able to return information\.
     191\FCwbinfo\F[]
     192program to be able to return information\&.
    35193.SH "OPTIONS"
    36194.PP
    37195\-a|\-\-authenticate username%password
    38196.RS 4
    39 Attempt to authenticate a user via winbindd\. This checks both authenticaion methods and reports its results\.
     197Attempt to authenticate a user via winbindd\&. This checks both authenticaion methods and reports its results\&.
     198.if n \{\
    40199.sp
     200.\}
     201.RS 4
     202.BM yellow
    41203.it 1 an-trap
    42204.nr an-no-space-flag 1
    43205.nr an-break-flag 1
    44206.br
    45 Note
    46 Do not be tempted to use this functionality for authentication in third\-party applications\. Instead use
    47 \fBntlm_auth\fR(1)\.
     207.ps +1
     208\fBNote\fR
     209.ps -1
     210.br
     211Do not be tempted to use this functionality for authentication in third\-party applications\&. Instead use
     212\fBntlm_auth\fR(1)\&.
     213.sp .5v
     214.EM yellow
     215.RE
    48216.RE
    49217.PP
     
    60228\-\-all\-domains
    61229.RS 4
    62 List all domains (trusted and own domain)\.
     230List all domains (trusted and own domain)\&.
    63231.RE
    64232.PP
    65233\-\-domain name
    66234.RS 4
    67 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
     235This 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
    68236\fB\-\-sequence\fR,
    69237\fB\-u\fR, and
    70238\fB\-g\fR
    71 options honor this parameter\.
     239options honor this parameter\&.
    72240.RE
    73241.PP
    74242\-D|\-\-domain\-info domain
    75243.RS 4
    76 Show most of the info we have about the domain\.
     244Show most of the info we have about the domain\&.
    77245.RE
    78246.PP
     
    81249This option will list all groups available in the Windows NT domain for which the
    82250\fBsamba\fR(7)
    83 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
    84 \fBwinbindd\fR(8)\.
     251daemon 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
     252\fBwinbindd\fR(8)\&.
    85253.RE
    86254.PP
    87255\-\-get\-auth\-user
    88256.RS 4
    89 Print username and password used by winbindd during session setup to a domain controller\. Username and password can be set using
    90 \fB\-\-set\-auth\-user\fR\. Only available for root\.
     257Print username and password used by winbindd during session setup to a domain controller\&. Username and password can be set using
     258\fB\-\-set\-auth\-user\fR\&. Only available for root\&.
    91259.RE
    92260.PP
    93261\-\-getdcname domain
    94262.RS 4
    95 Get the DC name for the specified domain\.
     263Get the DC name for the specified domain\&.
    96264.RE
    97265.PP
    98266\-G|\-\-gid\-to\-sid gid
    99267.RS 4
    100 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\.
     268Try 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\&.
    101269.RE
    102270.PP
    103271\-i|\-\-user\-info user
    104272.RS 4
    105 Get user info\.
     273Get user info\&.
    106274.RE
    107275.PP
     
    114282to send a node status request to get the NetBIOS name associated with the IP address specified by the
    115283\fIip\fR
    116 parameter\.
     284parameter\&.
    117285.RE
    118286.PP
    119287\-K|\-\-krb5auth username%password
    120288.RS 4
    121 Attempt to authenticate a user via Kerberos\.
     289Attempt to authenticate a user via Kerberos\&.
    122290.RE
    123291.PP
     
    126294Produce a list of domains trusted by the Windows NT server
    127295\fBwinbindd\fR(8)
    128 contacts when resolving names\. This list does not include the Windows NT domain the server is a Primary Domain Controller for\.
     296contacts when resolving names\&. This list does not include the Windows NT domain the server is a Primary Domain Controller for\&.
    129297.RE
    130298.PP
     
    135303option queries
    136304\fBwinbindd\fR(8)
    137 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
     305for 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
    138306\fBsmb.conf\fR(5)
    139307\fIworkgroup \fR
    140 parameter\.
     308parameter\&.
    141309.RE
    142310.PP
     
    149317to query the WINS server for the IP address associated with the NetBIOS name specified by the
    150318\fIname\fR
    151 parameter\.
     319parameter\&.
    152320.RE
    153321.PP
    154322\-\-own\-domain
    155323.RS 4
    156 List own domain\.
     324List own domain\&.
    157325.RE
    158326.PP
    159327\-p|\-\-ping
    160328.RS 4
    161 Check whether winbindd is still alive\. Prints out either \'succeeded\' or \'failed\'\.
     329Check whether winbindd is still alive\&. Prints out either \'succeeded\' or \'failed\'\&.
    162330.RE
    163331.PP
    164332\-r|\-\-user\-groups username
    165333.RS 4
    166 Try to obtain the list of UNIX group ids to which the user belongs\. This only works for users defined on a Domain Controller\.
     334Try to obtain the list of UNIX group ids to which the user belongs\&. This only works for users defined on a Domain Controller\&.
    167335.RE
    168336.PP
     
    171339Use
    172340\fI\-s\fR
    173 to resolve a SID to a name\. This is the inverse of the
     341to resolve a SID to a name\&. This is the inverse of the
    174342\fI\-n \fR
    175 option above\. SIDs must be specified as ASCII strings in the traditional Microsoft format\. For example, S\-1\-5\-21\-1455342024\-3071081365\-2475485837\-500\.
     343option above\&. SIDs must be specified as ASCII strings in the traditional Microsoft format\&. For example, S\-1\-5\-21\-1455342024\-3071081365\-2475485837\-500\&.
    176344.RE
    177345.PP
    178346\-\-separator
    179347.RS 4
    180 Get the active winbind separator\.
     348Get the active winbind separator\&.
    181349.RE
    182350.PP
     
    188356\-\-set\-auth\-user username%password
    189357.RS 4
    190 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 compatible with Windows 2000 servers only)\.
     358Store 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 compatible with Windows 2000 servers only)\&.
    191359.RE
    192360.PP
    193361\-S|\-\-sid\-to\-uid sid
    194362.RS 4
    195 Convert a SID to a UNIX user id\. If the SID does not correspond to a UNIX user mapped by
    196 \fBwinbindd\fR(8)
    197 then the operation will fail\.
     363Convert a SID to a UNIX user id\&. If the SID does not correspond to a UNIX user mapped by
     364\fBwinbindd\fR(8)
     365then the operation will fail\&.
    198366.RE
    199367.PP
    200368\-t|\-\-check\-secret
    201369.RS 4
    202 Verify that the workstation trust account created when the Samba server is added to the Windows NT domain is working\.
     370Verify that the workstation trust account created when the Samba server is added to the Windows NT domain is working\&.
    203371.RE
    204372.PP
     
    207375This option will list all users available in the Windows NT domain for which the
    208376\fBwinbindd\fR(8)
    209 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
    210 \fBwinbindd\fR(8)
    211 \.
     377daemon 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
     378\fBwinbindd\fR(8)
     379\&.
    212380.RE
    213381.PP
    214382\-\-uid\-info UID
    215383.RS 4
    216 Get user info for the user conencted to user id UID\.
     384Get user info for the user conencted to user id UID\&.
    217385.RE
    218386.PP
    219387\-\-user\-domgroups SID
    220388.RS 4
    221 Get user domain groups\.
     389Get user domain groups\&.
    222390.RE
    223391.PP
    224392\-\-user\-sids SID
    225393.RS 4
    226 Get user group SIDs for user\.
     394Get user group SIDs for user\&.
    227395.RE
    228396.PP
    229397\-U|\-\-uid\-to\-sid uid
    230398.RS 4
    231 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\.
     399Try 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\&.
    232400.RE
    233401.PP
    234402\-\-verbose
    235403.RS 4
    236 Print additional information about the query results\.
     404Print additional information about the query results\&.
    237405.RE
    238406.PP
    239407\-Y|\-\-sid\-to\-gid sid
    240408.RS 4
    241 Convert a SID to a UNIX group id\. If the SID does not correspond to a UNIX group mapped by
    242 \fBwinbindd\fR(8)
    243 then the operation will fail\.
     409Convert a SID to a UNIX group id\&. If the SID does not correspond to a UNIX group mapped by
     410\fBwinbindd\fR(8)
     411then the operation will fail\&.
    244412.RE
    245413.PP
    246414\-V
    247415.RS 4
    248 Prints the program version number\.
     416Prints the program version number\&.
    249417.RE
    250418.PP
    251419\-h|\-\-help
    252420.RS 4
    253 Print a summary of command line options\.
     421Print a summary of command line options\&.
    254422.RE
    255423.SH "EXIT STATUS"
    256424.PP
    257 The wbinfo program returns 0 if the operation succeeded, or 1 if the operation failed\. If the
     425The wbinfo program returns 0 if the operation succeeded, or 1 if the operation failed\&. If the
    258426\fBwinbindd\fR(8)
    259427daemon is not working
    260 wbinfo
    261 will always return failure\.
     428\FCwbinfo\F[]
     429will always return failure\&.
    262430.SH "VERSION"
    263431.PP
    264 This man page is correct for version 3 of the Samba suite\.
     432This man page is correct for version 3 of the Samba suite\&.
    265433.SH "SEE ALSO"
    266434.PP
     
    270438.SH "AUTHOR"
    271439.PP
    272 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\.
    273 .PP
    274 wbinfo
     440The 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\&.
     441.PP
     442\FCwbinfo\F[]
    275443and
    276 winbindd
    277 were written by Tim Potter\.
    278 .PP
    279 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\.
     444\FCwinbindd\F[]
     445were written by Tim Potter\&.
     446.PP
     447The 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\&.
Note: See TracChangeset for help on using the changeset viewer.