s3/service: convert lp_force_group() to const
[Samba.git] / docs-xml / smbdotconf / security / forcegroup.xml
blobb6e729be927b52b276ae0eeccb431b62f4b96aeb
1 <samba:parameter name="force group"
2                  context="S"
3                  type="string"
4                  constant="1"
5                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
6 <synonym>group</synonym>
7 <description>
8     <para>This specifies a UNIX group name that will be 
9     assigned as the default primary group for all users connecting 
10     to this service. This is useful for sharing files by ensuring 
11     that all access to files on service will use the named group for 
12     their permissions checking. Thus, by assigning permissions for this 
13     group to the files and directories within this service the Samba 
14     administrator can restrict or allow sharing of these files.</para>
16     <para>In Samba 2.0.5 and above this parameter has extended 
17     functionality in the following way. If the group name listed here 
18     has a '+' character prepended to it then the current user accessing 
19     the share only has the primary group default assigned to this group 
20     if they are already assigned as a member of that group. This allows 
21     an administrator to decide that only users who are already in a 
22     particular group will create files with group ownership set to that 
23     group. This gives a finer granularity of ownership assignment. For 
24     example, the setting <filename moreinfo="none">force group = +sys</filename> means 
25     that only users who are already in group sys will have their default
26     primary group assigned to sys when accessing this Samba share. All
27     other users will retain their ordinary primary group.</para>
29     <para>
30         If the <smbconfoption name="force user"/> parameter is also set the group specified in 
31     <parameter moreinfo="none">force group</parameter> will override the primary group
32     set in <parameter moreinfo="none">force user</parameter>.</para>
34 </description>
36 <related>force user</related>
38 <value type="default"/>
39 <value type="example">agroup</value>
40 </samba:parameter>