Commits

Ned Batchelder  committed b2804f7

Add some docs

  • Participants
  • Parent commits 7c2c439

Comments (0)

Files changed (1)

 
 """fixtar - A setup.py command to correct permissions in tar kits
 
-Say more here.
+When building source kits on Windows, the native tar command is used, but it
+doesn't create correct permissions in the tar file.  The fixtar command
+re-packs the tar file using the Python tarfile standard library module to
+give it good permissions.
+
+Use it like this:
+
+    python setup.py sdist --keep-temp --formats=gztar fixtar -oned -gfixtar --clean
+
+The --keep-temp option to sdist is required so that the original tarred files
+are available for re-tarring.  The --clean option to fixtar will remove them.
+The -o and -g options to fixtar let you specify the symbolic owner and group 
+for the tar contents.
+
 """
 
 import sys