Context Navigation

-              rf009801
+              re0d33ef
   bzip2'ed pages, a feature you can use to free some disk space while keeping
   your documentation available. However, things are not that simple; man
   directories tend to contain links&mdash;hard and symbolic&mdash;which defeat
   simple ideas like recursively calling <command>gzip</command> on them. A
+  directories tend to contain links&mdash;hard and symbolic&mdash;which defeat
+  simple ideas like recursively calling <command>gzip</command> on them. A
   better way to go is to use the script below.</para>
 …
 # to allow for a backup, to allow to keep the newest version of a page.
+#
 # Modified 20040330 by Tushar Teredesai to replace $0 by the name of the
+# Modified 20040330 by Tushar Teredesai to replace $0 by the name of the
 # script.
 #   (Note: It is assumed that the script is in the user's PATH)
 …
 #     - choose a default compress method to be based on the available
 #       tool : gzip or bzip2;
 #     - offer an option to automagically choose the best compression
 #       methed on a per page basis (eg. check which of
+#     - offer an option to automagically choose the best compression
+#       methed on a per page basis (eg. check which of
 #       gzip/bzip2/whatever is the most effective, page per page);
 #     - when a MANPATH env var exists, use this instead of /etc/man.conf
 …
   --backup      Specify a .tar backup shall be done for all directories.
                 In case a backup already exists, it is saved as .tar.old
                 prior to making the new backup. If a .tar.old backup
+                In case a backup already exists, it is saved as .tar.old
+                prior to making the new backup. If a .tar.old backup
                 exists, it is removed prior to saving the backup.
                 In backup mode, no other action is performed.
 …
 And where options are :
   -1 to -9, --fast, --best
                 The compression level, as accepted by gzip and bzip2.
                 When not specified, uses the default compression level
                 for the given method (-6 for gzip, and -9 for bzip2).
+                The compression level, as accepted by gzip and bzip2.
+                When not specified, uses the default compression level
+                for the given method (-6 for gzip, and -9 for bzip2).
                 Not used when in backup or decompress modes.
   --force, -F   Force (re-)compression, even if the previous one was
                 the same method. Useful when changing the compression
                 ratio. By default, a page will not be re-compressed if
                 it ends with the same suffix as the method adds
+  --force, -F   Force (re-)compression, even if the previous one was
+                the same method. Useful when changing the compression
+                ratio. By default, a page will not be re-compressed if
+                it ends with the same suffix as the method adds
                 (.bz2 for bzip2, .gz for gzip).
   --soft, -S    Change hard-links into soft-links. Use with _caution_
                 as the first encountered file will be used as a
+  --soft, -S    Change hard-links into soft-links. Use with _caution_
+                as the first encountered file will be used as a
                 reference. Not used when in backup mode.
   --hard, -H    Change soft-links into hard-links. Not used when in
+  --hard, -H    Change soft-links into hard-links. Not used when in
                 backup mode.
 …
                 Specify the location of man.conf. Defaults to /etc.
   --verbose, -v Verbose mode, print the name of the directory being
                 processed. Double the flag to turn it even more verbose,
+  --verbose, -v Verbose mode, print the name of the directory being
+                processed. Double the flag to turn it even more verbose,
                 and to print the name of the file being processed.
   --fake, -f    Fakes it. Print the actual parameters compman will use.
   dirs          A list of space-separated _absolute_ pathnames to the
                 man directories. When empty, and only then, parse
+  dirs          A list of space-separated _absolute_ pathnames to the
+                man directories. When empty, and only then, parse
                 ${MAN_CONF}/man.conf for all occurrences of MANPATH.
 …
   both gzip and bzip2 on man pages, taking into account the hosting fs,
   the architecture, etc... On the overall, the conclusion was that gzip
   was much more efficient on 'small' files, and bzip2 on 'big' files,
+  was much more efficient on 'small' files, and bzip2 on 'big' files,
   small and big being very dependent on the content of the files.
   See the original post from Mickael A. Peters, titled
+  See the original post from Mickael A. Peters, titled
   "Bootable Utility CD", dated 20030409.1816(+0200), and subsequent posts:
   http://linuxfromscratch.org/pipermail/blfs-support/2003-April/038817.html
   On my system (x86, ext3), man pages were 35564KB before compression.
   gzip -9 compressed them down to 20372KB (57.28%), bzip2 -9 got down to
+  On my system (x86, ext3), man pages were 35564KB before compression.
+  gzip -9 compressed them down to 20372KB (57.28%), bzip2 -9 got down to
 KB (55.71%). That is a 1.57% gain in space. YMMV.
   What was not taken into consideration was the decompression speed. But
   does it make sense to? You gain fast access with uncompressed man
   pages, or you gain space at the expense of a slight overhead in time.
+  What was not taken into consideration was the decompression speed. But
+  does it make sense to? You gain fast access with uncompressed man
+  pages, or you gain space at the expense of a slight overhead in time.
   Well, my P4-2.5GHz does not even let me notice this... :-)
 …
+}
 # This function checks that the man page is unique amongst bzip2'd,
+# This function checks that the man page is unique amongst bzip2'd,
 # gzip'd and uncompressed versions.
 #  $1 the directory in which the file resides
 #  $2 the file name for the man page
 # Returns 0 (true) if the file is the latest and must be taken care of,
 # and 1 (false) if the file is not the latest (and has therefore been
