freebsd-dev/usr.sbin/asf/asf.8

.\" Copyright (c) 2003 Greg Lehey.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" This software is provided by Greg Lehey ``as is'' and
.\" any express or implied warranties, including, but not limited to, the
.\" implied warranties of merchantability and fitness for a particular purpose
.\" are disclaimed.  in no event shall Greg Lehey be liable
.\" for any direct, indirect, incidental, special, exemplary, or consequential
.\" damages (including, but not limited to, procurement of substitute goods
.\" or services; loss of use, data, or profits; or business interruption)
.\" however caused and on any theory of liability, whether in contract, strict
.\" liability, or tort (including negligence or otherwise) arising in any way
.\" out of the use of this software, even if advised of the possibility of
.\" such damage.
.\"
.\" $FreeBSD$
.\"
.Dd June 8, 2003
.Os
.Dt ASF 8
.Sh NAME
.Nm asf
.Nd add symbol files
.Sh SYNOPSIS
.Nm
.Op Fl afksx
.Op Ar modules-path Op Ar outfile
.Sh DESCRIPTION
By default,
.Nm
reads
.Xr kldstat 8
output from standard input and writes to standard output a list of
.Xr gdb 1
commands to add symbol files from KLDs in subdirectories of the subdirectory
.Pa modules
of the current directory, which is intended to be a kernel build directory.
This allows
.Xr gdb 1
to load the symbols into the debugging environment.
.Pp
If
.Ar modules-path
is specified,
.Nm
uses it for the modules directory instead of the default
.Pa modules .
This is useful when building in a non-standard location (i.e., not
.Pa /usr/src
and
.Pa /usr/obj ) .
.Pp
If
.Ar outfile
is specified,
.Nm
writes to it instead of standard output.
.Sh OPTIONS
The following options modify the function of
.Nm :
.Bl -tag -width indent
.It Fl a
When writing to an explicit
.Ar outfile ,
append to the file rather than overwriting it.
.It Fl f
Instead of trying to simplistically guess the path for each module, perform
a traversal in the same way that
.Xr find 1
does to locate an exact path for each module, no matter where in
.Ar modules-path
it is located.
.It Fl k
Instead of reading from standard input, start a
.Xr kldstat 8
and read the information from it.
.It Fl s
Do not prepend a (guessed) subdirectory of the module path.
.It Fl x
Normally
.Nm
looks for KLDs with names of the form
.Ao Ar module Ac Ns Pa .ko.debug .
The
.Fl x
option tells
.Nm
to look for KLDs with names of the form
.Ao Ar module Ac Ns Pa .ko .
.El
.Sh SEE ALSO
.Xr gdb 1 ,
.Xr kldstat 8
.Sh HISTORY
The
.Nm
utility first appeared in
.Fx 5.2 .
.Sh AUTHORS
.An Greg Lehey Aq grog@FreeBSD.org
.Sh BUGS
It should be possible to write to an
.Ar outfile
without specifying a module path.
Add man page. 2003-06-08 06:57:57 +00:00			`.\" Copyright (c) 2003 Greg Lehey. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\"`
			.\" This software is provided by Greg Lehey ``as is'' and
			`.\" any express or implied warranties, including, but not limited to, the`
			`.\" implied warranties of merchantability and fitness for a particular purpose`
			`.\" are disclaimed. in no event shall Greg Lehey be liable`
			`.\" for any direct, indirect, incidental, special, exemplary, or consequential`
			`.\" damages (including, but not limited to, procurement of substitute goods`
			`.\" or services; loss of use, data, or profits; or business interruption)`
			`.\" however caused and on any theory of liability, whether in contract, strict`
			`.\" liability, or tort (including negligence or otherwise) arising in any way`
			`.\" out of the use of this software, even if advised of the possibility of`
			`.\" such damage.`
			`.\"`
			`.\" $FreeBSD$`
			`.\"`
			`.Dd June 8, 2003`
			`.Os`
Oops, this is section 8, not 1. 2003-06-08 06:59:33 +00:00			`.Dt ASF 8`
Add man page. 2003-06-08 06:57:57 +00:00			`.Sh NAME`
			`.Nm asf`
			`.Nd add symbol files`
			`.Sh SYNOPSIS`
			`.Nm`
Add a "-f" flag for asf(8) which performs a search to find the each module no matter where in the directory structure it may be. Use this and the "-k" flag in the generated gdbinit files so that the "getsyms" function in gdb requires no user intervention to run and will find every module if they're in the kernel build's module directory. This is still quite useful for cases where gdb knows that the path for some modules is /boot/kernel and others are in the object directory for /usr/src/sys/$ARCH/compile/kernel. Approved by: grog 2003-11-04 06:38:37 +00:00			`.Op Fl afksx`
Add man page. 2003-06-08 06:57:57 +00:00			`.Op Ar modules-path Op Ar outfile`
			`.Sh DESCRIPTION`
			`By default,`
			`.Nm`
			`reads`
Tidy up the manpage. Reviewed by: grog 2003-06-10 05:29:14 +00:00			`.Xr kldstat 8`
Add man page. 2003-06-08 06:57:57 +00:00			`output from standard input and writes to standard output a list of`
Tidy up the manpage. Reviewed by: grog 2003-06-10 05:29:14 +00:00			`.Xr gdb 1`
			`commands to add symbol files from KLDs in subdirectories of the subdirectory`
			`.Pa modules`
