From 31c87d90f58ec3cb1e306c335d0bcae788409be1 Mon Sep 17 00:00:00 2001 From: Joerg Sonnenberger Date: Mon, 22 Feb 2010 15:31:21 -0500 Subject: [PATCH] Document the various long options and use consistent markup. SVN-Revision: 1963 --- cpio/bsdcpio.1 | 53 +++++++++++++++++++++++++------------------------- 1 file changed, 27 insertions(+), 26 deletions(-) diff --git a/cpio/bsdcpio.1 b/cpio/bsdcpio.1 index bb69fd157..65d5648fd 100644 --- a/cpio/bsdcpio.1 +++ b/cpio/bsdcpio.1 @@ -80,7 +80,7 @@ specified directory. Unless specifically stated otherwise, options are applicable in all operating modes. .Bl -tag -width indent -.It Fl 0 +.It Fl 0 , Fl Fl null Read filenames separated by NUL characters instead of newlines. This is necessary if any of the filenames being read might contain newlines. .It Fl A @@ -102,8 +102,8 @@ bytes. (o mode only) Use the old POSIX portable character format. Equivalent to -.Fl -format Ar odc . -.It Fl d +.Fl Fl format Ar odc . +.It Fl d , Fl Fl make-directories (i and p modes) Create directories as necessary. .It Fl E Ar file @@ -111,14 +111,14 @@ Create directories as necessary. Read list of file name patterns from .Ar file to list and extract. -.It Fl F Ar file +.It Fl F Ar file , Fl Fl file Ar file Read archive from or write archive to .Ar file . .It Fl f Ar pattern (i mode only) Ignore files that match .Ar pattern . -.It Fl -format Ar format +.It Fl H Ar format , Fl Fl format Ar format (o mode only) Produce the output archive in the specified format. Supported formats include: @@ -145,24 +145,21 @@ for more complete information about the formats currently supported by the underlying .Xr libarchive 3 library. -.It Fl H Ar format -Synonym for -.Fl -format . -.It Fl h , Fl -help +.It Fl h , Fl Fl help Print usage information. .It Fl I Ar file Read archive from .Ar file . -.It Fl i +.It Fl i , Fl Fl extract Input mode. See above for description. -.It Fl -insecure +.It Fl Fl insecure (i and p mode only) Disable security checks during extraction or copying. This allows extraction via symbolic links and path names containing .Sq .. in the name. -.It Fl J +.It Fl J , Fl Fl xz (o mode only) Compress the file with xz-compatible compression before writing it. In input mode, this option is ignored; xz compression is recognized @@ -175,20 +172,20 @@ Synonym for All symbolic links will be followed. Normally, symbolic links are archived and copied as symbolic links. With this option, the target of the link will be archived or copied instead. -.It Fl l +.It Fl l , Fl Fl link (p mode only) Create links from the target directory to the original files, instead of copying. -.It Fl lzma +.It Fl Fl lzma (o mode only) Compress the file with lzma-compatible compression before writing it. In input mode, this option is ignored; lzma compression is recognized automatically on input. -.It Fl m +.It Fl m , Fl Fl preserve-modification-time (i and p modes) Set file modification time on created files to match those in the source. -.It Fl n +.It Fl n , Fl Fl numeric-uid-gid (i mode, only with .Fl t ) Display numeric uid and gid. @@ -197,26 +194,26 @@ By default, displays the user and group names when they are provided in the archive, or looks up the user and group names in the system password database. -.It Fl no-preserve-owner +.It Fl Fl no-preserve-owner (i mode only) Do not attempt to restore file ownership. This is the default when run by non-root users. .It Fl O Ar file Write archive to .Ar file . -.It Fl o +.It Fl o , Fl Fl create Output mode. See above for description. -.It Fl p +.It Fl p , Fl Fl pass-through Pass-through mode. See above for description. -.It Fl preserve-owner +.It Fl Fl preserve-owner (i mode only) Restore file ownership. This is the default when run by the root user. -.It Fl -quiet +.It Fl Fl quiet Suppress unnecessary messages. -.It Fl R Oo user Oc Ns Oo : Oc Ns Oo group Oc +.It Fl R Oo user Oc Ns Oo : Oc Ns Oo group Oc , Fl Fl owner Oo user Oc Ns Oo : Oc Ns Oo group Oc Set the owner and/or group on files in the output. If group is specified with no user (for example, @@ -244,20 +241,24 @@ containing the name of the file and a line is read from If the line read is blank, the file is skipped. If the line contains a single period, the file is processed normally. Otherwise, the line is taken to be the new name of the file. -.It Fl t +.It Fl t , Fl Fl list (i mode only) List the contents of the archive to stdout; do not restore the contents to disk. -.It Fl u +.It Fl u , Fl Fl unconditional (i and p modes) Unconditionally overwrite existing files. Ordinarily, an older file will not overwrite a newer file on disk. -.It Fl v +.It Fl V , Fl Fl dot +Print a dot to stderr for each file as it is processed. +Superseded by +.Fl v . +.It Fl v , Fl Fl verbose Print the name of each file to stderr as it is processed. With .Fl t , provide a detailed listing of each file. -.It Fl -version +.It Fl Fl version Print the program version information and exit. .It Fl y (o mode only) -- 2.47.3