Explorar o código

man: Clarify “EXIT STATUS” sections by using bold and a table

Change the status codes to bold and list them with a table to makes
it easier to visually distinguish them.
Guillem Jover %!s(int64=15) %!d(string=hai) anos
pai
achega
ad188eee15
Modificáronse 5 ficheiros con 37 adicións e 19 borrados
  1. 1 0
      debian/changelog
  2. 5 3
      man/dpkg-query.1
  3. 10 7
      man/dpkg-split.1
  4. 16 6
      man/start-stop-daemon.8
  5. 5 3
      man/update-alternatives.8

+ 1 - 0
debian/changelog

@@ -46,6 +46,7 @@ dpkg (1.16.1) UNRELEASED; urgency=low
   * Use “unselected” as an adjective in dpkg output messages instead of
   * Use “unselected” as an adjective in dpkg output messages instead of
     “deselected”. Closes: #231089
     “deselected”. Closes: #231089
   * Clarify exit status in dpkg-split and start-stop-daemon --help output.
   * Clarify exit status in dpkg-split and start-stop-daemon --help output.
+  * Clarify “EXIT STATUS” section in man pages by using a table.
 
 
   [ Updated man page translations ]
   [ Updated man page translations ]
   * German (Helge Kreutzmann).
   * German (Helge Kreutzmann).

+ 5 - 3
man/dpkg-query.1

@@ -1,4 +1,4 @@
-.TH dpkg\-query 1 "2011-04-20" "Debian Project" "dpkg suite"
+.TH dpkg\-query 1 "2011-04-28" "Debian Project" "dpkg suite"
 .SH NAME
 .SH NAME
 dpkg\-query \- a tool to query the dpkg database
 dpkg\-query \- a tool to query the dpkg database
 .
 .
@@ -193,9 +193,11 @@ run:
 .fi
 .fi
 .
 .
 .SH "EXIT STATUS"
 .SH "EXIT STATUS"
-.IP 0
+.TP
+.B 0
 The requested query was successfully performed.
 The requested query was successfully performed.
-.IP 1
+.TP
+.B 1
 Problems were encountered while parsing the command line or performing the
 Problems were encountered while parsing the command line or performing the
 query, including no file or package being found (except for \-\-control\-path).
 query, including no file or package being found (except for \-\-control\-path).
 .
 .

+ 10 - 7
man/dpkg-split.1

@@ -1,5 +1,5 @@
 .\" Authors: Ian Jackson
 .\" Authors: Ian Jackson
-.TH dpkg\-split 1 "2011-04-15" "Debian Project" "dpkg utilities"
+.TH dpkg\-split 1 "2011-04-28" "Debian Project" "dpkg utilities"
 .SH NAME
 .SH NAME
 dpkg\-split \- Debian package archive split/join tool
 dpkg\-split \- Debian package archive split/join tool
 .
 .
@@ -178,19 +178,22 @@ the form
 are generated.
 are generated.
 .
 .
 .SH EXIT STATUS
 .SH EXIT STATUS
-An exit status of 0 indicates that the requested split, merge, or
-other command succeeded.
+.TP
+.B 0
+The requested split, merge, or other command succeeded.
 .B \-\-info
 .B \-\-info
 commands count as successful even if the files are not binary package
 commands count as successful even if the files are not binary package
 parts.
 parts.
-
-An exit status of 1 occurs only with
+.TP
+.B 1
+Only occurs with
 .B \-\-auto
 .B \-\-auto
 and indicates that the
 and indicates that the
 .I part
 .I part
 file was not a binary package part.
 file was not a binary package part.
-
-An exit status of 2 indicates some kind of trouble, such as a system
+.TP
+.B 2
+Some kind of trouble happened, such as a system
 call failure, a file that looked like a package part file but was
 call failure, a file that looked like a package part file but was
 corrupted, a usage error or some other problem.
 corrupted, a usage error or some other problem.
 .
 .

+ 16 - 6
man/start-stop-daemon.8

@@ -1,4 +1,4 @@
-.TH start\-stop\-daemon 8 "2011-03-04" "Debian Project" "dpkg utilities"
+.TH start\-stop\-daemon 8 "2011-04-28" "Debian Project" "dpkg utilities"
 .SH NAME
 .SH NAME
 start\-stop\-daemon \- start and stop system daemon programs
 start\-stop\-daemon \- start and stop system daemon programs
 .
 .
@@ -254,21 +254,31 @@ option.
 Print verbose informational messages.
 Print verbose informational messages.
 .
 .
 .SH EXIT STATUS
 .SH EXIT STATUS
-.B start\-stop\-daemon
-returns 0 if the requested action was performed, or if
+.TP
+.B 0
+The requested action was performed, or if
 .B \-\-oknodo
 .B \-\-oknodo
 is specified and either
 is specified and either
 .B \-\-start
 .B \-\-start
 was specified and a matching process was already running, or
 was specified and a matching process was already running, or
 .B \-\-stop
 .B \-\-stop
-was specified and there were no matching processes. If
+was specified and there were no matching processes.
+.TP
+.B 1
+If
 .B \-\-oknodo
 .B \-\-oknodo
-was not specified and nothing was done, 1 is returned. If
+was not specified and nothing was done.
+.TP
+.B 2
+If
 .B \-\-stop
 .B \-\-stop
 and
 and
 .B \-\-retry
 .B \-\-retry
 were specified, but the end of the schedule was reached and the processes were
 were specified, but the end of the schedule was reached and the processes were
-still running, the error value is 2. For all other errors, the status is 3.
+still running.
+.TP
+.B 3
+Any other error.
 .
 .
 .SH EXAMPLE
 .SH EXAMPLE
 Start the \fBfood\fP daemon, unless one is already running (a process named
 Start the \fBfood\fP daemon, unless one is already running (a process named

+ 5 - 3
man/update-alternatives.8

@@ -5,7 +5,7 @@
 .\" by the Free Software Foundation; either version 2 of the License, or
 .\" by the Free Software Foundation; either version 2 of the License, or
 .\" (at your option) any later version.  There is NO WARRANTY.  You can
 .\" (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.
 .\" find the GNU GPL in /usr/share/common-licenses/GPL on any Debian system.
-.TH update\-alternatives 8 "2011-03-04" "Debian Project" "dpkg utilities"
+.TH update\-alternatives 8 "2011-04-28" "Debian Project" "dpkg utilities"
 .SH NAME
 .SH NAME
 update\-alternatives \- maintain symbolic links determining default commands
 update\-alternatives \- maintain symbolic links determining default commands
 .
 .
@@ -373,9 +373,11 @@ Can be overridden by the
 option.
 option.
 .
 .
 .SH "EXIT STATUS"
 .SH "EXIT STATUS"
-.IP 0
+.TP
+.B 0
 The requested action was successfully performed.
 The requested action was successfully performed.
-.IP 2
+.TP
+.B 2
 Problems were encountered whilst parsing the command line
 Problems were encountered whilst parsing the command line
 or performing the action.
 or performing the action.
 .
 .