+# Returns 0 (true) if the file is the latest and must be taken care of,
+# and 1 (false) if the file is not the latest (and has therefore been
 # deleted).
 function check_unique ()
 …
 MY_NAME=`basename $0`
 # OK, parse the command-line for arguments, and initialize to some
 # sensible state, that is: don't change links state, parse
 # /etc/man.conf, be most silent, search man.conf in /etc, and don't
+# OK, parse the command-line for arguments, and initialize to some
+# sensible state, that is: don't change links state, parse
+# /etc/man.conf, be most silent, search man.conf in /etc, and don't
 # force (re-)compression.
 COMP_METHOD=
 …
       ;;
     *)
       echo "\"$1\" is not an absolute path name"
+      echo "\"$1\" is not an absolute path name"
       exit 1
       ;;
 …
 esac
 # Note: on my machine, 'man --path' gives /usr/share/man twice, once
+# Note: on my machine, 'man --path' gives /usr/share/man twice, once
 # with a trailing '/', once without.
 if [ -z "$MAN_DIR" ]; then
 …
   echo "man.conf is.......: ${MAN_CONF}/man.conf"
   echo -n "Hard-links........: "
   [ "foo$LN_OPT" = "foo-S" ] &amp;&amp;
+  [ "foo$LN_OPT" = "foo-S" ] &amp;&amp;
   echo "convert to soft-links" || echo "leave as is"
   echo -n "Soft-links........: "
   [ "foo$LN_OPT" = "foo-H" ] &amp;&amp;
+  [ "foo$LN_OPT" = "foo-H" ] &amp;&amp;
   echo "convert to hard-links" || echo "leave as is"
   echo "Backup............: $BACKUP"
 …
     echo "Backing up $DIR..." &gt; $DEST_FD0
     [ -f "${DIR_NAME}.tar.old" ] &amp;&amp; rm -f "${DIR_NAME}.tar.old"
     [ -f "${DIR_NAME}.tar" ] &amp;&amp;
+    [ -f "${DIR_NAME}.tar" ] &amp;&amp;
     mv "${DIR_NAME}.tar" "${DIR_NAME}.tar.old"
     tar -cfv "${DIR_NAME}.tar" "${DIR_NAME}" &gt; $DEST_FD1
 …
     # Fixes the case when hard-links see their compression scheme change
     # (from not compressed to compressed, or from bz2 to gz, or from gz
+    # (from not compressed to compressed, or from bz2 to gz, or from gz
     # to bz2)
     # Also fixes the case when multiple version of the page are present,
+    # Also fixes the case when multiple version of the page are present,
     # which are either compressed or not.
     if [ ! -L "$FILE" -a ! -e "$FILE" ]; then continue; fi
 …
     if [ -d "$FILE" ]; then
       cd "${MEM_DIR}"  # Go back to where we ran "$0",
+      cd "${MEM_DIR}"  # Go back to where we ran "$0",
                        # in case "$0"=="./compressdoc" ...
       # We are going recursive to that directory
 …
         # Take care of hard-links: build the list of files hard-linked
         # to the one we are {de,}compressing.
         # NB. This is not optimum has the file will eventually be
         # compressed as many times it has hard-links. But for now,
+        # NB. This is not optimum has the file will eventually be
+        # compressed as many times it has hard-links. But for now,
         # that's the safe way.
         inode=`ls -li "$FILE" | awk '{print $1}'`
 …
       else
         # There is a problem when we get neither a symlink nor a plain
+        # There is a problem when we get neither a symlink nor a plain
         # file. Obviously, we shall never ever come here... :-(
         echo -n "Whaooo... \"${DIR}/${FILE}\" is neither a symlink "
 …
 chmod 755 /usr/sbin/compressdoc</userinput></screen>
   <para>Now, as <systemitem class="username">root</systemitem>, you can issue a
   <command>compressdoc --bz2</command> to compress all your system man
   pages. You can also run <command>compressdoc --help</command> to get
+  <para>Now, as <systemitem class="username">root</systemitem>, you can issue a
+  <command>compressdoc --bz2</command> to compress all your system man
+  pages. You can also run <command>compressdoc --help</command> to get
   comprehensive help about what the script is able to do.</para>
   <para> Don't forget that a few programs, like the <application>X Window
   System</application>  and <application>XEmacs</application> also
   install their documentation in non standard places (such as
   <filename class="directory">/usr/X11R6/man</filename>, etc...). Be sure
   to add these locations to the file <filename>/etc/man.conf</filename>, as a
+  <para> Don't forget that a few programs, like the <application>X Window
+  System</application>  and <application>XEmacs</application> also
+  install their documentation in non standard places (such as
+  <filename class="directory">/usr/X11R6/man</filename>, etc...). Be sure
+  to add these locations to the file <filename>/etc/man.conf</filename>, as a
   <envar>MANPATH</envar>=<replaceable>[/path]</replaceable> section.</para>
 …
     ...</literal></screen>
   <para>Generally, package installation systems do not compress man/info pages,
   which means you will need to run the script again if you want to keep the size
+  <para>Generally, package installation systems do not compress man/info pages,
+  which means you will need to run the script again if you want to keep the size
   of your documentation as small as possible. Also, note that running the script
   after upgrading a package is safe; when you have several versions of a page
+  after upgrading a package is safe; when you have several versions of a page
   (for example, one compressed and one uncompressed), the most recent one is kept
   and the others deleted.</para>

Note: See TracChangeset for help on using the changeset viewer.

Context Navigation

Changeset e0d33ef for postlfs/config/compressdoc.xml

Legend:

postlfs/config/compressdoc.xml

Download in other formats: