source: patches/tar-1.22-man_page-1.patch@ 2606272

clfs-1.2 clfs-2.1 clfs-3.0.0-systemd clfs-3.0.0-sysvinit systemd sysvinit
Last change on this file since 2606272 was 4588a6c, checked in by Jim Gifford <clfs@…>, 16 years ago

Fix to Tar Man-Page Patch
  • Property mode set to 100644
File size: 16.7 KB

  • doc/Makefile.am 

    Submitted By: Jim Gifford (jim at cross-lfs dot org)
Date: 2009-03-06
Initial Package Version: 1.22
Origin: Debian
Upstream Status: N/A
Description: This Patch adds and man-page to TAR. This has been
	     added as per numerous requests.

diff -Naur tar-1.22.orig/doc/Makefile.am tar-1.22/doc/Makefile.am
    old new  
    1717## along with this program; if not, write to the Free Software Foundation,
    1818## Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
    1919
     20man_MANS = tar.1
     21
    2022info_TEXINFOS = tar.texi
    2123tar_TEXINFOS = \
    2224 dumpdir.texi\

  • doc/Makefile.in 

    diff -Naur tar-1.22.orig/doc/Makefile.in tar-1.22/doc/Makefile.in
    old new  
    146146MAKEINFOHTML = $(MAKEINFO) --html
    147147AM_MAKEINFOHTMLFLAGS = $(AM_MAKEINFOFLAGS)
    148148DVIPS = dvips
    149 am__installdirs = "$(DESTDIR)$(infodir)"
     149am__installdirs = "$(DESTDIR)$(infodir)" "$(DESTDIR)$(man1dir)"
    150150am__vpath_adj_setup = srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`;
    151151am__vpath_adj = case $$p in \
    152152    $(srcdir)/*) f=`echo "$$p" | sed "s|^$$srcdirstrip/||"`;; \
    153153    *) f=$$p;; \
    154154  esac;
    155155am__strip_dir = `echo $$p | sed -e 's|^.*/||'`;
     156man1dir = $(mandir)/man1
     157NROFF = nroff
     158MANS = $(man_MANS)
    156159DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST)
    157160ACLOCAL = @ACLOCAL@
    158161ALLOCA = @ALLOCA@
    … …  
    645648target_alias = @target_alias@
    646649top_builddir = @top_builddir@
    647650top_srcdir = @top_srcdir@
     651man_MANS = tar.1
    648652info_TEXINFOS = tar.texi
    649653tar_TEXINFOS = \
    650654 dumpdir.texi\
    … …  
    858862          echo " rm -f $$i $$i-[0-9] $$i-[0-9][0-9] $$i_i[0-9] $$i_i[0-9][0-9]"; \
    859863          rm -f $$i $$i-[0-9] $$i-[0-9][0-9] $$i_i[0-9] $$i_i[0-9][0-9]; \
    860864        done
     865install-man1: $(man1_MANS) $(man_MANS)
     866        @$(NORMAL_INSTALL)
     867        test -z "$(man1dir)" || $(MKDIR_P) "$(DESTDIR)$(man1dir)"
     868        @list='$(man1_MANS) $(dist_man1_MANS) $(nodist_man1_MANS)'; \
     869        l2='$(man_MANS) $(dist_man_MANS) $(nodist_man_MANS)'; \
     870        for i in $$l2; do \
     871          case "$$i" in \
     872            *.1*) list="$$list $$i" ;; \
     873          esac; \
     874        done; \
     875        for i in $$list; do \
     876          if test -f $(srcdir)/$$i; then file=$(srcdir)/$$i; \
     877          else file=$$i; fi; \
     878          ext=`echo $$i | sed -e 's/^.*\\.//'`; \
     879          case "$$ext" in \
     880            1*) ;; \
     881            *) ext='1' ;; \
     882          esac; \
     883          inst=`echo $$i | sed -e 's/\\.[0-9a-z]*$$//'`; \
     884          inst=`echo $$inst | sed -e 's/^.*\///'`; \
     885          inst=`echo $$inst | sed '$(transform)'`.$$ext; \
     886          echo " $(INSTALL_DATA) '$$file' '$(DESTDIR)$(man1dir)/$$inst'"; \
     887          $(INSTALL_DATA) "$$file" "$(DESTDIR)$(man1dir)/$$inst"; \
     888        done
     889uninstall-man1:
     890        @$(NORMAL_UNINSTALL)
     891        @list='$(man1_MANS) $(dist_man1_MANS) $(nodist_man1_MANS)'; \
     892        l2='$(man_MANS) $(dist_man_MANS) $(nodist_man_MANS)'; \
     893        for i in $$l2; do \
     894          case "$$i" in \
     895            *.1*) list="$$list $$i" ;; \
     896          esac; \
     897        done; \
     898        for i in $$list; do \
     899          ext=`echo $$i | sed -e 's/^.*\\.//'`; \
     900          case "$$ext" in \
     901            1*) ;; \
     902            *) ext='1' ;; \
     903          esac; \
     904          inst=`echo $$i | sed -e 's/\\.[0-9a-z]*$$//'`; \
     905          inst=`echo $$inst | sed -e 's/^.*\///'`; \
     906          inst=`echo $$inst | sed '$(transform)'`.$$ext; \
     907          echo " rm -f '$(DESTDIR)$(man1dir)/$$inst'"; \
     908          rm -f "$(DESTDIR)$(man1dir)/$$inst"; \
     909        done
    861910tags: TAGS
    862911TAGS:
    863912
    … …  
    896945          dist-info
    897946check-am: all-am
    898947check: check-am
    899 all-am: Makefile $(INFO_DEPS)
     948all-am: Makefile $(INFO_DEPS) $(MANS)
    900949installdirs:
    901         for dir in "$(DESTDIR)$(infodir)"; do \
     950        for dir in "$(DESTDIR)$(infodir)" "$(DESTDIR)$(man1dir)"; do \
    902951          test -z "$$dir" || $(MKDIR_P) "$$dir"; \
    903952        done
    904953install: install-am
    … …  
    945994
    946995info-am: $(INFO_DEPS)
    947996
    948 install-data-am: install-info-am
     997install-data-am: install-info-am install-man
    949998
    950999install-dvi: install-dvi-am
    9511000
    … …  
    10101059            install-info --info-dir="$(DESTDIR)$(infodir)" "$(DESTDIR)$(infodir)/$$relfile" || :;\
    10111060          done; \
    10121061        else : ; fi
    1013 install-man:
     1062install-man: install-man1
    10141063
    10151064install-pdf: install-pdf-am
    10161065
    … …  
    10541103ps-am: $(PSS)
    10551104
    10561105uninstall-am: uninstall-dvi-am uninstall-html-am uninstall-info-am \
    1057         uninstall-pdf-am uninstall-ps-am
     1106        uninstall-man uninstall-pdf-am uninstall-ps-am
     1107
     1108uninstall-man: uninstall-man1
    10581109
    10591110.MAKE: install-am install-strip
    10601111
    … …  
    10631114        html-am info info-am install install-am install-data \
    10641115        install-data-am install-dvi install-dvi-am install-exec \
    10651116        install-exec-am install-html install-html-am install-info \
    1066         install-info-am install-man install-pdf install-pdf-am \
    1067         install-ps install-ps-am install-strip installcheck \
    1068         installcheck-am installdirs maintainer-clean \
     1117        install-info-am install-man install-man1 install-pdf \
     1118        install-pdf-am install-ps install-ps-am install-strip \
     1119        installcheck installcheck-am installdirs maintainer-clean \
    10691120        maintainer-clean-aminfo maintainer-clean-generic \
    10701121        maintainer-clean-vti mostlyclean mostlyclean-aminfo \
    10711122        mostlyclean-generic mostlyclean-vti pdf pdf-am ps ps-am \
    10721123        uninstall uninstall-am uninstall-dvi-am uninstall-html-am \
    1073         uninstall-info-am uninstall-pdf-am uninstall-ps-am
     1124        uninstall-info-am uninstall-man uninstall-man1 \
     1125        uninstall-pdf-am uninstall-ps-am
    10741126
    10751127
    10761128header.texi: $(top_srcdir)/src/tar.h

  • doc/tar.1 

    diff -Naur tar-1.22.orig/doc/tar.1 tar-1.22/doc/tar.1
    old new  
     1.\" @(#)tar.1 1.11.1 93/19/22 PJV;
     2.TH TAR 1 "29 Aug 2007"
     3.SH NAME
     4tar \- The GNU version of the tar archiving utility
     5.SH SYNOPSIS
     6.B tar
     7[
     8.B \-
     9]
     10.B A \-\-catenate \-\-concatenate \||\| c \-\-create \||\| d \-\-diff \-\-compare \||\| \-\-delete \||\| r \-\-append \||\| t \-\-list \||\| u \-\-update \||\| x \-\-extract \-\-get
     11.I [ options ]
     12.I pathname [ pathname ... ]
     13.SH DESCRIPTION
     14.LP
     15This manual page documents the GNU version of
     16.B tar
     17, an archiving program designed to store and extract files from
     18an archive file known as a
     19.IR tarfile.
     20A
     21.IR tarfile
     22may be made on a tape drive, however, it is also common
     23to write a
     24.IR tarfile
     25to a normal file.
     26The first argument to
     27.B tar
     28must be one of the options:
     29.BR Acdrtux ,
     30followed by any optional functions.
     31The final arguments to
     32.B tar
     33are the names of the files or directories which should be archived. The use
     34of a directory name always implies that the subdirectories below should be
     35included in the archive.
     36.SH EXAMPLES
     37.TP
     38.B tar \-xvvf foo.tar
     39extract foo.tar
     40.TP
     41.B tar \-xvvzf foo.tar.gz
     42extract gzipped foo.tar.gz
     43.TP
     44.B tar \-cvvf foo.tar foo/
     45tar contents of folder foo in foo.tar
     46.SH "FUNCTION LETTERS"
     47.TP
     48.B One of the following options must be used:
     49.TP
     50.B \-A, \-\-catenate, \-\-concatenate
     51append tar files to an archive
     52.TP
     53.B \-c, \-\-create     
     54create a new archive
     55.TP
     56.B \-d, \-\-diff, \-\-compare
     57find differences between archive and file system
     58.TP
     59.B \-\-delete           
     60delete from the archive (not for use on mag tapes!)
     61.TP
     62.B \-r, \-\-append             
     63append files to the end of an archive
     64.TP
     65.B \-t, \-\-list               
     66list the contents of an archive
     67.TP
     68.B \-u, \-\-update             
     69only append files that are newer than copy in archive
     70.TP
     71.B \-x, \-\-extract, \-\-get           
     72extract files from an archive
     73.SH "OTHER OPTIONS"
     74.TP
     75.B \-\-allow\-name\-mangling
     76re-enable handling of GNUTYPE_NAMES which is now disabled by default
     77.TP
     78.B \-\-anchored
     79force exclusion patterns to match initial subsequences
     80.TP
     81.B \-\-atime\-preserve 
     82don't change access times on dumped files
     83.TP
     84.B \-a, \-\-auto\-compress
     85with \-\-create, selects compression algorithm basing on the suffix
     86of the archive file name
     87.TP
     88.B \-b, \-\-blocking\-factor N
     89use record size of Nx512 bytes (default N=20)
     90.TP
     91.B \-B, \-\-read\-full\-records
     92reblock as we read (for reading 4.2BSD pipes)
     93.TP
     94.B \-\-backup[\=TYPE]
     95back up files instead of overwriting (TYPE=numbered, existing, simple)
     96.TP
     97.B \-C, \-\-directory DIR       
     98change to directory DIR
     99.TP
     100.B \-\-checkpoint               
     101print periodic checkpoints
     102.TP
     103.B \-\-checkpoint\-action
     104this action allows to specify an action to be executed upon hitting a
     105checkpoint.  Recognized actions are: dot, echo (the default),
     106echo\=string, ttyout\=string, exec\=cmdline, and sleep\=value.  Any number
     107of `\-\-checkpoint\-action' options can be specified, the actions will be
     108executed in order of their appearance in the command line.
     109.TP
     110.B \-\-check\-device
     111enables comparing device numbers.  This is the default.
     112.TP
     113.B \-\-no\-check\-device
     114disables comparing device numbers during preparatory stage of an
     115incremental dump. 
     116This allows to avoid creating full dumps if the device numbers change
     117(e.g. when using an LVM snapshot)
     118.TP
     119.B \-\-exclude=PATTERN
     120exclude files matching PATTERN
     121.TP
     122.B \-f, \-\-file [HOSTNAME:]F   
     123use archive file or device F (otherwise value of TAPE environment variable; if unset, "\-", meaning stdin/stdout)
     124.TP
     125.B \-F, \-\-info\-script F, \-\-new\-volume\-script F
     126run script at end of each tape (implies \-M)
     127.TP
     128.B \-\-force\-local             
     129archive file is local even if it has a colon
     130.TP
     131.B \-G, \-\-incremental
     132create/list/extract old GNU-format incremental backup
     133.TP
     134.B \-g, \-\-listed\-incremental F
     135create/list/extract new GNU-format incremental backup
     136.TP
     137.B \-\-group G
     138set group to G while adding files
     139.TP
     140.B \-h, \-\-dereference
     141don't dump symlinks; dump the files they point to
     142.TP
     143.B \-\-hard\-dereference
     144during archive creation, dereferences hard links and stores the files
     145they refer to, instead of creating usual hard link members (type '1')
     146.TP
     147.B \-\-help
     148print help message
     149.TP
     150.B \-i, \-\-ignore\-zeros       
     151ignore blocks of zeros in archive (normally mean EOF)
     152.TP
     153.B \-\-ignore\-case
     154ignore case when excluding files
     155.TP
     156.B \-\-ignore\-failed\-read     
     157don't exit with non-zero status on unreadable files
     158.TP
     159.B \-j, \-\-bzip2
     160filter archive through bzip2, use to decompress .bz2 files.
     161WARNING: some previous versions of tar used option \-I to
     162filter through bzip2.  When writing scripts, use \-\-bzip2
     163instead of \-j so that both older and newer tar versions
     164will work.
     165.TP
     166.B \-J, \-\-xz
     167selects XZ compression algorithm
     168.TP
     169.B \-k, \-\-keep\-old\-files   
     170keep existing files; don't overwrite them from archive
     171.TP
     172.B \-K, \-\-starting\-file F   
     173begin at file F in the archive
     174.TP
     175.B \-\-lzip
     176selects Lzip compression algorithm
     177.TP
     178.B \-\-lzma
     179selects LZMA compression algorithm
     180.TP
     181.B \-l, \-\-check\-links
     182print a message if not all links are dumped
     183.TP
     184.B \-L, \-\-tape\-length N     
     185change tapes after writing N*1024 bytes
     186.TP
     187.B \-m, \-\-touch
     188don't extract file modified time
     189.TP
     190.BI \-\-transform " expr"
     191applies filename transformations. 
     192The argument to this option can be a list of replace expressions, separated
     193by semicolon (as in `sed').
     194Filename transformations are applied to symbolic link targets during both
     195creation and extraction.
     196This option may be specified any number of
     197times, the specified transofrmations will be applied in turn.
     198.TP
     199.B \-M, \-\-multi\-volume       
     200create/list/extract multi-volume archive
     201.TP
     202.B \-\-mode M
     203set permissions to M while adding files
     204.TP
     205.B \-N, \-\-after\-date DATE, \-\-newer DATE
     206only store files newer than DATE
     207.TP
     208.B \-\-newer\-mtime DATE
     209only store files whose contents have changed after DATE
     210.TP
     211.B \-\-no\-anchored
     212allow exclusion patterns to match any substring (the default)
     213.TP
     214.B \-\-no\-ignore\-case
     215match patterns case sensitively (the default)
     216.TP
     217.B \-\-no\-recursion
     218do not recurse into subdirectories
     219.TP
     220.B \-o, \-\-no\-same\-owner
     221extract files with owner set to current user (the default for non-root
     222users)
     223.TP
     224.B \-\-no\-same\-permissions
     225apply umask to extracted files (the default for non-root users)
     226.TP
     227.B \-\-no\-wildcards
     228do not use wildcards when excluding files
     229.TP
     230.B \-\-no\-wildcards\-match\-slash
     231don't let wildcards match "/" when excluding files
     232.TP
     233.B \-\-null
     234for \-T, use "NUL" instead of newline as filename terminator
     235.TP
     236.B \-\-numeric\-owner
     237always use numbers for user/group names
     238.TP
     239.B \-\-old\-archive, \-\-portability   
     240write a V7 format archive, rather than ANSI format.  These options are
     241deprecated, please use
     242.B \-\-format\=v7
     243instead.
     244.TP
     245.B \-\-one\-file\-system       
     246stay in local file system when creating an archive
     247.TP
     248.B \-\-owner O
     249set owner to O while adding files
     250.TP
     251.B \-O, \-\-to\-stdout         
     252extract files to standard output
     253.TP
     254.B \-p, \-\-same\-permissions, \-\-preserve\-permissions
     255ignore umask when extracting files (the default for root)
     256.TP
     257.B \-P, \-\-absolute\-names
     258don't strip leading `/'s from file names
     259.TP
     260.B \-\-posix
     261create POSIX compliant archive.  This option is deprecated,
     262please use
     263.B \-\-format\=posix
     264instead.
     265.TP
     266.B \-\-preserve         
     267like \-p \-s
     268.TP
     269.B \-R, \-\-block\-number       
     270show block number within archive with each message
     271.TP
     272.B \-\-record\-size SIZE
     273use SIZE bytes per record
     274.TP
     275.B \-\-recursion
     276recurse into directories (the default)
     277.TP
     278.B \-\-recursive\-unlink
     279remove existing directories before extracting directories of the same
     280name
     281.TP
     282.B \-\-remove\-files           
     283remove files after adding them to the archive
     284.TP
     285.B \-\-rsh\-command=CMD
     286Use remote COMMAND instead of `rsh'.  This option exists so that
     287people who use something other than the standard `rsh' (e.g., a
     288Kerberized `rsh') can access a remote device.
     289.TP
     290.B \-S, \-\-sparse             
     291handle sparse files efficiently
     292.TP
     293.B \-s, \-\-same\-order, \-\-preserve\-order   
     294list of names to extract is sorted to match archive
     295.TP
     296.B \-\-same\-owner             
     297extract files with owner as specified in archive (the default for
     298root)
     299.TP
     300.B \-\-show\-omitted\-dirs
     301mention directories that are being skipped over
     302.TP
     303.BI \-\-strip\-components " n"
     304Strip the given number of leading directory components
     305.TP
     306.B \-\-strip, \-\-strip\-components N
     307Strips the first N components from archive members' pathnames when
     308unpacking.
     309.TP
     310.B \-\-suffix SUFFIX
     311append SUFFIX to make backup files (default ~)
     312.TP
     313.B \-T, \-\-files\-from F       
     314get names to extract or archive from file F
     315.TP
     316.B \-\-totals
     317display total bytes written after creating an archive
     318.TP
     319.B \-U, \-\-unlink\-first
     320unlink & recreate files instead of overwriting
     321.TP
     322.B \-\-use\-compress\-program PROG
     323filter the archive through PROG (which must accept \-d)
     324.TP
     325.B \-v, \-\-verbose             
     326verbosely list files processed
     327.TP
     328.B \-V, \-\-label NAME 
     329create archive with volume name NAME
     330.TP
     331.B \-\-version         
     332print tar program version number
     333.TP
     334.B \-\-volno\-file F
     335keep track of current volume (of a multi-volume archive) in F
     336.TP
     337.B \-w, \-\-interactive, \-\-confirmation       
     338ask for confirmation for every action
     339.TP
     340.B \-W, \-\-verify             
     341attempt to verify the archive after writing it
     342.TP
     343.B \-\-wildcards
     344use wildcards when excluding files (the default)
     345.TP
     346.B \-\-wildcards\-match\-slash
     347allow wildcards to match "/" (the default)
     348.TP
     349.B \-X, \-\-exclude\-from=FILE 
     350exclude files matching patterns listed in FILE
     351.TP
     352.B \-Z, \-\-compress, \-\-uncompress           
     353filter the archive through compress
     354.TP
     355.B \-z, \-\-gzip, \-\-gunzip, \-\-ungzip               
     356filter the archive through gzip
     357.TP
     358.B \-[0\-7][lmh]               
     359specify drive and density
     360.SH ENVIRONMENT
     361The behavior of tar is controlled by the following environment variables,
     362among others:
     363.TP
     364.B TAPE
     365Device or file to use for the archive if \fB--file\fR is not specified.
     366If this environment variable is unset, use stdin or stdout instead.
     367.TP
     368.B TAR_OPTIONS
     369Options to prepend to those specified on the command line, separated by
     370whitespace.  Embedded backslashes may be used to escape whitespace or
     371backslashes within an option.
     372.LP
     373In addition, the value of the blocking factor is made available to info
     374and checkpoint scripts via environment variable
     375.B TAR_BLOCKING_FACTOR.
     376.SH BUGS
     377.LP
     378The GNU folks, in general, abhor man pages and create info documents instead.
     379The maintainer of \fBtar\fR falls into this category.  Thus, this man page may
     380not be complete nor current, and it is included in the Cross-LFS Build
     381because man is a great tool :).  This man page was taken from Debian
     382Linux and has since been lovingly updated here.
     383
     384If you want to read the complete documentation for GNU tar, please refer to
     385the online version at
     386.PP
     387.ce 1
     388<http://www.gnu.org/software/tar/manual/index.html>
     389.PP
     390This man page was created for the Cross LFS Build.  It does not describe
     391all of the functionality of tar, and it is often out of date.  Patches to
     392improve the coverage and/or accuracy of this man page are appreciated, and
     393should be filed as tickets in bug reporting system for Cross-LFS and
     394not submitted to the GNU tar maintainers. The URL for the Cross-LFS bug
     395reporting system is at
     396.PP
     397.ce 1
     398<http://trac.cross-lfs.org>
     399.PP
     400
Note: See TracBrowser for help on using the repository browser.