merge from HEAD
[garming/samba-autobuild/.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" "01 October 2002" "" ""
7 .SH NAME
8 smbgroupedit \- Query/set/change UNIX - Windows NT group mapping
9 .SH SYNOPSIS
10
11 \fBsmbroupedit\fR [ \fB-v [l|s]\fR ] [ \fB-a UNIX-groupname [-d NT-groupname|-p privilege|]\fR ]
12
13 .SH "DESCRIPTION"
14 .PP
15 This program is part of the Samba
16 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 examples,
43
44
45 .nf
46 Users
47     SID       : S-1-5-32-545
48     Unix group: -1
49     Group type: Local group
50     Comment   :
51     Privilege : No privilege
52 .fi
53 .TP
54 \fB-s\fR
55 display a short listing of the format:
56
57
58 .nf
59 NTGroupName(SID) -> UnixGroupName
60 .fi
61
62 For example,
63
64
65 .nf
66 Users (S-1-5-32-545) -> -1
67 .fi
68 .RE
69 .SH "FILES"
70 .PP
71 .SH "EXIT STATUS"
72 .PP
73 \fBsmbgroupedit\fR returns a status of 0 if the
74 operation completed successfully, and a value of 1 in the event
75 of a failure.
76 .SH "EXAMPLES"
77 .PP
78 To make a subset of your samba PDC users members of
79 the 'Domain Admins'  Global group:
80 .TP 3
81 1. 
82 create a unix group (usually in
83 \fI/etc/group\fR), let's call it domadm.
84 .TP 3
85 2. 
86 add to this group the users that you want to be
87 domain administrators. For example if you want joe, john and mary,
88 your entry in \fI/etc/group\fR will look like:
89
90 domadm:x:502:joe,john,mary
91 .TP 3
92 3. 
93 map this domadm group to the 'domain admins' group:
94 .RS
95 .TP 3
96 1. 
97 Get the SID for the Windows NT "Domain Admins"
98 group:
99
100
101 .nf
102 root# \fBsmbgroupedit -vs | grep "Domain Admins"\fR
103 Domain Admins (S-1-5-21-1108995562-3116817432-1375597819-512) -> -1
104 .fi
105 .TP 3
106 2. 
107 map the unix domadm group to the Windows NT
108 "Domain Admins" group, by running the command:
109
110
111 .nf
112 root# \fBsmbgroupedit \\
113 -c S-1-5-21-1108995562-3116817432-1375597819-512 \\
114 -u domadm\fR
115 .fi
116
117 \fBwarning:\fR don't copy and paste this sample, the
118 Domain Admins SID (the S-1-5-21-...-512) is different for every PDC.
119 .RE
120 .PP
121 To verify that your mapping has taken effect:
122 .PP
123
124 .nf
125 root# \fBsmbgroupedit -vs|grep "Domain Admins"\fR
126 Domain Admins (S-1-5-21-1108995562-3116817432-1375597819-512) -> domadm
127 .fi
128 .PP
129 To give access to a certain directory on a domain member machine (an
130 NT/W2K or a samba server running winbind) to some users who are member
131 of a group on your samba PDC, flag that group as a domain group:
132 .PP
133
134 .nf
135 root# \fBsmbgroupedit -a unixgroup -td\fR
136 .fi
137 .SH "VERSION"
138 .PP
139 This man page is correct for the 3.0alpha releases of
140 the Samba suite.
141 .SH "SEE ALSO"
142 .PP
143 smb.conf(5)
144 .SH "AUTHOR"
145 .PP
146 The original Samba software and related utilities
147 were created by Andrew Tridgell. Samba is now developed
148 by the Samba Team as an Open Source project similar
149 to the way the Linux kernel is developed.
150 .PP
151 \fBsmbgroupedit\fR was written by Jean Francois Micouleau.
152 The current set of manpages and documentation is maintained
153 by the Samba Team in the same fashion as the Samba source code.