Date: Sun, 24 Jan 1999 19:00:13 +0900 From: horikawa@jp.freebsd.org To: FreeBSD-gnats-submit@FreeBSD.ORG Subject: docs/9658: tar(1) SYNOPSIS refinement Message-ID: <19990124190013W.k-horik@yk.rim.or.jp>
next in thread | raw e-mail | index | archive | help
>Number: 9658
>Category: docs
>Synopsis: tar(1) SYNOPSIS refinement
>Confidential: no
>Severity: non-critical
>Priority: medium
>Responsible: freebsd-doc
>State: open
>Quarter:
>Keywords:
>Date-Required:
>Class: doc-bug
>Submitter-Id: current-users
>Arrival-Date: Sun Jan 24 02:10:00 PST 1999
>Closed-Date:
>Last-Modified:
>Originator: Kazuo Horikawa
>Release: FreeBSD 2.2.7-RELEASE i386
>Organization:
jpman project, Japan FreeBSD Users Group
>Environment:
src/gnu/usr.bin/tar/tar.1 revision 1.18 (HEAD and RELENG_3)
>Description:
tar.1's SYNOPSIS says:
SYNOPSIS
tar [[-]bundled-options] [gnu-style-flags] [tarfile] [blocksize]
[exclude-file] [filenames] [-C directory-name]
while I think that tar.1's SYNOPSIS should be:
SYNOPSIS
tar [[-]bundled-options args] [gnu-style-flags] [filenames | -C
directory-name] ...
The reasons why I think as above are described below.
o About [tarfile], [blocksize], and [exclude-file]:
- The order of tarfile, blocksize, exclude-file depends
on the order of bubdled-options.
Ex. $ tar xfb tarfile blocksize
$ tar xbf blocksize tarfile
- gnu-style-flags should not exist between bundled-options
and arguments (tarfile, blocksize, exclude-file, and
etc.).
Ex.
$ {128} ls
files tarfile
$ tar cf --blocking-facotr=64 tarfile files
$ ls
--blocking-facotr=64 files tarfile
So, I think that [tarfile], [blocksize], and [exclude-file]
should be expressed as `args' and should follow
bundled-options.
o About [filenames] and [-C directory-name]:
-C option is applied for following filenames and can be
speficied multiple.
Ex.
$ ls /tmp/a /tmp/b
/tmp/a:
a1 a2
/tmp/b:
b1 b2
$ tar cvf tarfile -C /tmp/a a1 a2 -C /tmp/b b1 b2
a1
a2
b1
b2
So, I think that `[filenames | -C directory-name] ...' is
better than `[filenames] [-C directory-name]'.
>How-To-Repeat:
$ man 1 tar
>Fix:
Apply following patch for src/gnu/usr.bin/tar/tar.1 revision
1.18 (HEAD and RELENG_3).
--- tar.1.bak Sun Jan 24 18:07:24 1999
+++ tar.1 Sun Jan 24 18:09:41 1999
@@ -15,13 +15,11 @@
tape archiver; manipulate "tar" archive files
.Sh SYNOPSIS
.Nm tar
-.Op [-] Ns Ar bundled-options
+.Op [-] Ns Ar bundled-options Ar args
.Op Ar gnu-style-flags
-.Op Ar tarfile
-.Op Ar blocksize
-.Op Ar exclude-file
-.Op Ar filenames
-.Op Fl C Ar directory-name
+.Oo
+.Ar filenames | Fl C Ar directory-name
+.Oc ...
.Sh DESCRIPTION
.Nm Tar
is short for
>Release-Note:
>Audit-Trail:
>Unformatted:
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?19990124190013W.k-horik>