Re: [patch] man1/*: tfix, use a one-font macro for a single argument

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hello Bjarni,

On 12/24/18 1:20 AM, Bjarni Ingi Gislason wrote:
>   Changes to the git repository "man-pages" from Saturday 22th December
> 2018.
> 
> 1) Use a single capital font macro for a genuine single argument.
>   The output is unchanged.
> 
> 2) Remove quotation marks (") around a single argument.
>   The output is unchanged.
> 
> 3) Change ".IR ab()" to ".IR ab ()"
>   A font is changed in the output.

Patch applied. Mainly because of 3, and because I'm reasonably
sure I have no outstanding patches against man1/*.

Thanks,

Michael

> Signed-off-by: Bjarni Ingi Gislason <bjarniig@xxxxxxxxx>
> ---
>  man1/getent.1       |  2 +-
>  man1/iconv.1        |  6 +++---
>  man1/ldd.1          |  4 ++--
>  man1/locale.1       |  4 ++--
>  man1/localedef.1    |  2 +-
>  man1/memusage.1     | 18 +++++++++---------
>  man1/memusagestat.1 | 10 +++++-----
>  man1/pldd.1         |  4 ++--
>  man1/sprof.1        | 18 +++++++++---------
>  man1/time.1         |  2 +-
>  10 files changed, 35 insertions(+), 35 deletions(-)
> 
> diff --git a/man1/getent.1 b/man1/getent.1
> index 0af76e824..d750ae9f9 100644
> --- a/man1/getent.1
> +++ b/man1/getent.1
> @@ -26,7 +26,7 @@
>  .SH NAME
>  getent \- get entries from Name Service Switch libraries
>  .SH SYNOPSIS
> -.BR getent\ [\fIoption\fP]...\ \fIdatabase\fP\ \fIkey\fP...
> +.B getent\ [\fIoption\fP]...\ \fIdatabase\fP\ \fIkey\fP...
>  .SH DESCRIPTION
>  The
>  .B getent
> diff --git a/man1/iconv.1 b/man1/iconv.1
> index 2fcb5aa92..3bd527f5c 100644
> --- a/man1/iconv.1
> +++ b/man1/iconv.1
> @@ -66,14 +66,14 @@ Use
>  for output characters.
>  .IP
>  If the string
> -.BR //IGNORE
> +.B //IGNORE
>  is appended to
>  .IR to-encoding ,
>  characters that cannot be converted are discarded and an error is
>  printed after conversion.
>  .IP
>  If the string
> -.BR //TRANSLIT
> +.B //TRANSLIT
>  is appended to
>  .IR to-encoding ,
>  characters being converted are transliterated when needed and possible.
> @@ -150,7 +150,7 @@ the system gconv module configuration cache is not used.
>  Instead,
>  .BR iconv_open (3)
>  first tries to load the configuration files by searching the directories in
> -.BR GCONV_PATH
> +.B GCONV_PATH
>  in order,
>  followed by the system default gconv module configuration file.
>  If a directory does not contain a gconv module configuration file,
> diff --git a/man1/ldd.1 b/man1/ldd.1
> index 376f04fe1..bbb6ecfe6 100644
> --- a/man1/ldd.1
> +++ b/man1/ldd.1
> @@ -49,7 +49,7 @@ and find (according to the rules described in
>  .BR ld.so (8))
>  and load the objects that satisfy those dependencies.
>  For each dependency,
> -.BR ldd
> +.B ldd
>  displays the location of the matching object
>  and the (hexadecimal) address at which it is loaded.
>  (The
> @@ -73,7 +73,7 @@ Be aware that in some circumstances
>  .\" Much more detail at
>  .\" http://www.catonmat.net/blog/ldd-arbitrary-code-execution/
>  some versions of
> -.BR ldd
> +.B ldd
>  may attempt to obtain the dependency information
>  by attempting to directly execute the program,
>  which may lead to the execution of whatever code is defined
> diff --git a/man1/locale.1 b/man1/locale.1
> index 0efcadbe3..76f432703 100644
> --- a/man1/locale.1
> +++ b/man1/locale.1
> @@ -78,7 +78,7 @@ which are the names of locale keywords (for example,
>  or
>  .IR decimal_point )
>  or locale categories (for example,
> -.BR LC_CTYPE
> +.B LC_CTYPE
>  or
>  .BR LC_TIME ).
>  For each argument, the following is displayed:
> @@ -122,7 +122,7 @@ combinations.
>  .BR \-? ", " \-\-help
>  Display a summary of command-line options and arguments and exit.
>  .TP
> -.BR \-\-usage
> +.B \-\-usage
>  Display a short usage message and exit.
>  .TP
>  .BR \-V ", " \-\-version
> diff --git a/man1/localedef.1 b/man1/localedef.1
> index 63935feb1..8c9c43612 100644
> --- a/man1/localedef.1
> +++ b/man1/localedef.1
> @@ -50,7 +50,7 @@ localedef \- compile locale definition files
>  .br
>  .B "localedef \-\-add\-to\-archive"
>  .RI [ options ]
> -.IR compiledpath
> +.I compiledpath
>  .br
>  .B "localedef \-\-version"
>  .br
> diff --git a/man1/memusage.1 b/man1/memusage.1
> index e87e507c9..44c676f93 100644
> --- a/man1/memusage.1
> +++ b/man1/memusage.1
> @@ -61,7 +61,7 @@ to create a PNG file containing graphical representation
>  of the collected data.
>  .SS Memory usage summary
>  The "Memory usage summary" line output by
> -.BR memusage
> +.B memusage
>  contains three fields:
>  .RS 4
>  .TP
> @@ -144,7 +144,7 @@ Generate PNG graphic and store it in
>  Generate binary data file and store it in
>  .IR file .
>  .TP
> -.BI \-u\fR,\ \fB\-\-unbuffered
> +.B \-u\fR,\ \fB\-\-unbuffered
>  Do not buffer output.
>  .TP
>  .BI \-b\  size \fR,\ \fB\-\-buffer= size
> @@ -152,33 +152,33 @@ Collect
>  .I size
>  entries before writing them out.
>  .TP
> -.BI \fB\-\-no-timer
> +.B \fB\-\-no-timer
>  Disable timer-based
>  .RB ( SIGPROF )
>  sampling of stack pointer value.
>  .TP
> -.BI \-m\fR,\ \fB\-\-mmap
> +.B \-m\fR,\ \fB\-\-mmap
>  Also trace
>  .BR mmap (2),
>  .BR mremap (2),
>  and
>  .BR munmap (2).
>  .TP
> -.BI \-?\fR,\ \fB\-\-help
> +.B \-?\fR,\ \fB\-\-help
>  Print help and exit.
>  .TP
> -.BI \fB\-\-usage
> +.B \-\-usage
>  Print a short usage message and exit.
>  .TP
> -.BI \-V\fR,\ \fB\-\-version
> +.B \-V\fR,\ \fB\-\-version
>  Print version information and exit.
>  .TP
>  The following options apply only when generating graphical output:
>  .TP
> -.BI \-t\fR,\ \fB\-\-time\-based
> +.B \-t\fR,\ \fB\-\-time\-based
>  Use time (rather than number of function calls) as the scale for the X axis.
>  .TP
> -.BI \-T\fR,\ \fB\-\-total
> +.B \-T\fR,\ \fB\-\-total
>  Also draw a graph of total memory use.
>  .TP
>  .BI \fB\-\-title= name
> diff --git a/man1/memusagestat.1 b/man1/memusagestat.1
> index 21cd5d4b6..87883f062 100644
> --- a/man1/memusagestat.1
> +++ b/man1/memusagestat.1
> @@ -54,10 +54,10 @@ Use
>  .I string
>  as the title inside the output graph.
>  .TP
> -.BI \-t\fR,\ \fB\-\-time
> +.B \-t\fR,\ \fB\-\-time
>  Use time (rather than number of function calls) as the scale for the X axis.
>  .TP
> -.BI \-T\fR,\ \fB\-\-total
> +.B \-T\fR,\ \fB\-\-total
>  Also draw a graph of total memory consumption.
>  .TP
>  .BI \-x\  size \fR,\ \fB\-\-x-size= size
> @@ -70,13 +70,13 @@ Make the output graph
>  .I size
>  pixels high.
>  .TP
> -.BI \-?\fR,\ \fB\-\-help
> +.B \-?\fR,\ \fB\-\-help
>  Print a help message and exit.
>  .TP
> -.BI \fB\-\-usage
> +.B \-\-usage
>  Print a short usage message and exit.
>  .TP
> -.BI \-V\fR,\ \fB\-\-version
> +.B \-V\fR,\ \fB\-\-version
>  Print version information and exit.
>  .SH BUGS
>  To report bugs, see
> diff --git a/man1/pldd.1 b/man1/pldd.1
> index 4e4501251..6957c8d60 100644
> --- a/man1/pldd.1
> +++ b/man1/pldd.1
> @@ -42,7 +42,7 @@ The list includes the libraries that have been dynamically loaded using
>  .BR \-? ", " \-\-help
>  Display program help message.
>  .TP
> -.BR \-\-usage
> +.B \-\-usage
>  Display a short usage message.
>  .TP
>  .BR \-V ", " \-\-version
> @@ -85,7 +85,7 @@ The
>  .I "info shared"
>  command also shows the shared libraries being used by a process,
>  so that one can obtain similar output to
> -.BR pldd
> +.B pldd
>  using a command such as the following
>  (to monitor the process with the specified
>  .IR pid ):
> diff --git a/man1/sprof.1 b/man1/sprof.1
> index 900190d4a..9e40f7d42 100644
> --- a/man1/sprof.1
> +++ b/man1/sprof.1
> @@ -41,7 +41,7 @@ If the profiling data pathname is omitted, then
>  .B sprof
>  will attempt to deduce it using the soname of the shared object,
>  looking for a file with the name
> -.IR <soname>.profile
> +.I <soname>.profile
>  in the current directory.
>  .SH OPTIONS
>  The following command-line options specify the profile output
> @@ -67,7 +67,7 @@ The following additional command-line options are available:
>  .BR \-? ", " \-\-help
>  Display a summary of command-line options and arguments and exit.
>  .TP
> -.BR \-\-usage
> +.B \-\-usage
>  Display a short usage message and exit.
>  .TP
>  .BR \-V ", " \-\-version
> @@ -102,9 +102,9 @@ main(int argc, char *argv[])
>  .in
>  .PP
>  The functions
> -.IR x1()
> +.IR x1 ()
>  and
> -.IR x2()
> +.IR x2 ()
>  are defined in the following source file that is used to
>  construct the shared object:
>  .PP
> @@ -188,7 +188,7 @@ $ \fBldd prog\fP
>  .PP
>  In order to get profiling information for the shared object,
>  we define the environment variable
> -.BR LD_PROFILE
> +.B LD_PROFILE
>  with the soname of the library:
>  .PP
>  .in +4n
> @@ -198,7 +198,7 @@ $ \fBexport LD_PROFILE=libdemo.so.1\fP
>  .in
>  .PP
>  We then define the environment variable
> -.BR LD_PROFILE_OUTPUT
> +.B LD_PROFILE_OUTPUT
>  with the pathname of the directory where profile output should be written,
>  and create that directory if it does not exist already:
>  .PP
> @@ -234,7 +234,7 @@ libdemo.so.1.profile
>  .in
>  .PP
>  We then use the
> -.BR "sprof \-p"
> +.B sprof \-p
>  option to generate a flat profile with counts and ticks:
>  .PP
>  .in +4n
> @@ -253,7 +253,7 @@ Each sample counts as 0.01 seconds.
>  .in
>  .PP
>  The
> -.BR "sprof \-q"
> +.B sprof \-q
>  option generates a call graph:
>  .PP
>  .in +4n
> @@ -284,7 +284,7 @@ are outside of the profiled object (in this example, these are instances of
>  .IR main() ).
>  .PP
>  The
> -.BR "sprof \-c"
> +.B sprof \-c
>  option generates a list of call pairs and the number of their occurrences:
>  .PP
>  .in +4n
> diff --git a/man1/time.1 b/man1/time.1
> index 4d6c4e1c6..13bfa9842 100644
> --- a/man1/time.1
> +++ b/man1/time.1
> @@ -82,7 +82,7 @@ The variables
>  .BR LC_MESSAGES ,
>  .BR LC_NUMERIC ,
>  and
> -.BR NLSPATH
> +.B NLSPATH
>  are used for the text and formatting of the output.
>  .B PATH
>  is used to search for
> 


-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/



[Index of Archives]     [Kernel Documentation]     [Netdev]     [Linux Ethernet Bridging]     [Linux Wireless]     [Kernel Newbies]     [Security]     [Linux for Hams]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux Admin]     [Samba]

  Powered by Linux