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

113 lines
3.1 KiB
Groff
Raw Normal View History

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
2003-06-08 06:59:33 +00:00
.Dt ASF 8
2003-06-08 06:57:57 +00:00
.Sh NAME
.Nm asf
.Nd add symbol files
.Sh SYNOPSIS
.Nm
.Op Fl afksx
2003-06-08 06:57:57 +00:00
.Op Ar modules-path Op Ar outfile
.Sh DESCRIPTION
By default,
.Nm
reads
2003-06-10 05:29:14 +00:00
.Xr kldstat 8
2003-06-08 06:57:57 +00:00
output from standard input and writes to standard output a list of
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
2003-06-08 06:57:57 +00:00
of the current directory, which is intended to be a kernel build directory.
2003-06-10 05:29:14 +00:00
This allows
.Xr gdb 1
2003-06-08 06:57:57 +00:00
to load the symbols into the debugging environment.
.Pp
If
2003-06-10 05:29:14 +00:00
.Ar modules-path
2003-06-08 06:57:57 +00:00
is specified,
.Nm
uses it for the modules directory instead of the default
.Pa modules .
2003-06-10 05:29:14 +00:00
This is useful when building in a non-standard location (i.e., not
2003-06-08 06:57:57 +00:00
.Pa /usr/src
and
2003-06-10 05:29:14 +00:00
.Pa /usr/obj ) .
2003-06-08 06:57:57 +00:00
.Pp
If
2003-06-10 05:29:14 +00:00
.Ar outfile
2003-06-08 06:57:57 +00:00
is specified,
2003-06-10 05:29:14 +00:00
.Nm
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
2003-06-10 05:29:14 +00:00
.Ar outfile ,
2003-06-08 06:57:57 +00:00
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.
2003-06-08 06:57:57 +00:00
.It Fl k
Instead of reading from standard input, start a
2003-06-10 05:29:14 +00:00
.Xr kldstat 8
2003-06-08 06:57:57 +00:00
and read the information from it.
.It Fl s
Do not prepend a (guessed) subdirectory of the module path.
2003-06-08 06:57:57 +00:00
.It Fl x
Normally
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 .
2003-06-08 06:57:57 +00:00
The
.Fl x
option tells
.Nm
2003-06-10 05:29:14 +00:00
to look for KLDs with names of the form
.Ao Ar module Ac Ns Pa .ko .
2003-06-08 06:57:57 +00:00
.El
2005-01-18 20:02:45 +00:00
.Sh SEE ALSO
.Xr gdb 1 ,
.Xr kldstat 8
2003-06-08 06:57:57 +00:00
.Sh HISTORY
2003-06-10 05:29:14 +00:00
The
2003-06-08 06:57:57 +00:00
.Nm
2003-06-10 05:29:14 +00:00
utility first appeared in
.Fx 5.2 .
2003-06-08 06:57:57 +00:00
.Sh AUTHORS
.An Greg Lehey Aq grog@FreeBSD.org
.Sh BUGS
2003-06-10 05:29:14 +00:00
It should be possible to write to an
.Ar outfile
without specifying a module path.