summaryrefslogtreecommitdiffstats
path: root/man5
diff options
context:
space:
mode:
authorAlejandro Colomar <alx@kernel.org>2023-10-22 14:57:46 +0200
committerAlejandro Colomar <alx@kernel.org>2023-10-23 22:13:39 +0200
commit6fdb1c03075b31364968bcccf472a4d4a86952a6 (patch)
treed68dd6326fb842f90e18b84401789af20aee67e6 /man5
parent59804ef61b00a6b463434a949c80f264f4ff0516 (diff)
man*/: ffix (Use '.TQ' where appropriate)
When there are multiple tags for a paragraph, using a single TP and separating the tags with commas makes the man(7) source more complex. It also has a disadvantage: when searching through a manual page, heuristics such as " --option" don't work so well. By using GNU's TQ, we simplify the source of the pages, and improve the ability to search them. Signed-off-by: Alejandro Colomar <alx@kernel.org>
Diffstat (limited to 'man5')
-rw-r--r--man5/elf.537
-rw-r--r--man5/proc_pid_status.530
2 files changed, 51 insertions, 16 deletions
diff --git a/man5/elf.5 b/man5/elf.5
index 1518a2ac8..824476bcf 100644
--- a/man5/elf.5
+++ b/man5/elf.5
@@ -727,7 +727,9 @@ occur only if the program header table is part of the memory image of the
program.
If it is present, it must precede any loadable segment entry.
.TP
-.BR PT_LOPROC ", " PT_HIPROC
+.B PT_LOPROC
+.TQ
+.B PT_HIPROC
Values in the inclusive range
.RB [ PT_LOPROC ,
.BR PT_HIPROC ]
@@ -848,7 +850,9 @@ or otherwise meaningless section reference.
.B SHN_LORESERVE
This value specifies the lower bound of the range of reserved indices.
.TP
-.BR SHN_LOPROC ", " SHN_HIPROC
+.B SHN_LOPROC
+.TQ
+.B SHN_HIPROC
Values greater in the inclusive range
.RB [ SHN_LOPROC ,
.BR SHN_HIPROC ]
@@ -1002,7 +1006,9 @@ object file can also contain a
.B SHT_SYMTAB
section.
.TP
-.BR SHT_LOPROC ", " SHT_HIPROC
+.B SHT_LOPROC
+.TQ
+.B SHT_HIPROC
Values in the inclusive range
.RB [ SHT_LOPROC ,
.BR SHT_HIPROC ]
@@ -1520,7 +1526,9 @@ and it precedes the other
.B STB_LOCAL
symbols of the file, if it is present.
.TP
-.BR STT_LOPROC ", " STT_HIPROC
+.B STT_LOPROC
+.TQ
+.B STT_HIPROC
Values in the inclusive range
.RB [ STT_LOPROC ,
.BR STT_HIPROC ]
@@ -1542,7 +1550,9 @@ reference to the same symbol.
Weak symbols resemble global symbols, but their definitions have lower
precedence.
.TP
-.BR STB_LOPROC ", " STB_HIPROC
+.B STB_LOPROC
+.TQ
+.B STB_HIPROC
Values in the inclusive range
.RB [ STB_LOPROC ,
.BR STB_HIPROC ]
@@ -1552,18 +1562,23 @@ are reserved for processor-specific semantics.
There are macros for packing and unpacking the binding and type fields:
.RS
.TP
-.BR ELF32_ST_BIND( \fIinfo\fP ) ", " ELF64_ST_BIND( \fIinfo\fP )
+.BI ELF32_ST_BIND( info )
+.TQ
+.BI ELF64_ST_BIND( info )
Extract a binding from an
.I st_info
value.
.TP
-.BR ELF32_ST_TYPE( \fIinfo ) ", " ELF64_ST_TYPE( \fIinfo\fP )
+.BI ELF32_ST_TYPE( info )
+.TQ
+.BI ELF64_ST_TYPE( info )
Extract a type from an
.I st_info
value.
.TP
-.BR ELF32_ST_INFO( \fIbind\fP ", " \fItype\fP ) ", " \
-ELF64_ST_INFO( \fIbind\fP ", " \fItype\fP )
+.BI ELF32_ST_INFO( bind ", " type )
+.TQ
+.BI ELF64_ST_INFO( bind ", " type )
Convert a binding and a type into an
.I st_info
value.
@@ -1806,7 +1821,9 @@ transferring control to the executable
.B DT_RUNPATH
String table offset to library search path
.TP
-.BR DT_LOPROC ", " DT_HIPROC
+.B DT_LOPROC
+.TQ
+.B DT_HIPROC
Values in the inclusive range
.RB [ DT_LOPROC ,
.BR DT_HIPROC ]
diff --git a/man5/proc_pid_status.5 b/man5/proc_pid_status.5
index 597c70f7b..65a75546e 100644
--- a/man5/proc_pid_status.5
+++ b/man5/proc_pid_status.5
@@ -121,7 +121,9 @@ PID of parent process.
.I TracerPid
PID of process tracing this process (0 if not being traced).
.TP
-.IR Uid ", " Gid
+.I Uid
+.TQ
+.I Gid
Real, effective, saved set, and filesystem UIDs (GIDs).
.TP
.I FDSize
@@ -224,7 +226,11 @@ and shared anonymous mappings).
.\" commit bf9683d6990589390b5178dafe8fd06808869293
(since Linux 4.5).
.TP
-.IR VmData ", " VmStk ", " VmExe
+.I VmData
+.TQ
+.I VmStk
+.TQ
+.I VmExe
Size of data, stack, and text segments.
This value is inaccurate; see
.IR /proc/ pid /statm
@@ -276,19 +282,29 @@ resource limit on the number of queued signals for this process
in
.BR getrlimit (2)).
.TP
-.IR SigPnd ", " ShdPnd
+.I SigPnd
+.TQ
+.I ShdPnd
Mask (expressed in hexadecimal)
of signals pending for thread and for process as a whole (see
.BR pthreads (7)
and
.BR signal (7)).
.TP
-.IR SigBlk ", " SigIgn ", " SigCgt
+.I SigBlk
+.TQ
+.I SigIgn
+.TQ
+.I SigCgt
Masks (expressed in hexadecimal)
indicating signals being blocked, ignored, and caught (see
.BR signal (7)).
.TP
-.IR CapInh ", " CapPrm ", " CapEff
+.I CapInh
+.TQ
+.I CapPrm
+.TQ
+.I CapEff
Masks (expressed in hexadecimal)
of capabilities enabled in inheritable, permitted, and effective sets
(see
@@ -359,7 +375,9 @@ Same as previous, but in "list format"
(since Linux 2.6.26, see
.BR cpuset (7)).
.TP
-.IR voluntary_ctxt_switches ", " nonvoluntary_ctxt_switches
+.I voluntary_ctxt_switches
+.TQ
+.I nonvoluntary_ctxt_switches
Number of voluntary and involuntary context switches (since Linux 2.6.23).
.RE
.SH SEE ALSO