Merge from Subversion r50.
[ira/wip.git] / docs / manpages / smbgroupedit.8
1 .\" This manpage has been automatically generated by docbook2man 
2 .\" from a DocBook document.  This tool can be found at:
3 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
4 .\" Please send any bug reports, improvements, comments, patches, 
5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
6 .TH "SMBGROUPEDIT" "8" "03 april 2003" "" ""
7
8 .SH NAME
9 smbgroupedit \- Query/set/change UNIX - Windows NT group mapping
10 .SH SYNOPSIS
11
12 \fBsmbroupedit\fR [ \fB-v [l|s]\fR ] [ \fB-a UNIX-groupname [-d NT-groupname|-p privilege|]\fR ]
13
14 .SH "DESCRIPTION"
15 .PP
16 This program is part of the \fBSamba\fR(7) suite.
17 .PP
18 The  smbgroupedit  command  allows for mapping unix groups
19 to NT Builtin, Domain, or Local groups.  Also
20 allows setting privileges for that group, such as saAddUser,
21 etc.
22 .SH "OPTIONS"
23 .TP
24 \fB-v[l|s]\fR
25 This option will list all groups available
26 in the Windows NT domain in which samba is operating.
27 .RS
28 .TP
29 \fB-l\fR
30 give a long listing, of the format:
31
32
33 .nf
34 "NT Group Name"
35     SID            :
36     Unix group     :
37     Group type     :
38     Comment        :
39     Privilege      :
40 .fi
41
42 For example:
43
44 .nf
45 Users
46     SID       : S-1-5-32-545
47     Unix group: -1
48     Group type: Local group
49     Comment   :
50     Privilege : No privilege
51 .fi
52 .TP
53 \fB-s\fR
54 display a short listing of the format:
55
56
57 .nf
58 NTGroupName(SID) -> UnixGroupName
59 .fi
60
61 For example:
62
63 .nf
64 Users (S-1-5-32-545) -> -1
65 .fi
66 .RE
67 .SH "FILES"
68 .PP
69 .SH "EXIT STATUS"
70 .PP
71 \fBsmbgroupedit\fR returns a status of 0 if the
72 operation completed successfully, and a value of 1 in the event
73 of a failure.
74 .SH "EXAMPLES"
75 .PP
76 To make a subset of your samba PDC users members of
77 the 'Domain Admins'  Global group:
78 .TP 3
79 1. 
80 create a unix group (usually in
81 \fI/etc/group\fR), let's call it domadm.
82 .TP 3
83 2. 
84 add to this group the users that you want to be
85 domain administrators. For example if you want joe, john and mary,
86 your entry in \fI/etc/group\fR will look like:
87
88 domadm:x:502:joe,john,mary
89 .TP 3
90 3. 
91 map this domadm group to the 'domain admins' group:
92 .RS
93 .TP 3
94 1. 
95 Get the SID for the Windows NT "Domain Admins" group:
96
97
98 .nf
99 root# \fBsmbgroupedit -vs | grep "Domain Admins"\fR
100 Domain Admins (S-1-5-21-1108995562-3116817432-1375597819-512) -> -1
101 .fi
102 .TP 3
103 2. 
104 map the unix domadm group to the Windows NT
105 "Domain Admins" group, by running the command:
106
107 .nf
108 root# \fBsmbgroupedit \\
109 -c S-1-5-21-1108995562-3116817432-1375597819-512 \\
110 -u domadm -td\fR
111 .fi
112
113 \fBwarning:\fR don't copy and paste this sample, the
114 Domain Admins SID (the S-1-5-21-...-512) is different for every PDC.
115 .RE
116 .PP
117 To verify that your mapping has taken effect:
118
119 .nf
120 root# \fBsmbgroupedit -vs|grep "Domain Admins"\fR
121 Domain Admins (S-1-5-21-1108995562-3116817432-1375597819-512) -> domadm
122 .fi
123 .PP
124 To give access to a certain directory on a domain member machine (an
125 NT/W2K or a samba server running winbind) to some users who are member
126 of a group on your samba PDC, flag that group as a domain group:
127
128 .nf
129 root# \fBsmbgroupedit -a unixgroup -td\fR
130 .fi
131 .SH "VERSION"
132 .PP
133 This man page is correct for the 3.0alpha releases of
134 the Samba suite.
135 .SH "SEE ALSO"
136 .PP
137 \fBsmb.conf\fR(5)
138 .SH "AUTHOR"
139 .PP
140 The original Samba software and related utilities
141 were created by Andrew Tridgell. Samba is now developed
142 by the Samba Team as an Open Source project similar
143 to the way the Linux kernel is developed.
144 .PP
145 \fBsmbgroupedit\fR was written by Jean Francois Micouleau.
146 The current set of manpages and documentation is maintained
147 by the Samba Team in the same fashion as the Samba source code. The conversion
148 to DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.