From ad91a7b714b10a3a67e7cb0bdcbe61e8a9624397 Mon Sep 17 00:00:00 2001 From: Scott James Remnant Date: Thu, 6 May 2004 22:38:51 +0000 Subject: [PATCH] Various low-hanging documentation updates. --- ChangeLog | 13 ++++++ debian/changelog | 15 +++++-- main/main.c | 4 +- man/de/md5sum.1 | 2 +- man/en/dpkg.8.sgml | 82 ++++++++++++++++------------------- man/es/md5sum.1 | 2 +- man/ja/md5sum.1 | 2 +- scripts/update-alternatives.8 | 4 +- utils/md5sum.1 | 2 +- utils/start-stop-daemon.8 | 12 ++--- 10 files changed, 77 insertions(+), 61 deletions(-) diff --git a/ChangeLog b/ChangeLog index eb222960..b7c42d74 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,16 @@ +Thu May 6 23:23:10 BST 2004 Scott James Remnant + + * utils/md5sum.1, man/es/md5sum.1, man/de/md5sum.1, men/ja/md5sum.1: + Correct "et al" to "et al." + * main/main.c, man/en/dpkg.8.sgml: Correct description of + --compare-versions command to describe versions as "empty" rather + than "missing" or "no version" as "" has to be passed. + * man/en/dpkg.8.sgml: Add dpkg-reconfigure(8) to SEE ALSO section. + * utils/start-stop-daemon.8: Move documentation of --retry to the + paragraph about --stop where it belongs. + * scripts/update-alternatives.8: Remove strange " usage and + replace with appropriate .BR. + Sun May 2 10:22:25 CEST 2004 Tollef Fog Heen * scripts/dpkg-scanpackages.pl: Give proper case for Origin and diff --git a/debian/changelog b/debian/changelog index cde28d14..835027ce 100644 --- a/debian/changelog +++ b/debian/changelog @@ -2,14 +2,21 @@ dpkg (1.10.22) unstable; urgency=low * Add amd64 support. Closes: #238483, #241938. * Add i?86-gnu support. Closes: #216695, #236331. - * Stop hardcoding the list of manual page languages in debian/rules, - so we include Spanish, Russian and Brazilian Portugese. Closes: #245994. - * Correct dpkg manpage to refer to --force-remove-reinstreq instead of - non-existant --force-reinstreq option. Closes: #232831. * Fix dpkg-source (actually controllib.pl) to output the field name properly again. Closes: #246595. * Make dpkg-scanpackages output Origin and Bugs fields with proper casing. Closes: #154422. + * Stop hardcoding the list of manual page languages in debian/rules, + so we include Spanish, Russian and Brazilian Portugese. Closes: #245994. + * Correct dpkg manpage to refer to --force-remove-reinstreq instead of + non-existant --force-reinstreq option. Closes: #232831. + * Correct usage of "et al" to "et al.". Closes: #230751. + * Correct documentation of --compare-versions arguments. Closes: #232317. + * Correct documentation of start-stop-daemon manpage to refer to --retry + alongside --stop. Closes: #204691. + * Correct invalid use of " within update-alternatives(8) with .BR. + Closes: #244624. + * Add dpkg-reconfigure(8) to SEE ALSO section of dpkg(8). Closes: #233282. * Updated Translations: - Catalan (Jordi Mallach). - Spanish manpages (Ruben Porras). Closes: #246158, #246159, #246160, diff --git a/main/main.c b/main/main.c index 1235b523..d327eb71 100644 --- a/main/main.c +++ b/main/main.c @@ -107,8 +107,8 @@ Options:\n\ --abort-after Abort after encountering errors\n\ \n\ Comparison operators for --compare-versions are:\n\ - lt le eq ne ge gt (treat no version as earlier than any version);\n\ - lt-nl le-nl ge-nl gt-nl (treat no version as later than any version);\n\ + lt le eq ne ge gt (treat empty version as earlier than any version);\n\ + lt-nl le-nl ge-nl gt-nl (treat empty version as later than any version);\n\ < << <= = >= >> > (only for compatibility with control file syntax).\n\ \n\ Use `dselect' for user-friendly package management.\n"), diff --git a/man/de/md5sum.1 b/man/de/md5sum.1 index 873e1c91..a3057bed 100644 --- a/man/de/md5sum.1 +++ b/man/de/md5sum.1 @@ -1,6 +1,6 @@ .\" Hey, Emacs! This is an -*- nroff -*- source file. .hw ge-knackt -.TH MD5SUM 1 "29. November 1995" "Lankester et al" "Debian GNU/Linux" +.TH MD5SUM 1 "29. November 1995" "Lankester et al." "Debian GNU/Linux" .SH NAME md5sum \- generiert oder überprüft MD5-Prüfsummen diff --git a/man/en/dpkg.8.sgml b/man/en/dpkg.8.sgml index 6dea5394..cfc308c7 100644 --- a/man/en/dpkg.8.sgml +++ b/man/en/dpkg.8.sgml @@ -10,7 +10,7 @@ dpkg - medium-level package manager for Debian + a medium-level package manager for Debian @@ -37,11 +37,6 @@ packages. The descriptions of what dpkg does when installing and removing packages are particularly inadequate. - - - For information about this, please refer to sections regarding the - Debian packaging system in the Debian FAQ or in the Debian Reference. - @@ -50,7 +45,10 @@ dpkg is a medium-level tool to install, build, remove - and manage Debian packages. dpkg + and manage Debian packages. The primary and more user-friendly front-end + for dpkg is dselect (see + dselect + 8). dpkg itself is controlled entirely via command line parameters, which consist of exactly one action and zero or more options. The action-parameter tells dpkg what to do and options control the behavior of @@ -82,17 +80,6 @@ 1 for information about these actions. - - - - The primary and more user-friendly front-end for - dpkg is dselect (see - dselect - 8). There are other front-ends - such as those based on apt - 8. - - @@ -699,10 +686,11 @@ operator. dpkg returns success (zero result) if the specified condition is satisfied, and failure (nonzero result) otherwise. There are two groups of operators, which differ in how - they treat a missing or . - These treat no version as earlier than any version: - lt le eq ne ge gt. These treat no version as - later than any version: lt-nl le-nl ge-nl gt-nl. + they treat an empty or . + These treat an empty version as earlier than any version: + lt le eq ne ge gt. These treat an empty version + as later than any version: + lt-nl le-nl ge-nl gt-nl. These are provided only for compatibility with control file syntax: < << <= = >= >> >. @@ -734,7 +722,7 @@ - Display the usage instructions. + Display a brief help message. @@ -777,14 +765,14 @@ --licence - --license + --license - Display dpkg copyright and licence information. + Display dpkg licence. @@ -956,13 +944,13 @@ (*) are forced by default. - + - These options are mostly intended to be used by experts only. - Using them without fully understanding their effects may break - your whole system. + Warning: These options are mostly intended to be used + by experts only. Using them without fully understanding their + effects may break your whole system. - + @@ -1228,7 +1216,7 @@ (e.g. dpkg --purge foo --no-act will first purge package foo and then try to purge package --no-act, even though you probably expected it to - actually do nothing!) + actually do nothing) @@ -1445,20 +1433,26 @@ Examples - To list packages containing the string `vi' in their name: + To list packages related to the editor vi: dpkg '*vi*' - To see the entries in /var/lib/dpkg/available on - several packages: + To see the entries in /var/lib/dpkg/available on two + packages + + dpkg elvis vim + + + + To search the listing of packages yourself: - dpkg base-files login xfree86-common | pager + less /var/lib/dpkg/available - To remove an installed package named "emacs": + To remove an installed emacs package: dpkg emacs @@ -1493,6 +1487,11 @@ See Also + + dselect + 8 + , + dpkg-deb 1 @@ -1506,17 +1505,12 @@ deb-control 5 - , - - - dselect - 8 - , + - apt + dpkg-reconfigure 8 - . + diff --git a/man/es/md5sum.1 b/man/es/md5sum.1 index 689694c4..e8bf0706 100644 --- a/man/es/md5sum.1 +++ b/man/es/md5sum.1 @@ -1,5 +1,5 @@ .\" Hey, Emacs! This is an -*- nroff -*- source file. -.TH MD5SUM 1 "29 de Noviembre de 1995" "Lankester et al" "Debian GNU/Linux" +.TH MD5SUM 1 "29 de Noviembre de 1995" "Lankester et al." "Debian GNU/Linux" .SH NOMBRE md5sum \- genera o comprueba las sumas de control MD5 diff --git a/man/ja/md5sum.1 b/man/ja/md5sum.1 index 9d3d242c..f8b5b03c 100644 --- a/man/ja/md5sum.1 +++ b/man/ja/md5sum.1 @@ -3,7 +3,7 @@ .\"WORD: checksum ¥Á¥§¥Ã¥¯¥µ¥à .\"WORD: check ¾È¹ç .\"original revision: 1.2 -.TH MD5SUM 1 "29th November 1995" "Lankester et al" "Debian GNU/Linux" +.TH MD5SUM 1 "29th November 1995" "Lankester et al." "Debian GNU/Linux" .SH ̾Á° md5sum \- MD5 ¥á¥Ã¥»¡¼¥¸¥À¥¤¥¸¥§¥¹¥È¤òºîÀ®¡¦¾È¹ç¤¹¤ë¡£ diff --git a/scripts/update-alternatives.8 b/scripts/update-alternatives.8 index fbfa4928..3ee9e6c9 100644 --- a/scripts/update-alternatives.8 +++ b/scripts/update-alternatives.8 @@ -233,7 +233,9 @@ There are several packages which provide a text editor compatible with .BR vi , for example -.BR nvi " and " vim . +.BR nvi +and +.BR vim . Which one is used is controlled by the link group .BR vi , which includes links for the program itself and the associated manpage. diff --git a/utils/md5sum.1 b/utils/md5sum.1 index df7c704f..ed125b72 100644 --- a/utils/md5sum.1 +++ b/utils/md5sum.1 @@ -1,5 +1,5 @@ .\" Hey, Emacs! This is an -*- nroff -*- source file. -.TH MD5SUM 1 "29th November 1995" "Lankester et al" "Debian GNU/Linux" +.TH MD5SUM 1 "29th November 1995" "Lankester et al." "Debian GNU/Linux" .SH NAME md5sum \- generates or checks MD5 message digests diff --git a/utils/start-stop-daemon.8 b/utils/start-stop-daemon.8 index 3fa41ff5..005b1930 100644 --- a/utils/start-stop-daemon.8 +++ b/utils/start-stop-daemon.8 @@ -42,11 +42,7 @@ instance, using either the executable specified by Any arguments given after .BR -- on the command line are passed unmodified to the program being -started. If -.B --retry -is specified then -.B start-stop-daemon -will check that the process(es) have terminated. +started. With .BR --stop , @@ -62,7 +58,11 @@ If such a process does not exist, exits with error status 1 (0 if .BR --oknodo -is specified). +is specified). If +.B --retry +is specified then +.B start-stop-daemon +will check that the process(es) have terminated. .SH OPTIONS -- 2.39.5