source: vendor/current/docs/manpages/sharesec.1@ 594

Last change on this file since 594 was 594, checked in by Herwig Bauernfeind, 14 years ago

Samba 3.5: Update vendor to version 3.5.8

File size: 7.5 KB
Line 
1'\" t
2.\" Title: sharesec
3.\" Author: [see the "AUTHOR" section]
4.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
5.\" Date: 03/06/2011
6.\" Manual: User Commands
7.\" Source: Samba 3.5
8.\" Language: English
9.\"
10.TH "SHARESEC" "1" "03/06/2011" "Samba 3\&.5" "User Commands"
11.\" -----------------------------------------------------------------
12.\" * set default formatting
13.\" -----------------------------------------------------------------
14.\" disable hyphenation
15.nh
16.\" disable justification (adjust text to left margin only)
17.ad l
18.\" -----------------------------------------------------------------
19.\" * MAIN CONTENT STARTS HERE *
20.\" -----------------------------------------------------------------
21.SH "NAME"
22sharesec \- Set or get share ACLs
23.SH "SYNOPSIS"
24.HP \w'\ 'u
25sharesec {sharename} [\-r,\ \-\-remove=ACL] [\-m,\ \-\-modify=ACL] [\-a,\ \-\-add=ACL] [\-R,\ \-\-replace=ACLs] [\-D,\ \-\-delete] [\-v,\ \-\-view] [\-M,\ \-\-machine\-sid] [\-F,\ \-\-force] [\-d,\ \-\-debuglevel=DEBUGLEVEL] [\-s,\ \-\-configfile=CONFIGFILE] [\-l,\ \-\-log\-basename=LOGFILEBASE] [\-V,\ \-\-version] [\-?,\ \-\-help] [\-\-usage]
26.SH "DESCRIPTION"
27.PP
28This tool is part of the
29\fBsamba\fR(7)
30suite\&.
31.PP
32The
33sharesec
34program manipulates share permissions on SMB file shares\&.
35.SH "OPTIONS"
36.PP
37The following options are available to the
38sharesec
39program\&. The format of ACLs is described in the section ACL FORMAT
40.PP
41\-a|\-\-add=ACL
42.RS 4
43Add the ACEs specified to the ACL list\&.
44.RE
45.PP
46\-D|\-\-delete
47.RS 4
48Delete the entire security descriptor\&.
49.RE
50.PP
51\-F|\-\-force
52.RS 4
53Force storing the ACL\&.
54.RE
55.PP
56\-m|\-\-modify=ACL
57.RS 4
58Modify existing ACEs\&.
59.RE
60.PP
61\-M|\-\-machine\-sid
62.RS 4
63Initialize the machine SID\&.
64.RE
65.PP
66\-r|\-\-remove=ACL
67.RS 4
68Remove ACEs\&.
69.RE
70.PP
71\-R|\-\-replace=ACLS
72.RS 4
73Overwrite an existing share permission ACL\&.
74.RE
75.PP
76\-h|\-\-help
77.RS 4
78Print a summary of command line options\&.
79.RE
80.PP
81\-d|\-\-debuglevel=level
82.RS 4
83\fIlevel\fR
84is an integer from 0 to 10\&. The default value if this parameter is not specified is 0\&.
85.sp
86The higher this value, the more detail will be logged to the log files about the activities of the server\&. At level 0, only critical errors and serious warnings will be logged\&. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\&.
87.sp
88Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\&. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\&.
89.sp
90Note that specifying this parameter here will override the
91\m[blue]\fB\%smb.conf.5.html#\fR\m[]
92parameter in the
93smb\&.conf
94file\&.
95.RE
96.PP
97\-V|\-\-version
98.RS 4
99Prints the program version number\&.
100.RE
101.PP
102\-s|\-\-configfile <configuration file>
103.RS 4
104The file specified contains the configuration details required by the server\&. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\&. See
105smb\&.conf
106for more information\&. The default configuration file name is determined at compile time\&.
107.RE
108.PP
109\-l|\-\-log\-basename=logdirectory
110.RS 4
111Base directory name for log/debug files\&. The extension
112\fB"\&.progname"\fR
113will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log file is never removed by the client\&.
114.RE
115.SH "ACL FORMAT"
116.PP
117The format of an ACL is one or more ACL entries separated by either commas or newlines\&. An ACL entry is one of the following:
118.PP
119.if n \{\
120.RS 4
121.\}
122.nf
123 REVISION:<revision number>
124 OWNER:<sid or name>
125 GROUP:<sid or name>
126 ACL:<sid or name>:<type>/<flags>/<mask>
127
128.fi
129.if n \{\
130.RE
131.\}
132.PP
133The revision of the ACL specifies the internal Windows NT ACL revision for the security descriptor\&. If not specified it defaults to 1\&. Using values other than 1 may cause strange behaviour\&.
134.PP
135The owner and group specify the owner and group SIDs for the object\&. If a SID in the format S\-1\-x\-y\-z is specified this is used, otherwise the name specified is resolved using the server on which the file or directory resides\&.
136.PP
137ACLs specify permissions granted to the SID\&. This SID can be specified in S\-1\-x\-y\-z format or as a name in which case it is resolved against the server on which the file or directory resides\&. The type, flags and mask values determine the type of access granted to the SID\&.
138.PP
139The type can be either ALLOWED or DENIED to allow/deny access to the SID\&. The flags values are generally zero for share ACLs\&.
140.PP
141The mask is a value which expresses the access right granted to the SID\&. It can be given as a decimal or hexadecimal value, or by using one of the following text strings which map to the NT file permissions of the same name\&.
142.sp
143.RS 4
144.ie n \{\
145\h'-04'\(bu\h'+03'\c
146.\}
147.el \{\
148.sp -1
149.IP \(bu 2.3
150.\}
151\fIR\fR
152\- Allow read access
153.RE
154.sp
155.RS 4
156.ie n \{\
157\h'-04'\(bu\h'+03'\c
158.\}
159.el \{\
160.sp -1
161.IP \(bu 2.3
162.\}
163\fIW\fR
164\- Allow write access
165.RE
166.sp
167.RS 4
168.ie n \{\
169\h'-04'\(bu\h'+03'\c
170.\}
171.el \{\
172.sp -1
173.IP \(bu 2.3
174.\}
175\fIX\fR
176\- Execute permission on the object
177.RE