Browse Source

man: Use [option...] instead of [options] and friends

Guillem Jover 13 years ago
parent
commit
5190ed2c6b

+ 0 - 1
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 «.  ».
 

+ 1 - 0
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.
 

+ 2 - 3
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

+ 2 - 2
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

+ 2 - 2
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

+ 2 - 3
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

+ 2 - 2
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

+ 2 - 2
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

+ 2 - 2
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

+ 2 - 2
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

+ 2 - 2
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

+ 2 - 2
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

+ 3 - 3
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

+ 2 - 2
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

+ 2 - 3
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 >

+ 2 - 3
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 >

+ 2 - 4
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

+ 2 - 3
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

+ 2 - 3
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

+ 2 - 3
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

+ 1 - 1
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

+ 2 - 10
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

+ 2 - 3
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

+ 2 - 3
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