strace.1.in: print names of entities in bold, provide man page sections

* strace.1.in (.SH DESCRIPTION): add man page section numbber to open,
lstat, getpwuid, id mentions.
(.SH OPTIONS): make strace mentions bold.
(.SH NOTES): It was meant setrlimit(3), not setrlimit(2).
This commit is contained in:
Eugene Syromyatnikov 2018-09-04 16:45:04 +02:00
parent 71404212b8
commit 059568a665

View File

@ -177,7 +177,7 @@ This example shows the shell performing ">>xyzzy" output redirection:
open("xyzzy", O_WRONLY|O_APPEND|O_CREAT, 0666) = 3 open("xyzzy", O_WRONLY|O_APPEND|O_CREAT, 0666) = 3
.CE .CE
Here, the third argument of Here, the third argument of
.B open .BR open (2)
is decoded by breaking down the is decoded by breaking down the
flag argument into its three bitwise-OR constituents and printing the flag argument into its three bitwise-OR constituents and printing the
mode value in octal by tradition. Where the traditional or native mode value in octal by tradition. Where the traditional or native
@ -198,7 +198,7 @@ displayed symbolically. In particular, observe how the
.B st_mode .B st_mode
member is carefully decoded into a bitwise-OR of symbolic and numeric values. member is carefully decoded into a bitwise-OR of symbolic and numeric values.
Also notice in this example that the first argument to Also notice in this example that the first argument to
.B lstat .BR lstat (2)
is an input to the system call and the second argument is an output. is an input to the system call and the second argument is an output.
Since output arguments are not modified if the system call fails, arguments may Since output arguments are not modified if the system call fails, arguments may
not always be dereferenced. For example, retrying the "ls \-l" example not always be dereferenced. For example, retrying the "ls \-l" example
@ -224,15 +224,16 @@ Only the first
(32 by default) bytes of strings are printed; (32 by default) bytes of strings are printed;
longer strings have an ellipsis appended following the closing quote. longer strings have an ellipsis appended following the closing quote.
Here is a line from "ls \-l" where the Here is a line from "ls \-l" where the
.B getpwuid .BR getpwuid (3)
library routine is reading the password file: library routine is reading the password file:
.CW .CW
read(3, "root::0:0:System Administrator:/"..., 1024) = 422 read(3, "root::0:0:System Administrator:/"..., 1024) = 422
.CE .CE
While structures are annotated using curly braces, simple pointers While structures are annotated using curly braces, simple pointers
and arrays are printed using square brackets with commas separating and arrays are printed using square brackets with commas separating
elements. Here is an example from the command "id" on a system with elements. Here is an example from the command
supplementary group ids: .BR id (1)
on a system with supplementary group ids:
.CW .CW
getgroups(32, [100, 0]) = 2 getgroups(32, [100, 0]) = 2
.CE .CE
@ -835,7 +836,9 @@ One might want to consider using
to obtain a combined strace log view. to obtain a combined strace log view.
.TP .TP
.BI "\-I " interruptible .BI "\-I " interruptible
When strace can be interrupted by signals (such as pressing ^C). When
.B strace
can be interrupted by signals (such as pressing ^C).
1: no signals are blocked; 2: fatal signals are blocked while decoding syscall 1: no signals are blocked; 2: fatal signals are blocked while decoding syscall
(default); 3: fatal signals are always blocked (default if '-o FILE PROG'); (default); 3: fatal signals are always blocked (default if '-o FILE PROG');
4: fatal signals and SIGTSTP (^Z) are always blocked (useful to make 4: fatal signals and SIGTSTP (^Z) are always blocked (useful to make
@ -987,8 +990,11 @@ This support is optional and relies on ability to generate and parse structure
definitions during the build time. definitions during the build time.
Please refer to the output of the Please refer to the output of the
.B strace \-V .B strace \-V
command in order to figure out what support is available in your strace build command in order to figure out what support is available in your
("non-native" refers to an ABI that differs from the ABI strace has): .B strace
build ("non-native" refers to an ABI that differs from the ABI
.B strace
has):
.TP 15 .TP 15
.B m32-mpers .B m32-mpers
.B strace .B strace
@ -1035,7 +1041,7 @@ or have a different name. For example, the
system call does not have system call does not have
.I flags .I flags
argument, and the argument, and the
.BR setrlimit (2) .BR setrlimit (3)
library function uses library function uses
.BR prlimit64 (2) .BR prlimit64 (2)
system call on modern (2.6.38+) kernels. These system call on modern (2.6.38+) kernels. These