]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - bin/getfacl/getfacl.1
Add "-q" argument to getfacl(1), which suppresses the per-file header
[FreeBSD/FreeBSD.git] / bin / getfacl / getfacl.1
1 .\"-
2 .\" Copyright (c) 2000, 2001, 2002 Robert N. M. Watson
3 .\" All rights reserved.
4 .\"
5 .\" This software was developed by Robert Watson for the TrustedBSD Project.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" SUCH DAMAGE.
27 .\"
28 .\" $FreeBSD$
29 .\"
30 .\" Developed by the TrustedBSD Project.
31 .\" Support for POSIX.1e access control lists.
32 .\"
33 .Dd December 30, 2002
34 .Dt GETFACL 1
35 .Os
36 .Sh NAME
37 .Nm getfacl
38 .Nd get ACL information
39 .Sh SYNOPSIS
40 .Nm
41 .Op Fl dhq
42 .Op Ar
43 .Sh DESCRIPTION
44 The
45 .Nm
46 utility writes discretionary access control information associated with
47 the specified file(s) to standard output.
48 If the
49 .Xr getconf 1
50 utility indicates that
51 .Eq { } Va _POSIX_ACL_EXTENDED
52 is not in effect for a
53 .Ar file
54 then the standard discretionary access permissions are interpreted as
55 an ACL containing only the required ACL entries.
56 .Pp
57 The following option is available:
58 .Bl -tag -width indent
59 .It Fl d
60 The operation applies to the default ACL of a directory instead of the
61 access ACL.
62 An error is generated if a default ACL cannot be associated with
63 .Ar file .
64 .It Fl h
65 If the target of the operation is a symbolic link, return the ACL from
66 the symbolic link itself rather than following the link.
67 .It Fl q
68 Don't write commented information about file name and ownership. This is
69 useful when dealing with filenames with unprintable characters.
70 .El
71 .Pp
72 The following operand is available:
73 .Bl -tag -width indent
74 .It Ar file
75 A pathname of a file whose ACL shall be retrieved.
76 If
77 .Ar file
78 is not specified, or a
79 .Ar file
80 is specified as
81 .Fl ,
82 then
83 .Nm
84 reads a list of pathnames, each terminated by one newline character,
85 from the standard input.
86 .El
87 .Sh EXIT STATUS
88 .Ex -std
89 .Sh EXAMPLES
90 .Dl getfacl /
91 .Pp
92 Retrieve ACL for the directory
93 .Pa / .
94 .Pp
95 .Dl getfacl -d /
96 .Pp
97 Retrieve the default ACL for the directory
98 .Pa / ,
99 if any.
100 .Sh SEE ALSO
101 .Xr setfacl 1 ,
102 .Xr acl 3 ,
103 .Xr getextattr 8 ,
104 .Xr setextattr 8 ,
105 .Xr acl 9 ,
106 .Xr extattr 9
107 .Sh STANDARDS
108 The
109 .Nm
110 utility is expected to be
111 .Tn IEEE
112 Std 1003.2c compliant.
113 .Sh HISTORY
114 Extended Attribute and Access Control List support was developed as part
115 of the
116 .Tn TrustedBSD
117 Project and introduced in
118 .Fx 5.0 .
119 .Sh AUTHORS
120 .An Robert N M Watson