d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
bdfd68dca7
freebsd-nq/usr.sbin/asf/asf.8

180 lines
4.6 KiB
Groff
Raw Normal View History

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$
.\"
Allow for module-path being a semicolon-separated list of dirs. This is consistent with kern.module_path sysctl and also compensates for the unconventional syntax of asf(8) where the last of multiple arguments is the output file, which prevents us from using the traditional Unix syntax "foo file ..." to specify multiple module dirs. Submitted by: emaste MFC after: 1 week
2006-12-20 06:20:04 +00:00
.Dd December 20, 2006
Oops, this is section 8, not 1.
2003-06-08 06:59:33 +00:00
.Dt ASF 8
mdoc: order prologue macros consistently by Dd/Dt/Os Although groff_mdoc(7) gives another impression, this is the ordering most widely used and also required by mdocml/mandoc. Reviewed by: ru Approved by: philip, ed (mentors)
2010-04-14 19:08:06 +00:00
.Os
Add man page.
2003-06-08 06:57:57 +00:00
.Sh NAME
.Nm asf
.Nd add symbol files
.Sh SYNOPSIS
.Nm
Give a major overhaul to asf(8). The improvements are: - can get the kld info from core files via kvm(3); - can use kldstat(2) directly, which is a piece of cake; - can use .symbols or whatever, which allows for use by non-developers when reporting system crashes -- now asf(8) can be mentioned in the handbook at last; - speed (no more double fts(3) per loaded module); - various bugs fixed. At the same time, the new asf(8) should stay compatible with the old one, bar bugs. Perhaps some defaults may be changed later to match today's state of affairs. Reviewed by: grog MFC after: 1 month Sponsored by: RiNet (Cronyx Plus LLC)
2006-06-18 11:14:40 +00:00
.Op Fl afKksVx
.Op Fl M Ar core
.Op Fl N Ar system
.Op Fl o Ar outfile
.Op Fl X Ar suffix
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
Give a major overhaul to asf(8). The improvements are: - can get the kld info from core files via kvm(3); - can use kldstat(2) directly, which is a piece of cake; - can use .symbols or whatever, which allows for use by non-developers when reporting system crashes -- now asf(8) can be mentioned in the handbook at last; - speed (no more double fts(3) per loaded module); - various bugs fixed. At the same time, the new asf(8) should stay compatible with the old one, bar bugs. Perhaps some defaults may be changed later to match today's state of affairs. Reviewed by: grog MFC after: 1 month Sponsored by: RiNet (Cronyx Plus LLC)
2006-06-18 11:14:40 +00:00
output from standard input and writes to the
Markup fixes.
2006-09-29 17:57:04 +00:00
.Pa .asf
Give a major overhaul to asf(8). The improvements are: - can get the kld info from core files via kvm(3); - can use kldstat(2) directly, which is a piece of cake; - can use .symbols or whatever, which allows for use by non-developers when reporting system crashes -- now asf(8) can be mentioned in the handbook at last; - speed (no more double fts(3) per loaded module); - various bugs fixed. At the same time, the new asf(8) should stay compatible with the old one, bar bugs. Perhaps some defaults may be changed later to match today's state of affairs. Reviewed by: grog MFC after: 1 month Sponsored by: RiNet (Cronyx Plus LLC)
2006-06-18 11:14:40 +00:00
file 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
Allow for module-path being a semicolon-separated list of dirs. This is consistent with kern.module_path sysctl and also compensates for the unconventional syntax of asf(8) where the last of multiple arguments is the output file, which prevents us from using the traditional Unix syntax "foo file ..." to specify multiple module dirs. Submitted by: emaste MFC after: 1 week
2006-12-20 06:20:04 +00:00
An optional
Tidy up the manpage. Reviewed by: grog
2003-06-10 05:29:14 +00:00
.Ar modules-path
Allow for module-path being a semicolon-separated list of dirs. This is consistent with kern.module_path sysctl and also compensates for the unconventional syntax of asf(8) where the last of multiple arguments is the output file, which prevents us from using the traditional Unix syntax "foo file ..." to specify multiple module dirs. Submitted by: emaste MFC after: 1 week
2006-12-20 06:20:04 +00:00
argument can specify a semicolon-separated list of directory pathnames
similar to the
.Va kern.module_path
sysctl.
Each directory in the list will be searched in turn for modules.
The default list consists of just one element,
.Pa modules ,
which is suitable if the current directory is a kernel build directory.
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
Give a major overhaul to asf(8). The improvements are: - can get the kld info from core files via kvm(3); - can use kldstat(2) directly, which is a piece of cake; - can use .symbols or whatever, which allows for use by non-developers when reporting system crashes -- now asf(8) can be mentioned in the handbook at last; - speed (no more double fts(3) per loaded module); - various bugs fixed. At the same time, the new asf(8) should stay compatible with the old one, bar bugs. Perhaps some defaults may be changed later to match today's state of affairs. Reviewed by: grog MFC after: 1 month Sponsored by: RiNet (Cronyx Plus LLC)
2006-06-18 11:14:40 +00:00
writes to it instead of
.Pa .asf .
If
.Ar outfile
is a single dash
Markup fixes.
2006-09-29 17:57:04 +00:00
.Pq Sq Fl ,
Make grammar a bit more consistent in this document.
2006-12-20 06:21:51 +00:00
standard output is used.
Add man page.
2003-06-08 06:57:57 +00:00
.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.
Give a major overhaul to asf(8). The improvements are: - can get the kld info from core files via kvm(3); - can use kldstat(2) directly, which is a piece of cake; - can use .symbols or whatever, which allows for use by non-developers when reporting system crashes -- now asf(8) can be mentioned in the handbook at last; - speed (no more double fts(3) per loaded module); - various bugs fixed. At the same time, the new asf(8) should stay compatible with the old one, bar bugs. Perhaps some defaults may be changed later to match today's state of affairs. Reviewed by: grog MFC after: 1 month Sponsored by: RiNet (Cronyx Plus LLC)
2006-06-18 11:14:40 +00:00
.It Fl K
Instead of reading from standard input, use the conventional
system interface to get the list of modules currently loaded.
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.
Give a major overhaul to asf(8). The improvements are: - can get the kld info from core files via kvm(3); - can use kldstat(2) directly, which is a piece of cake; - can use .symbols or whatever, which allows for use by non-developers when reporting system crashes -- now asf(8) can be mentioned in the handbook at last; - speed (no more double fts(3) per loaded module); - various bugs fixed. At the same time, the new asf(8) should stay compatible with the old one, bar bugs. Perhaps some defaults may be changed later to match today's state of affairs. Reviewed by: grog MFC after: 1 month Sponsored by: RiNet (Cronyx Plus LLC)
2006-06-18 11:14:40 +00:00
.It Fl M
Specify the core file for
.Xr kvm 3 .
Flush my typo fix queue for this directory.
2006-12-05 23:20:14 +00:00
Implies
Give a major overhaul to asf(8). The improvements are: - can get the kld info from core files via kvm(3); - can use kldstat(2) directly, which is a piece of cake; - can use .symbols or whatever, which allows for use by non-developers when reporting system crashes -- now asf(8) can be mentioned in the handbook at last; - speed (no more double fts(3) per loaded module); - various bugs fixed. At the same time, the new asf(8) should stay compatible with the old one, bar bugs. Perhaps some defaults may be changed later to match today's state of affairs. Reviewed by: grog MFC after: 1 month Sponsored by: RiNet (Cronyx Plus LLC)
2006-06-18 11:14:40 +00:00
.Fl V .
.It Fl N
Specify the system file for
.Xr kvm 3 .
Implies
.Fl V .
.It Fl o
Specify the file for
.Nm
to write or append its output to.
If
.Ar outfile
is a single dash
Markup fixes.
2006-09-29 17:57:04 +00:00
.Pq Sq Fl ,
Make grammar a bit more consistent in this document.
2006-12-20 06:21:51 +00:00
standard output is used.
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.
Give a major overhaul to asf(8). The improvements are: - can get the kld info from core files via kvm(3); - can use kldstat(2) directly, which is a piece of cake; - can use .symbols or whatever, which allows for use by non-developers when reporting system crashes -- now asf(8) can be mentioned in the handbook at last; - speed (no more double fts(3) per loaded module); - various bugs fixed. At the same time, the new asf(8) should stay compatible with the old one, bar bugs. Perhaps some defaults may be changed later to match today's state of affairs. Reviewed by: grog MFC after: 1 month Sponsored by: RiNet (Cronyx Plus LLC)
2006-06-18 11:14:40 +00:00
.It Fl V
Instead of reading from standard input, use the
.Xr kvm 3
interface to get the list of modules.
This interface allows for inspecting system crash dumps,
as well as the live system.
Add man page.
2003-06-08 06:57:57 +00:00
The
Give a major overhaul to asf(8). The improvements are: - can get the kld info from core files via kvm(3); - can use kldstat(2) directly, which is a piece of cake; - can use .symbols or whatever, which allows for use by non-developers when reporting system crashes -- now asf(8) can be mentioned in the handbook at last; - speed (no more double fts(3) per loaded module); - various bugs fixed. At the same time, the new asf(8) should stay compatible with the old one, bar bugs. Perhaps some defaults may be changed later to match today's state of affairs. Reviewed by: grog MFC after: 1 month Sponsored by: RiNet (Cronyx Plus LLC)
2006-06-18 11:14:40 +00:00
.Fl M
and
.Fl N
options will be of use if inspecting a crash dump.
Elevated privileges, e.g., those of a superuser,
may be needed to use this option.
.It Fl X
Add
.Ar suffix
to the list of suffixes
Add man page.
2003-06-08 06:57:57 +00:00
.Nm
Give a major overhaul to asf(8). The improvements are: - can get the kld info from core files via kvm(3); - can use kldstat(2) directly, which is a piece of cake; - can use .symbols or whatever, which allows for use by non-developers when reporting system crashes -- now asf(8) can be mentioned in the handbook at last; - speed (no more double fts(3) per loaded module); - various bugs fixed. At the same time, the new asf(8) should stay compatible with the old one, bar bugs. Perhaps some defaults may be changed later to match today's state of affairs. Reviewed by: grog MFC after: 1 month Sponsored by: RiNet (Cronyx Plus LLC)
2006-06-18 11:14:40 +00:00
tries to append to KLD file names.
The default list consists of
.Pa .debug ,
.Pa .symbols ,
and the null suffix.
The null suffix always stays at the list tail, after the suffix added.
Should it be needed in the middle of the list,
a blank suffix can be specified to
.Fl X
instead.
.It Fl x
Clear the list of suffixes
.Nm
tries to append to KLD file names.
Only the null suffix is left in the list.
Add man page.
2003-06-08 06:57:57 +00:00
.El
Allow for module-path being a semicolon-separated list of dirs. This is consistent with kern.module_path sysctl and also compensates for the unconventional syntax of asf(8) where the last of multiple arguments is the output file, which prevents us from using the traditional Unix syntax "foo file ..." to specify multiple module dirs. Submitted by: emaste MFC after: 1 week
2006-12-20 06:20:04 +00:00
.Sh EXAMPLES
To add symbol files from the system search path specified by the
.Va kern.module_path
sysctl, the following command can be used:
.Pp
.Dl asf -s `sysctl -n kern.module_path`
Sort sections.
2005-01-18 20:02:45 +00:00
.Sh SEE ALSO
.Xr gdb 1 ,
Give a major overhaul to asf(8). The improvements are: - can get the kld info from core files via kvm(3); - can use kldstat(2) directly, which is a piece of cake; - can use .symbols or whatever, which allows for use by non-developers when reporting system crashes -- now asf(8) can be mentioned in the handbook at last; - speed (no more double fts(3) per loaded module); - various bugs fixed. At the same time, the new asf(8) should stay compatible with the old one, bar bugs. Perhaps some defaults may be changed later to match today's state of affairs. Reviewed by: grog MFC after: 1 month Sponsored by: RiNet (Cronyx Plus LLC)
2006-06-18 11:14:40 +00:00
.Xr kvm 3 ,
.Xr kld 4 ,
Allow for module-path being a semicolon-separated list of dirs. This is consistent with kern.module_path sysctl and also compensates for the unconventional syntax of asf(8) where the last of multiple arguments is the output file, which prevents us from using the traditional Unix syntax "foo file ..." to specify multiple module dirs. Submitted by: emaste MFC after: 1 week
2006-12-20 06:20:04 +00:00
.Xr kldstat 8 ,
.Xr sysctl 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
use .Mt to mark up email addresses consistently (part2) PR: 191174 Submitted by: Franco Fichtner <franco@lastsummer.de>
2014-06-20 09:57:27 +00:00
.An Greg Lehey Aq Mt grog@FreeBSD.org
Add man page.
2003-06-08 06:57:57 +00:00
.Sh BUGS
Give a major overhaul to asf(8). The improvements are: - can get the kld info from core files via kvm(3); - can use kldstat(2) directly, which is a piece of cake; - can use .symbols or whatever, which allows for use by non-developers when reporting system crashes -- now asf(8) can be mentioned in the handbook at last; - speed (no more double fts(3) per loaded module); - various bugs fixed. At the same time, the new asf(8) should stay compatible with the old one, bar bugs. Perhaps some defaults may be changed later to match today's state of affairs. Reviewed by: grog MFC after: 1 month Sponsored by: RiNet (Cronyx Plus LLC)
2006-06-18 11:14:40 +00:00
Module paths are guessed in a rather naive way by default.
It is likely to lag behind the changes to the build tree layout.
Using
.Fl f
is recommended.
Reference in New Issue Copy Permalink