source: patches/tar-1.21-man_page-1.patch@ 29a9276

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

Added: TAR Man Page Patch
  • Property mode set to 100644
File size: 16.6 KB

  • doc/Makefile.am 

    Submitted By: Jim Gifford (jim at cross-lfs dot org)
Date: 2009-01-04
Initial Package Version: 1.21
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.21.orig/doc/Makefile.am tar-1.21/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.21.orig/doc/Makefile.in tar-1.21/doc/Makefile.in
    old new  
    143143MAKEINFOHTML = $(MAKEINFO) --html
    144144AM_MAKEINFOHTMLFLAGS = $(AM_MAKEINFOFLAGS)
    145145DVIPS = dvips
    146 am__installdirs = "$(DESTDIR)$(infodir)"
     146am__installdirs = "$(DESTDIR)$(infodir)" "$(DESTDIR)$(man1dir)"
    147147am__vpath_adj_setup = srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`;
    148148am__vpath_adj = case $$p in \
    149149    $(srcdir)/*) f=`echo "$$p" | sed "s|^$$srcdirstrip/||"`;; \
    150150    *) f=$$p;; \
    151151  esac;
    152152am__strip_dir = `echo $$p | sed -e 's|^.*/||'`;
     153man1dir = $(mandir)/man1
     154NROFF = nroff
     155MANS = $(man_MANS)
    153156DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST)
    154157ACLOCAL = @ACLOCAL@
    155158ALLOCA = @ALLOCA@
    … …  
    592595target_alias = @target_alias@
    593596top_builddir = @top_builddir@
    594597top_srcdir = @top_srcdir@
     598man_MANS = tar.1
    595599info_TEXINFOS = tar.texi
    596600tar_TEXINFOS = \
    597601 dumpdir.texi\
    … …  
    805809          echo " rm -f $$i $$i-[0-9] $$i-[0-9][0-9] $$i_i[0-9] $$i_i[0-9][0-9]"; \
    806810          rm -f $$i $$i-[0-9] $$i-[0-9][0-9] $$i_i[0-9] $$i_i[0-9][0-9]; \
    807811        done
     812install-man1: $(man1_MANS) $(man_MANS)
     813        @$(NORMAL_INSTALL)
     814        test -z "$(man1dir)" || $(MKDIR_P) "$(DESTDIR)$(man1dir)"
     815        @list='$(man1_MANS) $(dist_man1_MANS) $(nodist_man1_MANS)'; \
     816        l2='$(man_MANS) $(dist_man_MANS) $(nodist_man_MANS)'; \
     817        for i in $$l2; do \
     818          case "$$i" in \
     819            *.1*) list="$$list $$i" ;; \
     820          esac; \
     821        done; \
     822        for i in $$list; do \
     823          if test -f $(srcdir)/$$i; then file=$(srcdir)/$$i; \
     824          else file=$$i; fi; \
     825          ext=`echo $$i | sed -e 's/^.*\\.//'`; \
     826          case "$$ext" in \
     827            1*) ;; \
     828            *) ext='1' ;; \
     829          esac; \
     830          inst=`echo $$i | sed -e 's/\\.[0-9a-z]*$$//'`; \
     831          inst=`echo $$inst | sed -e 's/^.*\///'`; \
     832          inst=`echo $$inst | sed '$(transform)'`.$$ext; \
     833          echo " $(INSTALL_DATA) '$$file' '$(DESTDIR)$(man1dir)/$$inst'"; \
     834          $(INSTALL_DATA) "$$file" "$(DESTDIR)$(man1dir)/$$inst"; \
     835        done
     836uninstall-man1:
     837        @$(NORMAL_UNINSTALL)
     838        @list='$(man1_MANS) $(dist_man1_MANS) $(nodist_man1_MANS)'; \
     839        l2='$(man_MANS) $(dist_man_MANS) $(nodist_man_MANS)'; \
     840        for i in $$l2; do \
     841          case "$$i" in \
     842            *.1*) list="$$list $$i" ;; \
     843          esac; \
     844        done; \
     845        for i in $$list; do \
     846          ext=`echo $$i | sed -e 's/^.*\\.//'`; \
     847          case "$$ext" in \
     848            1*) ;; \
     849            *) ext='1' ;; \
     850          esac; \
     851          inst=`echo $$i | sed -e 's/\\.[0-9a-z]*$$//'`; \
     852          inst=`echo $$inst | sed -e 's/^.*\///'`; \
     853          inst=`echo $$inst | sed '$(transform)'`.$$ext; \
     854          echo " rm -f '$(DESTDIR)$(man1dir)/$$inst'"; \
     855          rm -f "$(DESTDIR)$(man1dir)/$$inst"; \
     856        done
    808857tags: TAGS
    809858TAGS:
    810859
    … …  
    843892          dist-info
    844893check-am: all-am
    845894check: check-am
    846 all-am: Makefile $(INFO_DEPS)
     895all-am: Makefile $(INFO_DEPS) $(MANS)
    847896installdirs:
    848         for dir in "$(DESTDIR)$(infodir)"; do \
     897        for dir in "$(DESTDIR)$(infodir)" "$(DESTDIR)$(man1dir)"; do \
    849898          test -z "$$dir" || $(MKDIR_P) "$$dir"; \
    850899        done
    851900install: install-am
    … …  
    892941
    893942info-am: $(INFO_DEPS)
    894943
    895 install-data-am: install-info-am
     944install-data-am: install-info-am install-man
    896945
    897946install-dvi: install-dvi-am
    898947
    … …  
    9571006            install-info --info-dir="$(DESTDIR)$(infodir)" "$(DESTDIR)$(infodir)/$$relfile" || :;\
    9581007          done; \
    9591008        else : ; fi
    960 install-man:
     1009install-man: install-man1
    9611010
    9621011install-pdf: install-pdf-am
    9631012
    … …  
    10011050ps-am: $(PSS)
    10021051
    10031052uninstall-am: uninstall-dvi-am uninstall-html-am uninstall-info-am \
    1004         uninstall-pdf-am uninstall-ps-am
     1053        uninstall-man uninstall-pdf-am uninstall-ps-am
     1054
     1055uninstall-man: uninstall-man1
    10051056
    10061057.MAKE: install-am install-strip
    10071058
    … …  
    10101061        html-am info info-am install install-am install-data \
    10111062        install-data-am install-dvi install-dvi-am install-exec \
    10121063        install-exec-am install-html install-html-am install-info \
    1013         install-info-am install-man install-pdf install-pdf-am \
    1014         install-ps install-ps-am install-strip installcheck \
    1015         installcheck-am installdirs maintainer-clean \
     1064        install-info-am install-man install-man1 install-pdf \
     1065        install-pdf-am install-ps install-ps-am install-strip \
     1066        installcheck installcheck-am installdirs maintainer-clean \
    10161067        maintainer-clean-aminfo maintainer-clean-generic \
    10171068        maintainer-clean-vti mostlyclean mostlyclean-aminfo \
    10181069        mostlyclean-generic mostlyclean-vti pdf pdf-am ps ps-am \
    10191070        uninstall uninstall-am uninstall-dvi-am uninstall-html-am \
    1020         uninstall-info-am uninstall-pdf-am uninstall-ps-am
     1071        uninstall-info-am uninstall-man uninstall-man1 \
     1072        uninstall-pdf-am uninstall-ps-am
    10211073
    10221074
    10231075header.texi: $(top_srcdir)/src/tar.h

  • doc/tar.1 

    diff -Naur tar-1.21.orig/doc/tar.1 tar-1.21/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 \-k, \-\-keep\-old\-files   
     167keep existing files; don't overwrite them from archive
     168.TP
     169.B \-K, \-\-starting\-file F   
     170begin at file F in the archive
     171.TP
     172.B \-\-lzma
     173selects LZMA compression algorithm
     174.TP
     175.B \-l, \-\-check\-links
     176print a message if not all links are dumped
     177.TP
     178.B \-L, \-\-tape\-length N     
     179change tapes after writing N*1024 bytes
     180.TP
     181.B \-m, \-\-touch
     182don't extract file modified time
     183.TP
     184.BI \-\-transform " expr"
     185applies filename transformations. 
     186The argument to this option can be a list of replace expressions, separated
     187by semicolon (as in `sed').
     188Filename transformations are applied to symbolic link targets during both
     189creation and extraction.
     190This option may be specified any number of
     191times, the specified transofrmations will be applied in turn.
     192.TP
     193.B \-M, \-\-multi\-volume       
     194create/list/extract multi-volume archive
     195.TP
     196.B \-\-mode M
     197set permissions to M while adding files
     198.TP
     199.B \-N, \-\-after\-date DATE, \-\-newer DATE
     200only store files newer than DATE
     201.TP
     202.B \-\-newer\-mtime DATE
     203only store files whose contents have changed after DATE
     204.TP
     205.B \-\-no\-anchored
     206allow exclusion patterns to match any substring (the default)
     207.TP
     208.B \-\-no\-ignore\-case
     209match patterns case sensitively (the default)
     210.TP
     211.B \-\-no\-recursion
     212do not recurse into subdirectories
     213.TP
     214.B \-o, \-\-no\-same\-owner
     215extract files with owner set to current user (the default for non-root
     216users)
     217.TP
     218.B \-\-no\-same\-permissions
     219apply umask to extracted files (the default for non-root users)
     220.TP
     221.B \-\-no\-wildcards
     222do not use wildcards when excluding files
     223.TP
     224.B \-\-no\-wildcards\-match\-slash
     225don't let wildcards match "/" when excluding files
     226.TP
     227.B \-\-null
     228for \-T, use "NUL" instead of newline as filename terminator
     229.TP
     230.B \-\-numeric\-owner
     231always use numbers for user/group names
     232.TP
     233.B \-\-old\-archive, \-\-portability   
     234write a V7 format archive, rather than ANSI format.  These options are
     235deprecated, please use
     236.B \-\-format\=v7
     237instead.
     238.TP
     239.B \-\-one\-file\-system       
     240stay in local file system when creating an archive
     241.TP
     242.B \-\-owner O
     243set owner to O while adding files
     244.TP
     245.B \-O, \-\-to\-stdout         
     246extract files to standard output
     247.TP
     248.B \-p, \-\-same\-permissions, \-\-preserve\-permissions
     249ignore umask when extracting files (the default for root)
     250.TP
     251.B \-P, \-\-absolute\-names
     252don't strip leading `/'s from file names
     253.TP
     254.B \-\-posix
     255create POSIX compliant archive.  This option is deprecated,
     256please use
     257.B \-\-format\=posix
     258instead.
     259.TP
     260.B \-\-preserve         
     261like \-p \-s
     262.TP
     263.B \-R, \-\-block\-number       
     264show block number within archive with each message
     265.TP
     266.B \-\-record\-size SIZE
     267use SIZE bytes per record
     268.TP
     269.B \-\-recursion
     270recurse into directories (the default)
     271.TP
     272.B \-\-recursive\-unlink
     273remove existing directories before extracting directories of the same
     274name
     275.TP
     276.B \-\-remove\-files           
     277remove files after adding them to the archive
     278.TP
     279.B \-\-rsh\-command=CMD
     280Use remote COMMAND instead of `rsh'.  This option exists so that
     281people who use something other than the standard `rsh' (e.g., a
     282Kerberized `rsh') can access a remote device.
     283.TP
     284.B \-S, \-\-sparse             
     285handle sparse files efficiently
     286.TP
     287.B \-s, \-\-same\-order, \-\-preserve\-order   
     288list of names to extract is sorted to match archive
     289.TP
     290.B \-\-same\-owner             
     291extract files with owner as specified in archive (the default for
     292root)
     293.TP
     294.B \-\-show\-omitted\-dirs
     295mention directories that are being skipped over
     296.TP
     297.BI \-\-strip\-components " n"
     298Strip the given number of leading directory components
     299.TP
     300.B \-\-strip, \-\-strip\-components N
     301Strips the first N components from archive members' pathnames when
     302unpacking.
     303.TP
     304.B \-\-suffix SUFFIX
     305append SUFFIX to make backup files (default ~)
     306.TP
     307.B \-T, \-\-files\-from F       
     308get names to extract or archive from file F
     309.TP
     310.B \-\-totals
     311display total bytes written after creating an archive
     312.TP
     313.B \-U, \-\-unlink\-first
     314unlink & recreate files instead of overwriting
     315.TP
     316.B \-\-use\-compress\-program PROG
     317filter the archive through PROG (which must accept \-d)
     318.TP
     319.B \-v, \-\-verbose             
     320verbosely list files processed
     321.TP
     322.B \-V, \-\-label NAME 
     323create archive with volume name NAME
     324.TP
     325.B \-\-version         
     326print tar program version number
     327.TP
     328.B \-\-volno\-file F
     329keep track of current volume (of a multi-volume archive) in F
     330.TP
     331.B \-w, \-\-interactive, \-\-confirmation       
     332ask for confirmation for every action
     333.TP
     334.B \-W, \-\-verify             
     335attempt to verify the archive after writing it
     336.TP
     337.B \-\-wildcards
     338use wildcards when excluding files (the default)
     339.TP
     340.B \-\-wildcards\-match\-slash
     341allow wildcards to match "/" (the default)
     342.TP
     343.B \-X, \-\-exclude\-from=FILE 
     344exclude files matching patterns listed in FILE
     345.TP
     346.B \-Z, \-\-compress, \-\-uncompress           
     347filter the archive through compress
     348.TP
     349.B \-z, \-\-gzip, \-\-gunzip, \-\-ungzip               
     350filter the archive through gzip
     351.TP
     352.B \-[0\-7][lmh]               
     353specify drive and density
     354.SH ENVIRONMENT
     355The behavior of tar is controlled by the following environment variables,
     356among others:
     357.TP
     358.B TAPE
     359Device or file to use for the archive if \fB--file\fR is not specified.
     360If this environment variable is unset, use stdin or stdout instead.
     361.TP
     362.B TAR_OPTIONS
     363Options to prepend to those specified on the command line, separated by
     364whitespace.  Embedded backslashes may be used to escape whitespace or
     365backslashes within an option.
     366.LP
     367In addition, the value of the blocking factor is made available to info
     368and checkpoint scripts via environment variable
     369.B TAR_BLOCKING_FACTOR.
     370.SH BUGS
     371.LP
     372The GNU folks, in general, abhor man pages and create info documents instead.
     373The maintainer of \fBtar\fR falls into this category.  Thus, this man page may
     374not be complete nor current, and it is included in the Cross-LFS Build
     375because man is a great tool :).  This man page was taken from Debian
     376Linux and has since been lovingly updated here.
     377
     378If you want to read the complete documentation for GNU tar, please refer to
     379the online version at
     380.PP
     381.ce 1
     382<http://www.gnu.org/software/tar/manual/index.html>
     383.PP
     384This man page was created for the Cross LFS Build.  It does not describe
     385all of the functionality of tar, and it is often out of date.  Patches to
     386improve the coverage and/or accuracy of this man page are appreciated, and
     387should be filed as tickets in bug reporting system for Cross-LFS and
     388not submitted to the GNU tar maintainers. The URL for the Cross-LFS bug
     389reporting system is at
     390.PP
     391.ce 1
     392<http://trac.cross-lfs.org>
     393.PP
     394
Note: See TracBrowser for help on using the repository browser.