Author: guillem
Date: 2007-07-18 04:27:15 +0000 (Wed, 18 Jul 2007)
New Revision: 879
Modified:
trunk/debian/changelog
trunk/man/ChangeLog
trunk/man/dpkg-buildpackage.1
trunk/man/dpkg-genchanges.1
trunk/man/dpkg-source.1
trunk/man/dpkg.1
Log:
Man pages cleanup:
- Split option descriptions so that it gets easier to distinguish.
Modified: trunk/debian/changelog
===================================================================
--- trunk/debian/changelog 2007-07-18 03:00:16 UTC (rev 878)
+++ trunk/debian/changelog 2007-07-18 04:27:15 UTC (rev 879)
@@ -12,6 +12,7 @@
preceding the options.
- Substitute 'FILES' header with 'SEE ALSO' in dpkg-buildpackage(1),
and remove leftover string from man page split.
+ - Split option descriptions so that it gets easier to distinguish.
[ Updated scripts translations ]
* French (Frédéric Bothamy, Christian Perrier).
Modified: trunk/man/ChangeLog
===================================================================
--- trunk/man/ChangeLog 2007-07-18 03:00:16 UTC (rev 878)
+++ trunk/man/ChangeLog 2007-07-18 04:27:15 UTC (rev 879)
@@ -1,5 +1,12 @@
2007-07-18 Guillem Jover <[EMAIL PROTECTED]>
+ * dpkg.1: Split indeendent options.
+ * dpkg-buildpackage.1: Likewise.
+ * dpkg-genchanges.1: Likewise.
+ * dpkg-source.1: Likewise.
+
+2007-07-18 Guillem Jover <[EMAIL PROTECTED]>
+
* dpkg-buildpackage.1: Remove ', and' leftover from man page split.
Substitute 'FILES' with 'SEE ALSO'.
Modified: trunk/man/dpkg-buildpackage.1
===================================================================
--- trunk/man/dpkg-buildpackage.1 2007-07-18 03:00:16 UTC (rev 878)
+++ trunk/man/dpkg-buildpackage.1 2007-07-18 04:27:15 UTC (rev 879)
@@ -24,19 +24,17 @@
.B \-S
Specifies a source-only build, no binary packages need to be made.
.PP
-These options control whether the original source archive is included
-in the upload generated by
-.BR dpkg\-buildpackage
-if any source is being generated (i.e.,
+The \fB-s\fP\fIx\fP options control whether the original source archive is
+included in the upload if any source is being generated (i.e.
.BR \-b " or " \-B
haven't been used).
.TP
.B \-si
-Include the original source if the version number ends in
+By default, or if specified, the original source will be included if the
+version number ends in
.BR \-0 " or " \-1 ,
i.e. if the Debian revision part of the version number is
.BR 0 " or " 1 .
-.B This is the default.
.TP
.B \-sa
Forces the inclusion of the original source.
Modified: trunk/man/dpkg-genchanges.1
===================================================================
--- trunk/man/dpkg-genchanges.1 2007-07-18 03:00:16 UTC (rev 878)
+++ trunk/man/dpkg-genchanges.1 2007-07-18 04:27:15 UTC (rev 879)
@@ -1,4 +1,4 @@
-.TH dpkg\-genchanges 1 "2007-06-12" "Debian Project" "dpkg utilities"
+.TH dpkg\-genchanges 1 "2007-07-18" "Debian Project" "dpkg utilities"
.SH NAME
dpkg\-genchanges \- generate Debian .changes files
.
@@ -16,6 +16,38 @@
.
.SH OPTIONS
.TP
+.BR \-b ", " \-B
+Specifies that a binary-only build is taking place (no source files are
+to be included). There's no distinction between \fB\-b\fP and \fB\-B\fP,
+the produced
+.B .changes
+file will include whatever files were created by the
+.B binary\-*
+target(s) of the package being built.
+.TP
+.B \-S
+Specifies that only the source should be uploaded (no binary packages
+will be included).
+.PP
+The \fB-s\fP\fIx\fP options control whether the original source archive is
+included in the upload if any source is being generated (i.e.
+.BR \-b " or " \-B
+haven't been used).
+.TP
+.B \-si
+By default, or if specified, the original source will be included if the
+version number ends in
+.BR \-0 " or " \-1 ,
+i.e. if the Debian revision part of the version number is
+.BR 0 " or " 1 .
+.TP
+.B \-sa
+Forces the inclusion of the original source.
+.TP
+.B \-sd
+Forces the exclusion of the original source and includes only the diff.
+.fi
+.TP
.BI \-v version
Causes changelog information from all versions strictly later than
.I version
@@ -39,27 +71,6 @@
as the name and email address of the maintainer for this upload,
rather than using the information from the source tree's changelog.
.TP
-.BR \-si ", " \-sa ", " \-sd
-These options control whether the original source archive is included
-in the upload generated by
-.BR dpkg\-genchanges
-if any source is being generated (i.e.,
-.BR \-b " or " \-B
-haven't been used).
-
-By default, or if
-.B \-si
-is specified, the original source will be included if the version
-number ends in
-.BR \-0 " or " \-1 ,
-i.e. if the Debian revision part of the version number is
-.BR 0 " or " 1 .
-
-.B \-sa
-forces the inclusion of the original source;
-.B \-sd
-forces its exclusion and includes only the diff.
-.TP
.BI \-V name = value
Set an output substitution variable.
See \fBdeb\-substvars\fP(5) for a discussion of output substitution.
@@ -76,29 +87,6 @@
.BI \-U field
Remove an output control file field.
.TP
-.BR \-b ", " \-B ", " \-S
-For
-.BR dpkg\-genchanges " and " dpkg\-buildpackage
-.BR \-b " and " \-B
-specify that a binary-only build is taking place.
-.B \-b
-indicates that no source files are to be built and/or distributed, and
-.B \-B
-that no architecture-independent binary package files are to be
-distributed either.
-.B \-S
-specifies that only the source should be uploaded and no binary packages
-need to be made. The distinction between
-.BR \-b " and " \-B
-is only used by
-.BR dpkg\-buildpackage ;
-.B dpkg\-genchanges
-just produces a
-.B .changes
-file for whatever files were produced by the
-.B binary\-*
-target(s) of the package being built.
-.TP
.BI \-c controlfile
Specifies the main source control file to read information from. The
default is
Modified: trunk/man/dpkg-source.1
===================================================================
--- trunk/man/dpkg-source.1 2007-07-18 03:00:16 UTC (rev 878)
+++ trunk/man/dpkg-source.1 2007-07-18 04:27:15 UTC (rev 879)
@@ -1,5 +1,5 @@
.\" Authors: Ian Jackson
-.TH dpkg\-source 1 "2007-06-12" "Debian Project" "dpkg utilities"
+.TH dpkg\-source 1 "2007-07-18" "Debian Project" "dpkg utilities"
.SH NAME
dpkg\-source \- Debian source package (.dsc) manipulation tool
.
@@ -132,59 +132,60 @@
example, \-ICVS will make tar skip over CVS directories when generating
a .tar.gz file. The option may be repeated multiple times to list multiple
filenames to exclude.
+.PP
+All the
+.BI \-s X
+options are mutually exclusive. If you specify more than one only the
+last one will be used.
.TP
-.BR \-sa , \-sp , \-su , \-sk , \-sA , \-sP , \-sU , \-sK , \-ss " with " \-b
-If
-.BR \-sk " or " \-sp
-is specified
-.B dpkg\-source
-expects the original source as a tarfile, by default
+.B Build options (with -b):
+.PP
+.BR \-sa ", " \-sp ", " \-sk ", " \-su " and " \-sr
+will not overwrite existing tarfiles or directories. If this is
+desired then
+.BR \-sA ", " \-sP ", " \-sK ", " \-sU " and " \-sR
+should be used instead.
+.TP
+.BR \-sk
+Specifies to expect the original source as a tarfile, by default
.IB package _ upstream-version .orig.tar.gz\fR.
It will leave this original source in place as a tarfile, or copy it
-to the current directory if it isn't already there
-If
+to the current directory if it isn't already there.
+.TP
.B \-sp
-is used rather than
+Like
.B \-sk
-it will remove it again afterwards.
-
-If
-.BR \-su " or " \-sr
-is specified the original source is expected as a directory, by
+but will remove that tarball again afterwards.
+.TP
+.B \-su
+Specifies that the original source is expected as a directory, by
default
.IB package - upstream-version .orig
and
.B dpkg\-source
-will create a new original source archive from it. If
+will create a new original source archive from it.
+.TP
.B \-sr
-is used
-.B dpkg\-source will remove that directory after it has been used.
-
-If
+Like
+.B \-su
+but will remove that directory after it has been used.
+.TP
.B \-ss
-is specified
-.B dpkg\-source
-will expect that the original source is available both as a directory
+Specifies that the original source is available both as a directory
and as a tarfile. If will use the directory to create the diff, but
the tarfile to create the
.BR .dsc .
This option must be used with care - if the directory and tarfile do
not match a bad source archive will be generated.
-
-If
+.TP
.B \-sn
-is specified
-.B dpkg\-source
-will not look for any original source, and will not generate a diff.
+Specifies to not look for any original source, and to not generate a diff.
The second argument, if supplied, must be the empty string. This is
used for Debian-specific packages which do not have a separate
upstream source and therefore have no debianisation diffs.
-
-If
+.TP
.BR \-sa " or " \-sA
-is specified
-.B dpkg\-source
-will look for the original source archive as a tarfile or as a
+Specifies to look for the original source archive as a tarfile or as a
directory - the second argument, if any, may be either, or the empty
string (this is equivalent to using
.BR \-sn ).
@@ -208,35 +209,24 @@
was specified.
.B \-sA
is the default.
-
-.BR \-sa ", " \-sp ", " \-sk ", " \-su " and " \-sr
-will not overwrite existing tarfiles or directories. If this is
-desired then
-.BR \-sA ", " \-sP ", " \-sK ", " \-sU " and " \-sR
-should be used instead.
.TP
-.BR \-sp , \-su , \-sn " with " \-x
+.B Extract options (with \-x):
+.PP
In all cases any existing original source tree will be removed.
-
-If
+.TP
.B \-sp
-is used when extracting then the original source (if any) will be left
+Used when extracting then the original source (if any) will be left
as a tarfile. If it is not already located in the current directory
or if an existing but different file is there it will be copied there.
-This is the default.
-
+(\fBThis is the default\fP).
+.TP
.B \-su
-unpacks the original source tree.
-
+Unpacks the original source tree.
+.TP
.B \-sn
-ensures that the original source is neither copied to the current
+Ensures that the original source is neither copied to the current
directory nor unpacked. Any original source tree that was in the
current directory is still removed.
-.PP
-All the
-.B \-sX
-options are mutually exclusive. If you specify more than one only the
-last one will be used.
.
.SH BUGS
The point at which field overriding occurs compared to certain
Modified: trunk/man/dpkg.1
===================================================================
--- trunk/man/dpkg.1 2007-07-18 03:00:16 UTC (rev 878)
+++ trunk/man/dpkg.1 2007-07-18 04:27:15 UTC (rev 879)
@@ -451,17 +451,22 @@
Don't install a package if a newer version of the same package is already
installed. This is an alias of \fB\-\-refuse\-downgrade\fP.
.TP
-\fB\-\-root=\fP\fIdir\fP, \fB\-\-admindir=\fP\fIdir\fP,
\fB\-\-instdir=\fP\fIdir\fP
-Change default directories. \fBadmindir\fP defaults to
-\fI/var/lib/dpkg\fP and contains many files that give information
-about status of installed or uninstalled packages, etc. \fBinstdir\fP
-defaults to \fI/\fP and refers to the directory where packages are to
-be installed. \fBinstdir\fP is also the directory passed to
-\fBchroot\fP(2) before running package's installation scripts, which
+.BI \-\-admindir= dir
+Change default administrative directory, which contains many files that
+give information about status of installed or uninstalled packages, etc.
+(Defaults to \fI/var/lib/dpkg\fP)
+.TP
+.BI \-\-instdir= dir
+Change default installation directory which refers to the directory where
+packages are to be installed. \fBinstdir\fP is also the directory passed
+to \fBchroot\fP(2) before running package's installation scripts, which
means that the scripts see \fBinstdir\fP as a root directory.
-Changing \fBroot\fP changes \fBinstdir\fP to \fIdir\fP and
-\fBadmindir\fP to \fIdir\fP\fB/var/lib/dpkg\fP.
+(Defaults to \fI/\fP)
.TP
+.BI \-\-root= dir
+Changing \fBroot\fP changes \fBinstdir\fP to \fIdir\fP and \fBadmindir\fP
+to \fIdir\fP\fB/var/lib/dpkg\fP.
+.TP
\fB\-O\fP, \fB\-\-selected\-only\fP
Only process the packages that are selected for installation. The
actual marking is done with \fBdselect\fP or by \fBdpkg\fP, when it
--
To UNSUBSCRIBE, email to [EMAIL PROTECTED]
with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]
