summaryrefslogtreecommitdiff
path: root/getcifsacl.rst.in
diff options
context:
space:
mode:
authorJeff Layton <jlayton@samba.org>2017-10-23 13:46:33 -0400
committerJeff Layton <jlayton@samba.org>2017-10-23 13:46:33 -0400
commit72c68f598ccd935ba1c11c7e64d68e9d094bb1ac (patch)
tree27bbb4d22e857d9ed4efd5f8b4ca43c81c7137cc /getcifsacl.rst.in
parentd999610bf985f19fcc1984be95f11da7a3e88533 (diff)
downloadcifs-utils-72c68f598ccd935ba1c11c7e64d68e9d094bb1ac.tar.gz
cifs-utils-72c68f598ccd935ba1c11c7e64d68e9d094bb1ac.tar.bz2
cifs-utils-72c68f598ccd935ba1c11c7e64d68e9d094bb1ac.zip
doc: convert pod files to rst
Aurelien did a big conversion of raw troff files into .pod docs in a recent patch. That worked out pretty well, but I have some reservations about using POD as a canonical format. While it does make it pretty simple to write manpages, it's sort of an obscure format, and is heavily associated with perl. Meanwhile, the kernel is slowly moving to using ReStructured Text as its documentation format. Given the simplicity of the cifs-utils manpages, I think we're better suited to using rst as a canonical format, rather than pod. This patch converts all of the .pod files in the code to .rst files, and fixes the Makefile and autoconf to use the correct tools to turn those into manpages. The conversion was done with the pod2rst script, with some by-hand modifications at the end to clean up the formatting and add the manual section numbers. It's not perfect and could probably use a second pass to clean up the warts in the formatting, but the content is all intact and it should be readable. Finally, convert the makefile rules to use standard SUFFIX rules instead of the non-portable GNU make % style extension rules. We don't really expect anyone to use anything other than GNU make here, but this silences an automake warning. Signed-off-by: Aurelien Aptel <aaptel@suse.com> Signed-off-by: Jeff Layton <jlayton@samba.org>
Diffstat (limited to 'getcifsacl.rst.in')
-rw-r--r--getcifsacl.rst.in86
1 files changed, 86 insertions, 0 deletions
diff --git a/getcifsacl.rst.in b/getcifsacl.rst.in
new file mode 100644
index 0000000..42af258
--- /dev/null
+++ b/getcifsacl.rst.in
@@ -0,0 +1,86 @@
+==========
+getcifsacl
+==========
+
+--------------------------------------------------------------------------------------------------
+Userspace helper to display an ACL in a security descriptor for Common Internet File System (CIFS)
+--------------------------------------------------------------------------------------------------
+:Manual section: 1
+
+
+********
+SYNOPSIS
+********
+
+
+getcifsacl [-v|-r] {file system object}
+
+
+***********
+DESCRIPTION
+***********
+
+
+This tool is part of the cifs-utils suite.
+
+getcifsacl is a userspace helper program for the Linux CIFS client
+file system. It is intended to display a security descriptor including
+ACL for a file system object.
+
+This program uses a plugin to handle the mapping of SIDs to user and
+group names. \ *@pluginpath@*\ should be a symlink that points to the
+correct plugin to use.
+
+Fields of an ACE such as SID, type, flags, and mask are displayed
+separated by /. Numeric values of type, flags, and mask are displayed
+in hexadecimal format.
+
+
+*******
+OPTIONS
+*******
+
+
+
+\ **-v**\
+
+ Print version number and exit.
+
+
+
+\ **-r**\
+
+ Display a security descriptor in raw mode. Values such as type and
+ flags are displayed in hexadecimal format, a SID is not mapped to a
+ name.
+
+
+
+
+*****
+NOTES
+*****
+
+
+Kernel support for getcifsacl/setcifsacl utilities was initially
+introduced in the 2.6.37 kernel.
+
+
+********
+SEE ALSO
+********
+
+
+mount.cifs(8), setcifsacl(1)
+
+
+******
+AUTHOR
+******
+
+
+Shirish Pargaonkar wrote the getcifsacl program.
+
+The Linux CIFS Mailing list is the preferred place to ask questions
+regarding these programs.
+