Put lists in man pages in alphabetical order

Put lists in man pages in alphabetical order

[Andrey Borzenkov]

[-- Attachment #1.1: Type: text/plain, Size: 429 bytes --]

I find it hard to read man pages with unordered lists even if they are not 
excessively long. This patch attempts to put them in alphabetical order; for 
substitutions in udev.8 the question is what is primary - single letter or 
word form? Of course it is possible to have primary with description and 
second list which says "alternative forms are ..."?

Is it OK? Should I make second list too?

Regards

-andrey


[-- Attachment #1.2: udev-alphabetize_lists_in_man.patch --]
[-- Type: text/x-diff, Size: 10866 bytes --]

diff --git a/udev.8 b/udev.8
index 6d2f5e6..2dd0aee 100644
--- a/udev.8
+++ b/udev.8
@@ -29,6 +29,13 @@ All udev configuration files are placed 
 udev expects its main configuration file at 
 \fI/etc/udev/udev.conf\fR. It consists of a set of variables allowing the user to override default udev values. The following variables can be set:
 .TP
+\fBudev_log\fR
+The logging priority. Valid values are the numerical syslog priorities or their textual representations: 
+\fBdebug\fR.
+\fBerr\fR, 
+and 
+\fBinfo\fR 
+.TP
 \fBudev_root\fR
 Specifies where to place the device nodes in the filesystem. The default value is 
 \fI/dev\fR.
@@ -37,13 +44,6 @@ Specifies where to place the device node
 The name of the udev rules file or directory to look for files with the suffix 
 \fI.rules\fR. Multiple rule files are read in lexical order. The default value is 
 \fI/etc/udev/rules.d\fR.
-.TP
-\fBudev_log\fR
-The logging priority. Valid values are the numerical syslog priorities or their textual representations: 
-\fBerr\fR, 
-\fBinfo\fR 
-and 
-\fBdebug\fR.
 .SS "Rules files"
 .PP
 The udev rules are read from the files located in the 
@@ -72,35 +72,35 @@ The following key names can be used to m
 \fBACTION\fR
 Match the kernel action name.
 .TP
-\fBKERNEL\fR
-Match the kernel device name
+\fBBUS\fR
+Match the type of bus the device is connected to.
 .TP
 \fBDEVPATH\fR
 Match the kernel devpath.
 .TP
-\fBSUBSYSTEM\fR
-Match the kernel subsystem name
-.TP
-\fBBUS\fR
-Match the type of bus the device is connected to.
-.TP
 \fBDRIVER\fR
 Match the kernel driver name.
 .TP
-\fBID\fR
-Match the device number on the bus.
-.TP
 \fBENV{\fR\fB\fIkey\fR\fR\fB}\fR
 Match against the value of an environment key. Depending on the specified operation, this key is also used as an assignment.
 .TP
-\fBSYSFS{\fR\fB\fIfilename\fR\fR\fB}\fR
-Match the sysfs attribute value. Up to five values can be specified. Trailing whitespace is ignored, if the specified match value does not contain trailing whitespace itself.
+\fBID\fR
+Match the device number on the bus.
+.TP
+\fBKERNEL\fR
+Match the kernel device name
 .TP
 \fBPROGRAM\fR
 Execute external program. The key is true, if the program returns without exit code zero. The whole event environment is available to the executed program. The program's output printed to stdout is available for the RESULT key.
 .TP
 \fBRESULT\fR
 Match the returned string of the last PROGRAM call. This key can be used in the same or in any later rule after a PROGRAM call.
+.TP
+\fBSUBSYSTEM\fR
+Match the kernel subsystem name
+.TP
+\fBSYSFS{\fR\fB\fIfilename\fR\fR\fB}\fR
+Match the sysfs attribute value. Up to five values can be specified. Trailing whitespace is ignored, if the specified match value does not contain trailing whitespace itself.
 .PP
 Most of the fields support a shell style pattern matching. The following pattern characters are supported:
 .TP
@@ -115,24 +115,9 @@ Matches any single character specified w
 .PP
 The following keys can get values assigned:
 .TP
-\fBNAME\fR
-The name of the node to be created, or the name the network interface should be renamed to. Only one rule can set the node name, all later rules with a NAME key will be ignored.
-.TP
-\fBSYMLINK\fR
-The name of a symlink targeting the node. Every matching rule can add this value to the list of symlinks to be created along with the device node. Multiple symlinks may be specified by separating the names by the space character.
-.TP
-\fBOWNER, GROUP, MODE\fR
-The permissions for the device node. Every specified value overwrites the compiled\-in default value.
-.TP
 \fBENV{\fR\fB\fIkey\fR\fR\fB}\fR
 Export the key to the environment. Depending on the specified operation, this key is also used as a match.
 .TP
-\fBRUN\fR
-Add a program to the list of programs to be executed for a specific device.
-.TP
-\fBLABEL\fR
-Named label where a GOTO can jump to.
-.TP
 \fBGOTO\fR
 Jumps to the next LABEL with a matching gname
 .TP
@@ -143,18 +128,33 @@ will execute an external program and rea
 \fBfile\fR 
 will inport a text file. If no option is given, udev will determine it from the executable bit of of the file permissions.
 .TP
-\fBWAIT_FOR_SYSFS\fR
-Wait for the specified sysfs file of the device to be created. May be used to fight agains timing issues wth the kernel.
+\fBLABEL\fR
+Named label where a GOTO can jump to.
+.TP
+\fBNAME\fR
+The name of the node to be created, or the name the network interface should be renamed to. Only one rule can set the node name, all later rules with a NAME key will be ignored.
 .TP
 \fBOPTIONS\fR
-\fBlast_rule\fR 
-stops further rules application. No later rules will have any effect. 
+\fBall_partitions\fR 
+will create device nodes for all available partitions of a block device. This may be useful for removable media.
 \fBignore_device\fR 
 will ignore this event completely. 
 \fBignore_remove\fR 
 will ignore any later remove event for this device. This may be useful as a workaround for broken device drivers. 
-\fBall_partitions\fR 
-will create device nodes for all available partitions of a block device. This may be useful for removable media.
+\fBlast_rule\fR 
+stops further rules application. No later rules will have any effect. 
+.TP
+\fBOWNER, GROUP, MODE\fR
+The permissions for the device node. Every specified value overwrites the compiled\-in default value.
+.TP
+\fBRUN\fR
+Add a program to the list of programs to be executed for a specific device.
+.TP
+\fBSYMLINK\fR
+The name of a symlink targeting the node. Every matching rule can add this value to the list of symlinks to be created along with the device node. Multiple symlinks may be specified by separating the names by the space character.
+.TP
+\fBWAIT_FOR_SYSFS\fR
+Wait for the specified sysfs file of the device to be created. May be used to fight agains timing issues wth the kernel.
 .PP
 The 
 \fBNAME\fR, 
@@ -165,34 +165,34 @@ and 
 \fBGROUP\fR 
 fields support simple printf\-like string substitutions:
 .TP
-\fB%k\fR, \fB$kernel\fR
-The kernel name for this device.
-.TP
 \fB%b\fR, \fB$id\fR
 The kernel bus id for this device.
 .TP
-\fB%n\fR, \fB$number\fR
-The kernel number for this device. For example, 'sda3' has kernel number of '3'
-.TP
-\fB%p\fR, \fB$devpath\fR
-The devpath of the device.
-.TP
-\fB%s{\fR\fB\fIfile\fR\fR\fB}\fR, \fB$sysfs{\fR\fB\fIfile\fR\fR\fB}\fR
-The content of a sysfs attribute.
+\fB%c\fR, \fB$result\fR
+The string returned by the external program requested with PROGRAM. A single part of the string, separated by a space character may be selected by specifying the part number as an attribute: 
+\fB%c{N}\fR. If the number is followed by the '+' char this part plus all remaining parts of the result string are substituted: 
+\fB%c{N+}\fR
 .TP
 \fB%E{\fR\fB\fIkey\fR\fR\fB}\fR, \fB$env{\fR\fB\fIkey\fR\fR\fB}\fR
 The value of an environment variable.
 .TP
+\fB%k\fR, \fB$kernel\fR
+The kernel name for this device.
+.TP
 \fB%m\fR, \fB$major\fR
 The kernel major number for the device.
 .TP
-\fB%M\fR \fB$minor\fR
+\fB%M\fR, \fB$minor\fR
 The kernel minor number for the device.
 .TP
-\fB%c\fR, \fB$result\fR
-The string returned by the external program requested with PROGRAM. A single part of the string, separated by a space character may be selected by specifying the part number as an attribute: 
-\fB%c{N}\fR. If the number is followed by the '+' char this part plus all remaining parts of the result string are substituted: 
-\fB%c{N+}\fR
+\fB%n\fR, \fB$number\fR
+The kernel number for this device. For example, 'sda3' has kernel number of '3'
+.TP
+\fB%N\fR, \fB$tempnode\fR
+The name of a created temporary device node to provide access to the device from a external program before the real node is created.
+.TP
+\fB%p\fR, \fB$devpath\fR
+The devpath of the device.
 .TP
 \fB%P\fR, \fB$parent\fR
 The node name of the parent device.
@@ -200,8 +200,8 @@ The node name of the parent device.
 \fB%r\fR, \fB$root\fR
 The udev_root value.
 .TP
-\fB%N\fR, \fB$tempnode\fR
-The name of a created temporary device node to provide access to the device from a external program before the real node is created.
+\fB%s{\fR\fB\fIfile\fR\fR\fB}\fR, \fB$sysfs{\fR\fB\fIfile\fR\fR\fB}\fR
+The content of a sysfs attribute.
 .TP
 \fB%%\fR
 The '%' character itself.
diff --git a/udevd.8 b/udevd.8
index c6efe9a..75f0dde 100644
--- a/udevd.8
+++ b/udevd.8
@@ -29,11 +29,11 @@ udevcontrol can dynamically set the log 
 and 
 \fBdebug\fR.
 .TP
-\fBstop_exec_queue\fR
-udevcontrol stops the execution of events from udevd.
-.TP
 \fBstart_exec_queue\fR
 udevcontrol starts the execution of events from udevd.
+.TP
+\fBstop_exec_queue\fR
+udevcontrol stops the execution of events from udevd.
 .SH "ENVIRONMENT"
 .TP
 \fBUDEV_LOG\fR
diff --git a/udevinfo.8 b/udevinfo.8
index fc7001d..1ef9403 100644
--- a/udevinfo.8
+++ b/udevinfo.8
@@ -17,26 +17,32 @@ udevinfo \- query device information fro
 udevinfo queries the udev database for device information stored in the udev database. It can also query the properties of a device from its sysfs representation to help creating udev rules that match this device.
 .SH "OPTIONS"
 .TP
+\fB\-a\fR
+Print all sysfs properties of the specified device that can be used in udev rules to match the specified device. It prints all devices along the chain, up to the root of sysfs that can be used in udev rules.
+.TP
+\fB\-e\fR
+Export the content of the udev database.
+.TP
+\fB\-h\fR
+Print help text.
+.TP
+\fB\-n \fR\fB\fInode\-name\fR\fR
+The name of the device node or a symlink to query
+.TP
+\fB\-p \fR\fB\fIdevice\-path\fR\fR
+The sysfs path of the device to query.
+.TP
 \fB\-q\fR
 Query the database for specified type of device data. It needs the 
 \fB\-p\fR 
 or 
 \fB\-n\fR 
 to identify the specified device. Valid queries are: 
+\fBall\fR.
+\fBenv\fR, 
 \fBname\fR, 
-\fBsymlink\fR, 
 \fBpath\fR, 
-\fBenv\fR, 
-\fBall\fR.
-.TP
-\fB\-a\fR
-Print all sysfs properties of the specified device that can be used in udev rules to match the specified device. It prints all devices along the chain, up to the root of sysfs that can be used in udev rules.
-.TP
-\fB\-p \fR\fB\fIdevice\-path\fR\fR
-The sysfs path of the device to query.
-.TP
-\fB\-n \fR\fB\fInode\-name\fR\fR
-The name of the device node or a symlink to query
+\fBsymlink\fR, 
 .TP
 \fB\-r\fR
 The udev root directory: 
@@ -45,12 +51,6 @@ The udev root directory: 
 or 
 \fBsymlink\fR 
 query, the query returns the absolute path.
-.TP
-\fB\-e\fR
-Export the content of the udev database.
-.TP
-\fB\-h\fR
-Print help text.
 .SH "AUTHOR"
 .PP
 Written by Kay Sievers 

[-- Attachment #2: Type: application/pgp-signature, Size: 189 bytes --]