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

clfs-1.2 clfs-2.1 clfs-3.0.0-systemd clfs-3.0.0-sysvinit systemd sysvinit
Last change on this file since f1f3213 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
RevLine 
[ce3a096]1Submitted By: Jim Gifford (jim at cross-lfs dot org)
2Date: 2009-01-04
3Initial Package Version: 1.21
4Origin: Debian
5Upstream Status: N/A
6Description: This Patch adds and man-page to TAR. This has been
7 added as per numerous requests.
8
9diff -Naur tar-1.21.orig/doc/Makefile.am tar-1.21/doc/Makefile.am
10--- tar-1.21.orig/doc/Makefile.am 2008-04-14 05:03:12.000000000 -0700
11+++ tar-1.21/doc/Makefile.am 2009-01-04 21:40:09.000000000 -0800
12@@ -17,6 +17,8 @@
13 ## along with this program; if not, write to the Free Software Foundation,
14 ## Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15
16+man_MANS = tar.1
17+
18 info_TEXINFOS = tar.texi
19 tar_TEXINFOS = \
20 dumpdir.texi\
21diff -Naur tar-1.21.orig/doc/Makefile.in tar-1.21/doc/Makefile.in
22--- tar-1.21.orig/doc/Makefile.in 2008-12-26 14:41:47.000000000 -0800
23+++ tar-1.21/doc/Makefile.in 2009-01-04 21:41:05.000000000 -0800
24@@ -143,13 +143,16 @@
25 MAKEINFOHTML = $(MAKEINFO) --html
26 AM_MAKEINFOHTMLFLAGS = $(AM_MAKEINFOFLAGS)
27 DVIPS = dvips
28-am__installdirs = "$(DESTDIR)$(infodir)"
29+am__installdirs = "$(DESTDIR)$(infodir)" "$(DESTDIR)$(man1dir)"
30 am__vpath_adj_setup = srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`;
31 am__vpath_adj = case $$p in \
32 $(srcdir)/*) f=`echo "$$p" | sed "s|^$$srcdirstrip/||"`;; \
33 *) f=$$p;; \
34 esac;
35 am__strip_dir = `echo $$p | sed -e 's|^.*/||'`;
36+man1dir = $(mandir)/man1
37+NROFF = nroff
38+MANS = $(man_MANS)
39 DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST)
40 ACLOCAL = @ACLOCAL@
41 ALLOCA = @ALLOCA@
42@@ -592,6 +595,7 @@
43 target_alias = @target_alias@
44 top_builddir = @top_builddir@
45 top_srcdir = @top_srcdir@
46+man_MANS = tar.1
47 info_TEXINFOS = tar.texi
48 tar_TEXINFOS = \
49 dumpdir.texi\
50@@ -805,6 +809,51 @@
51 echo " rm -f $$i $$i-[0-9] $$i-[0-9][0-9] $$i_i[0-9] $$i_i[0-9][0-9]"; \
52 rm -f $$i $$i-[0-9] $$i-[0-9][0-9] $$i_i[0-9] $$i_i[0-9][0-9]; \
53 done
54+install-man1: $(man1_MANS) $(man_MANS)
55+ @$(NORMAL_INSTALL)
56+ test -z "$(man1dir)" || $(MKDIR_P) "$(DESTDIR)$(man1dir)"
57+ @list='$(man1_MANS) $(dist_man1_MANS) $(nodist_man1_MANS)'; \
58+ l2='$(man_MANS) $(dist_man_MANS) $(nodist_man_MANS)'; \
59+ for i in $$l2; do \
60+ case "$$i" in \
61+ *.1*) list="$$list $$i" ;; \
62+ esac; \
63+ done; \
64+ for i in $$list; do \
65+ if test -f $(srcdir)/$$i; then file=$(srcdir)/$$i; \
66+ else file=$$i; fi; \
67+ ext=`echo $$i | sed -e 's/^.*\\.//'`; \
68+ case "$$ext" in \
69+ 1*) ;; \
70+ *) ext='1' ;; \
71+ esac; \
72+ inst=`echo $$i | sed -e 's/\\.[0-9a-z]*$$//'`; \
73+ inst=`echo $$inst | sed -e 's/^.*\///'`; \
74+ inst=`echo $$inst | sed '$(transform)'`.$$ext; \
75+ echo " $(INSTALL_DATA) '$$file' '$(DESTDIR)$(man1dir)/$$inst'"; \
76+ $(INSTALL_DATA) "$$file" "$(DESTDIR)$(man1dir)/$$inst"; \
77+ done
78+uninstall-man1:
79+ @$(NORMAL_UNINSTALL)
80+ @list='$(man1_MANS) $(dist_man1_MANS) $(nodist_man1_MANS)'; \
81+ l2='$(man_MANS) $(dist_man_MANS) $(nodist_man_MANS)'; \
82+ for i in $$l2; do \
83+ case "$$i" in \
84+ *.1*) list="$$list $$i" ;; \
85+ esac; \
86+ done; \
87+ for i in $$list; do \
88+ ext=`echo $$i | sed -e 's/^.*\\.//'`; \
89+ case "$$ext" in \
90+ 1*) ;; \
91+ *) ext='1' ;; \
92+ esac; \
93+ inst=`echo $$i | sed -e 's/\\.[0-9a-z]*$$//'`; \
94+ inst=`echo $$inst | sed -e 's/^.*\///'`; \
95+ inst=`echo $$inst | sed '$(transform)'`.$$ext; \
96+ echo " rm -f '$(DESTDIR)$(man1dir)/$$inst'"; \
97+ rm -f "$(DESTDIR)$(man1dir)/$$inst"; \
98+ done
99 tags: TAGS
100 TAGS:
101
102@@ -843,9 +892,9 @@
103 dist-info
104 check-am: all-am
105 check: check-am
106-all-am: Makefile $(INFO_DEPS)
107+all-am: Makefile $(INFO_DEPS) $(MANS)
108 installdirs:
109- for dir in "$(DESTDIR)$(infodir)"; do \
110+ for dir in "$(DESTDIR)$(infodir)" "$(DESTDIR)$(man1dir)"; do \
111 test -z "$$dir" || $(MKDIR_P) "$$dir"; \
112 done
113 install: install-am
114@@ -892,7 +941,7 @@
115
116 info-am: $(INFO_DEPS)
117
118-install-data-am: install-info-am
119+install-data-am: install-info-am install-man
120
121 install-dvi: install-dvi-am
122
123@@ -957,7 +1006,7 @@
124 install-info --info-dir="$(DESTDIR)$(infodir)" "$(DESTDIR)$(infodir)/$$relfile" || :;\
125 done; \
126 else : ; fi
127-install-man:
128+install-man: install-man1
129
130 install-pdf: install-pdf-am
131
132@@ -1001,7 +1050,9 @@
133 ps-am: $(PSS)
134
135 uninstall-am: uninstall-dvi-am uninstall-html-am uninstall-info-am \
136- uninstall-pdf-am uninstall-ps-am
137+ uninstall-man uninstall-pdf-am uninstall-ps-am
138+
139+uninstall-man: uninstall-man1
140
141 .MAKE: install-am install-strip
142
143@@ -1010,14 +1061,15 @@
144 html-am info info-am install install-am install-data \
145 install-data-am install-dvi install-dvi-am install-exec \
146 install-exec-am install-html install-html-am install-info \
147- install-info-am install-man install-pdf install-pdf-am \
148- install-ps install-ps-am install-strip installcheck \
149- installcheck-am installdirs maintainer-clean \
150+ install-info-am install-man install-man1 install-pdf \
151+ install-pdf-am install-ps install-ps-am install-strip \
152+ installcheck installcheck-am installdirs maintainer-clean \
153 maintainer-clean-aminfo maintainer-clean-generic \
154 maintainer-clean-vti mostlyclean mostlyclean-aminfo \
155 mostlyclean-generic mostlyclean-vti pdf pdf-am ps ps-am \
156 uninstall uninstall-am uninstall-dvi-am uninstall-html-am \
157- uninstall-info-am uninstall-pdf-am uninstall-ps-am
158+ uninstall-info-am uninstall-man uninstall-man1 \
159+ uninstall-pdf-am uninstall-ps-am
160
161
162 header.texi: $(top_srcdir)/src/tar.h
163diff -Naur tar-1.21.orig/doc/tar.1 tar-1.21/doc/tar.1
164--- tar-1.21.orig/doc/tar.1 1969-12-31 16:00:00.000000000 -0800
165+++ tar-1.21/doc/tar.1 2009-01-04 21:30:00.000000000 -0800
166@@ -0,0 +1,394 @@
167+.\" @(#)tar.1 1.11.1 93/19/22 PJV;
168+.TH TAR 1 "29 Aug 2007"
169+.SH NAME
170+tar \- The GNU version of the tar archiving utility
171+.SH SYNOPSIS
172+.B tar
173+[
174+.B \-
175+]
176+.B A \-\-catenate \-\-concatenate \||\| c \-\-create \||\| d \-\-diff \-\-compare \||\| \-\-delete \||\| r \-\-append \||\| t \-\-list \||\| u \-\-update \||\| x \-\-extract \-\-get
177+.I [ options ]
178+.I pathname [ pathname ... ]
179+.SH DESCRIPTION
180+.LP
181+This manual page documents the GNU version of
182+.B tar
183+, an archiving program designed to store and extract files from
184+an archive file known as a
185+.IR tarfile.
186+A
187+.IR tarfile
188+may be made on a tape drive, however, it is also common
189+to write a
190+.IR tarfile
191+to a normal file.
192+The first argument to
193+.B tar
194+must be one of the options:
195+.BR Acdrtux ,
196+followed by any optional functions.
197+The final arguments to
198+.B tar
199+are the names of the files or directories which should be archived. The use
200+of a directory name always implies that the subdirectories below should be
201+included in the archive.
202+.SH EXAMPLES
203+.TP
204+.B tar \-xvvf foo.tar
205+extract foo.tar
206+.TP
207+.B tar \-xvvzf foo.tar.gz
208+extract gzipped foo.tar.gz
209+.TP
210+.B tar \-cvvf foo.tar foo/
211+tar contents of folder foo in foo.tar
212+.SH "FUNCTION LETTERS"
213+.TP
214+.B One of the following options must be used:
215+.TP
216+.B \-A, \-\-catenate, \-\-concatenate
217+append tar files to an archive
218+.TP
219+.B \-c, \-\-create
220+create a new archive
221+.TP
222+.B \-d, \-\-diff, \-\-compare
223+find differences between archive and file system
224+.TP
225+.B \-\-delete
226+delete from the archive (not for use on mag tapes!)
227+.TP
228+.B \-r, \-\-append
229+append files to the end of an archive
230+.TP
231+.B \-t, \-\-list
232+list the contents of an archive
233+.TP
234+.B \-u, \-\-update
235+only append files that are newer than copy in archive
236+.TP
237+.B \-x, \-\-extract, \-\-get
238+extract files from an archive
239+.SH "OTHER OPTIONS"
240+.TP
241+.B \-\-allow\-name\-mangling
242+re-enable handling of GNUTYPE_NAMES which is now disabled by default
243+.TP
244+.B \-\-anchored
245+force exclusion patterns to match initial subsequences
246+.TP
247+.B \-\-atime\-preserve
248+don't change access times on dumped files
249+.TP
250+.B \-a, \-\-auto\-compress
251+with \-\-create, selects compression algorithm basing on the suffix
252+of the archive file name
253+.TP
254+.B \-b, \-\-blocking\-factor N
255+use record size of Nx512 bytes (default N=20)
256+.TP
257+.B \-B, \-\-read\-full\-records
258+reblock as we read (for reading 4.2BSD pipes)
259+.TP
260+.B \-\-backup[\=TYPE]
261+back up files instead of overwriting (TYPE=numbered, existing, simple)
262+.TP
263+.B \-C, \-\-directory DIR
264+change to directory DIR
265+.TP
266+.B \-\-checkpoint
267+print periodic checkpoints
268+.TP
269+.B \-\-checkpoint\-action
270+this action allows to specify an action to be executed upon hitting a
271+checkpoint. Recognized actions are: dot, echo (the default),
272+echo\=string, ttyout\=string, exec\=cmdline, and sleep\=value. Any number
273+of `\-\-checkpoint\-action' options can be specified, the actions will be
274+executed in order of their appearance in the command line.
275+.TP
276+.B \-\-check\-device
277+enables comparing device numbers. This is the default.
278+.TP
279+.B \-\-no\-check\-device
280+disables comparing device numbers during preparatory stage of an
281+incremental dump.
282+This allows to avoid creating full dumps if the device numbers change
283+(e.g. when using an LVM snapshot)
284+.TP
285+.B \-\-exclude=PATTERN
286+exclude files matching PATTERN
287+.TP
288+.B \-f, \-\-file [HOSTNAME:]F
289+use archive file or device F (otherwise value of TAPE environment variable; if unset, "\-", meaning stdin/stdout)
290+.TP
291+.B \-F, \-\-info\-script F, \-\-new\-volume\-script F
292+run script at end of each tape (implies \-M)
293+.TP
294+.B \-\-force\-local
295+archive file is local even if it has a colon
296+.TP
297+.B \-G, \-\-incremental
298+create/list/extract old GNU-format incremental backup
299+.TP
300+.B \-g, \-\-listed\-incremental F
301+create/list/extract new GNU-format incremental backup
302+.TP
303+.B \-\-group G
304+set group to G while adding files
305+.TP
306+.B \-h, \-\-dereference
307+don't dump symlinks; dump the files they point to
308+.TP
309+.B \-\-hard\-dereference
310+during archive creation, dereferences hard links and stores the files
311+they refer to, instead of creating usual hard link members (type '1')
312+.TP
313+.B \-\-help
314+print help message
315+.TP
316+.B \-i, \-\-ignore\-zeros
317+ignore blocks of zeros in archive (normally mean EOF)
318+.TP
319+.B \-\-ignore\-case
320+ignore case when excluding files
321+.TP
322+.B \-\-ignore\-failed\-read
323+don't exit with non-zero status on unreadable files
324+.TP
325+.B \-j, \-\-bzip2
326+filter archive through bzip2, use to decompress .bz2 files.
327+WARNING: some previous versions of tar used option \-I to
328+filter through bzip2. When writing scripts, use \-\-bzip2
329+instead of \-j so that both older and newer tar versions
330+will work.
331+.TP
332+.B \-k, \-\-keep\-old\-files
333+keep existing files; don't overwrite them from archive
334+.TP
335+.B \-K, \-\-starting\-file F
336+begin at file F in the archive
337+.TP
338+.B \-\-lzma
339+selects LZMA compression algorithm
340+.TP
341+.B \-l, \-\-check\-links
342+print a message if not all links are dumped
343+.TP
344+.B \-L, \-\-tape\-length N
345+change tapes after writing N*1024 bytes
346+.TP
347+.B \-m, \-\-touch
348+don't extract file modified time
349+.TP
350+.BI \-\-transform " expr"
351+applies filename transformations.
352+The argument to this option can be a list of replace expressions, separated
353+by semicolon (as in `sed').
354+Filename transformations are applied to symbolic link targets during both
355+creation and extraction.
356+This option may be specified any number of
357+times, the specified transofrmations will be applied in turn.
358+.TP
359+.B \-M, \-\-multi\-volume
360+create/list/extract multi-volume archive
361+.TP
362+.B \-\-mode M
363+set permissions to M while adding files
364+.TP
365+.B \-N, \-\-after\-date DATE, \-\-newer DATE
366+only store files newer than DATE
367+.TP
368+.B \-\-newer\-mtime DATE
369+only store files whose contents have changed after DATE
370+.TP
371+.B \-\-no\-anchored
372+allow exclusion patterns to match any substring (the default)
373+.TP
374+.B \-\-no\-ignore\-case
375+match patterns case sensitively (the default)
376+.TP
377+.B \-\-no\-recursion
378+do not recurse into subdirectories
379+.TP
380+.B \-o, \-\-no\-same\-owner
381+extract files with owner set to current user (the default for non-root
382+users)
383+.TP
384+.B \-\-no\-same\-permissions
385+apply umask to extracted files (the default for non-root users)
386+.TP
387+.B \-\-no\-wildcards
388+do not use wildcards when excluding files
389+.TP
390+.B \-\-no\-wildcards\-match\-slash
391+don't let wildcards match "/" when excluding files
392+.TP
393+.B \-\-null
394+for \-T, use "NUL" instead of newline as filename terminator
395+.TP
396+.B \-\-numeric\-owner
397+always use numbers for user/group names
398+.TP
399+.B \-\-old\-archive, \-\-portability
400+write a V7 format archive, rather than ANSI format. These options are
401+deprecated, please use
402+.B \-\-format\=v7
403+instead.
404+.TP
405+.B \-\-one\-file\-system
406+stay in local file system when creating an archive
407+.TP
408+.B \-\-owner O
409+set owner to O while adding files
410+.TP
411+.B \-O, \-\-to\-stdout
412+extract files to standard output
413+.TP
414+.B \-p, \-\-same\-permissions, \-\-preserve\-permissions
415+ignore umask when extracting files (the default for root)
416+.TP
417+.B \-P, \-\-absolute\-names
418+don't strip leading `/'s from file names
419+.TP
420+.B \-\-posix
421+create POSIX compliant archive. This option is deprecated,
422+please use
423+.B \-\-format\=posix
424+instead.
425+.TP
426+.B \-\-preserve
427+like \-p \-s
428+.TP
429+.B \-R, \-\-block\-number
430+show block number within archive with each message
431+.TP
432+.B \-\-record\-size SIZE
433+use SIZE bytes per record
434+.TP
435+.B \-\-recursion
436+recurse into directories (the default)
437+.TP
438+.B \-\-recursive\-unlink
439+remove existing directories before extracting directories of the same
440+name
441+.TP
442+.B \-\-remove\-files
443+remove files after adding them to the archive
444+.TP
445+.B \-\-rsh\-command=CMD
446+Use remote COMMAND instead of `rsh'. This option exists so that
447+people who use something other than the standard `rsh' (e.g., a
448+Kerberized `rsh') can access a remote device.
449+.TP
450+.B \-S, \-\-sparse
451+handle sparse files efficiently
452+.TP
453+.B \-s, \-\-same\-order, \-\-preserve\-order
454+list of names to extract is sorted to match archive
455+.TP
456+.B \-\-same\-owner
457+extract files with owner as specified in archive (the default for
458+root)
459+.TP
460+.B \-\-show\-omitted\-dirs
461+mention directories that are being skipped over
462+.TP
463+.BI \-\-strip\-components " n"
464+Strip the given number of leading directory components
465+.TP
466+.B \-\-strip, \-\-strip\-components N
467+Strips the first N components from archive members' pathnames when
468+unpacking.
469+.TP
470+.B \-\-suffix SUFFIX
471+append SUFFIX to make backup files (default ~)
472+.TP
473+.B \-T, \-\-files\-from F
474+get names to extract or archive from file F
475+.TP
476+.B \-\-totals
477+display total bytes written after creating an archive
478+.TP
479+.B \-U, \-\-unlink\-first
480+unlink & recreate files instead of overwriting
481+.TP
482+.B \-\-use\-compress\-program PROG
483+filter the archive through PROG (which must accept \-d)
484+.TP
485+.B \-v, \-\-verbose
486+verbosely list files processed
487+.TP
488+.B \-V, \-\-label NAME
489+create archive with volume name NAME
490+.TP
491+.B \-\-version
492+print tar program version number
493+.TP
494+.B \-\-volno\-file F
495+keep track of current volume (of a multi-volume archive) in F
496+.TP
497+.B \-w, \-\-interactive, \-\-confirmation
498+ask for confirmation for every action
499+.TP
500+.B \-W, \-\-verify
501+attempt to verify the archive after writing it
502+.TP
503+.B \-\-wildcards
504+use wildcards when excluding files (the default)
505+.TP
506+.B \-\-wildcards\-match\-slash
507+allow wildcards to match "/" (the default)
508+.TP
509+.B \-X, \-\-exclude\-from=FILE
510+exclude files matching patterns listed in FILE
511+.TP
512+.B \-Z, \-\-compress, \-\-uncompress
513+filter the archive through compress
514+.TP
515+.B \-z, \-\-gzip, \-\-gunzip, \-\-ungzip
516+filter the archive through gzip
517+.TP
518+.B \-[0\-7][lmh]
519+specify drive and density
520+.SH ENVIRONMENT
521+The behavior of tar is controlled by the following environment variables,
522+among others:
523+.TP
524+.B TAPE
525+Device or file to use for the archive if \fB--file\fR is not specified.
526+If this environment variable is unset, use stdin or stdout instead.
527+.TP
528+.B TAR_OPTIONS
529+Options to prepend to those specified on the command line, separated by
530+whitespace. Embedded backslashes may be used to escape whitespace or
531+backslashes within an option.
532+.LP
533+In addition, the value of the blocking factor is made available to info
534+and checkpoint scripts via environment variable
535+.B TAR_BLOCKING_FACTOR.
536+.SH BUGS
537+.LP
538+The GNU folks, in general, abhor man pages and create info documents instead.
539+The maintainer of \fBtar\fR falls into this category. Thus, this man page may
540+not be complete nor current, and it is included in the Cross-LFS Build
541+because man is a great tool :). This man page was taken from Debian
542+Linux and has since been lovingly updated here.
543+
544+If you want to read the complete documentation for GNU tar, please refer to
545+the online version at
546+.PP
547+.ce 1
548+<http://www.gnu.org/software/tar/manual/index.html>
549+.PP
550+This man page was created for the Cross LFS Build. It does not describe
551+all of the functionality of tar, and it is often out of date. Patches to
552+improve the coverage and/or accuracy of this man page are appreciated, and
553+should be filed as tickets in bug reporting system for Cross-LFS and
554+not submitted to the GNU tar maintainers. The URL for the Cross-LFS bug
555+reporting system is at
556+.PP
557+.ce 1
558+<http://trac.cross-lfs.org>
559+.PP
560+
Note: See TracBrowser for help on using the repository browser.