From 82cabaf094ccc499ac4fe4d773bdf51457563f85 Mon Sep 17 00:00:00 2001 From: Guillem Jover Date: Wed, 18 Jul 2007 04:27:15 +0000 Subject: [PATCH] Man pages cleanup: - Split option descriptions so that it gets easier to distinguish. --- debian/changelog | 1 + man/ChangeLog | 7 +++ man/dpkg-buildpackage.1 | 10 ++--- man/dpkg-genchanges.1 | 78 ++++++++++++++------------------- man/dpkg-source.1 | 96 ++++++++++++++++++----------------------- man/dpkg.1 | 23 ++++++---- 6 files changed, 102 insertions(+), 113 deletions(-) diff --git a/debian/changelog b/debian/changelog index 5504c5a1..f76b6422 100644 --- a/debian/changelog +++ b/debian/changelog @@ -12,6 +12,7 @@ dpkg (1.14.6) UNRELEASED; urgency=low 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). diff --git a/man/ChangeLog b/man/ChangeLog index 87c383a9..410a5b16 100644 --- a/man/ChangeLog +++ b/man/ChangeLog @@ -1,3 +1,10 @@ +2007-07-18 Guillem Jover + + * dpkg.1: Split indeendent options. + * dpkg-buildpackage.1: Likewise. + * dpkg-genchanges.1: Likewise. + * dpkg-source.1: Likewise. + 2007-07-18 Guillem Jover * dpkg-buildpackage.1: Remove ', and' leftover from man page split. diff --git a/man/dpkg-buildpackage.1 b/man/dpkg-buildpackage.1 index ca70788c..89e4a62f 100644 --- a/man/dpkg-buildpackage.1 +++ b/man/dpkg-buildpackage.1 @@ -24,19 +24,17 @@ files are to be distributed either. .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. diff --git a/man/dpkg-genchanges.1 b/man/dpkg-genchanges.1 index fe5c7a6c..37ab3256 100644 --- a/man/dpkg-genchanges.1 +++ b/man/dpkg-genchanges.1 @@ -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 @@ file . .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 @@ Use 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 @@ Override or add an output control file field. .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 diff --git a/man/dpkg-source.1 b/man/dpkg-source.1 index 7ab51742..e83156fe 100644 --- a/man/dpkg-source.1 +++ b/man/dpkg-source.1 @@ -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 @@ option when it is called to generate a .orig.tar.gz or .tar.gz file. For 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 @@ or raise an error if 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 diff --git a/man/dpkg.1 b/man/dpkg.1 index 3c3db811..6f8624e8 100644 --- a/man/dpkg.1 +++ b/man/dpkg.1 @@ -451,16 +451,21 @@ be used with \fB\-i\fP, \fB\-A\fP, \fB\-\-install\fP, \fB\-\-unpack\fP and 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 -- 2.39.5