From 3c405c7e83678684e61b3c1a17e89f65eb4f059a Mon Sep 17 00:00:00 2001 From: Jens Schweikhardt Date: Wed, 17 Aug 2022 19:13:22 +0200 Subject: [PATCH] Indicate which port gdb.1 and kgdb.1 come from. --- sbin/dumpon/dumpon.8 | 6 +++--- share/man/man4/dcons.4 | 2 +- share/man/man4/ddb.4 | 8 ++++---- share/man/man4/gdb.4 | 16 ++++++++-------- share/man/man4/ti.4 | 2 +- share/man/man5/a.out.5 | 4 ++-- share/man/man5/core.5 | 2 +- share/man/man5/elf.5 | 2 +- share/man/man5/rc.conf.5 | 2 +- share/man/man9/ktr.9 | 2 +- usr.bin/gcore/gcore.1 | 4 ++-- usr.sbin/config/config.8 | 2 +- usr.sbin/dconschat/dconschat.8 | 20 ++++++++++---------- 13 files changed, 36 insertions(+), 36 deletions(-) diff --git a/sbin/dumpon/dumpon.8 b/sbin/dumpon/dumpon.8 index de9bd648e68b..473f0658158a 100644 --- a/sbin/dumpon/dumpon.8 +++ b/sbin/dumpon/dumpon.8 @@ -312,7 +312,7 @@ or shorter: The .Pa vmcore.# can be now examined using -.Xr kgdb 1 : +.Xr kgdb 1 Pq Pa ports/devel/gdb : .Pp .Dl # kgdb /boot/kernel/kernel vmcore.# .Pp @@ -321,7 +321,7 @@ or shorter: .Dl # kgdb -n # .Pp The core was decrypted properly if -.Xr kgdb 1 +.Xr kgdb 1 Pq Pa ports/devel/gdb does not print any errors. Note that the live kernel might be at a different path which can be examined by looking at the @@ -368,7 +368,7 @@ Be sure to fill in the server IP address and change the interface name if needed. .Sh SEE ALSO .Xr gzip 1 , -.Xr kgdb 1 , +.Xr kgdb 1 Pq Pa ports/devel/gdb , .Xr zstd 1 , .Xr ddb 4 , .Xr netdump 4 , diff --git a/share/man/man4/dcons.4 b/share/man/man4/dcons.4 index d228ad5c16b9..2b8292695649 100644 --- a/share/man/man4/dcons.4 +++ b/share/man/man4/dcons.4 @@ -102,7 +102,7 @@ for more details. If you want to use .Nm as a -.Xr gdb 1 +.Xr gdb 1 Pq Pa ports/devel/gdb port, add the following line into .Xr loader.conf 5 : .Bd -literal -offset indent diff --git a/share/man/man4/ddb.4 b/share/man/man4/ddb.4 index d7b51b270877..f8bf45c62c73 100644 --- a/share/man/man4/ddb.4 +++ b/share/man/man4/ddb.4 @@ -58,7 +58,7 @@ representation, define: .Ed .Pp To enable the -.Xr gdb 1 +.Xr gdb 1 Pq Pa ports/devel/gdb backend, so that remote debugging with .Xr kgdb 1 Pq Pa ports/devel/gdb is possible, include: @@ -69,7 +69,7 @@ is possible, include: The .Nm kernel debugger is an interactive debugger with a syntax inspired by -.Xr gdb 1 . +.Xr gdb 1 Pq Pa ports/devel/gdb . If linked into the running kernel, it can be invoked locally with the .Ql debug @@ -1190,7 +1190,7 @@ subsystem. .It Ic gdb Switches to remote GDB mode. In remote GDB mode, another machine is required that runs -.Xr gdb 1 +.Xr gdb 1 Pq Pa ports/devel/gdb using the remote debug feature, with a connection to the serial console port on the target machine. .Pp @@ -1598,7 +1598,7 @@ directory. .Pa sys/vnode.h .El .Sh SEE ALSO -.Xr gdb 1 , +.Xr gdb 1 Pq Pa ports/devel/gdb , .Xr kgdb 1 Pq Pa ports/devel/gdb , .Xr acpi 4 , .Xr CAM 4 , diff --git a/share/man/man4/gdb.4 b/share/man/man4/gdb.4 index de2f4d108048..47a1c9896843 100644 --- a/share/man/man4/gdb.4 +++ b/share/man/man4/gdb.4 @@ -37,7 +37,7 @@ The .Nm kernel debugger is a variation of -.Xr gdb 1 +.Xr gdb 1 Pq Pa ports/devel/gdb which understands some aspects of the .Fx kernel environment. @@ -90,7 +90,7 @@ on, In this mode, you need the .Fl k flag to indicate to -.Xr gdb 1 +.Xr gdb 1 Pq Pa ports/devel/gdb that the .Dq "dump file" .Pa /dev/mem @@ -336,9 +336,9 @@ The remote system continues to run. The user interface to .Nm is via -.Xr gdb 1 , +.Xr gdb 1 Pq Pa ports/devel/gdb , so -.Xr gdb 1 +.Xr gdb 1 Pq Pa ports/devel/gdb commands also work. This section discusses only the extensions for kernel debugging that get installed in the kernel build directory. @@ -387,7 +387,7 @@ are convenience commands which invoke .Ss "The current process environment" The following macros are convenience functions intended to make things easier than the standard -.Xr gdb 1 +.Xr gdb 1 Pq Pa ports/devel/gdb commands. .Bl -tag -width indent .It Ic f0 @@ -467,7 +467,7 @@ Show some PCB contents of the process .El .Ss "Examining data structures" You can use standard -.Xr gdb 1 +.Xr gdb 1 Pq Pa ports/devel/gdb commands to look at most data structures. The macros in this section are convenience functions which typically display the data in a more readable @@ -568,7 +568,7 @@ It does nothing else except to print a warning message to remind you to remove it again. .El .Sh SEE ALSO -.Xr gdb 1 , +.Xr gdb 1 Pq Pa ports/devel/gdb , .Xr ps 1 , .Xr ddb 4 , .Xr firewire 4 , @@ -581,7 +581,7 @@ This man page was written by .An Greg Lehey Aq Mt grog@FreeBSD.org . .Sh BUGS The -.Xr gdb 1 +.Xr gdb 1 Pq Pa ports/devel/gdb debugger was never designed to debug kernels, and it is not a very good match. Many problems exist. diff --git a/share/man/man4/ti.4 b/share/man/man4/ti.4 index a589ec048ebf..3209d9a0359f 100644 --- a/share/man/man4/ti.4 +++ b/share/man/man4/ti.4 @@ -299,7 +299,7 @@ driver also includes a character device interface that can be used for additional diagnostics, configuration and debugging. With this character device interface, and a specially patched version of -.Xr gdb 1 , +.Xr gdb 1 Pq Pa ports/devel/gdb , the user can debug firmware running on the Tigon board. .Pp diff --git a/share/man/man5/a.out.5 b/share/man/man5/a.out.5 index aa4c7da96929..606c96a4125a 100644 --- a/share/man/man5/a.out.5 +++ b/share/man/man5/a.out.5 @@ -386,7 +386,7 @@ The .Dv N_STAB mask selects bits of interest to symbolic debuggers such as -.Xr gdb 1 ; +.Xr gdb 1 Pq Pa ports/devel/gdb ; the values are described in .Xr stab 5 . .It Fa n_other @@ -429,7 +429,7 @@ so its minimum value (or the offset of the first string) is always 4 on 32-bit machines. .Sh SEE ALSO .Xr as 1 , -.Xr gdb 1 , +.Xr gdb 1 Pq Pa ports/devel/gdb , .Xr ld 1 , .Xr brk 2 , .Xr execve 2 , diff --git a/share/man/man5/core.5 b/share/man/man5/core.5 index f109b7932308..09dfbc12e8f6 100644 --- a/share/man/man5/core.5 +++ b/share/man/man5/core.5 @@ -177,7 +177,7 @@ command can be used: .Pp .Dl sysctl kern.corefile=/var/coredumps/\&%U/\&%N.core .Sh SEE ALSO -.Xr gdb 1 , +.Xr gdb 1 Pq Pa ports/devel/gdb , .Xr gzip 1 , .Xr kgdb 1 Pq Pa ports/devel/gdb , .Xr setrlimit 2 , diff --git a/share/man/man5/elf.5 b/share/man/man5/elf.5 index 95bc183a1f91..9a004bb3d08a 100644 --- a/share/man/man5/elf.5 +++ b/share/man/man5/elf.5 @@ -1387,7 +1387,7 @@ writeable and executable. .El .Sh SEE ALSO .Xr as 1 , -.Xr gdb 1 , +.Xr gdb 1 Pq Pa ports/devel/gdb , .Xr ld 1 , .Xr objdump 1 , .Xr readelf 1 , diff --git a/share/man/man5/rc.conf.5 b/share/man/man5/rc.conf.5 index 473f5b16a30f..d86af5a0f224 100644 --- a/share/man/man5/rc.conf.5 +++ b/share/man/man5/rc.conf.5 @@ -4685,7 +4685,7 @@ The default is 10. .El .Sh SEE ALSO .Xr chmod 1 , -.Xr gdb 1 , +.Xr gdb 1 Pq Pa ports/devel/gdb , .Xr info 1 , .Xr kbdcontrol 1 , .Xr limits 1 , diff --git a/share/man/man9/ktr.9 b/share/man/man9/ktr.9 index cfe9cacf8611..2bb6f9991ee9 100644 --- a/share/man/man9/ktr.9 +++ b/share/man/man9/ktr.9 @@ -61,7 +61,7 @@ style fashion. These events can then be dumped with .Xr ddb 4 , -.Xr gdb 1 +.Xr gdb 1 Pq Pa ports/devel/gdb or .Xr ktrdump 8 . .Pp diff --git a/usr.bin/gcore/gcore.1 b/usr.bin/gcore/gcore.1 index aa93a5ef1fe0..60a99d8a1a62 100644 --- a/usr.bin/gcore/gcore.1 +++ b/usr.bin/gcore/gcore.1 @@ -46,7 +46,7 @@ The .Nm utility creates a core image of the specified process, suitable for use with -.Xr gdb 1 . +.Xr gdb 1 Pq Pa ports/devel/gdb . By default, the core is written to the file .Dq Pa core. . The process identifier, @@ -96,7 +96,7 @@ usage may not work with processes which are actively being investigated with .Xr truss 1 or -.Xr gdb 1 . +.Xr gdb 1 Pq Pa ports/devel/gdb . Additionally, interruptable sleeps may exit with EINTR. .Pp The diff --git a/usr.sbin/config/config.8 b/usr.sbin/config/config.8 index 929607712ef8..77a0618527c0 100644 --- a/usr.sbin/config/config.8 +++ b/usr.sbin/config/config.8 @@ -178,7 +178,7 @@ debuggers available prior to .Bx 4.4 Lite were able to find some information from a normal kernel; -.Xr gdb 1 +.Xr gdb 1 Pq Pa ports/devel/gdb provides very little support for normal kernels, and a debug kernel is needed for any meaningful analysis. .Pp diff --git a/usr.sbin/dconschat/dconschat.8 b/usr.sbin/dconschat/dconschat.8 index 330f44c530c5..98e79752bf58 100644 --- a/usr.sbin/dconschat/dconschat.8 +++ b/usr.sbin/dconschat/dconschat.8 @@ -79,16 +79,16 @@ utility and the .Xr dcons 4 driver communicate using 2 ports, one for the console port and another for remote -.Xr gdb 1 +.Xr gdb 1 Pq Pa ports/devel/gdb port. Users are supposed to access .Nm using TTY, .Xr telnet 1 and -.Xr gdb 1 . +.Xr gdb 1 Pq Pa ports/devel/gdb . You can specify listen ports for console and -.Xr gdb 1 +.Xr gdb 1 Pq Pa ports/devel/gdb port using the .Fl C and @@ -129,7 +129,7 @@ The following options are supported. Translate Ctrl-C to ALT_BREAK (CR + .Ql ~ + Ctrl-B) on -.Xr gdb 1 +.Xr gdb 1 Pq Pa ports/devel/gdb port. .It Fl r Replay old buffer on connection. @@ -169,7 +169,7 @@ Specify the console port. The default value is 0 (stdin/stdout). .It Fl G Ar gdb_port Specify -.Xr gdb 1 +.Xr gdb 1 Pq Pa ports/devel/gdb port. The default value is \-1 (disabled). .It Fl M Ar core @@ -252,9 +252,9 @@ To quit the session, type CR + in the console port. .Pp Using -.Xr gdb 1 +.Xr gdb 1 Pq Pa ports/devel/gdb port is almost the same as remote -.Xr gdb 1 +.Xr gdb 1 Pq Pa ports/devel/gdb over serial line except using TCP/IP instead of .Pa /dev/cu* . @@ -271,13 +271,13 @@ for details. .Ed .Pp Once -.Xr gdb 1 +.Xr gdb 1 Pq Pa ports/devel/gdb is attached and you specified the .Fl b option to .Nm , typing Ctrl-C in -.Xr gdb 1 +.Xr gdb 1 Pq Pa ports/devel/gdb causes a break to debugger. .Pp The following command gets the console log from the crash dump: @@ -311,7 +311,7 @@ console remote { } .Ed .Sh SEE ALSO -.Xr gdb 1 , +.Xr gdb 1 Pq Pa ports/devel/gdb , .Xr telnet 1 , .Xr kvm 3 , .Xr dcons 4 ,