fix-fs-error-string-printing-20010623
[openafs.git] / doc / html / AdminReference / auarf135.htm
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
2 <HTML><HEAD>
3 <TITLE>Administration Reference</TITLE>
4 <!-- Begin Header Records  ========================================== -->
5 <!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID      -->
6 <!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30                -->
7 <META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
8 <META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
9 <META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
10 </HEAD><BODY>
11 <!-- (C) IBM Corporation 2000. All Rights Reserved    --> 
12 <BODY bgcolor="ffffff"> 
13 <!-- End Header Records  ============================================ -->
14 <A NAME="Top_Of_Page"></A>
15 <H1>Administration Reference</H1>
16 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf134.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Bot_Of_Page"><IMG SRC="../bot.gif" BORDER="0" ALT="[Bottom of Topic]"></A> <A HREF="auarf136.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
17 <P>
18 <H2><A NAME="HDRFS_CLEANACL" HREF="auarf002.htm#ToC_149">fs cleanacl</A></H2>
19 <A NAME="IDX4746"></A>
20 <A NAME="IDX4747"></A>
21 <A NAME="IDX4748"></A>
22 <A NAME="IDX4749"></A>
23 <A NAME="IDX4750"></A>
24 <A NAME="IDX4751"></A>
25 <A NAME="IDX4752"></A>
26 <P><STRONG>Purpose</STRONG>
27 <P>Remove obsolete entries from an ACL
28 <P><STRONG>Synopsis</STRONG>
29 <PRE><B>fs cleanacl </B>[<B>-path</B> &lt;<VAR>dir/file&nbsp;path</VAR>><SUP>+</SUP>]  [<B>-help</B>]
30    
31 <B>fs cl</B> [<B>-p</B> &lt;<VAR>dir/file&nbsp;path</VAR>><SUP>+</SUP>]  [<B>-h</B>] 
32 </PRE>
33 <P><STRONG>Description</STRONG>
34 <P>The <B>fs cleanacl</B> command removes from the access control list
35 (ACL) of each specified directory or file any entry that refers to a user or
36 group that no longer has a Protection Database entry. Such an entry
37 appears on the ACL as an AFS user ID number (UID) rather than a name, because
38 without a Protection Database entry, the File Server cannot translate the UID
39 into a name.
40 <P>Cleaning access control lists in this way not only keeps them from becoming
41 crowded with irrelevant information, but also prevents the new possessor of a
42 recycled AFS UID from obtaining access intended for the former possessor of
43 the AFS UID. (Note that recycling UIDs is not recommended in any
44 case.)
45 <P><STRONG>Options</STRONG>
46 <DL>
47 <P><DT><B>-path
48 </B><DD>Names each directory for which to clean the ACL (specifying a filename
49 cleans its directory's ACL). If this argument is omitted, the
50 current working directory's ACL is cleaned.
51 <P>Specify the read/write path to each directory, to avoid the failure that
52 results from attempting to change a read-only volume. By convention,
53 the read/write path is indicated by placing a period before the cell name at
54 the pathname's second level (for example,
55 <B>/afs/.abc.com</B>). For further discussion of the
56 concept of read/write and read-only paths through the filespace, see the
57 <B>fs mkmount</B> reference page.
58 <P><DT><B>-help
59 </B><DD>Prints the online help for this command. All other valid options
60 are ignored.
61 </DL>
62 <P><STRONG>Output</STRONG>
63 <P>If there are no obsolete entries on the ACL, the following message
64 appears:
65 <PRE>   Access list for <VAR>dir/file&nbsp;path</VAR> is fine.
66    
67 </PRE>
68 <P>Otherwise, the output reports the resulting state of the ACL, following the
69 header
70 <PRE>   Access list for <VAR>dir/file&nbsp;path</VAR> is now
71    
72 </PRE>
73 <P>At the same time, the following error message appears for each file in the
74 cleaned directories:
75 <PRE>   fs: '<VAR>filename</VAR>': Not a directory
76    
77 </PRE>
78 <P><STRONG>Examples</STRONG>
79 <P>The following example illustrates the cleaning of the ACLs on the current
80 working directory and two of its subdirectories. Only the second
81 subdirectory had obsolete entries on it.
82 <PRE>   % <B>fs cleanacl -path . ./reports ./sources</B>
83    Access list for . is fine.
84    Access list for ./reports is fine.
85    Access list for ./sources is now
86    Normal rights:
87       system:authuser rl
88       pat rlidwka
89    
90 </PRE>
91 <P><STRONG>Privilege Required</STRONG>
92 <P>The issuer must have the <B>a</B> (<B>administer</B>) permission on
93 each directory's ACL (or the ACL of each file's parent
94 directory); the directory's owner and the members of the
95 <B>system:administrators</B> group have the right implicitly, even
96 if it does not appear on the ACL.
97 <P><STRONG>Related Information</STRONG>
98 <P><A HREF="auarf148.htm#HDRFS_LISTACL">fs listacl</A>
99 <P><A HREF="auarf153.htm#HDRFS_MKMOUNT">fs mkmount</A>
100 <P>
101 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf134.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Top_Of_Page"><IMG SRC="../top.gif" BORDER="0" ALT="[Top of Topic]"></A> <A HREF="auarf136.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
102 <!-- Begin Footer Records  ========================================== -->
103 <P><HR><B> 
104 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
105 </B> 
106 <!-- End Footer Records  ============================================ -->
107 <A NAME="Bot_Of_Page"></A>
108 </BODY></HTML>