NetBSD/usr.sbin/dbsym/dbsym.8

.\"	$NetBSD: dbsym.8,v 1.3 1999/04/06 04:54:21 cgd Exp $
.\"
.Dd 12 May 1994
.Dt DBSYM 8 sun3
.Os 
.Sh NAME
.Nm dbsym
.Nd copy kernel symbol table into db_symtab space
.Sh SYNOPSIS
.Nm
.Ar kernel
.Sh DESCRIPTION
.Nm
is used to copy the symbol table in a newly linked kernel into the
.Va db_symtab
array (in the data section) so that the
.Xr ddb 4
kernel debugger can find the symbols.  This is program is only used
on systems for which the boot program does not load the symbol table
into memory with the kernel.  The space for these symbols is
reserved in the data segment using a config option like:
.Pp
.Li options		SYMTAB_SPACE=72000
.Pp
The size of the db_symtab array (the value of SYMTAB_SPACE) must be
at least as large as the kernel symbol table.  If insufficient space
is reserved, dbsym will refuse to copy the symbol table.
.Pp
Note that debugging symbols are not useful to the
.Xr ddb 4
kernel debugger, so to minimize the size of the kernel, one should
either compile the kernel without debugging symbols (no
.Fl g
flag) or use the
.Xr strip 1
command to strip debugging symbols from the kernel before
.Nm
is used to copy the symbol table.  The command
.Pp
.Li strip -d netbsd
.Pp
will strip out debugging symbols.
.Sh SEE ALSO
.Xr strip 1 ,
.Xr ddb 4
change: .Sh "SEE ALSO" to: .Sh SEE ALSO The doc macros check for the latter (actually just for 'SEE' as the first argument to .Sh) to set the section header SEE ALSO flag, which modifies some behaviour (e.g. references done with .Rs/.Re). 1999-04-06 08:54:19 +04:00			`.\" $NetBSD: dbsym.8,v 1.3 1999/04/06 04:54:21 cgd Exp $`
Add a man page. 1994-08-26 00:40:28 +04:00			`.\"`
			`.Dd 12 May 1994`
			`.Dt DBSYM 8 sun3`
			`.Os`
			`.Sh NAME`
			`.Nm dbsym`
			`.Nd copy kernel symbol table into db_symtab space`
			`.Sh SYNOPSIS`
WARNSify, use err/warn, cleanup manpage 1997-10-17 09:47:27 +04:00			`.Nm`
Add a man page. 1994-08-26 00:40:28 +04:00			`.Ar kernel`
			`.Sh DESCRIPTION`
WARNSify, use err/warn, cleanup manpage 1997-10-17 09:47:27 +04:00			`.Nm`
Add a man page. 1994-08-26 00:40:28 +04:00			`is used to copy the symbol table in a newly linked kernel into the`
WARNSify, use err/warn, cleanup manpage 1997-10-17 09:47:27 +04:00			`.Va db_symtab`
Add a man page. 1994-08-26 00:40:28 +04:00			`array (in the data section) so that the`
WARNSify, use err/warn, cleanup manpage 1997-10-17 09:47:27 +04:00			`.Xr ddb 4`
Add a man page. 1994-08-26 00:40:28 +04:00			`kernel debugger can find the symbols. This is program is only used`
			`on systems for which the boot program does not load the symbol table`
			`into memory with the kernel. The space for these symbols is`
			`reserved in the data segment using a config option like:`
			`.Pp`
			`.Li options SYMTAB_SPACE=72000`
			`.Pp`
			`The size of the db_symtab array (the value of SYMTAB_SPACE) must be`
			`at least as large as the kernel symbol table. If insufficient space`
			`is reserved, dbsym will refuse to copy the symbol table.`
			`.Pp`
			`Note that debugging symbols are not useful to the`
WARNSify, use err/warn, cleanup manpage 1997-10-17 09:47:27 +04:00			`.Xr ddb 4`
Add a man page. 1994-08-26 00:40:28 +04:00			`kernel debugger, so to minimize the size of the kernel, one should`
			`either compile the kernel without debugging symbols (no`
WARNSify, use err/warn, cleanup manpage 1997-10-17 09:47:27 +04:00			`.Fl g`
Add a man page. 1994-08-26 00:40:28 +04:00			`flag) or use the`
WARNSify, use err/warn, cleanup manpage 1997-10-17 09:47:27 +04:00			`.Xr strip 1`
Add a man page. 1994-08-26 00:40:28 +04:00			`command to strip debugging symbols from the kernel before`
WARNSify, use err/warn, cleanup manpage 1997-10-17 09:47:27 +04:00			`.Nm`
Add a man page. 1994-08-26 00:40:28 +04:00			`is used to copy the symbol table. The command`
			`.Pp`
			`.Li strip -d netbsd`
			`.Pp`
			`will strip out debugging symbols.`
change: .Sh "SEE ALSO" to: .Sh SEE ALSO The doc macros check for the latter (actually just for 'SEE' as the first argument to .Sh) to set the section header SEE ALSO flag, which modifies some behaviour (e.g. references done with .Rs/.Re). 1999-04-06 08:54:19 +04:00			`.Sh SEE ALSO`
WARNSify, use err/warn, cleanup manpage 1997-10-17 09:47:27 +04:00			`.Xr strip 1 ,`
			`.Xr ddb 4`