summaryrefslogtreecommitdiff
path: root/docs/manpages/smbcacls.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/manpages/smbcacls.1')
-rw-r--r--docs/manpages/smbcacls.183
1 files changed, 40 insertions, 43 deletions
diff --git a/docs/manpages/smbcacls.1 b/docs/manpages/smbcacls.1
index 449a2a24b8..fccb6ec887 100644
--- a/docs/manpages/smbcacls.1
+++ b/docs/manpages/smbcacls.1
@@ -1,56 +1,57 @@
-.\" This manpage has been automatically generated by docbook2man-spec
-.\" from a DocBook document. docbook2man-spec can be found at:
-.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/>
+.\" This manpage has been automatically generated by docbook2man
+.\" from a DocBook document. This tool can be found at:
+.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
.\" Please send any bug reports, improvements, comments, patches,
.\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "SMBCACLS" "1" "28 January 2002" "" ""
+.TH "SMBCACLS" "1" "01 October 2002" "" ""
.SH NAME
smbcacls \- Set or get ACLs on an NT file or directory names
.SH SYNOPSIS
-.sp
-\fBsmbcacls\fR \fB//server/share\fR \fBfilename\fR [ \fB-U username\fR ] [ \fB-A acls\fR ] [ \fB-M acls\fR ] [ \fB-D acls\fR ] [ \fB-S acls\fR ] [ \fB-C name\fR ] [ \fB-G name\fR ] [ \fB-n\fR ] [ \fB-h\fR ]
+
+\fBsmbcacls\fR \fB//server/share\fR \fBfilename\fR [ \fB-U username\fR ] [ \fB-A acls\fR ] [ \fB-M acls\fR ] [ \fB-D acls\fR ] [ \fB-S acls\fR ] [ \fB-C name\fR ] [ \fB-G name\fR ] [ \fB-n\fR ] [ \fB-h\fR ]
+
.SH "DESCRIPTION"
.PP
-This tool is part of the Sambasuite.
+This tool is part of the Samba suite.
.PP
-The \fBsmbcacls\fR program manipulates NT Access Control Lists
-(ACLs) on SMB file shares.
+The \fBsmbcacls\fR program manipulates NT Access Control
+Lists (ACLs) on SMB file shares.
.SH "OPTIONS"
.PP
-The following options are available to the \fBsmbcacls\fR program.
+The following options are available to the \fBsmbcacls\fR program.
The format of ACLs is described in the section ACL FORMAT
.TP
\fB-A acls\fR
-Add the ACLs specified to the ACL list. Existing
+Add the ACLs specified to the ACL list. Existing
access control entries are unchanged.
.TP
\fB-M acls\fR
Modify the mask value (permissions) for the ACLs
-specified on the command line. An error will be printed for each
+specified on the command line. An error will be printed for each
ACL specified that was not already present in the ACL list
.TP
\fB-D acls\fR
-Delete any ACLs specified on the command line.
+Delete any ACLs specified on the command line.
An error will be printed for each ACL specified that was not
already present in the ACL list.
.TP
\fB-S acls\fR
This command sets the ACLs on the file with
-only the ones specified on the command line. All other ACLs are
-erased. Note that the ACL specified must contain at least a revision,
+only the ones specified on the command line. All other ACLs are
+erased. Note that the ACL specified must contain at least a revision,
type, owner and group for the call to succeed.
.TP
\fB-U username\fR
Specifies a username used to connect to the
-specified service. The username may be of the form "username" in
+specified service. The username may be of the form "username" in
which case the user is prompted to enter in a password and the
workgroup specified in the \fIsmb.conf\fR file is
-used, or "username%password" or "DOMAIN\\username%password" and the
+used, or "username%password" or "DOMAIN\\username%password" and the
password and workgroup names are used as provided.
.TP
\fB-C name\fR
The owner of a file or directory can be changed
-to the name given using the \fI-C\fR option.
+to the name given using the \fI-C\fR option.
The name can be a sid in the form S-1-x-y-z or a name resolved
against the server specified in the first argument.
@@ -59,25 +60,25 @@ This command is a shortcut for -M OWNER:name.
\fB-G name\fR
The group owner of a file or directory can
be changed to the name given using the \fI-G\fR
-option. The name can be a sid in the form S-1-x-y-z or a name
+option. The name can be a sid in the form S-1-x-y-z or a name
resolved against the server specified n the first argument.
This command is a shortcut for -M GROUP:name.
.TP
\fB-n\fR
This option displays all ACL information in numeric
-format. The default is to convert SIDs to names and ACE types
-and masks to a readable string format.
+format. The default is to convert SIDs to names and ACE types
+and masks to a readable string format.
.TP
\fB-h\fR
Print usage information on the \fBsmbcacls
-\fRprogram.
+\fR program.
.SH "ACL FORMAT"
.PP
The format of an ACL is one or more ACL entries separated by
-either commas or newlines. An ACL entry is one of the following:
+either commas or newlines. An ACL entry is one of the following:
.PP
-.sp
+
.nf
REVISION:<revision number>
@@ -85,51 +86,48 @@ OWNER:<sid or name>
GROUP:<sid or name>
ACL:<sid or name>:<type>/<flags>/<mask>
-.sp
.fi
.PP
The 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
+NT ACL revision for the security descriptor.
+If not specified it defaults to 1. Using values other than 1 may
cause strange behaviour.
.PP
The owner and group specify the owner and group sids for the
-object. If a SID in the format CWS-1-x-y-z is specified this is used,
+object. If a SID in the format CWS-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.
.PP
-ACLs specify permissions granted to the SID. This SID again
+ACLs specify permissions granted to the SID. This SID again
can be specified in CWS-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
+resides. The type, flags and mask values determine the type of
access granted to the SID.
.PP
The type can be either 0 or 1 corresponding to ALLOWED or
-DENIED access to the SID. The flags values are generally
-zero for file ACLs and either 9 or 2 for directory ACLs. Some
+DENIED access to the SID. The flags values are generally
+zero for file ACLs and either 9 or 2 for directory ACLs. Some
common flags are:
.TP 0.2i
\(bu
-#define SEC_ACE_FLAG_OBJECT_INHERIT 0x1
+#define SEC_ACE_FLAG_OBJECT_INHERIT 0x1
.TP 0.2i
\(bu
-#define SEC_ACE_FLAG_CONTAINER_INHERIT 0x2
+#define SEC_ACE_FLAG_CONTAINER_INHERIT 0x2
.TP 0.2i
\(bu
-#define SEC_ACE_FLAG_NO_PROPAGATE_INHERIT 0x4
+#define SEC_ACE_FLAG_NO_PROPAGATE_INHERIT 0x4
.TP 0.2i
\(bu
-#define SEC_ACE_FLAG_INHERIT_ONLY 0x8
+#define SEC_ACE_FLAG_INHERIT_ONLY 0x8
.PP
At present flags can only be specified as decimal or
hexadecimal values.
.PP
-.PP
The 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.
-.PP
.TP 0.2i
\(bu
\fBR\fR - Allow read access
@@ -150,10 +148,9 @@ file permissions of the same name.
\fBO\fR - Take ownership
.PP
The following combined permissions can be specified:
-.PP
.TP 0.2i
\(bu
-\fBREAD\fR - Equivalent to 'RX'
+\fBREAD\fR - Equivalent to 'RX'
permissions
.TP 0.2i
\(bu
@@ -165,13 +162,13 @@ permissions
.SH "EXIT STATUS"
.PP
The \fBsmbcacls\fR program sets the exit status
-depending on the success or otherwise of the operations performed.
+depending on the success or otherwise of the operations performed.
The exit status may be one of the following values.
.PP
If the operation succeeded, smbcacls returns and exit
-status of 0. If \fBsmbcacls\fR couldn't connect to the specified server,
+status of 0. If \fBsmbcacls\fR couldn't connect to the specified server,
or there was an error getting or setting the ACLs, an exit status
-of 1 is returned. If there was an error parsing any command line
+of 1 is returned. If there was an error parsing any command line
arguments, an exit status of 2 is returned.
.SH "VERSION"
.PP