From: Guillem Jover <guillem@debian.org>
Date: Fri, 10 Feb 2006 02:58:04 +0000 (+0000)
Subject: Add command descriptions in the synopis, and add a usage example for
X-Git-Url: https://err.no/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b557a00801d3e49c6b5b579848f2914240beefce;p=dpkg

Add command descriptions in the synopis, and add a usage example for
-f in the dpkg-query manpage. Thanks for the initial patch to
Philippe Batailler. Closes: #352091
---

diff --git a/ChangeLog b/ChangeLog
index 08b10162..96eb5bc6 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,13 @@
+2006-02-10  Philippe Batailler  <philippe.batailler@free.fr>,
+	    Guillem Jover  <guillem@debian.org>
+
+	* man/C/dpkg-query.1: Use dots instead of blank lines to logically
+	separate sections.
+	(SYNOPSIS): Add command descriptions.
+	(COMMANDS): Use package-name instead of package.
+	(OPTIONS): Give an example for --showformat.
+	(SEE ALSO): Add a final dot to reference.
+
 2006-02-08  Philippe Batailler <philippe.batailler@free.fr>
 
         * man/fr/update-alternatives.8.fr.po updated translation
diff --git a/debian/changelog b/debian/changelog
index ff868646..f5d0225c 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -13,6 +13,9 @@ dpkg (1.13.14~) UNRELEASED; urgency=low
     Add a Build-Dependency on pkg-config, thighten libselinux1-dev to
     at least version 1.28-4 which provides a .pc file, and remove
     libsepol1-dev as libselinux1-dev is Depending on it.
+  * Add command descriptions in the synopis, and add a usage example for
+    -f in the dpkg-query manpage. Thanks for the initial patch to
+    Philippe Batailler. Closes: #352091
 
   [ Frank Lichtenheld ]
   * Let dpkg-source ignore comments in the hunk header as used by
diff --git a/man/C/dpkg-query.1 b/man/C/dpkg-query.1
index bd93743a..2a149127 100644
--- a/man/C/dpkg-query.1
+++ b/man/C/dpkg-query.1
@@ -1,15 +1,42 @@
-.TH dpkg\-query 1 "2006-01-26" "Debian Project" "dpkg suite"
+.TH dpkg\-query 1 "2006-02-10" "Debian Project" "dpkg suite"
 .SH NAME
 dpkg\-query \- a tool to query the dpkg database
-
+.
 .SH SYNOPSIS
 .B dpkg\-query
-
+.BR \-l | \-\-list
+.IR package-name-pattern " ..."
+.br
+.B dpkg\-query
+.BR \-W | \-\-show
+.IR package-name-pattern " ..."
+.br
+.B dpkg\-query
+.BR \-s | \-\-status
+.IR package-name " ..."
+.br
+.B dpkg\-query
+.BR \-L | \-\-listfiles
+.IR package-name " ..."
+.br
+.B dpkg\-query
+.BR  \-S | \-\-search
+.IR filename-search-pattern " ..."
+.br
+.B dpkg\-query
+.BR \-p | \-\-print\-avail
+.IR package-name " ..."
+.br
+.B dpkg\-query
+.BR \-\-licence | \-\-license
+.br
+.B dpkg\-query
+.BR \-\-version
+.
 .SH DESCRIPTION
 \fBdpkg\-query\fP is a tool to show information about packages listed in
 the \fBdpkg\fP database.
-
-
+.
 .SH COMMANDS
 .TP
 \fB\-l\fP | \fB\-\-list\fP \fIpackage-name-pattern\fP ...
@@ -41,8 +68,8 @@ having the name and installed version of the package, separated by a tab.
 Report status of specified package. This just displays the entry in
 the installed package status database.
 .TP
-\fB\-L\fP | \fB\-\-listfiles\fP \fIpackage\fP ...
-List files installed to your system from \fBpackage\fP.
+\fB\-L\fP | \fB\-\-listfiles\fP \fIpackage-name\fP ...
+List files installed to your system from \fBpackage-name\fP.
 However, note that files created by package-specific
 installation-scripts are not listed.
 .TP
@@ -52,8 +79,8 @@ wildchars can be used in the pattern.  This command will not list
 extra files created by maintainer scripts, nor will it list
 alternatives.
 .TP
-\fB\-p\fP |\fB\-\-print\-avail\fP package
-Display details about \fIpackage\fP, as found in
+\fB\-p\fP |\fB\-\-print\-avail\fP \fIpackage-name\fP
+Display details about \fIpackage-name\fP, as found in
 \fI/var/lib/dpkg/available\fP.
 .TP
 \fB\-\-licence\fP | \fB\-\-license\fP
@@ -61,7 +88,7 @@ Display licence and copyright information.
 .TP
 \fB\-\-version\fP
 Display version information.
-
+.
 .SH OPTIONS
 .TP
 \fB\-\-admindir=\fIdir\fP
@@ -125,13 +152,20 @@ alignment will be used. The following \fIfield\fRs are recognised:
 .fi
 
 The default format string is \(lq\fB${Package}\et${Version}\en\fP\(rq.
+To get the name of the dpkg maintainer and the installed version, you could
+run:
 
+.T
+.nf
+  \fBdpkg\-query \-W \-f='${Package} ${Version}\\t${Maintainer}\\n' dpkg\fP
+.fi
+.
 .SH ENVIRONMENT
 .TP
 \fBCOLUMNS\fP
 This setting influences the output of the \fB\-\-list\fP option by changing
 the width of its output.
-
+.
 .SH AUTHOR
 Copyright 2001 Wichert Akkerman
 .UR mailto:wakkerma@debian.org
@@ -140,8 +174,7 @@ Copyright 2001 Wichert Akkerman
 .sp
 This is free software; see the GNU General Public Licence version 2 or
 later for copying conditions.  There is NO warranty.
-
-
+.
 .SH SEE ALSO
-.BR dpkg (1)
+.BR dpkg (1).