real documentation

1 files changed, 55 insertions, 29 deletions

diff --git a/README b/README
index 91b4037..8991e9c 100644
--- a/README
+++ b/README
@@ -1,29 +1,55 @@
-From: Frederic Lepied <flepied@mandrakesoft.com>
-Subject: [Cooker] spec-helper
-To: cooker@linux-mandrake.com
-Date: 22 Feb 2000 14:45:21 +0100
-
-For information.
-
-Starting  from  rpm-3.0.4-0.2mdk,  the  spec-helper  package  must  be
-installed as a dependency of the rpm-build package.
-
-The  spec-helper script  is called  automatically  at the  end of  the
-%install  section to  compress info  and  man pages,  strip files  and
-remove backup files from the $RPM_BUILD_ROOT dir. The %install section
-can be  cleaned off this  tasks but the  %files section about  man and
-info pages must be specified without  the .bz2 extension but with an *
-instead. The goal is to have vendor neutral spec files.
-
-Example:
-
-%files
-/usr/man/man1/alias.1*
-
-and not
-
-%files
-/usr/man/man1/alias.1.bz2
-
--- 
-Fred - May the source be with you
\ No newline at end of file
+spec-helper is a set of helper scripts to be executed at package installation
+time. They are automatically invocated at the end of the %install section to
+perform various tasks. Here is a list of them, along with their usage
+instructions:
+
+clean_files
+remove backup files.
+Set DONT_CLEANUP to disable.
+
+compress_files
+compress man and info pages.
+Set DONT_COMPRESS to disable.
+
+strip_files
+Strip binary files.
+Set DONT_STRIP to disable, or EXCLUDE_FROM_STRIP to give a space-separated list
+of files exceptions.
+
+relink_symlinks
+Relativize absolute symlinks.
+Set DONT_RELINK to disable.
+
+clean_perl
+Remove useless files in perl tree.
+Set DONT_CLEAN_PERL to disable.
+
+lib_symlinks
+Run ldconfig to create symlinks to libraries.
+Set DONT_SYMLINK_LIBS to disable.
+
+gprintify
+rewrite "bla $TOTO bla" in "bla %s bla" $TOTO in
+echo/failure/success/passed/daemon/action and replace echo by gprintf.
+Set DONT_GPRINTIFY to disable.
+
+fix-mo
+Fix bad translations.
+Set DONT_FIX_MO to disable.
+
+translate_menu
+Change the menu sections.
+Set DONT_TRANSLATE_MENU to disable.
+
+fixpamd
+Fix pam.d config files.
+Set DONT_FIX_PAMD_CONFIGS to disable.
+
+remove_info_dir
+Remove info directories.
+Set DONT_REMOVE_INFO_DIR to disable.
+
+fix-eol
+Convert end of line patterns from DOS to UNIX.
+Set DONT_FIX_EOL to disable, or EXCLUDE_FROM_EOL_CONVERSION to give a
+space-separated list of files exceptions.