call readt with ONE_DELAY = 5 s

[netatalk.git] / doc / README.hidden-items

diff --git a/doc/README.hidden-items b/doc/README.hidden-items
index 9c49db611c2a8b3b3b79903c9f71f7a772f21dd6..f07b1254b6bb13e4368b9c9248be25dfce97e9df 100644 (file)
--- a/doc/README.hidden-items
+++ b/doc/README.hidden-items
@@ -1,6 +1,8 @@
-Special folders created inside Netatalk shares
+              Special folders created inside Netatalk shares
 
-(ali@gwc.org.uk 20/10/01)
+(Originally by ali@gwc.org.uk 2001-10-20)
+(Amended by Sebastian Rittau 2001-11-03)
+(Amended by HAT 2010-03-30)
 
 Inside netatalk share points you will find several files and directories
 which are created automatically by the afpd process either for its own
@@ -21,16 +23,23 @@ should be set on them.
 
 Note that in general on Netatalk shares, all directories should have the
 setgid bit set. This forces any new files or folders created to have the
-same group as the folder they were created in.
+same group as the folder they were created in. On some operating systems,
+notably FreeBSD, the group owner is always inherited from the parent
+directory, so the setgid bit is not necessary.
 
 
 .AppleDouble/
 
 This directory exists inside each folder on a Netatalk share. It contains
-the resource fork of each file in that folder. Its permissions should
-match those of its parent directory, i.e. anyone who has write access to
-the parent directory must have write access to the corresponding
-.AppleDouble directory.
+meta information like the resource fork, or creator/type of each file in that
+folder. Its permissions should match those of its parent directory, i.e.
+anyone who has write access to the parent directory must have write access to
+the corresponding .AppleDouble directory.
+
+
+.AppleDouble/.Parent
+
+This file specifically contains meta information about the directory.
 
 
 .AppleDesktop/
@@ -76,10 +85,15 @@ make it writeable then users will get a message "That item cannot be put
 in the Trash. Do you want to delete it immediately?" if they try to put
 something in the Trash.
 
+Unfortunately networked trash handling is broken in current versions of Mac
+OS X even if this directory is writeable. Apple is aware of this problem
+and is working on a solution.
+
 
 Temporary\ Items/
+.TemporaryItems/ (:2eTemporaryItems/)
 
-This folder may exist at the top level of a sharepoint. This folder is
+These folder may exist at the top level of a sharepoint. These folder is
 used by certain applications (Adobe PhotoShop among others) to store,
 well, temporary items. These programs may not work correctly if this
 folder is missing or not writeable, when a user tries to work on a
@@ -101,13 +115,16 @@ always appears to be empty. It would be wise to set its permissions
 the same as the top level of the sharepoint.
 
 
-:2eDS_Store (.DS_Store)
+.DS_Store (:2eDS_Store)
 
 This file may appear in share points which have been accessed by a
 machine running Mac OS X. Its permissions should be set to match
 those of the enclosing directory.
 
-For more info on how this file could pose a potential security risk
-if you are sharing the same folder by HTTP, see:
 
-http://cert.uni-stuttgart.de/archive/bugtraq/2001/09/msg00106.html
+.FBCIndex (.FBCIndex)
+.FBCLockFolder/.FBCSemaphoreFile (:2eFBCLockFolder/:2eFBCSemaphoreFile)
+
+These are created to preserve retrieval information by Sherlock
+on Mac OS X 10.1. If these are removed, the next retrieval will slow.
+Mac OS X 10.2 and later do not use these.