Add man page. 2003-06-08 06:57:57 +00:00			`of the current directory, which is intended to be a kernel build directory.`
Tidy up the manpage. Reviewed by: grog 2003-06-10 05:29:14 +00:00			`This allows`
			`.Xr gdb 1`
Add man page. 2003-06-08 06:57:57 +00:00			`to load the symbols into the debugging environment.`
			`.Pp`
			`If`
Tidy up the manpage. Reviewed by: grog 2003-06-10 05:29:14 +00:00			`.Ar modules-path`
Add man page. 2003-06-08 06:57:57 +00:00			`is specified,`
			`.Nm`
			`uses it for the modules directory instead of the default`
			`.Pa modules .`
Tidy up the manpage. Reviewed by: grog 2003-06-10 05:29:14 +00:00			`This is useful when building in a non-standard location (i.e., not`
Add man page. 2003-06-08 06:57:57 +00:00			`.Pa /usr/src`
			`and`
Tidy up the manpage. Reviewed by: grog 2003-06-10 05:29:14 +00:00			`.Pa /usr/obj ) .`
Add man page. 2003-06-08 06:57:57 +00:00			`.Pp`
			`If`
Tidy up the manpage. Reviewed by: grog 2003-06-10 05:29:14 +00:00			`.Ar outfile`
Add man page. 2003-06-08 06:57:57 +00:00			`is specified,`
Tidy up the manpage. Reviewed by: grog 2003-06-10 05:29:14 +00:00			`.Nm`
Add man page. 2003-06-08 06:57:57 +00:00			`writes to it instead of standard output.`
			`.Sh OPTIONS`
			`The following options modify the function of`
			`.Nm :`
			`.Bl -tag -width indent`
			`.It Fl a`
			`When writing to an explicit`
Tidy up the manpage. Reviewed by: grog 2003-06-10 05:29:14 +00:00			`.Ar outfile ,`
Add man page. 2003-06-08 06:57:57 +00:00			`append to the file rather than overwriting it.`
Add a "-f" flag for asf(8) which performs a search to find the each module no matter where in the directory structure it may be. Use this and the "-k" flag in the generated gdbinit files so that the "getsyms" function in gdb requires no user intervention to run and will find every module if they're in the kernel build's module directory. This is still quite useful for cases where gdb knows that the path for some modules is /boot/kernel and others are in the object directory for /usr/src/sys/$ARCH/compile/kernel. Approved by: grog 2003-11-04 06:38:37 +00:00			`.It Fl f`
			`Instead of trying to simplistically guess the path for each module, perform`
			`a traversal in the same way that`
			`.Xr find 1`
			`does to locate an exact path for each module, no matter where in`
			`.Ar modules-path`
			`it is located.`
Add man page. 2003-06-08 06:57:57 +00:00			`.It Fl k`
			`Instead of reading from standard input, start a`
Tidy up the manpage. Reviewed by: grog 2003-06-10 05:29:14 +00:00			`.Xr kldstat 8`
Add man page. 2003-06-08 06:57:57 +00:00			`and read the information from it.`
Add -s option to strip subdirectory from module path. e.g. moudle-path/firewire/firewire.ko -> module-path/firewire.ko Reviewed by: grog 2003-09-25 07:56:48 +00:00			`.It Fl s`
Assorted markup, grammar, and spelling fixes. 2004-06-13 18:03:44 +00:00			`Do not prepend a (guessed) subdirectory of the module path.`
Add man page. 2003-06-08 06:57:57 +00:00			`.It Fl x`
			`Normally`
Tidy up the manpage. Reviewed by: grog 2003-06-10 05:29:14 +00:00			`.Nm`
			`looks for KLDs with names of the form`
			`.Ao Ar module Ac Ns Pa .ko.debug .`
Add man page. 2003-06-08 06:57:57 +00:00			`The`
			`.Fl x`
			`option tells`
			`.Nm`
Tidy up the manpage. Reviewed by: grog 2003-06-10 05:29:14 +00:00			`to look for KLDs with names of the form`
			`.Ao Ar module Ac Ns Pa .ko .`
Add man page. 2003-06-08 06:57:57 +00:00			`.El`
Sort sections. 2005-01-18 20:02:45 +00:00			`.Sh SEE ALSO`
			`.Xr gdb 1 ,`
			`.Xr kldstat 8`
Add man page. 2003-06-08 06:57:57 +00:00			`.Sh HISTORY`
Tidy up the manpage. Reviewed by: grog 2003-06-10 05:29:14 +00:00			`The`
Add man page. 2003-06-08 06:57:57 +00:00			`.Nm`
Tidy up the manpage. Reviewed by: grog 2003-06-10 05:29:14 +00:00			`utility first appeared in`
			`.Fx 5.2 .`
Add man page. 2003-06-08 06:57:57 +00:00			`.Sh AUTHORS`
			`.An Greg Lehey Aq grog@FreeBSD.org`
			`.Sh BUGS`
Tidy up the manpage. Reviewed by: grog 2003-06-10 05:29:14 +00:00			`It should be possible to write to an`
			`.Ar outfile`
			`without specifying a module path.`