The following commit has been merged in the master branch: commit 5190ed2c6b5c3d9e4f21db2cbdfddeca6ace2d46 Author: Guillem Jover <guil...@debian.org> Date: Mon Jul 4 19:06:38 2011 +0200
man: Use [option...] instead of [options] and friends diff --git a/TODO b/TODO index 6af952e..75606a2 100644 --- a/TODO +++ b/TODO @@ -67,7 +67,6 @@ TODO - Check all command vs action. - Check usage of '|' instead of ', '. - Check position of short option before long option. - - Use [option...] instead of [options] and friends? - Fix dpkg man page, refs to dpkg-deb and dpkg-split, etc. - Fix «. ». diff --git a/debian/changelog b/debian/changelog index d183637..cdff489 100644 --- a/debian/changelog +++ b/debian/changelog @@ -127,6 +127,7 @@ dpkg (1.16.1) UNRELEASED; urgency=low - Use dashes instead of underscores for variable text. - Clarify that several front-end fields are not dselect specific in dpkg-query(1). + - Use [option...] instead of [options] and friends. * Refer to Sources and Packages files as part of a repository instead of as being of exclusive use or owned by APT, which has never been the case. diff --git a/man/dpkg-architecture.1 b/man/dpkg-architecture.1 index 511e683..0710da1 100644 --- a/man/dpkg-architecture.1 +++ b/man/dpkg-architecture.1 @@ -1,11 +1,10 @@ -.TH dpkg\-architecture 1 "2009-08-15" "Debian Project" "dpkg utilities" +.TH dpkg\-architecture 1 "2011-07-04" "Debian Project" "dpkg utilities" .SH "NAME" dpkg\-architecture \- set and determine the architecture for package building . .SH SYNOPSIS .B dpkg-architecture -.RI [ options ] -.RI [ commands ] +.RI [ option "...] [" command ] .PP . .SH DESCRIPTION diff --git a/man/dpkg-buildpackage.1 b/man/dpkg-buildpackage.1 index f747ab7..b3932cb 100644 --- a/man/dpkg-buildpackage.1 +++ b/man/dpkg-buildpackage.1 @@ -1,10 +1,10 @@ -.TH dpkg\-buildpackage 1 "2010-07-29" "Debian Project" "dpkg utilities" +.TH dpkg\-buildpackage 1 "2011-07-04" "Debian Project" "dpkg utilities" .SH NAME dpkg\-buildpackage \- build binary or source packages from sources . .SH SYNOPSIS .B dpkg\-buildpackage -.RI [ options ] +.RI [ option ...] . .SH DESCRIPTION .B dpkg\-buildpackage diff --git a/man/dpkg-checkbuilddeps.1 b/man/dpkg-checkbuilddeps.1 index 1ac3bad..0b90849 100644 --- a/man/dpkg-checkbuilddeps.1 +++ b/man/dpkg-checkbuilddeps.1 @@ -1,10 +1,10 @@ -.TH dpkg\-checkbuilddeps 1 "2009-11-21" "Debian Project" "dpkg utilities" +.TH dpkg\-checkbuilddeps 1 "2011-07-04" "Debian Project" "dpkg utilities" .SH NAME dpkg\-checkbuilddeps \- check build dependencies and conflicts . .SH SYNOPSIS .B dpkg\-checkbuilddeps -.RI [ options ] +.RI [ option ...] .RI [ control-file ] . .SH DESCRIPTION diff --git a/man/dpkg-deb.1 b/man/dpkg-deb.1 index d3d8987..99cdc8e 100644 --- a/man/dpkg-deb.1 +++ b/man/dpkg-deb.1 @@ -1,11 +1,10 @@ -.TH dpkg\-deb 1 "2011-04-26" "Debian Project" "dpkg suite" +.TH dpkg\-deb 1 "2011-07-04" "Debian Project" "dpkg suite" .SH NAME dpkg\-deb \- Debian package archive (.deb) manipulation tool . .SH SYNOPSIS .B dpkg\-deb -.RI [ options ] -.I command +.RI [ option "...] " command . .SH DESCRIPTION .B dpkg\-deb diff --git a/man/dpkg-distaddfile.1 b/man/dpkg-distaddfile.1 index 24138ea..50e616d 100644 --- a/man/dpkg-distaddfile.1 +++ b/man/dpkg-distaddfile.1 @@ -1,10 +1,10 @@ -.TH dpkg\-distaddfile 1 "2008-08-18" "Debian Project" "dpkg utilities" +.TH dpkg\-distaddfile 1 "2011-07-04" "Debian Project" "dpkg utilities" .SH NAME dpkg\-distaddfile \- add entries to debian/files . .SH SYNOPSIS .B dpkg\-distaddfile -.RI [ options ] " filename section priority" +.RI [ option ...] " filename section priority" . .SH DESCRIPTION .B dpkg\-distaddfile diff --git a/man/dpkg-divert.8 b/man/dpkg-divert.8 index 1c2fe05..23e5207 100644 --- a/man/dpkg-divert.8 +++ b/man/dpkg-divert.8 @@ -1,10 +1,10 @@ -.TH dpkg\-divert 8 "2010-10-12" "Debian Project" "dpkg utilities" +.TH dpkg\-divert 8 "2011-07-04" "Debian Project" "dpkg utilities" .SH NAME dpkg\-divert \- override a package's version of a file . .SH SYNOPSIS .B dpkg\-divert -.RI [ options ] +.RI [ option ...] .I command . .SH DESCRIPTION diff --git a/man/dpkg-genchanges.1 b/man/dpkg-genchanges.1 index b4f8511..63d8bb0 100644 --- a/man/dpkg-genchanges.1 +++ b/man/dpkg-genchanges.1 @@ -1,10 +1,10 @@ -.TH dpkg\-genchanges 1 "2008-08-18" "Debian Project" "dpkg utilities" +.TH dpkg\-genchanges 1 "2011-07-04" "Debian Project" "dpkg utilities" .SH NAME dpkg\-genchanges \- generate Debian .changes files . .SH SYNOPSIS .B dpkg\-genchanges -.RI [ options ] +.RI [ option ...] .br . .SH DESCRIPTION diff --git a/man/dpkg-gencontrol.1 b/man/dpkg-gencontrol.1 index e13b556..c3f761b 100644 --- a/man/dpkg-gencontrol.1 +++ b/man/dpkg-gencontrol.1 @@ -1,10 +1,10 @@ -.TH dpkg\-gencontrol 1 "2008-08-18" "Debian Project" "dpkg utilities" +.TH dpkg\-gencontrol 1 "2011-07-04" "Debian Project" "dpkg utilities" .SH NAME dpkg\-gencontrol \- generate Debian control files . .SH SYNOPSIS .B dpkg\-gencontrol -.RI [ options ] +.RI [ option ...] . .SH DESCRIPTION .B dpkg\-gencontrol diff --git a/man/dpkg-gensymbols.1 b/man/dpkg-gensymbols.1 index f1e8558..73de683 100644 --- a/man/dpkg-gensymbols.1 +++ b/man/dpkg-gensymbols.1 @@ -1,11 +1,11 @@ .\" Author: Raphaël Hertzog -.TH dpkg\-gensymbols 1 "2009-08-07" "Debian Project" "dpkg utilities" +.TH dpkg\-gensymbols 1 "2011-07-04" "Debian Project" "dpkg utilities" .SH NAME dpkg\-gensymbols \- generate symbols files (shared library dependency information) . .SH SYNOPSIS .B dpkg\-gensymbols -.RI [ options ] +.RI [ option ...] . .SH DESCRIPTION .B dpkg\-gensymbols diff --git a/man/dpkg-maintscript-helper.1 b/man/dpkg-maintscript-helper.1 index 4cd061f..ed268b9 100644 --- a/man/dpkg-maintscript-helper.1 +++ b/man/dpkg-maintscript-helper.1 @@ -1,10 +1,10 @@ -.TH dpkg\-maintscript\-helper 1 "2010-04-16" "Debian Project" "dpkg suite" +.TH dpkg\-maintscript\-helper 1 "2011-07-04" "Debian Project" "dpkg suite" .SH NAME dpkg\-maintscript\-helper \- works around known dpkg limitations in maintainer scripts . .SH SYNOPSIS .B dpkg\-maintscript\-helper -.IR command " [" parameters "...] \-\- " maint-script-parameters +.IR command " [" parameter "...] \-\- " maint-script-parameter ... . .SH COMMANDS AND PARAMETERS .P diff --git a/man/dpkg-name.1 b/man/dpkg-name.1 index 20b3f8d..41ebb67 100644 --- a/man/dpkg-name.1 +++ b/man/dpkg-name.1 @@ -3,15 +3,15 @@ .\" .\" This is free software; see the GNU General Public Licence version 2 .\" or later for copying conditions. There is NO warranty. -.TH dpkg\-name 1 "2008-08-18" "Debian Project" "dpkg utilities" +.TH dpkg\-name 1 "2011-07-04" "Debian Project" "dpkg utilities" .SH NAME dpkg\-name \- rename Debian packages to full package names . .SH SYNOPSIS .B dpkg\-name -.RI [ options ] +.RI [ option ...] .RB [ \-\- ] -.I files +.IR file ... . .SH DESCRIPTION .PP diff --git a/man/dpkg-parsechangelog.1 b/man/dpkg-parsechangelog.1 index b49964c..e6dc56c 100644 --- a/man/dpkg-parsechangelog.1 +++ b/man/dpkg-parsechangelog.1 @@ -1,10 +1,10 @@ -.TH dpkg\-parsechangelog 1 "2009-05-19" "Debian Project" "dpkg utilities" +.TH dpkg\-parsechangelog 1 "2011-07-04" "Debian Project" "dpkg utilities" .SH NAME dpkg\-parsechangelog \- parse Debian changelog files . .SH SYNOPSIS .B dpkg\-parsechangelog -.RI [ options ] +.RI [ option ...] . .SH DESCRIPTION .B dpkg\-parsechangelog diff --git a/man/dpkg-scanpackages.1 b/man/dpkg-scanpackages.1 index c2b21c8..ce93500 100644 --- a/man/dpkg-scanpackages.1 +++ b/man/dpkg-scanpackages.1 @@ -12,14 +12,13 @@ .\" .\" You should have received a copy of the GNU General Public License .\" along with this program. If not, see <http://www.gnu.org/licenses/>. -.TH dpkg\-scanpackages 1 "2009-10-01" "Debian Project" "dpkg utilities" +.TH dpkg\-scanpackages 1 "2011-07-04" "Debian Project" "dpkg utilities" .SH NAME dpkg\-scanpackages \- create Packages index files . .SH SYNOPSIS .B dpkg\-scanpackages -.RI [ options ] -.I binary-dir +.RI [ option "...] " binary-dir .RI [ override-file .RI [ path-prefix ]] .B > diff --git a/man/dpkg-scansources.1 b/man/dpkg-scansources.1 index 327dfe7..579aa1f 100644 --- a/man/dpkg-scansources.1 +++ b/man/dpkg-scansources.1 @@ -1,11 +1,10 @@ -.TH dpkg\-scansources 1 "2009-10-01" "Debian Project" "dpkg utilities" +.TH dpkg\-scansources 1 "2011-07-04" "Debian Project" "dpkg utilities" .SH NAME dpkg\-scansources \- create Sources index files . .SH SYNOPSIS .B dpkg\-scansources -.RI [ options ] -.I binary-dir +.RI [ option "...] " binary-dir .RI [ override-file .RI [ path-prefix ]] .B > diff --git a/man/dpkg-shlibdeps.1 b/man/dpkg-shlibdeps.1 index 487dd02..69d8bbe 100644 --- a/man/dpkg-shlibdeps.1 +++ b/man/dpkg-shlibdeps.1 @@ -1,12 +1,10 @@ -.TH dpkg\-shlibdeps 1 "2011-03-04" "Debian Project" "dpkg utilities" +.TH dpkg\-shlibdeps 1 "2011-07-04" "Debian Project" "dpkg utilities" .SH NAME dpkg\-shlibdeps \- generate shared library substvar dependencies . .SH SYNOPSIS .B dpkg\-shlibdeps -.RI [ options ] -.IR executable | \fB-e\fPexecutable -.RI [ options ] +.RI [ option "...] [" \fB\-e\fP ] executable " [" option ...] . .SH DESCRIPTION .B dpkg\-shlibdeps diff --git a/man/dpkg-source.1 b/man/dpkg-source.1 index f752a4e..bb01523 100644 --- a/man/dpkg-source.1 +++ b/man/dpkg-source.1 @@ -1,12 +1,11 @@ .\" Authors: Ian Jackson, Raphaël Hertzog -.TH dpkg\-source 1 "2011-07-03" "Debian Project" "dpkg utilities" +.TH dpkg\-source 1 "2011-07-04" "Debian Project" "dpkg utilities" .SH NAME dpkg\-source \- Debian source package (.dsc) manipulation tool . .SH SYNOPSIS .B dpkg\-source -.RI [ options ] -.I command +.RI [ option "...] " command . .SH DESCRIPTION .B dpkg\-source diff --git a/man/dpkg-split.1 b/man/dpkg-split.1 index 45654ad..14c37d4 100644 --- a/man/dpkg-split.1 +++ b/man/dpkg-split.1 @@ -1,12 +1,11 @@ .\" Authors: Ian Jackson -.TH dpkg\-split 1 "2011-04-28" "Debian Project" "dpkg utilities" +.TH dpkg\-split 1 "2011-07-04" "Debian Project" "dpkg utilities" .SH NAME dpkg\-split \- Debian package archive split/join tool . .SH SYNOPSIS .B dpkg\-split -.RI [ options ] -.I command +.RI [ option "...] " command . .SH DESCRIPTION .B dpkg\-split diff --git a/man/dpkg-statoverride.8 b/man/dpkg-statoverride.8 index c5d69dd..d32029a 100644 --- a/man/dpkg-statoverride.8 +++ b/man/dpkg-statoverride.8 @@ -1,11 +1,10 @@ -.TH dpkg\-statoverride 8 "2009-06-26" "Debian project" "dpkg utilities" +.TH dpkg\-statoverride 8 "2011-07-04" "Debian project" "dpkg utilities" .SH NAME dpkg\-statoverride \- override ownership and mode of files . .SH SYNOPSIS .B dpkg\-statoverride -.RI [ options ] -.I command +.RI [ option "...] " command . .SH DESCRIPTION `\fBstat overrides\fR' are a way to tell diff --git a/man/dpkg.1 b/man/dpkg.1 index f944e31..3a9336f 100644 --- a/man/dpkg.1 +++ b/man/dpkg.1 @@ -4,7 +4,7 @@ dpkg \- package manager for Debian . .SH SYNOPSIS .B dpkg -[\fIoptions\fP] \fIaction\fP +.RI [ option "...] " action . .SH WARNING This manual is intended for users wishing to understand \fBdpkg\fP's diff --git a/man/dselect.1 b/man/dselect.1 index a7ffea7..0b88e26 100644 --- a/man/dselect.1 +++ b/man/dselect.1 @@ -1,18 +1,10 @@ -.TH dselect 1 "2011-07-03" "Debian Project" "Debian" +.TH dselect 1 "2011-07-04" "Debian Project" "Debian" .SH NAME dselect \- Debian package management frontend . .SH SYNOPSIS .B dselect -.RB [ \-\-admindir -.IR <directory> ] -.RB [ \-\-help ] -.RB [ \-\-version ] -.RB [ \-\-expert ] -.RB [ \-\-debug | \-D\fI<file>\fP ] -.RI [ <action> ] -.RB [ \-\-colour | \-\-color -.IR screenpart: [ foreground ],[ background ][ :attr [ +attr+.. ]]] +.RI [ option "...] [" action ] . .SH DESCRIPTION .B dselect diff --git a/man/start-stop-daemon.8 b/man/start-stop-daemon.8 index fc39fd6..38c6fda 100644 --- a/man/start-stop-daemon.8 +++ b/man/start-stop-daemon.8 @@ -1,11 +1,10 @@ -.TH start\-stop\-daemon 8 "2011-04-28" "Debian Project" "dpkg utilities" +.TH start\-stop\-daemon 8 "2011-07-04" "Debian Project" "dpkg utilities" .SH NAME start\-stop\-daemon \- start and stop system daemon programs . .SH SYNOPSIS .B start\-stop\-daemon -.RI [ options ] -.I command +.RI [ option "...] " command . .SH DESCRIPTION .B start\-stop\-daemon diff --git a/man/update-alternatives.8 b/man/update-alternatives.8 index f9f64d0..abf87cc 100644 --- a/man/update-alternatives.8 +++ b/man/update-alternatives.8 @@ -5,14 +5,13 @@ .\" by the Free Software Foundation; either version 2 of the License, or .\" (at your option) any later version. There is NO WARRANTY. You can .\" find the GNU GPL in /usr/share/common-licenses/GPL on any Debian system. -.TH update\-alternatives 8 "2011-04-28" "Debian Project" "dpkg utilities" +.TH update\-alternatives 8 "2011-07-04" "Debian Project" "dpkg utilities" .SH NAME update\-alternatives \- maintain symbolic links determining default commands . .SH SYNOPSIS .B update\-alternatives -.RI [ options ] -.I command +.RI [ option "...] " command . .SH DESCRIPTION .B update\-alternatives -- dpkg's main repository -- To UNSUBSCRIBE, email to debian-dpkg-cvs-requ...@lists.debian.org with a subject of "unsubscribe". Trouble? Contact listmas...@lists.debian.org