diff options
| author | Alejandro Colomar <alx@kernel.org> | 2022-10-26 01:01:32 +0200 |
|---|---|---|
| committer | Alejandro Colomar <alx@kernel.org> | 2022-10-29 23:51:29 +0200 |
| commit | 22356d97e388c79993c94d43109087d3c8740187 (patch) | |
| tree | 3746eae8880200683dc61f1c44d55e3d62649dfd /man1 | |
| parent | 4279e42dd98a11b31fa4e1fcebbb00b7a677bb70 (diff) | |
Many pages: Use a consistent style for lists
There are different kinds of lists:
Tagged paragraphs
These are fixed in a separate commit (the previous one).
They are used for a list of tags and their descriptions.
An example is this commit message itself.
Ordered lists
Elements are preceeded by a number in parentheses.
These represent a set of steps that have an order.
When there are substeps, they will be numbered like (4.2).
Positional lists
Elements are preceeded by a number in square brackets
(index). These represent fields in a set. The index will
start at:
0 fields of a C data structure, to be consistent
with arrays.
1 fields of a file, to be consistent with tools like
cut(1).
Alternatives list
Elements are preceeded by a letter in parentheses.
These represent a set of (normally) exclusive
alternatives.
Bullet lists
Elements are preceeded by bullet symbols. Anything that
doesn't fit elsewhere usually is covered by this type of
list.
Notes
Not really a list, but the syntax is identical to
"positional lists".
There should always be 2 spaces between the list symbol and the
elements. This doesn't apply to "tagged paragraphs", which use
the default indentation rules.
Reported-by: Mike Frysinger <vapier@gentoo.org>
Cc: <groff@gnu.org>
Acked-by: Douglas McIlroy <douglas.mcilroy@dartmouth.edu>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
Diffstat (limited to 'man1')
| -rw-r--r-- | man1/iconv.1 | 4 | ||||
| -rw-r--r-- | man1/locale.1 | 4 | ||||
| -rw-r--r-- | man1/localedef.1 | 6 |
3 files changed, 7 insertions, 7 deletions
diff --git a/man1/iconv.1 b/man1/iconv.1 index 4fd06a1ad..5140e15e1 100644 --- a/man1/iconv.1 +++ b/man1/iconv.1 @@ -110,7 +110,7 @@ program must first allocate a conversion descriptor using The operation of the latter function is influenced by the setting of the .B GCONV_PATH environment variable: -.IP * 3 +.IP \(bu 3 If .B GCONV_PATH is not set, @@ -121,7 +121,7 @@ and then, based on the configuration, loads the gconv modules needed to perform the conversion. If the system gconv module configuration cache file is not available then the system gconv module configuration file is used. -.IP * +.IP \(bu If .B GCONV_PATH is defined (as a colon-separated list of pathnames), diff --git a/man1/locale.1 b/man1/locale.1 index 0b5e765c7..da240d116 100644 --- a/man1/locale.1 +++ b/man1/locale.1 @@ -62,9 +62,9 @@ or locale categories (for example, or .BR LC_TIME ). For each argument, the following is displayed: -.IP * 3 +.IP \(bu 3 For a locale keyword, the value of that keyword to be displayed. -.IP * +.IP \(bu For a locale category, the values of all keywords in that category are displayed. .PP diff --git a/man1/localedef.1 b/man1/localedef.1 index 1f6f8efcc..9c393cd66 100644 --- a/man1/localedef.1 +++ b/man1/localedef.1 @@ -57,7 +57,7 @@ etc.), and places the output in The .I outputpath argument is interpreted as follows: -.IP * 3 +.IP \(bu 3 If .I outputpath contains a slash character ('/'), it is interpreted as the name of the @@ -66,7 +66,7 @@ In this case, there is a separate output file for each locale category .RI ( LC_TIME , .IR LC_NUMERIC , and so on). -.IP * +.IP \(bu If the .B \-\-no\-archive option is used, @@ -74,7 +74,7 @@ option is used, is the name of a subdirectory in .I /usr/lib/locale where per-category compiled files are placed. -.IP * +.IP \(bu Otherwise, .I outputpath is the name of a locale and the compiled locale data is added to the |